filterrific 5.2.1 → 5.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1fa8a5a4ff398442a2c78dea54460d53e142dca
-  data.tar.gz: 591c17e9e1832475dbfa4bf10c74cd57b6a1a6f4
+  metadata.gz: 5226106f7944a5b6c08d8f568185d4e6fcf0c561
+  data.tar.gz: 2e4b24d697de15d10a5dddf6a7b444b5564950ed
 SHA512:
-  metadata.gz: 71625782430ff42eb28fed1f5a8ec9ec6a5d12bf303bb0a1616e2e5313dc5be8c59dbd207b616f9a80ab94674c23a126052b211cbaa3398a657d8151d3077c09
-  data.tar.gz: b6870c78b8d46659b75bc1b8cdcad8ac1190005fe513653e0d40c2697b6808bb44e965ac18f31678e5617b03db75ae96f24b2d25479e465d39f7468522c98fe1
+  metadata.gz: 7829c794eb5e1a2e19a95cbb2e9651550f8c6cb5c123709a78c5fd5658c569a2c78963144f68b07cb30de9d28372ad3bfaf0087499a91f48f2e5c0597ed09d02
+  data.tar.gz: 4c7894ba6c9c1e9e5cde222bd69a088761dda82ccc01c0a1c12a1db4ed9e489b1f03b008bdc09dad8563355d95f138491cc17bd5c78174f1b9f6b46c3a4f0ec9

data/CHANGELOG.md

@@ -7,6 +7,13 @@ 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.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.

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

@@ -38,8 +38,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,38 @@
 # Filterrific scratchpad
 
+## 2021 Initiative
+
+* Update for Rails 6
+* Implement API only version (no frontend)
+* Update scope docs to use AREL
+* Implement/document various front end scenarios:
+    * React
+    * Stimulus
+    * jQuery
+    * sprockets/webpacker
+    * Thoughts: Support the rails defaults (webpacker or sprockets?) out of the box, batteries included. Document how to do everything else.
+* Work through issues and pull requests
+
+improve the filterrific frontend handling:
+
+* Remove invocation of init, document for devs to do it manually
+  https://github.com/jhund/filterrific/issues/199
+* Replace jquery with vanilla JS
+* Provide filterrific API version
+* Make compatible with Rails 6
+    * Remove jquery dependency, make it easier to use with webpacker, document how to do init
+      https://github.com/jhund/filterrific/issues/198
+
+* Support the following js scenarios:
+    * Sprockets
+    * Webpacker
+    * API only (e.g., for React)
+
+
 ## 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

@@ -101,7 +101,7 @@ module Filterrific
           # 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.1"
+  VERSION = "5.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filterrific
 version: !ruby/object:Gem::Version
-  version: 5.2.1
+  version: 5.2.2
 platform: ruby
 authors:
 - Jo Hund
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2021-07-12 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
@@ -66,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: A Rails engine plugin for filtering ActiveRecord lists.