doure 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 699a3e3244c2fe33d075967a17478c02b176e9b8
+  data.tar.gz: 837ef221bb0e702fac32a3a7a6c6429b561a1da9
+SHA512:
+  metadata.gz: 36b4859bbe22a9baf42ad38da0c49dd49c8e52309d880886fb5e985d69886cee9f68ed8e0e2864cad5208786cd8690a85345ee494b17c6e25bf0fb6fb1ef6eeb
+  data.tar.gz: 788e22ff0aa88d28892f3aa3cce3c6b0651f685a88e02dd43f87ff9d3b7605b22a97f83a13558fa5010cb06b53466902ba9b8f3371917aed018a34be54668e3d

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in doure.gemspec
+gemspec

data/README.md

@@ -0,0 +1,143 @@
+# Doure
+
+Doure is a minimal abstraction to write parameterized filters for ActiveRecord models. It allows you to write named filters that accept one parameter, and use those later with `filter`, ex:
+
+```ruby
+class PostFilter < Doure::Filter
+  cont_filter(:title)
+  filter(:author_role_in) { |s, v| s.joins(:author).where(authors: { role: v }) }
+end
+
+Post.filter(title_cont: "Dev", author_role_in: ["editor", "admin"])
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'doure'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doure
+
+## Usage
+
+Given you have an ActiveRecord model, you need to extend the filterable module and define which class you will use to declare the filters, for example:
+
+```ruby
+# app/models/post.rb
+
+class Post < ApplicationRecord
+  extend Doure::Filterable
+  
+  filter_class PostFilter
+end
+```
+
+Then declare the filters in that class, inheriting from `Doure::Filter`:
+
+```ruby
+# app/filters/post_filter.rb
+
+class PostFilter < Doure::Filter
+  cont_filter(:title)
+  filter(:author_role_in) { |s, v| s.joins(:author).where(authors: { role: v }) }
+end
+```
+
+### Declaring filters
+
+Each filter has a name and receive a parameter, which you use to implement the desired clause. 
+
+The most basic method to declare filters is `filter(name, &block)`. The block receives an AR relation and the value, and must return another AR relation. 
+
+You can also use the additional argument `:as` to `filter` (or any of the other predefined filters) in order to apply an automatic casting to the value passed from `Model#filter(hash)`. Example:
+
+```ruby
+class PostFilter < Doure::Filter
+  filter(:is_visible, as: :boolean) { |s, v|
+    # 'v' is a boolean here even if used as `Post.filter(is_visible: 'true')` 
+    s.where(active: v) 
+  }
+end
+```
+
+The supported type castings are:
+
+- `:boolean`: Will be casted using the default Rails semantics around booleans coming from forms, so that '1', 'true', 'T', etc will be `true`. See: https://github.com/rails/rails/blob/47eadb68bfcae1641b019e07e051aa39420685fb/activemodel/lib/active_model/type/boolean.rb#L17
+
+- `:date`: Will be casted using `Date.parse`
+
+- `:datetime`: Will be casted using `Time.parse` 
+
+If you want to modify or extend the supported type castings, you can always define the `cast_value(type, value)` method on the filter class. Ex:
+
+```ruby
+class PostFilter < Doure::Filter
+  eq_filter(:publish_date, as: :special_date_format)
+  
+  def cast_value(type, value)
+    case type
+      when :special_date_format
+        Date.strptime(value, "formatting string")
+      else
+        super
+    end
+  end
+end
+```
+
+
+### Predefined filters
+
+Some of the most commonly used filters are already provided. The name of the resulting filter is always <filter_name>_<prefix>, for example "title_cont" for a filter like "cont_filter(:title)". In particular the provided filters are:
+
+- `cont_filter(name)`: Implements `ILIKE '%#{value}%'`. Ex: `Post.filter(title_cont: 'dev')`
+- `eq_filter(name)`: Implements equality. Ex: `Post.filter(id_eq: 12)`
+- `not_eq_filter(name)`: Non-equality. Ex: `Post.filter(id_not_eq: 12)`
+- `present_filter(name)`: This is a boolean filter by default. Implements equality / non-equality against NULL. Ex: `Post.filter(slug_present: false)`
+-  Numerical comparators, `gt_filter, lt_filter, gteq_filter, lteq_filter`: Implements numerical comparators, the passed value is left as-is. Ex: `Post.filter(views_count_gt: 10)` 
+
+
+### Using Model#filter
+
+The `#filter` method is chainable with other scopes, for example:
+
+`Post.where(category_id: 12).filter(title_cont: "Dev")`
+
+Or with named scopes you have declared in the model:
+
+`Post.not_deleted.visible.filter(title_cont: "Dev", category_id_eq: '88')`
+
+The expected use case for Doure is to implement search features. Since it's a common scenario to use `Model#filter` passing a hash of values coming from a view form, the hash will usually have most of their keys with nil values or empty strings. In order to not give incorrect results, then, `nil` and the empty string (`""`) values are ignored by default. For example:
+
+`Post.filter(title_cont: "", is_visible: "f")`
+
+Will only apply the `is_visible` filter but not the `title_cont`.  
+
+ 
+### FAQ
+
+- The equality filters are not working when using nil values. 
+
+Since nil and empty strings are ignored by default, the equality with nil is not a supported scenario. Instead, you can create an specific presence filter for this (`present_filter(:title)`). 
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/rogercampos/doure.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "doure"
+
+# 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(__FILE__)

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/doure.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "doure/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "doure"
+  spec.version       = Doure::VERSION
+  spec.authors       = ["Roger Campos"]
+  spec.email         = ["roger@rogercampos.com"]
+
+  spec.summary       = %q{Minimal abstraction to write parameterized filters for ActiveRecord models}
+  spec.description   = %q{Minimal abstraction to write parameterized filters for ActiveRecord models}
+  spec.homepage      = "https://github.com/rogercampos/doure"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 4.0.0"
+  spec.add_dependency "activesupport", ">= 4.0.0"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/doure.rb

@@ -0,0 +1,8 @@
+require "doure/version"
+
+require 'doure/filter'
+require 'doure/filterable'
+
+module Doure
+  # Your code goes here...
+end

data/lib/doure/filter.rb

@@ -0,0 +1,73 @@
+module Doure
+  class Filter
+    class_attribute :mapping
+    self.mapping = ActiveSupport::HashWithIndifferentAccess.new
+
+    class << self
+      def inherited(subclass)
+        subclass.mapping = self.mapping.dup
+      end
+
+      def filter(name, opts = {}, &apply)
+        mapping[name] = [opts, apply]
+      end
+
+      def eq_filter(name, opts = {})
+        block = lambda { |s, value| s.where(name => value) }
+        mapping["#{name}_eq"] = [opts, block]
+      end
+
+      def not_eq_filter(name, opts = {})
+        block = lambda { |s, value| s.where.not(name => value) }
+        mapping["#{name}_not_eq"] = [opts, block]
+      end
+
+      def cont_filter(name, opts = {})
+        block = lambda { |s, value| s.where(s.arel_table[name].matches("%#{value}%")) }
+        mapping["#{name}_cont"] = [opts, block]
+      end
+
+      def present_filter(name, opts = {})
+        block = lambda { |s, value| value ? s.where.not(name => nil) : s.where(name => nil) }
+        mapping["#{name}_present"] = [opts.merge(as: :boolean), block]
+      end
+
+      %w(gt lt gteq lteq).each do |comparison|
+        define_method("#{comparison}_filter") do |name, opts = {}|
+          block = lambda { |s, value| s.where(s.arel_table[name].send(comparison, value)) }
+          mapping["#{name}_#{comparison}"] = [opts, block]
+        end
+      end
+    end
+
+    def initialize(scope)
+      @scope = scope.all # Force AR:Relation from possible AR:Base
+    end
+
+    def apply(params = {})
+      params.each do |key, value|
+        if !value.nil? && value != "" && mapping.key?(key)
+          casted_value = mapping[key][0].key?(:as) ? cast_value(mapping[key][0][:as], value) : value
+          @scope = mapping[key][1].call(@scope, casted_value)
+        end
+      end
+
+      @scope
+    end
+
+    private
+
+    def cast_value(type, value)
+      case type
+        when :boolean
+          ActiveRecord::Type::Boolean.new.cast(value)
+        when :date
+          (String === value) ? Date.parse(value) : value
+        when :datetime
+          (String === value) ? Time.parse(value) : value
+        else
+          value
+      end
+    end
+  end
+end

data/lib/doure/filterable.rb

@@ -0,0 +1,12 @@
+module Doure
+  module Filterable
+    def filter_class(klass)
+      @filter_class = klass
+    end
+
+    def filter(params = {})
+      @filter_class or raise "No filter model specified"
+      @filter_class.new(self).apply(params)
+    end
+  end
+end

data/lib/doure/version.rb

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

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: doure
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roger Campos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Minimal abstraction to write parameterized filters for ActiveRecord models
+email:
+- roger@rogercampos.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- doure.gemspec
+- lib/doure.rb
+- lib/doure/filter.rb
+- lib/doure/filterable.rb
+- lib/doure/version.rb
+homepage: https://github.com/rogercampos/doure
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Minimal abstraction to write parameterized filters for ActiveRecord models
+test_files: []