merge_filter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59fa277069936dbd7372984695f1c982c381498c
+  data.tar.gz: c27f63c3fe1716a2220b4bb2c839bf935446d971
+SHA512:
+  metadata.gz: bd2ccbba99c502738fde7237929733af57bbd076dfdfd6d89891356e3a437a0a208286c1be10bb9a83898752037b2e022f5fa4288773b257a48fed63634a5809
+  data.tar.gz: 626dec8c043a8a12bd3b8077cd078e33f88713f872dd283524611ed2f71e9b78b00787da0a3aa30da7fca984a19cebe50b0c861c145f9419b8fe91c582cf926e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Thomas Cioppettini
+
+MIT License
+
+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,86 @@
+# MergeFilter
+
+MergeFilter is a minimal DSL for filtering ActiveRecord objects. Instead of writing complex branching logic in your controllers, encapsulate that logic into a PORO.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'merge_filter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install merge_filter
+
+## Usage
+Imagine we have a listings model with a price_cents field. 
+
+Instead of complex branching logic:
+``` ruby
+  class ListingsController < ApplicationController
+    def index 
+      if params[:min_price]
+        Listing.where("price_cents >= ?", params[:min_price])
+      elsif params[:max_price]
+        Listing.where("price_cents <= ?", params[:max_price])
+      else
+        Listing.all
+      end
+    end
+  end
+```
+
+
+Or using multiple scopes:
+``` ruby
+  class ListingsController < ApplicationController
+    def index 
+      Listing.all.max_price(params[:max_price).min_price(params[:min_price])
+    end
+  end
+```
+
+Encapsulate your logic in a PORO
+``` ruby 
+  class ListingFilter
+    include MergeFilter
+    
+    default_scope { Listing.all }
+    
+    filter_by(:price_cents)
+    
+    filter_by(:min_price) do |value, scope|
+      scope.where("price_cents >= ?", value)
+    end
+    
+    filter_by(:max_price) do |value|
+      Listing.where("price_cents <= ?", value)
+    end
+  end 
+  
+  class ListingsController < ApplicationController
+    def index
+      ListingFilter.new(min_price: params[:min_price], max_price: params[:max_price]).records
+    end
+  end
+```
+
+## Notes for including MergeFilter in your project:
+  1. Classes that include the MergeFilter module need to implement a single default_scope method that takes a block, and as many filter_by methods as you like. 
+  2. The filter_by method takes two arguments. The first is the column which you want to filter by, the second is an optional block which must return an ActiveRecord relation object. If you leave off the block MergeFilter defaults to a `where` query.
+  3. To filter records, intitialize your MergeFilter object with a hash. The keys of the hash must correspond to the columns in the filter_by methods. The values get passed into their respective filter_by method.
+  4. Call the records method when you want to return the corresponding records from your database.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/merge_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,2 @@
+require "bundler/gem_tasks"
+

data/lib/merge_filter.rb

@@ -0,0 +1,41 @@
+require "merge_filter/version"
+
+module MergeFilter
+  attr_reader :filter
+
+  def self.included base
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def default_scope &block
+      define_method :default_scope do
+        if block_given?
+          yield
+        else
+          fail NotImplementedError, "You need to supply a default_scope."
+        end
+      end
+    end
+
+    def filter_by column, &block
+      define_method column do |*args|
+        if block_given?
+          yield args, default_scope
+        else
+          default_scope.where(column => args)
+        end
+      end
+    end
+  end
+
+  def initialize filter = {}
+    @filter = filter
+  end
+
+  def records
+    filter.inject(default_scope) do |scope, (key, value)|
+      scope.merge(__send__(key, value))
+    end
+  end
+end

data/lib/merge_filter/version.rb

@@ -0,0 +1,3 @@
+module MergeFilter
+  VERSION = "0.0.1"
+end

data/merge_filter.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'merge_filter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "merge_filter"
+  spec.version       = MergeFilter::VERSION
+  spec.authors       = ["Thomas Cioppettini"]
+  spec.email         = ["thomas.cioppettini@gmail.com"]
+  spec.summary       = %q{DSL for filtering ActiveRecord models}
+  spec.description   = %q{Build quick search objects by merging ActiveRecord queries.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: merge_filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thomas Cioppettini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Build quick search objects by merging ActiveRecord queries.
+email:
+- thomas.cioppettini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/merge_filter.rb
+- lib/merge_filter/version.rb
+- merge_filter.gemspec
+homepage: ''
+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: DSL for filtering ActiveRecord models
+test_files: []