Extensions Docs Server: HandlebarDictGenerator

chrome/common/extensions/docs/server2/handlebar_dict_generator.py

+# Copyright (c) 2012 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+import os
+
+import third_party.json_schema_compiler.model as model
+
+def _RemoveNoDocs(item):
+  if type(item) == dict:
+    if item.get('nodoc', False):
+      return True
+    for key, value in item.items():
+      if _RemoveNoDocs(value):
+        del item[key]
+  elif type(item) == list:
+    for i in item:
+      if _RemoveNoDocs(i):
+        item.remove(i)
+  return False
+
+class HandlebarDictGenerator(object):
+  """Uses a Model from the JSON Schema Compiler and generates a dict that
+  a Handlebar template can use for a data source.
+  """
+  def __init__(self, json):
+    _RemoveNoDocs(json)

[not at google - send to devlin, 2012/06/20 18:11:53]

Would prefer not to modify the input json here. Make a copy first?

[cduvall, 2012/06/20 18:24:49]

Done.

+    self._namespace = model.Namespace(json, json['namespace'])
+
+  def Generate(self):
+    return {
+      'name': self._namespace.name,
+      'types': self._GenerateTypes(self._namespace.types),
+      'functions': self._GenerateFunctions(self._namespace.functions)
+    }
+
+  def _GenerateTypes(self, types):
+    types_list = []
+    for type_name in types:
+      types_list.append(self._GenerateType(types[type_name]))
+    return types_list
+
+  def _GenerateType(self, type_):
+    type_dict = {
+      'name': type_.name,
+      'type': type_.type_.name,
+      'description': type_.description,
+      'properties': self._GenerateProperties(type_.properties),
+      'functions': self._GenerateFunctions(type_.functions)
+    }
+    # Only Array types have 'item_type'.
+    if type_.type_ == model.PropertyType.ARRAY:
+      type_dict['item_type'] = self._GenerateType(type_.item_type)

[not at google - send to devlin, 2012/06/20 18:11:53]

It's this kind of stuff that I think will end up changing when we actually write
the template for rendering a type. I.e. we will certainly need to know what the
item type of an array is so that we can render "array of string" but I see this
more as having a separate dictionary called "array", like

if type_.type == ARRAY:
  type_dict['array'] = {
    'type': self._GenerateType(type_.item_type)
  }

and the templates will have like

{{?array}}
array of {{type.type}}
{{/}}

as opposed to

{{?item_type}}
array of {{type.type}}
{{/}}

A trivial example really, but anyway, that's just something to keep in mind.

So: how about just changing the key to "array" for now and seeing what happens.

[cduvall, 2012/06/20 18:24:49]

Done.

+    return type_dict
+
+  def _GenerateFunctions(self, functions):
+    functions_list = []
+    for function_name in functions:
+      functions_list.append(self._GenerateFunction(functions[function_name]))
+    return functions_list
+
+  def _GenerateFunction(self, function):
+    function_dict = {
+      'name': function.name,
+      'description': function.description,
+      'callback': self._GenerateCallback(function.callback),
+      'parameters': []
+    }
+    for param in function.params:
+      function_dict['parameters'].append(self._GenerateProperty(param))
+    return function_dict
+
+  def _GenerateCallback(self, callback):
+    callback_dict = {
+      'name': 'callback',
+      'parameters': []
+    }
+    for param in callback.params:
+      callback_dict['parameters'].append(self._GenerateProperty(param))
+    return callback_dict
+
+  def _GenerateProperties(self, properties):
+    properties_list = []
+    for property_name in properties:
+      properties_list.append(self._GenerateProperty(properties[property_name]))
+    return properties_list
+
+  def _GenerateProperty(self, property_):
+    property_dict = {
+      'name': property_.name,
+      'type': property_.type_.name,
+      'optional': property_.optional,
+      'description': property_.description,
+      'properties': self._GenerateProperties(property_.properties)
+    }
+    if property_.type_ == model.PropertyType.CHOICES:
+      property_dict['choices'] = []
+      for choice_name in property_.choices:
+        property_dict['choices'].append(
+            self._GenerateProperty(property_.choices[choice_name]))
+    elif property_.type_ == model.PropertyType.REF:
+      property_dict['ref_type'] = property_.ref_type
+    elif property_.type_ == model.PropertyType.ARRAY:
+      property_dict['item_type'] = self._GenerateProperty(property_.item_type)

[not at google - send to devlin, 2012/06/20 18:11:53]

ditto, my comment above applies to all these "type == Foo" things. 'ref_type' ->
'ref', 'item_type' -> 'array'.

[cduvall, 2012/06/20 18:24:49]

Done.

+    return property_dict