forty_facets 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83edd5ef19658c58ba68e8a0e45a01f84e03703f
-  data.tar.gz: 0134b19f051971d1cdba2aa1009517a1b61e60b3
+  metadata.gz: f4d7a0229978d1d9133b0082e3924554cd5a0cbf
+  data.tar.gz: b054dd26585014ffe9aa8a7851e9d30c4e43d130
 SHA512:
-  metadata.gz: 342c89c8336bfdc51ccbc487ccd30d1eaa4de7caf0c2617d6d6da86291326bfd9d41c9a3dae0f0e4cee46988a16084f633b99bdab04428d79b5e6a2e77303dfe
-  data.tar.gz: 74d86c743767e2a2f76a3d442e3ea60c3985f385ba6c91dd8e5a15fdefa5535381ebb3dd482dc46addbc66011e381f0e3aaff145691f8b17f0031129fc18fcaa
+  metadata.gz: 4936450a29cb55d55562e94894db107defda556f29dd3690d3421f893f814a416f76dafeb84d09148375bf405e613f1ec76d104ed248b18bc0aa647f91ea4a56
+  data.tar.gz: f331f6c08b3aab3e1c51e633ed628633dea49ffdfa839dc777e79dc818a7dda41b9cc0f8ddc8a3daef6932705c844bfc3e9b9be8f9603a0d8194a6753eb64a2a

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea
+

data/Gemfile

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

data/README.md

@@ -8,7 +8,8 @@ FortyFacets lets you easily build explorative search interfaces based on fields
 
 ![demo](demo.gif)
 
-Try a [working demo](http://forty-facets-demo.herokuapp.com/ "Testinstallation on heroku")!
+See it implemented in a [example rails application](https://github.com/fortytools/forty_facets_demo) or
+try a [working demo](http://forty-facets-demo.herokuapp.com/ "Testinstallation on heroku")!
 
 It offers a simple API to create an interactive UI to browse your data by iteratively adding
 filter values.
@@ -55,7 +56,7 @@ class HomeController < ApplicationController
     text :title   # filter by a generic string entered by the user
     range :price, name: 'Price' # filter by ranges for decimal fields
     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 :year, name: 'Releaseyear', order: :year # additionally order values in the year field
     facet :studio, name: 'Studio', order: :name
 
     orders 'Title' => :title,

data/lib/forty_facets.rb

@@ -7,7 +7,8 @@ require "forty_facets/order_definition"
 require "forty_facets/order"
 require "forty_facets/filter"
 require "forty_facets/filter_definition"
-require "forty_facets/filter/belongs_to"
+require "forty_facets/filter/belongs_to_filter_definition"
 require "forty_facets/filter/range_filter_definition"
 require "forty_facets/filter/text_filter_definition"
+require "forty_facets/filter/attribute_filter_definition"
 require "forty_facets/facet_search"

data/lib/forty_facets/facet_search.rb

@@ -28,11 +28,15 @@ module FortyFacets
       end
 
       def range(model_field, opts = {})
-        definitions << RangeFilterDefintion.new(self, model_field, opts)
+        definitions << RangeFilterDefinition.new(self, model_field, opts)
       end
 
       def facet(model_field, opts = {})
-        definitions << BelongsToFilter.new(self, model_field, opts)
+        definitions << BelongsToFilterDefinition.new(self, model_field, opts)
+      end
+
+      def facet_attr(model_field, opts = {})
+        definitions << AttributeFilterDefinition.new(self, model_field, opts)
       end
 
       def orders(name_and_order_options)

data/lib/forty_facets/filter.rb

@@ -7,6 +7,10 @@ module FortyFacets
       filter_definition.options[:name] || filter_definition.model_field
     end
 
+    def values
+      @values ||= Array.wrap(value).sort.uniq
+    end
+
     def empty?
       value.nil? || value == '' || value == []
     end
@@ -15,7 +19,7 @@ module FortyFacets
     def without
       search = search_instance
       return search if empty?
-      new_params = search_instance.params
+      new_params = search_instance.params || {}
       new_params.delete(filter_definition.request_param)
       search_instance.class.new_unwrapped(new_params)
     end

data/lib/forty_facets/filter/attribute_filter_definition.rb

@@ -0,0 +1,44 @@
+module FortyFacets
+  class AttributeFilterDefinition < FilterDefinition
+    class AttributeFilter < Filter
+      def selected
+        entity = search_instance.class.root_class
+        column = entity.columns_hash[filter_definition.model_field.to_s]
+        values.map{|v| column.type_cast(v)}
+      end
+
+      def build_scope
+        return Proc.new { |base| base } if empty?
+        Proc.new {  |base| base.where(filter_definition.model_field => value) }
+      end
+
+      def facet
+        my_column = filter_definition.model_field
+        counts = without.result.reorder('').select("#{my_column} AS facet_value, count(#{my_column}) as occurrences").group(my_column)
+        counts.map do |c|
+          is_selected = selected.include?(c.facet_value)
+          FacetValue.new(c.facet_value, c.occurrences, is_selected)
+        end
+      end
+
+      def remove(value)
+        new_params = search_instance.params || {}
+        old_values = new_params[filter_definition.request_param]
+        old_values.delete(value.to_s)
+        new_params.delete(filter_definition.request_param) if old_values.empty?
+        search_instance.class.new_unwrapped(new_params)
+      end
+
+      def add(value)
+        new_params = search_instance.params || {}
+        old_values = new_params[filter_definition.request_param] ||= []
+        old_values << value.to_s
+        search_instance.class.new_unwrapped(new_params)
+      end
+    end
+
+    def build_filter(search_instance, value)
+      AttributeFilter.new(self, search_instance, value)
+    end
+  end
+end

data/lib/forty_facets/filter/{belongs_to.rb → belongs_to_filter_definition.rb}

@@ -1,7 +1,5 @@
 module FortyFacets
-  class BelongsToFilter < FilterDefinition
-    FacetValue = Struct.new(:entity, :count, :selected)
-
+  class BelongsToFilterDefinition < FilterDefinition
     class FacetFilter < Filter
       def association
         filter_definition.search.root_class.reflect_on_association(filter_definition.model_field)
@@ -12,10 +10,6 @@ module FortyFacets
         association.klass
       end
 
-      def values
-        @values ||= Array.wrap(value).sort.uniq
-      end
-
       def selected
         @selected ||= klass.find(values)
       end
@@ -29,25 +23,20 @@ module FortyFacets
         my_column = association.association_foreign_key
         counts = without.result.reorder('').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 = counts.map do |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)
+          FacetValue.new(facet_entity, count.occurrences, is_selected)
         end
 
         order_facet!(facet)
       end
 
-      def without
-        new_params = search_instance.params || {}
-        new_params.delete(filter_definition.request_param)
-        search_instance.class.new_unwrapped(new_params)
-      end
-
-      def remove(value)
+      def remove(entity)
         new_params = search_instance.params || {}
         old_values = new_params[filter_definition.request_param]
-        old_values.delete(value.id.to_s)
+        old_values.delete(entity.id.to_s)
         new_params.delete(filter_definition.request_param) if old_values.empty?
         search_instance.class.new_unwrapped(new_params)
       end

data/lib/forty_facets/filter/range_filter_definition.rb

@@ -1,5 +1,5 @@
 module FortyFacets
-  class RangeFilterDefintion < FilterDefinition
+  class RangeFilterDefinition < FilterDefinition
     class RangeFilter < Filter
       def build_scope
         return Proc.new { |base| base } if empty?

data/lib/forty_facets/filter_definition.rb

@@ -1,6 +1,9 @@
 module FortyFacets
   # Base class for the classes storing the definition of differently behaving filters
   FilterDefinition = Struct.new(:search, :model_field, :options) do
+
+    FacetValue = Struct.new(:entity, :count, :selected)
+
     def request_param
       model_field
     end

data/lib/forty_facets/version.rb

@@ -1,3 +1,3 @@
 module FortyFacets
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/test/smoke_test.rb

@@ -20,6 +20,7 @@ ActiveRecord::Base.connection.instance_eval do
 
   create_table :movies do |t|
     t.integer :studio_id
+    t.integer :year
     t.string :title
     t.float :price
   end
@@ -38,6 +39,7 @@ class MovieSearch < FortyFacets::FacetSearch
 
   text :title, name: 'Title'
   facet :studio, name: 'Studio'
+  facet_attr :year
   range :price, name: 'Price'
 end
 
@@ -48,7 +50,7 @@ end
 
 rand = Random.new
 %w{Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren}.each_with_index do |title, index|
-  Movie.create!(title: title, studio: studios[index % studios.length], price: rand.rand(20.0))
+  Movie.create!(title: title, studio: studios[index % studios.length], price: rand.rand(20.0), year: (index%3 + 2010) )
 end
 
 class SmokeTest < Minitest::Test
@@ -64,6 +66,43 @@ class SmokeTest < Minitest::Test
     assert_equal 'ipsum', search.result.first.title
   end
 
+  def test_year_filter
+    search = MovieSearch.new({'search' => { year: '2011' }})
+    assert_equal [2011], search.result.map(&:year).uniq
+
+    facet = search.filter(:year).facet
+    assert_equal Movie.count, facet.map(&:count).sum
+  end
+
+  def test_year_add_remove_filter
+
+    search = MovieSearch.new()
+
+    search = search.filter(:year).add(2010)
+    assert_equal Movie.where(year: 2010).count, search.result.count
+
+    search = search.filter(:year).add(2011)
+    assert_equal Movie.where(year: [2010, 2011]).count, search.result.count
+
+    search = search.filter(:year).remove(2010)
+    assert_equal Movie.where(year: 2011).count, search.result.count
+  end
+
+  def test_selected_year_filter
+    search = MovieSearch.new()
+
+    search = search.filter(:year).add(2010)
+    assert_equal [2010], search.filter(:year).selected
+
+    search = search.filter(:year).add(2011)
+    assert_equal [2010, 2011], search.filter(:year).selected
+
+    facet = search.filter(:year).facet
+    assert facet.find{|fv| fv.entity == 2010}.selected
+    assert facet.find{|fv| fv.entity == 2011}.selected
+    assert !facet.find{|fv| fv.entity == 2012}.selected
+  end
+
   def test_belongs_to_filter
     blank_search = MovieSearch.new
     first_facet_value = blank_search.filter(:studio).facet.first

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forty_facets
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Axel Tetzlaff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,7 +113,8 @@ files:
 - lib/forty_facets.rb
 - lib/forty_facets/facet_search.rb
 - lib/forty_facets/filter.rb
-- lib/forty_facets/filter/belongs_to.rb
+- lib/forty_facets/filter/attribute_filter_definition.rb
+- lib/forty_facets/filter/belongs_to_filter_definition.rb
 - lib/forty_facets/filter/range_filter_definition.rb
 - lib/forty_facets/filter/text_filter_definition.rb
 - lib/forty_facets/filter_definition.rb