faceted_search 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f82d1b15fdbb630bd290e8d915b5dd109b7e07ad17561c959043a44a13af4ade
-  data.tar.gz: c958ae79ef81325ae652ebe54a0c9fdfebe7ebd0ce8b60a30188c0bb3de3a062
+  metadata.gz: 579f5857155cd830b339c6aa99c86ea05f12d50dd905782ad36798673cfe3df9
+  data.tar.gz: c4bf2c97ee9d1ce84fed8836929ad2ee15a1d12374890b9a87d4ac9d3d2a98f6
 SHA512:
-  metadata.gz: 91a8751b4523d08c0dff7112a05d5d87eebd6ed69c1c7ace85d438093d521c5421e860adeee41beeb931c0833143ced6a45f2f0f0fc16dcbbffdbdec861f4bc9
-  data.tar.gz: cd64b29320ff0a978e436a5df1b48f8f98319d512c3c9984756bc352d6f74d911b1ea2bbc48dbffc4bf17382eed3e95275dd1375b69f8ba54060e0a4364ce178
+  metadata.gz: b0a21b9eaba7960fd61785bba72752f966ef89a2a08f66351cdb88a375a7aa3f349f89ec1e8fd279d523b2b02d0932dccf2cbb93d9ed83625bf10acd3cbcff48
+  data.tar.gz: 71771e3c03cfba3c103729785e677cec5ba76653578cb9ed433c631e2030ab8fab76dc6cbcc92dffacb536537253f52a8db0add2e98ad8115c35ea4ddb4c3ad7

data/README.md

@@ -22,16 +22,11 @@ $ gem install faceted_search
 
 ## Getting started
 
-Add to your `app/assets/stylesheets/application.sass`
+Add Bootstrap and Font Awesome to your `app/assets/stylesheets/application.sass`
 ```
+@import 'bootstrap'
 @import 'font-awesome-sprockets'
 @import 'font-awesome'
-@import 'faceted_search'
-```
-
-And to your `app/assets/javascripts/application.js`
-```
-//= require faceted_search
 ```
 
 Create a model defining your facets:
@@ -40,16 +35,16 @@ Create a model defining your facets:
       def initialize(params)
         super
         @model = Item.all
-        search :title
-        filter :products, {
-            find_by: :title,
-            habtm: true
+        filter_with_text :title
+        filter_with_list :products, {
+          find_by: :title,
+          habtm: true
         }
-        filter :kinds, {
-            habtm: true
+        filter_with_list :kinds, {
+          habtm: true
         }
-        filter :categories, {
-            habtm: true
+        filter_with_tree :categories, {
+          habtm: true
         }
       end
     end

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

@@ -0,0 +1,48 @@
+module FacetedSearch
+  class Facets::DefaultList < Facets::Default
+
+    def display_method
+      @options[:display_method] ||= Proc.new { |object| object.to_s }
+    end
+
+    def find_by
+      @options[:find_by] || :id
+    end
+
+    def source
+      @options[:source] || name.to_s.singularize.titleize.constantize.send(:all)
+    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)
+    end
+
+    def value_selected?(value)
+      value.to_s.in? params_array
+    end
+
+    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
+
+    protected
+
+    def params_array
+      @params_array ||= @params.to_s.split(',')
+    end
+
+    def habtm?
+      @options[:habtm]
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module FacetedSearch
+  class Facets::List < Facets::DefaultList
+
+    # Show all values that have corresponding results.
+    # This is a regular SQL inner join.
+    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
+      end
+      @values
+    end
+  end
+end

data/app/models/faceted_search/facets/{search.rb → text.rb}

@@ -1,5 +1,5 @@
 module FacetedSearch
-  class Facets::Search < Facets::Default
+  class Facets::Text < Facets::Default
 
     def placeholder
       @options[:placeholder]

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

@@ -0,0 +1,25 @@
+module FacetedSearch
+  class Facets::Tree < Facets::DefaultList
+
+    def selected_objects
+      source.where(find_by => params_array)
+    end
+
+    def selected_object
+      selected_objects.last
+    end
+
+    # All values, not filtered
+    # Otherwise, we would need to search all the children to do a good filtering
+    def values
+      root? ? source.root
+            : selected_object.children
+    end
+
+    protected
+
+    def root?
+      params_array.empty?
+    end
+  end
+end

data/app/models/faceted_search/facets.rb

@@ -20,7 +20,7 @@ module FacetedSearch
 
     def path_for(facet, value)
       p = path
-      @list.each do |current_facet|
+      list.each do |current_facet|
         p += current_facet == facet ? current_facet.path_for(value)
                                     : current_facet.path
       end
@@ -41,20 +41,24 @@ module FacetedSearch
 
     protected
 
-    def search(value, options = {})
-      add(Search.new(value, params_for(value), self, options))
+    def filter_with_text(value, options = {})
+      add_facet Text, value, options
     end
 
-    def filter(value, options = {})
-      add(Filter.new(value, params_for(value), self, options))
+    def filter_with_list(value, options = {})
+      add_facet List, value, options
+    end
+
+    def filter_with_tree(value, options = {})
+      add_facet Tree, value, options
     end
 
     def params_for(value)
       @params[value] if @params.has_key? value
     end
 
-    def add(facet)
-      @list << facet
+    def add_facet(kind, value, options)
+      @list << kind.new(value, params_for(value), self, options)
     end
   end
 end

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

@@ -10,5 +10,5 @@ anchor ||= ''
       <%= render facet.kind.underscore, facet: facet, anchor: anchor %>
     </li>
   <% end %>
-  <li class="faceted__facet__reinit"><a href="<%= facets.path%>"><i class="fas fa-backspace"></i></a></li>
+  <li class="faceted__facet__reinit"><a href="<%= facets.path%>"><i class="fas fa-ban"></i></a></li>
 </ul>

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

@@ -0,0 +1,11 @@
+<ol class="faceted__facet__list list-unstyled">
+  <% facet.values.each do |value| %>
+    <%
+    identifier = value.send facet.find_by
+    display_value = facet.display_method.call(value)
+    %>
+    <li class="faceted__facet__list__value<%= '--selected' if facet.value_selected?(identifier) %>">
+      <%= link_to display_value, facet.facets.path_for(facet, identifier) + anchor %>
+    </li>
+  <% end %>
+</ol>

data/app/views/faceted_search/facets/{_search.html.erb → _text.html.erb}

@@ -1,5 +1,5 @@
 <% value = params[:facets][facet.name] if params[:facets] && params[:facets].has_key?(facet.name) %>
-<form action="<%= anchor %>" class="faceted__facet__search form-inline">
+<form action="<%= anchor %>" class="faceted__facet__text form-inline">
   <% facet.facets.list.each do |f| %>
     <% next if f == facet %>
     <% next if f.params.blank? %>

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

@@ -0,0 +1,26 @@
+<div class="faceted__facet__tree<% if facet.selected_object %> faceted__facet__tree--selected<% end %>">
+  <% if facet.selected_object %>
+    <%
+    display_value = facet.display_method.call(facet.selected_object)
+    identifier = facet.selected_object.send facet.find_by
+    path = facet.facets.path_for(facet, identifier)
+    %>
+    <div class="faceted__facet__tree__back">
+      <%= link_to path do %>
+        <i class="fas fa-arrow-left"></i> <%= display_value %>
+      <% end %>
+    </div>
+  <% end %>
+
+  <ol class="faceted__facet__tree__values list-unstyled ">
+  <% facet.values.each do |value| %>
+    <%
+    display_value = facet.display_method.call(value)
+    identifier = value.send facet.find_by
+    path = facet.facets.path_for(facet, identifier)
+    %>
+    <li class="faceted__facet__tree__value">
+      <%= link_to display_value, path %>
+    </li>
+  <% end %>
+</div>

data/lib/faceted_search/version.rb

@@ -1,3 +1,3 @@
 module FacetedSearch
-  VERSION = '2.2.0'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faceted_search
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Arnaud Levy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-28 00:00:00.000000000 Z
+date: 2019-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -40,20 +40,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: nestable-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -83,7 +69,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simple_form
+  name: bootstrap
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -97,7 +83,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bootstrap
+  name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -111,7 +97,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: kaminari
+  name: font-awesome-sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,17 +122,16 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/javascripts/faceted_search.js
-- app/assets/javascripts/faceted_search/Tree.js
-- app/assets/stylesheets/faceted_search.sass
-- app/assets/stylesheets/faceted_search/nestable.sass
 - app/models/faceted_search/facets.rb
 - app/models/faceted_search/facets/default.rb
-- app/models/faceted_search/facets/filter.rb
-- app/models/faceted_search/facets/search.rb
+- app/models/faceted_search/facets/default_list.rb
+- app/models/faceted_search/facets/list.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/facets/_filter.html.erb
-- app/views/faceted_search/facets/_search.html.erb
+- app/views/faceted_search/facets/_list.html.erb
+- app/views/faceted_search/facets/_text.html.erb
+- app/views/faceted_search/facets/_tree.html.erb
 - lib/faceted_search.rb
 - lib/faceted_search/engine.rb
 - lib/faceted_search/railtie.rb
@@ -171,7 +156,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

data/app/assets/javascripts/faceted_search/Tree.js

@@ -1,139 +0,0 @@
-/*global window, document, $ */
-
-window.facetedSearch = window.facetedSearch || {};
-
-window.facetedSearch.Tree = function Tree(wrapper) {
-    "use strict";
-    this.wrapper = wrapper;
-    this.data = [];
-};
-
-window.facetedSearch.Tree.prototype.unflatten = function (list) {
-    "use strict";
-    var map = {},
-        node,
-        roots = [],
-        i;
-
-    for (i = 0; i < list.length; i += 1) {
-        map[list[i].id] = i;
-        list[i].children = [];
-    }
-
-    for (i = 0; i < list.length; i += 1) {
-        node = list[i];
-        if (node.parentId !== 0) {
-            list[map[node.parentId]].children.push(node);
-        } else {
-            roots.push(node);
-        }
-    }
-
-    return roots;
-};
-
-window.facetedSearch.Tree.prototype.generateItem = function (item) {
-    "use strict";
-
-    var liNode = document.createElement('li');
-
-    liNode.className = item.selected ? "dd-item dd-item--selected"
-                                     : "dd-item";
-
-    var iconNode = null;
-    iconNode = document.createElement('i');
-    iconNode.className = "back-link fas fa-arrow-left";
-    var titleNode = document.createTextNode(item.title);
-
-    var itemContent = document.createDocumentFragment();
-    if (item.back === "true") {
-        itemContent.appendChild(iconNode);
-    }
-    itemContent.appendChild(titleNode);
-
-    if (item.url !== "") {
-        var aNode = document.createElement('a');
-        aNode.setAttribute("href", item.url);
-        aNode.appendChild(itemContent);
-        liNode.appendChild(aNode);
-    } else {
-        liNode.appendChild(itemContent);
-    }
-
-
-    if (item.children.length > 0) {
-        var olNode = this.generateList(item.children);
-        liNode.appendChild(olNode);
-    }
-
-
-    return liNode;
-};
-
-window.facetedSearch.Tree.prototype.generateList = function (array) {
-    "use strict";
-
-    var olNode = document.createElement('ol'),
-        liNode,
-        i;
-
-    olNode.className = "faceted__facet__filter--tree__level dd-list";
-
-    for (i = 0; i < array.length; i += 1) {
-        liNode = this.generateItem(array[i]);
-        olNode.appendChild(liNode);
-    }
-
-    return olNode;
-};
-
-window.facetedSearch.Tree.prototype.initDOM = function () {
-    "use strict";
-
-    var listElements = Array.prototype.slice.call(this.wrapper.querySelectorAll('li'));
-    var listData = listElements.map(function (elt) {
-        return {
-            id: parseInt(elt.getAttribute('data-id'), 10),
-            parentId: parseInt(elt.getAttribute('data-parent'), 10),
-            selected: elt.getAttribute('data-selected') === "true",
-            resultsCount: parseInt(elt.getAttribute('data-count'), 10),
-            url: elt.getAttribute('data-url'),
-            back: elt.getAttribute('data-back'),
-            title: elt.textContent.trim()
-        };
-    });
-
-    this.data = this.unflatten(listData);
-    var treeNode = this.generateList(this.data);
-
-    var rootElt = document.createElement('div');
-    rootElt.className = 'dd';
-    rootElt.appendChild(treeNode);
-
-    while (this.wrapper.firstChild) {
-        this.wrapper.removeChild(this.wrapper.firstChild);
-    }
-    this.wrapper.appendChild(rootElt);
-};
-
-window.facetedSearch.Tree.prototype.initNestable = function () {
-    "use strict";
-
-    $('.dd', this.wrapper).nestable({
-        expandBtnHTML: '',
-        collapseBtnHTML: ''
-    }).data("nestable");
-};
-
-window.addEventListener('DOMContentLoaded', function () {
-    "use strict";
-    var facetedTreeElts = document.querySelectorAll('.faceted__facet__filter--tree'),
-        facetedTree,
-        i;
-
-    for (i = 0; i < facetedTreeElts.length; i += 1) {
-        facetedTree = new window.facetedSearch.Tree(facetedTreeElts[i]);
-        facetedTree.initDOM();
-        facetedTree.initNestable();
-    }
-});

data/app/assets/javascripts/faceted_search.js

@@ -1,7 +0,0 @@
-//= require nestable-rails
-//= require_self
-//= require_tree ./faceted_search
-
-/*global window */
-
-window.facetedSearch = {};

data/app/assets/stylesheets/faceted_search/nestable.sass

@@ -1,64 +0,0 @@
-.dd, .dd-list
-    position: relative
-    display: block
-    margin: 0
-    padding: 0
-    list-style: none
-    font-size: 13px
-    line-height: 20px
-
-.dd-list .dd-list
-        padding-left: 26px
-
-.dd-collapsed .dd-list
-    display: none
-
-.dd-item
-    display: block
-    position: relative
-    margin: 3px 0 0
-    padding: 0
-    min-height: 20px
-    font-size: 13px
-    line-height: 20px
-
-
-    a
-        color: #8c8c8c
-        &:hover
-            color: #000
-
-    i.back-link
-        margin-right: 5px
-
-    &--selected > a
-        color: #000
-
-    & > button
-        display: block
-        position: relative
-        cursor: pointer
-        float: left
-        width: 26px
-        height: 20px
-        margin: 0
-        padding: 0
-        text-indent: 100%
-        white-space: nowrap
-        overflow: hidden
-        border: 0
-        background: transparent
-        font-size: 16px
-        line-height: 1
-        text-align: center
-        font-weight: bold
-        .fas
-            position: absolute
-            top: 2px
-            left: -14px
-        &.dd-collapse-btn .fas
-            left: -16px
-
-#nestable-menu
-  padding: 0
-  margin: 10px 0 20px 0

data/app/assets/stylesheets/faceted_search.sass

@@ -1 +0,0 @@
-@import "faceted_search/*"

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

@@ -1,95 +0,0 @@
-module FacetedSearch
-  class Facets::Filter < Facets::Default
-
-    def tree?
-      @options[:tree]
-    end
-
-    def display_method
-      @options[:display_method] ||= Proc.new { |object| object.to_s }
-    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?
-
-      identifiers = params_array.dup
-      identifiers << selected_objects.first.descendents if tree?
-      identifiers.flatten!
-
-      habtm?  ? scope.joins(name).where(name => { find_by => identifiers })
-              : scope.where(name => identifiers)
-    end
-
-    def find_by
-      @options[:find_by] || :id
-    end
-
-    def selected_objects
-      values.where(find_by => params_array)
-    end
-
-    # Show all values that have corresponding results.
-    # This is a regular SQL inner join.
-    def values
-      @values ||= get_values
-    end
-
-    def tree_values
-      return values.select { |obj| obj.root? } if params_array.empty?
-
-      selected_object = selected_objects.first
-      return [] if selected_object.nil?
-
-      array = []
-      array << values.find   { |obj| obj.id == selected_object.parent_id } if selected_object.has_parent?   # parent
-      array << values.select { |obj| obj.parent_id == selected_object.parent_id }                           # selected & siblings
-      array << values.select { |obj| obj.parent_id == selected_object.id } if selected_object.has_children? # selected object's children
-      array.flatten.compact
-    end
-
-    def value_selected?(value)
-      value.to_s.in? params_array
-    end
-
-    def path_for(value)
-      value = value.to_s
-      return path_for_tree(value) if tree?
-
-      custom_params = params_array.dup
-      value_selected?(value)  ? custom_params.delete(value)
-                              : custom_params.push(value)
-      path(custom_params.join(','))
-    end
-
-    def source
-      @options[:source] || name.to_s.singularize.titleize.constantize.send(:all)
-    end
-
-    def has_params?
-      params_array.any?
-    end
-
-    protected
-
-    def get_values
-      joined_table = facets.model_table_name.to_sym
-      source.all.joins(joined_table).where(joined_table => { id: facets.model }).distinct
-    end
-
-    def path_for_tree(value)
-      value_selected?(value) ? path('')
-      : path(value)
-    end
-
-    def params_array
-      @params_array ||= @params.to_s.split(',')
-    end
-
-    def habtm?
-      @options[:habtm]
-    end
-  end
-end

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

@@ -1,45 +0,0 @@
-<% if facet.tree? %>
-  <div class="faceted__facet__filter--tree">
-    <div class="dd">
-      <ol class="faceted__facet__filter--tree__level dd-list">
-        <% facet.tree_values.each_with_index do |object, index| %>
-          <%
-          identifier = object.send facet.find_by
-          selected = facet.value_selected?(identifier)
-          facet_url = selected ? '' : facet.facets.path_for(facet, identifier)
-          back = index == 0 && !selected && facet.has_params?
-          display_value = facet.display_method.call(object)
-          parent_id = object.parent_id.nil? ? 0 : object.parent_id
-          %>
-          <% if index == 0 && selected %>
-          <li data-parent="0"
-              data-id="-1"
-              data-back="true"
-              data-selected="false"
-              data-url="<%= facet.facets.path_for(facet, '') %>">
-          </li>
-          <% end %>
-          <li data-parent="<%= back ? 0 : parent_id %>"
-              data-id="<%= object.id %>"
-              data-back="<%= back %>"
-              data-selected="<%= selected %>"
-              data-url="<%= facet_url %>">
-            <%= display_value %>
-          </li>
-        <% end %>
-      </ol>
-    </div>
-  </div>
-<% else %>
-  <ul class="faceted__facet__filter list-unstyled">
-    <% facet.values.each do |value| %>
-      <%
-      identifier = value.send facet.find_by
-      display_value = facet.display_method.call(value)
-      %>
-      <li class="faceted__facet__filter__value<%= '--selected' if facet.value_selected?(identifier) %>">
-        <%= link_to display_value, facet.facets.path_for(facet, identifier) + anchor %>
-      </li>
-    <% end %>
-  </ul>
-<% end %>