qry_filter 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17501b95f2d0615442a1b81056df65461f31c31263f508e5458898162df6bb91
-  data.tar.gz: e759286af0273f0b89df702ba2a396b622e6856175f874f31027fff9b12ad9c1
+  metadata.gz: 60ab5cc64d73a67de92abde0aaef2a9390b82beb64dcf70a64b706c7b94ac812
+  data.tar.gz: 4a5c753b591b8ade82a85989ee85ad3ec87b2908b0782bc4f3bb647c808f210c
 SHA512:
-  metadata.gz: 8795ad6c170e0f5d27f4ac359ac58a85f8951f4faf246eba3e27eb49d34ca22aab95074d730b9b9e0cd6de46dc7415b3b506c06bda273a45da68fdabe3d56ed8
-  data.tar.gz: 654164d8518af4e6cb858ac469f9f25ffc9d6832ec855c668a16007720e4b40f1f58a5b3d68f2b8678235a624df1aa5d1edf7517f61e6fbd527f35f7f4feab9a
+  metadata.gz: 3eceb727a88db6521fc2c8f5d8a79a01b915004ed1d6a6e38383832c853e6456f95e6dff129fdd66c52426c8743133ac822b6d0518cd067d53834c16513bbd68
+  data.tar.gz: 34c55324984dc9dff118d58beb9dbb33cd530e8b0884a77f4d9d310f483186147f039623951087a4991a7f6b6a9baf24bd0690620d38b10fc36107c130eb140c

data/README.md

@@ -1,6 +1,4 @@
 # QryFilter
-*Note: This is a work in progress and should not be used in production.*
-
 QryFilter aka "QueryFilter" is a simple Rails gem that provides a pattern and helper when dealing with lots of filter clauses in your ActiveRecord query.
 
 ## Usage
@@ -23,25 +21,35 @@ class UserFilter < ApplicationFilter
 end
 ```
 
-**Class Method**
+**In Controller**
 ```ruby
-QryFilter.compose(scope, params)
-QryFilter.compose(scope, params, filter_by: [:id, :age])
-QryFilter.compose(scope, params, filter_by: [:id, :age], filter_class: UserFilter)
+# app/controllers/user_controller.rb
+class UsersController < ApplicationController
+  def index
+    users = filter User, params
+    # ...
+  end
+end
 ```
 
-**Helper**
+**Other options**
+
+Class Method:
 ```ruby
-filter scope, params
-filter scope, params, filter_by: [:id, :age]
-filter scope, params, filter_by: [:id, :age], filter_class: UserFilter
-```
+params = {id: [1, 2, 3], age: [18, 20]}
+users = User.where(happy: true)
 
-## TODO
-- Autodetect Model name to match with Filter class
-- Work with ActiveRecord::Relation
-- Generator for ApplicationFilter
-- More tests
+QryFilter.compose(users, params, filter_by: [:id, :age], filter_class: UserFilter)
+```
+Helper:
+```ruby
+filter User, params, filter_by: [:id, :age], filter_class: UserFilter
+```
+- The first argument accepts ActiveRecord::Relation or model class name.
+- The second is for key-value pair of data you want to pass to your filter class.
+- The last argument is a hash and allows you to set ```filter_by``` and ```filter_class```
+- ```filter_by``` maps with your filter class methods e.g. ```[:id]``` will only trigger ```by_id``` method.
+- ```filter_class``` allows you to set a specific class when needed.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -60,11 +68,18 @@ Or install it yourself as:
 $ gem install qry_filter
 ```
 
-Generate app/filters/application_filter.rb: 
+Generate app/filters/application_filter.rb:
 ```bash
 $ rails g qry_filter:install
 ```
 
+Include QryFilter in ApplicationController
+```ruby
+class ApplicationController < ActionController::Base
+  include QryFilter
+end
+```
+
 ## Contributing
 Contribution directions go here.
 

data/lib/qry_filter/version.rb

@@ -1,3 +1,3 @@
 module QryFilter
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qry_filter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Iñaki Ibarra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-06 00:00:00.000000000 Z
+date: 2019-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -68,7 +68,7 @@ files:
 - lib/qry_filter.rb
 - lib/qry_filter/filter_class_finder.rb
 - lib/qry_filter/version.rb
-homepage: https://github.com/ibarrain/qry_filter
+homepage: https://github.com/inaki-ibarra/qry_filter
 licenses:
 - MIT
 metadata: {}