Some documentation fixes and other chores.

Author: jmdobry

CHANGELOG.md

@@ -1,8 +1,12 @@
-##### 0.10.6 - xx August 2014
+##### 1.0.0-beta.1 - xx August 2014
 
 ###### Backwards compatible API changes
+- #118, #122 - Multiple relationships to the same model
 - #120 - When using DSCacheFactory, allow onExpire to be specified
 
+###### Other
+- #121 - Documentation errors
+
 ##### 0.10.5 - 14 August 2014
 
 ###### Backwards compatible API changes

CONTRIBUTING.md

@@ -1,21 +1,12 @@
 # Contributing Guide
 
-First, feel free to contact me with questions
+First, feel free to contact me with questions. [Mailing List](https://groups.google.com/forum/?fromgroups#!forum/angular-data). [Issues](https://github.com/jmdobry/angular-data/issues).
 
-1. Fork the repo
-	- `$ git clone <yourForkUrl>`
-	- `$ npm install && bower install && npm test`
-1. Checkout a new branch based on whatever version branch is available (if none then branch from `master`) and name it to what you intend to do:
-    - `$ git checkout -b BRANCH_NAME`
-    - Use one branch per fix/feature
-1. Make your changes
-	- Use `grunt build`, `grunt watch` and `grunt karma:dev` while developing
-	- Make sure to provide a spec for unit tests
-	- Run your tests with `test`
-	- When all tests pass, everything's fine
-1. Commit your changes
-	- Please provide a git message which explains what you've done
-	- Commit to the forked repository
-1. Make a pull request
-	- Make sure you send the PR to the branch you branched from
-	- Travis CI is watching you!
+1. Contribute to the issue that is the reason you'll be developing in the first place
+1. Fork angular-data
+1. `git clone https://github.com/<you>/angular-data.git`
+1. `cd angular-data; npm install; bower install;`
+1. `grunt go` (builds and starts a watch)
+1. (in another terminal) `grunt karma:dev` (runs the tests)
+1. Write your code, including relevant documentation and tests
+1. Submit a PR and we'll review

Gruntfile.js

@@ -8,7 +8,7 @@
 module.exports = function (grunt) {
   'use strict';
 
-  require('load-grunt-tasks')(grunt);
+  require('jit-grunt')(grunt);
   require('time-grunt')(grunt);
 
   var dev = process.cwd().indexOf('/home/jdobry/angular-data') === -1;

README.md

@@ -1,22 +1,71 @@
 ## angular-data
 
-__Data store for Angular.js.__
+Inspired by [Ember Data](https://github.com/emberjs/data), Angular-data is the model layer Angular is missing. It consists of a convenient in-memory cache for interacting with your various resources, and several adapters for communicating with various persistence layers.
+
+By default angular-data uses the http adapter–perfect for communicating with your RESTful backend. It includes a localStorage adapter, and another [localforage adapter](https://github.com/jmdobry/angular-data-localForage) is also available. More adapters are coming, and you're free to implement your own.
+
+Unlike Backbone and Ember Models, angular-data does not require the use of getters and setters, and doesn't wrap your data with custom classes if you don't want it to. Angular-data's internal dirty-checking (via [observe-js](https://github.com/Polymer/observe-js) or `Object.observe` in supporting browsers) allows for powerful use cases and an easy avenue for implementing your own [3-way data-binding](https://www.firebase.com/blog/2013-10-04-firebase-angular-data-binding.html).
+
+Supporting relations, computed properties, model lifecycle control and a slew of other features, angular-data is the tool for giving your data the respect it deserves.
 
 __Latest Release:__ [0.10.5](http://angular-data.pseudobry.com/)
-__master:__ [0.10.6](http://angular-data-next.pseudobry.com/)
+__master:__ [1.0.0-beta.1](http://angular-data-next.pseudobry.com/)
 
 Angular-data is approaching 1.0.0 Beta. The API is stabilizing and angular-data is well tested.
 
-Angular-data is being used in production, though it's not 1.0.0. If you want to use Angular-data, keep an eye on the changelog. 1.0.0 will introduce strict semver (until then, minor number is bumped for breaking changes).
+Although angular-data is being used in production, it's not 1.0.0. If you want to use Angular-data, keep an eye on the changelog. 1.0.0 will introduce strict semver (until then, minor number is bumped for breaking changes).
 
-Roadmap:
-- Even more adapters
-- Nested Resources
-- See [issues](https://github.com/jmdobry/angular-data/issues?page=1&state=open) for what's in development
-- See [Design Doc](https://docs.google.com/document/d/1o069KLuBH4jpwm1FCLZFwKMgM73Xi8_1JyjhSxVpidM/edit?usp=sharing) for other juicy reading material
 
 ## Documentation
-[angular-data.pseudobry.com](http://angular-data.pseudobry.com)
+[http://angular-data.pseudobry.com](http://angular-data.pseudobry.com)
+
+## Quick Start
+`bower install angular-data` or `npm install angular-data`.
+
+```js
+var app = angular.module('myApp', ['angular-data.DS']);
+```
+
+```js
+app.factory('User', function (DS) {
+  // Simplest resource definition
+  return DS.defineResource('user');
+});
+```
+
+```js
+app.controller('friendsCtrl', function ($scope, $routeParams, User) {
+  // it's up to your server to know how to interpret this query
+  // or you can teach angular-data how to understand your servers' query language
+  var query = {
+    where: {
+      friendIds: {
+        in: $routeParams.id
+      }
+    }
+  };
+  
+  User.find($routeParams.id);
+  User.findAll(query);
+  
+  // My goodness this was easy
+  User.bindOne($scope, 'me', $routeParams.id);
+  User.bindAll($scope, 'friends', query);
+  
+  // Long form
+  $scope.$watch(function () {
+    return User.lastModified($routeParams.id);
+  }, function () {
+    $scope.me = User.get($routeParams.id);
+  });
+  $scope.$watch(function () {
+    // Changes when anything in the User collection is modified
+    return User.lastModified();
+  }, function () {
+    $scope.friends = User.filter(query);
+  });
+});
+```
 
 ## Changelog
 [CHANGELOG.md](https://github.com/jmdobry/angular-data/blob/master/CHANGELOG.md)
@@ -35,7 +84,7 @@ Roadmap:
 
 [Design Doc](https://docs.google.com/document/d/1o069KLuBH4jpwm1FCLZFwKMgM73Xi8_1JyjhSxVpidM/edit?usp=sharing) - Design document for Angular-data.
 
-[Contributing Guide](https://github.com/jmdobry/angular-data/blob/master/CONTRIBUTING.md)
+[Contributing Guide](#Contributing)
 
 ## Project Status
 
@@ -48,6 +97,21 @@ Roadmap:
 | Dependency Status | [![Dependency Status](https://gemnasium.com/jmdobry/angular-data.png)](https://gemnasium.com/jmdobry/angular-data) |
 | Coverage | [![Coverage Status](https://coveralls.io/repos/jmdobry/angular-data/badge.png?branch=master)](https://coveralls.io/r/jmdobry/angular-data?branch=master) |
 
+## Contributing
+
+First, feel free to contact me with questions. [Mailing List](https://groups.google.com/forum/?fromgroups#!forum/angular-data). [Issues](https://github.com/jmdobry/angular-data/issues).
+
+1. Contribute to the issue that is the reason you'll be developing in the first place
+1. Fork angular-data
+1. `git clone https://github.com/<you>/angular-data.git`
+1. `cd angular-data; npm install; bower install;`
+1. `grunt go` (builds and starts a watch)
+1. (in another terminal) `grunt karma:dev` (runs the tests)
+1. Write your code, including relevant documentation and tests
+1. Submit a PR and we'll review
+
+## License
+
 Copyright (C) 2014 Jason Dobry
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of

bower.json

@@ -2,7 +2,7 @@
   "author": "Jason Dobry",
   "name": "angular-data",
   "description": "Data store for Angular.js.",
-  "version": "0.10.6",
+  "version": "1.0.0-beta.1",
   "homepage": "http://angular-data.pseudobry.com/",
   "repository": {
     "type": "git",

dist/angular-data.js

@@ -1,7 +1,7 @@
 /**
 * @author Jason Dobry <jason.dobry@gmail.com>
 * @file angular-data.js
-* @version 0.10.6 - Homepage <http://angular-data.pseudobry.com/>
+* @version 1.0.0-beta.1 - Homepage <http://angular-data.pseudobry.com/>
 * @copyright (c) 2014 Jason Dobry <https://github.com/jmdobry/>
 * @license MIT <https://github.com/jmdobry/angular-data/blob/master/LICENSE>
 *
@@ -1459,8 +1459,8 @@ function DSHttpAdapterProvider() {
      *
      * ## Example:
      * ```js
-     * angular.module('myApp', function (DSHttpAdapterProvider) {
-     *   angular.extend(DSHttpAdapterProvider.defaults.httpConfig, {
+     * angular.module('myApp').config(function (DSHttpAdapterProvider) {
+     *   angular.extend(DSHttpAdapterProvider.defaults.$httpConfig, {
      *     interceptor: [...],
      *     headers: {
      *       common: {
@@ -2839,30 +2839,36 @@ function loadRelations(resourceName, instance, relations, options) {
     var tasks = [];
     var fields = [];
 
-    DS.utils.forOwn(definition.relations, function (relation, type) {
-      DS.utils.forOwn(relation, function (def, relationName) {
-        if (DS.utils.contains(relations, relationName)) {
-          var task;
-          var params = {};
-          params[def.foreignKey] = instance[definition.idAttribute];
-
-          if (type === 'hasMany') {
-            task = DS.findAll(relationName, params, options);
-          } else if (type === 'hasOne') {
-            if (def.localKey && instance[def.localKey]) {
-              task = DS.find(relationName, instance[def.localKey], options);
-            } else if (def.foreignKey) {
+    DS.utils.forOwn(definition.relations, function (relatedModels, type) {
+      DS.utils.forOwn(relatedModels, function (defs, relationName) {
+        if (!DS.utils.isArray(defs)) {
+          defs = [defs];
+        }
+
+        defs.forEach(function (def) {
+          if (DS.utils.contains(relations, relationName)) {
+            var task;
+            var params = {};
+            params[def.foreignKey] = instance[definition.idAttribute];
+
+            if (type === 'hasMany') {
               task = DS.findAll(relationName, params, options);
+            } else if (type === 'hasOne') {
+              if (def.localKey && instance[def.localKey]) {
+                task = DS.find(relationName, instance[def.localKey], options);
+              } else if (def.foreignKey) {
+                task = DS.findAll(relationName, params, options);
+              }
+            } else {
+              task = DS.find(relationName, instance[def.localKey], options);
             }
-          } else {
-            task = DS.find(relationName, instance[def.localKey], options);
-          }
 
-          if (task) {
-            tasks.push(task);
-            fields.push(def.localField);
+            if (task) {
+              tasks.push(task);
+              fields.push(def.localField);
+            }
           }
-        }
+        });
       });
     });
 
@@ -5362,15 +5368,21 @@ function _inject(definition, resource, attrs) {
 
 function _injectRelations(definition, injected) {
   var DS = this;
-  DS.utils.forOwn(definition.relations, function (relation, type) {
-    DS.utils.forOwn(relation, function (def, relationName) {
-      if (DS.definitions[relationName] && injected[def.localField]) {
-        try {
-          injected[def.localField] = DS.inject(relationName, injected[def.localField]);
-        } catch (err) {
-          DS.$log.error(errorPrefix(definition.name) + 'Failed to inject ' + type + ' relation: "' + relationName + '"!', err);
-        }
+  DS.utils.forOwn(definition.relations, function (relatedModels, type) {
+    DS.utils.forOwn(relatedModels, function (defs, relationName) {
+      if (!DS.utils.isArray(defs)) {
+        defs = [defs];
       }
+
+      defs.forEach(function (def) {
+        if (DS.definitions[relationName] && injected[def.localField]) {
+          try {
+            injected[def.localField] = DS.inject(relationName, injected[def.localField]);
+          } catch (err) {
+            DS.$log.error(errorPrefix(definition.name) + 'Failed to inject ' + type + ' relation: "' + relationName + '"!', err);
+          }
+        }
+      });
     });
   });
 }
@@ -5764,7 +5776,7 @@ module.exports = [function () {
    * @id angular-data
    * @name angular-data
    * @description
-   * __Version:__ 0.10.0
+   * __Version:__ 1.0.0-beta.1
    *
    * ## Install
    *
@@ -5783,7 +5795,7 @@ module.exports = [function () {
    * Load `dist/angular-data.js` or `dist/angular-data.min.js` onto your web page after Angular.js.
    *
    * #### Manual download
-   * Download angular-data-<%= pkg.version %>.js from the [Releases](https://github.com/jmdobry/angular-data/releases)
+   * Download angular-data from the [Releases](https://github.com/jmdobry/angular-data/releases)
    * section of the angular-data GitHub project.
    *
    * ## Load into Angular

dist/angular-data.min.js

@@ -311,10 +311,18 @@ DS.defineResource({
   name: 'organization',
   relations: {
     hasMany: {
-      user: {
-        localField: 'users',
-        foreignKey: 'organizationId'
-      }
+      // this is an example of multiple relations
+      // of the same type to the same resource
+      user: [
+        {
+          localField: 'users',
+          foreignKey: 'organizationId'
+        },
+        {
+          localField: 'owners',
+          foreignKey: 'organizationId'
+        }
+      ]
     }
   }
 });
@@ -344,7 +352,7 @@ DS.defineResource({
 });
 ```
 
-`DS.inject` can be called by you, and is also used internally by `find`, `findAll`, `create`, `update`, `updateAll`, `save` and `refresh`.
+You can manually load items into the data store via `DS.inject`.
 
 ## Loading relations
 
@@ -426,7 +434,7 @@ DS.defineResource('user', {
     // you computed properties to work after you've
     // minified your code
     initials: function (first, last) {
-        return first.toUppercase()[0] + '. ' + last.toUppercase()[0] + '.';
+      return first.toUppercase()[0] + '. ' + last.toUppercase()[0] + '.';
     }
   }
 });