Merge pull request #13 from neocotic/wip-1.0.0

1.0.0 WIP

.gitignore

@@ -1,7 +1,7 @@
-node_modules/
+node_modules
 npm-debug.log
 
 .DS_Store?
 ehthumbs.db
 Icon?
-Thumbs.db
+Thumbs.db

.jshintrc

@@ -4,10 +4,11 @@
   "camelcase": true,
   "curly": false,
   "eqeqeq": true,
+  "eqnull": true,
   "immed": true,
   "latedef": true,
   "laxcomma": true,
-  "maxlen": 100,
+  "maxlen": 120,
   "newcap": true,
   "noarg": true,
   "node": false,
@@ -37,4 +38,4 @@
     "require": true,
     "define": true
   }
-}
+}

.npmignore

@@ -0,0 +1,12 @@
+docs
+test
+.jshintrc
+.travis.yml
+AUTHORS.md
+CHANGES.md
+CONTRIBUTING.md
+Gruntfile.js
+README.md
+backbone.do.min.js
+backbone.do.min.map
+bower.json

.travis.yml

@@ -2,4 +2,4 @@ language: node_js
 node_js:
   - "0.10"
 before_script:
-  - npm install -g grunt-cli
+  - npm install -g grunt-cli

AUTHORS.md

@@ -1,3 +1,3 @@
 # Authors ordered by first contribution
 
-* Alasdair Mercer <mercer.alasdair@gmail.com>
+* Alasdair Mercer <mercer.alasdair@gmail.com>

CHANGES.md

@@ -1,3 +1,15 @@
+## Version 1.0.0, 2014.09.16
+
+* [#4](https://github.com/neocotic/Backbone.Do/issues/4): Add support for `Backbone.Collection`
+* [#5](https://github.com/neocotic/Backbone.Do/issues/5): Add support for [Backbone][0] v1.1.2
+* [#8](https://github.com/neocotic/Backbone.Do/issues/8): Change methods from HTTP to CRUD to match [Backbone][0] API
+* [#8](https://github.com/neocotic/Backbone.Do/issues/8): Change `Backbone.Do.defaultMethod` to `update`
+* [#10](https://github.com/neocotic/Backbone.Do/issues/10): Change parameters for calling action methods to `data` and `options` (both still optional)
+* [#10](https://github.com/neocotic/Backbone.Do/issues/10): Action names must not match any existing property names
+* [#11](https://github.com/neocotic/Backbone.Do/issues/11): Fix bug with [Backbone][0] module import on [node.js][1]
+* Improve code styling
+* Bump development dependencies
+
 ## Version 0.1.4, 2014.06.26
 
 * [#6](https://github.com/neocotic/Backbone.Do/issues/6): Custom URL paths are no longer encoded
@@ -12,3 +24,6 @@
 
 * [#1](https://github.com/neocotic/Backbone.Do/issues/1): Add configuration overloading example to `README.md`
 * [#2](https://github.com/neocotic/Backbone.Do/issues/2): Give `data` configuration priority over `attrs`
+
+[0]: http://backbonejs.org
+[1]: http://nodejs.org

CONTRIBUTING.md

@@ -1,60 +1,38 @@
 # Contributing
 
-Here are some guidelines that we'd like contributors to follow so that we can
-have a chance of keeping things right.
-
-## Getting Starting
-
-* Make sure you have a [GitHub account](https://github.com/signup/free)
-* Submit a ticket for your issue if one does not already exist
-  * Clearly describe the issue including steps to reproduce when it is a bug
-  * Include the earliest version that you know has the issue
-* Fork the repository on GitHub
-
-## Making Changes
-
-* Create a topic branch from where you want to base your work
-  * This is usually the master branch
-  * Only target release branches if you are certain your fix must be on that
-    branch
-  * To quickly create a topic branch based on master; `git branch
-    fix/master/my_contribution master` then checkout the new branch with `git
-    checkout fix/master/my_contribution`
-  * Avoid working directly on the `master` branch
-* Make commits of logical units
-* Check for unnecessary whitespace with `git diff --check` before committing
-* Make sure your commit messages are in the proper format
-```
-    (#99999) Make the example in CONTRIBUTING imperative and concrete
+If you have any questions about [Backbone.Do][0] please feel free to [raise an issue][2].
+
+Please [search existing issues][1] for the same feature and/or issue before raising a new issue. Commenting on an
+existing issue is usually preferred over raising duplicate issues.
 
-    Without this patch applied the example commit message in the CONTRIBUTING
-    document is not a concrete example.  This is a problem because the
-    contributor is left to imagine what the commit message should look like
-    based on a description rather than an example.  This patch fixes the
-    problem by making the example concrete and imperative.
+Ensure that you update any relevant unit tests (in the `test` directory) and that all tests are currently passing. This
+can be done easily via command-line:
 
-    The first line is a real life imperative statement with a ticket number
-    from our issue tracker.  The body describes the behavior without the patch,
-    why this is a problem, and how the patch fixes the problem when applied.
+``` bash
+# install/update package dependencies
+$ npm install
+# run test suite
+$ grunt test
 ```
-* Make sure you have added the necessary tests for your changes
-* Run *all* the tests to assure nothing else was accidentally broken
 
-## Submitting Changes
+You will obviously need to have [node.js][3] for this, but you should also need to install (if you haven't done so
+already) the [Grunt][4] command-line tool:
 
-* Ensure you added your details to `AUTHORS.md` in the correct format
+``` bash
+$ npm install -g grunt-cli
 ```
-    * Joe Bloggs <joe.bloggs@example.com>
-```
-* Push your changes to a topic branch in your fork of the repository
-* Submit a pull request to neocotic's repository
-* Update your issue to mark that you have submitted code and are ready for it
-  to be reviewed
-  * Include a link to the pull request in the issue
-
-# Additional Resources
-
-* [Backbone.Do repository](https://github.com/neocotic/Backbone.Do)
-* [Issue tracker](https://github.com/neocotic/Backbone.Do/issues)
-* [General GitHub documentation](http://help.github.com)
-* [GitHub pull request documentation](http://help.github.com/send-pull-requests)
+
+Use the same coding style as the rest of the [code base][0].
+
+When submitting a pull request, please do *not* build the documentation or the minified files. We will built the
+distributables when cutting a release.
+
+All pull requests should be made to the `develop` branch.
+
+Don't forget to add your details to the list of `AUTHORS.md` if you want your contribution to be recognized by others.
+
+[0]: https://github.com/neocotic/Backbone.Do
+[1]: https://github.com/neocotic/Backbone.Do/issues
+[2]: https://github.com/neocotic/Backbone.Do/issues/new
+[3]: http://nodejs.org
+[4]: http://gruntjs.com

Gruntfile.js

@@ -2,7 +2,11 @@ module.exports = function(grunt) {
 
   'use strict';
 
+  // Configuration
+  // -------------
+
   grunt.initConfig({
+
     pkg: grunt.file.readJSON('package.json'),
 
     connect: {
@@ -49,29 +53,36 @@ module.exports = function(grunt) {
         }
       },
       options: {
+        banner: (
+          '/*! Backbone.Do v<%= pkg.version %> | (c) <%= grunt.template.today("yyyy") %>' +
+          ' <%= pkg.author.name %> | <%= pkg.licenses[0].type %> License\n' +
+          '*/'
+        ),
+        report: 'min',
         sourceMap: true,
-        sourceMapName: '<%= pkg.name %>.min.map',
-        banner: '/*! Backbone.Do v<%= pkg.version %> | (c) ' +
-          '<%= grunt.template.today("yyyy") %> <%= pkg.author.name %> | ' +
-          '<%= pkg.licenses[0].type %> License */\n'
+        sourceMapName: '<%= pkg.name %>.min.map'
       }
     },
 
     watch: {
       files: [ '<%= jshint.all %>' ],
       tasks: [ 'default' ]
     }
+
   });
 
+  // Tasks
+  // -----
+
   grunt.loadNpmTasks('grunt-contrib-connect');
   grunt.loadNpmTasks('grunt-contrib-jshint');
   grunt.loadNpmTasks('grunt-contrib-qunit');
   grunt.loadNpmTasks('grunt-contrib-uglify');
   grunt.loadNpmTasks('grunt-contrib-watch');
   grunt.loadNpmTasks('grunt-docco');
 
-  grunt.registerTask('build',   [ 'docco', 'uglify' ]);
-  grunt.registerTask('default', [ 'test', 'build' ]);
-  grunt.registerTask('test',    [ 'jshint', 'connect', 'qunit' ]);
+  grunt.registerTask('default', [ 'test' ]);
+  grunt.registerTask('dist', [ 'test', 'uglify', 'docco' ]);
+  grunt.registerTask('test', [ 'jshint', 'connect', 'qunit' ]);
 
-};
+};

LICENSE.md

@@ -16,4 +16,4 @@ 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.
+SOFTWARE.