Docserver manifest follow up (rewrite)

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

 # Copyright 2013 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.
 
 from collections import OrderedDict
 from copy import deepcopy
 from operator import itemgetter
 
 from third_party.json_schema_compiler.json_parse import Parse
 
+_PROPERTY_STATUSES = ('required', 'only_one', 'recommended', 'optional')
+
 class ManifestDataSource(object):
   """ Provides a template with access to manifest properties specific to apps or
   extensions.
   """
   def __init__(self,
                compiled_fs_factory,
                file_system,
                manifest_path,
                features_path):
     self._manifest_path = manifest_path
     self._features_path = features_path
     self._file_system = file_system
     self._cache = compiled_fs_factory.Create(
         self._CreateManifestData, ManifestDataSource)
 
   def _ApplyAppsTransformations(self, manifest):
-    manifest['required'][0]['example'] = 'Application'
+    manifest['required'][0]['example'] = {'value': 'Application'}
     manifest['optional'][-1]['is_last'] = True
 
   def _ApplyExtensionsTransformations(self, manifest):
     manifest['optional'][-1]['is_last'] = True
 
+  def _InsertSubDocs(self, manifest_dict):
+    """ Insert all docs in the 'subdoc' category into their 'parent' objcets,

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

objcets

also """ -> '''

oh damn they're all like that.

[jshumway, 2013/07/24 17:40:07]

Rewrote pretty much the entire file, so it should be up to current standards in
style (''', tuples for literals not lists, etc)

+    determined by the section of the subdocs name before a period. Only nests
+    one level.
+    """
+    for key in manifest_dict.get('subdoc', []):
+      parent_name, doc_name = key['name'].split('.', 1)
+      key['name'] = doc_name
+      for category in _PROPERTY_STATUSES:
+        for entry in manifest_dict[category]:
+          if parent_name == entry['name']:
+            parent = entry
+
+      assert parent
+      if 'subdoc' in parent:
+        parent['subdoc'].append(key)
+      else:
+        parent['subdoc'] = [key]
+
+    del manifest_dict['subdoc']
+
   def _CreateManifestData(self, _, content):
-    """Take the contents of |_manifest_path| and create apps and extensions
+    """ Take the contents of |_manifest_path| and create apps and extensions
     versions of a manifest example based on the contents of |_features_path|.
     """
     def create_manifest_dict():
       d = OrderedDict()
-      for category in ['required', 'only_one', 'recommended', 'optional']:
+      for category in _PROPERTY_STATUSES + ('subdoc',):
         d[category] = []
       return d
 
     apps = create_manifest_dict()
     extensions = create_manifest_dict()
 
     manifest_json = Parse(content)
     features_json = Parse(self._file_system.ReadSingle(
         self._features_path))
 
     def add_property(feature, manifest_key, category):
-      """If |feature|, from features_json, has the correct extension_types, add
+      """ If |feature|, from features_json, has the correct extension_types, add
       |manifest_key| to either apps or extensions.
       """
+      # Save the subdocs for later by putting them in their own category.
+      category = 'subdoc' if '.' in manifest_key['name'] else category
+
       added = False
       extension_types = feature['extension_types']
       if extension_types == 'all' or 'platform_app' in extension_types:
         apps[category].append(deepcopy(manifest_key))
         added = True
       if extension_types == 'all' or 'extension' in extension_types:
         extensions[category].append(deepcopy(manifest_key))
         added = True
       return added
 
@@ skipping 10 matching lines @@
     for feature in features_json.keys():
       item = features_json[feature]
       # Handles instances where a features entry is a union with a whitelist.
       if isinstance(item, list):
         item = item[0]
       add_property(item, {'name': feature}, 'optional')
 
     apps['optional'].sort(key=itemgetter('name'))
     extensions['optional'].sort(key=itemgetter('name'))
 
+    self._InsertSubDocs(extensions)
+    self._InsertSubDocs(apps)
+
     self._ApplyAppsTransformations(apps)
     self._ApplyExtensionsTransformations(extensions)

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

how about this:

apps['required'][0]['example'] = {'value': 'Application'}

for manifest in (apps, extensions):
  manifest['optional'].sort(...)
  manifest['optional'][-1]['is_last'] = True
  self._InsertSubDocs(manifest)

return {..}

you can delete _ApplyExtension/AppsTransformations.

[jshumway, 2013/07/24 17:40:07]

Done.

 
     return {'apps': apps, 'extensions': extensions}
 
   def get(self, key):
     return self._cache.GetFromFile(self._manifest_path)[key]