All Projects → dubadub → filtered

dubadub / filtered

Licence: MIT license
Filters ActiveRecord queries in a nice way

Programming Languages

ruby
36898 projects - #4 most used programming language
shell
77523 projects

Projects that are alternatives of or similar to filtered

rails cursor pagination
Add cursor pagination to your ActiveRecord backed application
Stars: ✭ 21 (-25%)
Mutual labels:  ruby-gem, activerecord, gem, ruby-on-rails
Motion
Reactive frontend UI components for Rails in pure Ruby
Stars: ✭ 498 (+1678.57%)
Mutual labels:  ruby-gem, gem, ruby-on-rails
activerecord-setops
Union, Intersect, and Difference set operations for ActiveRecord (also, SQL's UnionAll).
Stars: ✭ 21 (-25%)
Mutual labels:  ruby-gem, activerecord, ruby-on-rails
Devise masquerade
Extension for devise, enable login as functionality. Add link to the masquerade_path(resource) and use it.
Stars: ✭ 380 (+1257.14%)
Mutual labels:  ruby-gem, gem, ruby-on-rails
Ransack
Object-based searching.
Stars: ✭ 5,020 (+17828.57%)
Mutual labels:  ruby-gem, activerecord, ruby-on-rails
activerecord-crate-adapter
Ruby on Rails ActiveRecord adapter for CrateDB
Stars: ✭ 27 (-3.57%)
Mutual labels:  ruby-gem, activerecord, ruby-on-rails
active record-updated at
Touch `updated_at` by default with calls to `update_all` and `update_column(s)`
Stars: ✭ 27 (-3.57%)
Mutual labels:  activerecord, gem, ruby-on-rails
rails-countries
Integration between Rails and countries gem.
Stars: ✭ 17 (-39.29%)
Mutual labels:  activerecord, gem
index shotgun
duplicate index checker 🔥 🔫 👮
Stars: ✭ 35 (+25%)
Mutual labels:  activerecord, gem
eight ball
Ruby gem for querying feature flags
Stars: ✭ 17 (-39.29%)
Mutual labels:  ruby-gem, ruby-on-rails
multi-tenancy-devise
mtdevise adds basecamp style user logins to your ruby on rails application.
Stars: ✭ 27 (-3.57%)
Mutual labels:  ruby-gem, gem
activerecord-cockroachdb-adapter
CockroachDB adapter for ActiveRecord.
Stars: ✭ 90 (+221.43%)
Mutual labels:  activerecord, ruby-on-rails
has placeholder image
A Ruby gem for generating string based placeholder images in Rails.
Stars: ✭ 20 (-28.57%)
Mutual labels:  ruby-gem, ruby-on-rails
syobocal
Simle gem for Syboi Calendar
Stars: ✭ 13 (-53.57%)
Mutual labels:  ruby-gem, gem
request store-sidekiq
Provides an easy integration between RequestStore and Sidekiq
Stars: ✭ 32 (+14.29%)
Mutual labels:  ruby-gem, ruby-on-rails
tag columns
Fast & simple Rails ActiveRecord model tagging using PostgreSQL's Array datatype
Stars: ✭ 40 (+42.86%)
Mutual labels:  ruby-gem, ruby-on-rails
nxt state machine
A simple but powerful state machine implementation.
Stars: ✭ 14 (-50%)
Mutual labels:  activerecord, ruby-on-rails
squint
Search PostgreSQL jsonb and hstore columns
Stars: ✭ 26 (-7.14%)
Mutual labels:  activerecord, ruby-on-rails
modular routes
Dedicated controllers for each of your Rails route actions.
Stars: ✭ 45 (+60.71%)
Mutual labels:  gem, ruby-on-rails
activerecord-shard for
Database Sharding Library for ActiveRecord
Stars: ✭ 16 (-42.86%)
Mutual labels:  activerecord, gem

Gem VersionBuild Status

Filtered - add filter to ActiveRecord queries

The gem helps to create filters for Rails’ ActiveRecord in an old-fashion way. It makes your controller simpler and forms effortless.

Installation

Add this line to your application's Gemfile:

gem "filtered"

And then run:

    # 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:

    $ rails generate filter car make model year body # fields can be added later
          create app/filters/car_filter.rb

To use this filter in a controller:

# 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 = CarFilter.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:

# 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. There are a few open issues in ActiveRecord related to that method, please, have a look through it here.

Ruby/Rails versions supported

Ruby: 2.3.x, 2.4.x, 2.5.x, 2.6.x, jruby-9.1.x, jruby-9.2.x. Rails: 4.0.x, 4.1.x, 4.2.x, 5.0.x, 5.1.x, 5.2.x, 6.0.0rc.

Credits

This gem woudn't exist without original ideas of @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.

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 code of conduct.

License

The gem is available as open source under the terms of the MIT License.

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.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].