refactor(ngCookies): split $cookies/$cookieStore to two files

Author: shahata

angularFiles.js

@@ -91,6 +91,7 @@ var angularFiles = {
     ],
     'ngCookies': [
       'src/ngCookies/cookies.js',
+      'src/ngCookies/cookieStore.js',
       'src/ngCookies/cookieWriter.js'
     ],
     'ngMessages': [

src/ngCookies/cookieStore.js

@@ -0,0 +1,76 @@
+'use strict';
+
+angular.module('ngCookies').
+/**
+ * @ngdoc service
+ * @name $cookieStore
+ * @requires $cookies
+ *
+ * @description
+ * Provides a key-value (string-object) storage, that is backed by session cookies.
+ * Objects put or retrieved from this storage are automatically serialized or
+ * deserialized by angular's toJson/fromJson.
+ *
+ * Requires the {@link ngCookies `ngCookies`} module to be installed.
+ *
+ * @example
+ *
+ * ```js
+ * angular.module('cookieStoreExample', ['ngCookies'])
+ *   .controller('ExampleController', ['$cookieStore', function($cookieStore) {
+ *     // Put cookie
+ *     $cookieStore.put('myFavorite','oatmeal');
+ *     // Get cookie
+ *     var favoriteCookie = $cookieStore.get('myFavorite');
+ *     // Removing a cookie
+ *     $cookieStore.remove('myFavorite');
+ *   }]);
+ * ```
+ */
+ factory('$cookieStore', ['$cookies', function($cookies) {
+
+    return {
+      /**
+       * @ngdoc method
+       * @name $cookieStore#get
+       *
+       * @description
+       * Returns the value of given cookie key
+       *
+       * @param {string} key Id to use for lookup.
+       * @returns {Object} Deserialized cookie value, undefined if the cookie does not exist.
+       */
+      get: function(key) {
+        var value = $cookies[key];
+        return value ? angular.fromJson(value) : value;
+      },
+
+      /**
+       * @ngdoc method
+       * @name $cookieStore#put
+       *
+       * @description
+       * Sets a value for given cookie key
+       *
+       * @param {string} key Id for the `value`.
+       * @param {Object} value Value to be stored.
+       */
+      put: function(key, value) {
+        $cookies[key] = angular.toJson(value);
+      },
+
+      /**
+       * @ngdoc method
+       * @name $cookieStore#remove
+       *
+       * @description
+       * Remove given cookie
+       *
+       * @param {string} key Id of the key-value pair to delete.
+       */
+      remove: function(key) {
+        delete $cookies[key];
+      }
+    };
+
+  }]);

src/ngCookies/cookies.js

@@ -120,79 +120,4 @@ angular.module('ngCookies', ['ng']).
           }
         }
       }
-    }]).
-
-
-  /**
-   * @ngdoc service
-   * @name $cookieStore
-   * @requires $cookies
-   *
-   * @description
-   * Provides a key-value (string-object) storage, that is backed by session cookies.
-   * Objects put or retrieved from this storage are automatically serialized or
-   * deserialized by angular's toJson/fromJson.
-   *
-   * Requires the {@link ngCookies `ngCookies`} module to be installed.
-   *
-   * @example
-   *
-   * ```js
-   * angular.module('cookieStoreExample', ['ngCookies'])
-   *   .controller('ExampleController', ['$cookieStore', function($cookieStore) {
-   *     // Put cookie
-   *     $cookieStore.put('myFavorite','oatmeal');
-   *     // Get cookie
-   *     var favoriteCookie = $cookieStore.get('myFavorite');
-   *     // Removing a cookie
-   *     $cookieStore.remove('myFavorite');
-   *   }]);
-   * ```
-   */
-   factory('$cookieStore', ['$cookies', function($cookies) {
-
-      return {
-        /**
-         * @ngdoc method
-         * @name $cookieStore#get
-         *
-         * @description
-         * Returns the value of given cookie key
-         *
-         * @param {string} key Id to use for lookup.
-         * @returns {Object} Deserialized cookie value, undefined if the cookie does not exist.
-         */
-        get: function(key) {
-          var value = $cookies[key];
-          return value ? angular.fromJson(value) : value;
-        },
-
-        /**
-         * @ngdoc method
-         * @name $cookieStore#put
-         *
-         * @description
-         * Sets a value for given cookie key
-         *
-         * @param {string} key Id for the `value`.
-         * @param {Object} value Value to be stored.
-         */
-        put: function(key, value) {
-          $cookies[key] = angular.toJson(value);
-        },
-
-        /**
-         * @ngdoc method
-         * @name $cookieStore#remove
-         *
-         * @description
-         * Remove given cookie
-         *
-         * @param {string} key Id of the key-value pair to delete.
-         */
-        remove: function(key) {
-          delete $cookies[key];
-        }
-      };
-
     }]);

test/ngCookies/cookieStoreSpec.js

@@ -0,0 +1,58 @@
+'use strict';
+
+describe('$cookieStore', function() {
+  var mockedCookies;
+
+  beforeEach(function() {
+    var lastCookies = {};
+    mockedCookies = {};
+    module('ngCookies', {
+      $$cookieWriter: function(name, value) {
+        mockedCookies[name] = value;
+      },
+      $$cookieReader: function() {
+        if (!angular.equals(lastCookies, mockedCookies)) {
+          lastCookies = angular.copy(mockedCookies);
+          mockedCookies = angular.copy(mockedCookies);
+        }
+        return mockedCookies;
+      }
+    });
+  });
+
+  it('should serialize objects to json', inject(function($cookieStore, $$cookieReader, $rootScope) {
+    $cookieStore.put('objectCookie', {id: 123, name: 'blah'});
+    $rootScope.$digest();
+    expect($$cookieReader()).toEqual({'objectCookie': '{"id":123,"name":"blah"}'});
+  }));
+
+
+  it('should deserialize json to object', inject(function($cookieStore, $browser, $$cookieWriter) {
+    $$cookieWriter('objectCookie', '{"id":123,"name":"blah"}');
+    $browser.poll();
+    expect($cookieStore.get('objectCookie')).toEqual({id: 123, name: 'blah'});
+  }));
+
+
+  it('should delete objects from the store when remove is called', inject(function($cookieStore, $browser, $rootScope, $$cookieReader) {
+    $cookieStore.put('gonner', { "I'll":"Be Back"});
+    $rootScope.$digest(); //force eval in test
+    $browser.poll();
+    expect($$cookieReader()).toEqual({'gonner': '{"I\'ll":"Be Back"}'});
+
+    $cookieStore.remove('gonner');
+    $rootScope.$digest();
+    expect($$cookieReader()).toEqual({});
+  }));
+  it('should handle empty string value cookies', inject(function($cookieStore, $browser, $rootScope, $$cookieReader) {
+    $cookieStore.put("emptyCookie",'');
+    $rootScope.$digest();
+    expect($$cookieReader()).
+        toEqual({ 'emptyCookie': '""' });
+    expect($cookieStore.get("emptyCookie")).toEqual('');
+
+    mockedCookies['blankCookie'] = '';
+    $browser.poll();
+    expect($cookieStore.get("blankCookie")).toEqual('');
+  }));
+});

test/ngCookies/cookiesSpec.js

@@ -94,61 +94,3 @@ describe('$cookies', function() {
     expect($$cookieReader()).toEqual({'preexisting': 'oldCookie'});
   }));
 });
-
-
-describe('$cookieStore', function() {
-  var mockedCookies;
-
-  beforeEach(function() {
-    var lastCookies = {};
-    mockedCookies = {};
-    module('ngCookies', {
-      $$cookieWriter: function(name, value) {
-        mockedCookies[name] = value;
-      },
-      $$cookieReader: function() {
-        if (!angular.equals(lastCookies, mockedCookies)) {
-          lastCookies = angular.copy(mockedCookies);
-          mockedCookies = angular.copy(mockedCookies);
-        }
-        return mockedCookies;
-      }
-    });
-  });
-
-  it('should serialize objects to json', inject(function($cookieStore, $$cookieReader, $rootScope) {
-    $cookieStore.put('objectCookie', {id: 123, name: 'blah'});
-    $rootScope.$digest();
-    expect($$cookieReader()).toEqual({'objectCookie': '{"id":123,"name":"blah"}'});
-  }));
-
-
-  it('should deserialize json to object', inject(function($cookieStore, $browser, $$cookieWriter) {
-    $$cookieWriter('objectCookie', '{"id":123,"name":"blah"}');
-    $browser.poll();
-    expect($cookieStore.get('objectCookie')).toEqual({id: 123, name: 'blah'});
-  }));
-
-
-  it('should delete objects from the store when remove is called', inject(function($cookieStore, $browser, $rootScope, $$cookieReader) {
-    $cookieStore.put('gonner', { "I'll":"Be Back"});
-    $rootScope.$digest(); //force eval in test
-    $browser.poll();
-    expect($$cookieReader()).toEqual({'gonner': '{"I\'ll":"Be Back"}'});
-
-    $cookieStore.remove('gonner');
-    $rootScope.$digest();
-    expect($$cookieReader()).toEqual({});
-  }));
-  it('should handle empty string value cookies', inject(function($cookieStore, $browser, $rootScope, $$cookieReader) {
-    $cookieStore.put("emptyCookie",'');
-    $rootScope.$digest();
-    expect($$cookieReader()).
-        toEqual({ 'emptyCookie': '""' });
-    expect($cookieStore.get("emptyCookie")).toEqual('');
-
-    mockedCookies['blankCookie'] = '';
-    $browser.poll();
-    expect($cookieStore.get("blankCookie")).toEqual('');
-  }));
-});