filterrific 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5771d0552efaa97955d18305f8199f7691148d93
-  data.tar.gz: 037e7d5b634f6183cd6315d35cdd5a8874c47f3c
+  metadata.gz: 11a56a1d6587f1b007103d3f23906fe5cda61466
+  data.tar.gz: 7f33fc8e000fe7f7969cc6b8dfd057e6364c0518
 SHA512:
-  metadata.gz: 6da890161d37d8884debfff82b057f1fe304ebcf858b6a0493cc756739428cc33fdc131abd0f174fd4ea449704404adc10204c33fa22d89b96c623001aefdafc
-  data.tar.gz: 192de17ea6192932f6e6c262fa6888fa35b39188ec0c99dcaf76bedd94434671f2754968ac4e9cc0fad8d2fc461c95dbb122e1b11074afc7fe1567b46920258d
+  metadata.gz: 812ea2580b378e23db574823a3fa561d116773392698a7b5fa51e3bbbc90a7053fe000dc98622e15666d85b6e81a11e4560b08d578e7449e84a3d1de50a2728e
+  data.tar.gz: df6c4d694d297697fd3befc2702af6b65094a0631e457f22732cc44e216fb5c98b29c520a1ca23e754917675f46cca349d69ec6bb87f76ababed04791797bd8d

data/CHANGELOG.md

@@ -39,6 +39,10 @@
       },
     )
 
+### 2.0.1
+
+* Fixed regression with Rails 3.2 (doesn't support `#deep_stringify_keys`)
+
 
 
 # 2.0.0

data/README.md

@@ -28,11 +28,12 @@ Every commit to Filterrific is automatically tested against the following scenar
 
 | Rails version | Ruby environments              | Database adapters                  | Build status |
 |---------------|--------------------------------|------------------------------------|--------------|
+| Rails 4.2     | MRI 1.9.3, 2.0.0, 2.1.2, 2.2.0 | mysql, mysql2, postgresql, sqlite3 |[![Build Status](https://travis-ci.org/jhund/filterrific_demo.svg?branch=rails-4.2)](https://travis-ci.org/jhund/filterrific_demo)|
 | Rails 4.1     | MRI 1.9.3, 2.0.0, 2.1.2, 2.2.0 | mysql, mysql2, postgresql, sqlite3 |[![Build Status](https://travis-ci.org/jhund/filterrific_demo.svg?branch=rails-4.1)](https://travis-ci.org/jhund/filterrific_demo)|
 | Rails 4.0     | MRI 1.9.3, 2.0.0, 2.1.2, 2.2.0 | mysql, mysql2, postgresql, sqlite3 |[![Build Status](https://travis-ci.org/jhund/filterrific_demo.svg?branch=rails-4.0)](https://travis-ci.org/jhund/filterrific_demo)|
 | Rails 3.2     | MRI 1.9.3, 2.0.0, 2.1.2        | mysql, mysql2, postgresql, sqlite3 |[![Build Status](https://travis-ci.org/jhund/filterrific_demo.svg?branch=rails-3.2)](https://travis-ci.org/jhund/filterrific_demo)|
 
-Filterrific version 1.4.0 should work on older versions of Rails and Ruby, however
+Filterrific version 1.x should work on older versions of Rails and Ruby, however
 the 1.x branch is not supported any more.
 
 

data/lib/filterrific/action_controller_extension.rb

@@ -10,7 +10,7 @@ module Filterrific
     # @param model_class [Class]
     # @param filterrific_params [Hash] typically the Rails request params under
     #    the :filterrific key (params[:filterrific]), however can be any Hash.
-    # @param opts [Hash]
+    # @param opts [Hash, optional]
     # @option opts [Array<String>, optional] :available_filters
     #   further restrict which of the filters specified in the model are
     #   available in this context.
@@ -24,8 +24,10 @@ module Filterrific
     #   these are available in the view to populate select lists and other
     #   dynamic values.
     # @return [Filterrific::ParamSet]
-    def initialize_filterrific(model_class, filterrific_params, opts)
-      f_params = (filterrific_params || {}).deep_stringify_keys
+    def initialize_filterrific(model_class, filterrific_params, opts = {})
+      # We used #deep_stringify_keys, however that breaks on Rails 3.x, so we
+      # went back to #stringify_keys which should be sufficient.
+      f_params = (filterrific_params || {}).stringify_keys
       opts = opts.stringify_keys
       pi = opts['persistence_id'] || compute_default_persistence_id
 
@@ -35,13 +37,7 @@ module Filterrific
         redirect_to url_for({})  and return false # works with `or return` in calling action.
       end
 
-      f_params = f_params.presence || # start with passed in params
-                 session[pi].presence || # then try session persisted params
-                 opts['default_filter_params'] || # then use passed in opts
-                 model_class.filterrific_default_filter_params # finally use model_class defaults
-
-      f_params.deep_stringify_keys!
-      f_params.slice!(opts['available_filters'].map(&:to_s))  if opts['available_filters']
+      f_params = compute_filterrific_params(model_class, f_params, opts)
 
       filterrific = Filterrific::ParamSet.new(model_class, f_params)
       filterrific.select_options = opts['select_options']
@@ -54,5 +50,21 @@ module Filterrific
       [controller_name, action_name].join('#')
     end
 
+    # Computes filterrific params using a number of strategies. Limits params
+    # to 'available_filters' if given via opts.
+    # @param model_class [ActiveRecord::Base]
+    # @param filterrific_params [Hash]
+    # @param opts [Hash]
+    def compute_filterrific_params(model_class, filterrific_params, opts)
+      r = (
+        filterrific_params.presence || # start with passed in params
+        session[pi].presence || # then try session persisted params
+        opts['default_filter_params'] || # then use passed in opts
+        model_class.filterrific_default_filter_params # finally use model_class defaults
+      ).stringify_keys
+      r.slice!(opts['available_filters'].map(&:to_s))  if opts['available_filters']
+      r
+    end
+
   end
 end

data/lib/filterrific/version.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
 
 module Filterrific
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/filterrific/active_record_extension_spec.rb

@@ -9,11 +9,11 @@ module Filterrific
   # Container for test data
   class TestData
 
-    def self.filterrific_filter_names
-      %w[sorted_by search_query with_country_id]
+    def self.filterrific_available_filters
+      %w[search_query sorted_by with_country_id]
     end
 
-    def self.filterrific_default_settings
+    def self.filterrific_default_filter_params
       { 'sorted_by' => 'name_asc' }
     end
 
@@ -24,8 +24,8 @@ module Filterrific
     let(:filterrific_class){
       Class.new(ActiveRecord::Base) do
         filterrific(
-          :filter_names => TestData.filterrific_filter_names,
-          :default_settings => TestData.filterrific_default_settings
+          available_filters: TestData.filterrific_available_filters,
+          default_filter_params: TestData.filterrific_default_filter_params
         )
       end
     }
@@ -44,19 +44,19 @@ module Filterrific
 
     describe "Filterrific initialization" do
 
-      it "initializes filterrific_filter_names" do
-        filterrific_class.filterrific_filter_names.must_equal(TestData.filterrific_filter_names)
+      it "initializes filterrific_available_filters" do
+        filterrific_class.filterrific_available_filters.must_equal(TestData.filterrific_available_filters)
       end
 
-      it "initializes filterrific_default_settings" do
-        filterrific_class.filterrific_default_settings.must_equal(TestData.filterrific_default_settings)
+      it "initializes filterrific_default_filter_params" do
+        filterrific_class.filterrific_default_filter_params.must_equal(TestData.filterrific_default_filter_params)
       end
 
       it "raises when no filter_names are given" do
         proc {
           Class.new(ActiveRecord::Base) do
             filterrific(
-              :filter_names => []
+              available_filters: []
             )
           end
         }.must_raise(ArgumentError)
@@ -66,8 +66,8 @@ module Filterrific
         proc {
           Class.new(ActiveRecord::Base) do
             filterrific(
-              :filter_names => [:one, :two],
-              :default_settings => { :three => '' }
+              available_filters: [:one, :two],
+              default_filter_params:{ three: '' }
             )
           end
         }.must_raise(ArgumentError)

data/spec/filterrific/param_set_spec.rb

@@ -6,17 +6,17 @@ module Filterrific
   # Container for test data
   class TestData
 
-    def self.filterrific_filter_names
+    def self.filterrific_available_filters
       %w[
-        filter_proc
         filter_array_int
         filter_array_string
         filter_int
+        filter_proc
         filter_string
       ]
     end
 
-    def self.filterrific_default_settings
+    def self.filterrific_default_filter_params
       { 'filter_int' => 42 }
     end
 
@@ -32,10 +32,10 @@ module Filterrific
 
     def self.filterrific_params_after_sanitizing
       {
-        'filter_proc' => 2,
         'filter_array_int' => [1, 2, 3],
         'filter_array_string' => %w[one two three],
         'filter_int' => 42,
+        'filter_proc' => 2,
         'filter_string' => 'forty-two'
       }
     end
@@ -43,13 +43,13 @@ module Filterrific
   end
 
   # Simulates a class that would include the filterrific directive
-  class ResourceClass
+  class ModelClass
 
-    def self.filterrific_default_settings
-      TestData.filterrific_default_settings
+    def self.filterrific_default_filter_params
+      TestData.filterrific_default_filter_params
     end
-    def self.filterrific_filter_names
-      TestData.filterrific_filter_names
+    def self.filterrific_available_filters
+      TestData.filterrific_available_filters
     end
 
   end
@@ -57,18 +57,18 @@ module Filterrific
   describe ParamSet do
 
     let(:filterrific_param_set){
-      Filterrific::ParamSet.new(ResourceClass, TestData.filterrific_params)
+      Filterrific::ParamSet.new(ModelClass, TestData.filterrific_params)
     }
 
     describe "initialization" do
 
       it "assigns resource class" do
-        filterrific_param_set.resource_class.must_equal(ResourceClass)
+        filterrific_param_set.model_class.must_equal(ModelClass)
       end
 
       describe "dynamic filter_name attr_accessors" do
 
-        TestData.filterrific_filter_names.each do |filter_name|
+        TestData.filterrific_available_filters.each do |filter_name|
 
           it "defines a getter for '#{ filter_name }'" do
             filterrific_param_set.must_respond_to(filter_name)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filterrific
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Jo Hund