Extensions Docs Server: Samples zip files

chrome/common/extensions/docs/server2/template_data_source.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 json
+import re
 from path_utils import FormatKey
 from third_party.handlebar import Handlebar
 
 EXTENSIONS_URL = '/chrome/extensions'
 
 class TemplateDataSource(object):
   """This class fetches and compiles templates using the fetcher passed in with
   |cache_builder|.
   """
   def __init__(self,
                branch,
                api_data_source,
                intro_data_source,
                cache_builder,
+               samples_path,
                base_paths):
     self._branch_info = self._MakeBranchDict(branch)
     self._static_resources = ((('/' + branch) if branch != 'local' else '') +
                               '/static')
     self._api_data_source = api_data_source
     self._intro_data_source = intro_data_source
     self._cache = cache_builder.build(self._LoadTemplate)
+    self._dir_cache = cache_builder.build(self._MakeSamplesList)
+    self._file_cache = cache_builder.build(lambda x: x)

[not at google - send to devlin, 2012/07/12 00:22:48]

Same comment as earlier. file_cache not necessary given the files are already
being memcached, and we're caching at a higher level so don't need to also cache
at a low level.

[cduvall, 2012/07/12 01:51:23]

Done.

     self._base_paths = base_paths
+    self._samples_path = samples_path
 
   def _MakeBranchDict(self, branch):
     return {
       'showWarning': branch != 'stable',
       'branches': [
         { 'name': 'Stable', 'path': EXTENSIONS_URL + '/stable' },
         { 'name': 'Dev', 'path': EXTENSIONS_URL + '/dev' },
         { 'name': 'Beta', 'path': EXTENSIONS_URL + '/beta' },
         { 'name': 'Trunk', 'path': EXTENSIONS_URL + '/trunk' }
       ],
       'current': branch
     }
 
+  def _InsertApiItems(self, api_items, js_file):
+    funcs = re.findall('(chrome\.[a-zA-Z0-9\.]+)',
+                       self._file_cache.get(js_file))
+    return api_items + list(set(funcs) - set(api_items))

[not at google - send to devlin, 2012/07/12 00:22:48]

This is pretty indirect, just pass through set and add() to it? Or rather,

funcs = ...
api_items.update(funcs)

[cduvall, 2012/07/12 01:51:23]

Done.

+
+  def _MakeApiLink(self, prefix, item):
+    api, name = item.replace('chrome.', '').rsplit('.', 1)
+    return api + '.html#' + prefix + '-' + name
+
+  def _GetDescriptionFromManifest(self, path):
+    manifest = self._file_cache.get(path + '/manifest.json')
+    return json.loads(manifest).get('description')
+
+  def _MakeSamplesList(self, files):
+    samples_list = []
+    for filename in files:
+      if filename.rsplit('/')[-1] == 'manifest.json':

[not at google - send to devlin, 2012/07/12 00:22:48]

if filename.rsplit('/')[-1] != 'manifest.json':
  continue

?

You could also do something like let the Fetchers accept a filter, but that's
probably overengineering for now.

[cduvall, 2012/07/12 01:51:23]

Done.

+        # This is a little hacky, but it makes a sample page.
+        sample_path = filename.rsplit('/', 1)[-2]
+        sample_files = filter(lambda x: x.startswith(sample_path), files)
+        api_items = []
+        for file_ in sample_files:
+          if file_.endswith('.js'):
+            api_items = self._InsertApiItems(api_items, file_)
+
+        api_calls = []
+        for item in api_items:
+          if len(item.split('.')) < 3:
+            continue
+          if item.endswith('.addListener'):
+            item = item.replace('.addListener', '')
+            api_calls.append({
+              'name': item.rsplit('.')[-1],
+              'link': self._MakeApiLink('event', item)
+            })
+          else:
+            api_calls.append({
+              'name': item.rsplit('.')[-1],
+              'link': self._MakeApiLink('method', item)
+            })
+
+        samples_list.append({
+          'name': filename.rsplit('/')[-2],
+          'description': self._GetDescriptionFromManifest(sample_path),
+          'path': sample_path.split('/', 1)[1],
+          'files': [f.replace(sample_path + '/', '') for f in sample_files],
+          'api_calls': api_calls
+        })
+    return samples_list

[not at google - send to devlin, 2012/07/12 00:22:48]

wow badass.

Definitely pull this stuff out of here and into a SampleFetcher.

+
   def _LoadTemplate(self, template):
     return Handlebar(template)
 
   def Render(self, template_name):
     """This method will render a template named |template_name|, fetching all
     the partial templates needed from |self._cache|. Partials are retrieved
     from the TemplateDataSource with the |get| method.
     """
     template = self.get(template_name)
     if not template:
       return ''
       # TODO error handling
     return template.render({
       'apis': self._api_data_source,
       'branchInfo': self._branch_info,
       'intros': self._intro_data_source,
       'partials': self,
+      'samples': self._dir_cache.get(self._samples_path, True),

[not at google - send to devlin, 2012/07/12 00:22:48]

Can we make this lazily populate somehow? Most templates won't care about the
samples, e.g. write a SamplesDataSource.

[cduvall, 2012/07/12 01:51:23]

Done.

       'static': self._static_resources
     }).text
 
   def __getitem__(self, key):
     return self.get(key)
 
   def get(self, key):
     real_path = FormatKey(key)
     for base_path in self._base_paths:
       try:
         return self._cache.get(base_path + '/' + real_path)
       except:
         pass
     return None