From: Stephen Burrows Date: Thu, 28 Apr 2011 20:13:55 +0000 (-0400) Subject: Merge branch 'release' into gilbert X-Git-Url: http://git.ithinksw.org/philo.git/commitdiff_plain/a2d75eae2cab588a28155b9c901935aa8d664d5f?hp=1eb51a5b5ac85607af67275ff3684febd84406c9 Merge branch 'release' into gilbert Conflicts: README --- diff --git a/.gitignore b/.gitignore index 0d20b64..073067c 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ *.pyc +docs/_build/ diff --git a/README b/README index 4a89499..cb5f47a 100644 --- a/README +++ b/README @@ -2,7 +2,7 @@ Philo is a foundation for developing web content management systems. Prerequisites: * Python 2.5.4+ - * Django 1.2+ + * Django 1.3+ * django-mptt e734079+ * (Optional) django-grappelli 2.0+ * (Optional) south 0.7.2+ @@ -24,4 +24,4 @@ Philo should be ready to go! If you are using philo.contrib.gilbert, you will additionally need to complete the following steps: -1. add 'django.core.context_processors.request' to settings.TEMPLATE_CONTEXT_PROCESSORS \ No newline at end of file +1. add 'django.core.context_processors.request' to settings.TEMPLATE_CONTEXT_PROCESSORS diff --git a/README.markdown b/README.markdown index 22bac1c..b529ca2 100644 --- a/README.markdown +++ b/README.markdown @@ -3,7 +3,7 @@ Philo is a foundation for developing web content management systems. Prerequisites: * [Python 2.5.4+ <http://www.python.org>](http://www.python.org/) - * [Django 1.2+ <http://www.djangoproject.com/>](http://www.djangoproject.com/) + * [Django 1.3+ <http://www.djangoproject.com/>](http://www.djangoproject.com/) * [django-mptt e734079+ <https://github.com/django-mptt/django-mptt/>](https://github.com/django-mptt/django-mptt/) * (Optional) [django-grappelli 2.0+ <http://code.google.com/p/django-grappelli/>](http://code.google.com/p/django-grappelli/) * (Optional) [south 0.7.2+ <http://south.aeracode.org/)](http://south.aeracode.org/) @@ -25,4 +25,4 @@ Philo should be ready to go! If you are using philo.contrib.gilbert, you will additionally need to complete the following steps: -1. add 'django.core.context_processors.request' to settings.TEMPLATE_CONTEXT_PROCESSORS \ No newline at end of file +1. add 'django.core.context_processors.request' to settings.TEMPLATE_CONTEXT_PROCESSORS diff --git a/__init__.py b/__init__.py deleted file mode 100644 index ba78dda..0000000 --- a/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -from philo.loaders.database import Loader - - -_loader = Loader() - - -def load_template_source(template_name, template_dirs=None): - # For backwards compatibility - import warnings - warnings.warn( - "'philo.load_template_source' is deprecated; use 'philo.loaders.database.Loader' instead.", - PendingDeprecationWarning - ) - return _loader.load_template_source(template_name, template_dirs) -load_template_source.is_usable = True diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..16c56a5 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,130 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest + +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 " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @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 " text to make text files" + @echo " man to make manual pages" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +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." + +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/Philo.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Philo.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Philo" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Philo" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +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)." + +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." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +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." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/_ext/djangodocs.py b/docs/_ext/djangodocs.py new file mode 100644 index 0000000..7710786 --- /dev/null +++ b/docs/_ext/djangodocs.py @@ -0,0 +1,248 @@ +""" +Sphinx plugins for Django documentation. +""" +import os +import re + +from docutils import nodes, transforms +try: + import json +except ImportError: + try: + import simplejson as json + except ImportError: + try: + from django.utils import simplejson as json + except ImportError: + json = None + +from sphinx import addnodes, roles +from sphinx.builders.html import StandaloneHTMLBuilder +from sphinx.writers.html import SmartyPantsHTMLTranslator +from sphinx.util.console import bold +from sphinx.util.compat import Directive + +# RE for option descriptions without a '--' prefix +simple_option_desc_re = re.compile( + r'([-_a-zA-Z0-9]+)(\s*.*?)(?=,\s+(?:/|-|--)|$)') + +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" + ) + app.add_crossref_type( + directivename = "templatefilter", + rolename = "tfilter", + indextemplate = "pair: %s; template filter" + ) + app.add_crossref_type( + directivename = "fieldlookup", + rolename = "lookup", + indextemplate = "pair: %s; field lookup type", + ) + app.add_description_unit( + directivename = "django-admin", + rolename = "djadmin", + indextemplate = "pair: %s; django-admin command", + parse_node = parse_django_admin_node, + ) + app.add_description_unit( + directivename = "django-admin-option", + rolename = "djadminopt", + indextemplate = "pair: %s; django-admin command-line option", + parse_node = parse_django_adminopt_node, + ) + app.add_config_value('django_next_version', '0.0', True) + app.add_directive('versionadded', VersionDirective) + app.add_directive('versionchanged', VersionDirective) + app.add_transform(SuppressBlockquotes) + app.add_builder(DjangoStandaloneHTMLBuilder) + + +class VersionDirective(Directive): + has_content = True + required_arguments = 1 + optional_arguments = 1 + final_argument_whitespace = True + option_spec = {} + + def run(self): + env = self.state.document.settings.env + arg0 = self.arguments[0] + is_nextversion = env.config.django_next_version == arg0 + ret = [] + node = addnodes.versionmodified() + ret.append(node) + if not is_nextversion: + if len(self.arguments) == 1: + linktext = 'Please, see the release notes ' % (arg0) + xrefs = roles.XRefRole()('doc', linktext, linktext, self.lineno, self.state) + node.extend(xrefs[0]) + node['version'] = arg0 + else: + node['version'] = "Development version" + node['type'] = self.name + if len(self.arguments) == 2: + inodes, messages = self.state.inline_text(self.arguments[1], self.lineno+1) + node.extend(inodes) + if self.content: + self.state.nested_parse(self.content, self.content_offset, node) + ret = ret + messages + env.note_versionchange(node['type'], node['version'], node, self.lineno) + return ret + + +class SuppressBlockquotes(transforms.Transform): + """ + Remove the default blockquotes that encase indented list, tables, etc. + """ + default_priority = 300 + + suppress_blockquote_child_nodes = ( + nodes.bullet_list, + nodes.enumerated_list, + nodes.definition_list, + nodes.literal_block, + nodes.doctest_block, + nodes.line_block, + nodes.table + ) + + def apply(self): + for node in self.document.traverse(nodes.block_quote): + if len(node.children) == 1 and isinstance(node.children[0], self.suppress_blockquote_child_nodes): + node.replace_self(node.children[0]) + +class DjangoHTMLTranslator(SmartyPantsHTMLTranslator): + """ + Django-specific reST to HTML tweaks. + """ + + # Don't use border=1, which docutils does by default. + def visit_table(self, node): + self.body.append(self.starttag(node, 'table', CLASS='docutils')) + + # ? Really? + def visit_desc_parameterlist(self, node): + self.body.append('(') + self.first_param = 1 + + def depart_desc_parameterlist(self, node): + self.body.append(')') + + # + # Don't apply smartypants to literal blocks + # + def visit_literal_block(self, node): + self.no_smarty += 1 + SmartyPantsHTMLTranslator.visit_literal_block(self, node) + + def depart_literal_block(self, node): + SmartyPantsHTMLTranslator.depart_literal_block(self, node) + self.no_smarty -= 1 + + # + # Turn the "new in version" stuff (versionadded/versionchanged) into a + # better callout -- the Sphinx default is just a little span, + # which is a bit less obvious that I'd like. + # + # FIXME: these messages are all hardcoded in English. We need to change + # that to accomodate other language docs, but I can't work out how to make + # that work. + # + version_text = { + 'deprecated': 'Deprecated in Django %s', + 'versionchanged': 'Changed in Django %s', + 'versionadded': 'New in Django %s', + } + + def visit_versionmodified(self, node): + self.body.append( + self.starttag(node, 'div', CLASS=node['type']) + ) + title = "%s%s" % ( + self.version_text[node['type']] % node['version'], + len(node) and ":" or "." + ) + self.body.append('%s ' % title) + + def depart_versionmodified(self, node): + self.body.append("\n") + + # Give each section a unique ID -- nice for custom CSS hooks + def visit_section(self, node): + old_ids = node.get('ids', []) + node['ids'] = ['s-' + i for i in old_ids] + node['ids'].extend(old_ids) + SmartyPantsHTMLTranslator.visit_section(self, node) + node['ids'] = old_ids + +def parse_django_admin_node(env, sig, signode): + command = sig.split(' ')[0] + env._django_curr_admin_command = command + title = "django-admin.py %s" % sig + signode += addnodes.desc_name(title, title) + return sig + +def parse_django_adminopt_node(env, sig, signode): + """A copy of sphinx.directives.CmdoptionDesc.parse_signature()""" + from sphinx.domains.std import option_desc_re + count = 0 + firstname = '' + for m in option_desc_re.finditer(sig): + optname, args = m.groups() + if count: + signode += addnodes.desc_addname(', ', ', ') + signode += addnodes.desc_name(optname, optname) + signode += addnodes.desc_addname(args, args) + if not count: + firstname = optname + count += 1 + if not count: + for m in simple_option_desc_re.finditer(sig): + optname, args = m.groups() + if count: + signode += addnodes.desc_addname(', ', ', ') + signode += addnodes.desc_name(optname, optname) + signode += addnodes.desc_addname(args, args) + if not count: + firstname = optname + count += 1 + if not firstname: + raise ValueError + return firstname + + +class DjangoStandaloneHTMLBuilder(StandaloneHTMLBuilder): + """ + Subclass to add some extra things we need. + """ + + name = 'djangohtml' + + def finish(self): + super(DjangoStandaloneHTMLBuilder, self).finish() + if json is None: + self.warn("cannot create templatebuiltins.js due to missing simplejson dependency") + return + self.info(bold("writing templatebuiltins.js...")) + xrefs = self.env.domaindata["std"]["objects"] + templatebuiltins = { + "ttags": [n for ((t, n), (l, a)) in xrefs.items() + if t == "templatetag" and l == "ref/templates/builtins"], + "tfilters": [n for ((t, n), (l, a)) in xrefs.items() + if t == "templatefilter" and l == "ref/templates/builtins"], + } + outfilename = os.path.join(self.outdir, "templatebuiltins.js") + f = open(outfilename, 'wb') + f.write('var django_template_builtins = ') + json.dump(templatebuiltins, f) + f.write(';\n') + f.close(); diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..043219d --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,220 @@ +# -*- coding: utf-8 -*- +# +# Philo documentation build configuration file, created by +# sphinx-quickstart on Fri Jan 28 14:04:16 2011. +# +# 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, 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(os.path.join(os.path.dirname(__file__), "_ext"))) +sys.path.append(os.path.abspath(os.path.dirname(os.path.dirname(__file__)))) + +os.environ['DJANGO_SETTINGS_MODULE'] = 'dummy-settings' + +# -- 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 = ['djangodocs', 'sphinx.ext.autodoc'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +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'Philo' +copyright = u'2011, Joseph Spiros' + +# 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. +from philo import VERSION +version = '%s.%s' % (VERSION[0], VERSION[1]) +# The full version, including alpha/beta/rc tags. +release = version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#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. +exclude_patterns = ['_build'] + +# 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 = [] + + +# -- 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 = 'default' + +# 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. If None, it defaults to +# " v documentation". +#html_title = None + +# 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 (within the static path) to use as 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'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# 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 + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Philodoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'Philo.tex', u'Philo Documentation', + u'Stephen Burrows', '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 + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# 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 = [ + ('index', 'philo', u'Philo Documentation', + [u'Stephen Burrows'], 1) +] diff --git a/contrib/__init__.py b/docs/dummy-settings.py similarity index 100% rename from contrib/__init__.py rename to docs/dummy-settings.py diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..cfc7136 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,38 @@ +.. Philo documentation master file, created by + sphinx-quickstart on Fri Jan 28 14:04:16 2011. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Philo's documentation! +================================= + +Contents: + +.. toctree:: + :maxdepth: 2 + + intro + models/intro + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + +What is Philo? +============== + +Philo is a foundation for developing web content management systems. + +Prerequisites: + +* `Python 2.5.4+ `_ +* `Django 1.2+ `_ +* `django-mptt e734079+ `_ +* (Optional) `django-grappelli 2.0+ `_ +* (Optional) `south 0.7.2+ `_ +* (Optional) `recaptcha-django r6 `_ + +To contribute, please visit the `project website `_ or make a fork of the `git repository `_. Feel free to join us on IRC at `irc://irc.oftc.net/#philo `_. diff --git a/docs/intro.rst b/docs/intro.rst new file mode 100644 index 0000000..33d1a98 --- /dev/null +++ b/docs/intro.rst @@ -0,0 +1,35 @@ +How to get started with philo +============================= + +After installing `philo`_ and `mptt`_ on your python path, make sure to complete the following steps: + +1. add :mod:`philo` and :mod:`mptt` to :setting:`settings.INSTALLED_APPS`:: + + INSTALLED_APPS = ( + ... + 'philo', + 'mptt', + ... + ) + +2. add :class:`philo.middleware.RequestNodeMiddleware` to :setting:`settings.MIDDLEWARE_CLASSES`:: + + MIDDLEWARE_CLASSES = ( + ... + 'philo.middleware.RequestNodeMiddleware', + ... + ) + +3. include :mod:`philo.urls` somewhere in your urls.py file. For example:: + + from django.conf.urls.defaults import patterns, include, url + urlpatterns = patterns('', + url(r'^', include('philo.urls')), + ) + +4. Optionally add a root :class:`node ` to your current :class:`Site` in the admin interface. + +Philo should be ready to go! + +.. _philo: http://github.com/ithinksw/philo +.. _mptt: http://github.com/django-mptt/django-mptt \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..25f0d2a --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,170 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "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. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. changes to make an overview over all changed/added/deprecated items + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Philo.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Philo.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +:end diff --git a/docs/models/entities.rst b/docs/models/entities.rst new file mode 100644 index 0000000..a834b13 --- /dev/null +++ b/docs/models/entities.rst @@ -0,0 +1,54 @@ +Entities and Attributes +======================= + +.. module:: philo.models.base + +One of the core concepts in Philo is the relationship between the :class:`Entity` and :class:`Attribute` classes. :class:`Attribute`\ s represent an arbitrary key/value pair by having one :class:`GenericForeignKey` to an :class:`Entity` and another to an :class:`AttributeValue`. + + +Attributes +---------- + +.. autoclass:: Attribute + :members: + +.. autoclass:: AttributeValue + :members: + +.. automodule:: philo.models.base + :members: attribute_value_limiter + +.. autoclass:: JSONValue + :show-inheritance: + +.. autoclass:: ForeignKeyValue + :show-inheritance: + +.. autoclass:: ManyToManyValue + :show-inheritance: + +.. automodule:: philo.models.base + :members: value_content_type_limiter + +.. autofunction:: register_value_model(model) +.. autofunction:: unregister_value_model(model) + +Entities +-------- + +.. autoclass:: Entity + :members: + :exclude-members: attribute_set + +.. autoclass:: TreeManager + :members: + +.. autoclass:: TreeEntity + :members: + :exclude-members: attribute_set + + .. attribute:: objects + + An instance of :class:`TreeManager`. + + .. automethod:: get_path \ No newline at end of file diff --git a/docs/models/intro.rst b/docs/models/intro.rst new file mode 100644 index 0000000..49b2ac1 --- /dev/null +++ b/docs/models/intro.rst @@ -0,0 +1,13 @@ +Philo's models +============== + +Contents: + +.. toctree:: + :maxdepth: 2 + + entities + nodes-and-views + + +.. :module: philo.models diff --git a/docs/models/nodes-and-views.rst b/docs/models/nodes-and-views.rst new file mode 100644 index 0000000..bd31ceb --- /dev/null +++ b/docs/models/nodes-and-views.rst @@ -0,0 +1,270 @@ +Nodes and Views: Building Website structure +=========================================== +.. currentmodule:: philo.models + +Nodes +----- + +:class:`Node`\ s are the basic building blocks of a website using Philo. They define the URL hierarchy and connect each URL to a :class:`View` subclass instance which is used to generate an HttpResponse. + +.. class:: Node + + :class:`!Node` subclasses :class:`TreeEntity`. It defines the following additional methods and attributes: + + .. attribute:: view + + :class:`GenericForeignKey` to a non-abstract subclass of :class:`View` + + .. attribute:: accepts_subpath + + A property shortcut for :attr:`self.view.accepts_subpath ` + + .. method:: render_to_response(request[, extra_context=None]) + + This is a shortcut method for :meth:`View.render_to_response` + + .. method:: get_absolute_url([request=None, with_domain=False, secure=False]) + + This is essentially a shortcut for calling :meth:`construct_url` without a subpath - which will return the URL of the Node. + + .. method:: construct_url([subpath="/", request=None, with_domain=False, secure=False]) + + This method will do its best to construct a URL based on the Node's location. If with_domain is True, that URL will include a domain and a protocol; if secure is True as well, the protocol will be https. The request will be used to construct a domain in cases where a call to :meth:`Site.objects.get_current` fails. + + Node urls will not contain a trailing slash unless a subpath is provided which ends with a trailing slash. Subpaths are expected to begin with a slash, as if returned by :func:`django.core.urlresolvers.reverse`. + + :meth:`construct_url` may raise the following exceptions: + + - :class:`NoReverseMatch` if "philo-root" is not reversable -- for example, if :mod:`philo.urls` is not included anywhere in your urlpatterns. + - :class:`Site.DoesNotExist ` if with_domain is True but no :class:`Site` or :class:`RequestSite` can be built. + - :class:`AncestorDoesNotExist` if the root node of the site isn't an ancestor of the node constructing the URL. + +Views +----- + +Abstract View Models +++++++++++++++++++++ +.. class:: View + + :class:`!View` is an abstract model that represents an item which can be "rendered", either in response to an :class:`HttpRequest` or as a standalone. It subclasses :class:`Entity`, and defines the following additional methods and attributes: + + .. attribute:: accepts_subpath + + Defines whether this :class:`View` can handle subpaths. Default: ``False`` + + .. method:: handles_subpath(subpath) + + Returns True if the the :class:`View` handles the given subpath, and False otherwise. + + .. attribute:: nodes + + A generic relation back to nodes. + + .. method:: reverse([view_name=None, args=None, kwargs=None, node=None, obj=None]) + + If :attr:`accepts_subpath` is True, try to reverse a URL using the given parameters using ``self`` as the urlconf. + + If ``obj`` is provided, :meth:`get_reverse_params` will be called and the results will be combined with any ``view_name``, ``args``, and ``kwargs`` that may have been passed in. + + This method will raise the following exceptions: + + - :class:`ViewDoesNotProvideSubpaths` if :attr:`accepts_subpath` is False. + - :class:`ViewCanNotProvideSubpath` if a reversal is not possible. + + .. method:: get_reverse_params(obj) + + This method is not implemented on the base class. It should return a ``view_name``, ``args``, ``kwargs`` tuple suitable for reversing a url for the given ``obj`` using ``self`` as the urlconf. If a reversal will not be possible, this method should raise :class:`ViewCanNotProvideSubpath`. + + .. method:: attributes_with_node(node) + + Returns a :class:`QuerySetMapper` using the :class:`node `'s attributes as a passthrough. + + .. method:: render_to_response(request[, extra_context=None]) + + Renders the :class:`View` as an :class:`HttpResponse`. This will raise :const:`philo.exceptions.MIDDLEWARE_NOT_CONFIGURED` if the `request` doesn't have an attached :class:`Node`. This can happen if :class:`philo.middleware.RequestNodeMiddleware` is not in :setting:`settings.MIDDLEWARE_CLASSES` or if it is not functioning correctly. + + :meth:`!render_to_response` will send the :obj:`view_about_to_render ` signal, then call :meth:`actually_render_to_response`, and finally send the :obj:`view_finished_rendering ` signal before returning the ``response``. + + .. method:: actually_render_to_response(request[, extra_context=None]) + + Concrete subclasses must override this method to provide the business logic for turning a ``request`` and ``extra_context`` into an :class:`HttpResponse`. + +.. class:: MultiView + + :class:`!MultiView` is an abstract model which represents a section of related pages - for example, a :class:`~philo.contrib.penfield.BlogView` might have a foreign key to :class:`Page`\ s for an index, an entry detail, an entry archive by day, and so on. :class:`!MultiView` subclasses :class:`View`, and defines the following additional methods and attributes: + + .. attribute:: accepts_subpath + + Same as :attr:`View.accepts_subpath`. Default: ``True`` + + .. attribute:: urlpatterns + + Returns urlpatterns that point to views (generally methods on the class). :class:`!MultiView`\ s can be thought of as "managing" these subpaths. + + .. method:: actually_render_to_response(request[, extra_context=None]) + + Resolves the remaining subpath left after finding this :class:`View`'s node using :attr:`self.urlpatterns ` and renders the view function (or method) found with the appropriate args and kwargs. + + .. method:: get_context() + + Hook for providing instance-specific context - such as the value of a Field - to all views. + + .. method:: basic_view(field_name) + + Given the name of a field on ``self``, accesses the value of that field and treats it as a :class:`View` instance. Creates a basic context based on :meth:`get_context` and any extra_context that was passed in, then calls the :class:`View` instance's :meth:`~View.render_to_response` method. This method is meant to be called to return a view function appropriate for :attr:`urlpatterns`. + +Concrete View Subclasses +++++++++++++++++++++++++ + +.. class:: Redirect + + A :class:`View` subclass. Defines a 301 or 302 redirect to a different url on an absolute or relative path. + + .. attribute:: STATUS_CODES + + A choices tuple of redirect status codes (temporary or permanent). + + .. attribute:: status_code + + An :class:`IntegerField` which uses :attr:`STATUS_CODES` as its choices. Determines whether the redirect is considered temporary or permanent. + + .. attribute:: target_node + + An optional :class:`ForeignKey` to a :class:`Node`. If provided, that node will be used as the basis for the redirect. + + .. attribute:: url_or_subpath + + A :class:`CharField` which may contain an absolute or relative URL. This will be validated with :class:`philo.validators.RedirectValidator`. + + .. attribute:: reversing_parameters + + A :class:`~philo.models.fields.JSONField` instance. If the value of :attr:`reversing_parameters` is not None, the :attr:`url_or_subpath` will be treated as the name of a view to be reversed. The value of :attr:`reversing_parameters` will be passed into the reversal as args if it is a list or as kwargs if it is a dictionary. + + .. attribute:: target_url + + Calculates and returns the target url based on the :attr:`target_node`, :attr:`url_or_subpath`, and :attr:`reversing_parameters`. + + .. method:: actually_render_to_response(request[, extra_context=None]) + + Returns an :class:`HttpResponseRedirect` to :attr:`self.target`. + +.. class:: File + + A :class:`View` subclass. Stores an arbitrary file. + + .. attribute:: mimetype + + Defines the mimetype of the uploaded file. This will not be validated. + + .. attribute:: file + + Contains the uploaded file. Files are uploaded to ``philo/files/%Y/%m/%d``. + + .. method:: __unicode__() + + Returns the name of :attr:`self.file `. + +Pages +***** + +:class:`Page`\ s are the most frequently used :class:`View` subclass. They define a basic HTML page and its associated content. Each :class:`Page` renders itself according to a :class:`Template`. The :class:`Template` may contain :ttag:`container` tags, which define related :class:`Contentlet`\ s and :class:`ContentReference`\ s for any page using that :class:`Template`. + +.. class:: Page + + A :class:`View` subclass. Represents a page - something which is rendered according to a template. The page will have a number of related Contentlets depending on the template selected - but these will appear only after the page has been saved with that template. + + .. attribute:: template + + A :class:`ForeignKey` to the :class:`Template` used to render this :class:`Page`. + + .. attribute:: title + + The name of this page. Chances are this will be used for organization - i.e. finding the page in a list of pages - rather than for display. + + .. attribute:: containers + + Returns :attr:`self.template.containers ` - a tuple containing the specs of all :ttag:`container`\ s defined in the :class:`Template`. The value will be cached on the instance so that multiple accesses will be less expensive. + + .. method:: render_to_string([request=None, extra_context=None]) + + In addition to rendering as an :class:`HttpResponse`, a :class:`Page` can also render as a string. This means, for example, that :class:`Page`\ s can be used to render emails or other non-HTML-related content with the same :ttag:`container`-based functionality as is used for HTML. + + .. method:: actually_render_to_response(request[, extra_context=None]) + + Returns an :class:`HttpResponse` with the content of the :meth:`render_to_string` method and the mimetype set to :attr:`self.template.mimetype `. + + .. clean_fields(self[, exclude=None) + + This is an override of the default model clean_fields method. Essentially, in addition to validating the fields, this method validates the :class:`Template` instance that is used to render this :class:`Page`. This is useful for catching template errors before they show up as 500 errors on a live site. + + .. method:: __unicode__() + + Returns :meth:`self.title ` + +.. class:: Template + + Subclasses :class:`TreeModel`. Represents a database-driven django template. Defines the following additional methods and attributes: + + .. attribute:: name + + The name of the template. Used for organization and debugging. + + .. attribute:: documentation + + Can be used to let users know what the template is meant to be used for. + + .. attribute:: mimetype + + Defines the mimetype of the template. This is not validated. Default: ``text/html``. + + .. attribute:: code + + An insecure :class:`~philo.models.fields.TemplateField` containing the django template code for this template. + + .. attribute:: containers + + Returns a tuple where the first item is a list of names of contentlets referenced by containers, and the second item is a list of tuples of names and contenttypes of contentreferences referenced by containers. This will break if there is a recursive extends or includes in the template code. Due to the use of an empty Context, any extends or include tags with dynamic arguments probably won't work. + + .. method:: __unicode__() + + Returns the results of the :meth:`~TreeModel.get_path` method, using the "name" field and a chevron joiner. + +.. class:: Contentlet + + Defines a piece of content on a page. This content is treated as a secure :class:`~philo.models.fields.TemplateField`. + + .. attribute:: page + + The page which this :class:`Contentlet` is related to. + + .. attribute:: name + + This represents the name of the container as defined by a :ttag:`container` tag. + + .. attribute:: content + + A secure :class:`~philo.models.fields.TemplateField` holding the content for this :class:`Contentlet`. Note that actually using this field as a template requires use of the :ttag:`include_string` template tag. + + .. method:: __unicode__() + + Returns :attr:`self.name <name>` + +.. class:: ContentReference + + Defines a model instance related to a page. + + .. attribute:: page + + The page which this :class:`ContentReference` is related to. + + .. attribute:: name + + This represents the name of the container as defined by a :ttag:`container` tag. + + .. attribute:: content + + A :class:`GenericForeignKey` to a model instance. The content type of this instance is defined by the :ttag:`container` tag which defines this :class:`ContentReference`. + + .. method:: __unicode__() + + Returns :attr:`self.name <name>` \ No newline at end of file diff --git a/LICENSE b/philo/LICENSE similarity index 100% rename from LICENSE rename to philo/LICENSE diff --git a/philo/__init__.py b/philo/__init__.py new file mode 100644 index 0000000..32297e0 --- /dev/null +++ b/philo/__init__.py @@ -0,0 +1 @@ +VERSION = (0, 0) diff --git a/admin/__init__.py b/philo/admin/__init__.py similarity index 100% rename from admin/__init__.py rename to philo/admin/__init__.py diff --git a/admin/base.py b/philo/admin/base.py similarity index 100% rename from admin/base.py rename to philo/admin/base.py diff --git a/admin/collections.py b/philo/admin/collections.py similarity index 86% rename from admin/collections.py rename to philo/admin/collections.py index dfc4826..d422b74 100644 --- a/admin/collections.py +++ b/philo/admin/collections.py @@ -10,6 +10,7 @@ class CollectionMemberInline(admin.TabularInline): classes = COLLAPSE_CLASSES allow_add = True fields = ('member_content_type', 'member_object_id', 'index') + sortable_field_name = 'index' class CollectionAdmin(admin.ModelAdmin): diff --git a/admin/forms/__init__.py b/philo/admin/forms/__init__.py similarity index 100% rename from admin/forms/__init__.py rename to philo/admin/forms/__init__.py diff --git a/admin/forms/attributes.py b/philo/admin/forms/attributes.py similarity index 100% rename from admin/forms/attributes.py rename to philo/admin/forms/attributes.py diff --git a/admin/forms/containers.py b/philo/admin/forms/containers.py similarity index 100% rename from admin/forms/containers.py rename to philo/admin/forms/containers.py diff --git a/admin/nodes.py b/philo/admin/nodes.py similarity index 79% rename from admin/nodes.py rename to philo/admin/nodes.py index 66be107..e2a9c9d 100644 --- a/admin/nodes.py +++ b/philo/admin/nodes.py @@ -1,12 +1,14 @@ from django.contrib import admin from philo.admin.base import EntityAdmin, TreeEntityAdmin, COLLAPSE_CLASSES from philo.models import Node, Redirect, File +from mptt.admin import MPTTModelAdmin class NodeAdmin(TreeEntityAdmin): list_display = ('slug', 'view', 'accepts_subpath') + raw_id_fields = ('parent',) related_lookup_fields = { - 'fk': [], + 'fk': raw_id_fields, 'm2m': [], 'generic': [['view_content_type', 'view_object_id']] } @@ -14,6 +16,9 @@ class NodeAdmin(TreeEntityAdmin): def accepts_subpath(self, obj): return obj.accepts_subpath accepts_subpath.boolean = True + + def formfield_for_foreignkey(self, db_field, request, **kwargs): + return super(MPTTModelAdmin, self).formfield_for_foreignkey(db_field, request, **kwargs) class ViewAdmin(EntityAdmin): diff --git a/admin/pages.py b/philo/admin/pages.py similarity index 84% rename from admin/pages.py rename to philo/admin/pages.py index 13d4098..f9e96c0 100644 --- a/admin/pages.py +++ b/philo/admin/pages.py @@ -46,6 +46,12 @@ class PageAdmin(ViewAdmin): list_filter = ('template',) search_fields = ['title', 'contentlets__content'] inlines = [ContentletInline, ContentReferenceInline] + ViewAdmin.inlines + + def response_add(self, request, obj, post_url_continue='../%s/'): + # Shamelessly cribbed from django/contrib/auth/admin.py:143 + if '_addanother' not in request.POST and '_popup' not in request.POST: + request.POST['_continue'] = 1 + return super(PageAdmin, self).response_add(request, obj, post_url_continue) class TemplateAdmin(TreeAdmin): diff --git a/admin/widgets.py b/philo/admin/widgets.py similarity index 59% rename from admin/widgets.py rename to philo/admin/widgets.py index 7a47c63..fb13ac7 100644 --- a/admin/widgets.py +++ b/philo/admin/widgets.py @@ -1,6 +1,6 @@ from django import forms from django.conf import settings -from django.contrib.admin.widgets import FilteredSelectMultiple +from django.contrib.admin.widgets import FilteredSelectMultiple, url_params_from_lookup_dict from django.utils.translation import ugettext as _ from django.utils.safestring import mark_safe from django.utils.text import truncate_words @@ -10,28 +10,34 @@ from django.utils.html import escape class ModelLookupWidget(forms.TextInput): # is_hidden = False - def __init__(self, content_type, attrs=None): + def __init__(self, content_type, attrs=None, limit_choices_to=None): self.content_type = content_type + self.limit_choices_to = limit_choices_to super(ModelLookupWidget, self).__init__(attrs) def render(self, name, value, attrs=None): related_url = '../../../%s/%s/' % (self.content_type.app_label, self.content_type.model) + params = url_params_from_lookup_dict(self.limit_choices_to) + if params: + url = u'?' + u'&'.join([u'%s=%s' % (k, v) for k, v in params.items()]) + else: + url = u'' if attrs is None: attrs = {} - if not attrs.has_key('class'): + if "class" not in attrs: attrs['class'] = 'vForeignKeyRawIdAdminField' - output = super(ModelLookupWidget, self).render(name, value, attrs) - output += '<a href="%s" class="related-lookup" id="lookup_id_%s" onclick="return showRelatedObjectLookupPopup(this);">' % (related_url, name) - output += '<img src="%simg/admin/selector-search.gif" width="16" height="16" alt="%s" />' % (settings.ADMIN_MEDIA_PREFIX, _('Lookup')) - output += '</a>' + output = [super(ModelLookupWidget, self).render(name, value, attrs)] + output.append('<a href="%s%s" class="related-lookup" id="lookup_id_%s" onclick="return showRelatedObjectLookupPopup(this);">' % (related_url, url, name)) + output.append('<img src="%simg/admin/selector-search.gif" width="16" height="16" alt="%s" />' % (settings.ADMIN_MEDIA_PREFIX, _('Lookup'))) + output.append('</a>') if value: value_class = self.content_type.model_class() try: value_object = value_class.objects.get(pk=value) - output += ' <strong>%s</strong>' % escape(truncate_words(value_object, 14)) + output.append(' <strong>%s</strong>' % escape(truncate_words(value_object, 14))) except value_class.DoesNotExist: pass - return mark_safe(output) + return mark_safe(u''.join(output)) class TagFilteredSelectMultiple(FilteredSelectMultiple): @@ -42,15 +48,12 @@ class TagFilteredSelectMultiple(FilteredSelectMultiple): catalog has been loaded in the page """ class Media: - js = (settings.ADMIN_MEDIA_PREFIX + "js/core.js", - settings.ADMIN_MEDIA_PREFIX + "js/SelectBox.js", - settings.ADMIN_MEDIA_PREFIX + "js/SelectFilter2.js") - - if 'staticmedia' in settings.INSTALLED_APPS: - import staticmedia - js += (staticmedia.url('admin/js/TagCreation.js'),) - else: - js += (settings.ADMIN_MEDIA_PREFIX + "js/TagCreation.js",) + js = ( + settings.ADMIN_MEDIA_PREFIX + "js/core.js", + settings.ADMIN_MEDIA_PREFIX + "js/SelectBox.js", + settings.ADMIN_MEDIA_PREFIX + "js/SelectFilter2.js", + settings.ADMIN_MEDIA_PREFIX + "js/TagCreation.js", + ) def render(self, name, value, attrs=None, choices=()): if attrs is None: attrs = {} diff --git a/contrib/julian/__init__.py b/philo/contrib/__init__.py similarity index 100% rename from contrib/julian/__init__.py rename to philo/contrib/__init__.py diff --git a/contrib/julian/migrations/__init__.py b/philo/contrib/julian/__init__.py similarity index 100% rename from contrib/julian/migrations/__init__.py rename to philo/contrib/julian/__init__.py diff --git a/contrib/julian/admin.py b/philo/contrib/julian/admin.py similarity index 100% rename from contrib/julian/admin.py rename to philo/contrib/julian/admin.py diff --git a/contrib/julian/feedgenerator.py b/philo/contrib/julian/feedgenerator.py similarity index 100% rename from contrib/julian/feedgenerator.py rename to philo/contrib/julian/feedgenerator.py diff --git a/contrib/julian/migrations/0001_initial.py b/philo/contrib/julian/migrations/0001_initial.py similarity index 100% rename from contrib/julian/migrations/0001_initial.py rename to philo/contrib/julian/migrations/0001_initial.py diff --git a/contrib/penfield/__init__.py b/philo/contrib/julian/migrations/__init__.py similarity index 100% rename from contrib/penfield/__init__.py rename to philo/contrib/julian/migrations/__init__.py diff --git a/contrib/julian/models.py b/philo/contrib/julian/models.py similarity index 98% rename from contrib/julian/models.py rename to philo/contrib/julian/models.py index 5dea7a3..5c49c7e 100644 --- a/contrib/julian/models.py +++ b/philo/contrib/julian/models.py @@ -79,10 +79,10 @@ class TimedModel(models.Model): raise ValidationError("A %s cannot end before it starts." % self.__class__.__name__) def get_start(self): - return self.start_date + return datetime.datetime.combine(self.start_date, self.start_time) if self.start_time else self.start_date def get_end(self): - return self.end_date + return datetime.datetime.combine(self.end_date, self.end_time) if self.end_time else self.end_date class Meta: abstract = True diff --git a/contrib/penfield/migrations/__init__.py b/philo/contrib/penfield/__init__.py similarity index 100% rename from contrib/penfield/migrations/__init__.py rename to philo/contrib/penfield/__init__.py diff --git a/contrib/penfield/admin.py b/philo/contrib/penfield/admin.py similarity index 100% rename from contrib/penfield/admin.py rename to philo/contrib/penfield/admin.py diff --git a/contrib/penfield/exceptions.py b/philo/contrib/penfield/exceptions.py similarity index 100% rename from contrib/penfield/exceptions.py rename to philo/contrib/penfield/exceptions.py diff --git a/contrib/penfield/middleware.py b/philo/contrib/penfield/middleware.py similarity index 100% rename from contrib/penfield/middleware.py rename to philo/contrib/penfield/middleware.py diff --git a/contrib/penfield/migrations/0001_initial.py b/philo/contrib/penfield/migrations/0001_initial.py similarity index 100% rename from contrib/penfield/migrations/0001_initial.py rename to philo/contrib/penfield/migrations/0001_initial.py diff --git a/contrib/penfield/migrations/0002_auto.py b/philo/contrib/penfield/migrations/0002_auto.py similarity index 100% rename from contrib/penfield/migrations/0002_auto.py rename to philo/contrib/penfield/migrations/0002_auto.py diff --git a/contrib/penfield/migrations/0003_auto__add_field_newsletterview_feed_type__add_field_newsletterview_ite.py b/philo/contrib/penfield/migrations/0003_auto__add_field_newsletterview_feed_type__add_field_newsletterview_ite.py similarity index 100% rename from contrib/penfield/migrations/0003_auto__add_field_newsletterview_feed_type__add_field_newsletterview_ite.py rename to philo/contrib/penfield/migrations/0003_auto__add_field_newsletterview_feed_type__add_field_newsletterview_ite.py diff --git a/contrib/penfield/migrations/0004_auto__add_field_newsletterview_feed_length__add_field_blogview_feed_le.py b/philo/contrib/penfield/migrations/0004_auto__add_field_newsletterview_feed_length__add_field_blogview_feed_le.py similarity index 100% rename from contrib/penfield/migrations/0004_auto__add_field_newsletterview_feed_length__add_field_blogview_feed_le.py rename to philo/contrib/penfield/migrations/0004_auto__add_field_newsletterview_feed_length__add_field_blogview_feed_le.py diff --git a/contrib/penfield/templatetags/__init__.py b/philo/contrib/penfield/migrations/__init__.py similarity index 100% rename from contrib/penfield/templatetags/__init__.py rename to philo/contrib/penfield/migrations/__init__.py diff --git a/contrib/penfield/models.py b/philo/contrib/penfield/models.py similarity index 100% rename from contrib/penfield/models.py rename to philo/contrib/penfield/models.py diff --git a/contrib/shipherd/__init__.py b/philo/contrib/penfield/templatetags/__init__.py similarity index 100% rename from contrib/shipherd/__init__.py rename to philo/contrib/penfield/templatetags/__init__.py diff --git a/contrib/penfield/templatetags/penfield.py b/philo/contrib/penfield/templatetags/penfield.py similarity index 100% rename from contrib/penfield/templatetags/penfield.py rename to philo/contrib/penfield/templatetags/penfield.py diff --git a/contrib/penfield/validators.py b/philo/contrib/penfield/validators.py similarity index 100% rename from contrib/penfield/validators.py rename to philo/contrib/penfield/validators.py diff --git a/contrib/shipherd/migrations/__init__.py b/philo/contrib/shipherd/__init__.py similarity index 100% rename from contrib/shipherd/migrations/__init__.py rename to philo/contrib/shipherd/__init__.py diff --git a/contrib/shipherd/admin.py b/philo/contrib/shipherd/admin.py similarity index 100% rename from contrib/shipherd/admin.py rename to philo/contrib/shipherd/admin.py diff --git a/contrib/shipherd/migrations/0001_initial.py b/philo/contrib/shipherd/migrations/0001_initial.py similarity index 100% rename from contrib/shipherd/migrations/0001_initial.py rename to philo/contrib/shipherd/migrations/0001_initial.py diff --git a/contrib/shipherd/migrations/0002_auto.py b/philo/contrib/shipherd/migrations/0002_auto.py similarity index 100% rename from contrib/shipherd/migrations/0002_auto.py rename to philo/contrib/shipherd/migrations/0002_auto.py diff --git a/contrib/shipherd/templatetags/__init__.py b/philo/contrib/shipherd/migrations/__init__.py similarity index 100% rename from contrib/shipherd/templatetags/__init__.py rename to philo/contrib/shipherd/migrations/__init__.py diff --git a/contrib/shipherd/models.py b/philo/contrib/shipherd/models.py similarity index 100% rename from contrib/shipherd/models.py rename to philo/contrib/shipherd/models.py diff --git a/contrib/waldo/__init__.py b/philo/contrib/shipherd/templatetags/__init__.py similarity index 100% rename from contrib/waldo/__init__.py rename to philo/contrib/shipherd/templatetags/__init__.py diff --git a/contrib/shipherd/templatetags/shipherd.py b/philo/contrib/shipherd/templatetags/shipherd.py similarity index 98% rename from contrib/shipherd/templatetags/shipherd.py rename to philo/contrib/shipherd/templatetags/shipherd.py index 1413bdf..e3019e1 100644 --- a/contrib/shipherd/templatetags/shipherd.py +++ b/philo/contrib/shipherd/templatetags/shipherd.py @@ -1,4 +1,4 @@ -from django import template +from django import template, VERSION as django_version from django.conf import settings from django.utils.safestring import mark_safe from philo.contrib.shipherd.models import Navigation diff --git a/contrib/sobol/__init__.py b/philo/contrib/sobol/__init__.py similarity index 100% rename from contrib/sobol/__init__.py rename to philo/contrib/sobol/__init__.py diff --git a/contrib/sobol/admin.py b/philo/contrib/sobol/admin.py similarity index 100% rename from contrib/sobol/admin.py rename to philo/contrib/sobol/admin.py diff --git a/contrib/sobol/forms.py b/philo/contrib/sobol/forms.py similarity index 100% rename from contrib/sobol/forms.py rename to philo/contrib/sobol/forms.py diff --git a/contrib/sobol/models.py b/philo/contrib/sobol/models.py similarity index 93% rename from contrib/sobol/models.py rename to philo/contrib/sobol/models.py index b653c09..ee8187d 100644 --- a/contrib/sobol/models.py +++ b/philo/contrib/sobol/models.py @@ -130,13 +130,13 @@ class Click(models.Model): class SearchView(MultiView): results_page = models.ForeignKey(Page, related_name='search_results_related') searches = SlugMultipleChoiceField(choices=registry.iterchoices()) - enable_ajax_api = models.BooleanField("Enable AJAX API", default=True) + enable_ajax_api = models.BooleanField("Enable AJAX API", default=True, help_text="Search results will be available <i>only</i> by AJAX, not as template variables.") placeholder_text = models.CharField(max_length=75, default="Search") search_form = SearchForm def __unicode__(self): - return u"%s (%s)" % (self.placeholder_text, u", ".join([display for slug, display in registry.iterchoices()])) + return u"%s (%s)" % (self.placeholder_text, u", ".join([display for slug, display in registry.iterchoices() if slug in self.searches])) def get_reverse_params(self, obj): raise ViewCanNotProvideSubpath @@ -198,7 +198,7 @@ class SearchView(MultiView): }) else: context.update({ - 'searches': [{'verbose_name': verbose_name, 'url': self.reverse('ajax_api_view', kwargs={'slug': slug}, node=request.node)} for slug, verbose_name in registry.iterchoices()] + 'searches': [{'verbose_name': verbose_name, 'slug': slug, 'url': self.reverse('ajax_api_view', kwargs={'slug': slug}, node=request.node), 'result_template': registry[slug].result_template} for slug, verbose_name in registry.iterchoices() if slug in self.searches] }) else: form = SearchForm() diff --git a/contrib/sobol/search.py b/philo/contrib/sobol/search.py similarity index 90% rename from contrib/sobol/search.py rename to philo/contrib/sobol/search.py index 36c2b5d..39b93c7 100644 --- a/contrib/sobol/search.py +++ b/philo/contrib/sobol/search.py @@ -25,9 +25,10 @@ __all__ = ( SEARCH_CACHE_KEY = 'philo_sobol_search_results' DEFAULT_RESULT_TEMPLATE_STRING = "{% if url %}<a href='{{ url }}'>{% endif %}{{ title }}{% if url %}</a>{% endif %}" +DEFAULT_RESULT_TEMPLATE = Template(DEFAULT_RESULT_TEMPLATE_STRING) # Determines the timeout on the entire result cache. -MAX_CACHE_TIMEOUT = 60*60*24*7 +MAX_CACHE_TIMEOUT = 60*24*7 class RegistrationError(Exception): @@ -42,8 +43,9 @@ class SearchRegistry(object): def register(self, search, slug=None): slug = slug or search.slug if slug in self._registry: - if self._registry[slug] != search: - raise RegistrationError("A different search is already registered as `%s`") + registered = self._registry[slug] + if registered.__module__ != search.__module__: + raise RegistrationError("A different search is already registered as `%s`" % slug) else: self._registry[slug] = search @@ -93,7 +95,10 @@ class Result(object): return self.search.get_result_title(self.result) def get_url(self): - return "?%s" % self.search.get_result_querydict(self.result).urlencode() + qd = self.search.get_result_querydict(self.result) + if qd is None: + return "" + return "?%s" % qd.urlencode() def get_template(self): return self.search.get_result_template(self.result) @@ -170,7 +175,7 @@ class BaseSearch(object): limit = self.result_limit if limit is not None: limit += 1 - results = self.get_results(self.result_limit) + results = self.get_results(limit) except: if settings.DEBUG: raise @@ -209,13 +214,16 @@ class BaseSearch(object): raise NotImplementedError def get_result_querydict(self, result): - return make_tracking_querydict(self.search_arg, self.get_result_url(result)) + url = self.get_result_url(result) + if url is None: + return None + return make_tracking_querydict(self.search_arg, url) def get_result_template(self, result): if hasattr(self, 'result_template'): return loader.get_template(self.result_template) if not hasattr(self, '_result_template'): - self._result_template = Template(DEFAULT_RESULT_TEMPLATE_STRING) + self._result_template = DEFAULT_RESULT_TEMPLATE return self._result_template def get_result_extra_context(self, result): @@ -244,9 +252,6 @@ class BaseSearch(object): class DatabaseSearch(BaseSearch): model = None - def has_more_results(self): - return self.get_queryset().count() > self.result_limit - def search(self, limit=None): if not hasattr(self, '_qs'): self._qs = self.get_queryset() @@ -295,10 +300,21 @@ class JSONSearch(URLSearch): class GoogleSearch(JSONSearch): search_url = "http://ajax.googleapis.com/ajax/services/search/web" - query_format_str = "?v=1.0&q=%s" # TODO: Change this template to reflect the app's actual name. result_template = 'search/googlesearch.html' - timeout = 60 + _cache_timeout = 60 + verbose_name = "Google search (current site)" + + @property + def query_format_str(self): + default_args = self.default_args + if default_args: + default_args += " " + return "?v=1.0&q=%s%%s" % urlquote_plus(default_args).replace('%', '%%') + + @property + def default_args(self): + return "site:%s" % Site.objects.get_current().domain def parse_response(self, response, limit=None): responseData = json.loads(response.read())['responseData'] @@ -361,7 +377,7 @@ else: def parse_response(self, response, limit=None): strainer = self.strainer soup = BeautifulSoup(response, parseOnlyThese=strainer) - return self.parse_results(soup[:limit]) + return self.parse_results(soup.findAll(recursive=False, limit=limit)) def parse_results(self, results): """ @@ -378,5 +394,5 @@ else: def parse_response(self, response, limit=None): strainer = self.strainer - soup = BeautifulStoneSoup(page, selfClosingTags=self._self_closing_tags, parseOnlyThese=strainer) - return self.parse_results(soup[:limit]) \ No newline at end of file + soup = BeautifulStoneSoup(response, selfClosingTags=self._self_closing_tags, parseOnlyThese=strainer) + return self.parse_results(soup.findAll(recursive=False, limit=limit)) \ No newline at end of file diff --git a/contrib/sobol/templates/admin/sobol/search/grappelli_results.html b/philo/contrib/sobol/templates/admin/sobol/search/grappelli_results.html similarity index 100% rename from contrib/sobol/templates/admin/sobol/search/grappelli_results.html rename to philo/contrib/sobol/templates/admin/sobol/search/grappelli_results.html diff --git a/contrib/sobol/templates/admin/sobol/search/results.html b/philo/contrib/sobol/templates/admin/sobol/search/results.html similarity index 100% rename from contrib/sobol/templates/admin/sobol/search/results.html rename to philo/contrib/sobol/templates/admin/sobol/search/results.html diff --git a/contrib/sobol/templates/search/googlesearch.html b/philo/contrib/sobol/templates/search/googlesearch.html similarity index 100% rename from contrib/sobol/templates/search/googlesearch.html rename to philo/contrib/sobol/templates/search/googlesearch.html diff --git a/contrib/sobol/utils.py b/philo/contrib/sobol/utils.py similarity index 100% rename from contrib/sobol/utils.py rename to philo/contrib/sobol/utils.py diff --git a/loaders/__init__.py b/philo/contrib/waldo/__init__.py similarity index 100% rename from loaders/__init__.py rename to philo/contrib/waldo/__init__.py diff --git a/contrib/waldo/forms.py b/philo/contrib/waldo/forms.py similarity index 100% rename from contrib/waldo/forms.py rename to philo/contrib/waldo/forms.py diff --git a/contrib/waldo/models.py b/philo/contrib/waldo/models.py similarity index 100% rename from contrib/waldo/models.py rename to philo/contrib/waldo/models.py diff --git a/contrib/waldo/tokens.py b/philo/contrib/waldo/tokens.py similarity index 100% rename from contrib/waldo/tokens.py rename to philo/contrib/waldo/tokens.py diff --git a/exceptions.py b/philo/exceptions.py similarity index 100% rename from exceptions.py rename to philo/exceptions.py diff --git a/fixtures/test_fixtures.json b/philo/fixtures/test_fixtures.json similarity index 100% rename from fixtures/test_fixtures.json rename to philo/fixtures/test_fixtures.json diff --git a/forms/__init__.py b/philo/forms/__init__.py similarity index 100% rename from forms/__init__.py rename to philo/forms/__init__.py diff --git a/forms/entities.py b/philo/forms/entities.py similarity index 100% rename from forms/entities.py rename to philo/forms/entities.py diff --git a/forms/fields.py b/philo/forms/fields.py similarity index 100% rename from forms/fields.py rename to philo/forms/fields.py diff --git a/templatetags/__init__.py b/philo/loaders/__init__.py similarity index 100% rename from templatetags/__init__.py rename to philo/loaders/__init__.py diff --git a/loaders/database.py b/philo/loaders/database.py similarity index 100% rename from loaders/database.py rename to philo/loaders/database.py diff --git a/middleware.py b/philo/middleware.py similarity index 100% rename from middleware.py rename to philo/middleware.py diff --git a/migrations/0001_initial.py b/philo/migrations/0001_initial.py similarity index 100% rename from migrations/0001_initial.py rename to philo/migrations/0001_initial.py diff --git a/migrations/0002_auto__add_field_attribute_value.py b/philo/migrations/0002_auto__add_field_attribute_value.py similarity index 100% rename from migrations/0002_auto__add_field_attribute_value.py rename to philo/migrations/0002_auto__add_field_attribute_value.py diff --git a/migrations/0003_move_json.py b/philo/migrations/0003_move_json.py similarity index 100% rename from migrations/0003_move_json.py rename to philo/migrations/0003_move_json.py diff --git a/migrations/0004_auto__del_field_attribute_json_value.py b/philo/migrations/0004_auto__del_field_attribute_json_value.py similarity index 100% rename from migrations/0004_auto__del_field_attribute_json_value.py rename to philo/migrations/0004_auto__del_field_attribute_json_value.py diff --git a/migrations/0005_add_attribute_values.py b/philo/migrations/0005_add_attribute_values.py similarity index 100% rename from migrations/0005_add_attribute_values.py rename to philo/migrations/0005_add_attribute_values.py diff --git a/migrations/0006_move_attribute_and_relationship_values.py b/philo/migrations/0006_move_attribute_and_relationship_values.py similarity index 100% rename from migrations/0006_move_attribute_and_relationship_values.py rename to philo/migrations/0006_move_attribute_and_relationship_values.py diff --git a/migrations/0007_auto__del_relationship__del_field_attribute_value.py b/philo/migrations/0007_auto__del_relationship__del_field_attribute_value.py similarity index 100% rename from migrations/0007_auto__del_relationship__del_field_attribute_value.py rename to philo/migrations/0007_auto__del_relationship__del_field_attribute_value.py diff --git a/migrations/0008_auto__del_field_manytomanyvalue_object_ids.py b/philo/migrations/0008_auto__del_field_manytomanyvalue_object_ids.py similarity index 100% rename from migrations/0008_auto__del_field_manytomanyvalue_object_ids.py rename to philo/migrations/0008_auto__del_field_manytomanyvalue_object_ids.py diff --git a/migrations/0009_auto__add_field_node_lft__add_field_node_rght__add_field_node_tree_id_.py b/philo/migrations/0009_auto__add_field_node_lft__add_field_node_rght__add_field_node_tree_id_.py similarity index 100% rename from migrations/0009_auto__add_field_node_lft__add_field_node_rght__add_field_node_tree_id_.py rename to philo/migrations/0009_auto__add_field_node_lft__add_field_node_rght__add_field_node_tree_id_.py diff --git a/migrations/0010_auto__add_field_redirect_target_node__add_field_redirect_url_or_subpat.py b/philo/migrations/0010_auto__add_field_redirect_target_node__add_field_redirect_url_or_subpat.py similarity index 100% rename from migrations/0010_auto__add_field_redirect_target_node__add_field_redirect_url_or_subpat.py rename to philo/migrations/0010_auto__add_field_redirect_target_node__add_field_redirect_url_or_subpat.py diff --git a/migrations/0011_move_target_url.py b/philo/migrations/0011_move_target_url.py similarity index 100% rename from migrations/0011_move_target_url.py rename to philo/migrations/0011_move_target_url.py diff --git a/migrations/0012_auto__del_field_redirect_target.py b/philo/migrations/0012_auto__del_field_redirect_target.py similarity index 100% rename from migrations/0012_auto__del_field_redirect_target.py rename to philo/migrations/0012_auto__del_field_redirect_target.py diff --git a/migrations/0013_auto.py b/philo/migrations/0013_auto.py similarity index 100% rename from migrations/0013_auto.py rename to philo/migrations/0013_auto.py diff --git a/migrations/0014_auto.py b/philo/migrations/0014_auto.py similarity index 100% rename from migrations/0014_auto.py rename to philo/migrations/0014_auto.py diff --git a/migrations/__init__.py b/philo/migrations/__init__.py similarity index 100% rename from migrations/__init__.py rename to philo/migrations/__init__.py diff --git a/models/__init__.py b/philo/models/__init__.py similarity index 100% rename from models/__init__.py rename to philo/models/__init__.py diff --git a/models/base.py b/philo/models/base.py similarity index 73% rename from models/base.py rename to philo/models/base.py index af1e880..cf420c7 100644 --- a/models/base.py +++ b/philo/models/base.py @@ -38,10 +38,12 @@ class Titled(models.Model): abstract = True +#: An instance of :class:`ContentTypeRegistryLimiter` which is used to track the content types which can be related to by ForeignKeyValues and ManyToManyValues. value_content_type_limiter = ContentTypeRegistryLimiter() def register_value_model(model): + """Registers a model as a valid content type for a :class:`ForeignKeyValue` or :class:`ManyToManyValue` through the :data:`value_content_type_limiter`.""" value_content_type_limiter.register_class(model) @@ -49,21 +51,37 @@ register_value_model(Tag) def unregister_value_model(model): + """Registers a model as a valid content type for a :class:`ForeignKeyValue` or :class:`ManyToManyValue` through the :data:`value_content_type_limiter`.""" value_content_type_limiter.unregister_class(model) class AttributeValue(models.Model): + """ + This is an abstract base class for models that can be used as values for :class:`Attribute`\ s. + + AttributeValue subclasses are expected to supply access to a clean version of their value through an attribute called "value". + + """ + + #: :class:`GenericRelation` to :class:`Attribute` attribute_set = generic.GenericRelation('Attribute', content_type_field='value_content_type', object_id_field='value_object_id') def set_value(self, value): + """Given a ``value``, sets the appropriate fields so that it can be correctly stored in the database.""" raise NotImplementedError def value_formfields(self, **kwargs): - """Define any formfields that would be used to construct an instance of this value.""" + """ + Returns any formfields that would be used to construct an instance of this value. + + :returns: A dictionary mapping field names to formfields. + + """ + raise NotImplementedError def construct_instance(self, **kwargs): - """Apply cleaned data from the formfields generated by valid_formfields to oneself.""" + """Applies cleaned data from the formfields generated by valid_formfields to oneself.""" raise NotImplementedError def __unicode__(self): @@ -73,10 +91,12 @@ class AttributeValue(models.Model): abstract = True +#: An instance of :class:`ContentTypeSubclassLimiter` which is used to track the content types which are considered valid value models for an :class:`Attribute`. attribute_value_limiter = ContentTypeSubclassLimiter(AttributeValue) class JSONValue(AttributeValue): + """Stores a python object as a json string.""" value = JSONField(verbose_name='Value (JSON)', help_text='This value must be valid JSON.', default='null', db_index=True) def __unicode__(self): @@ -99,6 +119,7 @@ class JSONValue(AttributeValue): class ForeignKeyValue(AttributeValue): + """Stores a generic relationship to an instance of any value content type (as defined by the :data:`value_content_type_limiter`).""" content_type = models.ForeignKey(ContentType, limit_choices_to=value_content_type_limiter, verbose_name='Value type', null=True, blank=True) object_id = models.PositiveIntegerField(verbose_name='Value ID', null=True, blank=True, db_index=True) value = generic.GenericForeignKey() @@ -136,6 +157,7 @@ class ForeignKeyValue(AttributeValue): class ManyToManyValue(AttributeValue): + """Stores a generic relationship to many instances of any value content type (as defined by the :data:`value_content_type_limiter`).""" content_type = models.ForeignKey(ContentType, limit_choices_to=value_content_type_limiter, verbose_name='Value type', null=True, blank=True) values = models.ManyToManyField(ForeignKeyValue, blank=True, null=True) @@ -215,14 +237,20 @@ class ManyToManyValue(AttributeValue): class Attribute(models.Model): + """Represents an arbitrary key/value pair on an arbitrary :class:`Model` where the key consists of word characters and the value is a subclass of :class:`AttributeValue`.""" entity_content_type = models.ForeignKey(ContentType, related_name='attribute_entity_set', verbose_name='Entity type') entity_object_id = models.PositiveIntegerField(verbose_name='Entity ID', db_index=True) + + #: :class:`GenericForeignKey` to anything (generally an instance of an Entity subclass). entity = generic.GenericForeignKey('entity_content_type', 'entity_object_id') value_content_type = models.ForeignKey(ContentType, related_name='attribute_value_set', limit_choices_to=attribute_value_limiter, verbose_name='Value type', null=True, blank=True) value_object_id = models.PositiveIntegerField(verbose_name='Value ID', null=True, blank=True, db_index=True) + + #: :class:`GenericForeignKey` to an instance of a subclass of :class:`AttributeValue` as determined by the :data:`attribute_value_limiter`. value = generic.GenericForeignKey('value_content_type', 'value_object_id') + #: :class:`CharField` containing a key (up to 255 characters) consisting of alphanumeric characters and underscores. key = models.CharField(max_length=255, validators=[RegexValidator("\w+")], help_text="Must contain one or more alphanumeric characters or underscores.", db_index=True) def __unicode__(self): @@ -279,12 +307,26 @@ class EntityBase(models.base.ModelBase): class Entity(models.Model): + """An abstract class that simplifies access to related attributes. Most models provided by Philo subclass Entity.""" __metaclass__ = EntityBase attribute_set = generic.GenericRelation(Attribute, content_type_field='entity_content_type', object_id_field='entity_object_id') @property def attributes(self): + """ + Property that returns a dictionary-like object which can be used to retrieve related :class:`Attribute`\ s' values directly. + + Example:: + + >>> attr = entity.attribute_set.get(key='spam') + >>> attr.value.value + u'eggs' + >>> entity.attributes['spam'] + u'eggs' + + """ + return QuerySetMapper(self.attribute_set.all()) class Meta: @@ -296,19 +338,21 @@ class TreeManager(models.Manager): def get_with_path(self, path, root=None, absolute_result=True, pathsep='/', field='slug'): """ - Returns the object with the path, unless absolute_result is set to False, in which - case it returns a tuple containing the deepest object found along the path, and the - remainder of the path after that object as a string (or None if there is no remaining - path). Raises a DoesNotExist exception if no object is found with the given path. - - If the path you're searching for is known to exist, it is always faster to use - absolute_result=True - unless the path depth is over ~40, in which case the high cost - of the absolute query makes a binary search (i.e. non-absolute) faster. + If ``absolute_result`` is ``True``, returns the object at ``path`` (starting at ``root``) or raises a :exception:`DoesNotExist` exception. Otherwise, returns a tuple containing the deepest object found along ``path`` (or ``root`` if no deeper object is found) and the remainder of the path after that object as a string (or None if there is no remaining path). + + .. note:: If you are looking for something with an exact path, it is faster to use absolute_result=True, unless the path depth is over ~40, in which case the high cost of the absolute query may make a binary search (i.e. non-absolute) faster. + + .. note:: SQLite allows max of 64 tables in one join. That means the binary search will only work on paths with a max depth of 127 and the absolute fetch will only work to a max depth of (surprise!) 63. Larger depths could be handled, but since the common use case will not have a tree structure that deep, they are not. + + :param path: The path of the object + :param root: The object which will be considered the root of the search + :param absolute_result: Whether to return an absolute result or do a binary search + :param pathsep: The path separator used in ``path`` + :param field: The field on the model which should be queried for ``path`` segment matching. + :returns: An instance if absolute_result is True or (instance, remaining_path) otherwise. + """ - # Note: SQLite allows max of 64 tables in one join. That means the binary search will - # only work on paths with a max depth of 127 and the absolute fetch will only work - # to a max depth of (surprise!) 63. Although this could be handled, chances are your - # tree structure won't be that deep. + segments = path.split(pathsep) # Clean out blank segments. Handles multiple consecutive pathseps. @@ -407,6 +451,14 @@ class TreeModel(MPTTModel): slug = models.SlugField(max_length=255) def get_path(self, root=None, pathsep='/', field='slug'): + """ + :param root: Only return the path since this object. + :param pathsep: The path separator to use when constructing an instance's path + :param field: The field to pull path information from for each ancestor. + :returns: A string representation of an object's path. + + """ + if root == self: return '' @@ -438,10 +490,27 @@ class TreeEntityBase(MPTTModelBase, EntityBase): class TreeEntity(Entity, TreeModel): + """An abstract subclass of Entity which represents a tree relationship.""" + __metaclass__ = TreeEntityBase @property def attributes(self): + """ + Property that returns a dictionary-like object which can be used to retrieve related :class:`Attribute`\ s' values directly. If an attribute with a given key is not related to the :class:`Entity`, then the object will check the parent's attributes. + + Example:: + + >>> attr = entity.attribute_set.get(key='spam') + DoesNotExist: Attribute matching query does not exist. + >>> attr = entity.parent.attribute_set.get(key='spam') + >>> attr.value.value + u'eggs' + >>> entity.attributes['spam'] + u'eggs' + + """ + if self.parent: return QuerySetMapper(self.attribute_set.all(), passthrough=self.parent.attributes) return super(TreeEntity, self).attributes diff --git a/models/collections.py b/philo/models/collections.py similarity index 100% rename from models/collections.py rename to philo/models/collections.py diff --git a/models/fields/__init__.py b/philo/models/fields/__init__.py similarity index 100% rename from models/fields/__init__.py rename to philo/models/fields/__init__.py diff --git a/models/fields/entities.py b/philo/models/fields/entities.py similarity index 100% rename from models/fields/entities.py rename to philo/models/fields/entities.py diff --git a/models/nodes.py b/philo/models/nodes.py similarity index 100% rename from models/nodes.py rename to philo/models/nodes.py diff --git a/models/pages.py b/philo/models/pages.py similarity index 99% rename from models/pages.py rename to philo/models/pages.py index 86db88f..2221ee4 100644 --- a/models/pages.py +++ b/philo/models/pages.py @@ -171,6 +171,9 @@ class Page(View): return self.title def clean_fields(self, exclude=None): + if exclude is None: + exclude = [] + try: super(Page, self).clean_fields(exclude) except ValidationError, e: diff --git a/signals.py b/philo/signals.py similarity index 100% rename from signals.py rename to philo/signals.py diff --git a/media/admin/js/TagCreation.js b/philo/static/admin/js/TagCreation.js similarity index 100% rename from media/admin/js/TagCreation.js rename to philo/static/admin/js/TagCreation.js diff --git a/templates/admin/philo/edit_inline/grappelli_tabular_attribute.html b/philo/templates/admin/philo/edit_inline/grappelli_tabular_attribute.html similarity index 56% rename from templates/admin/philo/edit_inline/grappelli_tabular_attribute.html rename to philo/templates/admin/philo/edit_inline/grappelli_tabular_attribute.html index ccead57..25c1ac4 100644 --- a/templates/admin/philo/edit_inline/grappelli_tabular_attribute.html +++ b/philo/templates/admin/philo/edit_inline/grappelli_tabular_attribute.html @@ -1,4 +1,4 @@ -{% load i18n adminmedia %} +{% load i18n adminmedia grp_tags %} <!-- group --> <div class="group tabular{% if inline_admin_formset.opts.classes %} {{ inline_admin_formset.opts.classes|join:" " }}{% endif %}" @@ -84,43 +84,90 @@ <script type="text/javascript"> (function($) { - $(document).ready(function($) { - - $("#{{ inline_admin_formset.formset.prefix }}-group").grp_inline({ - prefix: "{{ inline_admin_formset.formset.prefix }}", - onBeforeAdded: function(inline) {}, - onAfterAdded: function(form) { - grappelli.reinitDateTimeFields(form); - grappelli.updateSelectFilter(form); - form.find("input.vForeignKeyRawIdAdminField").grp_related_fk({lookup_url:"{% url grp_related_lookup %}"}); - form.find("input.vManyToManyRawIdAdminField").grp_related_m2m({lookup_url:"{% url grp_m2m_lookup %}"}); - form.find("input[name*='object_id'][name$='id']").grp_related_generic({lookup_url:"{% url grp_related_lookup %}"}); - }, - }); - - {% if inline_admin_formset.opts.sortable_field_name %} - $("#{{ inline_admin_formset.formset.prefix }}-group > div.table").sortable({ - handle: "a.drag-handler", - items: "div.dynamic-form", - axis: "y", - appendTo: 'body', - forceHelperSize: true, - containment: '#{{ inline_admin_formset.formset.prefix }}-group > div.table', - tolerance: 'pointer', - }); - $("#{{ opts.module_name }}_form").bind("submit", function(){ - var sortable_field_name = "{{ inline_admin_formset.opts.sortable_field_name }}"; - var i = 0; - $("#{{ inline_admin_formset.formset.prefix }}-group").find("div.dynamic-form").each(function(){ - var fields = $(this).find("div.td :input[value]"); - if (fields.serialize()) { - $(this).find("input[name$='"+sortable_field_name+"']").val(i); - i++; - } - }); - }); - {% endif %} - - }); + $(document).ready(function($) { + + var prefix = "{{ inline_admin_formset.formset.prefix }}"; + var related_lookup_fields_fk = {% get_related_lookup_fields_fk inline_admin_formset.opts %}; + var related_lookup_fields_m2m = {% get_related_lookup_fields_m2m inline_admin_formset.opts %}; + var related_lookup_fields_generic = {% get_related_lookup_fields_generic inline_admin_formset.opts %}; + $.each(related_lookup_fields_fk, function() { + $("#{{ inline_admin_formset.formset.prefix }}-group > div.table") + .find("input[name^='" + prefix + "'][name$='" + this + "']") + .grp_related_fk({lookup_url:"{% url grp_related_lookup %}"}); + }); + $.each(related_lookup_fields_m2m, function() { + $("#{{ inline_admin_formset.formset.prefix }}-group > div.table") + .find("input[name^='" + prefix + "'][name$='" + this + "']") + .grp_related_m2m({lookup_url:"{% url grp_m2m_lookup %}"}); + }); + $.each(related_lookup_fields_generic, function() { + var content_type = this[0], + object_id = this[1]; + $("#{{ inline_admin_formset.formset.prefix }}-group > div.table") + .find("input[name^='" + prefix + "'][name$='" + this[1] + "']") + .each(function() { + var i = $(this).attr("id").match(/-\d+-/); + if (i) { + var ct_id = "#id_" + prefix + i[0] + content_type, + obj_id = "#id_" + prefix + i[0] + object_id; + $(this).grp_related_generic({content_type:ct_id, object_id:obj_id, lookup_url:"{% url grp_related_lookup %}"}); + } + }); + }); + + $("#{{ inline_admin_formset.formset.prefix }}-group").grp_inline({ + prefix: "{{ inline_admin_formset.formset.prefix }}", + onBeforeAdded: function(inline) {}, + onAfterAdded: function(form) { + grappelli.reinitDateTimeFields(form); + grappelli.updateSelectFilter(form); + $.each(related_lookup_fields_fk, function() { + form.find("input[name^='" + prefix + "'][name$='" + this + "']") + .grp_related_fk({lookup_url:"{% url grp_related_lookup %}"}); + }); + $.each(related_lookup_fields_m2m, function() { + form.find("input[name^='" + prefix + "'][name$='" + this + "']") + .grp_related_m2m({lookup_url:"{% url grp_m2m_lookup %}"}); + }); + $.each(related_lookup_fields_generic, function() { + var content_type = this[0], + object_id = this[1]; + form.find("input[name^='" + prefix + "'][name$='" + this[1] + "']") + .each(function() { + var i = $(this).attr("id").match(/-\d+-/); + if (i) { + var ct_id = "#id_" + prefix + i[0] + content_type, + obj_id = "#id_" + prefix + i[0] + object_id; + $(this).grp_related_generic({content_type:ct_id, object_id:obj_id, lookup_url:"{% url grp_related_lookup %}"}); + } + }); + }); + }, + }); + + {% if inline_admin_formset.opts.sortable_field_name %} + $("#{{ inline_admin_formset.formset.prefix }}-group > div.table").sortable({ + handle: "a.drag-handler", + items: "div.dynamic-form", + axis: "y", + appendTo: 'body', + forceHelperSize: true, + containment: '#{{ inline_admin_formset.formset.prefix }}-group > div.table', + tolerance: 'pointer', + }); + $("#{{ opts.module_name }}_form").bind("submit", function(){ + var sortable_field_name = "{{ inline_admin_formset.opts.sortable_field_name }}"; + var i = 0; + $("#{{ inline_admin_formset.formset.prefix }}-group").find("div.dynamic-form").each(function(){ + var fields = $(this).find("div.td :input[value]"); + if (fields.serialize()) { + $(this).find("input[name$='"+sortable_field_name+"']").val(i); + i++; + } + }); + }); + {% endif %} + + }); })(django.jQuery); </script> diff --git a/templates/admin/philo/edit_inline/grappelli_tabular_container.html b/philo/templates/admin/philo/edit_inline/grappelli_tabular_container.html similarity index 81% rename from templates/admin/philo/edit_inline/grappelli_tabular_container.html rename to philo/templates/admin/philo/edit_inline/grappelli_tabular_container.html index 59aba8f..621fea6 100644 --- a/templates/admin/philo/edit_inline/grappelli_tabular_container.html +++ b/philo/templates/admin/philo/edit_inline/grappelli_tabular_container.html @@ -20,12 +20,13 @@ {% endfor %}{% endspaceless %} {% endfor %} {% for form in inline_admin_formset.formset.forms %} - <div class="row cells-{{ form.fields.keys|length }}{% if not form.fields.keys|length_is:"2" %} cells{% endif %}{% if form.errors %} errors{% endif %} {% for field in form %}{{ field.field.name }} {% endfor %}{% comment %} {% if forloop.last %} empty-form{% endif %}{% endcomment %}"> + <div class="row cells-{{ form.fields|length }} cells{% if form.errors %} errors{% endif %}{% for field in form %} {{ field.field.name }}{% endfor %}"> {{ form.non_field_errors }} - <div{% if not form.fields.keys|length_is:"2" %} class="cell"{% endif %}> - <div class="column span-4"><label class='required' for="{{ form.content.auto_id }}{{ form.content_id.auto_id }}">{{ form.verbose_name|capfirst }}:</label></div> + <div> {% for field in form %} {% if not field.is_hidden %} + {% comment %}This will be true for one field: the content/content reference{% endcomment %} + <div class="column span-4"><label class='required' for="{{ form.content.auto_id }}{{ form.content_id.auto_id }}">{{ form.verbose_name|capfirst }}:</label></div> <div class="column span-flexible"> {{ field }} {{ field.errors }} diff --git a/templates/admin/philo/edit_inline/tabular_attribute.html b/philo/templates/admin/philo/edit_inline/tabular_attribute.html similarity index 100% rename from templates/admin/philo/edit_inline/tabular_attribute.html rename to philo/templates/admin/philo/edit_inline/tabular_attribute.html diff --git a/templates/admin/philo/edit_inline/tabular_container.html b/philo/templates/admin/philo/edit_inline/tabular_container.html similarity index 100% rename from templates/admin/philo/edit_inline/tabular_container.html rename to philo/templates/admin/philo/edit_inline/tabular_container.html diff --git a/philo/templates/admin/philo/page/add_form.html b/philo/templates/admin/philo/page/add_form.html new file mode 100644 index 0000000..b2a6358 --- /dev/null +++ b/philo/templates/admin/philo/page/add_form.html @@ -0,0 +1,14 @@ +{% extends "admin/change_form.html" %} +{% load i18n %} + +{% block form_top %} + {% if not is_popup %} + <p>{% trans "First, choose a template. After saving, you'll be able to provide additional content for containers." %}</p> + {% else %} + <p>{% trans "Choose a template" %}</p> + {% endif %} +{% endblock %} + +{% block after_field_sets %} +<script type="text/javascript">document.getElementById("id_name").focus();</script> +{% endblock %} \ No newline at end of file diff --git a/philo/templatetags/__init__.py b/philo/templatetags/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/templatetags/collections.py b/philo/templatetags/collections.py similarity index 100% rename from templatetags/collections.py rename to philo/templatetags/collections.py diff --git a/templatetags/containers.py b/philo/templatetags/containers.py similarity index 100% rename from templatetags/containers.py rename to philo/templatetags/containers.py diff --git a/templatetags/embed.py b/philo/templatetags/embed.py similarity index 100% rename from templatetags/embed.py rename to philo/templatetags/embed.py diff --git a/templatetags/include_string.py b/philo/templatetags/include_string.py similarity index 100% rename from templatetags/include_string.py rename to philo/templatetags/include_string.py diff --git a/templatetags/nodes.py b/philo/templatetags/nodes.py similarity index 100% rename from templatetags/nodes.py rename to philo/templatetags/nodes.py diff --git a/tests.py b/philo/tests.py similarity index 94% rename from tests.py rename to philo/tests.py index 96ac7b6..a0e0184 100644 --- a/tests.py +++ b/philo/tests.py @@ -1,13 +1,17 @@ -from django.test import TestCase +import sys +import traceback + from django import template from django.conf import settings from django.db import connection from django.template import loader from django.template.loaders import cached +from django.test import TestCase +from django.test.utils import setup_test_template_loader + +from philo.contrib.penfield.models import Blog, BlogView, BlogEntry from philo.exceptions import AncestorDoesNotExist from philo.models import Node, Page, Template -from philo.contrib.penfield.models import Blog, BlogView, BlogEntry -import sys, traceback class TemplateTestCase(TestCase): @@ -17,19 +21,15 @@ class TemplateTestCase(TestCase): "Tests to make sure that embed behaves with complex includes and extends" template_tests = self.get_template_tests() - # Register our custom template loader. Shamelessly cribbed from django core regressiontests. - def test_template_loader(template_name, template_dirs=None): - "A custom template loader that loads the unit-test templates." - try: - return (template_tests[template_name][0] , "test:%s" % template_name) - except KeyError: - raise template.TemplateDoesNotExist, template_name - - cache_loader = cached.Loader(('test_template_loader',)) - cache_loader._cached_loaders = (test_template_loader,) + # Register our custom template loader. Shamelessly cribbed from django/tests/regressiontests/templates/tests.py:384. + cache_loader = setup_test_template_loader( + dict([(name, t[0]) for name, t in template_tests.iteritems()]), + use_cached_loader=True, + ) - old_template_loaders = loader.template_source_loaders - loader.template_source_loaders = [cache_loader] + failures = [] + tests = template_tests.items() + tests.sort() # Turn TEMPLATE_DEBUG off, because tests assume that. old_td, settings.TEMPLATE_DEBUG = settings.TEMPLATE_DEBUG, False @@ -38,9 +38,6 @@ class TemplateTestCase(TestCase): old_invalid = settings.TEMPLATE_STRING_IF_INVALID expected_invalid_str = 'INVALID' - failures = [] - tests = template_tests.items() - tests.sort() # Run tests for name, vals in tests: xx, context, result = vals diff --git a/urls.py b/philo/urls.py similarity index 100% rename from urls.py rename to philo/urls.py diff --git a/utils.py b/philo/utils.py similarity index 100% rename from utils.py rename to philo/utils.py diff --git a/validators.py b/philo/validators.py similarity index 98% rename from validators.py rename to philo/validators.py index 5ae9409..c8e5dc9 100644 --- a/validators.py +++ b/philo/validators.py @@ -118,7 +118,7 @@ class TemplateValidationParser(Parser): def linebreak_iter(template_source): - # Cribbed from django/views/debug.py + # Cribbed from django/views/debug.py:18 yield 0 p = template_source.find('\n') while p >= 0: diff --git a/views.py b/philo/views.py similarity index 100% rename from views.py rename to philo/views.py diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..3c18b16 --- /dev/null +++ b/setup.py @@ -0,0 +1,47 @@ +#!/usr/bin/env python + +from distutils.core import setup +import os + + +# Shamelessly cribbed from django's setup.py file. +def fullsplit(path, result=None): + """ + Split a pathname into components (the opposite of os.path.join) in a + platform-neutral way. + """ + if result is None: + result = [] + head, tail = os.path.split(path) + if head == '': + return [tail] + result + if head == path: + return result + return fullsplit(head, [tail] + result) + +# Compile the list of packages available, because distutils doesn't have +# an easy way to do this. Shamelessly cribbed from django's setup.py file. +packages, data_files = [], [] +root_dir = os.path.dirname(__file__) +if root_dir != '': + os.chdir(root_dir) +philo_dir = 'philo' + +for dirpath, dirnames, filenames in os.walk(philo_dir): + # Ignore dirnames that start with '.' + for i, dirname in enumerate(dirnames): + if dirname.startswith('.'): del dirnames[i] + if '__init__.py' in filenames: + packages.append('.'.join(fullsplit(dirpath))) + elif filenames: + data_files.append([dirpath, [os.path.join(dirpath, f) for f in filenames]]) + + +version = __import__('philo').VERSION + +setup( + name = 'Philo', + version = '%s.%s' % (version[0], version[1]), + packages = packages, + data_files = data_files, +) \ No newline at end of file diff --git a/templates/admin/philo/page/add_form.html b/templates/admin/philo/page/add_form.html deleted file mode 100644 index 67f6ec4..0000000 --- a/templates/admin/philo/page/add_form.html +++ /dev/null @@ -1,29 +0,0 @@ -{% extends "admin/change_form.html" %} -{% load i18n %} - -{% block extrahead %}{{ block.super }} -<!-- This will break if anything ever changes and may not work in all browsers. Sad face. --> -<script type='text/javascript'> -(function($){ - $(function(){ - $('#page_form input[type=submit]').click(function(e){ - if (e.target.name == '_addanother') { - hidden = document.getElementById('page_form')._continue[0] - hidden.parentNode.removeChild(hidden) - } - }) - }) -}(django.jQuery)); -</script> -{% endblock %} - -{% block form_top %} - <p>{% trans "First, choose a template. After saving, you'll be able to provide additional content for containers." %}</p> - <input type="hidden" name="_continue" value="1" /> -{% endblock %} - -{% block content %} -{% with 0 as save_on_top %} -{{ block.super }} -{% endwith %} -{% endblock %} \ No newline at end of file