active_filters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4db334f6ba04d16a4d98c1d2cbf270b6c5c9ae0c14021028dda658ff4c72e06
+  data.tar.gz: 0c146475da64250d96d681977a9e58e11c3dc85bd287fbf4e21504940b9db96b
+SHA512:
+  metadata.gz: 498d857af4d5e6dd3f8f5a81b61e290abd7056fe6ab81af616e9a825a6ff02c5a6ec8a07af908ede654bffa9b0f890491e66b4953da08b4bd33dd3bd1ada8f33
+  data.tar.gz: edb023ee0b84c34d4c3f8f75f5d20771bf3db53f13131c59205067ea615ba02066d1d413ed10b776df1390f75e829ebcb47012146441b3cfddfc41e43e9c2bb3

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    active_filters (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.2)
+      actionview (= 5.2.2)
+      activesupport (= 5.2.2)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.2)
+      activesupport (= 5.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.2)
+      activesupport (= 5.2.2)
+    activerecord (5.2.2)
+      activemodel (= 5.2.2)
+      activesupport (= 5.2.2)
+      arel (>= 9.0)
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.4)
+    crass (1.0.4)
+    erubi (1.8.0)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    metaclass (0.0.4)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    mocha (1.8.0)
+      metaclass (~> 0.0.1)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (>= 4.2)
+  active_filters!
+  activerecord (>= 4.2)
+  activesupport (>= 4.2)
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  mocha (>= 1.8.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nathan Huberty
+
+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,120 @@
+# ActiveFilters
+
+Active Filters allows you to map incoming controller parameters to filter your resources by chaining scopes.
+
+It is inspired by [Justin Weiss solution](https://www.justinweiss.com/articles/search-and-filter-rails-models-without-bloating-your-controller/) offering a cleaner way to declare your filters.
+
+The gem [has_scope](https://github.com/plataformatec/has_scope) exists but does not handle params stored as the value of a hash.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_filters'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_filters
+
+## Usage
+
+Let's say you have several scopes on your User model
+
+```ruby
+class User < ApplicationRecord
+    scope :country, -> country_code { where(country: country_code) }
+    scope :gender, -> gender { where(gender: gender) }
+end
+```
+
+And you want to chain thoses two scopes.
+You first need to include the Filterable controller module in your application controller
+
+```ruby
+class ApplicationController < ActionController::Base
+    include ActiveFilters::Controller::Filterable
+end
+```
+
+and then include the model Filterable one in the model you want to filter.
+
+```ruby
+class User < ApplicationRecord
+    include ActiveFilters::Model::Filterable
+
+    scope :country, -> country_code { where(country: country_code) }
+    scope :gender, -> gender { where(gender: gender) }
+end
+```
+
+Then you just need to declare your named scopes as filters using the `has_filters` DSL
+
+```ruby
+class UsersController < ApplicationController
+    has_filters :country, :gender
+end
+```
+
+and apply them to a specific resource using the `filter` class method and the `filterable params` hash of params as argument.
+
+```ruby
+class UsersController < ApplicationController
+    has_filters :country, :gender
+
+    def index
+        @users = User.filter(filterable_params)
+    end
+end
+```
+
+For each request:
+
+```
+/users
+#=> acts like a normal request
+
+/users?country=FR&gender=female
+#=> calls the named scope and bring only females in France
+```
+
+Now let's say you want to use incoming params stored as the value of a hash as scopes:
+
+```
+/users?filter[country]=FR&filter[gender]=female
+#=> { filter: { country: 'FR', gender: 'female' } }
+```
+
+Then you can add the `in_key` attribute with the name of the key in which params are stored.
+
+```ruby
+class UsersController < ApplicationController
+    has_filters :country, :gender, in_key: :filter
+
+    def index
+        @users = User.filter(filterable_params)
+    end
+end
+```
+
+## Initializer
+
+By default the params variable used by Active Filters is `params`.
+If you want to use another params variable, you have to create an initializer in `config/initializers/active_filters.rb` and set the variable name: (for instance with @params)
+
+```ruby
+ActiveFilters::Setup.params_variable = '@params'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_filters.
+
+## 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,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/active_filters.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_filters/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_filters"
+  spec.version       = ActiveFilters::VERSION
+  spec.authors       = ["Nathan Huberty"]
+  spec.email         = ["nathan.huberty@gmail.com"]
+
+  spec.summary       = "Map incoming controller parameters to named scopes in your models"
+  spec.description   = "Map incoming controller parameters to named scopes in your models"
+  spec.homepage      = "https://github.com/FidMe/active_filters"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "activerecord", ">= 4.2"
+  spec.add_development_dependency "activesupport", ">= 4.2"
+  spec.add_development_dependency "actionpack", ">= 4.2"
+  spec.add_development_dependency "mocha", ">= 1.8.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_filters"
+
+# 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/lib/active_filters.rb

@@ -0,0 +1,44 @@
+require "active_filters/version"
+require "active_support/all"
+require_relative "active_filters/setup"
+
+module ActiveFilters
+  module Model
+    module Filterable
+      extend ::ActiveSupport::Concern
+
+      class_methods do
+        def filter(filterable_params)
+          results = all
+          (filterable_params || []).each do |key, value|
+            results = results.public_send(key, value) if value.present?
+          end
+          results
+        end
+      end
+    end
+  end
+
+  module Controller
+    module Filterable
+      extend ::ActiveSupport::Concern
+
+      class_methods do
+        def has_filters(*filters)
+          filter_key = filters.last.is_a?(Hash) && filters.last[:in_key]
+          filters.pop if filter_key
+
+          define_method(:filterable_params) do
+            return {} unless _get_filter_params(filter_key) && filters
+            _get_filter_params(filter_key).slice(*filters)
+          end
+        end
+      end
+
+      def _get_filter_params(filter_key)
+        _params = eval(::ActiveFilters::Setup.params_variable)
+        (filter_key ? _params[filter_key] : _params)
+      end
+    end
+  end
+end

data/lib/active_filters/setup.rb

@@ -0,0 +1,13 @@
+module ActiveFilters
+  class Setup
+    @params_variable = 'params'
+
+    class << self
+      attr_accessor :params_variable
+    end
+
+    def self.configure
+      yield self
+    end
+  end
+end

data/lib/active_filters/version.rb

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

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: active_filters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Huberty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-07 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: 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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Map incoming controller parameters to named scopes in your models
+email:
+- nathan.huberty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_filters.gemspec
+- bin/console
+- bin/setup
+- lib/active_filters.rb
+- lib/active_filters/setup.rb
+- lib/active_filters/version.rb
+homepage: https://github.com/FidMe/active_filters
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Map incoming controller parameters to named scopes in your models
+test_files: []