filterrific 2.1.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad148673088fdac9894406d0412de1b2e7009244
-  data.tar.gz: cddde32256c96b655c8ffabe6d9dce532d455ac4
+  metadata.gz: 771515c7025eb50eb134294d03a3a92006e7bd13
+  data.tar.gz: 050cae50516c688d0decb04e42867ea6b850368e
 SHA512:
-  metadata.gz: f2b7d359e7bc6e8ccef3d1c30ac7d8fb187c4925ea94baff7476440ad7d69c246997d4c056bc3abbff18eaf550cf81f42aaad0200821c61390502d15ccf0b5d9
-  data.tar.gz: 37d7a118f6d49f3251496630909ef4361dfc0467a115ea01d5e9fcc813b2e3b5370c976bb947f2442920cc991f09ea50bf74de3ec2a10fd0b8ac49027ed97239
+  metadata.gz: 4acf9f6d39fa6c2aa6bd1820fbfe760ca39df1acd19494cd9010afc5ae027d625291a34ad42f5ded6b737ac3a60a5ca143e9559c79fa2f40dd87df6e38417024
+  data.tar.gz: 6c15ede2f3ab0f0cf36a885dbc4d9826c13fa37978a916aed0718e123644efee580b7468178edd339490975fb58605dc1dcb7737d6287e57f0f739ab2cef3a13

data/CHANGELOG.md

@@ -1,53 +1,25 @@
-* using the "sorted_by" magic method will add entries to select_options automatically
-    filterrific(
-      default_filter_params: { sorted_by: 'name_asc' },
-      available_filters: [
-        :with_country,
-        ...
-      ],
-      search_query: {
-        match_terms: :any, # [:all]
-        auto_wildcard: :suffix, # [:prefix, :both, :none]
-        columns: [:first_name, :email, :last_name],
-        case_sensitive: false, # [true]
-      },
-      sorted_by: {
-        name_asc: 'Name (A-Z)',
-        name_desc: 'Name (Z-A)',
-      },
-    )
-
-    filterrific(
-      default_filter_params: { sorted_by: 'name_asc' },
-      custom_scopes: [
-        :with_country,
-        ...
-      ],
-      lookup_filters: [ # column_value_filters:, value_filters:
-        :with_country_id,
-        :with_state,
-      ]
-      search_query: {
-        match_terms: :any, # [:all]
-        auto_wildcard: :suffix, # [:prefix, :both, :none]
-        columns: [:first_name, :email, :last_name],
-        case_sensitive: false, # [true]
-      },
-      sorted_by: {
-        name_asc: 'Name (A-Z)',
-        name_desc: 'Name (Z-A)',
-      },
-    )
-
-### 2.1.2
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+Filterrific major versions match the Ruby on Rails major versions they work with.
+
+## [3.0.0] - Dec. 31, 2017
+
+* This is the first release of Filterrific specifically geared towards Rails 3.x. No functional changes, just new versioning system and removal of unused code.
+
+## [2.1.2] - Nov. 11, 2016
 
 * Removed older way of initializing assets, relying on config/initializers/assets.rb for all versions of Rails.
 
-### 2.1.1
+## [2.1.1] - Nov. 11, 2016
 
 * Reverted asset initialization back to working state for versions prior to Rails5.
 
-## 2.1.0
+## [2.1.0] - Nov. 6, 2016
 
 * Updated filterrific for Rails 5 compatibility:
     * Turbolinks compatibility (thanks @olegantonyan)
@@ -58,7 +30,7 @@
 * Improved param casting to Int: hyphens and zeros (thanks @grit96)
 
 
-### 2.0.5
+## [2.0.5] - May 4, 2015
 
 * Feature: Allow disabling of session persistence by passing `false` as
   `:persistence_id` option.
@@ -68,7 +40,7 @@
 
 
 
-### 2.0.4
+## [2.0.4] - Mar. 10, 2015
 
 * Objectify nested params so that they render correctly on the form when
   restored from session or URL params.
@@ -77,26 +49,26 @@
 
 
 
-### 2.0.3
+## [2.0.3] - Jan. 30, 2015
 
 * Cleaned up obsolete option names
 
 
 
-### 2.0.2
+## [2.0.2] - Jan. 28, 2015
 
 * Fixed bugs in ActionControllerExtension
 * Improved test coverage
 
 
 
-### 2.0.1
+## [2.0.1] - Jan. 28, 2015
 
 * Fixed regression with Rails 3.2 (doesn't support `#deep_stringify_keys`)
 
 
 
-# 2.0.0
+## [2.0.0] - Jan. 28, 2015
 
 API changes:
 
@@ -114,25 +86,25 @@ API changes:
 
 
 
-### 1.4.3
+## [1.4.3] - Jan. 12, 2015
 
 * Handle case where Filterrific filter params are empty.
 
 
 
-### 1.4.2
+## [1.4.2] - Oct. 18, 2014
 
 * Updated initialization of ActiveRecord and ActionView extensions again
 
 
 
-### 1.4.1
+## [1.4.1] - Oct. 15, 2014
 
 * Updated initialization of ActiveRecord and ActionView extensions
 
 
 
-### 1.4.0
+## [1.4.0] - Oct. 13, 2014
 
 * Better support for new versions of Rails (integration tests are done in filterrific_demo)
 * Fixed asset pipeline for filterrific-spinner.gif.
@@ -143,13 +115,13 @@ API changes:
 
 
 
-### 1.3.1
+## [1.3.1] - Jun. 18, 2014
 
 * Changed ParamSet#select_options so that a complete hash can be assigned
 
 
 
-## 1.3.0
+## [1.3.0] - Jun. 3, 2014
 
 * Added ParamSet#select_options (thanks @pnomolos).
 * Added ParamSet#signature to quickly test two param_sets for equality.
@@ -164,7 +136,7 @@ API changes:
 
 
 
-## 1.2.0
+## [1.2.0] - May 16, 2013
 
 * Added simple wrapper for Filterrific::ParamSet.new so that it can be
   instantiated with Filterrific.new instead of Filterrific::ParamSet.new.
@@ -177,7 +149,7 @@ API changes:
 
 
 
-## 1.1.0
+## [1.1.0] - May 8, 2013
 
 * Major refactor.
 * Added specs.
@@ -186,25 +158,25 @@ API changes:
 
 
 
-### 1.0.1
+## [1.0.1] - Nov. 9, 2011
 
 * Bug fix: Replaced stringify_keys with map.to_s (filter_names is an Array, not a Hash!).
 
 
 
-# 1.0.0
+## [1.0.0] - Nov. 9, 2011
 
 * Support for Rails 3.1.
 * New model api.
 
 
 
-## 0.1.0, released 2010-08-01
+## [0.1.0] - Aug. 1, 2010
 
 * Replicate functionality of Rails 2.3 version.
 
 
 
-### 0.0.1, released 2010-07-30
+## [0.0.1] - Jul. 30, 2010
 
 * Initial setup.

data/README.md

@@ -1,17 +1,24 @@
-Filterrific
-===========
+# Filterrific
 
 Filterrific is a Rails Engine plugin that makes it easy to filter,
 search, and sort your ActiveRecord lists:
 
+
+### Features
+
+* Makes heavy use of ActiveRecord Scopes
+* ActionController helpers to shuttle filter params from ActionView forms to ActiveRecord based models, and to return matching records back from ActiveRecord to ActionView.
+* Form helpers to build powerful search and filter forms with ease.
+* Javascript assets to auto-submit filter form on change via AJAX.
+* Image asset to show a spinner in the Filterrific form when new records are being loaded via AJAX.
+* API option to use Filterrific with Rails API mode. Just use `gem 'filterrific', require: 'filterrific_api'` in your Gemfile.
+
 ***
 
 ![A filterrific enhanced list](https://github.com/jhund/filterrific/blob/gh-pages/images/screenshot_s.png)
 
 ***
 
-Make sure to go to the fantastic [Filterrific documentation](http://filterrific.clearcove.ca)
-to find out more!
 
 ### Installation
 
@@ -22,6 +29,12 @@ or with bundler in your Gemfile:
 `gem 'filterrific'`
 
 
+### Usage
+
+Make sure to go to the fantastic [Filterrific documentation](http://filterrific.clearcove.ca)
+to find out more!
+
+
 ### Compatibility
 
 Every commit to Filterrific is automatically tested against the following scenarios:
@@ -78,4 +91,4 @@ If you think you've found a bug, or have a feature request, then create an issue
 
 ### Copyright
 
-Copyright (c) 2010 - 2016 Jo Hund. See [(MIT) LICENSE](https://github.com/jhund/filterrific/blob/master/MIT-LICENSE) for details.
+Copyright (c) 2010 - 2018 Jo Hund. See [(MIT) LICENSE](https://github.com/jhund/filterrific/blob/master/MIT-LICENSE) for details.

data/doc/scratchpad.md

@@ -2,6 +2,10 @@
 
 ## TODO
 
+* Go to deep_stringify_keys (in ActionControllerExtension#initialize_filterrific)
+* Lock Gemfile to correct version of Rails
+* Add Rails major version check to filterrific.rb
+* In ParamSet#condition_filterrific_params: Why are we type casting integers?
 * add check that no filter_name conflicts with existing methods on included ActiveRecord class (See https://github.com/jhund/filterrific/issues/17)
 * fix reset url, make controller method, helper method
 

data/lib/filterrific.rb

@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
 
+if Rails::VERSION::MAJOR != 3
+  raise "\n\nThis version of Filterrific only works with Rails 3.x.\nPlease see the Filterrific README for the correct version of Filterrific to use with your version of Rails!\n\n"
+end
+
 require 'filterrific/version'
 require 'filterrific/engine'
 

data/lib/filterrific/action_controller_extension.rb

@@ -27,8 +27,6 @@ module Filterrific
     #   dynamic values.
     # @return [Filterrific::ParamSet]
     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
       pers_id = if false == opts['persistence_id']

data/lib/filterrific/active_record_extension.rb

@@ -54,12 +54,9 @@ module Filterrific
       ar_rel = if ActiveRecord::Relation === self
         # self is already an ActiveRecord::Relation, use as is
         self
-      elsif Rails::VERSION::MAJOR <= 3
-        # Active Record 3: send `:scoped` to class to get an ActiveRecord::Relation
-        scoped
       else
-        # Active Record 4 and later: Send `:all` to class to get an ActiveRecord::Relation
-        all
+        # Send `:scoped` to class to get an ActiveRecord::Relation
+        scoped
       end
 
       # Apply filterrific params

data/lib/filterrific/engine_api.rb

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+require 'filterrific/param_set'
+
+require 'filterrific/action_controller_extension'
+require 'filterrific/active_record_extension'
+
+module Filterrific
+  class EngineApi < ::Rails::Engine
+
+TODO: Since this is API only, I don't think we need an engine!
+    # It's an engine so that we can add javascript and image assets
+    # to the asset pipeline.
+
+    isolate_namespace Filterrific
+
+    ActiveSupport.on_load :action_controller do
+      include Filterrific::ActionControllerExtension
+    end
+
+    ActiveSupport.on_load :active_record do
+      extend Filterrific::ActiveRecordExtension
+    end
+
+  end
+end

data/lib/filterrific/param_set.rb

@@ -45,13 +45,6 @@ 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
@@ -83,7 +76,6 @@ module Filterrific
   protected
 
     # Conditions params: Evaluates Procs and type casts integer values.
-    # TODO: Why are we type casting integers?
     # @param fp [Hash] the filterrific params hash
     # @return[Hash] the conditioned params hash
     def condition_filterrific_params(fp)

data/lib/filterrific/version.rb

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

data/lib/filterrific_api.rb

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+
+require 'filterrific/version'
+require 'filterrific/engine_api'
+
+module Filterrific
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filterrific
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Jo Hund
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2017-12-30 00:00:00.000000000 Z
 dependencies: []
 description: Filterrific is a Rails Engine plugin that makes it easy to filter, search,
   and sort your ActiveRecord lists.
@@ -37,9 +37,11 @@ files:
 - lib/filterrific/action_view_extension.rb
 - lib/filterrific/active_record_extension.rb
 - lib/filterrific/engine.rb
+- lib/filterrific/engine_api.rb
 - lib/filterrific/has_reset_filterrific_url_mixin.rb
 - lib/filterrific/param_set.rb
 - lib/filterrific/version.rb
+- lib/filterrific_api.rb
 - spec/filterrific/action_controller_extension_spec.rb
 - spec/filterrific/action_view_extension_spec.rb
 - spec/filterrific/active_record_extension_spec.rb
@@ -66,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A Rails engine plugin for filtering ActiveRecord lists.