forty_facets 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c4e5f1187a806a2d29a592deb215db699c940ca
-  data.tar.gz: f744711ed252d741a508583565c033531d70f5f1
+  metadata.gz: 1b86da7ae3b989602b2dcbd37699c80466901e16
+  data.tar.gz: afd3024e01104aa310b23a4ac564fdd4c478c093
 SHA512:
-  metadata.gz: 97da5234fce9ebb01fff1c1f5994ca739724a62b61b343de9e58dd7eacae1e4eb543743b9e338862f098e3c0abbac7aed716848bcc71b16f746bc43aff0675e3
-  data.tar.gz: 0ade8fdfb9ee93d93f76f642412f90f60b2dd2959f5f0a092efaf19031b8ed45daa0ee91993ff9854c5630f621e0d5b36711108ebb7ae2c859265cc07f8e722f
+  metadata.gz: 3ef1428c9e97396a80f8c2577c7290b201208c603e4ade01b045ed2499ea8c137bb3a1b015a272787bd52979ccb29207accd274ce13593fb7012745e7a6e8ce5
+  data.tar.gz: 172f6758103dbea345a9bbd1ea67139fc4dff60da450a7c2285089ce528b452c67d80faa132add9a87ffd51ebf8ae4a34c4ec4259d4fb9b83a44d33cfd3095ea

data/README.md

@@ -67,6 +67,8 @@ class HomeController < ApplicationController
     orders 'Title' => :title,
            'price, cheap first' => "price asc",
            'price, expensive first' => {price: :desc, title: :desc}
+    custom :for_manual_handling
+
   end
 
   def index
@@ -124,6 +126,7 @@ end
 | facet   |               | creates a facetted filter on the specified model attribute (attribute or belongs_to)                                    |
 | range   |               | creates a range filter (param format 'FROM - TO') limiting result to entities with values in that range              | 
 | orders  |               | takes a hash mapping a label to an argument that the active record `order` method can be called with to sort the result |
+| custom  |               | doesnt affect the query directly, just handles the request param. access via @search.filter(:custom_filter).set(..) /@search.filter(:custom_filter).value |
 
 ## FAQ
 

data/lib/forty_facets.rb

@@ -9,6 +9,7 @@ require "forty_facets/filter"
 require "forty_facets/filter_definition"
 require "forty_facets/filter/range_filter_definition"
 require "forty_facets/filter/text_filter_definition"
+require "forty_facets/filter/custom_filter_definition"
 require "forty_facets/filter/scope_filter_definition"
 require "forty_facets/filter/facet_filter_definition"
 require "forty_facets/filter/sql_facet_filter_definition"

data/lib/forty_facets/facet_search.rb

@@ -15,6 +15,7 @@ module FortyFacets
   #            'price, cheap first' => "price asc",
   #            'price, expensive first' => {price: :desc, title: :desc},
   #            'Title, reverse' => {order: "title desc", default: true}
+  #     custom :for_manual_handling
   #
   #   end
   class FacetSearch
@@ -33,6 +34,10 @@ module FortyFacets
         definitions << TextFilterDefinition.new(self, path, opts)
       end
 
+      def custom(path, opts = {})
+        definitions << CustomFilterDefinition.new(self, path, opts)
+      end
+
       def scope(path, opts = {})
         definitions << ScopeFilterDefinition.new(self, path, opts)
       end

data/lib/forty_facets/filter/custom_filter_definition.rb

@@ -0,0 +1,26 @@
+module FortyFacets
+  class CustomFilterDefinition < FilterDefinition
+    class CustomFilter < Filter
+      def build_scope
+        return Proc.new { |base| base } # the custom filter doesn alter the query at all
+                                        # but you can use it's state to modify the base_scope
+                                        # in your controller
+      end
+
+      def set(new_value)
+        new_params = search_instance.params || {}
+
+        new_params[definition.request_param] = new_value
+        search_instance.class.new_unwrapped(new_params, search_instance.root)
+      end
+
+    end
+
+    def build_filter(search_instance, value)
+      CustomFilter.new(self, search_instance, value)
+    end
+
+  end
+end
+
+

data/lib/forty_facets/version.rb

@@ -1,3 +1,3 @@
 module FortyFacets
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/smoke_test.rb

@@ -29,6 +29,7 @@ class MovieSearch < FortyFacets::FacetSearch
             { name: "Classic" })
   text [:studio, :description], name: 'Studio Description'
   scope :classics, 'Name classics'
+  custom :needs_complex_filtering
 end
 
 class SmokeTest < Minitest::Test
@@ -273,4 +274,11 @@ class SmokeTest < Minitest::Test
     assert search_with_scope.result.count < Movie.count, 'Activating the scope should yield a smaller set of movies'
   end
 
+  def test_custom_filter
+    search = MovieSearch.new
+    new_search = search.filter(:needs_complex_filtering).set('foo')
+
+    assert_equal 'foo', new_search.filter(:needs_complex_filtering).value
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forty_facets
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Axel Tetzlaff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ files:
 - lib/forty_facets.rb
 - lib/forty_facets/facet_search.rb
 - lib/forty_facets/filter.rb
+- lib/forty_facets/filter/custom_filter_definition.rb
 - lib/forty_facets/filter/facet_filter_definition.rb
 - lib/forty_facets/filter/range_filter_definition.rb
 - lib/forty_facets/filter/scope_filter_definition.rb