Merge pull request #13 from graphql-python/feat-list-of-embedded-document

Feature: Support ListField(EmbeddedDocumentField)

Author: abawchen

README.md

@@ -73,12 +73,12 @@ To learn more check out the following [examples](examples/):
     - [x] Flask example
     - [ ] Django example
 - [ ] Filtering & Paging
-    - [x] Default filtering enabled with all model's attributes by equal comparison
-    - [x] Take first, or last n items
+    - [x] Default filtering enabled with all model's attributes by equal comparison (requester: [git-albertomarin](https://github.com/git-albertomarin))
+    - [x] Take first, or last n items (credit: [alexpantyukhin](https://github.com/alexpantyukhin))
     - [ ] Advanced filtering
 - [ ] Support more types
-    - [x] Self-reference and list-of-self-reference relationship
-    - [ ] List(EmbeddedDocument)
+    - [x] Self-reference and list-of-self-reference relationship (requester: [mehdiym](https://github.com/mehdiym))
+    - [x] ListField(EmbeddedDocumentField)
     - [ ] Others
 
 ## Contributing

graphene_mongo/converter.py

@@ -60,13 +60,22 @@ def convert_date_to_string(field, registry=None):
 @convert_mongoengine_field.register(mongoengine.ListField)
 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()._type
+        base_type = base_type.get_type()
+        if base_type is None:
+            return
+        base_type = base_type._type
+
     if is_node(base_type):
         return MongoengineConnectionField(base_type)
-    elif not isinstance(base_type, (List, NonNull)) \
-            and not isinstance(field.field, mongoengine.ReferenceField):
+
+    # Non-relationship field
+    relations = (mongoengine.ReferenceField, mongoengine.EmbeddedDocumentField)
+    if not isinstance(base_type, (List, NonNull)) \
+            and not isinstance(field.field, relations):
         base_type = type(base_type)
+
     return List(base_type, description=field.db_field, required=not field.null)
 
 

graphene_mongo/tests/fixtures.py

@@ -0,0 +1,46 @@
+from .models import Article, Editor, EmbeddedArticle, Player, Reporter
+
+
+def setup_fixtures():
+    Editor.drop_collection()
+    editor1 = Editor(first_name='Penny', last_name='Hardaway')
+    editor1.save()
+    editor2 = Editor(first_name='Grant', last_name='Hill')
+    editor2.save()
+    editor3 = Editor(first_name='Dennis', last_name='Rodman')
+    editor3.save()
+
+    Article.drop_collection()
+    article1 = Article(headline='Hello', editor=editor1)
+    article1.save()
+    article2 = Article(headline='World', editor=editor2)
+    article2.save()
+
+    Reporter.drop_collection()
+    reporter = Reporter(first_name='Allen', last_name='Iverson',
+                        email='[email protected]',  awards=['2010-mvp'])
+    reporter.articles = [article1, article2]
+    embedded_article1 = EmbeddedArticle(
+        headline='Real',
+        editor=editor1
+    )
+    embedded_article2 = EmbeddedArticle(
+        headline='World',
+        editor=editor2
+    )
+    reporter.embedded_articles = [embedded_article1, embedded_article2]
+    reporter.save()
+
+    Player.drop_collection()
+    player1 = Player(first_name='Michael', last_name='Jordan')
+    player1.save()
+    player2 = Player(first_name='Magic', last_name='Johnson', opponent=player1)
+    player2.save()
+    player3 = Player(first_name='Larry', last_name='Bird', players=[player1, player2])
+    player3.save()
+
+    player1.players = [player2]
+    player1.save()
+
+    player2.players = [player1]
+    player2.save()

graphene_mongo/tests/models.py

@@ -49,8 +49,7 @@ class Reporter(Document):
     last_name = StringField(required=True)
     email = EmailField()
     articles = ListField(ReferenceField(Article))
-    # FIXME
-    # embedded_articles = ListField(EmbeddedDocumentField(EmbeddedArticle))
+    embedded_articles = ListField(EmbeddedDocumentField(EmbeddedArticle))
     # FIXME
     # custom_map = MapField(field=StringField())
     awards = ListField(StringField())

graphene_mongo/tests/test_converter.py

@@ -75,7 +75,7 @@ def test_should_field_convert_list():
     assert_conversion(mongoengine.ListField, graphene.List, field=mongoengine.StringField())
 
 
-def test_should_reference_convert_dynamic():
+def test_should_embedded_convert_dynamic():
 
     class E(MongoengineObjectType):
 
@@ -90,7 +90,7 @@ class Meta:
     assert graphene_type.type == E
 
 
-def test_should_one2many_convert_list():
+def test_should_list_of_reference_convert_list():
 
     class A(MongoengineObjectType):
 
@@ -102,8 +102,21 @@ class Meta:
     dynamic_field = graphene_field.get_type()
     assert dynamic_field._of_type == A
 
+
+def test_should_list_of_embedded_convert_list():
+
+    class E(MongoengineObjectType):
+
+        class Meta:
+            model = EmbeddedArticle
+
+    graphene_field = convert_mongoengine_field(Reporter._fields['embedded_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():
-    # pass
     class P(MongoengineObjectType):
 
         class Meta: