Feature/expose exceptions (#2)

* expose exceptions

* bump version

* tests

* changelog

* docs usage exceptions

* editorconfig

* makefile

* remove build_docs script

* readme make commands

Author: nitely

.editorconfig

@@ -0,0 +1,27 @@
+# This file is for unifying the coding style for different editors and IDEs.
+# More information at http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# 4 space indentation
+[*.py]
+indent_style = space
+indent_size = 4
+
+# Matches the exact files either package.json or .travis.yml
+[{package.json,.travis.yml}]
+indent_style = space
+indent_size = 2
+
+# Override for Makefile
+[{Makefile, makefile, GNUmakefile}]
+indent_style = tab
+indent_size = 4

CHANGELOG.md

@@ -1,3 +1,9 @@
+0.1.1
+==================
+
+* Expose V8 exceptions
+
+
 0.1.0
 ==================
 

Makefile

@@ -0,0 +1,22 @@
+clean:
+	rm -fr dist/ doc/_build/
+
+docs:
+	cd docs && make clean && make html
+
+test:
+	python runtests.py
+
+build-examples:
+	export NODE_ENV=production
+	cd examples/flux && npm install && npm run bundle
+	cd examples/simple && npm install && npm run bundle
+	python build_examples.py
+
+sdist: test clean
+	python setup.py sdist
+
+release: test clean
+	python setup.py sdist upload
+
+.PHONY: clean docs test build-examples sdist release

README.md

@@ -56,6 +56,20 @@ Read the [docs](http://python-react-v8.readthedocs.org/en/latest/).
 * [Simple](https://github.com/nitely/python-react-v8/tree/master/examples/simple)
 
 
+## Build examples
+
+```
+$ make build-examples
+```
+
+
+## Tests
+
+```
+$ make test
+```
+
+
 ## License
 
 MIT

build_docs.sh

@@ -16,3 +16,10 @@ Utils Module
 
 .. automodule:: react.utils
    :members: set_up, load_libs, run_script
+
+
+Excepts Module
+--------------
+
+.. automodule:: react.excepts
+   :members:

docs/api.rst

@@ -69,3 +69,44 @@ But there are two things to have in mind:
        it gets exposed as a JS object within the HTML.
     2. The data passed to react should be exactly the same as the data provided
        by the API endpoint for that view, so the query should be the same.
+
+
+Multiple stores
+---------------
+
+::
+
+    # ...
+    data = {
+        'postIts': orm.query().all().only('id', 'text'),
+        'comments': orm.query().all().only('id', 'created_by', 'comment_html')
+    }
+    # ...
+
+Seriously.
+
+
+Handling errors
+---------------
+
+::
+
+    import react
+
+    # ...
+    try:
+        content = react_.render()
+    except react.excepts.V8Error as err:
+        logger.error(err)
+        content = ''
+    # ...
+
+When handling exceptions, there is not much to do other
+than set an empty content and let react render it client-side.
+
+The data can still be pre-loaded, assuming the error wasn't
+thrown by the load function.
+
+It may be a good idea to log the data (as json) to replicate
+the error later. Since most of the logic is the same client-side,
+once you have replicated it, it can be debugged in the web-browser.

docs/usage.rst

@@ -2,10 +2,12 @@
 
 from .react import React, set_up
 from . import utils
+from . import excepts
 
 __all__ = [
     'set_up',
     'React',
-    'utils']
+    'utils',
+    'excepts']
 
-__version__ = '0.1.0'
+__version__ = '0.1.1'

react/__init__.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+from v8cffi.exceptions import (
+    V8Error,
+    V8JSError,
+    V8MemoryError,
+    V8UnknownError)
+
+__all__ = [
+    'V8Error',
+    'V8JSError',
+    'V8MemoryError',
+    'V8UnknownError']

react/excepts.py

@@ -24,6 +24,10 @@ def set_up():
     global V8 context.\
     Should be called once\
     in the app lifetime.
+
+    :raises react.excepts.V8Error: if there was\
+    an error running the JS script. This should\
+    usually not be handled
     """
     utils.set_up()
 
@@ -65,6 +69,8 @@ def render(self):
         """
         :return: Result of the JS render call
         :rtype: str
+        :raises react.excepts.V8Error: if there was\
+        an error running the JS script
         """
         return utils.run_script(self.build_js_script())