Merge pull request #26 from graphql-python/feat-inheritance

Feature: Support model inheritance

Author: abawchen

graphene_mongo/tests/fixtures.py

@@ -1,4 +1,7 @@
-from .models import Article, Editor, EmbeddedArticle, Player, Reporter
+from .models import (
+    Article, Editor, EmbeddedArticle, Player,
+    Reporter, Parent, Child
+)
 
 
 def setup_fixtures():
@@ -74,3 +77,10 @@ def setup_fixtures():
 
     player2.players = [player1]
     player2.save()
+
+    Child.drop_collection()
+    child1 = Child(bar='BAR', baz='BAZ')
+    child1.save()
+
+    child2 = Child(bar='bar', baz='baz')
+    child2.save()

graphene_mongo/tests/models.py

@@ -45,8 +45,8 @@ class EmbeddedArticle(EmbeddedDocument):
 
 
 class Reporter(Document):
-    meta = {'collection': 'test_repoter'}
 
+    meta = {'collection': 'test_repoter'}
     id = StringField(primary_key=True)
     first_name = StringField(required=True)
     last_name = StringField(required=True)
@@ -65,3 +65,18 @@ class Player(Document):
     articles = ListField(ReferenceField('Article'))
     embedded_list_articles = EmbeddedDocumentListField(EmbeddedArticle)
 
+
+class Parent(Document):
+
+    meta = {
+        'collection': 'test_parent',
+        'allow_inheritance': True
+    }
+    bar = StringField()
+
+
+class Child(Parent):
+
+    meta = {'collection': 'Child'}
+    baz = StringField()
+

graphene_mongo/tests/test_relay_query.py

@@ -9,7 +9,8 @@
 from .types import (ArticleNode, ArticleType,
                     EditorNode, EditorType,
                     PlayerNode, PlayerType,
-                    ReporterNode, ReporterType)
+                    ReporterNode, ReporterType,
+                    ChildNode, ChildType)
 from ..fields import MongoengineConnectionField
 
 setup_fixtures()
@@ -294,6 +295,43 @@ class Query(graphene.ObjectType):
     assert result.data == expected
 
 
+def test_should_filter_through_inheritance():
+
+    class Query(graphene.ObjectType):
+        node = Node.Field()
+        children = MongoengineConnectionField(ChildNode)
+
+    query = '''
+        query ChildrenQuery {
+            children(bar: "bar") {
+                edges {
+                    node {
+                        bar,
+                        baz
+                    }
+                }
+            }
+        }
+    '''
+    expected = {
+        'children': {
+            'edges': [
+                {
+                    'node': {
+                        'bar': 'bar',
+                        'baz': 'baz',
+                    }
+                }
+            ]
+        }
+    }
+    schema = graphene.Schema(query=Query)
+    result = schema.execute(query)
+    assert not result.errors
+    assert json.dumps(result.data, sort_keys=True) == json.dumps(
+        expected, sort_keys=True)
+
+
 def test_should_get_node_by_id():
     # Notes: https://goo.gl/hMNRgs
     class Query(graphene.ObjectType):

graphene_mongo/tests/test_types.py

@@ -5,8 +5,8 @@
 
 from .. import registry
 from ..types import MongoengineObjectType
-from .models import Article
-from .models import Reporter
+from .models import Article, EmbeddedArticle, Reporter
+from .models import Parent, Child
 from .utils import with_local_registry
 
 registry.reset_global_registry()
@@ -22,12 +22,33 @@ class Meta:
         interfaces = (Node,)
 
 
+class Being(MongoengineObjectType):
+
+    class Meta:
+        model = EmbeddedArticle
+        interfaces = (Node,)
+
 class Character(MongoengineObjectType):
+
     class Meta:
         model = Reporter
         registry = registry.get_global_registry()
 
 
+class Dad(MongoengineObjectType):
+
+    class Meta:
+        model = Parent
+        registry = registry.get_global_registry()
+
+
+class Son(MongoengineObjectType):
+
+    class Meta:
+        model = Child
+        registry = registry.get_global_registry()
+
+
 def test_mongoengine_interface():
     assert issubclass(Node, Interface)
     assert issubclass(Node, Node)
@@ -41,13 +62,16 @@ def test_objecttype_registered():
         'first_name',
         'last_name',
         'email',
-        # FIXME
-        # 'embedded_articles',
+        'embedded_articles',
+        'embedded_list_articles',
         'articles',
         'awards'
     ])
 
 
+def test_mongoengine_inheritance():
+    assert issubclass(Son._meta.model, Dad._meta.model)
+
 def test_node_replacedfield():
     idfield = Human._meta.fields['pub_date']
     assert isinstance(idfield, Field)

graphene_mongo/tests/test_utils.py

@@ -5,14 +5,18 @@
 from ..utils import (
     get_model_fields, is_valid_mongoengine_model
 )
-from .models import Reporter
+from .models import Reporter, Child
 
 def test_get_model_fields_no_duplication():
     reporter_fields = get_model_fields(Reporter)
     reporter_name_set = set(reporter_fields)
     assert len(reporter_fields) == len(reporter_name_set)
 
 
+def test_get_base_model_fields():
+    child_fields = get_model_fields(Child)
+    assert all(field in set(child_fields) for field in ['bar', 'baz'])
+
 def test_is_valid_mongoengine_mode():
     assert is_valid_mongoengine_model(Reporter)
 

graphene_mongo/tests/types.py

@@ -1,7 +1,10 @@
 from graphene.relay import Node
 
 from ..types import MongoengineObjectType
-from .models import Article, Editor, EmbeddedArticle, Player, Reporter
+from .models import (
+    Article, Editor, EmbeddedArticle, Player, Reporter,
+    Parent, Child
+)
 
 
 class EditorType(MongoengineObjectType):
@@ -34,6 +37,18 @@ class Meta:
         model = Reporter
 
 
+class ParentType(MongoengineObjectType):
+
+    class Meta:
+        model = Parent
+
+
+class ChildType(MongoengineObjectType):
+
+    class Meta:
+        model = Child
+
+
 class ArticleNode(MongoengineObjectType):
 
     class Meta:
@@ -68,3 +83,15 @@ class Meta:
         model = Reporter
         interfaces = (Node,)
 
+
+class ParentNode(MongoengineObjectType):
+
+    class Meta:
+        model = Parent
+        interfaces = (Node,)
+
+
+class ChildNode(MongoengineObjectType):
+    class Meta:
+        model = Child
+        interfaces = (Node,)

graphene_mongo/utils.py

@@ -2,20 +2,16 @@
 import mongoengine
 
 from collections import OrderedDict
-from mongoengine.base.fields import BaseField
 
 
 def get_model_fields(model, excluding=None):
     if excluding is None:
         excluding = []
     attributes = dict()
-    for attr_name in vars(model):
+    for attr_name, attr in model._fields.items():
         if attr_name in excluding:
             continue
-        attr = getattr(model, attr_name)
-        if isinstance(attr, BaseField):
-            attributes[attr_name] = attr
-
+        attributes[attr_name] = attr
     return OrderedDict(sorted(attributes.items()))