Extensions Docs Server: Server code for showing properties of properties

Extensions Docs Server: Server code for showing properties of properties

This is a separate patch with just the server code for showing properties of
properties. HandlebarDictGenerator now generates IDs for all API items, which
are used in the table of contents.

Template changes are here: https://codereview.chromium.org/10985071/

BUG=151866
Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=160300

[not at google - send to devlin, 2012-10-03 01:07:26]

(you might want to make the change description less context-specific, like, "add
IDs to all items blah blah"

https://codereview.chromium.org/11018003/diff/1/chrome/common/extensions/docs...
File chrome/common/extensions/docs/server2/handlebar_dict_generator.py (right):

https://codereview.chromium.org/11018003/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/server2/handlebar_dict_generator.py:24: def
_CreateId(name, parent, prefix):
It would be a bit nicer to have parent be an optional parameter for
self-documentation, even though sometimes when you call this you don't know
whether there's a parent or not.

Actually... if you pass in the model object itself, it can figure out the parent
from that? Though see comment below about the "simple_name" stuff. That goes for
everywhere in this file where you've added a "parent" parameter to functions.

https://codereview.chromium.org/11018003/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/server2/handlebar_dict_generator.py:25: if parent:
"is not None" or whatever?

https://codereview.chromium.org/11018003/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/server2/handlebar_dict_generator.py:97: def
_GenerateFunctions(self, functions, parent):
Again, make parent explicitly optional, though you might not actually need it.

https://codereview.chromium.org/11018003/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/server2/handlebar_dict_generator.py:172:
'functions': self._GenerateFunctions(property_.functions, name),
It's confusing to me that "parent" is actually "name of parent". Could you just
pass the parent in directly, and let the template code that uses it fish out the
name? It would mean pushing the _StripName logic into the JSON schema compiler
model, but that should be easy enough, right? It's possible to figure out the
namespace of an object and strip out the prefix. You could call it "simple_name"
or something (matches the Java reflection API).

[not at google - send to devlin, 2012-10-03 01:09:12]

(because all the model items in model.py have a "parent" property -- they're
just for printing stack traces IIRC, but this seems like a pretty good use case
for them)

[cduvall, 2012-10-05 01:13:26]

http://codereview.chromium.org/11018003/diff/1/chrome/common/extensions/docs/...
File chrome/common/extensions/docs/server2/handlebar_dict_generator.py (right):

http://codereview.chromium.org/11018003/diff/1/chrome/common/extensions/docs/...
chrome/common/extensions/docs/server2/handlebar_dict_generator.py:24: def
_CreateId(name, parent, prefix):
On 2012/10/03 01:07:26, kalman wrote:
> It would be a bit nicer to have parent be an optional parameter for
> self-documentation, even though sometimes when you call this you don't know
> whether there's a parent or not.
> 
> Actually... if you pass in the model object itself, it can figure out the
parent
> from that? Though see comment below about the "simple_name" stuff. That goes
for
> everywhere in this file where you've added a "parent" parameter to functions.

Done.

http://codereview.chromium.org/11018003/diff/1/chrome/common/extensions/docs/...
chrome/common/extensions/docs/server2/handlebar_dict_generator.py:25: if parent:
On 2012/10/03 01:07:26, kalman wrote:
> "is not None" or whatever?

Done.

http://codereview.chromium.org/11018003/diff/1/chrome/common/extensions/docs/...
chrome/common/extensions/docs/server2/handlebar_dict_generator.py:97: def
_GenerateFunctions(self, functions, parent):
On 2012/10/03 01:07:26, kalman wrote:
> Again, make parent explicitly optional, though you might not actually need it.

Done.

http://codereview.chromium.org/11018003/diff/1/chrome/common/extensions/docs/...
chrome/common/extensions/docs/server2/handlebar_dict_generator.py:172:
'functions': self._GenerateFunctions(property_.functions, name),
On 2012/10/03 01:07:26, kalman wrote:
> It's confusing to me that "parent" is actually "name of parent". Could you
just
> pass the parent in directly, and let the template code that uses it fish out
the
> name? It would mean pushing the _StripName logic into the JSON schema compiler
> model, but that should be easy enough, right? It's possible to figure out the
> namespace of an object and strip out the prefix. You could call it
"simple_name"
> or something (matches the Java reflection API).

Done. I named this 'parent_name' instead, and added the 'simple_name' property
to the JSON schema compiler. This removed the need to pass parents around at all
to the functions.

[not at google - send to devlin, 2012-10-05 01:30:16]

lgtm, thanks.

I realised that you can't just put "parent" on the JSON because that would
create a nastily deep/recursive JSON structure :)

http://codereview.chromium.org/11018003/diff/3001/chrome/common/extensions/do...
File chrome/common/extensions/docs/server2/handlebar_dict_generator.py (right):

http://codereview.chromium.org/11018003/diff/3001/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/handlebar_dict_generator.py:132:
'parent_name': None,
put this in the else clause below? nit but I find it easier to read.

http://codereview.chromium.org/11018003/diff/3001/chrome/common/extensions/do...
chrome/common/extensions/docs/server2/handlebar_dict_generator.py:176:
property_dict['parent_name'] = property_.parent.simple_name
ditto

http://codereview.chromium.org/11018003/diff/3001/tools/json_schema_compiler/...
File tools/json_schema_compiler/model.py (right):

http://codereview.chromium.org/11018003/diff/3001/tools/json_schema_compiler/...
tools/json_schema_compiler/model.py:54: _AddTypes(self, json, self.name)
I think passing around the namespace itself rather than its name would be a
nicer idiom. Just access its name when needed.

http://codereview.chromium.org/11018003/diff/3001/tools/json_schema_compiler/...
tools/json_schema_compiler/model.py:74: - |item_type| if this is an array, the
type of items in the array
add simple_name to this list?

[cduvall, 2012-10-05 01:44:56]

https://codereview.chromium.org/11018003/diff/3001/chrome/common/extensions/d...
File chrome/common/extensions/docs/server2/handlebar_dict_generator.py (right):

https://codereview.chromium.org/11018003/diff/3001/chrome/common/extensions/d...
chrome/common/extensions/docs/server2/handlebar_dict_generator.py:132:
'parent_name': None,
On 2012/10/05 01:30:16, kalman wrote:
> put this in the else clause below? nit but I find it easier to read.

Done.

https://codereview.chromium.org/11018003/diff/3001/chrome/common/extensions/d...
chrome/common/extensions/docs/server2/handlebar_dict_generator.py:176:
property_dict['parent_name'] = property_.parent.simple_name
On 2012/10/05 01:30:16, kalman wrote:
> ditto

Done.

https://codereview.chromium.org/11018003/diff/3001/tools/json_schema_compiler...
File tools/json_schema_compiler/model.py (right):

https://codereview.chromium.org/11018003/diff/3001/tools/json_schema_compiler...
tools/json_schema_compiler/model.py:54: _AddTypes(self, json, self.name)
On 2012/10/05 01:30:16, kalman wrote:
> I think passing around the namespace itself rather than its name would be a
> nicer idiom. Just access its name when needed.

Done.

https://codereview.chromium.org/11018003/diff/3001/tools/json_schema_compiler...
tools/json_schema_compiler/model.py:74: - |item_type| if this is an array, the
type of items in the array
On 2012/10/05 01:30:16, kalman wrote:
> add simple_name to this list?

Done.

[commit-bot: I haz the power, 2012-10-05 01:45:27]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/cduvall@chromium.org/11018003/7002