filterrific 4.0.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3399bb18bfa5191cd87ee2b7d31c806a290aee45
-  data.tar.gz: dd3f5b946c313509c89006122652d7c27cb28140
+  metadata.gz: b450ac700cb2087731e8d30c8c4e94bc7f90df26
+  data.tar.gz: fce6b4218644562383de7f9a9bfdf9d71fd75c5f
 SHA512:
-  metadata.gz: 1ba9f0d838ce2c7880ecf34c30ab2c2cd04fcbbe36d58875eba52d5d88fee4abce66aac499270c4bcfc458b6ee25d70a880e86293db00e265ea376cc7239f544
-  data.tar.gz: b22987d4aec16b97b018b93869d6987a90aac4e43086674941c761e8067816630504dd7ae858955deede691143061c0786c0d263b6f5f27769910631bf87d38d
+  metadata.gz: 2137ab79b5a0bdd7d40d07046208ec8f5b3d73ad7f883f2ea3d5516c00c5c1fb5eb17c811b30bb6f4001549eb5168ec3b38b7038bbca925d87c969591c423b81
+  data.tar.gz: 4397b2c6d32ff3acc39fe4d3ea31f9d6799583b65c55a75bf7bf1e3f759eeb2b7ecd90d5ec853cfe9dc859085f0955b13fcbab3bebfc423a7bda8a8d278339e3

data/CHANGELOG.md

@@ -7,9 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 Filterrific major versions match the Ruby on Rails major versions they work with.
 
-## [4.0.1] - Apr. 6, 2018
+## [5.0.0] - Dec. 31, 2017
 
-* Updated Filterific JS initialization on page load.
+* We're switching to a new versioning strategy for Filterrific: Filterrific major releases (the first number in the version) will be matched with the supported major version of Rails. Minor and path versions may diverge from Rails. That means for any version of Rails 5.x you will use the most current version of Filterrific 5.x.
 
 ## [4.0.0] - Dec. 31, 2017
 

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,18 +29,23 @@ or with bundler in your Gemfile:
 `gem 'filterrific'`
 
 
-### Compatibility
+### Usage
 
-Every commit to Filterrific is automatically tested against the following scenarios:
+Make sure to go to the fantastic [Filterrific documentation](http://filterrific.clearcove.ca)
+to find out more!
 
-| Rails version | Ruby environments              | Database adapters                  | Build status |
-|---------------|--------------------------------|------------------------------------|--------------|
-| Rails 5.x     | MRI 2.0.0, 2.1.7, 2.2.3, 2.3.1 | mysql2, postgresql                 |[![Build Status](https://travis-ci.org/jhund/filterrific_demo.svg?branch=rails-5.x)](https://travis-ci.org/jhund/filterrific_demo)|
-| Rails 4.x     | MRI 2.0.0, 2.1.7, 2.2.3, 2.3.1 | mysql2, postgresql                 |[![Build Status](https://travis-ci.org/jhund/filterrific_demo.svg?branch=rails-4.x)](https://travis-ci.org/jhund/filterrific_demo)|
 
-Filterrific up to version 2.1.x should work on Rails 3.2 and Ruby 1.9.3. I stopped testing it though as it became too cumbersome to manage gem dependencies.
+### Compatibility
+
+Every commit to Filterrific is automatically tested against the following scenarios:
 
-Filterrific version 1.x should work on versions prior to Rails 3.2 and older Rubies, however the 1.x branch is not supported any more.
+|Filterrific version | Rails version | Ruby environments              | Database adapters                  | Build status |
+|--------------------|---------------|--------------------------------|------------------------------------|--------------|
+| 5.x                | Rails 5.x     | MRI 2.0.0, 2.1.7, 2.2.3, 2.3.1 | mysql2, postgresql                 |[![Build Status](https://travis-ci.org/jhund/filterrific_demo.svg?branch=rails-5.x)](https://travis-ci.org/jhund/filterrific_demo)|
+| 4.x                | Rails 4.x     | MRI 2.0.0, 2.1.7, 2.2.3, 2.3.1 | mysql, mysql2, postgresql, sqlite3 |[![Build Status](https://travis-ci.org/jhund/filterrific_demo.svg?branch=rails-4.x)](https://travis-ci.org/jhund/filterrific_demo)|
+| 3.x                | Rails 3.2     | MRI 2.0.0, 2.1.7               | mysql, mysql2, postgresql, sqlite3 |[![Build Status](https://travis-ci.org/jhund/filterrific_demo.svg?branch=rails-3.x)](https://travis-ci.org/jhund/filterrific_demo)|
+| 2.x                | Rails 3.2     | MRI 1.9.3                      | mysql, mysql2, postgresql, sqlite3 | [N/A]
+| 1.x                | < 3.2         | MRI <= 1.9.3                   | mysql, mysql2, postgresql, sqlite3 | [N/A]
 
 ### Guidelines for submitting issues
 

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

@@ -94,6 +94,15 @@ Filterrific.init = function() {
   );
 };
 
-// Handle with and without Turbolinks
-jQuery(document).ready(Filterrific.init);
-jQuery(document).on('page:load', Filterrific.init);
+
+// Initialize event observers on document ready and turbolinks page:load
+jQuery(document).on('turbolinks:load', function() {
+  // Prevent double initilisation. With turbolinks 5 this function
+  // will be called twice: on 'ready' and 'turbolinks:load'
+  jQuery(document).off('ready page:load')
+  Filterrific.init();
+});
+
+jQuery(document).on('ready page:load', function() {
+  Filterrific.init();
+});

data/doc/meta.md

@@ -9,7 +9,7 @@ For more info see: https://github.com/svenfuchs/gem-release#usage
 ## Steps for an update
 
 1. Update code and commit it.
-2. Add entry to CHANGELOG and commit it.
+2. Add entry to CHANGELOG and commit it
 3. Bump the version with one of these commands:
    * `gem bump --version 1.1.1` # Bump the gem version to the given version number
    * `gem bump --version major` # 0.0.1 -> 1.0.0

data/doc/scratchpad.md

@@ -2,7 +2,12 @@
 
 ## TODO
 
-* add check that no filter_name conflicts with existing methods on included ActiveRecord class (See https://github.com/jhund/filterrific/issues/17)
+* [x] Go to deep_stringify_keys (in ActionControllerExtension#initialize_filterrific)
+* [x] Lock Gemfile to correct version of Rails
+* [x] 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)
+* [x] I think this is done: fix reset url, make controller method, helper method
 
 ## Travis
 
@@ -25,6 +30,7 @@ Ruby 1.8.7
 Ruby 1.9.3
 Ruby 2.0
 Ruby 2.1
+Ruby 2.2    No         No         No         No
 
 Each combination is also tested for postgres and mysql
 

data/lib/filterrific.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
-if Rails::VERSION::MAJOR != 4
-  raise "\n\nThis version of Filterrific only works with Rails 4.x.\nPlease see the Filterrific README for the correct version of Filterrific to use with your version of Rails!\n\n"
+if Rails::VERSION::MAJOR != 5
+  raise "\n\nThis version of Filterrific only works with Rails 5.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'

data/lib/filterrific/action_controller_extension.rb

@@ -27,10 +27,8 @@ 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
+      f_params = (filterrific_params || {}).deep_stringify_keys
+      opts = opts.deep_stringify_keys
       pers_id = if false == opts['persistence_id']
         nil
       else
@@ -68,7 +66,7 @@ module Filterrific
         (persistence_id && session[persistence_id].presence) || # then try session persisted params if persistence_id is present
         opts['default_filter_params'] || # then use passed in opts
         model_class.filterrific_default_filter_params # finally use model_class defaults
-      ).stringify_keys
+      ).deep_stringify_keys
       r.slice!(*opts['available_filters'].map(&:to_s))  if opts['available_filters']
       r
     end

data/lib/filterrific/active_record_extension.rb

@@ -54,11 +54,8 @@ 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
+        # Send `:all` to class to get an ActiveRecord::Relation
         all
       end
 
@@ -101,7 +98,7 @@ module Filterrific
     def assign_filterrific_default_filter_params(opts)
       self.filterrific_default_filter_params = (
         opts['default_filter_params'] || {}
-      ).stringify_keys
+      ).deep_stringify_keys
     end
 
     def validate_filterrific_default_filter_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/version.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
 
 module Filterrific
-  VERSION = "4.0.1"
+  VERSION = "5.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: 4.0.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Jo Hund
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-07 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