filterable-by 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1369751aa86d400aa27ab43ad4cdbbcc92ff06a2ca19162582f8c95914882814
-  data.tar.gz: ca8d93901d61b20377196045430f22e63bf622e05abdab58ec4f85a578526458
+  metadata.gz: ae571004dd8c2aebddad1f69b8a698b7f52f0fa5bb2d3338a74de5f6a9e18e1a
+  data.tar.gz: f1744d312f8b99eab4ada84590b65361e1cb183ef3a41ce1969569ca723880e5
 SHA512:
-  metadata.gz: 5e487f8f1e5337faaaf0a25c009ded133b78f21a89c07b49b4d81ead360b6cbfb1a21acb4787ff96b2e5d35931ed126f42c1d1acdfa6b23b8d8ad190da260a41
-  data.tar.gz: e68b17a74b428364b6bb46bf92da38f18b0fda824eef32823af567b336f172ef011c2dd15a904e41accad29ea0e0c103f078e8949a30dedd08c7a6b96407152b
+  metadata.gz: ce8c6eabe14c36dd917c8f30f29926a6ae88baa494067683912f63dd3af6445ca93b74426e1d24c3f8992e2d740d340a4bbb8b494c033872fb1a0ed51924e085
+  data.tar.gz: eed08234ac28e40f99fc786225bc2e65ead127808e93714d8747a30fcb0c4a01fe27b450f4dfa9de713d08d05cd1c65c2e6c4412402a0567b48d5f05a1b1011b

data/.travis.yml

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

data/Gemfile.lock

@@ -1,63 +1,68 @@
 PATH
   remote: .
   specs:
-    filterable-by (0.5.0)
+    filterable-by (0.5.1)
       activerecord
       activesupport
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activerecord (6.0.0)
-      activemodel (= 6.0.0)
-      activesupport (= 6.0.0)
-    activesupport (6.0.0)
+    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)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    ast (2.4.0)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    i18n (1.6.0)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.4)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
-    minitest (5.11.3)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
+    minitest (5.14.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (12.3.3)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.87.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 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)
-    sqlite3 (1.4.1)
+    sqlite3 (1.4.2)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    zeitwerk (2.1.9)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.1)
 
 PLATFORMS
   ruby
@@ -71,4 +76,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -16,22 +16,33 @@ class Comment < ActiveRecord::Base
 
   filterable_by :post_id, :user_id
   filterable_by :post_author_id do |scope, value|
-    scope.joins(:posts).where(:"posts.author_id" => value)
+    scope.joins(:posts).where(:'posts.author_id' => value)
+  end
+  filterable_by :only do |scope, value, **opts|
+    case value
+    when 'mine'
+      scope.where(user_id: opts[:user_id]) if opts[:user_id]
+    else
+      scope
+    end
   end
 end
 
-Comment.filter_by(params[:filter])  # => ActiveRecord::Relation
+Comment.filter_by(params[:filter], user_id: current_user.id)  # => ActiveRecord::Relation
 ```
 
 Simple use cases:
 
 ```ruby
-Comment.filter_by({ "post_id" => "1" })
+Comment.filter_by({ 'post_id' => '1' })
 # => WHERE post_id = 1
 
-Comment.filter_by({ "user_id" => "2", "ignored" => "3" })
+Comment.filter_by({ 'user_id' => '2', 'ignored' => '3' })
 # => WHERE user_id = 2
 
-Comment.filter_by({ "post_author_id" => "5" })
+Comment.filter_by({ 'only' => 'mine' }, user_id: 4)
+# => WHERE user_id = 4
+
+Comment.filter_by({ 'post_author_id' => '5' })
 # => JOINS posts ON posts.id = comments.post_id WHERE posts.author_id = 5
 ```

data/filterable-by.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'filterable-by'
-  s.version     = '0.5.0'
+  s.version     = '0.5.1'
   s.authors     = ['Dimitrij Denissenko']
   s.email       = ['dimitrij@blacksquaremedia.com']
   s.summary     = 'Generate white-listed filter scopes from URL parameter values'

data/lib/filterable_by.rb

@@ -27,13 +27,17 @@ module ActiveRecord
 
       def filterable_by(*names, &block)
         names.each do |name|
-          _filterable_by_config[name.to_s] = block || ->(scope, v) { scope.where(name.to_sym => v) }
+          _filterable_by_config[name.to_s] = block || ->(scope, value, **) { scope.where(name.to_sym => value) }
         end
       end
 
       # @param [Hash] hash the filter params
       # @return [ActiveRecord::Relation] the scoped relation
-      def filter_by(hash)
+      def filter_by(hash = nil, **opts)
+        if hash.nil?
+          hash = opts
+          opts = {}
+        end
         scope = all
         return scope unless hash.is_a?(Hash)
 
@@ -43,9 +47,10 @@ module ActiveRecord
           value = FilterableBy.normalize(hash[name])
           next if value.blank?
 
-          scope = block.call(scope, value)
+          scope = block.call(scope, value, **opts)
         end
-        scope
+
+        scope || none
       end
     end
   end

data/spec/filterable_by_spec.rb

@@ -10,12 +10,14 @@ describe ActiveRecord::FilterableBy do
   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)
-    expect(Post.send(:_filterable_by_config).count).to eq(1)
+    expect(Post.send(:_filterable_by_config).count).to eq(2)
   end
 
   it 'should ignore bad inputs' do
+    expect(Comment.filter_by.count).to eq(4)
     expect(Comment.filter_by(nil).count).to eq(4)
-    expect(Comment.filter_by({}).count).to eq(4)
+    expect(Comment.filter_by(nil, extra: true).count).to eq(4)
+    expect(Comment.filter_by('bad').count).to eq(4)
 
     expect(Comment.filter_by('author_id' => '').count).to eq(4)
     expect(Comment.filter_by('author_id' => []).count).to eq(4)
@@ -53,6 +55,23 @@ describe ActiveRecord::FilterableBy do
     expect(scope.pluck(:title)).to match_array(['AA'])
   end
 
+  it 'should allow custom options' do
+    scope = Post.filter_by({ 'only' => 'me' }, user_id: alice.id)
+    expect(scope).to match_array([apost])
+
+    scope = Post.filter_by({ 'only' => '??' }, user_id: alice.id)
+    expect(scope.count).to eq(2)
+
+    scope = Post.filter_by({ 'only' => 'me' })
+    expect(scope.count).to eq(0)
+  end
+
+  it 'should allow 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
     expect(Comment.filter_by('invalid' => 1).count).to eq(4)
     expect(Post.filter_by('post_id' => bpost.id).count).to eq(2)

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ ENV['RACK_ENV'] ||= 'test'
 require 'filterable-by'
 require 'rspec'
 
-ActiveRecord::Base.configurations['test'] = { 'adapter' => 'sqlite3', 'database' => ':memory:' }
+ActiveRecord::Base.configurations = { 'test' => { 'adapter' => 'sqlite3', 'database' => ':memory:' } }
 ActiveRecord::Base.establish_connection :test
 
 ActiveRecord::Base.connection.instance_eval do
@@ -27,6 +27,14 @@ class Post < ActiveRecord::Base
   belongs_to :author
 
   filterable_by :author_id
+  filterable_by :only do |scope, value, **opts|
+    case value
+    when 'me'
+      scope.where(author_id: opts[:user_id]) if opts[:user_id]
+    else
+      scope
+    end
+  end
 end
 
 class Feedback < ActiveRecord::Base

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filterable-by
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -147,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Generate white-listed filter scopes from URL parameter values