chore(release): v2.0.0

Author: ajoslin

CHANGELOG.md

@@ -1,54 +1,18 @@
-<a name="2.0.0-beta2"></a>
-### 2.0.0-beta2 (2014-01-27)
+<a name="2.0.0"></a>
+### 2.0.0 (2014-01-27)
 
-#### Features
-
-* **promiseTracker:**
-  * remove events system ([d3770aac](http://github.com/ajoslin/angular-promise-tracker/commit/d3770aacbd1d1233dcf3f894982004939e64bf91))
-  * add register() and deregister() methods ([cab3c620](http://github.com/ajoslin/angular-promise-tracker/commit/cab3c62013ed3dcb9a0b47d9d1d5ae17d2fe6ab4))
-
-
-#### Breaking Changes
-
-* The events system has been removed.  That means that `promiseTracker.on()`
-and `promiseTracker.off()` no longer exist. In essence, events were a poor way of doing
-'hooks' on promises that we wanted to do.  See [this
-issue](https://github.com/ajoslin/angular-promise-tracker/issues/37) for
-more information.
-
-  [Open an
-  issue of your own](https://github.com/ajoslin/angular-promise-tracker/issues) if you
-  were using events and need help migrating to use another method.
+**The API has completely changed in 2.0. See the README for details. Synopsis of changes:**
 
-  Check [the
-  README](https://github.com/ajoslin/angular-promise-tracker/tree/master/README.md)
-  for details on the current API for promiseTracker.
-   ([d3770aac](http://github.com/ajoslin/angular-promise-tracker/commit/d3770aacbd1d1233dcf3f894982004939e64bf91))
+* String ID system for trackers removed, now use instances created with `var myTrack = new promiseTracker([options]);`.
+* http interceptor functionality is now optional; use it by including `promise-tracker-http-interceptor.js`
+* maxDuration option is removed (there are better ways to do this in every case)
 
-* A promiseTracker instance can no longer be created with the
-`promiseTracker` function, it is a getter only now.  Use
-`promiseTracker.register()`.
+If you are using 1.x in your app and you would like to upgrade, here is the migration guide:
 
-  To migrate your code, change the following:
-
-  ```js
-  var newTracker = promiseTracker('newTracker', options);
-  //..later
-  var tracker = promiseTracker('newTracker');
-  ```
-
-  To:
-
-  ```js
-  var newTracker = promiseTracker.register('newTracker', options);
-  //..later
-  var tracker = promiseTracker('newTracker');
-  ```
+* Find your string ids where you are getting promiseTracker with `promiseTracker('id')`, and create a reference instead with `promiseTracker()`.  If you want a global tracker, store it on rootScope or in a service (check README).
+* (note: The actual instances of the promiseTrackers will have the same API).
 
-  Check the [project
-  README](http://github.com/ajoslin/angular-promise-tracker/tree/master/README.md)
-  for more details about this change.
-   ([cab3c620](http://github.com/ajoslin/angular-promise-tracker/commit/cab3c62013ed3dcb9a0b47d9d1d5ae17d2fe6ab4))
+Upgrading is *not* required, or even recommended, for existing apps.
 
 
 <a name="v1.5.1"></a>

Gruntfile.js

@@ -46,7 +46,7 @@ module.exports = function (grunt) {
         },
         files: {
           '<%= dist %>/promise-tracker.js': ['src/promise-tracker.js'],
-          '<%= dist %>/promise-tracker-http-intercetpor.js': ['src/http-interceptor.js']
+          '<%= dist %>/promise-tracker-http-interceptor.js': ['src/http-interceptor.js']
         }
       }
     },

README.md

@@ -1,6 +1,10 @@
 angular-promise-tracker
 =======================
 
+> **Version**: 2.0
+
+(note to users using version 1.x: upgrading has *many* breaking changes, see [the CHANGELOG](https://github.com/ajoslin/angular-promise-tracker/tree/master/CHANGELOG.md).)
+
 [![Build Status](https://travis-ci.org/ajoslin/angular-promise-tracker.png)](https://travis-ci.org/ajoslin/angular-promise-tracker)
 
 Small, feature filled library used to easily add spinners or general promise/request tracking to your angular app.
@@ -24,79 +28,68 @@ $ bower install angular-promise-tracker
   <div class="my-super-awesome-loading-box" ng-show="loadingTracker.active()">
     Loading...
   </div>
-  <button ng-click="fetchSomething()">Fetch Something</button>
   <button ng-click="delaySomething()">Delay Something</button>
+  <button ng-click="fetchSomething()">Fetch Something</button>
 
   <script src="angular.js"></script>
-  <script src="angular-promise-tracker.js"></script>
+  <script src="promise-tracker.js"></script>
+
+  <!-- optional for $http sugar -->
+  <script src="promise-tracker-http-intercetpor.js"></script>
 </body>
 ```
 ```js
 angular.module('myApp', ['ajoslin.promise-tracker'])
 .controller('MainCtrl', function($scope, $http, $timeout, promiseTracker) {
-  //Create / get our tracker with unique ID
-  $scope.loadingTracker = promiseTracker.register('loadingTracker');
+  //Create a new tracker
+  $scope.loadingTracker = promiseTracker();
+
+  //use `addPromise` to add any old promise to our tracker
+  $scope.delaySomething = function() {
+    var promise = $timeout(function() {
+      alert('Delayed something!');
+    }, 1000);
+    $scope.loadingTracker.addPromise(promise);
+  };
 
   //use `tracker:` shortcut in $http config to link our http promise to a tracker
+  //This shortcut is included in promise-tracker-http-interceptor.js
   $scope.fetchSomething = function(id) {
     return $http.get('/something', {
       tracker: 'loadingTracker'
     }).then(function(response) {
       alert('Fetched something! ' + response.data);
     });
   };
-
-  //use `addPromise` to add any old promise to our tracker
-  $scope.delaySomething = function() {
-    var promise = $timeout(function() {
-      alert('Delayed something!');
-    }, 1000);
-    $scope.loadingTracker.addPromise(promise);
-  };
 });
 ```
 
 ## API Documentation
 
 ### Service `promiseTracker`
 
-* **`tracker` promiseTracker.register(trackerId[, options])**
+* **`tracker` promiseTracker([options])**
 
-  Registers a new promiseTracker with the given identifier.
+  Creates and returns a new promiseTracker.
 
   Options can be given as an object, with the following allowed values:
 
   - `activationDelay` `{Number}` - Number of milliseconds that an added promise needs to be pending before this tracker is active.
       * Usage example: You have some http calls that sometimes return too quickly for a loading spinner to look good. You only want to show the tracker if a promise is pending for over 500ms. You put `{activationDelay: 500}` in options.
   - `minDuration` `{Number}` - Minimum number of milliseconds that a tracker will stay active.
       * Usage example: You want a loading spinner to always show up for at least 750ms. You put `{minDuration: 750}` in options.
-  - `maxDuration` `{Number}` - Maximum number of milliseconds that a tracker will stay active.
-      * Usage example: Your http request takes over ten seconds to come back.  You don't want to display  a loading spinner that long; only for two seconds.  You put `{maxDuration: 2000}` in options.
-
-* **`void` promiseTracker.deregister(trackerId)**
 
-  Deregisters a tracker `register`ed with the given identifier.
-
-* **`tracker` promiseTracker(trackerId)**
-
-  Returns a tracker with `register`ed with the given id.
-
-### **`$http` Sugar**
-
-  * **Any $http call's `config` parameter can have a `tracker` field. Examples:**
+  Often you want a global promiseTracker (eg to show a loading screen); one easy way is to put the tracker on your $rootScope:
 
   ```js
-  //Add $http promise to tracker with id 'myTracker'
-  $http('/banana', { tracker: 'myTracker' })
-  ```
-  ```js
-  //Add $http promise to both 'tracker1' and 'tracker2'
-  $http.post('/elephant', {some: 'data'}, { tracker: ['tracker1', 'tracker2'] })
+  app.run(function($rootScope, promiseTracker) {
+    $rootScope.loadingTracker = promiseTracker();
+  });
   ```
 
 ### Instantiated promiseTracker
 
-`var tracker = promiseTracker('myId');`
+Example: `var myTracker = promiseTracker({ activationDelay: 500, minDuration: 750 });`
 
 * **`boolean` tracker.active()**
 
@@ -126,7 +119,6 @@ angular.module('myApp', ['ajoslin.promise-tracker'])
   ```js
   var deferred = myTracker.createPromise()
   console.log(myTracker.active()) // => true
-  //later...
   deferred.resolve();
   console.log(myTracker.active()) // => false
   }
@@ -136,6 +128,21 @@ angular.module('myApp', ['ajoslin.promise-tracker'])
 
   Causes a tracker to immediately become inactive and stop tracking all current promises.
 
+### **`$http` Sugar**
+
+  **Requires promise-tracker-http-interceptor.js**
+
+  * **Any $http call's `config` parameter can have a `tracker` field. Examples:**
+
+  ```js
+  //Add $http promise to tracker with id 'myTracker'
+  $http('/banana', { tracker: myPromiseTrackerInstance })
+  ```
+  ```js
+  //Add $http promise to both 'tracker1' and 'tracker2'
+  $http.post('/elephant', {some: 'data'}, { tracker: [myFirstTracker, mySecondTracker] })
+  ```
+
 ## Development
 
 * Install karma & grunt with `npm install -g karma grunt-cli` to build & test

bower.json

@@ -2,7 +2,7 @@
   "author": "Andy Joslin",
   "name": "promise-tracker",
   "description": "Easily add spinners or general request tracking to your angular app.",
-  "version": "2.0.0-beta3",
+  "version": "2.0.0",
   "homepage": "http://github.com/ajoslin/angular-promise-tracker",
   "repository": {
     "type": "git",
@@ -23,8 +23,7 @@
   ],
   "files": [
     "promise-tracker.js",
-    "promise-tracker.min.js",
-    "README.md"
+    "promise-tracker-http-interceptor.js"
   ],
   "devDependencies": {
     "angular": "1.2.6",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-promise-tracker",
-  "version": "2.0.0-beta4",
+  "version": "2.0.0",
   "author": {
     "name": "Andy Joslin"
   },

promise-tracker-http-interceptor.js

@@ -0,0 +1,47 @@
+/*
+ * promise-tracker - v2.0.0-beta3 - 2014-02-13
+ * http://github.com/ajoslin/angular-promise-tracker
+ * Created by Andy Joslin; Licensed under Public Domain
+ */
+
+(function() {
+
+angular.module('ajoslin.promise-tracker')
+.config(['$httpProvider', function($httpProvider) {
+  $httpProvider.interceptors.push(['$q', 'promiseTracker', function($q, promiseTracker) {
+    return {
+      request: function(config) {
+        if (config.tracker) {
+          if (!angular.isArray(config.tracker)) {
+            config.tracker = [config.tracker];
+          }
+          config.$promiseTrackerDeferred = config.$promiseTrackerDeferred || [];
+
+          angular.forEach(config.tracker, function(tracker) {
+            var deferred = tracker.createPromise();
+            config.$promiseTrackerDeferred.push(deferred);
+          });
+        }
+        return $q.when(config);
+      },
+      response: function(response) {
+        if (response.config && response.config.$promiseTrackerDeferred) {
+          angular.forEach(response.config.$promiseTrackerDeferred, function(deferred) {
+            deferred.resolve(response);
+          });
+        }
+        return $q.when(response);
+      },
+      responseError: function(response) {
+        if (response.config && response.config.$promiseTrackerDeferred) {
+          angular.forEach(response.config.$promiseTrackerDeferred, function(deferred) {
+            deferred.reject(response);
+          });
+        }
+        return $q.reject(response);
+      }
+    };
+  }]);
+}]);
+
+}());