Close issue #5

Author: Grzegorz Tężycki

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG for django-popup-view-field
 
+## 0.4.0 (2018-10-04)
+
+* Added `callback_data` attribute to PopupViewField (read more in README)
+
 ## 0.3.0 (2017-03-07)
 
 * Support for Django 1.11

README.rst

@@ -340,10 +340,49 @@ Create typical FormView
     </form>
 
 
+callback_data attribute
+------------------------
+If you want pass extra parameters to your popup view, you should use `callback_data`
+attribute for PopupViewField. This argument should be dictionary or OrderedDict.
+This dictionary containing yours parameters will be encoded to ASCII text string and
+added to url address. In your popup view You can take this parameters from `request.GET`.
+
+*popups.py* ::
+
+    from django.views.generic import View
+    from django_popup_view_field.registry import registry_popup_view
+
+    class FooPopupView(View):
+        def get(self, request):
+            print(request.GET['extra_param'])  # --> will be "Foo Bar"
+            print(request.GET['my_pk'])        # --> will be 666
+            ....
+
+    # REGISTER IS IMPORTANT
+    registry_popup_view.register(FooPopupView)
+
+*forms.py* ::
+
+    from django import forms
+    from django_popup_view_field.fields import PopupViewField
+
+    class FooForm(forms.Form):
+
+        some_field = PopupViewField(
+            view_class=FooPopupView,
+            callback_data={
+                'extra_param': 'Foo Bar',
+                'my_pk': 666
+            }
+        )
+
+
+
 Advanced Example
 ------------------------
 
-Advanced Example use django-bootstrap3. Dialog is interactive, all links and forms will be send via Ajax and response will be loaded in dialog.
+Advanced Example use django-bootstrap3.
+Dialog is interactive, all links and forms will be send via Ajax and response will be loaded in dialog.
 
 .. image:: https://raw.githubusercontent.com/djk2/django-popup-view-field/master/doc/static/advanced_example.png
     :alt: Advanced Example - screenshot
@@ -371,7 +410,7 @@ PopupView
         Reverse order
     </a>
 
-*popups.py* ::
+**popups.py* ::
 
     from django.views.generic import TemplateView
     from django_popup_view_field.registry import registry_popup_view

demo/db.sqlite3

@@ -3,8 +3,7 @@
 
 from django_popup_view_field.fields import PopupViewField
 
-from .popups import ColorPopupView, CountryPopupView, SexPopupView, SelectionReasonPopUpViews
-from .models import APReview
+from .popups import ColorPopupView, CountryPopupView, SexPopupView
 
 
 class DemoForm(forms.Form):
@@ -26,19 +25,3 @@ class DemoForm(forms.Form):
     def __init__(self, *args, **kwargs):
         super(DemoForm, self).__init__(*args, **kwargs)
         self.helper = FormHelper()
-
-class APReviewForm(forms.ModelForm):
-    class Meta:
-        model=APReview
-        fields=['rating', 'selectionReason', ]
-
-    def __init__(self, *args, **kwargs):
-        super(APReviewForm, self).__init__(*args, **kwargs)
-        self.helper = FormHelper()
-        self.fields['selectionReason']=PopupViewField(
-            view_class=SelectionReasonPopUpViews,
-            popup_dialog_title="Please select a reason for",
-            callback_data={'my_id':'APid_1', 'other_param': 'xxx'},
-            required=True,
-
-        )

demo/demo/forms.py

@@ -4,22 +4,3 @@
 class Country(models.Model):
     code = models.CharField(max_length=2, primary_key=True)
     name = models.CharField(max_length=256)
-
-
-class AP(models.Model):
-    name=models.CharField(max_length=200)
-    APid=models.CharField(max_length=200)
-    description1= models.CharField(max_length=200)
-    description2= models.CharField(max_length=200)
-    description3= models.CharField(max_length=200)
-
-
-RATING_CHOICES = (
-    (1, 1),
-    (2, 2)
-)
-
-class APReview(models.Model):
-    atPat=models.ForeignKey(AP, on_delete=models.CASCADE)
-    rating = models.IntegerField(choices=RATING_CHOICES)
-    selectionReason=models.CharField(max_length=200)

demo/demo/migrations/0002_ap_apreview.py

@@ -2,11 +2,11 @@
 
 from django import forms
 from django.http import HttpResponse
-from django.views.generic import FormView, TemplateView, DetailView
-from django.shortcuts import get_object_or_404
+from django.views.generic import FormView, TemplateView
+
 from django_popup_view_field.registry import registry_popup_view
 
-from .models import Country, AP
+from .models import Country
 
 
 class SexPopupView(TemplateView):
@@ -41,26 +41,7 @@ def get_context_data(self, **kwargs):
         return context
 
 
-class SelectionReasonPopUpViews(DetailView):
-    template_name = 'popups/selectionReason.html'
-    model = AP
-    context_object_name = 'attackpattern'
-
-    def get(self, request, *args, **kwargs):
-        return super(SelectionReasonPopUpViews, self).get(request, *args, **kwargs)
-
-    def get_object(self):
-        #I would like to pass the APiD of AP to myID
-        #This should just get a specific AP based on the myID value
-        my_id = self.request.GET.get("my_id")
-        other_param = self.request.GET.get("other_param")
-        obj = get_object_or_404(AP, APid=my_id)
-        return obj
-
-
-
 # Register popup views
 registry_popup_view.register(SexPopupView)
 registry_popup_view.register(ColorPopupView)
 registry_popup_view.register(CountryPopupView)
-registry_popup_view.register(SelectionReasonPopUpViews)

demo/demo/models.py

@@ -1,12 +1,11 @@
 from django.conf.urls import include, url
 from django.contrib import admin
 
-from .views import Index, APReviewCreateView
+from .views import Index
 
 urlpatterns = [
     url(r'^admin/', admin.site.urls),
     url(r'^$', Index.as_view(), name="index"),
-    url(r'^ap/$', APReviewCreateView.as_view(), name="ap"),
 
     # django-popup-view-field
     url(r'^django_popup_view_field/', include('django_popup_view_field.urls')),

demo/demo/popups.py

@@ -1,7 +1,7 @@
 from django.http import HttpResponse
-from django.views.generic import TemplateView, CreateView
+from django.views.generic import CreateView, TemplateView
 
-from .forms import DemoForm, APReviewForm
+from .forms import DemoForm
 
 
 class Index(TemplateView):
@@ -35,9 +35,3 @@ def get_context_data(self, **kwargs):
         context["form_2"] = self.form_2
         context["form_3"] = self.form_3
         return context
-
-
-class APReviewCreateView(CreateView):
-    form_class = APReviewForm
-    template_name = 'demo/APReview_new.html'
-    success_url = 'success'

demo/demo/templates/demo/APReview_new.html

@@ -1,2 +1,2 @@
-VERSION = (0, 3, 0)
+VERSION = (0, 4, 0)
 __version__ = ".".join(str(i) for i in VERSION)

demo/demo/templates/popups/selectionReason.html

@@ -1,10 +1,11 @@
+import urllib
+
 from django.forms.fields import CharField
 from django.utils.translation import ugettext_lazy as _
 from django.views.generic import View
 
 from .exceptions import PopupViewIsNotSubclassView
 from .widgets import PopupViewWidget
-import urllib
 
 
 class PopupViewField(CharField):

demo/demo/urls.py

@@ -1,4 +1,6 @@
 # encoding: utf-8
+from collections import OrderedDict
+
 from django import VERSION, forms
 from django.forms.fields import CharField
 from django.test import TestCase
@@ -50,7 +52,7 @@ class Form(forms.Form):
         assert html.find('''class="input-group-addon btn popup-view-btn-load"''') != -1
         assert html.find('''data-target="id_popup_view_field"''') != -1
         assert html.find('''data-popup-dialog-title="Popup Dialog: Select value"''') != -1
-        assert html.find('''data-url = "/django_popup_view_field/PopupView/"''') != -1
+        assert html.find('''data-url = "/django_popup_view_field/PopupView/?"''') != -1
 
         class Form(forms.Form):
             popup_view_field = PopupViewField(
@@ -63,3 +65,34 @@ class Form(forms.Form):
         html = form.as_p()
         assert html.find('''data-popup-dialog-title="Foo Bar Title Window"''') != -1
         self.assertInHTML('''<span class="helptext">Test help text</span>''', html)
+
+    def test_callback_data_type_error(self):
+
+        class PopupView(View):
+            pass
+
+        with self.assertRaises(AttributeError):
+            PopupViewField(view_class=PopupView, callback_data="wrong type")
+
+    def test_callback_data(self):
+
+        class PopupView(View):
+            pass
+
+        class Form(forms.Form):
+            popup_view_field = PopupViewField(
+                view_class=PopupView,
+                callback_data=OrderedDict([
+                    ('pk', 1),
+                    ('name', "Some name"),
+                    ('utf', "ąść"),
+                    ('escape', '&?')
+                ])
+            )
+
+        form = Form()
+        html = form.as_p()
+        assert (
+            '"/django_popup_view_field/PopupView/'
+            '?pk=1&amp;name=Some+name&amp;utf=%C4%85%C5%9B%C4%87&amp;escape=%26%3F"'
+        ) in html

demo/demo/views.py

@@ -34,7 +34,7 @@ def test_get_response(self):
         assert html.find('''class="input-group-addon btn popup-view-btn-load"''') != -1
         assert html.find('''data-target="id_field"''') != -1
         assert html.find('''data-popup-dialog-title="Test PopupView1 Title"''') != -1
-        assert html.find('''data-url = "/django_popup_view_field/PopupView1/"''') != -1
+        assert html.find('''data-url = "/django_popup_view_field/PopupView1/?"''') != -1
 
     def test_post_response(self):
         response = self.client.post(self.url, {"field": "Test Value"})

django_popup_view_field/__init__.py

@@ -12,4 +12,4 @@ def get(self, request, *args, **kwargs):
             raise ValueError("view_class_name must be pass")
         else:
             view_class = registry_popup_view.get(view_class_name)
-            return view_class.as_view()(request=request, **kwargs)
+            return view_class.as_view()(request=request, *args, **kwargs)

django_popup_view_field/fields.py

@@ -1,5 +1,6 @@
 # encoding:utf-8
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
+
 from django_popup_view_field import __version__ as version
 
 

django_popup_view_field/tests/test_field.py

@@ -5,8 +5,7 @@ envlist=
     {py27,py34}-dj_1.9-bootstrap_{7.1,8.1,8.2}-crispy_{1.5,1.6}-tests,
     {py27,py34}-dj_1.10-bootstrap_{7.1,8.1,8.2}-crispy_{1.5,1.6}-tests,
     {py27,py34}-dj_1.11-bootstrap_{8.2}-crispy_{1.6}-tests,
-    {py27,py34}-flake,
-    py34-isort
+    {py27,py34}-flake
 
 [testenv]
 basepython =
@@ -17,7 +16,6 @@ pip_pre = true
 
 deps =
     flake8
-    isort
     dj_1.8: Django>=1.8,<1.9
     dj_1.9: Django>=1.9,<1.10
     dj_1.10: Django>=1.9,<1.11
@@ -31,4 +29,3 @@ deps =
 commands =
     tests: ./run_test.py
     flake: flake8
-    isort: isort -rc -w80 -m3 -tc -c -df django_popup_view_field run_test.py