faceted_search 1.1.8 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74e46e964703fb8393bd61a38c156c4e160f2ddbd1e080bebed62d7a81f570e6
-  data.tar.gz: 18dd01b18a593d8cf64f25d844ccbdfbe64c8f4ee425af35de2e607d21caccb6
+  metadata.gz: 85b178d8ebe6784b6a4f5314795e448ad235122f70011f5e928a3d22cb6d8b71
+  data.tar.gz: cb478862460627e6ff37983212f1a4ef17af809bc64cba208edb432cad6b010d
 SHA512:
-  metadata.gz: 9dceb31e9d014a8b7b31e551d13671602730a444c008d5ae4a9c5fe0bde4ae9d0e49d9a13c68b95b4c8c2b777cbe229c9e14a782e1bffba97d497bc3c1b30eac
-  data.tar.gz: dafdf064c2c14d93675da97b6687af3bc33c9db04db52949ca57ea8e941c4dd953e111cb7de625403813a119f791c6b781702e9adf503f40e888121c241cf869
+  metadata.gz: aab3bff63a1cb917d6e5fd5439f8d0f02a61ff81005d4fc2f2f57c316c5d61f3df626b9d05e37100c10a54f0dec54fa1de871342f9c2e49c97ef926e7ac0cfb5
+  data.tar.gz: d290071a7050fefd94fb87cb71563827f8267427bad0f0086f86e331e5c222dd9e4deb86902ab75cefeaf1d1d05b3ca9ea6f26097e5e7a010ba138ea1eee14ef

data/app/models/faceted_search/facets/default.rb

@@ -1,25 +1,16 @@
 module FacetedSearch
   class Facets::Default
-    attr_reader :name, :params, :facets, :find_by
+    attr_reader :name, :params, :facets
 
-    def initialize( name:,
-                    params:,
-                    facets:,
-                    find_by: nil,
-                    source: nil,
-                    habtm: false,
-                    title: nil)
+    def initialize(name, params, facets, options)
       @name = name
-      @title = title
       @params = params
       @facets = facets
-      @find_by = find_by
-      @source = source
-      @habtm = habtm
+      @options = options
     end
 
     def title
-      @title ||= name.to_s.humanize.titleize
+      @options[:title] || name.to_s.humanize.titleize
     end
 
     def kind
@@ -37,7 +28,7 @@ module FacetedSearch
 
     def path(custom_params = @params)
       return '' if custom_params.blank?
-      "&facets[#{@name}]=#{custom_params}"
+      "&facets[#{name}]=#{custom_params}"
     end
 
     def to_s

data/app/models/faceted_search/facets/filter.rb

@@ -1,35 +1,35 @@
 module FacetedSearch
   class Facets::Filter < Facets::Default
-    attr_reader :display_method
 
-    def initialize( name:,
-                    params:,
-                    facets:,
-                    display_method:,
-                    find_by: nil,
-                    source: nil,
-                    habtm: false,
-                    title: nil)
-      super(name: name,
-            title: title,
-            facets: facets,
-            params: params,
-            find_by: find_by,
-            source: source,
-            habtm: habtm,
-            title: title)
-      @display_method = display_method
+    def tree?
+      @options[:tree]
     end
 
-    def path_for(value)
-      value = value.to_s
-      custom_params = params_array.dup
-      selected?(value)  ? custom_params.delete(value)
-                        : custom_params.push(value)
-      path(custom_params.join(','))
+    def display_method
+      @options[:display_method] ||= Proc.new { |object| object.to_s }
     end
 
-    def selected?(value)
+    # Adds a scope corresponding to this facet
+    # to the scope sent as an argument
+    # and return the modified scope
+    def add_scope(scope)
+      return scope if params_array.blank?
+      habtm?  ? scope.joins(name).where(name => { find_by => params_array })
+              : scope.where(name => params_array)
+    end
+
+    def find_by
+      @options[:find_by] || :id
+    end
+
+    # Show all values that have corresponding results.
+    # This is a regular SQL inner join.
+    def values
+      joined_table = facets.model_table_name.to_sym
+      source.all.joins(joined_table).where(joined_table => { id: facets.model }).distinct
+    end
+
+    def value_selected?(value)
       value.to_s.in? params_array
     end
 
@@ -42,38 +42,34 @@ module FacetedSearch
       scope
     end
 
-    def params_array
-      @params_array ||= @params.to_s.split(',')
+    def path_for(value)
+      value = value.to_s
+      custom_params = params_array.dup
+      value_selected?(value)  ? custom_params.delete(value)
+                              : custom_params.push(value)
+      path(custom_params.join(','))
     end
 
-    # Adds a scope corresponding to this facet
-    # to the scope sent as an argument
-    # and return the modified scope
-    def add_scope(scope)
-      return scope if params_array.blank?
-      @habtm  ? scope.joins(name).where(name => { find_by => params_array })
-              : scope.where(name => params_array)
+    protected
+
+    def params_array
+      @params_array ||= @params.to_s.split(',')
     end
 
     # Adds a scope corresponding to this facet
     # to the scope sent as an argument with specific value
     # and return the modified scope
     def add_scope_with_value(scope, value)
-      @habtm  ? scope.joins(name).where(name => { find_by => value })
+      habtm?  ? scope.joins(name).where(name => { find_by => value })
               : scope.where(name => value)
     end
 
-    # Show all values that have corresponding results.
-    # This is a regular SQL inner join.
-    def values
-      joined_table = @facets.model_table_name.to_sym
-      source.all.joins(joined_table).where(joined_table => { id: @facets.model }).distinct
+    def source
+      @options[:source] || name.to_s.singularize.titleize.constantize
     end
 
-    protected
-
-    def source
-      @source ||= @name.to_s.singularize.titleize.constantize
+    def habtm?
+      @options[:habtm]
     end
   end
 end

data/app/models/faceted_search/facets/search.rb

@@ -1,29 +1,13 @@
 module FacetedSearch
   class Facets::Search < Facets::Default
-    attr_reader :placeholder
 
-    def initialize( name:,
-                    params:,
-                    facets:,
-                    placeholder: nil,
-                    find_by: nil,
-                    source: nil,
-                    habtm: false,
-                    title: nil)
-      super(name: name,
-            title: title,
-            facets: facets,
-            params: params,
-            find_by: find_by,
-            source: source,
-            habtm: habtm,
-            title: title)
-      @placeholder = placeholder
+    def placeholder
+      @options[:placeholder]
     end
 
     def add_scope(scope)
-      return scope if @params.blank?
-      scope.where("#{@facets.model_table_name}.#{name} ILIKE ?", "%#{@params}%")
+      return scope if params.blank?
+      scope.where("#{facets.model_table_name}.#{name} ILIKE ?", "%#{params}%")
     end
   end
 end

data/app/models/faceted_search/facets.rb

@@ -41,23 +41,12 @@ module FacetedSearch
 
     protected
 
-    def search(value, placeholder: nil, title: nil)
-      add(Search.new( name: value,
-                      params: params_for(value),
-                      placeholder: placeholder,
-                      facets: self,
-                      title: title))
+    def search(value, options = {})
+      add(Search.new(value, params_for(value), self, options))
     end
 
-    def filter(value, find_by: :id, source: nil, habtm: nil, title: nil, display_method: Proc.new { |object| object.to_s })
-      add(Filter.new( name: value,
-                      params: params_for(value),
-                      facets: self,
-                      find_by: find_by,
-                      source: source,
-                      habtm: habtm,
-                      title: title,
-                      display_method: display_method))
+    def filter(value, options = {})
+      add(Filter.new(value, params_for(value), self, options))
     end
 
     def params_for(value)

data/app/views/faceted_search/facets/_filter.html.erb

@@ -1,13 +1,12 @@
-<ul class="faceted__facet__filter list-unstyled">
+<ul class="faceted__facet__filter<%= '--tree' if facet.tree? %> list-unstyled">
   <% facet.values.each do |value| %>
     <%
     identifier = value.send facet.find_by
-    selected = facet.selected? identifier
     results_count = facet.results_with(identifier).count
     display_value = facet.display_method.call(value)
     next if results_count.zero?
     %>
-    <li class="faceted__facet__filter__value<%= '--selected' if selected %>">
+    <li class="faceted__facet__filter__value<%= '--selected' if facet.value_selected?(identifier) %>">
       <%= link_to "#{display_value} (#{results_count})", facet.facets.path_for(facet, identifier) %>
     </li>
   <% end %>

data/lib/faceted_search/version.rb

@@ -1,3 +1,3 @@
 module FacetedSearch
-  VERSION = '1.1.8'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faceted_search
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 2.0.0
 platform: ruby
 authors:
 - Arnaud Levy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-22 00:00:00.000000000 Z
+date: 2019-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -139,7 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Faceted search with Active Record