[Pkg-mozext-commits] [adblock-plus] 355/464: Allow metadata file to inherit values from another configuration file

[David Prévot]

This is an automated email from the git hooks/post-receive script.

taffit pushed a commit to branch master
in repository adblock-plus.

commit 0ffb24254548ed19a20cb3889bc50fafa3b502e3
Author: Wladimir Palant <trev at adblockplus.org>
Date:   Fri Jan 18 12:28:54 2013 +0100

    Allow metadata file to inherit values from another configuration file
---
 chainedconfigparser.py | 112 +++++++++++++++++++++++++++++++++++++++++++++++++
 packager.py            |   9 +---
 2 files changed, 114 insertions(+), 7 deletions(-)

diff --git a/chainedconfigparser.py b/chainedconfigparser.py
new file mode 100644
index 0000000..ba1260c
--- /dev/null
+++ b/chainedconfigparser.py
@@ -0,0 +1,112 @@
+# coding: utf-8
+
+# This file is part of the Adblock Plus build tools,
+# Copyright (C) 2006-2012 Eyeo GmbH
+#
+# Adblock Plus is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# Adblock Plus is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
+
+# Note: These are the base functions common to all packagers, the actual
+# packagers are implemented in packagerGecko and packagerChrome.
+
+import os, codecs, ConfigParser
+
+class ChainedConfigParser:
+  """
+    This class provides essentially the same interfaces as SafeConfigParser but
+    allows chaining configuration files so that one config file provides the
+    default values for the other. To specify the config file to inherit from
+    a config file needs to contain the following option:
+
+    [default]
+    inherit = foo/bar.config
+
+    The value of the inherit option has to be a relative path with forward
+    slashes as delimiters. Up to 5 configuration files can be chained this way,
+    longer chains are disallowed to deal with circular references.
+
+    A main API difference to SafeConfigParser is the way a class instance is
+    constructed: a file path has to be passed, this file is assumed to be
+    encoded as UTF-8. Also, ChainedConfigParser data is read-only and the
+    options are case-sensitive.
+  """
+
+  def __init__(self, path):
+    self.chain = []
+    self.read_path(path)
+
+  def read_path(self, path):
+    if len(self.chain) >= 5:
+      raise Exception('Too much inheritance in config files')
+
+    config = ConfigParser.SafeConfigParser()
+    config.optionxform = str
+    handle = codecs.open(path, 'rb', encoding='utf-8')
+    config.readfp(handle)
+    handle.close()
+    self.chain.append(config)
+
+    if config.has_section('default') and config.has_option('default', 'inherit'):
+      parts = config.get('default', 'inherit').split('/')
+      defaults_path = os.path.join(os.path.dirname(path), *parts)
+      self.read_path(defaults_path)
+
+  def defaults(self):
+    result = {}
+    for config in reverse(self.chain):
+      for key, value in config.defaults().iteritems():
+        result[key] = value
+    return result
+
+  def sections(self):
+    result = set()
+    for config in self.chain:
+      for section in config.sections():
+        result.add(section)
+    return list(result)
+
+  def has_section(self, section):
+    for config in self.chain:
+      if config.has_section(section):
+        return True
+    return False
+
+  def options(self, section):
+    result = set()
+    for config in self.chain:
+      if config.has_section(section):
+        for option in config.options(section):
+          result.add(option)
+    return list(result)
+
+  def has_option(self, section, option):
+    for config in self.chain:
+      if config.has_section(section) and config.has_option(section, option):
+        return True
+    return False
+
+  def get(self, section, option):
+    for config in self.chain:
+      if config.has_section(section) and config.has_option(section, option):
+        return config.get(section, option)
+    raise ConfigParser.NoOptionError(option, section)
+
+  def items(self, section):
+    seen = set()
+    result = []
+    for config in self.chain:
+      if config.has_section(section):
+        for name, value in config.items(section):
+          if name not in seen:
+            seen.add(name)
+            result.append((name, value))
+    return result
diff --git a/packager.py b/packager.py
index 2a89977..dda8205 100644
--- a/packager.py
+++ b/packager.py
@@ -20,7 +20,7 @@
 
 import sys, os, re, codecs, subprocess, json, zipfile, jinja2
 from StringIO import StringIO
-from ConfigParser import SafeConfigParser
+from chainedconfigparser import ChainedConfigParser
 
 import buildtools
 
@@ -31,12 +31,7 @@ def getMetadataPath(baseDir):
   return os.path.join(baseDir, 'metadata')
 
 def readMetadata(baseDir):
-  metadata = SafeConfigParser()
-  metadata.optionxform = str
-  file = codecs.open(getMetadataPath(baseDir), 'rb', encoding='utf-8')
-  metadata.readfp(file)
-  file.close()
-  return metadata
+  return ChainedConfigParser(getMetadataPath(baseDir))
 
 def getBuildNum(baseDir):
   try:

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-mozext/adblock-plus.git