filterrific 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b083d6ced83900d819a27094c641df15c8b8eaa
-  data.tar.gz: b6792d8a295048001d3def4112b6917edb263293
+  metadata.gz: 36dc749c095650e566eacee010e3021ee5aad1c3
+  data.tar.gz: dedcfb34441effe7dfde8fbb610b0dedcfcab461
 SHA512:
-  metadata.gz: c780219e349ac9e7a8aae20db84476c086a1650de029d176268757a5331c3e5924694ff9c856281cc59ed8058d41432f0a675942d2f6b5ac113abf3231310adc
-  data.tar.gz: 17e8b121fe5e15ec56a4d34dfae5fbd7906ffb5ebdc506c96a3ba357a405fd1c299f55c54c8750a023586c5a91e1874327add1c8b96512fb08df5294d29eb252
+  metadata.gz: c92f6d1eae2d2a91ad1b00bc9cfb5c6bc2e84ea0889748042b4b295ede9a9741a14232e565b8ffad66a9ac7fd897f3f5e9e8140762649bbb6f155b99967845d1
+  data.tar.gz: caf3aca751fbc4d9dbe894530ac03ef4024d2d69ca1569fa29081ed89ddd361cb3e40c4f09738204a6c0a73a7f6898595242c6475a7d9493eca5338578055e7d

data/CHANGELOG.md

@@ -39,6 +39,16 @@
       },
     )
 
+
+### 2.0.4
+
+* Objectify nested params so that they render correctly on the form when
+  restored from session or URL params.
+* Don't convert strings that almost look like integers to integers. Example:
+  `"0123"` as part of a phone number should not be converted to `123`.
+
+
+
 ### 2.0.3
 
 * Cleaned up obsolete option names

data/lib/filterrific/action_controller_extension.rb

@@ -34,7 +34,7 @@ module Filterrific
       if (f_params.delete('reset_filterrific'))
         # Reset query and session_persisted params
         session[pi] = nil
-        redirect_to url_for({})  and return false # works with `or return` in calling action.
+        redirect_to url_for({})  and return false # requires `or return` in calling action.
       end
 
       f_params = compute_filterrific_params(model_class, f_params, opts, pi)

data/lib/filterrific/param_set.rb

@@ -13,9 +13,9 @@ module Filterrific
 
     # Initializes a new Filterrific::ParamSet. This is the core of Filterrific
     # where all the action happens.
-    # @param a_model_class [Class] the class you want to filter records of
-    # @param filterrific_params [Hash, optional] the filter params, uses
-    #   model_class' default_settings
+    # @param a_model_class [Class] the class you want to filter records of.
+    # @param filterrific_params [Hash, optional] the filter params, falls back
+    #   to model_class' default_settings.
     # @return [Filterrific::ParamSet]
     def initialize(a_model_class, filterrific_params = {})
       self.model_class = a_model_class
@@ -41,6 +41,13 @@ module Filterrific
       model_class.filterrific_find(self)
     end
 
+    # Returns true if this instance of Filterrific has params other than the
+    # defaults.
+    # @return [Boolean]
+    def has_filters_applied?
+      sdf
+    end
+
     # Returns Filterrific::ParamSet as hash (used for URL params and serialization)
     # @return [Hash] with stringified keys
     def to_hash
@@ -53,6 +60,9 @@ module Filterrific
           when param_value.is_a?(Proc)
             # evaluate Proc so it can be serialized
             h[filter_name] = param_value.call
+          when param_value.is_a?(OpenStruct)
+            # convert OpenStruct to hash
+            h[filter_name] = param_value.marshal_dump
           else
             h[filter_name] = param_value
           end
@@ -69,18 +79,23 @@ module Filterrific
   protected
 
     # Conditions params: Evaluates Procs and type casts integer values.
+    # Why are we type casting integers?
     # @param fp [Hash] the filterrific params hash
     # @return[Hash] the conditioned params hash
     def condition_filterrific_params(fp)
       fp.each do |key, val|
         case
         when val.is_a?(Proc)
-          # evaulate Procs
+          # evaluate Procs
           fp[key] = val.call
         when val.is_a?(Array)
           # type cast integers in the array
-          fp[key] = fp[key].map { |e| e =~ /^\d+$/ ? e.to_i : e }
-        when val =~ /^\d+$/
+          fp[key] = fp[key].map { |e| e =~ /^[1-9]\d*$/ ? e.to_i : e }
+        when val.is_a?(Hash)
+          # type cast Hash to OpenStruct so that nested params render correctly
+          # in the form
+          fp[key] = OpenStruct.new(fp[key])
+        when val =~ /^[1-9]\d*$/
           # type cast integer
           fp[key] = fp[key].to_i
         end

data/lib/filterrific/version.rb

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

data/spec/filterrific/param_set_spec.rb

@@ -8,8 +8,10 @@ module Filterrific
 
     def self.filterrific_available_filters
       %w[
+        filter_almost_int
         filter_array_int
         filter_array_string
+        filter_hash
         filter_int
         filter_proc
         filter_string
@@ -22,21 +24,37 @@ module Filterrific
 
     def self.filterrific_params
       {
-        'filter_proc' => lambda { 1 + 1 },
+        'filter_almost_int' => '042',
         'filter_array_int' => %w[1 2 3],
         'filter_array_string' => %w[one two three],
+        'filter_hash' => { a: 1, b: 2 },
         'filter_int' => '42',
-        'filter_string' => 'forty-two'
+        'filter_proc' => lambda { 1 + 1 },
+        'filter_string' => 'forty-two',
       }
     end
 
-    def self.filterrific_params_after_sanitizing
+    def self.filterrific_params_after_conditioning
       {
+        'filter_almost_int' => '042',
         'filter_array_int' => [1, 2, 3],
         'filter_array_string' => %w[one two three],
+        'filter_hash' => OpenStruct.new(a: 1, b: 2),
         'filter_int' => 42,
         'filter_proc' => 2,
-        'filter_string' => 'forty-two'
+        'filter_string' => 'forty-two',
+      }
+    end
+
+    def self.filterrific_params_as_hash
+      {
+        'filter_almost_int' => '042',
+        'filter_array_int' => [1, 2, 3],
+        'filter_array_string' => %w[one two three],
+        'filter_hash' => { a: 1, b: 2 },
+        'filter_int' => 42,
+        'filter_proc' => 2,
+        'filter_string' => 'forty-two',
       }
     end
 
@@ -82,8 +100,8 @@ module Filterrific
 
         TestData.filterrific_params.keys.each do |key|
 
-          it "assigns sanitized param to '#{ key }' attr" do
-            filterrific_param_set.send(key).must_equal(TestData.filterrific_params_after_sanitizing[key])
+          it "assigns conditioned param to '#{ key }' attr" do
+            filterrific_param_set.send(key).must_equal(TestData.filterrific_params_after_conditioning[key])
           end
 
         end
@@ -102,7 +120,7 @@ module Filterrific
 
       it "returns all filterrific_params as hash" do
         filterrific_param_set.to_hash.must_equal(
-          TestData.filterrific_params_after_sanitizing
+          TestData.filterrific_params_as_hash
         )
       end
 
@@ -112,7 +130,7 @@ module Filterrific
 
       it "returns all filterrific_params as json string" do
         filterrific_param_set.to_json.must_equal(
-          TestData.filterrific_params_after_sanitizing.to_json
+          TestData.filterrific_params_as_hash.to_json
         )
       end
 
@@ -142,5 +160,26 @@ module Filterrific
       end
     end
 
+    describe "#condition_filterrific_params" do
+
+      [
+        [{ a_proc: lambda { 1 + 1 } }, { a_proc: 2 }],
+        [{ an_array: [1, 'a'] }, { an_array: [1, 'a'] }],
+        [{ a_hash: { 'a' => 1, 'b' => 2 } }, { a_hash: OpenStruct.new({ 'a' => 1, 'b' => 2 }) }],
+        [{ a_string_that_looks_like_int: '123' }, { a_string_that_looks_like_int: 123 }],
+        [{ a_string_that_almost_looks_like_int: '0123' }, { a_string_that_almost_looks_like_int: '0123' }],
+        [{ an_array_with_almost_int: ['0123', '123'] }, { an_array_with_almost_int: ['0123', 123] }],
+        [{ a_string: 'abc' }, { a_string: 'abc' }],
+      ].each do |test_params, xpect|
+        it "Handles #{ test_params.inspect }" do
+          filterrific_param_set.send(
+            :condition_filterrific_params,
+            test_params
+          ).must_equal(xpect)
+        end
+      end
+
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filterrific
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Jo Hund
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-30 00:00:00.000000000 Z
+date: 2015-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails