filterrific 1.2.0 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5d3faba1051ddc4f44e54c059d8066e79088c01
+  data.tar.gz: 2fd9d094d986128b8fbcc523fffe2b79a3d04dee
+SHA512:
+  metadata.gz: 2874548de0af99e2cd671314a651231cb6b4c5b87303c36dbb4287767b4f14595290045043745e3285c0fa68cba18bb7a999bb572c7be1c06b9f6defed155a86
+  data.tar.gz: cd45acb35c256fa3b61ac47ae8bfe517834ed450b818df3f9bc71b59761681d5b52ef3e7629adec535f199d0a8eac23ba03658261f4c21f71c7b9426cdcd2ded

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 1.3.0
+
+* Added ParamSet#select_options (thanks @pnomolos).
+* Added ParamSet#signature to quickly test two param_sets for equality.
+* Bugfix: When using with Rails 4.0: Fixed ‘wrong number of arguments 0 for 1’ exception (thanks @sebboh).
+* Bugfix: jQuery bug in `form_for` helper (thanks @sebboh).
+* Bugfix: removed duplicate dependency in .gemspec.
+
+* Updated documentation.
+* Updated Gemfile source
+* Refactored ParamSet initialization.
+* Refactored ActiveRecordExtension initialization.
+
+
+
 ## 1.2.0
 
 * Added simple wrapper for Filterrific::ParamSet.new so that it can be 
@@ -14,31 +29,31 @@
 
 ## 1.1.0
 
-* Major refactor
-* Added specs
-* Tied in Rails asset pipeline
-* Added gh-pages branch for documentation
+* Major refactor.
+* Added specs.
+* Tied in Rails asset pipeline.
+* Added gh-pages branch for documentation.
 
 
 ### 1.0.1
 
-* Bug fix: Replaced stringify_keys with map.to_s (filter_names is an Array, not a Hash!)
+* Bug fix: Replaced stringify_keys with map.to_s (filter_names is an Array, not a Hash!).
 
 
 
 
 # 1.0.0
 
-* Support for Rails 3.1
-* New model api
+* Support for Rails 3.1.
+* New model api.
 
 
 
 ## 0.1.0, released 2010-08-01
 
-* Replicate functionality of Rails 2.3 version
+* Replicate functionality of Rails 2.3 version.
 
 
 ### 0.0.1, released 2010-07-30
 
-* Initial setup
+* Initial setup.

data/README.md

@@ -22,12 +22,13 @@ or with bundler in your Gemfile:
 ### Resources
 
 * [Documentation](http://filterrific.clearcove.ca)
+* [Live demo](http://filterrific-demo.herokuapp.com)
 * [Changelog](https://github.com/jhund/filterrific/blob/master/CHANGELOG.md)
 * [Source code (github)](https://github.com/jhund/filterrific)
 * [Issues](https://github.com/jhund/filterrific/issues)
 * [Rubygems.org](http://rubygems.org/gems/filterrific)
 
-
+[![Code Climate](https://codeclimate.com/github/jhund/filterrific.png)](https://codeclimate.com/github/jhund/filterrific)
 
 ### License
 

data/lib/filterrific/action_view_extension.rb

@@ -10,7 +10,7 @@ module Filterrific::ActionViewExtension
       options[:html] ||= {}
       options[:html][:method] ||= :get
       options[:html][:id] ||= :filterrific_filter
-      options[:url] ||= url_for
+      options[:url] ||= url_for(:controller => controller.controller_name, :action => controller.action_name)
     end
     super
   end

data/lib/filterrific/active_record_extension.rb

@@ -25,21 +25,10 @@ module Filterrific::ActiveRecordExtension
 
       options.stringify_keys!
 
-      # Raise exception if not filter_names are given
-      self.filterrific_filter_names = (
-        options['filter_names'] || options['scope_names'] || []
-      ).map { |e| e.to_s }
-      raise(ArgumentError, ":filter_names can't be empty")  if filterrific_filter_names.blank?
-
-      self.filterrific_default_settings = (
-        options['default_settings'] || options['defaults'] || {}
-      ).stringify_keys
-      # Raise exception if defaults contain keys that are not present in filter_names
-      if (
-        invalid_defaults = (filterrific_default_settings.keys - filterrific_filter_names)
-      ).any?
-        raise(ArgumentError, "Invalid default keys: #{ invalid_defaults.inspect }")
-      end
+      assign_filterrific_filter_names(options)
+      validate_filterrific_filter_names
+      assign_filterrific_default_settings(options)
+      validate_filterrific_default_settings
     end
 
     # Returns ActiveRecord relation based on given filterrific_param_set.
@@ -66,6 +55,34 @@ module Filterrific::ActiveRecordExtension
       ar_proxy
     end
 
+  protected
+
+    def assign_filterrific_filter_names(options)
+      self.filterrific_filter_names = (
+        options['filter_names'] || options['scope_names'] || []
+      ).map { |e| e.to_s }
+    end
+
+    def validate_filterrific_filter_names
+      # Raise exception if not filter_names are given
+      raise(ArgumentError, ":filter_names can't be empty")  if filterrific_filter_names.blank?
+    end
+
+    def assign_filterrific_default_settings(options)
+      self.filterrific_default_settings = (
+        options['default_settings'] || options['defaults'] || {}
+      ).stringify_keys
+    end
+
+    def validate_filterrific_default_settings
+      # Raise exception if defaults contain keys that are not present in filter_names
+      if (
+        invalid_defaults = (filterrific_default_settings.keys - filterrific_filter_names)
+      ).any?
+        raise(ArgumentError, "Invalid default keys: #{ invalid_defaults.inspect }")
+      end
+    end
+
   end
 
 end

data/lib/filterrific/param_set.rb

@@ -1,4 +1,5 @@
 require 'active_support/all'
+require 'digest/sha1'
 
 module Filterrific
 
@@ -6,10 +7,11 @@ module Filterrific
   class ParamSet
 
     attr_accessor :resource_class
+    attr_reader   :select_options
 
     def initialize(a_resource_class, filterrific_params = {})
-
       self.resource_class = a_resource_class
+      @select_options     = {}
 
       # Use either passed in filterrific_params or resource class' default_settings.
       # Don't merge the hashes. This causes trouble if an option is set to nil
@@ -18,33 +20,9 @@ module Filterrific
       # Persistence, baby. By the time you submit changes to one dimension, all the others
       # will be already initialized with the defaults.
       filterrific_params = resource_class.filterrific_default_settings  if filterrific_params.blank?
-
-      # force all keys to strings
       filterrific_params.stringify_keys!
-
-      # condition filterrific_params
-      filterrific_params.each do |key, val|
-        case
-        when val.is_a?(Proc)
-          # evaulate Procs
-          filterrific_params[key] = val.call
-        when val.is_a?(Array)
-          # type cast integers in the array
-          filterrific_params[key] = filterrific_params[key].map { |e| e =~ /^\d+$/ ? e.to_i : e }
-        when val =~ /^\d+$/
-          # type cast integer
-          filterrific_params[key] = filterrific_params[key].to_i
-        end
-      end
-
-      # Define attr_accessor for each filterrific_filter_name
-      # on Filterrific::ParamSet instance and assign values from options
-      resource_class.filterrific_filter_names.each do |filter_name|
-        self.class.send(:attr_accessor, filter_name)
-        v = filterrific_params[filter_name]
-        self.send("#{ filter_name }=", v)  if v.present?
-      end
-
+      filterrific_params = condition_filterrific_params(filterrific_params)
+      define_attr_accessors_for_each_filter(filterrific_params)
     end
 
     # Returns Filterrific::ParamSet as hash (used for URL params and serialization)
@@ -69,14 +47,52 @@ module Filterrific
       to_hash.to_json
     end
 
+    # Returns a signature that is unique to self's params
+    def signature
+      Digest::SHA1.hexdigest(to_hash.to_a.sort.to_s)
+    end
+
     # Returns true if this Filterrific::ParamSet is not the model's default.
-    # TODO: this doesn't work for procs. I need to evaluate the 
+    # TODO: this doesn't work for procs. I need to evaluate the
     # filterrific_default_settings before comparing them to to_hash.
     #
     # def customized?
     #   resource_class.filterrific_default_settings != to_hash
     # end
 
+  protected
+
+    # Conditions params
+    # @param[Hash] fp 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
+          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+$/
+          # type cast integer
+          fp[key] = fp[key].to_i
+        end
+      end
+      fp
+    end
+
+    # Defines attr accessors for each filter name on self and assigns
+    # values based on fp
+    # @param[Hash] fp filterrific_params
+    def define_attr_accessors_for_each_filter(fp)
+      resource_class.filterrific_filter_names.each do |filter_name|
+        self.class.send(:attr_accessor, filter_name)
+        v = fp[filter_name]
+        self.send("#{ filter_name }=", v)  if v.present?
+      end
+    end
+
   end
 
 end

data/lib/filterrific/version.rb

@@ -1,3 +1,3 @@
 module Filterrific
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/spec/param_set_spec.rb

@@ -106,4 +106,24 @@ describe Filterrific::ParamSet do
 
   end
 
+  describe "#select_options" do
+    it "exists" do
+      expect(filterrific_param_set.select_options).to eq({})
+    end
+
+    it "does not let you set itself" do
+      expect{filterrific_param_set.select_options = nil}.to raise_error
+    end
+
+    it "lets you set a value" do
+      expect{filterrific_param_set.select_options[:value] = 1}.not_to raise_error
+    end
+
+    it "returns the same value you set" do
+      value = rand(1..200)
+      filterrific_param_set.select_options[:value] = value
+      expect(filterrific_param_set.select_options[:value]).to eq(value)
+    end
+  end
+
 end

data/vendor/assets/javascripts/filterrific-jquery.js

@@ -80,7 +80,7 @@ Filterrific.submitFilterForm = function(){
 
 
 // Initialize event observers on document ready
-jQuery(function($){
+jQuery(document).ready(function($) {
   // Add change event handler to all Filterrific filter inputs.
   $(document).on(
     "change",

metadata

@@ -1,110 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: filterrific
 version: !ruby/object:Gem::Version
-  version: 1.2.0
-  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors:
 - Jo Hund
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-16 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Filterrific is a Rails Engine plugin that makes it easy to add filtering,
@@ -116,21 +89,21 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - MIT-LICENSE
-- Rakefile
 - README.md
+- Rakefile
+- doc/Overview diagram.graffle/data.plist
+- doc/Overview diagram.graffle/image1.tiff
 - doc/development_notes/api_design.txt
 - doc/development_notes/controller_api.txt
 - doc/development_notes/model_api.rb
 - doc/development_notes/view_api.txt
 - doc/meta.md
-- doc/Overview diagram.graffle/data.plist
-- doc/Overview diagram.graffle/image1.tiff
+- lib/filterrific.rb
 - lib/filterrific/action_view_extension.rb
 - lib/filterrific/active_record_extension.rb
 - lib/filterrific/engine.rb
 - lib/filterrific/param_set.rb
 - lib/filterrific/version.rb
-- lib/filterrific.rb
 - spec/action_view_extension_spec.rb
 - spec/active_record_extension_spec.rb
 - spec/filterrific_spec.rb
@@ -141,26 +114,25 @@ files:
 homepage: http://filterrific.clearcove.ca
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Rails engine plugin for filtering ActiveRecord lists.
 test_files: []