Extensions Docs Server: Fix handling of nodocs

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
 
+class NoDocError(Exception):
+  pass
+
 def _RemoveNoDocs(item):
   if type(item) == dict:
     if item.get('nodoc', False):
       return True
     for key, value in item.items():
       if _RemoveNoDocs(value):
         del item[key]
   elif type(item) == list:
     for i in item:
       if _RemoveNoDocs(i):
         item.remove(i)
   return False
 
 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):
     clean_json = copy.deepcopy(json)
-    _RemoveNoDocs(clean_json)
+    if _RemoveNoDocs(clean_json):
+      raise NoDocError()

[not at google - send to devlin, 2012/08/09 05:11:36]

I don't think an exception is the answer here. We should just have
self._namespace = None and handle that throughout here (e.g. return an empty
object from Generate, or one with just samples).

Let the lack of documentation be handled at the templates/public/... level.

[cduvall, 2012/08/09 17:54:05]

Done.

     try:
       self._namespace = model.Namespace(clean_json, clean_json['namespace'])
     except Exception as e:

[not at google - send to devlin, 2012/08/09 05:11:36]

why do we need to log this error rather than handling it at the top (which will
presumably log it, so we'll end up logging twice)?

[cduvall, 2012/08/09 17:54:05]

Done.

       logging.error(e)
       raise
 
   def _StripPrefix(self, name):
     if name.startswith(self._namespace.name + '.'):
       return name[len(self._namespace.name + '.'):]
     return name
 
   def _FormatDescription(self, description):
     if description is None or '$ref:' not in description:
@@ skipping 19 matching lines @@
   def Generate(self, samples):
     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),
         'samples': samples,
       }
     except Exception as e:

[not at google - send to devlin, 2012/08/09 05:11:36]

ditto

[cduvall, 2012/08/09 17:54:05]

Done.

       logging.error(e)
       raise
 
   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())
@@ skipping 86 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()