Support polymorphic models (from django-polymorphic and django-typed-models)

Author: leo-naeka

example/factories/__init__.py

@@ -3,37 +3,39 @@
 
 import factory
 from faker import Factory as FakerFactory
-from example.models import Blog, Author, AuthorBio, Entry, Comment
+from example import models
+
 
 faker = FakerFactory.create()
 faker.seed(983843)
 
+
 class BlogFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = Blog
+        model = models.Blog
 
     name = factory.LazyAttribute(lambda x: faker.name())
 
 
 class AuthorFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = Author
+        model = models.Author
 
     name = factory.LazyAttribute(lambda x: faker.name())
     email = factory.LazyAttribute(lambda x: faker.email())
 
 
 class AuthorBioFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = AuthorBio
+        model = models.AuthorBio
 
     author = factory.SubFactory(AuthorFactory)
     body = factory.LazyAttribute(lambda x: faker.text())
 
 
 class EntryFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = Entry
+        model = models.Entry
 
     headline = factory.LazyAttribute(lambda x: faker.sentence(nb_words=4))
     body_text = factory.LazyAttribute(lambda x: faker.text())
@@ -52,9 +54,40 @@ def authors(self, create, extracted, **kwargs):
 
 class CommentFactory(factory.django.DjangoModelFactory):
     class Meta:
-        model = Comment
+        model = models.Comment
 
     entry = factory.SubFactory(EntryFactory)
     body = factory.LazyAttribute(lambda x: faker.text())
     author = factory.SubFactory(AuthorFactory)
 
+
+class ArtProjectFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = models.ArtProject
+
+    topic = factory.LazyAttribute(lambda x: faker.catch_phrase())
+    artist = factory.LazyAttribute(lambda x: faker.name())
+
+
+class ResearchProjectFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = models.ResearchProject
+
+    topic = factory.LazyAttribute(lambda x: faker.catch_phrase())
+    supervisor = factory.LazyAttribute(lambda x: faker.name())
+
+
+class CompanyFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = models.Company
+
+    name = factory.LazyAttribute(lambda x: faker.company())
+    current_project = factory.SubFactory(ArtProjectFactory)
+
+    @factory.post_generation
+    def future_projects(self, create, extracted, **kwargs):
+        if not create:
+            return
+        if extracted:
+            for project in extracted:
+                self.future_projects.add(project)

example/models.py

@@ -3,6 +3,7 @@
 
 from django.db import models
 from django.utils.encoding import python_2_unicode_compatible
+from polymorphic.models import PolymorphicModel
 
 
 class BaseModel(models.Model):
@@ -72,3 +73,24 @@ class Comment(BaseModel):
     def __str__(self):
         return self.body
 
+
+class Project(PolymorphicModel):
+    topic = models.CharField(max_length=30)
+
+
+class ArtProject(Project):
+    artist = models.CharField(max_length=30)
+
+
+class ResearchProject(Project):
+    supervisor = models.CharField(max_length=30)
+
+
+@python_2_unicode_compatible
+class Company(models.Model):
+    name = models.CharField(max_length=100)
+    current_project = models.ForeignKey(Project, related_name='companies')
+    future_projects = models.ManyToManyField(Project)
+
+    def __str__(self):
+        return self.name

example/serializers.py

@@ -1,6 +1,6 @@
 from datetime import datetime
 from rest_framework_json_api import serializers, relations
-from example.models import Blog, Entry, Author, AuthorBio, Comment
+from example import models
 
 
 class BlogSerializer(serializers.ModelSerializer):
@@ -12,11 +12,11 @@ def get_copyright(self, obj):
 
     def get_root_meta(self, obj):
         return {
-          'api_docs': '/docs/api/blogs'
+            'api_docs': '/docs/api/blogs'
         }
 
     class Meta:
-        model = Blog
+        model = models.Blog
         fields = ('name', )
         meta_fields = ('copyright',)
 
@@ -38,18 +38,18 @@ def __init__(self, *args, **kwargs):
 
     body_format = serializers.SerializerMethodField()
     comments = relations.ResourceRelatedField(
-            source='comment_set', many=True, read_only=True)
+        source='comment_set', many=True, read_only=True)
     suggested = relations.SerializerMethodResourceRelatedField(
-            source='get_suggested', model=Entry, read_only=True)
+        source='get_suggested', model=models.Entry, read_only=True)
 
     def get_suggested(self, obj):
-        return Entry.objects.exclude(pk=obj.pk).first()
+        return models.Entry.objects.exclude(pk=obj.pk).first()
 
     def get_body_format(self, obj):
         return 'text'
 
     class Meta:
-        model = Entry
+        model = models.Entry
         fields = ('blog', 'headline', 'body_text', 'pub_date', 'mod_date',
                   'authors', 'comments', 'suggested',)
         meta_fields = ('body_format',)
@@ -58,7 +58,7 @@ class Meta:
 class AuthorBioSerializer(serializers.ModelSerializer):
 
     class Meta:
-        model = AuthorBio
+        model = models.AuthorBio
         fields = ('author', 'body',)
 
 
@@ -68,13 +68,52 @@ class AuthorSerializer(serializers.ModelSerializer):
     }
 
     class Meta:
-        model = Author
+        model = models.Author
         fields = ('name', 'email', 'bio')
 
 
 class CommentSerializer(serializers.ModelSerializer):
 
     class Meta:
-        model = Comment
+        model = models.Comment
         exclude = ('created_at', 'modified_at',)
         # fields = ('entry', 'body', 'author',)
+
+
+class ArtProjectSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = models.ArtProject
+        exclude = ('polymorphic_ctype',)
+
+
+class ResearchProjectSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = models.ResearchProject
+        exclude = ('polymorphic_ctype',)
+
+
+class ProjectSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = models.Project
+        exclude = ('polymorphic_ctype',)
+
+    def to_representation(self, instance):
+        # Handle polymorphism
+        if isinstance(instance, models.ArtProject):
+            return ArtProjectSerializer(
+                instance, context=self.context).to_representation(instance)
+        elif isinstance(instance, models.ResearchProject):
+            return ResearchProjectSerializer(
+                instance, context=self.context).to_representation(instance)
+        return super(ProjectSerializer, self).to_representation(instance)
+
+
+class CompanySerializer(serializers.ModelSerializer):
+    included_serializers = {
+        'current_project': ProjectSerializer,
+        'future_projects': ProjectSerializer,
+    }
+
+    class Meta:
+        model = models.Company

example/settings/dev.py

@@ -23,6 +23,7 @@
     'django.contrib.auth',
     'django.contrib.admin',
     'rest_framework',
+    'polymorphic',
     'example',
 ]
 

example/tests/conftest.py

@@ -1,13 +1,16 @@
 import pytest
 from pytest_factoryboy import register
 
-from example.factories import BlogFactory, AuthorFactory, AuthorBioFactory, EntryFactory, CommentFactory
+from example import factories
 
-register(BlogFactory)
-register(AuthorFactory)
-register(AuthorBioFactory)
-register(EntryFactory)
-register(CommentFactory)
+register(factories.BlogFactory)
+register(factories.AuthorFactory)
+register(factories.AuthorBioFactory)
+register(factories.EntryFactory)
+register(factories.CommentFactory)
+register(factories.ArtProjectFactory)
+register(factories.ResearchProjectFactory)
+register(factories.CompanyFactory)
 
 
 @pytest.fixture
@@ -29,3 +32,13 @@ def multiple_entries(blog_factory, author_factory, entry_factory, comment_factor
     comment_factory(entry=entries[1])
     return entries
 
+
+@pytest.fixture
+def single_company(art_project_factory, research_project_factory, company_factory):
+    company = company_factory(future_projects=(research_project_factory(), art_project_factory()))
+    return company
+
+
+@pytest.fixture
+def single_art_project(art_project_factory):
+    return art_project_factory()

example/tests/integration/test_polymorphism.py

@@ -0,0 +1,31 @@
+import pytest
+from django.core.urlresolvers import reverse
+
+from example.tests.utils import load_json
+
+pytestmark = pytest.mark.django_db
+
+
+def test_polymorphism_on_detail(single_art_project, client):
+    response = client.get(reverse("project-detail", kwargs={'pk': single_art_project.pk}))
+    content = load_json(response.content)
+    assert content["data"]["type"] == "artProjects"
+
+
+def test_polymorphism_on_detail_relations(single_company, client):
+    response = client.get(reverse("company-detail", kwargs={'pk': single_company.pk}))
+    content = load_json(response.content)
+    assert content["data"]["relationships"]["currentProject"]["data"]["type"] == "artProjects"
+    assert [rel["type"] for rel in content["data"]["relationships"]["futureProjects"]["data"]] == [
+        "researchProjects", "artProjects"]
+
+
+def test_polymorphism_on_included_relations(single_company, client):
+    response = client.get(reverse("company-detail", kwargs={'pk': single_company.pk}) +
+                          '?include=current_project,future_projects')
+    content = load_json(response.content)
+    assert content["data"]["relationships"]["currentProject"]["data"]["type"] == "artProjects"
+    assert [rel["type"] for rel in content["data"]["relationships"]["futureProjects"]["data"]] == [
+        "researchProjects", "artProjects"]
+    assert [x.get('type') for x in content.get('included')] == ['artProjects', 'artProjects', 'researchProjects'], \
+        'Detail included types are incorrect'

example/urls.py

@@ -1,14 +1,17 @@
 from django.conf.urls import include, url
 from rest_framework import routers
 
-from example.views import BlogViewSet, EntryViewSet, AuthorViewSet, CommentViewSet
+from example.views import (
+    BlogViewSet, EntryViewSet, AuthorViewSet, CommentViewSet, CompanyViewset, ProjectViewset)
 
 router = routers.DefaultRouter(trailing_slash=False)
 
 router.register(r'blogs', BlogViewSet)
 router.register(r'entries', EntryViewSet)
 router.register(r'authors', AuthorViewSet)
 router.register(r'comments', CommentViewSet)
+router.register(r'companies', CompanyViewset)
+router.register(r'projects', ProjectViewset)
 
 urlpatterns = [
     url(r'^', include(router.urls)),

example/urls_test.py

@@ -1,8 +1,9 @@
 from django.conf.urls import include, url
 from rest_framework import routers
 
-from example.views import BlogViewSet, EntryViewSet, AuthorViewSet, CommentViewSet, EntryRelationshipView, BlogRelationshipView, \
-    CommentRelationshipView, AuthorRelationshipView
+from example.views import (
+    BlogViewSet, EntryViewSet, AuthorViewSet, CommentViewSet, CompanyViewset, ProjectViewset,
+    EntryRelationshipView, BlogRelationshipView, CommentRelationshipView, AuthorRelationshipView)
 from .api.resources.identity import Identity, GenericIdentity
 
 router = routers.DefaultRouter(trailing_slash=False)
@@ -11,6 +12,8 @@
 router.register(r'entries', EntryViewSet)
 router.register(r'authors', AuthorViewSet)
 router.register(r'comments', CommentViewSet)
+router.register(r'companies', CompanyViewset)
+router.register(r'projects', ProjectViewset)
 
 # for the old tests
 router.register(r'identities', Identity)
@@ -36,4 +39,3 @@
         AuthorRelationshipView.as_view(),
         name='author-relationships'),
 ]
-

example/views.py

@@ -1,8 +1,9 @@
 from rest_framework import viewsets
 from rest_framework_json_api.views import RelationshipView
-from example.models import Blog, Entry, Author, Comment
+from example.models import Blog, Entry, Author, Comment, Company, Project
 from example.serializers import (
-    BlogSerializer, EntrySerializer, AuthorSerializer, CommentSerializer)
+    BlogSerializer, EntrySerializer, AuthorSerializer, CommentSerializer, CompanySerializer,
+    ProjectSerializer)
 
 
 class BlogViewSet(viewsets.ModelViewSet):
@@ -26,6 +27,16 @@ class CommentViewSet(viewsets.ModelViewSet):
     serializer_class = CommentSerializer
 
 
+class CompanyViewset(viewsets.ModelViewSet):
+    queryset = Company.objects.all()
+    serializer_class = CompanySerializer
+
+
+class ProjectViewset(viewsets.ModelViewSet):
+    queryset = Project.objects.all()
+    serializer_class = ProjectSerializer
+
+
 class EntryRelationshipView(RelationshipView):
     queryset = Entry.objects.all()
 

requirements-development.txt

@@ -3,4 +3,5 @@ pytest==2.8.2
 pytest-django
 pytest-factoryboy
 fake-factory
+django-polymorphic
 tox