filtron 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4da48a4bd725abada21ee792367ac234463e213b
+  data.tar.gz: 4fbd214421276dd779381371def7e4f926cd90eb
+SHA512:
+  metadata.gz: c2108831492429deb0c1bd0dd64ff292a6b89b0ec5abdcf8878949ad57b8c373a0011deca52fac86b0110860aa166c3b1d685741b34b93265e70bbc9be5678c3
+  data.tar.gz: 49173cd2de3913c79a5315794b45fc444affb886aad8e6297036e59e257de0e5b17c0a8d293feac1b938ba73c10d8ed06e6988cbbb02eb1b2c1c9c55b12d14e9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lee Jarvis
+
+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,84 @@
+# Filtron
+
+Filtron was built to work with [Ransack](https://github.com/ernie/ransack).
+Ransack uses search predicates to simplify searching and querying your model
+data. Filtron aims to alias these predicates so your URLs are a little
+less ugly when filtering your data via GET requests. Take this URL for example:
+
+    http://example.com/users?user[first_name_eq]=Lee&user[email_cont]=@gmail
+
+    # Controller:
+    def index
+      @users = User.search(params[:user]).result
+    end
+
+Wouldn't this be nicer?
+
+    http://example.com/users?name=Lee&email=@gmail
+
+    # Controller:
+    def index
+      @users = User.filter(params)
+    end
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'filtron'
+
+## Usage
+
+You can easily add Filtron to your existing models
+
+```ruby
+class User < ActiveRecord::Base
+  filter_with :fname, :first_name_eq
+  filter_with :lname, :last_name_eq
+  filter_with :country, :address_country_name_eq do |code|
+    Country.find_by_code(code).name
+  end
+
+  queries :first_name, :email
+end
+```
+
+Now in your controller:
+
+```ruby
+def index
+  @users = User.filter(params)
+end
+```
+
+`params` might look something like this:
+
+```ruby
+{
+  fname: "Lee",
+  country: "gb",
+  q: "@gmail.com",
+  something: "else"
+}
+```
+
+This will translate into the following Ransack predicates:
+
+```ruby
+{
+  first_name_eq: "Lee",
+  address_country_name_eq: "Great Britain",
+  first_name_or_email_cont: "@gmail.com"
+}
+```
+
+Filtron will then use these predicates to search for and return a result.
+
+By default, `queries` will use `params[:q]` for a general query. You can
+change this in the call to `queries`:
+
+```
+queries :first_name, :last_name, :email, with: :search
+```
+
+Now, `/users?search=foo` will use these query predicates.

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require "bundler/gem_tasks"
+rescue LoadError
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = Dir['test/*_test.rb']
+end
+
+task default: :test

data/filtron.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |spec|
+  spec.name          = "filtron"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Lee Jarvis"]
+  spec.email         = ["ljjarvis@gmail.com"]
+  spec.description   = "Pretty aliases for filtering your data"
+  spec.summary       = "Simple filtering"
+  spec.homepage      = "https://github.com/leejarvis/filtron"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(/^test/)
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/filtron.rb

@@ -0,0 +1,70 @@
+module Filtron
+  VERSION = "0.0.1"
+
+  def filtron_filters
+    @filtron_filters ||= {}
+  end
+
+  def filtron_query_predicate
+    @filtron_query_predicate
+  end
+
+  def filtron_query_param
+    @filtron_query_param ||= :q
+  end
+
+  def filter_with(param, predicate, options = {}, &block)
+    filtron_filters[param] = [predicate, options, block]
+  end
+
+  def queries(*columns)
+    options = columns[-1].is_a?(Hash) ? columns.pop : {}
+    suffix  = options.fetch(:suffix, "_cont")
+    suffix  = "_#{suffix}" unless suffix.start_with?("_")
+
+    @filtron_query_param     = options.fetch(:with, @filtron_query_param)
+    @filtron_query_predicate = columns.join("_or_") + suffix
+  end
+
+  def filter(filters)
+    conditions = filters_to_conditions(filters)
+
+    if filters[:ransack_options]
+      search(conditions).result(filters[:ransack_options])
+    else
+      search(conditions)
+    end
+  end
+
+  protected
+
+  def filters_to_conditions(params)
+    predicates = filtron_filters
+    filters    = filters_from_predicates(params, predicates)
+    add_query_predicate(filters, params)
+    Hash[filters]
+  end
+
+  def filters_from_predicates(params, predicates)
+    slice(params, *predicates.keys).map do |key, value|
+      filter = predicates[key]
+      value  = filter[-1].call(value) if filter[-1].respond_to?(:call)
+      [filter[0], value]
+    end
+  end
+
+  def slice(hash, *keys)
+    keys.each_with_object({}) { |k, h| h[k] = hash[k] if hash.key?(k) }
+  end
+
+  def add_query_predicate(filters, params)
+    key = filtron_query_param
+    if key && params[key]
+      filters << [filtron_query_predicate, params[key]]
+    end
+  end
+end
+
+if defined? ActiveRecord::Base
+  ActiveRecord::Base.extend Filtron
+end

data/test/filtron_test.rb

@@ -0,0 +1,43 @@
+require "test_helper"
+
+class FiltronTest < Minitest::Test
+
+  class Search
+    attr_reader :conditions
+
+    def initialize(conditions)
+      @conditions = conditions
+    end
+
+    def result(options = {})
+      self
+    end
+  end
+
+  class User
+    extend Filtron
+
+    filter_with :name, :name_eq
+    filter_with :country, :country_name_eq do |code|
+      {"gb" => "Great Britain"}[code]
+    end
+    queries :name, :email, with: :s
+
+    def self.search(conditions)
+      Search.new(conditions)
+    end
+  end
+
+  def test_adding_filters
+    assert_equal [:name_eq, {}, nil], User.filtron_filters[:name]
+  end
+
+  def test_filters_with_blocks
+    assert_equal "Great Britain", User.filter(country: "gb").conditions[:country_name_eq]
+  end
+
+  def test_adding_queries
+    assert_equal({"name_or_email_cont" => "foo"}, User.filter(s: "foo").conditions)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "filtron"
+
+require "minitest/autorun"

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: filtron
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lee Jarvis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Pretty aliases for filtering your data
+email:
+- ljjarvis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- filtron.gemspec
+- lib/filtron.rb
+- test/filtron_test.rb
+- test/test_helper.rb
+homepage: https://github.com/leejarvis/filtron
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Simple filtering
+test_files:
+- test/filtron_test.rb
+- test/test_helper.rb