Clean patch with DCC static content

chrome/common/extensions/docs/server2/sidenav_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 copy
 import logging
 
 from compiled_file_system import SingleFile, Unicode
 from data_source import DataSource
 from extensions_paths import JSON_TEMPLATES
 from future import Gettable, Future
 from third_party.json_schema_compiler.json_parse import Parse
 
 
 def _AddLevels(items, level):
   '''Add a 'level' key to each item in |items|. 'level' corresponds to how deep
   in |items| an item is. |level| sets the starting depth.
   '''
   for item in items:
     item['level'] = level
     if 'items' in item:
       _AddLevels(item['items'], level + 1)
 

[not at google - send to devlin, 2013/12/18 05:10:14]

need an extra \n here

[Renato Mangini (chromium), 2013/12/18 13:25:30]

Done.

-
-def _AddSelected(items, path):
-  '''Add 'selected' and 'child_selected' properties to |items| so that the
-  sidenav can be expanded to show which menu item has been selected. Returns
-  True if an item was marked 'selected'.
+def _AddAnnotations(items, path, parent=None):
+  '''Add 'selected', 'child_selected' and 'related' properties to 
+  |items| so that the sidenav can be expanded to show which menu item has 
+  been selected and the related pages section can be drawn. 'related'
+  is added to all items with the same parent as the selected item.
+  If more than one item exactly matches the path, the deepest one is considered 
+  'selected'. A 'parent' property is added to the selected path.
+  
+  Returns True if an item was marked 'selected'.
   '''
   for item in items:
-    if item.get('href', '') == path:
-      item['selected'] = True
-      return True
+    # depth first search

[not at google - send to devlin, 2013/12/18 05:10:14]

Comment is ok to leave out I think.

[Renato Mangini (chromium), 2013/12/18 13:25:30]

Done.

     if 'items' in item:
-      if _AddSelected(item['items'], path):
+      if _AddAnnotations(item['items'], path, item):
         item['child_selected'] = True
         return True
 
+    if item.get('href', '') == path:
+      item['selected'] = True
+      if parent:
+        item['parent'] = parent
+      
+      # navigate on siblings, marking them as related

[not at google - send to devlin, 2013/12/18 05:10:14]

the docstring on this function adequately covers this; no comment needed

[Renato Mangini (chromium), 2013/12/18 13:25:30]

Done.

+      for sibling in items:
+        sibling['related'] = True
+        
+      return True
+
   return False
 
 
+

[not at google - send to devlin, 2013/12/18 05:10:14]

need 1 less \n here

[Renato Mangini (chromium), 2013/12/18 13:25:30]

Done.

 class SidenavDataSource(DataSource):
   '''Provides templates with access to JSON files used to create the side
   navigation bar.
   '''
   def __init__(self, server_instance, request):
     self._cache = server_instance.compiled_fs_factory.Create(
         server_instance.host_file_system_provider.GetTrunk(),
         self._CreateSidenavDict,
         SidenavDataSource)
     self._server_instance = server_instance
@@ skipping 19 matching lines @@
 
       href = item.get('href')
       if href is not None and not href.startswith(('http://', 'https://')):
         if not href.startswith('/'):
           logging.warn('Paths in sidenav must be qualified. %s is not.' % href)
         else:
           href = href.lstrip('/')
         item['href'] = self._server_instance.base_path + href
 
   def Cron(self):
-    futures = [self._cache.GetFromFile('%s/%s_sidenav.json' %
-                                       (JSON_TEMPLATES, platform))
-               for platform in ('apps', 'extensions')]
-    return Future(delegate=Gettable(lambda: [f.Get() for f in futures]))
+    future = self._cache.GetFromFile('%s/chrome_sidenav.json' %
+                                       (JSON_TEMPLATES))
+    return future

[not at google - send to devlin, 2013/12/18 05:10:14]

inline this (no need for the extra |future| variable, return directly)

[Renato Mangini (chromium), 2013/12/18 13:25:30]

Done.

 
   def get(self, key):

[not at google - send to devlin, 2013/12/18 05:10:14]

add:

# TODO(mangini/kalman): Use |key| to decide which sidenav to use, which will
require a more complex Cron method.

[Renato Mangini (chromium), 2013/12/18 13:25:30]

Done.

-    sidenav = copy.deepcopy(self._cache.GetFromFile(
-        '%s/%s_sidenav.json' % (JSON_TEMPLATES, key)).Get())
-    _AddSelected(sidenav, self._server_instance.base_path + self._request.path)
-    return sidenav
+    sidenav = self._cache.GetFromFile(
+        '%s/chrome_sidenav.json' % JSON_TEMPLATES).Get()
+    sidenav = copy.deepcopy(sidenav)
+    _AddAnnotations(sidenav, 
+                       self._server_instance.base_path + self._request.path)

[not at google - send to devlin, 2013/12/18 05:10:14]

indent -= 3 to align with the (

[Renato Mangini (chromium), 2013/12/18 13:25:30]

Done.

+    return sidenav 

[not at google - send to devlin, 2013/12/18 05:10:14]

no trailing space

[Renato Mangini (chromium), 2013/12/18 13:25:30]

Done.