diff --git a/CHANGELOG.txt b/CHANGELOG.txt new file mode 100644 index 0000000..15fb0d5 --- /dev/null +++ b/CHANGELOG.txt @@ -0,0 +1,7 @@ + +==== 0.1.1 (2016-04-24) === + +* Adds `request` to signature of `get_form_class`, `get_success_url` + and `form_valid`. +* Adds proper documentation +* Adds this `CHANGELOG.txt` diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..3c5e46c --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,6 @@ +include LICENSE +include README.rst +include CHANGELOG.txt +recursive-include docs * +recursive-exclude * *.pyc +recursive-exclude * *.scssc diff --git a/README.rst b/README.rst index 044f432..afc435a 100644 --- a/README.rst +++ b/README.rst @@ -6,117 +6,6 @@ This package aims to provide a mechanism for handling form-submissions in django-CMS plugins. -Background ----------- +.. include:: docs/background.rst -Plugins are a key component of `django CMS `_ for -creating reusable, configurable content fragments in django CMS projects. Due to -their flexibility and utility, project developers would benefit from emitting -forms and handling form submissions using plugins. - -Since CMS plugins are fragments of a page, they do not provide a unique, RESTful -URL for receiving and handling form submissions. This presents numerous -challenges when attempting to process form submissions. - - -Approach --------- - -To get around these limitations, the approach taken in this package is to direct -form submissions from plugins which sub-class ``FormPluginBase`` to a URL that -is outside of the django CMS URL-space and handled by a ``ProcessFormView`` -provided by this package. - -The ``ProcessFormView`` accepts form-submissions, processes them, and if valid, -the request is redirected to a ``success_url`` provided by the plugin. On -validation errors, the view will redirect the request back to the originating -page and provide the form data via a session variable back to the plugin's form. - -The user experience is precisely as expected and the handling of the form is -performed without "thrown HTTPRedirectResponses" or special middleware. - -This package encapsulates all extra logic so that the plugin developer need -only to subclass ``cmsplugin_form_handler.cms_plugins.FormPluginBase`` rather -than the usual ``cms.plugin_base.CMSPluginBase``. - -The ``Form`` or ``ModelForm`` presented in the CMS plugin should also include -the "mixin" ``cmsplugin_form_handler.forms.FormPluginFormMixin``. - - ------------- -Installation ------------- - -Install package into your project's path:: - - pip install [TODO] - -Add to your project's settings.INSTALLED_APPS:: - - INSTALLED_APPS = ( - ..., - 'cmsplugin_form_handler', - ) - -Also, add a line to your project's urls.py file:: - - urlpatterns = i18n_patterns('', - url(r'^admin/', include(admin.site.urls)), # NOQA - url(r'^sitemap\.xml$', 'django.contrib.sitemaps.views.sitemap', - {'sitemaps': {'cmspages': CMSSitemap}}), - url(r'^select2/', include('django_select2.urls')), - - # vvvvv - url(r'^plugin_forms/', include('cmsplugin_form_handler.urls', - namespace='cmsplugin_form_handler')), - # ^^^^^ - url(r'^', include('cms.urls')), - ) - -.. note:: - - The URL segment ``plugin_forms`` can be anything you like but pick something - that is unlikely to collide with a desired page slug. It should be inserted - before the CMS urls, but after the Admin urls. - ------ -Usage ------ - -When you create your plugin class, instead of inheriting from CMSPluginBase, -inherit from PluginFormBase as follows:: - - from django import forms - - from cms.models import CMSPlugin - - from cmsplugin_form_handler.cms_plugins import PluginFormBase - from cmsplugin_form_handler.forms import FormPluginFormMixin - - - class CoolForm(FormPluginFormMixin, forms.Form): - # Define your form as per usual... - cool_field = forms.CharField(...) - - - class CoolFormPlugin(PluginFormBase): - name = 'Cool Form' - model = CMSPlugin - render_template = 'form_plugin.html' - form_class = CoolForm - success_url = 'http://www.google.com/' - - plugin_pool.register_plugin(FormPlugin) - -As usual, you must define a ``render_template`` for your plugin. Here's one:: - - {% load cmsplugin_form_tags %} -

Form Plugin ({{ instance.pk }})

-
- {% csrf_token %} - {{ form }} - -
- -Note that the only thing special here is the extra context: -``plugin_form_action`` and ``form``. +.. include:: docs/quickstart.rst diff --git a/cmsplugin_form_handler/cms_plugins.py b/cmsplugin_form_handler/cms_plugins.py index 74c92c7..b6fb799 100644 --- a/cmsplugin_form_handler/cms_plugins.py +++ b/cmsplugin_form_handler/cms_plugins.py @@ -17,7 +17,7 @@ class FormPluginBase(CMSPluginBase): form_class = None success_url = None - def get_form_class(self, instance): + def get_form_class(self, request, instance): """ Returns the form class to be used by this plugin. @@ -27,7 +27,7 @@ def get_form_class(self, instance): """ return self.form_class - def get_success_url(self, instance): + def get_success_url(self, request, instance): """ Returns the redirect URL for successful form submissions. @@ -37,7 +37,7 @@ def get_success_url(self, instance): """ return self.success_url - def form_valid(self, instance, form): + def form_valid(self, request, instance, form): """ If the form validates, this method will be called before the user is redirected to the success_url. The default implementation is to just @@ -49,7 +49,7 @@ def render(self, context, instance, placeholder): context = super(FormPluginBase, self).render(context, instance, placeholder) # noqa request = context.get('request') - form_class = self.get_form_class(instance) + form_class = self.get_form_class(request, instance) if form_class: source_url = request.path data = None diff --git a/cmsplugin_form_handler/views.py b/cmsplugin_form_handler/views.py index b17c7a7..084ddb6 100644 --- a/cmsplugin_form_handler/views.py +++ b/cmsplugin_form_handler/views.py @@ -49,7 +49,7 @@ def source_url(self): def get_form_class(self): instance, plugin = self.plugin if hasattr(plugin, 'get_form_class'): - return plugin.get_form_class(instance) + return plugin.get_form_class(self.request, instance) raise ImproperlyConfigured( 'Source form plugin does not define `get_form_class()`.') @@ -61,7 +61,7 @@ def get_form_kwargs(self): def get_success_url(self): instance, plugin = self.plugin try: - url = plugin.get_success_url(instance) + url = plugin.get_success_url(self.request, instance) return url except AttributeError: raise ImproperlyConfigured( @@ -74,7 +74,7 @@ def get_form_valid(self): """ instance, plugin = self.plugin try: - callback = plugin.on_valid_form(instance) + callback = plugin.valid_form(self.request, instance) return callback except AttributeError: return None @@ -93,7 +93,7 @@ def form_valid(self, form): # If the source plugin has declared a `form_valid` method, call it with # the validated form before redirecting to the `success_url`. instance, plugin = self.plugin - plugin.form_valid(instance, form) + plugin.form_valid(self.request, instance, form) return super(ProcessFormView, self).form_valid(form) diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..ea472d8 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,230 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) + $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " epub3 to make an epub3" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + @echo " dummy to check syntax errors of document sources" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/cmsplugin-form-handler.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/cmsplugin-form-handler.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/cmsplugin-form-handler" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/cmsplugin-form-handler" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: epub3 +epub3: + $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 + @echo + @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +.PHONY: dummy +dummy: + $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy + @echo + @echo "Build finished. Dummy builder generates no files." diff --git a/docs/_ext/cmspluginformhandler.py b/docs/_ext/cmspluginformhandler.py new file mode 100644 index 0000000..58ffccb --- /dev/null +++ b/docs/_ext/cmspluginformhandler.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- + + +def setup(app): + app.add_crossref_type( + directivename="setting", + rolename="setting", + indextemplate="pair: %s; setting", + ) + + app.add_crossref_type( + directivename="templatetag", + rolename="ttag", + indextemplate="pair: %s; template tag" + ) diff --git a/docs/background.rst b/docs/background.rst new file mode 100644 index 0000000..ad33584 --- /dev/null +++ b/docs/background.rst @@ -0,0 +1,44 @@ +--------------------- +Background & Approach +--------------------- + +.. Avoid non-standard directives (like those from Sphinx) here, as this file is + also `include`d in the project's README.txt file. + +Background +---------- + +Plugins are a key component of `django CMS `_ for +creating reusable, configurable content fragments in django CMS projects. Due to +their flexibility and utility, project developers would benefit from emitting +forms and handling form submissions using plugins. + +Since CMS plugins are fragments of a page, they do not provide a unique, URL for +receiving and handling form submissions. This presents numerous challenges when +attempting to process form submissions. + + +Approach +-------- + +To get around these limitations, the approach taken in this package is to direct +form submissions from plugins which sub-class ``FormPluginBase`` to a URL that +is outside of the django CMS URL-space and handled by a ``ProcessFormView`` +provided by this package. + +The ``ProcessFormView`` accepts form-submissions, processes them, and if valid, +sends the resulting form back to the plugin class for handling and then responds +to the request with a redirect to a ``success_url`` provided by the plugin. + +On validation errors, the view will redirect the request back to the originating +page and provide the form data via a session variable back to the plugin's form. + +The user experience is precisely as expected and the handling of the form is +performed without "thrown HTTPRedirectResponses" or any special middleware. + +This package encapsulates all extra logic so that the plugin developer need +only to subclass ``FormPluginBase`` rather than the usual +``cms.plugin_base.CMSPluginBase``. + +The ``Form`` or ``ModelForm`` presented in the CMS plugin should also include +the "mixin" ``FormPluginFormMixin``. diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..cbc6438 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,300 @@ +# -*- coding: utf-8 -*- +# +# cmsplugin-form-handler documentation build configuration file, created by +# sphinx-quickstart on Sun Apr 24 18:25:32 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.append(os.path.abspath('.')) +sys.path.append(os.path.abspath('..')) +sys.path.append(os.path.join(os.path.abspath('.'), '_ext')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'cmspluginformhandler', + 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.imgmath', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'cmsplugin-form-handler' +copyright = u'2016, Martin Koistinen' +author = u'Martin Koistinen' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'0.1.0' +# The full version, including alpha/beta/rc tags. +release = u'0.1.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. +# " v documentation" by default. +#html_title = u'cmsplugin-form-handler v0.1.0' + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +#html_last_updated_fmt = None + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'cmsplugin-form-handlerdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'cmsplugin-form-handler.tex', u'cmsplugin-form-handler Documentation', + u'Martin Koistinen', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'cmsplugin-form-handler', u'cmsplugin-form-handler Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'cmsplugin-form-handler', u'cmsplugin-form-handler Documentation', + author, 'cmsplugin-form-handler', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..cabc337 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,27 @@ +.. cmsplugin-form-handler documentation master file, created by + sphinx-quickstart on Sun Apr 24 18:25:32 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to cmsplugin-form-handler's documentation! +================================================== + +This package aims to provide a mechanism for handling form-submissions in +django-CMS plugins. + +Contents: + +.. toctree:: + :maxdepth: 3 + + background + quickstart + reference/index + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/quickstart.rst b/docs/quickstart.rst new file mode 100644 index 0000000..14c0e5d --- /dev/null +++ b/docs/quickstart.rst @@ -0,0 +1,110 @@ +---------- +Quickstart +---------- + +.. Avoid non-standard directives (like those from Sphinx) here, as this file is + also `include`d in the project's README.txt file. + +To get started quickly, first install the package: :: + + pip install cmsplugin-form-handler + +Add the package to ``settings.INSTALLED_APPS``: :: + + # my_cool_project/settings.py + + INSTALLED_APPS = ( + ... + 'cmsplugin_form_handler', + ) + +Add an extra line in your url configuration: :: + + urlpatterns = i18n_patterns('', + url(r'^admin/', include(admin.site.urls)), + ... + url(r'^plugin_forms/', include('cmsplugin_form_handler.urls', + namespace='cmsplugin_form_handler')), + url(r'^', include('cms.urls')), + ) + + +Add the ``FormPluginFormMixin`` mixin to your ``Form``: :: + + # my_cool_project/forms.py + + from django import forms + from cmsplugin_form_handler.forms import FormPluginFormMixin + + class MyCoolForm(FormPluginFormMixin, forms.Form): + # everything else is your normal form. + my_cool_field = forms.CharField(...) + ... + +Or, if you're using a ``ModelForm``: :: + + # my_cool_project/forms.py + + from django import forms + from cmsplugin_form_handler.forms import FormPluginFormMixin + + class MyCoolModelForm(FormPluginFormMixin, forms.ModelForm): + # everything else is your normal form. + class Meta: + model = MyCoolModel + ... + +Subclass your cms plugin from ``FormPluginBase``: :: + + # my_cool_project/cms_plugins.py + + from cmsplugin_form_handler.cms_plugins import FormPluginBase + + class MyCoolPlugin(FormPluginBase): + # Use your normal CMSPlugin attributes... + render_template = 'plugins/my_cool_plugin.html' + # Note that ``cache = False`` will automatically be set + + # These should be overridden in sub-classes + form_class = MyCoolForm # Or, see: get_form_class() + success_url = '/static/success/url/here' # Or, see: get_success_url() + + def render(self, context, instance, placeholder): + context = super(MyCoolPlugin, self).render(context, instance, placeholder) + + # Do your normal thing here + ... + + return context + + def get_form_class(self, instance): + # Use this method to programmatically determine the form_class. + # This is what this method does by default: + return self.form_class + + def get_success_url(self, instance): + # Use this method to programmatically determine the success_url. + # This is what this method does by default: + return self.success_url + + def form_valid(self, instance, form): + # Optionally do something with the rendered form here + # This is what this method does by default: + form.save() + + +Finally, update your plugin's template: :: + + # my_cool_project/templates/plugins/my_cool_plugin.html + + {% load cmsplugin_form_tags %} + +

Form Plugin

+
+ {% csrf_token %} + {{ cmsplugin_form }} + +
+ + + diff --git a/docs/reference/cms_plugins.rst b/docs/reference/cms_plugins.rst new file mode 100644 index 0000000..a105215 --- /dev/null +++ b/docs/reference/cms_plugins.rst @@ -0,0 +1,116 @@ +----------------------------------------- +:mod:`cmsplugin_form_handler.cms_plugins` +----------------------------------------- + +.. module:: cmsplugin_form_handler.cms_plugins + +This module contains an alternative super-class for CMS plugins that +encapsulates all plugin-related cmsplugin-form-handler logic. + +FormPluginBase +-------------- + +.. class:: FormPluginBase() + +This class is a sub-class of the normal ``cms.plugin_base.CMSPluginBase`` +but offers additional functionality for dealing with plugin-based forms. + +.. attribute:: cache + + This base-class will automatically set the normal ``cache`` attribute + to ``False``. This is because presenting a form should also include a + CSRF token, which should never be cached. + + This can be overridden in the project's plugin class, but it is not + recommended. + +.. attribute:: form_class + + Set this to the ``forms.Form`` or ``forms.ModelForm`` you wish this + plugin to present. If you need to determine which form to present based + on the specific plugin instance, see :meth:`get_form_class`. + +.. attribute:: success_url + + Set this to the URL of the "success page" of the form. Using this + attribute is simple and suitable for static success URLs. However, in + most projects, it is likely more appropriate to use + :meth:`get_success_url`. + +.. method:: get_form_class(request, instance) + + Returns the class of the form that this plugin presents. The default + implementation of this method is to simply return the contents of + :attr:`form_class`. Override this method if different plugins + instances of the same plugin class should return different forms. + + :param HTTPRequest request: + + This is the request object for the form-submission. This may be + useful for making a determination about which form class to return. + + :param CMSPlugin instance: + + This is the CMS plugin instance of the plugin used to produce + the form. + +.. method:: get_success_url(request, instance) + + Returns the desired URL that the user should be redirected to if their + form submission validates. + + :param HTTPRequest request: + + This is the request object for the form-submission. This may be + useful for making a determination about which success URL to return. + + :param CMSPlugin instance: + + This is the CMS plugin instance of the plugin used to produce the + form. (Hint: you could present a list of choices in the + ``CMSPlugin`` model. + + The default implementation of this method is to simply return the + contents of :attr:`success_url`, but in most cases, a static URL is + inappropriate. For example, it may be better to return the absolute URL + of a specific CMS page (which could be moved by the content managers to + different paths). In this case, something like this may be useful: :: + + # NOTE: only relevant code is shown here... + + from cms.models import Page + from cms.utils import get_language_from_request + from cms.utils.i18n import get_default_language + + from cmsplugin_form_handler.cms_plugins import FormPluginBase + + class SomePlugin(FormPluginBase): + ... + success_url = '/' # a sane default + ... + + def get_success_url(self, request, instance): + # Be sure to set this in the Advanced Settings tab of the + # desired CMS Page. + reverse_id = 'success_page' + + # We'll need to know which language is relevant... + lang = get_language_from_request(request) or get_default_language() + + try: + page = Page.objects.get( + reverse_id=reverse_id, + publisher_is_draft=False + ) + except Page.DoesNotExist: + # Can't find the success page, return the something sane... + return self.success_url + else: + return page.get_absolute_url(lang) + + Or, as hinted above, you could use the CMSPlugin model to present a set + of choices using a ``cms.models.fields.PageField`` to the Content + Manager when creating the plugin instance, then, use the + ``get_success_url`` method to return the absolute URL of the + selected choice. + diff --git a/docs/reference/forms.rst b/docs/reference/forms.rst new file mode 100644 index 0000000..28e97d6 --- /dev/null +++ b/docs/reference/forms.rst @@ -0,0 +1,21 @@ +----------------------------------- +:mod:`cmsplugin_form_handler.forms` +----------------------------------- + +.. module:: cmsplugin_form_handler.forms + +FormPluginFormMixin +------------------- + +This module contains code that encapsulates the cmsplugin-forms-handler +functionality relating to forms. + +.. class:: FormPluginFormMixin(source_url, *args, **kwargs) + +This class is a form "mixin" that may be applied to ``forms.Form`` or +``forms.ModelForm`` classes. The mixin embeds a hidden field for passing +the source URL which is required for the correct operation of this package. + +It also modifies the constructor signature of the form by adding a new, +required arg: source_url, but in most cases, this is transparently dealt +with by the package. diff --git a/docs/reference/index.rst b/docs/reference/index.rst new file mode 100644 index 0000000..55fe555 --- /dev/null +++ b/docs/reference/index.rst @@ -0,0 +1,10 @@ +========= +Reference +========= + +.. toctree:: + :maxdepth: 2 + + cms_plugins + forms + templatetags \ No newline at end of file diff --git a/docs/reference/templatetags.rst b/docs/reference/templatetags.rst new file mode 100644 index 0000000..074bdb8 --- /dev/null +++ b/docs/reference/templatetags.rst @@ -0,0 +1,40 @@ +-------------------------------------------------------------- +:mod:`cmsplugin_form_handler.templatetags.cmsplugin_form_tags` +-------------------------------------------------------------- + +.. module:: cmsplugin_form_handler.templatetags.cmsplugin_form_tags + +This module contains template tags that are provided by this package. + + +.. templatetag:: form_action + +form_action +----------- + +This template tag provides the URL for the form action. It simply returns +the correct URL to use for submitting the form. It is roughly equivalent +to: :: + + {% url 'plugin_form_handler:process_form' instance.pk %} + +Although simple, the purpose of this tag is to encapsulate the +implementation details of cmsplugin-form-handler so that future changes can +occur as necessary without breaking existing projects. + +:param int plugin_pk: + + This can be used to specify the ID of the plugin that the view should + use to process the form. If the developer uses CMS development + conventions, this parameter should never be necessary. However, there + may be some cases where the ``render()`` method uses a variable other + than ``instance`` in its context. In these cases, it may be necessary + to use that variable in this template tag as follows: :: + + # In this example, the context includes the variable ``plugin`` + # that contains the plugin instance to render + + {% load cmsplugin_form_tags %} + ... +
+