Extensions Docs Server: Internationalized samples

chrome/common/extensions/docs/server2/samples_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
 
 class SamplesDataSource(object):

[not at google - send to devlin, 2012/07/20 01:28:21]

See comment in template_data_source... this needs a Factory to get injected into
TDS and then TDS creates one of these bound to a request too.

[cduvall, 2012/07/20 19:40:50]

Done.

   """Constructs a list of samples and their respective files and api calls.
   """
   def __init__(self, fetcher, cache_builder, samples_path):
     self._fetcher = fetcher
     self._cache = cache_builder.build(self._MakeSamplesList)
     self._samples_path = samples_path
+    self._headers = {}

[not at google - send to devlin, 2012/07/20 01:28:21]

let's just bind this to the request. Easier to understand what that is than
"headers".

[cduvall, 2012/07/20 19:40:50]

Done.

+
+  def SetHeaders(self, headers):
+    self._headers = headers
 
   def _GetApiItems(self, js_file):
     return set(re.findall('(chrome\.[a-zA-Z0-9\.]+)', js_file))
 
   def _MakeApiLink(self, prefix, item):
     api, name = item.replace('chrome.', '').split('.', 1)
     return api + '.html#' + prefix + '-' + name
 
+  def _FetchFile(self, filename):
+    return self._fetcher.Read([filename]).Get()[filename]

[not at google - send to devlin, 2012/07/20 01:28:21]

Seen this pattern in a couple of places now.

Would it work to add a method to FileSystem called ReadSingleFile which just
returns that one file calling the interface methods? If the subclasses implement
it properly then should all work?

[cduvall, 2012/07/20 19:40:50]

Done.

+
   def _GetDataFromManifest(self, path):
-    manifest_path = path + '/manifest.json'
-    manifest = self._fetcher.Read([manifest_path]).Get()[manifest_path]
+    manifest = self._FetchFile(path + '/manifest.json')
     manifest_json = json.loads(manifest)
-    return (manifest_json.get('name'), manifest_json.get('description'))
+    name = manifest_json.get('name', '')
+    description = manifest_json.get('description', '')
+    if name.startswith('__MSG_') or description.startswith('__MSG_'):

[not at google - send to devlin, 2012/07/20 01:28:21]

Won't this cache only the language in the header? We need to cache all the
languages. Algorithm should be like...

manifest = self._FetchFile(path + '/manfiest.json')
manifest_json = manifest_json.loads(manifest)

data = {
  name: manifest_json.get('name', ''),
  description: manifest_json.get('description', ''),
  default_locale: manifest_json.get('default_local', None)
}

locale_dirs = self._fetcher.Read(path + '/_locales').Get()
if local_dirs:
  locales = {}
  for locale in locale_dirs:
    locales[locale] = manifest_json.loads(
        self._FetchFile(path + '/_locales/' + locale))
  data.locales = locales

then in get(), when setting name/description, detect if there's a __MSG_ and
internationalise it (based on the headers).

if that makes sense.

in any case, once this cache moves into the Factory you won't be able to access
the request anymore, anyway.

[cduvall, 2012/07/20 19:40:50]

Done.

+      default_language = manifest_json['default_locale']
+      if 'Accept-Language' in self._headers:

[not at google - send to devlin, 2012/07/20 01:28:21]

for thsi kind of thing, would prefer to see somethign like

accepted_languages = _GetAcceptedLanguages(
    self._request.headers['Accept-Languages'])
accepted_languages.add(manifest.default_locale)
... etc

[cduvall, 2012/07/20 19:40:50]

Done.

+        languages = filter(lambda x: x != 'q',
+                           re.findall('([a-zA-Z]+\-[a-zA-Z]+|[a-zA-Z]+)',
+                                      self._headers['Accept-Language']))
+        languages = [l.replace('-', '_') for l in languages]

[not at google - send to devlin, 2012/07/20 01:28:21]

l as a short variable is like the most confusing short variable name ever. Or is
that a 1?

[cduvall, 2012/07/20 19:40:50]

Very true, sorry about that.

+        locales_path = path + '/_locales/'
+        locales = [l.strip('/') for l in self._FetchFile(locales_path)]
+        for language in languages:
+          if language in locales:
+            default_language = language
+            break
+        locale_json = json.loads(unicode(
+            self._FetchFile(locales_path + default_language + '/messages.json'),
+            'latin-1'))
+        if name.startswith('__MSG_'):
+          name = locale_json[name[len('__MSG_'):-2]]['message']
+        if description.startswith('__MSG_'):
+          description = locale_json[description[len('__MSG_'):-2]]['message']
+
+    return (name, description)
 
   def _MakeSamplesList(self, files):
     samples_list = []
     for filename in sorted(files):
       if filename.rsplit('/')[-1] != 'manifest.json':
         continue
       # 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)
       js_files = filter(lambda x: x.endswith('.js'), sample_files)
@@ skipping 25 matching lines @@
         'files': [f.replace(sample_path + '/', '') for f in sample_files],
         'api_calls': api_calls
       })
     return samples_list
 
   def __getitem__(self, key):
     return self.get(key)
 
   def get(self, key):
     return self._cache.GetFromFileListing(self._samples_path + '/')