angular-data

angular-data

Inspired by Ember Data, Angular-data is the model layer Angular is missing. It consists of a convenient in-memory cache for managing your data, 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 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 or Object.observe in supporting browsers) allows for powerful use cases and an easy avenue for implementing your own 3-way data-binding.

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: 1.0.0-beta.1 master: 1.0.0-beta.1

Angular-data is in a 1.0.0 Beta. The API is rather stable and angular-data is well tested.

Although angular-data is being used in production, it's not fully 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).

Documentation

http://angular-data.pseudobry.com

Project Status

Branch	Master
Bower
NPM
Build Status
Code Climate
Dependency Status
Coverage

Quick Start

bower install --save angular-data or npm install --save angular-data.

var app = angular.module('myApp', ['angular-data.DS']);

app.factory('User', function (DS) {
  // Simplest resource definition
  return DS.defineResource('user');
});

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);
  });
});

Guide

• Overview
• Basics
• Defining Resources
• Asynchronous Methods
• Synchronous Methods
• Queries & Filtering
• Adapters
• How do I...?

API

• Overview
• DS
• DSHttpAdapter

Changelog

CHANGELOG.md

Version Migration

TRANSITION.md

Community

• Mailing List - Ask your questions!
• Issues - Found a bug? Feature request? Submit an issue!
• GitHub - View the source code for angular-data.
• Design Doc - Design document for Angular-data.
• Contributing Guide

Contributing

First, feel free to contact me with questions. Mailing List. Issues.

1. Contribute to the issue that is the reason you'll be developing in the first place
2. Fork angular-data
3. git clone https://github.com/<you>/angular-data.git
4. cd angular-data; npm install; bower install;
5. grunt go (builds and starts a watch)
6. (in another terminal) grunt karma:dev (runs the tests)
7. Write your code, including relevant documentation and tests
8. 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 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.

Changelog

1.0.0-beta.1 - 23 August 2014

Backwards compatible API changes

• #40 - Support for nested resource endpoints
• #118, #122 - Multiple relationships to the same model
• #120 - When using DSCacheFactory, allow onExpire to be specified
• #132 - Inject relations for parent resource on create
• #141 - Allow lifecycle hooks to be overridden per method as well

Backwards compatible bug fixes

• #126 - injectRelations isn't running when injecting an array

Other

• #121 - Documentation errors
• #123 - Send query params with DS.find()
• #124 - Documentation overhaul