Merge branch 'development' into 'master': staging v0.5.2-rc

Author: cjerdonek

HISTORY.rst

@@ -1,6 +1,15 @@
 History
 =======
 
+0.5.2 (2012-05-03)
+------------------
+
+* Added support for dot notation and version 1.1.2 of the spec (issue #99). [rbp]
+* Missing partials now render as empty string per latest version of spec (issue #115).
+* Bugfix: falsey values now coerced to strings using str().
+* Bugfix: lambda return values for sections no longer pushed onto context stack (issue #113).
+* Bugfix: lists of lambdas for sections were not rendered (issue #114).
+
 0.5.1 (2012-04-24)
 ------------------
 

README.rst

@@ -15,15 +15,15 @@ syntax.  For a more complete (and more current) description of Mustache's
 behavior, see the official `Mustache spec`_.
 
 Pystache is `semantically versioned`_ and can be found on PyPI_.  This
-version of Pystache passes all tests in `version 1.0.3`_ of the spec.
+version of Pystache passes all tests in `version 1.1.2`_ of the spec.
 
 Logo: `David Phillips`_
 
 
 Requirements
 ============
 
-Pystache is tested with the following versions of Python:
+Pystache is tested with--
 
 * Python 2.4 (requires simplejson `version 2.0.9`_ or earlier)
 * Python 2.5 (requires simplejson_)
@@ -49,6 +49,9 @@ Install It
 ::
 
     pip install pystache
+    pystache-test
+
+To install and test from source (e.g. from GitHub), see the Develop section.
 
 
 Use It
@@ -74,7 +77,8 @@ Like so::
     >>> from pystache.tests.examples.readme import SayHello
     >>> hello = SayHello()
 
-Then your template, say_hello.mustache (by default in the same directory)::
+Then your template, say_hello.mustache (in the same directory by default
+as your class definition)::
 
     Hello, {{to}}!
 
@@ -95,9 +99,8 @@ more information.
 Python 3
 ========
 
-As of version 0.5.1, Pystache fully supports Python 3.  There are slight
-differences in behavior between Pystache running under Python 2 and 3,
-as follows:
+Pystache has supported Python 3 since version 0.5.1.  Pystache behaves
+slightly differently between Python 2 and 3, as follows:
 
 * In Python 2, the default html-escape function ``cgi.escape()`` does not
   escape single quotes; whereas in Python 3, the default escape function
@@ -109,14 +112,13 @@ as follows:
   defaults by passing in the encodings explicitly (e.g. to the ``Renderer`` class).
 
 
-Unicode Handling
-================
+Unicode
+=======
 
-This section describes Pystache's handling of unicode (e.g. strings and
-encodings).
+This section describes how Pystache handles unicode, strings, and encodings.
 
-Internally, Pystache uses `only unicode strings`_ (type ``str`` in Python 3 and
-type ``unicode`` in Python 2).  For input, Pystache accepts both unicode strings
+Internally, Pystache uses `only unicode strings`_ (``str`` in Python 3 and
+``unicode`` in Python 2).  For input, Pystache accepts both unicode strings
 and byte strings (``bytes`` in Python 3 and ``str`` in Python 2).  For output,
 Pystache's template rendering methods return only unicode.
 
@@ -143,26 +145,22 @@ attribute can be controlled on a per-view basis by subclassing the
 default to values set in Pystache's ``defaults`` module.
 
 
-Test It
+Develop
 =======
 
-From an install-- ::
-
-    pystache-test
-
-From a source distribution-- ::
+To test from a source distribution (without installing)-- ::
 
     python test_pystache.py
 
-To test Pystache source under multiple versions of Python all at once, you
-can use tox_: ::
+To test Pystache with multiple versions of Python (with a single command!),
+you can use tox_: ::
 
     pip install tox
     tox
 
 If you do not have all Python versions listed in ``tox.ini``-- ::
 
-    tox -e py26,py27  # for example
+    tox -e py26,py32  # for example
 
 The source distribution tests also include doctests and tests from the
 Mustache spec.  To include tests from the Mustache spec in your test runs: ::
@@ -175,23 +173,32 @@ is present.  Otherwise, it parses the json files.  To install PyYAML-- ::
 
     pip install pyyaml
 
-To test Pystache from a source distribution with Python 3.x, you must use tox.
-This is because the source code must first be run through 2to3_.
+To run a subset of the tests, you can use nose_: ::
 
+    pip install nose
+    nosetests --tests pystache/tests/test_context.py:GetValueTests.test_dictionary__key_present
 
-Mailing List
-============
+**Running Pystache from source with Python 3.**  Pystache is written in
+Python 2 and must be converted with 2to3_ prior to running under Python 3.
+The installation process (and tox) do this conversion automatically.
+
+To ``import pystache`` from a source distribution while using Python 3,
+be sure that you are importing from a directory containing a converted
+version (e.g. from your site-packages directory after manually installing)
+and not from the original source directory.  Otherwise, you will get a
+syntax error.  You can help ensure this by not running the Python IDE
+from the project directory when importing Pystache.
 
-As of November 2011, there's a mailing list, pystache@librelist.com.
 
-Archive: http://librelist.com/browser/pystache/
+Mailing List
+============
 
-Note: There's a bit of a delay in seeing the latest emails appear
-in the archive.
+There is a `mailing list`_.  Note that there is a bit of a delay between
+posting a message and seeing it appear in the mailing list archive.
 
 
-Author
-======
+Authors
+=======
 
 ::
 
@@ -208,9 +215,11 @@ Author
 .. _Distribute: http://pypi.python.org/pypi/distribute
 .. _et: http://www.ivan.fomichev.name/2008/05/erlang-template-engine-prototype.html
 .. _json: http://docs.python.org/library/json.html
+.. _mailing list: http://librelist.com/browser/pystache/
 .. _Mustache: http://mustache.github.com/
 .. _Mustache spec: https://github.com/mustache/spec
 .. _mustache(5): http://mustache.github.com/mustache.5.html
+.. _nose: http://somethingaboutorange.com/mrl/projects/nose/0.11.1/testing.html
 .. _only unicode strings: http://docs.python.org/howto/unicode.html#tips-for-writing-unicode-aware-programs
 .. _PyPI: http://pypi.python.org/pypi/pystache
 .. _Pystache: https://github.com/defunkt/pystache
@@ -221,5 +230,5 @@ Author
 .. _TemplateSpec: https://github.com/defunkt/pystache/blob/master/pystache/template_spec.py
 .. _test: http://packages.python.org/distribute/setuptools.html#test
 .. _tox: http://pypi.python.org/pypi/tox
-.. _version 1.0.3: https://github.com/mustache/spec/tree/48c933b0bb780875acbfd15816297e263c53d6f7
+.. _version 1.1.2: https://github.com/mustache/spec/tree/v1.1.2
 .. _version 2.0.9: http://pypi.python.org/pypi/simplejson/2.0.9

TODO.md

@@ -4,6 +4,5 @@ TODO
 * Turn the benchmarking script at pystache/tests/benchmark.py into a command in pystache/commands, or
   make it a subcommand of one of the existing commands (i.e. using a command argument).
 * Provide support for logging in at least one of the commands.
-* Make sure doctest text files can be converted for Python 3 when using tox.
 * Make sure command parsing to pystache-test doesn't break with Python 2.4 and earlier.
 * Combine pystache-test with the main command.

ext/spec

@@ -10,4 +10,4 @@
 
 __all__ = ['render', 'Renderer', 'TemplateSpec']
 
-__version__ = '0.5.1'  # Also change in setup.py.
+__version__ = '0.5.2-rc'  # Also change in setup.py.

pystache/__init__.py

@@ -35,6 +35,7 @@
 #
 #   ValueError: Attempted relative import in non-package
 #
+from pystache.common import TemplateNotFoundError
 from pystache.renderer import Renderer
 
 
@@ -78,7 +79,7 @@ def main(sys_argv=sys.argv):
 
     try:
         template = renderer.load_template(template)
-    except IOError:
+    except TemplateNotFoundError:
         pass
 
     try:

pystache/commands/render.py

@@ -7,7 +7,7 @@
 
 import sys
 
-from pystache.tests.main import run_tests
+from pystache.tests.main import main as run_tests
 
 
 def main(sys_argv=sys.argv):

pystache/commands/test.py

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 """
-Exposes common functions.
+Exposes functionality needed throughout the project.
 
 """
 
@@ -24,3 +24,13 @@ def read(path):
         return f.read()
     finally:
         f.close()
+
+
+class PystacheError(Exception):
+    """Base class for Pystache exceptions."""
+    pass
+
+
+class TemplateNotFoundError(PystacheError):
+    """An exception raised when a template is not found."""
+    pass