Merge pull request #18 from graphql-python/feat-support-embedded-list-field

Feature: Support EmbeddedListField

Author: abawchen

examples/flask_mongoengine/app.py

@@ -17,10 +17,26 @@
           id,
           name
         },
-        role {
+        roles {
+          edges {
+            node {
+              id,
+              name
+            }
+          }
+        },
+        leader {
           id,
           name
         }
+        tasks {
+          edges {
+            node {
+              name,
+              deadline
+            }
+          }
+        }
       }
     }
   }

examples/flask_mongoengine/database.py

@@ -1,6 +1,6 @@
 from mongoengine import connect
 
-from models import Department, Employee, Role
+from models import Department, Employee, Role, Task
 
 connect('graphene-mongo-example', host='mongomock://localhost', alias='default')
 
@@ -19,12 +19,31 @@ def init_db():
     engineer = Role(name='engineer')
     engineer.save()
 
-    peter = Employee(name='Peter', department=engineering, role=engineer)
-    peter.save()
-
-    roy = Employee(name='Roy', department=engineering, role=engineer)
-    roy.save()
+    debug = Task(name='Debug')
+    test = Task(name='Test')
 
-    tracy = Employee(name='Tracy', department=hr, role=manager)
+    tracy = Employee(
+        name='Tracy',
+        department=hr,
+        roles=[engineer, manager],
+        tasks=[]
+    )
     tracy.save()
 
+    peter = Employee(
+        name='Peter',
+        department=engineering,
+        leader=tracy,
+        roles=[engineer],
+        tasks=[debug, test]
+    )
+    peter.save()
+
+    roy = Employee(
+        name='Roy',
+        department=engineering,
+        leader=tracy,
+        roles=[engineer],
+        tasks=[debug]
+    )
+    roy.save()

examples/flask_mongoengine/models.py

@@ -1,24 +1,35 @@
 from datetime import datetime
-from mongoengine import Document
+from mongoengine import Document, EmbeddedDocument
 from mongoengine.fields import (
-    DateTimeField, ReferenceField, StringField,
+    DateTimeField, EmbeddedDocumentField,
+    ListField, ReferenceField, StringField,
 )
 
 
 class Department(Document):
+
     meta = {'collection': 'department'}
     name = StringField()
 
 
 class Role(Document):
+
     meta = {'collection': 'role'}
     name = StringField()
 
 
+class Task(EmbeddedDocument):
+
+    name = StringField()
+    deadline = DateTimeField(default=datetime.now)
+
+
 class Employee(Document):
+
     meta = {'collection': 'employee'}
     name = StringField()
     hired_on = DateTimeField(default=datetime.now)
     department = ReferenceField(Department)
-    role = ReferenceField(Role)
-
+    roles = ListField(ReferenceField(Role))
+    leader = ReferenceField('Employee')
+    tasks = ListField(EmbeddedDocumentField(Task))

examples/flask_mongoengine/schema.py

@@ -4,6 +4,7 @@
 from models import Department as DepartmentModel
 from models import Employee as EmployeeModel
 from models import Role as RoleModel
+from models import Task as TaskModel
 
 class Department(MongoengineObjectType):
 
@@ -19,6 +20,12 @@ class Meta:
         interfaces = (Node,)
 
 
+class Task(MongoengineObjectType):
+
+    class Meta:
+        model = TaskModel
+        interfaces = (Node,)
+
 class Employee(MongoengineObjectType):
 
     class Meta:

graphene_mongo/converter.py

@@ -58,9 +58,9 @@ def convert_date_to_string(field, registry=None):
 
 
 @convert_mongoengine_field.register(mongoengine.ListField)
+@convert_mongoengine_field.register(mongoengine.EmbeddedDocumentListField)
 def convert_field_to_list(field, registry=None):
     base_type = convert_mongoengine_field(field.field, registry=registry)
-
     if isinstance(base_type, (Dynamic)):
         base_type = base_type.get_type()
         if base_type is None:

graphene_mongo/fields.py

@@ -86,6 +86,10 @@ def fields(self):
 
     @classmethod
     def get_query(cls, model, info, **args):
+
+        if not callable(getattr(model, 'objects', None)):
+            return []
+
         objs = model.objects()
 
         if args:

graphene_mongo/tests/fixtures.py

@@ -17,9 +17,9 @@ def setup_fixtures():
     article2.save()
 
     Reporter.drop_collection()
-    reporter = Reporter(id='1', first_name='Allen', last_name='Iverson',
+    reporter1 = Reporter(id='1', first_name='Allen', last_name='Iverson',
                         email='[email protected]',  awards=['2010-mvp'])
-    reporter.articles = [article1, article2]
+    reporter1.articles = [article1, article2]
     embedded_article1 = EmbeddedArticle(
         headline='Real',
         editor=editor1
@@ -28,8 +28,9 @@ def setup_fixtures():
         headline='World',
         editor=editor2
     )
-    reporter.embedded_articles = [embedded_article1, embedded_article2]
-    reporter.save()
+    reporter1.embedded_articles = [embedded_article1, embedded_article2]
+    reporter1.embedded_list_articles = [embedded_article2, embedded_article1]
+    reporter1.save()
 
     Player.drop_collection()
     player1 = Player(first_name='Michael', last_name='Jordan')

graphene_mongo/tests/models.py

@@ -3,7 +3,8 @@
     connect, Document, EmbeddedDocument
 )
 from mongoengine.fields import (
-    DateTimeField, EmailField, EmbeddedDocumentField, ListField,
+    DateTimeField, EmailField, EmbeddedDocumentField,
+    EmbeddedDocumentListField, ListField,
     MapField, ReferenceField, StringField
 )
 
@@ -52,6 +53,7 @@ class Reporter(Document):
     email = EmailField()
     articles = ListField(ReferenceField(Article))
     embedded_articles = ListField(EmbeddedDocumentField(EmbeddedArticle))
+    embedded_list_articles = EmbeddedDocumentListField(EmbeddedArticle)
     # FIXME
     # custom_map = MapField(field=StringField())
     awards = ListField(StringField())
@@ -63,3 +65,5 @@ class Player(Document):
     opponent = ReferenceField('Player')
     players = ListField(ReferenceField('Player'))
     articles = ListField(ReferenceField('Article'))
+    embedded_list_articles = EmbeddedDocumentListField(EmbeddedArticle)
+

graphene_mongo/tests/test_converter.py

@@ -116,6 +116,19 @@ class Meta:
     assert dynamic_field._of_type == E
 
 
+def test_should_embedded_list_convert_list():
+
+    class E(MongoengineObjectType):
+
+        class Meta:
+            model = EmbeddedArticle
+
+    graphene_field = convert_mongoengine_field(Reporter._fields['embedded_list_articles'], E._meta.registry)
+    assert isinstance(graphene_field, graphene.List)
+    dynamic_field = graphene_field.get_type()
+    assert dynamic_field._of_type == E
+
+
 def test_should_self_reference_convert_dynamic():
     class P(MongoengineObjectType):
 

graphene_mongo/tests/test_query.py

@@ -79,6 +79,9 @@ def resolve_reporter(self, *args, **kwargs):
                 embeddedArticles {
                     headline
                 },
+                embeddedListArticles {
+                    headline
+                },
                 awards
             }
         }
@@ -100,6 +103,14 @@ def resolve_reporter(self, *args, **kwargs):
                     'headline': 'World'
                 }
             ],
+            'embeddedListArticles': [
+                {
+                    'headline': 'World'
+                },
+                {
+                    'headline': 'Real'
+                }
+            ],
             'awards': ['2010-mvp']
         }
     }