Merge pull request scotttrinh#33 from GaelMagnan/master

feat: Added search functionality

Author: ocombe

README.md

@@ -12,7 +12,7 @@ This angularJS module is a rewrite of [angular-local-storage by grevory](https:/
 - Store your data in the best available storage solution that your browser can offer (IndexedDB / WebSQL or localstorage as a fallback)
 
 - All browsers are supported starting at IE8. For the full list check: [IndexedDB support](http://caniuse.com/#search=indexeddb), [WebSQL support](http://caniuse.com/#search=websql) and [localstorage support](http://caniuse.com/#search=localstorage)
- 
+
 - Everything is async and uses promises
 
 - Use the service or the directive
@@ -60,6 +60,8 @@ angular.module('yourModule', ['LocalForageModule'])
 
 - `length()`: returns the number of items stored (async, promise)
 
+- `search(filter)`: returns all the items for which filter returns true (filter is a function taking key,value as params) (async, promise)
+
 - `bind($scope, key/params object)`: lets you directly bind a LocalForage value to a $scope variable (async, promise)
 ```js
 $localForage.bind($scope, 'myStorageKey');

src/angular-localForage.js

@@ -125,6 +125,55 @@
 return deferred.promise;
 };
 
+
+// Get all the values for which the filter function returns true
+// filter should be a function that takes two parameters key, value and returns a boolean
+// return a list of item
+LocalForageInstance.prototype.search = function search(filter) {
+// throw error on undefined key
+if(angular.isUndefined(filter)) {
+throw new Error("You must define a filter");
+}
+if(!angular.isFunction(filter)) {
+throw new Error("filter must be a function");
+}
+var deferred = $q.defer(),
+args = arguments,
+self = this;
+
+self._localforage.keys().then(function success(keyList) {
+var promises = [],
+datas = [],
+ret = [];
+angular.forEach(keyList, function(key){
+var d = $q.defer()
+self._localforage.getItem(self.prefix() + key)
+.then(function success(item) {
+datas.push({'key': key, 'value': item});
+d.resolve();
+},function failure(err){
+self.onError(data, args, self.search, deferred);
+});
+promises.push(d.promise);
+});
+$q.all(promises).then(function(){
+angular.forEach(datas, function(data){
+var key = data['key'],
+value = data['value'];
+if(filter(key, value))
+ret.push(value);
+});
+deferred.resolve(ret);
+},function(err){
+self.onError(data, args, self.search, deferred);
+});
+}, function error(data) {
+self.onError(data, args, self.search, deferred);
+deferred.reject(data)
+});
+return deferred.promise;
+};
+
 // Remove an item from storage
 LocalForageInstance.prototype.removeItem = function removeItem(key) {
 // throw error on undefined key

tests/angular-localForage.js

@@ -6,10 +6,12 @@ describe('Module: LocalForageModule', function () {
  var rootScope,
  $injector,
  myService,
+ q,
  spies = {};
 
- beforeEach(inject(function ($rootScope) {
+ beforeEach(inject(function ($rootScope, $q) {
  rootScope = $rootScope;
+ q = $q;
  $injector = angular.injector(['LocalForageModule']);
  myService = $injector.get('$localForage');
 
@@ -44,6 +46,11 @@ describe('Module: LocalForageModule', function () {
  expect(typeof myService.getItem).toBe('function');
  });
 
+ it('service:search should be defined', function () {
+ expect(myService.search).toBeDefined();
+ expect(typeof myService.search).toBe('function');
+ });
+
  it('service:removeItem should be defined', function () {
  expect(myService.removeItem).toBeDefined();
  expect(typeof myService.removeItem).toBe('function');
@@ -159,4 +166,86 @@ describe('Module: LocalForageModule', function () {
  run('webSQLStorage');
  });
 
+
+ it('service:search should work', function() {
+ function run(driver) {
+ return runs(function() {
+ return myService.setDriver(driver).then(function() {
+ return myService.clear().then(function() {
+ q.all(myService.setItem('myName', 'Olivier Combe'),
+ myService.setItem('myPassion', 'AngularJs'),
+ myService.setItem('myHobbie', 'Open Source')
+ ).then(function(all_rets) {
+
+ var promises = [];
+ //test no filter
+ var d1 = q.defer();
+ myService.search(
+ function(key, value){
+ return true;
+ }
+ ).then(function(data) {
+ expect(data.length).toEqual(3);
+ d1.resolve();
+ }, function(res) {
+ console.log(res);
+ throw('Fail search, driver = '+driver)
+ d1.reject();
+ });
+ promises.push(d1);
+
+ //test key filter
+ var d2 = q.defer();
+ myService.search(
+ function(key, value){
+ return key == 'myPassion';
+ }
+ ).then(function(data) {
+ expect(data.length).toEqual(1);
+ expect(data[0]).toBe('AngularJs');
+ d2.resolve();
+ }, function(res) {
+ console.log(res);
+ throw('Fail search, driver = '+driver)
+ d2.reject();
+ });
+ promises.push(d2);
+
+ //test value filter
+ var d3 = q.defer();
+ myService.search(
+ function(key, value){
+ return value == 'AngularJs';
+ }
+ ).then(function(data) {
+ expect(data.length).toEqual(1);
+ expect(data[0]).toBe('AngularJs');
+ d3.resolve();
+ }, function(res) {
+ console.log(res);
+ throw('Fail search, driver = '+driver)
+ d3.reject();
+ });
+ promises.push(d3);
+ return q.all(promises);
+ }, function(res) {
+ console.log(res);
+ throw('Fail set item, driver = '+driver)
+ });
+ }, function(res) {
+ console.log(res);
+ throw('Fail clear, driver = '+driver)
+ })
+ }, function( res ) {
+ console.log(res);
+ throw('Fail sets driver '+driver)
+ })
+ });
+ }
+
+ // run('asyncStorage');
+ run('localStorageWrapper');
+ // run('webSQLStorage');
+ });
+
 });