forty_facets 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d9c32f0c9730c55259649e32b7b38909d24da00
-  data.tar.gz: 0b38e2588247108aa332113e2a50907bf89ca8d1
+  metadata.gz: 3667e156a13134b58e742270c9a19671cd6e81b0
+  data.tar.gz: 692413b311dc68334826c7fa9460fd9acab6f403
 SHA512:
-  metadata.gz: 1260c88aba045ed9c89e1f8209e154b45cbef190f67183e13625705de727dc6bd54c3057075b5d1f4ab31dc93d540475a904cf14868dec24cce1416628e10909
-  data.tar.gz: de80f703356346a84b8a2c3c776e8a23e70935ad31512e3ad7a94de9bdcc92961b8e78f85937a3ad7d05aa4c9235ceecd833bbbf52bd35a5b801ecf8d10aba95
+  metadata.gz: 6344847f3c58519bd965b018910c9146851c5276ebf0a678227b3295f35efc37d4abc9459ad09592ee048521941c8f22e08151de01ad8892d18417c4da0656df
+  data.tar.gz: 85db56a26bdc57ba0eded2681c7f9554e397feb175c6250a946a30a7d6b101f25a635f36200cf16371a6550a1e2a989d5821e78367cefaf1c2f5113a628673a6

data/README.md

@@ -42,8 +42,8 @@ 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
+      has_and_belongs_to_many :genres
     end
 
 You can then declare the structure of your search like so:
@@ -55,9 +55,9 @@ class HomeController < ApplicationController
     model 'Movie' # which model to search for
     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 order values in the year field
     facet :studio, name: 'Studio', order: :name
+    facet :genres, name: 'Genre' # generate a filter with all values of 'genre' occuring in the result
 
     orders 'Title' => :title,
            'price, cheap first' => "price asc",
@@ -121,9 +121,9 @@ end
 
 ## FAQ
 
-### Can I create filter for `has_many` associations ?
+### What kind of associations can be searched/filtered for?
 
-No. At the moment only objects directly related via a `belongs_to` can be used as filter.
+At the moment you can facet for entities mapped via a standard `belongs_to` or `has_and_belongs_to` association. 
 
 ## Contributing
 

data/forty_facets.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "activerecord", ">= 4.0"
+  spec.add_development_dependency "byebug"
 end

data/lib/forty_facets/facet_search.rb

@@ -32,8 +32,13 @@ module FortyFacets
       end
 
       def facet(model_field, opts = {})
-        if self.root_scope.reflect_on_association(model_field)
-          definitions << BelongsToFilterDefinition.new(self, model_field, opts)
+        reflection = self.root_scope.reflect_on_association(model_field)
+        if reflection
+          if reflection.macro == :belongs_to
+            definitions << BelongsToFilterDefinition.new(self, model_field, opts)
+          else
+            definitions << HasManyFilterDefinition.new(self, model_field, opts)
+          end
         else
           definitions << AttributeFilterDefinition.new(self, model_field, opts)
         end

data/lib/forty_facets/filter/belongs_to_filter_definition.rb

@@ -1,6 +1,6 @@
 module FortyFacets
   class BelongsToFilterDefinition < FilterDefinition
-    class BelonsToFilter < FacetFilter
+    class BelongsToFilter < FacetFilter
       def association
         filter_definition.search.root_class.reflect_on_association(filter_definition.model_field)
       end
@@ -51,7 +51,7 @@ module FortyFacets
     end
 
     def build_filter(search_instance, param_value)
-      BelonsToFilter.new(self, search_instance, param_value)
+      BelongsToFilter.new(self, search_instance, param_value)
     end
 
   end

data/lib/forty_facets/filter/has_many_filter_definition.rb

@@ -0,0 +1,74 @@
+module FortyFacets
+  class HasManyFilterDefinition < FilterDefinition
+    class HasManyFilter < FacetFilter
+      def association
+        filter_definition.search.root_class.reflect_on_association(filter_definition.model_field)
+      end
+
+      # class objects in this filter
+      def klass
+        association.klass
+      end
+
+      def selected
+        @selected ||= klass.find(values)
+      end
+
+      def build_scope
+        return Proc.new { |base| base } if empty?
+        Proc.new do |base|
+          base_table = filter_definition.search.root_class.table_name
+          join_name =  [association.name.to_s, base_table.to_s].sort.join('_')
+          foreign_id_col = association.name.to_s.singularize + '_id'
+          # this will actually generate a subquery
+          base.where(id: base.joins(association.options[:through])
+              .where(join_name + '.' + foreign_id_col => values)
+              .group(base_table + '.id').select(base_table + '.id'))
+        end
+      end
+
+      def facet
+        base_table = filter_definition.search.root_class.table_name
+        join_name =  [association.name.to_s, base_table.to_s].sort.join('_')
+        foreign_id_col = association.name.to_s.singularize + '_id'
+        my_column = join_name + '.' + foreign_id_col
+        counts = without.result
+                  .reorder('')
+                  .joins(association.options[:through])
+                  .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.map do |count|
+          facet_entity = entities_by_id[count.foreign_id].first
+          is_selected = selected.include?(facet_entity)
+          FacetValue.new(facet_entity, count.occurrences, is_selected)
+        end
+
+        order_facet!(facet)
+      end
+
+      def remove(entity)
+        new_params = search_instance.params || {}
+        old_values = new_params[filter_definition.request_param]
+        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
+
+      def add(entity)
+        new_params = search_instance.params || {}
+        old_values = new_params[filter_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)
+      HasManyFilter.new(self, search_instance, param_value)
+    end
+
+  end
+end
+

data/lib/forty_facets/version.rb

@@ -1,3 +1,3 @@
 module FortyFacets
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/forty_facets.rb

@@ -8,6 +8,7 @@ require "forty_facets/order"
 require "forty_facets/filter"
 require "forty_facets/filter_definition"
 require "forty_facets/filter/belongs_to_filter_definition"
+require "forty_facets/filter/has_many_filter_definition"
 require "forty_facets/filter/range_filter_definition"
 require "forty_facets/filter/text_filter_definition"
 require "forty_facets/filter/attribute_filter_definition"

data/test/fixtures.rb

@@ -0,0 +1,110 @@
+require 'active_record'
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.logger = Logger.new(nil)
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Base.connection.instance_eval do
+
+  create_table :studios do |t|
+    t.string :name
+  end
+
+  create_table :actors do |t|
+    t.string :name
+  end
+
+  create_table :writers do |t|
+    t.string :name
+  end
+
+  create_table :genres do |t|
+    t.string :name
+  end
+
+  create_table :movies do |t|
+    t.integer :studio_id
+    t.integer :year
+    t.string :title
+    t.float :price
+  end
+
+  create_table :actors_movies do |t|
+    t.integer :movie_id
+    t.integer :actor_id
+  end
+
+  create_table :movies_writers do |t|
+    t.integer :movie_id
+    t.integer :writer_id
+  end
+
+  create_table :genres_movies do |t|
+    t.integer :movie_id
+    t.integer :genre_id
+  end
+
+end
+
+class Actor < ActiveRecord::Base
+end
+
+class Writer < ActiveRecord::Base
+end
+
+class Genre < ActiveRecord::Base
+end
+
+class Studio < ActiveRecord::Base
+end
+
+class Movie < ActiveRecord::Base
+  belongs_to :studio
+  has_and_belongs_to_many :genres
+  has_and_belongs_to_many :actors
+  has_and_belongs_to_many :writers
+end
+
+studios = []
+%w{A B C D}.each do |suffix|
+  studios << Studio.create!(name: "Studio #{suffix}")
+end
+
+genres = []
+%w{horror thriller drama comedy family action documentery}.each do |genre_name|
+  genres << Genre.create!(name: genre_name)
+end
+
+actors = []
+%w{Matt Julie Tom Brad Tony Dustin Lucy Jenny}.each do |actor_name|
+  actors << Actor.create!(name: actor_name)
+end
+
+writers = []
+%w{Matt Julie Tom Brad Tony Dustin Lucy Jenny}.each do |writer_name|
+  writers << Writer.create!(name: writer_name)
+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|
+  m = Movie.create!(title: title, studio: studios[index % studios.length], price: rand.rand(20.0), year: (index%3 + 2010) )
+  3.times do
+    actor = actors[rand(actors.length)]
+    unless m.actors.include? actor
+      m.actors << actor
+    end
+  end
+  3.times do
+    writer = writers[rand(writers.length)]
+    unless m.writers.include? writer
+      m.writers << writer
+    end
+  end
+  rand(6).to_i.times do
+    genre = genres[rand(genres.length)]
+    unless m.genres.include? genre
+      m.genres << genre
+    end
+  end
+end
+
+

data/test/smoke_test.rb

@@ -2,37 +2,13 @@ require 'coveralls'
 Coveralls.wear!
 
 require "minitest/autorun"
-require 'active_record'
 require 'logger'
+require 'byebug'
 require_relative '../lib/forty_facets'
 
-silence_warnings do
-  ActiveRecord::Migration.verbose = false
-  ActiveRecord::Base.logger = Logger.new(nil)
-  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
-end
-
-ActiveRecord::Base.connection.instance_eval do
-
-  create_table :studios do |t|
-    t.string :name
-  end
-
-  create_table :movies do |t|
-    t.integer :studio_id
-    t.integer :year
-    t.string :title
-    t.float :price
-  end
-
-end
-
-class Studio < ActiveRecord::Base
-end
-
-class Movie < ActiveRecord::Base
-  belongs_to :studio
-end
+#silence_warnings do
+require_relative 'fixtures'
+#end
 
 class MovieSearch < FortyFacets::FacetSearch
   model 'Movie'
@@ -40,17 +16,10 @@ class MovieSearch < FortyFacets::FacetSearch
   text :title, name: 'Title'
   facet :studio, name: 'Studio'
   facet :year, order: Proc.new {|year| -year}
+  facet :genres, name: 'Genre'
+  facet :actors, name: 'Actor'
   range :price, name: 'Price'
-end
-
-studios = []
-%w{A B C D}.each do |suffix|
-  studios << Studio.create!(name: "Studio #{suffix}")
-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), year: (index%3 + 2010) )
+  facet :writers, name: 'Writer'
 end
 
 class SmokeTest < Minitest::Test
@@ -122,4 +91,67 @@ class SmokeTest < Minitest::Test
     assert_equal Movie.all.map(&:year).sort.uniq.reverse, facet_entities
   end
 
+  def test_has_many
+    blank_search = MovieSearch.new
+    genre = Genre.first
+    expected = Movie.order(:id).select{|m| m.genres.include?(genre)}
+    assert blank_search.filter(:genres).is_a?(FortyFacets::HasManyFilterDefinition::HasManyFilter)
+    search = blank_search.filter(:genres).add(genre)
+    actual = search.result
+
+    assert_equal expected.size, actual.size
+  end
+
+  def test_has_many_writers
+    blank_search = MovieSearch.new
+    writer = Writer.first
+    expected = Movie.order(:id).select{|m| m.writers.include?(writer)}
+    assert blank_search.filter(:writers).is_a?(FortyFacets::HasManyFilterDefinition::HasManyFilter)
+    search = blank_search.filter(:writers).add(writer)
+    actual = search.result
+
+    assert_equal expected.size, actual.size
+  end
+
+  def test_has_many_combo
+    blank_search = MovieSearch.new
+    genre = Genre.first
+    actor = Actor.first
+    expected = Movie.order(:id)
+                .select{|m| m.genres.include?(genre)}
+                .select{|m| m.actors.include?(actor)}
+    assert blank_search.filter(:genres).is_a?(FortyFacets::HasManyFilterDefinition::HasManyFilter)
+    search_with_genre = blank_search.filter(:genres).add(genre)
+    search_with_genre_and_actor = search_with_genre.filter(:actors).add(actor)
+    actual = search_with_genre_and_actor.result
+
+    assert_equal expected.size, actual.size
+  end
+
+  def test_has_many_facet_values_writers
+    selected_writer = Writer.first
+    search = MovieSearch.new.filter(:writers).add(selected_writer)
+
+    search.filter(:writers).facet.each do |facet_value|
+      writer = facet_value.entity
+      expected = Movie.order(:id).select{|m| m.writers.include?(writer)}.count
+      assert_equal expected, facet_value.count, "The amount of movies for a writer should match the number indicated in the facet"
+      assert_equal writer.id == selected_writer.id, facet_value.selected
+    end
+
+  end
+
+  def test_has_many_facet_values_genres
+    selected_genre = Genre.first
+    search = MovieSearch.new.filter(:genres).add(selected_genre)
+
+    search.filter(:genres).facet.each do |facet_value|
+      genre = facet_value.entity
+      expected = Movie.order(:id).select{|m| m.genres.include?(genre)}.count
+      assert_equal expected, facet_value.count, "The amount of movies for a genre should match the number indicated in the facet"
+      assert_equal genre.id == selected_genre.id, facet_value.selected
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forty_facets
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Axel Tetzlaff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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:
@@ -115,12 +129,14 @@ files:
 - lib/forty_facets/filter.rb
 - lib/forty_facets/filter/attribute_filter_definition.rb
 - lib/forty_facets/filter/belongs_to_filter_definition.rb
+- lib/forty_facets/filter/has_many_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
 - lib/forty_facets/order.rb
 - lib/forty_facets/order_definition.rb
 - lib/forty_facets/version.rb
+- test/fixtures.rb
 - test/smoke_test.rb
 - test/test_helper.rb
 homepage: https://github.com/fortytools/forty_facets
@@ -148,5 +164,6 @@ signing_key:
 specification_version: 4
 summary: Library for building facet searches for active_record models
 test_files:
+- test/fixtures.rb
 - test/smoke_test.rb
 - test/test_helper.rb