faceted_search 3.4.6 → 3.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e9f81eccfba92e5b5cdee2597cbb3398441e50509c3ef5a03917ede6640f344
-  data.tar.gz: d25738a940c0bbfcb7e971d65df5347fe7ca93e22e756d1f3cd2b2ff0a207e19
+  metadata.gz: f9c031c6042e6795df7c7465fba26d1ff6e8d8ad3c7f3db94859febdcf3df6e0
+  data.tar.gz: c534ffb91303aaa601e530bd2271bb36dcef60ec01d04ba97ee74645f8968e86
 SHA512:
-  metadata.gz: 4ef30658dc5d4c0bea74517853adcc22641ad5b2b6d51f8d18700576c293bb92579e592667a7fa200df22b8480d23161df53a4b253725922f0ceac5249e26fbc
-  data.tar.gz: 204033e66314157a25b00f15bfc6f51650b62ce1dc7979f462394b27bfdec9f4cec9bc1aab88cae1ae223c4979ae8d900ec198b4aafe9fb167fa5b29179ce8e3
+  metadata.gz: f062d6086f4608816429ad31f69cf706f7a7868e486183a3c42f7c1d546190c8142d8dcc6b2cb3fb91901b0f26f64cf49c848a3c5de37407d7cd9150ab0ca737
+  data.tar.gz: 90669a44d5ba16929296b22854a80446ddb88cde6ea2df4e38e96495e25ab61b3e7b38788fefce07ce78d5a55162bf11b9cef99106616f6bd9388da228f68b13

data/README.md

@@ -56,6 +56,24 @@ Create a model defining your facets:
         #     children.order(:title)
         #   }
         # }
+
+        # Other option, with searchable (SEO) categories
+        filter_with_full_tree :categories, {
+          habtm: true,
+          searchable: true,
+          path_pattern: Proc.new { |category_id|
+            Rails.application.routes.url_helpers.category_path(category_id)
+          }
+        }
+
+        # Filter with range input
+        filter_with_range :distance, {
+          min: 10,
+          max: 200,
+          step: 10,
+          default_value: 50,
+          hide_in_selected: true
+        }
       end
     end
 

data/app/models/faceted_search/facets.rb

@@ -19,10 +19,18 @@ module FacetedSearch
     end
 
     def path_for(facet, value)
-      p = path
-      list.each do |current_facet|
-        p += current_facet == facet ? current_facet.path_for(value)
-                                    : current_facet.path
+      if facet.path_pattern?
+        p = "#{facet.path_pattern.call(value)}#{path}"
+        list.each do |current_facet|
+          p += current_facet.path if current_facet != facet
+        end
+      else
+        p = path
+        list.each do |current_facet|
+          next if current_facet.path_pattern?
+          p += current_facet == facet ? current_facet.path_for(value)
+                                      : current_facet.path
+        end
       end
       p
     end
@@ -31,7 +39,7 @@ module FacetedSearch
       unless @results
         scope = @model
         list.each do |facet|
-          scope = facet.add_scope(scope)
+          scope = facet.add_scope(scope) unless facet.ignore_scope?
         end
         @results = scope.distinct
       end
@@ -76,6 +84,10 @@ module FacetedSearch
       add_facet FullTree, value, options
     end
 
+    def filter_with_range(value, options = {})
+      add_facet Range, value, options
+    end
+
     def params_for(value)
       @params[value] if @params.has_key? value
     end

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

@@ -13,6 +13,26 @@ module FacetedSearch
       @options[:title] || name.to_s.humanize.titleize
     end
 
+    def searchable
+      @options[:searchable] || false
+    end
+
+    def path_pattern
+      @options[:path_pattern] || false
+    end
+
+    def path_pattern?
+      @options.has_key? :path_pattern
+    end
+
+    def ignore_scope?
+      @options[:ignore_scope] || false
+    end
+
+    def hide_in_selected?
+      @options[:hide_in_selected] || path_pattern?
+    end
+
     def kind
       self.class.to_s
     end

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

@@ -28,7 +28,7 @@ module FacetedSearch
     def values
       unless @values
         joined_table = facets.model_table_name.to_sym
-        @values = source.all.joins(joined_table).where(joined_table => { id: facets.model }).distinct
+        @values = source.all.joins(joined_table).where(joined_table => { id: facets.results }).distinct
       end
       @values
     end

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

@@ -0,0 +1,24 @@
+module FacetedSearch
+  class Facets::Range < Facets::Default
+    def min
+      @options[:min] || 0
+    end
+
+    def max
+      @options[:max] || 100
+    end
+
+    def step
+      @options[:step] || 1
+    end
+
+    def default_value
+      @options[:default_value] || min
+    end
+
+    def add_scope(scope)
+      return scope if params.blank?
+      scope.where("#{facets.model_table_name}.#{name}" => params)
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 module FacetedSearch
   class Facets::Text < Facets::Default
+    include ActiveRecord::Sanitization
 
     def placeholder
       @options[:placeholder]
@@ -7,7 +8,7 @@ module FacetedSearch
 
     def add_scope(scope)
       return scope if params.blank?
-      scope.where("#{facets.model_table_name}.#{name} ILIKE ?", "%#{params}%")
+      scope.where("#{facets.model_table_name}.#{name} ILIKE ?", "%#{self.class.sanitize_sql_like(params)}%")
     end
   end
 end

data/app/views/faceted_search/_facets.html.erb

@@ -6,7 +6,10 @@ reset ||= 'Reset'
 <% if facets.has_params? %>
   <ul class="faceted__facets-selected list-inline">
     <% facets.list.each do |facet| %>
-      <% partial = "#{facet.kind.underscore}/selected" %>
+      <%
+      next if facet.hide_in_selected?
+      partial = "#{facet.kind.underscore}/selected"
+      %>
       <%= render partial, facet: facet %>
     <% end %>
   </ul>
@@ -18,7 +21,7 @@ reset ||= 'Reset'
     <%= render partial, facet: facet, anchor: anchor %>
   <% end %>
   <li class="faceted__facet__reinit">
-    <a href="<%= facets.path %>">
+    <a href="<%= facets.path %>" rel="nofollow">
       <i class="fas fa-ban"></i>
       <%= reset %>
     </a>

data/app/views/faceted_search/_link.html.erb

@@ -0,0 +1,5 @@
+<% if searchable %>
+  <%= link_to display_value, path %>
+<% else %>
+  <%= link_to display_value, path, rel: 'nofollow' %>
+<% end %>

data/app/views/faceted_search/facets/_facet-selected.html.erb

@@ -1,6 +1,6 @@
 <li class=" faceted__facet-selected
             list-inline-item">
-  <%= link_to path, class: 'badge badge-light' do %>
+  <%= link_to path, class: 'badge badge-light', rel: 'nofollow' do %>
     <% unless title %>
       <span class="faceted__facet-selected__title d-none">
         <%= title %>

data/app/views/faceted_search/facets/checkboxes/_all.html.erb

@@ -14,9 +14,12 @@
                   onclick="window.location.href='<%= path %>'"
                   <%= 'checked' if selected %>
                   />
-          <%= link_to name, path %>
+          <%= render 'faceted_search/link',
+                      display_value: name,
+                      path: path,
+                      searchable: facet.searchable %>
         </li>
       <% end %>
     </ul>
   </li>
-<% end %>
+<% end %>

data/app/views/faceted_search/facets/date/_all.html.erb

@@ -4,9 +4,12 @@
     <ol class="faceted__facet__date list-unstyled">
       <% facet.values.each do |year| %>
         <li class="faceted__facet__date__value <%= 'faceted__facet__date__value--selected' if facet.value_selected?(year) %>">
-          <%= link_to year, facet.facets.path_for(facet, year) + anchor %>
+          <%= render 'faceted_search/link',
+                     display_value: year,
+                     path: facet.facets.path_for(facet, year) + anchor,
+                     searchable: facet.searchable %>
         </li>
       <% end %>
     </ol>
   </li>
-<% end %>
+<% end %>

data/app/views/faceted_search/facets/full_tree/_values.html.erb

@@ -1,11 +1,10 @@
 <% values.each do |value| %>
-  <%
-  display_value = facet.display_method.call(value)
-  identifier = value.send facet.find_by
-  path = facet.facets.path_for(facet, identifier)
-  %>
+  <% identifier = value.send facet.find_by %>
   <li class="faceted__facet__full_tree__value<%= '--selected' if facet.value_selected?(identifier) %> dd-item <%= 'dd-item--selected' if facet.value_selected?(identifier) %>">
-    <%= link_to display_value, path %>
+    <%= render 'faceted_search/link',
+                display_value: facet.display_method.call(value),
+                path: facet.facets.path_for(facet, identifier),
+                searchable: facet.searchable %>
     <% child_values = facet.values_with_parent(value.id) %>
     <% if child_values.any? %>
       <ol class="dd-list">

data/app/views/faceted_search/facets/list/_all.html.erb

@@ -8,9 +8,12 @@
         display_value = facet.display_method.call(value)
         %>
         <li class="faceted__facet__list__value <%= 'faceted__facet__list__value--selected' if facet.value_selected?(identifier) %>">
-          <%= link_to display_value, facet.facets.path_for(facet, identifier) + anchor %>
+          <%= render 'faceted_search/link',
+                     display_value: display_value,
+                     path: facet.facets.path_for(facet, identifier) + anchor,
+                     searchable: facet.searchable %>
         </li>
       <% end %>
     </ol>
   </li>
-<% end %>
+<% end %>

data/app/views/faceted_search/facets/primitive_list/_all.html.erb

@@ -12,7 +12,10 @@
                   onclick="window.location.href='<%= path %>'"
                   <%= 'checked' if selected %>
                   />
-          <%= link_to identifier, path %>
+          <%= render 'faceted_search/link',
+                     display_value: identifier,
+                     path: path,
+                     searchable: facet.searchable %>
         </li>
       <% end %>
     </ul>

data/app/views/faceted_search/facets/range/_all.html.erb

@@ -0,0 +1,25 @@
+<li>
+  <% unless facet.title.blank? %><b><%= facet.title %></b><% end %>
+  <%
+  value = params[:facets][facet.name] if params.dig(:facets, facet.name).present?
+  value ||= facet.default_value
+  %>
+  <form action="<%= anchor %>" class="faceted__facet__text form-inline">
+    <% facet.facets.list.each do |f| %>
+      <% next if f == facet || f.params.blank? || f.path_pattern? %>
+      <input  type="hidden"
+              name="facets[<%= f.name %>]"
+              value="<%= f.params %>" />
+    <% end %>
+    <input  type="range"
+            name="facets[<%= facet.name %>]"
+            min="<%= facet.min %>"
+            max="<%= facet.max %>"
+            step="<%= facet.step %>"
+            value="<%= value %>"
+            class="form-control-range" />
+    <input  type="submit"
+            class="btn btn-light"
+            value="OK" />
+  </form>
+</li>

data/app/views/faceted_search/facets/range/_selected.html.erb

@@ -0,0 +1,7 @@
+<% value = params[:facets][facet.name] if params[:facets] && params[:facets].has_key?(facet.name) %>
+<% unless value.blank? %>
+  <%= render 'faceted_search/facets/facet-selected',
+              title: facet.title,
+              value: value,
+              path: facet.facets.path_for(facet, nil) %>
+<% end %>

data/app/views/faceted_search/facets/text/_all.html.erb

@@ -3,8 +3,7 @@
   <% value = params[:facets][facet.name] if params[:facets] && params[:facets].has_key?(facet.name) %>
   <form action="<%= anchor %>" class="faceted__facet__text form-inline">
     <% facet.facets.list.each do |f| %>
-      <% next if f == facet %>
-      <% next if f.params.blank? %>
+      <% next if f == facet || f.params.blank? || f.path_pattern? %>
       <input  type="hidden"
               name="facets[<%= f.name %>]"
               value="<%= f.params %>" />

data/app/views/faceted_search/facets/tree/_all.html.erb

@@ -9,7 +9,7 @@
         path = facet.facets.path_for(facet, identifier)
         %>
         <div class="faceted__facet__tree__back">
-          <%= link_to path do %>
+          <%= link_to path, rel: 'nofollow' do %>
             <i class="fas fa-arrow-left"></i> <%= display_value %>
           <% end %>
         </div>
@@ -23,10 +23,13 @@
           path = facet.facets.path_for(facet, identifier)
           %>
           <li class="faceted__facet__tree__value">
-            <%= link_to display_value, path %>
+            <%= render 'faceted_search/link',
+                       display_value: display_value,
+                       path: path,
+                       searchable: facet.searchable %>
           </li>
         <% end %>
       </ol>
     </div>
   </li>
-<% end %>
+<% end %>

data/lib/faceted_search/version.rb

@@ -1,3 +1,3 @@
 module FacetedSearch
-  VERSION = '3.4.6'
+  VERSION = '3.5.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faceted_search
 version: !ruby/object:Gem::Version
-  version: 3.4.6
+  version: 3.5.4
 platform: ruby
 authors:
 - Arnaud Levy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2021-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -137,9 +137,11 @@ files:
 - app/models/faceted_search/facets/full_tree.rb
 - app/models/faceted_search/facets/list.rb
 - app/models/faceted_search/facets/primitive_list.rb
+- app/models/faceted_search/facets/range.rb
 - app/models/faceted_search/facets/text.rb
 - app/models/faceted_search/facets/tree.rb
 - app/views/faceted_search/_facets.html.erb
+- app/views/faceted_search/_link.html.erb
 - app/views/faceted_search/facets/_facet-selected.html.erb
 - app/views/faceted_search/facets/checkboxes/_all.html.erb
 - app/views/faceted_search/facets/checkboxes/_selected.html.erb
@@ -153,6 +155,8 @@ files:
 - app/views/faceted_search/facets/list/_selected.html.erb
 - app/views/faceted_search/facets/primitive_list/_all.html.erb
 - app/views/faceted_search/facets/primitive_list/_selected.html.erb
+- app/views/faceted_search/facets/range/_all.html.erb
+- app/views/faceted_search/facets/range/_selected.html.erb
 - app/views/faceted_search/facets/text/_all.html.erb
 - app/views/faceted_search/facets/text/_selected.html.erb
 - app/views/faceted_search/facets/tree/_all.html.erb