version 0.7.1: support for creating foreign key linked objects

Mirek Simek · Mirek Simek · commit 4d29d87833c6 · 2018-03-03T18:22:47.000+01:00
diff --git a/angular/package-dist.json b/angular/package-dist.json
@@ -1,6 +1,6 @@
 {
     "name": "django-angular-dynamic-forms",
-    "version": "0.6.12",
+    "version": "0.7.1",
     "license": "MIT",
     "description": "Django Rest Framework meets Angular 5 material.io dynamic forms - automatic create and edit dialogs",
     "typings": "./django-angular-dynamic-forms.d.ts",
diff --git a/angular/package.json b/angular/package.json
@@ -1,6 +1,6 @@
 {
     "name": "django-angular-dynamic-forms",
-    "version": "0.6.12",
+    "version": "0.7.1",
     "license": "MIT",
     "description": "Django Rest Framework meets Angular 5 material.io dynamic forms - rapid development of create and edit dialogs",
     "typings": "./django-angular-dynamic-forms.d.ts",
diff --git a/angular_dynamic_forms/__init__.py b/angular_dynamic_forms/__init__.py
@@ -1,12 +1,15 @@
 from .autocomplete import AutoCompleteMixin, autocomplete
 from .rest import AngularFormMixin
 from .foreign_key import foreign_field_autocomplete, ForeignFieldAutoCompleteMixin, M2MEnabledMetadata
+from .linked_form import linked_form, linked_forms
 
 __all__ = [
     AutoCompleteMixin,
     AngularFormMixin,
     autocomplete,
     foreign_field_autocomplete,
     ForeignFieldAutoCompleteMixin,
-    M2MEnabledMetadata
+    M2MEnabledMetadata,
+    linked_form,
+    linked_forms
 ]
diff --git a/angular_dynamic_forms/linked_form.py b/angular_dynamic_forms/linked_form.py
@@ -0,0 +1,60 @@
+from rest_framework.decorators import detail_route
+from rest_framework.relations import PrimaryKeyRelatedField
+
+
+def linked_form(viewset, form_id=None, link=None, method='create'):
+    """
+    When having foreign key or m2m relationships between models A and B (B has foreign key to A named parent),
+    we want to have a form that sits on A's viewset but creates/edits B and sets it relationship to A
+    automatically.
+
+    In order to do so, define linked_forms on A's viewset containing a call to linked_form as follows:
+
+    @linked_forms()
+    class AViewSet(AngularFormMixin, ...):
+        linked_forms = {
+            'new-b': linked_form(BViewSet, link='parent')
+        }
+
+    Then, there will be a form definition on <aviewset>/pk/forms/new-b, with POST/PATCH operations pointing
+    to an automatically created endpoint <aviewset>/pk/linked-endpoint/new-b and detail-route named "new_b"
+
+    :param viewset:     the foreign viewset
+    :param form_id:     id of the form on the foreign viewset. If unset, use the default form
+    :param link:        either a field name on the foreign viewset or a callable that will get (foreign_instance, this_instance)
+    :return:            an internal definition of a linked form
+    """
+    return {
+        'viewset' : viewset,
+        'form_id' : form_id,
+        'link'    : link,
+        'method'  : method
+    }
+
+
+def linked_forms():
+    def build_form(clz, form_name, form_def):
+        def form_method(self, request, pk, *args, **kwargs):
+            viewset = form_def['viewset']()
+            viewset.request = request
+            viewset.format_kwarg = self.format_kwarg
+            link = form_def['link']
+            if isinstance(link, str):
+                serializer = viewset.get_serializer()
+                fld = serializer.fields[link]
+                if isinstance(fld, PrimaryKeyRelatedField):
+                    request.data[link] = self.get_object().pk
+                else:
+                    request.data[link] = self.get_object()
+            return getattr(viewset, form_def['method'])(request, *args, **kwargs)
+
+        setattr(clz, form_name.replace('-', '_'),
+                detail_route(methods=['get', 'post', 'patch'], url_path=form_name)(form_method))
+
+    def wrapper(clz):
+        forms = getattr(clz, 'linked_forms', {})
+        if forms:
+            for form_name, form_def in forms.items():
+                build_form(clz, form_name, form_def)
+        return clz
+    return wrapper
diff --git a/angular_dynamic_forms/rest.py b/angular_dynamic_forms/rest.py
@@ -1,9 +1,10 @@
 # noinspection PyUnresolvedReferences
 import inspect
+import re
 
 from django.core.exceptions import FieldDoesNotExist
 from django.db.models import TextField
-from django.http import HttpResponseNotFound
+from django.http import HttpResponseNotFound, Http404
 from django.utils.translation import gettext
 from rest_framework import renderers
 from rest_framework.decorators import detail_route, list_route
@@ -60,6 +61,12 @@ class AngularFormMixin(object):
     form_titles   = {}
     form_defaults_map = {}
 
+    """
+    A map of linked forms, i.e. forms defined on other viewsets linked by foreign key or m2m. See @linked_forms
+    decorator and linked_form(...) call for details. 
+    """
+    linked_forms = {}
+
     @staticmethod
     def fieldset(title, controls):
         """
@@ -104,22 +111,22 @@ def group(*controls):
     # noinspection PyUnusedLocal
     @detail_route(renderer_classes=[renderers.JSONRenderer], url_path='form')
     def form(self, request, *args, **kwargs):
-        return self._get_form_metadata(has_instance=True)
+        return Response(self._get_form_metadata(has_instance=True))
 
     # noinspection PyUnusedLocal
     @list_route(renderer_classes=[renderers.JSONRenderer], url_path='form')
     def form_list(self, request, *args, **kwargs):
-        return self._get_form_metadata(has_instance=False)
+        return Response(self._get_form_metadata(has_instance=False))
 
     # noinspection PyUnusedLocal
     @detail_route(renderer_classes=[renderers.JSONRenderer], url_path='form/(?P<form_name>.+)')
     def form_with_name(self, request, *args, form_name=None, **kwargs):
-        return self._get_form_metadata(has_instance=True, form_name =form_name or '')
+        return Response(self._get_form_metadata(has_instance=True, form_name =form_name or ''))
 
     # noinspection PyUnusedLocal
     @list_route(renderer_classes=[renderers.JSONRenderer], url_path='form/(?P<form_name>.+)')
     def form_list_with_name(self, request, *args, form_name=None, **kwargs):
-        return self._get_form_metadata(has_instance=False, form_name =form_name or '')
+        return Response(self._get_form_metadata(has_instance=False, form_name =form_name or ''))
 
     #
     # the rest of the methods on this class are private ones
@@ -272,12 +279,16 @@ def _get_actions(self, has_instance, serializer):
     def _get_form_metadata(self, has_instance, form_name=''):
 
         if form_name:
+
+            if form_name in self.linked_forms:
+                return self._linked_form_metadata(form_name)
+
             if not self.form_layouts:
-                return HttpResponseNotFound('Form layouts not configured. '
+                raise Http404('Form layouts not configured. '
                                             'Please add form_layouts attribute on the viewset class')
 
             if form_name not in self.form_layouts:
-                return HttpResponseNotFound('Form with name %s not found' % form_name)
+                raise Http404('Form with name %s not found' % form_name)
 
         ret = {}
 
@@ -301,8 +312,21 @@ def _get_form_metadata(self, has_instance, form_name=''):
         ret['hasInitialData'] = has_instance
 
         # print(json.dumps(ret, indent=4))
+        return ret
 
-        return Response(ret)
+    def _linked_form_metadata(self, form_name):
+        form_def = self.linked_forms[form_name]
+        viewset = form_def['viewset']()
+        viewset.request = self.request
+        viewset.format_kwarg = self.format_kwarg
+        ret = viewset._get_form_metadata(False, form_name=form_def['form_id'])
+
+        path = self.request.path
+        # must be called from /form/ ...
+        path = re.sub(r'/form(/[^/]+)?/?$', '', path)
+
+        ret['djangoUrl'] = '%s/%s/' % (path, form_name)
+        return ret
 
     # @LoggerDecorator.log()
     def _decorate_layout(self, layout, fields_info):
@@ -340,3 +364,5 @@ def _decorate_layout_item(self, item):
 def camel(snake_str):
     first, *others = snake_str.split('_')
     return ''.join([first.lower(), *map(str.title, others)])
+
+
diff --git a/demo/angular/package.json b/demo/angular/package.json
@@ -1,6 +1,6 @@
 {
     "name": "django-angular-dynamic-forms-demo",
-    "version": "0.6.12",
+    "version": "0.7.1",
     "license": "MIT",
     "scripts": {
         "ng": "ng",
diff --git a/demo/angular/src/app/app-routing.module.ts b/demo/angular/src/app/app-routing.module.ts
@@ -13,6 +13,7 @@ import {CreateViaDialogMultipleFormsComponent} from './create-via-dialog-multipl
 import {CreateInPageMultipleFormsComponent} from './create-in-page-multiple-forms/create-in-page-multiple-forms.component';
 import {AllControlsComponent} from './all-controls/all-controls.component';
 import {ForeignComponent} from './foreign/foreign.component';
+import {CreateForeignComponent} from './create-foreign/create-foreign.component';
 
 const routes: Routes = [
     {
@@ -65,6 +66,11 @@ const routes: Routes = [
         pathMatch: 'full',
         component: ForeignComponent
     },
+    {
+        path: 'create-foreign',
+        pathMatch: 'full',
+        component: CreateForeignComponent
+    },
     {
         path: 'edit-in-page',
         pathMatch: 'prefix',
diff --git a/demo/angular/src/app/app.component.ts b/demo/angular/src/app/app.component.ts
@@ -57,6 +57,7 @@ import {environment} from '../environments/environment';
                             </mat-expansion-panel-header>
                             <a routerLink="/foreign">Foreign Key</a>
                             <a routerLink="/all-controls">m2m in All available controls and layout demo</a>
+                            <a routerLink="/create-foreign">Create a new instance of referenced object</a>
                         </mat-expansion-panel>
                         <mat-expansion-panel>
                             <mat-expansion-panel-header>
diff --git a/demo/angular/src/app/app.module.ts b/demo/angular/src/app/app.module.ts
@@ -43,6 +43,7 @@ import {FormsModule, ReactiveFormsModule} from '@angular/forms';
 import {ForeignSelectorFactoryService} from './all-controls/foreign-selector-factory.service';
 import {ForeignSelectorComponent} from './all-controls/foreign-selector.component';
 import {TagSelectorComponent} from './all-controls/tag-selector.component';
+import { CreateForeignComponent } from './create-foreign/create-foreign.component';
 
 
 @Injectable()
@@ -76,7 +77,8 @@ export class SimpleForeignFieldFormatter implements ForeignFieldFormatter {
         ForeignComponent,
         SampleForeignSelectorComponent,
         ForeignSelectorComponent,
-        TagSelectorComponent
+        TagSelectorComponent,
+        CreateForeignComponent
     ],
     imports: [
         BrowserAnimationsModule,
@@ -101,7 +103,7 @@ export class SimpleForeignFieldFormatter implements ForeignFieldFormatter {
         MatSortModule,
         MatSliderModule,
         MatSlideToggleModule,
-        FormsModule
+        FormsModule,
     ],
     providers: [
         {
diff --git a/demo/angular/src/app/edit-via-dialog/edit-via-dialog.component.ts b/demo/angular/src/app/edit-via-dialog/edit-via-dialog.component.ts
@@ -161,7 +161,7 @@ urlpatterns = [
             .catch(err => this.errors.showCommunicationError(err))
             .subscribe(resp => {
                 this.data = new MatTableDataSource(resp);
-            })
+            });
     }
 
     edit(id: string) {
diff --git a/demo/django/api/management/commands/demo_initial_data.py b/demo/django/api/management/commands/demo_initial_data.py
@@ -1,6 +1,6 @@
 from django.core.management import BaseCommand
 
-from api.models import City, Tag, TestModel
+from api.models import City, Tag, TestModel, Company
 
 
 class Command(BaseCommand):
@@ -31,4 +31,6 @@ def handle(self, *args, **options):
             foreign_key = c1
         )
         tm.tags.set([t1, t2])
-        tm.save()
+        tm.save()
+
+        company = Company.objects.create(name='UCT Prague')
diff --git a/demo/django/api/migrations/0010_auto_20180303_1332.py b/demo/django/api/migrations/0010_auto_20180303_1332.py
@@ -0,0 +1,35 @@
+# Generated by Django 2.0.2 on 2018-03-03 13:32
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0009_auto_20180222_1028'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Company',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=100)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Contact',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=100)),
+                ('email', models.CharField(max_length=100)),
+                ('company', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='contacts', to='api.Company')),
+            ],
+        ),
+        migrations.AlterField(
+            model_name='testmodel',
+            name='tags',
+            field=models.ManyToManyField(blank=True, related_name='_testmodel_tags_+', to='api.Tag', verbose_name='Tags (many to many field)'),
+        ),
+    ]
diff --git a/demo/django/api/models.py b/demo/django/api/models.py
@@ -42,3 +42,12 @@ class TestModel(models.Model):
     foreign_key = models.ForeignKey(City, null=True, blank=True, on_delete=models.CASCADE, related_name='+')
     tags = models.ManyToManyField(Tag, related_name='+', blank=True, verbose_name='Tags (many to many field)')
 
+
+class Company(models.Model):
+    name = models.CharField(max_length=100)
+
+
+class Contact(models.Model):
+    company = models.ForeignKey(Company, on_delete=models.CASCADE, related_name='contacts')
+    name = models.CharField(max_length=100)
+    email = models.EmailField(max_length=100)
diff --git a/demo/django/api/v_1/rest.py b/demo/django/api/v_1/rest.py
@@ -1,9 +1,10 @@
 from rest_framework import viewsets, permissions, serializers
+from rest_framework.viewsets import ModelViewSet
 
 from angular_dynamic_forms.foreign_key import ForeignSerializerMixin
-from api.models import City, TestModel, Address, Tag
+from api.models import City, TestModel, Address, Tag, Contact, Company
 from angular_dynamic_forms import AngularFormMixin, AutoCompleteMixin, autocomplete, \
-    foreign_field_autocomplete, ForeignFieldAutoCompleteMixin
+    foreign_field_autocomplete, ForeignFieldAutoCompleteMixin, linked_forms, linked_form
 
 
 class CitySerializer(ForeignSerializerMixin, serializers.ModelSerializer):
@@ -41,6 +42,11 @@ class Meta:
         exclude = ()
 
 
+class TagViewSet(AngularFormMixin, ModelViewSet):
+    queryset = Tag.objects.all()
+    serializer_class = TagSerializer
+
+
 class TestModelViewSet(ForeignFieldAutoCompleteMixin, AutoCompleteMixin, AngularFormMixin, viewsets.ModelViewSet):
     """
     API for TestModel
@@ -117,3 +123,35 @@ def city_autocomplete(self, request):
         if query:
             qs = qs.filter(name__icontains=query)
         return qs
+
+
+class ContactSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Contact
+        exclude = ()
+
+
+class ContactViewSet(AngularFormMixin, viewsets.ModelViewSet):
+    queryset = Contact.objects.all()
+    serializer_class = ContactSerializer
+    form_layout = (
+        'name', 'email'
+    )
+
+
+class CompanySerializer(serializers.ModelSerializer):
+
+    contacts = ContactSerializer(many=True)
+
+    class Meta:
+        model = Company
+        exclude = ()
+
+
+@linked_forms()
+class CompanyViewSet(AngularFormMixin, viewsets.ModelViewSet):
+    queryset = Company.objects.all()
+    serializer_class = CompanySerializer
+    linked_forms = {
+        'contact': linked_form(ContactViewSet, link='company')
+    }
diff --git a/demo/django/api/v_1/urls.py b/demo/django/api/v_1/urls.py
diff --git a/demo/django/setup.py b/demo/django/setup.py
diff --git a/setup.py b/setup.py

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "django-angular-dynamic-forms",`
`3`		`- "version": "0.6.12",`
	`3`	`+ "version": "0.7.1",`
`4`	`4`	`"license": "MIT",`
`5`	`5`	`"description": "Django Rest Framework meets Angular 5 material.io dynamic forms - automatic create and edit dialogs",`
`6`	`6`	`"typings": "./django-angular-dynamic-forms.d.ts",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "django-angular-dynamic-forms-demo",`
`3`		`- "version": "0.6.12",`
	`3`	`+ "version": "0.7.1",`
`4`	`4`	`"license": "MIT",`
`5`	`5`	`"scripts": {`
`6`	`6`	`"ng": "ng",`
Original file line number	Diff line number	Diff line change
`@@ -161,7 +161,7 @@ urlpatterns = [`
`161`	`161`	`.catch(err => this.errors.showCommunicationError(err))`
`162`	`162`	`.subscribe(resp => {`
`163`	`163`	`this.data = new MatTableDataSource(resp);`
`164`		`- })`
	`164`	`+ });`
`165`	`165`	`}`
`166`	`166`
`167`	`167`	`edit(id: string) {`