filterable-by 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae571004dd8c2aebddad1f69b8a698b7f52f0fa5bb2d3338a74de5f6a9e18e1a
-  data.tar.gz: f1744d312f8b99eab4ada84590b65361e1cb183ef3a41ce1969569ca723880e5
+  metadata.gz: 5a5cdaf4511167346ca041eea0e8c3e472c0bea213429ffd7907a6f95501b7f8
+  data.tar.gz: 6e65a71a9e5aa47f41b37cfc5ac054213166e405fd9b3a81ea1054dca0ffb802
 SHA512:
-  metadata.gz: ce8c6eabe14c36dd917c8f30f29926a6ae88baa494067683912f63dd3af6445ca93b74426e1d24c3f8992e2d740d340a4bbb8b494c033872fb1a0ed51924e085
-  data.tar.gz: eed08234ac28e40f99fc786225bc2e65ead127808e93714d8747a30fcb0c4a01fe27b450f4dfa9de713d08d05cd1c65c2e6c4412402a0567b48d5f05a1b1011b
+  metadata.gz: d102876e053de4c60fdc714e0371977f389a0e3066a0538dfcb93b0e1ac8f20582fdb6ef86fe53991729c052ca85ffc22c89dca8bec80016e437d746cbd477ba
+  data.tar.gz: c8d8c948a1766a96abb88cab12f51648ebaf21c59e7e53b97cbc54f9778799d58d5baaf6f279d21a808139530076fee4ba47d7da7663e7f49df2a894a58f1d82

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  ruby:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.7", "3.0", "3.1"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.rubocop.yml

@@ -1,6 +1,11 @@
-inherit_from:
-  - https://gitlab.com/bsm/misc/raw/master/rubocop/default.yml
+inherit_gem:
+  rubocop-bsm:
+    - default.yml
+inherit_mode:
+  merge:
+    - Exclude
+
 AllCops:
-  TargetRubyVersion: "2.5"
+  TargetRubyVersion: "2.7"
 Naming/FileName:
   Exclude: [lib/filterable-by.rb]

data/Gemfile.lock

@@ -1,68 +1,77 @@
 PATH
   remote: .
   specs:
-    filterable-by (0.5.1)
+    filterable-by (0.6.0)
       activerecord
       activesupport
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activesupport (6.0.3.2)
+    activemodel (7.0.2.2)
+      activesupport (= 7.0.2.2)
+    activerecord (7.0.2.2)
+      activemodel (= 7.0.2.2)
+      activesupport (= 7.0.2.2)
+    activesupport (7.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.1)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.4.4)
-    i18n (1.8.3)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.5.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.1)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.87.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.25.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.1.0)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-bsm (0.6.0)
+      rubocop (~> 1.0)
+      rubocop-performance
+      rubocop-rake
+      rubocop-rspec
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
     sqlite3 (1.4.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.3.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -72,8 +81,8 @@ DEPENDENCIES
   filterable-by!
   rake
   rspec
-  rubocop
+  rubocop-bsm
   sqlite3
 
 BUNDLED WITH
-   2.1.4
+   2.3.6

data/README.md

@@ -1,5 +1,7 @@
 # Filterable By
 
+[![Test](https://github.com/bsm/filterable-by/actions/workflows/test.yml/badge.svg)](https://github.com/bsm/filterable-by/actions/workflows/test.yml)
+
 ActiveRecord plugin to parse e.g. a `filter` query parameter apply scopes. Useful for [JSON-API][jsonapi] compatibility.
 
 [jsonapi]: http://jsonapi.org/format/#fetching-filtering
@@ -15,15 +17,15 @@ class Comment < ActiveRecord::Base
   belongs_to :post
 
   filterable_by :post_id, :user_id
-  filterable_by :post_author_id do |scope, value|
-    scope.joins(:posts).where(:'posts.author_id' => value)
+  filterable_by :post_author_id do |value|
+    joins(:posts).where(:'posts.author_id' => value)
   end
-  filterable_by :only do |scope, value, **opts|
+  filterable_by :only do |value, **opts|
     case value
     when 'mine'
-      scope.where(user_id: opts[:user_id]) if opts[:user_id]
+      where(user_id: opts[:user_id]) if opts[:user_id]
     else
-      scope
+      all
     end
   end
 end
@@ -37,6 +39,12 @@ Simple use cases:
 Comment.filter_by({ 'post_id' => '1' })
 # => WHERE post_id = 1
 
+Comment.filter_by({ 'post_id' => ['1', '2'] })
+# => WHERE post_id IN (1, 2)
+
+Comment.filter_by({ 'post_id_not' => '3' })
+# => WHERE post_id != 3
+
 Comment.filter_by({ 'user_id' => '2', 'ignored' => '3' })
 # => WHERE user_id = 2
 

data/filterable-by.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'filterable-by'
-  s.version     = '0.5.1'
+  s.version     = '0.6.0'
   s.authors     = ['Dimitrij Denissenko']
   s.email       = ['dimitrij@blacksquaremedia.com']
   s.summary     = 'Generate white-listed filter scopes from URL parameter values'
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^spec/}) }
   s.test_files    = `git ls-files -z -- spec/*`.split("\x0")
   s.require_paths = ['lib']
-  s.required_ruby_version = '>= 2.5'
+  s.required_ruby_version = '>= 2.7'
 
   s.add_dependency 'activerecord'
   s.add_dependency 'activesupport'
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-bsm'
   s.add_development_dependency 'sqlite3'
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/filterable_by.rb

@@ -13,6 +13,28 @@ module ActiveRecord
       end
     end
 
+    def self.merge(scope, unscoped, hash, name, **opts, &block)
+      key = name
+      positive = normalize(hash[key]) if hash.key?(key)
+      if positive.present?
+        sub = block.arity == 2 ? yield(unscoped, positive, **opts) : yield(positive, **opts)
+        return nil unless sub
+
+        scope = scope.merge(sub)
+      end
+
+      key = "#{name}_not"
+      negative = normalize(hash[key]) if hash.key?(key)
+      if negative.present?
+        sub = block.arity == 2 ? yield(unscoped, negative, **opts) : yield(negative, **opts)
+        return nil unless sub
+
+        scope = scope.merge(sub.invert_where)
+      end
+
+      scope
+    end
+
     module ClassMethods
       def self.extended(base) # :nodoc:
         base.class_attribute :_filterable_by_config, instance_accessor: false, instance_predicate: false
@@ -26,28 +48,29 @@ module ActiveRecord
       end
 
       def filterable_by(*names, &block)
+        if block && block.arity > 1
+          ActiveSupport::Deprecation.warn('using scope in filterable_by blocks is deprecated. Please use filterable_by(:x) {|val| where(field: val) } instead.')
+        end
+
         names.each do |name|
-          _filterable_by_config[name.to_s] = block || ->(scope, value, **) { scope.where(name.to_sym => value) }
+          _filterable_by_config[name.to_s] = block || ->(value, **) { where(name.to_sym => value) }
         end
       end
 
-      # @param [Hash] hash the filter params
+      # @param [Hash|ActionController::Parameters] the filter params
       # @return [ActiveRecord::Relation] the scoped relation
       def filter_by(hash = nil, **opts)
         if hash.nil?
           hash = opts
           opts = {}
         end
+
         scope = all
-        return scope unless hash.is_a?(Hash)
+        return scope unless hash.respond_to?(:key?) && hash.respond_to?(:[])
 
         _filterable_by_config.each do |name, block|
-          next unless hash.key?(name)
-
-          value = FilterableBy.normalize(hash[name])
-          next if value.blank?
-
-          scope = block.call(scope, value, **opts)
+          scope = FilterableBy.merge(scope, unscoped, hash, name, **opts, &block)
+          break unless scope
         end
 
         scope || none

data/spec/{filterable_by_spec.rb → active_record/filterable_by_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper'
+require 'spec_helper'
 
 describe ActiveRecord::FilterableBy do
   let(:alice) { AUTHORS[:alice] }
@@ -7,13 +7,13 @@ describe ActiveRecord::FilterableBy do
   let(:apost) { POSTS[:alices] }
   let(:bpost) { POSTS[:bobs] }
 
-  it 'should have config' do
-    expect(Comment.send(:_filterable_by_config).count).to eq(3)
-    expect(Rating.send(:_filterable_by_config).count).to eq(2)
+  it 'has config' do
+    expect(Comment.send(:_filterable_by_config).count).to eq(5)
+    expect(Rating.send(:_filterable_by_config).count).to eq(4)
     expect(Post.send(:_filterable_by_config).count).to eq(2)
   end
 
-  it 'should ignore bad inputs' do
+  it 'ignores bad inputs' do
     expect(Comment.filter_by.count).to eq(4)
     expect(Comment.filter_by(nil).count).to eq(4)
     expect(Comment.filter_by(nil, extra: true).count).to eq(4)
@@ -23,7 +23,7 @@ describe ActiveRecord::FilterableBy do
     expect(Comment.filter_by('author_id' => []).count).to eq(4)
   end
 
-  it 'should generate simple scopes' do
+  it 'generates simple scopes' do
     expect(Comment.filter_by('author_id' => alice.id).pluck(:title)).to match_array(%w[AA AB])
     expect(Comment.filter_by('author_id' => bob.id).pluck(:title)).to match_array(%w[BA BB])
     expect(Comment.filter_by('author_id' => [alice.id, '']).pluck(:title)).to match_array(%w[AA AB])
@@ -40,7 +40,7 @@ describe ActiveRecord::FilterableBy do
     expect(Post.filter_by('author_id' => bob.id).count).to eq(1)
   end
 
-  it 'should generate combined scopes' do
+  it 'generates combined scopes' do
     expect(Comment.filter_by('author_id' => alice.id, 'post_id' => apost.id).pluck(:title)).to match_array(['AA'])
     expect(Comment.filter_by('author_id' => alice.id, 'post_id' => bpost.id).pluck(:title)).to match_array(['AB'])
     expect(Comment.filter_by('author_id' => bob.id, 'post_id' => apost.id).pluck(:title)).to match_array(['BA'])
@@ -50,12 +50,20 @@ describe ActiveRecord::FilterableBy do
     expect(scope.pluck(:title)).to match_array(%w[AB BB])
   end
 
-  it 'should combine with other scopes' do
+  it 'generates negated scopes' do
+    expect(Comment.filter_by('author_id_not' => alice.id).pluck(:title)).to match_array(%w[BA BB])
+    expect(Comment.filter_by('author_id_not' => [alice.id, bob.id]).pluck(:title)).to match_array(%w[])
+    expect(Comment.filter_by('post_id_not' => apost.id).pluck(:title)).to match_array(%w[AB BB])
+    expect(Comment.filter_by('post_author_id_not' => alice.id).pluck(:title)).to match_array(%w[AB BB])
+    expect(Comment.filter_by('author_id' => bob.id, 'post_id_not' => bpost.id).pluck(:title)).to match_array(['BA'])
+  end
+
+  it 'combines with other scopes' do
     scope = Comment.where(author_id: alice.id).filter_by('post_id' => apost.id)
     expect(scope.pluck(:title)).to match_array(['AA'])
   end
 
-  it 'should allow custom options' do
+  it 'allows custom options' do
     scope = Post.filter_by({ 'only' => 'me' }, user_id: alice.id)
     expect(scope).to match_array([apost])
 
@@ -66,15 +74,21 @@ describe ActiveRecord::FilterableBy do
     expect(scope.count).to eq(0)
   end
 
-  it 'should allow custom options from params' do
+  it 'allows custom options from params' do
     filter = { 'only' => 'me' }
     expect(Post.filter_by(filter, user_id: alice.id)).to match_array([apost])
     expect(Post.filter_by(filter).count).to eq(0)
   end
 
-  it 'should ignore invalid scopes' do
+  it 'ignores invalid scopes' do
     expect(Comment.filter_by('invalid' => 1).count).to eq(4)
     expect(Post.filter_by('post_id' => bpost.id).count).to eq(2)
     expect(Rating.filter_by('post_author_id' => bob.id).count).to eq(1)
   end
+
+  it 'supports deprecated scoping' do
+    expect(Comment.filter_by('deprecated' => alice.id).pluck(:title)).to match_array(%w[AA AB])
+    expect(Comment.filter_by('deprecated_with_opts' => alice.id).pluck(:title)).to match_array(%w[AA AB])
+    expect(Comment.filter_by('deprecated_not' => alice.id).pluck(:title)).to match_array(%w[BA BB])
+  end
 end

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ ActiveRecord::Base.establish_connection :test
 
 ActiveRecord::Base.connection.instance_eval do
   create_table :authors do |_|
+    # no columns
   end
   create_table :posts do |t|
     t.integer :author_id, null: false
@@ -27,12 +28,12 @@ class Post < ActiveRecord::Base
   belongs_to :author
 
   filterable_by :author_id
-  filterable_by :only do |scope, value, **opts|
+  filterable_by :only do |value, **opts|
     case value
     when 'me'
-      scope.where(author_id: opts[:user_id]) if opts[:user_id]
+      where(author_id: opts[:user_id]) if opts[:user_id]
     else
-      scope
+      all
     end
   end
 end
@@ -42,11 +43,20 @@ class Feedback < ActiveRecord::Base
   belongs_to :post
 
   filterable_by :post_id, :author_id
+
+  ActiveSupport::Deprecation.silence do
+    filterable_by :deprecated do |scope, value|
+      scope.where(author_id: value)
+    end
+    filterable_by :deprecated_with_opts do |scope, value, **_opts|
+      scope.where(author_id: value)
+    end
+  end
 end
 
 class Comment < Feedback
-  filterable_by :post_author_id do |scope, value|
-    scope.joins(:post).where(Post.arel_table[:author_id].eq(value))
+  filterable_by :post_author_id do |value|
+    joins(:post).where(Post.arel_table[:author_id].eq(value))
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filterable-by
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-bsm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,9 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -126,12 +126,13 @@ files:
 - filterable-by.gemspec
 - lib/filterable-by.rb
 - lib/filterable_by.rb
-- spec/filterable_by_spec.rb
+- spec/active_record/filterable_by_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bsm/filterable-by
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -140,17 +141,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Generate white-listed filter scopes from URL parameter values
 test_files:
-- spec/filterable_by_spec.rb
+- spec/active_record/filterable_by_spec.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,6 +0,0 @@
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-gemfile:
-  - Gemfile