Upgrades. Recursive "with" now supported in find and findAll.

js-data · Feb 25, 2016 · 3747a92 · 3747a92
1 parent 0bcf45b
commit 3747a92
Show file tree

Hide file tree

Showing 34 changed files with 1,684 additions and 1,481 deletions.
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,3 @@
+{
+  "presets": ["es2015-rollup"]
+}
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,27 @@
+# Contributing
+
+[Read the Contributing Guide](http://js-data.io/docs/contributing).
+
+## Support
+
+[Find out how to Get Support](http://js-data.io/docs/support).
+
+## Community
+
+[Explore the Community](http://js-data.io/docs/community).
+
+### Have write access?
+
+To cut a release:
+
+1. Checkout master
+1. Bump version in `package.json` appropriately
+1. Run `npm run release`
+1. Update `CHANGELOG.md` appropriately
+1. Commit and push changes, including the `dist/` folder
+1. Make a GitHub release
+  - set tag name to version
+  - set release name to version
+  - set release body to changelog entry for the version
+  - attach the files in the `dist/` folder
+1. `npm publish .`
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,7 @@
+(delete this line) GitHub Issues are NOT for support questions.
+(delete this line) GitHub Issues ARE for bug reports, feature requests, and other issues.
+(delete this line) Find out how to Get Support here: http://js-data.io/docs/support.
+
+<your detailed, discussable, actionable, and helpful text goes here>
+
+Thanks!
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,8 @@
+Fixes #<issue_number_goes_here> (it's a good idea to open an issue first for discussion)
+
+- [ ] - `npm test` succeeds
+- [ ] - Pull request has been squashed into 1 commit
+- [ ] - I did NOT commit changes to `dist/`
+- [ ] - Code coverage does not decrease (if any source code was changed)
+- [ ] - Appropriate JSDoc comments were updated in source code (if applicable)
+- [ ] - Approprate changes to js-data.io docs have been suggested ("Suggest Edits" button)
diff --git a/.gitignore b/.gitignore
@@ -32,3 +32,4 @@ bower_components/
 *.iml
 
 rethinkdb_data/
+doc/
diff --git a/.mailmap b/.mailmap
@@ -0,0 +1,4 @@
+InternalFX <bryan@internalfx.com> Bryan <bryan@internalfx.com>
+InternalFX <bryan@internalfx.com> Bryan Morris <bryan@internalfx.com>
+Jason Dobry <jason.dobry@gmail.com> Jason Dobry <jmdobry@users.noreply.github.com>
+Ollie Relph <ollie@relph.me> Ollie Relph <ollie+github@relph.me>
diff --git a/.npmignore b/.npmignore
@@ -31,6 +31,8 @@ node_modules
 *.iml
 coverage/
 src/
+doc/
+junit/
 test/
 mocha.start.js
 webpack.config.js

diff --git a/AUTHORS b/AUTHORS
@@ -0,0 +1,10 @@
+# This is the official list of js-data-rethinkdb project authors.
+#
+# This file is controlled by scripts/authors.js
+#
+# Names are formatted as:
+#   # commits  Name or Organization <email address>
+# The email address is not required for organizations.
+InternalFX <bryan@internalfx.com>
+Jason Dobry <jason.dobry@gmail.com>
+Ollie Relph <ollie@relph.me>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+##### 2.2.0 - 25 February 2016
+
+###### Other
+- General improvements
+
 ##### 2.1.0 - 26 October 2015
 
 ###### Backwards compatible bug fixes

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -0,0 +1,9 @@
+# People who have contributed to the js-data-rethinkdb project.
+#
+# This file is controlled by scripts/authors.js
+#
+# Names should be added to this file as:
+#   [commit count] Name <email address>
+     1	InternalFX <bryan@internalfx.com>
+    39	Jason Dobry <jason.dobry@gmail.com>
+     2	Ollie Relph <ollie@relph.me>
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2015 Jason Dobry
+Copyright (c) 2014-2016 js-data-rethinkdb project authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +19,3 @@ 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.
-
diff --git a/README.md b/README.md
@@ -1,91 +1,80 @@
-<img src="https://raw.githubusercontent.com/js-data/js-data/master/js-data.png" alt="js-data logo" title="js-data" align="right" width="64" height="64" />
+<img src="https://raw.githubusercontent.com/js-data/js-data/master/js-data.png" alt="js-data logo" title="js-data" align="right" width="96" height="96" />
 
-## js-data-rethinkdb [![Slack Status][sl_b]][sl_l] [![npm version][npm_b]][npm_l] [![Circle CI][circle_b]][circle_l] [![npm downloads][dn_b]][dn_l] [![Coverage Status][cov_b]][cov_l] [![Codacy][cod_b]][cod_l]
+# js-data-rethinkdb
+
+[![Slack Status][sl_b]][sl_l]
+[![npm version][npm_b]][npm_l]
+[![Circle CI][circle_b]][circle_l]
+[![npm downloads][dn_b]][dn_l]
+[![Coverage Status][cov_b]][cov_l]
+[![Codacy][cod_b]][cod_l]
 
 RethinkDB adapter for [js-data](http://www.js-data.io/).
 
-### API Documentation
-[DSRethinkDBAdapter](http://www.js-data.io/docs/dsrethinkdbadapter)
+To get started, visit __[http://js-data.io](http://www.js-data.io)__.
 
-### Example App
-[js-data-examples/server/rethinkdb](https://github.com/js-data/js-data-examples/tree/master/server/rethinkdb)
+## Table of contents
+
+* [Quick start](#quick-start)
+* [Example App](#example-app)
+* [Guides and Tutorials](#guides-and-tutorials)
+* [API Reference Docs](#api-reference-docs)
+* [Community](#community)
+* [Support](#support)
+* [Contributing](#contributing)
+* [License](#license)
 
-### Quick Start
-`npm install --save js-data js-data-rethinkdb rethinkdbdash`.
+## Quick Start
+`npm install --save js-data js-data-rethinkdb`.
 
 ```js
 var JSData = require('js-data');
-var DSRethinkDBAdapter = require('js-data-rethinkdb');
+var RethinkDBAdapter = require('js-data-rethinkdb');
 
 var store = new JSData.DS();
+var adapter = new RethinkDBAdapter();
 
-// "r" will be available at adapter.r
-var adapter = new DSRethinkDBAdapter();
-
+// "store" will now use the RethinkDB adapter for all async operations
 store.registerAdapter('rethinkdb', adapter, { default: true });
 
-// "store" will now use the RethinkDB adapter for all async operations
+var User = store.defineResource({
+  name: 'user'
+});
 ```
 
-### Changelog
-[CHANGELOG.md](https://github.com/js-data/js-data-rethinkdb/blob/master/CHANGELOG.md)
+## Example App
 
-### Community
-- [Slack Channel](http://slack.js-data.io/) - Better than IRC!
-- [Announcements](http://www.js-data.io/blog)
-- [Mailing List](https://groups.io/org/groupsio/jsdata) - Ask your questions!
-- [Issues](https://github.com/js-data/js-data-rethinkdb/issues) - Found a bug? Feature request? Submit an issue!
-- [GitHub](https://github.com/js-data/js-data-rethinkdb) - View the source code for js-data.
-- [Contributing Guide](https://github.com/js-data/js-data-rethinkdb/blob/master/CONTRIBUTING.md)
+[js-data-examples/server/rethinkdb](https://github.com/js-data/js-data-examples/tree/master/server/rethinkdb)
+
+## Guides and Tutorials
+
+[Get started at http://js-data.io](http://js-data.io)
 
-### Contributing
+## API Reference Docs
 
-First, support is handled via the [Slack Channel](http://slack.js-data.io/) and the [Mailing List](https://groups.io/org/groupsio/jsdata). Ask your questions there.
+[Visit http://api.js-data.io](http://api.js-data.io).
 
-When submitting issues on GitHub, please include as much detail as possible to make debugging quick and easy.
+## Community
 
-- good - Your versions of js-data, js-data-rethinkdb, etc., relevant console logs/error, code examples that revealed the issue
-- better - A [plnkr](http://plnkr.co/), [fiddle](http://jsfiddle.net/), or [bin](http://jsbin.com/?html,output) that demonstrates the issue
-- best - A Pull Request that fixes the issue, including test coverage for the issue and the fix
+[Explore the Community](http://js-data.io/docs/community).
 
-[Github Issues](https://github.com/js-data/js-data-rethinkdb/issues).
+## Support
 
-#### Submitting Pull Requests
+[Find out how to Get Support](http://js-data.io/docs/support).
 
-1. Contribute to the issue/discussion that is the reason you'll be developing in the first place
-1. Fork js-data-rethinkdb
-1. `git clone git@github.com:<you>/js-data-rethinkdb.git`
-1. `cd js-data-rethinkdb; npm install; bower install;`
-1. Write your code, including relevant documentation and tests
-1. Run `grunt test` (build and test)
-1. Your code will be linted and checked for formatting, the tests will be run
-1. The `dist/` folder & files will be generated, do NOT commit `dist/*`! They will be committed when a release is cut.
-1. Submit your PR and we'll review!
-1. Thanks!
+## Contributing
 
-### License
+[Read the Contributing Guide](http://js-data.io/docs/contributing).
+
+## License
 
 The MIT License (MIT)
 
-Copyright (c) 2014-2015 Jason Dobry
-
-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.
+Copyright (c) 2014-2016 js-data-rethinkdb project authors
+
+* [LICENSE](https://github.com/js-data/js-data-rethinkdb/blob/master/LICENSE)
+* [AUTHORS](https://github.com/js-data/js-data-rethinkdb/blob/master/AUTHORS)
+* [CONTRIBUTORS](https://github.com/js-data/js-data-rethinkdb/blob/master/CONTRIBUTORS)
 
 [sl_b]: http://slack.js-data.io/badge.svg
 [sl_l]: http://slack.js-data.io

diff --git a/conf.json b/conf.json
@@ -0,0 +1,23 @@
+  {
+  "source": {
+    "includePattern": ".*js$"
+  },
+  "plugins": ["plugins/markdown"],
+  "opts": {
+    "template": "./node_modules/ink-docstrap/template",
+    "destination": "./doc/",
+    "recurse": true,
+    "verbose": true,
+    "readme": "./README.md",
+    "package": "./package.json"
+  },
+  "templates": {
+    "theme": "lumen",
+    "systemName": "js-data-rethinkdb",
+    "copyright": "js-data-rethinkdb Copyright © 2014-2016 js-data-rethinkdb project authors",
+    "outputSourceFiles": true,
+    "syntaxTheme": "dark",
+    "linenums": true,
+    "footer": "<div style=\"text-align:center\">Back to <a href=\"http://js-data.io\">js-data.io</a></div>"
+  }
+}