faceted_search 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ce3ce9087daf197f5f45dd9a520a4bfcdd462c200ecc5d7ed22d1c4e38be7e5
+  data.tar.gz: c8ce82304faa681237b3d7d8233550ef633c8140dceca5d457c9e2a784b1a864
+SHA512:
+  metadata.gz: 13065dc90a9ce7827fb938b824a6d724192ac43496cd76ef106534876cdb505476b0ccc02faeb49a65e0fb81e9d85488a26e01e5be3c8346fecf2dff305c8d83
+  data.tar.gz: ff8498afd99bdfa14aeecab05a427642e0d35ad408c6dbbf09ecaa3df40beb5fc49fde29109369f62e86b70b697365c514d10d6ea054f4d1fc5353e63cac2f78

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Arnaud Levy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# FacetedSearch
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faceted_search'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install faceted_search
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FacetedSearch'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/models/faceted_search/facets.rb

@@ -0,0 +1,68 @@
+module FacetedSearch
+  class Facets
+    attr_accessor :list
+
+    def initialize(params)
+      @params = params.nil? ? {} 
+                            : params.to_unsafe_hash
+      @list = []
+      define
+    end
+
+    def path
+      '?facets'
+    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
+      end
+      p
+    end
+
+    def results
+      scope = @model
+      list.each do |facet|
+        scope = facet.add_scope(scope)
+      end
+      scope
+    end
+
+    def model_table_name
+      @model.table_name
+    end
+
+    protected
+
+    def define
+      # Override
+    end
+
+    def set_model(model)
+      @model = model
+    end
+
+    def search(value)
+      add(Search.new( name: value,
+                      params: params_for(value),
+                      facets: self))
+    end
+
+    def filter(value, find_by: :id)
+      add(Filter.new( name: value,
+                      params: params_for(value),
+                      facets: self,
+                      find_by: find_by))
+    end
+
+    def params_for(value)
+      @params[value] if @params.has_key? value
+    end
+
+    def add(facet)
+      @list << facet
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module FacetedSearch
+  class Facets::Default
+    attr_reader :name, :params, :facets, :find_by
+
+    def initialize(name:, params:, facets:, find_by: nil)
+      @name = name
+      @params = params
+      @facets = facets
+      @find_by = find_by
+    end
+
+    def title
+      name.to_s.humanize.titleize
+    end
+
+    def kind
+      self.class.to_s
+    end
+
+    def path_for(value)
+      "&facets[#{name}]=#{value}"
+    end
+
+    def add_scope(scope)
+      # Override
+      scope
+    end
+
+    def path(custom_params = @params)
+      return '' if custom_params.blank?
+      "&facets[#{@name}]=#{custom_params}"
+    end
+
+    def to_s
+      "#{title}"
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module FacetedSearch
+  class Facets::Filter < Facets::Default
+    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(','))
+    end
+
+    def selected?(value)
+      value.to_s.in? params_array
+    end
+
+    def params_array
+      @params_array ||= @params.to_s.split(',')
+    end
+
+    def add_scope(scope)
+      return scope if params_array.blank?
+      scope.joins(name).where(name => { find_by => params_array })
+    end
+
+    def values
+      source.all
+    end
+
+    def source
+      @name.to_s.singularize.titleize.constantize
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module FacetedSearch
+  class Facets::Search < Facets::Default
+    def add_scope(scope)
+      return scope if @params.blank?
+      scope.where("#{@facets.model_table_name}.#{name} ILIKE ?", "%#{@params}%")
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+<ul class="list-unstyled">
+  <% @facets.list.each do |facet| %>
+    <li class="mb-3">
+      <b><%= facet.title %></b>
+      <%= render facet.kind.underscore, facet: facet %>
+    </li>
+  <% end %>
+</ul>

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

@@ -0,0 +1,13 @@
+<ul class="list-unstyled">
+  <% facet.values.each do |value| %>
+    <%
+    identifier = value.send facet.find_by
+    selected = facet.selected? identifier
+    %>
+    <li>
+      <% if selected %><b><% end %>
+      <%= link_to value, @facets.path_for(facet, identifier) %>
+      <% if selected %></b><% end %>
+    </li>
+  <% end %>
+</ul>

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

@@ -0,0 +1,17 @@
+<% value = params[:facets][facet.name] if params[:facets] && params[:facets].has_key?(facet.name) %>
+<form action="" class="form-inline"">
+  <% facet.facets.list.each do |f| %>
+    <% next if f == facet %>
+    <% next if f.params.blank? %>
+    <input  type="hidden"
+            name="facets[<%= f.name %>]"
+            value="<%= f.params %>" />
+  <% end %>
+  <input  type="search"
+          name="facets[<%= facet.name %>]"
+          value="<%= value %>"
+          class="form-control" />
+  <input  type="submit"
+          class="btn btn-light"
+          value="OK" />
+</form>

data/lib/faceted_search.rb

@@ -0,0 +1,7 @@
+require "faceted_search/railtie"
+
+module FacetedSearch
+  module Rails
+    require "faceted_search/engine"
+  end
+end

data/lib/faceted_search/engine.rb

@@ -0,0 +1,2 @@
+class FacetedSearch::Rails::Engine < ::Rails::Engine
+end

data/lib/faceted_search/railtie.rb

@@ -0,0 +1,4 @@
+module FacetedSearch
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/faceted_search/version.rb

@@ -0,0 +1,3 @@
+module FacetedSearch
+  VERSION = '1.0.0'
+end

data/lib/tasks/faceted_search_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :faceted_search do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: faceted_search
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Arnaud Levy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bootstrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: All you need to create a faceted search, as simply as possible
+email:
+- alevy@lespoupees.paris
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- 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/views/faceted_search/_facets.html.erb
+- app/views/faceted_search/facets/_filter.html.erb
+- app/views/faceted_search/facets/_search.html.erb
+- lib/faceted_search.rb
+- lib/faceted_search/engine.rb
+- lib/faceted_search/railtie.rb
+- lib/faceted_search/version.rb
+- lib/tasks/faceted_search_tasks.rake
+homepage: http://github.com/lespoupeesrusses/faceted_search
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Faceted search with Active Record
+test_files: []