Extension Docs Server: Include a list of samples used in the api reference page.

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 copy
 import logging
 import os
 
 from docs_server_utils import GetLinkToRefType
 import third_party.json_schema_compiler.model as model
@@ skipping 14 matching lines @@
 def _FormatValue(value):
   """Inserts commas every three digits for integer values. It is magic.
   """
   s = str(value)
   return ','.join([s[max(0, i - 3):i] for i in range(len(s), 0, -3)][::-1])
 
 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):
+  def __init__(self, json, samples):
+    self._samples = samples

[not at google - send to devlin, 2012/08/01 10:09:19]

see example I mentioned

[chebert, 2012/08/01 18:04:33]

Done.

     clean_json = copy.deepcopy(json)
     _RemoveNoDocs(clean_json)
     try:
       self._namespace = model.Namespace(clean_json, clean_json['namespace'])
     except Exception as e:
       logging.error(e)
       raise
 
   def _StripPrefix(self, name):
     if name.startswith(self._namespace.name + '.'):
@@ skipping 21 matching lines @@
           { 'href': ref_dict['href'], 'text': ref_dict['text'], 'rest': rest })
     return ''.join(formatted_description)
 
   def Generate(self):
     try:
       return {
         'name': self._namespace.name,
         'types': map(self._GenerateType, self._namespace.types.values()),
         'functions': self._GenerateFunctions(self._namespace.functions),
         'events': map(self._GenerateEvent, self._namespace.events.values()),
-        'properties': self._GenerateProperties(self._namespace.properties)
+        'properties': self._GenerateProperties(self._namespace.properties),
+        'samples': self._FilterSamples(self._samples, self._namespace.name)
       }
     except Exception as e:
       logging.error(e)
       raise
 
+  def _FilterSamples(self, samples, api_name):
+    api_search = '.' + api_name + '.'
+    return [sample for sample in samples
+            if any(api_search in api['name'] for api in sample['api_calls'])]
+
   def _GenerateType(self, type_):
     type_dict = {
       'name': self._StripPrefix(type_.name),
       'description': self._FormatDescription(type_.description),
       'properties': self._GenerateProperties(type_.properties),
       'functions': self._GenerateFunctions(type_.functions),
       'events': map(self._GenerateEvent, type_.events.values())
     }
     self._RenderTypeInformation(type_, type_dict)
     return type_dict
@@ skipping 83 matching lines @@
     elif property_.type_ == model.PropertyType.ENUM:
       dst_dict['enum_values'] = []
       for enum_value in property_.enum_values:
         dst_dict['enum_values'].append({'name': enum_value})
       if len(dst_dict['enum_values']) > 0:
         dst_dict['enum_values'][-1]['last'] = True
     elif property_.instance_of:
       dst_dict['simple_type'] = property_.instance_of.lower()
     else:
       dst_dict['simple_type'] = property_.type_.name.lower()