filtered 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d893c9bc84dbc584724e5ebb0e64b6b44a67a0d4b56cbfce897db6ff3ee2b69
+  data.tar.gz: 43bc59830b13a4e4ea72e5c540575e312f408f9064beafc341c2f8bd7159189e
+SHA512:
+  metadata.gz: 6f80acf6e14e43d402313493c5ca0ec78bd66afbd359782594efbbf3824a39bbc1460f037f17d707b15ce7dc5ae368319388337e0c0d571af7b8c9a60c0c0197
+  data.tar.gz: 58a5d0b3fc5da81bac6deda3ce9417e557b7fbb93a1b685a44f91c5b1cb2eb81d340923307b580e1eb4b26263725e44e1c69a14479997117f7937ef65a8c95d7

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gemfile.lock
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,53 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+addons:
+  postgresql: "9.6"
+rvm:
+  - 2.3.5
+  - 2.4.2
+  - 2.5.1
+  - 2.6.3
+  - ruby-head
+  - jruby-9.1.9.0
+  - jruby-9.2.5.0
+  - jruby-head
+gemfile:
+  - gemfiles/activerecord_4.0.gemfile
+  - gemfiles/activerecord_4.1.gemfile
+  - gemfiles/activerecord_4.2.gemfile
+  - gemfiles/activerecord_5.0.gemfile
+  - gemfiles/activerecord_5.1.gemfile
+  - gemfiles/activerecord_5.2.gemfile
+  - gemfiles/activerecord_6.0rc1.gemfile
+env:
+  - DB=sqlite
+  - DB=postgres
+
+matrix:
+  fast_finish: true
+  exclude:
+  - rvm: 2.2.6
+    gemfile: gemfiles/activerecord_6.0rc1.gemfile
+  - rvm: 2.3.5
+    gemfile: gemfiles/activerecord_6.0rc1.gemfile
+  - rvm: 2.4.2
+    gemfile: gemfiles/activerecord_6.0rc1.gemfile
+  - rvm: jruby-9.1.9.0
+    gemfile: gemfiles/activerecord_5.0.gemfile
+  - rvm: jruby-9.1.9.0
+    gemfile: gemfiles/activerecord_6.0rc1.gemfile
+  - rvm: jruby-9.2.5.0
+    gemfile: gemfiles/activerecord_5.0.gemfile
+  - rvm: jruby-9.2.5.0
+    gemfile: gemfiles/activerecord_6.0rc1.gemfile
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+
+before_install:
+  - gem update --system
+  - gem install bundler
+script:
+  - bundle exec rake

data/Appraisals

@@ -0,0 +1,112 @@
+appraise "activerecord-6.0rc1" do
+  gem "activerecord", "~>6.0.0.rc1", require: "active_record"
+  gem "generator_spec"
+
+  platforms :jruby do
+    gem "activerecord-jdbcsqlite3-adapter"
+    gem "jdbc-sqlite3"
+    gem "jdbc-postgres"
+  end
+
+  platforms :ruby, :mswin, :mingw do
+    gem "pg", "~> 1.1.4"
+    gem "sqlite3", "~> 1.4.0"
+  end
+end
+
+appraise "activerecord-5.2" do
+  gem "activerecord", "~>5.2", require: "active_record"
+  gem "generator_spec"
+
+  gemfile.platforms :jruby do
+    gem "activerecord-jdbcsqlite3-adapter"
+    gem "jdbc-sqlite3"
+    gem "jdbc-postgres"
+  end
+
+  gemfile.platforms :ruby, :mswin, :mingw do
+    gem "sqlite3", "~> 1.3.0"
+    gem "pg", "~> 0.21"
+  end
+end
+
+appraise "activerecord-5.1" do
+  gem "activerecord", "~>5.1", require: "active_record"
+  gem "generator_spec"
+
+  gemfile.platforms :jruby do
+    gem "activerecord-jdbcsqlite3-adapter"
+    gem "jdbc-sqlite3"
+    gem "jdbc-postgres"
+  end
+
+  gemfile.platforms :ruby, :mswin, :mingw do
+    gem "sqlite3", "~> 1.3.0"
+    gem "pg", "~> 0.21"
+  end
+end
+
+appraise "activerecord-5.0" do
+  gem "activerecord", "~>5.0", require: "active_record"
+  gem "generator_spec"
+
+  gemfile.platforms :jruby do
+    gem "activerecord-jdbcsqlite3-adapter"
+    gem "jdbc-sqlite3"
+    gem "jdbc-postgres"
+  end
+
+  gemfile.platforms :ruby, :mswin, :mingw do
+    gem "sqlite3", "~> 1.3.0"
+    gem "pg", "~> 0.21"
+  end
+end
+
+appraise "activerecord-4.2" do
+  gem "activerecord", "~>4.2", require: "active_record"
+  gem "generator_spec"
+
+  gemfile.platforms :jruby do
+    gem "activerecord-jdbcsqlite3-adapter", "~>1.3"
+    gem "jdbc-sqlite3"
+    gem "jdbc-postgres"
+  end
+
+  gemfile.platforms :ruby, :mswin, :mingw do
+    gem "sqlite3", "~> 1.3.0"
+    gem "pg", "~> 0.21"
+  end
+end
+
+appraise "activerecord-4.1" do
+  gem "activerecord", "~>4.1", require: "active_record"
+  gem "generator_spec"
+
+  gemfile.platforms :jruby do
+    gem "activerecord-jdbcsqlite3-adapter", "~>1.3"
+    gem "jdbc-sqlite3"
+    gem "jdbc-postgres"
+  end
+
+  gemfile.platforms :ruby, :mswin, :mingw do
+    gem "sqlite3", "~> 1.3.0"
+    gem "pg", "~> 0.21"
+  end
+end
+
+appraise "activerecord-4.0" do
+  gem "activerecord", "~>4.0", require: "active_record"
+  gem "generator_spec"
+
+  gemfile.platforms :jruby do
+    gem "activerecord-jdbcsqlite3-adapter", "~>1.3"
+    gem "jdbc-sqlite3"
+    gem "jdbc-postgres"
+  end
+
+  gemfile.platforms :ruby, :mswin, :mingw do
+    gem "sqlite3", "~> 1.3.0"
+    gem "pg", "~> 0.21"
+  end
+end
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dubovskoy.a@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in filtered.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    filtered (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.2)
+  bundler (~> 2.0)
+  filtered!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Alexey Dubovskoy
+
+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,204 @@
+[![Build Status](https://travis-ci.org/dubadub/filtered.svg?branch=master)](https://travis-ci.org/dubadub/filtered)
+
+
+# Filtered - add filter to ActiveRecord queries
+
+It gives freedom of using any names, columns, scopes or associations behind fields. Also, it allows you to reuse queries or even compose them from reusable parts. Nice part about it is that it ingerates with Rails forms out of the box.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "filtered"
+```
+
+And then run:
+
+```bash
+    # 1. Download and install the gem
+    $ bundle
+
+    # 2. Generate a base filter class
+    $ rails generate filtered:install
+          create app/filters/application_filter.rb
+```
+
+## Usage
+
+To create a new filter with a generator:
+
+```bash
+    $ rails generate filter car make model year body # fields can be added later
+          create app/filiters/car_filter.rb
+```
+
+
+To use this filter in a controller:
+
+```ruby
+# app/controllers/noise_measurements_controller.rb
+class NoiseMeasurementsController < ApplicationController
+
+  before_action :set_filter
+
+  def index
+    @measurements = CarNoiseMeasurement.all.merge(@filter)
+  end
+
+  private
+
+  def set_filter
+    # it can take an optional block if you need to set an auxilary variable:
+    @filter = CarsFilter.new(filter_params) do |f|
+      f.user = current_user
+    end
+  end
+
+  def filter_params
+    params.fetch(:filter, {}).permit(make: [], model: [], year: [], body: [], :ordering)
+  end
+
+end
+```
+
+
+To define your filter:
+
+```ruby
+# app/filters/car_filter.rb
+class CarFilter < ApplicationFilter
+  attr_accessor :user
+
+  # Usage with default values.
+
+  # It will add a simple `.where(year: ["2010", "2011"])` clause to query.
+  field :year
+
+
+  # Or you can fully control how Filtered modifies query with a block.
+  # Notice that block returns lambda. That's because we want to postpone
+  # it's evaluation and let ActiveRecord do that when required.
+
+  # It will add `.joins(:specification).merge(Car::Specification.where(year: ["2010", "2011"]))`
+  # clause to the query.
+  field :year do |year|
+    -> { joins(:specification).merge(Car::Specification.where(year: year)) }
+  end
+
+  # There are some options to a filter field.
+
+  # `allow_nil` (default is false) will allow nil values to be passed into query.
+  # Defatul behaviour is to ignore field althogher if value is nil.
+  field :year, allow_nil: true
+
+  # `allow_blank` (default is false) will allow empty values to be passed into query.
+  # Defatul behaviour is to ignore field althogher if value is blank.
+  field :year, allow_blank: true
+
+  # `default` will set field default value if field is not passed into constructor.
+  # it accepts literal value:
+  field :year, default: "2019"
+  # method name
+  field :year, default: :default_year
+  # or lambda with filter object as argument
+  field :year, default: -> (filter) { filter.default_year }
+
+  # `if` and `unless` will switch filter on or off based on value or filter.
+  # it can accept lambda with value as argument:
+  field :year, if: -> (value) { %w(2018 2019).include?(value) }
+  # or value and filter as argument:
+  field :year, if: -> (value, filter) { filter.user.present? && %w(2018 2019).include?(value) }
+  # or method name. it will pass value as an argument
+  field :year, if: :year_applicable?
+
+  private
+
+  def default_year
+    if user
+      user.defaults.year
+    else
+      "2019"
+    end
+  end
+
+  def year_applicable?(value)
+    user.present? && %w(2018 2019).include?(value)
+  end
+
+end
+
+```
+
+To use the same `@filter` object in views (it will automatically set all the related inputs in a form):
+
+```
+# app/views/noise_measurements/index.slim
+
+  = form_for(@filter, url: search_path, method: "GET", as: :filter) do |f|
+    .fields
+      span Year
+      - YEARS.each do |year|
+        = year
+        = f.check_box :year, { multiple: true }, year, nil
+
+    .fields
+      span Body
+      - BODIES.each do |body|
+        = body
+        = f.check_box :body, { multiple: true }, body, nil
+
+    .fields
+      span Make
+      - MAKES.each do |make|
+        = make
+        = f.check_box :make, { multiple: true }, make, nil
+
+    .fields
+      span Sorting
+
+    span Year
+      = f.radio_button :ordering, "year asc"
+      = f.radio_button :ordering, "year desc"
+
+    span Idle
+      = f.radio_button :ordering, "noise_idle asc"
+      = f.radio_button :ordering, "noise_idle desc"
+      span 50
+      = f.radio_button :ordering, "noise_50 asc"
+      = f.radio_button :ordering, "noise_50 desc"
+      span 80
+      = f.radio_button :ordering, "noise_80 asc"
+      = f.radio_button :ordering, "noise_80 desc"
+
+    .actions
+      = f.submit "Filter"
+```
+
+
+## Under the hood
+
+Filtered uses API provided by ActiveRecord [merge method](https://api.rubyonrails.org/classes/ActiveRecord/SpawnMethods.html#method-i-merge). There are a few open issues in ActiveRecord related to that method, please, have a look through it [here](https://github.com/rails/rails/search?q=activerecord+merge&state=open&type=Issues).
+
+## Credits
+
+This gem woudn't exist without original ideas of [@caJaeger](https://github.com/caJaeger).
+
+## 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/dubadub/filtered. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Filtered project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dubadub/filtered/blob/master/CODE_OF_CONDUCT.md).

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 "filtered"
+
+# 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
+bundle exec appraisal install
+# Do any other automated setup that you need to do here

data/filtered.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "filtered/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "filtered"
+  spec.version       = Filtered::VERSION
+  spec.authors       = ["Alexey Dubovskoy"]
+  spec.email         = ["dubovskoy.a@gmail.com"]
+
+  spec.summary       = %q{Filters ActiveRecord queries in a nice way}
+  spec.homepage      = "https://github.com/dubadub/filtered"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples|docs|gemfiles)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "appraisal", "~> 2.2"
+
+end

data/lib/filtered/base.rb

@@ -0,0 +1,250 @@
+module Filtered
+  class Base
+
+    module ClassMethods
+      # Defines a field in a filter.
+      #
+      # When you provide no options, it will by default add a simple `where(year: ["2010", "2011"])`
+      # clause to the query.
+      #
+      #   class CarFilter < ApplicationFilter
+      #
+      #     field :year
+      #
+      #   end
+      #
+      # Or with a block which is passed with the current field value. Note that block must return
+      # proc which will be merged in the query:
+      #
+      #   class CarFilter < ApplicationFilter
+      #
+      #     field :year do |value|
+      #       -> { where(year: "20#{value}") }
+      #     end
+      #
+      #   end
+      #
+      # The second argument to a block is filter object itself:
+      #
+      #   class CarFilter < ApplicationFilter
+      #
+      #     attr_accessor :user
+      #
+      #     field :year, allow_blank: true do |value, filter|
+      #       -> { where(year: value, user: filter.user) }
+      #     end
+      #
+      #   end
+      #
+      # Options:
+      # * <tt>:default</tt> - Specifies a method (e.g. <tt>default: :default_year</tt>),
+      #   proc (e.g. <tt>default:  Proc.new { |filter| filter.default_year }</tt>)
+      #   or object (e.g <tt>default: "2012"</tt>) to call to determine default value.
+      #   It will be called only if the field not passed into filter constructor.
+      # * <tt>:allow_nil</tt> - Add the field into query if field value is +nil+.
+      # * <tt>:allow_blank</tt> - Add the field into query if the value is blank.
+      # * <tt>:if</tt> - Specifies a method or proc to call to determine
+      #   if the field addition to query should occur (e.g. <tt>if: :allow_year</tt>,
+      #   or <tt>if: Proc.new { |year| %w(2018 2019).include?(year) }</tt>). The method,
+      #   or proc should return a +true+ or +false+ value.
+      # * <tt>:unless</tt> - Specifies a method or proc to call to determine
+      #   if the field addition to query should not occur (e.g. <tt>if: :allow_year</tt>,
+      #   or <tt>if: Proc.new { |year| (1999..2005).include?(year) }</tt>). The method,
+      #   or proc should return a +true+ or +false+ value.
+
+      def field(field_name, options = {}, &block)
+        field_name = field_name.to_sym
+
+        field_definition = FieldDefinition.new.tap do |fd|
+          fd.query_updater = if block_given?
+            # TODO look for methods to validate that block returns proc
+            block
+          else
+            # AR ref
+            ->(value) { -> { where(field_name => value) } }
+          end
+
+
+          raise Error, "'if' can't be used with 'allow_nil' or 'allow_blank'" if options[:if] && (options[:allow_nil] || options[:allow_blank])
+
+          fd.acceptance_computer = if options[:if].is_a?(Proc)
+            options[:if]
+          elsif options[:if].is_a?(Symbol)
+            -> (value, filter) { filter.send(options[:if], value) }
+          elsif options[:if].nil?
+            # TODO checking that value is blank just comparing to empty string is very naive
+            ->(value) { (options[:allow_nil] || !value.nil?) && (options[:allow_blank] || value != "") }
+          else
+            raise Error, "Unsupported argument #{options[:if].class} for 'if'. Pass proc or method name"
+          end
+
+
+          raise Error, "'unless' can't be used with 'allow_nil' or 'allow_blank'" if options[:unless] && (options[:allow_nil] || options[:allow_blank])
+
+          fd.decline_computer = if options[:unless].is_a?(Proc)
+            options[:unless]
+          elsif options[:unless].is_a?(Symbol)
+            -> (value, filter) { filter.send(options[:unless], value) }
+          elsif options[:unless].nil?
+            -> { false }
+          else
+            raise Error, "Unsupported argument #{options[:unless].class} for 'unless'. Pass proc or method name"
+          end
+
+
+          fd.default_computer = if options[:default].is_a?(Proc)
+            options[:default]
+          elsif options[:default].is_a?(Symbol)
+            -> (filter) { filter.send(options[:default]) }
+          elsif options[:default]
+            -> (_) { options[:default] }
+          end
+        end
+
+        field_definitions[field_name] = field_definition
+
+        define_method field_name do
+          fields[field_name]
+        end
+      end
+
+      def field_definitions
+        instance_variable_get(:"@field_definitions")
+      end
+    end
+
+    module InstanceMehods
+      def initialize(*_)
+        @field_set = FieldSet.new(self.class.field_definitions)
+
+        super
+      end
+
+      private
+
+      def fields
+        @field_set
+      end
+    end
+
+    extend ClassMethods
+    prepend InstanceMehods
+
+    def self.inherited(base)
+      base.instance_variable_set(:"@field_definitions", Hash.new)
+
+      if field_definitions
+        field_definitions.each do |(name, definition)|
+          base.field_definitions[name] = definition
+        end
+      end
+
+      super
+    end
+
+    # Initializes a new filter with the given +params+.
+    #
+    #
+    #   class CarFilter < ApplicationFilter
+    #
+    #     attr_accessor :user
+    #
+    #     field :year, allow_blank: true do |value, filter|
+    #       -> { where(year: value, user: filter.user) }
+    #     end
+    #
+    #     field :make
+    #     field :model
+    #     field :body
+    #
+    #   end
+    #
+    #   class NoiseMeasurementsController < ApplicationController
+    #     before_action :set_filter
+    #
+    #     def index
+    #       @measurements = CarNoiseMeasurement.all.merge(@filter)
+    #     end
+    #
+    #     private
+    #
+    #     def set_filter
+    #       @filter = CarsFilter.new(filter_params) do |f|
+    #        f.user = current_user
+    #       end
+    #     end
+    #
+    #     def filter_params
+    #       params.fetch(:filter, {}).permit(make: [], model: [], year: [], body: [])
+    #     end
+    #  end
+    def initialize(params = {}, &block)
+      params.each do |name, value|
+        name = name.to_sym
+
+        raise Error, "Passing '#{name}' filter which is not defined" unless fields.defined?(name)
+
+        fields[name] = value
+      end
+
+      yield self if block_given?
+    end
+
+
+    # ActiveRecord calls to_proc when filter merged into relation.
+    def to_proc
+      procs = entitled_fields.inject([]) do |memo, (name, value, definition)|
+        memo << eval_option_proc(definition.query_updater, value)
+
+        memo
+      end
+
+      ->() {
+        # here self is an ActiveRecord relation
+        procs.inject(self) { |chain, next_proc| chain.merge(next_proc) }
+      }
+    end
+
+    def to_hash
+      Hash[entitled_fields.map { |name, value| [name, value] }]
+    end
+
+    def inspect
+      inspection = entitled_fields.collect { |name, value| "#{name}: #{value.inspect}" }.compact.join(", ")
+
+      "#<#{self.class} #{inspection}>"
+    end
+
+    private
+
+    def entitled_fields
+      return enum_for(:entitled_fields) unless block_given?
+
+      fields.each do |name, value, definition|
+        value = definition.default_computer.(self) if !value && definition.default_computer
+
+        value_accepted = eval_option_proc(definition.acceptance_computer, value)
+        value_declined = eval_option_proc(definition.decline_computer, value)
+
+        if value_accepted && !value_declined
+          yield name, value, definition
+        else
+          next
+        end
+      end
+    end
+
+    def eval_option_proc(proc_, value)
+      if proc_.arity == 2
+        proc_.call(value, self)
+      elsif proc_.arity == 1
+        proc_.call(value)
+      elsif proc_.arity == 0
+        proc_.call()
+      else
+        raise Error, "Unsupported number of arguments for proc"
+      end
+    end
+
+  end
+end

data/lib/filtered/engine.rb

@@ -0,0 +1,5 @@
+module Filtered
+  class Engine < ::Rails::Engine
+    config.autoload_paths += Dir["#{config.root}/app/filters/**/"]
+  end
+end

data/lib/filtered/field_definition.rb

@@ -0,0 +1,10 @@
+module Filtered
+  class FieldDefinition
+
+    attr_accessor :query_updater,
+                  :acceptance_computer,
+                  :decline_computer,
+                  :default_computer
+
+  end
+end

data/lib/filtered/field_set.rb

@@ -0,0 +1,27 @@
+module Filtered
+  class FieldSet
+    include Enumerable
+
+    def initialize(definitions)
+      @definitions = definitions
+    end
+
+    def defined?(name)
+      !!@definitions[name]
+    end
+
+    def [](name)
+      instance_variable_get("@#{name}")
+    end
+
+    def []=(name, value)
+      instance_variable_set("@#{name}", value)
+    end
+
+    def each
+      @definitions.each do |name, definition|
+        yield name, instance_variable_get("@#{name}"), definition
+      end
+    end
+  end
+end

data/lib/filtered/version.rb

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

data/lib/filtered.rb

@@ -0,0 +1,13 @@
+module Filtered
+
+  require "filtered/version"
+  require "filtered/field_definition"
+  require "filtered/field_set"
+  require "filtered/base"
+
+  if defined?(Rails)
+    require "filtered/engine"
+  end
+
+  class Error < StandardError; end
+end

data/lib/generators/filter/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Stubs out a new filter. Pass the filter name, either CamelCased or
+    under_scored, and an optional list of fields as arguments.
+
+    You don't have to think up every field up front, but it helps to
+    sketch out a few so you can start working with the filter immediately.
+
+    To create a filter within a module, specify the filter name as a
+    path like 'parent_module/filter_name'.
+
+Example:
+    `rails generate filter users group persmission`
+
+    Users filter.
+        Filter:     app/filters/users_filter.rb

data/lib/generators/filter/filter_generator.rb

@@ -0,0 +1,17 @@
+class FilterGenerator < Rails::Generators::NamedBase
+  check_class_collision suffix: "Filter"
+
+  source_root File.expand_path("templates", __dir__)
+
+  argument :fields, type: :array, default: [], banner: "field field"
+
+  def create_filter_file
+    template "filter.rb", File.join("app/filters", class_path, "#{file_name}_filter.rb")
+  end
+
+  private
+
+  def file_name
+    @_file_name ||= super.sub(/_filter\z/i, "")
+  end
+end

data/lib/generators/filter/templates/filter.rb

@@ -0,0 +1,8 @@
+class <%= class_name %>Filter < ApplicationFilter
+
+<% for field in fields -%>
+  field :<%= field %>
+<% end -%>
+
+end
+

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

@@ -0,0 +1,12 @@
+module Filtered
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("templates", __dir__)
+
+      def generate_install
+        copy_file "application_filter.rb", "app/filters/application_filter.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+class ApplicationFilter < Filtered::Base
+
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: filtered
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Dubovskoy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: 
+email:
+- dubovskoy.a@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- filtered.gemspec
+- lib/filtered.rb
+- lib/filtered/base.rb
+- lib/filtered/engine.rb
+- lib/filtered/field_definition.rb
+- lib/filtered/field_set.rb
+- lib/filtered/version.rb
+- lib/generators/filter/USAGE
+- lib/generators/filter/filter_generator.rb
+- lib/generators/filter/templates/filter.rb
+- lib/generators/filtered/install/install_generator.rb
+- lib/generators/filtered/install/templates/application_filter.rb
+homepage: https://github.com/dubadub/filtered
+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: Filters ActiveRecord queries in a nice way
+test_files: []