quickfilter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcced528170e4bb637585942b22c94881ba33c75
+  data.tar.gz: e6427b898d477e4552d6f25a9f5bd844d848be9f
+SHA512:
+  metadata.gz: 732bd37aa82e8314379e5fdca616ea77e408a35f19465eb346fb748e510b60f891573e8a8babe4212717cafb17f73824887043ac4cfd5729433b7b17823f973c
+  data.tar.gz: cba03ac9dc7e2a10ed267a9762771f9e752ea27dabeea109dcc93ce4ce03a03802fed35d07497279db787dc2b1cedb4b9778238c9184bec94b9a4f4f76c1bbe2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in quickfilter.gemspec
+gem 'activesupport'
+gem 'activerecord'
+gem 'sqlite3'
+
+gemspec

data/README.md

@@ -0,0 +1,104 @@
+# Quickfilter
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quickfilter', git: 'https://github.com/rcpedro/quickfilter.git'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quickfilter
+
+## Usage
+
+Given the models:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include Quickfilter
+  self.abstract_class = true
+end
+
+class User < ApplicationRecord
+  enum status: [:active, :inactive]
+  
+  has_many :students
+  has_many :universities, through: :students
+
+  has_one :current_student, -> { where(status: 'active') }, class_name: 'Student'
+  has_one :current_university, through: :current_student, class_name: 'University'
+end
+
+class University < ApplicationRecord
+  has_many :students
+  has_many :users, through: :students
+end
+
+class Student < ApplicationRecord
+  belongs_to :university
+  belongs_to :user
+end
+```
+
+### Basic Filter
+
+Query using a set number of operators defined in `lib/quickfilter/handlers.rb`:
+
+```ruby
+User.filter(
+  first_name: { likeic: 'jOhn' }, 
+  status:     { in: [0, 1] },
+  created_at: {
+    gte: Date.today.beginning_of_month,
+    lte: Date.today
+  }
+)
+``` 
+
+If the parameter for a filter is null, it is ignored and removed (since this is the case for most search forms wherein almost all parameters are optional). For example, the following are equivalent:
+
+```ruby
+User.filter(first_name: { likeic: nil })
+User.filter({})
+User.where(nil)
+```
+
+A special `isnull` filter which accepts `true` or `false` can be used to filter nulls.
+
+### Filter with Joins
+
+If another table is provided in the filter, the query builder will automatically do a join based on the table name:
+
+```ruby
+# Automatically joins University with User
+University.filter(name: { eq: 'SLU' }, 
+                  users: { first_name: { likeic: 'john' }})
+```
+
+However, if the parameter value is nil, the join is ommitted:
+
+```ruby
+# Automatically joins University with User
+query = University.filter(name: { eq: 'SLU' }, 
+                          users: { first_name: { likeic: nil }})
+
+query.to_sql # will output "SELECT \"universities\".* FROM \"universities\" WHERE (universities.name = 'SLU')"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/quickfilter.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "quickfilter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/quickfilter.rb

@@ -0,0 +1,26 @@
+require 'active_support/concern'
+require 'active_record'
+require 'active_record/reflection'
+require 'active_record/relation'
+
+require 'quickfilter/version'
+require 'quickfilter/query_builder'
+
+
+module Quickfilter
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # Parameters in the form of:
+    #   { [table]: { [field]: { [operator]: [value] }}}
+    #
+    # e.g.:
+    #   { courses: { name: { likeic: 'John' }}
+    #   { sessions: { start: { gte: DateTime.now - 1.days, lte: DateTime.now }}}
+    #
+    # Wherein, table is optional and defaults to self.table_name
+    def filter(params)
+      return QueryBuilder.new(self).build(params).query
+    end
+  end
+end

data/lib/quickfilter/filter.rb

@@ -0,0 +1,20 @@
+require 'quickfilter/handlers'
+
+module Quickfilter
+  class Filter
+
+    attr_accessor :field, :operator, :value, :adapter
+
+    def initialize(table, field, operator, value, adapter)
+      self.field = "#{table}.#{field}"
+      self.operator = operator
+      self.value = value
+      self.adapter = adapter
+    end
+
+    def build
+      return nil if self.value.blank?
+      return Quickfilter::Handlers.get(self.operator, self.adapter).call(self.field, self.value)
+    end
+  end
+end

data/lib/quickfilter/handlers.rb

@@ -0,0 +1,39 @@
+module Quickfilter
+  module Handlers
+    SQL = {
+      eq:          lambda { |field, value| ["#{field} = ?", value] },
+      eqic:        lambda { |field, value| ["lower(#{field}) = ?", "#{value.downcase}"] },
+      likeic:      lambda { |field, value| ["lower(#{field}) like ?", "#{value.downcase}"] },
+      startswith:  lambda { |field, value| ["lower(#{field}) like ?", "#{value.downcase}%"] },
+      contains:    lambda { |field, value| ["lower(#{field}) like ?", "%#{value.downcase}%"] },
+
+      gt:  lambda { |field, value| ["#{field} > ?",  value] },
+      gte: lambda { |field, value| ["#{field} >= ?", value] },
+      lt:  lambda { |field, value| ["#{field} < ?",  value] },
+      lte: lambda { |field, value| ["#{field} <= ?", value] },
+
+      in:      lambda { |field, value| ["#{field} in (?)", value] },
+      isnull:  lambda { |field, value| [field, (value.present? and value) ? 'null' : 'not null'] }
+    }
+
+    PG = {
+      sameday:   lambda { |field, value| ["date_trunc('day',   #{field}) = ?", value.to_date] },
+      sameweek:  lambda { |field, value| ["date_trunc('week',  #{field}) = ?", value.to_date.beginning_of_week] },
+      samemonth: lambda { |field, value| ["date_trunc('month', #{field}) = ?", value.to_date.beginning_of_month] }
+    }
+
+    class << self
+      def get(name, adapter)
+        result = SQL[name]
+        result ||= PG[name] if self.is_pg?(adapter)
+
+        raise "Operation #{name} not supported for adapter #{adapter}." if result.nil?
+        return result
+      end
+
+      def is_pg?(adapter)
+        return adapter == 'postgresql'
+      end
+    end
+  end
+end

data/lib/quickfilter/query_builder.rb

@@ -0,0 +1,58 @@
+require 'quickfilter/filter'
+
+module Quickfilter
+  class QueryBuilder
+    attr_reader :klass, :query, :adapter
+
+    def initialize(klass, adapter=nil)
+      @klass = klass
+      @query = klass.where(nil)
+      @associations = klass.reflect_on_all_associations
+
+      @adapter = adapter
+      @adapter ||= ActiveRecord::Base.connection_config[:adapter]
+    end
+
+    def build(params)
+      params.each do |param|
+        self.with(param) do |tablename, fieldname, operator, value|
+          self.filter(tablename, fieldname, operator, value)
+          self.join(tablename) if tablename != @klass.table_name
+        end
+      end
+      return self
+    end
+
+    protected
+      def filter(tablename, fieldname, operator, value)
+        filter = Filter.new(tablename, fieldname, operator, value, @adapter)
+        @query = @query.where(filter.build)
+        return self
+      end
+
+      def join(tablename)
+        @query = @query.joins(self.association_for(tablename)) 
+        return self
+      end
+
+      def with(param)
+        param[1].each do |second|
+          if second[1].is_a?(Hash)
+            second[1].each do |operator, value| 
+              next if value.nil?
+              yield(param[0], second[0], operator, value)
+            end
+          else
+            next if second[1].nil?
+            yield(@klass.table_name, param[0], second[0], second[1])
+          end
+        end
+      end
+    
+      def association_for(table)
+        @associations.each do |assoc|
+          return assoc.name if table.to_s == assoc.table_name
+        end
+      end
+  end
+end

data/lib/quickfilter/version.rb

@@ -0,0 +1,3 @@
+module Quickfilter
+  VERSION = "0.1.0"
+end

data/quickfilter.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quickfilter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "quickfilter"
+  spec.version       = Quickfilter::VERSION
+  spec.authors       = ["Rodette Pedro"]
+  spec.email         = ["rpedro@jway.com"]
+
+  spec.summary       = "Build Filters Quickly"
+  spec.description   = "Search active records using a standard set of SQL filters."
+  spec.homepage      = "https://github.com/rcpedro/quickfilter"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: quickfilter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodette Pedro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Search active records using a standard set of SQL filters.
+email:
+- rpedro@jway.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/quickfilter.rb
+- lib/quickfilter/filter.rb
+- lib/quickfilter/handlers.rb
+- lib/quickfilter/query_builder.rb
+- lib/quickfilter/version.rb
+- quickfilter.gemspec
+homepage: https://github.com/rcpedro/quickfilter
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Build Filters Quickly
+test_files: []