forty_facets 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffffd6ffbdfc630f50719b17036d4442aa08a900
-  data.tar.gz: d2e5c895e6c2ad6f422bca70935a0569d98801f3
+  metadata.gz: 3e439d4f05f7a8bfe44665eec3bed14cf9d323e2
+  data.tar.gz: c2c5a838fe3489158e5a88947e30cedfe68472b0
 SHA512:
-  metadata.gz: 1b863db6fb54e3d392cf23e220bd2513f581a077fee1ad448780d390e54e8f9f443719757f01e136b73a76ee4d1d07c0b10f5fa6c1e868af32a14fba81a17446
-  data.tar.gz: 09b7f942ae6584790fd6a578af19e2a2046d6bc7dde1753bda80dbc33e40403e5740eaa7dc6587d0c17addb862d7b06dc335a6487f21ca78d2c4bd80859e0d41
+  metadata.gz: 35018e26f1a6a037cf48d9e48d5df2fcd4df016758b4a5f91314b5f1b7ae6d36c5c91e6bd85d4f372417447fca70545469be79c2f6b8ff74aa94309eecf2d273
+  data.tar.gz: 337b7d8da1cfb036564bb03b1e997e0fd4de8d705d3efab261ec5bd5cc657f21f62a8c0a6f3b0c54b86f377644c35b0e8435ef0dfd7c4ed31555911965306989

data/README.md

@@ -4,6 +4,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")!
+
 It offers a simple API to create an interactive UI to browse your data by iteratively adding
 filter values.
 
@@ -88,9 +90,15 @@ Use the search object to display further narrowing options to the user
             %span.count= "(#{facet_value.count})"
 ```
 
+## FAQ
+
+### Can I create filter for `has_many` associations ?
+
+No. At the moment only objects directly related via a `belongs_to` can be used as filter.
+
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/forty_facets/fork )
+1. Fork it ( http://github.com/fortytools/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`)

data/forty_facets.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/fortytools/forty_facets"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = `git ls-files -z`.split("\x0").reject{|f| f == 'demo.gif'}
   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"]

data/lib/forty_facets/facet_search.rb

@@ -1,6 +1,7 @@
 module FortyFacets
   class FacetSearch
-    attr_reader :filters
+    attr_reader :filters, :orders
+
 
     FieldDefinition = Struct.new(:search, :model_field, :options) do
       def request_param
@@ -27,6 +28,42 @@ module FortyFacets
       end
     end
 
+    class RangeField < FieldDefinition
+      class RangeFilter < Filter
+        def build_scope
+          return Proc.new { |base| base } if empty?
+          Proc.new {  |base| base.where("#{field_definition.model_field} >= ? AND #{field_definition.model_field} <= ? ", min_value, max_value ) }
+        end
+
+        def min_value
+          return nil if empty?
+          value.split(' - ').first
+        end
+
+        def max_value
+          return nil if empty?
+          value.split(' - ').last
+        end
+
+        def absolute_interval
+          @abosultes ||= without.result.select("min(#{field_definition.model_field}) as min, max(#{field_definition.model_field}) as max").first
+        end
+
+        def absolute_min
+          absolute_interval.min
+        end
+
+        def absolute_max
+          absolute_interval.max
+        end
+
+      end
+
+      def build_filter(search_instance, value)
+        RangeFilter.new(self, search_instance, value)
+      end
+    end
+
     class TextField < FieldDefinition
       class TextFilter < Filter
         def build_scope
@@ -42,10 +79,6 @@ module FortyFacets
            "%#{term}%"
           end
         end
-
-        def display_value
-          value
-        end
       end
 
       def build_filter(search_instance, value)
@@ -137,10 +170,40 @@ module FortyFacets
         definitions << TextField.new(self, model_field, opts)
       end
 
+      def range(model_field, opts = {})
+        definitions << RangeField.new(self, model_field, opts)
+      end
+
       def facet(model_field, opts = {})
         definitions << FacetField.new(self, model_field, opts)
       end
 
+      OrderDefinition = Struct.new(:title, :clause) do
+        def build(search, order_param)
+          Order.new(search, self, order_param == title.to_s)
+        end
+
+        def request_value
+          title
+        end
+      end
+
+      Order = Struct.new(:search, :definition, :active) do
+        def title
+          definition.title
+        end
+
+        def by
+          new_params = search.params || {}
+          new_params[:order] = definition.request_value
+          search.class.new_unwrapped(new_params)
+        end
+      end
+
+      def orders(name_and_order_options)
+        @order_definitions = name_and_order_options.to_a.inject([]) {|ods, no| ods << OrderDefinition.new(no.first, no.last)}
+      end
+
       def definitions
         @definitions ||= []
       end
@@ -161,6 +224,10 @@ module FortyFacets
       def request_param_name
         @request_param_name ||= 'search'
       end
+
+      def order_definitions
+        @order_definitions
+      end
     end
 
     def initialize(request_params)
@@ -169,9 +236,14 @@ module FortyFacets
                else
                  {}
                end
-      @filters = self.class.definitions.inject([]) do |sum, definition|
-        sum << definition.build_filter(self, params[definition.request_param])
+      @filters = self.class.definitions.inject([]) do |filters, definition|
+        filters << definition.build_filter(self, params[definition.request_param])
       end
+
+      @orders = self.class.order_definitions.inject([]) do |orders, definition|
+        orders << definition.build(self, params[:order])
+      end
+
     end
 
     def self.new_unwrapped(params)
@@ -179,13 +251,21 @@ module FortyFacets
     end
 
     def filter(filter_name)
-      @filters.find { |f| f.field_definition.model_field == filter_name }
+      filter = @filters.find { |f| f.field_definition.model_field == filter_name }
+      raise "unknown filter #{filter_name}" unless filter
+      filter
+    end
+
+    def order
+      @orders.find(&:active)
     end
 
     def result
-      @filters.inject(self.class.root_scope) do |previous, filter|
+      query = @filters.inject(self.class.root_scope) do |previous, filter|
         filter.build_scope.call(previous)
       end
+      query = query.order(order.definition.clause) if order
+      query
     end
 
     def wrapped_params
@@ -193,10 +273,12 @@ module FortyFacets
     end
 
     def params
-      @filters.inject({}) do |sum, filter|
+      params = @filters.inject({}) do |sum, filter|
         sum[filter.field_definition.request_param] = filter.value.dup unless filter.empty?
         sum
       end
+      params[:order] = order.definition.request_value if order
+      params
     end
 
     def path
@@ -208,3 +290,4 @@ module FortyFacets
     end
   end
 end
+

data/lib/forty_facets/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forty_facets
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Axel Tetzlaff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-15 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -51,7 +51,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- demo.gif
 - forty_facets.gemspec
 - lib/forty_facets.rb
 - lib/forty_facets/facet_search.rb