filterrific 5.2.0 → 5.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3503569504542aef40ac725cf71644ff6df5eb49
-  data.tar.gz: 95cba3781467d0a1c96cdbfd05381afbd27d0e12
+SHA256:
+  metadata.gz: 67e7935ca4ceb8fce5778b36879ee941aef8105f23e8a211d070eb6c8cc2cd82
+  data.tar.gz: 5285cb9d2f1c18988f00a82b51733cccbbef67fe02f9f673754a3c2387117c56
 SHA512:
-  metadata.gz: d1641bc77e7522db73133f6b7b3f55af5d0ce10240f1da252d498b2ace1c0d6c0967a4c708b0d20a6681de43173d393c8aeba0a389ed653ed3942cefab0d9b9d
-  data.tar.gz: 0e4acf669d4aeb877e1ec6132de3adf7a91f94eaa4ecdc552cd2149e2ca705d1096f4c456392a6157fcc0ab740a6c27d8d6ccf650c26f211d70587628e0f8a81
+  metadata.gz: 797e8e2c763a3949277f1fd1e1bd2521adbac190175286331c59dd7cba17636c41ffeb6dda91325cb45bfe97c497934124b8a92c9d3ebd625a8744068337d6e5
+  data.tar.gz: 4272dfb90de22d22e494a9d1d800daec913ba1a64a3f7e3c399ee6e91de11aa4b82e569ad2dbd9c75f9da9b71a88860046333a6c19cc39a2e8a711da92d88a4b

data/CHANGELOG.md

@@ -7,6 +7,21 @@ 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.
 
+## [5.2.3] - Mar. 18, 2022
+
+* Added support for Rails 7
+
+## [5.2.2] - Jul. 11, 2021
+
+* Fixed Ruby 2.7 deprecated warning when trying to regex match an Integer.
+* Added ability to pass custom url parameter instead of default :filterrific.
+* Added basic Aria attrs to spinner for accessibility.
+* Improved concurrent ajax requests: Abort prior request when new ones are triggered.
+
+## [5.2.1] - Aug. 5, 2019
+
+* Fixed issue where uncommitted code was pushed to rubygems and broke array filters.
+
 ## [5.2.0] - Jul. 21, 2019
 
 * Make Filterrific master branch compatible with Rails 5 and 6.

data/README.md

@@ -39,13 +39,13 @@ to find out more!
 
 Every commit to Filterrific is automatically tested against the following scenarios:
 
-|Filterrific version | Rails version  | Ruby environments              | Database adapters                  | Build status |
-|--------------------|----------------|--------------------------------|------------------------------------|--------------|
-| 5.x                | Rails 5.x, 6.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 | Not tested|
-| 2.x                | Rails 3.2      | MRI 1.9.3                      | mysql, mysql2, postgresql, sqlite3 | Not tested|
-| 1.x                | < 3.2          | MRI <= 1.9.3                   | mysql, mysql2, postgresql, sqlite3 | Not tested|
+|Filterrific version | Rails version       | Ruby environments              | Database adapters                  | Build status |
+|--------------------|---------------------|--------------------------------|------------------------------------|--------------|
+| 5.x                | Rails 5.x, 6.x, 7.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 | Not tested|
+| 2.x                | Rails 3.2           | MRI 1.9.3                      | mysql, mysql2, postgresql, sqlite3 | Not tested|
+| 1.x                | < 3.2               | MRI <= 1.9.3                   | mysql, mysql2, postgresql, sqlite3 | Not tested|
 
 ### Guidelines for submitting issues
 

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

@@ -25,8 +25,14 @@ Filterrific.submitFilterForm = function(){
   $(form).trigger('loadingFilterrificResults');
   // turn on spinner
   $('.filterrific_spinner').show();
+
+  // Abort previous ajax request
+  if (Filterrific.lastRequest && Filterrific.lastRequest.readyState != 4) {
+    Filterrific.lastRequest.abort();
+  }
+
   // Submit ajax request
-  $.ajax({
+  Filterrific.lastRequest = $.ajax({
     url: url,
     data: form.serialize(),
     type: 'GET',

data/doc/development_notes/javascript_handling.md

@@ -0,0 +1,12 @@
+# Filterrific JS handling
+
+Filterrific JS and assets can be used in a number of scenarios:
+
+## Rails Sprockets (asset pipeline)
+
+## Rails with webpacker
+
+* https://www.reddit.com/r/rails/comments/d4o691/can_webpacker_pull_in_assets_from_a_rails_engine/
+
+## No JS assets, just API mode
+

data/doc/development_notes/view_api.txt

@@ -1,3 +1,7 @@
+Flexport's style guide has interesting guidelines for filter widgets:
+
+https://www.flexport.com/design/guidelines/filtering
+
 All view related aspects of filterrific are handled via the view API:
 
 <%= filterrific_form_for @filterrific do |f| %>

data/doc/meta.md

@@ -5,7 +5,6 @@ I use the gem-release gem
 For more info see: https://github.com/svenfuchs/gem-release#usage
 
 
-
 ## Steps for an update
 
 1. Update code and commit it.
@@ -15,17 +14,33 @@ For more info see: https://github.com/svenfuchs/gem-release#usage
    * `gem bump --version major` # 0.0.1 -> 1.0.0
    * `gem bump --version minor` # 0.0.1 -> 0.1.0
    * `gem bump --version patch` # 0.0.1 -> 0.0.2
-4. Release it.
+4. Make sure there are no uncommitted changes! They will be pushed to rubygems.
+5. Release it.
    * `gem release`
-5. Create a git tag and push to origin.
+6. Create a git tag and push to origin.
    `gem tag`
 
 
-
 ## How to run specs
 
-`bundle exec rake`
+`bundle exec rake` in the filterrific repo
+
+
+## How to support a new major Rails version
+
+Follow these steps when starting support for a new Rails major version:
+
+* In `filterrific`
+   * Archive the current major rails version into a new branch off of master, e.g., when starting to support Rails 6, create a new branch for `5.x` from current master. This will be the branch used for ongoing 5.x support, and all new development for Rails 6 will happen in the `master` branch.
+   * Make all changes required to support a new version of Rails.
+   * Release the first `filterrific` version for Rails 6: `6.0.0`.
 
+* In `filterrific_demo`
+   * Following the same example for Rails 6:
+   * Make sure that the `5.x` branch is up-to-date with master, and with current filterrific.
+   * Create a new `6.x` branch. In that branch create a brand new rails app using a current version of Rails 6.
+   * Make sure that the app works with the relevant version of `filterrific`.
+   * Deploy demo app to heroku.
 
 
 ## Travis CI
@@ -37,8 +52,8 @@ a branch for each minor version of Rails that is tested and supported.
 Sequence of a release:
 
 * finish updates in filterrific
-* run specs in each filterrific_demo branch (via `rake`)
-* when all specs pass, release filterrific (see above for steps)
+* update filterrific_demo Gemfile to refer to local filterrific via path: "../filterrific"
+* start the app and exercise it (currently there are no automated tests)
+* when everything works as expected, release filterrific (see above for steps)
 * after new filterrific is released, add new release version to each branch in
-  filterrific_demo and push each branch to trigger a Travis CI build for the
-  new filterrific release.
+  filterrific_demo.

data/doc/scratchpad.md

@@ -1,8 +1,10 @@
 # Filterrific scratchpad
 
+## 2021 Initiative
+
 ## TODO
 
-* add check that no filter_name conflicts with existing methods on included ActiveRecord class (See https://github.com/jhund/filterrific/issues/17)
+* Update SW architecture and documentation according to Osterhuis Philosophy of software architecture/design book (mark advanced controller options as such to keep interface to learn simple)
 
 ## Travis
 

data/lib/filterrific/action_view_extension.rb

@@ -27,7 +27,7 @@ module Filterrific
     def render_filterrific_spinner
       %(
         <span class="filterrific_spinner" style="display:none;">
-          #{ image_tag('filterrific/filterrific-spinner.gif') }
+          #{ image_tag('filterrific/filterrific-spinner.gif', alt: '', role: 'presentation') }
         </span>
       ).html_safe
     end
@@ -74,6 +74,7 @@ module Filterrific
         :label => sort_key.to_s.humanize,
         :sorting_scope_name => :sorted_by,
         :url_for_attrs => {},
+        :as => :filterrific
       }.merge(opts)
       opts.merge!(
         :html_attrs => opts[:html_attrs].with_indifferent_access,
@@ -110,7 +111,7 @@ module Filterrific
       new_filterrific_params = filterrific.to_hash
                                           .with_indifferent_access
                                           .merge(opts[:sorting_scope_name] => new_sorting)
-      url_for_attrs = opts[:url_for_attrs].merge(:filterrific => new_filterrific_params)
+      url_for_attrs = opts[:url_for_attrs].merge(opts[:as] => new_filterrific_params)
       link_to(
         safe_join([opts[:label], opts[:current_sort_direction_indicator]], ' '),
         url_for(url_for_attrs),
@@ -133,7 +134,7 @@ module Filterrific
       new_filterrific_params = filterrific.to_hash
                                           .with_indifferent_access
                                           .merge(opts[:sorting_scope_name] => new_sorting)
-      url_for_attrs = opts[:url_for_attrs].merge(:filterrific => new_filterrific_params)
+      url_for_attrs = opts[:url_for_attrs].merge(opts[:as] => new_filterrific_params)
       link_to(
         opts[:label],
         url_for(url_for_attrs),

data/lib/filterrific/param_set.rb

@@ -96,12 +96,12 @@ module Filterrific
           fp[key] = val.call
         when val.is_a?(Array)
           # type cast integers in the array
-          fp[key] = fp[key].map { |e| e =~ integer_detector_regex ? e.to_i : e }.find_all { |e| }
+          fp[key] = fp[key].map { |e| e =~ integer_detector_regex ? 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 =~ integer_detector_regex
+        when val.is_a?(String) && val =~ integer_detector_regex
           # 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 = "5.2.0"
+  VERSION = "5.2.3"
 end

data/lib/filterrific.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
-if ![5,6].include?(Rails::VERSION::MAJOR)
-  raise "\n\nThis version of Filterrific only works with Rails 5 and 6.\nPlease see the Filterrific README for the correct version of Filterrific to use with your version of Rails!\n\n"
+if ![5,6,7].include?(Rails::VERSION::MAJOR)
+  raise "\n\nThis version of Filterrific only works with Rails 5, 6 and 7.\nPlease see the Filterrific README for the correct version of Filterrific to use with your version of Rails!\n\n"
 end
 
 require 'filterrific/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filterrific
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.2.3
 platform: ruby
 authors:
 - Jo Hund
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-21 00:00:00.000000000 Z
+date: 2022-03-18 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.
@@ -28,6 +28,7 @@ files:
 - doc/Overview diagram.graffle/image1.tiff
 - doc/development_notes/api_design.txt
 - doc/development_notes/controller_api.txt
+- doc/development_notes/javascript_handling.md
 - doc/development_notes/model_api.rb
 - doc/development_notes/view_api.txt
 - doc/meta.md
@@ -65,8 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A Rails engine plugin for filtering ActiveRecord lists.