angular-local-storage/test/spec/localStorageSpec.js

'use strict';

describe('localStorageService', function() {
  var elmSpy;

  //Actions
  function getItem(key) {
    return function($window, localStorageService) {
      elmSpy = spyOn($window.localStorage, 'getItem').andCallThrough();
      localStorageService.get(key);
    };
  }

  function addItem(key, value) {
    return function($window, localStorageService) {
      elmSpy = spyOn($window.localStorage, 'setItem').andCallThrough();
      localStorageService.set(key, value);
    };
  }

  function addItemWithPut(key, value) {
    return function($window, localStorageService) {
      elmSpy = spyOn($window.localStorage, 'setItem').andCallThrough();
      localStorageService.put(key, value);
    };
  }


  function removeItem(key) {
    return function($window, localStorageService) {
      elmSpy = spyOn($window.localStorage, 'removeItem').andCallThrough();
      localStorageService.remove(key);
    };
  }

  //Expectations
  function expectGetting(key) {
    return function() {
      expect(elmSpy).toHaveBeenCalledWith(key);
    };
  }

  function expectAdding(key, value) {
    return function() {
      expect(elmSpy).toHaveBeenCalledWith(key, value);
    };
  }

  function expectRemoving(key) {
    return function() {
      expect(elmSpy).toHaveBeenCalledWith(key);
    };
  }

  function expectMatching(key, expected) {
    return function(localStorageService) {
      expect(localStorageService.get(key)).toEqual(expected);
    };
  }

  function expectStorageTyping(type) {
    return function(localStorageService) {
      expect(localStorageService.getStorageType()).toEqual(type);
    };
  }

  function expectSupporting(expected) {
    return function(localStorageService) {
      expect(localStorageService.isSupported).toEqual(expected);
    };
  }

  function expectCookieSupporting(expected) {
    return function(localStorageService) {
      expect(localStorageService.cookie.isSupported).toEqual(expected);
    };
  }

  function expectDomain(domain) {
    return function($document, localStorageService) {
      localStorageService.set('foo','bar'); //Should trigger first time
      expect($document.cookie.indexOf('domain=' + domain)).not.toEqual(-1);
    };
  }

  function expectCookieConfig(exp, path) {
    return function($document, localStorageService) {
      localStorageService.set('foo','bar'); //Should trigger first time
      // Just compare the expiry date, not the time, because of daylight savings
      var expiryStringPartial = exp.substr(0, exp.indexOf(new Date().getFullYear()));
      expect($document.cookie.indexOf('expires=' + expiryStringPartial)).not.toEqual(-1);
      expect($document.cookie.indexOf('path=' + path)).not.toEqual(-1);
    };
  }

  //Provider
  function setPrefix(prefix) {
    return function(localStorageServiceProvider) {
      localStorageServiceProvider.setPrefix(prefix);
    };
  }

  function setNotify(itemSet, itemRemove) {
    return function(localStorageServiceProvider) {
      localStorageServiceProvider.setNotify(itemSet, itemRemove);
    };
  }

  function setStorage(type) {
    return function(localStorageServiceProvider) {
      localStorageServiceProvider.setStorageType(type);
    };
  }

  function setCookieDomain(domain) {
    return function(localStorageServiceProvider) {
      localStorageServiceProvider.setStorageCookieDomain(domain);
    };
  }

  function setStorageCookie(exp, path) {
    return function(localStorageServiceProvider) {
      localStorageServiceProvider.setStorageCookie(exp, path);
    };
  }

  beforeEach(module('LocalStorageModule', function($provide) {

    $provide.value('$window', {
      localStorage: localStorageMock()
    });

  }));

  it('isSupported should be true', inject(
    expectSupporting(true)
  ));

  it('typing should be "localStorage" by default, if supported', inject(
    expectStorageTyping('localStorage')
  ));

  it('should add key to localeStorage with initial prefix(ls)', inject(
    addItem('foo', 'bar'),
    expectAdding('ls.foo', 'bar')
  ));

  it('should add key to localeStorage null if value not provided', inject(
    addItem('foo'),
    expectAdding('ls.foo', null)
  ));

  it('should add key to localStorage using put method', inject(
    addItemWithPut('key', 777),
    expectAdding('ls.key', angular.toJson(777)),
    expectMatching('key', 777)
  ));

  it('should support to set custom prefix', function() {
    module(setPrefix('myApp'));
    inject(
      addItem('foo', 'bar'),
      expectAdding('myApp.foo', 'bar')
    );
  });

  it('should be able to chain functions in the config phase', function() {
    module(function(localStorageServiceProvider) {
        localStorageServiceProvider
          .setPrefix('chain')
          .setNotify(false, true)
          .setStorageType('session');
      });
    inject(function(localStorageService) {
      expect(localStorageService.deriveKey('foo')).toEqual('chain.foo');
      expect(localStorageService.getStorageType()).toEqual('session');
    });
  });

  it('should be able to return the derive key', function() {
    module(setPrefix('myApp'));
    inject(function(localStorageService) {
      expect(localStorageService.deriveKey('foo')).toEqual('myApp.foo');
    });
  });

  it('should be able to set and get arrays', function() {
    var values = ['foo', 'bar', 'baz'];
    inject(
      addItem('key', values),
      expectAdding('ls.key', angular.toJson(values)),
      expectMatching('key', values)
    );
  });

  it('should be able to set and get objects', function() {
    var values = { 0: 'foo', 1: 'bar', 2: 'baz' };
    inject(
      addItem('key', values),
      expectAdding('ls.key', angular.toJson(values)),
      expectMatching('key', values)
    );
  });

  it('should be able to set and get integers', function() {
    inject(
      addItem('key', 777),
      expectAdding('ls.key', angular.toJson(777)),
      expectMatching('key', 777)
    );
  });

  it('should be able to set and get float numbers', function() {
    inject(
      addItem('key', 123.123),
      expectAdding('ls.key', angular.toJson(123.123)),
      expectMatching('key', 123.123)
    );
  });

  it('should be able to set and get strings', function() {
    inject(
      addItem('key', 'string'),
      expectAdding('ls.key', 'string'),
      expectMatching('key', 'string')
    );
  });

  it('should be able to set and get numbers as a strings', function() {
    inject(
      addItem('key', '777'),
      expectAdding('ls.key', angular.toJson('777')),
      expectMatching('key', '777')
    );
  });

  it('should be able to get items', inject(
    getItem('key'),
    expectGetting('ls.key')
  ));

  it('should be able to remove items', inject(
    removeItem('lorem.ipsum'),
    expectRemoving('ls.lorem.ipsum')
  ));

  it('should be able only to remove owned keys', inject(function($window, localStorageService) {
    localStorageService.set('appKey', 'appValue');
    $window.localStorage.setItem('appKey', 'appValue');

    expect($window.localStorage.getItem('ls.appKey')).toBeDefined();
    expect($window.localStorage.getItem('appKey')).toBeDefined();

    localStorageService.remove('appKey');

    expect($window.localStorage.getItem('ls.appKey')).not.toBeDefined();
    expect($window.localStorage.getItem('appKey')).toBeDefined();
  }));

  it('should broadcast event on settingItem', inject(function($rootScope, localStorageService) {
    var setSpy = spyOn($rootScope, '$broadcast');
    localStorageService.set('Ariel', 'Mashraki');
    expect(setSpy).toHaveBeenCalled();
  }));

  it('should not broadcast event on removingItem', inject(function($rootScope, localStorageService) {
    var removeSpy = spyOn($rootScope, '$broadcast');
    localStorageService.remove('Ariel', 'Mashraki');
    expect(removeSpy).not.toHaveBeenCalled();
  }));

  it('should be able to change notify/broadcasting settings', function() {
    module(setNotify(false, false));
    inject(function($rootScope, localStorageService) {
      var spy = spyOn($rootScope, '$broadcast');
      localStorageService.set('a8m', 'foobar');
      localStorageService.remove('a8m', 'foobar');

      expect(spy).not.toHaveBeenCalled();
    });
  });

  it('should be able to notify/broadcasting if set', function() {
    module(setNotify(true, true));
    inject(function($rootScope, localStorageService) {
      var spy = spyOn($rootScope, '$broadcast');

      localStorageService.set('a8m', 'foobar');
      localStorageService.remove('a8m', 'foobar');
      expect(spy.callCount).toEqual(2);
    });
  });

  it('should be able to bind to scope', inject(function($rootScope, localStorageService) {

    localStorageService.set('property', 'oldValue');
    localStorageService.bind($rootScope, 'property');

    $rootScope.property = 'newValue';
    $rootScope.$digest();

    expect($rootScope.property).toEqual(localStorageService.get('property'));
  }));

  it('should be able to unbind from scope variable', inject(function($rootScope, localStorageService) {

    localStorageService.set('property', 'oldValue');
    var lsUnbind = localStorageService.bind($rootScope, 'property');

    $rootScope.property = 'newValue';
    $rootScope.$digest();

    expect($rootScope.property).toEqual(localStorageService.get('property'));

    lsUnbind();
    $rootScope.property = 'anotherValue';
    $rootScope.$digest();

    expect($rootScope.property).not.toEqual(localStorageService.get('property'));
  }));

  it('should be able to bind to properties of objects', inject(function($rootScope, localStorageService) {

    localStorageService.set('obj.property', 'oldValue');
    localStorageService.bind($rootScope, 'obj.property');

    expect($rootScope.obj.property).toEqual(localStorageService.get('obj.property'));

    $rootScope.obj.property = 'newValue';
    $rootScope.$digest();

    expect($rootScope.obj.property).toEqual(localStorageService.get('obj.property'));
  }));

  it('should be able to bind to scope using different key', inject(function($rootScope, localStorageService) {

    localStorageService.set('lsProperty', 'oldValue');
    localStorageService.bind($rootScope, 'property', undefined, 'lsProperty');

    expect($rootScope.property).toEqual(localStorageService.get('lsProperty'));

    $rootScope.property = 'newValue';
    $rootScope.$digest();

    expect($rootScope.property).toEqual(localStorageService.get('lsProperty'));
  }));

  it('should $watch with deep comparison only for objects', inject(function($rootScope, localStorageService) {
    var mocks = [{}, [], 'string', 90, false];
    var expectation = [true, true, false, false, false];
    var results = [];

    spyOn($rootScope, '$watch').andCallFake(function(key, func, eq) {
      results.push(eq);
    });

    mocks.forEach(function(elm, i) {
      localStorageService.set('mock' + i, elm);
      localStorageService.bind($rootScope, 'mock' + i);
    });

    expect(results).toEqual(expectation);
  }));

  it('should be able to return it\'s owned keys amount', inject(
    function(localStorageService, $window) {

      for(var i = 0; i < 10; i++) {
        localStorageService.set('key' + i, 'val' + i);
        $window.localStorage.setItem('key' + i, 'val' + i);
      }
      expect(localStorageService.length()).toEqual(10);
      expect($window.localStorage.length).toEqual(20);
    }));

  it('should be able to clear all owned keys from storage',inject(function($window, localStorageService) {
    for(var i = 0; i < 10; i++) {
      localStorageService.set('key' + i, 'val' + i);
      $window.localStorage.setItem('key' + i, 'val' + i);
    }

    localStorageService.clearAll();
    //remove only owned keys
    for(var l = 0; l < 10; l++) {
      expect(localStorageService.get('key' + l)).toEqual(null);
      expect($window.localStorage.getItem('key' + l)).toEqual('val' + l);
    }
  }));

  it('should return array of all owned keys', inject(function($window, localStorageService) {
    //set keys
    for(var i = 0; i < 10; i++) {
      //localStorageService
      localStorageService.set('ownKey' + i, 'val' + i);
      //window.localStorage
      $window.localStorage.setItem('windowKey' + i, 'val' + i);
    }
    localStorageService.keys().forEach(function(el, i) {
      expect(el).toEqual('ownKey' + i);
    });
  }));

  //sessionStorage
  describe('SessionStorage', function() {

    beforeEach(module('LocalStorageModule', function($provide) {
      $provide.value('$window', {
        sessionStorage: localStorageMock()
      });
    }));

    it('should be able to change storage to SessionStorage', function() {
      module(setStorage('sessionStorage'));

      inject(function($window, localStorageService) {
        var setSpy = spyOn($window.sessionStorage, 'setItem'),
          getSpy = spyOn($window.sessionStorage, 'getItem'),
          removeSpy = spyOn($window.sessionStorage, 'removeItem');

        localStorageService.set('foo', 'bar');
        localStorageService.get('foo');
        localStorageService.remove('foo');

        expect(setSpy).toHaveBeenCalledWith('ls.foo', 'bar');
        expect(getSpy).toHaveBeenCalledWith('ls.foo');
        expect(removeSpy).toHaveBeenCalledWith('ls.foo');

      });
    });

    it('type should be sessionStorage', function() {
      module(setStorage('sessionStorage'));
      inject(
        expectStorageTyping('sessionStorage')
      );
    });

    it('isSupported should be true on sessionStorage mode', function() {
      module(setStorage('sessionStorage'));
      inject(
        expectSupporting(true)
      );
    });

  });

  //cookie
  describe('Cookie', function() {

    beforeEach(module('LocalStorageModule', function($provide) {
      $provide.value('$window', {
        localStorage: false,
        sessionStorage: false,
        navigator: {
          cookieEnabled: true
        }
      });
      $provide.value('$document', {
        cookie: ''
      });
    }));

    it('isSupported should be false on fallback mode', inject(
      expectSupporting(false)
    ));

    it('cookie.isSupported should be true if cookies are enabled', inject(
      expectCookieSupporting(true)
    ));

    it('fallback storage type should be cookie', inject(
      expectStorageTyping('cookie')
    ));

    it('should be able to add to cookie domain', function() {
      module(setCookieDomain('.example.org'));
      inject(expectDomain('.example.org'));
    });

    it('should be able to config expiry and path', function() {
      module(setStorageCookie(60, '/path'));
      inject(expectCookieConfig(new Date().addDays(60), '/path'));
    });

    it('should be able to set and get cookie', inject(function(localStorageService) {
      localStorageService.set('cookieKey', 'cookieValue');
      expect(localStorageService.get('cookieKey')).toEqual('cookieValue');
    }));

    it('should be able to remove from cookie', inject(function(localStorageService) {
      localStorageService.set('cookieKey', 'cookieValue');
      localStorageService.remove('cookieKey');
      expect(localStorageService.get('cookieKey')).toEqual('');
    }));

    it('should be able to set and get objects from cookie', inject(function(localStorageService) {
      //use as a fallback
      localStorageService.set('cookieKey', { a: { b: 1 } });
      expect(localStorageService.get('cookieKey')).toEqual({ a: { b: 1 } });
      //use directly
      localStorageService.cookie.set('cookieKey', { a: 2 });
      expect(localStorageService.cookie.get('cookieKey')).toEqual({ a: 2 });
    }));

    it('should be able to set and get arrays from cookie', inject(function(localStorageService) {
      //use as a fallback
      localStorageService.set('cookieKey', [1, 2, 3, [ 1, 2, 3 ]]);
      expect(localStorageService.get('cookieKey')).toEqual([1, 2, 3, [ 1, 2, 3 ]]);
      //use directly
      localStorageService.cookie.set('cookieKey', ['foo', 'bar']);
      expect(localStorageService.cookie.get('cookieKey')).toEqual(['foo', 'bar']);
    }));

    it('should be able to clear all owned keys from cookie', inject(function(localStorageService, $document) {
      localStorageService.set('ownKey1', 1);
      $document.cookie = 'username=John Doe';
      localStorageService.clearAll();
      expect(localStorageService.get('ownKey1')).toEqual(null);
      expect($document.cookie).not.toEqual('');
    }));

    it('should be broadcast on adding item', function() {
      module(setNotify(true, false));
      inject(function($rootScope, localStorageService) {
        var spy = spyOn($rootScope, '$broadcast');
        localStorageService.set('a8m', 'foobar');
        expect(spy).toHaveBeenCalled();
      });
    });

    it('should be broadcast on removing item', function() {
      module(setNotify(false, true));
      inject(function($rootScope, localStorageService) {
        var spy = spyOn($rootScope, '$broadcast');
        localStorageService.remove('a8m', 'foobar');
        expect(spy).toHaveBeenCalled();
      });
    });

    Date.prototype.addDays = function(days) {
      var date = new Date(this.getTime());
      date.setDate(date.getDate() + days);
      return date.toUTCString();
    };
  });

  //cookie disabled
  describe('No Cookie', function() {

    beforeEach(module('LocalStorageModule', function($provide) {
      $provide.value('$window', {
        navigator: {
          cookieEnabled: false
        }
      });
      $provide.value('$document', {

      });
    }));

    it('cookie.isSupported should be false if cookies are disabled', inject(
      expectCookieSupporting(false)
    ));
  });
});