forty_facets 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ffffd6ffbdfc630f50719b17036d4442aa08a900
+  data.tar.gz: d2e5c895e6c2ad6f422bca70935a0569d98801f3
+SHA512:
+  metadata.gz: 1b863db6fb54e3d392cf23e220bd2513f581a077fee1ad448780d390e54e8f9f443719757f01e136b73a76ee4d1d07c0b10f5fa6c1e868af32a14fba81a17446
+  data.tar.gz: 09b7f942ae6584790fd6a578af19e2a2046d6bc7dde1753bda80dbc33e40403e5740eaa7dc6587d0c17addb862d7b06dc335a6487f21ca78d2c4bd80859e0d41

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in forty_facets.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Axel Tetzlaff
+
+MIT License
+
+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,97 @@
+# FortyFacets
+
+FortyFacets lets you easily build explorative search interfaces based on fields of your ActiveRecord models.
+
+![demo](demo.gif)
+
+It offers a simple API to create an interactive UI to browse your data by iteratively adding
+filter values.
+
+The search is purely done via SQL queries, which are automatically generated via the AR-mappings.
+
+Narrowing down the search result is done purely via `GET` requests. This way all steps are bookmarkable. This way the search natively works together with turbolinks as well.
+
+There is no JavaScript involved. The collection returned is a normal ActiveRecord collection - this way it works seamlessly together with other GEMs like will_paginate
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'forty_facets'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install forty_facets
+
+## Usage
+
+You can clone a working example at https://github.com/fortytools/forty_facets_demo
+
+If you have Movies with a textual title, categotized by genre, studio and year ..
+
+    class Movie < ActiveRecord::Base
+      belongs_to :year
+      belongs_to :genre
+      belongs_to :studio
+    end
+
+You can then declare the structure of your search like so:
+
+```ruby
+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
+    facet :genre, name: 'Genre' # generate a filter with all values of 'genre' occuring in the result
+    facet :year, name: 'Releaseyear', order: :year # additionally oder values in the year field
+    facet :studio, name: 'Studio', order: :name
+  end
+
+  def index
+    @search = MovieSearch.new(params) # this initializes your search object from the request params
+    @movies = @search.result.paginate(page: params[:page], per_page: 5) # optionally paginate through your results
+  end
+```
+
+In your view you can iterate the result like any other ActiveRecord collection
+
+```haml
+%table.table.table-condensed
+  %tbody
+    - @movies.each do |movie|
+      %tr
+        %td
+          %strong=movie.title
+```
+
+Use the search object to display further narrowing options to the user
+
+```haml
+- filter = @search.filter(:genre)
+.col-md-4
+  .filter
+    .filter-title= filter.name
+    .filter-values
+      %ul.selected
+        - filter.selected.each do |genre|
+          %li= link_to genre.name, filter.remove(genre).path
+      %ul.selectable
+        - filter.facet.reject(&:selected).each do |facet_value|
+          - genre = facet_value.genre
+          %li
+            = link_to genre.name, filter.add(genre).path
+            %span.count= "(#{facet_value.count})"
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/forty_facets/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/forty_facets.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'forty_facets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "forty_facets"
+  spec.version       = FortyFacets::VERSION
+  spec.authors       = ["Axel Tetzlaff"]
+  spec.email         = ["axel.tetzlaff@fortytools.com"]
+  spec.summary       = %q{Library for building facet searches for active_record models}
+  spec.description   = %q{FortyFacets lets you easily build explorative search interfaces based on fields of your active_record models.}
+  spec.homepage      = "https://github.com/fortytools/forty_facets"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/forty_facets/facet_search.rb

@@ -0,0 +1,210 @@
+module FortyFacets
+  class FacetSearch
+    attr_reader :filters
+
+    FieldDefinition = Struct.new(:search, :model_field, :options) do
+      def request_param
+        model_field
+      end
+    end
+
+    Filter = Struct.new(:field_definition, :search_instance, :value) do
+      def name
+        field_definition.options[:name] || field_definition.model_field
+      end
+
+      def empty?
+        value.nil? || value == '' || value == []
+      end
+
+      # generate a search with this filter removed
+      def without
+        search = search_instance
+        return search if empty?
+        new_params = search_instance.params
+        new_params.delete(field_definition.request_param)
+        search_instance.class.new_unwrapped(new_params)
+      end
+    end
+
+    class TextField < FieldDefinition
+      class TextFilter < Filter
+        def build_scope
+          return Proc.new { |base| base } if empty?
+          like_value = expression_value(value)
+          Proc.new {  |base| base.where("#{field_definition.model_field} like ?", like_value ) }
+        end
+
+        def expression_value(term)
+          if field_definition.options[:prefix]
+           "#{term}%"
+          else
+           "%#{term}%"
+          end
+        end
+
+        def display_value
+          value
+        end
+      end
+
+      def build_filter(search_instance, value)
+        TextFilter.new(self, search_instance, value)
+      end
+    end
+
+    class FacetField < FieldDefinition
+      FacetValue = Struct.new(:entity, :count, :selected)
+
+      class FacetFilter < Filter
+        def association
+          field_definition.search.root_class.reflect_on_association(field_definition.model_field)
+        end
+
+        # class objects in this filter
+        def klass
+          association.klass
+        end
+
+        def values
+          @values ||= Array.wrap(value).sort.uniq
+        end
+
+        def selected
+          @selected ||= klass.find(values)
+        end
+
+        def build_scope
+          return Proc.new { |base| base } if empty?
+          Proc.new {  |base| base.where(association.association_foreign_key => values) }
+        end
+
+        def facet
+          my_column = association.association_foreign_key
+          counts = without.result.select("#{my_column} as foreign_id, count(#{my_column}) as occurrences").group(my_column)
+          entities_by_id = klass.find(counts.map(&:foreign_id)).group_by(&:id)
+          facet = counts.inject([]) do |sum, count|
+            facet_entity = entities_by_id[count.foreign_id].first
+            is_selected = selected.include?(facet_entity)
+            sum << FacetValue.new(facet_entity, count.occurrences, is_selected)
+          end
+
+          order_accessor = field_definition.options[:order]
+          if order_accessor
+            facet.sort_by!{|facet_value| facet_value.entity.send(order_accessor) }
+          else
+            facet.sort_by!{|facet_value| -facet_value.count }
+          end
+          facet
+
+        end
+
+        def without
+          new_params = search_instance.params || {}
+          new_params.delete(field_definition.request_param)
+          search_instance.class.new_unwrapped(new_params)
+        end
+
+        def remove(value)
+          new_params = search_instance.params || {}
+          old_values = new_params[field_definition.request_param]
+          old_values.delete(value.id.to_s)
+          new_params.delete(field_definition.request_param) if old_values.empty?
+          search_instance.class.new_unwrapped(new_params)
+        end
+
+        def add(entity)
+          new_params = search_instance.params || {}
+          old_values = new_params[field_definition.request_param] ||= []
+          old_values << entity.id.to_s
+          search_instance.class.new_unwrapped(new_params)
+        end
+
+      end
+
+      def build_filter(search_instance, param_value)
+        FacetFilter.new(self, search_instance, param_value)
+      end
+
+    end
+
+    class << self
+      def model(model_name)
+        @model_name = model_name
+      end
+
+      def text(model_field, opts = {})
+        definitions << TextField.new(self, model_field, opts)
+      end
+
+      def facet(model_field, opts = {})
+        definitions << FacetField.new(self, model_field, opts)
+      end
+
+      def definitions
+        @definitions ||= []
+      end
+
+      def root_class
+        raise 'No model given' unless @model_name
+        Kernel.const_get(@model_name)
+      end
+
+      def root_scope
+        root_class.all
+      end
+
+      def request_param(name)
+        @request_param_name = name
+      end
+
+      def request_param_name
+        @request_param_name ||= 'search'
+      end
+    end
+
+    def initialize(request_params)
+      params = if request_params && request_params[self.class.request_param_name]
+                 request_params[self.class.request_param_name]
+               else
+                 {}
+               end
+      @filters = self.class.definitions.inject([]) do |sum, definition|
+        sum << definition.build_filter(self, params[definition.request_param])
+      end
+    end
+
+    def self.new_unwrapped(params)
+      self.new(request_param_name => params)
+    end
+
+    def filter(filter_name)
+      @filters.find { |f| f.field_definition.model_field == filter_name }
+    end
+
+    def result
+      @filters.inject(self.class.root_scope) do |previous, filter|
+        filter.build_scope.call(previous)
+      end
+    end
+
+    def wrapped_params
+      { self.class.request_param_name => params }
+    end
+
+    def params
+      @filters.inject({}) do |sum, filter|
+        sum[filter.field_definition.request_param] = filter.value.dup unless filter.empty?
+        sum
+      end
+    end
+
+    def path
+      unfiltered? ? '?' : '?' + wrapped_params.to_param
+    end
+
+    def unfiltered?
+      @filters.reject(&:empty?).empty?
+    end
+  end
+end

data/lib/forty_facets/version.rb

@@ -0,0 +1,3 @@
+module FortyFacets
+  VERSION = "0.0.1"
+end

data/lib/forty_facets.rb

@@ -0,0 +1,6 @@
+require "forty_facets/version"
+
+module FortyFacets
+end
+
+require "forty_facets/facet_search"

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: forty_facets
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Axel Tetzlaff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: FortyFacets lets you easily build explorative search interfaces based
+  on fields of your active_record models.
+email:
+- axel.tetzlaff@fortytools.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- demo.gif
+- forty_facets.gemspec
+- lib/forty_facets.rb
+- lib/forty_facets/facet_search.rb
+- lib/forty_facets/version.rb
+homepage: https://github.com/fortytools/forty_facets
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Library for building facet searches for active_record models
+test_files: []