From 73c6467f1468353215dc689c019ed83aa4993c77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Go=C5=82=C4=99biowski-Owczarek?= Date: Tue, 13 Mar 2018 09:31:15 +0100 Subject: [PATCH] fix($cookies): remove the deprecated $cookieStore factory Closes #16465 BREAKING CHANGE: The $cookieStore has been removed. Migrate to the $cookies service. Note that for object values you need to use the `putObject` & `getObject` methods as `get`/`put` will not correctly save/retrieve them. Before: ```js $cookieStore.put('name', {key: 'value'}); $cookieStore.get('name'); // {key: 'value'} $cookieStore.remove('name'); ``` After: ```js $cookies.putObject('name', {key: 'value'}); $cookies.getObject('name'); // {key: 'value'} $cookies.remove('name'); ``` --- angularFiles.js | 1 - docs/content/api/index.ngdoc | 6 +-- src/ngCookies/cookieStore.js | 79 ------------------------------- test/ngCookies/cookieStoreSpec.js | 27 ----------- 4 files changed, 1 insertion(+), 112 deletions(-) delete mode 100644 src/ngCookies/cookieStore.js delete mode 100644 test/ngCookies/cookieStoreSpec.js diff --git a/angularFiles.js b/angularFiles.js index 01bb6422b1b2..0233722adfc4 100644 --- a/angularFiles.js +++ b/angularFiles.js @@ -109,7 +109,6 @@ var angularFiles = { ], 'ngCookies': [ 'src/ngCookies/cookies.js', - 'src/ngCookies/cookieStore.js', 'src/ngCookies/cookieWriter.js' ], 'ngMessageFormat': [ diff --git a/docs/content/api/index.ngdoc b/docs/content/api/index.ngdoc index d34ddfb64c1d..e50ca5c4d275 100644 --- a/docs/content/api/index.ngdoc +++ b/docs/content/api/index.ngdoc @@ -222,11 +222,7 @@ Use the ngCookies module to handle cookie management within your application. {@link ngCookies#service Services / Factories} - The following services are used for cookie management: - + The {@link ngCookies.$cookies $cookies} service is a convenient wrapper to store simple data within browser cookies. diff --git a/src/ngCookies/cookieStore.js b/src/ngCookies/cookieStore.js deleted file mode 100644 index ca7a25e2d0f7..000000000000 --- a/src/ngCookies/cookieStore.js +++ /dev/null @@ -1,79 +0,0 @@ -'use strict'; - -angular.module('ngCookies'). -/** - * @ngdoc service - * @name $cookieStore - * @deprecated - * sinceVersion="v1.4.0" - * Please use the {@link ngCookies.$cookies `$cookies`} service instead. - * - * @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 AngularJS'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) { - return $cookies.getObject(key); - }, - - /** - * @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.putObject(key, value); - }, - - /** - * @ngdoc method - * @name $cookieStore#remove - * - * @description - * Remove given cookie - * - * @param {string} key Id of the key-value pair to delete. - */ - remove: function(key) { - $cookies.remove(key); - } - }; - - }]); diff --git a/test/ngCookies/cookieStoreSpec.js b/test/ngCookies/cookieStoreSpec.js deleted file mode 100644 index a19150d99b25..000000000000 --- a/test/ngCookies/cookieStoreSpec.js +++ /dev/null @@ -1,27 +0,0 @@ -'use strict'; - -describe('$cookieStore', function() { - - beforeEach(module('ngCookies', { - $cookies: jasmine.createSpyObj('$cookies', ['getObject', 'putObject', 'remove']) - })); - - - it('should get cookie', inject(function($cookieStore, $cookies) { - $cookies.getObject.and.returnValue('value'); - expect($cookieStore.get('name')).toBe('value'); - expect($cookies.getObject).toHaveBeenCalledWith('name'); - })); - - - it('should put cookie', inject(function($cookieStore, $cookies) { - $cookieStore.put('name', 'value'); - expect($cookies.putObject).toHaveBeenCalledWith('name', 'value'); - })); - - - it('should remove cookie', inject(function($cookieStore, $cookies) { - $cookieStore.remove('name'); - expect($cookies.remove).toHaveBeenCalledWith('name'); - })); - });