qry_filter 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60ab5cc64d73a67de92abde0aaef2a9390b82beb64dcf70a64b706c7b94ac812
-  data.tar.gz: 4a5c753b591b8ade82a85989ee85ad3ec87b2908b0782bc4f3bb647c808f210c
+  metadata.gz: 4cf817574203c04621ce5976dbba69af0aa3beaf7cf59f4770a64a8d20557795
+  data.tar.gz: b678d2d8775b89ee066c1a71f43b17006b7ba9a193b2824d34fca802fdea7816
 SHA512:
-  metadata.gz: 3eceb727a88db6521fc2c8f5d8a79a01b915004ed1d6a6e38383832c853e6456f95e6dff129fdd66c52426c8743133ac822b6d0518cd067d53834c16513bbd68
-  data.tar.gz: 34c55324984dc9dff118d58beb9dbb33cd530e8b0884a77f4d9d310f483186147f039623951087a4991a7f6b6a9baf24bd0690620d38b10fc36107c130eb140c
+  metadata.gz: 3b75e73ad99904a217438cdb8324187f1c3dd64155fcb66f3c67c887b50b9d3a3ef0474232834ff4a733da0e9c5bcec2b7a486306ecb4f68a8c4af66f8b4fde8
+  data.tar.gz: b93d491a5e1b9e9ac8e87ffd9be66433f4634cacf70f3116a25012d8c37ab414e7b59dbba83daaac3b30c25fe78f56a3a8a381fdd1f4aa7844430d69ffcc4839

data/MIT-LICENSE

@@ -1,20 +1,20 @@
-Copyright 2019 
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright 2019 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,87 +1,87 @@
-# QryFilter
-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
-**Filter Class**
-```ruby
-# app/filters/user_filter.rb
-class UserFilter < ApplicationFilter
-  def default
-    by_id
-    by_age
-  end
-
-  def by_id
-    @scope = @scope.where(id: @filter_hash[:id])
-  end
-
-  def by_age
-    @scope = @scope.where(age: @filter_hash[:age])
-  end
-end
-```
-
-**In Controller**
-```ruby
-# app/controllers/user_controller.rb
-class UsersController < ApplicationController
-  def index
-    users = filter User, params
-    # ...
-  end
-end
-```
-
-**Other options**
-
-Class Method:
-```ruby
-params = {id: [1, 2, 3], age: [18, 20]}
-users = User.where(happy: true)
-
-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:
-
-```ruby
-gem 'qry_filter'
-```
-
-And then execute:
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-```bash
-$ gem install qry_filter
-```
-
-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.
-
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+[![Gem Version](https://badge.fury.io/rb/qry_filter.svg)](https://badge.fury.io/rb/qry_filter)
+![](https://github.com/inaki-ibarra/qry_filter/workflows/CI/badge.svg)
+![](https://github.com/inaki-ibarra/qry_filter/workflows/CD/badge.svg)
+
+# QryFilter
+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
+**Filter Class**
+```ruby
+# app/filters/user_filter.rb
+class UserFilter < ApplicationFilter
+  def by_id
+    @scope = @scope.where(id: @filter_hash[:id])
+  end
+
+  def by_age
+    @scope = @scope.where(age: @filter_hash[:age])
+  end
+end
+```
+
+**In Controller**
+```ruby
+# app/controllers/user_controller.rb
+class UsersController < ApplicationController
+  def index
+    users = filter User, params
+    # ...
+  end
+end
+```
+
+**Other options**
+
+Class Method:
+```ruby
+params = {id: [1, 2, 3], age: [18, 20]}
+users = User.where(happy: true)
+
+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. If empty, all filters will be triggered.
+- ```filter_class``` allows you to set a specific class when needed.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qry_filter'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install qry_filter
+```
+
+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
+Fork the repo and submit a pull request.
+Please follow this [Rails style guide](https://github.com/rubocop-hq/rails-style-guide).
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,27 +1,28 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'QryFilter'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-task default: :test
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'QryFilter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = '--format documentation'
+end
+
+task default: :spec

data/lib/generators/qry_filter/install/USAGE

@@ -1,2 +1,2 @@
-Description:
+Description:
     Generates initial application filter.

data/lib/generators/qry_filter/install/install_generator.rb

@@ -1,11 +1,13 @@
-module QryFilter
-  module Generators
-    class InstallGenerator < ::Rails::Generators::Base
-      source_root File.expand_path("templates", __dir__)
-
-      def copy_application_filter
-        template "application_filter.rb", "app/filters/application_filter.rb"
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module QryFilter
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_application_filter
+        template 'application_filter.rb', 'app/filters/application_filter.rb'
+      end
+    end
+  end
+end

data/lib/generators/qry_filter/install/templates/application_filter.rb

@@ -1,11 +1,10 @@
-class ApplicationFilter
-  attr_reader :scope
-
-  def initialize(scope, filter_hash)
-    @scope = scope
-    @filter_hash = filter_hash
-  end
-
-  def default
-  end
-end
+# frozen_string_literal: true
+
+class ApplicationFilter
+  attr_reader :scope
+
+  def initialize(scope, filter_hash)
+    @scope = scope
+    @filter_hash = filter_hash
+  end
+end

data/lib/qry_filter.rb

@@ -1,27 +1,48 @@
-require "qry_filter/filter_class_finder"
-
-module QryFilter
-  class << self
-    def compose(scope, filter_hash, filter_class: nil, filter_by: nil)
-      if filter_class.nil?
-        filter_class = FilterClassFinder.new(scope).filter_class
-      end
-
-      filter = filter_class.new(scope, filter_hash)
-
-      if filter_by.nil?
-        filter.send(:default)
-      else
-        filter_by.each do |subject|
-          filter.send("by_#{subject}")
-        end
-      end
-
-      filter.scope
-    end
-  end
-
-  def filter(*args)
-    QryFilter.compose(*args)
-  end
-end
+# frozen_string_literal: true
+
+require 'qry_filter/filter_class_finder'
+
+module QryFilter
+  class << self
+    def compose(scope, filter_hash, filter_class: nil, filter_by: nil)
+      if filter_class.nil?
+        filter_class = FilterClassFinder.new(scope).filter_class
+      end
+
+      filter = filter_class.new(scope, filter_hash)
+
+      execute(filter, filter_by)
+    end
+
+    protected
+
+    def execute(filter, filter_by)
+      if filter_by.nil? || filter_by.empty?
+        filter_all(filter)
+      else
+        filter_explicit(filter, filter_by)
+      end
+
+      filter.scope
+    end
+
+    private
+
+    def filter_all(filter)
+      methods = filter.class.instance_methods - Object.instance_methods
+      methods.each do |method|
+        filter.send(method)
+      end
+    end
+
+    def filter_explicit(filter, filter_by)
+      filter_by.each do |subject|
+        filter.send("by_#{subject}")
+      end
+    end
+  end
+
+  def filter(*args)
+    QryFilter.compose(*args)
+  end
+end

data/lib/qry_filter/filter_class_finder.rb

@@ -1,42 +1,44 @@
-module QryFilter
-
-  class FilterClassFinder
-    def initialize(scope)
-      @scope = scope
-    end
-
-    def filter_class
-      klass = find(@scope)
-      klass.is_a?(String) ? klass.safe_constantize : klass
-    end
-
-    private
-
-    def find(subject)
-      if subject.is_a?(Array)
-        modules = subject.dup
-        last = modules.pop
-        context = modules.map { |x| find_class_name(x) }.join("::")
-        [context, find(last)].join("::")
-      else
-        class_name = find_class_name(subject)
-        "#{class_name}Filter"
-      end
-    end
-
-    def find_class_name(subject)
-      if subject.respond_to?(:model_name)
-        subject.model_name
-      elsif subject.class.respond_to?(:model_name)
-        subject.class.model_name
-      elsif subject.is_a?(Class)
-        subject
-      elsif subject.is_a?(Symbol)
-        subject.to_s.camelize
-      else
-        subject.class
-      end
-    end
-  end
-
-end
+# frozen_string_literal: true
+
+module QryFilter
+  class FilterClassFinder
+    def initialize(scope)
+      @scope = scope
+    end
+
+    def filter_class
+      klass = find(@scope)
+      klass.is_a?(String) ? klass.safe_constantize : klass
+    end
+
+    private
+
+    def find(subject)
+      if subject.is_a?(Array)
+        modules = subject.dup
+        last = modules.pop
+        context = modules.map { |x| find_class_name(x) }.join('::')
+        [context, find(last)].join('::')
+      else
+        class_name = find_class_name(subject)
+        "#{class_name}Filter"
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def find_class_name(subject)
+      if subject.respond_to?(:model_name)
+        subject.model_name
+      elsif subject.class.respond_to?(:model_name)
+        subject.class.model_name
+      elsif subject.is_a?(Class)
+        subject
+      elsif subject.is_a?(Symbol)
+        subject.to_s.camelize
+      else
+        subject.class
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/qry_filter/version.rb

@@ -1,3 +1,5 @@
-module QryFilter
-  VERSION = '0.1.2'
-end
+# frozen_string_literal: true
+
+module QryFilter
+  VERSION = '0.2.0'
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: qry_filter
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Iñaki Ibarra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2020-01-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -25,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 0.79.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 0.79.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement