Linking AvailabilityFinder with APIDataSource and intro-table templates.

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

Index: chrome/common/extensions/docs/server2/api_data_source.py
diff --git a/chrome/common/extensions/docs/server2/api_data_source.py b/chrome/common/extensions/docs/server2/api_data_source.py
index 3fdd37587de23c6e4c8eab94d7958da966880ae4..a77738dd7fac09c9d4990f5f16298b2635b2f07b 100644
--- a/chrome/common/extensions/docs/server2/api_data_source.py
+++ b/chrome/common/extensions/docs/server2/api_data_source.py
@@ -7,6 +7,10 @@ import logging
 import os
 from collections import defaultdict, Mapping
 
+from branch_utility import BranchUtility
+from docs_server_utils import FormatKey
+import svn_constants
+from third_party.handlebar import Handlebar
 import third_party.json_schema_compiler.json_parse as json_parse
 import third_party.json_schema_compiler.model as model
 import third_party.json_schema_compiler.idl_schema as idl_schema
@@ -103,9 +107,20 @@ class _JSCModel(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, ref_resolver, disable_refs, idl=False):
+  def __init__(self,
+               json,
+               ref_resolver,
+               disable_refs,
+               availability_finder,
+               intro_cache,
+               partial_cache,
+               idl=False):
     self._ref_resolver = ref_resolver
     self._disable_refs = disable_refs
+    self._availability_finder = availability_finder
+    self._intro_tables = intro_cache.GetFromFile(
+        '%s/intro_tables.json' % svn_constants.JSON_PATH)
+    self._partial_cache = partial_cache

[not at google - send to devlin, 2013/07/18 02:20:30]

can you pass in the TemplateDataSource instance instead? You will probably need
to add a SetTemplateDataSource method in there somewhere, since
TemplateDataSource needs an APIDataSource already.

that already does all its own caching etc.

     clean_json = copy.deepcopy(json)
     if _RemoveNoDocs(clean_json):
       self._namespace = None
@@ -132,13 +147,72 @@ class _JSCModel(object):
       return {}
     return {
       'name': self._namespace.name,
-      'description': self._namespace.description,
       'types': self._GenerateTypes(self._namespace.types.values()),
       'functions': self._GenerateFunctions(self._namespace.functions),
       'events': self._GenerateEvents(self._namespace.events),
-      'properties': self._GenerateProperties(self._namespace.properties)
+      'properties': self._GenerateProperties(self._namespace.properties),
+      'intro_list': self._GetIntroTableList()
     }
 
+  def _GetPartial(self, template_name):
+    return self._partial_cache.GetFromFile(
+        '/'.join((svn_constants.PRIVATE_TEMPLATE_PATH,
+                  FormatKey(template_name))))
+
+  def _GetIntroTableList(self):
+    """Create a generic data structure that can be traversed by the templates
+    to create an API intro table.
+    """
+    intro_list = [{
+      'title': 'Description',
+      'content': [
+        { 'text': self._FormatDescription(self._namespace.description) }
+      ]
+    }]
+
+    if self._IsExperimental():
+      status = 'experimental'
+      version = None
+    else:
+      availability = self._GetApiAvailability()
+      status = availability.channel
+      version = availability.version
+    intro_list.append({
+      'title': 'Availability',
+      'content': [
+        {
+          'partial': self._GetPartial('intro_tables/%s_message.html' % status),
+          'version': version
+        }
+      ]
+    })
+
+    # Look up the API name in intro_tables.json, which is structured similarly
+    # to the data structure being created. If the name is found, loop through
+    # the attributes and add them to this structure.
+    table_info = self._intro_tables.get(self._namespace.name)
+    if table_info is None:
+      return intro_list
+
+    # The intro tables have a specific ordering that needs to be followed.
+    ordering = ('Permissions', 'Samples', 'Learn More')
+
+    for category in ordering:
+      if category in table_info.keys():

[not at google - send to devlin, 2013/07/18 02:20:30]

early-exit here:

if category not in table_info.keys():
  continue

+        node = { 'title': category, 'content': table_info.get(category, []) }
+        for obj in node['content']:
+          if ('partial' in obj.keys() and
+              not isinstance(obj['partial'], Handlebar)):
+            obj['partial'] = self._GetPartial(obj['partial'])
+        intro_list.append(node)

[epeterson, 2013/07/17 23:48:23]

Also, this became messy with the special behavior required for partials.

[not at google - send to devlin, 2013/07/18 02:20:30]

ah right. Yeah - oh well.

when is isinstance(obj['partial'], Handlebar) actually true? It should always be
false. Please comment it, and I think this could be structured a little more
clearly:

# Transform the 'partial' argument from the partial name to the template itself.
content = table_info[category]
if 'partial' in content:
  content['partial'] =
self._template_data_source.GetTemplate(content['partial'])
intro_list.append({
  'title': category,
  'content': content
})

+    return intro_list
+
+  def _GetApiAvailability(self):
+    return self._availability_finder.GetApiAvailability(self._namespace.name)
+
+  def _IsExperimental(self):
+     return self._namespace.name.startswith('experimental')
+
   def _GenerateTypes(self, types):
     return [self._GenerateType(t) for t in types]
 
@@ -325,7 +399,10 @@ class APIDataSource(object):
   |compiled_fs_factory|, so the APIs can be plugged into templates.
   """
   class Factory(object):
-    def __init__(self, compiled_fs_factory, base_path):
+    def __init__(self,
+                 compiled_fs_factory,
+                 base_path,
+                 availability_finder_factory):
       def create_compiled_fs(fn, category):
         return compiled_fs_factory.Create(fn, APIDataSource, category=category)
 
@@ -353,7 +430,13 @@ class APIDataSource(object):
       self._names_cache = create_compiled_fs(self._GetAllNames, 'names')
 
       self._base_path = base_path
-
+      self._availability_finder = availability_finder_factory.Create()
+      self._intro_cache = create_compiled_fs(
+          lambda _, json: json_parse.Parse(json),
+          'intro-cache')
+      self._partial_cache = create_compiled_fs(
+          lambda _, text: Handlebar(text),
+          'partial-cache')
       # These must be set later via the SetFooDataSourceFactory methods.
       self._ref_resolver_factory = None
       self._samples_data_source_factory = None
@@ -399,7 +482,10 @@ class APIDataSource(object):
       return _JSCModel(
           json_parse.Parse(api)[0],
           self._ref_resolver_factory.Create() if not disable_refs else None,
-          disable_refs).ToDict()
+          disable_refs,
+          self._availability_finder,
+          self._intro_cache,
+          self._partial_cache).ToDict()
 
     def _LoadIdlAPI(self, api, disable_refs):
       idl = idl_parser.IDLParser().ParseData(api)
@@ -407,6 +493,9 @@ class APIDataSource(object):
           idl_schema.IDLSchema(idl).process()[0],
           self._ref_resolver_factory.Create() if not disable_refs else None,
           disable_refs,
+          self._availability_finder,
+          self._intro_cache,
+          self._partial_cache,
           idl=True).ToDict()
 
     def _GetIDLNames(self, base_dir, apis):
@@ -484,8 +573,10 @@ class APIDataSource(object):
   def _GetAsSubdirectory(self, name):
     if name.startswith('experimental_'):
       parts = name[len('experimental_'):].split('_', 1)
-      parts[1] = 'experimental_%s' % parts[1]
-      return '/'.join(parts)
+      if len(parts) > 1:
+        parts[1] = 'experimental_%s' % parts[1]
+        return '/'.join(parts)
+      return '%s/%s' % (parts[0], name)
     return name.replace('_', '/', 1)
 
   def get(self, key):