diff --git a/.jshintrc b/.jshintrc index c40ad52..e408dcf 100644 --- a/.jshintrc +++ b/.jshintrc @@ -1,34 +1,39 @@ { - "node": false, - "browser": true, - "es5": true, - "esnext": true, - "bitwise": true, - "camelcase": true, - "curly": true, - "eqeqeq": true, - "immed": true, - "indent": 2, - "latedef": true, - "newcap": true, - "noarg": true, - "quotmark": "single", - "regexp": true, - "undef": true, - "unused": true, - "strict": true, - "trailing": true, - "smarttabs": true, - "predef": [ - "inject", - "describe", - "it", - "beforeEach", - "afterEach", - "assert", - "require", - "module", - "exports", - "angular" - ] + "node": false, + "browser": true, + "es5": true, + "esnext": true, + "bitwise": true, + "camelcase": true, + "curly": true, + "eqeqeq": true, + "immed": true, + "indent": 2, + "latedef": true, + "newcap": true, + "noarg": true, + "quotmark": "single", + "regexp": true, + "undef": true, + "unused": true, + "strict": false, + "trailing": true, + "smarttabs": true, + "globals": { + "inject": true, + "describe": true, + "it": true, + "beforeEach": true, + "afterEach": true, + "assert": true, + "startInjector": true, + "DS": true, + "fail": true, + "$httpBackend": true, + "console": true, + "require": true, + "module": true, + "exports": true, + "angular": true + } } diff --git a/CHANGELOG.md b/CHANGELOG.md index 60bd3a7..faad59c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,18 @@ +##### 0.10.0 - 29 June 2014 + +###### Breaking API changes +- #76 - Queries and filtering. See [TRANSITION.md](https://github.com/jmdobry/angular-data/blob/master/TRANSITION.md). +- #82 - Simplify error handling. Reduced size of angular-data.min.js by 4kb. +- #42 - Relations/Associations. `DS.inject` now looks for relations and injects them as well. + +###### Backwards compatible API changes +- #17 - Where predicates should be able to handle OR, not just AND +- #23 - Computed Properties +- #78 - Added optional callback to `bindOne` and `bindAll` +- #79 - `ejectAll` should clear matching completed queries +- #83 - Implement `DS.loadRelations(resourceName, instance(Id), relations[, options])` +- #84 - idAttribute of a resource can be a computed property + ##### 0.9.1 - 30 May 2014 ###### Backwards compatible bug fixes diff --git a/Gruntfile.js b/Gruntfile.js index 8f690a6..2ec3e89 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -6,372 +6,375 @@ * Licensed under the MIT license. */ module.exports = function (grunt) { - 'use strict'; + 'use strict'; - require('load-grunt-tasks')(grunt); - require('time-grunt')(grunt); + require('load-grunt-tasks')(grunt); + require('time-grunt')(grunt); - var dev = process.cwd().indexOf('/home/jdobry/angular-data') === -1, - pkg = grunt.file.readJSON('package.json'); + var dev = process.cwd().indexOf('/home/jdobry/angular-data') === -1, + pkg = grunt.file.readJSON('package.json'); - // Project configuration. - grunt.initConfig({ - pkg: pkg, - clean: { - coverage: ['coverage/'], - dist: ['dist/'], - doc: ['doc/'], - afterDoc: [ - 'doc/resources/img/angular.png', - 'doc/resources/img/angular_grey.png', - 'doc/resources/img/AngularJS-small.png', - 'doc/resources/img/docular-small.png', - 'doc/resources/img/favicon.ico', - 'doc/resources/img/grunt.png', - 'doc/resources/img/grunt_grey.png', - 'doc/resources/img/node.png', - 'doc/resources/img/node_grey.png', - 'doc/resources/angular/', - 'doc/resources/doc_api_resources/doc_api.js', - 'doc/resources/js/docs*.js', - 'doc/resources/js/jquery*.js' - ] - }, - jshint: { - all: ['Gruntfile.js', 'src/**/*.js', 'test/*.js'], - jshintrc: '.jshintrc' - }, - watch: { - files: ['src/**/*.js'], - tasks: ['build'] - }, - uglify: { - main: { - options: { - banner: '/**\n' + - '* @author Jason Dobry \n' + - '* @file angular-data.min.js\n' + - '* @version <%= pkg.version %> - Homepage \n' + - '* @copyright (c) 2014 Jason Dobry \n' + - '* @license MIT \n' + - '*\n' + - '* @overview Data store for Angular.js.\n' + - '*/\n' - }, - files: { - 'dist/angular-data.min.js': ['dist/angular-data.js'] - } - }, - scripts: { - files: { - 'doc/resources/js/libs.min.js': ['doc/resources/js/libs.js'] - } - } - }, - browserify: { - dist: { - files: { - 'dist/angular-data.js': ['src/index.js'] - }, - options: { - // TODO: There's got to be a better way to consume observe-js without it polluting the global space - postBundleCB: function (err, src, next) { - if (err) { - next(err); - } - src = src.replace('(typeof global !== \'undefined\' && global ? global : window)', '((exports.Number = { isNaN: window.isNaN }) ? exports : exports)'); - next(err, src); - } - } - } - }, - karma: { - options: { - configFile: './karma.conf.js' - }, - dev: { - browsers: ['Chrome'], - autoWatch: true, - singleRun: false, - exclude: [ - 'test/integration/datastore/cacheFactory.test.js' - ] - }, - min: { - browsers: ['Firefox', 'PhantomJS'], - options: { - files: [ - 'bower_components/angular/angular.js', - 'bower_components/angular-mocks/angular-mocks.js', - 'bower_components/angular-cache/dist/angular-cache.js', - 'dist/angular-data.min.js', - 'karma.start.js', - 'test/integration/**/*.js' - ] - }, - exclude: [ - 'test/integration/datastore/cacheFactory.test.js' - ] - }, - cacheFactory: { - browsers: ['Firefox', 'PhantomJS'], - options: { - files: [ - 'bower_components/angular/angular.js', - 'bower_components/angular-mocks/angular-mocks.js', - 'dist/angular-data.js', - 'karma.start.js', - 'test/integration/datastore/cacheFactory.test.js' - ] - } - }, - ci: { - browsers: ['Firefox', 'PhantomJS'], - exclude: [ - 'test/integration/datastore/cacheFactory.test.js' - ] - } - }, - coveralls: { - options: { - coverage_dir: 'coverage' - } - }, + // Project configuration. + grunt.initConfig({ + pkg: pkg, + clean: { + coverage: ['coverage/'], + dist: ['dist/'], + doc: ['doc/'], + afterDoc: [ + 'doc/resources/img/angular.png', + 'doc/resources/img/angular_grey.png', + 'doc/resources/img/AngularJS-small.png', + 'doc/resources/img/docular-small.png', + 'doc/resources/img/favicon.ico', + 'doc/resources/img/grunt.png', + 'doc/resources/img/grunt_grey.png', + 'doc/resources/img/node.png', + 'doc/resources/img/node_grey.png', + 'doc/resources/angular/', + 'doc/resources/doc_api_resources/doc_api.js', + 'doc/resources/js/docs*.js', + 'doc/resources/js/jquery*.js' + ] + }, + jshint: { + all: ['Gruntfile.js', 'src/**/*.js', 'test/*.js'], + jshintrc: '.jshintrc' + }, + watch: { + files: ['src/**/*.js'], + tasks: ['build'] + }, + uglify: { + main: { + options: { + banner: '/**\n' + + '* @author Jason Dobry \n' + + '* @file angular-data.min.js\n' + + '* @version <%= pkg.version %> - Homepage \n' + + '* @copyright (c) 2014 Jason Dobry \n' + + '* @license MIT \n' + + '*\n' + + '* @overview Data store for Angular.js.\n' + + '*/\n' + }, + files: { + 'dist/angular-data.min.js': ['dist/angular-data.js'] + } + }, + scripts: { + files: { + 'doc/resources/js/libs.min.js': ['doc/resources/js/libs.js'] + } + } + }, + browserify: { + dist: { + files: { + 'dist/angular-data.js': ['src/index.js'] + }, + options: { + // TODO: There's got to be a better way to consume observe-js without it polluting the global space + postBundleCB: function (err, src, next) { + if (err) { + next(err); + } + src = src.replace('(typeof global !== \'undefined\' && global ? global : window)', '((exports.Number = { isNaN: window.isNaN }) ? exports : exports)'); + next(err, src); + } + } + } + }, + karma: { + options: { + configFile: './karma.conf.js' + }, + dev: { + browsers: ['Chrome'], + autoWatch: true, + singleRun: false, + reporters: ['spec'], + preprocessors: {}, + exclude: [ + 'test/integration/datastore/cacheFactory.test.js' + ] + }, + min: { + browsers: ['Firefox', 'PhantomJS'], + options: { + files: [ + 'bower_components/angular/angular.js', + 'bower_components/angular-mocks/angular-mocks.js', + 'bower_components/angular-cache/dist/angular-cache.js', + 'dist/angular-data.min.js', + 'karma.start.js', + 'test/integration/**/*.js' + ] + }, + exclude: [ + 'test/integration/datastore/cacheFactory.test.js' + ] + }, + cacheFactory: { + browsers: ['Firefox', 'PhantomJS'], + options: { + files: [ + 'bower_components/angular/angular.js', + 'bower_components/angular-mocks/angular-mocks.js', + 'dist/angular-data.js', + 'karma.start.js', + 'test/integration/datastore/cacheFactory.test.js' + ] + } + }, + ci: { + browsers: ['Firefox', 'PhantomJS'], + exclude: [ + 'test/integration/datastore/cacheFactory.test.js' + ] + } + }, + coveralls: { + options: { + coverage_dir: 'coverage' + } + }, - concat: { - libs: { - src: [ - 'doc/resources/js/jquery.js', - 'doc/resources/js/jquery.goto.js', - 'doc/resources/js/jquery.cookie.js', - 'doc/resources/angular/angular.js', - 'doc/resources/angular/angular-bootstrap.js', - 'doc/resources/angular/angular-bootstrap-prettify.js', - 'doc/resources/angular/angular-cookies.js', - 'doc/resources/angular/angular-resource.js', - 'doc/resources/angular/angular-sanitize.js' + concat: { + libs: { + src: [ + 'doc/resources/js/jquery.js', + 'doc/resources/js/jquery.goto.js', + 'doc/resources/js/jquery.cookie.js', + 'doc/resources/angular/angular.js', + 'doc/resources/angular/angular-bootstrap.js', + 'doc/resources/angular/angular-bootstrap-prettify.js', + 'doc/resources/angular/angular-cookies.js', + 'doc/resources/angular/angular-resource.js', + 'doc/resources/angular/angular-sanitize.js' - ], - dest: 'doc/resources/js/libs.js' - }, - scripts: { - src: [ - 'doc/resources/js/docs_module_begin.js', - 'guide/angular-data.js', - 'doc/resources/doc_api_resources/doc_api.js', - 'doc/resources/js/docs_module_end.js', - 'doc/documentation/docs-metadata.js', - 'doc/documentation/groups-metadata.js', - 'doc/documentation/layout-metadata.js' + ], + dest: 'doc/resources/js/libs.js' + }, + scripts: { + src: [ + 'doc/resources/js/docs_module_begin.js', + 'guide/angular-data.js', + 'doc/resources/doc_api_resources/doc_api.js', + 'doc/resources/js/docs_module_end.js', + 'doc/documentation/docs-metadata.js', + 'doc/documentation/groups-metadata.js', + 'doc/documentation/layout-metadata.js' - ], - dest: 'doc/resources/js/scripts.js' - }, - css: { - src: [ - 'doc/resources/css/bootstrap.min.css', - 'doc/resources/css/font-awesome.css', - 'doc/resources/css/docular.css', - 'doc/resources/css/custom.css', - 'doc/resources/doc_api_resources/doc_api.css', - 'guide/angular-data.css' - ], - dest: 'doc/resources/css/styles.css' - } - }, + ], + dest: 'doc/resources/js/scripts.js' + }, + css: { + src: [ + 'doc/resources/css/bootstrap.min.css', + 'doc/resources/css/font-awesome.css', + 'doc/resources/css/docular.css', + 'doc/resources/css/custom.css', + 'doc/resources/doc_api_resources/doc_api.css', + 'guide/angular-data.css' + ], + dest: 'doc/resources/css/styles.css' + } + }, - copy: { - favicon: { - expand: true, - cwd: 'guide/', - src: 'favicon.ico', - dest: 'doc/', - flatten: true - }, - index: { - expand: true, - cwd: 'guide/', - src: 'index.html', - dest: 'doc/', - flatten: true - }, - data_white: { - expand: true, - cwd: 'guide/', - src: 'data_white.png', - dest: 'doc/resources/img/', - flatten: true - }, - chart: { - expand: true, - cwd: 'guide/', - src: 'chart.png', - dest: 'doc/resources/img/', - flatten: true - }, - cream_dust: { - expand: true, - cwd: 'guide/', - src: 'cream_dust.png', - dest: 'doc/resources/img/', - flatten: true - } - }, - docular: { - groups: [ - { - groupTitle: 'Guide', - groupId: 'guide', - groupIcon: 'icon-book', - sections: [ - { - id: 'angular-data', - title: 'angular-data', - docs: [ - 'guide/angular-data/index.doc', - 'guide/angular-data/overview.doc', - 'guide/angular-data/resources.doc', - 'guide/angular-data/asynchronous.doc', - 'guide/angular-data/synchronous.doc', - 'guide/angular-data/queries.doc', - 'guide/angular-data/adapters.doc', - 'guide/angular-data/how.doc' - ], - rank: { - index: 1, - overview: 2, - resources: 3, - asynchronous: 4, - synchronous: 5, - queries: 6, - adapters: 7, - how: 8 - } - }, - { - id: 'angular-cache', - title: 'angular-cache', - docs: ['guide/angular-cache/'], - rank: { - index: 1, - basics: 2, - configure: 3, - http: 4, - storage: 5 - } - }, - { - id: 'angular-data-mocks', - title: 'angular-data-mocks', - docs: ['guide/angular-data-mocks/'], - rank: { - index: 1, - overview: 2, - setup: 3, - testing: 4 - } - }, - { - id: 'angular-data-resource', - title: 'Defining Resources', - docs: ['guide/angular-data/resource/'], - rank: { - index: 1, - overview: 2, - basic: 3, - advanced: 4, - lifecycle: 5, - custom: 6 - } - } - ] - }, - { - groupTitle: 'API', - groupId: 'api', - groupIcon: 'icon-wrench', - showSource: true, - sections: [ - { - id: 'angular-data', - title: 'angular-data', - scripts: [ - 'src/' - ], - docs: ['guide/api'] - }, - { - id: 'angular-cache', - title: 'angular-cache', - scripts: [ - 'bower_components/angular-cache/dist/angular-cache.js' - ], - docs: ['guide/api'] - }, - { - id: 'angular-data-mocks', - title: 'angular-data-mocks', - scripts: [ - 'bower_components/angular-data-mocks/dist/angular-data-mocks.js' - ], - docs: ['guide/api'] - } - ] - } - ], - docular_webapp_target: 'doc', - showDocularDocs: false, - showAngularDocs: false, - docular_partial_home: 'guide/home.html', - docular_partial_navigation: 'guide/nav.html', - docular_partial_footer: 'guide/footer.html', - analytics: { - account: 'UA-34445126-2', - domainName: 'angular-data.pseudobry.com' - }, - discussions: { - shortName: 'angular-data', - url: 'http://angular-data.pseudobry.com', - dev: dev - } - } - }); + copy: { + favicon: { + expand: true, + cwd: 'guide/', + src: 'favicon.ico', + dest: 'doc/', + flatten: true + }, + index: { + expand: true, + cwd: 'guide/', + src: 'index.html', + dest: 'doc/', + flatten: true + }, + data_white: { + expand: true, + cwd: 'guide/', + src: 'data_white.png', + dest: 'doc/resources/img/', + flatten: true + }, + chart: { + expand: true, + cwd: 'guide/', + src: 'chart.png', + dest: 'doc/resources/img/', + flatten: true + }, + cream_dust: { + expand: true, + cwd: 'guide/', + src: 'cream_dust.png', + dest: 'doc/resources/img/', + flatten: true + } + }, + docular: { + groups: [ + { + groupTitle: 'Guide', + groupId: 'guide', + groupIcon: 'icon-book', + sections: [ + { + id: 'angular-data', + title: 'angular-data', + docs: [ + 'guide/angular-data/index.md', + 'guide/angular-data/overview.md', + 'guide/angular-data/resources.md', + 'guide/angular-data/asynchronous.md', + 'guide/angular-data/synchronous.md', + 'guide/angular-data/queries.md', + 'guide/angular-data/adapters.md', + 'guide/angular-data/how.md' + ], + rank: { + index: 1, + overview: 2, + resources: 3, + asynchronous: 4, + synchronous: 5, + queries: 6, + adapters: 7, + how: 8 + } + }, + { + id: 'angular-cache', + title: 'angular-cache', + docs: ['guide/angular-cache/'], + rank: { + index: 1, + basics: 2, + configure: 3, + http: 4, + storage: 5 + } + }, + { + id: 'angular-data-mocks', + title: 'angular-data-mocks', + docs: ['guide/angular-data-mocks/'], + rank: { + index: 1, + overview: 2, + setup: 3, + testing: 4 + } + }, + { + id: 'angular-data-resource', + title: 'Defining Resources', + docs: ['guide/angular-data/resource/'], + rank: { + index: 1, + overview: 2, + basic: 3, + advanced: 4, + lifecycle: 5, + custom: 6, + relations: 7 + } + } + ] + }, + { + groupTitle: 'API', + groupId: 'api', + groupIcon: 'icon-wrench', + showSource: true, + sections: [ + { + id: 'angular-data', + title: 'angular-data', + scripts: [ + 'src/' + ], + docs: ['guide/api'] + }, + { + id: 'angular-cache', + title: 'angular-cache', + scripts: [ + 'bower_components/angular-cache/dist/angular-cache.js' + ], + docs: ['guide/api'] + }, + { + id: 'angular-data-mocks', + title: 'angular-data-mocks', + scripts: [ + 'bower_components/angular-data-mocks/dist/angular-data-mocks.js' + ], + docs: ['guide/api'] + } + ] + } + ], + docular_webapp_target: 'doc', + showDocularDocs: false, + showAngularDocs: false, + docular_partial_home: 'guide/home.html', + docular_partial_navigation: 'guide/nav.html', + docular_partial_footer: 'guide/footer.html', + analytics: { + account: 'UA-34445126-2', + domainName: 'angular-data.pseudobry.com' + }, + discussions: { + shortName: 'angular-data', + url: 'http://angular-data.pseudobry.com', + dev: dev + } + } + }); - grunt.registerTask('version', function (filePath) { - var file = grunt.file.read(filePath); + grunt.registerTask('version', function (filePath) { + var file = grunt.file.read(filePath); - file = file.replace(/<%= pkg\.version %>/gi, pkg.version); + file = file.replace(/<%= pkg\.version %>/gi, pkg.version); - grunt.file.write(filePath, file); - }); + grunt.file.write(filePath, file); + }); - grunt.registerTask('banner', function () { - var file = grunt.file.read('dist/angular-data.js'); + grunt.registerTask('banner', function () { + var file = grunt.file.read('dist/angular-data.js'); - var banner = '/**\n' + - '* @author Jason Dobry \n' + - '* @file angular-data.js\n' + - '* @version ' + pkg.version + ' - Homepage \n' + - '* @copyright (c) 2014 Jason Dobry \n' + - '* @license MIT \n' + - '*\n' + - '* @overview Data store for Angular.js.\n' + - '*/\n'; + var banner = '/**\n' + + '* @author Jason Dobry \n' + + '* @file angular-data.js\n' + + '* @version ' + pkg.version + ' - Homepage \n' + + '* @copyright (c) 2014 Jason Dobry \n' + + '* @license MIT \n' + + '*\n' + + '* @overview Data store for Angular.js.\n' + + '*/\n'; - file = banner + file; + file = banner + file; - grunt.file.write('dist/angular-data.js', file); - }); + grunt.file.write('dist/angular-data.js', file); + }); - grunt.registerTask('test', ['build', 'karma:ci', 'karma:cacheFactory', 'karma:min']); - grunt.registerTask('doc', ['clean:doc', 'docular', 'concat', 'copy', 'clean:afterDoc', 'uglify:scripts']); - grunt.registerTask('build', [ - 'clean', - 'jshint', - 'browserify', - 'banner', - 'uglify:main' - ]); - grunt.registerTask('go', ['build', 'watch']); - grunt.registerTask('default', ['build']); + grunt.registerTask('test', ['build', 'karma:ci', 'karma:cacheFactory', 'karma:min']); + grunt.registerTask('doc', ['clean:doc', 'docular', 'concat', 'copy', 'clean:afterDoc', 'uglify:scripts']); + grunt.registerTask('build', [ + 'clean', + 'jshint', + 'browserify', + 'banner', + 'uglify:main' + ]); + grunt.registerTask('go', ['build', 'watch']); + grunt.registerTask('default', ['build']); }; diff --git a/README.md b/README.md index a36ceba..5891181 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ __Data store for Angular.js.__ -__Latest Release:__ [0.9.1](http://angular-data.codetrain.io/) -__master:__ [0.9.1](http://angular-data-next.codetrain.io/) +__Latest Release:__ [0.9.1](http://angular-data.pseudobry.com/) +__master:__ [0.9.1](http://angular-data-next.pseudobry.com/) Angular-data is in a pre-1.0.0 development stage; the API is fluctuating, not a lot of tests yet, etc. diff --git a/TRANSITION.md b/TRANSITION.md new file mode 100644 index 0000000..3512475 --- /dev/null +++ b/TRANSITION.md @@ -0,0 +1,100 @@ +### 0.9.x. ---> 0.10.0 - 29 June 2014 + +#### Breaking API changes +##### #76 - Queries and filtering. + +###### Before +`IllegalArgumentError` has an `errors` field. + +###### After +`IllegalArgumentError` no longer has an `errors` field. + +###### Before +```javascript +DS.findAll('post', { + query: { + where: { + name: 'John' + } + } +}) +``` + +###### After +```javascript +DS.findAll('post', { + where: { + name: 'John' + } +}) +``` + +###### Before +```javascript +DS.filter('post', { + query: { + where: { + name: 'John' + } + } +}) +``` + +###### After +```javascript +DS.filter('post', { + where: { + name: 'John' + } +}) +``` + +###### Before +```javascript +// override how DS.filter handles the "where" clause +DSProvider.defaults.filter = function (resourceName, where, attrs) { + // return true to keep the item in the result set + // return false to exclude it +}; +``` + +###### After +```javascript +// override how DS.filter handles the "where", "skip", "limit" and "orderBy" clauses +DSProvider.defaults.filter = function (collection, resourceName, params, options) { + // examine params and + // decide whether to exclude items, skip items, start from an offset, or sort the items + + // see the [default implementation that ships with angular-data](https://github.com/jmdobry/angular-data/blob/master/src/datastore/index.js#L12) + // overriding this method is useful when our server only understands a certain + // params format and you want angular-data's filter to behave the same as your server + + // angular-data looks for the following fields: + // - where + // - skip (or offset) + // - limit + // - orderBy (or sort) + + // return the filtered collection +}; +``` + +###### Before +```javascript +DSHttpAdapter.defaults.queryTransform = function (resourceName, query) { + // the second argument was the "query" field of the "params" passed in the DSHttpAdapter method + // return the transformed query +}; +``` + +###### After +```javascript +// This is useful when you don't want to implement the filter method above +// and instead rely on angular-data's expectation of where, skip, limit, orderBy, etc. +// This transform is useful when you want to change the where, skip, limit, orderBy, etc. fields +// into something your server understands. +DSHttpAdapter.defaults.queryTransform = function (resourceName, params) { + // the second argument is now the whole "params" object passed in the DSHttpAdapter method + // return the transformed params +}; +``` diff --git a/bower.json b/bower.json index a3bcbc1..7dafcef 100644 --- a/bower.json +++ b/bower.json @@ -2,8 +2,8 @@ "author": "Jason Dobry", "name": "angular-data", "description": "Data store for Angular.js.", - "version": "0.9.1", - "homepage": "http://angular-data.codetrain.io/", + "version": "0.10.0", + "homepage": "http://angular-data.pseudobry.com/", "repository": { "type": "git", "url": "git://github.com/jmdobry/angular-data.git" diff --git a/dist/angular-data.js b/dist/angular-data.js index b2fde84..82d7702 100644 --- a/dist/angular-data.js +++ b/dist/angular-data.js @@ -1,7 +1,7 @@ /** * @author Jason Dobry * @file angular-data.js -* @version 0.9.1 - Homepage +* @version 0.10.0 - Homepage * @copyright (c) 2014 Jason Dobry * @license MIT * @@ -1206,429 +1206,423 @@ var toString = require('../lang/toString'); */ function DSHttpAdapterProvider() { - /** - * @doc property - * @id DSHttpAdapterProvider.properties:defaults - * @name defaults - * @description - * Default configuration for this adapter. - * - * Properties: - * - * - `{function}` - `queryTransform` - See [the guide](/documentation/guide/adapters/index). Default: No-op. - */ - var defaults = this.defaults = { - /** - * @doc property - * @id DSHttpAdapterProvider.properties:defaults.queryTransform - * @name defaults.queryTransform - * @description - * Transform the angular-data query to something your server understands. You might just do this on the server instead. - * - * @param {string} resourceName The name of the resource. - * @param {object} query Response object from `$http()`. - * @returns {*} Returns `query` as-is. - */ - queryTransform: function (resourceName, query) { - return query; - } - }; + /** + * @doc property + * @id DSHttpAdapterProvider.properties:defaults + * @name defaults + * @description + * Default configuration for this adapter. + * + * Properties: + * + * - `{function}` - `queryTransform` - See [the guide](/documentation/guide/adapters/index). Default: No-op. + */ + var defaults = this.defaults = { + /** + * @doc property + * @id DSHttpAdapterProvider.properties:defaults.queryTransform + * @name defaults.queryTransform + * @description + * Transform the angular-data query to something your server understands. You might just do this on the server instead. + * + * @param {string} resourceName The name of the resource. + * @param {object} params Params sent through from `$http()`. + * @returns {*} Returns `params` as-is. + */ + queryTransform: function (resourceName, params) { + return params; + } + }; - this.$get = ['$http', '$log', 'DSUtils', function ($http, $log, DSUtils) { + this.$get = ['$http', '$log', 'DSUtils', function ($http, $log, DSUtils) { - /** - * @doc interface - * @id DSHttpAdapter - * @name DSHttpAdapter - * @description - * Default adapter used by angular-data. This adapter uses AJAX and JSON to send/retrieve data to/from a server. - * Developers may provide custom adapters that implement the adapter interface. - */ - return { - /** - * @doc property - * @id DSHttpAdapter.properties:defaults - * @name defaults - * @description - * Reference to [DSHttpAdapterProvider.defaults](/documentation/api/api/DSHttpAdapterProvider.properties:defaults). - */ - defaults: defaults, - - /** - * @doc method - * @id DSHttpAdapter.methods:HTTP - * @name HTTP - * @description - * Wrapper for `$http()`. - * - * ## Signature: - * ```js - * DS.HTTP(config) - * ``` - * - * ## Example: - * - * ```js - * works the same as $http() - * ``` - * - * @param {object} config Configuration for the request. - * @returns {Promise} Promise produced by the `$q` service. - */ - HTTP: HTTP, - - /** - * @doc method - * @id DSHttpAdapter.methods:GET - * @name GET - * @description - * Wrapper for `$http.get()`. - * - * ## Signature: - * ```js - * DS.GET(url[, config]) - * ``` - * - * ## Example: - * - * ```js - * Works the same as $http.get() - * ``` - * - * @param {string} url The url of the request. - * @param {object=} config Configuration for the request. - * @returns {Promise} Promise produced by the `$q` service. - */ - GET: GET, - - /** - * @doc method - * @id DSHttpAdapter.methods:POST - * @name POST - * @description - * Wrapper for `$http.post()`. - * - * ## Signature: - * ```js - * DS.POST(url[, attrs][, config]) - * ``` - * - * ## Example: - * - * ```js - * Works the same as $http.post() - * ``` - * - * @param {string} url The url of the request. - * @param {object=} attrs Request payload. - * @param {object=} config Configuration for the request. - * @returns {Promise} Promise produced by the `$q` service. - */ - POST: POST, - - /** - * @doc method - * @id DSHttpAdapter.methods:PUT - * @name PUT - * @description - * Wrapper for `$http.put()`. - * - * ## Signature: - * ```js - * DS.PUT(url[, attrs][, config]) - * ``` - * - * ## Example: - * - * ```js - * Works the same as $http.put() - * ``` - * - * @param {string} url The url of the request. - * @param {object=} attrs Request payload. - * @param {object=} config Configuration for the request. - * @returns {Promise} Promise produced by the `$q` service. - */ - PUT: PUT, - - /** - * @doc method - * @id DSHttpAdapter.methods:DEL - * @name DEL - * @description - * Wrapper for `$http.delete()`. - * - * ## Signature: - * ```js - * DS.DEL(url[, config]) - * ``` - * - * ## Example: - * - * ```js - * Works the same as $http.delete - * ``` - * - * @param {string} url The url of the request. - * @param {object} config Configuration for the request. - * @returns {Promise} Promise produced by the `$q` service. - */ - DEL: DEL, - - /** - * @doc method - * @id DSHttpAdapter.methods:find - * @name find - * @description - * Retrieve a single entity from the server. - * - * Sends a `GET` request to `:baseUrl/:endpoint/:id`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {string|number} id The primary key of the entity to retrieve. - * @param {object=} options Optional configuration. Refer to the documentation for `$http.get`. - * @returns {Promise} Promise. - */ - find: find, - - /** - * @doc method - * @id DSHttpAdapter.methods:findAll - * @name findAll - * @description - * Retrieve a collection of entities from the server. - * - * Sends a `GET` request to `:baseUrl/:endpoint`. - * - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). - * @param {object=} options Optional configuration. Refer to the documentation for `$http.get`. - * @returns {Promise} Promise. - */ - findAll: findAll, - - /** - * @doc method - * @id DSHttpAdapter.methods:findAll - * @name find - * @description - * Create a new entity on the server. - * - * Sends a `POST` request to `:baseUrl/:endpoint`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). - * @param {object=} options Optional configuration. Refer to the documentation for `$http.post`. - * @returns {Promise} Promise. - */ - create: create, - - /** - * @doc method - * @id DSHttpAdapter.methods:update - * @name update - * @description - * Update an entity on the server. - * - * Sends a `PUT` request to `:baseUrl/:endpoint/:id`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {string|number} id The primary key of the entity to update. - * @param {object} attrs The attributes with which to update the entity. See the [query guide](/documentation/guide/queries/index). - * @param {object=} options Optional configuration. Refer to the documentation for `$http.put`. - * @returns {Promise} Promise. - */ - update: update, - - /** - * @doc method - * @id DSHttpAdapter.methods:updateAll - * @name updateAll - * @description - * Update a collection of entities on the server. - * - * Sends a `PUT` request to `:baseUrl/:endpoint`. - * - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). - * @param {object=} options Optional configuration. Refer to the documentation for `$http.put`. - * @returns {Promise} Promise. - */ - updateAll: updateAll, - - /** - * @doc method - * @id DSHttpAdapter.methods:destroy - * @name destroy - * @description - * destroy an entity on the server. - * - * Sends a `PUT` request to `:baseUrl/:endpoint/:id`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {string|number} id The primary key of the entity to destroy. - * @param {object=} options Optional configuration. Refer to the documentation for `$http.delete`. - * @returns {Promise} Promise. - */ - destroy: destroy, - - /** - * @doc method - * @id DSHttpAdapter.methods:destroyAll - * @name destroyAll - * @description - * Retrieve a collection of entities from the server. - * - * Sends a `DELETE` request to `:baseUrl/:endpoint`. - * - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). - * @param {object=} options Optional configuration. Refer to the documentation for `$http.delete`. - * @returns {Promise} Promise. - */ - destroyAll: destroyAll - }; + /** + * @doc interface + * @id DSHttpAdapter + * @name DSHttpAdapter + * @description + * Default adapter used by angular-data. This adapter uses AJAX and JSON to send/retrieve data to/from a server. + * Developers may provide custom adapters that implement the adapter interface. + */ + return { + /** + * @doc property + * @id DSHttpAdapter.properties:defaults + * @name defaults + * @description + * Reference to [DSHttpAdapterProvider.defaults](/documentation/api/api/DSHttpAdapterProvider.properties:defaults). + */ + defaults: defaults, + + /** + * @doc method + * @id DSHttpAdapter.methods:HTTP + * @name HTTP + * @description + * Wrapper for `$http()`. + * + * ## Signature: + * ```js + * DS.HTTP(config) + * ``` + * + * ## Example: + * + * ```js + * works the same as $http() + * ``` + * + * @param {object} config Configuration for the request. + * @returns {Promise} Promise produced by the `$q` service. + */ + HTTP: HTTP, + + /** + * @doc method + * @id DSHttpAdapter.methods:GET + * @name GET + * @description + * Wrapper for `$http.get()`. + * + * ## Signature: + * ```js + * DS.GET(url[, config]) + * ``` + * + * ## Example: + * + * ```js + * Works the same as $http.get() + * ``` + * + * @param {string} url The url of the request. + * @param {object=} config Configuration for the request. + * @returns {Promise} Promise produced by the `$q` service. + */ + GET: GET, + + /** + * @doc method + * @id DSHttpAdapter.methods:POST + * @name POST + * @description + * Wrapper for `$http.post()`. + * + * ## Signature: + * ```js + * DS.POST(url[, attrs][, config]) + * ``` + * + * ## Example: + * + * ```js + * Works the same as $http.post() + * ``` + * + * @param {string} url The url of the request. + * @param {object=} attrs Request payload. + * @param {object=} config Configuration for the request. + * @returns {Promise} Promise produced by the `$q` service. + */ + POST: POST, + + /** + * @doc method + * @id DSHttpAdapter.methods:PUT + * @name PUT + * @description + * Wrapper for `$http.put()`. + * + * ## Signature: + * ```js + * DS.PUT(url[, attrs][, config]) + * ``` + * + * ## Example: + * + * ```js + * Works the same as $http.put() + * ``` + * + * @param {string} url The url of the request. + * @param {object=} attrs Request payload. + * @param {object=} config Configuration for the request. + * @returns {Promise} Promise produced by the `$q` service. + */ + PUT: PUT, + + /** + * @doc method + * @id DSHttpAdapter.methods:DEL + * @name DEL + * @description + * Wrapper for `$http.delete()`. + * + * ## Signature: + * ```js + * DS.DEL(url[, config]) + * ``` + * + * ## Example: + * + * ```js + * Works the same as $http.delete + * ``` + * + * @param {string} url The url of the request. + * @param {object} config Configuration for the request. + * @returns {Promise} Promise produced by the `$q` service. + */ + DEL: DEL, + + /** + * @doc method + * @id DSHttpAdapter.methods:find + * @name find + * @description + * Retrieve a single entity from the server. + * + * Sends a `GET` request to `:baseUrl/:endpoint/:id`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {string|number} id The primary key of the entity to retrieve. + * @param {object=} options Optional configuration. Refer to the documentation for `$http.get`. + * @returns {Promise} Promise. + */ + find: find, + + /** + * @doc method + * @id DSHttpAdapter.methods:findAll + * @name findAll + * @description + * Retrieve a collection of entities from the server. + * + * Sends a `GET` request to `:baseUrl/:endpoint`. + * + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). + * @param {object=} options Optional configuration. Refer to the documentation for `$http.get`. + * @returns {Promise} Promise. + */ + findAll: findAll, + + /** + * @doc method + * @id DSHttpAdapter.methods:findAll + * @name find + * @description + * Create a new entity on the server. + * + * Sends a `POST` request to `:baseUrl/:endpoint`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). + * @param {object=} options Optional configuration. Refer to the documentation for `$http.post`. + * @returns {Promise} Promise. + */ + create: create, + + /** + * @doc method + * @id DSHttpAdapter.methods:update + * @name update + * @description + * Update an entity on the server. + * + * Sends a `PUT` request to `:baseUrl/:endpoint/:id`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {string|number} id The primary key of the entity to update. + * @param {object} attrs The attributes with which to update the entity. See the [query guide](/documentation/guide/queries/index). + * @param {object=} options Optional configuration. Refer to the documentation for `$http.put`. + * @returns {Promise} Promise. + */ + update: update, + + /** + * @doc method + * @id DSHttpAdapter.methods:updateAll + * @name updateAll + * @description + * Update a collection of entities on the server. + * + * Sends a `PUT` request to `:baseUrl/:endpoint`. + * + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). + * @param {object=} options Optional configuration. Refer to the documentation for `$http.put`. + * @returns {Promise} Promise. + */ + updateAll: updateAll, + + /** + * @doc method + * @id DSHttpAdapter.methods:destroy + * @name destroy + * @description + * destroy an entity on the server. + * + * Sends a `PUT` request to `:baseUrl/:endpoint/:id`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {string|number} id The primary key of the entity to destroy. + * @param {object=} options Optional configuration. Refer to the documentation for `$http.delete`. + * @returns {Promise} Promise. + */ + destroy: destroy, + + /** + * @doc method + * @id DSHttpAdapter.methods:destroyAll + * @name destroyAll + * @description + * Retrieve a collection of entities from the server. + * + * Sends a `DELETE` request to `:baseUrl/:endpoint`. + * + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). + * @param {object=} options Optional configuration. Refer to the documentation for `$http.delete`. + * @returns {Promise} Promise. + */ + destroyAll: destroyAll + }; - function HTTP(config) { - var start = new Date().getTime(); + function HTTP(config) { + var start = new Date().getTime(); - return $http(config).then(function (data) { - $log.debug(data.config.method + ' request:' + data.config.url + ' Time taken: ' + (new Date().getTime() - start) + 'ms', arguments); - return data; - }); - } + return $http(config).then(function (data) { + $log.debug(data.config.method + ' request:' + data.config.url + ' Time taken: ' + (new Date().getTime() - start) + 'ms', arguments); + return data; + }); + } - function GET(url, config) { - config = config || {}; - return HTTP(DSUtils.deepMixIn(config, { - url: url, - method: 'GET' - })); - } + function GET(url, config) { + config = config || {}; + return HTTP(DSUtils.deepMixIn(config, { + url: url, + method: 'GET' + })); + } - function POST(url, attrs, config) { - config = config || {}; - return HTTP(DSUtils.deepMixIn(config, { - url: url, - data: attrs, - method: 'POST' - })); - } + function POST(url, attrs, config) { + config = config || {}; + return HTTP(DSUtils.deepMixIn(config, { + url: url, + data: attrs, + method: 'POST' + })); + } - function PUT(url, attrs, config) { - config = config || {}; - return HTTP(DSUtils.deepMixIn(config, { - url: url, - data: attrs, - method: 'PUT' - })); - } + function PUT(url, attrs, config) { + config = config || {}; + return HTTP(DSUtils.deepMixIn(config, { + url: url, + data: attrs, + method: 'PUT' + })); + } - function DEL(url, config) { - config = config || {}; - return this.HTTP(DSUtils.deepMixIn(config, { - url: url, - method: 'DELETE' - })); - } + function DEL(url, config) { + config = config || {}; + return this.HTTP(DSUtils.deepMixIn(config, { + url: url, + method: 'DELETE' + })); + } - function create(resourceConfig, attrs, options) { - options = options || {}; - return this.POST( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), - attrs, - options - ); - } + function create(resourceConfig, attrs, options) { + options = options || {}; + return this.POST( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), + attrs, + options + ); + } - function destroy(resourceConfig, id, options) { - options = options || {}; - return this.DEL( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), - options - ); - } + function destroy(resourceConfig, id, options) { + options = options || {}; + return this.DEL( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), + options + ); + } - function destroyAll(resourceConfig, params, options) { - options = options || {}; - options.params = options.params || {}; - if (params) { - if (params.query) { - params.query = defaults.queryTransform(resourceConfig.name, params.query); - } - DSUtils.deepMixIn(options.params, params); - } - return this.DEL( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), - options - ); - } + function destroyAll(resourceConfig, params, options) { + options = options || {}; + options.params = options.params || {}; + if (params) { + params = defaults.queryTransform(resourceConfig.name, params); + DSUtils.deepMixIn(options.params, params); + } + return this.DEL( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), + options + ); + } - function find(resourceConfig, id, options) { - options = options || {}; - return this.GET( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), - options - ); - } + function find(resourceConfig, id, options) { + options = options || {}; + return this.GET( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), + options + ); + } - function findAll(resourceConfig, params, options) { - options = options || {}; - options.params = options.params || {}; - if (params) { - if (params.query) { - params.query = defaults.queryTransform(resourceConfig.name, params.query); - } - DSUtils.deepMixIn(options.params, params); - } - return this.GET( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), - options - ); - } + function findAll(resourceConfig, params, options) { + options = options || {}; + options.params = options.params || {}; + if (params) { + params = defaults.queryTransform(resourceConfig.name, params); + DSUtils.deepMixIn(options.params, params); + } + return this.GET( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), + options + ); + } - function update(resourceConfig, id, attrs, options) { - options = options || {}; - return this.PUT( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), - attrs, - options - ); - } + function update(resourceConfig, id, attrs, options) { + options = options || {}; + return this.PUT( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), + attrs, + options + ); + } - function updateAll(resourceConfig, attrs, params, options) { - options = options || {}; - options.params = options.params || {}; - if (params) { - if (params.query) { - params.query = defaults.queryTransform(resourceConfig.name, params.query); - } - DSUtils.deepMixIn(options.params, params); - } - return this.PUT( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), - attrs, - options - ); - } - }]; + function updateAll(resourceConfig, attrs, params, options) { + options = options || {}; + options.params = options.params || {}; + if (params) { + params = defaults.queryTransform(resourceConfig.name, params); + DSUtils.deepMixIn(options.params, params); + } + return this.PUT( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), + attrs, + options + ); + } + }]; } module.exports = DSHttpAdapterProvider; @@ -1641,179 +1635,179 @@ module.exports = DSHttpAdapterProvider; */ function DSLocalStorageProvider() { - this.$get = ['$q', 'DSUtils', function ($q, DSUtils) { + this.$get = ['$q', 'DSUtils', function ($q, DSUtils) { - /** - * @doc interface - * @id DSLocalStorage - * @name DSLocalStorage - * @description - * Default adapter used by angular-data. This adapter uses AJAX and JSON to send/retrieve data to/from a server. - * Developers may provide custom adapters that implement the adapter interface. - */ - return { - /** - * @doc method - * @id DSLocalStorage.methods:find - * @name find - * @description - * Retrieve a single entity from localStorage. - * - * Calls `localStorage.getItem(key)`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `namespace` - Namespace path for the resource. - * @param {string|number} id The primary key of the entity to retrieve. - * @returns {Promise} Promise. - */ - find: find, - - /** - * @doc method - * @id DSLocalStorage.methods:findAll - * @name findAll - * @description - * Not supported. - */ - findAll: function () { - throw new Error('Not supported!'); - }, - - /** - * @doc method - * @id DSLocalStorage.methods:findAll - * @name find - * @description - * Not supported. - */ - create: function () { - throw new Error('Not supported!'); - }, - - /** - * @doc method - * @id DSLocalStorage.methods:update - * @name update - * @description - * Update an entity in localStorage. - * - * Calls `localStorage.setItem(key, value)`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `namespace` - Namespace path for the resource. - * @param {string|number} id The primary key of the entity to update. - * @param {object} attrs The attributes with which to update the entity. - * @returns {Promise} Promise. - */ - update: update, - - /** - * @doc method - * @id DSLocalStorage.methods:updateAll - * @name updateAll - * @description - * Not supported. - */ - updateAll: function () { - throw new Error('Not supported!'); - }, - - /** - * @doc method - * @id DSLocalStorage.methods:destroy - * @name destroy - * @description - * Destroy an entity from localStorage. - * - * Calls `localStorage.removeItem(key)`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {string|number} id The primary key of the entity to destroy. - * @returns {Promise} Promise. - */ - destroy: destroy, - - /** - * @doc method - * @id DSLocalStorage.methods:destroyAll - * @name destroyAll - * @description - * Not supported. - */ - destroyAll: function () { - throw new Error('Not supported!'); - } - }; + /** + * @doc interface + * @id DSLocalStorage + * @name DSLocalStorage + * @description + * Default adapter used by angular-data. This adapter uses AJAX and JSON to send/retrieve data to/from a server. + * Developers may provide custom adapters that implement the adapter interface. + */ + return { + /** + * @doc method + * @id DSLocalStorage.methods:find + * @name find + * @description + * Retrieve a single entity from localStorage. + * + * Calls `localStorage.getItem(key)`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `namespace` - Namespace path for the resource. + * @param {string|number} id The primary key of the entity to retrieve. + * @returns {Promise} Promise. + */ + find: find, + + /** + * @doc method + * @id DSLocalStorage.methods:findAll + * @name findAll + * @description + * Not supported. + */ + findAll: function () { + throw new Error('Not supported!'); + }, + + /** + * @doc method + * @id DSLocalStorage.methods:findAll + * @name find + * @description + * Not supported. + */ + create: function () { + throw new Error('Not supported!'); + }, + + /** + * @doc method + * @id DSLocalStorage.methods:update + * @name update + * @description + * Update an entity in localStorage. + * + * Calls `localStorage.setItem(key, value)`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `namespace` - Namespace path for the resource. + * @param {string|number} id The primary key of the entity to update. + * @param {object} attrs The attributes with which to update the entity. + * @returns {Promise} Promise. + */ + update: update, + + /** + * @doc method + * @id DSLocalStorage.methods:updateAll + * @name updateAll + * @description + * Not supported. + */ + updateAll: function () { + throw new Error('Not supported!'); + }, + + /** + * @doc method + * @id DSLocalStorage.methods:destroy + * @name destroy + * @description + * Destroy an entity from localStorage. + * + * Calls `localStorage.removeItem(key)`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {string|number} id The primary key of the entity to destroy. + * @returns {Promise} Promise. + */ + destroy: destroy, + + /** + * @doc method + * @id DSLocalStorage.methods:destroyAll + * @name destroyAll + * @description + * Not supported. + */ + destroyAll: function () { + throw new Error('Not supported!'); + } + }; - function GET(key) { - var deferred = $q.defer(); - try { - var item = localStorage.getItem(key); - deferred.resolve(item ? angular.fromJson(item) : undefined); - } catch (err) { - deferred.reject(err); - } - return deferred.promise; - } + function GET(key) { + var deferred = $q.defer(); + try { + var item = localStorage.getItem(key); + deferred.resolve(item ? angular.fromJson(item) : undefined); + } catch (err) { + deferred.reject(err); + } + return deferred.promise; + } - function PUT(key, value) { - var deferred = $q.defer(); - try { - var item = localStorage.getItem(key); - if (item) { - item = angular.fromJson(item); - DSUtils.deepMixIn(item, value); - deferred.resolve(localStorage.setItem(key, angular.toJson(item))); - } else { - deferred.resolve(localStorage.setItem(key, angular.toJson(value))); - } - } catch (err) { - deferred.reject(err); - } - return deferred.promise; - } + function PUT(key, value) { + var deferred = $q.defer(); + try { + var item = localStorage.getItem(key); + if (item) { + item = angular.fromJson(item); + DSUtils.deepMixIn(item, value); + deferred.resolve(localStorage.setItem(key, angular.toJson(item))); + } else { + deferred.resolve(localStorage.setItem(key, angular.toJson(value))); + } + } catch (err) { + deferred.reject(err); + } + return deferred.promise; + } - function DEL(key) { - var deferred = $q.defer(); - try { - deferred.resolve(localStorage.removeItem(key)); - } catch (err) { - deferred.reject(err); - } - return deferred.promise; - } + function DEL(key) { + var deferred = $q.defer(); + try { + deferred.resolve(localStorage.removeItem(key)); + } catch (err) { + deferred.reject(err); + } + return deferred.promise; + } - function destroy(resourceConfig, id, options) { - options = options || {}; - return DEL( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), - options - ); - } + function destroy(resourceConfig, id, options) { + options = options || {}; + return DEL( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), + options + ); + } - function find(resourceConfig, id, options) { - options = options || {}; - return GET( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), - options - ); - } + function find(resourceConfig, id, options) { + options = options || {}; + return GET( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), + options + ); + } - function update(resourceConfig, id, attrs, options) { - options = options || {}; - return PUT( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), - attrs, - options - ).then(function () { - return GET(DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id)); - }); - } - }]; + function update(resourceConfig, id, attrs, options) { + options = options || {}; + return PUT( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), + attrs, + options + ).then(function () { + return GET(DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id)); + }); + } + }]; } module.exports = DSLocalStorageProvider; @@ -1860,59 +1854,57 @@ var errorPrefix = 'DS.create(resourceName, attrs[, options]): '; * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function create(resourceName, attrs, options) { - var deferred = this.$q.defer(), - promise = deferred.promise; - - options = options || {}; - - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isObject(attrs)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'attrs: Must be an object!', { attrs: { actual: typeof attrs, expected: 'object' } })); - } else { - try { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; - - promise = promise - .then(function (attrs) { - return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.validate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.beforeCreate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.adapters[options.adapter || definition.defaultAdapter].create(definition, definition.serialize(resourceName, attrs), options); - }) - .then(function (res) { - return _this.$q.promisify(definition.afterCreate)(resourceName, definition.deserialize(resourceName, res)); - }) - .then(function (data) { - var created = _this.inject(definition.name, data); - var id = created[definition.idAttribute]; - resource.previousAttributes[id] = _this.utils.deepMixIn({}, created); - resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); - return _this.get(definition.name, id); - }); - - deferred.resolve(attrs); - } catch (err) { - deferred.reject(new this.errors.UnhandledError(err)); - } - } + var deferred = this.$q.defer(); + var promise = deferred.promise; - return promise; + try { + options = options || {}; + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(attrs)) { + throw new this.errors.IA(errorPrefix + 'attrs: Must be an object!'); + } + var definition = this.definitions[resourceName]; + var resource = this.store[resourceName]; + var _this = this; + + promise = promise + .then(function (attrs) { + return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.validate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.beforeCreate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.adapters[options.adapter || definition.defaultAdapter].create(definition, definition.serialize(resourceName, attrs), options); + }) + .then(function (res) { + return _this.$q.promisify(definition.afterCreate)(resourceName, definition.deserialize(resourceName, res)); + }) + .then(function (data) { + var created = _this.inject(definition.name, data); + var id = created[definition.idAttribute]; + resource.previousAttributes[id] = _this.utils.deepMixIn({}, created); + resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); + return _this.get(definition.name, id); + }); + + deferred.resolve(attrs); + } catch (err) { + deferred.reject(err); + } + + return promise; } module.exports = create; @@ -1960,46 +1952,49 @@ var errorPrefix = 'DS.destroy(resourceName, id): '; * * - `{IllegalArgumentError}` * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function destroy(resourceName, id, options) { - var deferred = this.$q.defer(), - promise = deferred.promise; - - options = options || {}; - - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } })); - } else { - var item = this.get(resourceName, id); - if (!item) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + 'id: "' + id + '" not found!')); - } else { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; - - promise = promise - .then(function (attrs) { - return _this.$q.promisify(definition.beforeDestroy)(resourceName, attrs); - }) - .then(function () { - return _this.adapters[options.adapter || definition.defaultAdapter].destroy(definition, id, options); - }) - .then(function () { - return _this.$q.promisify(definition.afterDestroy)(resourceName, item); - }) - .then(function () { - _this.eject(resourceName, id); - return id; - }); - deferred.resolve(item); - } - } + var deferred = this.$q.defer(); + var promise = deferred.promise; + + try { + options = options || {}; + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } - return promise; + var item = this.get(resourceName, id); + if (!item) { + throw new this.errors.R(errorPrefix + 'id: "' + id + '" not found!'); + } + + var definition = this.definitions[resourceName]; + var _this = this; + + promise = promise + .then(function (attrs) { + return _this.$q.promisify(definition.beforeDestroy)(resourceName, attrs); + }) + .then(function () { + return _this.adapters[options.adapter || definition.defaultAdapter].destroy(definition, id, options); + }) + .then(function () { + return _this.$q.promisify(definition.afterDestroy)(resourceName, item); + }) + .then(function () { + _this.eject(resourceName, id); + return id; + }); + deferred.resolve(item); + } catch (err) { + deferred.reject(err); + } + + return promise; } module.exports = destroy; @@ -2023,7 +2018,7 @@ var errorPrefix = 'DS.destroyAll(resourceName, params[, options]): '; * ## Example: * * ```js - * var query = { + * var params = { * where: { * author: { * '==': 'John Anderson' @@ -2031,13 +2026,9 @@ var errorPrefix = 'DS.destroyAll(resourceName, params[, options]): '; * } * }; * - * DS.destroyAll('document', { - * query: query - * }).then(function (documents) { + * DS.destroyAll('document', params).then(function (documents) { * // The documents are gone from the data store - * DS.filter('document', { - * query: query - * }); // [] + * DS.filter('document', params); // [] * * }, function (err) { * // handle error @@ -2047,11 +2038,11 @@ var errorPrefix = 'DS.destroyAll(resourceName, params[, options]): '; * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {object} params Parameter object that is serialized into the query string. Properties: * - * - `{object=}` - `query` - The query object by which to filter items of the type specified by `resourceName`. Properties: - * - `{object=}` - `where` - Where clause. - * - `{number=}` - `limit` - Limit clause. - * - `{skip=}` - `skip` - Skip clause. - * - `{orderBy=}` - `orderBy` - OrderBy clause. + * - `{object=}` - `where` - Where clause. + * - `{number=}` - `limit` - Limit clause. + * - `{number=}` - `skip` - Skip clause. + * - `{number=}` - `offset` - Same as skip. + * - `{string|array=}` - `orderBy` - OrderBy clause. * * @param {object=} options Optional configuration. Properties: * - `{boolean=}` - `bypassCache` - Bypass the cache. Default: `false`. @@ -2061,40 +2052,41 @@ var errorPrefix = 'DS.destroyAll(resourceName, params[, options]): '; * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function destroyAll(resourceName, params, options) { - var deferred = this.$q.defer(), - promise = deferred.promise, - _this = this; - - options = options || {}; - - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isObject(params)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'params: Must be an object!')); - } else if (!this.utils.isObject(options)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!')); - } else { - try { - var definition = this.definitions[resourceName]; - - promise = promise - .then(function () { - return _this.adapters[options.adapter || definition.defaultAdapter].destroyAll(definition, params, options); - }) - .then(function () { - return _this.ejectAll(resourceName, params); - }); - deferred.resolve(); - } catch (err) { - deferred.reject(new this.errors.UnhandledError(err)); - } - } + var deferred = this.$q.defer(); + var promise = deferred.promise; + + try { + var _this = this; + var IA = this.errors.IA; - return promise; + options = options || {}; + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(params)) { + throw new IA(errorPrefix + 'params: Must be an object!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } + + var definition = this.definitions[resourceName]; + + promise = promise + .then(function () { + return _this.adapters[options.adapter || definition.defaultAdapter].destroyAll(definition, params, options); + }) + .then(function () { + return _this.ejectAll(resourceName, params); + }); + deferred.resolve(); + } catch (err) { + deferred.reject(err); + } + + return promise; } module.exports = destroyAll; @@ -2143,65 +2135,67 @@ var errorPrefix = 'DS.find(resourceName, id[, options]): '; * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function find(resourceName, id, options) { - var deferred = this.$q.defer(), - promise = deferred.promise; - - options = options || {}; - - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } })); - } else if (!this.utils.isObject(options)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!', { options: { actual: typeof options, expected: 'object' } })); - } else { - if (!('cacheResponse' in options)) { - options.cacheResponse = true; - } else { - options.cacheResponse = !!options.cacheResponse; - } - try { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; + var deferred = this.$q.defer(); + var promise = deferred.promise; - if (options.bypassCache) { - delete resource.completedQueries[id]; - } + try { + var IA = this.errors.IA; - if (!(id in resource.completedQueries)) { - if (!(id in resource.pendingQueries)) { - promise = resource.pendingQueries[id] = _this.adapters[options.adapter || definition.defaultAdapter].find(definition, id, options) - .then(function (res) { - var data = definition.deserialize(resourceName, res); - if (options.cacheResponse) { - // Query is no longer pending - delete resource.pendingQueries[id]; - resource.completedQueries[id] = new Date().getTime(); - return _this.inject(resourceName, data); - } else { - return data; - } - }, function (err) { - delete resource.pendingQueries[id]; - return _this.$q.reject(err); - }); - } + options = options || {}; - return resource.pendingQueries[id]; - } else { - deferred.resolve(_this.get(resourceName, id)); - } - } catch (err) { - deferred.reject(err); - } - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new IA(errorPrefix + 'id: Must be a string or a number!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } + + if (!('cacheResponse' in options)) { + options.cacheResponse = true; + } else { + options.cacheResponse = !!options.cacheResponse; + } + + var definition = this.definitions[resourceName]; + var resource = this.store[resourceName]; + var _this = this; + + if (options.bypassCache) { + delete resource.completedQueries[id]; + } + + if (!(id in resource.completedQueries)) { + if (!(id in resource.pendingQueries)) { + promise = resource.pendingQueries[id] = _this.adapters[options.adapter || definition.defaultAdapter].find(definition, id, options) + .then(function (res) { + var data = definition.deserialize(resourceName, res); + if (options.cacheResponse) { + // Query is no longer pending + delete resource.pendingQueries[id]; + resource.completedQueries[id] = new Date().getTime(); + return _this.inject(resourceName, data); + } else { + return data; + } + }, function (err) { + delete resource.pendingQueries[id]; + return _this.$q.reject(err); + }); + } + + return resource.pendingQueries[id]; + } else { + deferred.resolve(_this.get(resourceName, id)); + } + } catch (err) { + deferred.reject(err); + } - return promise; + return promise; } module.exports = find; @@ -2210,59 +2204,59 @@ module.exports = find; var errorPrefix = 'DS.findAll(resourceName, params[, options]): '; function processResults(utils, data, resourceName, queryHash) { - var resource = this.store[resourceName]; + var resource = this.store[resourceName]; - data = data || []; + data = data || []; - // Query is no longer pending - delete resource.pendingQueries[queryHash]; - resource.completedQueries[queryHash] = new Date().getTime(); + // Query is no longer pending + delete resource.pendingQueries[queryHash]; + resource.completedQueries[queryHash] = new Date().getTime(); - // Update modified timestamp of collection - resource.collectionModified = utils.updateTimestamp(resource.collectionModified); + // Update modified timestamp of collection + resource.collectionModified = utils.updateTimestamp(resource.collectionModified); - // Merge the new values into the cache - return this.inject(resourceName, data); + // Merge the new values into the cache + return this.inject(resourceName, data); } function _findAll(utils, resourceName, params, options) { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this, - queryHash = utils.toJson(params); - - if (options.bypassCache) { - delete resource.completedQueries[queryHash]; - } - - if (!(queryHash in resource.completedQueries)) { - // This particular query has never been completed - - if (!(queryHash in resource.pendingQueries)) { - - // This particular query has never even been made - resource.pendingQueries[queryHash] = _this.adapters[options.adapter || definition.defaultAdapter].findAll(definition, params, options) - .then(function (res) { - var data = definition.deserialize(resourceName, res); - if (options.cacheResponse) { - try { - return processResults.apply(_this, [utils, data, resourceName, queryHash]); - } catch (err) { - return _this.$q.reject(_this.errors.UnhandledError(err)); - } - } else { - return data; - } - }, function (err) { - delete resource.pendingQueries[queryHash]; - return _this.$q.reject(err); - }); - } + var definition = this.definitions[resourceName], + resource = this.store[resourceName], + _this = this, + queryHash = utils.toJson(params); + + if (options.bypassCache) { + delete resource.completedQueries[queryHash]; + } + + if (!(queryHash in resource.completedQueries)) { + // This particular query has never been completed + + if (!(queryHash in resource.pendingQueries)) { + + // This particular query has never even been made + resource.pendingQueries[queryHash] = _this.adapters[options.adapter || definition.defaultAdapter].findAll(definition, params, options) + .then(function (res) { + var data = definition.deserialize(resourceName, res); + if (options.cacheResponse) { + try { + return processResults.apply(_this, [utils, data, resourceName, queryHash]); + } catch (err) { + return _this.$q.reject(err); + } + } else { + return data; + } + }, function (err) { + delete resource.pendingQueries[queryHash]; + return _this.$q.reject(err); + }); + } - return resource.pendingQueries[queryHash]; - } else { - return this.filter(resourceName, params, options); - } + return resource.pendingQueries[queryHash]; + } else { + return this.filter(resourceName, params, options); + } } /** @@ -2281,7 +2275,7 @@ function _findAll(utils, resourceName, params, options) { * ## Example: * * ```js - * var query = { + * var params = { * where: { * author: { * '==': 'John Anderson' @@ -2289,17 +2283,13 @@ function _findAll(utils, resourceName, params, options) { * } * }; * - * DS.findAll('document', { - * query: query - * }).then(function (documents) { - * documents; // [{ id: 'aab7ff66-e21e-46e2-8be8-264d82aee535', author: 'John Anderson', title: 'How to cook' }, - * // { id: 'ee7f3f4d-98d5-4934-9e5a-6a559b08479f', author: 'John Anderson', title: 'How NOT to cook' }] + * DS.findAll('document', params).then(function (documents) { + * documents; // [{ id: '1', author: 'John Anderson', title: 'How to cook' }, + * // { id: '2', author: 'John Anderson', title: 'How NOT to cook' }] * * // The documents are now in the data store - * DS.filter('document', { - * query: query - * }); // [{ id: 'aab7ff66-e21e-46e2-8be8-264d82aee535', author: 'John Anderson', title: 'How to cook' }, - * // { id: 'ee7f3f4d-98d5-4934-9e5a-6a559b08479f', author: 'John Anderson', title: 'How NOT to cook' }] + * DS.filter('document', params); // [{ id: '1', author: 'John Anderson', title: 'How to cook' }, + * // { id: '2', author: 'John Anderson', title: 'How NOT to cook' }] * * }, function (err) { * // handle error @@ -2309,11 +2299,11 @@ function _findAll(utils, resourceName, params, options) { * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {object=} params Parameter object that is serialized into the query string. Properties: * - * - `{object=}` - `query` - The query object by which to filter items of the type specified by `resourceName`. Properties: - * - `{object=}` - `where` - Where clause. - * - `{number=}` - `limit` - Limit clause. - * - `{skip=}` - `skip` - Skip clause. - * - `{orderBy=}` - `orderBy` - OrderBy clause. + * - `{object=}` - `where` - Where clause. + * - `{number=}` - `limit` - Limit clause. + * - `{number=}` - `skip` - Skip clause. + * - `{number=}` - `offset` - Same as skip. + * - `{string|array=}` - `orderBy` - OrderBy clause. * * @param {object=} options Optional configuration. Properties: * - `{boolean=}` - `bypassCache` - Bypass the cache. Default: `false`. @@ -2328,138 +2318,286 @@ function _findAll(utils, resourceName, params, options) { * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function findAll(resourceName, params, options) { - var deferred = this.$q.defer(), - promise = deferred.promise, - _this = this; - - options = options || {}; - params = params || {}; - - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isObject(params)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'params: Must be an object!')); - } else if (!this.utils.isObject(options)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!')); - } else { - if (!('cacheResponse' in options)) { - options.cacheResponse = true; - } else { - options.cacheResponse = !!options.cacheResponse; - } - try { - promise = promise.then(function () { - return _findAll.apply(_this, [_this.utils, resourceName, params, options]); - }); - deferred.resolve(); - } catch (err) { - deferred.reject(new this.errors.UnhandledError(err)); - } - } + var deferred = this.$q.defer(); + var promise = deferred.promise; + + try { + var IA = this.errors.IA; + var _this = this; + + options = options || {}; + params = params || {}; + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(params)) { + throw new IA(errorPrefix + 'params: Must be an object!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } + + if (!('cacheResponse' in options)) { + options.cacheResponse = true; + } else { + options.cacheResponse = !!options.cacheResponse; + } + + promise = promise.then(function () { + return _findAll.apply(_this, [_this.utils, resourceName, params, options]); + }); + deferred.resolve(); + } catch (err) { + deferred.reject(err); + } - return promise; + return promise; } module.exports = findAll; },{}],37:[function(require,module,exports){ module.exports = { - /** - * @doc method - * @id DS.async_methods:create - * @name create - * @methodOf DS - * @description - * See [DS.create](/documentation/api/api/DS.async_methods:create). - */ - create: require('./create'), - - /** - * @doc method - * @id DS.async_methods:destroy - * @name destroy - * @methodOf DS - * @description - * See [DS.destroy](/documentation/api/api/DS.async_methods:destroy). - */ - destroy: require('./destroy'), - - /** - * @doc method - * @id DS.async_methods:destroyAll - * @name destroyAll - * @methodOf DS - * @description - * See [DS.destroyAll](/documentation/api/api/DS.async_methods:destroyAll). - */ - destroyAll: require('./destroyAll'), - - /** - * @doc method - * @id DS.async_methods:find - * @name find - * @methodOf DS - * @description - * See [DS.find](/documentation/api/api/DS.async_methods:find). - */ - find: require('./find'), - - /** - * @doc method - * @id DS.async_methods:findAll - * @name findAll - * @methodOf DS - * @description - * See [DS.findAll](/documentation/api/api/DS.async_methods:findAll). - */ - findAll: require('./findAll'), - - /** - * @doc method - * @id DS.async_methods:refresh - * @name refresh - * @methodOf DS - * @description - * See [DS.refresh](/documentation/api/api/DS.async_methods:refresh). - */ - refresh: require('./refresh'), - - /** - * @doc method - * @id DS.async_methods:save - * @name save - * @methodOf DS - * @description - * See [DS.save](/documentation/api/api/DS.async_methods:save). - */ - save: require('./save'), - - /** - * @doc method - * @id DS.async_methods:update - * @name update - * @methodOf DS - * @description - * See [DS.update](/documentation/api/api/DS.async_methods:update). - */ - update: require('./update'), - - /** - * @doc method - * @id DS.async_methods:updateAll - * @name updateAll - * @methodOf DS - * @description - * See [DS.updateAll](/documentation/api/api/DS.async_methods:updateAll). - */ - updateAll: require('./updateAll') + /** + * @doc method + * @id DS.async_methods:create + * @name create + * @methodOf DS + * @description + * See [DS.create](/documentation/api/api/DS.async_methods:create). + */ + create: require('./create'), + + /** + * @doc method + * @id DS.async_methods:destroy + * @name destroy + * @methodOf DS + * @description + * See [DS.destroy](/documentation/api/api/DS.async_methods:destroy). + */ + destroy: require('./destroy'), + + /** + * @doc method + * @id DS.async_methods:destroyAll + * @name destroyAll + * @methodOf DS + * @description + * See [DS.destroyAll](/documentation/api/api/DS.async_methods:destroyAll). + */ + destroyAll: require('./destroyAll'), + + /** + * @doc method + * @id DS.async_methods:find + * @name find + * @methodOf DS + * @description + * See [DS.find](/documentation/api/api/DS.async_methods:find). + */ + find: require('./find'), + + /** + * @doc method + * @id DS.async_methods:findAll + * @name findAll + * @methodOf DS + * @description + * See [DS.findAll](/documentation/api/api/DS.async_methods:findAll). + */ + findAll: require('./findAll'), + + /** + * @doc method + * @id DS.async_methods:loadRelations + * @name loadRelations + * @methodOf DS + * @description + * See [DS.loadRelations](/documentation/api/api/DS.async_methods:loadRelations). + */ + loadRelations: require('./loadRelations'), + + /** + * @doc method + * @id DS.async_methods:refresh + * @name refresh + * @methodOf DS + * @description + * See [DS.refresh](/documentation/api/api/DS.async_methods:refresh). + */ + refresh: require('./refresh'), + + /** + * @doc method + * @id DS.async_methods:save + * @name save + * @methodOf DS + * @description + * See [DS.save](/documentation/api/api/DS.async_methods:save). + */ + save: require('./save'), + + /** + * @doc method + * @id DS.async_methods:update + * @name update + * @methodOf DS + * @description + * See [DS.update](/documentation/api/api/DS.async_methods:update). + */ + update: require('./update'), + + /** + * @doc method + * @id DS.async_methods:updateAll + * @name updateAll + * @methodOf DS + * @description + * See [DS.updateAll](/documentation/api/api/DS.async_methods:updateAll). + */ + updateAll: require('./updateAll') }; -},{"./create":32,"./destroy":33,"./destroyAll":34,"./find":35,"./findAll":36,"./refresh":38,"./save":39,"./update":40,"./updateAll":41}],38:[function(require,module,exports){ +},{"./create":32,"./destroy":33,"./destroyAll":34,"./find":35,"./findAll":36,"./loadRelations":38,"./refresh":39,"./save":40,"./update":41,"./updateAll":42}],38:[function(require,module,exports){ +var errorPrefix = 'DS.loadRelations(resourceName, instance(Id), relations[, options]): '; + +/** + * @doc method + * @id DS.async_methods:loadRelations + * @name loadRelations + * @description + * Asynchronously load the indicated relations of the given instance. + * + * ## Signature: + * ```js + * DS.loadRelations(resourceName, instance(Id), relations[, options]) + * ``` + * + * ## Examples: + * + * ```js + * DS.loadRelations('user', 10, ['profile']).then(function (user) { + * user.profile; // object + * assert.deepEqual(user.profile, DS.filter('profile', { userId: 10 })[0]); + * }); + * ``` + * + * ```js + * var user = DS.get('user', 10); + * + * DS.loadRelations('user', user, ['profile']).then(function (user) { + * user.profile; // object + * assert.deepEqual(user.profile, DS.filter('profile', { userId: 10 })[0]); + * }); + * ``` + * + * ```js + * DS.loadRelations('user', 10, ['profile'], { cacheResponse: false }).then(function (user) { + * user.profile; // object + * assert.equal(DS.filter('profile', { userId: 10 }).length, 0); + * }); + * ``` + * + * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. + * @param {string|number|object} instance The instance or the id of the instance for which relations are to be loaded. + * @param {string|array=} relations The relation(s) to load. + * @param {object=} options Optional configuration that is passed to the `find` and `findAll` methods that may be called. + * + * @returns {Promise} Promise produced by the `$q` service. + * + * ## Resolves with: + * + * - `{object}` - `item` - The instance with its loaded relations. + * + * ## Rejects with: + * + * - `{IllegalArgumentError}` + * - `{NonexistentResourceError}` + */ +function loadRelations(resourceName, instance, relations, options) { + var deferred = this.$q.defer(); + var promise = deferred.promise; + + try { + var IA = this.errors.IA; + + options = options || {}; + + if (angular.isString(instance) || angular.isNumber(instance)) { + instance = this.get(resourceName, instance); + } + + if (angular.isString(relations)) { + relations = [relations]; + } + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(instance)) { + throw new IA(errorPrefix + 'instance(Id): Must be a string, number or object!'); + } else if (!this.utils.isArray(relations)) { + throw new IA(errorPrefix + 'relations: Must be a string or an array!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } + + var definition = this.definitions[resourceName]; + var _this = this; + var tasks = []; + var fields = []; + + _this.utils.forOwn(definition.relations, function (relation, type) { + _this.utils.forOwn(relation, function (def, relationName) { + if (_this.utils.contains(relations, relationName)) { + var task; + var params = {}; + params[def.foreignKey] = instance[definition.idAttribute]; + + if (type === 'hasMany') { + task = _this.findAll(relationName, params, options); + } else if (type === 'hasOne') { + if (def.localKey && instance[def.localKey]) { + task = _this.find(relationName, instance[def.localKey], options); + } else if (def.foreignKey) { + task = _this.findAll(relationName, params, options); + } + } else { + task = _this.find(relationName, instance[def.localKey], options); + } + + if (task) { + tasks.push(task); + fields.push(def.localField); + } + } + }); + }); + + promise = promise + .then(function () { + return _this.$q.all(tasks); + }) + .then(function (loadedRelations) { + angular.forEach(fields, function (field, index) { + instance[field] = loadedRelations[index]; + }); + return instance; + }); + + deferred.resolve(); + } catch (err) { + deferred.reject(err); + } + + return promise; +} + +module.exports = loadRelations; + +},{}],39:[function(require,module,exports){ var errorPrefix = 'DS.refresh(resourceName, id[, options]): '; /** @@ -2493,7 +2631,7 @@ var errorPrefix = 'DS.refresh(resourceName, id[, options]): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item to refresh from the server. @@ -2508,32 +2646,33 @@ var errorPrefix = 'DS.refresh(resourceName, id[, options]): '; * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function refresh(resourceName, id, options) { - options = options || {}; - - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } else if (!this.utils.isObject(options)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!', { options: { actual: typeof options, expected: 'object' } }); - } else { - options.bypassCache = true; - - if (this.get(resourceName, id)) { - return this.find(resourceName, id, options); - } else { - return false; - } - } + var IA = this.errors.IA; + + options = options || {}; + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new IA(errorPrefix + 'id: Must be a string or a number!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } else { + options.bypassCache = true; + + if (this.get(resourceName, id)) { + return this.find(resourceName, id, options); + } else { + return false; + } + } } module.exports = refresh; -},{}],39:[function(require,module,exports){ +},{}],40:[function(require,module,exports){ var errorPrefix = 'DS.save(resourceName, id[, options]): '; /** @@ -2576,83 +2715,90 @@ var errorPrefix = 'DS.save(resourceName, id[, options]): '; * * - `{IllegalArgumentError}` * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function save(resourceName, id, options) { - var deferred = this.$q.defer(), - promise = deferred.promise; - - options = options || {}; - - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } })); - } else if (!this.utils.isObject(options)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!', { options: { actual: typeof options, expected: 'object' } })); - } else { - var item = this.get(resourceName, id); - if (!item) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + 'id: "' + id + '" not found!')); - } else { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; - - promise = promise - .then(function (attrs) { - return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.validate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.beforeUpdate)(resourceName, attrs); - }) - .then(function (attrs) { - if (options.changesOnly) { - resource.observers[id].deliver(); - var toKeep = [], - changes = _this.changes(resourceName, id); - - for (var key in changes.added) { - toKeep.push(key); - } - for (key in changes.changed) { - toKeep.push(key); - } - changes = _this.utils.pick(attrs, toKeep); - if (_this.utils.isEmpty(changes)) { - // no changes, return - return attrs; - } else { - attrs = changes; - } - } - return _this.adapters[options.adapter || definition.defaultAdapter].update(definition, id, definition.serialize(resourceName, attrs), options); - }) - .then(function (res) { - return _this.$q.promisify(definition.afterUpdate)(resourceName, definition.deserialize(resourceName, res)); - }) - .then(function (data) { - _this.inject(definition.name, data, options); - resource.previousAttributes[id] = _this.utils.deepMixIn({}, data); - resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); - return _this.get(resourceName, id); - }); - - deferred.resolve(item); - } - } - return promise; + var deferred = this.$q.defer(); + var promise = deferred.promise; + + try { + var IA = this.errors.IA; + + options = options || {}; + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new IA(errorPrefix + 'id: Must be a string or a number!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } + + var item = this.get(resourceName, id); + if (!item) { + throw new this.errors.R(errorPrefix + 'id: "' + id + '" not found!'); + } + + var definition = this.definitions[resourceName]; + var resource = this.store[resourceName]; + var _this = this; + + promise = promise + .then(function (attrs) { + return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.validate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.beforeUpdate)(resourceName, attrs); + }) + .then(function (attrs) { + if (options.changesOnly) { + resource.observers[id].deliver(); + var toKeep = [], + changes = _this.changes(resourceName, id); + + for (var key in changes.added) { + toKeep.push(key); + } + for (key in changes.changed) { + toKeep.push(key); + } + changes = _this.utils.pick(attrs, toKeep); + if (_this.utils.isEmpty(changes)) { + // no changes, return + return attrs; + } else { + attrs = changes; + } + } + return _this.adapters[options.adapter || definition.defaultAdapter].update(definition, id, definition.serialize(resourceName, attrs), options); + }) + .then(function (res) { + return _this.$q.promisify(definition.afterUpdate)(resourceName, definition.deserialize(resourceName, res)); + }) + .then(function (data) { + _this.inject(definition.name, data, options); + resource.previousAttributes[id] = _this.utils.deepMixIn({}, data); + resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); + return _this.get(resourceName, id); + }); + + deferred.resolve(item); + } catch (err) { + deferred.reject(err); + } + + return promise; } module.exports = save; -},{}],40:[function(require,module,exports){ +},{}],41:[function(require,module,exports){ var errorPrefix = 'DS.update(resourceName, id, attrs[, options]): '; /** @@ -2697,73 +2843,79 @@ var errorPrefix = 'DS.update(resourceName, id, attrs[, options]): '; * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function update(resourceName, id, attrs, options) { - var deferred = this.$q.defer(), - promise = deferred.promise; - - options = options || {}; - - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!')); - } else if (!this.utils.isObject(attrs)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'attrs: Must be an object!')); - } else if (!this.utils.isObject(options)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!')); - } else { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; - - if (!('cacheResponse' in options)) { - options.cacheResponse = true; - } else { - options.cacheResponse = !!options.cacheResponse; - } + var deferred = this.$q.defer(); + var promise = deferred.promise; + + try { + var IA = this.errors.IA; + + options = options || {}; + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new IA(errorPrefix + 'id: Must be a string or a number!'); + } else if (!this.utils.isObject(attrs)) { + throw new IA(errorPrefix + 'attrs: Must be an object!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } - promise = promise - .then(function (attrs) { - return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.validate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.beforeUpdate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.adapters[options.adapter || definition.defaultAdapter].update(definition, id, definition.serialize(resourceName, attrs), options); - }) - .then(function (res) { - return _this.$q.promisify(definition.afterUpdate)(resourceName, definition.deserialize(resourceName, res)); - }) - .then(function (data) { - if (options.cacheResponse) { - var updated = _this.inject(definition.name, data, options); - var id = updated[definition.idAttribute]; - resource.previousAttributes[id] = _this.utils.deepMixIn({}, updated); - resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); - return _this.get(definition.name, id); - } else { - return data; - } - }); + var definition = this.definitions[resourceName]; + var resource = this.store[resourceName]; + var _this = this; - deferred.resolve(attrs); - } - return promise; + if (!('cacheResponse' in options)) { + options.cacheResponse = true; + } else { + options.cacheResponse = !!options.cacheResponse; + } + + promise = promise + .then(function (attrs) { + return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.validate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.beforeUpdate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.adapters[options.adapter || definition.defaultAdapter].update(definition, id, definition.serialize(resourceName, attrs), options); + }) + .then(function (res) { + return _this.$q.promisify(definition.afterUpdate)(resourceName, definition.deserialize(resourceName, res)); + }) + .then(function (data) { + if (options.cacheResponse) { + var updated = _this.inject(definition.name, data, options); + var id = updated[definition.idAttribute]; + resource.previousAttributes[id] = _this.utils.deepMixIn({}, updated); + resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); + return _this.get(definition.name, id); + } else { + return data; + } + }); + + deferred.resolve(attrs); + } catch (err) { + deferred.reject(err); + } + + return promise; } module.exports = update; -},{}],41:[function(require,module,exports){ +},{}],42:[function(require,module,exports){ var errorPrefix = 'DS.updateAll(resourceName, attrs, params[, options]): '; /** @@ -2786,11 +2938,9 @@ var errorPrefix = 'DS.updateAll(resourceName, attrs, params[, options]): '; * DS.filter('document'); // [] * * DS.updateAll('document', 5, { author: 'Sally' }, { - * query: { - * where: { - * author: { - * '==': 'John Anderson' - * } + * where: { + * author: { + * '==': 'John Anderson' * } * } * }) @@ -2806,11 +2956,11 @@ var errorPrefix = 'DS.updateAll(resourceName, attrs, params[, options]): '; * @param {object} attrs The attributes with which to update the items. * @param {object} params Parameter object that is serialized into the query string. Properties: * - * - `{object=}` - `query` - The query object by which to filter items of the type specified by `resourceName`. Properties: - * - `{object=}` - `where` - Where clause. - * - `{number=}` - `limit` - Limit clause. - * - `{skip=}` - `skip` - Skip clause. - * - `{orderBy=}` - `orderBy` - OrderBy clause. + * - `{object=}` - `where` - Where clause. + * - `{number=}` - `limit` - Limit clause. + * - `{number=}` - `skip` - Skip clause. + * - `{number=}` - `offset` - Same as skip. + * - `{string|array=}` - `orderBy` - OrderBy clause. * * @param {object=} options Optional configuration. Properties: * - `{boolean=}` - `cacheResponse` - Inject the data returned by the server into the data store. Default: `true`. @@ -2824,114 +2974,264 @@ var errorPrefix = 'DS.updateAll(resourceName, attrs, params[, options]): '; * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function updateAll(resourceName, attrs, params, options) { - var deferred = this.$q.defer(), - promise = deferred.promise; - - options = options || {}; - - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isObject(attrs)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'attrs: Must be an object!')); - } else if (!this.utils.isObject(params)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'params: Must be an object!')); - } else if (!this.utils.isObject(options)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!')); - } else { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; - - if (!('cacheResponse' in options)) { - options.cacheResponse = true; - } else { - options.cacheResponse = !!options.cacheResponse; - } + var deferred = this.$q.defer(); + var promise = deferred.promise; + + try { + var IA = this.errors.IA; + + options = options || {}; + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(attrs)) { + throw new IA(errorPrefix + 'attrs: Must be an object!'); + } else if (!this.utils.isObject(params)) { + throw new IA(errorPrefix + 'params: Must be an object!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } - promise = promise - .then(function (attrs) { - return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.validate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.beforeUpdate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.adapters[options.adapter || definition.defaultAdapter].updateAll(definition, definition.serialize(resourceName, attrs), params, options); - }) - .then(function (res) { - return _this.$q.promisify(definition.afterUpdate)(resourceName, definition.deserialize(resourceName, res)); - }) - .then(function (data) { - if (options.cacheResponse) { - return _this.inject(definition.name, data, options); - } else { - return data; - } - }); + var definition = this.definitions[resourceName]; + var _this = this; - deferred.resolve(attrs); - } - return promise; + if (!('cacheResponse' in options)) { + options.cacheResponse = true; + } else { + options.cacheResponse = !!options.cacheResponse; + } + + promise = promise + .then(function (attrs) { + return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.validate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.beforeUpdate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.adapters[options.adapter || definition.defaultAdapter].updateAll(definition, definition.serialize(resourceName, attrs), params, options); + }) + .then(function (res) { + return _this.$q.promisify(definition.afterUpdate)(resourceName, definition.deserialize(resourceName, res)); + }) + .then(function (data) { + if (options.cacheResponse) { + return _this.inject(definition.name, data, options); + } else { + return data; + } + }); + + deferred.resolve(attrs); + } catch (err) { + deferred.reject(err); + } + + return promise; } module.exports = updateAll; -},{}],42:[function(require,module,exports){ +},{}],43:[function(require,module,exports){ var utils = require('../utils')[0](); function lifecycleNoop(resourceName, attrs, cb) { - cb(null, attrs); + cb(null, attrs); } -function BaseConfig() { +function Defaults() { } -BaseConfig.prototype.idAttribute = 'id'; -BaseConfig.prototype.defaultAdapter = 'DSHttpAdapter'; -BaseConfig.prototype.filter = function (resourceName, where, attrs) { - var keep = true; - utils.forOwn(where, function (clause, field) { - if (utils.isString(clause)) { - clause = { - '===': clause - }; - } else if (utils.isNumber(clause)) { - clause = { - '==': clause - }; - } - if ('==' in clause) { - keep = keep && (attrs[field] == clause['==']); - } else if ('===' in clause) { - keep = keep && (attrs[field] === clause['===']); - } else if ('!=' in clause) { - keep = keep && (attrs[field] != clause['!=']); - } else if ('>' in clause) { - keep = keep && (attrs[field] > clause['>']); - } else if ('>=' in clause) { - keep = keep && (attrs[field] >= clause['>=']); - } else if ('<' in clause) { - keep = keep && (attrs[field] < clause['<']); - } else if ('<=' in clause) { - keep = keep && (attrs[field] <= clause['<=']); - } else if ('in' in clause) { - keep = keep && utils.contains(clause['in'], attrs[field]); - } - }); - return keep; +Defaults.prototype.idAttribute = 'id'; +Defaults.prototype.defaultAdapter = 'DSHttpAdapter'; +Defaults.prototype.filter = function (collection, resourceName, params, options) { + var _this = this; + var filtered = collection; + var where = null; + var reserved = { + skip: '', + offset: '', + where: '', + limit: '', + orderBy: '', + sort: '' + }; + + if (this.utils.isObject(params.where)) { + where = params.where; + } else { + where = {}; + } + + if (options.allowSimpleWhere) { + this.utils.forOwn(params, function (value, key) { + if (!(key in reserved) && !(key in where)) { + where[key] = { + '==': value + }; + } + }); + } + + if (this.utils.isEmpty(where)) { + where = null; + } + + if (where) { + filtered = this.utils.filter(filtered, function (attrs) { +// console.log(attrs); + var first = true; + var keep = true; + _this.utils.forOwn(where, function (clause, field) { +// console.log(clause, field); + if (_this.utils.isString(clause)) { + clause = { + '===': clause + }; + } else if (_this.utils.isNumber(clause)) { + clause = { + '==': clause + }; + } + if (_this.utils.isObject(clause)) { + _this.utils.forOwn(clause, function (val, op) { +// console.log(op, val); + if (op === '==') { + keep = first ? (attrs[field] == val) : keep && (attrs[field] == val); + } else if (op === '===') { + keep = first ? (attrs[field] === val) : keep && (attrs[field] === val); + } else if (op === '!=') { + keep = first ? (attrs[field] != val) : keep && (attrs[field] != val); + } else if (op === '!==') { + keep = first ? (attrs[field] !== val) : keep && (attrs[field] !== val); + } else if (op === '>') { + keep = first ? (attrs[field] > val) : keep && (attrs[field] > val); + } else if (op === '>=') { + keep = first ? (attrs[field] >= val) : keep && (attrs[field] >= val); + } else if (op === '<') { + keep = first ? (attrs[field] < val) : keep && (attrs[field] < val); + } else if (op === '<=') { + keep = first ? (attrs[field] <= val) : keep && (attrs[field] <= val); + } else if (op === 'in') { + keep = first ? _this.utils.contains(val, attrs[field]) : keep && _this.utils.contains(val, attrs[field]); + } else if (op === '|==') { + keep = first ? (attrs[field] == val) : keep || (attrs[field] == val); + } else if (op === '|===') { + keep = first ? (attrs[field] === val) : keep || (attrs[field] === val); + } else if (op === '|!=') { + keep = first ? (attrs[field] != val) : keep || (attrs[field] != val); + } else if (op === '|!==') { + keep = first ? (attrs[field] !== val) : keep || (attrs[field] !== val); + } else if (op === '|>') { + keep = first ? (attrs[field] > val) : keep || (attrs[field] > val); + } else if (op === '|>=') { + keep = first ? (attrs[field] >= val) : keep || (attrs[field] >= val); + } else if (op === '|<') { + keep = first ? (attrs[field] < val) : keep || (attrs[field] < val); + } else if (op === '|<=') { + keep = first ? (attrs[field] <= val) : keep || (attrs[field] <= val); + } else if (op === '|in') { + keep = first ? _this.utils.contains(val, attrs[field]) : keep || _this.utils.contains(val, attrs[field]); + } + first = false; +// console.log(keep, first); + }); + } + }); + return keep; + }); + } + + var orderBy = null; + + if (this.utils.isString(params.orderBy)) { + orderBy = [ + [params.orderBy, 'ASC'] + ]; + } else if (this.utils.isArray(params.orderBy)) { + orderBy = params.orderBy; + } + + if (!orderBy && this.utils.isString(params.sort)) { + orderBy = [ + [params.sort, 'ASC'] + ]; + } else if (!orderBy && this.utils.isArray(params.sort)) { + orderBy = params.sort; + } + + // Apply 'orderBy' + if (orderBy) { + angular.forEach(orderBy, function (def) { + if (_this.utils.isString(def)) { + def = [def, 'ASC']; + } else if (!_this.utils.isArray(def)) { + throw new _this.errors.IllegalArgumentError('DS.filter(resourceName[, params][, options]): ' + angular.toJson(def) + ': Must be a string or an array!', { params: { 'orderBy[i]': { actual: typeof def, expected: 'string|array' } } }); + } + filtered = _this.utils.sort(filtered, function (a, b) { + var cA = a[def[0]], cB = b[def[0]]; + if (_this.utils.isString(cA)) { + cA = _this.utils.upperCase(cA); + } + if (_this.utils.isString(cB)) { + cB = _this.utils.upperCase(cB); + } + if (def[1] === 'DESC') { + if (cB < cA) { + return -1; + } else if (cB > cA) { + return 1; + } else { + return 0; + } + } else { + if (cA < cB) { + return -1; + } else if (cA > cB) { + return 1; + } else { + return 0; + } + } + }); + }); + } + + var limit = angular.isNumber(params.limit) ? params.limit : null; + var skip = null; + + if (angular.isNumber(params.skip)) { + skip = params.skip; + } else if (angular.isNumber(params.offset)) { + skip = params.offset; + } + + // Apply 'limit' and 'skip' + if (limit && skip) { + filtered = this.utils.slice(filtered, skip, Math.min(filtered.length, skip + limit)); + } else if (this.utils.isNumber(limit)) { + filtered = this.utils.slice(filtered, 0, Math.min(filtered.length, limit)); + } else if (this.utils.isNumber(skip)) { + if (skip < filtered.length) { + filtered = this.utils.slice(filtered, skip); + } else { + filtered = []; + } + } + + return filtered; }; -BaseConfig.prototype.baseUrl = ''; -BaseConfig.prototype.endpoint = ''; +Defaults.prototype.baseUrl = ''; +Defaults.prototype.endpoint = ''; /** * @doc property * @id DSProvider.properties:defaults.beforeValidate @@ -2962,7 +3262,7 @@ BaseConfig.prototype.endpoint = ''; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.beforeValidate = lifecycleNoop; +Defaults.prototype.beforeValidate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.validate @@ -2993,7 +3293,7 @@ BaseConfig.prototype.beforeValidate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.validate = lifecycleNoop; +Defaults.prototype.validate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.afterValidate @@ -3024,7 +3324,7 @@ BaseConfig.prototype.validate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.afterValidate = lifecycleNoop; +Defaults.prototype.afterValidate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.beforeCreate @@ -3055,7 +3355,7 @@ BaseConfig.prototype.afterValidate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.beforeCreate = lifecycleNoop; +Defaults.prototype.beforeCreate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.afterCreate @@ -3086,7 +3386,7 @@ BaseConfig.prototype.beforeCreate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.afterCreate = lifecycleNoop; +Defaults.prototype.afterCreate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.beforeUpdate @@ -3117,7 +3417,7 @@ BaseConfig.prototype.afterCreate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.beforeUpdate = lifecycleNoop; +Defaults.prototype.beforeUpdate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.afterUpdate @@ -3148,7 +3448,7 @@ BaseConfig.prototype.beforeUpdate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.afterUpdate = lifecycleNoop; +Defaults.prototype.afterUpdate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.beforeDestroy @@ -3179,7 +3479,7 @@ BaseConfig.prototype.afterUpdate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.beforeDestroy = lifecycleNoop; +Defaults.prototype.beforeDestroy = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.afterDestroy @@ -3210,7 +3510,7 @@ BaseConfig.prototype.beforeDestroy = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.afterDestroy = lifecycleNoop; +Defaults.prototype.afterDestroy = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.beforeInject @@ -3235,8 +3535,8 @@ BaseConfig.prototype.afterDestroy = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.beforeInject = function (resourceName, attrs) { - return attrs; +Defaults.prototype.beforeInject = function (resourceName, attrs) { + return attrs; }; /** * @doc property @@ -3262,8 +3562,8 @@ BaseConfig.prototype.beforeInject = function (resourceName, attrs) { * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.afterInject = function (resourceName, attrs) { - return attrs; +Defaults.prototype.afterInject = function (resourceName, attrs) { + return attrs; }; /** * @doc property @@ -3286,8 +3586,8 @@ BaseConfig.prototype.afterInject = function (resourceName, attrs) { * @param {object} data Data to be sent to the server. * @returns {*} By default returns `data` as-is. */ -BaseConfig.prototype.serialize = function (resourceName, data) { - return data; +Defaults.prototype.serialize = function (resourceName, data) { + return data; }; /** @@ -3309,8 +3609,8 @@ BaseConfig.prototype.serialize = function (resourceName, data) { * @param {object} data Response object from `$http()`. * @returns {*} By default returns `data.data`. */ -BaseConfig.prototype.deserialize = function (resourceName, data) { - return data.data; +Defaults.prototype.deserialize = function (resourceName, data) { + return data.data; }; /** @@ -3320,153 +3620,154 @@ BaseConfig.prototype.deserialize = function (resourceName, data) { */ function DSProvider() { - /** - * @doc property - * @id DSProvider.properties:defaults - * @name defaults - * @description - * See the [configuration guide](/documentation/guide/configure/global). - * - * Properties: - * - * - `{string}` - `baseUrl` - The url relative to which all AJAX requests will be made. - * - `{string}` - `idAttribute` - Default: `"id"` - The attribute that specifies the primary key for resources. - * - `{string}` - `defaultAdapter` - Default: `"DSHttpAdapter"` - * - `{function}` - `filter` - Default: See [angular-data query language](/documentation/guide/queries/custom). - * - `{function}` - `beforeValidate` - See [DSProvider.defaults.beforeValidate](/documentation/api/angular-data/DSProvider.properties:defaults.beforeValidate). Default: No-op - * - `{function}` - `validate` - See [DSProvider.defaults.validate](/documentation/api/angular-data/DSProvider.properties:defaults.validate). Default: No-op - * - `{function}` - `afterValidate` - See [DSProvider.defaults.afterValidate](/documentation/api/angular-data/DSProvider.properties:defaults.afterValidate). Default: No-op - * - `{function}` - `beforeCreate` - See [DSProvider.defaults.beforeCreate](/documentation/api/angular-data/DSProvider.properties:defaults.beforeCreate). Default: No-op - * - `{function}` - `afterCreate` - See [DSProvider.defaults.afterCreate](/documentation/api/angular-data/DSProvider.properties:defaults.afterCreate). Default: No-op - * - `{function}` - `beforeUpdate` - See [DSProvider.defaults.beforeUpdate](/documentation/api/angular-data/DSProvider.properties:defaults.beforeUpdate). Default: No-op - * - `{function}` - `afterUpdate` - See [DSProvider.defaults.afterUpdate](/documentation/api/angular-data/DSProvider.properties:defaults.afterUpdate). Default: No-op - * - `{function}` - `beforeDestroy` - See [DSProvider.defaults.beforeDestroy](/documentation/api/angular-data/DSProvider.properties:defaults.beforeDestroy). Default: No-op - * - `{function}` - `afterDestroy` - See [DSProvider.defaults.afterDestroy](/documentation/api/angular-data/DSProvider.properties:defaults.afterDestroy). Default: No-op - * - `{function}` - `afterInject` - See [DSProvider.defaults.afterInject](/documentation/api/angular-data/DSProvider.properties:defaults.afterInject). Default: No-op - * - `{function}` - `beforeInject` - See [DSProvider.defaults.beforeInject](/documentation/api/angular-data/DSProvider.properties:defaults.beforeInject). Default: No-op - * - `{function}` - `serialize` - See [DSProvider.defaults.serialize](/documentation/api/angular-data/DSProvider.properties:defaults.serialize). Default: No-op - * - `{function}` - `deserialize` - See [DSProvider.defaults.deserialize](/documentation/api/angular-data/DSProvider.properties:defaults.deserialize). Default: No-op - */ - var defaults = this.defaults = new BaseConfig(); - - this.$get = [ - '$rootScope', '$log', '$q', 'DSHttpAdapter', 'DSLocalStorageAdapter', 'DSUtils', 'DSErrors', - function ($rootScope, $log, $q, DSHttpAdapter, DSLocalStorageAdapter, DSUtils, DSErrors) { - - var syncMethods = require('./sync_methods'), - asyncMethods = require('./async_methods'), - cache; - - try { - cache = angular.injector(['angular-data.DSCacheFactory']).get('DSCacheFactory'); - } catch (err) { - $log.warn(err); - $log.warn('DSCacheFactory is unavailable. Resorting to the lesser capabilities of $cacheFactory.'); - cache = angular.injector(['ng']).get('$cacheFactory'); - } - - /** - * @doc interface - * @id DS - * @name DS - * @description - * Public data store interface. Consists of several properties and a number of methods. Injectable as `DS`. - * - * See the [guide](/documentation/guide/overview/index). - */ - var DS = { - $rootScope: $rootScope, - $log: $log, - $q: $q, - - cacheFactory: cache, - - /** - * @doc property - * @id DS.properties:defaults - * @name defaults - * @description - * Reference to [DSProvider.defaults](/documentation/api/api/DSProvider.properties:defaults). - */ - defaults: defaults, - - /*! - * @doc property - * @id DS.properties:store - * @name store - * @description - * Meta data for each registered resource. - */ - store: {}, - - /*! - * @doc property - * @id DS.properties:definitions - * @name definitions - * @description - * Registered resource definitions available to the data store. - */ - definitions: {}, - - /** - * @doc property - * @id DS.properties:adapters - * @name adapters - * @description - * Registered adapters available to the data store. Object consists of key-values pairs where the key is - * the name of the adapter and the value is the adapter itself. - */ - adapters: { - DSHttpAdapter: DSHttpAdapter, - DSLocalStorageAdapter: DSLocalStorageAdapter - }, - - /** - * @doc property - * @id DS.properties:errors - * @name errors - * @description - * References to the various [error types](/documentation/api/api/errors) used by angular-data. - */ - errors: DSErrors, - - /*! - * @doc property - * @id DS.properties:utils - * @name utils - * @description - * Utility functions used internally by angular-data. - */ - utils: DSUtils - }; - - DSUtils.deepFreeze(syncMethods); - DSUtils.deepFreeze(asyncMethods); - - DSUtils.deepMixIn(DS, syncMethods); - DSUtils.deepMixIn(DS, asyncMethods); - - DSUtils.deepFreeze(DS.errors); - DSUtils.deepFreeze(DS.utils); - - var $dirtyCheckScope = $rootScope.$new(); - - $dirtyCheckScope.$watch(function () { - // Throttle angular-data's digest loop to tenths of a second - // TODO: Is this okay? - return new Date().getTime() / 100 | 0; - }, function () { - DS.digest(); - }); - - return DS; - }]; + /** + * @doc property + * @id DSProvider.properties:defaults + * @name defaults + * @description + * See the [configuration guide](/documentation/guide/configure/global). + * + * Properties: + * + * - `{string}` - `baseUrl` - The url relative to which all AJAX requests will be made. + * - `{string}` - `idAttribute` - Default: `"id"` - The attribute that specifies the primary key for resources. + * - `{string}` - `defaultAdapter` - Default: `"DSHttpAdapter"` + * - `{function}` - `filter` - Default: See [angular-data query language](/documentation/guide/queries/custom). + * - `{function}` - `beforeValidate` - See [DSProvider.defaults.beforeValidate](/documentation/api/angular-data/DSProvider.properties:defaults.beforeValidate). Default: No-op + * - `{function}` - `validate` - See [DSProvider.defaults.validate](/documentation/api/angular-data/DSProvider.properties:defaults.validate). Default: No-op + * - `{function}` - `afterValidate` - See [DSProvider.defaults.afterValidate](/documentation/api/angular-data/DSProvider.properties:defaults.afterValidate). Default: No-op + * - `{function}` - `beforeCreate` - See [DSProvider.defaults.beforeCreate](/documentation/api/angular-data/DSProvider.properties:defaults.beforeCreate). Default: No-op + * - `{function}` - `afterCreate` - See [DSProvider.defaults.afterCreate](/documentation/api/angular-data/DSProvider.properties:defaults.afterCreate). Default: No-op + * - `{function}` - `beforeUpdate` - See [DSProvider.defaults.beforeUpdate](/documentation/api/angular-data/DSProvider.properties:defaults.beforeUpdate). Default: No-op + * - `{function}` - `afterUpdate` - See [DSProvider.defaults.afterUpdate](/documentation/api/angular-data/DSProvider.properties:defaults.afterUpdate). Default: No-op + * - `{function}` - `beforeDestroy` - See [DSProvider.defaults.beforeDestroy](/documentation/api/angular-data/DSProvider.properties:defaults.beforeDestroy). Default: No-op + * - `{function}` - `afterDestroy` - See [DSProvider.defaults.afterDestroy](/documentation/api/angular-data/DSProvider.properties:defaults.afterDestroy). Default: No-op + * - `{function}` - `afterInject` - See [DSProvider.defaults.afterInject](/documentation/api/angular-data/DSProvider.properties:defaults.afterInject). Default: No-op + * - `{function}` - `beforeInject` - See [DSProvider.defaults.beforeInject](/documentation/api/angular-data/DSProvider.properties:defaults.beforeInject). Default: No-op + * - `{function}` - `serialize` - See [DSProvider.defaults.serialize](/documentation/api/angular-data/DSProvider.properties:defaults.serialize). Default: No-op + * - `{function}` - `deserialize` - See [DSProvider.defaults.deserialize](/documentation/api/angular-data/DSProvider.properties:defaults.deserialize). Default: No-op + */ + var defaults = this.defaults = new Defaults(); + + this.$get = [ + '$rootScope', '$log', '$q', 'DSHttpAdapter', 'DSLocalStorageAdapter', 'DSUtils', 'DSErrors', + function ($rootScope, $log, $q, DSHttpAdapter, DSLocalStorageAdapter, DSUtils, DSErrors) { + + var syncMethods = require('./sync_methods'), + asyncMethods = require('./async_methods'), + cache; + + try { + cache = angular.injector(['angular-data.DSCacheFactory']).get('DSCacheFactory'); + } catch (err) { + $log.warn(err); + $log.warn('DSCacheFactory is unavailable. Resorting to the lesser capabilities of $cacheFactory.'); + cache = angular.injector(['ng']).get('$cacheFactory'); + } + + /** + * @doc interface + * @id DS + * @name DS + * @description + * Public data store interface. Consists of several properties and a number of methods. Injectable as `DS`. + * + * See the [guide](/documentation/guide/overview/index). + */ + var DS = { + $rootScope: $rootScope, + $log: $log, + $q: $q, + + cacheFactory: cache, + + /** + * @doc property + * @id DS.properties:defaults + * @name defaults + * @description + * Reference to [DSProvider.defaults](/documentation/api/api/DSProvider.properties:defaults). + */ + defaults: defaults, + + /*! + * @doc property + * @id DS.properties:store + * @name store + * @description + * Meta data for each registered resource. + */ + store: {}, + + /*! + * @doc property + * @id DS.properties:definitions + * @name definitions + * @description + * Registered resource definitions available to the data store. + */ + definitions: {}, + + /** + * @doc property + * @id DS.properties:adapters + * @name adapters + * @description + * Registered adapters available to the data store. Object consists of key-values pairs where the key is + * the name of the adapter and the value is the adapter itself. + */ + adapters: { + DSHttpAdapter: DSHttpAdapter, + DSLocalStorageAdapter: DSLocalStorageAdapter + }, + + /** + * @doc property + * @id DS.properties:errors + * @name errors + * @description + * References to the various [error types](/documentation/api/api/errors) used by angular-data. + */ + errors: DSErrors, + + /*! + * @doc property + * @id DS.properties:utils + * @name utils + * @description + * Utility functions used internally by angular-data. + */ + utils: DSUtils + }; + + DSUtils.deepFreeze(syncMethods); + DSUtils.deepFreeze(asyncMethods); + + DSUtils.deepMixIn(DS, syncMethods); + DSUtils.deepMixIn(DS, asyncMethods); + + DSUtils.deepFreeze(DS.errors); + DSUtils.deepFreeze(DS.utils); + + var $dirtyCheckScope = $rootScope.$new(); + + $dirtyCheckScope.$watch(function () { + // Throttle angular-data's digest loop to tenths of a second + // TODO: Is this okay? + return new Date().getTime() / 100 | 0; + }, function () { + DS.digest(); + }); + + return DS; + } + ]; } module.exports = DSProvider; -},{"../utils":60,"./async_methods":37,"./sync_methods":53}],43:[function(require,module,exports){ -var errorPrefix = 'DS.bindAll(scope, expr, resourceName, params): '; +},{"../utils":61,"./async_methods":37,"./sync_methods":54}],44:[function(require,module,exports){ +var errorPrefix = 'DS.bindAll(scope, expr, resourceName, params[, cb]): '; /** * @doc method @@ -3477,7 +3778,7 @@ var errorPrefix = 'DS.bindAll(scope, expr, resourceName, params): '; * * ## Signature: * ```js - * DS.bindAll(scope, expr, resourceName, params) + * DS.bindAll(scope, expr, resourceName, params[, cb]) * ``` * * ## Example: @@ -3485,10 +3786,8 @@ var errorPrefix = 'DS.bindAll(scope, expr, resourceName, params): '; * ```js * // bind the documents with ownerId of 5 to the 'docs' property of the $scope * var deregisterFunc = DS.bindAll($scope, 'docs', 'document', { - * query: { - * criteria: { - * ownerId: 5 - * } + * where: { + * ownerId: 5 * } * }); * ``` @@ -3496,49 +3795,61 @@ var errorPrefix = 'DS.bindAll(scope, expr, resourceName, params): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {object} scope The scope to bind to. * @param {string} expr An expression used to bind to the scope. Can be used to set nested keys, i.e. `"user.comments"`. * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {object} params Parameter object that is used in filtering the collection. Properties: * - * - `{object=}` - `query` - The query object by which to filter items of the type specified by `resourceName`. Properties: - * - `{object=}` - `where` - Where clause. - * - `{number=}` - `limit` - Limit clause. - * - `{skip=}` - `skip` - Skip clause. - * - `{orderBy=}` - `orderBy` - OrderBy clause. + * - `{object=}` - `where` - Where clause. + * - `{number=}` - `limit` - Limit clause. + * - `{number=}` - `skip` - Skip clause. + * - `{number=}` - `offset` - Same as skip. + * - `{string|array=}` - `orderBy` - OrderBy clause. + * + * @param {function=} cb Optional callback executed on change. Signature: `cb(err, items)`. + * * @returns {function} Scope $watch deregistration function. */ -function bindOne(scope, expr, resourceName, params) { - if (!this.utils.isObject(scope)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'scope: Must be an object!'); - } else if (!this.utils.isString(expr)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'expr: Must be a string!'); - } else if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isObject(params)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'params: Must be an object!'); - } - - var _this = this; - - try { - return scope.$watch(function () { - return _this.lastModified(resourceName); - }, function () { - _this.utils.set(scope, expr, _this.filter(resourceName, params)); - }); - } catch (err) { - throw new this.errors.UnhandledError(err); - } +function bindOne(scope, expr, resourceName, params, cb) { + var IA = this.errors.IA; + + if (!this.utils.isObject(scope)) { + throw new IA(errorPrefix + 'scope: Must be an object!'); + } else if (!this.utils.isString(expr)) { + throw new IA(errorPrefix + 'expr: Must be a string!'); + } else if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(params)) { + throw new IA(errorPrefix + 'params: Must be an object!'); + } + + var _this = this; + + try { + return scope.$watch(function () { + return _this.lastModified(resourceName); + }, function () { + var items = _this.filter(resourceName, params); + _this.utils.set(scope, expr, items); + if (cb) { + cb(null, items); + } + }); + } catch (err) { + if (cb) { + cb(err); + } else { + throw err; + } + } } module.exports = bindOne; -},{}],44:[function(require,module,exports){ -var errorPrefix = 'DS.bindOne(scope, expr, resourceName, id): '; +},{}],45:[function(require,module,exports){ +var errorPrefix = 'DS.bindOne(scope, expr, resourceName, id[, cb]): '; /** * @doc method @@ -3549,7 +3860,7 @@ var errorPrefix = 'DS.bindOne(scope, expr, resourceName, id): '; * * ## Signature: * ```js - * DS.bindOne(scope, expr, resourceName, id) + * DS.bindOne(scope, expr, resourceName, id[, cb]) * ``` * * ## Example: @@ -3562,42 +3873,52 @@ var errorPrefix = 'DS.bindOne(scope, expr, resourceName, id): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {object} scope The scope to bind to. * @param {string} expr An expression used to bind to the scope. Can be used to set nested keys, i.e. `"user.profile"`. * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item to bind. + * @param {function=} cb Optional callback executed on change. Signature: `cb(err, item)`. * @returns {function} Scope $watch deregistration function. */ -function bindOne(scope, expr, resourceName, id) { - if (!this.utils.isObject(scope)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'scope: Must be an object!'); - } else if (!this.utils.isString(expr)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'expr: Must be a string!'); - } else if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!'); - } - - var _this = this; - - try { - return scope.$watch(function () { - return _this.lastModified(resourceName, id); - }, function () { - _this.utils.set(scope, expr, _this.get(resourceName, id)); - }); - } catch (err) { - throw new this.errors.UnhandledError(err); - } +function bindOne(scope, expr, resourceName, id, cb) { + var IA = this.errors.IA; + + if (!this.utils.isObject(scope)) { + throw new IA(errorPrefix + 'scope: Must be an object!'); + } else if (!this.utils.isString(expr)) { + throw new IA(errorPrefix + 'expr: Must be a string!'); + } else if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new IA(errorPrefix + 'id: Must be a string or a number!'); + } + + var _this = this; + + try { + return scope.$watch(function () { + return _this.lastModified(resourceName, id); + }, function () { + var item = _this.get(resourceName, id); + _this.utils.set(scope, expr, item); + if (cb) { + cb(null, item); + } + }); + } catch (err) { + if (cb) { + cb(err); + } else { + throw err; + } + } } module.exports = bindOne; -},{}],45:[function(require,module,exports){ +},{}],46:[function(require,module,exports){ var errorPrefix = 'DS.changes(resourceName, id): '; /** @@ -3627,46 +3948,41 @@ var errorPrefix = 'DS.changes(resourceName, id): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item of the changes to retrieve. * @returns {object} The changes of the item of the type specified by `resourceName` with the primary key specified by `id`. */ function changes(resourceName, id) { - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } - - try { - var item = this.get(resourceName, id); - if (item) { - this.store[resourceName].observers[id].deliver(); - return this.utils.diffObjectFromOldObject(item, this.store[resourceName].previousAttributes[id]); - } - } catch (err) { - throw new this.errors.UnhandledError(err); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } + + var item = this.get(resourceName, id); + if (item) { + this.store[resourceName].observers[id].deliver(); + return this.utils.diffObjectFromOldObject(item, this.store[resourceName].previousAttributes[id]); + } } module.exports = changes; -},{}],46:[function(require,module,exports){ +},{}],47:[function(require,module,exports){ /*jshint evil:true*/ var errorPrefix = 'DS.defineResource(definition): '; function Resource(utils, options) { - utils.deepMixIn(this, options); + utils.deepMixIn(this, options); - if ('endpoint' in options) { - this.endpoint = options.endpoint; - } else { - this.endpoint = this.name; - } + if ('endpoint' in options) { + this.endpoint = options.endpoint; + } else { + this.endpoint = this.name; + } } /** @@ -3700,7 +4016,6 @@ function Resource(utils, options) { * * - `{IllegalArgumentError}` * - `{RuntimeError}` - * - `{UnhandledError}` * * @param {string|object} definition Name of resource or resource definition object: Properties: * @@ -3730,73 +4045,93 @@ function Resource(utils, options) { * See [DSProvider.defaults](/documentation/api/angular-data/DSProvider.properties:defaults). */ function defineResource(definition) { - if (this.utils.isString(definition)) { - definition = { - name: definition - }; - } - if (!this.utils.isObject(definition)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'definition: Must be an object!', { definition: { actual: typeof definition, expected: 'object' } }); - } else if (!this.utils.isString(definition.name)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'definition.name: Must be a string!', { definition: { name: { actual: typeof definition.name, expected: 'string' } } }); - } else if (definition.idAttribute && !this.utils.isString(definition.idAttribute)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'definition.idAttribute: Must be a string!', { definition: { idAttribute: { actual: typeof definition.idAttribute, expected: 'string' } } }); - } else if (definition.endpoint && !this.utils.isString(definition.endpoint)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'definition.endpoint: Must be a string!', { definition: { endpoint: { actual: typeof definition.endpoint, expected: 'string' } } }); - } else if (this.store[definition.name]) { - throw new this.errors.RuntimeError(errorPrefix + definition.name + ' is already registered!'); - } + var IA = this.errors.IA; - try { - Resource.prototype = this.defaults; - this.definitions[definition.name] = new Resource(this.utils, definition); - - var _this = this, - def = this.definitions[definition.name]; - - var cache = this.cacheFactory('DS.' + def.name, { - maxAge: def.maxAge || null, - recycleFreq: def.recycleFreq || 1000, - cacheFlushInterval: def.cacheFlushInterval || null, - deleteOnExpire: def.deleteOnExpire || 'none', - onExpire: function (id) { - _this.eject(def.name, id); - }, - capacity: Number.MAX_VALUE, - storageMode: 'memory', - storageImpl: null, - disabled: false, - storagePrefix: 'DS.' + def.name - }); - - if (def.methods) { - def.class = definition.name[0].toUpperCase() + definition.name.substring(1); - eval('function ' + def.class + '() {}'); - def[def.class] = eval(def.class); - this.utils.deepMixIn(def[def.class].prototype, def.methods); - } + if (this.utils.isString(definition)) { + definition = { + name: definition + }; + } + if (!this.utils.isObject(definition)) { + throw new IA(errorPrefix + 'definition: Must be an object!'); + } else if (!this.utils.isString(definition.name)) { + throw new IA(errorPrefix + 'definition.name: Must be a string!'); + } else if (definition.idAttribute && !this.utils.isString(definition.idAttribute)) { + throw new IA(errorPrefix + 'definition.idAttribute: Must be a string!'); + } else if (definition.endpoint && !this.utils.isString(definition.endpoint)) { + throw new IA(errorPrefix + 'definition.endpoint: Must be a string!'); + } else if (this.store[definition.name]) { + throw new this.errors.R(errorPrefix + definition.name + ' is already registered!'); + } + + try { + Resource.prototype = this.defaults; + this.definitions[definition.name] = new Resource(this.utils, definition); + + var _this = this; + var def = this.definitions[definition.name]; + + var cache = this.cacheFactory('DS.' + def.name, { + maxAge: def.maxAge || null, + recycleFreq: def.recycleFreq || 1000, + cacheFlushInterval: def.cacheFlushInterval || null, + deleteOnExpire: def.deleteOnExpire || 'none', + onExpire: function (id) { + _this.eject(def.name, id); + }, + capacity: Number.MAX_VALUE, + storageMode: 'memory', + storageImpl: null, + disabled: false, + storagePrefix: 'DS.' + def.name + }); + + if (def.methods) { + def.class = definition.name[0].toUpperCase() + definition.name.substring(1); + eval('function ' + def.class + '() {}'); + def[def.class] = eval(def.class); + this.utils.deepMixIn(def[def.class].prototype, def.methods); + } - this.store[def.name] = { - collection: [], - completedQueries: {}, - pendingQueries: {}, - index: cache, - modified: {}, - saved: {}, - previousAttributes: {}, - observers: {}, - collectionModified: 0 - }; - } catch (err) { - delete this.definitions[definition.name]; - delete this.store[definition.name]; - throw new this.errors.UnhandledError(err); - } + if (def.computed) { + this.utils.forOwn(def.computed, function (fn, field) { + if (def.methods && field in def.methods) { + _this.$log.warn(errorPrefix + 'Computed property "' + field + '" conflicts with previously defined prototype method!'); + } + var match = fn.toString().match(/function.*?\(([\s\S]*?)\)/); + var deps = match[1].split(','); + fn.deps = _this.utils.filter(deps, function (dep) { + return !!dep; + }); + angular.forEach(fn.deps, function (val, index) { + fn.deps[index] = val.trim(); + }); + }); + } + + this.store[def.name] = { + collection: [], + completedQueries: {}, + pendingQueries: {}, + index: cache, + modified: {}, + saved: {}, + previousAttributes: {}, + observers: {}, + collectionModified: 0 + }; + } + catch + (err) { + delete this.definitions[definition.name]; + delete this.store[definition.name]; + throw err; + } } module.exports = defineResource; -},{}],47:[function(require,module,exports){ +},{}],48:[function(require,module,exports){ var observe = require('../../../lib/observe-js/observe-js'); /** @@ -3818,47 +4153,40 @@ var observe = require('../../../lib/observe-js/observe-js'); * Works like $scope.$apply() * ``` * - * ## Throws - * - * - `{UnhandledError}` */ function digest() { - try { - if (!this.$rootScope.$$phase) { - this.$rootScope.$apply(function () { - observe.Platform.performMicrotaskCheckpoint(); - }); - } else { - observe.Platform.performMicrotaskCheckpoint(); - } - } catch (err) { - throw new this.errors.UnhandledError(err); - } + if (!this.$rootScope.$$phase) { + this.$rootScope.$apply(function () { + observe.Platform.performMicrotaskCheckpoint(); + }); + } else { + observe.Platform.performMicrotaskCheckpoint(); + } } module.exports = digest; -},{"../../../lib/observe-js/observe-js":1}],48:[function(require,module,exports){ +},{"../../../lib/observe-js/observe-js":1}],49:[function(require,module,exports){ var errorPrefix = 'DS.eject(resourceName, id): '; function _eject(definition, resource, id) { - var found = false; - for (var i = 0; i < resource.collection.length; i++) { - if (resource.collection[i][definition.idAttribute] == id) { - found = true; - break; - } - } - if (found) { - resource.collection.splice(i, 1); - resource.observers[id].close(); - delete resource.observers[id]; - - resource.index.remove(id); - delete resource.previousAttributes[id]; - delete resource.modified[id]; - delete resource.saved[id]; - } + var found = false; + for (var i = 0; i < resource.collection.length; i++) { + if (resource.collection[i][definition.idAttribute] == id) { + found = true; + break; + } + } + if (found) { + resource.collection.splice(i, 1); + resource.observers[id].close(); + delete resource.observers[id]; + + resource.index.remove(id); + delete resource.previousAttributes[id]; + delete resource.modified[id]; + delete resource.saved[id]; + } } /** @@ -3887,52 +4215,49 @@ function _eject(definition, resource, id) { * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item to eject. */ function eject(resourceName, id) { - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } - - var resource = this.store[resourceName], - _this = this; - - try { - if (!this.$rootScope.$$phase) { - this.$rootScope.$apply(function () { - _eject(_this.definitions[resourceName], resource, id); - resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); - }); - } else { - _eject(_this.definitions[resourceName], resource, id); - resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); - } - delete this.store[resourceName].completedQueries[id]; - } catch (err) { - throw new this.errors.UnhandledError(err); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } + + var resource = this.store[resourceName]; + var _this = this; + + if (!this.$rootScope.$$phase) { + this.$rootScope.$apply(function () { + _eject(_this.definitions[resourceName], resource, id); + resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); + }); + } else { + _eject(_this.definitions[resourceName], resource, id); + resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); + } + delete this.store[resourceName].completedQueries[id]; } module.exports = eject; -},{}],49:[function(require,module,exports){ +},{}],50:[function(require,module,exports){ var errorPrefix = 'DS.ejectAll(resourceName[, params]): '; function _ejectAll(definition, resource, params) { - var queryHash = this.utils.toJson(params), - items = this.filter(definition.name, params); + var queryHash = this.utils.toJson(params); + var items = this.filter(definition.name, params); + var ids = this.utils.toLookup(items, definition.idAttribute); + var _this = this; - for (var i = 0; i < items.length; i++) { - this.eject(definition.name, items[i][definition.idAttribute]); - } + angular.forEach(ids, function (item, id) { + _this.eject(definition.name, id); + }); - delete resource.completedQueries[queryHash]; + delete resource.completedQueries[queryHash]; } /** @@ -3965,7 +4290,7 @@ function _ejectAll(definition, resource, params) { * DS.filter('document'); // [ { title: 'How to Cook', id: 45, author: 'John Anderson' }, * // { title: 'How to Eat', id: 46, author: 'Sally Jane' } ] * - * DS.ejectAll('document', { query: { where: { author: 'Sally Jane' } } }); + * DS.ejectAll('document', { where: { author: 'Sally Jane' } }); * * DS.filter('document'); // [ { title: 'How to Cook', id: 45, author: 'John Anderson' } ] * ``` @@ -3984,50 +4309,51 @@ function _ejectAll(definition, resource, params) { * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {object} params Parameter object that is serialized into the query string. Properties: * - * - `{object=}` - `query` - The query object by which to filter items of the type specified by `resourceName`. Properties: - * - `{object=}` - `where` - Where clause. - * - `{number=}` - `limit` - Limit clause. - * - `{skip=}` - `skip` - Skip clause. - * - `{orderBy=}` - `orderBy` - OrderBy clause. + * - `{object=}` - `where` - Where clause. + * - `{number=}` - `limit` - Limit clause. + * - `{number=}` - `skip` - Skip clause. + * - `{number=}` - `offset` - Same as skip. + * - `{string|array=}` - `orderBy` - OrderBy clause. */ function ejectAll(resourceName, params) { - params = params || {}; - - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isObject(params)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'params: Must be an object!', { params: { actual: typeof params, expected: 'object' } }); - } - - var resource = this.store[resourceName], - _this = this; - - try { - if (!this.$rootScope.$$phase) { - this.$rootScope.$apply(function () { - _ejectAll.apply(_this, [_this.definitions[resourceName], resource, params]); - resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); - }); - } else { - _ejectAll.apply(_this, [_this.definitions[resourceName], resource, params]); - resource.collectionModified = this.utils.updateTimestamp(resource.collectionModified); - } - } catch (err) { - throw new this.errors.UnhandledError(err); - } + params = params || {}; + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(params)) { + throw new this.errors.IA(errorPrefix + 'params: Must be an object!'); + } + + var _this = this; + var resource = this.store[resourceName]; + var queryHash = this.utils.toJson(params); + + delete resource.completedQueries[queryHash]; + + if (this.utils.isEmpty(params)) { + resource.completedQueries = {}; + } + + if (!this.$rootScope.$$phase) { + this.$rootScope.$apply(function () { + _ejectAll.apply(_this, [_this.definitions[resourceName], resource, params]); + resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); + }); + } else { + _ejectAll.apply(_this, [_this.definitions[resourceName], resource, params]); + resource.collectionModified = this.utils.updateTimestamp(resource.collectionModified); + } } module.exports = ejectAll; -},{}],50:[function(require,module,exports){ -/* jshint loopfunc: true */ -var errorPrefix = 'DS.filter(resourceName, params[, options]): '; +},{}],51:[function(require,module,exports){ +var errorPrefix = 'DS.filter(resourceName[, params][, options]): '; /** * @doc method @@ -4038,7 +4364,7 @@ var errorPrefix = 'DS.filter(resourceName, params[, options]): '; * * ## Signature: * ```js - * DS.filter(resourceName, params[, options]) + * DS.filter(resourceName[, params][, options]) * ``` * * ## Example: @@ -4050,140 +4376,64 @@ var errorPrefix = 'DS.filter(resourceName, params[, options]): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {object=} params Parameter object that is serialized into the query string. Properties: * - * - `{object=}` - `query` - The query object by which to filter items of the type specified by `resourceName`. Properties: - * - `{object=}` - `where` - Where clause. - * - `{number=}` - `limit` - Limit clause. - * - `{skip=}` - `skip` - Skip clause. - * - `{orderBy=}` - `orderBy` - OrderBy clause. + * - `{object=}` - `where` - Where clause. + * - `{number=}` - `limit` - Limit clause. + * - `{number=}` - `skip` - Skip clause. + * - `{number=}` - `offset` - Same as skip. + * - `{string|array=}` - `orderBy` - OrderBy clause. * * @param {object=} options Optional configuration. Properties: * - `{boolean=}` - `loadFromServer` - Send the query to server if it has not been sent yet. Default: `false`. + * - `{boolean=}` - `allowSimpleWhere` - Treat top-level fields on the `params` argument as simple "where" equality clauses. Default: `true`. * @returns {array} The filtered collection of items of the type specified by `resourceName`. */ function filter(resourceName, params, options) { - options = options || {}; - - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (params && !this.utils.isObject(params)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'params: Must be an object!', { params: { actual: typeof params, expected: 'object' } }); - } else if (!this.utils.isObject(options)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!', { options: { actual: typeof options, expected: 'object' } }); - } + var IA = this.errors.IA; - try { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; + options = options || {}; - // Protect against null - params = params || {}; + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (params && !this.utils.isObject(params)) { + throw new IA(errorPrefix + 'params: Must be an object!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } - var queryHash = this.utils.toJson(params); + var definition = this.definitions[resourceName]; + var resource = this.store[resourceName]; - if (!(queryHash in resource.completedQueries) && options.loadFromServer) { - // This particular query has never been completed + // Protect against null + params = params || {}; - if (!resource.pendingQueries[queryHash]) { - // This particular query has never even been started - this.findAll(resourceName, params, options); - } - } + if ('allowSimpleWhere' in options) { + options.allowSimpleWhere = !!options.allowSimpleWhere; + } else { + options.allowSimpleWhere = true; + } - params.query = params.query || {}; - // The query has been completed, so hit the cache with the query - var filtered = this.utils.filter(resource.collection, function (attrs) { - var keep = true, - where = params.query.where; + var queryHash = this.utils.toJson(params); - // Apply 'where' clauses - if (where) { - if (!_this.utils.isObject(where)) { - throw new _this.errors.IllegalArgumentError(errorPrefix + 'params.query.where: Must be an object!', { params: { query: { where: { actual: typeof params.query.where, expected: 'object' } } } }); - } - keep = definition.filter(resourceName, where, attrs); - } - return keep; - }); - - // Apply 'orderBy' - if (params.query.orderBy) { - if (this.utils.isString(params.query.orderBy)) { - params.query.orderBy = [ - [params.query.orderBy, 'ASC'] - ]; - } - if (this.utils.isArray(params.query.orderBy)) { - for (var i = 0; i < params.query.orderBy.length; i++) { - if (this.utils.isString(params.query.orderBy[i])) { - params.query.orderBy[i] = [params.query.orderBy[i], 'ASC']; - } else if (!this.utils.isArray(params.query.orderBy[i])) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'params.query.orderBy[' + i + ']: Must be a string or an array!', { params: { query: { 'orderBy[i]': { actual: typeof params.query.orderBy[i], expected: 'string|array' } } } }); - } - filtered = this.utils.sort(filtered, function (a, b) { - var cA = a[params.query.orderBy[i][0]], cB = b[params.query.orderBy[i][0]]; - if (_this.utils.isString(cA)) { - cA = _this.utils.upperCase(cA); - } - if (_this.utils.isString(cB)) { - cB = _this.utils.upperCase(cB); - } - if (params.query.orderBy[i][1] === 'DESC') { - if (cB < cA) { - return -1; - } else if (cB > cA) { - return 1; - } else { - return 0; - } - } else { - if (cA < cB) { - return -1; - } else if (cA > cB) { - return 1; - } else { - return 0; - } - } - }); - } - } else { - throw new this.errors.IllegalArgumentError(errorPrefix + 'params.query.orderBy: Must be a string or an array!', { params: { query: { orderBy: { actual: typeof params.query.orderBy, expected: 'string|array' } } } }); - } - } + if (!(queryHash in resource.completedQueries) && options.loadFromServer) { + // This particular query has never been completed - // Apply 'limit' and 'skip' - if (this.utils.isNumber(params.query.limit) && this.utils.isNumber(params.query.skip)) { - filtered = this.utils.slice(filtered, params.query.skip, Math.min(filtered.length, params.query.skip + params.query.limit)); - } else if (this.utils.isNumber(params.query.limit)) { - filtered = this.utils.slice(filtered, 0, Math.min(filtered.length, params.query.limit)); - } else if (this.utils.isNumber(params.query.skip)) { - if (params.query.skip < filtered.length) { - filtered = this.utils.slice(filtered, params.query.skip); - } else { - filtered = []; - } - } + if (!resource.pendingQueries[queryHash]) { + // This particular query has never even been started + this.findAll(resourceName, params, options); + } + } - return filtered; - } catch (err) { - if (err instanceof this.errors.IllegalArgumentError) { - throw err; - } else { - throw new this.errors.UnhandledError(err); - } - } + return definition.filter.call(this, resource.collection, resourceName, params, options); } module.exports = filter; -},{}],51:[function(require,module,exports){ +},{}],52:[function(require,module,exports){ var errorPrefix = 'DS.get(resourceName, id[, options]): '; /** @@ -4208,8 +4458,7 @@ var errorPrefix = 'DS.get(resourceName, id[, options]): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item to retrieve. @@ -4218,42 +4467,40 @@ var errorPrefix = 'DS.get(resourceName, id[, options]): '; * @returns {object} The item of the type specified by `resourceName` with the primary key specified by `id`. */ function get(resourceName, id, options) { - options = options || {}; - - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } else if (!this.utils.isObject(options)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!', { options: { actual: typeof options, expected: 'object' } }); - } - var _this = this; - - try { - // cache miss, request resource from server - var item = this.store[resourceName].index.get(id); - if (!item && options.loadFromServer) { - this.find(resourceName, id).then(null, function (err) { - return _this.$q.reject(err); - }); - } - - // return resource from cache - return item; - } catch (err) { - throw new this.errors.UnhandledError(err); - } + var IA = this.errors.IA; + + options = options || {}; + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new IA(errorPrefix + 'id: Must be a string or a number!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } + var _this = this; + + // cache miss, request resource from server + var item = this.store[resourceName].index.get(id); + if (!item && options.loadFromServer) { + this.find(resourceName, id).then(null, function (err) { + return _this.$q.reject(err); + }); + } + + // return resource from cache + return item; } module.exports = get; -},{}],52:[function(require,module,exports){ +},{}],53:[function(require,module,exports){ var errorPrefix = 'DS.hasChanges(resourceName, id): '; function diffIsEmpty(utils, diff) { - return !(utils.isEmpty(diff.added) && - utils.isEmpty(diff.removed) && - utils.isEmpty(diff.changed)); + return !(utils.isEmpty(diff.added) && + utils.isEmpty(diff.removed) && + utils.isEmpty(diff.changed)); } /** @@ -4282,259 +4529,294 @@ function diffIsEmpty(utils, diff) { * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item. * @returns {boolean} Whether the item of the type specified by `resourceName` with the primary key specified by `id` has changes. */ function hasChanges(resourceName, id) { - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } - - try { - // return resource from cache - if (this.get(resourceName, id)) { - return diffIsEmpty(this.utils, this.changes(resourceName, id)); - } else { - return false; - } - } catch (err) { - throw new this.errors.UnhandledError(err); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } + + // return resource from cache + if (this.get(resourceName, id)) { + return diffIsEmpty(this.utils, this.changes(resourceName, id)); + } else { + return false; + } } module.exports = hasChanges; -},{}],53:[function(require,module,exports){ +},{}],54:[function(require,module,exports){ module.exports = { - /** - * @doc method - * @id DS.sync_methods:defineResource - * @name defineResource - * @methodOf DS - * @description - * See [DS.defineResource](/documentation/api/api/DS.sync_methods:defineResource). - */ - defineResource: require('./defineResource'), - - /** - * @doc method - * @id DS.sync_methods:bindOne - * @name bindOne - * @methodOf DS - * @description - * See [DS.bindOne](/documentation/api/api/DS.sync_methods:bindOne). - */ - bindOne: require('./bindOne'), - - /** - * @doc method - * @id DS.sync_methods:bindAll - * @name bindAll - * @methodOf DS - * @description - * See [DS.bindAll](/documentation/api/api/DS.sync_methods:bindAll). - */ - bindAll: require('./bindAll'), - - /** - * @doc method - * @id DS.sync_methods:eject - * @name eject - * @methodOf DS - * @description - * See [DS.eject](/documentation/api/api/DS.sync_methods:eject). - */ - eject: require('./eject'), - - /** - * @doc method - * @id DS.sync_methods:ejectAll - * @name ejectAll - * @methodOf DS - * @description - * See [DS.ejectAll](/documentation/api/api/DS.sync_methods:ejectAll). - */ - ejectAll: require('./ejectAll'), - - /** - * @doc method - * @id DS.sync_methods:filter - * @name filter - * @methodOf DS - * @description - * See [DS.filter](/documentation/api/api/DS.sync_methods:filter). - */ - filter: require('./filter'), - - /** - * @doc method - * @id DS.sync_methods:get - * @name get - * @methodOf DS - * @description - * See [DS.get](/documentation/api/api/DS.sync_methods:get). - */ - get: require('./get'), - - /** - * @doc method - * @id DS.sync_methods:inject - * @name inject - * @methodOf DS - * @description - * See [DS.inject](/documentation/api/api/DS.sync_methods:inject). - */ - inject: require('./inject'), - - /** - * @doc method - * @id DS.sync_methods:lastModified - * @name lastModified - * @methodOf DS - * @description - * See [DS.lastModified](/documentation/api/api/DS.sync_methods:lastModified). - */ - lastModified: require('./lastModified'), - - /** - * @doc method - * @id DS.sync_methods:lastSaved - * @name lastSaved - * @methodOf DS - * @description - * See [DS.lastSaved](/documentation/api/api/DS.sync_methods:lastSaved). - */ - lastSaved: require('./lastSaved'), - - /** - * @doc method - * @id DS.sync_methods:digest - * @name digest - * @methodOf DS - * @description - * See [DS.digest](/documentation/api/api/DS.sync_methods:digest). - */ - digest: require('./digest'), - - /** - * @doc method - * @id DS.sync_methods:changes - * @name changes - * @methodOf DS - * @description - * See [DS.changes](/documentation/api/api/DS.sync_methods:changes). - */ - changes: require('./changes'), - - /** - * @doc method - * @id DS.sync_methods:previous - * @name previous - * @methodOf DS - * @description - * See [DS.previous](/documentation/api/api/DS.sync_methods:previous). - */ - previous: require('./previous'), - - /** - * @doc method - * @id DS.sync_methods:hasChanges - * @name hasChanges - * @methodOf DS - * @description - * See [DS.hasChanges](/documentation/api/api/DS.sync_methods:hasChanges). - */ - hasChanges: require('./hasChanges') + /** + * @doc method + * @id DS.sync_methods:defineResource + * @name defineResource + * @methodOf DS + * @description + * See [DS.defineResource](/documentation/api/api/DS.sync_methods:defineResource). + */ + defineResource: require('./defineResource'), + + /** + * @doc method + * @id DS.sync_methods:bindOne + * @name bindOne + * @methodOf DS + * @description + * See [DS.bindOne](/documentation/api/api/DS.sync_methods:bindOne). + */ + bindOne: require('./bindOne'), + + /** + * @doc method + * @id DS.sync_methods:bindAll + * @name bindAll + * @methodOf DS + * @description + * See [DS.bindAll](/documentation/api/api/DS.sync_methods:bindAll). + */ + bindAll: require('./bindAll'), + + /** + * @doc method + * @id DS.sync_methods:eject + * @name eject + * @methodOf DS + * @description + * See [DS.eject](/documentation/api/api/DS.sync_methods:eject). + */ + eject: require('./eject'), + + /** + * @doc method + * @id DS.sync_methods:ejectAll + * @name ejectAll + * @methodOf DS + * @description + * See [DS.ejectAll](/documentation/api/api/DS.sync_methods:ejectAll). + */ + ejectAll: require('./ejectAll'), + + /** + * @doc method + * @id DS.sync_methods:filter + * @name filter + * @methodOf DS + * @description + * See [DS.filter](/documentation/api/api/DS.sync_methods:filter). + */ + filter: require('./filter'), + + /** + * @doc method + * @id DS.sync_methods:get + * @name get + * @methodOf DS + * @description + * See [DS.get](/documentation/api/api/DS.sync_methods:get). + */ + get: require('./get'), + + /** + * @doc method + * @id DS.sync_methods:inject + * @name inject + * @methodOf DS + * @description + * See [DS.inject](/documentation/api/api/DS.sync_methods:inject). + */ + inject: require('./inject'), + + /** + * @doc method + * @id DS.sync_methods:lastModified + * @name lastModified + * @methodOf DS + * @description + * See [DS.lastModified](/documentation/api/api/DS.sync_methods:lastModified). + */ + lastModified: require('./lastModified'), + + /** + * @doc method + * @id DS.sync_methods:lastSaved + * @name lastSaved + * @methodOf DS + * @description + * See [DS.lastSaved](/documentation/api/api/DS.sync_methods:lastSaved). + */ + lastSaved: require('./lastSaved'), + + /** + * @doc method + * @id DS.sync_methods:digest + * @name digest + * @methodOf DS + * @description + * See [DS.digest](/documentation/api/api/DS.sync_methods:digest). + */ + digest: require('./digest'), + + /** + * @doc method + * @id DS.sync_methods:changes + * @name changes + * @methodOf DS + * @description + * See [DS.changes](/documentation/api/api/DS.sync_methods:changes). + */ + changes: require('./changes'), + + /** + * @doc method + * @id DS.sync_methods:previous + * @name previous + * @methodOf DS + * @description + * See [DS.previous](/documentation/api/api/DS.sync_methods:previous). + */ + previous: require('./previous'), + + /** + * @doc method + * @id DS.sync_methods:hasChanges + * @name hasChanges + * @methodOf DS + * @description + * See [DS.hasChanges](/documentation/api/api/DS.sync_methods:hasChanges). + */ + hasChanges: require('./hasChanges') }; -},{"./bindAll":43,"./bindOne":44,"./changes":45,"./defineResource":46,"./digest":47,"./eject":48,"./ejectAll":49,"./filter":50,"./get":51,"./hasChanges":52,"./inject":54,"./lastModified":55,"./lastSaved":56,"./previous":57}],54:[function(require,module,exports){ -var observe = require('../../../lib/observe-js/observe-js'), - errorPrefix = 'DS.inject(resourceName, attrs[, options]): '; +},{"./bindAll":44,"./bindOne":45,"./changes":46,"./defineResource":47,"./digest":48,"./eject":49,"./ejectAll":50,"./filter":51,"./get":52,"./hasChanges":53,"./inject":55,"./lastModified":56,"./lastSaved":57,"./previous":58}],55:[function(require,module,exports){ +var observe = require('../../../lib/observe-js/observe-js'); +var errorPrefix = 'DS.inject(resourceName, attrs[, options]): '; function _inject(definition, resource, attrs) { - var _this = this, - $log = _this.$log; - - function _react(added, removed, changed, getOldValueFn) { - try { - var innerId = getOldValueFn(definition.idAttribute); + var _this = this; + var $log = _this.$log; + + function _react(added, removed, changed, getOldValueFn) { + var innerId = getOldValueFn(definition.idAttribute); + + resource.modified[innerId] = _this.utils.updateTimestamp(resource.modified[innerId]); + resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); + + if (definition.computed) { + var item = _this.get(definition.name, innerId); + _this.utils.forOwn(definition.computed, function (fn, field) { + var compute = false; + // check if required fields changed + angular.forEach(fn.deps, function (dep) { + if (dep in changed || dep in removed || dep in changed || !(field in item)) { + compute = true; + } + }); + if (compute) { + var args = []; + angular.forEach(fn.deps, function (dep) { + args.push(item[dep]); + }); + // recompute property + item[field] = fn.apply(item, args); + } + }); + } - resource.modified[innerId] = _this.utils.updateTimestamp(resource.modified[innerId]); - resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); + if (definition.idAttribute in changed) { + $log.error('Doh! You just changed the primary key of an object! ' + + 'I don\'t know how to handle this yet, so your data for the "' + definition.name + + '" resource is now in an undefined (probably broken) state.'); + } + } - if (definition.idAttribute in changed) { - $log.error('Doh! You just changed the primary key of an object! ' + - 'I don\'t know how to handle this yet, so your data for the "' + definition.name + - '" resource is now in an undefined (probably broken) state.'); - } - } catch (err) { - throw new _this.errors.UnhandledError(err); - } - } + var injected; + if (_this.utils.isArray(attrs)) { + injected = []; + for (var i = 0; i < attrs.length; i++) { + injected.push(_inject.call(_this, definition, resource, attrs[i])); + } + } else { + // check if "idAttribute" is a computed property + if (definition.computed && definition.computed[definition.idAttribute]) { + var args = []; + angular.forEach(definition.computed[definition.idAttribute].deps, function (dep) { + args.push(attrs[dep]); + }); + attrs[definition.idAttribute] = definition.computed[definition.idAttribute].apply(attrs, args); + } + if (!(definition.idAttribute in attrs)) { + throw new _this.errors.R(errorPrefix + 'attrs: Must contain the property specified by `idAttribute`!'); + } else { + try { + definition.beforeInject(definition.name, attrs); + var id = attrs[definition.idAttribute], + item = this.get(definition.name, id); + + if (!item) { + if (definition.class) { + if (attrs instanceof definition[definition.class]) { + item = attrs; + } else { + item = new definition[definition.class](); + } + } else { + item = {}; + } + resource.previousAttributes[id] = {}; - var injected; - if (_this.utils.isArray(attrs)) { - injected = []; - for (var i = 0; i < attrs.length; i++) { - injected.push(_inject.call(_this, definition, resource, attrs[i])); - } - } else { - if (!(definition.idAttribute in attrs)) { - throw new _this.errors.RuntimeError(errorPrefix + 'attrs: Must contain the property specified by `idAttribute`!'); - } else { - try { - definition.beforeInject(definition.name, attrs); - var id = attrs[definition.idAttribute], - item = this.get(definition.name, id); - - if (!item) { - if (definition.class) { - if (attrs instanceof definition[definition.class]) { - item = attrs; - } else { - item = new definition[definition.class](); - } - } else { - item = {}; - } - resource.previousAttributes[id] = {}; + _this.utils.deepMixIn(item, attrs); + _this.utils.deepMixIn(resource.previousAttributes[id], attrs); - _this.utils.deepMixIn(item, attrs); - _this.utils.deepMixIn(resource.previousAttributes[id], attrs); + resource.collection.push(item); - resource.collection.push(item); + resource.observers[id] = new observe.ObjectObserver(item, _react); + resource.index.put(id, item); - resource.observers[id] = new observe.ObjectObserver(item, _react); - resource.index.put(id, item); + _react({}, {}, {}, function () { + return id; + }); + } else { + _this.utils.deepMixIn(item, attrs); + if (typeof resource.index.touch === 'function') { + resource.index.touch(id); + } else { + resource.index.put(id, resource.index.get(id)); + } + resource.observers[id].deliver(); + } + resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); + definition.afterInject(definition.name, item); + injected = item; + } catch (err) { + $log.error(err); + $log.error('inject failed!', definition.name, attrs); + } + } + } + return injected; +} - _react({}, {}, {}, function () { - return id; - }); - } else { - _this.utils.deepMixIn(item, attrs); - if (typeof resource.index.touch === 'function') { - resource.index.touch(id); - } else { - resource.index.put(id, resource.index.get(id)); - } - resource.observers[id].deliver(); - } - resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); - definition.afterInject(definition.name, item); - injected = item; - } catch (err) { - $log.error(err); - $log.error('inject failed!', definition.name, attrs); - } - } - } - return injected; +function _injectRelations(definition, injected) { + var _this = this; + _this.utils.forOwn(definition.relations, function (relation, type) { + _this.utils.forOwn(relation, function (def, relationName) { + if (_this.definitions[relationName] && injected[def.localField]) { + try { + injected[def.localField] = _this.inject(relationName, injected[def.localField]); + } catch (err) { + _this.$log.error(errorPrefix + 'Failed to inject ' + type + ' relation: "' + relationName + '"!', err); + } + } + }); + }); } /** @@ -4574,7 +4856,7 @@ function _inject(definition, resource, attrs) { * * - `{IllegalArgumentError}` * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {object|array} attrs The item or collection of items to inject into the data store. @@ -4583,42 +4865,40 @@ function _inject(definition, resource, attrs) { * the items that were injected into the data store. */ function inject(resourceName, attrs, options) { - options = options || {}; - - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isObject(attrs) && !this.utils.isArray(attrs)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'attrs: Must be an object or an array!', { attrs: { actual: typeof attrs, expected: 'object|array' } }); - } else if (!this.utils.isObject(options)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!', { options: { actual: typeof options, expected: 'object' } }); - } - - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; - - try { - var injected; - if (!this.$rootScope.$$phase) { - this.$rootScope.$apply(function () { - injected = _inject.apply(_this, [definition, resource, attrs]); - }); - } else { - injected = _inject.apply(_this, [definition, resource, attrs]); - } - return injected; - } catch (err) { - if (!(err instanceof this.errors.RuntimeError)) { - throw new this.errors.UnhandledError(err); - } else { - throw err; - } - } + var IA = this.errors.IA; + + options = options || {}; + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(attrs) && !this.utils.isArray(attrs)) { + throw new IA(errorPrefix + 'attrs: Must be an object or an array!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } + + var definition = this.definitions[resourceName]; + var resource = this.store[resourceName]; + var _this = this; + + var injected; + if (!this.$rootScope.$$phase) { + this.$rootScope.$apply(function () { + injected = _inject.call(_this, definition, resource, attrs); + }); + } else { + injected = _inject.call(_this, definition, resource, attrs); + } + if (definition.relations) { + _injectRelations.call(_this, definition, injected); + } + + return injected; } module.exports = inject; -},{"../../../lib/observe-js/observe-js":1}],55:[function(require,module,exports){ +},{"../../../lib/observe-js/observe-js":1}],56:[function(require,module,exports){ var errorPrefix = 'DS.lastModified(resourceName[, id]): '; /** @@ -4647,8 +4927,7 @@ var errorPrefix = 'DS.lastModified(resourceName[, id]): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number=} id The primary key of the item to remove. @@ -4656,27 +4935,23 @@ var errorPrefix = 'DS.lastModified(resourceName[, id]): '; * `resourceName` with the given primary key was modified. */ function lastModified(resourceName, id) { - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (id && !this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } - try { - if (id) { - if (!(id in this.store[resourceName].modified)) { - this.store[resourceName].modified[id] = 0; - } - return this.store[resourceName].modified[id]; - } - return this.store[resourceName].collectionModified; - } catch (err) { - throw new this.errors.UnhandledError(err); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (id && !this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } + if (id) { + if (!(id in this.store[resourceName].modified)) { + this.store[resourceName].modified[id] = 0; + } + return this.store[resourceName].modified[id]; + } + return this.store[resourceName].collectionModified; } module.exports = lastModified; -},{}],56:[function(require,module,exports){ +},{}],57:[function(require,module,exports){ var errorPrefix = 'DS.lastSaved(resourceName[, id]): '; /** @@ -4712,32 +4987,27 @@ var errorPrefix = 'DS.lastSaved(resourceName[, id]): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item for which to retrieve the lastSaved timestamp. * @returns {number} The timestamp of the last time the item of type `resourceName` with the given primary key was saved. */ function lastSaved(resourceName, id) { - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } - try { - if (!(id in this.store[resourceName].saved)) { - this.store[resourceName].saved[id] = 0; - } - return this.store[resourceName].saved[id]; - } catch (err) { - throw new this.errors.UnhandledError(err); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } + if (!(id in this.store[resourceName].saved)) { + this.store[resourceName].saved[id] = 0; + } + return this.store[resourceName].saved[id]; } module.exports = lastSaved; -},{}],57:[function(require,module,exports){ +},{}],58:[function(require,module,exports){ var errorPrefix = 'DS.previous(resourceName, id): '; /** @@ -4768,129 +5038,57 @@ var errorPrefix = 'DS.previous(resourceName, id): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item whose previous attributes are to be retrieved. * @returns {object} The previous attributes of the item of the type specified by `resourceName` with the primary key specified by `id`. */ function previous(resourceName, id) { - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } - - try { - // return resource from cache - return angular.copy(this.store[resourceName].previousAttributes[id]); - } catch (err) { - throw new this.errors.UnhandledError(err); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } + + // return resource from cache + return angular.copy(this.store[resourceName].previousAttributes[id]); } module.exports = previous; -},{}],58:[function(require,module,exports){ -/** - * @doc function - * @id errors.types:UnhandledError - * @name UnhandledError - * @description Error that is thrown/returned when Reheat encounters an uncaught/unknown exception. - * @param {Error} error The originally thrown error. - * @returns {UnhandledError} A new instance of `UnhandledError`. - */ -function UnhandledError(error) { - Error.call(this); - if (typeof Error.captureStackTrace === 'function') { - Error.captureStackTrace(this, this.constructor); - } - - error = error || {}; - - /** - * @doc property - * @id errors.types:UnhandledError.type - * @name type - * @propertyOf errors.types:UnhandledError - * @description Name of error type. Default: `"UnhandledError"`. - */ - this.type = this.constructor.name; - - /** - * @doc property - * @id errors.types:UnhandledError.originalError - * @name originalError - * @propertyOf errors.types:UnhandledError - * @description A reference to the original error that was thrown. - */ - this.originalError = error; - - /** - * @doc property - * @id errors.types:UnhandledError.message - * @name message - * @propertyOf errors.types:UnhandledError - * @description Message and stack trace. Same as `UnhandledError#stack`. - */ - this.message = 'UnhandledError: This is an uncaught exception. Please consider submitting an issue at https://github.com/jmdobry/angular-data/issues.\n\n' + - 'Original Uncaught Exception:\n' + (error.stack ? error.stack.toString() : error.stack); - - /** - * @doc property - * @id errors.types:UnhandledError.stack - * @name stack - * @propertyOf errors.types:UnhandledError - * @description Message and stack trace. Same as `UnhandledError#message`. - */ - this.stack = this.message; -} - -UnhandledError.prototype = Object.create(Error.prototype); -UnhandledError.prototype.constructor = UnhandledError; - +},{}],59:[function(require,module,exports){ /** * @doc function * @id errors.types:IllegalArgumentError * @name IllegalArgumentError * @description Error that is thrown/returned when a caller does not honor the pre-conditions of a method/function. * @param {string=} message Error message. Default: `"Illegal Argument!"`. - * @param {object=} errors Object containing information about the error. * @returns {IllegalArgumentError} A new instance of `IllegalArgumentError`. */ -function IllegalArgumentError(message, errors) { - Error.call(this); - if (typeof Error.captureStackTrace === 'function') { - Error.captureStackTrace(this, this.constructor); - } - - /** - * @doc property - * @id errors.types:IllegalArgumentError.type - * @name type - * @propertyOf errors.types:IllegalArgumentError - * @description Name of error type. Default: `"IllegalArgumentError"`. - */ - this.type = this.constructor.name; - - /** - * @doc property - * @id errors.types:IllegalArgumentError.errors - * @name errors - * @propertyOf errors.types:IllegalArgumentError - * @description Object containing information about the error. - */ - this.errors = errors || {}; - - /** - * @doc property - * @id errors.types:IllegalArgumentError.message - * @name message - * @propertyOf errors.types:IllegalArgumentError - * @description Error message. Default: `"Illegal Argument!"`. - */ - this.message = message || 'Illegal Argument!'; +function IllegalArgumentError(message) { + Error.call(this); + if (typeof Error.captureStackTrace === 'function') { + Error.captureStackTrace(this, this.constructor); + } + + /** + * @doc property + * @id errors.types:IllegalArgumentError.type + * @name type + * @propertyOf errors.types:IllegalArgumentError + * @description Name of error type. Default: `"IllegalArgumentError"`. + */ + this.type = this.constructor.name; + + /** + * @doc property + * @id errors.types:IllegalArgumentError.message + * @name message + * @propertyOf errors.types:IllegalArgumentError + * @description Error message. Default: `"Illegal Argument!"`. + */ + this.message = message || 'Illegal Argument!'; } IllegalArgumentError.prototype = Object.create(Error.prototype); @@ -4902,46 +5100,72 @@ IllegalArgumentError.prototype.constructor = IllegalArgumentError; * @name RuntimeError * @description Error that is thrown/returned for invalid state during runtime. * @param {string=} message Error message. Default: `"Runtime Error!"`. - * @param {object=} errors Object containing information about the error. * @returns {RuntimeError} A new instance of `RuntimeError`. */ -function RuntimeError(message, errors) { - Error.call(this); - if (typeof Error.captureStackTrace === 'function') { - Error.captureStackTrace(this, this.constructor); - } - - /** - * @doc property - * @id errors.types:RuntimeError.type - * @name type - * @propertyOf errors.types:RuntimeError - * @description Name of error type. Default: `"RuntimeError"`. - */ - this.type = this.constructor.name; - - /** - * @doc property - * @id errors.types:RuntimeError.errors - * @name errors - * @propertyOf errors.types:RuntimeError - * @description Object containing information about the error. - */ - this.errors = errors || {}; - - /** - * @doc property - * @id errors.types:RuntimeError.message - * @name message - * @propertyOf errors.types:RuntimeError - * @description Error message. Default: `"Runtime Error!"`. - */ - this.message = message || 'RuntimeError Error!'; +function RuntimeError(message) { + Error.call(this); + if (typeof Error.captureStackTrace === 'function') { + Error.captureStackTrace(this, this.constructor); + } + + /** + * @doc property + * @id errors.types:RuntimeError.type + * @name type + * @propertyOf errors.types:RuntimeError + * @description Name of error type. Default: `"RuntimeError"`. + */ + this.type = this.constructor.name; + + /** + * @doc property + * @id errors.types:RuntimeError.message + * @name message + * @propertyOf errors.types:RuntimeError + * @description Error message. Default: `"Runtime Error!"`. + */ + this.message = message || 'RuntimeError Error!'; } RuntimeError.prototype = Object.create(Error.prototype); RuntimeError.prototype.constructor = RuntimeError; +/** + * @doc function + * @id errors.types:NonexistentResourceError + * @name NonexistentResourceError + * @description Error that is thrown/returned when trying to access a resource that does not exist. + * @param {string=} resourceName Name of non-existent resource. + * @returns {NonexistentResourceError} A new instance of `NonexistentResourceError`. + */ +function NonexistentResourceError(resourceName) { + Error.call(this); + if (typeof Error.captureStackTrace === 'function') { + Error.captureStackTrace(this, this.constructor); + } + + /** + * @doc property + * @id errors.types:NonexistentResourceError.type + * @name type + * @propertyOf errors.types:NonexistentResourceError + * @description Name of error type. Default: `"NonexistentResourceError"`. + */ + this.type = this.constructor.name; + + /** + * @doc property + * @id errors.types:NonexistentResourceError.message + * @name message + * @propertyOf errors.types:NonexistentResourceError + * @description Error message. Default: `"Runtime Error!"`. + */ + this.message = (resourceName || '') + ' is not a registered resource!'; +} + +NonexistentResourceError.prototype = Object.create(Error.prototype); +NonexistentResourceError.prototype.constructor = NonexistentResourceError; + /** * @doc interface * @id errors @@ -4949,183 +5173,186 @@ RuntimeError.prototype.constructor = RuntimeError; * @description * Various error types that may be thrown by angular-data. * - * - [UnhandledError](/documentation/api/api/errors.types:UnhandledError) * - [IllegalArgumentError](/documentation/api/api/errors.types:IllegalArgumentError) * - [RuntimeError](/documentation/api/api/errors.types:RuntimeError) + * - [NonexistentResourceError](/documentation/api/api/errors.types:NonexistentResourceError) * * References to the constructor functions of these errors can be found in `DS.errors`. */ module.exports = [function () { - return { - UnhandledError: UnhandledError, - IllegalArgumentError: IllegalArgumentError, - RuntimeError: RuntimeError - }; + return { + IllegalArgumentError: IllegalArgumentError, + IA: IllegalArgumentError, + RuntimeError: RuntimeError, + R: RuntimeError, + NonexistentResourceError: NonexistentResourceError, + NER: NonexistentResourceError + }; }]; -},{}],59:[function(require,module,exports){ +},{}],60:[function(require,module,exports){ (function (window, angular, undefined) { - 'use strict'; + 'use strict'; + + /** + * @doc overview + * @id angular-data + * @name angular-data + * @description + * __Version:__ 0.10.0 + * + * ## Install + * + * #### Bower + * ```text + * bower install angular-data + * ``` + * + * Load `dist/angular-data.js` or `dist/angular-data.min.js` onto your web page after Angular.js. + * + * #### Npm + * ```text + * npm install angular-data + * ``` + * + * 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) + * section of the angular-data GitHub project. + * + * ## Load into Angular + * Your Angular app must depend on the module `"angular-data.DS"` in order to use angular-data. Loading + * angular-data into your app allows you to inject the following: + * + * - `DS` + * - `DSHttpAdapter` + * - `DSUtils` + * - `DSErrors` + * + * [DS](/documentation/api/api/DS) is the Data Store itself, which you will inject often. + * [DSHttpAdapter](/documentation/api/api/DSHttpAdapter) is useful as a wrapper for `$http` and is configurable. + * [DSUtils](/documentation/api/api/DSUtils) has some useful utility methods. + * [DSErrors](/documentation/api/api/DSErrors) provides references to the various errors thrown by the data store. + */ + angular.module('angular-data.DS', ['ng']) + .factory('DSUtils', require('./utils')) + .factory('DSErrors', require('./errors')) + .provider('DSHttpAdapter', require('./adapters/http')) + .provider('DSLocalStorageAdapter', require('./adapters/localStorage')) + .provider('DS', require('./datastore')) + .config(['$provide', function ($provide) { + $provide.decorator('$q', ['$delegate', function ($delegate) { + // do whatever you you want + $delegate.promisify = function (fn, target) { + var _this = this; + return function () { + var deferred = _this.defer(), + args = Array.prototype.slice.apply(arguments); + + args.push(function (err, result) { + if (err) { + deferred.reject(err); + } else { + deferred.resolve(result); + } + }); - /** - * @doc overview - * @id angular-data - * @name angular-data - * @description - * __Version:__ 0.9.1 - * - * ## Install - * - * #### Bower - * ```text - * bower install angular-data - * ``` - * - * Load `dist/angular-data.js` or `dist/angular-data.min.js` onto your web page after Angular.js. - * - * #### Npm - * ```text - * npm install angular-data - * ``` - * - * 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) - * section of the angular-data GitHub project. - * - * ## Load into Angular - * Your Angular app must depend on the module `"angular-data.DS"` in order to use angular-data. Loading - * angular-data into your app allows you to inject the following: - * - * - `DS` - * - `DSHttpAdapter` - * - `DSUtils` - * - `DSErrors` - * - * [DS](/documentation/api/api/DS) is the Data Store itself, which you will inject often. - * [DSHttpAdapter](/documentation/api/api/DSHttpAdapter) is useful as a wrapper for `$http` and is configurable. - * [DSUtils](/documentation/api/api/DSUtils) has some useful utility methods. - * [DSErrors](/documentation/api/api/DSErrors) provides references to the various errors thrown by the data store. - */ - angular.module('angular-data.DS', ['ng']) - .factory('DSUtils', require('./utils')) - .factory('DSErrors', require('./errors')) - .provider('DSHttpAdapter', require('./adapters/http')) - .provider('DSLocalStorageAdapter', require('./adapters/localStorage')) - .provider('DS', require('./datastore')) - .config(['$provide', function ($provide) { - $provide.decorator('$q', ['$delegate', function ($delegate) { - // do whatever you you want - $delegate.promisify = function (fn, target) { - var _this = this; - return function () { - var deferred = _this.defer(), - args = Array.prototype.slice.apply(arguments); - - args.push(function (err, result) { - if (err) { - deferred.reject(err); - } else { - deferred.resolve(result); - } - }); - - try { - fn.apply(target || this, args); - } catch (err) { - deferred.reject(err); - } - - return deferred.promise; - }; - }; - return $delegate; - }]); - }]); + try { + fn.apply(target || this, args); + } catch (err) { + deferred.reject(err); + } + + return deferred.promise; + }; + }; + return $delegate; + }]); + }]); })(window, window.angular); -},{"./adapters/http":30,"./adapters/localStorage":31,"./datastore":42,"./errors":58,"./utils":60}],60:[function(require,module,exports){ +},{"./adapters/http":30,"./adapters/localStorage":31,"./datastore":43,"./errors":59,"./utils":61}],61:[function(require,module,exports){ module.exports = [function () { - return { - isString: angular.isString, - isArray: angular.isArray, - isObject: angular.isObject, - isNumber: angular.isNumber, - isFunction: angular.isFunction, - isEmpty: require('mout/lang/isEmpty'), - toJson: angular.toJson, - makePath: require('mout/string/makePath'), - upperCase: require('mout/string/upperCase'), - deepMixIn: require('mout/object/deepMixIn'), - forOwn: require('mout/object/forOwn'), - pick: require('mout/object/pick'), - set: require('mout/object/set'), - contains: require('mout/array/contains'), - filter: require('mout/array/filter'), - toLookup: require('mout/array/toLookup'), - slice: require('mout/array/slice'), - sort: require('mout/array/sort'), - updateTimestamp: function (timestamp) { - var newTimestamp = typeof Date.now === 'function' ? Date.now() : new Date().getTime(); - if (timestamp && newTimestamp <= timestamp) { - return timestamp + 1; - } else { - return newTimestamp; - } - }, - deepFreeze: function deepFreeze(o) { - if (typeof Object.freeze === 'function') { - var prop, propKey; - Object.freeze(o); // First freeze the object. - for (propKey in o) { - prop = o[propKey]; - if (!o.hasOwnProperty(propKey) || typeof prop !== 'object' || Object.isFrozen(prop)) { - // If the object is on the prototype, not an object, or is already frozen, - // skip it. Note that this might leave an unfrozen reference somewhere in the - // object if there is an already frozen object containing an unfrozen object. - continue; - } - - deepFreeze(prop); // Recursively call deepFreeze. - } - } - }, - diffObjectFromOldObject: function (object, oldObject) { - var added = {}; - var removed = {}; - var changed = {}; - - for (var prop in oldObject) { - var newValue = object[prop]; + return { + isString: angular.isString, + isArray: angular.isArray, + isObject: angular.isObject, + isNumber: angular.isNumber, + isFunction: angular.isFunction, + isEmpty: require('mout/lang/isEmpty'), + toJson: angular.toJson, + makePath: require('mout/string/makePath'), + upperCase: require('mout/string/upperCase'), + deepMixIn: require('mout/object/deepMixIn'), + forOwn: require('mout/object/forOwn'), + pick: require('mout/object/pick'), + set: require('mout/object/set'), + contains: require('mout/array/contains'), + filter: require('mout/array/filter'), + toLookup: require('mout/array/toLookup'), + slice: require('mout/array/slice'), + sort: require('mout/array/sort'), + updateTimestamp: function (timestamp) { + var newTimestamp = typeof Date.now === 'function' ? Date.now() : new Date().getTime(); + if (timestamp && newTimestamp <= timestamp) { + return timestamp + 1; + } else { + return newTimestamp; + } + }, + deepFreeze: function deepFreeze(o) { + if (typeof Object.freeze === 'function') { + var prop, propKey; + Object.freeze(o); // First freeze the object. + for (propKey in o) { + prop = o[propKey]; + if (!o.hasOwnProperty(propKey) || typeof prop !== 'object' || Object.isFrozen(prop)) { + // If the object is on the prototype, not an object, or is already frozen, + // skip it. Note that this might leave an unfrozen reference somewhere in the + // object if there is an already frozen object containing an unfrozen object. + continue; + } + + deepFreeze(prop); // Recursively call deepFreeze. + } + } + }, + diffObjectFromOldObject: function (object, oldObject) { + var added = {}; + var removed = {}; + var changed = {}; + + for (var prop in oldObject) { + var newValue = object[prop]; + + if (newValue !== undefined && newValue === oldObject[prop]) + continue; + + if (!(prop in object)) { + removed[prop] = undefined; + continue; + } - if (newValue !== undefined && newValue === oldObject[prop]) - continue; + if (newValue !== oldObject[prop]) + changed[prop] = newValue; + } - if (!(prop in object)) { - removed[prop] = undefined; - continue; - } + for (var prop2 in object) { + if (prop2 in oldObject) + continue; - if (newValue !== oldObject[prop]) - changed[prop] = newValue; - } + added[prop2] = object[prop2]; + } - for (var prop2 in object) { - if (prop2 in oldObject) - continue; - - added[prop2] = object[prop2]; - } - - return { - added: added, - removed: removed, - changed: changed - }; - } - }; + return { + added: added, + removed: removed, + changed: changed + }; + } + }; }]; -},{"mout/array/contains":2,"mout/array/filter":3,"mout/array/slice":7,"mout/array/sort":8,"mout/array/toLookup":9,"mout/lang/isEmpty":14,"mout/object/deepMixIn":21,"mout/object/forOwn":23,"mout/object/pick":26,"mout/object/set":27,"mout/string/makePath":28,"mout/string/upperCase":29}]},{},[59]) \ No newline at end of file +},{"mout/array/contains":2,"mout/array/filter":3,"mout/array/slice":7,"mout/array/sort":8,"mout/array/toLookup":9,"mout/lang/isEmpty":14,"mout/object/deepMixIn":21,"mout/object/forOwn":23,"mout/object/pick":26,"mout/object/set":27,"mout/string/makePath":28,"mout/string/upperCase":29}]},{},[60]) \ No newline at end of file diff --git a/dist/angular-data.min.js b/dist/angular-data.min.js index 410397c..ecb5633 100644 --- a/dist/angular-data.min.js +++ b/dist/angular-data.min.js @@ -1,11 +1,11 @@ /** * @author Jason Dobry * @file angular-data.min.js -* @version 0.9.1 - Homepage +* @version 0.10.0 - Homepage * @copyright (c) 2014 Jason Dobry * @license MIT * * @overview Data store for Angular.js. */ -!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;gb&&a.check();)a.report(),b++}function e(a){for(var b in a)return!1;return!0}function f(a){return e(a.added)&&e(a.removed)&&e(a.changed)}function g(a,b){var c={},d={},e={};for(var f in b){var g=a[f];(void 0===g||g!==b[f])&&(f in a?g!==b[f]&&(e[f]=g):d[f]=void 0)}for(var f in a)f in b||(c[f]=a[f]);return Array.isArray(a)&&a.length!==b.length&&(e.length=a.length),{added:c,removed:d,changed:e}}function h(a,b){var c=b||(Array.isArray(a)?[]:{});for(var d in a)c[d]=a[d];return Array.isArray(a)&&(c.length=a.length),c}function i(a,b,c,d){if(this.closed=!1,this.object=a,this.callback=b,this.target=c,this.token=d,this.reporting=!0,n){var e=this;this.boundInternalCallback=function(a){e.internalCallback(a)}}j(this),this.connect(),this.sync(!0)}function j(a){u&&(t.push(a),i._allObserversCount++)}function k(a,b,c,d){i.call(this,a,b,c,d)}function l(a){this.arr=[],this.callback=a,this.isObserved=!0}function m(a,b,c){for(var d={},e={},f=0;fa&&b.anyChanged);i._allObserversCount=t.length,v=!1}}},u&&(a.Platform.clearObservers=function(){t=[]}),k.prototype=r({__proto__:i.prototype,connect:function(){n&&Object.observe(this.object,this.boundInternalCallback)},sync:function(){n||(this.oldObject=h(this.object))},check:function(a){var b,c;if(n){if(!a)return!1;c={},b=m(this.object,a,c)}else c=this.oldObject,b=g(this.object,this.oldObject);return f(b)?!1:(this.reportArgs=[b.added||{},b.removed||{},b.changed||{}],this.reportArgs.push(function(a){return c[a]}),!0)},disconnect:function(){n?this.object&&Object.unobserve(this.object,this.boundInternalCallback):this.oldObject=void 0}});var x=Object.getPrototypeOf({}),y=Object.getPrototypeOf([]);l.prototype={reset:function(){this.isObserved=!this.isObserved},observe:function(a){if(c(a)&&a!==x&&a!==y){var b=this.arr.indexOf(a);b>=0&&this.arr[b+1]===this.isObserved||(0>b&&(b=this.arr.length,this.arr[b]=a,Object.observe(a,this.callback)),this.arr[b+1]=this.isObserved,this.observe(Object.getPrototypeOf(a)))}},cleanup:function(){for(var a=0,b=0,c=this.isObserved;ba&&(this.arr[a]=d,this.arr[a+1]=c),a+=2):Object.unobserve(d,this.callback),b+=2}this.arr.length=a}};var z={"new":!0,updated:!0,deleted:!0};a.Observer=i,a.Observer.hasObjectObserve=n,a.ObjectObserver=k}((c.Number={isNaN:window.isNaN})?c:c)}).call(this,"undefined"!=typeof self?self:"undefined"!=typeof window?window:{})},{}],2:[function(a,b){function c(a,b){return-1!==d(a,b)}var d=a("./indexOf");b.exports=c},{"./indexOf":5}],3:[function(a,b){function c(a,b,c){b=d(b,c);var e=[];if(null==a)return e;for(var f,g=-1,h=a.length;++gc?d+c:c;d>e;){if(a[e]===b)return e;e++}return-1}b.exports=c},{}],6:[function(a,b){function c(a){return null!=a&&""!==a}function d(a,b){return b=b||"",e(a,c).join(b)}var e=a("./filter");b.exports=d},{"./filter":3}],7:[function(a,b){function c(a,b,c){var d=a.length;b=null==b?0:0>b?Math.max(d+b,0):Math.min(b,d),c=null==c?d:0>c?Math.max(d+c,0):Math.min(c,d);for(var e=[];c>b;)e.push(a[b++]);return e}b.exports=c},{}],8:[function(a,b){function c(a,b){if(null==a)return[];if(a.length<2)return a;null==b&&(b=d);var f,g,h;return f=~~(a.length/2),g=c(a.slice(0,f),b),h=c(a.slice(f,a.length),b),e(g,h,b)}function d(a,b){return b>a?-1:a>b?1:0}function e(a,b,c){for(var d=[];a.length&&b.length;)d.push(c(a[0],b[0])<=0?a.shift():b.shift());return a.length&&d.push.apply(d,a),b.length&&d.push.apply(d,b),d}b.exports=c},{}],9:[function(a,b){function c(a,b){var c={};if(null==a)return c;var e,f=-1,g=a.length;if(d(b))for(;++f"in a?d=d&&c[b]>a[">"]:">="in a?d=d&&c[b]>=a[">="]:"<"in a?d=d&&c[b]e?-1:e>d?1:0:e>d?-1:d>e?1:0})}}return this.utils.isNumber(b.query.limit)&&this.utils.isNumber(b.query.skip)?i=this.utils.slice(i,b.query.skip,Math.min(i.length,b.query.skip+b.query.limit)):this.utils.isNumber(b.query.limit)?i=this.utils.slice(i,0,Math.min(i.length,b.query.limit)):this.utils.isNumber(b.query.skip)&&(i=b.query.skip=b?a+1:b},deepFreeze:function b(a){if("function"==typeof Object.freeze){var c,d;Object.freeze(a);for(d in a)c=a[d],a.hasOwnProperty(d)&&"object"==typeof c&&!Object.isFrozen(c)&&b(c)}},diffObjectFromOldObject:function(a,b){var c={},d={},e={};for(var f in b){var g=a[f];(void 0===g||g!==b[f])&&(f in a?g!==b[f]&&(e[f]=g):d[f]=void 0)}for(var h in a)h in b||(c[h]=a[h]);return{added:c,removed:d,changed:e}}}}]},{"mout/array/contains":2,"mout/array/filter":3,"mout/array/slice":7,"mout/array/sort":8,"mout/array/toLookup":9,"mout/lang/isEmpty":14,"mout/object/deepMixIn":21,"mout/object/forOwn":23,"mout/object/pick":26,"mout/object/set":27,"mout/string/makePath":28,"mout/string/upperCase":29}]},{},[59]); \ No newline at end of file +!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;gb&&a.check();)a.report(),b++}function e(a){for(var b in a)return!1;return!0}function f(a){return e(a.added)&&e(a.removed)&&e(a.changed)}function g(a,b){var c={},d={},e={};for(var f in b){var g=a[f];(void 0===g||g!==b[f])&&(f in a?g!==b[f]&&(e[f]=g):d[f]=void 0)}for(var f in a)f in b||(c[f]=a[f]);return Array.isArray(a)&&a.length!==b.length&&(e.length=a.length),{added:c,removed:d,changed:e}}function h(a,b){var c=b||(Array.isArray(a)?[]:{});for(var d in a)c[d]=a[d];return Array.isArray(a)&&(c.length=a.length),c}function i(a,b,c,d){if(this.closed=!1,this.object=a,this.callback=b,this.target=c,this.token=d,this.reporting=!0,n){var e=this;this.boundInternalCallback=function(a){e.internalCallback(a)}}j(this),this.connect(),this.sync(!0)}function j(a){u&&(t.push(a),i._allObserversCount++)}function k(a,b,c,d){i.call(this,a,b,c,d)}function l(a){this.arr=[],this.callback=a,this.isObserved=!0}function m(a,b,c){for(var d={},e={},f=0;fa&&b.anyChanged);i._allObserversCount=t.length,v=!1}}},u&&(a.Platform.clearObservers=function(){t=[]}),k.prototype=r({__proto__:i.prototype,connect:function(){n&&Object.observe(this.object,this.boundInternalCallback)},sync:function(){n||(this.oldObject=h(this.object))},check:function(a){var b,c;if(n){if(!a)return!1;c={},b=m(this.object,a,c)}else c=this.oldObject,b=g(this.object,this.oldObject);return f(b)?!1:(this.reportArgs=[b.added||{},b.removed||{},b.changed||{}],this.reportArgs.push(function(a){return c[a]}),!0)},disconnect:function(){n?this.object&&Object.unobserve(this.object,this.boundInternalCallback):this.oldObject=void 0}});var x=Object.getPrototypeOf({}),y=Object.getPrototypeOf([]);l.prototype={reset:function(){this.isObserved=!this.isObserved},observe:function(a){if(c(a)&&a!==x&&a!==y){var b=this.arr.indexOf(a);b>=0&&this.arr[b+1]===this.isObserved||(0>b&&(b=this.arr.length,this.arr[b]=a,Object.observe(a,this.callback)),this.arr[b+1]=this.isObserved,this.observe(Object.getPrototypeOf(a)))}},cleanup:function(){for(var a=0,b=0,c=this.isObserved;ba&&(this.arr[a]=d,this.arr[a+1]=c),a+=2):Object.unobserve(d,this.callback),b+=2}this.arr.length=a}};var z={"new":!0,updated:!0,deleted:!0};a.Observer=i,a.Observer.hasObjectObserve=n,a.ObjectObserver=k}((c.Number={isNaN:window.isNaN})?c:c)}).call(this,"undefined"!=typeof self?self:"undefined"!=typeof window?window:{})},{}],2:[function(a,b){function c(a,b){return-1!==d(a,b)}var d=a("./indexOf");b.exports=c},{"./indexOf":5}],3:[function(a,b){function c(a,b,c){b=d(b,c);var e=[];if(null==a)return e;for(var f,g=-1,h=a.length;++gc?d+c:c;d>e;){if(a[e]===b)return e;e++}return-1}b.exports=c},{}],6:[function(a,b){function c(a){return null!=a&&""!==a}function d(a,b){return b=b||"",e(a,c).join(b)}var e=a("./filter");b.exports=d},{"./filter":3}],7:[function(a,b){function c(a,b,c){var d=a.length;b=null==b?0:0>b?Math.max(d+b,0):Math.min(b,d),c=null==c?d:0>c?Math.max(d+c,0):Math.min(c,d);for(var e=[];c>b;)e.push(a[b++]);return e}b.exports=c},{}],8:[function(a,b){function c(a,b){if(null==a)return[];if(a.length<2)return a;null==b&&(b=d);var f,g,h;return f=~~(a.length/2),g=c(a.slice(0,f),b),h=c(a.slice(f,a.length),b),e(g,h,b)}function d(a,b){return b>a?-1:a>b?1:0}function e(a,b,c){for(var d=[];a.length&&b.length;)d.push(c(a[0],b[0])<=0?a.shift():b.shift());return a.length&&d.push.apply(d,a),b.length&&d.push.apply(d,b),d}b.exports=c},{}],9:[function(a,b){function c(a,b){var c={};if(null==a)return c;var e,f=-1,g=a.length;if(d(b))for(;++f"===g?c=b?a[f]>d:c&&a[f]>d:">="===g?c=b?a[f]>=d:c&&a[f]>=d:"<"===g?c=b?a[f]"===g?c=b?a[f]>d:c||a[f]>d:"|>="===g?c=b?a[f]>=d:c||a[f]>=d:"|<"===g?c=b?a[f]f?-1:f>d?1:0:f>d?-1:d>f?1:0})});var j=angular.isNumber(c.limit)?c.limit:null,k=null;return angular.isNumber(c.skip)?k=c.skip:angular.isNumber(c.offset)&&(k=c.offset),j&&k?f=this.utils.slice(f,k,Math.min(f.length,k+j)):this.utils.isNumber(j)?f=this.utils.slice(f,0,Math.min(f.length,j)):this.utils.isNumber(k)&&(f=k=b?a+1:b},deepFreeze:function b(a){if("function"==typeof Object.freeze){var c,d;Object.freeze(a);for(d in a)c=a[d],a.hasOwnProperty(d)&&"object"==typeof c&&!Object.isFrozen(c)&&b(c)}},diffObjectFromOldObject:function(a,b){var c={},d={},e={};for(var f in b){var g=a[f];(void 0===g||g!==b[f])&&(f in a?g!==b[f]&&(e[f]=g):d[f]=void 0)}for(var h in a)h in b||(c[h]=a[h]);return{added:c,removed:d,changed:e}}}}]},{"mout/array/contains":2,"mout/array/filter":3,"mout/array/slice":7,"mout/array/sort":8,"mout/array/toLookup":9,"mout/lang/isEmpty":14,"mout/object/deepMixIn":21,"mout/object/forOwn":23,"mout/object/pick":26,"mout/object/set":27,"mout/string/makePath":28,"mout/string/upperCase":29}]},{},[60]); \ No newline at end of file diff --git a/guide/angular-cache/basics.doc b/guide/angular-cache/basics.md similarity index 100% rename from guide/angular-cache/basics.doc rename to guide/angular-cache/basics.md diff --git a/guide/angular-cache/configure.doc b/guide/angular-cache/configure.md similarity index 100% rename from guide/angular-cache/configure.doc rename to guide/angular-cache/configure.md diff --git a/guide/angular-cache/http.doc b/guide/angular-cache/http.md similarity index 100% rename from guide/angular-cache/http.doc rename to guide/angular-cache/http.md diff --git a/guide/angular-cache/index.doc b/guide/angular-cache/index.md similarity index 100% rename from guide/angular-cache/index.doc rename to guide/angular-cache/index.md diff --git a/guide/angular-cache/storage.doc b/guide/angular-cache/storage.md similarity index 100% rename from guide/angular-cache/storage.doc rename to guide/angular-cache/storage.md diff --git a/guide/angular-data-mocks/index.doc b/guide/angular-data-mocks/index.md similarity index 100% rename from guide/angular-data-mocks/index.doc rename to guide/angular-data-mocks/index.md diff --git a/guide/angular-data-mocks/overview.doc b/guide/angular-data-mocks/overview.md similarity index 100% rename from guide/angular-data-mocks/overview.doc rename to guide/angular-data-mocks/overview.md diff --git a/guide/angular-data-mocks/setup.doc b/guide/angular-data-mocks/setup.md similarity index 100% rename from guide/angular-data-mocks/setup.doc rename to guide/angular-data-mocks/setup.md diff --git a/guide/angular-data-mocks/testing.doc b/guide/angular-data-mocks/testing.md similarity index 100% rename from guide/angular-data-mocks/testing.doc rename to guide/angular-data-mocks/testing.md diff --git a/guide/angular-data/adapters.doc b/guide/angular-data/adapters.md similarity index 100% rename from guide/angular-data/adapters.doc rename to guide/angular-data/adapters.md diff --git a/guide/angular-data/asynchronous.doc b/guide/angular-data/asynchronous.md similarity index 100% rename from guide/angular-data/asynchronous.doc rename to guide/angular-data/asynchronous.md diff --git a/guide/angular-data/how.doc b/guide/angular-data/how.md similarity index 100% rename from guide/angular-data/how.doc rename to guide/angular-data/how.md diff --git a/guide/angular-data/index.doc b/guide/angular-data/index.md similarity index 100% rename from guide/angular-data/index.doc rename to guide/angular-data/index.md diff --git a/guide/angular-data/overview.doc b/guide/angular-data/overview.md similarity index 72% rename from guide/angular-data/overview.doc rename to guide/angular-data/overview.md index eac9149..f715426 100644 --- a/guide/angular-data/overview.doc +++ b/guide/angular-data/overview.md @@ -14,38 +14,36 @@ Angular-data is an in-browser data store for [Angular.js](http://angularjs.org). ## Example: ```js angular.module('myApp', ['angular-data.DS']) - .config(function (DSProvider) { - DSProvider.defaults.baseUrl = '/api'; - }) - .run(function (DS) { - DS.defineResource({ - name: 'post', - endpoint: 'posts', - idAttribute: '_id' - }); - }) - .controller('PostCtrl', function ($scope, DS) { - var params = { - query: { - where: { - author: { - '==': 'John Anderson' - } - } - } - }; + .config(function (DSProvider) { + DSProvider.defaults.baseUrl = '/api'; + }) + .run(function (DS) { + DS.defineResource({ + name: 'post', + endpoint: 'posts', + idAttribute: '_id' + }); + }) + .controller('PostCtrl', function ($scope, DS) { + var params = { + where: { + author: { + '==': 'John Anderson' + } + } + }; - DS.findAll('post', params); + DS.findAll('post', params); - DS.bindAll($scope', 'posts', 'post', params); + DS.bindAll($scope', 'posts', 'post', params); - // Verbose way of doing the bindAll() above, but gives more control - $scope.$watch(function () { - return DS.lastModified('post'); - }, function () { - $scope.posts = DS.filter('post', query); - }); - }); + // Verbose way of doing the bindAll() above, but gives more control + $scope.$watch(function () { + return DS.lastModified('post'); + }, function () { + $scope.posts = DS.filter('post', params); + }); + }); ``` Angular-data does not decorate your data in any way–your data maintains the pure POJO representation common to Angular diff --git a/guide/angular-data/queries.doc b/guide/angular-data/queries.doc deleted file mode 100644 index 420e8b0..0000000 --- a/guide/angular-data/queries.doc +++ /dev/null @@ -1,130 +0,0 @@ -@doc overview -@id queries -@name Queries and Filtering -@description - -Items injected into the data store are indexed by their primary key, but they're also stored in collections. - -`DS.findAll()` is used to asynchronously query a persistence layer for a collection of items. `DS.filter()` is used to -synchronously query the items already in the data store. Here are some examples: - -Translates into a `GET` request to `/post`: -```js -DS.findAll('post', {}).then(function (posts) { - posts; // [ { ... }, { ... }, ... , { ... } ] - - DS.filter('post', {}); // returns all posts in the data store -}).catch(function (err) { - err; // reason why query failed -}); -``` - -Translates into a `GET` request to `/post?query={"where":{"author":{"==":"John Anderson"}}}'` (url encoded of course): -```js -var params = { - query: { - where: { - author: { - '==': 'John Anderson' - } - } - } -}; - -DS.findAll('post', params).then(function (posts) { - posts; // [ { ... }, { ... }, ... , { ... } ] - - DS.filter('post', params); // filters the posts already in the data store -}).catch(function (err) { - err; // reason why query failed -}); -``` - -Angular-data has a "query" language that it natively understands. To sync up how your API and the data store query -collections you will need to do one of the following: - -##### Option A -Configure your API to understand angular-data's query syntax, translating the query object into the appropriate database query. - -##### Option B -Replace Angular-data's filter with your own filter that works the same way your API already works. - -Here's is angular-data's filter (it's pretty simple): - -```js -function (resourceName, where, attrs) { - var keep = true; - utils.forOwn(where, function (clause, field) { - if (utils.isString(clause)) { - clause = { - '===': clause - }; - } else if (utils.isNumber(clause)) { - clause = { - '==': clause - }; - } - if ('==' in clause) { - keep = keep && (attrs[field] == clause['==']); - } else if ('===' in clause) { - keep = keep && (attrs[field] === clause['===']); - } else if ('!=' in clause) { - keep = keep && (attrs[field] != clause['!=']); - } else if ('>' in clause) { - keep = keep && (attrs[field] > clause['>']); - } else if ('>=' in clause) { - keep = keep && (attrs[field] >= clause['>=']); - } else if ('<' in clause) { - keep = keep && (attrs[field] < clause['<']); - } else if ('<=' in clause) { - keep = keep && (attrs[field] <= clause['<=']); - } else if ('in' in clause) { - keep = keep && utils.contains(clause['in'], attrs[field]); - } - }); - return keep; -} -``` - -If the following `params` argument is passed to `DS.filter`: - -```js -var params = { - query: { - where: { - author: { - '==': 'John Anderson' - } - } - } -}; - -DS.filter('post', params); -``` - -Then `DS.filter` will return the posts (already in the data store) where `post.author == 'John Anderson'` is true. - -Here's how to replace Angular-data's filter: - -```js -DSProvider.defaults.filter = function (resourceName, where, attrs) { - // custom filter - // this will be called on every item in the collection - // return true to keep `attrs` in the result set - // return false to exclude `attrs` from the result set -}); -``` - -You can even override the filter per-resource: - -```js -DS.defineResource({ - name: 'post', - filter: function (resourceName, where, attrs) { - // custom filter for posts - // this will be called on every item in the collection - // return true to keep `attrs` in the result set - // return false to exclude `attrs` from the result set - } -}); -``` diff --git a/guide/angular-data/queries.md b/guide/angular-data/queries.md new file mode 100644 index 0000000..ea7fc97 --- /dev/null +++ b/guide/angular-data/queries.md @@ -0,0 +1,256 @@ +@doc overview +@id queries +@name Queries and Filtering +@description + +Items injected into the data store are indexed by their primary key, but they're also stored in collections. + +`DS.findAll()` is used to asynchronously query a persistence layer for a collection of items. `DS.filter()` is used to +synchronously query the items already in the data store. Here are some examples: + +Translates into a `GET` request to `/post`: +```js +DS.findAll('post', {}).then(function (posts) { + posts; // [ { ... }, { ... }, ... , { ... } ] + + DS.filter('post', {}); // returns all posts in the data store +}).catch(function (err) { + err; // reason why query failed +}); +``` + +Translates into a `GET` request to `/post?where={"author":{"==":"John Anderson"}}'` (url encoded of course): +```js +var params = { + where: { + author: { + '==': 'John Anderson' + } + } +}; + +DS.findAll('post', params).then(function (posts) { + posts; // [ { ... }, { ... }, ... , { ... } ] + + DS.filter('post', params); // filters the posts already in the data store +}).catch(function (err) { + err; // reason why query failed +}); +``` + +Angular-data has a "query" language that it natively understands. To sync up how your API and the data store query +collections you will need to do one of the following: + +##### Option A +Configure your API to understand angular-data's query syntax, translating the query object into the appropriate database query. + +##### Option B +Replace Angular-data's filter with your own filter that works the same way your API already works. + +If the following `params` argument is passed to `DS.filter`: + +```js +var params = { + where: { + author: { + '==': 'John Anderson' + } + } +}; + +DS.filter('post', params); +``` + +Then `DS.filter` will return the posts (already in the data store) where `post.author == 'John Anderson'`. + +Here's how to replace Angular-data's filter: + +```js +// override how DS.filter handles the "where", "skip", "limit" and "orderBy" clauses +DSProvider.defaults.filter = function (collection, resourceName, params, options) { + // examine params and + // decide whether to exclude items, skip items, start from an offset, or sort the items + + // see the [default implementation that ships with angular-data](https://github.com/jmdobry/angular-data/blob/master/src/datastore/index.js#L12) + // overriding this method is useful when our server only understands a certain + // params format and you want angular-data's filter to behave the same as your server + + // angular-data looks for the following fields: + // - where + // - skip (or offset) + // - limit + // - orderBy (or sort) + + // return the filtered collection +}; +``` + +You can even override the filter per-resource: + +```js +DS.defineResource({ + name: 'post', + filter: function (collection, resourceName, params, options) { + // … + } +}); +``` + +#### angular-data's default filter + +Params definition: +```js +{ + where: { + : { + : , + : , + : + }, + : { + : , + : , + : + }, + : { + : , + : , + : + } + }, + skip: , + offset: , // same as offset + limit: , + orderBy: , + sort: // same as orderBy +} +``` + +##### where +Where can be any top-level field on the item being filtered and is one of the operators angular-data's default filter understands. + +__Operators__: + +These get ANDed into the final result: +- `==` +- `===` +- `!=` +- `!==` +- `>` +- `>=` +- `<` +- `<=` +- `in` + +These get ORed into the final result: +- `|==` +- `|===` +- `|!=` +- `|!==` +- `|>` +- `|>=` +- `|<` +- `|<=` +- `|in` + +##### skip or offset +Should be a number + +##### limit +Should be a number + +##### orderBy or sort +Should be an array of arrays. + +#### Examples: + +```js +DS.filter('post', { + where: { + author: { + '==': 'John Anderson' + } + }, + skip: 20, + limit: 100 +}); +``` + +```js +DS.filter('post', { + orderBy: [ + ['author', 'DESC'], + ['created_date', 'DESC'] + ] +}); +``` + +```js +DS.filter('post', { + where: { + author: { + 'in': ['John', 'Sally'] + } + } +}); +``` + +`age` is greater than or equal to 15 AND less than or equal to 30. +```js +DS.filter('user', { + where: { + age: { + '>=': 15, + '<=': 30 + } + } +}); +``` + +`age` is less than 15 OR greater than 30. +```js +DS.filter('post', { + where: { + age: { + '|<': 15, + '|>': 30 + } + } +}); +``` + +#### Shortcuts + +These are equivalent: +```js +DS.filter('post', { + author: 'John' +}); +DS.filter('post', { + where: { + author: 'John' + } +}); +DS.filter('post', { + where: { + author: { + 'in': ['John', 'Sally'] + } + } +}); +``` + +These are equivalent: +```js +DS.filter('post', { + orderBy: 'age' +}); +DS.filter('post', { + orderBy: ['age', 'ASC'] +}); +DS.filter('post', { + orderBy: [ + ['age', 'ASC'] + ] +}); +``` diff --git a/guide/angular-data/resource/resource.doc b/guide/angular-data/resource/resource.md similarity index 57% rename from guide/angular-data/resource/resource.doc rename to guide/angular-data/resource/resource.md index 433f4f8..3ec2596 100644 --- a/guide/angular-data/resource/resource.doc +++ b/guide/angular-data/resource/resource.md @@ -211,3 +211,237 @@ user.fullName(); // "John Anderson" user.constructor; // function User() { ... } ``` + +@doc overview +@id relations +@name Defining Relations +@description + +Angular-data supports relations to some extent. If `GET /user/10` returns: + +```js +{ + id: 10, + name: 'John Anderson', + profile: { + email: 'John Anderson', + id: 18, + userId: 10 + } +} +``` + +then only the user object is injected into the store. If you've defined the `hasOne` relationship of users to profiles, +not only will the user be injected into the store, but the profile as well. Example: + +Without defining relations: +```js +var userJson = { + id: 10, + name: 'John Anderson', + profile: { + email: 'John Anderson', + id: 18, + userId: 10 + } +}; + +DS.inject('user', userJson); + +assert.deepEqual(DS.get('user', 10), userJson); +assert.isUndefined(DS.get('profile', 18)); +``` + +With relations defined: +```js +var userJson = { + id: 10, + name: 'John Anderson', + profile: { + email: 'John Anderson', + id: 18, + userId: 10 + } +}; + +DS.inject('user', userJson); + +assert.deepEqual(DS.get('user', 10), userJson); +assert.deepEqual(DS.get('profile', 18), userJson.profile); +assert.deepEqual(DS.get('profile', 18), DS.get('user', 10).profile); +``` + +## Defining relations: +```js +DS.defineResource({ + name: 'user', + relations: { + hasMany: { + comment: { + localField: 'comments', + foreignKey: 'userId' + } + }, + hasOne: { + profile: { + localField: 'profile', + foreignKey: 'userId' + } + }, + belongsTo: { + organization: { + localKey: 'organizationId', + localField: 'organization' + } + } + } +}); + +DS.defineResource({ + name: 'organization', + relations: { + hasMany: { + user: { + localField: 'users', + foreignKey: 'organizationId' + } + } + } +}); + +DS.defineResource({ + name: 'profile', + relations: { + belongsTo: { + user: { + localField: 'user', + localKey: 'userId' + } + } + } +}); + +DS.defineResource({ + name: 'comment', + relations: { + belongsTo: { + user: { + localField: 'user', + localKey: 'userId' + } + } + } +}); +``` + +`DS.inject` can be called by you, and is also used internally by `find`, `findAll`, `create`, `update`, `updateAll`, `save` and `refresh`. + +## Loading relations + +#### Lazy +```js +DS.find('user', 10).then(function (user) { + // let's assume the server only returned the user + user.comments; // undefined + user.profile; // undefined + + DS.loadRelations('user', user, ['comment', 'profile']).then(function (user) { + user.comments; // array + user.profile; // object + }); +}); +``` + +#### Direct (requires server-side support) + +When you call `DS.find` you can pass `params` to the http adapter like so: +```js +DS.find('user', 10, { + // will be serialized to the query string + params: {...} +}); +``` + +For `findAll` it works like this: +```js +var params = {...}; // will be serialized to the query string +DS.findAll('user', params); +``` + +You could, for example, configure your server to look for a query string parameter called `with` or something, which tells +the server which relations to include with the response, for example: + +```js +DS.find('user', 10, { + params: { + with: ['comment', 'organization'] + } +}); +``` + +With default settings (and using the http adapter) this will produce `GET /user/10with=comment&with=organization`. + +You can configure your server to also return the `comment` and `organization` relations in the response: + +```js +{ + id: 10, + name: 'John Anderson', + organizationId: 15, + comments: [...], + organization: {...} +} +``` + +If you've told angular-data about the relations, then the comments and organization will be injected into the data store in addition to the user. + +@doc overview +@id computed +@name Computed Properties +@description + +Angular-data supports computed properties. When you define a computed property you also define the fields that it depends on. +The computed property will only be updated when one of those fields changes. + +## Example +```js +DS.defineResource('user', { + computed: { + // each function's argument list defines the fields + // that the computed property depends on + fullName: function (first, last) { + return first + ' ' + last; + } + } +}); + +var user = DS.inject('user', { + id: 1, + first: 'John', + last: 'Anderson' +}); + +user.fullName; // "John Anderson" + +user.first = 'Fred'; + +// angular-data relies on dirty-checking, so the +// computed property hasn't been updated yet +user.fullName; // "John Anderson" + +DS.digest(); + +user.fullName; // "Fred Anderson" + +user.first = 'George'; + +$timeout(function () { + user.fullName; // "George Anderson" +}); + +user.first = 'William'; + +$scope.$apply(function () { + user.fullName; // "William Anderson" +}); +``` diff --git a/guide/angular-data/resources.doc b/guide/angular-data/resources.md similarity index 100% rename from guide/angular-data/resources.doc rename to guide/angular-data/resources.md diff --git a/guide/angular-data/synchronous.doc b/guide/angular-data/synchronous.md similarity index 100% rename from guide/angular-data/synchronous.doc rename to guide/angular-data/synchronous.md diff --git a/guide/api/api.doc b/guide/api/api.md similarity index 100% rename from guide/api/api.doc rename to guide/api/api.md diff --git a/guide/nav.html b/guide/nav.html index 2593d85..f4fc5d3 100644 --- a/guide/nav.html +++ b/guide/nav.html @@ -72,7 +72,7 @@ API
    -
  • Angular-data - 0.9.1
    • +
  • Angular-data - 0.10.0
  • Overview
    • @@ -94,7 +94,7 @@ DSHttpAdapter
  • -
  • Angular-cache - 3.0.1
    • +
  • Angular-cache - 3.0.3
  • Overview
    • diff --git a/karma.start.js b/karma.start.js index ff186a7..fed372f 100644 --- a/karma.start.js +++ b/karma.start.js @@ -1,155 +1,325 @@ // Setup global test variables -var $rootScope, $q, $log, DSHttpAdapterProvider, DSProvider, DSLocalStorageAdapter, DS, DSUtils, DSHttpAdapter, app, $httpBackend, p1, p2, p3, p4, p5; +var $rootScope, $q, $log, $timeout, DSHttpAdapterProvider, DSProvider, DSLocalStorageAdapter, DS, DSUtils, DSHttpAdapter, app, $httpBackend, p1, p2, p3, p4, p5; + +var user1, organization2, comment3, profile4; +var comment11, comment12, comment13, organization14, profile15, user10, user16, user17, user18, organization15, user20, comment19, user22, profile21; var lifecycle = {}; // Helper globals var fail = function (msg) { - assert.equal('should not reach this!: ' + msg, 'failure'); - }, - TYPES_EXCEPT_STRING = [123, 123.123, null, undefined, {}, [], true, false, function () { - }], - TYPES_EXCEPT_STRING_OR_ARRAY = [123, 123.123, null, undefined, {}, true, false, function () { - }], - TYPES_EXCEPT_STRING_OR_OBJECT = [123, 123.123, null, undefined, [], true, false, function () { - }], - TYPES_EXCEPT_ARRAY = ['string', 123, 123.123, null, undefined, {}, true, false, function () { - }], - TYPES_EXCEPT_STRING_OR_NUMBER = [null, undefined, {}, [], true, false, function () { - }], - TYPES_EXCEPT_STRING_OR_ARRAY_OR_NUMBER = [null, undefined, {}, true, false, function () { - }], - TYPES_EXCEPT_NUMBER = ['string', null, undefined, {}, [], true, false, function () { - }], - TYPES_EXCEPT_OBJECT = ['string', 123, 123.123, null, undefined, true, false, function () { - }], - TYPES_EXCEPT_BOOLEAN = ['string', 123, 123.123, null, undefined, {}, [], function () { - }], - TYPES_EXCEPT_FUNCTION = ['string', 123, 123.123, null, undefined, {}, [], true, false]; + if (msg instanceof Error) { + console.log(msg.stack); + } else { + assert.equal('should not reach this!: ' + msg, 'failure'); + } + }, + TYPES_EXCEPT_STRING = [123, 123.123, null, undefined, {}, [], true, false, function () { + }], + TYPES_EXCEPT_STRING_OR_ARRAY = [123, 123.123, null, undefined, {}, true, false, function () { + }], + TYPES_EXCEPT_STRING_OR_OBJECT = [123, 123.123, null, undefined, [], true, false, function () { + }], + TYPES_EXCEPT_STRING_OR_NUMBER_OBJECT = [null, undefined, [], true, false, function () { + }], + TYPES_EXCEPT_ARRAY = ['string', 123, 123.123, null, undefined, {}, true, false, function () { + }], + TYPES_EXCEPT_STRING_OR_NUMBER = [null, undefined, {}, [], true, false, function () { + }], + TYPES_EXCEPT_STRING_OR_ARRAY_OR_NUMBER = [null, undefined, {}, true, false, function () { + }], + TYPES_EXCEPT_NUMBER = ['string', null, undefined, {}, [], true, false, function () { + }], + TYPES_EXCEPT_OBJECT = ['string', 123, 123.123, null, undefined, true, false, function () { + }], + TYPES_EXCEPT_BOOLEAN = ['string', 123, 123.123, null, undefined, {}, [], function () { + }], + TYPES_EXCEPT_FUNCTION = ['string', 123, 123.123, null, undefined, {}, [], true, false]; angular.module('app', ['ng', 'angular-data.DS']); // Setup before each test beforeEach(function () { - lifecycle.beforeValidate = function (resourceName, attrs, cb) { - lifecycle.beforeValidate.callCount += 1; - cb(null, attrs); - }; - lifecycle.validate = function (resourceName, attrs, cb) { - lifecycle.validate.callCount += 1; - cb(null, attrs); - }; - lifecycle.afterValidate = function (resourceName, attrs, cb) { - lifecycle.afterValidate.callCount += 1; - cb(null, attrs); - }; - lifecycle.beforeCreate = function (resourceName, attrs, cb) { - lifecycle.beforeCreate.callCount += 1; - cb(null, attrs); - }; - lifecycle.afterCreate = function (resourceName, attrs, cb) { - lifecycle.afterCreate.callCount += 1; - cb(null, attrs); - }; - lifecycle.beforeUpdate = function (resourceName, attrs, cb) { - lifecycle.beforeUpdate.callCount += 1; - cb(null, attrs); - }; - lifecycle.afterUpdate = function (resourceName, attrs, cb) { - lifecycle.afterUpdate.callCount += 1; - cb(null, attrs); - }; - lifecycle.beforeDestroy = function (resourceName, attrs, cb) { - lifecycle.beforeDestroy.callCount += 1; - cb(null, attrs); - }; - lifecycle.afterDestroy = function (resourceName, attrs, cb) { - lifecycle.afterDestroy.callCount += 1; - cb(null, attrs); - }; - lifecycle.beforeInject = function () { - lifecycle.beforeInject.callCount += 1; - }; - lifecycle.afterInject = function () { - lifecycle.afterInject.callCount += 1; - }; - lifecycle.serialize = function (resourceName, data) { - lifecycle.serialize.callCount += 1; - return data; - }; - lifecycle.deserialize = function (resourceName, data) { - lifecycle.deserialize.callCount += 1; - return data.data; - }; - lifecycle.queryTransform = function (resourceName, query) { - lifecycle.queryTransform.callCount += 1; - return query; - }; - module('app', function (_DSProvider_, _DSHttpAdapterProvider_) { - DSProvider = _DSProvider_; - DSProvider.defaults.baseUrl = 'http://test.angular-cache.com'; - DSProvider.defaults.beforeValidate = lifecycle.beforeValidate; - DSProvider.defaults.validate = lifecycle.validate; - DSProvider.defaults.afterValidate = lifecycle.afterValidate; - DSProvider.defaults.beforeCreate = lifecycle.beforeCreate; - DSProvider.defaults.afterCreate = lifecycle.afterCreate; - DSProvider.defaults.beforeUpdate = lifecycle.beforeUpdate; - DSProvider.defaults.afterUpdate = lifecycle.afterUpdate; - DSProvider.defaults.beforeDestroy = lifecycle.beforeDestroy; - DSProvider.defaults.afterDestroy = lifecycle.afterDestroy; - DSProvider.defaults.beforeInject = lifecycle.beforeInject; - DSProvider.defaults.afterInject = lifecycle.afterInject; - DSProvider.defaults.serialize = lifecycle.serialize; - DSProvider.defaults.deserialize = lifecycle.deserialize; - DSHttpAdapterProvider = _DSHttpAdapterProvider_; - DSHttpAdapterProvider.defaults.queryTransform = lifecycle.queryTransform; - }); + lifecycle.beforeValidate = function (resourceName, attrs, cb) { + lifecycle.beforeValidate.callCount += 1; + cb(null, attrs); + }; + lifecycle.validate = function (resourceName, attrs, cb) { + lifecycle.validate.callCount += 1; + cb(null, attrs); + }; + lifecycle.afterValidate = function (resourceName, attrs, cb) { + lifecycle.afterValidate.callCount += 1; + cb(null, attrs); + }; + lifecycle.beforeCreate = function (resourceName, attrs, cb) { + lifecycle.beforeCreate.callCount += 1; + cb(null, attrs); + }; + lifecycle.afterCreate = function (resourceName, attrs, cb) { + lifecycle.afterCreate.callCount += 1; + cb(null, attrs); + }; + lifecycle.beforeUpdate = function (resourceName, attrs, cb) { + lifecycle.beforeUpdate.callCount += 1; + cb(null, attrs); + }; + lifecycle.afterUpdate = function (resourceName, attrs, cb) { + lifecycle.afterUpdate.callCount += 1; + cb(null, attrs); + }; + lifecycle.beforeDestroy = function (resourceName, attrs, cb) { + lifecycle.beforeDestroy.callCount += 1; + cb(null, attrs); + }; + lifecycle.afterDestroy = function (resourceName, attrs, cb) { + lifecycle.afterDestroy.callCount += 1; + cb(null, attrs); + }; + lifecycle.beforeInject = function () { + lifecycle.beforeInject.callCount += 1; + }; + lifecycle.afterInject = function () { + lifecycle.afterInject.callCount += 1; + }; + lifecycle.serialize = function (resourceName, data) { + lifecycle.serialize.callCount += 1; + return data; + }; + lifecycle.deserialize = function (resourceName, data) { + lifecycle.deserialize.callCount += 1; + return data.data; + }; + lifecycle.queryTransform = function (resourceName, query) { + lifecycle.queryTransform.callCount += 1; + return query; + }; + module('app', function (_DSProvider_, _DSHttpAdapterProvider_) { + DSProvider = _DSProvider_; + DSProvider.defaults.baseUrl = 'http://test.angular-cache.com'; + DSProvider.defaults.beforeValidate = lifecycle.beforeValidate; + DSProvider.defaults.validate = lifecycle.validate; + DSProvider.defaults.afterValidate = lifecycle.afterValidate; + DSProvider.defaults.beforeCreate = lifecycle.beforeCreate; + DSProvider.defaults.afterCreate = lifecycle.afterCreate; + DSProvider.defaults.beforeUpdate = lifecycle.beforeUpdate; + DSProvider.defaults.afterUpdate = lifecycle.afterUpdate; + DSProvider.defaults.beforeDestroy = lifecycle.beforeDestroy; + DSProvider.defaults.afterDestroy = lifecycle.afterDestroy; + DSProvider.defaults.beforeInject = lifecycle.beforeInject; + DSProvider.defaults.afterInject = lifecycle.afterInject; + DSProvider.defaults.serialize = lifecycle.serialize; + DSProvider.defaults.deserialize = lifecycle.deserialize; + DSHttpAdapterProvider = _DSHttpAdapterProvider_; + DSHttpAdapterProvider.defaults.queryTransform = lifecycle.queryTransform; + }); }); function startInjector() { - inject(function (_$rootScope_, _$q_, _$httpBackend_, _DS_, _$log_, _DSUtils_, _DSHttpAdapter_, _DSLocalStorageAdapter_) { - // Setup global mocks + inject(function (_$rootScope_, _$q_, _$timeout_, _$httpBackend_, _DS_, _$log_, _DSUtils_, _DSHttpAdapter_, _DSLocalStorageAdapter_) { + // Setup global mocks + + localStorage.clear(); + $q = _$q_; + $rootScope = _$rootScope_; + DS = _DS_; + $timeout = _$timeout_; + DSUtils = _DSUtils_; + DSHttpAdapter = _DSHttpAdapter_; + DSLocalStorageAdapter = _DSLocalStorageAdapter_; + $httpBackend = _$httpBackend_; + DS.defineResource({ + name: 'post', + endpoint: '/posts' + }); + DS.defineResource({ + name: 'user', + relations: { + hasMany: { + comment: { + localField: 'comments', + foreignKey: 'userId' + } + }, + hasOne: { + profile: { + localField: 'profile', + foreignKey: 'userId' + } + }, + belongsTo: { + organization: { + localKey: 'organizationId', + localField: 'organization' + } + } + } + }); + + DS.defineResource({ + name: 'organization', + relations: { + hasMany: { + user: { + localField: 'users', + foreignKey: 'organizationId' + } + } + } + }); + + DS.defineResource({ + name: 'profile', + relations: { + belongsTo: { + user: { + localField: 'user', + localKey: 'userId' + } + } + } + }); + + DS.defineResource({ + name: 'comment', + relations: { + belongsTo: { + user: { + localField: 'user', + localKey: 'userId' + } + } + } + }); + $log = _$log_; + + lifecycle.beforeValidate.callCount = 0; + lifecycle.validate.callCount = 0; + lifecycle.afterValidate.callCount = 0; + lifecycle.beforeCreate.callCount = 0; + lifecycle.afterCreate.callCount = 0; + lifecycle.beforeUpdate.callCount = 0; + lifecycle.afterUpdate.callCount = 0; + lifecycle.beforeDestroy.callCount = 0; + lifecycle.afterDestroy.callCount = 0; + lifecycle.beforeInject.callCount = 0; + lifecycle.afterInject.callCount = 0; + lifecycle.serialize.callCount = 0; + lifecycle.deserialize.callCount = 0; + lifecycle.queryTransform.callCount = 0; - localStorage.clear(); - $q = _$q_; - $rootScope = _$rootScope_; - DS = _DS_; - DSUtils = _DSUtils_; - DSHttpAdapter = _DSHttpAdapter_; - DSLocalStorageAdapter = _DSLocalStorageAdapter_; - $httpBackend = _$httpBackend_; - DS.defineResource({ - name: 'post', - endpoint: '/posts' - }); - $log = _$log_; + p1 = { author: 'John', age: 30, id: 5 }; + p2 = { author: 'Sally', age: 31, id: 6 }; + p3 = { author: 'Mike', age: 32, id: 7 }; + p4 = { author: 'Adam', age: 33, id: 8 }; + p5 = { author: 'Adam', age: 33, id: 9 }; - lifecycle.beforeValidate.callCount = 0; - lifecycle.validate.callCount = 0; - lifecycle.afterValidate.callCount = 0; - lifecycle.beforeCreate.callCount = 0; - lifecycle.afterCreate.callCount = 0; - lifecycle.beforeUpdate.callCount = 0; - lifecycle.afterUpdate.callCount = 0; - lifecycle.beforeDestroy.callCount = 0; - lifecycle.afterDestroy.callCount = 0; - lifecycle.beforeInject.callCount = 0; - lifecycle.afterInject.callCount = 0; - lifecycle.serialize.callCount = 0; - lifecycle.deserialize.callCount = 0; - lifecycle.queryTransform.callCount = 0; + user1 = { + name: 'John Anderson', + id: 1, + organizationId: 2 + }; + organization2 = { + name: 'Test Corp 2', + id: 2 + }; + comment3 = { + content: 'test comment 3', + id: 3, + userId: 1 + }; + profile4 = { + content: 'test profile 4', + id: 4, + userId: 1 + }; - p1 = { author: 'John', age: 30, id: 5 }; - p2 = { author: 'Sally', age: 31, id: 6 }; - p3 = { author: 'Mike', age: 32, id: 7 }; - p4 = { author: 'Adam', age: 33, id: 8 }; - p5 = { author: 'Adam', age: 33, id: 9 }; - }); + comment11 = { + id: 11, + userId: 10, + content: 'test comment 11' + }; + comment12 = { + id: 12, + userId: 10, + content: 'test comment 12' + }; + comment13 = { + id: 13, + userId: 10, + content: 'test comment 13' + }; + organization14 = { + id: 14, + name: 'Test Corp' + }; + profile15 = { + id: 15, + userId: 10, + email: 'john.anderson@test.com' + }; + user10 = { + name: 'John Anderson', + id: 10, + organizationId: 14, + comments: [ + comment11, + comment12, + comment13 + ], + organization: organization14, + profile: profile15 + }; + user16 = { + id: 16, + organizationId: 15, + name: 'test user 16' + }; + user17 = { + id: 17, + organizationId: 15, + name: 'test user 17' + }; + user18 = { + id: 18, + organizationId: 15, + name: 'test user 18' + }; + organization15 = { + name: 'Another Test Corp', + id: 15, + users: [ + user16, + user17, + user18 + ] + }; + user20 = { + id: 20, + name: 'test user 20' + }; + comment19 = { + content: 'test comment 19', + id: 19, + userId: 20, + user: user20 + }; + user22 = { + id: 22, + name: 'test user 22' + }; + profile21 = { + content: 'test profile 21', + id: 21, + userId: 22, + user: user22 + }; + }); } // Clean up after each test afterEach(function () { - $httpBackend.verifyNoOutstandingExpectation(); - $httpBackend.verifyNoOutstandingRequest(); - $log.reset(); + $httpBackend.verifyNoOutstandingExpectation(); + $httpBackend.verifyNoOutstandingRequest(); + $log.reset(); }); diff --git a/package.json b/package.json index 7a0b84b..cb869b4 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { "name": "angular-data", "description": "Data store for Angular.js.", - "version": "0.9.1", - "homepage": "http://angular-data.codetrain.io", + "version": "0.10.0", + "homepage": "http://angular-data.pseudobry.com", "repository": { "type": "git", "url": "git://github.com/jmdobry/angular-data.git" diff --git a/src/adapters/http.js b/src/adapters/http.js index ac9659e..921a383 100644 --- a/src/adapters/http.js +++ b/src/adapters/http.js @@ -5,429 +5,423 @@ */ function DSHttpAdapterProvider() { - /** - * @doc property - * @id DSHttpAdapterProvider.properties:defaults - * @name defaults - * @description - * Default configuration for this adapter. - * - * Properties: - * - * - `{function}` - `queryTransform` - See [the guide](/documentation/guide/adapters/index). Default: No-op. - */ - var defaults = this.defaults = { - /** - * @doc property - * @id DSHttpAdapterProvider.properties:defaults.queryTransform - * @name defaults.queryTransform - * @description - * Transform the angular-data query to something your server understands. You might just do this on the server instead. - * - * @param {string} resourceName The name of the resource. - * @param {object} query Response object from `$http()`. - * @returns {*} Returns `query` as-is. - */ - queryTransform: function (resourceName, query) { - return query; - } - }; + /** + * @doc property + * @id DSHttpAdapterProvider.properties:defaults + * @name defaults + * @description + * Default configuration for this adapter. + * + * Properties: + * + * - `{function}` - `queryTransform` - See [the guide](/documentation/guide/adapters/index). Default: No-op. + */ + var defaults = this.defaults = { + /** + * @doc property + * @id DSHttpAdapterProvider.properties:defaults.queryTransform + * @name defaults.queryTransform + * @description + * Transform the angular-data query to something your server understands. You might just do this on the server instead. + * + * @param {string} resourceName The name of the resource. + * @param {object} params Params sent through from `$http()`. + * @returns {*} Returns `params` as-is. + */ + queryTransform: function (resourceName, params) { + return params; + } + }; - this.$get = ['$http', '$log', 'DSUtils', function ($http, $log, DSUtils) { + this.$get = ['$http', '$log', 'DSUtils', function ($http, $log, DSUtils) { - /** - * @doc interface - * @id DSHttpAdapter - * @name DSHttpAdapter - * @description - * Default adapter used by angular-data. This adapter uses AJAX and JSON to send/retrieve data to/from a server. - * Developers may provide custom adapters that implement the adapter interface. - */ - return { - /** - * @doc property - * @id DSHttpAdapter.properties:defaults - * @name defaults - * @description - * Reference to [DSHttpAdapterProvider.defaults](/documentation/api/api/DSHttpAdapterProvider.properties:defaults). - */ - defaults: defaults, + /** + * @doc interface + * @id DSHttpAdapter + * @name DSHttpAdapter + * @description + * Default adapter used by angular-data. This adapter uses AJAX and JSON to send/retrieve data to/from a server. + * Developers may provide custom adapters that implement the adapter interface. + */ + return { + /** + * @doc property + * @id DSHttpAdapter.properties:defaults + * @name defaults + * @description + * Reference to [DSHttpAdapterProvider.defaults](/documentation/api/api/DSHttpAdapterProvider.properties:defaults). + */ + defaults: defaults, - /** - * @doc method - * @id DSHttpAdapter.methods:HTTP - * @name HTTP - * @description - * Wrapper for `$http()`. - * - * ## Signature: - * ```js - * DS.HTTP(config) - * ``` - * - * ## Example: - * - * ```js - * works the same as $http() - * ``` - * - * @param {object} config Configuration for the request. - * @returns {Promise} Promise produced by the `$q` service. - */ - HTTP: HTTP, + /** + * @doc method + * @id DSHttpAdapter.methods:HTTP + * @name HTTP + * @description + * Wrapper for `$http()`. + * + * ## Signature: + * ```js + * DS.HTTP(config) + * ``` + * + * ## Example: + * + * ```js + * works the same as $http() + * ``` + * + * @param {object} config Configuration for the request. + * @returns {Promise} Promise produced by the `$q` service. + */ + HTTP: HTTP, - /** - * @doc method - * @id DSHttpAdapter.methods:GET - * @name GET - * @description - * Wrapper for `$http.get()`. - * - * ## Signature: - * ```js - * DS.GET(url[, config]) - * ``` - * - * ## Example: - * - * ```js - * Works the same as $http.get() - * ``` - * - * @param {string} url The url of the request. - * @param {object=} config Configuration for the request. - * @returns {Promise} Promise produced by the `$q` service. - */ - GET: GET, + /** + * @doc method + * @id DSHttpAdapter.methods:GET + * @name GET + * @description + * Wrapper for `$http.get()`. + * + * ## Signature: + * ```js + * DS.GET(url[, config]) + * ``` + * + * ## Example: + * + * ```js + * Works the same as $http.get() + * ``` + * + * @param {string} url The url of the request. + * @param {object=} config Configuration for the request. + * @returns {Promise} Promise produced by the `$q` service. + */ + GET: GET, - /** - * @doc method - * @id DSHttpAdapter.methods:POST - * @name POST - * @description - * Wrapper for `$http.post()`. - * - * ## Signature: - * ```js - * DS.POST(url[, attrs][, config]) - * ``` - * - * ## Example: - * - * ```js - * Works the same as $http.post() - * ``` - * - * @param {string} url The url of the request. - * @param {object=} attrs Request payload. - * @param {object=} config Configuration for the request. - * @returns {Promise} Promise produced by the `$q` service. - */ - POST: POST, + /** + * @doc method + * @id DSHttpAdapter.methods:POST + * @name POST + * @description + * Wrapper for `$http.post()`. + * + * ## Signature: + * ```js + * DS.POST(url[, attrs][, config]) + * ``` + * + * ## Example: + * + * ```js + * Works the same as $http.post() + * ``` + * + * @param {string} url The url of the request. + * @param {object=} attrs Request payload. + * @param {object=} config Configuration for the request. + * @returns {Promise} Promise produced by the `$q` service. + */ + POST: POST, - /** - * @doc method - * @id DSHttpAdapter.methods:PUT - * @name PUT - * @description - * Wrapper for `$http.put()`. - * - * ## Signature: - * ```js - * DS.PUT(url[, attrs][, config]) - * ``` - * - * ## Example: - * - * ```js - * Works the same as $http.put() - * ``` - * - * @param {string} url The url of the request. - * @param {object=} attrs Request payload. - * @param {object=} config Configuration for the request. - * @returns {Promise} Promise produced by the `$q` service. - */ - PUT: PUT, + /** + * @doc method + * @id DSHttpAdapter.methods:PUT + * @name PUT + * @description + * Wrapper for `$http.put()`. + * + * ## Signature: + * ```js + * DS.PUT(url[, attrs][, config]) + * ``` + * + * ## Example: + * + * ```js + * Works the same as $http.put() + * ``` + * + * @param {string} url The url of the request. + * @param {object=} attrs Request payload. + * @param {object=} config Configuration for the request. + * @returns {Promise} Promise produced by the `$q` service. + */ + PUT: PUT, - /** - * @doc method - * @id DSHttpAdapter.methods:DEL - * @name DEL - * @description - * Wrapper for `$http.delete()`. - * - * ## Signature: - * ```js - * DS.DEL(url[, config]) - * ``` - * - * ## Example: - * - * ```js - * Works the same as $http.delete - * ``` - * - * @param {string} url The url of the request. - * @param {object} config Configuration for the request. - * @returns {Promise} Promise produced by the `$q` service. - */ - DEL: DEL, + /** + * @doc method + * @id DSHttpAdapter.methods:DEL + * @name DEL + * @description + * Wrapper for `$http.delete()`. + * + * ## Signature: + * ```js + * DS.DEL(url[, config]) + * ``` + * + * ## Example: + * + * ```js + * Works the same as $http.delete + * ``` + * + * @param {string} url The url of the request. + * @param {object} config Configuration for the request. + * @returns {Promise} Promise produced by the `$q` service. + */ + DEL: DEL, - /** - * @doc method - * @id DSHttpAdapter.methods:find - * @name find - * @description - * Retrieve a single entity from the server. - * - * Sends a `GET` request to `:baseUrl/:endpoint/:id`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {string|number} id The primary key of the entity to retrieve. - * @param {object=} options Optional configuration. Refer to the documentation for `$http.get`. - * @returns {Promise} Promise. - */ - find: find, + /** + * @doc method + * @id DSHttpAdapter.methods:find + * @name find + * @description + * Retrieve a single entity from the server. + * + * Sends a `GET` request to `:baseUrl/:endpoint/:id`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {string|number} id The primary key of the entity to retrieve. + * @param {object=} options Optional configuration. Refer to the documentation for `$http.get`. + * @returns {Promise} Promise. + */ + find: find, - /** - * @doc method - * @id DSHttpAdapter.methods:findAll - * @name findAll - * @description - * Retrieve a collection of entities from the server. - * - * Sends a `GET` request to `:baseUrl/:endpoint`. - * - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). - * @param {object=} options Optional configuration. Refer to the documentation for `$http.get`. - * @returns {Promise} Promise. - */ - findAll: findAll, + /** + * @doc method + * @id DSHttpAdapter.methods:findAll + * @name findAll + * @description + * Retrieve a collection of entities from the server. + * + * Sends a `GET` request to `:baseUrl/:endpoint`. + * + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). + * @param {object=} options Optional configuration. Refer to the documentation for `$http.get`. + * @returns {Promise} Promise. + */ + findAll: findAll, - /** - * @doc method - * @id DSHttpAdapter.methods:findAll - * @name find - * @description - * Create a new entity on the server. - * - * Sends a `POST` request to `:baseUrl/:endpoint`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). - * @param {object=} options Optional configuration. Refer to the documentation for `$http.post`. - * @returns {Promise} Promise. - */ - create: create, + /** + * @doc method + * @id DSHttpAdapter.methods:findAll + * @name find + * @description + * Create a new entity on the server. + * + * Sends a `POST` request to `:baseUrl/:endpoint`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). + * @param {object=} options Optional configuration. Refer to the documentation for `$http.post`. + * @returns {Promise} Promise. + */ + create: create, - /** - * @doc method - * @id DSHttpAdapter.methods:update - * @name update - * @description - * Update an entity on the server. - * - * Sends a `PUT` request to `:baseUrl/:endpoint/:id`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {string|number} id The primary key of the entity to update. - * @param {object} attrs The attributes with which to update the entity. See the [query guide](/documentation/guide/queries/index). - * @param {object=} options Optional configuration. Refer to the documentation for `$http.put`. - * @returns {Promise} Promise. - */ - update: update, + /** + * @doc method + * @id DSHttpAdapter.methods:update + * @name update + * @description + * Update an entity on the server. + * + * Sends a `PUT` request to `:baseUrl/:endpoint/:id`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {string|number} id The primary key of the entity to update. + * @param {object} attrs The attributes with which to update the entity. See the [query guide](/documentation/guide/queries/index). + * @param {object=} options Optional configuration. Refer to the documentation for `$http.put`. + * @returns {Promise} Promise. + */ + update: update, - /** - * @doc method - * @id DSHttpAdapter.methods:updateAll - * @name updateAll - * @description - * Update a collection of entities on the server. - * - * Sends a `PUT` request to `:baseUrl/:endpoint`. - * - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). - * @param {object=} options Optional configuration. Refer to the documentation for `$http.put`. - * @returns {Promise} Promise. - */ - updateAll: updateAll, + /** + * @doc method + * @id DSHttpAdapter.methods:updateAll + * @name updateAll + * @description + * Update a collection of entities on the server. + * + * Sends a `PUT` request to `:baseUrl/:endpoint`. + * + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). + * @param {object=} options Optional configuration. Refer to the documentation for `$http.put`. + * @returns {Promise} Promise. + */ + updateAll: updateAll, - /** - * @doc method - * @id DSHttpAdapter.methods:destroy - * @name destroy - * @description - * destroy an entity on the server. - * - * Sends a `PUT` request to `:baseUrl/:endpoint/:id`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {string|number} id The primary key of the entity to destroy. - * @param {object=} options Optional configuration. Refer to the documentation for `$http.delete`. - * @returns {Promise} Promise. - */ - destroy: destroy, + /** + * @doc method + * @id DSHttpAdapter.methods:destroy + * @name destroy + * @description + * destroy an entity on the server. + * + * Sends a `PUT` request to `:baseUrl/:endpoint/:id`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {string|number} id The primary key of the entity to destroy. + * @param {object=} options Optional configuration. Refer to the documentation for `$http.delete`. + * @returns {Promise} Promise. + */ + destroy: destroy, - /** - * @doc method - * @id DSHttpAdapter.methods:destroyAll - * @name destroyAll - * @description - * Retrieve a collection of entities from the server. - * - * Sends a `DELETE` request to `:baseUrl/:endpoint`. - * - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). - * @param {object=} options Optional configuration. Refer to the documentation for `$http.delete`. - * @returns {Promise} Promise. - */ - destroyAll: destroyAll - }; + /** + * @doc method + * @id DSHttpAdapter.methods:destroyAll + * @name destroyAll + * @description + * Retrieve a collection of entities from the server. + * + * Sends a `DELETE` request to `:baseUrl/:endpoint`. + * + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {object=} params Search query parameters. See the [query guide](/documentation/guide/queries/index). + * @param {object=} options Optional configuration. Refer to the documentation for `$http.delete`. + * @returns {Promise} Promise. + */ + destroyAll: destroyAll + }; - function HTTP(config) { - var start = new Date().getTime(); + function HTTP(config) { + var start = new Date().getTime(); - return $http(config).then(function (data) { - $log.debug(data.config.method + ' request:' + data.config.url + ' Time taken: ' + (new Date().getTime() - start) + 'ms', arguments); - return data; - }); - } + return $http(config).then(function (data) { + $log.debug(data.config.method + ' request:' + data.config.url + ' Time taken: ' + (new Date().getTime() - start) + 'ms', arguments); + return data; + }); + } - function GET(url, config) { - config = config || {}; - return HTTP(DSUtils.deepMixIn(config, { - url: url, - method: 'GET' - })); - } + function GET(url, config) { + config = config || {}; + return HTTP(DSUtils.deepMixIn(config, { + url: url, + method: 'GET' + })); + } - function POST(url, attrs, config) { - config = config || {}; - return HTTP(DSUtils.deepMixIn(config, { - url: url, - data: attrs, - method: 'POST' - })); - } + function POST(url, attrs, config) { + config = config || {}; + return HTTP(DSUtils.deepMixIn(config, { + url: url, + data: attrs, + method: 'POST' + })); + } - function PUT(url, attrs, config) { - config = config || {}; - return HTTP(DSUtils.deepMixIn(config, { - url: url, - data: attrs, - method: 'PUT' - })); - } + function PUT(url, attrs, config) { + config = config || {}; + return HTTP(DSUtils.deepMixIn(config, { + url: url, + data: attrs, + method: 'PUT' + })); + } - function DEL(url, config) { - config = config || {}; - return this.HTTP(DSUtils.deepMixIn(config, { - url: url, - method: 'DELETE' - })); - } + function DEL(url, config) { + config = config || {}; + return this.HTTP(DSUtils.deepMixIn(config, { + url: url, + method: 'DELETE' + })); + } - function create(resourceConfig, attrs, options) { - options = options || {}; - return this.POST( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), - attrs, - options - ); - } + function create(resourceConfig, attrs, options) { + options = options || {}; + return this.POST( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), + attrs, + options + ); + } - function destroy(resourceConfig, id, options) { - options = options || {}; - return this.DEL( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), - options - ); - } + function destroy(resourceConfig, id, options) { + options = options || {}; + return this.DEL( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), + options + ); + } - function destroyAll(resourceConfig, params, options) { - options = options || {}; - options.params = options.params || {}; - if (params) { - if (params.query) { - params.query = defaults.queryTransform(resourceConfig.name, params.query); - } - DSUtils.deepMixIn(options.params, params); - } - return this.DEL( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), - options - ); - } + function destroyAll(resourceConfig, params, options) { + options = options || {}; + options.params = options.params || {}; + if (params) { + params = defaults.queryTransform(resourceConfig.name, params); + DSUtils.deepMixIn(options.params, params); + } + return this.DEL( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), + options + ); + } - function find(resourceConfig, id, options) { - options = options || {}; - return this.GET( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), - options - ); - } + function find(resourceConfig, id, options) { + options = options || {}; + return this.GET( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), + options + ); + } - function findAll(resourceConfig, params, options) { - options = options || {}; - options.params = options.params || {}; - if (params) { - if (params.query) { - params.query = defaults.queryTransform(resourceConfig.name, params.query); - } - DSUtils.deepMixIn(options.params, params); - } - return this.GET( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), - options - ); - } + function findAll(resourceConfig, params, options) { + options = options || {}; + options.params = options.params || {}; + if (params) { + params = defaults.queryTransform(resourceConfig.name, params); + DSUtils.deepMixIn(options.params, params); + } + return this.GET( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), + options + ); + } - function update(resourceConfig, id, attrs, options) { - options = options || {}; - return this.PUT( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), - attrs, - options - ); - } + function update(resourceConfig, id, attrs, options) { + options = options || {}; + return this.PUT( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), + attrs, + options + ); + } - function updateAll(resourceConfig, attrs, params, options) { - options = options || {}; - options.params = options.params || {}; - if (params) { - if (params.query) { - params.query = defaults.queryTransform(resourceConfig.name, params.query); - } - DSUtils.deepMixIn(options.params, params); - } - return this.PUT( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), - attrs, - options - ); - } - }]; + function updateAll(resourceConfig, attrs, params, options) { + options = options || {}; + options.params = options.params || {}; + if (params) { + params = defaults.queryTransform(resourceConfig.name, params); + DSUtils.deepMixIn(options.params, params); + } + return this.PUT( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint), + attrs, + options + ); + } + }]; } module.exports = DSHttpAdapterProvider; diff --git a/src/adapters/localStorage.js b/src/adapters/localStorage.js index a97b22d..c3e2710 100644 --- a/src/adapters/localStorage.js +++ b/src/adapters/localStorage.js @@ -5,179 +5,179 @@ */ function DSLocalStorageProvider() { - this.$get = ['$q', 'DSUtils', function ($q, DSUtils) { + this.$get = ['$q', 'DSUtils', function ($q, DSUtils) { - /** - * @doc interface - * @id DSLocalStorage - * @name DSLocalStorage - * @description - * Default adapter used by angular-data. This adapter uses AJAX and JSON to send/retrieve data to/from a server. - * Developers may provide custom adapters that implement the adapter interface. - */ - return { - /** - * @doc method - * @id DSLocalStorage.methods:find - * @name find - * @description - * Retrieve a single entity from localStorage. - * - * Calls `localStorage.getItem(key)`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `namespace` - Namespace path for the resource. - * @param {string|number} id The primary key of the entity to retrieve. - * @returns {Promise} Promise. - */ - find: find, + /** + * @doc interface + * @id DSLocalStorage + * @name DSLocalStorage + * @description + * Default adapter used by angular-data. This adapter uses AJAX and JSON to send/retrieve data to/from a server. + * Developers may provide custom adapters that implement the adapter interface. + */ + return { + /** + * @doc method + * @id DSLocalStorage.methods:find + * @name find + * @description + * Retrieve a single entity from localStorage. + * + * Calls `localStorage.getItem(key)`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `namespace` - Namespace path for the resource. + * @param {string|number} id The primary key of the entity to retrieve. + * @returns {Promise} Promise. + */ + find: find, - /** - * @doc method - * @id DSLocalStorage.methods:findAll - * @name findAll - * @description - * Not supported. - */ - findAll: function () { - throw new Error('Not supported!'); - }, + /** + * @doc method + * @id DSLocalStorage.methods:findAll + * @name findAll + * @description + * Not supported. + */ + findAll: function () { + throw new Error('Not supported!'); + }, - /** - * @doc method - * @id DSLocalStorage.methods:findAll - * @name find - * @description - * Not supported. - */ - create: function () { - throw new Error('Not supported!'); - }, + /** + * @doc method + * @id DSLocalStorage.methods:findAll + * @name find + * @description + * Not supported. + */ + create: function () { + throw new Error('Not supported!'); + }, - /** - * @doc method - * @id DSLocalStorage.methods:update - * @name update - * @description - * Update an entity in localStorage. - * - * Calls `localStorage.setItem(key, value)`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `namespace` - Namespace path for the resource. - * @param {string|number} id The primary key of the entity to update. - * @param {object} attrs The attributes with which to update the entity. - * @returns {Promise} Promise. - */ - update: update, + /** + * @doc method + * @id DSLocalStorage.methods:update + * @name update + * @description + * Update an entity in localStorage. + * + * Calls `localStorage.setItem(key, value)`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `namespace` - Namespace path for the resource. + * @param {string|number} id The primary key of the entity to update. + * @param {object} attrs The attributes with which to update the entity. + * @returns {Promise} Promise. + */ + update: update, - /** - * @doc method - * @id DSLocalStorage.methods:updateAll - * @name updateAll - * @description - * Not supported. - */ - updateAll: function () { - throw new Error('Not supported!'); - }, + /** + * @doc method + * @id DSLocalStorage.methods:updateAll + * @name updateAll + * @description + * Not supported. + */ + updateAll: function () { + throw new Error('Not supported!'); + }, - /** - * @doc method - * @id DSLocalStorage.methods:destroy - * @name destroy - * @description - * Destroy an entity from localStorage. - * - * Calls `localStorage.removeItem(key)`. - * - * @param {object} resourceConfig Properties: - * - `{string}` - `baseUrl` - Base url. - * - `{string=}` - `endpoint` - Endpoint path for the resource. - * @param {string|number} id The primary key of the entity to destroy. - * @returns {Promise} Promise. - */ - destroy: destroy, + /** + * @doc method + * @id DSLocalStorage.methods:destroy + * @name destroy + * @description + * Destroy an entity from localStorage. + * + * Calls `localStorage.removeItem(key)`. + * + * @param {object} resourceConfig Properties: + * - `{string}` - `baseUrl` - Base url. + * - `{string=}` - `endpoint` - Endpoint path for the resource. + * @param {string|number} id The primary key of the entity to destroy. + * @returns {Promise} Promise. + */ + destroy: destroy, - /** - * @doc method - * @id DSLocalStorage.methods:destroyAll - * @name destroyAll - * @description - * Not supported. - */ - destroyAll: function () { - throw new Error('Not supported!'); - } - }; + /** + * @doc method + * @id DSLocalStorage.methods:destroyAll + * @name destroyAll + * @description + * Not supported. + */ + destroyAll: function () { + throw new Error('Not supported!'); + } + }; - function GET(key) { - var deferred = $q.defer(); - try { - var item = localStorage.getItem(key); - deferred.resolve(item ? angular.fromJson(item) : undefined); - } catch (err) { - deferred.reject(err); - } - return deferred.promise; - } + function GET(key) { + var deferred = $q.defer(); + try { + var item = localStorage.getItem(key); + deferred.resolve(item ? angular.fromJson(item) : undefined); + } catch (err) { + deferred.reject(err); + } + return deferred.promise; + } - function PUT(key, value) { - var deferred = $q.defer(); - try { - var item = localStorage.getItem(key); - if (item) { - item = angular.fromJson(item); - DSUtils.deepMixIn(item, value); - deferred.resolve(localStorage.setItem(key, angular.toJson(item))); - } else { - deferred.resolve(localStorage.setItem(key, angular.toJson(value))); - } - } catch (err) { - deferred.reject(err); - } - return deferred.promise; - } + function PUT(key, value) { + var deferred = $q.defer(); + try { + var item = localStorage.getItem(key); + if (item) { + item = angular.fromJson(item); + DSUtils.deepMixIn(item, value); + deferred.resolve(localStorage.setItem(key, angular.toJson(item))); + } else { + deferred.resolve(localStorage.setItem(key, angular.toJson(value))); + } + } catch (err) { + deferred.reject(err); + } + return deferred.promise; + } - function DEL(key) { - var deferred = $q.defer(); - try { - deferred.resolve(localStorage.removeItem(key)); - } catch (err) { - deferred.reject(err); - } - return deferred.promise; - } + function DEL(key) { + var deferred = $q.defer(); + try { + deferred.resolve(localStorage.removeItem(key)); + } catch (err) { + deferred.reject(err); + } + return deferred.promise; + } - function destroy(resourceConfig, id, options) { - options = options || {}; - return DEL( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), - options - ); - } + function destroy(resourceConfig, id, options) { + options = options || {}; + return DEL( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), + options + ); + } - function find(resourceConfig, id, options) { - options = options || {}; - return GET( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), - options - ); - } + function find(resourceConfig, id, options) { + options = options || {}; + return GET( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), + options + ); + } - function update(resourceConfig, id, attrs, options) { - options = options || {}; - return PUT( - DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), - attrs, - options - ).then(function () { - return GET(DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id)); - }); - } - }]; + function update(resourceConfig, id, attrs, options) { + options = options || {}; + return PUT( + DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id), + attrs, + options + ).then(function () { + return GET(DSUtils.makePath(options.baseUrl || resourceConfig.baseUrl, resourceConfig.endpoint, id)); + }); + } + }]; } module.exports = DSLocalStorageProvider; diff --git a/src/datastore/async_methods/create.js b/src/datastore/async_methods/create.js index a3a04a9..2be26c3 100644 --- a/src/datastore/async_methods/create.js +++ b/src/datastore/async_methods/create.js @@ -39,59 +39,57 @@ var errorPrefix = 'DS.create(resourceName, attrs[, options]): '; * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function create(resourceName, attrs, options) { - var deferred = this.$q.defer(), - promise = deferred.promise; + var deferred = this.$q.defer(); + var promise = deferred.promise; - options = options || {}; + try { + options = options || {}; - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isObject(attrs)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'attrs: Must be an object!', { attrs: { actual: typeof attrs, expected: 'object' } })); - } else { - try { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(attrs)) { + throw new this.errors.IA(errorPrefix + 'attrs: Must be an object!'); + } + var definition = this.definitions[resourceName]; + var resource = this.store[resourceName]; + var _this = this; - promise = promise - .then(function (attrs) { - return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.validate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.beforeCreate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.adapters[options.adapter || definition.defaultAdapter].create(definition, definition.serialize(resourceName, attrs), options); - }) - .then(function (res) { - return _this.$q.promisify(definition.afterCreate)(resourceName, definition.deserialize(resourceName, res)); - }) - .then(function (data) { - var created = _this.inject(definition.name, data); - var id = created[definition.idAttribute]; - resource.previousAttributes[id] = _this.utils.deepMixIn({}, created); - resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); - return _this.get(definition.name, id); - }); + promise = promise + .then(function (attrs) { + return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.validate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.beforeCreate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.adapters[options.adapter || definition.defaultAdapter].create(definition, definition.serialize(resourceName, attrs), options); + }) + .then(function (res) { + return _this.$q.promisify(definition.afterCreate)(resourceName, definition.deserialize(resourceName, res)); + }) + .then(function (data) { + var created = _this.inject(definition.name, data); + var id = created[definition.idAttribute]; + resource.previousAttributes[id] = _this.utils.deepMixIn({}, created); + resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); + return _this.get(definition.name, id); + }); - deferred.resolve(attrs); - } catch (err) { - deferred.reject(new this.errors.UnhandledError(err)); - } - } + deferred.resolve(attrs); + } catch (err) { + deferred.reject(err); + } - return promise; + return promise; } module.exports = create; diff --git a/src/datastore/async_methods/destroy.js b/src/datastore/async_methods/destroy.js index 3afe3c1..c0aef0c 100644 --- a/src/datastore/async_methods/destroy.js +++ b/src/datastore/async_methods/destroy.js @@ -40,46 +40,49 @@ var errorPrefix = 'DS.destroy(resourceName, id): '; * * - `{IllegalArgumentError}` * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function destroy(resourceName, id, options) { - var deferred = this.$q.defer(), - promise = deferred.promise; + var deferred = this.$q.defer(); + var promise = deferred.promise; - options = options || {}; + try { + options = options || {}; - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } })); - } else { - var item = this.get(resourceName, id); - if (!item) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + 'id: "' + id + '" not found!')); - } else { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } - promise = promise - .then(function (attrs) { - return _this.$q.promisify(definition.beforeDestroy)(resourceName, attrs); - }) - .then(function () { - return _this.adapters[options.adapter || definition.defaultAdapter].destroy(definition, id, options); - }) - .then(function () { - return _this.$q.promisify(definition.afterDestroy)(resourceName, item); - }) - .then(function () { - _this.eject(resourceName, id); - return id; - }); - deferred.resolve(item); - } - } + var item = this.get(resourceName, id); + if (!item) { + throw new this.errors.R(errorPrefix + 'id: "' + id + '" not found!'); + } - return promise; + var definition = this.definitions[resourceName]; + var _this = this; + + promise = promise + .then(function (attrs) { + return _this.$q.promisify(definition.beforeDestroy)(resourceName, attrs); + }) + .then(function () { + return _this.adapters[options.adapter || definition.defaultAdapter].destroy(definition, id, options); + }) + .then(function () { + return _this.$q.promisify(definition.afterDestroy)(resourceName, item); + }) + .then(function () { + _this.eject(resourceName, id); + return id; + }); + deferred.resolve(item); + } catch (err) { + deferred.reject(err); + } + + return promise; } module.exports = destroy; diff --git a/src/datastore/async_methods/destroyAll.js b/src/datastore/async_methods/destroyAll.js index d77df78..cefc41a 100644 --- a/src/datastore/async_methods/destroyAll.js +++ b/src/datastore/async_methods/destroyAll.js @@ -16,7 +16,7 @@ var errorPrefix = 'DS.destroyAll(resourceName, params[, options]): '; * ## Example: * * ```js - * var query = { + * var params = { * where: { * author: { * '==': 'John Anderson' @@ -24,13 +24,9 @@ var errorPrefix = 'DS.destroyAll(resourceName, params[, options]): '; * } * }; * - * DS.destroyAll('document', { - * query: query - * }).then(function (documents) { + * DS.destroyAll('document', params).then(function (documents) { * // The documents are gone from the data store - * DS.filter('document', { - * query: query - * }); // [] + * DS.filter('document', params); // [] * * }, function (err) { * // handle error @@ -40,11 +36,11 @@ var errorPrefix = 'DS.destroyAll(resourceName, params[, options]): '; * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {object} params Parameter object that is serialized into the query string. Properties: * - * - `{object=}` - `query` - The query object by which to filter items of the type specified by `resourceName`. Properties: - * - `{object=}` - `where` - Where clause. - * - `{number=}` - `limit` - Limit clause. - * - `{skip=}` - `skip` - Skip clause. - * - `{orderBy=}` - `orderBy` - OrderBy clause. + * - `{object=}` - `where` - Where clause. + * - `{number=}` - `limit` - Limit clause. + * - `{number=}` - `skip` - Skip clause. + * - `{number=}` - `offset` - Same as skip. + * - `{string|array=}` - `orderBy` - OrderBy clause. * * @param {object=} options Optional configuration. Properties: * - `{boolean=}` - `bypassCache` - Bypass the cache. Default: `false`. @@ -54,40 +50,41 @@ var errorPrefix = 'DS.destroyAll(resourceName, params[, options]): '; * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function destroyAll(resourceName, params, options) { - var deferred = this.$q.defer(), - promise = deferred.promise, - _this = this; + var deferred = this.$q.defer(); + var promise = deferred.promise; - options = options || {}; + try { + var _this = this; + var IA = this.errors.IA; - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isObject(params)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'params: Must be an object!')); - } else if (!this.utils.isObject(options)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!')); - } else { - try { - var definition = this.definitions[resourceName]; + options = options || {}; - promise = promise - .then(function () { - return _this.adapters[options.adapter || definition.defaultAdapter].destroyAll(definition, params, options); - }) - .then(function () { - return _this.ejectAll(resourceName, params); - }); - deferred.resolve(); - } catch (err) { - deferred.reject(new this.errors.UnhandledError(err)); - } - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(params)) { + throw new IA(errorPrefix + 'params: Must be an object!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } - return promise; + var definition = this.definitions[resourceName]; + + promise = promise + .then(function () { + return _this.adapters[options.adapter || definition.defaultAdapter].destroyAll(definition, params, options); + }) + .then(function () { + return _this.ejectAll(resourceName, params); + }); + deferred.resolve(); + } catch (err) { + deferred.reject(err); + } + + return promise; } module.exports = destroyAll; diff --git a/src/datastore/async_methods/find.js b/src/datastore/async_methods/find.js index fea42ad..b94f8d6 100644 --- a/src/datastore/async_methods/find.js +++ b/src/datastore/async_methods/find.js @@ -41,65 +41,67 @@ var errorPrefix = 'DS.find(resourceName, id[, options]): '; * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function find(resourceName, id, options) { - var deferred = this.$q.defer(), - promise = deferred.promise; + var deferred = this.$q.defer(); + var promise = deferred.promise; - options = options || {}; + try { + var IA = this.errors.IA; - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } })); - } else if (!this.utils.isObject(options)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!', { options: { actual: typeof options, expected: 'object' } })); - } else { - if (!('cacheResponse' in options)) { - options.cacheResponse = true; - } else { - options.cacheResponse = !!options.cacheResponse; - } - try { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; + options = options || {}; - if (options.bypassCache) { - delete resource.completedQueries[id]; - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new IA(errorPrefix + 'id: Must be a string or a number!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } - if (!(id in resource.completedQueries)) { - if (!(id in resource.pendingQueries)) { - promise = resource.pendingQueries[id] = _this.adapters[options.adapter || definition.defaultAdapter].find(definition, id, options) - .then(function (res) { - var data = definition.deserialize(resourceName, res); - if (options.cacheResponse) { - // Query is no longer pending - delete resource.pendingQueries[id]; - resource.completedQueries[id] = new Date().getTime(); - return _this.inject(resourceName, data); - } else { - return data; - } - }, function (err) { - delete resource.pendingQueries[id]; - return _this.$q.reject(err); - }); - } + if (!('cacheResponse' in options)) { + options.cacheResponse = true; + } else { + options.cacheResponse = !!options.cacheResponse; + } - return resource.pendingQueries[id]; - } else { - deferred.resolve(_this.get(resourceName, id)); - } - } catch (err) { - deferred.reject(err); - } - } + var definition = this.definitions[resourceName]; + var resource = this.store[resourceName]; + var _this = this; - return promise; + if (options.bypassCache) { + delete resource.completedQueries[id]; + } + + if (!(id in resource.completedQueries)) { + if (!(id in resource.pendingQueries)) { + promise = resource.pendingQueries[id] = _this.adapters[options.adapter || definition.defaultAdapter].find(definition, id, options) + .then(function (res) { + var data = definition.deserialize(resourceName, res); + if (options.cacheResponse) { + // Query is no longer pending + delete resource.pendingQueries[id]; + resource.completedQueries[id] = new Date().getTime(); + return _this.inject(resourceName, data); + } else { + return data; + } + }, function (err) { + delete resource.pendingQueries[id]; + return _this.$q.reject(err); + }); + } + + return resource.pendingQueries[id]; + } else { + deferred.resolve(_this.get(resourceName, id)); + } + } catch (err) { + deferred.reject(err); + } + + return promise; } module.exports = find; diff --git a/src/datastore/async_methods/findAll.js b/src/datastore/async_methods/findAll.js index fe3c035..98275bb 100644 --- a/src/datastore/async_methods/findAll.js +++ b/src/datastore/async_methods/findAll.js @@ -1,59 +1,59 @@ var errorPrefix = 'DS.findAll(resourceName, params[, options]): '; function processResults(utils, data, resourceName, queryHash) { - var resource = this.store[resourceName]; + var resource = this.store[resourceName]; - data = data || []; + data = data || []; - // Query is no longer pending - delete resource.pendingQueries[queryHash]; - resource.completedQueries[queryHash] = new Date().getTime(); + // Query is no longer pending + delete resource.pendingQueries[queryHash]; + resource.completedQueries[queryHash] = new Date().getTime(); - // Update modified timestamp of collection - resource.collectionModified = utils.updateTimestamp(resource.collectionModified); + // Update modified timestamp of collection + resource.collectionModified = utils.updateTimestamp(resource.collectionModified); - // Merge the new values into the cache - return this.inject(resourceName, data); + // Merge the new values into the cache + return this.inject(resourceName, data); } function _findAll(utils, resourceName, params, options) { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this, - queryHash = utils.toJson(params); - - if (options.bypassCache) { - delete resource.completedQueries[queryHash]; - } - - if (!(queryHash in resource.completedQueries)) { - // This particular query has never been completed - - if (!(queryHash in resource.pendingQueries)) { - - // This particular query has never even been made - resource.pendingQueries[queryHash] = _this.adapters[options.adapter || definition.defaultAdapter].findAll(definition, params, options) - .then(function (res) { - var data = definition.deserialize(resourceName, res); - if (options.cacheResponse) { - try { - return processResults.apply(_this, [utils, data, resourceName, queryHash]); - } catch (err) { - return _this.$q.reject(_this.errors.UnhandledError(err)); - } - } else { - return data; - } - }, function (err) { - delete resource.pendingQueries[queryHash]; - return _this.$q.reject(err); - }); - } - - return resource.pendingQueries[queryHash]; - } else { - return this.filter(resourceName, params, options); - } + var definition = this.definitions[resourceName], + resource = this.store[resourceName], + _this = this, + queryHash = utils.toJson(params); + + if (options.bypassCache) { + delete resource.completedQueries[queryHash]; + } + + if (!(queryHash in resource.completedQueries)) { + // This particular query has never been completed + + if (!(queryHash in resource.pendingQueries)) { + + // This particular query has never even been made + resource.pendingQueries[queryHash] = _this.adapters[options.adapter || definition.defaultAdapter].findAll(definition, params, options) + .then(function (res) { + var data = definition.deserialize(resourceName, res); + if (options.cacheResponse) { + try { + return processResults.apply(_this, [utils, data, resourceName, queryHash]); + } catch (err) { + return _this.$q.reject(err); + } + } else { + return data; + } + }, function (err) { + delete resource.pendingQueries[queryHash]; + return _this.$q.reject(err); + }); + } + + return resource.pendingQueries[queryHash]; + } else { + return this.filter(resourceName, params, options); + } } /** @@ -72,7 +72,7 @@ function _findAll(utils, resourceName, params, options) { * ## Example: * * ```js - * var query = { + * var params = { * where: { * author: { * '==': 'John Anderson' @@ -80,17 +80,13 @@ function _findAll(utils, resourceName, params, options) { * } * }; * - * DS.findAll('document', { - * query: query - * }).then(function (documents) { - * documents; // [{ id: 'aab7ff66-e21e-46e2-8be8-264d82aee535', author: 'John Anderson', title: 'How to cook' }, - * // { id: 'ee7f3f4d-98d5-4934-9e5a-6a559b08479f', author: 'John Anderson', title: 'How NOT to cook' }] + * DS.findAll('document', params).then(function (documents) { + * documents; // [{ id: '1', author: 'John Anderson', title: 'How to cook' }, + * // { id: '2', author: 'John Anderson', title: 'How NOT to cook' }] * * // The documents are now in the data store - * DS.filter('document', { - * query: query - * }); // [{ id: 'aab7ff66-e21e-46e2-8be8-264d82aee535', author: 'John Anderson', title: 'How to cook' }, - * // { id: 'ee7f3f4d-98d5-4934-9e5a-6a559b08479f', author: 'John Anderson', title: 'How NOT to cook' }] + * DS.filter('document', params); // [{ id: '1', author: 'John Anderson', title: 'How to cook' }, + * // { id: '2', author: 'John Anderson', title: 'How NOT to cook' }] * * }, function (err) { * // handle error @@ -100,11 +96,11 @@ function _findAll(utils, resourceName, params, options) { * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {object=} params Parameter object that is serialized into the query string. Properties: * - * - `{object=}` - `query` - The query object by which to filter items of the type specified by `resourceName`. Properties: - * - `{object=}` - `where` - Where clause. - * - `{number=}` - `limit` - Limit clause. - * - `{skip=}` - `skip` - Skip clause. - * - `{orderBy=}` - `orderBy` - OrderBy clause. + * - `{object=}` - `where` - Where clause. + * - `{number=}` - `limit` - Limit clause. + * - `{number=}` - `skip` - Skip clause. + * - `{number=}` - `offset` - Same as skip. + * - `{string|array=}` - `orderBy` - OrderBy clause. * * @param {object=} options Optional configuration. Properties: * - `{boolean=}` - `bypassCache` - Bypass the cache. Default: `false`. @@ -119,40 +115,42 @@ function _findAll(utils, resourceName, params, options) { * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function findAll(resourceName, params, options) { - var deferred = this.$q.defer(), - promise = deferred.promise, - _this = this; - - options = options || {}; - params = params || {}; - - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isObject(params)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'params: Must be an object!')); - } else if (!this.utils.isObject(options)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!')); - } else { - if (!('cacheResponse' in options)) { - options.cacheResponse = true; - } else { - options.cacheResponse = !!options.cacheResponse; - } - try { - promise = promise.then(function () { - return _findAll.apply(_this, [_this.utils, resourceName, params, options]); - }); - deferred.resolve(); - } catch (err) { - deferred.reject(new this.errors.UnhandledError(err)); - } - } - - return promise; + var deferred = this.$q.defer(); + var promise = deferred.promise; + + try { + var IA = this.errors.IA; + var _this = this; + + options = options || {}; + params = params || {}; + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(params)) { + throw new IA(errorPrefix + 'params: Must be an object!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } + + if (!('cacheResponse' in options)) { + options.cacheResponse = true; + } else { + options.cacheResponse = !!options.cacheResponse; + } + + promise = promise.then(function () { + return _findAll.apply(_this, [_this.utils, resourceName, params, options]); + }); + deferred.resolve(); + } catch (err) { + deferred.reject(err); + } + + return promise; } module.exports = findAll; diff --git a/src/datastore/async_methods/index.js b/src/datastore/async_methods/index.js index 6d81d57..919df1e 100644 --- a/src/datastore/async_methods/index.js +++ b/src/datastore/async_methods/index.js @@ -1,91 +1,101 @@ module.exports = { - /** - * @doc method - * @id DS.async_methods:create - * @name create - * @methodOf DS - * @description - * See [DS.create](/documentation/api/api/DS.async_methods:create). - */ - create: require('./create'), + /** + * @doc method + * @id DS.async_methods:create + * @name create + * @methodOf DS + * @description + * See [DS.create](/documentation/api/api/DS.async_methods:create). + */ + create: require('./create'), - /** - * @doc method - * @id DS.async_methods:destroy - * @name destroy - * @methodOf DS - * @description - * See [DS.destroy](/documentation/api/api/DS.async_methods:destroy). - */ - destroy: require('./destroy'), + /** + * @doc method + * @id DS.async_methods:destroy + * @name destroy + * @methodOf DS + * @description + * See [DS.destroy](/documentation/api/api/DS.async_methods:destroy). + */ + destroy: require('./destroy'), - /** - * @doc method - * @id DS.async_methods:destroyAll - * @name destroyAll - * @methodOf DS - * @description - * See [DS.destroyAll](/documentation/api/api/DS.async_methods:destroyAll). - */ - destroyAll: require('./destroyAll'), + /** + * @doc method + * @id DS.async_methods:destroyAll + * @name destroyAll + * @methodOf DS + * @description + * See [DS.destroyAll](/documentation/api/api/DS.async_methods:destroyAll). + */ + destroyAll: require('./destroyAll'), - /** - * @doc method - * @id DS.async_methods:find - * @name find - * @methodOf DS - * @description - * See [DS.find](/documentation/api/api/DS.async_methods:find). - */ - find: require('./find'), + /** + * @doc method + * @id DS.async_methods:find + * @name find + * @methodOf DS + * @description + * See [DS.find](/documentation/api/api/DS.async_methods:find). + */ + find: require('./find'), - /** - * @doc method - * @id DS.async_methods:findAll - * @name findAll - * @methodOf DS - * @description - * See [DS.findAll](/documentation/api/api/DS.async_methods:findAll). - */ - findAll: require('./findAll'), + /** + * @doc method + * @id DS.async_methods:findAll + * @name findAll + * @methodOf DS + * @description + * See [DS.findAll](/documentation/api/api/DS.async_methods:findAll). + */ + findAll: require('./findAll'), - /** - * @doc method - * @id DS.async_methods:refresh - * @name refresh - * @methodOf DS - * @description - * See [DS.refresh](/documentation/api/api/DS.async_methods:refresh). - */ - refresh: require('./refresh'), + /** + * @doc method + * @id DS.async_methods:loadRelations + * @name loadRelations + * @methodOf DS + * @description + * See [DS.loadRelations](/documentation/api/api/DS.async_methods:loadRelations). + */ + loadRelations: require('./loadRelations'), - /** - * @doc method - * @id DS.async_methods:save - * @name save - * @methodOf DS - * @description - * See [DS.save](/documentation/api/api/DS.async_methods:save). - */ - save: require('./save'), + /** + * @doc method + * @id DS.async_methods:refresh + * @name refresh + * @methodOf DS + * @description + * See [DS.refresh](/documentation/api/api/DS.async_methods:refresh). + */ + refresh: require('./refresh'), - /** - * @doc method - * @id DS.async_methods:update - * @name update - * @methodOf DS - * @description - * See [DS.update](/documentation/api/api/DS.async_methods:update). - */ - update: require('./update'), + /** + * @doc method + * @id DS.async_methods:save + * @name save + * @methodOf DS + * @description + * See [DS.save](/documentation/api/api/DS.async_methods:save). + */ + save: require('./save'), - /** - * @doc method - * @id DS.async_methods:updateAll - * @name updateAll - * @methodOf DS - * @description - * See [DS.updateAll](/documentation/api/api/DS.async_methods:updateAll). - */ - updateAll: require('./updateAll') + /** + * @doc method + * @id DS.async_methods:update + * @name update + * @methodOf DS + * @description + * See [DS.update](/documentation/api/api/DS.async_methods:update). + */ + update: require('./update'), + + /** + * @doc method + * @id DS.async_methods:updateAll + * @name updateAll + * @methodOf DS + * @description + * See [DS.updateAll](/documentation/api/api/DS.async_methods:updateAll). + */ + updateAll: require('./updateAll') }; diff --git a/src/datastore/async_methods/loadRelations.js b/src/datastore/async_methods/loadRelations.js new file mode 100644 index 0000000..2aa8a4b --- /dev/null +++ b/src/datastore/async_methods/loadRelations.js @@ -0,0 +1,134 @@ +var errorPrefix = 'DS.loadRelations(resourceName, instance(Id), relations[, options]): '; + +/** + * @doc method + * @id DS.async_methods:loadRelations + * @name loadRelations + * @description + * Asynchronously load the indicated relations of the given instance. + * + * ## Signature: + * ```js + * DS.loadRelations(resourceName, instance(Id), relations[, options]) + * ``` + * + * ## Examples: + * + * ```js + * DS.loadRelations('user', 10, ['profile']).then(function (user) { + * user.profile; // object + * assert.deepEqual(user.profile, DS.filter('profile', { userId: 10 })[0]); + * }); + * ``` + * + * ```js + * var user = DS.get('user', 10); + * + * DS.loadRelations('user', user, ['profile']).then(function (user) { + * user.profile; // object + * assert.deepEqual(user.profile, DS.filter('profile', { userId: 10 })[0]); + * }); + * ``` + * + * ```js + * DS.loadRelations('user', 10, ['profile'], { cacheResponse: false }).then(function (user) { + * user.profile; // object + * assert.equal(DS.filter('profile', { userId: 10 }).length, 0); + * }); + * ``` + * + * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. + * @param {string|number|object} instance The instance or the id of the instance for which relations are to be loaded. + * @param {string|array=} relations The relation(s) to load. + * @param {object=} options Optional configuration that is passed to the `find` and `findAll` methods that may be called. + * + * @returns {Promise} Promise produced by the `$q` service. + * + * ## Resolves with: + * + * - `{object}` - `item` - The instance with its loaded relations. + * + * ## Rejects with: + * + * - `{IllegalArgumentError}` + * - `{NonexistentResourceError}` + */ +function loadRelations(resourceName, instance, relations, options) { + var deferred = this.$q.defer(); + var promise = deferred.promise; + + try { + var IA = this.errors.IA; + + options = options || {}; + + if (angular.isString(instance) || angular.isNumber(instance)) { + instance = this.get(resourceName, instance); + } + + if (angular.isString(relations)) { + relations = [relations]; + } + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(instance)) { + throw new IA(errorPrefix + 'instance(Id): Must be a string, number or object!'); + } else if (!this.utils.isArray(relations)) { + throw new IA(errorPrefix + 'relations: Must be a string or an array!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } + + var definition = this.definitions[resourceName]; + var _this = this; + var tasks = []; + var fields = []; + + _this.utils.forOwn(definition.relations, function (relation, type) { + _this.utils.forOwn(relation, function (def, relationName) { + if (_this.utils.contains(relations, relationName)) { + var task; + var params = {}; + params[def.foreignKey] = instance[definition.idAttribute]; + + if (type === 'hasMany') { + task = _this.findAll(relationName, params, options); + } else if (type === 'hasOne') { + if (def.localKey && instance[def.localKey]) { + task = _this.find(relationName, instance[def.localKey], options); + } else if (def.foreignKey) { + task = _this.findAll(relationName, params, options); + } + } else { + task = _this.find(relationName, instance[def.localKey], options); + } + + if (task) { + tasks.push(task); + fields.push(def.localField); + } + } + }); + }); + + promise = promise + .then(function () { + return _this.$q.all(tasks); + }) + .then(function (loadedRelations) { + angular.forEach(fields, function (field, index) { + instance[field] = loadedRelations[index]; + }); + return instance; + }); + + deferred.resolve(); + } catch (err) { + deferred.reject(err); + } + + return promise; +} + +module.exports = loadRelations; diff --git a/src/datastore/async_methods/refresh.js b/src/datastore/async_methods/refresh.js index ba55ecc..53f8144 100644 --- a/src/datastore/async_methods/refresh.js +++ b/src/datastore/async_methods/refresh.js @@ -31,7 +31,7 @@ var errorPrefix = 'DS.refresh(resourceName, id[, options]): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item to refresh from the server. @@ -46,27 +46,28 @@ var errorPrefix = 'DS.refresh(resourceName, id[, options]): '; * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function refresh(resourceName, id, options) { - options = options || {}; + var IA = this.errors.IA; - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } else if (!this.utils.isObject(options)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!', { options: { actual: typeof options, expected: 'object' } }); - } else { - options.bypassCache = true; + options = options || {}; - if (this.get(resourceName, id)) { - return this.find(resourceName, id, options); - } else { - return false; - } - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new IA(errorPrefix + 'id: Must be a string or a number!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } else { + options.bypassCache = true; + + if (this.get(resourceName, id)) { + return this.find(resourceName, id, options); + } else { + return false; + } + } } module.exports = refresh; diff --git a/src/datastore/async_methods/save.js b/src/datastore/async_methods/save.js index c353e4c..0429171 100644 --- a/src/datastore/async_methods/save.js +++ b/src/datastore/async_methods/save.js @@ -40,78 +40,85 @@ var errorPrefix = 'DS.save(resourceName, id[, options]): '; * * - `{IllegalArgumentError}` * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function save(resourceName, id, options) { - var deferred = this.$q.defer(), - promise = deferred.promise; + var deferred = this.$q.defer(); + var promise = deferred.promise; - options = options || {}; + try { + var IA = this.errors.IA; - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } })); - } else if (!this.utils.isObject(options)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!', { options: { actual: typeof options, expected: 'object' } })); - } else { - var item = this.get(resourceName, id); - if (!item) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + 'id: "' + id + '" not found!')); - } else { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; + options = options || {}; - promise = promise - .then(function (attrs) { - return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.validate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.beforeUpdate)(resourceName, attrs); - }) - .then(function (attrs) { - if (options.changesOnly) { - resource.observers[id].deliver(); - var toKeep = [], - changes = _this.changes(resourceName, id); + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new IA(errorPrefix + 'id: Must be a string or a number!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } - for (var key in changes.added) { - toKeep.push(key); - } - for (key in changes.changed) { - toKeep.push(key); - } - changes = _this.utils.pick(attrs, toKeep); - if (_this.utils.isEmpty(changes)) { - // no changes, return - return attrs; - } else { - attrs = changes; - } - } - return _this.adapters[options.adapter || definition.defaultAdapter].update(definition, id, definition.serialize(resourceName, attrs), options); - }) - .then(function (res) { - return _this.$q.promisify(definition.afterUpdate)(resourceName, definition.deserialize(resourceName, res)); - }) - .then(function (data) { - _this.inject(definition.name, data, options); - resource.previousAttributes[id] = _this.utils.deepMixIn({}, data); - resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); - return _this.get(resourceName, id); - }); + var item = this.get(resourceName, id); + if (!item) { + throw new this.errors.R(errorPrefix + 'id: "' + id + '" not found!'); + } - deferred.resolve(item); - } - } - return promise; + var definition = this.definitions[resourceName]; + var resource = this.store[resourceName]; + var _this = this; + + promise = promise + .then(function (attrs) { + return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.validate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.beforeUpdate)(resourceName, attrs); + }) + .then(function (attrs) { + if (options.changesOnly) { + resource.observers[id].deliver(); + var toKeep = [], + changes = _this.changes(resourceName, id); + + for (var key in changes.added) { + toKeep.push(key); + } + for (key in changes.changed) { + toKeep.push(key); + } + changes = _this.utils.pick(attrs, toKeep); + if (_this.utils.isEmpty(changes)) { + // no changes, return + return attrs; + } else { + attrs = changes; + } + } + return _this.adapters[options.adapter || definition.defaultAdapter].update(definition, id, definition.serialize(resourceName, attrs), options); + }) + .then(function (res) { + return _this.$q.promisify(definition.afterUpdate)(resourceName, definition.deserialize(resourceName, res)); + }) + .then(function (data) { + _this.inject(definition.name, data, options); + resource.previousAttributes[id] = _this.utils.deepMixIn({}, data); + resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); + return _this.get(resourceName, id); + }); + + deferred.resolve(item); + } catch (err) { + deferred.reject(err); + } + + return promise; } module.exports = save; diff --git a/src/datastore/async_methods/update.js b/src/datastore/async_methods/update.js index 0c9f5af..784e756 100644 --- a/src/datastore/async_methods/update.js +++ b/src/datastore/async_methods/update.js @@ -42,68 +42,74 @@ var errorPrefix = 'DS.update(resourceName, id, attrs[, options]): '; * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function update(resourceName, id, attrs, options) { - var deferred = this.$q.defer(), - promise = deferred.promise; + var deferred = this.$q.defer(); + var promise = deferred.promise; - options = options || {}; + try { + var IA = this.errors.IA; - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!')); - } else if (!this.utils.isObject(attrs)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'attrs: Must be an object!')); - } else if (!this.utils.isObject(options)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!')); - } else { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; + options = options || {}; - if (!('cacheResponse' in options)) { - options.cacheResponse = true; - } else { - options.cacheResponse = !!options.cacheResponse; - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new IA(errorPrefix + 'id: Must be a string or a number!'); + } else if (!this.utils.isObject(attrs)) { + throw new IA(errorPrefix + 'attrs: Must be an object!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } - promise = promise - .then(function (attrs) { - return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.validate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.beforeUpdate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.adapters[options.adapter || definition.defaultAdapter].update(definition, id, definition.serialize(resourceName, attrs), options); - }) - .then(function (res) { - return _this.$q.promisify(definition.afterUpdate)(resourceName, definition.deserialize(resourceName, res)); - }) - .then(function (data) { - if (options.cacheResponse) { - var updated = _this.inject(definition.name, data, options); - var id = updated[definition.idAttribute]; - resource.previousAttributes[id] = _this.utils.deepMixIn({}, updated); - resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); - return _this.get(definition.name, id); - } else { - return data; - } - }); + var definition = this.definitions[resourceName]; + var resource = this.store[resourceName]; + var _this = this; - deferred.resolve(attrs); - } - return promise; + if (!('cacheResponse' in options)) { + options.cacheResponse = true; + } else { + options.cacheResponse = !!options.cacheResponse; + } + + promise = promise + .then(function (attrs) { + return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.validate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.beforeUpdate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.adapters[options.adapter || definition.defaultAdapter].update(definition, id, definition.serialize(resourceName, attrs), options); + }) + .then(function (res) { + return _this.$q.promisify(definition.afterUpdate)(resourceName, definition.deserialize(resourceName, res)); + }) + .then(function (data) { + if (options.cacheResponse) { + var updated = _this.inject(definition.name, data, options); + var id = updated[definition.idAttribute]; + resource.previousAttributes[id] = _this.utils.deepMixIn({}, updated); + resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); + return _this.get(definition.name, id); + } else { + return data; + } + }); + + deferred.resolve(attrs); + } catch (err) { + deferred.reject(err); + } + + return promise; } module.exports = update; diff --git a/src/datastore/async_methods/updateAll.js b/src/datastore/async_methods/updateAll.js index 2b31fc7..a78f65a 100644 --- a/src/datastore/async_methods/updateAll.js +++ b/src/datastore/async_methods/updateAll.js @@ -20,11 +20,9 @@ var errorPrefix = 'DS.updateAll(resourceName, attrs, params[, options]): '; * DS.filter('document'); // [] * * DS.updateAll('document', 5, { author: 'Sally' }, { - * query: { - * where: { - * author: { - * '==': 'John Anderson' - * } + * where: { + * author: { + * '==': 'John Anderson' * } * } * }) @@ -40,11 +38,11 @@ var errorPrefix = 'DS.updateAll(resourceName, attrs, params[, options]): '; * @param {object} attrs The attributes with which to update the items. * @param {object} params Parameter object that is serialized into the query string. Properties: * - * - `{object=}` - `query` - The query object by which to filter items of the type specified by `resourceName`. Properties: - * - `{object=}` - `where` - Where clause. - * - `{number=}` - `limit` - Limit clause. - * - `{skip=}` - `skip` - Skip clause. - * - `{orderBy=}` - `orderBy` - OrderBy clause. + * - `{object=}` - `where` - Where clause. + * - `{number=}` - `limit` - Limit clause. + * - `{number=}` - `skip` - Skip clause. + * - `{number=}` - `offset` - Same as skip. + * - `{string|array=}` - `orderBy` - OrderBy clause. * * @param {object=} options Optional configuration. Properties: * - `{boolean=}` - `cacheResponse` - Inject the data returned by the server into the data store. Default: `true`. @@ -58,64 +56,69 @@ var errorPrefix = 'DS.updateAll(resourceName, attrs, params[, options]): '; * ## Rejects with: * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` */ function updateAll(resourceName, attrs, params, options) { - var deferred = this.$q.defer(), - promise = deferred.promise; + var deferred = this.$q.defer(); + var promise = deferred.promise; - options = options || {}; + try { + var IA = this.errors.IA; - if (!this.definitions[resourceName]) { - deferred.reject(new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!')); - } else if (!this.utils.isObject(attrs)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'attrs: Must be an object!')); - } else if (!this.utils.isObject(params)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'params: Must be an object!')); - } else if (!this.utils.isObject(options)) { - deferred.reject(new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!')); - } else { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; + options = options || {}; - if (!('cacheResponse' in options)) { - options.cacheResponse = true; - } else { - options.cacheResponse = !!options.cacheResponse; - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(attrs)) { + throw new IA(errorPrefix + 'attrs: Must be an object!'); + } else if (!this.utils.isObject(params)) { + throw new IA(errorPrefix + 'params: Must be an object!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } - promise = promise - .then(function (attrs) { - return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.validate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.$q.promisify(definition.beforeUpdate)(resourceName, attrs); - }) - .then(function (attrs) { - return _this.adapters[options.adapter || definition.defaultAdapter].updateAll(definition, definition.serialize(resourceName, attrs), params, options); - }) - .then(function (res) { - return _this.$q.promisify(definition.afterUpdate)(resourceName, definition.deserialize(resourceName, res)); - }) - .then(function (data) { - if (options.cacheResponse) { - return _this.inject(definition.name, data, options); - } else { - return data; - } - }); + var definition = this.definitions[resourceName]; + var _this = this; - deferred.resolve(attrs); - } - return promise; + if (!('cacheResponse' in options)) { + options.cacheResponse = true; + } else { + options.cacheResponse = !!options.cacheResponse; + } + + promise = promise + .then(function (attrs) { + return _this.$q.promisify(definition.beforeValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.validate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.afterValidate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.$q.promisify(definition.beforeUpdate)(resourceName, attrs); + }) + .then(function (attrs) { + return _this.adapters[options.adapter || definition.defaultAdapter].updateAll(definition, definition.serialize(resourceName, attrs), params, options); + }) + .then(function (res) { + return _this.$q.promisify(definition.afterUpdate)(resourceName, definition.deserialize(resourceName, res)); + }) + .then(function (data) { + if (options.cacheResponse) { + return _this.inject(definition.name, data, options); + } else { + return data; + } + }); + + deferred.resolve(attrs); + } catch (err) { + deferred.reject(err); + } + + return promise; } module.exports = updateAll; diff --git a/src/datastore/index.js b/src/datastore/index.js index f5f102b..61a618b 100644 --- a/src/datastore/index.js +++ b/src/datastore/index.js @@ -1,48 +1,193 @@ var utils = require('../utils')[0](); function lifecycleNoop(resourceName, attrs, cb) { - cb(null, attrs); + cb(null, attrs); } -function BaseConfig() { +function Defaults() { } -BaseConfig.prototype.idAttribute = 'id'; -BaseConfig.prototype.defaultAdapter = 'DSHttpAdapter'; -BaseConfig.prototype.filter = function (resourceName, where, attrs) { - var keep = true; - utils.forOwn(where, function (clause, field) { - if (utils.isString(clause)) { - clause = { - '===': clause - }; - } else if (utils.isNumber(clause)) { - clause = { - '==': clause - }; - } - if ('==' in clause) { - keep = keep && (attrs[field] == clause['==']); - } else if ('===' in clause) { - keep = keep && (attrs[field] === clause['===']); - } else if ('!=' in clause) { - keep = keep && (attrs[field] != clause['!=']); - } else if ('>' in clause) { - keep = keep && (attrs[field] > clause['>']); - } else if ('>=' in clause) { - keep = keep && (attrs[field] >= clause['>=']); - } else if ('<' in clause) { - keep = keep && (attrs[field] < clause['<']); - } else if ('<=' in clause) { - keep = keep && (attrs[field] <= clause['<=']); - } else if ('in' in clause) { - keep = keep && utils.contains(clause['in'], attrs[field]); - } - }); - return keep; +Defaults.prototype.idAttribute = 'id'; +Defaults.prototype.defaultAdapter = 'DSHttpAdapter'; +Defaults.prototype.filter = function (collection, resourceName, params, options) { + var _this = this; + var filtered = collection; + var where = null; + var reserved = { + skip: '', + offset: '', + where: '', + limit: '', + orderBy: '', + sort: '' + }; + + if (this.utils.isObject(params.where)) { + where = params.where; + } else { + where = {}; + } + + if (options.allowSimpleWhere) { + this.utils.forOwn(params, function (value, key) { + if (!(key in reserved) && !(key in where)) { + where[key] = { + '==': value + }; + } + }); + } + + if (this.utils.isEmpty(where)) { + where = null; + } + + if (where) { + filtered = this.utils.filter(filtered, function (attrs) { +// console.log(attrs); + var first = true; + var keep = true; + _this.utils.forOwn(where, function (clause, field) { +// console.log(clause, field); + if (_this.utils.isString(clause)) { + clause = { + '===': clause + }; + } else if (_this.utils.isNumber(clause)) { + clause = { + '==': clause + }; + } + if (_this.utils.isObject(clause)) { + _this.utils.forOwn(clause, function (val, op) { +// console.log(op, val); + if (op === '==') { + keep = first ? (attrs[field] == val) : keep && (attrs[field] == val); + } else if (op === '===') { + keep = first ? (attrs[field] === val) : keep && (attrs[field] === val); + } else if (op === '!=') { + keep = first ? (attrs[field] != val) : keep && (attrs[field] != val); + } else if (op === '!==') { + keep = first ? (attrs[field] !== val) : keep && (attrs[field] !== val); + } else if (op === '>') { + keep = first ? (attrs[field] > val) : keep && (attrs[field] > val); + } else if (op === '>=') { + keep = first ? (attrs[field] >= val) : keep && (attrs[field] >= val); + } else if (op === '<') { + keep = first ? (attrs[field] < val) : keep && (attrs[field] < val); + } else if (op === '<=') { + keep = first ? (attrs[field] <= val) : keep && (attrs[field] <= val); + } else if (op === 'in') { + keep = first ? _this.utils.contains(val, attrs[field]) : keep && _this.utils.contains(val, attrs[field]); + } else if (op === '|==') { + keep = first ? (attrs[field] == val) : keep || (attrs[field] == val); + } else if (op === '|===') { + keep = first ? (attrs[field] === val) : keep || (attrs[field] === val); + } else if (op === '|!=') { + keep = first ? (attrs[field] != val) : keep || (attrs[field] != val); + } else if (op === '|!==') { + keep = first ? (attrs[field] !== val) : keep || (attrs[field] !== val); + } else if (op === '|>') { + keep = first ? (attrs[field] > val) : keep || (attrs[field] > val); + } else if (op === '|>=') { + keep = first ? (attrs[field] >= val) : keep || (attrs[field] >= val); + } else if (op === '|<') { + keep = first ? (attrs[field] < val) : keep || (attrs[field] < val); + } else if (op === '|<=') { + keep = first ? (attrs[field] <= val) : keep || (attrs[field] <= val); + } else if (op === '|in') { + keep = first ? _this.utils.contains(val, attrs[field]) : keep || _this.utils.contains(val, attrs[field]); + } + first = false; +// console.log(keep, first); + }); + } + }); + return keep; + }); + } + + var orderBy = null; + + if (this.utils.isString(params.orderBy)) { + orderBy = [ + [params.orderBy, 'ASC'] + ]; + } else if (this.utils.isArray(params.orderBy)) { + orderBy = params.orderBy; + } + + if (!orderBy && this.utils.isString(params.sort)) { + orderBy = [ + [params.sort, 'ASC'] + ]; + } else if (!orderBy && this.utils.isArray(params.sort)) { + orderBy = params.sort; + } + + // Apply 'orderBy' + if (orderBy) { + angular.forEach(orderBy, function (def) { + if (_this.utils.isString(def)) { + def = [def, 'ASC']; + } else if (!_this.utils.isArray(def)) { + throw new _this.errors.IllegalArgumentError('DS.filter(resourceName[, params][, options]): ' + angular.toJson(def) + ': Must be a string or an array!', { params: { 'orderBy[i]': { actual: typeof def, expected: 'string|array' } } }); + } + filtered = _this.utils.sort(filtered, function (a, b) { + var cA = a[def[0]], cB = b[def[0]]; + if (_this.utils.isString(cA)) { + cA = _this.utils.upperCase(cA); + } + if (_this.utils.isString(cB)) { + cB = _this.utils.upperCase(cB); + } + if (def[1] === 'DESC') { + if (cB < cA) { + return -1; + } else if (cB > cA) { + return 1; + } else { + return 0; + } + } else { + if (cA < cB) { + return -1; + } else if (cA > cB) { + return 1; + } else { + return 0; + } + } + }); + }); + } + + var limit = angular.isNumber(params.limit) ? params.limit : null; + var skip = null; + + if (angular.isNumber(params.skip)) { + skip = params.skip; + } else if (angular.isNumber(params.offset)) { + skip = params.offset; + } + + // Apply 'limit' and 'skip' + if (limit && skip) { + filtered = this.utils.slice(filtered, skip, Math.min(filtered.length, skip + limit)); + } else if (this.utils.isNumber(limit)) { + filtered = this.utils.slice(filtered, 0, Math.min(filtered.length, limit)); + } else if (this.utils.isNumber(skip)) { + if (skip < filtered.length) { + filtered = this.utils.slice(filtered, skip); + } else { + filtered = []; + } + } + + return filtered; }; -BaseConfig.prototype.baseUrl = ''; -BaseConfig.prototype.endpoint = ''; +Defaults.prototype.baseUrl = ''; +Defaults.prototype.endpoint = ''; /** * @doc property * @id DSProvider.properties:defaults.beforeValidate @@ -73,7 +218,7 @@ BaseConfig.prototype.endpoint = ''; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.beforeValidate = lifecycleNoop; +Defaults.prototype.beforeValidate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.validate @@ -104,7 +249,7 @@ BaseConfig.prototype.beforeValidate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.validate = lifecycleNoop; +Defaults.prototype.validate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.afterValidate @@ -135,7 +280,7 @@ BaseConfig.prototype.validate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.afterValidate = lifecycleNoop; +Defaults.prototype.afterValidate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.beforeCreate @@ -166,7 +311,7 @@ BaseConfig.prototype.afterValidate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.beforeCreate = lifecycleNoop; +Defaults.prototype.beforeCreate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.afterCreate @@ -197,7 +342,7 @@ BaseConfig.prototype.beforeCreate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.afterCreate = lifecycleNoop; +Defaults.prototype.afterCreate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.beforeUpdate @@ -228,7 +373,7 @@ BaseConfig.prototype.afterCreate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.beforeUpdate = lifecycleNoop; +Defaults.prototype.beforeUpdate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.afterUpdate @@ -259,7 +404,7 @@ BaseConfig.prototype.beforeUpdate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.afterUpdate = lifecycleNoop; +Defaults.prototype.afterUpdate = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.beforeDestroy @@ -290,7 +435,7 @@ BaseConfig.prototype.afterUpdate = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.beforeDestroy = lifecycleNoop; +Defaults.prototype.beforeDestroy = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.afterDestroy @@ -321,7 +466,7 @@ BaseConfig.prototype.beforeDestroy = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.afterDestroy = lifecycleNoop; +Defaults.prototype.afterDestroy = lifecycleNoop; /** * @doc property * @id DSProvider.properties:defaults.beforeInject @@ -346,8 +491,8 @@ BaseConfig.prototype.afterDestroy = lifecycleNoop; * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.beforeInject = function (resourceName, attrs) { - return attrs; +Defaults.prototype.beforeInject = function (resourceName, attrs) { + return attrs; }; /** * @doc property @@ -373,8 +518,8 @@ BaseConfig.prototype.beforeInject = function (resourceName, attrs) { * @param {string} resourceName The name of the resource moving through the lifecycle. * @param {object} attrs Attributes of the item moving through the lifecycle. */ -BaseConfig.prototype.afterInject = function (resourceName, attrs) { - return attrs; +Defaults.prototype.afterInject = function (resourceName, attrs) { + return attrs; }; /** * @doc property @@ -397,8 +542,8 @@ BaseConfig.prototype.afterInject = function (resourceName, attrs) { * @param {object} data Data to be sent to the server. * @returns {*} By default returns `data` as-is. */ -BaseConfig.prototype.serialize = function (resourceName, data) { - return data; +Defaults.prototype.serialize = function (resourceName, data) { + return data; }; /** @@ -420,8 +565,8 @@ BaseConfig.prototype.serialize = function (resourceName, data) { * @param {object} data Response object from `$http()`. * @returns {*} By default returns `data.data`. */ -BaseConfig.prototype.deserialize = function (resourceName, data) { - return data.data; +Defaults.prototype.deserialize = function (resourceName, data) { + return data.data; }; /** @@ -431,147 +576,148 @@ BaseConfig.prototype.deserialize = function (resourceName, data) { */ function DSProvider() { - /** - * @doc property - * @id DSProvider.properties:defaults - * @name defaults - * @description - * See the [configuration guide](/documentation/guide/configure/global). - * - * Properties: - * - * - `{string}` - `baseUrl` - The url relative to which all AJAX requests will be made. - * - `{string}` - `idAttribute` - Default: `"id"` - The attribute that specifies the primary key for resources. - * - `{string}` - `defaultAdapter` - Default: `"DSHttpAdapter"` - * - `{function}` - `filter` - Default: See [angular-data query language](/documentation/guide/queries/custom). - * - `{function}` - `beforeValidate` - See [DSProvider.defaults.beforeValidate](/documentation/api/angular-data/DSProvider.properties:defaults.beforeValidate). Default: No-op - * - `{function}` - `validate` - See [DSProvider.defaults.validate](/documentation/api/angular-data/DSProvider.properties:defaults.validate). Default: No-op - * - `{function}` - `afterValidate` - See [DSProvider.defaults.afterValidate](/documentation/api/angular-data/DSProvider.properties:defaults.afterValidate). Default: No-op - * - `{function}` - `beforeCreate` - See [DSProvider.defaults.beforeCreate](/documentation/api/angular-data/DSProvider.properties:defaults.beforeCreate). Default: No-op - * - `{function}` - `afterCreate` - See [DSProvider.defaults.afterCreate](/documentation/api/angular-data/DSProvider.properties:defaults.afterCreate). Default: No-op - * - `{function}` - `beforeUpdate` - See [DSProvider.defaults.beforeUpdate](/documentation/api/angular-data/DSProvider.properties:defaults.beforeUpdate). Default: No-op - * - `{function}` - `afterUpdate` - See [DSProvider.defaults.afterUpdate](/documentation/api/angular-data/DSProvider.properties:defaults.afterUpdate). Default: No-op - * - `{function}` - `beforeDestroy` - See [DSProvider.defaults.beforeDestroy](/documentation/api/angular-data/DSProvider.properties:defaults.beforeDestroy). Default: No-op - * - `{function}` - `afterDestroy` - See [DSProvider.defaults.afterDestroy](/documentation/api/angular-data/DSProvider.properties:defaults.afterDestroy). Default: No-op - * - `{function}` - `afterInject` - See [DSProvider.defaults.afterInject](/documentation/api/angular-data/DSProvider.properties:defaults.afterInject). Default: No-op - * - `{function}` - `beforeInject` - See [DSProvider.defaults.beforeInject](/documentation/api/angular-data/DSProvider.properties:defaults.beforeInject). Default: No-op - * - `{function}` - `serialize` - See [DSProvider.defaults.serialize](/documentation/api/angular-data/DSProvider.properties:defaults.serialize). Default: No-op - * - `{function}` - `deserialize` - See [DSProvider.defaults.deserialize](/documentation/api/angular-data/DSProvider.properties:defaults.deserialize). Default: No-op - */ - var defaults = this.defaults = new BaseConfig(); - - this.$get = [ - '$rootScope', '$log', '$q', 'DSHttpAdapter', 'DSLocalStorageAdapter', 'DSUtils', 'DSErrors', - function ($rootScope, $log, $q, DSHttpAdapter, DSLocalStorageAdapter, DSUtils, DSErrors) { - - var syncMethods = require('./sync_methods'), - asyncMethods = require('./async_methods'), - cache; - - try { - cache = angular.injector(['angular-data.DSCacheFactory']).get('DSCacheFactory'); - } catch (err) { - $log.warn(err); - $log.warn('DSCacheFactory is unavailable. Resorting to the lesser capabilities of $cacheFactory.'); - cache = angular.injector(['ng']).get('$cacheFactory'); - } - - /** - * @doc interface - * @id DS - * @name DS - * @description - * Public data store interface. Consists of several properties and a number of methods. Injectable as `DS`. - * - * See the [guide](/documentation/guide/overview/index). - */ - var DS = { - $rootScope: $rootScope, - $log: $log, - $q: $q, - - cacheFactory: cache, - - /** - * @doc property - * @id DS.properties:defaults - * @name defaults - * @description - * Reference to [DSProvider.defaults](/documentation/api/api/DSProvider.properties:defaults). - */ - defaults: defaults, - - /*! - * @doc property - * @id DS.properties:store - * @name store - * @description - * Meta data for each registered resource. - */ - store: {}, - - /*! - * @doc property - * @id DS.properties:definitions - * @name definitions - * @description - * Registered resource definitions available to the data store. - */ - definitions: {}, - - /** - * @doc property - * @id DS.properties:adapters - * @name adapters - * @description - * Registered adapters available to the data store. Object consists of key-values pairs where the key is - * the name of the adapter and the value is the adapter itself. - */ - adapters: { - DSHttpAdapter: DSHttpAdapter, - DSLocalStorageAdapter: DSLocalStorageAdapter - }, - - /** - * @doc property - * @id DS.properties:errors - * @name errors - * @description - * References to the various [error types](/documentation/api/api/errors) used by angular-data. - */ - errors: DSErrors, - - /*! - * @doc property - * @id DS.properties:utils - * @name utils - * @description - * Utility functions used internally by angular-data. - */ - utils: DSUtils - }; - - DSUtils.deepFreeze(syncMethods); - DSUtils.deepFreeze(asyncMethods); - - DSUtils.deepMixIn(DS, syncMethods); - DSUtils.deepMixIn(DS, asyncMethods); - - DSUtils.deepFreeze(DS.errors); - DSUtils.deepFreeze(DS.utils); - - var $dirtyCheckScope = $rootScope.$new(); - - $dirtyCheckScope.$watch(function () { - // Throttle angular-data's digest loop to tenths of a second - // TODO: Is this okay? - return new Date().getTime() / 100 | 0; - }, function () { - DS.digest(); - }); - - return DS; - }]; + /** + * @doc property + * @id DSProvider.properties:defaults + * @name defaults + * @description + * See the [configuration guide](/documentation/guide/configure/global). + * + * Properties: + * + * - `{string}` - `baseUrl` - The url relative to which all AJAX requests will be made. + * - `{string}` - `idAttribute` - Default: `"id"` - The attribute that specifies the primary key for resources. + * - `{string}` - `defaultAdapter` - Default: `"DSHttpAdapter"` + * - `{function}` - `filter` - Default: See [angular-data query language](/documentation/guide/queries/custom). + * - `{function}` - `beforeValidate` - See [DSProvider.defaults.beforeValidate](/documentation/api/angular-data/DSProvider.properties:defaults.beforeValidate). Default: No-op + * - `{function}` - `validate` - See [DSProvider.defaults.validate](/documentation/api/angular-data/DSProvider.properties:defaults.validate). Default: No-op + * - `{function}` - `afterValidate` - See [DSProvider.defaults.afterValidate](/documentation/api/angular-data/DSProvider.properties:defaults.afterValidate). Default: No-op + * - `{function}` - `beforeCreate` - See [DSProvider.defaults.beforeCreate](/documentation/api/angular-data/DSProvider.properties:defaults.beforeCreate). Default: No-op + * - `{function}` - `afterCreate` - See [DSProvider.defaults.afterCreate](/documentation/api/angular-data/DSProvider.properties:defaults.afterCreate). Default: No-op + * - `{function}` - `beforeUpdate` - See [DSProvider.defaults.beforeUpdate](/documentation/api/angular-data/DSProvider.properties:defaults.beforeUpdate). Default: No-op + * - `{function}` - `afterUpdate` - See [DSProvider.defaults.afterUpdate](/documentation/api/angular-data/DSProvider.properties:defaults.afterUpdate). Default: No-op + * - `{function}` - `beforeDestroy` - See [DSProvider.defaults.beforeDestroy](/documentation/api/angular-data/DSProvider.properties:defaults.beforeDestroy). Default: No-op + * - `{function}` - `afterDestroy` - See [DSProvider.defaults.afterDestroy](/documentation/api/angular-data/DSProvider.properties:defaults.afterDestroy). Default: No-op + * - `{function}` - `afterInject` - See [DSProvider.defaults.afterInject](/documentation/api/angular-data/DSProvider.properties:defaults.afterInject). Default: No-op + * - `{function}` - `beforeInject` - See [DSProvider.defaults.beforeInject](/documentation/api/angular-data/DSProvider.properties:defaults.beforeInject). Default: No-op + * - `{function}` - `serialize` - See [DSProvider.defaults.serialize](/documentation/api/angular-data/DSProvider.properties:defaults.serialize). Default: No-op + * - `{function}` - `deserialize` - See [DSProvider.defaults.deserialize](/documentation/api/angular-data/DSProvider.properties:defaults.deserialize). Default: No-op + */ + var defaults = this.defaults = new Defaults(); + + this.$get = [ + '$rootScope', '$log', '$q', 'DSHttpAdapter', 'DSLocalStorageAdapter', 'DSUtils', 'DSErrors', + function ($rootScope, $log, $q, DSHttpAdapter, DSLocalStorageAdapter, DSUtils, DSErrors) { + + var syncMethods = require('./sync_methods'), + asyncMethods = require('./async_methods'), + cache; + + try { + cache = angular.injector(['angular-data.DSCacheFactory']).get('DSCacheFactory'); + } catch (err) { + $log.warn(err); + $log.warn('DSCacheFactory is unavailable. Resorting to the lesser capabilities of $cacheFactory.'); + cache = angular.injector(['ng']).get('$cacheFactory'); + } + + /** + * @doc interface + * @id DS + * @name DS + * @description + * Public data store interface. Consists of several properties and a number of methods. Injectable as `DS`. + * + * See the [guide](/documentation/guide/overview/index). + */ + var DS = { + $rootScope: $rootScope, + $log: $log, + $q: $q, + + cacheFactory: cache, + + /** + * @doc property + * @id DS.properties:defaults + * @name defaults + * @description + * Reference to [DSProvider.defaults](/documentation/api/api/DSProvider.properties:defaults). + */ + defaults: defaults, + + /*! + * @doc property + * @id DS.properties:store + * @name store + * @description + * Meta data for each registered resource. + */ + store: {}, + + /*! + * @doc property + * @id DS.properties:definitions + * @name definitions + * @description + * Registered resource definitions available to the data store. + */ + definitions: {}, + + /** + * @doc property + * @id DS.properties:adapters + * @name adapters + * @description + * Registered adapters available to the data store. Object consists of key-values pairs where the key is + * the name of the adapter and the value is the adapter itself. + */ + adapters: { + DSHttpAdapter: DSHttpAdapter, + DSLocalStorageAdapter: DSLocalStorageAdapter + }, + + /** + * @doc property + * @id DS.properties:errors + * @name errors + * @description + * References to the various [error types](/documentation/api/api/errors) used by angular-data. + */ + errors: DSErrors, + + /*! + * @doc property + * @id DS.properties:utils + * @name utils + * @description + * Utility functions used internally by angular-data. + */ + utils: DSUtils + }; + + DSUtils.deepFreeze(syncMethods); + DSUtils.deepFreeze(asyncMethods); + + DSUtils.deepMixIn(DS, syncMethods); + DSUtils.deepMixIn(DS, asyncMethods); + + DSUtils.deepFreeze(DS.errors); + DSUtils.deepFreeze(DS.utils); + + var $dirtyCheckScope = $rootScope.$new(); + + $dirtyCheckScope.$watch(function () { + // Throttle angular-data's digest loop to tenths of a second + // TODO: Is this okay? + return new Date().getTime() / 100 | 0; + }, function () { + DS.digest(); + }); + + return DS; + } + ]; } module.exports = DSProvider; diff --git a/src/datastore/sync_methods/bindAll.js b/src/datastore/sync_methods/bindAll.js index 045275b..600fdd0 100644 --- a/src/datastore/sync_methods/bindAll.js +++ b/src/datastore/sync_methods/bindAll.js @@ -1,4 +1,4 @@ -var errorPrefix = 'DS.bindAll(scope, expr, resourceName, params): '; +var errorPrefix = 'DS.bindAll(scope, expr, resourceName, params[, cb]): '; /** * @doc method @@ -9,7 +9,7 @@ var errorPrefix = 'DS.bindAll(scope, expr, resourceName, params): '; * * ## Signature: * ```js - * DS.bindAll(scope, expr, resourceName, params) + * DS.bindAll(scope, expr, resourceName, params[, cb]) * ``` * * ## Example: @@ -17,10 +17,8 @@ var errorPrefix = 'DS.bindAll(scope, expr, resourceName, params): '; * ```js * // bind the documents with ownerId of 5 to the 'docs' property of the $scope * var deregisterFunc = DS.bindAll($scope, 'docs', 'document', { - * query: { - * criteria: { - * ownerId: 5 - * } + * where: { + * ownerId: 5 * } * }); * ``` @@ -28,43 +26,55 @@ var errorPrefix = 'DS.bindAll(scope, expr, resourceName, params): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {object} scope The scope to bind to. * @param {string} expr An expression used to bind to the scope. Can be used to set nested keys, i.e. `"user.comments"`. * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {object} params Parameter object that is used in filtering the collection. Properties: * - * - `{object=}` - `query` - The query object by which to filter items of the type specified by `resourceName`. Properties: - * - `{object=}` - `where` - Where clause. - * - `{number=}` - `limit` - Limit clause. - * - `{skip=}` - `skip` - Skip clause. - * - `{orderBy=}` - `orderBy` - OrderBy clause. + * - `{object=}` - `where` - Where clause. + * - `{number=}` - `limit` - Limit clause. + * - `{number=}` - `skip` - Skip clause. + * - `{number=}` - `offset` - Same as skip. + * - `{string|array=}` - `orderBy` - OrderBy clause. + * + * @param {function=} cb Optional callback executed on change. Signature: `cb(err, items)`. + * * @returns {function} Scope $watch deregistration function. */ -function bindOne(scope, expr, resourceName, params) { - if (!this.utils.isObject(scope)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'scope: Must be an object!'); - } else if (!this.utils.isString(expr)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'expr: Must be a string!'); - } else if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isObject(params)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'params: Must be an object!'); - } +function bindOne(scope, expr, resourceName, params, cb) { + var IA = this.errors.IA; + + if (!this.utils.isObject(scope)) { + throw new IA(errorPrefix + 'scope: Must be an object!'); + } else if (!this.utils.isString(expr)) { + throw new IA(errorPrefix + 'expr: Must be a string!'); + } else if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(params)) { + throw new IA(errorPrefix + 'params: Must be an object!'); + } - var _this = this; + var _this = this; - try { - return scope.$watch(function () { - return _this.lastModified(resourceName); - }, function () { - _this.utils.set(scope, expr, _this.filter(resourceName, params)); - }); - } catch (err) { - throw new this.errors.UnhandledError(err); - } + try { + return scope.$watch(function () { + return _this.lastModified(resourceName); + }, function () { + var items = _this.filter(resourceName, params); + _this.utils.set(scope, expr, items); + if (cb) { + cb(null, items); + } + }); + } catch (err) { + if (cb) { + cb(err); + } else { + throw err; + } + } } module.exports = bindOne; diff --git a/src/datastore/sync_methods/bindOne.js b/src/datastore/sync_methods/bindOne.js index 83fcd96..5985750 100644 --- a/src/datastore/sync_methods/bindOne.js +++ b/src/datastore/sync_methods/bindOne.js @@ -1,4 +1,4 @@ -var errorPrefix = 'DS.bindOne(scope, expr, resourceName, id): '; +var errorPrefix = 'DS.bindOne(scope, expr, resourceName, id[, cb]): '; /** * @doc method @@ -9,7 +9,7 @@ var errorPrefix = 'DS.bindOne(scope, expr, resourceName, id): '; * * ## Signature: * ```js - * DS.bindOne(scope, expr, resourceName, id) + * DS.bindOne(scope, expr, resourceName, id[, cb]) * ``` * * ## Example: @@ -22,37 +22,47 @@ var errorPrefix = 'DS.bindOne(scope, expr, resourceName, id): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {object} scope The scope to bind to. * @param {string} expr An expression used to bind to the scope. Can be used to set nested keys, i.e. `"user.profile"`. * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item to bind. + * @param {function=} cb Optional callback executed on change. Signature: `cb(err, item)`. * @returns {function} Scope $watch deregistration function. */ -function bindOne(scope, expr, resourceName, id) { - if (!this.utils.isObject(scope)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'scope: Must be an object!'); - } else if (!this.utils.isString(expr)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'expr: Must be a string!'); - } else if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!'); - } +function bindOne(scope, expr, resourceName, id, cb) { + var IA = this.errors.IA; - var _this = this; + if (!this.utils.isObject(scope)) { + throw new IA(errorPrefix + 'scope: Must be an object!'); + } else if (!this.utils.isString(expr)) { + throw new IA(errorPrefix + 'expr: Must be a string!'); + } else if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new IA(errorPrefix + 'id: Must be a string or a number!'); + } - try { - return scope.$watch(function () { - return _this.lastModified(resourceName, id); - }, function () { - _this.utils.set(scope, expr, _this.get(resourceName, id)); - }); - } catch (err) { - throw new this.errors.UnhandledError(err); - } + var _this = this; + + try { + return scope.$watch(function () { + return _this.lastModified(resourceName, id); + }, function () { + var item = _this.get(resourceName, id); + _this.utils.set(scope, expr, item); + if (cb) { + cb(null, item); + } + }); + } catch (err) { + if (cb) { + cb(err); + } else { + throw err; + } + } } module.exports = bindOne; diff --git a/src/datastore/sync_methods/changes.js b/src/datastore/sync_methods/changes.js index 0da9217..3acf50f 100644 --- a/src/datastore/sync_methods/changes.js +++ b/src/datastore/sync_methods/changes.js @@ -27,29 +27,24 @@ var errorPrefix = 'DS.changes(resourceName, id): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item of the changes to retrieve. * @returns {object} The changes of the item of the type specified by `resourceName` with the primary key specified by `id`. */ function changes(resourceName, id) { - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } - try { - var item = this.get(resourceName, id); - if (item) { - this.store[resourceName].observers[id].deliver(); - return this.utils.diffObjectFromOldObject(item, this.store[resourceName].previousAttributes[id]); - } - } catch (err) { - throw new this.errors.UnhandledError(err); - } + var item = this.get(resourceName, id); + if (item) { + this.store[resourceName].observers[id].deliver(); + return this.utils.diffObjectFromOldObject(item, this.store[resourceName].previousAttributes[id]); + } } module.exports = changes; diff --git a/src/datastore/sync_methods/defineResource.js b/src/datastore/sync_methods/defineResource.js index 64fbe53..c69f98c 100644 --- a/src/datastore/sync_methods/defineResource.js +++ b/src/datastore/sync_methods/defineResource.js @@ -3,13 +3,13 @@ var errorPrefix = 'DS.defineResource(definition): '; function Resource(utils, options) { - utils.deepMixIn(this, options); + utils.deepMixIn(this, options); - if ('endpoint' in options) { - this.endpoint = options.endpoint; - } else { - this.endpoint = this.name; - } + if ('endpoint' in options) { + this.endpoint = options.endpoint; + } else { + this.endpoint = this.name; + } } /** @@ -43,7 +43,6 @@ function Resource(utils, options) { * * - `{IllegalArgumentError}` * - `{RuntimeError}` - * - `{UnhandledError}` * * @param {string|object} definition Name of resource or resource definition object: Properties: * @@ -73,68 +72,88 @@ function Resource(utils, options) { * See [DSProvider.defaults](/documentation/api/angular-data/DSProvider.properties:defaults). */ function defineResource(definition) { - if (this.utils.isString(definition)) { - definition = { - name: definition - }; - } - if (!this.utils.isObject(definition)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'definition: Must be an object!', { definition: { actual: typeof definition, expected: 'object' } }); - } else if (!this.utils.isString(definition.name)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'definition.name: Must be a string!', { definition: { name: { actual: typeof definition.name, expected: 'string' } } }); - } else if (definition.idAttribute && !this.utils.isString(definition.idAttribute)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'definition.idAttribute: Must be a string!', { definition: { idAttribute: { actual: typeof definition.idAttribute, expected: 'string' } } }); - } else if (definition.endpoint && !this.utils.isString(definition.endpoint)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'definition.endpoint: Must be a string!', { definition: { endpoint: { actual: typeof definition.endpoint, expected: 'string' } } }); - } else if (this.store[definition.name]) { - throw new this.errors.RuntimeError(errorPrefix + definition.name + ' is already registered!'); - } + var IA = this.errors.IA; - try { - Resource.prototype = this.defaults; - this.definitions[definition.name] = new Resource(this.utils, definition); + if (this.utils.isString(definition)) { + definition = { + name: definition + }; + } + if (!this.utils.isObject(definition)) { + throw new IA(errorPrefix + 'definition: Must be an object!'); + } else if (!this.utils.isString(definition.name)) { + throw new IA(errorPrefix + 'definition.name: Must be a string!'); + } else if (definition.idAttribute && !this.utils.isString(definition.idAttribute)) { + throw new IA(errorPrefix + 'definition.idAttribute: Must be a string!'); + } else if (definition.endpoint && !this.utils.isString(definition.endpoint)) { + throw new IA(errorPrefix + 'definition.endpoint: Must be a string!'); + } else if (this.store[definition.name]) { + throw new this.errors.R(errorPrefix + definition.name + ' is already registered!'); + } - var _this = this, - def = this.definitions[definition.name]; + try { + Resource.prototype = this.defaults; + this.definitions[definition.name] = new Resource(this.utils, definition); - var cache = this.cacheFactory('DS.' + def.name, { - maxAge: def.maxAge || null, - recycleFreq: def.recycleFreq || 1000, - cacheFlushInterval: def.cacheFlushInterval || null, - deleteOnExpire: def.deleteOnExpire || 'none', - onExpire: function (id) { - _this.eject(def.name, id); - }, - capacity: Number.MAX_VALUE, - storageMode: 'memory', - storageImpl: null, - disabled: false, - storagePrefix: 'DS.' + def.name - }); + var _this = this; + var def = this.definitions[definition.name]; - if (def.methods) { - def.class = definition.name[0].toUpperCase() + definition.name.substring(1); - eval('function ' + def.class + '() {}'); - def[def.class] = eval(def.class); - this.utils.deepMixIn(def[def.class].prototype, def.methods); - } + var cache = this.cacheFactory('DS.' + def.name, { + maxAge: def.maxAge || null, + recycleFreq: def.recycleFreq || 1000, + cacheFlushInterval: def.cacheFlushInterval || null, + deleteOnExpire: def.deleteOnExpire || 'none', + onExpire: function (id) { + _this.eject(def.name, id); + }, + capacity: Number.MAX_VALUE, + storageMode: 'memory', + storageImpl: null, + disabled: false, + storagePrefix: 'DS.' + def.name + }); - this.store[def.name] = { - collection: [], - completedQueries: {}, - pendingQueries: {}, - index: cache, - modified: {}, - saved: {}, - previousAttributes: {}, - observers: {}, - collectionModified: 0 - }; - } catch (err) { - delete this.definitions[definition.name]; - delete this.store[definition.name]; - throw new this.errors.UnhandledError(err); - } + if (def.methods) { + def.class = definition.name[0].toUpperCase() + definition.name.substring(1); + eval('function ' + def.class + '() {}'); + def[def.class] = eval(def.class); + this.utils.deepMixIn(def[def.class].prototype, def.methods); + } + + if (def.computed) { + this.utils.forOwn(def.computed, function (fn, field) { + if (def.methods && field in def.methods) { + _this.$log.warn(errorPrefix + 'Computed property "' + field + '" conflicts with previously defined prototype method!'); + } + var match = fn.toString().match(/function.*?\(([\s\S]*?)\)/); + var deps = match[1].split(','); + fn.deps = _this.utils.filter(deps, function (dep) { + return !!dep; + }); + angular.forEach(fn.deps, function (val, index) { + fn.deps[index] = val.trim(); + }); + }); + } + + this.store[def.name] = { + collection: [], + completedQueries: {}, + pendingQueries: {}, + index: cache, + modified: {}, + saved: {}, + previousAttributes: {}, + observers: {}, + collectionModified: 0 + }; + } + catch + (err) { + delete this.definitions[definition.name]; + delete this.store[definition.name]; + throw err; + } } module.exports = defineResource; diff --git a/src/datastore/sync_methods/digest.js b/src/datastore/sync_methods/digest.js index 333d0e8..b517b6d 100644 --- a/src/datastore/sync_methods/digest.js +++ b/src/datastore/sync_methods/digest.js @@ -19,22 +19,15 @@ var observe = require('../../../lib/observe-js/observe-js'); * Works like $scope.$apply() * ``` * - * ## Throws - * - * - `{UnhandledError}` */ function digest() { - try { - if (!this.$rootScope.$$phase) { - this.$rootScope.$apply(function () { - observe.Platform.performMicrotaskCheckpoint(); - }); - } else { - observe.Platform.performMicrotaskCheckpoint(); - } - } catch (err) { - throw new this.errors.UnhandledError(err); - } + if (!this.$rootScope.$$phase) { + this.$rootScope.$apply(function () { + observe.Platform.performMicrotaskCheckpoint(); + }); + } else { + observe.Platform.performMicrotaskCheckpoint(); + } } module.exports = digest; diff --git a/src/datastore/sync_methods/eject.js b/src/datastore/sync_methods/eject.js index e6b22fd..e54ed22 100644 --- a/src/datastore/sync_methods/eject.js +++ b/src/datastore/sync_methods/eject.js @@ -1,23 +1,23 @@ var errorPrefix = 'DS.eject(resourceName, id): '; function _eject(definition, resource, id) { - var found = false; - for (var i = 0; i < resource.collection.length; i++) { - if (resource.collection[i][definition.idAttribute] == id) { - found = true; - break; - } - } - if (found) { - resource.collection.splice(i, 1); - resource.observers[id].close(); - delete resource.observers[id]; + var found = false; + for (var i = 0; i < resource.collection.length; i++) { + if (resource.collection[i][definition.idAttribute] == id) { + found = true; + break; + } + } + if (found) { + resource.collection.splice(i, 1); + resource.observers[id].close(); + delete resource.observers[id]; - resource.index.remove(id); - delete resource.previousAttributes[id]; - delete resource.modified[id]; - delete resource.saved[id]; - } + resource.index.remove(id); + delete resource.previousAttributes[id]; + delete resource.modified[id]; + delete resource.saved[id]; + } } /** @@ -46,36 +46,31 @@ function _eject(definition, resource, id) { * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item to eject. */ function eject(resourceName, id) { - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } - var resource = this.store[resourceName], - _this = this; + var resource = this.store[resourceName]; + var _this = this; - try { - if (!this.$rootScope.$$phase) { - this.$rootScope.$apply(function () { - _eject(_this.definitions[resourceName], resource, id); - resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); - }); - } else { - _eject(_this.definitions[resourceName], resource, id); - resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); - } - delete this.store[resourceName].completedQueries[id]; - } catch (err) { - throw new this.errors.UnhandledError(err); - } + if (!this.$rootScope.$$phase) { + this.$rootScope.$apply(function () { + _eject(_this.definitions[resourceName], resource, id); + resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); + }); + } else { + _eject(_this.definitions[resourceName], resource, id); + resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); + } + delete this.store[resourceName].completedQueries[id]; } module.exports = eject; diff --git a/src/datastore/sync_methods/ejectAll.js b/src/datastore/sync_methods/ejectAll.js index 18e2474..0ef988d 100644 --- a/src/datastore/sync_methods/ejectAll.js +++ b/src/datastore/sync_methods/ejectAll.js @@ -1,14 +1,16 @@ var errorPrefix = 'DS.ejectAll(resourceName[, params]): '; function _ejectAll(definition, resource, params) { - var queryHash = this.utils.toJson(params), - items = this.filter(definition.name, params); + var queryHash = this.utils.toJson(params); + var items = this.filter(definition.name, params); + var ids = this.utils.toLookup(items, definition.idAttribute); + var _this = this; - for (var i = 0; i < items.length; i++) { - this.eject(definition.name, items[i][definition.idAttribute]); - } + angular.forEach(ids, function (item, id) { + _this.eject(definition.name, id); + }); - delete resource.completedQueries[queryHash]; + delete resource.completedQueries[queryHash]; } /** @@ -41,7 +43,7 @@ function _ejectAll(definition, resource, params) { * DS.filter('document'); // [ { title: 'How to Cook', id: 45, author: 'John Anderson' }, * // { title: 'How to Eat', id: 46, author: 'Sally Jane' } ] * - * DS.ejectAll('document', { query: { where: { author: 'Sally Jane' } } }); + * DS.ejectAll('document', { where: { author: 'Sally Jane' } }); * * DS.filter('document'); // [ { title: 'How to Cook', id: 45, author: 'John Anderson' } ] * ``` @@ -60,43 +62,45 @@ function _ejectAll(definition, resource, params) { * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {object} params Parameter object that is serialized into the query string. Properties: * - * - `{object=}` - `query` - The query object by which to filter items of the type specified by `resourceName`. Properties: - * - `{object=}` - `where` - Where clause. - * - `{number=}` - `limit` - Limit clause. - * - `{skip=}` - `skip` - Skip clause. - * - `{orderBy=}` - `orderBy` - OrderBy clause. + * - `{object=}` - `where` - Where clause. + * - `{number=}` - `limit` - Limit clause. + * - `{number=}` - `skip` - Skip clause. + * - `{number=}` - `offset` - Same as skip. + * - `{string|array=}` - `orderBy` - OrderBy clause. */ function ejectAll(resourceName, params) { - params = params || {}; + params = params || {}; - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isObject(params)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'params: Must be an object!', { params: { actual: typeof params, expected: 'object' } }); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(params)) { + throw new this.errors.IA(errorPrefix + 'params: Must be an object!'); + } - var resource = this.store[resourceName], - _this = this; + var _this = this; + var resource = this.store[resourceName]; + var queryHash = this.utils.toJson(params); - try { - if (!this.$rootScope.$$phase) { - this.$rootScope.$apply(function () { - _ejectAll.apply(_this, [_this.definitions[resourceName], resource, params]); - resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); - }); - } else { - _ejectAll.apply(_this, [_this.definitions[resourceName], resource, params]); - resource.collectionModified = this.utils.updateTimestamp(resource.collectionModified); - } - } catch (err) { - throw new this.errors.UnhandledError(err); - } + delete resource.completedQueries[queryHash]; + + if (this.utils.isEmpty(params)) { + resource.completedQueries = {}; + } + + if (!this.$rootScope.$$phase) { + this.$rootScope.$apply(function () { + _ejectAll.apply(_this, [_this.definitions[resourceName], resource, params]); + resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); + }); + } else { + _ejectAll.apply(_this, [_this.definitions[resourceName], resource, params]); + resource.collectionModified = this.utils.updateTimestamp(resource.collectionModified); + } } module.exports = ejectAll; diff --git a/src/datastore/sync_methods/filter.js b/src/datastore/sync_methods/filter.js index 400d8e5..8b1d45e 100644 --- a/src/datastore/sync_methods/filter.js +++ b/src/datastore/sync_methods/filter.js @@ -1,5 +1,4 @@ -/* jshint loopfunc: true */ -var errorPrefix = 'DS.filter(resourceName, params[, options]): '; +var errorPrefix = 'DS.filter(resourceName[, params][, options]): '; /** * @doc method @@ -10,7 +9,7 @@ var errorPrefix = 'DS.filter(resourceName, params[, options]): '; * * ## Signature: * ```js - * DS.filter(resourceName, params[, options]) + * DS.filter(resourceName[, params][, options]) * ``` * * ## Example: @@ -22,135 +21,59 @@ var errorPrefix = 'DS.filter(resourceName, params[, options]): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {object=} params Parameter object that is serialized into the query string. Properties: * - * - `{object=}` - `query` - The query object by which to filter items of the type specified by `resourceName`. Properties: - * - `{object=}` - `where` - Where clause. - * - `{number=}` - `limit` - Limit clause. - * - `{skip=}` - `skip` - Skip clause. - * - `{orderBy=}` - `orderBy` - OrderBy clause. + * - `{object=}` - `where` - Where clause. + * - `{number=}` - `limit` - Limit clause. + * - `{number=}` - `skip` - Skip clause. + * - `{number=}` - `offset` - Same as skip. + * - `{string|array=}` - `orderBy` - OrderBy clause. * * @param {object=} options Optional configuration. Properties: * - `{boolean=}` - `loadFromServer` - Send the query to server if it has not been sent yet. Default: `false`. + * - `{boolean=}` - `allowSimpleWhere` - Treat top-level fields on the `params` argument as simple "where" equality clauses. Default: `true`. * @returns {array} The filtered collection of items of the type specified by `resourceName`. */ function filter(resourceName, params, options) { - options = options || {}; + var IA = this.errors.IA; - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (params && !this.utils.isObject(params)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'params: Must be an object!', { params: { actual: typeof params, expected: 'object' } }); - } else if (!this.utils.isObject(options)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!', { options: { actual: typeof options, expected: 'object' } }); - } + options = options || {}; - try { - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (params && !this.utils.isObject(params)) { + throw new IA(errorPrefix + 'params: Must be an object!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } - // Protect against null - params = params || {}; + var definition = this.definitions[resourceName]; + var resource = this.store[resourceName]; - var queryHash = this.utils.toJson(params); + // Protect against null + params = params || {}; - if (!(queryHash in resource.completedQueries) && options.loadFromServer) { - // This particular query has never been completed + if ('allowSimpleWhere' in options) { + options.allowSimpleWhere = !!options.allowSimpleWhere; + } else { + options.allowSimpleWhere = true; + } - if (!resource.pendingQueries[queryHash]) { - // This particular query has never even been started - this.findAll(resourceName, params, options); - } - } + var queryHash = this.utils.toJson(params); - params.query = params.query || {}; - // The query has been completed, so hit the cache with the query - var filtered = this.utils.filter(resource.collection, function (attrs) { - var keep = true, - where = params.query.where; + if (!(queryHash in resource.completedQueries) && options.loadFromServer) { + // This particular query has never been completed - // Apply 'where' clauses - if (where) { - if (!_this.utils.isObject(where)) { - throw new _this.errors.IllegalArgumentError(errorPrefix + 'params.query.where: Must be an object!', { params: { query: { where: { actual: typeof params.query.where, expected: 'object' } } } }); - } - keep = definition.filter(resourceName, where, attrs); - } - return keep; - }); + if (!resource.pendingQueries[queryHash]) { + // This particular query has never even been started + this.findAll(resourceName, params, options); + } + } - // Apply 'orderBy' - if (params.query.orderBy) { - if (this.utils.isString(params.query.orderBy)) { - params.query.orderBy = [ - [params.query.orderBy, 'ASC'] - ]; - } - if (this.utils.isArray(params.query.orderBy)) { - for (var i = 0; i < params.query.orderBy.length; i++) { - if (this.utils.isString(params.query.orderBy[i])) { - params.query.orderBy[i] = [params.query.orderBy[i], 'ASC']; - } else if (!this.utils.isArray(params.query.orderBy[i])) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'params.query.orderBy[' + i + ']: Must be a string or an array!', { params: { query: { 'orderBy[i]': { actual: typeof params.query.orderBy[i], expected: 'string|array' } } } }); - } - filtered = this.utils.sort(filtered, function (a, b) { - var cA = a[params.query.orderBy[i][0]], cB = b[params.query.orderBy[i][0]]; - if (_this.utils.isString(cA)) { - cA = _this.utils.upperCase(cA); - } - if (_this.utils.isString(cB)) { - cB = _this.utils.upperCase(cB); - } - if (params.query.orderBy[i][1] === 'DESC') { - if (cB < cA) { - return -1; - } else if (cB > cA) { - return 1; - } else { - return 0; - } - } else { - if (cA < cB) { - return -1; - } else if (cA > cB) { - return 1; - } else { - return 0; - } - } - }); - } - } else { - throw new this.errors.IllegalArgumentError(errorPrefix + 'params.query.orderBy: Must be a string or an array!', { params: { query: { orderBy: { actual: typeof params.query.orderBy, expected: 'string|array' } } } }); - } - } - - // Apply 'limit' and 'skip' - if (this.utils.isNumber(params.query.limit) && this.utils.isNumber(params.query.skip)) { - filtered = this.utils.slice(filtered, params.query.skip, Math.min(filtered.length, params.query.skip + params.query.limit)); - } else if (this.utils.isNumber(params.query.limit)) { - filtered = this.utils.slice(filtered, 0, Math.min(filtered.length, params.query.limit)); - } else if (this.utils.isNumber(params.query.skip)) { - if (params.query.skip < filtered.length) { - filtered = this.utils.slice(filtered, params.query.skip); - } else { - filtered = []; - } - } - - return filtered; - } catch (err) { - if (err instanceof this.errors.IllegalArgumentError) { - throw err; - } else { - throw new this.errors.UnhandledError(err); - } - } + return definition.filter.call(this, resource.collection, resourceName, params, options); } module.exports = filter; diff --git a/src/datastore/sync_methods/get.js b/src/datastore/sync_methods/get.js index 84f9653..5a9792d 100644 --- a/src/datastore/sync_methods/get.js +++ b/src/datastore/sync_methods/get.js @@ -22,8 +22,7 @@ var errorPrefix = 'DS.get(resourceName, id[, options]): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item to retrieve. @@ -32,31 +31,29 @@ var errorPrefix = 'DS.get(resourceName, id[, options]): '; * @returns {object} The item of the type specified by `resourceName` with the primary key specified by `id`. */ function get(resourceName, id, options) { - options = options || {}; + var IA = this.errors.IA; - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } else if (!this.utils.isObject(options)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!', { options: { actual: typeof options, expected: 'object' } }); - } - var _this = this; + options = options || {}; - try { - // cache miss, request resource from server - var item = this.store[resourceName].index.get(id); - if (!item && options.loadFromServer) { - this.find(resourceName, id).then(null, function (err) { - return _this.$q.reject(err); - }); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new IA(errorPrefix + 'id: Must be a string or a number!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } + var _this = this; - // return resource from cache - return item; - } catch (err) { - throw new this.errors.UnhandledError(err); - } + // cache miss, request resource from server + var item = this.store[resourceName].index.get(id); + if (!item && options.loadFromServer) { + this.find(resourceName, id).then(null, function (err) { + return _this.$q.reject(err); + }); + } + + // return resource from cache + return item; } module.exports = get; diff --git a/src/datastore/sync_methods/hasChanges.js b/src/datastore/sync_methods/hasChanges.js index 071613f..e32b1bf 100644 --- a/src/datastore/sync_methods/hasChanges.js +++ b/src/datastore/sync_methods/hasChanges.js @@ -1,9 +1,9 @@ var errorPrefix = 'DS.hasChanges(resourceName, id): '; function diffIsEmpty(utils, diff) { - return !(utils.isEmpty(diff.added) && - utils.isEmpty(diff.removed) && - utils.isEmpty(diff.changed)); + return !(utils.isEmpty(diff.added) && + utils.isEmpty(diff.removed) && + utils.isEmpty(diff.changed)); } /** @@ -32,30 +32,25 @@ function diffIsEmpty(utils, diff) { * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item. * @returns {boolean} Whether the item of the type specified by `resourceName` with the primary key specified by `id` has changes. */ function hasChanges(resourceName, id) { - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } - try { - // return resource from cache - if (this.get(resourceName, id)) { - return diffIsEmpty(this.utils, this.changes(resourceName, id)); - } else { - return false; - } - } catch (err) { - throw new this.errors.UnhandledError(err); - } + // return resource from cache + if (this.get(resourceName, id)) { + return diffIsEmpty(this.utils, this.changes(resourceName, id)); + } else { + return false; + } } module.exports = hasChanges; diff --git a/src/datastore/sync_methods/index.js b/src/datastore/sync_methods/index.js index e88dd4d..63a63a0 100644 --- a/src/datastore/sync_methods/index.js +++ b/src/datastore/sync_methods/index.js @@ -1,141 +1,141 @@ module.exports = { - /** - * @doc method - * @id DS.sync_methods:defineResource - * @name defineResource - * @methodOf DS - * @description - * See [DS.defineResource](/documentation/api/api/DS.sync_methods:defineResource). - */ - defineResource: require('./defineResource'), + /** + * @doc method + * @id DS.sync_methods:defineResource + * @name defineResource + * @methodOf DS + * @description + * See [DS.defineResource](/documentation/api/api/DS.sync_methods:defineResource). + */ + defineResource: require('./defineResource'), - /** - * @doc method - * @id DS.sync_methods:bindOne - * @name bindOne - * @methodOf DS - * @description - * See [DS.bindOne](/documentation/api/api/DS.sync_methods:bindOne). - */ - bindOne: require('./bindOne'), + /** + * @doc method + * @id DS.sync_methods:bindOne + * @name bindOne + * @methodOf DS + * @description + * See [DS.bindOne](/documentation/api/api/DS.sync_methods:bindOne). + */ + bindOne: require('./bindOne'), - /** - * @doc method - * @id DS.sync_methods:bindAll - * @name bindAll - * @methodOf DS - * @description - * See [DS.bindAll](/documentation/api/api/DS.sync_methods:bindAll). - */ - bindAll: require('./bindAll'), + /** + * @doc method + * @id DS.sync_methods:bindAll + * @name bindAll + * @methodOf DS + * @description + * See [DS.bindAll](/documentation/api/api/DS.sync_methods:bindAll). + */ + bindAll: require('./bindAll'), - /** - * @doc method - * @id DS.sync_methods:eject - * @name eject - * @methodOf DS - * @description - * See [DS.eject](/documentation/api/api/DS.sync_methods:eject). - */ - eject: require('./eject'), + /** + * @doc method + * @id DS.sync_methods:eject + * @name eject + * @methodOf DS + * @description + * See [DS.eject](/documentation/api/api/DS.sync_methods:eject). + */ + eject: require('./eject'), - /** - * @doc method - * @id DS.sync_methods:ejectAll - * @name ejectAll - * @methodOf DS - * @description - * See [DS.ejectAll](/documentation/api/api/DS.sync_methods:ejectAll). - */ - ejectAll: require('./ejectAll'), + /** + * @doc method + * @id DS.sync_methods:ejectAll + * @name ejectAll + * @methodOf DS + * @description + * See [DS.ejectAll](/documentation/api/api/DS.sync_methods:ejectAll). + */ + ejectAll: require('./ejectAll'), - /** - * @doc method - * @id DS.sync_methods:filter - * @name filter - * @methodOf DS - * @description - * See [DS.filter](/documentation/api/api/DS.sync_methods:filter). - */ - filter: require('./filter'), + /** + * @doc method + * @id DS.sync_methods:filter + * @name filter + * @methodOf DS + * @description + * See [DS.filter](/documentation/api/api/DS.sync_methods:filter). + */ + filter: require('./filter'), - /** - * @doc method - * @id DS.sync_methods:get - * @name get - * @methodOf DS - * @description - * See [DS.get](/documentation/api/api/DS.sync_methods:get). - */ - get: require('./get'), + /** + * @doc method + * @id DS.sync_methods:get + * @name get + * @methodOf DS + * @description + * See [DS.get](/documentation/api/api/DS.sync_methods:get). + */ + get: require('./get'), - /** - * @doc method - * @id DS.sync_methods:inject - * @name inject - * @methodOf DS - * @description - * See [DS.inject](/documentation/api/api/DS.sync_methods:inject). - */ - inject: require('./inject'), + /** + * @doc method + * @id DS.sync_methods:inject + * @name inject + * @methodOf DS + * @description + * See [DS.inject](/documentation/api/api/DS.sync_methods:inject). + */ + inject: require('./inject'), - /** - * @doc method - * @id DS.sync_methods:lastModified - * @name lastModified - * @methodOf DS - * @description - * See [DS.lastModified](/documentation/api/api/DS.sync_methods:lastModified). - */ - lastModified: require('./lastModified'), + /** + * @doc method + * @id DS.sync_methods:lastModified + * @name lastModified + * @methodOf DS + * @description + * See [DS.lastModified](/documentation/api/api/DS.sync_methods:lastModified). + */ + lastModified: require('./lastModified'), - /** - * @doc method - * @id DS.sync_methods:lastSaved - * @name lastSaved - * @methodOf DS - * @description - * See [DS.lastSaved](/documentation/api/api/DS.sync_methods:lastSaved). - */ - lastSaved: require('./lastSaved'), + /** + * @doc method + * @id DS.sync_methods:lastSaved + * @name lastSaved + * @methodOf DS + * @description + * See [DS.lastSaved](/documentation/api/api/DS.sync_methods:lastSaved). + */ + lastSaved: require('./lastSaved'), - /** - * @doc method - * @id DS.sync_methods:digest - * @name digest - * @methodOf DS - * @description - * See [DS.digest](/documentation/api/api/DS.sync_methods:digest). - */ - digest: require('./digest'), + /** + * @doc method + * @id DS.sync_methods:digest + * @name digest + * @methodOf DS + * @description + * See [DS.digest](/documentation/api/api/DS.sync_methods:digest). + */ + digest: require('./digest'), - /** - * @doc method - * @id DS.sync_methods:changes - * @name changes - * @methodOf DS - * @description - * See [DS.changes](/documentation/api/api/DS.sync_methods:changes). - */ - changes: require('./changes'), + /** + * @doc method + * @id DS.sync_methods:changes + * @name changes + * @methodOf DS + * @description + * See [DS.changes](/documentation/api/api/DS.sync_methods:changes). + */ + changes: require('./changes'), - /** - * @doc method - * @id DS.sync_methods:previous - * @name previous - * @methodOf DS - * @description - * See [DS.previous](/documentation/api/api/DS.sync_methods:previous). - */ - previous: require('./previous'), + /** + * @doc method + * @id DS.sync_methods:previous + * @name previous + * @methodOf DS + * @description + * See [DS.previous](/documentation/api/api/DS.sync_methods:previous). + */ + previous: require('./previous'), - /** - * @doc method - * @id DS.sync_methods:hasChanges - * @name hasChanges - * @methodOf DS - * @description - * See [DS.hasChanges](/documentation/api/api/DS.sync_methods:hasChanges). - */ - hasChanges: require('./hasChanges') + /** + * @doc method + * @id DS.sync_methods:hasChanges + * @name hasChanges + * @methodOf DS + * @description + * See [DS.hasChanges](/documentation/api/api/DS.sync_methods:hasChanges). + */ + hasChanges: require('./hasChanges') }; diff --git a/src/datastore/sync_methods/inject.js b/src/datastore/sync_methods/inject.js index c59f3ca..4f04c95 100644 --- a/src/datastore/sync_methods/inject.js +++ b/src/datastore/sync_methods/inject.js @@ -1,84 +1,124 @@ -var observe = require('../../../lib/observe-js/observe-js'), - errorPrefix = 'DS.inject(resourceName, attrs[, options]): '; +var observe = require('../../../lib/observe-js/observe-js'); +var errorPrefix = 'DS.inject(resourceName, attrs[, options]): '; function _inject(definition, resource, attrs) { - var _this = this, - $log = _this.$log; - - function _react(added, removed, changed, getOldValueFn) { - try { - var innerId = getOldValueFn(definition.idAttribute); - - resource.modified[innerId] = _this.utils.updateTimestamp(resource.modified[innerId]); - resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); - - if (definition.idAttribute in changed) { - $log.error('Doh! You just changed the primary key of an object! ' + - 'I don\'t know how to handle this yet, so your data for the "' + definition.name + - '" resource is now in an undefined (probably broken) state.'); - } - } catch (err) { - throw new _this.errors.UnhandledError(err); - } - } - - var injected; - if (_this.utils.isArray(attrs)) { - injected = []; - for (var i = 0; i < attrs.length; i++) { - injected.push(_inject.call(_this, definition, resource, attrs[i])); - } - } else { - if (!(definition.idAttribute in attrs)) { - throw new _this.errors.RuntimeError(errorPrefix + 'attrs: Must contain the property specified by `idAttribute`!'); - } else { - try { - definition.beforeInject(definition.name, attrs); - var id = attrs[definition.idAttribute], - item = this.get(definition.name, id); - - if (!item) { - if (definition.class) { - if (attrs instanceof definition[definition.class]) { - item = attrs; - } else { - item = new definition[definition.class](); - } - } else { - item = {}; - } - resource.previousAttributes[id] = {}; - - _this.utils.deepMixIn(item, attrs); - _this.utils.deepMixIn(resource.previousAttributes[id], attrs); - - resource.collection.push(item); - - resource.observers[id] = new observe.ObjectObserver(item, _react); - resource.index.put(id, item); - - _react({}, {}, {}, function () { - return id; - }); - } else { - _this.utils.deepMixIn(item, attrs); - if (typeof resource.index.touch === 'function') { - resource.index.touch(id); - } else { - resource.index.put(id, resource.index.get(id)); - } - resource.observers[id].deliver(); - } - resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); - definition.afterInject(definition.name, item); - injected = item; - } catch (err) { - $log.error(err); - $log.error('inject failed!', definition.name, attrs); - } - } - } - return injected; + var _this = this; + var $log = _this.$log; + + function _react(added, removed, changed, getOldValueFn) { + var innerId = getOldValueFn(definition.idAttribute); + + resource.modified[innerId] = _this.utils.updateTimestamp(resource.modified[innerId]); + resource.collectionModified = _this.utils.updateTimestamp(resource.collectionModified); + + if (definition.computed) { + var item = _this.get(definition.name, innerId); + _this.utils.forOwn(definition.computed, function (fn, field) { + var compute = false; + // check if required fields changed + angular.forEach(fn.deps, function (dep) { + if (dep in changed || dep in removed || dep in changed || !(field in item)) { + compute = true; + } + }); + if (compute) { + var args = []; + angular.forEach(fn.deps, function (dep) { + args.push(item[dep]); + }); + // recompute property + item[field] = fn.apply(item, args); + } + }); + } + + if (definition.idAttribute in changed) { + $log.error('Doh! You just changed the primary key of an object! ' + + 'I don\'t know how to handle this yet, so your data for the "' + definition.name + + '" resource is now in an undefined (probably broken) state.'); + } + } + + var injected; + if (_this.utils.isArray(attrs)) { + injected = []; + for (var i = 0; i < attrs.length; i++) { + injected.push(_inject.call(_this, definition, resource, attrs[i])); + } + } else { + // check if "idAttribute" is a computed property + if (definition.computed && definition.computed[definition.idAttribute]) { + var args = []; + angular.forEach(definition.computed[definition.idAttribute].deps, function (dep) { + args.push(attrs[dep]); + }); + attrs[definition.idAttribute] = definition.computed[definition.idAttribute].apply(attrs, args); + } + if (!(definition.idAttribute in attrs)) { + throw new _this.errors.R(errorPrefix + 'attrs: Must contain the property specified by `idAttribute`!'); + } else { + try { + definition.beforeInject(definition.name, attrs); + var id = attrs[definition.idAttribute], + item = this.get(definition.name, id); + + if (!item) { + if (definition.class) { + if (attrs instanceof definition[definition.class]) { + item = attrs; + } else { + item = new definition[definition.class](); + } + } else { + item = {}; + } + resource.previousAttributes[id] = {}; + + _this.utils.deepMixIn(item, attrs); + _this.utils.deepMixIn(resource.previousAttributes[id], attrs); + + resource.collection.push(item); + + resource.observers[id] = new observe.ObjectObserver(item, _react); + resource.index.put(id, item); + + _react({}, {}, {}, function () { + return id; + }); + } else { + _this.utils.deepMixIn(item, attrs); + if (typeof resource.index.touch === 'function') { + resource.index.touch(id); + } else { + resource.index.put(id, resource.index.get(id)); + } + resource.observers[id].deliver(); + } + resource.saved[id] = _this.utils.updateTimestamp(resource.saved[id]); + definition.afterInject(definition.name, item); + injected = item; + } catch (err) { + $log.error(err); + $log.error('inject failed!', definition.name, attrs); + } + } + } + return injected; +} + +function _injectRelations(definition, injected) { + var _this = this; + _this.utils.forOwn(definition.relations, function (relation, type) { + _this.utils.forOwn(relation, function (def, relationName) { + if (_this.definitions[relationName] && injected[def.localField]) { + try { + injected[def.localField] = _this.inject(relationName, injected[def.localField]); + } catch (err) { + _this.$log.error(errorPrefix + 'Failed to inject ' + type + ' relation: "' + relationName + '"!', err); + } + } + }); + }); } /** @@ -118,7 +158,7 @@ function _inject(definition, resource, attrs) { * * - `{IllegalArgumentError}` * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {object|array} attrs The item or collection of items to inject into the data store. @@ -127,37 +167,35 @@ function _inject(definition, resource, attrs) { * the items that were injected into the data store. */ function inject(resourceName, attrs, options) { - options = options || {}; - - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isObject(attrs) && !this.utils.isArray(attrs)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'attrs: Must be an object or an array!', { attrs: { actual: typeof attrs, expected: 'object|array' } }); - } else if (!this.utils.isObject(options)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'options: Must be an object!', { options: { actual: typeof options, expected: 'object' } }); - } - - var definition = this.definitions[resourceName], - resource = this.store[resourceName], - _this = this; - - try { - var injected; - if (!this.$rootScope.$$phase) { - this.$rootScope.$apply(function () { - injected = _inject.apply(_this, [definition, resource, attrs]); - }); - } else { - injected = _inject.apply(_this, [definition, resource, attrs]); - } - return injected; - } catch (err) { - if (!(err instanceof this.errors.RuntimeError)) { - throw new this.errors.UnhandledError(err); - } else { - throw err; - } - } + var IA = this.errors.IA; + + options = options || {}; + + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isObject(attrs) && !this.utils.isArray(attrs)) { + throw new IA(errorPrefix + 'attrs: Must be an object or an array!'); + } else if (!this.utils.isObject(options)) { + throw new IA(errorPrefix + 'options: Must be an object!'); + } + + var definition = this.definitions[resourceName]; + var resource = this.store[resourceName]; + var _this = this; + + var injected; + if (!this.$rootScope.$$phase) { + this.$rootScope.$apply(function () { + injected = _inject.call(_this, definition, resource, attrs); + }); + } else { + injected = _inject.call(_this, definition, resource, attrs); + } + if (definition.relations) { + _injectRelations.call(_this, definition, injected); + } + + return injected; } module.exports = inject; diff --git a/src/datastore/sync_methods/lastModified.js b/src/datastore/sync_methods/lastModified.js index 3896769..679ba14 100644 --- a/src/datastore/sync_methods/lastModified.js +++ b/src/datastore/sync_methods/lastModified.js @@ -26,8 +26,7 @@ var errorPrefix = 'DS.lastModified(resourceName[, id]): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number=} id The primary key of the item to remove. @@ -35,22 +34,18 @@ var errorPrefix = 'DS.lastModified(resourceName[, id]): '; * `resourceName` with the given primary key was modified. */ function lastModified(resourceName, id) { - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (id && !this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } - try { - if (id) { - if (!(id in this.store[resourceName].modified)) { - this.store[resourceName].modified[id] = 0; - } - return this.store[resourceName].modified[id]; - } - return this.store[resourceName].collectionModified; - } catch (err) { - throw new this.errors.UnhandledError(err); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (id && !this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } + if (id) { + if (!(id in this.store[resourceName].modified)) { + this.store[resourceName].modified[id] = 0; + } + return this.store[resourceName].modified[id]; + } + return this.store[resourceName].collectionModified; } module.exports = lastModified; diff --git a/src/datastore/sync_methods/lastSaved.js b/src/datastore/sync_methods/lastSaved.js index 45601a1..e89fc6c 100644 --- a/src/datastore/sync_methods/lastSaved.js +++ b/src/datastore/sync_methods/lastSaved.js @@ -33,27 +33,22 @@ var errorPrefix = 'DS.lastSaved(resourceName[, id]): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item for which to retrieve the lastSaved timestamp. * @returns {number} The timestamp of the last time the item of type `resourceName` with the given primary key was saved. */ function lastSaved(resourceName, id) { - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } - try { - if (!(id in this.store[resourceName].saved)) { - this.store[resourceName].saved[id] = 0; - } - return this.store[resourceName].saved[id]; - } catch (err) { - throw new this.errors.UnhandledError(err); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } + if (!(id in this.store[resourceName].saved)) { + this.store[resourceName].saved[id] = 0; + } + return this.store[resourceName].saved[id]; } module.exports = lastSaved; diff --git a/src/datastore/sync_methods/previous.js b/src/datastore/sync_methods/previous.js index 6655dc2..eceb65a 100644 --- a/src/datastore/sync_methods/previous.js +++ b/src/datastore/sync_methods/previous.js @@ -28,26 +28,21 @@ var errorPrefix = 'DS.previous(resourceName, id): '; * ## Throws * * - `{IllegalArgumentError}` - * - `{RuntimeError}` - * - `{UnhandledError}` + * - `{NonexistentResourceError}` * * @param {string} resourceName The resource type, e.g. 'user', 'comment', etc. * @param {string|number} id The primary key of the item whose previous attributes are to be retrieved. * @returns {object} The previous attributes of the item of the type specified by `resourceName` with the primary key specified by `id`. */ function previous(resourceName, id) { - if (!this.definitions[resourceName]) { - throw new this.errors.RuntimeError(errorPrefix + resourceName + ' is not a registered resource!'); - } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { - throw new this.errors.IllegalArgumentError(errorPrefix + 'id: Must be a string or a number!', { id: { actual: typeof id, expected: 'string|number' } }); - } + if (!this.definitions[resourceName]) { + throw new this.errors.NER(errorPrefix + resourceName); + } else if (!this.utils.isString(id) && !this.utils.isNumber(id)) { + throw new this.errors.IA(errorPrefix + 'id: Must be a string or a number!'); + } - try { - // return resource from cache - return angular.copy(this.store[resourceName].previousAttributes[id]); - } catch (err) { - throw new this.errors.UnhandledError(err); - } + // return resource from cache + return angular.copy(this.store[resourceName].previousAttributes[id]); } module.exports = previous; diff --git a/src/errors.js b/src/errors.js index cdaa4e6..0463f23 100644 --- a/src/errors.js +++ b/src/errors.js @@ -1,101 +1,34 @@ -/** - * @doc function - * @id errors.types:UnhandledError - * @name UnhandledError - * @description Error that is thrown/returned when Reheat encounters an uncaught/unknown exception. - * @param {Error} error The originally thrown error. - * @returns {UnhandledError} A new instance of `UnhandledError`. - */ -function UnhandledError(error) { - Error.call(this); - if (typeof Error.captureStackTrace === 'function') { - Error.captureStackTrace(this, this.constructor); - } - - error = error || {}; - - /** - * @doc property - * @id errors.types:UnhandledError.type - * @name type - * @propertyOf errors.types:UnhandledError - * @description Name of error type. Default: `"UnhandledError"`. - */ - this.type = this.constructor.name; - - /** - * @doc property - * @id errors.types:UnhandledError.originalError - * @name originalError - * @propertyOf errors.types:UnhandledError - * @description A reference to the original error that was thrown. - */ - this.originalError = error; - - /** - * @doc property - * @id errors.types:UnhandledError.message - * @name message - * @propertyOf errors.types:UnhandledError - * @description Message and stack trace. Same as `UnhandledError#stack`. - */ - this.message = 'UnhandledError: This is an uncaught exception. Please consider submitting an issue at https://github.com/jmdobry/angular-data/issues.\n\n' + - 'Original Uncaught Exception:\n' + (error.stack ? error.stack.toString() : error.stack); - - /** - * @doc property - * @id errors.types:UnhandledError.stack - * @name stack - * @propertyOf errors.types:UnhandledError - * @description Message and stack trace. Same as `UnhandledError#message`. - */ - this.stack = this.message; -} - -UnhandledError.prototype = Object.create(Error.prototype); -UnhandledError.prototype.constructor = UnhandledError; - /** * @doc function * @id errors.types:IllegalArgumentError * @name IllegalArgumentError * @description Error that is thrown/returned when a caller does not honor the pre-conditions of a method/function. * @param {string=} message Error message. Default: `"Illegal Argument!"`. - * @param {object=} errors Object containing information about the error. * @returns {IllegalArgumentError} A new instance of `IllegalArgumentError`. */ -function IllegalArgumentError(message, errors) { - Error.call(this); - if (typeof Error.captureStackTrace === 'function') { - Error.captureStackTrace(this, this.constructor); - } - - /** - * @doc property - * @id errors.types:IllegalArgumentError.type - * @name type - * @propertyOf errors.types:IllegalArgumentError - * @description Name of error type. Default: `"IllegalArgumentError"`. - */ - this.type = this.constructor.name; - - /** - * @doc property - * @id errors.types:IllegalArgumentError.errors - * @name errors - * @propertyOf errors.types:IllegalArgumentError - * @description Object containing information about the error. - */ - this.errors = errors || {}; - - /** - * @doc property - * @id errors.types:IllegalArgumentError.message - * @name message - * @propertyOf errors.types:IllegalArgumentError - * @description Error message. Default: `"Illegal Argument!"`. - */ - this.message = message || 'Illegal Argument!'; +function IllegalArgumentError(message) { + Error.call(this); + if (typeof Error.captureStackTrace === 'function') { + Error.captureStackTrace(this, this.constructor); + } + + /** + * @doc property + * @id errors.types:IllegalArgumentError.type + * @name type + * @propertyOf errors.types:IllegalArgumentError + * @description Name of error type. Default: `"IllegalArgumentError"`. + */ + this.type = this.constructor.name; + + /** + * @doc property + * @id errors.types:IllegalArgumentError.message + * @name message + * @propertyOf errors.types:IllegalArgumentError + * @description Error message. Default: `"Illegal Argument!"`. + */ + this.message = message || 'Illegal Argument!'; } IllegalArgumentError.prototype = Object.create(Error.prototype); @@ -107,46 +40,72 @@ IllegalArgumentError.prototype.constructor = IllegalArgumentError; * @name RuntimeError * @description Error that is thrown/returned for invalid state during runtime. * @param {string=} message Error message. Default: `"Runtime Error!"`. - * @param {object=} errors Object containing information about the error. * @returns {RuntimeError} A new instance of `RuntimeError`. */ -function RuntimeError(message, errors) { - Error.call(this); - if (typeof Error.captureStackTrace === 'function') { - Error.captureStackTrace(this, this.constructor); - } - - /** - * @doc property - * @id errors.types:RuntimeError.type - * @name type - * @propertyOf errors.types:RuntimeError - * @description Name of error type. Default: `"RuntimeError"`. - */ - this.type = this.constructor.name; - - /** - * @doc property - * @id errors.types:RuntimeError.errors - * @name errors - * @propertyOf errors.types:RuntimeError - * @description Object containing information about the error. - */ - this.errors = errors || {}; - - /** - * @doc property - * @id errors.types:RuntimeError.message - * @name message - * @propertyOf errors.types:RuntimeError - * @description Error message. Default: `"Runtime Error!"`. - */ - this.message = message || 'RuntimeError Error!'; +function RuntimeError(message) { + Error.call(this); + if (typeof Error.captureStackTrace === 'function') { + Error.captureStackTrace(this, this.constructor); + } + + /** + * @doc property + * @id errors.types:RuntimeError.type + * @name type + * @propertyOf errors.types:RuntimeError + * @description Name of error type. Default: `"RuntimeError"`. + */ + this.type = this.constructor.name; + + /** + * @doc property + * @id errors.types:RuntimeError.message + * @name message + * @propertyOf errors.types:RuntimeError + * @description Error message. Default: `"Runtime Error!"`. + */ + this.message = message || 'RuntimeError Error!'; } RuntimeError.prototype = Object.create(Error.prototype); RuntimeError.prototype.constructor = RuntimeError; +/** + * @doc function + * @id errors.types:NonexistentResourceError + * @name NonexistentResourceError + * @description Error that is thrown/returned when trying to access a resource that does not exist. + * @param {string=} resourceName Name of non-existent resource. + * @returns {NonexistentResourceError} A new instance of `NonexistentResourceError`. + */ +function NonexistentResourceError(resourceName) { + Error.call(this); + if (typeof Error.captureStackTrace === 'function') { + Error.captureStackTrace(this, this.constructor); + } + + /** + * @doc property + * @id errors.types:NonexistentResourceError.type + * @name type + * @propertyOf errors.types:NonexistentResourceError + * @description Name of error type. Default: `"NonexistentResourceError"`. + */ + this.type = this.constructor.name; + + /** + * @doc property + * @id errors.types:NonexistentResourceError.message + * @name message + * @propertyOf errors.types:NonexistentResourceError + * @description Error message. Default: `"Runtime Error!"`. + */ + this.message = (resourceName || '') + ' is not a registered resource!'; +} + +NonexistentResourceError.prototype = Object.create(Error.prototype); +NonexistentResourceError.prototype.constructor = NonexistentResourceError; + /** * @doc interface * @id errors @@ -154,16 +113,19 @@ RuntimeError.prototype.constructor = RuntimeError; * @description * Various error types that may be thrown by angular-data. * - * - [UnhandledError](/documentation/api/api/errors.types:UnhandledError) * - [IllegalArgumentError](/documentation/api/api/errors.types:IllegalArgumentError) * - [RuntimeError](/documentation/api/api/errors.types:RuntimeError) + * - [NonexistentResourceError](/documentation/api/api/errors.types:NonexistentResourceError) * * References to the constructor functions of these errors can be found in `DS.errors`. */ module.exports = [function () { - return { - UnhandledError: UnhandledError, - IllegalArgumentError: IllegalArgumentError, - RuntimeError: RuntimeError - }; + return { + IllegalArgumentError: IllegalArgumentError, + IA: IllegalArgumentError, + RuntimeError: RuntimeError, + R: RuntimeError, + NonexistentResourceError: NonexistentResourceError, + NER: NonexistentResourceError + }; }]; diff --git a/src/index.js b/src/index.js index 3cee8e6..b791b9c 100644 --- a/src/index.js +++ b/src/index.js @@ -1,81 +1,81 @@ (function (window, angular, undefined) { - 'use strict'; + 'use strict'; - /** - * @doc overview - * @id angular-data - * @name angular-data - * @description - * __Version:__ 0.9.1 - * - * ## Install - * - * #### Bower - * ```text - * bower install angular-data - * ``` - * - * Load `dist/angular-data.js` or `dist/angular-data.min.js` onto your web page after Angular.js. - * - * #### Npm - * ```text - * npm install angular-data - * ``` - * - * 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) - * section of the angular-data GitHub project. - * - * ## Load into Angular - * Your Angular app must depend on the module `"angular-data.DS"` in order to use angular-data. Loading - * angular-data into your app allows you to inject the following: - * - * - `DS` - * - `DSHttpAdapter` - * - `DSUtils` - * - `DSErrors` - * - * [DS](/documentation/api/api/DS) is the Data Store itself, which you will inject often. - * [DSHttpAdapter](/documentation/api/api/DSHttpAdapter) is useful as a wrapper for `$http` and is configurable. - * [DSUtils](/documentation/api/api/DSUtils) has some useful utility methods. - * [DSErrors](/documentation/api/api/DSErrors) provides references to the various errors thrown by the data store. - */ - angular.module('angular-data.DS', ['ng']) - .factory('DSUtils', require('./utils')) - .factory('DSErrors', require('./errors')) - .provider('DSHttpAdapter', require('./adapters/http')) - .provider('DSLocalStorageAdapter', require('./adapters/localStorage')) - .provider('DS', require('./datastore')) - .config(['$provide', function ($provide) { - $provide.decorator('$q', ['$delegate', function ($delegate) { - // do whatever you you want - $delegate.promisify = function (fn, target) { - var _this = this; - return function () { - var deferred = _this.defer(), - args = Array.prototype.slice.apply(arguments); + /** + * @doc overview + * @id angular-data + * @name angular-data + * @description + * __Version:__ 0.10.0 + * + * ## Install + * + * #### Bower + * ```text + * bower install angular-data + * ``` + * + * Load `dist/angular-data.js` or `dist/angular-data.min.js` onto your web page after Angular.js. + * + * #### Npm + * ```text + * npm install angular-data + * ``` + * + * 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) + * section of the angular-data GitHub project. + * + * ## Load into Angular + * Your Angular app must depend on the module `"angular-data.DS"` in order to use angular-data. Loading + * angular-data into your app allows you to inject the following: + * + * - `DS` + * - `DSHttpAdapter` + * - `DSUtils` + * - `DSErrors` + * + * [DS](/documentation/api/api/DS) is the Data Store itself, which you will inject often. + * [DSHttpAdapter](/documentation/api/api/DSHttpAdapter) is useful as a wrapper for `$http` and is configurable. + * [DSUtils](/documentation/api/api/DSUtils) has some useful utility methods. + * [DSErrors](/documentation/api/api/DSErrors) provides references to the various errors thrown by the data store. + */ + angular.module('angular-data.DS', ['ng']) + .factory('DSUtils', require('./utils')) + .factory('DSErrors', require('./errors')) + .provider('DSHttpAdapter', require('./adapters/http')) + .provider('DSLocalStorageAdapter', require('./adapters/localStorage')) + .provider('DS', require('./datastore')) + .config(['$provide', function ($provide) { + $provide.decorator('$q', ['$delegate', function ($delegate) { + // do whatever you you want + $delegate.promisify = function (fn, target) { + var _this = this; + return function () { + var deferred = _this.defer(), + args = Array.prototype.slice.apply(arguments); - args.push(function (err, result) { - if (err) { - deferred.reject(err); - } else { - deferred.resolve(result); - } - }); + args.push(function (err, result) { + if (err) { + deferred.reject(err); + } else { + deferred.resolve(result); + } + }); - try { - fn.apply(target || this, args); - } catch (err) { - deferred.reject(err); - } + try { + fn.apply(target || this, args); + } catch (err) { + deferred.reject(err); + } - return deferred.promise; - }; - }; - return $delegate; - }]); - }]); + return deferred.promise; + }; + }; + return $delegate; + }]); + }]); })(window, window.angular); diff --git a/src/utils.js b/src/utils.js index 27de510..71ee9ff 100644 --- a/src/utils.js +++ b/src/utils.js @@ -1,80 +1,80 @@ module.exports = [function () { - return { - isString: angular.isString, - isArray: angular.isArray, - isObject: angular.isObject, - isNumber: angular.isNumber, - isFunction: angular.isFunction, - isEmpty: require('mout/lang/isEmpty'), - toJson: angular.toJson, - makePath: require('mout/string/makePath'), - upperCase: require('mout/string/upperCase'), - deepMixIn: require('mout/object/deepMixIn'), - forOwn: require('mout/object/forOwn'), - pick: require('mout/object/pick'), - set: require('mout/object/set'), - contains: require('mout/array/contains'), - filter: require('mout/array/filter'), - toLookup: require('mout/array/toLookup'), - slice: require('mout/array/slice'), - sort: require('mout/array/sort'), - updateTimestamp: function (timestamp) { - var newTimestamp = typeof Date.now === 'function' ? Date.now() : new Date().getTime(); - if (timestamp && newTimestamp <= timestamp) { - return timestamp + 1; - } else { - return newTimestamp; - } - }, - deepFreeze: function deepFreeze(o) { - if (typeof Object.freeze === 'function') { - var prop, propKey; - Object.freeze(o); // First freeze the object. - for (propKey in o) { - prop = o[propKey]; - if (!o.hasOwnProperty(propKey) || typeof prop !== 'object' || Object.isFrozen(prop)) { - // If the object is on the prototype, not an object, or is already frozen, - // skip it. Note that this might leave an unfrozen reference somewhere in the - // object if there is an already frozen object containing an unfrozen object. - continue; - } + return { + isString: angular.isString, + isArray: angular.isArray, + isObject: angular.isObject, + isNumber: angular.isNumber, + isFunction: angular.isFunction, + isEmpty: require('mout/lang/isEmpty'), + toJson: angular.toJson, + makePath: require('mout/string/makePath'), + upperCase: require('mout/string/upperCase'), + deepMixIn: require('mout/object/deepMixIn'), + forOwn: require('mout/object/forOwn'), + pick: require('mout/object/pick'), + set: require('mout/object/set'), + contains: require('mout/array/contains'), + filter: require('mout/array/filter'), + toLookup: require('mout/array/toLookup'), + slice: require('mout/array/slice'), + sort: require('mout/array/sort'), + updateTimestamp: function (timestamp) { + var newTimestamp = typeof Date.now === 'function' ? Date.now() : new Date().getTime(); + if (timestamp && newTimestamp <= timestamp) { + return timestamp + 1; + } else { + return newTimestamp; + } + }, + deepFreeze: function deepFreeze(o) { + if (typeof Object.freeze === 'function') { + var prop, propKey; + Object.freeze(o); // First freeze the object. + for (propKey in o) { + prop = o[propKey]; + if (!o.hasOwnProperty(propKey) || typeof prop !== 'object' || Object.isFrozen(prop)) { + // If the object is on the prototype, not an object, or is already frozen, + // skip it. Note that this might leave an unfrozen reference somewhere in the + // object if there is an already frozen object containing an unfrozen object. + continue; + } - deepFreeze(prop); // Recursively call deepFreeze. - } - } - }, - diffObjectFromOldObject: function (object, oldObject) { - var added = {}; - var removed = {}; - var changed = {}; + deepFreeze(prop); // Recursively call deepFreeze. + } + } + }, + diffObjectFromOldObject: function (object, oldObject) { + var added = {}; + var removed = {}; + var changed = {}; - for (var prop in oldObject) { - var newValue = object[prop]; + for (var prop in oldObject) { + var newValue = object[prop]; - if (newValue !== undefined && newValue === oldObject[prop]) - continue; + if (newValue !== undefined && newValue === oldObject[prop]) + continue; - if (!(prop in object)) { - removed[prop] = undefined; - continue; - } + if (!(prop in object)) { + removed[prop] = undefined; + continue; + } - if (newValue !== oldObject[prop]) - changed[prop] = newValue; - } + if (newValue !== oldObject[prop]) + changed[prop] = newValue; + } - for (var prop2 in object) { - if (prop2 in oldObject) - continue; + for (var prop2 in object) { + if (prop2 in oldObject) + continue; - added[prop2] = object[prop2]; - } + added[prop2] = object[prop2]; + } - return { - added: added, - removed: removed, - changed: changed - }; - } - }; + return { + added: added, + removed: removed, + changed: changed + }; + } + }; }]; diff --git a/test/integration/adapters/http/create.test.js b/test/integration/adapters/http/create.test.js index fbd8772..8f21e34 100644 --- a/test/integration/adapters/http/create.test.js +++ b/test/integration/adapters/http/create.test.js @@ -1,42 +1,42 @@ describe('DSHttpAdapter.create(resourceConfig, attrs, options)', function () { - beforeEach(startInjector); - - it('should make a POST request', function () { - $httpBackend.expectPOST('api/posts', { - author: 'John', - age: 30 - }).respond(200, p1); - - DSHttpAdapter.create({ - baseUrl: 'api', - endpoint: 'posts' - }, { author: 'John', age: 30 }).then(function (data) { - assert.deepEqual(data.data, p1, 'post should have been created'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - $httpBackend.expectPOST('api2/posts', { - author: 'John', - age: 30 - }).respond(200, p1); - - DSHttpAdapter.create({ - baseUrl: 'api', - endpoint: 'posts' - }, { author: 'John', age: 30 }, { baseUrl: 'api2' }).then(function (data) { - assert.deepEqual(data.data, p1, 'post should have been created'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - assert.equal(lifecycle.queryTransform.callCount, 0, 'queryTransform should not have been called'); - }); + beforeEach(startInjector); + + it('should make a POST request', function () { + $httpBackend.expectPOST('api/posts', { + author: 'John', + age: 30 + }).respond(200, p1); + + DSHttpAdapter.create({ + baseUrl: 'api', + endpoint: 'posts' + }, { author: 'John', age: 30 }).then(function (data) { + assert.deepEqual(data.data, p1, 'post should have been created'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + $httpBackend.expectPOST('api2/posts', { + author: 'John', + age: 30 + }).respond(200, p1); + + DSHttpAdapter.create({ + baseUrl: 'api', + endpoint: 'posts' + }, { author: 'John', age: 30 }, { baseUrl: 'api2' }).then(function (data) { + assert.deepEqual(data.data, p1, 'post should have been created'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + assert.equal(lifecycle.queryTransform.callCount, 0, 'queryTransform should not have been called'); + }); }); diff --git a/test/integration/adapters/http/destroy.test.js b/test/integration/adapters/http/destroy.test.js index 3202a95..c010e98 100644 --- a/test/integration/adapters/http/destroy.test.js +++ b/test/integration/adapters/http/destroy.test.js @@ -1,36 +1,36 @@ describe('DSHttpAdapter.destroy(resourceConfig, id, options)', function () { - beforeEach(startInjector); - - it('should make a DELETE request', function () { - $httpBackend.expectDELETE('api/posts/1').respond(200, 1); - - DSHttpAdapter.destroy({ - baseUrl: 'api', - endpoint: 'posts' - }, 1).then(function (data) { - assert.deepEqual(data.data, 1, 'post should have been deleted'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - $httpBackend.expectDELETE('api2/posts/1').respond(200, 1); - - DSHttpAdapter.destroy({ - baseUrl: 'api', - endpoint: 'posts' - }, 1, { baseUrl: 'api2' }).then(function (data) { - assert.deepEqual(data.data, 1, 'post should have been deleted'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - assert.equal(lifecycle.queryTransform.callCount, 0, 'queryTransform should not have been called'); - }); + beforeEach(startInjector); + + it('should make a DELETE request', function () { + $httpBackend.expectDELETE('api/posts/1').respond(200, 1); + + DSHttpAdapter.destroy({ + baseUrl: 'api', + endpoint: 'posts' + }, 1).then(function (data) { + assert.deepEqual(data.data, 1, 'post should have been deleted'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + $httpBackend.expectDELETE('api2/posts/1').respond(200, 1); + + DSHttpAdapter.destroy({ + baseUrl: 'api', + endpoint: 'posts' + }, 1, { baseUrl: 'api2' }).then(function (data) { + assert.deepEqual(data.data, 1, 'post should have been deleted'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + assert.equal(lifecycle.queryTransform.callCount, 0, 'queryTransform should not have been called'); + }); }); diff --git a/test/integration/adapters/http/destroyAll.test.js b/test/integration/adapters/http/destroyAll.test.js index 2614603..1831164 100644 --- a/test/integration/adapters/http/destroyAll.test.js +++ b/test/integration/adapters/http/destroyAll.test.js @@ -1,44 +1,42 @@ describe('DSHttpAdapter.destroyAll(resourceConfig, params, options)', function () { - beforeEach(startInjector); - - it('should make a DELETE request', function () { - $httpBackend.expectDELETE('api/posts').respond(204); - - DSHttpAdapter.destroyAll({ - baseUrl: 'api', - endpoint: 'posts' - }, {}).then(function (data) { - assert.isUndefined(data.data, 'posts should have been found'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - $httpBackend.expectDELETE('api2/posts?query=%7B%22where%22:%7B%22author%22:%7B%22%3D%3D%22:%22John%22%7D%7D%7D').respond(204); - - DSHttpAdapter.destroyAll({ - baseUrl: 'api', - endpoint: 'posts' - }, { - query: { - where: { - author: { - '==': 'John' - } - } - } - }, { baseUrl: 'api2' }).then(function (data) { - assert.isUndefined(data.data, 'posts should have been destroyed'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - assert.equal(lifecycle.queryTransform.callCount, 1, 'queryTransform should have been called'); - }); + beforeEach(startInjector); + + it('should make a DELETE request', function () { + $httpBackend.expectDELETE('api/posts').respond(204); + + DSHttpAdapter.destroyAll({ + baseUrl: 'api', + endpoint: 'posts' + }, {}).then(function (data) { + assert.isUndefined(data.data, 'posts should have been found'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + $httpBackend.expectDELETE('api2/posts?where=%7B%22author%22:%7B%22%3D%3D%22:%22John%22%7D%7D').respond(204); + + DSHttpAdapter.destroyAll({ + baseUrl: 'api', + endpoint: 'posts' + }, { + where: { + author: { + '==': 'John' + } + } + }, { baseUrl: 'api2' }).then(function (data) { + assert.isUndefined(data.data, 'posts should have been destroyed'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + assert.equal(lifecycle.queryTransform.callCount, 2, 'queryTransform should have been called'); + }); }); diff --git a/test/integration/adapters/http/find.test.js b/test/integration/adapters/http/find.test.js index 8c7009c..fa2cbc2 100644 --- a/test/integration/adapters/http/find.test.js +++ b/test/integration/adapters/http/find.test.js @@ -1,36 +1,36 @@ describe('DSHttpAdapter.find(resourceConfig, id, options)', function () { - beforeEach(startInjector); - - it('should make a GET request', function () { - $httpBackend.expectGET('api/posts/1').respond(200, p1); - - DSHttpAdapter.find({ - baseUrl: 'api', - endpoint: 'posts' - }, 1).then(function (data) { - assert.deepEqual(data.data, p1, 'post should have been found'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - $httpBackend.expectGET('api2/posts/1').respond(200, p1); - - DSHttpAdapter.find({ - baseUrl: 'api', - endpoint: 'posts' - }, 1, { baseUrl: 'api2' }).then(function (data) { - assert.deepEqual(data.data, p1, 'post should have been found'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - assert.equal(lifecycle.queryTransform.callCount, 0, 'queryTransform should not have been called'); - }); + beforeEach(startInjector); + + it('should make a GET request', function () { + $httpBackend.expectGET('api/posts/1').respond(200, p1); + + DSHttpAdapter.find({ + baseUrl: 'api', + endpoint: 'posts' + }, 1).then(function (data) { + assert.deepEqual(data.data, p1, 'post should have been found'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + $httpBackend.expectGET('api2/posts/1').respond(200, p1); + + DSHttpAdapter.find({ + baseUrl: 'api', + endpoint: 'posts' + }, 1, { baseUrl: 'api2' }).then(function (data) { + assert.deepEqual(data.data, p1, 'post should have been found'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + assert.equal(lifecycle.queryTransform.callCount, 0, 'queryTransform should not have been called'); + }); }); diff --git a/test/integration/adapters/http/findAll.test.js b/test/integration/adapters/http/findAll.test.js index b62cc65..80e2b85 100644 --- a/test/integration/adapters/http/findAll.test.js +++ b/test/integration/adapters/http/findAll.test.js @@ -1,44 +1,42 @@ describe('DSHttpAdapter.findAll(resourceConfig, params, options)', function () { - beforeEach(startInjector); - - it('should make a GET request', function () { - $httpBackend.expectGET('api/posts').respond(200, [p1]); - - DSHttpAdapter.findAll({ - baseUrl: 'api', - endpoint: 'posts' - }, {}).then(function (data) { - assert.deepEqual(data.data, [p1], 'posts should have been found'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - $httpBackend.expectGET('api2/posts?query=%7B%22where%22:%7B%22author%22:%7B%22%3D%3D%22:%22John%22%7D%7D%7D').respond(200, [p1]); - - DSHttpAdapter.findAll({ - baseUrl: 'api', - endpoint: 'posts' - }, { - query: { - where: { - author: { - '==': 'John' - } - } - } - }, { baseUrl: 'api2' }).then(function (data) { - assert.deepEqual(data.data, [p1], 'posts should have been found'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - assert.equal(lifecycle.queryTransform.callCount, 1, 'queryTransform should have been called'); - }); + beforeEach(startInjector); + + it('should make a GET request', function () { + $httpBackend.expectGET('api/posts').respond(200, [p1]); + + DSHttpAdapter.findAll({ + baseUrl: 'api', + endpoint: 'posts' + }, {}).then(function (data) { + assert.deepEqual(data.data, [p1], 'posts should have been found'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + $httpBackend.expectGET('api2/posts?where=%7B%22author%22:%7B%22%3D%3D%22:%22John%22%7D%7D').respond(200, [p1]); + + DSHttpAdapter.findAll({ + baseUrl: 'api', + endpoint: 'posts' + }, { + where: { + author: { + '==': 'John' + } + } + }, { baseUrl: 'api2' }).then(function (data) { + assert.deepEqual(data.data, [p1], 'posts should have been found'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + assert.equal(lifecycle.queryTransform.callCount, 2, 'queryTransform should have been called'); + }); }); diff --git a/test/integration/adapters/http/update.test.js b/test/integration/adapters/http/update.test.js index aaff63e..dca3444 100644 --- a/test/integration/adapters/http/update.test.js +++ b/test/integration/adapters/http/update.test.js @@ -1,42 +1,42 @@ describe('DSHttpAdapter.update(resourceConfig, id, attrs, options)', function () { - beforeEach(startInjector); - - it('should make a PUT request', function () { - $httpBackend.expectPUT('api/posts/1', { - author: 'John', - age: 30 - }).respond(200, p1); - - DSHttpAdapter.update({ - baseUrl: 'api', - endpoint: 'posts' - }, 1, { author: 'John', age: 30 }).then(function (data) { - assert.deepEqual(data.data, p1, 'post 5 should have been updated'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - $httpBackend.expectPUT('api2/posts/1', { - author: 'John', - age: 30 - }).respond(200, p1); - - DSHttpAdapter.update({ - baseUrl: 'api', - endpoint: 'posts' - }, 1, { author: 'John', age: 30 }, { baseUrl: 'api2' }).then(function (data) { - assert.deepEqual(data.data, p1, 'post 5 should have been updated'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - assert.equal(lifecycle.queryTransform.callCount, 0, 'queryTransform should not have been called'); - }); + beforeEach(startInjector); + + it('should make a PUT request', function () { + $httpBackend.expectPUT('api/posts/1', { + author: 'John', + age: 30 + }).respond(200, p1); + + DSHttpAdapter.update({ + baseUrl: 'api', + endpoint: 'posts' + }, 1, { author: 'John', age: 30 }).then(function (data) { + assert.deepEqual(data.data, p1, 'post 5 should have been updated'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + $httpBackend.expectPUT('api2/posts/1', { + author: 'John', + age: 30 + }).respond(200, p1); + + DSHttpAdapter.update({ + baseUrl: 'api', + endpoint: 'posts' + }, 1, { author: 'John', age: 30 }, { baseUrl: 'api2' }).then(function (data) { + assert.deepEqual(data.data, p1, 'post 5 should have been updated'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + assert.equal(lifecycle.queryTransform.callCount, 0, 'queryTransform should not have been called'); + }); }); diff --git a/test/integration/adapters/http/updateAll.test.js b/test/integration/adapters/http/updateAll.test.js index 02d006a..9b8246f 100644 --- a/test/integration/adapters/http/updateAll.test.js +++ b/test/integration/adapters/http/updateAll.test.js @@ -1,44 +1,42 @@ describe('DSHttpAdapter.updateAll(resourceConfig, attrs, params, options)', function () { - beforeEach(startInjector); - - it('should make a PUT request', function () { - $httpBackend.expectPUT('api/posts').respond(200, [p1]); - - DSHttpAdapter.updateAll({ - baseUrl: 'api', - endpoint: 'posts' - }, { author: 'John', age: 30 }).then(function (data) { - assert.deepEqual(data.data, [p1], 'posts should have been updated'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - $httpBackend.expectPUT('api2/posts?query=%7B%22where%22:%7B%22author%22:%7B%22%3D%3D%22:%22John%22%7D%7D%7D').respond(200, [p1]); - - DSHttpAdapter.updateAll({ - baseUrl: 'api', - endpoint: 'posts' - }, { author: 'John', age: 30 }, { - query: { - where: { - author: { - '==': 'John' - } - } - } - }, { baseUrl: 'api2' }).then(function (data) { - assert.deepEqual(data.data, [p1], 'posts should have been updated'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - assert.equal(lifecycle.queryTransform.callCount, 1, 'queryTransform should have been called'); - }); + beforeEach(startInjector); + + it('should make a PUT request', function () { + $httpBackend.expectPUT('api/posts').respond(200, [p1]); + + DSHttpAdapter.updateAll({ + baseUrl: 'api', + endpoint: 'posts' + }, { author: 'John', age: 30 }).then(function (data) { + assert.deepEqual(data.data, [p1], 'posts should have been updated'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + $httpBackend.expectPUT('api2/posts?where=%7B%22author%22:%7B%22%3D%3D%22:%22John%22%7D%7D').respond(200, [p1]); + + DSHttpAdapter.updateAll({ + baseUrl: 'api', + endpoint: 'posts' + }, { author: 'John', age: 30 }, { + where: { + author: { + '==': 'John' + } + } + }, { baseUrl: 'api2' }).then(function (data) { + assert.deepEqual(data.data, [p1], 'posts should have been updated'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + assert.equal(lifecycle.queryTransform.callCount, 1, 'queryTransform should have been called'); + }); }); diff --git a/test/integration/adapters/localStorage/destroy.test.js b/test/integration/adapters/localStorage/destroy.test.js index 4232508..c0a9f89 100644 --- a/test/integration/adapters/localStorage/destroy.test.js +++ b/test/integration/adapters/localStorage/destroy.test.js @@ -1,41 +1,41 @@ describe('DSLocalStorageAdapter.destroy(resourceConfig, id, options)', function () { - beforeEach(startInjector); - - it('should destroy an item from localStorage', function (done) { - var path = DSUtils.makePath('api', 'posts', 1); - - localStorage.setItem(path, angular.toJson(p1)); - - assert.deepEqual(angular.fromJson(localStorage.getItem(path)), p1, 'p1 should be in localStorage'); - - DSLocalStorageAdapter.destroy({ - baseUrl: 'api', - endpoint: 'posts' - }, 1).then(function () { - assert.isNull(localStorage.getItem(path), 'the item should be gone from localStorage'); - - path = DSUtils.makePath('api2', 'posts', 1); - localStorage.setItem(path, angular.toJson(p2)); - assert.deepEqual(angular.fromJson(localStorage.getItem(path)), p2); - - DSLocalStorageAdapter.destroy({ - baseUrl: 'api', - endpoint: 'posts' - }, 1, { baseUrl: 'api2' }).then(function () { - assert.isNull(localStorage.getItem(path), 'the item should be gone from localStorage'); - done(); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $rootScope.$apply(); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $rootScope.$apply(); - }); + beforeEach(startInjector); + + it('should destroy an item from localStorage', function (done) { + var path = DSUtils.makePath('api', 'posts', 1); + + localStorage.setItem(path, angular.toJson(p1)); + + assert.deepEqual(angular.fromJson(localStorage.getItem(path)), p1, 'p1 should be in localStorage'); + + DSLocalStorageAdapter.destroy({ + baseUrl: 'api', + endpoint: 'posts' + }, 1).then(function () { + assert.isNull(localStorage.getItem(path), 'the item should be gone from localStorage'); + + path = DSUtils.makePath('api2', 'posts', 1); + localStorage.setItem(path, angular.toJson(p2)); + assert.deepEqual(angular.fromJson(localStorage.getItem(path)), p2); + + DSLocalStorageAdapter.destroy({ + baseUrl: 'api', + endpoint: 'posts' + }, 1, { baseUrl: 'api2' }).then(function () { + assert.isNull(localStorage.getItem(path), 'the item should be gone from localStorage'); + done(); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $rootScope.$apply(); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $rootScope.$apply(); + }); }); diff --git a/test/integration/adapters/localStorage/find.test.js b/test/integration/adapters/localStorage/find.test.js index 8b7afe2..2e3dc62 100644 --- a/test/integration/adapters/localStorage/find.test.js +++ b/test/integration/adapters/localStorage/find.test.js @@ -1,44 +1,44 @@ describe('DSLocalStorageAdapter.find(resourceConfig, id, options)', function () { - beforeEach(startInjector); + beforeEach(startInjector); - it('should retrieve an item from localStorage', function (done) { - var path = DSUtils.makePath('api', 'posts', 1); + it('should retrieve an item from localStorage', function (done) { + var path = DSUtils.makePath('api', 'posts', 1); - localStorage.setItem(path, angular.toJson(p1)); + localStorage.setItem(path, angular.toJson(p1)); - assert.deepEqual(angular.fromJson(localStorage.getItem(path)), p1, 'p1 should be in localStorage'); + assert.deepEqual(angular.fromJson(localStorage.getItem(path)), p1, 'p1 should be in localStorage'); - DSLocalStorageAdapter.find({ - baseUrl: 'api', - endpoint: 'posts' - }, 1).then(function (data) { - assert.deepEqual(data, p1, 'post should have been found'); + DSLocalStorageAdapter.find({ + baseUrl: 'api', + endpoint: 'posts' + }, 1).then(function (data) { + assert.deepEqual(data, p1, 'post should have been found'); - path = DSUtils.makePath('api2', 'posts', 2); + path = DSUtils.makePath('api2', 'posts', 2); - localStorage.setItem(path, angular.toJson(p2)); + localStorage.setItem(path, angular.toJson(p2)); - assert.deepEqual(angular.fromJson(localStorage.getItem(path)), p2, 'p2 should be in localStorage'); + assert.deepEqual(angular.fromJson(localStorage.getItem(path)), p2, 'p2 should be in localStorage'); - DSLocalStorageAdapter.find({ - baseUrl: 'api', - endpoint: 'posts' - }, 2, { baseUrl: 'api2' }).then(function (data) { - assert.deepEqual(data, p2, 'post should have been found'); + DSLocalStorageAdapter.find({ + baseUrl: 'api', + endpoint: 'posts' + }, 2, { baseUrl: 'api2' }).then(function (data) { + assert.deepEqual(data, p2, 'post should have been found'); - done(); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); + done(); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); - $rootScope.$apply(); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); + $rootScope.$apply(); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); - $rootScope.$apply(); - }); + $rootScope.$apply(); + }); }); diff --git a/test/integration/adapters/localStorage/update.test.js b/test/integration/adapters/localStorage/update.test.js index 2eab8a7..94d3a8b 100644 --- a/test/integration/adapters/localStorage/update.test.js +++ b/test/integration/adapters/localStorage/update.test.js @@ -1,46 +1,46 @@ describe('DSLocalStorageAdapter.update(resourceConfig, id, attrs, options)', function () { - beforeEach(startInjector); + beforeEach(startInjector); - it('should make a PUT request', function (done) { - var path = DSUtils.makePath('api', 'posts', 1); + it('should make a PUT request', function (done) { + var path = DSUtils.makePath('api', 'posts', 1); - localStorage.setItem(path, angular.toJson(p1)); + localStorage.setItem(path, angular.toJson(p1)); - assert.deepEqual(angular.fromJson(localStorage.getItem(path)), p1, 'p1 should be in localStorage'); + assert.deepEqual(angular.fromJson(localStorage.getItem(path)), p1, 'p1 should be in localStorage'); - DSLocalStorageAdapter.update({ - baseUrl: 'api', - endpoint: 'posts' - }, 1, { author: 'Sally' }).then(function (data) { - assert.deepEqual(data, { author: 'Sally', age: 30, id: 5 }, 'data should have been updated'); - assert.deepEqual(angular.fromJson(localStorage.getItem(path)), { author: 'Sally', age: 30, id: 5 }, 'p1 should be in localStorage'); + DSLocalStorageAdapter.update({ + baseUrl: 'api', + endpoint: 'posts' + }, 1, { author: 'Sally' }).then(function (data) { + assert.deepEqual(data, { author: 'Sally', age: 30, id: 5 }, 'data should have been updated'); + assert.deepEqual(angular.fromJson(localStorage.getItem(path)), { author: 'Sally', age: 30, id: 5 }, 'p1 should be in localStorage'); - path = DSUtils.makePath('api2', 'posts', 2); + path = DSUtils.makePath('api2', 'posts', 2); - localStorage.setItem(path, angular.toJson(p2)); + localStorage.setItem(path, angular.toJson(p2)); - assert.deepEqual(angular.fromJson(localStorage.getItem(path)), p2, 'p2 should be in localStorage'); + assert.deepEqual(angular.fromJson(localStorage.getItem(path)), p2, 'p2 should be in localStorage'); - DSLocalStorageAdapter.update({ - baseUrl: 'api', - endpoint: 'posts' - }, 2, { age: 44 }, { baseUrl: 'api2' }).then(function (data) { - assert.deepEqual(data, { author: 'Sally', age: 44, id: 6 }, 'data should have been updated'); - assert.deepEqual(angular.fromJson(localStorage.getItem(path)), { author: 'Sally', age: 44, id: 6 }, 'p1 should be in localStorage'); + DSLocalStorageAdapter.update({ + baseUrl: 'api', + endpoint: 'posts' + }, 2, { age: 44 }, { baseUrl: 'api2' }).then(function (data) { + assert.deepEqual(data, { author: 'Sally', age: 44, id: 6 }, 'data should have been updated'); + assert.deepEqual(angular.fromJson(localStorage.getItem(path)), { author: 'Sally', age: 44, id: 6 }, 'p1 should be in localStorage'); - done(); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); + done(); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); - $rootScope.$apply(); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); + $rootScope.$apply(); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); - $rootScope.$apply(); - }); + $rootScope.$apply(); + }); }); diff --git a/test/integration/datastore/DSCacheFactory.test.js b/test/integration/datastore/DSCacheFactory.test.js index 082ea46..164b41e 100644 --- a/test/integration/datastore/DSCacheFactory.test.js +++ b/test/integration/datastore/DSCacheFactory.test.js @@ -1,96 +1,96 @@ describe('DSCacheFactory integration', function () { - beforeEach(function () { - module('angular-data.DSCacheFactory'); - }); - - beforeEach(startInjector); - - it('should get an item from the server and delete when using DSCacheFactory in passive mode', function (done) { - DS.defineResource({ - name: 'comment', - endpoint: '/comments', - deleteOnExpire: 'passive', - maxAge: 20 - }); - - $httpBackend.expectGET('http://test.angular-cache.com/comments/5').respond(200, { - id: 5, - text: 'test' - }); - - DS.find('comment', 5).then(function (comment) { - assert.deepEqual(comment, { - id: 5, - text: 'test' - }); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - $httpBackend.flush(); - - assert.deepEqual(DS.get('comment', 5), { - id: 5, - text: 'test' - }, 'The comment is now in the store'); - assert.isNumber(DS.lastModified('comment', 5)); - assert.isNumber(DS.lastSaved('comment', 5)); - - setTimeout(function () { - assert.isUndefined(DS.get('comment', 5)); - - assert.equal(lifecycle.beforeInject.callCount, 1, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 1, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); - - done(); - }, 100); - }); - it('should get an item from the server and delete when using DSCacheFactory in aggressive mode', function (done) { - DS.defineResource({ - name: 'comment', - endpoint: '/comments', - deleteOnExpire: 'aggressive', - recycleFreq: 10, - maxAge: 20 - }); - - $httpBackend.expectGET('http://test.angular-cache.com/comments/5').respond(200, { - id: 5, - text: 'test' - }); - - DS.find('comment', 5).then(function (comment) { - assert.deepEqual(comment, { - id: 5, - text: 'test' - }); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - $httpBackend.flush(); - - assert.deepEqual(DS.get('comment', 5), { - id: 5, - text: 'test' - }, 'The comment is now in the store'); - assert.isNumber(DS.lastModified('comment', 5)); - assert.isNumber(DS.lastSaved('comment', 5)); - - setTimeout(function () { - assert.isUndefined(DS.get('comment', 5)); - - assert.equal(lifecycle.beforeInject.callCount, 1, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 1, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); - - done(); - }, 100); - }); + beforeEach(function () { + module('angular-data.DSCacheFactory'); + }); + + beforeEach(startInjector); + + it('should get an item from the server and delete when using DSCacheFactory in passive mode', function (done) { + DS.defineResource({ + name: 'Comment', + endpoint: '/comments', + deleteOnExpire: 'passive', + maxAge: 20 + }); + + $httpBackend.expectGET('http://test.angular-cache.com/comments/5').respond(200, { + id: 5, + text: 'test' + }); + + DS.find('Comment', 5).then(function (comment) { + assert.deepEqual(comment, { + id: 5, + text: 'test' + }); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + $httpBackend.flush(); + + assert.deepEqual(DS.get('Comment', 5), { + id: 5, + text: 'test' + }, 'The comment is now in the store'); + assert.isNumber(DS.lastModified('Comment', 5)); + assert.isNumber(DS.lastSaved('Comment', 5)); + + setTimeout(function () { + assert.isUndefined(DS.get('Comment', 5)); + + assert.equal(lifecycle.beforeInject.callCount, 1, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 1, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); + + done(); + }, 100); + }); + it('should get an item from the server and delete when using DSCacheFactory in aggressive mode', function (done) { + DS.defineResource({ + name: 'Comment', + endpoint: '/comments', + deleteOnExpire: 'aggressive', + recycleFreq: 10, + maxAge: 20 + }); + + $httpBackend.expectGET('http://test.angular-cache.com/comments/5').respond(200, { + id: 5, + text: 'test' + }); + + DS.find('Comment', 5).then(function (comment) { + assert.deepEqual(comment, { + id: 5, + text: 'test' + }); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + $httpBackend.flush(); + + assert.deepEqual(DS.get('Comment', 5), { + id: 5, + text: 'test' + }, 'The comment is now in the store'); + assert.isNumber(DS.lastModified('Comment', 5)); + assert.isNumber(DS.lastSaved('Comment', 5)); + + setTimeout(function () { + assert.isUndefined(DS.get('Comment', 5)); + + assert.equal(lifecycle.beforeInject.callCount, 1, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 1, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); + + done(); + }, 100); + }); }); diff --git a/test/integration/datastore/async_methods/create.test.js b/test/integration/datastore/async_methods/create.test.js index 2c2e807..02e198f 100644 --- a/test/integration/datastore/async_methods/create.test.js +++ b/test/integration/datastore/async_methods/create.test.js @@ -1,43 +1,83 @@ describe('DS.create(resourceName, attrs[, options])', function () { - var errorPrefix = 'DS.create(resourceName, attrs[, options]): '; - - beforeEach(startInjector); - - it('should throw an error when method pre-conditions are not met', function () { - DS.create('does not exist', 5).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.RuntimeError); - assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); - }); - - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - DS.create('post', key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'attrs: Must be an object!'); - }); - }); - }); - it('should create an item and save it to the server', function () { - $httpBackend.expectPOST('http://test.angular-cache.com/posts').respond(200, p1); - - DS.create('post', { author: 'John', age: 30 }).then(function (post) { - assert.deepEqual(post, p1, 'post 5 should have been created'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - assert.equal(lifecycle.beforeCreate.callCount, 1, 'beforeCreate should have been called'); - assert.equal(lifecycle.afterCreate.callCount, 1, 'afterCreate should have been called'); - assert.equal(lifecycle.beforeInject.callCount, 1, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 1, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 1, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); - assert.deepEqual(DS.get('post', 5), p1); - }); + var errorPrefix = 'DS.create(resourceName, attrs[, options]): '; + + beforeEach(startInjector); + + it('should throw an error when method pre-conditions are not met', function () { + DS.create('fruit loops', 5).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.NonexistentResourceError); + assert.equal(err.message, errorPrefix + 'fruit loops is not a registered resource!'); + }); + + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + DS.create('post', key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'attrs: Must be an object!'); + }); + }); + }); + it('should create an item and save it to the server', function () { + $httpBackend.expectPOST('http://test.angular-cache.com/posts').respond(200, p1); + + DS.create('post', { author: 'John', age: 30 }).then(function (post) { + assert.deepEqual(post, p1, 'post 5 should have been created'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + assert.equal(lifecycle.beforeCreate.callCount, 1, 'beforeCreate should have been called'); + assert.equal(lifecycle.afterCreate.callCount, 1, 'afterCreate should have been called'); + assert.equal(lifecycle.beforeInject.callCount, 1, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 1, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 1, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); + assert.deepEqual(DS.get('post', 5), p1); + }); + it('should create an item that includes relations, save them to the server and inject the results', function () { + var payload = { + id: 99, + name: 'Sally', + profile: { + id: 999, + userId: 99, + email: 'sally@test.com' + } + }; + + $httpBackend.expectPOST('http://test.angular-cache.com/user').respond(200, payload); + + DS.create('user', { + name: 'Sally', + profile: { + email: 'sally@test.com' + } + }).then(function (user) { + assert.deepEqual(user, payload, 'user should have been created'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + assert.equal(lifecycle.beforeCreate.callCount, 1, 'beforeCreate should have been called twice'); + assert.equal(lifecycle.afterCreate.callCount, 1, 'afterCreate should have been called twice'); + assert.equal(lifecycle.beforeInject.callCount, 2, 'beforeInject should have been called twice'); + assert.equal(lifecycle.afterInject.callCount, 2, 'afterInject should have been called twice'); + assert.equal(lifecycle.serialize.callCount, 1, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); + assert.deepEqual(DS.get('user', 99), payload); + assert.deepEqual(DS.get('profile', 999), { + id: 999, + userId: 99, + email: 'sally@test.com' + }); + }); }); diff --git a/test/integration/datastore/async_methods/destroy.test.js b/test/integration/datastore/async_methods/destroy.test.js index d0b4c5b..46e9dc3 100644 --- a/test/integration/datastore/async_methods/destroy.test.js +++ b/test/integration/datastore/async_methods/destroy.test.js @@ -1,43 +1,43 @@ describe('DS.destroy(resourceName, id)', function () { - var errorPrefix = 'DS.destroy(resourceName, id): '; + var errorPrefix = 'DS.destroy(resourceName, id): '; - beforeEach(startInjector); + beforeEach(startInjector); - it('should throw an error when method pre-conditions are not met', function () { - DS.destroy('does not exist', 5).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.RuntimeError); - assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); - }); + it('should throw an error when method pre-conditions are not met', function () { + DS.destroy('does not exist', 5).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.NonexistentResourceError); + assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); + }); - angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { - DS.destroy('post', key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'id: Must be a string or a number!'); - }); - }); - }); - it('should delete an item from the data store', function () { - $httpBackend.expectDELETE('http://test.angular-cache.com/posts/5').respond(200, 5); + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { + DS.destroy('post', key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'id: Must be a string or a number!'); + }); + }); + }); + it('should delete an item from the data store', function () { + $httpBackend.expectDELETE('http://test.angular-cache.com/posts/5').respond(200, 5); - DS.inject('post', p1); + DS.inject('post', p1); - DS.destroy('post', 5).then(function (id) { - assert.equal(id, 5, 'post 5 should have been deleted'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); + DS.destroy('post', 5).then(function (id) { + assert.equal(id, 5, 'post 5 should have been deleted'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); - $httpBackend.flush(); + $httpBackend.flush(); - assert.equal(lifecycle.beforeDestroy.callCount, 1, 'beforeDestroy should have been called'); - assert.equal(lifecycle.afterDestroy.callCount, 1, 'afterDestroy should have been called'); - assert.isUndefined(DS.get('post', 5)); - assert.equal(DS.lastModified('post', 5), 0); - assert.equal(DS.lastSaved('post', 5), 0); - }); + assert.equal(lifecycle.beforeDestroy.callCount, 1, 'beforeDestroy should have been called'); + assert.equal(lifecycle.afterDestroy.callCount, 1, 'afterDestroy should have been called'); + assert.isUndefined(DS.get('post', 5)); + assert.equal(DS.lastModified('post', 5), 0); + assert.equal(DS.lastSaved('post', 5), 0); + }); }); diff --git a/test/integration/datastore/async_methods/destroyAll.test.js b/test/integration/datastore/async_methods/destroyAll.test.js index 74812ea..d7cd083 100644 --- a/test/integration/datastore/async_methods/destroyAll.test.js +++ b/test/integration/datastore/async_methods/destroyAll.test.js @@ -1,77 +1,77 @@ describe('DS.destroyAll(resourceName, params[, options]): ', function () { - var errorPrefix = 'DS.destroyAll(resourceName, params[, options]): '; + var errorPrefix = 'DS.destroyAll(resourceName, params[, options]): '; - beforeEach(startInjector); + beforeEach(startInjector); - it('should throw an error when method pre-conditions are not met', function () { - DS.destroyAll('does not exist', {}).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.RuntimeError); - assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); - }); + it('should throw an error when method pre-conditions are not met', function () { + DS.destroyAll('does not exist', {}).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.NonexistentResourceError); + assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); + }); - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - DS.destroyAll('post', key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'params: Must be an object!'); - }); - }); + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + DS.destroyAll('post', key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'params: Must be an object!'); + }); + }); - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - DS.destroyAll('post', {}, key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'options: Must be an object!'); - }); - } - }); - }); - it('should query the server for a collection', function () { - $httpBackend.expectDELETE('http://test.angular-cache.com/posts?query=%7B%22where%22:%7B%22age%22:33%7D%7D').respond(200); + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + DS.destroyAll('post', {}, key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'options: Must be an object!'); + }); + } + }); + }); + it('should query the server for a collection', function () { + $httpBackend.expectDELETE('http://test.angular-cache.com/posts?where=%7B%22age%22:33%7D').respond(200); - DS.inject('post', p1); - DS.inject('post', p2); - DS.inject('post', p3); - DS.inject('post', p4); - DS.inject('post', p5); + DS.inject('post', p1); + DS.inject('post', p2); + DS.inject('post', p3); + DS.inject('post', p4); + DS.inject('post', p5); - DS.destroyAll('post', { query: { where: { age: 33 } } }).then(function () { + DS.destroyAll('post', { where: { age: 33 } }).then(function () { - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); - $httpBackend.flush(); + $httpBackend.flush(); - assert.isDefined(DS.get('post', 5)); - assert.isDefined(DS.get('post', 6)); - assert.isDefined(DS.get('post', 7)); - assert.isUndefined(DS.get('post', 8)); - assert.isUndefined(DS.get('post', 9)); + assert.isDefined(DS.get('post', 5)); + assert.isDefined(DS.get('post', 6)); + assert.isDefined(DS.get('post', 7)); + assert.isUndefined(DS.get('post', 8)); + assert.isUndefined(DS.get('post', 9)); - $httpBackend.expectDELETE(/http:\/\/test\.angular-cache\.com\/posts\??/).respond(200); + $httpBackend.expectDELETE('http://test.angular-cache.com/posts').respond(200); - DS.inject('post', p1); - DS.inject('post', p2); - DS.inject('post', p3); - DS.inject('post', p4); - DS.inject('post', p5); + DS.inject('post', p1); + DS.inject('post', p2); + DS.inject('post', p3); + DS.inject('post', p4); + DS.inject('post', p5); - DS.destroyAll('post', {}).then(function () { + DS.destroyAll('post', {}).then(function () { - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); - $httpBackend.flush(); + $httpBackend.flush(); - assert.deepEqual(DS.filter('post', {}), [], 'The posts should not be in the store yet'); - }); + assert.deepEqual(DS.filter('post', {}), [], 'The posts should not be in the store yet'); + }); }); diff --git a/test/integration/datastore/async_methods/find.test.js b/test/integration/datastore/async_methods/find.test.js index c69e76a..c42acf5 100644 --- a/test/integration/datastore/async_methods/find.test.js +++ b/test/integration/datastore/async_methods/find.test.js @@ -1,114 +1,114 @@ describe('DS.find(resourceName, id[, options]): ', function () { - var errorPrefix = 'DS.find(resourceName, id[, options]): '; - - beforeEach(startInjector); - - it('should throw an error when method pre-conditions are not met', function () { - DS.find('does not exist', 5).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.RuntimeError); - assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); - }); - - angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { - DS.find('post', key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'id: Must be a string or a number!'); - }); - }); - - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - DS.find('post', 5, key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'options: Must be an object!'); - }); - } - }); - }); - it('should get an item from the server', function () { - $httpBackend.expectGET('http://test.angular-cache.com/posts/5').respond(200, p1); - - DS.find('post', 5).then(function (post) { - assert.deepEqual(post, p1); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - assert.isUndefined(DS.get('post', 5), 'The post should not be in the store yet'); - - // Should have no effect because there is already a pending query - DS.find('post', 5).then(function (post) { - assert.deepEqual(post, p1); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - $httpBackend.flush(); - - assert.deepEqual(DS.get('post', 5), p1, 'The post is now in the store'); - assert.isNumber(DS.lastModified('post', 5)); - assert.isNumber(DS.lastSaved('post', 5)); - - // Should not make a request because the request was already completed - DS.find('post', 5).then(function (post) { - assert.deepEqual(post, p1); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - $httpBackend.expectGET('http://test.angular-cache.com/posts/5').respond(200, p1); - - // Should make a request because bypassCache is set to true - DS.find('post', 5, { bypassCache: true }).then(function (post) { - assert.deepEqual(post, p1); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - $httpBackend.flush(); - - assert.equal(lifecycle.beforeInject.callCount, 2, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 2, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 2, 'deserialize should have been called'); - }); - it('should get an item from the server but not store it if cacheResponse is false', function () { - $httpBackend.expectGET('http://test.angular-cache.com/posts/5').respond(200, p1); - - DS.find('post', 5, { cacheResponse: false }).then(function (post) { - assert.deepEqual(post, p1); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - $httpBackend.flush(); - - assert.isUndefined(DS.get('post', 5), 'The post should not have been injected into the store'); - assert.equal(lifecycle.beforeInject.callCount, 0, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 0, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); - }); - it('should correctly propagate errors', function () { - $httpBackend.expectGET('http://test.angular-cache.com/posts/5').respond(404, 'Not Found'); - - DS.find('post', 5).then(function () { - fail('Should not have succeeded!'); - }, function (err) { - assert.equal(err.data, 'Not Found'); - }); - - $httpBackend.flush(); - }); + var errorPrefix = 'DS.find(resourceName, id[, options]): '; + + beforeEach(startInjector); + + it('should throw an error when method pre-conditions are not met', function () { + DS.find('does not exist', 5).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.NonexistentResourceError); + assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); + }); + + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { + DS.find('post', key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'id: Must be a string or a number!'); + }); + }); + + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + DS.find('post', 5, key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'options: Must be an object!'); + }); + } + }); + }); + it('should get an item from the server', function () { + $httpBackend.expectGET('http://test.angular-cache.com/posts/5').respond(200, p1); + + DS.find('post', 5).then(function (post) { + assert.deepEqual(post, p1); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + assert.isUndefined(DS.get('post', 5), 'The post should not be in the store yet'); + + // Should have no effect because there is already a pending query + DS.find('post', 5).then(function (post) { + assert.deepEqual(post, p1); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + $httpBackend.flush(); + + assert.deepEqual(DS.get('post', 5), p1, 'The post is now in the store'); + assert.isNumber(DS.lastModified('post', 5)); + assert.isNumber(DS.lastSaved('post', 5)); + + // Should not make a request because the request was already completed + DS.find('post', 5).then(function (post) { + assert.deepEqual(post, p1); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + $httpBackend.expectGET('http://test.angular-cache.com/posts/5').respond(200, p1); + + // Should make a request because bypassCache is set to true + DS.find('post', 5, { bypassCache: true }).then(function (post) { + assert.deepEqual(post, p1); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + $httpBackend.flush(); + + assert.equal(lifecycle.beforeInject.callCount, 2, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 2, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 2, 'deserialize should have been called'); + }); + it('should get an item from the server but not store it if cacheResponse is false', function () { + $httpBackend.expectGET('http://test.angular-cache.com/posts/5').respond(200, p1); + + DS.find('post', 5, { cacheResponse: false }).then(function (post) { + assert.deepEqual(post, p1); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + $httpBackend.flush(); + + assert.isUndefined(DS.get('post', 5), 'The post should not have been injected into the store'); + assert.equal(lifecycle.beforeInject.callCount, 0, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 0, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); + }); + it('should correctly propagate errors', function () { + $httpBackend.expectGET('http://test.angular-cache.com/posts/5').respond(404, 'Not Found'); + + DS.find('post', 5).then(function () { + fail('Should not have succeeded!'); + }, function (err) { + assert.equal(err.data, 'Not Found'); + }); + + $httpBackend.flush(); + }); }); diff --git a/test/integration/datastore/async_methods/findAll.test.js b/test/integration/datastore/async_methods/findAll.test.js index 92a681f..d7de101 100644 --- a/test/integration/datastore/async_methods/findAll.test.js +++ b/test/integration/datastore/async_methods/findAll.test.js @@ -1,183 +1,214 @@ describe('DS.findAll(resourceName, params[, options]): ', function () { - var errorPrefix = 'DS.findAll(resourceName, params[, options]): '; - - beforeEach(startInjector); - - it('should throw an error when method pre-conditions are not met', function () { - DS.findAll('does not exist', {}).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.RuntimeError); - assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); - }); - - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - DS.findAll('post', key, { cacheResponse: false }).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'params: Must be an object!'); - }); - } - }); - - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - DS.findAll('post', {}, key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'options: Must be an object!'); - }); - } - }); - }); - it('should query the server for a collection', function () { - $httpBackend.expectGET(/http:\/\/test\.angular-cache\.com\/posts\??/).respond(200, [p1, p2, p3, p4]); - - DS.findAll('post', {}).then(function (data) { - assert.deepEqual(data, [p1, p2, p3, p4]); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - assert.deepEqual(DS.filter('post', {}), [], 'The posts should not be in the store yet'); - - // Should have no effect because there is already a pending query - DS.findAll('post', {}).then(function (data) { - assert.deepEqual(data, [p1, p2, p3, p4]); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - $httpBackend.flush(); - - assert.deepEqual(DS.filter('post', {}), [p1, p2, p3, p4], 'The posts are now in the store'); - assert.isNumber(DS.lastModified('post', 5)); - assert.isNumber(DS.lastSaved('post', 5)); - - // Should not make a request because the request was already completed - DS.findAll('post', {}).then(function (data) { - assert.deepEqual(data, [p1, p2, p3, p4]); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - $httpBackend.expectGET(/http:\/\/test\.angular-cache\.com\/posts\??/).respond(200, [p1, p2, p3, p4]); - - // Should make a request because bypassCache is set to true - DS.findAll('post', {}, { bypassCache: true }).then(function (data) { - assert.deepEqual(data, [p1, p2, p3, p4]); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - $httpBackend.flush(); - - assert.equal(lifecycle.beforeInject.callCount, 8, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 8, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 2, 'deserialize should have been called'); - }); - it('should query the server for a collection but not store the data if cacheResponse is false', function () { - $httpBackend.expectGET(/http:\/\/test\.angular-cache\.com\/posts\??/).respond(200, [p1, p2, p3, p4]); - - DS.findAll('post', {}, { cacheResponse: false }).then(function (data) { - assert.deepEqual(data, [p1, p2, p3, p4]); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - $httpBackend.flush(); - - assert.deepEqual(DS.filter('post', {}), [], 'The posts should not have been injected into the store'); - - assert.equal(lifecycle.beforeInject.callCount, 0, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 0, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); - }); - it('should correctly propagate errors', function () { - $httpBackend.expectGET(/http:\/\/test\.angular-cache\.com\/posts\??/).respond(404, 'Not Found'); - - DS.findAll('post', {}).then(function () { - fail('Should not have succeeded!'); - }, function (err) { - assert.equal(err.data, 'Not Found'); - }); - - $httpBackend.flush(); - }); - it('"params" argument is optional', function () { - $httpBackend.expectGET(/http:\/\/test\.angular-cache\.com\/posts\??/).respond(200, [p1, p2, p3, p4]); - - DS.findAll('post').then(function (data) { - assert.deepEqual(data, [p1, p2, p3, p4]); - }, function (err) { - console.error(err.message); - fail('Should not have rejected!'); - }); - - $httpBackend.flush(); - - assert.deepEqual(DS.filter('post', {}), [p1, p2, p3, p4], 'The posts are now in the store'); - - assert.equal(lifecycle.beforeInject.callCount, 4, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 4, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); - }); - it('should return already injected items', function () { - var u1 = { - id: 1, - name: 'John' - }, - u2 = { - id: 2, - name: 'Sally' - }; - - DS.defineResource({ - name: 'user', - endpoint: 'users', - methods: { - fullName: function () { - return this.first + ' ' + this.last; - } - } - }); - - $httpBackend.expectGET(/http:\/\/test\.angular-cache\.com\/users\??/).respond(200, [u1, u2]); - - DS.findAll('user').then(function (data) { - assert.deepEqual(data, [ - DSUtils.deepMixIn(new DS.definitions.user[DS.definitions.user.class](), u1), - DSUtils.deepMixIn(new DS.definitions.user[DS.definitions.user.class](), u2) - ]); - angular.forEach(data, function (user) { - assert.isTrue(user instanceof DS.definitions.user[DS.definitions.user.class], 'should be an instance of User'); - }); - }, function (err) { - console.error(err.message); - fail('Should not have rejected!'); - }); - - $httpBackend.flush(); - - assert.deepEqual(DS.filter('user'), [ - DSUtils.deepMixIn(new DS.definitions.user[DS.definitions.user.class](), u1), - DSUtils.deepMixIn(new DS.definitions.user[DS.definitions.user.class](), u2) - ], 'The users are now in the store'); - - assert.equal(lifecycle.beforeInject.callCount, 2, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 2, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); - }); + var errorPrefix = 'DS.findAll(resourceName, params[, options]): '; + + beforeEach(startInjector); + + it('should throw an error when method pre-conditions are not met', function () { + DS.findAll('does not exist', {}).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.NonexistentResourceError); + assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); + }); + + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + DS.findAll('post', key, { cacheResponse: false }).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'params: Must be an object!'); + }); + } + }); + + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + DS.findAll('post', {}, key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'options: Must be an object!'); + }); + } + }); + }); + it('should query the server for a collection', function () { + $httpBackend.expectGET(/http:\/\/test\.angular-cache\.com\/posts\??/).respond(200, [p1, p2, p3, p4]); + + DS.findAll('post', {}).then(function (data) { + assert.deepEqual(data, [p1, p2, p3, p4]); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + assert.deepEqual(DS.filter('post', {}), [], 'The posts should not be in the store yet'); + + // Should have no effect because there is already a pending query + DS.findAll('post', {}).then(function (data) { + assert.deepEqual(data, [p1, p2, p3, p4]); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + $httpBackend.flush(); + + assert.deepEqual(DS.filter('post', {}), [p1, p2, p3, p4], 'The posts are now in the store'); + assert.isNumber(DS.lastModified('post', 5)); + assert.isNumber(DS.lastSaved('post', 5)); + + // Should not make a request because the request was already completed + DS.findAll('post', {}).then(function (data) { + assert.deepEqual(data, [p1, p2, p3, p4]); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + $httpBackend.expectGET(/http:\/\/test\.angular-cache\.com\/posts\??/).respond(200, [p1, p2, p3, p4]); + + // Should make a request because bypassCache is set to true + DS.findAll('post', {}, { bypassCache: true }).then(function (data) { + assert.deepEqual(data, [p1, p2, p3, p4]); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + $httpBackend.flush(); + + assert.equal(lifecycle.beforeInject.callCount, 8, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 8, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 2, 'deserialize should have been called'); + }); + it('should query the server for a collection but not store the data if cacheResponse is false', function () { + $httpBackend.expectGET(/http:\/\/test\.angular-cache\.com\/posts\??/).respond(200, [p1, p2, p3, p4]); + + DS.findAll('post', {}, { cacheResponse: false }).then(function (data) { + assert.deepEqual(data, [p1, p2, p3, p4]); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + $httpBackend.flush(); + + assert.deepEqual(DS.filter('post', {}), [], 'The posts should not have been injected into the store'); + + assert.equal(lifecycle.beforeInject.callCount, 0, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 0, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); + }); + it('should correctly propagate errors', function () { + $httpBackend.expectGET(/http:\/\/test\.angular-cache\.com\/posts\??/).respond(404, 'Not Found'); + + DS.findAll('post', {}).then(function () { + fail('Should not have succeeded!'); + }, function (err) { + assert.equal(err.data, 'Not Found'); + }); + + $httpBackend.flush(); + }); + it('"params" argument is optional', function () { + $httpBackend.expectGET(/http:\/\/test\.angular-cache\.com\/posts\??/).respond(200, [p1, p2, p3, p4]); + + DS.findAll('post').then(function (data) { + assert.deepEqual(data, [p1, p2, p3, p4]); + }, function (err) { + console.error(err.message); + fail('Should not have rejected!'); + }); + + $httpBackend.flush(); + + assert.deepEqual(DS.filter('post', {}), [p1, p2, p3, p4], 'The posts are now in the store'); + + assert.equal(lifecycle.beforeInject.callCount, 4, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 4, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); + }); + it('"params"', function () { + $httpBackend.expectGET('http://test.angular-cache.com/posts?where=%7B%22author%22:%22Adam%22%7D').respond(200, [p4, p5]); + + var params = { + where: { + author: 'Adam' + } + }; + DS.findAll('post', params).then(function (data) { + assert.deepEqual(data, [p4, p5]); + }, function (err) { + console.error(err.message); + fail('Should not have rejected!'); + }); + + $httpBackend.flush(); + + assert.deepEqual(DS.filter('post', params), [p4, p5], 'The posts are now in the store'); + assert.deepEqual(DS.filter('post', { + where: { + id: { + '>': 8 + } + } + }), [p5], 'The posts are now in the store'); + + assert.equal(lifecycle.beforeInject.callCount, 2, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 2, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); + }); + it('should return already injected items', function () { + var u1 = { + id: 1, + name: 'John' + }, + u2 = { + id: 2, + name: 'Sally' + }; + + DS.defineResource({ + name: 'person', + endpoint: 'users', + methods: { + fullName: function () { + return this.first + ' ' + this.last; + } + } + }); + + $httpBackend.expectGET(/http:\/\/test\.angular-cache\.com\/users\??/).respond(200, [u1, u2]); + + DS.findAll('person').then(function (data) { + assert.deepEqual(data, [ + DSUtils.deepMixIn(new DS.definitions.person[DS.definitions.person.class](), u1), + DSUtils.deepMixIn(new DS.definitions.person[DS.definitions.person.class](), u2) + ]); + angular.forEach(data, function (person) { + assert.isTrue(person instanceof DS.definitions.person[DS.definitions.person.class], 'should be an instance of User'); + }); + }, function (err) { + console.error(err.message); + fail('Should not have rejected!'); + }); + + $httpBackend.flush(); + + assert.deepEqual(DS.filter('person'), [ + DSUtils.deepMixIn(new DS.definitions.person[DS.definitions.person.class](), u1), + DSUtils.deepMixIn(new DS.definitions.person[DS.definitions.person.class](), u2) + ], 'The users are now in the store'); + + assert.equal(lifecycle.beforeInject.callCount, 2, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 2, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); + }); }); diff --git a/test/integration/datastore/async_methods/loadRelations.test.js b/test/integration/datastore/async_methods/loadRelations.test.js new file mode 100644 index 0000000..de68dd7 --- /dev/null +++ b/test/integration/datastore/async_methods/loadRelations.test.js @@ -0,0 +1,123 @@ +describe('DS.loadRelations(resourceName, instance(Id), relations[, options]): ', function () { + var errorPrefix = 'DS.loadRelations(resourceName, instance(Id), relations[, options]): '; + + beforeEach(startInjector); + + it('should throw an error when method pre-conditions are not met', function () { + DS.loadRelations('does not exist', user10, []).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.NonexistentResourceError); + assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); + }); + + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER_OBJECT, function (key) { + if (angular.isArray(key)) { + return; + } + DS.loadRelations('user', key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'instance(Id): Must be a string, number or object!'); + }); + }); + + angular.forEach(TYPES_EXCEPT_STRING_OR_ARRAY, function (key) { + if (key) { + DS.loadRelations('user', user10, key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'relations: Must be a string or an array!'); + }); + } + }); + + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + DS.loadRelations('user', user10, [], key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'options: Must be an object!'); + }); + } + }); + }); + it('should get an item from the server', function () { + DS.inject('user', user10); + + $httpBackend.expectGET('http://test.angular-cache.com/organization/14').respond(200, organization14); + $httpBackend.expectGET('http://test.angular-cache.com/comment?userId=10').respond(200, [ + comment11, + comment12, + comment13 + ]); + $httpBackend.expectGET('http://test.angular-cache.com/profile?userId=10').respond(200, profile15); + + DS.loadRelations('user', 10, ['comment', 'profile', 'organization']).then(function (user) { + assert.deepEqual(user.comments, [ + comment11, + comment12, + comment13 + ]); + assert.deepEqual(user.organization, organization14); + assert.deepEqual(user.profile, profile15); + }, fail); + + $httpBackend.flush(); + }); + it('should get an item from the server but not store it if cacheResponse is false', function () { + DS.inject('user', { + name: 'John Anderson', + id: 10, + organizationId: 14 + }); + + $httpBackend.expectGET('http://test.angular-cache.com/organization/14').respond(200, organization14); + $httpBackend.expectGET('http://test.angular-cache.com/comment?userId=10').respond(200, [ + comment11, + comment12, + comment13 + ]); + $httpBackend.expectGET('http://test.angular-cache.com/profile?userId=10').respond(200, profile15); + + DS.loadRelations('user', 10, ['comment', 'profile', 'organization'], { cacheResponse: false }).then(function (user) { + assert.deepEqual(user.comments, [ + comment11, + comment12, + comment13 + ]); + assert.deepEqual(user.organization, organization14); + assert.deepEqual(user.profile, profile15); + + assert.isUndefined(DS.get('comment', 11)); + assert.isUndefined(DS.get('comment', 12)); + assert.isUndefined(DS.get('comment', 13)); + assert.isUndefined(DS.get('organization', 14)); + assert.isUndefined(DS.get('profile', 15)); + }, fail); + + $httpBackend.flush(); + }); + it('should correctly propagate errors', function () { + DS.inject('user', { + name: 'John Anderson', + id: 10, + organizationId: 14 + }); + + $httpBackend.expectGET('http://test.angular-cache.com/organization/14').respond(404, 'Not Found'); + $httpBackend.expectGET('http://test.angular-cache.com/comment?userId=10').respond(404, 'Not Found'); + $httpBackend.expectGET('http://test.angular-cache.com/profile?userId=10').respond(404, 'Not Found'); + + DS.loadRelations('user', 10, ['comment', 'profile', 'organization']).then(function () { + fail('Should not have succeeded!'); + }, function (err) { + assert.equal(err.data, 'Not Found'); + }); + + $httpBackend.flush(); + }); +}); diff --git a/test/integration/datastore/async_methods/refresh.test.js b/test/integration/datastore/async_methods/refresh.test.js index b0dae88..782b5ce 100644 --- a/test/integration/datastore/async_methods/refresh.test.js +++ b/test/integration/datastore/async_methods/refresh.test.js @@ -1,60 +1,60 @@ describe('DS.refresh(resourceName, id[, options]): ', function () { - var errorPrefix = 'DS.refresh(resourceName, id[, options]): '; - - beforeEach(startInjector); - - it('should throw an error when method pre-conditions are not met', function () { - assert.throws(function () { - DS.refresh('does not exist', 5); - }, DS.errors.RuntimeError, errorPrefix + 'does not exist is not a registered resource!'); - - angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { - assert.throws(function () { - DS.refresh('post', key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); - }); - - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - assert.throws(function () { - DS.refresh('post', 5, key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'options: Must be an object!'); - } - }); - }); - it('should get an item from the server', function () { - - // Should do nothing because the data isn't in the store - assert.isFalse(DS.refresh('post', 5)); - - assert.isUndefined(DS.get('post', 5), 'The post should not be in the store yet'); - - DS.inject('post', p1); - assert.deepEqual(DS.get('post', 5), p1, 'The post is now in the store'); - - var initialLastModified = DS.lastModified('post', 5); - - $httpBackend.expectGET('http://test.angular-cache.com/posts/5').respond(200, { author: 'John', age: 31, id: 5 }); - - // Should refresh the item that's in the store - DS.refresh('post', 5).then(function (post) { - assert.deepEqual(post, { author: 'John', age: 31, id: 5 }); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - // Should have no effect because the request is already pending - DS.refresh('post', 5).then(function (post) { - assert.deepEqual(post, { author: 'John', age: 31, id: 5 }); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - $httpBackend.flush(); - - assert.deepEqual(DS.get('post', 5), { author: 'John', age: 31, id: 5 }, 'The post has been refreshed'); - assert.notEqual(DS.lastModified('post', 5), initialLastModified); - }); + var errorPrefix = 'DS.refresh(resourceName, id[, options]): '; + + beforeEach(startInjector); + + it('should throw an error when method pre-conditions are not met', function () { + assert.throws(function () { + DS.refresh('does not exist', 5); + }, DS.errors.NonexistentResourceError, errorPrefix + 'does not exist is not a registered resource!'); + + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { + assert.throws(function () { + DS.refresh('post', key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); + }); + + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + assert.throws(function () { + DS.refresh('post', 5, key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'options: Must be an object!'); + } + }); + }); + it('should get an item from the server', function () { + + // Should do nothing because the data isn't in the store + assert.isFalse(DS.refresh('post', 5)); + + assert.isUndefined(DS.get('post', 5), 'The post should not be in the store yet'); + + DS.inject('post', p1); + assert.deepEqual(DS.get('post', 5), p1, 'The post is now in the store'); + + var initialLastModified = DS.lastModified('post', 5); + + $httpBackend.expectGET('http://test.angular-cache.com/posts/5').respond(200, { author: 'John', age: 31, id: 5 }); + + // Should refresh the item that's in the store + DS.refresh('post', 5).then(function (post) { + assert.deepEqual(post, { author: 'John', age: 31, id: 5 }); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + // Should have no effect because the request is already pending + DS.refresh('post', 5).then(function (post) { + assert.deepEqual(post, { author: 'John', age: 31, id: 5 }); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + $httpBackend.flush(); + + assert.deepEqual(DS.get('post', 5), { author: 'John', age: 31, id: 5 }, 'The post has been refreshed'); + assert.notEqual(DS.lastModified('post', 5), initialLastModified); + }); }); diff --git a/test/integration/datastore/async_methods/save.test.js b/test/integration/datastore/async_methods/save.test.js index d17c871..13d3822 100644 --- a/test/integration/datastore/async_methods/save.test.js +++ b/test/integration/datastore/async_methods/save.test.js @@ -1,115 +1,115 @@ describe('DS.save(resourceName, id[, options])', function () { - var errorPrefix = 'DS.save(resourceName, id[, options]): '; - - beforeEach(startInjector); - - it('should throw an error when method pre-conditions are not met', function () { - DS.save('does not exist', 5).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.RuntimeError); - assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); - }); - - angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { - DS.save('post', key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'id: Must be a string or a number!'); - }); - }); - - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - DS.save('post', 5, key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'options: Must be an object!'); - }); - } - }); - }); - it('should save an item to the server', function () { - $httpBackend.expectPUT('http://test.angular-cache.com/posts/5').respond(200, p1); - - DS.inject('post', p1); - - var initialModified = DS.lastModified('post', 5), - initialSaved = DS.lastSaved('post', 5); - - p1.author = 'Jake'; - - DS.save('post', 5).then(function (post) { - assert.deepEqual(post, p1, 'post 5 should have been saved'); - assert.equal(post.author, 'Jake'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - assert.equal(lifecycle.beforeUpdate.callCount, 1, 'beforeUpdate should have been called'); - assert.equal(lifecycle.afterUpdate.callCount, 1, 'afterUpdate should have been called'); - assert.deepEqual(DS.get('post', 5), p1); - assert.notEqual(DS.lastModified('post', 5), initialModified); - assert.notEqual(DS.lastSaved('post', 5), initialSaved); - - DS.save('post', 6).then(function () { - fail('should not have succeeded'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.RuntimeError); - assert.equal(err.message, errorPrefix + 'id: "6" not found!'); - }); - - assert.equal(lifecycle.beforeInject.callCount, 2, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 2, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 1, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); - }); - it('should save changes of an item to the server', function () { - $httpBackend.expectPUT('http://test.angular-cache.com/posts/5', { author: 'Jake' }).respond(200, { - author: 'Jake', - id: 5, - age: 30 - }); - - DS.inject('post', p1); - - var initialModified = DS.lastModified('post', 5), - initialSaved = DS.lastSaved('post', 5), - post1 = DS.get('post', 5); - - post1.author = 'Jake'; - - DS.save('post', 5, { changesOnly: true }).then(function (post) { - assert.deepEqual(post, post1, 'post 5 should have been saved'); - assert.equal(post.author, 'Jake'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); - - $httpBackend.flush(); - - assert.equal(lifecycle.beforeUpdate.callCount, 1, 'beforeUpdate should have been called'); - assert.equal(lifecycle.afterUpdate.callCount, 1, 'afterUpdate should have been called'); - assert.deepEqual(DS.get('post', 5), post1); - assert.notEqual(DS.lastModified('post', 5), initialModified); - assert.notEqual(DS.lastSaved('post', 5), initialSaved); - - DS.save('post', 6).then(function () { - fail('should not have succeeded'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.RuntimeError); - assert.equal(err.message, errorPrefix + 'id: "6" not found!'); - }); - - assert.equal(lifecycle.beforeInject.callCount, 2, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 2, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 1, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); - }); + var errorPrefix = 'DS.save(resourceName, id[, options]): '; + + beforeEach(startInjector); + + it('should throw an error when method pre-conditions are not met', function () { + DS.save('does not exist', 5).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.NonexistentResourceError); + assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); + }); + + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { + DS.save('post', key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'id: Must be a string or a number!'); + }); + }); + + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + DS.save('post', 5, key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'options: Must be an object!'); + }); + } + }); + }); + it('should save an item to the server', function () { + $httpBackend.expectPUT('http://test.angular-cache.com/posts/5').respond(200, p1); + + DS.inject('post', p1); + + var initialModified = DS.lastModified('post', 5), + initialSaved = DS.lastSaved('post', 5); + + p1.author = 'Jake'; + + DS.save('post', 5).then(function (post) { + assert.deepEqual(post, p1, 'post 5 should have been saved'); + assert.equal(post.author, 'Jake'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + assert.equal(lifecycle.beforeUpdate.callCount, 1, 'beforeUpdate should have been called'); + assert.equal(lifecycle.afterUpdate.callCount, 1, 'afterUpdate should have been called'); + assert.deepEqual(DS.get('post', 5), p1); + assert.notEqual(DS.lastModified('post', 5), initialModified); + assert.notEqual(DS.lastSaved('post', 5), initialSaved); + + DS.save('post', 6).then(function () { + fail('should not have succeeded'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.RuntimeError); + assert.equal(err.message, errorPrefix + 'id: "6" not found!'); + }); + + assert.equal(lifecycle.beforeInject.callCount, 2, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 2, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 1, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); + }); + it('should save changes of an item to the server', function () { + $httpBackend.expectPUT('http://test.angular-cache.com/posts/5', { author: 'Jake' }).respond(200, { + author: 'Jake', + id: 5, + age: 30 + }); + + DS.inject('post', p1); + + var initialModified = DS.lastModified('post', 5), + initialSaved = DS.lastSaved('post', 5), + post1 = DS.get('post', 5); + + post1.author = 'Jake'; + + DS.save('post', 5, { changesOnly: true }).then(function (post) { + assert.deepEqual(post, post1, 'post 5 should have been saved'); + assert.equal(post.author, 'Jake'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); + + $httpBackend.flush(); + + assert.equal(lifecycle.beforeUpdate.callCount, 1, 'beforeUpdate should have been called'); + assert.equal(lifecycle.afterUpdate.callCount, 1, 'afterUpdate should have been called'); + assert.deepEqual(DS.get('post', 5), post1); + assert.notEqual(DS.lastModified('post', 5), initialModified); + assert.notEqual(DS.lastSaved('post', 5), initialSaved); + + DS.save('post', 6).then(function () { + fail('should not have succeeded'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.RuntimeError); + assert.equal(err.message, errorPrefix + 'id: "6" not found!'); + }); + + assert.equal(lifecycle.beforeInject.callCount, 2, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 2, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 1, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); + }); }); diff --git a/test/integration/datastore/async_methods/update.test.js b/test/integration/datastore/async_methods/update.test.js index 0e89ce6..0fd7614 100644 --- a/test/integration/datastore/async_methods/update.test.js +++ b/test/integration/datastore/async_methods/update.test.js @@ -1,90 +1,90 @@ describe('DS.update(resourceName, id, attrs[, options])', function () { - var errorPrefix = 'DS.update(resourceName, id, attrs[, options]): '; + var errorPrefix = 'DS.update(resourceName, id, attrs[, options]): '; - beforeEach(startInjector); + beforeEach(startInjector); - it('should throw an error when method pre-conditions are not met', function () { - DS.update('does not exist', 5).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.RuntimeError); - assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); - }); + it('should throw an error when method pre-conditions are not met', function () { + DS.update('does not exist', 5).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.NonexistentResourceError); + assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); + }); - angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { - DS.update('post', key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'id: Must be a string or a number!'); - }); - }); + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { + DS.update('post', key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'id: Must be a string or a number!'); + }); + }); - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - DS.update('post', 5, key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'attrs: Must be an object!'); - }); - } - }); + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + DS.update('post', 5, key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'attrs: Must be an object!'); + }); + } + }); - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - DS.update('post', 5, {}, key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'options: Must be an object!'); - }); - } - }); - }); - it('should update an item', function () { - $httpBackend.expectPUT('http://test.angular-cache.com/posts/5').respond(200, { author: 'Jake', age: 30, id: 5 }); + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + DS.update('post', 5, {}, key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'options: Must be an object!'); + }); + } + }); + }); + it('should update an item', function () { + $httpBackend.expectPUT('http://test.angular-cache.com/posts/5').respond(200, { author: 'Jake', age: 30, id: 5 }); - var post = DS.inject('post', p1); + var post = DS.inject('post', p1); - var initialModified = DS.lastModified('post', 5), - initialSaved = DS.lastSaved('post', 5); + var initialModified = DS.lastModified('post', 5), + initialSaved = DS.lastSaved('post', 5); - DS.update('post', 5, { author: 'Jake' }).then(function (p) { - assert.deepEqual(p, post, 'post 5 should have been updated'); - assert.equal(p.author, 'Jake'); - assert.equal(post.author, 'Jake'); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); + DS.update('post', 5, { author: 'Jake' }).then(function (p) { + assert.deepEqual(p, post, 'post 5 should have been updated'); + assert.equal(p.author, 'Jake'); + assert.equal(post.author, 'Jake'); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); - $httpBackend.flush(); - $httpBackend.expectPUT('http://test.angular-cache.com/posts/6').respond(200, { author: 'Jane', age: 31, id: 6 }); + $httpBackend.flush(); + $httpBackend.expectPUT('http://test.angular-cache.com/posts/6').respond(200, { author: 'Jane', age: 31, id: 6 }); - assert.equal(lifecycle.beforeUpdate.callCount, 1, 'beforeUpdate should have been called'); - assert.equal(lifecycle.afterUpdate.callCount, 1, 'afterUpdate should have been called'); - assert.equal(lifecycle.beforeInject.callCount, 2, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 2, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 1, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); - assert.deepEqual(DS.get('post', 5), post); - assert.notEqual(DS.lastModified('post', 5), initialModified); - assert.notEqual(DS.lastSaved('post', 5), initialSaved); + assert.equal(lifecycle.beforeUpdate.callCount, 1, 'beforeUpdate should have been called'); + assert.equal(lifecycle.afterUpdate.callCount, 1, 'afterUpdate should have been called'); + assert.equal(lifecycle.beforeInject.callCount, 2, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 2, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 1, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); + assert.deepEqual(DS.get('post', 5), post); + assert.notEqual(DS.lastModified('post', 5), initialModified); + assert.notEqual(DS.lastSaved('post', 5), initialSaved); - DS.update('post', 6, { author: 'Jane' }).then(function (p) { - assert.deepEqual(p, DS.get('post', 6)); - assert.deepEqual(p, { author: 'Jane', age: 31, id: 6 }); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); + DS.update('post', 6, { author: 'Jane' }).then(function (p) { + assert.deepEqual(p, DS.get('post', 6)); + assert.deepEqual(p, { author: 'Jane', age: 31, id: 6 }); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); - $httpBackend.flush(); + $httpBackend.flush(); - assert.equal(lifecycle.beforeInject.callCount, 3, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 3, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 2, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 2, 'deserialize should have been called'); - }); + assert.equal(lifecycle.beforeInject.callCount, 3, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 3, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 2, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 2, 'deserialize should have been called'); + }); }); diff --git a/test/integration/datastore/async_methods/updateAll.test.js b/test/integration/datastore/async_methods/updateAll.test.js index 95707cc..1379034 100644 --- a/test/integration/datastore/async_methods/updateAll.test.js +++ b/test/integration/datastore/async_methods/updateAll.test.js @@ -1,97 +1,97 @@ describe('DS.updateAll(resourceName, attrs, params[, options])', function () { - var errorPrefix = 'DS.updateAll(resourceName, attrs, params[, options]): '; + var errorPrefix = 'DS.updateAll(resourceName, attrs, params[, options]): '; - beforeEach(startInjector); + beforeEach(startInjector); - it('should throw an error when method pre-conditions are not met', function () { - DS.updateAll('does not exist').then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.RuntimeError); - assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); - }); + it('should throw an error when method pre-conditions are not met', function () { + DS.updateAll('does not exist').then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.NonexistentResourceError); + assert.equal(err.message, errorPrefix + 'does not exist is not a registered resource!'); + }); - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - DS.updateAll('post', key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'attrs: Must be an object!'); - }); - } - }); + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + DS.updateAll('post', key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'attrs: Must be an object!'); + }); + } + }); - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - DS.updateAll('post', {}, key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'params: Must be an object!'); - }); - } - }); + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + DS.updateAll('post', {}, key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'params: Must be an object!'); + }); + } + }); - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - DS.updateAll('post', {}, {}, key).then(function () { - fail('should have rejected'); - }, function (err) { - assert.isTrue(err instanceof DS.errors.IllegalArgumentError); - assert.equal(err.message, errorPrefix + 'options: Must be an object!'); - }); - } - }); - }); - it('should update a collection of items', function () { - $httpBackend.expectPUT('http://test.angular-cache.com/posts?query=%7B%22where%22:%7B%22age%22:%7B%22%3D%3D%22:33%7D%7D%7D').respond(200, [ - { author: 'Adam', age: 27, id: 8 }, - { author: 'Adam', age: 27, id: 9 } - ]); + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + DS.updateAll('post', {}, {}, key).then(function () { + fail('should have rejected'); + }, function (err) { + assert.isTrue(err instanceof DS.errors.IllegalArgumentError); + assert.equal(err.message, errorPrefix + 'options: Must be an object!'); + }); + } + }); + }); + it('should update a collection of items', function () { + $httpBackend.expectPUT('http://test.angular-cache.com/posts?where=%7B%22age%22:%7B%22%3D%3D%22:33%7D%7D').respond(200, [ + { author: 'Adam', age: 27, id: 8 }, + { author: 'Adam', age: 27, id: 9 } + ]); - var post4 = DS.inject('post', p4), - post5 = DS.inject('post', p5), - posts = DS.filter('post', { query: { where: { age: { '==': 33 } } } }); + var post4 = DS.inject('post', p4), + post5 = DS.inject('post', p5), + posts = DS.filter('post', { where: { age: { '==': 33 } } }); - var initialModified = DS.lastModified('post', 8), - initialSaved = DS.lastSaved('post', 8); + var initialModified = DS.lastModified('post', 8), + initialSaved = DS.lastSaved('post', 8); - DS.updateAll('post', { age: 27 }, { query: { where: { age: { '==': 33 } } } }).then(function (ps) { - assert.deepEqual(ps, posts, '2 posts should have been updated'); - assert.equal(posts[0].age, 27); - assert.equal(posts[1].age, 27); - assert.equal(post4.age, 27); - assert.equal(post5.age, 27); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); + DS.updateAll('post', { age: 27 }, { where: { age: { '==': 33 } } }).then(function (ps) { + assert.deepEqual(ps, posts, '2 posts should have been updated'); + assert.equal(posts[0].age, 27); + assert.equal(posts[1].age, 27); + assert.equal(post4.age, 27); + assert.equal(post5.age, 27); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); - $httpBackend.flush(); - $httpBackend.expectPUT('http://test.angular-cache.com/posts?query=%7B%22where%22:%7B%22age%22:%7B%22%3D%3D%22:31%7D%7D%7D').respond(200, [ - { author: 'Jane', age: 5, id: 6 } - ]); + $httpBackend.flush(); + $httpBackend.expectPUT('http://test.angular-cache.com/posts?where=%7B%22age%22:%7B%22%3D%3D%22:31%7D%7D').respond(200, [ + { author: 'Jane', age: 5, id: 6 } + ]); - assert.equal(lifecycle.beforeUpdate.callCount, 1, 'beforeUpdate should have been called'); - assert.equal(lifecycle.afterUpdate.callCount, 1, 'afterUpdate should have been called'); - assert.deepEqual(DS.filter('post', { query: { where: { age: { '==': 27 } } } }), posts); - assert.notEqual(DS.lastModified('post', 8), initialModified); - assert.notEqual(DS.lastSaved('post', 8), initialSaved); + assert.equal(lifecycle.beforeUpdate.callCount, 1, 'beforeUpdate should have been called'); + assert.equal(lifecycle.afterUpdate.callCount, 1, 'afterUpdate should have been called'); + assert.deepEqual(DS.filter('post', { where: { age: { '==': 27 } } }), posts); + assert.notEqual(DS.lastModified('post', 8), initialModified); + assert.notEqual(DS.lastSaved('post', 8), initialSaved); - DS.updateAll('post', { age: 5 }, { query: { where: { age: { '==': 31 } } } }).then(function (ps) { - assert.deepEqual(ps, DS.filter('post', { query: { where: { age: { '==': 5 } } } })); - assert.deepEqual(ps[0], { author: 'Jane', age: 5, id: 6 }); - }, function (err) { - console.error(err.stack); - fail('should not have rejected'); - }); + DS.updateAll('post', { age: 5 }, { where: { age: { '==': 31 } } }).then(function (ps) { + assert.deepEqual(ps, DS.filter('post', { where: { age: { '==': 5 } } })); + assert.deepEqual(ps[0], { author: 'Jane', age: 5, id: 6 }); + }, function (err) { + console.error(err.stack); + fail('should not have rejected'); + }); - $httpBackend.flush(); + $httpBackend.flush(); - assert.equal(lifecycle.beforeInject.callCount, 5, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 5, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 2, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 2, 'deserialize should have been called'); - }); + assert.equal(lifecycle.beforeInject.callCount, 5, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 5, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 2, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 2, 'deserialize should have been called'); + }); }); diff --git a/test/integration/datastore/cacheFactory.test.js b/test/integration/datastore/cacheFactory.test.js index 9edfc8a..7249ba7 100644 --- a/test/integration/datastore/cacheFactory.test.js +++ b/test/integration/datastore/cacheFactory.test.js @@ -1,56 +1,56 @@ describe('$cacheFactory integration', function () { - beforeEach(startInjector); - - it('should use $cacheFactory when DSCacheFactory is not available', function (done) { - DS.defineResource({ - name: 'comment', - endpoint: '/comments', - deleteOnExpire: 'passive', - maxAge: 20 - }); - - var cache = DS.cacheFactory.get('DS.comment'); - - assert.equal(typeof DS.cacheFactory.touch, 'undefined', 'should not be using DSCacheFactory'); - - $httpBackend.expectGET('http://test.angular-cache.com/comments/5').respond(200, { - id: 5, - text: 'test' - }); - - DS.find('comment', 5).then(function (comment) { - assert.deepEqual(comment, { - id: 5, - text: 'test' - }); - assert.deepEqual(cache.get(5), comment, 'should be in the cache'); - }, function (err) { - console.error(err.stack); - fail('Should not have rejected!'); - }); - - $httpBackend.flush(); - - assert.deepEqual(DS.get('comment', 5), { - id: 5, - text: 'test' - }, 'The comment is now in the store'); - assert.isNumber(DS.lastModified('comment', 5)); - assert.isNumber(DS.lastSaved('comment', 5)); - - setTimeout(function () { - assert.deepEqual(cache.get(5), { - id: 5, - text: 'test' - }, 'should be in the cache'); - - assert.equal(lifecycle.beforeInject.callCount, 1, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 1, 'afterInject should have been called'); - assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); - assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); - - done(); - }, 100); - }); + beforeEach(startInjector); + + it('should use $cacheFactory when DSCacheFactory is not available', function (done) { + DS.defineResource({ + name: 'Comment', + endpoint: '/comments', + deleteOnExpire: 'passive', + maxAge: 20 + }); + + var cache = DS.cacheFactory.get('DS.Comment'); + + assert.equal(typeof DS.cacheFactory.touch, 'undefined', 'should not be using DSCacheFactory'); + + $httpBackend.expectGET('http://test.angular-cache.com/comments/5').respond(200, { + id: 5, + text: 'test' + }); + + DS.find('Comment', 5).then(function (comment) { + assert.deepEqual(comment, { + id: 5, + text: 'test' + }); + assert.deepEqual(cache.get(5), comment, 'should be in the cache'); + }, function (err) { + console.error(err.stack); + fail('Should not have rejected!'); + }); + + $httpBackend.flush(); + + assert.deepEqual(DS.get('Comment', 5), { + id: 5, + text: 'test' + }, 'The comment is now in the store'); + assert.isNumber(DS.lastModified('Comment', 5)); + assert.isNumber(DS.lastSaved('Comment', 5)); + + setTimeout(function () { + assert.deepEqual(cache.get(5), { + id: 5, + text: 'test' + }, 'should be in the cache'); + + assert.equal(lifecycle.beforeInject.callCount, 1, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 1, 'afterInject should have been called'); + assert.equal(lifecycle.serialize.callCount, 0, 'serialize should have been called'); + assert.equal(lifecycle.deserialize.callCount, 1, 'deserialize should have been called'); + + done(); + }, 100); + }); }); diff --git a/test/integration/datastore/sync_methods/bindAll.test.js b/test/integration/datastore/sync_methods/bindAll.test.js index 9928438..b16becc 100644 --- a/test/integration/datastore/sync_methods/bindAll.test.js +++ b/test/integration/datastore/sync_methods/bindAll.test.js @@ -1,66 +1,93 @@ -describe('DS.bindAll(scope, expr, resourceName, params)', function () { - var errorPrefix = 'DS.bindAll(scope, expr, resourceName, params): '; - - var $rootScope, $scope; - - beforeEach(startInjector); - - beforeEach(function () { - inject(function (_$rootScope_) { - $rootScope = _$rootScope_; - $scope = $rootScope.$new(); - }); - }); - - it('should throw an error when method pre-conditions are not met', function () { - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - assert.throws(function () { - DS.bindAll(key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'scope: Must be an object!'); - }); - - angular.forEach(TYPES_EXCEPT_STRING, function (key) { - assert.throws(function () { - DS.bindAll($scope, key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'expr: Must be a string!'); - }); - - assert.throws(function () { - DS.bindAll($scope, 'post', 'does not exist', {}); - }, DS.errors.RuntimeError, errorPrefix + 'does not exist is not a registered resource!'); - - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - assert.throws(function () { - DS.bindAll($scope, 'post', 'post', key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'params: Must be an object!'); - }); - }); - it('should bind an item in the data store to the scope', function () { - - DS.inject('post', p1); - DS.inject('post', p2); - DS.inject('post', p3); - DS.inject('post', p4); - DS.inject('post', p5); - - DS.bindAll($scope, 'posts', 'post', { - query: { - where: { - age: { - '>': 31 - } - } - } - }); - - $rootScope.$apply(); - - assert.deepEqual($scope.posts, [p3, p4, p5]); - - DS.eject('post', 8); - - $rootScope.$apply(); - - assert.deepEqual($scope.posts, [p3, p5]); - }); +describe('DS.bindAll(scope, expr, resourceName, params[, cb])', function () { + var errorPrefix = 'DS.bindAll(scope, expr, resourceName, params[, cb]): '; + + var $rootScope, $scope; + + beforeEach(startInjector); + + beforeEach(function () { + inject(function (_$rootScope_) { + $rootScope = _$rootScope_; + $scope = $rootScope.$new(); + }); + }); + + it('should throw an error when method pre-conditions are not met', function () { + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + assert.throws(function () { + DS.bindAll(key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'scope: Must be an object!'); + }); + + angular.forEach(TYPES_EXCEPT_STRING, function (key) { + assert.throws(function () { + DS.bindAll($scope, key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'expr: Must be a string!'); + }); + + assert.throws(function () { + DS.bindAll($scope, 'post', 'does not exist', {}); + }, DS.errors.NonexistentResourceError, errorPrefix + 'does not exist is not a registered resource!'); + + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + assert.throws(function () { + DS.bindAll($scope, 'post', 'post', key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'params: Must be an object!'); + }); + }); + it('should bind an item in the data store to the scope', function () { + + DS.inject('post', p1); + DS.inject('post', p2); + DS.inject('post', p3); + DS.inject('post', p4); + DS.inject('post', p5); + + DS.bindAll($scope, 'posts', 'post', { + where: { + age: { + '>': 31 + } + } + }); + + $rootScope.$apply(); + + assert.deepEqual($scope.posts, [p3, p4, p5]); + + DS.eject('post', 8); + + $rootScope.$apply(); + + assert.deepEqual($scope.posts, [p3, p5]); + }); + it('should execute a callback if given', function () { + + var cb = sinon.spy(); + DS.inject('post', p1); + DS.inject('post', p2); + DS.inject('post', p3); + DS.inject('post', p4); + DS.inject('post', p5); + + DS.bindAll($scope, 'posts', 'post', { + where: { + age: { + '>': 31 + } + } + }, cb); + + $rootScope.$apply(); + + assert.deepEqual($scope.posts, [p3, p4, p5]); + assert.equal(cb.callCount, 1); + + DS.eject('post', 8); + + $rootScope.$apply(function () { + assert.deepEqual($scope.posts, [p3, p5]); + assert.equal(cb.callCount, 2); + }); + }); }); diff --git a/test/integration/datastore/sync_methods/bindOne.test.js b/test/integration/datastore/sync_methods/bindOne.test.js index e513286..15c4f53 100644 --- a/test/integration/datastore/sync_methods/bindOne.test.js +++ b/test/integration/datastore/sync_methods/bindOne.test.js @@ -1,65 +1,89 @@ -describe('DS.bindOne(scope, expr, resourceName, id)', function () { - var errorPrefix = 'DS.bindOne(scope, expr, resourceName, id): '; - - var $rootScope, $scope; - - beforeEach(startInjector); - - beforeEach(function () { - inject(function (_$rootScope_) { - $rootScope = _$rootScope_; - $scope = $rootScope.$new(); - }); - }); - - it('should throw an error when method pre-conditions are not met', function () { - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - assert.throws(function () { - DS.bindOne(key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'scope: Must be an object!'); - }); - - angular.forEach(TYPES_EXCEPT_STRING, function (key) { - assert.throws(function () { - DS.bindOne($scope, key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'expr: Must be a string!'); - }); - - assert.throws(function () { - DS.bindOne($scope, 'post', 'does not exist', {}); - }, DS.errors.RuntimeError, errorPrefix + 'does not exist is not a registered resource!'); - - angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { - assert.throws(function () { - DS.bindOne($scope, 'post', 'post', key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); - }); - }); - it('should bind an item in the data store to the scope', function () { - - DS.inject('post', p1); - DS.inject('post', p2); - - var post = DS.get('post', 5), - post2 = DS.get('post', 6); - - DS.bindOne($scope, 'post', 'post', 5); - DS.bindOne($scope, 'other.post', 'post', 6); - DS.bindOne($scope, 'post3', 'post', 7); - - $rootScope.$apply(); - - assert.deepEqual($scope.post, post); - assert.deepEqual($scope.other.post, post2); - assert.isUndefined($scope.post2); - - post.author = 'Jason'; - - $rootScope.$apply(); - - assert.equal($scope.post.author, 'Jason'); - assert.deepEqual($scope.post, post); - assert.deepEqual($scope.other.post, post2); - assert.isUndefined($scope.post2); - }); +describe('DS.bindOne(scope, expr, resourceName, id[, cb])', function () { + var errorPrefix = 'DS.bindOne(scope, expr, resourceName, id[, cb]): '; + + var $rootScope, $scope; + + beforeEach(startInjector); + + beforeEach(function () { + inject(function (_$rootScope_) { + $rootScope = _$rootScope_; + $scope = $rootScope.$new(); + }); + }); + + it('should throw an error when method pre-conditions are not met', function () { + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + assert.throws(function () { + DS.bindOne(key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'scope: Must be an object!'); + }); + + angular.forEach(TYPES_EXCEPT_STRING, function (key) { + assert.throws(function () { + DS.bindOne($scope, key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'expr: Must be a string!'); + }); + + assert.throws(function () { + DS.bindOne($scope, 'post', 'does not exist', {}); + }, DS.errors.NonexistentResourceError, errorPrefix + 'does not exist is not a registered resource!'); + + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { + assert.throws(function () { + DS.bindOne($scope, 'post', 'post', key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); + }); + }); + it('should bind an item in the data store to the scope', function () { + + DS.inject('post', p1); + DS.inject('post', p2); + + var post = DS.get('post', 5); + var post2 = DS.get('post', 6); + + DS.bindOne($scope, 'post', 'post', 5); + DS.bindOne($scope, 'other.post', 'post', 6); + DS.bindOne($scope, 'post3', 'post', 7); + + $rootScope.$apply(); + + assert.deepEqual($scope.post, post); + assert.deepEqual($scope.other.post, post2); + assert.isUndefined($scope.post2); + + post.author = 'Jason'; + + $rootScope.$apply(); + + assert.equal($scope.post.author, 'Jason'); + assert.deepEqual($scope.post, post); + assert.deepEqual($scope.other.post, post2); + assert.isUndefined($scope.post2); + }); + it('should execute a callback if given', function () { + + var cb = sinon.spy(); + DS.inject('post', p1); + + var post = DS.get('post', 5); + + DS.bindOne($scope, 'post', 'post', 5, cb); + + $rootScope.$apply(); + + assert.equal(cb.callCount, 1); + assert.deepEqual($scope.post, post); + + post.author = 'Jason'; + + DS.digest(); + + $rootScope.$apply(function () { + assert.equal(cb.callCount, 2); + assert.equal($scope.post.author, 'Jason'); + assert.deepEqual($scope.post, post); + }); + }); }); diff --git a/test/integration/datastore/sync_methods/changes.test.js b/test/integration/datastore/sync_methods/changes.test.js index 159c529..e7425c1 100644 --- a/test/integration/datastore/sync_methods/changes.test.js +++ b/test/integration/datastore/sync_methods/changes.test.js @@ -1,35 +1,35 @@ describe('DS.changes(resourceName, id)', function () { - var errorPrefix = 'DS.changes(resourceName, id): '; + var errorPrefix = 'DS.changes(resourceName, id): '; - beforeEach(startInjector); + beforeEach(startInjector); - it('should throw an error when method pre-conditions are not met', function () { - assert.throws(function () { - DS.changes('does not exist', {}); - }, DS.errors.RuntimeError, errorPrefix + 'does not exist is not a registered resource!'); + it('should throw an error when method pre-conditions are not met', function () { + assert.throws(function () { + DS.changes('does not exist', {}); + }, DS.errors.NonexistentResourceError, errorPrefix + 'does not exist is not a registered resource!'); - angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { - assert.throws(function () { - DS.changes('post', key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); - }); - }); - it('should return false if the item is not in the store', function () { - assert.isUndefined(DS.changes('post', 5)); - }); - it('should return the changes in an object', function () { + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { + assert.throws(function () { + DS.changes('post', key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); + }); + }); + it('should return false if the item is not in the store', function () { + assert.isUndefined(DS.changes('post', 5)); + }); + it('should return the changes in an object', function () { - DS.inject('post', p1); + DS.inject('post', p1); - assert.deepEqual(DS.changes('post', 5), {added: {}, changed: {}, removed: {}}); + assert.deepEqual(DS.changes('post', 5), {added: {}, changed: {}, removed: {}}); - var post = DS.get('post', 5); - post.author = 'Jake'; + var post = DS.get('post', 5); + post.author = 'Jake'; - DS.digest(); + DS.digest(); - assert.deepEqual(DS.changes('post', 5), {added: {}, changed: { - author: 'Jake' - }, removed: {}}); - }); + assert.deepEqual(DS.changes('post', 5), {added: {}, changed: { + author: 'Jake' + }, removed: {}}); + }); }); diff --git a/test/integration/datastore/sync_methods/defineResource.test.js b/test/integration/datastore/sync_methods/defineResource.test.js index 575b7be..3516d6a 100644 --- a/test/integration/datastore/sync_methods/defineResource.test.js +++ b/test/integration/datastore/sync_methods/defineResource.test.js @@ -1,118 +1,239 @@ describe('DS.defineResource(definition)', function () { - var errorPrefix = 'DS.defineResource(definition): '; - - beforeEach(startInjector); - - it('should throw an error when method pre-conditions are not met', function () { - angular.forEach(TYPES_EXCEPT_STRING_OR_OBJECT, function (key) { - if (!angular.isArray(key)) { - assert.throws(function () { - DS.defineResource(key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'definition: Must be an object!'); - } - }); - - angular.forEach(TYPES_EXCEPT_STRING, function (key) { - assert.throws(function () { - DS.defineResource({ name: key }); - }, DS.errors.IllegalArgumentError, errorPrefix + 'definition.name: Must be a string!'); - }); - - angular.forEach(TYPES_EXCEPT_STRING, function (key) { - if (key) { - assert.throws(function () { - DS.defineResource({ name: 'name', idAttribute: key }); - }, DS.errors.IllegalArgumentError, errorPrefix + 'definition.idAttribute: Must be a string!'); - } - }); - - angular.forEach(TYPES_EXCEPT_STRING, function (key) { - if (key) { - assert.throws(function () { - DS.defineResource({ name: 'name', endpoint: key }); - }, DS.errors.IllegalArgumentError, errorPrefix + 'definition.endpoint: Must be a string!'); - } - }); - - DS.defineResource('name'); - - assert.throws(function () { - DS.defineResource('name'); - }, DS.errors.RuntimeError, errorPrefix + 'name is already registered!'); - - assert.doesNotThrow(function () { - DS.defineResource('new resource'); - }, 'Should not throw'); - }); - - it('should correctly register a resource', function () { - - var callCount = 0, - test = { - validate: function (resourceName, attrs, cb) { - callCount += 1; - cb(null, attrs); - } - }; - - DS.defineResource({ - name: 'comment', - baseUrl: 'hello/', - validate: test.validate - }); - - assert.doesNotThrow(function () { - assert.isUndefined(DS.get('comment', 5), 'should be undefined'); - }); - - // Should override global baseUrl - $httpBackend.expectGET('hello/comment/1').respond(200, { name: 'Sally', id: 1 }); - - assert.isUndefined(DS.get('comment', 1, { loadFromServer: true }), 'should be undefined'); - - $httpBackend.flush(); - - assert.deepEqual(DS.get('comment', 1), { name: 'Sally', id: 1 }); - - $httpBackend.expectPOST('hello/comment').respond(200, { name: 'John', id: 2 }); - - DS.create('comment', { name: 'John' }).then(function (comment) { - assert.deepEqual(comment, { name: 'John', id: 2 }); - }); - - $httpBackend.flush(); - - assert.equal(callCount, 1, 'overridden validate should have been called once'); - assert.equal(lifecycle.validate.callCount, 0, 'global validate should not have been called'); - }); - it('should allow custom behavior to be applied to resources', function () { - DS.defineResource({ - name: 'user', - methods: { - fullName: function () { - return this.first + ' ' + this.last; - } - } - }); - - DS.inject('user', { - first: 'John', - last: 'Anderson', - id: 1 - }); - - var user = DS.get('user', 1); - - assert.deepEqual(JSON.stringify(user), JSON.stringify({ - first: 'John', - last: 'Anderson', - id: 1 - })); - assert.equal(user.fullName(), 'John Anderson'); - assert.isTrue(user instanceof DS.definitions.user[DS.definitions.user.class]); - assert.equal(DS.definitions.user.class, 'User'); - assert.equal(DS.definitions.user[DS.definitions.user.class].name, 'User'); - assert.equal(lifecycle.beforeInject.callCount, 1, 'beforeInject should have been called'); - assert.equal(lifecycle.afterInject.callCount, 1, 'afterInject should have been called'); - }); + var errorPrefix = 'DS.defineResource(definition): '; + + beforeEach(startInjector); + + it('should throw an error when method pre-conditions are not met', function () { + angular.forEach(TYPES_EXCEPT_STRING_OR_OBJECT, function (key) { + if (!angular.isArray(key)) { + assert.throws(function () { + DS.defineResource(key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'definition: Must be an object!'); + } + }); + + angular.forEach(TYPES_EXCEPT_STRING, function (key) { + assert.throws(function () { + DS.defineResource({ name: key }); + }, DS.errors.IllegalArgumentError, errorPrefix + 'definition.name: Must be a string!'); + }); + + angular.forEach(TYPES_EXCEPT_STRING, function (key) { + if (key) { + assert.throws(function () { + DS.defineResource({ name: 'name', idAttribute: key }); + }, DS.errors.IllegalArgumentError, errorPrefix + 'definition.idAttribute: Must be a string!'); + } + }); + + angular.forEach(TYPES_EXCEPT_STRING, function (key) { + if (key) { + assert.throws(function () { + DS.defineResource({ name: 'name', endpoint: key }); + }, DS.errors.IllegalArgumentError, errorPrefix + 'definition.endpoint: Must be a string!'); + } + }); + + DS.defineResource('name'); + + assert.throws(function () { + DS.defineResource('name'); + }, DS.errors.RuntimeError, errorPrefix + 'name is already registered!'); + + assert.doesNotThrow(function () { + DS.defineResource('new resource'); + }, 'Should not throw'); + }); + + it('should correctly register a resource', function () { + + var callCount = 0, + test = { + validate: function (resourceName, attrs, cb) { + callCount += 1; + cb(null, attrs); + } + }; + + DS.defineResource({ + name: 'Comment', + baseUrl: 'hello/', + validate: test.validate + }); + + assert.doesNotThrow(function () { + assert.isUndefined(DS.get('Comment', 5), 'should be undefined'); + }); + + // Should override global baseUrl + $httpBackend.expectGET('hello/Comment/1').respond(200, { name: 'Sally', id: 1 }); + + assert.isUndefined(DS.get('Comment', 1, { loadFromServer: true }), 'should be undefined'); + + $httpBackend.flush(); + + assert.deepEqual(DS.get('Comment', 1), { name: 'Sally', id: 1 }); + + $httpBackend.expectPOST('hello/Comment').respond(200, { name: 'John', id: 2 }); + + DS.create('Comment', { name: 'John' }).then(function (comment) { + assert.deepEqual(comment, { name: 'John', id: 2 }); + }); + + $httpBackend.flush(); + + assert.equal(callCount, 1, 'overridden validate should have been called once'); + assert.equal(lifecycle.validate.callCount, 0, 'global validate should not have been called'); + }); + it('should allow custom behavior to be applied to resources', function () { + DS.defineResource({ + name: 'person', + methods: { + fullName: function () { + return this.first + ' ' + this.last; + } + } + }); + + DS.inject('person', { + first: 'John', + last: 'Anderson', + id: 1 + }); + + var user = DS.get('person', 1); + + assert.deepEqual(JSON.stringify(user), JSON.stringify({ + first: 'John', + last: 'Anderson', + id: 1 + })); + assert.equal(user.fullName(), 'John Anderson'); + assert.isTrue(user instanceof DS.definitions.person[DS.definitions.person.class]); + assert.equal(DS.definitions.person.class, 'Person'); + assert.equal(DS.definitions.person[DS.definitions.person.class].name, 'Person'); + assert.equal(lifecycle.beforeInject.callCount, 1, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 1, 'afterInject should have been called'); + }); + it('should allow definition of computed properties', function () { + var callCount = 0; + + DS.defineResource({ + name: 'person', + computed: { + fullName: function (first, last) { + callCount++; + return first + ' ' + last; + } + } + }); + + DS.inject('person', { + first: 'John', + last: 'Anderson', + email: 'john.anderson@test.com', + id: 1 + }); + + var person = DS.get('person', 1); + + assert.deepEqual(JSON.stringify(person), JSON.stringify({ + first: 'John', + last: 'Anderson', + email: 'john.anderson@test.com', + id: 1, + fullName: 'John Anderson' + })); + assert.equal(person.fullName, 'John Anderson'); + assert.equal(lifecycle.beforeInject.callCount, 1, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 1, 'afterInject should have been called'); + + person.first = 'Johnny'; + + // digest loop hasn't happened yet + assert.equal(DS.get('person', 1).first, 'Johnny'); + assert.equal(DS.get('person', 1).fullName, 'John Anderson'); + + DS.digest(); + + assert.deepEqual(person, { + first: 'Johnny', + last: 'Anderson', + email: 'john.anderson@test.com', + id: 1, + fullName: 'Johnny Anderson' + }); + assert.equal(person.fullName, 'Johnny Anderson'); + + // should work with $timeout + $timeout(function () { + person.first = 'Jack'; + + DS.digest(); + + assert.deepEqual(person, { + first: 'Jack', + last: 'Anderson', + email: 'john.anderson@test.com', + id: 1, + fullName: 'Jack Anderson' + }); + assert.equal(person.fullName, 'Jack Anderson'); + }); + + $timeout.flush(); + + // computed property function should not be called + // when a property changes that isn't a dependency + // of the computed property + person.email = 'ja@test.com'; + + DS.digest(); + + assert.equal(callCount, 3, 'fullName() should have been called 3 times'); + }); + it('should work if idAttribute is a computed property computed property', function () { + DS.defineResource({ + name: 'person', + computed: { + id: function (first, last) { + return first + '_' + last; + } + } + }); + + DS.inject('person', { + first: 'John', + last: 'Anderson', + email: 'john.anderson@test.com' + }); + + var person = DS.get('person', 'John_Anderson'); + + assert.deepEqual(JSON.stringify(person), JSON.stringify({ + first: 'John', + last: 'Anderson', + email: 'john.anderson@test.com', + id: 'John_Anderson' + })); + assert.equal(person.id, 'John_Anderson'); + assert.equal(lifecycle.beforeInject.callCount, 1, 'beforeInject should have been called'); + assert.equal(lifecycle.afterInject.callCount, 1, 'afterInject should have been called'); + + person.first = 'Johnny'; + + // digest loop hasn't happened yet + assert.equal(DS.get('person', 'John_Anderson').first, 'Johnny'); + assert.equal(DS.get('person', 'John_Anderson').id, 'John_Anderson'); + + DS.digest(); + + assert.deepEqual(person, { + first: 'Johnny', + last: 'Anderson', + email: 'john.anderson@test.com', + id: 'Johnny_Anderson' + }); + assert.equal(person.id, 'Johnny_Anderson'); + }); }); diff --git a/test/integration/datastore/sync_methods/eject.test.js b/test/integration/datastore/sync_methods/eject.test.js index 407348c..f1607dd 100644 --- a/test/integration/datastore/sync_methods/eject.test.js +++ b/test/integration/datastore/sync_methods/eject.test.js @@ -1,35 +1,35 @@ describe('DS.eject(resourceName, id)', function () { - var errorPrefix = 'DS.eject(resourceName, id): '; + var errorPrefix = 'DS.eject(resourceName, id): '; - beforeEach(startInjector); + beforeEach(startInjector); - it('should throw an error when method pre-conditions are not met', function () { - assert.throws(function () { - DS.eject('does not exist', 5); - }, DS.errors.RuntimeError, errorPrefix + 'does not exist is not a registered resource!'); + it('should throw an error when method pre-conditions are not met', function () { + assert.throws(function () { + DS.eject('does not exist', 5); + }, DS.errors.NonexistentResourceError, errorPrefix + 'does not exist is not a registered resource!'); - angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { - assert.throws(function () { - DS.eject('post', key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); - }); - }); - it('should do nothing if the item is not in the store', function () { - assert.equal(DS.lastModified('post', 5), 0); - assert.doesNotThrow(function () { - DS.eject('post', 5); - }); - assert.equal(DS.lastModified('post', 5), 0); - }); - it('should eject an item from the store', function () { - DS.inject('post', p3); - DS.inject('post', p2); - DS.inject('post', p1); - assert.notEqual(DS.lastModified('post', 5), 0); - assert.doesNotThrow(function () { - DS.eject('post', 5); - }); - assert.isUndefined(DS.get('post', 5)); - assert.equal(DS.lastModified('post', 5), 0); - }); + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { + assert.throws(function () { + DS.eject('post', key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); + }); + }); + it('should do nothing if the item is not in the store', function () { + assert.equal(DS.lastModified('post', 5), 0); + assert.doesNotThrow(function () { + DS.eject('post', 5); + }); + assert.equal(DS.lastModified('post', 5), 0); + }); + it('should eject an item from the store', function () { + DS.inject('post', p3); + DS.inject('post', p2); + DS.inject('post', p1); + assert.notEqual(DS.lastModified('post', 5), 0); + assert.doesNotThrow(function () { + DS.eject('post', 5); + }); + assert.isUndefined(DS.get('post', 5)); + assert.equal(DS.lastModified('post', 5), 0); + }); }); diff --git a/test/integration/datastore/sync_methods/ejectAll.test.js b/test/integration/datastore/sync_methods/ejectAll.test.js index ca6f447..659bbe1 100644 --- a/test/integration/datastore/sync_methods/ejectAll.test.js +++ b/test/integration/datastore/sync_methods/ejectAll.test.js @@ -1,75 +1,78 @@ describe('DS.ejectAll(resourceName[, params])', function () { - var errorPrefix = 'DS.ejectAll(resourceName[, params]): '; + var errorPrefix = 'DS.ejectAll(resourceName[, params]): '; - beforeEach(startInjector); + beforeEach(startInjector); - it('should throw an error when method pre-conditions are not met', function () { - assert.throws(function () { - DS.ejectAll('does not exist'); - }, DS.errors.RuntimeError, errorPrefix + 'does not exist is not a registered resource!'); + it('should throw an error when method pre-conditions are not met', function () { + assert.throws(function () { + DS.ejectAll('does not exist'); + }, DS.errors.NonexistentResourceError, errorPrefix + 'does not exist is not a registered resource!'); - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - assert.throws(function () { - DS.ejectAll('post', key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'params: Must be an object!'); - } - }); - }); - it('should eject items that meet the criteria from the store', function () { - DS.inject('post', p1); - DS.inject('post', p2); - DS.inject('post', p3); - DS.inject('post', p4); - DS.inject('post', p5); - assert.doesNotThrow(function () { - DS.ejectAll('post', { query: { where: { author: 'Adam' } } }); - }); - assert.isDefined(DS.get('post', 5)); - assert.isDefined(DS.get('post', 6)); - assert.isDefined(DS.get('post', 7)); - assert.isUndefined(DS.get('post', 8)); - assert.isUndefined(DS.get('post', 9)); - }); - it('should eject items that meet the criteria from the store 2', function () { - DS.inject('post', p1); - DS.inject('post', p2); - DS.inject('post', p3); - DS.inject('post', p4); - DS.inject('post', p5); - try { - DS.ejectAll('post', { query: { where: { age: 33 } } }); - } catch (err) { - console.log(err.stack); - } - assert.doesNotThrow(function () { - DS.ejectAll('post', { query: { where: { age: 33 } } }); - }); + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + assert.throws(function () { + DS.ejectAll('post', key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'params: Must be an object!'); + } + }); + }); + it('should eject items that meet the criteria from the store', function () { + DS.inject('post', p1); + DS.inject('post', p2); + DS.inject('post', p3); + DS.inject('post', p4); + DS.inject('post', p5); + assert.doesNotThrow(function () { + DS.ejectAll('post', { where: { author: 'Adam' } }); + }); + assert.isDefined(DS.get('post', 5)); + assert.isDefined(DS.get('post', 6)); + assert.isDefined(DS.get('post', 7)); + assert.isUndefined(DS.get('post', 8)); + assert.isUndefined(DS.get('post', 9)); + }); + it('should eject items that meet the criteria from the store 2', function () { + DS.inject('post', p1); + DS.inject('post', p2); + DS.inject('post', p3); + DS.inject('post', p4); + DS.inject('post', p5); + try { + DS.ejectAll('post', { where: { age: 33 } }); + } catch (err) { + console.log(err.stack); + } + assert.doesNotThrow(function () { + DS.ejectAll('post', { where: { age: 33 } }); + }); - assert.isDefined(DS.get('post', 5)); - assert.isDefined(DS.get('post', 6)); - assert.isDefined(DS.get('post', 7)); - assert.isUndefined(DS.get('post', 8)); - assert.isUndefined(DS.get('post', 9)); - }); - it('should eject all items from the store', function () { - DS.inject('post', p1); - DS.inject('post', p2); - DS.inject('post', p3); - DS.inject('post', p4); + assert.isDefined(DS.get('post', 5)); + assert.isDefined(DS.get('post', 6)); + assert.isDefined(DS.get('post', 7)); + assert.isUndefined(DS.get('post', 8)); + assert.isUndefined(DS.get('post', 9)); + }); + it('should eject all items from the store', function () { + DS.inject('post', p1); + DS.inject('post', p2); + DS.inject('post', p3); + DS.inject('post', p4); - assert.deepEqual(DS.get('post', 5), p1); - assert.deepEqual(DS.get('post', 6), p2); - assert.deepEqual(DS.get('post', 7), p3); - assert.deepEqual(DS.get('post', 8), p4); + assert.deepEqual(DS.get('post', 5), p1); + assert.deepEqual(DS.get('post', 6), p2); + assert.deepEqual(DS.get('post', 7), p3); + assert.deepEqual(DS.get('post', 8), p4); - assert.doesNotThrow(function () { - DS.ejectAll('post'); - }); + DS.store.post.completedQueries.test = 'stuff'; - assert.isUndefined(DS.get('post', 5)); - assert.isUndefined(DS.get('post', 6)); - assert.isUndefined(DS.get('post', 7)); - assert.isUndefined(DS.get('post', 8)); - }); + assert.doesNotThrow(function () { + DS.ejectAll('post'); + }); + + assert.deepEqual(DS.store.post.completedQueries, {}); + assert.isUndefined(DS.get('post', 5)); + assert.isUndefined(DS.get('post', 6)); + assert.isUndefined(DS.get('post', 7)); + assert.isUndefined(DS.get('post', 8)); + }); }); diff --git a/test/integration/datastore/sync_methods/filter.test.js b/test/integration/datastore/sync_methods/filter.test.js index d25d4a8..aa41812 100644 --- a/test/integration/datastore/sync_methods/filter.test.js +++ b/test/integration/datastore/sync_methods/filter.test.js @@ -1,352 +1,357 @@ -describe('DS.filter(resourceName, params[, options])', function () { - var errorPrefix = 'DS.filter(resourceName, params[, options]): '; - - beforeEach(startInjector); - - it('should throw an error when method pre-conditions are not met', function () { - assert.throws(function () { - DS.filter('does not exist'); - }, DS.errors.RuntimeError, errorPrefix + 'does not exist is not a registered resource!'); - - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - assert.throws(function () { - DS.filter('post', key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'params: Must be an object!'); - } - }); - - DS.inject('post', p1); - - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - assert.throws(function () { - DS.filter('post', { - query: { - where: key - } - }); - }, DS.errors.IllegalArgumentError, errorPrefix + 'params.query.where: Must be an object!'); - } - }); - - angular.forEach(TYPES_EXCEPT_STRING_OR_ARRAY, function (key) { - if (key) { - assert.throws(function () { - DS.filter('post', { - query: { - orderBy: key - } - }); - }, DS.errors.IllegalArgumentError, errorPrefix + 'params.query.orderBy: Must be a string or an array!'); - } - }); - - angular.forEach(TYPES_EXCEPT_STRING_OR_ARRAY, function (key) { - if (key) { - assert.throws(function () { - DS.filter('post', { - query: { - orderBy: [key] - } - }); - }, DS.errors.IllegalArgumentError, errorPrefix + 'params.query.orderBy[0]: Must be a string or an array!'); - } - }); - - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - assert.throws(function () { - DS.filter('post', {}, key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'options: Must be an object!'); - } - }); - - DS.filter('post'); - }); - it('should return an empty array if the query has never been made before', function () { - $httpBackend.expectGET('http://test.angular-cache.com/posts?query=%7B%22where%22:%7B%22author%22:%7B%22%3D%3D%22:%22John%22%7D%7D%7D').respond(200, [p1]); - - assert.deepEqual(DS.filter('post', { - query: { - where: { - author: { - '==': 'John' - } - } - } - }, { loadFromServer: true }), [], 'should be an empty array'); - - assert.deepEqual(DS.filter('post', { - query: { - where: { - author: { - '==': 'John' - } - } - } - }, { loadFromServer: true }), [], 'should still be an empty array because the request is pending'); - - $httpBackend.flush(); - - assert.deepEqual(DS.filter('post', { - query: { - where: { - author: { - '==': 'John' - } - } - } - }), [ - p1 - ], 'should no longer be empty'); - }); - it('should correctly apply "where" predicates', function () { - assert.doesNotThrow(function () { - DS.inject('post', p1); - DS.inject('post', p2); - DS.inject('post', p3); - DS.inject('post', p4); - }, Error, 'should not throw an error'); - - assert.equal(lifecycle.beforeInject.callCount, 4); - assert.equal(lifecycle.afterInject.callCount, 4); - - var params = { - query: { - where: { - author: 'John' - } - } - }; - - assert.deepEqual(DS.filter('post', params), [p1], 'should default a string to "=="'); - - params.query.where.author = { - '==': 'John' - }; - - assert.deepEqual(DS.filter('post', params), [p1], 'should accept normal "==" clause'); - - params.query.where.author = { - '===': null - }; - - assert.deepEqual(DS.filter('post', params), [], 'should accept normal "===" clause'); - - params.query.where.author = { - '!=': 'John' - }; - - assert.deepEqual(DS.filter('post', params), [p2, p3, p4], 'should accept normal "!=" clause'); - - params.query.where = { - age: { - '>': 31 - } - }; - - assert.deepEqual(DS.filter('post', params), [p3, p4], 'should accept normal ">" clause'); - - params.query.where = { - age: { - '>=': 31 - } - }; - - assert.deepEqual(DS.filter('post', params), [p2, p3, p4], 'should accept normal ">=" clause'); - - params.query.where = { - age: { - '<': 31 - } - }; - - assert.deepEqual(DS.filter('post', params), [p1], 'should accept normal "<" clause'); - - params.query.where = { - age: { - '<=': 31 - } - }; - - assert.deepEqual(DS.filter('post', params), [p1, p2], 'should accept normal "<=" clause'); - - params.query.where = { - age: { - 'in': [30, 33] - }, - author: { - 'in': ['John', 'Sally', 'Adam'] - } - }; - - assert.deepEqual(DS.filter('post', params), [p1, p4], 'should accept normal "in" clause'); - - params.query.where = { age: { garbage: 'should have no effect' } }; - - assert.deepEqual(DS.filter('post', params), [p1, p2, p3, p4], 'should return all elements'); - }); - it('should correctly apply "orderBy" predicates', function () { - assert.doesNotThrow(function () { - DS.inject('post', p1); - DS.inject('post', p2); - DS.inject('post', p3); - DS.inject('post', p4); - }, Error, 'should not throw an error'); - - var params = { - query: { - orderBy: 'age' - } - }; - - assert.deepEqual(DS.filter('post', params), [p1, p2, p3, p4], 'should accept a single string and sort in ascending order for numbers'); - - params.query.orderBy = 'author'; - - assert.deepEqual(DS.filter('post', params), [p4, p1, p3, p2], 'should accept a single string and sort in ascending for strings'); - - params.query.orderBy = [ - ['age', 'DESC'] - ]; - - assert.deepEqual(DS.filter('post', params), [p4, p3, p2, p1], 'should accept an array of an array and sort in descending for numbers'); - - params.query.orderBy = [ - ['author', 'DESC'] - ]; +describe('DS.filter(resourceName[, params][, options])', function () { + var errorPrefix = 'DS.filter(resourceName[, params][, options]): '; + + beforeEach(startInjector); + + it('should throw an error when method pre-conditions are not met', function () { + assert.throws(function () { + DS.filter('does not exist'); + }, DS.errors.NonexistentResourceError, errorPrefix + 'does not exist is not a registered resource!'); + + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + assert.throws(function () { + DS.filter('post', key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'params: Must be an object!'); + } + }); + + DS.inject('post', p1); + + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + assert.throws(function () { + DS.filter('post', {}, key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'options: Must be an object!'); + } + }); + + DS.filter('post'); + }); + it('should return an empty array if the query has never been made before', function () { + $httpBackend.expectGET('http://test.angular-cache.com/posts?where=%7B%22author%22:%7B%22%3D%3D%22:%22John%22%7D%7D').respond(200, [p1]); + + assert.deepEqual(DS.filter('post', { + where: { + author: { + '==': 'John' + } + } + }, { loadFromServer: true }), [], 'should be an empty array'); + + assert.deepEqual(DS.filter('post', { + where: { + author: { + '==': 'John' + } + } + }, { loadFromServer: true }), [], 'should still be an empty array because the request is pending'); + + $httpBackend.flush(); + + assert.deepEqual(DS.filter('post', { + where: { + author: { + '==': 'John' + } + } + }), [ + p1 + ], 'should no longer be empty'); + }); + it('should correctly apply "where" predicates', function () { + assert.doesNotThrow(function () { + DS.inject('post', p1); + DS.inject('post', p2); + DS.inject('post', p3); + DS.inject('post', p4); + DS.inject('post', p5); + }, Error, 'should not throw an error'); + + assert.equal(lifecycle.beforeInject.callCount, 5); + assert.equal(lifecycle.afterInject.callCount, 5); + + var params = { + author: 'John' + }; + + assert.deepEqual(DS.filter('post', params), [p1], 'should default a string to "=="'); + + params = { + author: 'Adam', + id: 9 + }; + + assert.deepEqual(DS.filter('post', params), [p5], 'should default a string to "=="'); + + params = { + where: { + author: 'John' + } + }; + + assert.deepEqual(DS.filter('post', params), [p1], 'should default a string to "=="'); + + params.where.author = { + '==': 'John' + }; + + assert.deepEqual(DS.filter('post', params), [p1], 'should accept normal "==" clause'); + + params.where.author = { + '===': null + }; + + assert.deepEqual(DS.filter('post', params), [], 'should accept normal "===" clause'); + + params.where.author = { + '!=': 'John' + }; + + assert.deepEqual(DS.filter('post', params), [p2, p3, p4, p5], 'should accept normal "!=" clause'); + + params.where = { + age: { + '>': 31 + } + }; + + assert.deepEqual(DS.filter('post', params), [p3, p4, p5], 'should accept normal ">" clause'); + + params.where = { + age: { + '>=': 31 + } + }; + + assert.deepEqual(DS.filter('post', params), [p2, p3, p4, p5], 'should accept normal ">=" clause'); + + params.where = { + age: { + '<': 31 + } + }; + + assert.deepEqual(DS.filter('post', params), [p1], 'should accept normal "<" clause'); + + params.where = { + age: { + '>': 30, + '<': 33 + } + }; + + assert.deepEqual(DS.filter('post', params), [p2, p3], 'should accept dual "<" and ">" clause'); + + params.where = { + age: { + '|>': 30, + '|<': 33 + } + }; + + assert.deepEqual(DS.filter('post', params), [p1, p2, p3, p4, p5], 'should accept or "<" and ">" clause'); + + params.where = { + age: { + '|<=': 31 + }, + author: { + '|==': 'Adam' + } + }; - assert.deepEqual(DS.filter('post', params), [p2, p3, p1, p4], 'should accept an array of an array and sort in descending for strings'); + assert.deepEqual(DS.filter('post', params), [p1, p2, p4, p5], 'should accept or "<=" and "==" clause'); - params.query.orderBy = ['age']; - - assert.deepEqual(DS.filter('post', params), [p1, p2, p3, p4], 'should accept an array of a string and sort in ascending for numbers'); - - params.query.orderBy = ['author']; - - assert.deepEqual(DS.filter('post', params), [p4, p1, p3, p2], 'should accept an array of a string and sort in ascending for strings'); - }); - it('should correctly apply "skip" predicates', function () { - assert.doesNotThrow(function () { - DS.inject('post', p1); - DS.inject('post', p2); - DS.inject('post', p3); - DS.inject('post', p4); - }, Error, 'should not throw an error'); - - var params = { - query: { - skip: 1 - } - }; - - assert.deepEqual(DS.filter('post', params), [p2, p3, p4], 'should skip 1'); - - params.query.skip = 2; - assert.deepEqual(DS.filter('post', params), [p3, p4], 'should skip 2'); - - params.query.skip = 3; - assert.deepEqual(DS.filter('post', params), [p4], 'should skip 3'); - - params.query.skip = 4; - assert.deepEqual(DS.filter('post', params), [], 'should skip 4'); - }); - it('should correctly apply "limit" predicates', function () { - assert.doesNotThrow(function () { - DS.inject('post', p1); - DS.inject('post', p2); - DS.inject('post', p3); - DS.inject('post', p4); - }, Error, 'should not throw an error'); - - var params = { - query: { - limit: 1 - } - }; - - assert.deepEqual(DS.filter('post', params), [p1], 'should limit to 1'); - - params.query.limit = 2; - assert.deepEqual(DS.filter('post', params), [p1, p2], 'should limit to 2'); - - params.query.limit = 3; - assert.deepEqual(DS.filter('post', params), [p1, p2, p3], 'should limit to 3'); - - params.query.limit = 4; - assert.deepEqual(DS.filter('post', params), [p1, p2, p3, p4], 'should limit to 4'); - }); - it('should correctly apply "limit" and "skip" predicates together', function () { - assert.doesNotThrow(function () { - DS.inject('post', p1); - DS.inject('post', p2); - DS.inject('post', p3); - DS.inject('post', p4); - }, Error, 'should not throw an error'); - - var params = { - query: { - limit: 1, - skip: 1 - } - }; - - assert.deepEqual(DS.filter('post', params), [p2], 'should limit to 1 and skip 2'); - - params.query.limit = 2; - assert.deepEqual(DS.filter('post', params), [p2, p3], 'should limit to 2 and skip 1'); - - params.query.skip = 2; - assert.deepEqual(DS.filter('post', params), [p3, p4], 'should limit to 2 and skip 2'); - - params.query.limit = 1; - params.query.skip = 3; - assert.deepEqual(DS.filter('post', params), [p4], 'should limit to 1 and skip 3'); - - params.query.limit = 8; - params.query.skip = 0; - assert.deepEqual(DS.filter('post', params), [p1, p2, p3, p4], 'should return all items'); - - params.query.limit = 1; - params.query.skip = 5; - assert.deepEqual(DS.filter('post', params), [], 'should return nothing if skip if greater than the number of items'); - - params.query.limit = 8; - delete params.query.skip; - assert.deepEqual(DS.filter('post', params), [p1, p2, p3, p4], 'should return all items'); - - delete params.query.limit; - params.query.skip = 5; - assert.deepEqual(DS.filter('post', params), [], 'should return nothing if skip if greater than the number of items'); - }); - it('should allow custom "where" filter function', function () { - DS.defineResource({ - name: 'comment', - filter: function (resourceName, where, attrs) { - return attrs.author === where.author.EQUALS || attrs.age % where.age.MOD === 1; - } - }); - assert.doesNotThrow(function () { - DS.inject('comment', p1); - DS.inject('comment', p2); - DS.inject('comment', p3); - DS.inject('comment', p4); - }, Error, 'should not throw an error'); - - var params = { - query: { - where: { - author: { - 'EQUALS': 'John' - }, - age: { - 'MOD': 30 - } - } - } - }; - - assert.deepEqual(DS.filter('comment', params), [p1, p2], 'should keep p1 and p2'); - }); + params.where = { + age: { + '<=': 31 + } + }; + + assert.deepEqual(DS.filter('post', params), [p1, p2], 'should accept normal "<=" clause'); + + params.where = { + age: { + 'in': [30, 33] + }, + author: { + 'in': ['John', 'Sally', 'Adam'] + } + }; + + assert.deepEqual(DS.filter('post', params), [p1, p4, p5], 'should accept normal "in" clause'); + + params.where = { + age: { + '|in': [31] + }, + id: { + '|in': [8] + } + }; + + assert.deepEqual(DS.filter('post', params), [p2, p4], 'should accept and/or clause'); + + params.where = { age: { garbage: 'should have no effect' } }; + + assert.deepEqual(DS.filter('post', params), [p1, p2, p3, p4, p5], 'should return all elements'); + }); + it('should correctly apply "orderBy" predicates', function () { + assert.doesNotThrow(function () { + DS.inject('post', p1); + DS.inject('post', p2); + DS.inject('post', p3); + DS.inject('post', p4); + }, Error, 'should not throw an error'); + + var params = { + orderBy: 'age' + }; + + assert.deepEqual(DS.filter('post', params), [p1, p2, p3, p4], 'should accept a single string and sort in ascending order for numbers'); + + params.orderBy = 'author'; + + assert.deepEqual(DS.filter('post', params), [p4, p1, p3, p2], 'should accept a single string and sort in ascending for strings'); + + params.orderBy = [ + ['age', 'DESC'] + ]; + + assert.deepEqual(DS.filter('post', params), [p4, p3, p2, p1], 'should accept an array of an array and sort in descending for numbers'); + + params.orderBy = [ + ['author', 'DESC'] + ]; + + assert.deepEqual(DS.filter('post', params), [p2, p3, p1, p4], 'should accept an array of an array and sort in descending for strings'); + + params.orderBy = ['age']; + + assert.deepEqual(DS.filter('post', params), [p1, p2, p3, p4], 'should accept an array of a string and sort in ascending for numbers'); + + params.orderBy = ['author']; + + assert.deepEqual(DS.filter('post', params), [p4, p1, p3, p2], 'should accept an array of a string and sort in ascending for strings'); + }); + it('should correctly apply "skip" predicates', function () { + assert.doesNotThrow(function () { + DS.inject('post', p1); + DS.inject('post', p2); + DS.inject('post', p3); + DS.inject('post', p4); + }, Error, 'should not throw an error'); + + var params = { + skip: 1 + }; + + assert.deepEqual(DS.filter('post', params), [p2, p3, p4], 'should skip 1'); + + params.skip = 2; + assert.deepEqual(DS.filter('post', params), [p3, p4], 'should skip 2'); + + params.skip = 3; + assert.deepEqual(DS.filter('post', params), [p4], 'should skip 3'); + + params.skip = 4; + assert.deepEqual(DS.filter('post', params), [], 'should skip 4'); + }); + it('should correctly apply "limit" predicates', function () { + assert.doesNotThrow(function () { + DS.inject('post', p1); + DS.inject('post', p2); + DS.inject('post', p3); + DS.inject('post', p4); + }, Error, 'should not throw an error'); + + var params = { + limit: 1 + }; + + assert.deepEqual(DS.filter('post', params), [p1], 'should limit to 1'); + + params.limit = 2; + assert.deepEqual(DS.filter('post', params), [p1, p2], 'should limit to 2'); + + params.limit = 3; + assert.deepEqual(DS.filter('post', params), [p1, p2, p3], 'should limit to 3'); + + params.limit = 4; + assert.deepEqual(DS.filter('post', params), [p1, p2, p3, p4], 'should limit to 4'); + }); + it('should correctly apply "limit" and "skip" predicates together', function () { + assert.doesNotThrow(function () { + DS.inject('post', p1); + DS.inject('post', p2); + DS.inject('post', p3); + DS.inject('post', p4); + }, Error, 'should not throw an error'); + + var params = { + limit: 1, + skip: 1 + }; + + assert.deepEqual(DS.filter('post', params), [p2], 'should limit to 1 and skip 2'); + + params.limit = 2; + assert.deepEqual(DS.filter('post', params), [p2, p3], 'should limit to 2 and skip 1'); + + params.skip = 2; + assert.deepEqual(DS.filter('post', params), [p3, p4], 'should limit to 2 and skip 2'); + + params.limit = 1; + params.skip = 3; + assert.deepEqual(DS.filter('post', params), [p4], 'should limit to 1 and skip 3'); + + params.limit = 8; + params.skip = 0; + assert.deepEqual(DS.filter('post', params), [p1, p2, p3, p4], 'should return all items'); + + params.limit = 1; + params.skip = 5; + assert.deepEqual(DS.filter('post', params), [], 'should return nothing if skip if greater than the number of items'); + + params.limit = 8; + delete params.skip; + assert.deepEqual(DS.filter('post', params), [p1, p2, p3, p4], 'should return all items'); + + delete params.limit; + params.skip = 5; + assert.deepEqual(DS.filter('post', params), [], 'should return nothing if skip if greater than the number of items'); + }); + it('should allow custom filter function', function () { + DS.defineResource({ + name: 'Comment', + filter: function (collection, resourceName, params, options) { + var filtered = collection; + var where = params.where; + filtered = this.utils.filter(filtered, function (attrs) { + return attrs.author === where.author.EQUALS || attrs.age % where.age.MOD === 1; + }); + return filtered; + } + }); + assert.doesNotThrow(function () { + DS.inject('Comment', p1); + DS.inject('Comment', p2); + DS.inject('Comment', p3); + DS.inject('Comment', p4); + }, Error, 'should not throw an error'); + + var params = { + where: { + author: { + 'EQUALS': 'John' + }, + age: { + 'MOD': 30 + } + } + }; + + assert.deepEqual(DS.filter('Comment', params), [p1, p2], 'should keep p1 and p2'); + }); }); diff --git a/test/integration/datastore/sync_methods/get.test.js b/test/integration/datastore/sync_methods/get.test.js index 334ca05..21f066c 100644 --- a/test/integration/datastore/sync_methods/get.test.js +++ b/test/integration/datastore/sync_methods/get.test.js @@ -1,42 +1,42 @@ describe('DS.get(resourceName, id[, options])', function () { - var errorPrefix = 'DS.get(resourceName, id[, options]): '; - - beforeEach(startInjector); - - it('should throw an error when method pre-conditions are not met', function () { - assert.throws(function () { - DS.get('does not exist', {}); - }, DS.errors.RuntimeError, errorPrefix + 'does not exist is not a registered resource!'); - - angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { - assert.throws(function () { - DS.get('post', key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); - }); - - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - assert.throws(function () { - DS.get('post', 5, key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'options: Must be an object!'); - } - }); - }); - it('should return undefined if the query has never been made before', function () { - assert.isUndefined(DS.get('post', 5), 'should be undefined'); - }); - it('should return undefined and send the query to the server if the query has never been made before and loadFromServer is set to true', function () { - $httpBackend.expectGET('http://test.angular-cache.com/posts/5').respond(200, p1); - - assert.isUndefined(DS.get('post', 5, { loadFromServer: true }), 'should be undefined'); - - // There should only be one GET request, so this should have no effect. - assert.isUndefined(DS.get('post', 5, { loadFromServer: true }), 'should be undefined'); - - $httpBackend.flush(); - - assert.deepEqual(DS.get('post', 5), p1, 'p1 should now be in the store'); - assert.isNumber(DS.lastModified('post', 5)); - assert.isNumber(DS.lastSaved('post', 5)); - }); + var errorPrefix = 'DS.get(resourceName, id[, options]): '; + + beforeEach(startInjector); + + it('should throw an error when method pre-conditions are not met', function () { + assert.throws(function () { + DS.get('does not exist', {}); + }, DS.errors.NonexistentResourceError, errorPrefix + 'does not exist is not a registered resource!'); + + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { + assert.throws(function () { + DS.get('post', key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); + }); + + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + assert.throws(function () { + DS.get('post', 5, key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'options: Must be an object!'); + } + }); + }); + it('should return undefined if the query has never been made before', function () { + assert.isUndefined(DS.get('post', 5), 'should be undefined'); + }); + it('should return undefined and send the query to the server if the query has never been made before and loadFromServer is set to true', function () { + $httpBackend.expectGET('http://test.angular-cache.com/posts/5').respond(200, p1); + + assert.isUndefined(DS.get('post', 5, { loadFromServer: true }), 'should be undefined'); + + // There should only be one GET request, so this should have no effect. + assert.isUndefined(DS.get('post', 5, { loadFromServer: true }), 'should be undefined'); + + $httpBackend.flush(); + + assert.deepEqual(DS.get('post', 5), p1, 'p1 should now be in the store'); + assert.isNumber(DS.lastModified('post', 5)); + assert.isNumber(DS.lastSaved('post', 5)); + }); }); diff --git a/test/integration/datastore/sync_methods/hasChanges.test.js b/test/integration/datastore/sync_methods/hasChanges.test.js index d69bd74..0685fee 100644 --- a/test/integration/datastore/sync_methods/hasChanges.test.js +++ b/test/integration/datastore/sync_methods/hasChanges.test.js @@ -1,33 +1,33 @@ describe('DS.hasChanges(resourceName, id)', function () { - var errorPrefix = 'DS.hasChanges(resourceName, id): '; + var errorPrefix = 'DS.hasChanges(resourceName, id): '; - beforeEach(startInjector); + beforeEach(startInjector); - it('should throw an error when method pre-conditions are not met', function () { - assert.throws(function () { - DS.hasChanges('does not exist', {}); - }, DS.errors.RuntimeError, errorPrefix + 'does not exist is not a registered resource!'); + it('should throw an error when method pre-conditions are not met', function () { + assert.throws(function () { + DS.hasChanges('does not exist', {}); + }, DS.errors.NonexistentResourceError, errorPrefix + 'does not exist is not a registered resource!'); - angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { - assert.throws(function () { - DS.hasChanges('post', key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); - }); - }); - it('should return false if the item is not in the store', function () { - assert.isFalse(DS.hasChanges('post', 5)); - }); - it('should return whether an item has changes', function () { + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { + assert.throws(function () { + DS.hasChanges('post', key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); + }); + }); + it('should return false if the item is not in the store', function () { + assert.isFalse(DS.hasChanges('post', 5)); + }); + it('should return whether an item has changes', function () { - DS.inject('post', p1); + DS.inject('post', p1); - assert.isFalse(DS.hasChanges('post', 5)); + assert.isFalse(DS.hasChanges('post', 5)); - var post = DS.get('post', 5); - post.author = 'Jake'; + var post = DS.get('post', 5); + post.author = 'Jake'; - DS.digest(); + DS.digest(); - assert.isTrue(DS.hasChanges('post', 5)); - }); + assert.isTrue(DS.hasChanges('post', 5)); + }); }); diff --git a/test/integration/datastore/sync_methods/inject.test.js b/test/integration/datastore/sync_methods/inject.test.js index c983f05..6801d58 100644 --- a/test/integration/datastore/sync_methods/inject.test.js +++ b/test/integration/datastore/sync_methods/inject.test.js @@ -1,68 +1,110 @@ describe('DS.inject(resourceName, attrs[, options])', function () { - var errorPrefix = 'DS.inject(resourceName, attrs[, options]): '; - - beforeEach(startInjector); - - it('should throw an error when method pre-conditions are not met', function () { - assert.throws(function () { - DS.inject('does not exist', {}); - }, DS.errors.RuntimeError, errorPrefix + 'does not exist is not a registered resource!'); - - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - assert.throws(function () { - DS.inject('post', key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'attrs: Must be an object or an array!'); - }); - - angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { - if (key) { - assert.throws(function () { - DS.inject('post', {}, key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'options: Must be an object!'); - } - }); - - assert.throws(function () { - DS.inject('post', {}); - }, DS.errors.RuntimeError, errorPrefix + 'attrs: Must contain the property specified by `idAttribute`!'); - }); - it('should inject an item into the store', function () { - - assert.equal(DS.lastModified('post', 5), 0); - assert.doesNotThrow(function () { - assert.deepEqual(DS.inject('post', p1), p1); - }); - assert.notEqual(DS.lastModified('post', 5), 0); - assert.isNumber(DS.lastModified('post', 5)); - }); - it('should inject an item into the store', function () { - - assert.equal(DS.lastModified('post', 5), 0); - assert.doesNotThrow(function () { - assert.deepEqual(DS.inject('post', p1), p1); - }); - assert.notEqual(DS.lastModified('post', 5), 0); - assert.isNumber(DS.lastModified('post', 5)); - - var post = DS.get('post', 5); - - post.id = 10; - - DS.digest(); - - assert.deepEqual('Doh! You just changed the primary key of an object! ' + - 'I don\'t know how to handle this yet, so your data for the "post' + - '" resource is now in an undefined (probably broken) state.', $log.error.logs[0][0]); - }); - it('should inject multiple items into the store', function () { - - assert.doesNotThrow(function () { - assert.deepEqual(DS.inject('post', [p1, p2, p3, p4]), [p1, p2, p3, p4]); - }); - - assert.deepEqual(DS.get('post', 5), p1); - assert.deepEqual(DS.get('post', 6), p2); - assert.deepEqual(DS.get('post', 7), p3); - assert.deepEqual(DS.get('post', 8), p4); - }); + var errorPrefix = 'DS.inject(resourceName, attrs[, options]): '; + + beforeEach(startInjector); + + it('should throw an error when method pre-conditions are not met', function () { + assert.throws(function () { + DS.inject('does not exist', {}); + }, DS.errors.NonexistentResourceError, errorPrefix + 'does not exist is not a registered resource!'); + + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + assert.throws(function () { + DS.inject('post', key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'attrs: Must be an object or an array!'); + }); + + angular.forEach(TYPES_EXCEPT_OBJECT, function (key) { + if (key) { + assert.throws(function () { + DS.inject('post', {}, key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'options: Must be an object!'); + } + }); + + assert.throws(function () { + DS.inject('post', {}); + }, DS.errors.RuntimeError, errorPrefix + 'attrs: Must contain the property specified by `idAttribute`!'); + }); + it('should inject an item into the store', function () { + + assert.equal(DS.lastModified('post', 5), 0); + assert.doesNotThrow(function () { + assert.deepEqual(DS.inject('post', p1), p1); + }); + assert.notEqual(DS.lastModified('post', 5), 0); + assert.isNumber(DS.lastModified('post', 5)); + }); + it('should inject an item into the store', function () { + + assert.equal(DS.lastModified('post', 5), 0); + assert.doesNotThrow(function () { + assert.deepEqual(DS.inject('post', p1), p1); + }); + assert.notEqual(DS.lastModified('post', 5), 0); + assert.isNumber(DS.lastModified('post', 5)); + + var post = DS.get('post', 5); + + post.id = 10; + + DS.digest(); + + assert.deepEqual('Doh! You just changed the primary key of an object! ' + + 'I don\'t know how to handle this yet, so your data for the "post' + + '" resource is now in an undefined (probably broken) state.', $log.error.logs[0][0]); + }); + it('should inject multiple items into the store', function () { + + assert.doesNotThrow(function () { + assert.deepEqual(DS.inject('post', [p1, p2, p3, p4]), [p1, p2, p3, p4]); + }); + + assert.deepEqual(DS.get('post', 5), p1); + assert.deepEqual(DS.get('post', 6), p2); + assert.deepEqual(DS.get('post', 7), p3); + assert.deepEqual(DS.get('post', 8), p4); + }); + it('should inject relations', function () { + // can inject items without relations + DS.inject('user', user1); + DS.inject('organization', organization2); + DS.inject('comment', comment3); + DS.inject('profile', profile4); + + assert.deepEqual(DS.get('user', 1), user1); + assert.deepEqual(DS.get('organization', 2), organization2); + assert.deepEqual(DS.get('comment', 3), comment3); + assert.deepEqual(DS.get('profile', 4), profile4); + + // can inject items with relations + DS.inject('user', user10); + DS.inject('organization', organization15); + DS.inject('comment', comment19); + DS.inject('profile', profile21); + + // originals + assert.deepEqual(DS.get('user', 10), user10); + assert.deepEqual(DS.get('organization', 15), organization15); + assert.deepEqual(DS.get('comment', 19), comment19); + assert.deepEqual(DS.get('profile', 21), profile21); + + // user10 relations + assert.deepEqual(DS.get('comment', 11), comment11); + assert.deepEqual(DS.get('comment', 12), comment12); + assert.deepEqual(DS.get('comment', 13), comment13); + assert.deepEqual(DS.get('organization', 14), organization14); + assert.deepEqual(DS.get('profile', 15), profile15); + + // organization15 relations + assert.deepEqual(DS.get('user', 16), user16); + assert.deepEqual(DS.get('user', 17), user17); + assert.deepEqual(DS.get('user', 18), user18); + + // comment19 relations + assert.deepEqual(DS.get('user', 20), user20); + + // profile21 relations + assert.deepEqual(DS.get('user', 22), user22); + }); }); diff --git a/test/integration/datastore/sync_methods/lastModified.test.js b/test/integration/datastore/sync_methods/lastModified.test.js index d7a30ba..4118bc3 100644 --- a/test/integration/datastore/sync_methods/lastModified.test.js +++ b/test/integration/datastore/sync_methods/lastModified.test.js @@ -1,58 +1,58 @@ describe('DS.lastModified(resourceName[, id])', function () { - var errorPrefix = 'DS.lastModified(resourceName[, id]): '; + var errorPrefix = 'DS.lastModified(resourceName[, id]): '; - beforeEach(startInjector); + beforeEach(startInjector); - it('should throw an error when method pre-conditions are not met', function () { - assert.throws(function () { - DS.lastModified('does not exist', {}); - }, DS.errors.RuntimeError, errorPrefix + 'does not exist is not a registered resource!'); + it('should throw an error when method pre-conditions are not met', function () { + assert.throws(function () { + DS.lastModified('does not exist', {}); + }, DS.errors.NonexistentResourceError, errorPrefix + 'does not exist is not a registered resource!'); - angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { - if (key) { - assert.throws(function () { - DS.lastModified('post', key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); - } - }); - }); - it('should lastModified an item into the store', function () { + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { + if (key) { + assert.throws(function () { + DS.lastModified('post', key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); + } + }); + }); + it('should lastModified an item into the store', function () { - var collectionLastModified; + var collectionLastModified; - assert.equal(DS.lastModified('post', 5), 0); - assert.equal(DS.lastModified('post'), 0); + assert.equal(DS.lastModified('post', 5), 0); + assert.equal(DS.lastModified('post'), 0); - collectionLastModified = DS.lastModified('post'); + collectionLastModified = DS.lastModified('post'); - assert.doesNotThrow(function () { - DS.inject('post', p1); - }); + assert.doesNotThrow(function () { + DS.inject('post', p1); + }); - assert.notEqual(DS.lastModified('post'), collectionLastModified); - collectionLastModified = DS.lastModified('post'); - assert.notEqual(DS.lastModified('post', 5), 0); - var lastModified = DS.lastModified('post', 5); - assert.isNumber(lastModified); + assert.notEqual(DS.lastModified('post'), collectionLastModified); + collectionLastModified = DS.lastModified('post'); + assert.notEqual(DS.lastModified('post', 5), 0); + var lastModified = DS.lastModified('post', 5); + assert.isNumber(lastModified); - assert.doesNotThrow(function () { - DS.inject('post', p2); - }); + assert.doesNotThrow(function () { + DS.inject('post', p2); + }); - assert.notEqual(DS.lastModified('post'), collectionLastModified); + assert.notEqual(DS.lastModified('post'), collectionLastModified); - collectionLastModified = DS.lastModified('post'); - assert.equal(DS.lastModified('post', 5), lastModified); + collectionLastModified = DS.lastModified('post'); + assert.equal(DS.lastModified('post', 5), lastModified); - assert.doesNotThrow(function () { - DS.inject('post', p3); - }); + assert.doesNotThrow(function () { + DS.inject('post', p3); + }); - assert.notEqual(DS.lastModified('post'), collectionLastModified); + assert.notEqual(DS.lastModified('post'), collectionLastModified); - collectionLastModified = DS.lastModified('post'); - assert.equal(DS.lastModified('post', 5), lastModified); - }); + collectionLastModified = DS.lastModified('post'); + assert.equal(DS.lastModified('post', 5), lastModified); + }); // it('should lastModified an item into the store', function (done) { // // assert.equal(DS.lastModified('post', 5), 0); diff --git a/test/integration/datastore/sync_methods/lastSaved.test.js b/test/integration/datastore/sync_methods/lastSaved.test.js index 50a293b..9ed7668 100644 --- a/test/integration/datastore/sync_methods/lastSaved.test.js +++ b/test/integration/datastore/sync_methods/lastSaved.test.js @@ -1,44 +1,44 @@ describe('DS.lastSaved(resourceName[, id])', function () { - var errorPrefix = 'DS.lastSaved(resourceName[, id]): '; + var errorPrefix = 'DS.lastSaved(resourceName[, id]): '; - beforeEach(startInjector); + beforeEach(startInjector); - it('should throw an error when method pre-conditions are not met', function () { - assert.throws(function () { - DS.lastSaved('does not exist', {}); - }, DS.errors.RuntimeError, errorPrefix + 'does not exist is not a registered resource!'); + it('should throw an error when method pre-conditions are not met', function () { + assert.throws(function () { + DS.lastSaved('does not exist', {}); + }, DS.errors.NonexistentResourceError, errorPrefix + 'does not exist is not a registered resource!'); - angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { - if (key) { - assert.throws(function () { - DS.lastSaved('post', key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); - } - }); - }); - it('should lastSaved an item into the store', function () { + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { + if (key) { + assert.throws(function () { + DS.lastSaved('post', key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); + } + }); + }); + it('should lastSaved an item into the store', function () { - var lastSaved = DS.lastSaved('post', 5); - assert.equal(DS.lastSaved('post', 5), 0); + var lastSaved = DS.lastSaved('post', 5); + assert.equal(DS.lastSaved('post', 5), 0); - assert.doesNotThrow(function () { - DS.inject('post', p1); - }); + assert.doesNotThrow(function () { + DS.inject('post', p1); + }); - assert.notEqual(lastSaved, DS.lastSaved('post', 5)); + assert.notEqual(lastSaved, DS.lastSaved('post', 5)); - lastSaved = DS.lastSaved('post', 5); + lastSaved = DS.lastSaved('post', 5); - $httpBackend.expectPUT('http://test.angular-cache.com/posts/5').respond(200, p1); + $httpBackend.expectPUT('http://test.angular-cache.com/posts/5').respond(200, p1); - var post = DS.get('post', 5); + var post = DS.get('post', 5); - post.author = 'Jake'; + post.author = 'Jake'; - DS.save('post', 5); + DS.save('post', 5); - $httpBackend.flush(); + $httpBackend.flush(); - assert.notEqual(lastSaved, DS.lastSaved('post', 5)); - }); + assert.notEqual(lastSaved, DS.lastSaved('post', 5)); + }); }); diff --git a/test/integration/datastore/sync_methods/previous.test.js b/test/integration/datastore/sync_methods/previous.test.js index d26b89e..4e34724 100644 --- a/test/integration/datastore/sync_methods/previous.test.js +++ b/test/integration/datastore/sync_methods/previous.test.js @@ -1,69 +1,69 @@ describe('DS.previous(resourceName, id)', function () { - var errorPrefix = 'DS.previous(resourceName, id): '; + var errorPrefix = 'DS.previous(resourceName, id): '; - beforeEach(startInjector); + beforeEach(startInjector); - it('should throw an error when method pre-conditions are not met', function () { - assert.throws(function () { - DS.previous('does not exist', {}); - }, DS.errors.RuntimeError, errorPrefix + 'does not exist is not a registered resource!'); + it('should throw an error when method pre-conditions are not met', function () { + assert.throws(function () { + DS.previous('does not exist', {}); + }, DS.errors.NonexistentResourceError, errorPrefix + 'does not exist is not a registered resource!'); - angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { - assert.throws(function () { - DS.previous('post', key); - }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); - }); - }); - it('should return false if the item is not in the store', function () { + angular.forEach(TYPES_EXCEPT_STRING_OR_NUMBER, function (key) { + assert.throws(function () { + DS.previous('post', key); + }, DS.errors.IllegalArgumentError, errorPrefix + 'id: Must be a string or a number!'); + }); + }); + it('should return false if the item is not in the store', function () { - assert.isUndefined(DS.previous('post', 5)); - }); - it('should return the previous in an object', function () { + assert.isUndefined(DS.previous('post', 5)); + }); + it('should return the previous in an object', function () { - DS.inject('post', p1); + DS.inject('post', p1); - var post = DS.get('post', 5); + var post = DS.get('post', 5); - assert.deepEqual(DS.previous('post', 5), p1); + assert.deepEqual(DS.previous('post', 5), p1); - post.author = 'Jake'; + post.author = 'Jake'; - DS.digest(); + DS.digest(); - assert.deepEqual(DS.previous('post', 5), p1); - assert.deepEqual(DS.get('post', 5), { author: 'Jake', age: 30, id: 5 }); + assert.deepEqual(DS.previous('post', 5), p1); + assert.deepEqual(DS.get('post', 5), { author: 'Jake', age: 30, id: 5 }); - $httpBackend.expectPUT('http://test.angular-cache.com/posts/5', DS.get('post', 5)).respond(200, { author: 'Jake', age: 30, id: 5 }); + $httpBackend.expectPUT('http://test.angular-cache.com/posts/5', DS.get('post', 5)).respond(200, { author: 'Jake', age: 30, id: 5 }); - DS.save('post', 5); + DS.save('post', 5); - $httpBackend.flush(); + $httpBackend.flush(); - assert.deepEqual(DS.previous('post', 5), { author: 'Jake', age: 30, id: 5 }, 'previous attributes should have been updated'); - assert.deepEqual(DS.get('post', 5), { author: 'Jake', age: 30, id: 5 }); - }); - it('should return the previous in an object and save changed only', function () { + assert.deepEqual(DS.previous('post', 5), { author: 'Jake', age: 30, id: 5 }, 'previous attributes should have been updated'); + assert.deepEqual(DS.get('post', 5), { author: 'Jake', age: 30, id: 5 }); + }); + it('should return the previous in an object and save changed only', function () { - DS.inject('post', p1); + DS.inject('post', p1); - var post = DS.get('post', 5); + var post = DS.get('post', 5); - assert.deepEqual(DS.previous('post', 5), p1); + assert.deepEqual(DS.previous('post', 5), p1); - post.author = 'Jake'; + post.author = 'Jake'; - DS.digest(); + DS.digest(); - assert.deepEqual(DS.previous('post', 5), p1); - assert.deepEqual(DS.get('post', 5), { author: 'Jake', age: 30, id: 5 }); + assert.deepEqual(DS.previous('post', 5), p1); + assert.deepEqual(DS.get('post', 5), { author: 'Jake', age: 30, id: 5 }); - $httpBackend.expectPUT('http://test.angular-cache.com/posts/5', { author: 'Jake' }).respond(200, { author: 'Jake', age: 30, id: 5 }); + $httpBackend.expectPUT('http://test.angular-cache.com/posts/5', { author: 'Jake' }).respond(200, { author: 'Jake', age: 30, id: 5 }); - DS.save('post', 5, { changesOnly: true }); + DS.save('post', 5, { changesOnly: true }); - $httpBackend.flush(); + $httpBackend.flush(); - assert.deepEqual(DS.previous('post', 5), { author: 'Jake', age: 30, id: 5 }, 'previous attributes should have been updated'); - assert.deepEqual(DS.get('post', 5), { author: 'Jake', age: 30, id: 5 }); - }); + assert.deepEqual(DS.previous('post', 5), { author: 'Jake', age: 30, id: 5 }, 'previous attributes should have been updated'); + assert.deepEqual(DS.get('post', 5), { author: 'Jake', age: 30, id: 5 }); + }); });