Misc Updates

.gitignore

@@ -0,0 +1,4 @@
+*.pyc
+/build
+/dist
+/django_qunit2.egg-info

LICENSE

@@ -1,27 +1,26 @@
-Copyright (c) 2010, Cody Soyland
+Copyright (c) 2013, Timothy Van Heest, Cody Soyland (original author)
 All rights reserved.
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of django-qunit nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL CODY SOYLAND BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
 
 Includes QUnit, released under MIT license
 ------------------------------------------

MANIFEST.in

@@ -1,6 +1,7 @@
 include LICENSE
 include README.md
-include example/*
-include example/qunit_tests/*
-include django_qunit/media/qunit/*
-include django_qunit/templates/qunit/*
+recursive-include docs *
+recursive-include django_qunit *
+recursive-include django_qunit/static/css *
+recursive-include django_qunit/static/js *
+recursive-include django_qunit/templates/qunit *

README.md

@@ -8,18 +8,104 @@ app and test Ajax routines.
   [1]: http://docs.jquery.com/QUnit
   [2]: http://www.djangoproject.com/
 
-installation
+Installation
 ============
 
- 1. Add 'django_qunit' to your settings.INSTALLED_APPS.
- 2. Add settings.QUNIT_TEST_DIRECTORY, containing the path to your javascript files.
- 3. Add a urlconf to include('django_qunit.urls').
- 4. Visit the URL you've included in your urlconf, and it should display QUnit test results.
+ 1. Either: 
+   * Install via [`pip install django_qunit2`](https://pypi.python.org/pypi/django-qunit2/20130624)
+   * Download the files / clone the repo and put the `django_qunit/django_qunit` folder where ever you put your projects apps
+ 1. Add `django_qunit` (or `apps.django_qunit`, depending on which option you chose for the first step) to your `settings.INSTALLED_APPS`.
+ 2. Add `'django_qunit.snippet_loader.Loader',` to `settings.TEMPLATE_LOADERS`.
+ 3. Add `settings.QUNIT_TEST_PATH`, containing the path to the qunit test directory from within each app's static files directory, and your main project static directory.  This is a file path, so make sure to use `os.path.join` to create the path.
+
+   For example, if `STATICFILES_DIRS` contains `"/path/to/my/project/static"` and `QUNIT_TEST_PATH` is `"qunit"`, place your test files inside a "qunit" folder in `os.path.join("/path/to/my/project/static", QUNIT_TEST_PATH)`. 
+   Within each app, you should put the files in `appname/static_dir/QUNIT_TEST_PATH/appname/`.  Adding in `appname` keeps tests namespaced and creates a natural tree structure for your tests.
+
+ 4. Add a urlconf to `include('django_qunit.urls')`.
 
-*See the example in the tarball for more information.*
+  If you would only like these urls available in debug mode, use something like the following in your base `urls.py` file.
 
-license
+        if settings.DEBUG:
+            """Test-only urls """
+            urlpatterns += patterns('',
+                (r'^qunit/', include('django_qunit.urls')),
+            )  
+
+ 5. Visit the URL you've included in your urlconf, and it should display QUnit test results.
+
+Configuration
+==============
+* Qunit test directory layout
+
+  Extending upon the contents of the `examples` directory, we found something resembling the following works well, assuming `qunit` is your QUNIT_TEST_PATH. 
+  Group tests into files then folders.  Folders can be nested.
+
+        * qunit
+            * section_a
+                * test1.js
+                * test2.js
+                * stub_a.html
+                * suite.json
+            * section_b
+                * section_b1
+                    * test1.js
+                * test1.js
+                * suite.json
+            * section_c
+                * test1.js
+            * test1.js
+            * suite.json
+
+  Within an app, first create a empty folder with the name of the app, then add more tests and test directories with that.
+
+        * qunit
+            * myapp
+                * test1.js
+                * test2.js
+                * stub1.html
+                * suite.json
+                * section_a
+                    * section_b1
+                        * test1.js
+                    * test3.js
+                    * suite.json
+                * section_b
+                    * test4.js
+
+* Test configuration files
+
+  Add a file named `suite.json` to any directory in `QUNIT_TEST_DIRECTORY` to change the displayed name of that testing directory 
+  or change what external assets are loaded on that test page. For example, the following will load 
+  the js files at the listed urls into the page `django-qunit` creates for the folder containing this configuration file.
+
+  You can also pass an array named `extra_media_urls`, and these urls will be concatenated with your project's value of `settings.MEDIA_URL`.
+
+        {
+            "extra_urls": [
+              "/static_assets/js/lib/jquery.js",
+              "/static_assets/js/lib/underscore.js",
+              "/static_assets/js/lib/jquery-ui.js"
+            ]
+        }
+
+  Note that `suite.json` attributes are not inherited by lower level directories, so you need to define `suite.json` files for each 
+  folder that needs additional assets loaded.
+
+  Additionally, you can include `.html` files in any testing directory.  The contents of each of these files will be included on that 
+  directory's testing page inside a `div` with an id determined by the name of the file.  For example, for the example stuctur above, 
+  `stub_a.html` would be included in a `div` with id `stub_a`.  All html stubs are wrapped in a `div` with id `qunit-html-stubs`, and 
+  this `div` is given the css property `display: none`.
+
+Tips
+=====
+
+* You must have "django.contrib.staticfiles.finders.AppDirectoriesFinder" listed as one of your "STATICFILES_FINDERS"
+* Your Django installation should be looking for static files under "appname/static".  If you changed this, the static files for qunit may not be found.
+
+License
 =======
+Copyright (c) 2012 Timothy Van Heest
+
+Originally based off a fork of Cody Soyland's [django-qunit](https://github.com/codysoyland/django-qunit).
 
-Copyright (c) 2010 Cody Soyland
-Licensed new-style BSD, also containing QUnit, which is licensed MIT. See LICENSE file for more information.
+Licensed MIT, also containing QUnit, which is licensed MIT. See LICENSE file for more information.

django_qunit/__init__.py

@@ -2,6 +2,6 @@
 from django.conf import settings
 
 try:
-    settings.QUNIT_TEST_DIRECTORY
+    settings.QUNIT_TEST_PATH
 except AttributeError:
-    raise ImproperlyConfigured('Missing required setting QUNIT_TEST_DIRECTORY.')
+    raise ImproperlyConfigured('Missing required setting QUNIT_TEST_PATH.')