filtering 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cff302567fe65d0891e336fbd24a4abc2a7dc72f
-  data.tar.gz: 4990e53c9f347af71eb5cecfb7f7de6d02de4d5c
+  metadata.gz: 2d10e915ebf65faf4e5bde4d5757bf482638c2c6
+  data.tar.gz: c1aae098a832689f11562c4a04a760cc67ad702f
 SHA512:
-  metadata.gz: 6fb220d98c16d465d9f60628d2f1029f54c452803667fffb297a2cd377c26812d4b4522c1dd461bf9676e3cc524db00d66ebb6c440e48382a3517454e16d9b07
-  data.tar.gz: ccaee684fee547d705a6d221acbbaa3bda3c102fa524c57dfddba0bc8ba6e67e43e8edda0ef350e859c1a1a252c8a63690f49057b29a8f70ba6db06b674047b2
+  metadata.gz: 747eaed5311cc56b010dca7b3b40b9bdd9b84deea49df1d07a5e132730d05638d6efaf67aca14500e6d680185b15e58426aca607394e5647bf20cc8b372ddf92
+  data.tar.gz: 5ad728b74ae091db15c3432cb5168e01d8adc1b71b9594eec68db9ac707e3e90639f852eb46d81f5e57ff836e0d6c3ab22e887c9533b642f355d72062a915a46

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    filtering (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  filtering!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -24,7 +24,7 @@ All you need to do is inherit custom filter service from `Filtering::Base` and d
 ### Example filter service
 
 ```
-class Filters::OffersFilter < Filtering::Base
+class Filters::UsersFilter < Filtering::Base
   def initialize(params, page)
     super(params, page)
   end
@@ -37,7 +37,7 @@ class Filters::OffersFilter < Filtering::Base
     User.all
   end
 
-  def simple_acessible_params
+  def plain_acessible_params
     %i[city age]
   end
 
@@ -53,23 +53,23 @@ class Filters::OffersFilter < Filtering::Base
 end
 
 ```
-There are required private methods:
+There are private methods:
 
 `relation` is an ActiveRecord initial relation which must be filtered
 
-`plain_acessible_params` array of params for auto-filtering by `where`, so if you have `%i[city age]` will be called `User.where(city: city).where(age: age)`
+`plain_acessible_params` array of params for an auto-filtering by `where`, so if you have `%i[city age]` will be called `User.where(city: city).where(age: age)`
 
-`complex_acessible_params` array of params for filters with custom logic. If you have some params in that method you have to create methods for those custom filters by format: `filter_by_{param}`
+`complex_acessible_params` array of params for filters with custom logic. If you have some params in that method you have to create methods for those custom filters with format: `filter_by_{param}`
 
 ### Calling
-Feel free to call new service wherever you want. For example in controller:
+Controller usage example:
 
 ```
 def index
-  render json: Filters::OffersFilter.new(params, params[:page]).call
+  render json: Filters::UsersFilter.new(params, page: params[:page]).call
 end
 ```
-If you don't use caminari just delete page from initializer
+If you don't use Kaminari just delete page from initializer
 
 ## License
 

data/lib/filtering/base.rb

@@ -1,8 +1,8 @@
 class Filtering::Base
-  def initialize(params, page = nil)
+  def initialize(params, args = {})
     @plain_params = params.permit(plain_acessible_params)
     @complex_params = params.permit(complex_acessible_params)
-    @page = page
+    @page = args[:page]
     @results = relation
   end
 

data/lib/filtering/version.rb

@@ -1,3 +1,3 @@
 module Filtering
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filtering
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Vitaliy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2018-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile