diff --git a/django/views/generic/create_update.py b/django/views/generic/create_update.py index 46e92fe..3532820 100644 --- a/django/views/generic/create_update.py +++ b/django/views/generic/create_update.py @@ -1,16 +1,15 @@ from django.core.xheaders import populate_xheaders from django.template import loader -from django import oldforms -from django.db.models import FileField +from django import newforms as forms from django.contrib.auth.views import redirect_to_login from django.template import RequestContext from django.http import Http404, HttpResponse, HttpResponseRedirect from django.core.exceptions import ObjectDoesNotExist, ImproperlyConfigured from django.utils.translation import ugettext -def create_object(request, model, template_name=None, +def create_object(request, form_class, template_name=None, template_loader=loader, extra_context=None, post_save_redirect=None, - login_required=False, follow=None, context_processors=None): + login_required=False, context_processors=None): """ Generic object-creation function. @@ -22,25 +21,17 @@ def create_object(request, model, template_name=None, if extra_context is None: extra_context = {} if login_required and not request.user.is_authenticated(): return redirect_to_login(request.path) - - manipulator = model.AddManipulator(follow=follow) - if request.POST: - # If data was POSTed, we're trying to create a new object - new_data = request.POST.copy() - - if model._meta.has_field_type(FileField): - new_data.update(request.FILES) - - # Check for errors - errors = manipulator.get_validation_errors(new_data) - manipulator.do_html2python(new_data) - - if not errors: - # No errors -- this means we can save the data! - new_object = manipulator.save(new_data) - + + opts = form_class._meta + + if request.method == 'POST': + form = form_class(request.POST, request.FILES) + + if form.is_valid(): + new_object = form.save() + if request.user.is_authenticated(): - request.user.message_set.create(message=ugettext("The %(verbose_name)s was created successfully.") % {"verbose_name": model._meta.verbose_name}) + request.user.message_set.create(message=ugettext("The %(verbose_name)s was created successfully.") % {"verbose_name": opts.model._meta.verbose_name}) # Redirect to the new object: first by trying post_save_redirect, # then by obj.get_absolute_url; fail if neither works. @@ -51,14 +42,11 @@ def create_object(request, model, template_name=None, else: raise ImproperlyConfigured("No URL to redirect to from generic create view.") else: - # No POST, so we want a brand new form without any data or errors - errors = {} - new_data = manipulator.flatten_data() + form = form_class() - # Create the FormWrapper, template, context, response - form = oldforms.FormWrapper(manipulator, new_data, errors) + # Create the template, context, response if not template_name: - template_name = "%s/%s_form.html" % (model._meta.app_label, model._meta.object_name.lower()) + template_name = "%s/%s_form.html" % (opts.model._meta.app_label, opts.model._meta.object_name.lower()) t = template_loader.get_template(template_name) c = RequestContext(request, { 'form': form, @@ -70,10 +58,10 @@ def create_object(request, model, template_name=None, c[key] = value return HttpResponse(t.render(c)) -def update_object(request, model, object_id=None, slug=None, +def update_object(request, form_class, object_id=None, slug=None, slug_field='slug', template_name=None, template_loader=loader, extra_context=None, post_save_redirect=None, - login_required=False, follow=None, context_processors=None, + login_required=False, context_processors=None, template_object_name='object'): """ Generic object-update function. @@ -89,32 +77,28 @@ def update_object(request, model, object_id=None, slug=None, if login_required and not request.user.is_authenticated(): return redirect_to_login(request.path) + opts = form_class._meta + # Look up the object to be edited lookup_kwargs = {} if object_id: - lookup_kwargs['%s__exact' % model._meta.pk.name] = object_id + lookup_kwargs['%s__exact' % opts.model._meta.pk.name] = object_id elif slug and slug_field: lookup_kwargs['%s__exact' % slug_field] = slug else: raise AttributeError("Generic edit view must be called with either an object_id or a slug/slug_field") try: - object = model.objects.get(**lookup_kwargs) + object = opts.model.objects.get(**lookup_kwargs) except ObjectDoesNotExist: - raise Http404, "No %s found for %s" % (model._meta.verbose_name, lookup_kwargs) + raise Http404, "No %s found for %s" % (opts.model._meta.verbose_name, lookup_kwargs) - manipulator = model.ChangeManipulator(getattr(object, object._meta.pk.attname), follow=follow) - - if request.POST: - new_data = request.POST.copy() - if model._meta.has_field_type(FileField): - new_data.update(request.FILES) - errors = manipulator.get_validation_errors(new_data) - manipulator.do_html2python(new_data) - if not errors: - object = manipulator.save(new_data) + if request.method == 'POST': + form = form_class(request.POST, request.FILES, instance=object) + if form.is_valid(): + object = form.save() if request.user.is_authenticated(): - request.user.message_set.create(message=ugettext("The %(verbose_name)s was updated successfully.") % {"verbose_name": model._meta.verbose_name}) + request.user.message_set.create(message=ugettext("The %(verbose_name)s was updated successfully.") % {"verbose_name": opts.model._meta.verbose_name}) # Do a post-after-redirect so that reload works, etc. if post_save_redirect: @@ -124,13 +108,10 @@ def update_object(request, model, object_id=None, slug=None, else: raise ImproperlyConfigured("No URL to redirect to from generic create view.") else: - errors = {} - # This makes sure the form acurate represents the fields of the place. - new_data = manipulator.flatten_data() + form = form_class(instance=object) - form = oldforms.FormWrapper(manipulator, new_data, errors) if not template_name: - template_name = "%s/%s_form.html" % (model._meta.app_label, model._meta.object_name.lower()) + template_name = "%s/%s_form.html" % (opts.model._meta.app_label, opts.model._meta.object_name.lower()) t = template_loader.get_template(template_name) c = RequestContext(request, { 'form': form, @@ -142,7 +123,7 @@ def update_object(request, model, object_id=None, slug=None, else: c[key] = value response = HttpResponse(t.render(c)) - populate_xheaders(request, response, model, getattr(object, object._meta.pk.attname)) + populate_xheaders(request, response, opts.model, getattr(object, object._meta.pk.attname)) return response def delete_object(request, model, post_delete_redirect, diff --git a/docs/generic_views.txt b/docs/generic_views.txt index 1718789..090c738 100644 --- a/docs/generic_views.txt +++ b/docs/generic_views.txt @@ -894,19 +894,26 @@ Create/update/delete generic views The ``django.views.generic.create_update`` module contains a set of functions for creating, editing and deleting objects. +**New in Django development version:** + +``django.views.generic.create_update.create_object`` and +``django.views.generic.create_update.update_object`` now use `newforms`_ to +build and display the form. + +.. _newforms: ../newforms/ + ``django.views.generic.create_update.create_object`` ---------------------------------------------------- **Description:** A page that displays a form for creating an object, redisplaying the form with -validation errors (if there are any) and saving the object. This uses the -automatic manipulators that come with Django models. +validation errors (if there are any) and saving the object. **Required arguments:** - * ``model``: The Django model class of the object that the form will - create. + * ``form_class``: A ``django.newforms.ModelForm`` class that will + represent the model as a form. See `ModelForm docs`_ for more information. **Optional arguments:** @@ -947,22 +954,23 @@ If ``template_name`` isn't specified, this view will use the template In addition to ``extra_context``, the template's context will be: - * ``form``: A ``django.oldforms.FormWrapper`` instance representing the form - for editing the object. This lets you refer to form fields easily in the + * ``form``: A ``django.newforms.ModelForm`` instance representing the form + for creating the object. This lets you refer to form fields easily in the template system. - For example, if ``model`` has two fields, ``name`` and ``address``:: + For example, if the model has two fields, ``name`` and ``address``::
-

{{ form.name }}

-

{{ form.address }}

+

{{ form.name.label_tag }} {{ form.name }}

+

{{ form.address.label_tag }} {{ form.address }}

- See the `manipulator and formfield documentation`_ for more information - about using ``FormWrapper`` objects in templates. + See the `newforms documentation`_ for more information about using + ``Form`` objects in templates. .. _authentication system: ../authentication/ -.. _manipulator and formfield documentation: ../forms/ +.. _ModelForm docs: ../newforms/modelforms +.. _newforms documentation: ../newforms/ ``django.views.generic.create_update.update_object`` ---------------------------------------------------- @@ -975,8 +983,8 @@ object. This uses the automatic manipulators that come with Django models. **Required arguments:** - * ``model``: The Django model class of the object that the form will - create. + * ``form_class``: A ``django.newforms.ModelForm`` class that will + represent the model as a form. See `ModelForm docs`_ for more information. * Either ``object_id`` or (``slug`` *and* ``slug_field``) is required. @@ -1029,19 +1037,19 @@ If ``template_name`` isn't specified, this view will use the template In addition to ``extra_context``, the template's context will be: - * ``form``: A ``django.oldforms.FormWrapper`` instance representing the form + * ``form``: A ``django.newforms.ModelForm`` instance representing the form for editing the object. This lets you refer to form fields easily in the template system. - For example, if ``model`` has two fields, ``name`` and ``address``:: + For example, if the model has two fields, ``name`` and ``address``::
-

{{ form.name }}

-

{{ form.address }}

+

{{ form.name.label_tag }} {{ form.name }}

+

{{ form.address.label_tag }} {{ form.address }}

- - See the `manipulator and formfield documentation`_ for more information - about using ``FormWrapper`` objects in templates. + + See the `newforms documentation`_ for more information about using + ``Form`` objects in templates. * ``object``: The original object being edited. This variable's name depends on the ``template_object_name`` parameter, which is ``'object'`` diff --git a/tests/regressiontests/views/forms.py b/tests/regressiontests/views/forms.py new file mode 100644 index 0000000..60dd539 --- /dev/null +++ b/tests/regressiontests/views/forms.py @@ -0,0 +1,36 @@ + +from datetime import datetime + +from django import newforms as forms +from models import Author, Article + + +class ArticleForm(forms.ModelForm): + """ + A form bound to the Article model + """ + + class Meta: + model = Article + + +class CustomSlugArticleForm(forms.ModelForm): + """ + A ModelForm with a custom save method to modify how the form is saved. + """ + + class Meta: + model = Article + fields = ("title",) + + def save(self, commit=True): + instance = super(CustomSlugArticleForm, self).save(commit=False) + instance.slug = 'some-other-slug' + instance.author = Author.objects.get(pk=1) + # this would normally be done through the default value of the field + # this is just here to prove that it can be done in a save method + # override. + instance.date_created = datetime.now() + if commit: + instance.save() + return instance diff --git a/tests/regressiontests/views/tests/__init__.py b/tests/regressiontests/views/tests/__init__.py index 2c8c5b4..e076fa8 100644 --- a/tests/regressiontests/views/tests/__init__.py +++ b/tests/regressiontests/views/tests/__init__.py @@ -1,4 +1,5 @@ from defaults import * from i18n import * from static import * -from generic.date_based import * \ No newline at end of file +from generic.date_based import * +from generic.create_update import * \ No newline at end of file diff --git a/tests/regressiontests/views/tests/generic/create_update.py b/tests/regressiontests/views/tests/generic/create_update.py new file mode 100644 index 0000000..6676185 --- /dev/null +++ b/tests/regressiontests/views/tests/generic/create_update.py @@ -0,0 +1,102 @@ + +import datetime +from django.test import TestCase +from django.contrib.auth.views import redirect_to_login +from regressiontests.views.models import Article, Author + +class CreateObjectTest(TestCase): + fixtures = ['testdata.json'] + + def test_not_logged_in(self): + """Verifies the user is logged in through the login_required kwarg""" + view_url = '/views/create_update/member/create/article/' + response = self.client.get(view_url) + self.assertRedirects(response, 'http://testserver/accounts/login/?next=%s' % view_url) + + def test_create_article_display_page(self): + """Ensures the generic view returned the page and contains a form.""" + view_url = '/views/create_update/create/article/' + response = self.client.get(view_url) + self.assertEqual(response.status_code, 200) + if not response.context.get('form'): + self.fail('No form found in the response.') + + def test_create_article_with_errors(self): + """POSTs a form that contain validation errors.""" + view_url = '/views/create_update/create/article/' + response = self.client.post(view_url, { + 'title': 'My First Article', + }) + self.assertFormError(response, 'form', 'slug', [u'This field is required.']) + + def test_create_article(self): + """Creates a new article through the generic view and ensures it gets + redirected to the correct URL defined by post_save_redirect""" + view_url = '/views/create_update/create/article/' + response = self.client.post(view_url, { + 'title': 'My First Article', + 'slug': 'my-first-article', + 'author': '1', + 'date_created': datetime.datetime(2007, 6, 25), + }) + self.assertRedirects(response, + 'http://testserver/views/create_update/view/article/my-first-article/', + target_status_code=404) + + def test_create_custom_save_article(self): + """Creates a new article with a save method override to adjust the slug + before committing to the database.""" + view_url = '/views/create_update/create_custom/article/' + response = self.client.post(view_url, { + 'title': 'Test Article', + }) + self.assertRedirects(response, + 'http://testserver/views/create_update/view/article/some-other-slug/', + target_status_code=404) + +class UpdateDeleteObjectTest(TestCase): + fixtures = ['testdata.json'] + + def test_update_object_form_display(self): + """Verifies that the form was created properly and with initial values.""" + response = self.client.get('/views/create_update/update/article/old_article/') + self.assertEquals(unicode(response.context['form']['title']), + u'') + + def test_update_object(self): + """Verifies the form POST data and performs a redirect to + post_save_redirect""" + response = self.client.post('/views/create_update/update/article/old_article/', { + 'title': 'Another Article', + 'slug': 'another-article-slug', + 'author': 1, + 'date_created': datetime.datetime(2007, 6, 25), + }) + self.assertRedirects(response, + 'http://testserver/views/create_update/view/article/another-article-slug/', + target_status_code=404) + article = Article.objects.get(pk=1) + self.assertEquals(article.title, "Another Article") + + def test_delete_object_confirm(self): + """Verifies the confirm deletion page is displayed using a GET.""" + response = self.client.get('/views/create_update/delete/article/old_article/') + self.assertTemplateUsed(response, 'views/article_confirm_delete.html') + + def test_delete_object_redirect(self): + """Verifies that post_delete_redirect works properly.""" + response = self.client.post('/views/create_update/delete/article/old_article/') + self.assertRedirects(response, + 'http://testserver/views/create_update/', + target_status_code=404) + + def test_delete_object(self): + """Verifies the object actually gets deleted on a POST.""" + response = self.client.post('/views/create_update/delete/article/old_article/') + try: + Article.objects.get(slug='old_article') + except Article.DoesNotExist: + pass + else: + self.fail('Object was not deleted.') + \ No newline at end of file diff --git a/tests/regressiontests/views/urls.py b/tests/regressiontests/views/urls.py index 5ef0c51..cb8e8e4 100644 --- a/tests/regressiontests/views/urls.py +++ b/tests/regressiontests/views/urls.py @@ -3,6 +3,7 @@ from os import path from django.conf.urls.defaults import * from models import * +from forms import ArticleForm import views base_dir = path.dirname(path.abspath(__file__)) @@ -20,6 +21,14 @@ date_based_info_dict = { 'month_format': '%m', } +crud_form_info_dict = { + 'form_class': ArticleForm, +} + +crud_delete_info_dict = { + 'model': Article, +} + urlpatterns = patterns('', (r'^$', views.index_page), @@ -44,5 +53,17 @@ urlpatterns = patterns('', dict(allow_future=True, slug_field='slug', **date_based_info_dict)), (r'^date_based/archive_month/(?P\d{4})/(?P\d{1,2})/$', 'django.views.generic.date_based.archive_month', - date_based_info_dict), + date_based_info_dict), + + # crud generic views + (r'^create_update/member/create/article/$', 'django.views.generic.create_update.create_object', + dict(login_required=True, **crud_form_info_dict)), + (r'^create_update/create/article/$', 'django.views.generic.create_update.create_object', + dict(post_save_redirect='/views/create_update/view/article/%(slug)s/', **crud_form_info_dict)), + (r'^create_update/create_custom/article/$', views.custom_slug, + dict(post_save_redirect='/views/create_update/view/article/%(slug)s/', **crud_form_info_dict)), + (r'create_update/update/article/(?P[-\w]+)/$', 'django.views.generic.create_update.update_object', + dict(post_save_redirect='/views/create_update/view/article/%(slug)s/', slug_field='slug', **crud_form_info_dict)), + (r'create_update/delete/article/(?P[-\w]+)/$', 'django.views.generic.create_update.delete_object', + dict(post_delete_redirect='/views/create_update/', slug_field='slug', **crud_delete_info_dict)), ) diff --git a/tests/regressiontests/views/views.py b/tests/regressiontests/views/views.py index 956432e..7fd69be 100644 --- a/tests/regressiontests/views/views.py +++ b/tests/regressiontests/views/views.py @@ -1,5 +1,17 @@ +import datetime + from django.http import HttpResponse +from django.template import RequestContext +from django.views.generic.create_update import create_object + +from forms import CustomSlugArticleForm + def index_page(request): """Dummy index page""" return HttpResponse('Dummy page') + +def custom_slug(request, **kwargs): + # change the form_class before calling the create_object generic view + kwargs["form_class"] = CustomSlugArticleForm + return create_object(request, **kwargs) diff --git a/tests/templates/views/article_confirm_delete.html b/tests/templates/views/article_confirm_delete.html new file mode 100644 index 0000000..3f8ff55 --- /dev/null +++ b/tests/templates/views/article_confirm_delete.html @@ -0,0 +1 @@ +This template intentionally left blank \ No newline at end of file diff --git a/tests/templates/views/article_form.html b/tests/templates/views/article_form.html new file mode 100644 index 0000000..3f8ff55 --- /dev/null +++ b/tests/templates/views/article_form.html @@ -0,0 +1 @@ +This template intentionally left blank \ No newline at end of file