forty_facets 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2775c3dbeacb02d6a306671c1f46306f03baaa7c
-  data.tar.gz: 007b804dc78ebe61b1aff29a41f276f2986d62ed
+  metadata.gz: 0c4e5f1187a806a2d29a592deb215db699c940ca
+  data.tar.gz: f744711ed252d741a508583565c033531d70f5f1
 SHA512:
-  metadata.gz: 86d860f3463b9c264010489f2520cf4ac8e216f7f2cfe94ba0e1a5839439e1d799275ccc88281636e5b6a1f0911f26744a826e0a9ca93929eb6c0fb68082800b
-  data.tar.gz: 51c6d45ef8c18c8185d142baac5cbb7bccc1cd54888fb2453f7157d9559657b86d151fc72b5da83bf0cb708c456f2691a593b66210b8e63b2f39392a9507489f
+  metadata.gz: 97da5234fce9ebb01fff1c1f5994ca739724a62b61b343de9e58dd7eacae1e4eb543743b9e338862f098e3c0abbac7aed716848bcc71b16f746bc43aff0675e3
+  data.tar.gz: 0ade8fdfb9ee93d93f76f642412f90f60b2dd2959f5f0a092efaf19031b8ed45daa0ee91993ff9854c5630f621e0d5b36711108ebb7ae2c859265cc07f8e722f

data/README.md

@@ -45,6 +45,8 @@ If you have Movies with a textual title, categotized by genre, studio and year w
       belongs_to :year
       belongs_to :studio
       has_and_belongs_to_many :genres
+
+      scope :classics, -> { where("year <= ?", 1980) }
     end
 
 You can then declare the structure of your search like so:
@@ -55,6 +57,7 @@ class HomeController < ApplicationController
   class MovieSearch < FortyFacets::FacetSearch
     model 'Movie' # which model to search for
     text :title   # filter by a generic string entered by the user
+    scope :classics   # only return movies which are in the scope 'classics'
     range :price, name: 'Price' # filter by ranges for decimal fields
     facet :year, name: 'Releaseyear', order: :year # additionally order values in the year field
     facet :studio, name: 'Studio', order: :name
@@ -117,6 +120,7 @@ end
 | keyword | options       |                                                                                                                         |
 |---------|---------------|-------------------------------------------------------------------------------------------------------------------------|
 | text    | prefix:true   | creates a filter to limit search result to entities containing the filter value in the given field                      |
+| scope   |               | creates a filter to limit search result to entities matching the scope with the given name                              |
 | 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 |

data/lib/forty_facets/facet_search.rb

@@ -5,6 +5,7 @@ module FortyFacets
   #     model 'Movie'
   #
   #     text :title
+  #     scope :someScope, name: 'Only very special'
   #     range :price
   #     facet :genre, name: 'Genre'
   #     facet :year, name: 'Releaseyear', order: :year
@@ -32,6 +33,10 @@ module FortyFacets
         definitions << TextFilterDefinition.new(self, path, opts)
       end
 
+      def scope(path, opts = {})
+        definitions << ScopeFilterDefinition.new(self, path, opts)
+      end
+
       def range(path, opts = {})
         definitions << RangeFilterDefinition.new(self, path, opts)
       end

data/lib/forty_facets/filter/scope_filter_definition.rb

@@ -0,0 +1,32 @@
+module FortyFacets
+  class ScopeFilterDefinition < FilterDefinition
+    class ScopeFilter < Filter
+      def active?
+        value == '1'
+      end
+
+      def build_scope
+        return Proc.new { |base| base } unless active?
+        Proc.new {  |base| base.send(definition.path.first) }
+      end
+
+      def remove
+        new_params = search_instance.params || {}
+        new_params.delete(definition.request_param)
+        search_instance.class.new_unwrapped(new_params, search_instance.root)
+      end
+
+      def add
+        new_params = search_instance.params || {}
+        new_params[definition.request_param] = '1'
+        search_instance.class.new_unwrapped(new_params, search_instance.root)
+      end
+    end
+
+    def build_filter(search_instance, value)
+      ScopeFilter.new(self, search_instance, value)
+    end
+
+  end
+end
+

data/lib/forty_facets/version.rb

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

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/scope_filter_definition"
 require "forty_facets/filter/facet_filter_definition"
 require "forty_facets/filter/sql_facet_filter_definition"
 require "forty_facets/facet_search"

data/test/smoke_test.rb

@@ -28,6 +28,7 @@ class MovieSearch < FortyFacets::FacetSearch
   sql_facet({ classic: "year <= 1980", non_classic: "year > 1980" },
             { name: "Classic" })
   text [:studio, :description], name: 'Studio Description'
+  scope :classics, 'Name classics'
 end
 
 class SmokeTest < Minitest::Test
@@ -267,4 +268,9 @@ class SmokeTest < Minitest::Test
     search.filter(:studio).facet.reject(&:selected).to_a
   end
 
+  def test_scope_filter
+    search_with_scope = MovieSearch.new().filter(:classics).add
+    assert search_with_scope.result.count < Movie.count, 'Activating the scope should yield a smaller set of movies'
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forty_facets
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Axel Tetzlaff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,6 +117,7 @@ files:
 - lib/forty_facets/filter.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
 - lib/forty_facets/filter/sql_facet_filter_definition.rb
 - lib/forty_facets/filter/text_filter_definition.rb
 - lib/forty_facets/filter_definition.rb