qry_filter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17501b95f2d0615442a1b81056df65461f31c31263f508e5458898162df6bb91
+  data.tar.gz: e759286af0273f0b89df702ba2a396b622e6856175f874f31027fff9b12ad9c1
+SHA512:
+  metadata.gz: 8795ad6c170e0f5d27f4ac359ac58a85f8951f4faf246eba3e27eb49d34ca22aab95074d730b9b9e0cd6de46dc7415b3b506c06bda273a45da68fdabe3d56ed8
+  data.tar.gz: 654164d8518af4e6cb858ac469f9f25ffc9d6832ec855c668a16007720e4b40f1f58a5b3d68f2b8678235a624df1aa5d1edf7517f61e6fbd527f35f7f4feab9a

data/MIT-LICENSE

@@ -0,0 +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.

data/README.md

@@ -0,0 +1,72 @@
+# 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
+**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
+```
+
+**Class Method**
+```ruby
+QryFilter.compose(scope, params)
+QryFilter.compose(scope, params, filter_by: [:id, :age])
+QryFilter.compose(scope, params, filter_by: [:id, :age], filter_class: UserFilter)
+```
+
+**Helper**
+```ruby
+filter scope, params
+filter scope, params, filter_by: [:id, :age]
+filter scope, params, filter_by: [:id, :age], filter_class: UserFilter
+```
+
+## TODO
+- Autodetect Model name to match with Filter class
+- Work with ActiveRecord::Relation
+- Generator for ApplicationFilter
+- More tests
+
+## 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
+```
+
+## 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).

data/Rakefile

@@ -0,0 +1,27 @@
+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

data/lib/generators/qry_filter/install/USAGE

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

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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,11 @@
+class ApplicationFilter
+  attr_reader :scope
+
+  def initialize(scope, filter_hash)
+    @scope = scope
+    @filter_hash = filter_hash
+  end
+
+  def default
+  end
+end

data/lib/qry_filter.rb

@@ -0,0 +1,27 @@
+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

data/lib/qry_filter/filter_class_finder.rb

@@ -0,0 +1,42 @@
+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

data/lib/qry_filter/version.rb

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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: qry_filter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Iñaki Ibarra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+description: A Rails add-on for handling query filters
+email:
+- inaki.mateo.ibarra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/qry_filter/install/USAGE
+- lib/generators/qry_filter/install/install_generator.rb
+- lib/generators/qry_filter/install/templates/application_filter.rb
+- lib/qry_filter.rb
+- lib/qry_filter/filter_class_finder.rb
+- lib/qry_filter/version.rb
+homepage: https://github.com/ibarrain/qry_filter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Query filter helper for Rails
+test_files: []