move url filter functionality to service ProductFiltersService

spec/javascripts/unit/admin/bulk_product_update_spec.js.coffee

@@ -246,7 +246,7 @@ describe "filtering products for submission to database", ->
     ]
 
 describe "AdminProductEditCtrl", ->
-  $ctrl = $scope = $timeout = $httpBackend = BulkProducts = DirtyProducts = DisplayProperties = windowStub = null
+  $ctrl = $scope = $timeout = $httpBackend = BulkProducts = DirtyProducts = DisplayProperties = ProductFiltersService = windowStub = null
 
   beforeEach ->
     module "ofn.admin"
@@ -258,7 +258,7 @@ describe "AdminProductEditCtrl", ->
       $provide.value 'columns', []
       null
 
-  beforeEach inject((_$controller_, _$timeout_, $rootScope, _$httpBackend_, _BulkProducts_, _DirtyProducts_, _DisplayProperties_) ->
+  beforeEach inject((_$controller_, _$timeout_, $rootScope, _$httpBackend_, _BulkProducts_, _DirtyProducts_, _DisplayProperties_, _ProductFiltersService_) ->
     $scope = $rootScope.$new()
     $ctrl = _$controller_
     $timeout = _$timeout_
@@ -266,8 +266,9 @@ describe "AdminProductEditCtrl", ->
     BulkProducts = _BulkProducts_
     DirtyProducts = _DirtyProducts_
     DisplayProperties = _DisplayProperties_
+    ProductFiltersService = _ProductFiltersService_
 
-    # Stub the window object so we don't get redirected when href is updated 
+    # Stub the window object so we don't get redirected when href is updated
     windowStub = {navigator: {userAgent: 'foo'}, location: {href: ''}}
 
     $ctrl "AdminProductEditCtrl", {$scope: $scope, $timeout: $timeout, $window: windowStub}
@@ -282,7 +283,7 @@ describe "AdminProductEditCtrl", ->
       expect($scope.fetchProducts.calls.count()).toBe 1
 
     it "gets a list of products applying filters from the url", inject ($location) ->
-      query = 'lala' 
+      query = 'lala'
       producerFilter = 2
       categoryFilter = 5
       sorting = 'name desc'
@@ -291,11 +292,11 @@ describe "AdminProductEditCtrl", ->
 
       $scope.initialise()
 
-      expect($scope.query).toBe query
-      expect($scope.producerFilter).toBe producerFilter
-      expect($scope.categoryFilter).toBe categoryFilter
-      expect($scope.sorting).toBe sorting
-      expect($scope.importDateFilter).toBe importDateFilter
+      expect($scope.q.query).toBe query
+      expect($scope.q.producerFilter).toBe producerFilter
+      expect($scope.q.categoryFilter).toBe categoryFilter
+      expect($scope.q.sorting).toBe sorting
+      expect($scope.q.importDateFilter).toBe importDateFilter
 
   describe "fetching products", ->
     $q = null
@@ -316,18 +317,18 @@ describe "AdminProductEditCtrl", ->
       $scope.$digest()
       expect($scope.resetProducts).toHaveBeenCalled()
 
-    it "updates url wihth filter after data has been received", inject ($location, $window) ->
+    it "updates url with filter after data has been received", inject ($location, $window) ->
       query = 'lala'
       producerFilter = 2
       categoryFilter = 5
       sorting = 'name desc'
       importDateFilter = '2020-06-08'
 
-      $scope.query = query
-      $scope.producerFilter = producerFilter
-      $scope.categoryFilter = categoryFilter
-      $scope.sorting = sorting
-      $scope.importDateFilter = importDateFilter
+      $scope.q.query = query
+      $scope.q.producerFilter = producerFilter
+      $scope.q.categoryFilter = categoryFilter
+      $scope.q.sorting = sorting
+      $scope.q.importDateFilter = importDateFilter
 
       $scope.fetchProducts()
       $scope.$digest()
@@ -995,14 +996,14 @@ describe "AdminProductEditCtrl", ->
       it 'should load edit product page including the selected filters', inject ($httpParamSerializer) ->
         query = 'lala'
         category = 3
-        $scope.query = query
-        $scope.categoryFilter = category
+        $scope.q.query = query
+        $scope.q.categoryFilter = category
 
         # use $httpParamSerializer as it will sort parameters alphabetically
         expectedFilter = $httpParamSerializer({ query: query, categoryFilter: category })
 
         $scope.editWarn(testProduct, null)
-        
+
         expect(windowStub.location.href).toBe(
           "/admin/products/#{testProduct.permalink_live}/edit?#{expectedFilter}"
         )
@@ -1010,13 +1011,13 @@ describe "AdminProductEditCtrl", ->
   describe "filtering products", ->
     describe "clearing filters", ->
       it "resets filter variables", ->
-        $scope.query = "lala"
-        $scope.producerFilter = "5"
-        $scope.categoryFilter = "6"
+        $scope.q.query = "lala"
+        $scope.q.producerFilter = "5"
+        $scope.q.categoryFilter = "6"
         $scope.resetSelectFilters()
-        expect($scope.query).toBe ""
-        expect($scope.producerFilter).toBeUndefined
-        expect($scope.categoryFilter).toBeUndefined
+        expect($scope.q.query).toBe ""
+        expect($scope.q.producerFilter).toBeUndefined
+        expect($scope.q.categoryFilter).toBeUndefined
 
 
 describe "converting arrays of objects with ids to an object with ids as keys", ->

spec/javascripts/unit/admin/services/product_filters_spec.js.coffee

@@ -0,0 +1,68 @@
+describe "ProductFiltersService service", ->
+  ProductFiltersService = null
+
+  beforeEach ->
+    module "ofn.admin"
+
+  beforeEach inject (_ProductFiltersService_) ->
+    ProductFiltersService = _ProductFiltersService_
+
+  describe "loadFromUrl", ->
+    it "should return a hash with value populated for filters existing in parameter", ->
+      producerFilter = 2
+      query = 'fruit'
+
+      filters = ProductFiltersService.loadFromUrl(producerFilter: producerFilter, query: query)
+
+      expect(filters.producerFilter).toBe producerFilter
+      expect(filters.query).toBe query
+
+    it "should return a hash with empty value for filters missing from parameter", ->
+      filters = ProductFiltersService.loadFromUrl({})
+
+      expect(filters.producerFilter).toBe ""
+      expect(filters.query).toBe ""
+      expect(filters.categoryFilter).toBe ""
+      expect(filters.sorting).toBe ""
+      expect(filters.importDateFilter).toBe ""
+
+  describe "generate", ->
+    it 'should filter given hash with productFilters', ->
+      producerFilter = 2
+      query = 'fruit'
+
+      filters = ProductFiltersService.generate(
+        producerFilter: producerFilter, query: query, otherParam: 'otherParam'
+      )
+
+      expect(filters.producerFilter).toBe producerFilter
+      expect(filters.query).toBe query
+      expect(filters.otherParam).toBe undefined
+
+  describe "buildUrl", ->
+    it 'should return a url adding filters to the baseUrl', inject ($httpParamSerializer) ->
+      query = 'lala'
+      producerFilter = 2
+      categoryFilter = 5
+      sorting = 'name desc'
+      importDateFilter = '2020-06-08'
+      filters = {
+        producerFilter: producerFilter
+        categoryFilter: categoryFilter
+        query: query
+        sorting: sorting
+        importDateFilter: importDateFilter
+      }
+      baseUrl = "openfoodnetwork.org.au"
+
+      url = ProductFiltersService.buildUrl(baseUrl, filters)
+
+      expectedFilters = $httpParamSerializer(filters)
+      expect(url).toBe("#{baseUrl}?#{expectedFilters}")
+
+    it 'should return baseUrl if filters are empty', ->
+      baseUrl = "openfoodnetwork.org.au"
+
+      url = ProductFiltersService.buildUrl(baseUrl, {})
+      expect(url).toBe baseUrl
+