From 6f783d37d82e95a7e6385f8c292020234ecd6b96 Mon Sep 17 00:00:00 2001
From: Mike Hommey <mh+mozilla@glandium.org>
Date: Thu, 14 May 2015 09:31:04 +0900
Subject: [PATCH] Bug 991983 - Add a ContextDerivedTypedListWithItems type.
 r=gps

---
 python/mozbuild/mozbuild/frontend/context.py  | 12 ++++++
 .../mozbuild/test/frontend/test_namespaces.py | 39 ++++++++++++++++++-
 2 files changed, 49 insertions(+), 2 deletions(-)

diff --git a/python/mozbuild/mozbuild/frontend/context.py b/python/mozbuild/mozbuild/frontend/context.py
index 46d862d6f89..652f2cbe8f0 100644
--- a/python/mozbuild/mozbuild/frontend/context.py
+++ b/python/mozbuild/mozbuild/frontend/context.py
@@ -413,6 +413,18 @@ def ContextDerivedTypedList(type, base_class=List):
 
     return _TypedList
 
+@memoize
+def ContextDerivedTypedListWithItems(type, base_class=List):
+    """Specialized TypedList for use with ContextDerivedValue types.
+    """
+    class _TypedListWithItems(ContextDerivedTypedList(type, base_class)):
+        def __getitem__(self, name):
+            if not isinstance(name, type):
+                name = self.TYPE(name)
+            return super(_TypedListWithItems, self).__getitem__(name)
+
+    return _TypedListWithItems
+
 
 BugzillaComponent = TypedNamedTuple('BugzillaComponent',
                         [('product', unicode), ('component', unicode)])
diff --git a/python/mozbuild/mozbuild/test/frontend/test_namespaces.py b/python/mozbuild/mozbuild/test/frontend/test_namespaces.py
index e5a976392d4..3060b108300 100644
--- a/python/mozbuild/mozbuild/test/frontend/test_namespaces.py
+++ b/python/mozbuild/mozbuild/test/frontend/test_namespaces.py
@@ -12,10 +12,12 @@ from mozbuild.frontend.context import (
     Context,
     ContextDerivedValue,
     ContextDerivedTypedList,
+    ContextDerivedTypedListWithItems,
 )
 
 from mozbuild.util import (
     StrictOrderingOnAppendList,
+    StrictOrderingOnAppendListWithFlagsFactory,
     UnsortedError,
 )
 
@@ -38,6 +40,12 @@ class Piyo(ContextDerivedValue):
     def __str__(self):
         return self.value
 
+    def __cmp__(self, other):
+        return cmp(self.value, str(other))
+
+    def __hash__(self):
+        return hash(self.value)
+
 
 VARIABLES = {
     'HOGE': (unicode, unicode, None, None),
@@ -45,6 +53,11 @@ VARIABLES = {
     'PIYO': (Piyo, unicode, None, None),
     'HOGERA': (ContextDerivedTypedList(Piyo, StrictOrderingOnAppendList),
         list, None, None),
+    'HOGEHOGE': (ContextDerivedTypedListWithItems(
+        Piyo,
+        StrictOrderingOnAppendListWithFlagsFactory({
+            'foo': bool,
+        })), list, None, None),
 }
 
 class TestContext(unittest.TestCase):
@@ -158,8 +171,7 @@ class TestContext(unittest.TestCase):
 
         ns['HOGERA'] += ['a', 'b', 'c']
 
-        self.assertIsInstance(ns['HOGERA'],
-            ContextDerivedTypedList(Piyo, StrictOrderingOnAppendList))
+        self.assertIsInstance(ns['HOGERA'], VARIABLES['HOGERA'][0])
         for n in range(0, 3):
             self.assertIsInstance(ns['HOGERA'][n], Piyo)
             self.assertEqual(ns['HOGERA'][n].value, ['a', 'b', 'c'][n])
@@ -168,5 +180,28 @@ class TestContext(unittest.TestCase):
         with self.assertRaises(UnsortedError):
             ns['HOGERA'] += ['f', 'e', 'd']
 
+    def test_context_derived_typed_list_with_items(self):
+        ns = Context(allowed_variables=VARIABLES)
+
+        # Setting to a type that's rejected by coercion should not work.
+        with self.assertRaises(ValueError):
+            ns['HOGEHOGE'] = [False]
+
+        values = ['a', 'b', 'c']
+        ns['HOGEHOGE'] += values
+
+        self.assertIsInstance(ns['HOGEHOGE'], VARIABLES['HOGEHOGE'][0])
+        for v in values:
+            ns['HOGEHOGE'][v].foo = True
+
+        for v, item in zip(values, ns['HOGEHOGE']):
+            self.assertIsInstance(item, Piyo)
+            self.assertEqual(v, item)
+            self.assertEqual(ns['HOGEHOGE'][v].foo, True)
+            self.assertEqual(ns['HOGEHOGE'][item].foo, True)
+
+        with self.assertRaises(UnsortedError):
+            ns['HOGEHOGE'] += ['f', 'e', 'd']
+
 if __name__ == '__main__':
     main()