active_record_filterable 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f49388c51e77d6b3c1a9eebdb2707e9363ef933a76cc06426bca9c582bca7dc3
-  data.tar.gz: c08597f76c10fd643f78a5942d16d6a234767aad77fa34bceab29244bd130ed9
+  metadata.gz: 9f3fd07975c6a48200e596542644ddad458e3ff3293bee739151f4d25eae5231
+  data.tar.gz: c9415f4f77e93081d2189f9891709d3a009e98fc01c613ca6c059363f5f581b4
 SHA512:
-  metadata.gz: d19d09ee74bca4dd75550d7ddd96c1f8107f36244e73e7b5dff8b661adc9e4bd289411c7511dd74db1fb0d16f78945507eaf09cc1c64700b6c277961439a8157
-  data.tar.gz: 4196038390f371cddb094f6a6fb0d3803c1e50605f3ebbba7373c8acf92b298d315e4a0de4f464e2e09eb739df6c30f6460e8523a5b2e1856ccf8da34d7143c5
+  metadata.gz: 13c55dec18594a7ec978776e58ad25c0613e29d1258f68fd209ebcc2687fe46ff2981b240d29e2544db6819ad02dc85a5fc8c43324c6d3ffa29fd43ee19725d9
+  data.tar.gz: 42a9dc6a30c48bb94473ab9f9685944e0bbc65367806a7b5bdd97a703bb4536c3d873147f31308bc0e5d51301cfe8272812a1495098c8686ba49b77ae846d6c8

data/README.md

@@ -29,19 +29,18 @@ class City < ActiveRecord::Base
   field :people
 
   filter_by(:name)
-  filter_by(:people, ->(value) { where(:people.gt => value) })
+  filter_by(:people, ->(value) { where(City.arel_table[:people].gt(value)) })
   filter_by(:people_range, (lambda do |range_start, range_end|
-    where(:people.lte => range_end,
-          :people.gte => range_start)
+    where(people: range_start..range_end)
   end))
 end
 
 City.create(name: 'city1', people: 100)
 City.create(name: 'city2', people: 1000)
-City.filter({name: 'city'}).count # => 2
-City.filter({name: 'city1'}).count # => 1
-City.filter({name: ''}).count # => 0
-City.filter({people: 500}) # => 1
+City.filtrate({name: 'city'}).count # => 2
+City.filtrate({name: 'city1'}).count # => 1
+City.filtrate({name: ''}).count # => 0
+City.filtrate({people: 500}) # => 1
 ```
 
 #### Operator
@@ -52,8 +51,8 @@ You can specify selector operator:
 * or
 
 ```ruby
-City.filter({name: 'city1', people: 1000}, 'and').count # => 0
-City.filter({name: 'city1', people: 1000}, 'or').count # => 1
+City.filtrate({name: 'city1', people: 1000}, 'and').count # => 0
+City.filtrate({name: 'city1', people: 1000}, 'or').count # => 1
 ```
 
 #### Range
@@ -61,7 +60,7 @@ City.filter({name: 'city1', people: 1000}, 'or').count # => 1
 Searches with more than one param is also available:
 
 ```ruby
-City.filter(people_range: [500, 1000]).count # => 1
+City.filtrate(people_range: [500, 1000]).count # => 1
 ```
 
 #### Rails controller
@@ -69,7 +68,7 @@ City.filter(people_range: [500, 1000]).count # => 1
 ```ruby
 class CitiesController
   def index
-    respond_with City.filter(filter_params)
+    respond_with City.filtrate(filter_params)
   end
 
   private
@@ -82,7 +81,7 @@ end
 
 #### Normalized values
 
-Searches without considering accents are also supported. 
+Searches without considering accents are also supported.
 
 ```ruby
   filter_by_normalized :name
@@ -90,7 +89,7 @@ Searches without considering accents are also supported.
 enables to do sth like:
 
   ```ruby
-  City.filter(name_normalized: 'text with accents')
+  City.filtrate(name_normalized: 'text with accents')
   ```
 
 It also depends on which adapter you are using.

data/active_record_filterable.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'sqlite3'

data/lib/active_record_filterable.rb

@@ -1,5 +1,2 @@
 require 'active_record_filterable/version'
-require 'active_record_filterable/filter'
 require 'active_record_filterable/filterable'
-
-ActiveRecord::Relation.send(:include, ActiveRecord::Filterable::Filter)

data/lib/active_record_filterable/filterable.rb

@@ -9,7 +9,36 @@ module ActiveRecord
 
     # rubocop:disable Metrics/BlockLength
     class_methods do
-      include Filter
+      ##
+      # Applies params scopes to current scope
+      #
+      def filtrate(filtering_params, operator='and')
+        return all if filtering_params.blank?
+        criteria = nil
+
+        unscoped do
+          criteria = is_a?(ActiveRecord::Relation) ? self : all
+
+          filtering_params.each do |key, value|
+            next unless respond_to?("filter_with_#{key}")
+
+            # Add support for both kind of scopes: scope with multiple arguments and scope with
+            # one argument as array
+            value = [value] unless value.is_a?(Array) &&
+              scope_arities["filter_with_#{key}".to_sym] > 1
+
+            # check the number of arguments of filter scope
+            criteria =
+              if operator == 'and' || criteria.where_clause.empty?
+                criteria.public_send("filter_with_#{key}", *value)
+              else
+                criteria.or(all.public_send("filter_with_#{key}", *value))
+              end
+          end
+        end
+
+        criteria == self ? none : merge(criteria)
+      end
 
       def scope(name, scope_options, &block)
         super

data/lib/active_record_filterable/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Filterable
-    VERSION = '0.1.0'
+    VERSION = '1.0.0'
   end
 end

data/spec/filterable_spec.rb

@@ -30,12 +30,12 @@ RSpec.describe ActiveRecord::Filterable do
       end
 
       it 'filters' do
-        expect(City.filter(code: :code1).count).to eq(1)
-        expect(City.filter(code: :code1).first.code).to eq('code1')
+        expect(City.filtrate(code: :code1).count).to eq(1)
+        expect(City.filtrate(code: :code1).first.code).to eq('code1')
       end
 
       it 'doesn\'t find anything with partial match' do
-        expect(City.filter(name: :city).count).to eq(0)
+        expect(City.filtrate(name: :city).count).to eq(0)
       end
     end
 
@@ -47,11 +47,11 @@ RSpec.describe ActiveRecord::Filterable do
       end
 
       it 'respects default_scope' do
-        expect(City.filter(nil).count).to eq(2)
+        expect(City.filtrate(nil).count).to eq(2)
       end
 
       it 'ignores filter' do
-        expect(City.filter(nil).count).to eq(2)
+        expect(City.filtrate(nil).count).to eq(2)
       end
     end
 
@@ -63,11 +63,11 @@ RSpec.describe ActiveRecord::Filterable do
       end
 
       it 'should respect default_scope' do
-        expect(City.filter(invalid: 'val').count).to eq(2)
+        expect(City.filtrate(invalid: 'val').count).to eq(2)
       end
 
       it 'should ignore filter' do
-        expect(City.filter(invalid: 'val').count).to eq(2)
+        expect(City.filtrate(invalid: 'val').count).to eq(2)
       end
     end
 
@@ -81,11 +81,11 @@ RSpec.describe ActiveRecord::Filterable do
       end
 
       it 'receives all the values' do
-        expect(City.filter(people_range: [500, 1000]).count).to eq(3)
+        expect(City.filtrate(people_range: [500, 1000]).count).to eq(3)
       end
 
       it 'does not break compatibility with filters receiving only one param as array' do
-        expect(City.filter(people_in: [500, 100]).count).to eq(2)
+        expect(City.filtrate(people_in: [500, 100]).count).to eq(2)
       end
     end
 
@@ -96,7 +96,7 @@ RSpec.describe ActiveRecord::Filterable do
       end
 
       it 'applies filter' do
-        expect(City.filter(people: '').count).to eq(0)
+        expect(City.filtrate(people: '').count).to eq(0)
       end
     end
 
@@ -107,7 +107,7 @@ RSpec.describe ActiveRecord::Filterable do
       end
 
       it 'filters using a query' do
-        expect(City.unscoped.filter(active: false).count).to eq(1)
+        expect(City.unscoped.filtrate(active: false).count).to eq(1)
       end
     end
 
@@ -118,8 +118,8 @@ RSpec.describe ActiveRecord::Filterable do
       end
 
       it 'filters' do
-        expect(City.filter(people: 500).count).to eq(1)
-        expect(City.filter(people: 500).first.people).to eq(1000)
+        expect(City.filtrate(people: 500).count).to eq(1)
+        expect(City.filtrate(people: 500).first.people).to eq(1000)
       end
     end
 
@@ -132,16 +132,16 @@ RSpec.describe ActiveRecord::Filterable do
       end
 
       it 'filters ignoring upcase' do
-        expect(City.filter(name_normalized: 'spain').first.name).to eq('spaIn')
-        expect(City.filter(name_normalized: 'france').first.name).to eq('frAnce')
+        expect(City.filtrate(name_normalized: 'spain').first.name).to eq('spaIn')
+        expect(City.filtrate(name_normalized: 'france').first.name).to eq('frAnce')
       end
 
       it 'filters ignoring special characters', sqlite: false do
-        expect(City.filter(name_normalized: '%').first.name).to eq('_russian%')
+        expect(City.filtrate(name_normalized: '%').first.name).to eq('_russian%')
       end
 
       it 'filters ignoring accents', sqlite: false do
-        expect(City.filter(name_normalized: 'italy').first.name).to eq('itály')
+        expect(City.filtrate(name_normalized: 'italy').first.name).to eq('itály')
       end
     end
 
@@ -154,7 +154,7 @@ RSpec.describe ActiveRecord::Filterable do
       end
 
       it 'is maintained' do
-        expect(City.where(name: '2').filter(nil).count).to eq(1)
+        expect(City.where(name: '2').filtrate(nil).count).to eq(1)
       end
     end
 
@@ -166,8 +166,8 @@ RSpec.describe ActiveRecord::Filterable do
       end
 
       it 'respects previous selector' do
-        expect(City.where(name: 'city2').filter(people: '500').count).to eq(1)
-        expect(City.where(name: 'city2').filter(people: '500').first.name).to eq('city2')
+        expect(City.where(name: 'city2').filtrate(people: '500').count).to eq(1)
+        expect(City.where(name: 'city2').filtrate(people: '500').first.name).to eq('city2')
       end
     end
   end
@@ -179,7 +179,7 @@ RSpec.describe ActiveRecord::Filterable do
     end
 
     it 'filters' do
-      expect(City.filter({name: 'city1', people: '2000'}, 'and').count).to eq(0)
+      expect(City.filtrate({name: 'city1', people: '2000'}, 'and').count).to eq(0)
     end
   end
 
@@ -190,7 +190,7 @@ RSpec.describe ActiveRecord::Filterable do
     end
 
     it 'filters' do
-      expect(City.filter({name: 'city1', people: 500}, 'or').count).to eq(2)
+      expect(City.filtrate({name: 'city1', people: 500}, 'or').count).to eq(2)
     end
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: active_record_filterable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Francisco Padillo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2019-04-12 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -121,7 +107,6 @@ files:
 - Rakefile
 - active_record_filterable.gemspec
 - lib/active_record_filterable.rb
-- lib/active_record_filterable/filter.rb
 - lib/active_record_filterable/filterable.rb
 - lib/active_record_filterable/version.rb
 - spec/filterable_spec.rb
@@ -148,8 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Easy way to add scopes to your models.

data/lib/active_record_filterable/filter.rb

@@ -1,36 +0,0 @@
-module ActiveRecord
-  module Filterable
-    module Filter
-      ##
-      # Applies params scopes to current scope
-      #
-      def filter(filtering_params, operator='and')
-        return all if filtering_params.blank?
-        criteria = nil
-
-        unscoped do
-          criteria = is_a?(ActiveRecord::Relation) ? self : all
-
-          filtering_params.each do |key, value|
-            next unless respond_to?("filter_with_#{key}")
-
-            # Add support for both kind of scopes: scope with multiple arguments and scope with
-            # one argument as array
-            value = [value] unless value.is_a?(Array) &&
-              scope_arities["filter_with_#{key}".to_sym] > 1
-
-            # check the number of arguments of filter scope
-            criteria =
-              if operator == 'and' || criteria.where_clause.empty?
-                criteria.public_send("filter_with_#{key}", *value)
-              else
-                criteria.or(all.public_send("filter_with_#{key}", *value))
-              end
-          end
-        end
-
-        criteria == self ? none : merge(criteria)
-      end
-    end
-  end
-end