Ticket #16319: ticket_16319.patch

new file django/contrib/messages/views.py

@@ +1 @@
+from django.views.generic.edit import FormMixin
+from django.contrib import messages
+
+
+class SuccessMessageMixin(FormMixin):
+    """
+    A mixin that add a success message when a form is completed
+    """
+    success_message = None
+
+    def form_valid(self, form):
+        success_message = self.get_success_message()
+        if success_message:
+            messages.success(self.request, success_message)
+        return super(SuccessMessageMixin, self).form_valid(form)
+
+    def get_success_message(self):
+        if hasattr(self, 'object'):
+            return self.success_message % self.object.__dict__
+        return self.success_message

docs/ref/contrib/messages.txt

@@ -280 +280 @@
    use one of the ``add_message`` family of methods. It does not hide failures
    that may occur for other reasons.
 
+Adding a messages in CBV
+------------------------
+
+If you're writing a view for processing a form and want to add message
+about successful checking, you can use ``'django.contrib.messages.views.SuccessMessageMixin'`` for it.
+For example::
+
+    # views.py
+    from django.contrib.messages.views import SuccessMessageMixin
+    from django.views.generic.edit import CreateView
+    from myapp.models import Author
+
+
+    class AuthorCreate(CreateView, SuccessMessageMixin):
+        model = Author
+        success_url = '/success/'
+        success_message = "%(name)s was created successfully"
+
+.. note::
+    ``success_message`` is supported printing only fields what is contains in ``model``.
+
 Expiration of messages
 ======================
 

tests/regressiontests/generic_views/edit.py

@@ -20 +20 @@
          initial_2 = FormMixin().get_initial()
          self.assertNotEqual(initial_1, initial_2)
 
+
 class ModelFormMixinTests(TestCase):
     def test_get_form(self):
         form_class = views.AuthorGetQuerySetFormView().get_form_class()
         self.assertEqual(form_class._meta.model, Author)
 
+
+class SuccessMessageMixinTests(TestCase):
+    urls = 'regressiontests.generic_views.urls'
+
+    def test_set_messages_success(self):
+        req = self.client.post('/edit/authors/create/msg/',
+                               {'name': 'John Doe',
+                                'slug': 'success-msg'})
+        self.assertIn('John Doe', req.cookies['messages'].value)
+
+    def test_set_message_false(self):
+        req = self.client.post('/edit/authors/create/msg/',
+                               {'name': 'John Doe'})
+        self.assertFalse('messages' in req.cookies)
+
+
 class CreateViewTests(TestCase):
     urls = 'regressiontests.generic_views.urls'
 
@@ -298 +315 @@
             self.fail('Should raise exception -- No redirect URL provided, and no get_absolute_url provided')
         except ImproperlyConfigured:
             pass
-

tests/regressiontests/generic_views/tests.py

@@ -1 +1 @@
 from __future__ import absolute_import
 
 from .base import (ViewTest, TemplateViewTest, RedirectViewTest,
-    GetContextDataTest)
+                   GetContextDataTest)
 from .dates import (ArchiveIndexViewTests, YearArchiveViewTests,
-    MonthArchiveViewTests, WeekArchiveViewTests, DayArchiveViewTests,
-    DateDetailViewTests)
+                    MonthArchiveViewTests, WeekArchiveViewTests,
+                    DayArchiveViewTests, DateDetailViewTests)
 from .detail import DetailViewTest
 from .edit import (FormMixinTests, ModelFormMixinTests, CreateViewTests,
-    UpdateViewTests, DeleteViewTests)
+                   UpdateViewTests, DeleteViewTests, SuccessMessageMixinTests)
 from .list import ListViewTests

tests/regressiontests/generic_views/urls.py

@@ -72 +72 @@
         views.AuthorCreateRestricted.as_view()),
     (r'^edit/authors/create/$',
         views.AuthorCreate.as_view()),
+    (r'^edit/authors/create/msg/$',
+        views.AuthorCreateViewWithMsg.as_view()),
     (r'^edit/authors/create/special/$',
         views.SpecializedAuthorCreate.as_view()),
 

tests/regressiontests/generic_views/views.py

@@ -1 +1 @@
 from __future__ import absolute_import
 
 from django.contrib.auth.decorators import login_required
+from django.contrib.messages.views import SuccessMessageMixin
 from django.core.paginator import Paginator
 from django.core.urlresolvers import reverse
 from django.utils.decorators import method_decorator
@@ -102 +103 @@
     post = method_decorator(login_required)(AuthorCreate.post)
 
 
+class AuthorCreateViewWithMsg(generic.CreateView, SuccessMessageMixin):
+    model = Author
+    success_url = '/next/'
+    success_message = "%(name)s was created successfully"
+
+
 class ArtistUpdate(generic.UpdateView):
     model = Artist