simple-filter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc1fcde0783a3183de1f0564fe719aec2a5bee19
+  data.tar.gz: 4faaa88d0c96290aa96c4121dcd7e5cbeb636135
+SHA512:
+  metadata.gz: b20f50f704b2a0217ca555ab122808935f57d30616c15de3ff84e1941367fd0b47d906be62359bb76c38d0f9c61c64afc6539439784c6237f9981aa3d665926d
+  data.tar.gz: 8130ba9f3c88b5d5a5876917550013d197fe0b69119bfbbaf13f7485cca75c7f898bfebb0322cf1f3a9c9cac8f714ac12e94361198cac6ae522f8e01c8a6acff

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.1.6
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Matias Leidemer
+
+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,141 @@
+[![Code Climate](https://codeclimate.com/github/matiasleidemer/simple_filter/badges/gpa.svg)](https://codeclimate.com/github/matiasleidemer/simple_filter) [![Build Status](https://travis-ci.org/matiasleidemer/simple_filter.svg)](https://travis-ci.org/matiasleidemer/simple_filter)
+
+# SimpleFilter
+
+SimpleFilter is a very simple ruby _DSL_ to write filter (or search) classes for ActiveRecord scopes. It's only responsability is to map parameters to defined scopes.
+
+It currently works with ActiveRecord 4.0 or greater.
+
+## Usage
+
+To use search classes is pretty straightforward:
+
+```ruby
+FooSearch.new(params = {}).scoping(Model.all).search
+```
+
+`params` should be a hash containing all the desired filters, and `scope` is the current model scope that the filters will be applied into, for example:
+
+```ruby
+class CampaignsController < ApplicationController
+  def index
+    @campaigns = CampaignSearcher.new(search_params).scoping(Campaign.all).search
+  end
+
+  private
+  
+  def search_params
+    params.slice(:name, :category, :whatever)
+  end
+end
+```
+
+The `search` method returns an `ActiveRecord::Relation`, making it easy to chain other scopes or conditions when needed.
+
+### Filter
+
+Filter is the class method that creates a new filter (really?!). Here's a simple example:
+
+```ruby
+class FooSearch < SimpleFilter::Base
+  filter :active
+  
+end
+
+# Usage
+FooSearch.new(active: true).scoping(Foo.all).search
+
+# Which is the same as
+Foo.all.active
+```
+
+You can apply whatever scope needed:
+
+```ruby
+FooSearch.new(active: true).scoping(current_user.posts).search
+# => current_user.posts.active
+```
+
+You can also create a filter that calls the scope method with the parameter value using the option `value_param: true`
+
+```ruby
+class FooSearch < SimpleFilter::Base
+  filter :active
+  filter :by_name, value_param: true
+end
+
+FooSearch.new(by_name: 'Matias').scoping(Foo.all).search
+# => Foo.all.by_name('Matias')
+
+FooSearch.new(by_name: 'Matias', active: true).scoping(Foo.all).search
+# => Foo.all.active.by_name('Matias')
+```
+
+Of course you have to define those scopes in your ActiveRecord model:
+
+```ruby
+class Foo < ActiceRecord::Base
+  scope :active, -> { where active: true }
+  scope :by_name, -> (name) { where 'name like ?', "%#{name}%" }
+end
+```
+
+### Custom filters
+
+Lastly, you can create fully customized filters. Let's say you want to apply a specific filter only when some condition is true
+
+```ruby
+class FooSearch < SimpleFilter::Base
+  filter :active
+  filter :name, value_param: true
+  filter :within_period
+  
+  def within_period
+    return unless date_range?
+    
+    scope.where('start_at >= ? and end_at <= ?', params[:start_at], params[:end_at])
+  end
+    
+  private
+  
+  def date_range?
+    params[:start_at].present? && params[:end_at].present?
+  end
+end
+
+FooSearch.new(start_at: '2015-05-08', end_at: '2015-05-31').scoping(Foo.all).search
+```
+
+Note that in the example above I'm using `params` and `scope` attributes. You can use it the create custom conditions and validation for your filters. It's important that your custom filters always return a `ActiveRecord::Relation` object, since it will chain it with the other filters.
+
+It's also possible to call `super` when you define your custom filters, this happens because of the way filters are defined in the `SimpleFilter::Base` class.
+
+
+```ruby
+class FooSearch < SimpleFilter::Base
+  filter :active
+  
+  def active
+    super.where 'some other condition'
+  end
+end
+```
+
+## Todo
+
+- Ordering
+- Pagination
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/matiasleidemer/simple_filter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+task default: :spec

data/bin/console

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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_filter.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+require 'simple_filter/version'
+
+module SimpleFilter
+  autoload :ModuleHelper, 'simple_filter/module_helper'
+  autoload :Filter, 'simple_filter/filter'
+  autoload :Base, 'simple_filter/base'
+end

data/lib/simple_filter/base.rb

@@ -0,0 +1,32 @@
+module SimpleFilter
+  class Base
+    extend Filter
+
+    attr_reader :params, :scope
+
+    def initialize(params = {}, scope = nil)
+      @params = params
+      @scope = scope
+    end
+
+    def scoping(scope)
+      @scope = scope
+
+      self
+    end
+
+    def search
+      conditions.scope
+    end
+
+    private
+
+    def conditions
+      self.class.filters.each do |filter|
+        @scope.merge! send(filter) || @scope.where(nil)
+      end
+
+      self
+    end
+  end
+end

data/lib/simple_filter/filter.rb

@@ -0,0 +1,30 @@
+module SimpleFilter
+  module Filter
+    attr_accessor :filters
+
+    def filter(name, options = {})
+      method_module = ModuleHelper.module_for 'Filter', name, self
+      value_param = options.fetch :value_param, false
+
+      method_module.module_eval <<-CODE, __FILE__, __LINE__ + 1
+        def #{name}
+          return if !params[:#{name}] || params[:#{name}].to_s.blank?
+
+          args = [:#{name}]
+          args << params[:#{name}] if #{value_param}
+
+          scope.send *args
+        end
+      CODE
+
+      add_filter name
+    end
+
+    private
+
+    def add_filter(name)
+      @filters ||= []
+      @filters << name
+    end
+  end
+end

data/lib/simple_filter/module_helper.rb

@@ -0,0 +1,29 @@
+module SimpleFilter
+  module ModuleHelper
+    module_function def module_for(prefix, name, klass)
+      mod_name = ModuleName.new(prefix, name)
+
+      begin
+        mod = klass.send(:const_get, mod_name)
+      rescue NameError
+        mod = Module.new
+        klass.send(:const_set, mod_name, mod)
+        klass.send(:include, mod)
+      end
+
+      mod
+    end
+
+    class ModuleName
+      def initialize(prefix, name)
+        @prefix = prefix
+        @name = name
+      end
+
+      def to_s
+        @prefix + @name.to_s.split('_').map(&:capitalize).join
+      end
+      alias to_str to_s
+    end
+  end
+end

data/lib/simple_filter/version.rb

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

data/simple_filter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_filter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple-filter"
+  spec.version       = SimpleFilter::VERSION
+  spec.authors       = ["Matias Leidemer"]
+  spec.email         = ["matiasleidemer@gmail.com"]
+
+  spec.summary       = %q{A simple DSL to create filter classes for ActiveRecord scopes}
+  spec.description   = %q{A simple DSL to create filter classes for ActiveRecord scopes}
+  spec.homepage      = "https://github.com/matiasleidemer/simple_filter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 4.0"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: simple-filter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matias Leidemer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-06 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple DSL to create filter classes for ActiveRecord scopes
+email:
+- matiasleidemer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_filter.rb
+- lib/simple_filter/base.rb
+- lib/simple_filter/filter.rb
+- lib/simple_filter/module_helper.rb
+- lib/simple_filter/version.rb
+- simple_filter.gemspec
+homepage: https://github.com/matiasleidemer/simple_filter
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A simple DSL to create filter classes for ActiveRecord scopes
+test_files: []