filterable_model 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6078a2bd24668ce14e00ccf274a3965c4536e99c43b316a10775d53d606c7958
+  data.tar.gz: b11cd635de59d42d7ac76ef0967dbf21735e82ef77d2934f2071c24cc81e25cb
+SHA512:
+  metadata.gz: 753f40faa8a128a3af5b69a81a0a8c4e3209e82665dace115f2e1848ae0cf72806a8194a41c2f5db7963bf6595d4d2591f1e2711da272f10fe6a4314dc712fb6
+  data.tar.gz: ed6bff929dbf8c5e3cffbc948f8c4d8cfd31bc6c53ba4db336214bf72ca9c27c3a408d063c550dc8e9a735d277b2d6cfe5a5aad66e6428e16f9343740678de61

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Umar Al-Kfaween
+
+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,104 @@
+# FilterableModel
+
+FilterableModel provides an organized and seamless way to filter your ActiveRecord objects using real and custom attributes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'filterable_model', '~> 0.1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install filterable_model
+
+## Usage
+
+Include FilterableModel inside ApplicationRecord or directly inside your ActiveRecord model:
+
+```ruby
+class User < ApplicationRecord
+  include FilterableModel
+end
+```
+
+### Filtering by real attributes
+
+To filter using the exact values of your ActiveRecord model attributes, override the `filterable_attributes` class method to return an array of whitelisted attributes:
+
+```ruby
+class User < ApplicationRecord
+  include FilterableModel
+
+  concerning :Filtering do
+    class_methods do
+
+      def filterable_attributes
+        %w[id gender is_subscribed]
+      end
+
+    end
+  end
+
+end
+```
+
+### Filtering by custom attributes
+
+Filtering using custom attributes works by calling the add_filter method and passing a block that accepts the filter-by value, and returns an `ActiveRecord::Relation`:
+
+```ruby
+class User < ApplicationRecord
+  include FilterableModel
+
+  concerning :Filtering do
+    included do
+
+      add_filter :name do |name| # search by first name or username
+        where("LOWER(users.first_name) LIKE :query OR LOWER(users.username) LIKE :query", query: "%#{name.downcase}%")
+      end
+
+
+      add_filter :just_active do |value| # filter by users with active sessions
+        if value.to_s == 'true'
+          includes(:session).where(session: { active: true })
+        else
+          current_scope # do not change the current relation
+        end
+      end
+
+    end
+  end
+end
+```
+
+Filter your relation by calling `filter` on your model and passing the filtering hash:
+
+```ruby
+@users = User.all
+
+filtering_hash = {
+  gender: 'male',
+  is_subscribed: 'false',
+  name: 'John',
+  just_active: 'true'
+}
+
+@users = @users.filter(filtering_hash)
+```
+
+Passing an unknown filter will raise a `FilterNotSupported` error.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/umar221b/filterable_model.
+
+## 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,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 "filterable_model"
+
+# 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/filterable_model.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "filterable_model/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "filterable_model"
+  spec.version       = FilterableModel::VERSION
+  spec.authors       = ["Umar Al-Kfaween"]
+  spec.email         = ["omar.ka923@gmail.com"]
+
+  spec.summary       = %q{FilterableModel provides an organized and seamless way to filter your ActiveRecord objects using model attributes or custom attributes.}
+  spec.description   = %q{FilterableModel provides an organized and seamless way to filter your ActiveRecord objects using model attributes or custom attributes.}
+  spec.homepage      = "https://github.com/umar221b/filterable_model"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.2.2'
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/umar221b/filterable_model"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 4.2.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/filterable_model.rb

@@ -0,0 +1,50 @@
+require "filterable_model/version"
+
+module FilterableModel
+  class Error < StandardError; end
+  class FilterNotSupported < Error; end
+
+  extend ActiveSupport::Concern
+  included {}
+
+  class_methods do
+    def filter(filters)
+      relations = build_relations(filters.as_json)
+      result = send('all')
+      relations.each { |relation| result.merge!(relation) }
+      result
+    end
+
+    # array of strings of model attributes that support being filtered through a basic where statement
+    def filterable_attributes
+      []
+    end
+
+    def add_filter(filter_name, &block)
+      filter_name = filter_name.to_s
+      custom_filters[filter_name] = block
+    end
+
+    private
+
+    def custom_filters
+      @custom_filters ||= {}
+    end
+
+    def build_relations(filters)
+      filters.map do |filter_name, value|
+        get_relation(filter_name, value)
+      end
+    end
+
+    def get_relation(filter_name, value)
+      if custom_filters.key?(filter_name)
+        custom_filters[filter_name].call(value)
+      elsif filterable_attributes.include?(filter_name)
+        where(filter_name => value)
+      else
+        raise FilterNotSupported, "Filtering by '#{filter_name}' is not supported."
+      end
+    end
+  end
+end

data/lib/filterable_model/version.rb

@@ -0,0 +1,3 @@
+module FilterableModel
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: filterable_model
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Umar Al-Kfaween
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !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'
+description: FilterableModel provides an organized and seamless way to filter your
+  ActiveRecord objects using model attributes or custom attributes.
+email:
+- omar.ka923@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- filterable_model.gemspec
+- lib/filterable_model.rb
+- lib/filterable_model/version.rb
+homepage: https://github.com/umar221b/filterable_model
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/umar221b/filterable_model
+  source_code_uri: https://github.com/umar221b/filterable_model
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+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: FilterableModel provides an organized and seamless way to filter your ActiveRecord
+  objects using model attributes or custom attributes.
+test_files: []