angularjs-rails-resource 1.0.0.pre.2 → 1.0.0.pre.3

data/bower.json

@@ -1,11 +1,11 @@
 {
   "name": "angularjs-rails-resource",
-  "version": "1.0.0-pre.2",
+  "version": "1.0.0-pre.3",
   "main": "angularjs-rails-resource.js",
   "description": "A resource factory inspired by $resource from AngularJS",
   "repository": {
     "type": "git",
-    "url": "https://github.com/FineLinePrototyping/angularjs-rails-resource.git"
+    "url": "https://github.com/FineLinePrototyping/dist-angularjs-rails-resource.git"
   },
   "dependencies": {
     "angular": "*"

data/changelog.js

@@ -0,0 +1,206 @@
+#!/usr/bin/env node
+
+// Copied from angular.js and modified to suit our needs
+
+var child = require('child_process');
+var fs = require('fs');
+var util = require('util');
+var q = require('qq');
+
+var GIT_LOG_CMD = 'git log --grep="%s" -E -i --format=%s %s..HEAD';
+var GIT_TAG_CMD = 'git describe --tags --abbrev=0';
+
+var HEADER_TPL = '<a name="%s"></a>\n# %s (%s)\n\n';
+var LINK_ISSUE = '[#%s](https://github.com/FineLinePrototyping/angularjs-rails-resource/issues/%s)';
+var LINK_COMMIT = '[%s](https://github.com/FineLinePrototyping/angularjs-rails-resource/commit/%s)';
+
+var EMPTY_COMPONENT = '$$';
+
+
+var warn = function() {
+    console.log('WARNING:', util.format.apply(null, arguments));
+};
+
+
+var parseRawCommit = function(raw) {
+    if (!raw) return null;
+
+    var lines = raw.split('\n');
+    var msg = {}, match;
+
+    msg.hash = lines.shift();
+    msg.subject = lines.shift();
+    msg.closes = [];
+    msg.deprecates = [];
+    msg.breaks = [];
+
+    lines.forEach(function(line) {
+        match = line.match(/(?:Closes|Fixes)\s#(\d+)/);
+        if (match) msg.closes.push(parseInt(match[1]));
+        match = line.match(/^Deprecates:\s(.*)$/);
+        if (match) msg.deprecates.push(match[1]);
+    });
+
+    match = raw.match(/BREAKING CHANGE:([\s\S]*)/);
+    if (match) {
+        msg.breaking = match[1];
+    }
+
+
+    msg.body = lines.join('\n');
+    match = msg.subject.match(/^(.*)\(?(.*)\)?\:\s(.*)$/);
+
+    if (!match || !match[1] || !match[3]) {
+        warn('Incorrect message: %s %s', msg.hash, msg.subject);
+        return null;
+    }
+
+    msg.type = match[1].toLowerCase();
+    msg.component = match[2];
+    msg.subject = match[3];
+    return msg;
+};
+
+
+var linkToIssue = function(issue) {
+    return util.format(LINK_ISSUE, issue, issue);
+};
+
+
+var linkToCommit = function(hash) {
+    return util.format(LINK_COMMIT, hash.substr(0, 8), hash);
+};
+
+
+var currentDate = function() {
+    var now = new Date();
+    var pad = function(i) {
+        return ('0' + i).substr(-2);
+    };
+
+    return util.format('%d-%s-%s', now.getFullYear(), pad(now.getMonth() + 1), pad(now.getDate()));
+};
+
+
+var printSection = function(stream, title, section, printCommitLinks) {
+    printCommitLinks = printCommitLinks === undefined ? true : printCommitLinks;
+    var components = Object.getOwnPropertyNames(section).sort();
+
+    if (!components.length) return;
+
+    stream.write(util.format('\n## %s\n\n', title));
+
+    components.forEach(function(name) {
+        var prefix = '-';
+        var nested = section[name].length > 1;
+
+        if (name !== EMPTY_COMPONENT) {
+            if (nested) {
+                stream.write(util.format('- **%s:**\n', name));
+                prefix = '  -';
+            } else {
+                prefix = util.format('- **%s:**', name);
+            }
+        }
+
+        section[name].forEach(function(commit) {
+            if (printCommitLinks) {
+                stream.write(util.format('%s %s\n  (%s', prefix, commit.subject, linkToCommit(commit.hash)));
+                if (commit.closes.length) {
+                    stream.write(',\n   ' + commit.closes.map(linkToIssue).join(', '));
+                }
+                stream.write(')\n');
+            } else {
+                stream.write(util.format('%s %s', prefix, commit.subject));
+            }
+        });
+    });
+
+    stream.write('\n');
+};
+
+
+var readGitLog = function(grep, from) {
+    var deferred = q.defer();
+    child.exec(util.format(GIT_LOG_CMD, grep, '%H%n%s%n%b%n==END==', from), function(code, stdout, stderr) {
+        var commits = [];
+
+        stdout.split('\n==END==\n').forEach(function(rawCommit) {
+            var commit = parseRawCommit(rawCommit);
+            if (commit) commits.push(commit);
+        });
+
+        deferred.resolve(commits);
+    });
+
+    return deferred.promise;
+};
+
+
+var writeChangelog = function(stream, commits, version) {
+    var sections = {
+        fix: {},
+        feat: {},
+        perf: {},
+        deprecate: {},
+        breaks: {}
+    };
+
+    sections.breaks[EMPTY_COMPONENT] = [];
+
+    commits.forEach(function(commit) {
+        var section = sections[commit.type];
+        var component = commit.component || EMPTY_COMPONENT;
+
+        if (section) {
+            section[component] = section[component] || [];
+            section[component].push(commit);
+        }
+
+        if (commit.breaking) {
+            sections.breaks[component] = sections.breaks[component] || [];
+            sections.breaks[component].push({
+                subject: util.format("due to %s,\n %s", linkToCommit(commit.hash), commit.breaking),
+                hash: commit.hash,
+                closes: []
+            });
+        }
+    });
+
+    stream.write(util.format(HEADER_TPL, version, version, currentDate()));
+    printSection(stream, 'Bug Fixes', sections.fix);
+    printSection(stream, 'Features', sections.feat);
+    printSection(stream, 'Deprecations', sections.deprecates);
+    printSection(stream, 'Breaking Changes', sections.breaks, false);
+}
+
+
+var getPreviousTag = function() {
+    var deferred = q.defer();
+    child.exec(GIT_TAG_CMD, function(code, stdout, stderr) {
+        if (code) deferred.reject('Cannot get the previous tag.');
+        else deferred.resolve(stdout.replace('\n', ''));
+    });
+    return deferred.promise;
+};
+
+
+var generate = function(version, file) {
+    getPreviousTag().then(function(tag) {
+        console.log('Reading git log since', tag);
+        readGitLog('^fix|^feat|^perf|^deprecate|BREAKING', tag).then(function(commits) {
+            console.log('Parsed', commits.length, 'commits');
+            console.log('Generating changelog to', file || 'stdout', '(', version, ')');
+            writeChangelog(file ? fs.createWriteStream(file) : process.stdout, commits, version);
+        });
+    });
+};
+
+
+// publish for testing
+exports.parseRawCommit = parseRawCommit;
+
+// hacky start if not run by jasmine :-D
+if (process.argv.join('').indexOf('jasmine-node') === -1) {
+    generate(process.argv[2], process.argv[3]);
+}

data/karma.conf.js

@@ -11,7 +11,8 @@ module.exports = function(config) {
       'test/lib/angular/angular-loader.js',
       'test/lib/angular/angular-sanitize.js',
       'test/lib/angular/angular-mocks.js',
-      'vendor/assets/javascripts/**/*.js',
+      'vendor/assets/javascripts/angularjs/rails/resource/index.js',
+      'vendor/assets/javascripts/angularjs/rails/resource/**/*.js',
       'test/unit/**/*.js'
     ],
     junitReporter: {

data/lib/angularjs-rails-resource/version.rb

@@ -1,7 +1,7 @@
 module Angularjs
   module Rails
     module Resource
-      VERSION = '1.0.0.pre.2'
+      VERSION = '1.0.0.pre.3'
     end
   end
 end

data/package.json

@@ -1,7 +1,7 @@
 {
   "name": "angularjs-rails-resource",
   "description" : "A resource factory inspired by $resource from AngularJS",
-  "version": "1.0.0-pre.2",
+  "version": "1.0.0-pre.3",
   "main" : "dist/angularjs-rails-resource.min.js",
   "homepage" : "https://github.com/FineLinePrototyping/angularjs-rails-resource.git",
   "author" : "",
@@ -19,13 +19,19 @@
     "grunt-contrib-jshint": "~0.6.0",
     "grunt-contrib-uglify": "~0.2.2",
     "grunt-contrib-concat": "~0.3.0",
+    "grunt-contrib-copy": "~0.4.1",
+    "grunt-contrib-clean": "~0.5.0",
     "grunt-contrib-watch": "~0.5.1",
-    "grunt-zip": "~0.9.2",
+    "grunt-contrib-compress": "~0.5.2",
+    "grunt-bump": "~0.0.13",
     "karma": "~0.10",
     "karma-jasmine": "~0.1",
     "karma-chrome-launcher": "~0.1",
     "karma-phantomjs-launcher": "~0.1",
-    "karma-junit-reporter": "~0.1"
+    "karma-junit-reporter": "~0.1",
+    "q": "~0.9.2",
+    "q-io": "~1.10.6",
+    "qq": "~0.3.5"
   },
   "scripts": {
     "test": "./node_modules/.bin/karma start --single-run --browsers PhantomJS"

data/test/unit/angularjs/rails/extensions/snapshotsSpec.js

@@ -0,0 +1,428 @@
+describe('RailsResource.snapshots', function () {
+    'use strict';
+    var Book, $httpBackend, railsResourceFactory, railsSerializer;
+
+    beforeEach(function () {
+        module('rails')
+    });
+
+    beforeEach(inject(function (_$httpBackend_, _railsResourceFactory_, _railsSerializer_) {
+        $httpBackend = _$httpBackend_;
+        railsResourceFactory = _railsResourceFactory_;
+        railsSerializer = _railsSerializer_;
+        Book = railsResourceFactory({
+            url: '/books',
+            name: 'book',
+            extensions: ['snapshots']
+        });
+    }));
+
+    afterEach(function() {
+        $httpBackend.verifyNoOutstandingExpectation();
+        $httpBackend.verifyNoOutstandingRequest();
+    });
+
+    it('should store all keys', function () {
+        var book, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        expect(book.snapshot()).toBe(0);
+
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(1);
+        expect(book.$snapshots[0].$snapshots).toBeUndefined();
+        expect(book).toEqualData(data);
+        expect(book.$snapshots[0].$key).toBe('1234');
+        expect(book.$snapshots[0]).toEqualData(data);
+    });
+
+    it('should store deep copy', function () {
+        var book, data = {
+            id: 1,
+            $key: '1234',
+            name: 'The Winds of Winter',
+            author: {
+                id: 1,
+                name: 'George R. R. Martin'
+            }
+        };
+
+        book = new Book(data);
+        book.snapshot();
+
+        expect(book.$snapshots[0].author).toBeDefined();
+        expect(book.$snapshots[0].author.id).toBe(1);
+        expect(book.$snapshots[0]).toEqualData(data);
+    });
+
+    it('should store multiple snapshots', function () {
+        var book, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        expect(book.snapshot()).toBe(0);
+        book.$key = '1235';
+        expect(book.snapshot()).toBe(1);
+        book.$key = '1236';
+        expect(book.snapshot()).toBe(2);
+
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(3);
+        expect(book.$snapshots[0].$key).toBe('1234');
+        expect(book.$snapshots[1].$key).toBe('1235');
+        expect(book.$snapshots[2].$key).toBe('1236');
+    });
+
+    it('should rollback single version', function () {
+        var book, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot();
+        book.$key = '1235';
+        book.snapshot();
+        book.$key = '1236';
+        book.rollback();
+
+        expect(book.$key).toBe('1235');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(1);
+    });
+
+    it('should rollback deep copy', function () {
+        var book, data = {
+            id: 1,
+            $key: '1234',
+            name: 'The Winds of Winter',
+            author: {
+                id: 1,
+                name: 'George R. R. Martin'
+            }
+        };
+
+        book = new Book(data);
+        book.snapshot();
+        book.author = {id: 2, name: 'Hugh Howey'};
+        book.rollback();
+
+        expect(book.author).toBeDefined();
+        expect(book).toEqualData(data);
+
+        book.snapshot();
+        book.author.name = 'Hugh Howey';
+        book.rollback();
+
+        expect(book.author).toBeDefined();
+        expect(book).toEqualData(data);
+    });
+
+    it('should not modify source nested object on rollback', function () {
+        var book, hughHoweyAuthor = {id: 2, name: 'Hugh Howey'},
+            data = {
+            id: 1,
+            $key: '1234',
+            name: 'The Winds of Winter',
+            author: {
+                id: 1,
+                name: 'George R. R. Martin'
+            }
+        };
+
+        book = new Book(data);
+        book.snapshot();
+        book.author = hughHoweyAuthor;
+        book.rollback();
+
+        expect(hughHoweyAuthor).toEqualData({id: 2, name: 'Hugh Howey'});
+    });
+
+
+    it('should allow multiple rollbacks', function () {
+        var book, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot();
+        book.$key = '1235';
+        book.snapshot();
+        book.$key = '1236';
+        book.rollback();
+
+        expect(book.$key).toBe('1235');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(1);
+        book.rollback();
+
+        expect(book.$key).toBe('1234');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(0);
+    });
+
+
+    it('should rollback specified number of versions', function () {
+        var book, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot();
+        book.$key = '1235';
+        book.snapshot();
+        book.$key = '1236';
+        book.snapshot();
+        book.$key = '1237';
+        book.rollback(2);
+
+        expect(book.$key).toBe('1235');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(1);
+    });
+
+    it('should not change resource on rollback if no snapshots saved', function () {
+        var book, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.$key = '1235';
+        book.rollback();
+
+        expect(book.$key).toBe('1235');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(0);
+    });
+
+    it('should roll back to the first snapshot for -1', function () {
+        var book, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot();
+        book.$key = '1235';
+        book.snapshot();
+        book.$key = '1236';
+        book.snapshot();
+        book.rollback(-1);
+
+        expect(book.$key).toBe('1234');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(0);
+    });
+
+    it('should roll back to the first snapshot when versions exceeds available snapshots', function () {
+        var book, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot();
+        book.$key = '1235';
+        book.snapshot();
+        book.$key = '1236';
+        book.snapshot();
+        book.rollback(1000);
+
+        expect(book.$key).toBe('1234');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(0);
+    });
+
+    it('should roll back to version in middle', function () {
+        var book, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot();
+        book.$key = '1235';
+        book.snapshot();
+        book.$key = '1236';
+        book.snapshot();
+        book.rollbackTo(1);
+
+        expect(book.$key).toBe('1235');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(1);
+    });
+
+    it('should roll back to first version', function () {
+        var book, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot();
+        book.$key = '1235';
+        book.snapshot();
+        book.$key = '1236';
+        book.snapshot();
+        book.rollbackTo(0);
+
+        expect(book.$key).toBe('1234');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(0);
+    });
+
+    it('should roll back to last version when version exceeds available versions', function () {
+        var book, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot();
+        book.$key = '1235';
+        book.snapshot();
+        book.$key = '1236';
+        book.snapshot();
+        book.$key = '1237';
+        book.rollbackTo(100);
+
+        expect(book.$key).toBe('1236');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(2);
+    });
+
+    it('should reset snapshots on create', function () {
+        var book, data = {$key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot();
+        book.$key = '1235';
+
+        $httpBackend.expectPOST('/books').respond(200, {book: {id: 1}});
+        book.save();
+        $httpBackend.flush();
+
+        expect(book.$key).toBe('1235');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(0);
+    });
+
+    it('should be able to save after rollback', function () {
+        var book, data = {$key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot();
+        book.$key = '1235';
+        book.rollback();
+
+        $httpBackend.expectPOST('/books').respond(200, {book: {id: 1}});
+        book.save();
+        $httpBackend.flush();
+
+        expect(book.$key).toBe('1234');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(0);
+    });
+
+    it('should reset snapshots on update', function () {
+        var book, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot();
+        book.$key = '1235';
+
+        $httpBackend.expectPUT('/books/1').respond(200, {book: {id: 1}});
+        book.save();
+        $httpBackend.flush();
+
+        expect(book.$key).toBe('1235');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(0);
+    });
+
+    it('should reset snapshots on delete', function () {
+        var book, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot();
+        book.$key = '1235';
+
+        $httpBackend.expectDELETE('/books/1').respond(200, {book: {id: 1}});
+        book.delete();
+        $httpBackend.flush();
+
+        expect(book.$key).toBe('1235');
+        expect(book.$snapshots).toBeDefined();
+        expect(book.$snapshots.length).toBe(0);
+    });
+
+    it('should call rollback callback on rollback', function () {
+        var book, callbackCalled = false, data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot(function () {
+            callbackCalled = true;
+        });
+        book.rollback();
+        expect(callbackCalled).toBe(true);
+    });
+
+    it('should call correct rollback callback on each rollback', function () {
+        var book, firstCallbackCalled = false, secondCallbackCalled = false,
+            data = {id: 1, $key: '1234', name: 'The Winds of Winter'};
+        book = new Book(data);
+        book.snapshot(function () {
+            firstCallbackCalled = true;
+        });
+        book.$key = '1235';
+        book.snapshot(function () {
+            secondCallbackCalled = true;
+        });
+        book.$key = '1236';
+
+        book.rollback();
+        expect(book.$key).toBe('1235');
+        expect(firstCallbackCalled).toBe(false);
+        expect(secondCallbackCalled).toBe(true);
+
+        book.rollback();
+        expect(book.$key).toBe('1234');
+        expect(firstCallbackCalled).toBe(true);
+        expect(secondCallbackCalled).toBe(true);
+    });
+
+    describe('serializer', function () {
+        beforeEach(function () {
+            Book.configure({
+                serializer: railsSerializer(function () {
+                    this.exclude('author');
+                })
+            });
+        });
+
+        it('should exclude author from snapshot and rollback', function () {
+            var book, data = {
+                id: 1,
+                $key: '1234',
+                name: 'The Winds of Winter',
+                author: {
+                    id: 1,
+                    name: 'George R. R. Martin'
+                }
+            };
+
+            book = new Book(data);
+            book.snapshot();
+            book.author.name = 'George Orwell';
+
+            expect(book.$snapshots[0].author).not.toBeDefined();
+            expect(book.author).toEqualData({id: 1, name: 'George Orwell'});
+
+            book.rollback();
+            // should still be George Orwell since it wasn't snapshotted
+            expect(book.author).toEqualData({id: 1, name: 'George Orwell'});
+        });
+
+    });
+
+    describe('snapshotSerializer', function () {
+        beforeEach(function () {
+            Book.configure({
+                serializer: railsSerializer(function () {
+                    this.exclude('author');
+                }),
+                snapshotSerializer: railsSerializer(function () {
+                    this.exclude('$key');
+                })
+            });
+        });
+
+        it('should include author and exclude $key from snapshot and rollback', function () {
+            var book, data = {
+                id: 1,
+                $key: '1234',
+                name: 'The Winds of Winter',
+                author: {
+                    id: 1,
+                    name: 'George R. R. Martin'
+                }
+            };
+
+            book = new Book(data);
+            book.snapshot();
+            book.$key = '1235';
+            book.author.name = 'George Orwell';
+
+            expect(book.$snapshots[0].author).toBeDefined();
+            expect(book.$snapshots[0].$key).not.toBeDefined();
+            expect(book.$key).toBe('1235');
+            expect(book.author).toEqualData({id: 1, name: 'George Orwell'});
+
+            book.rollback();
+            // should be 1235 since it wasn't snapshotted
+            expect(book.$key).toBe('1235');
+            // should be George R. R. Martin since it was snapshotted
+            expect(book.author).toEqualData({id: 1, name: 'George R. R. Martin'});
+        });
+
+    });
+});