filterable-by 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e533d4d75b6d63e5fb7618d137ea0d3c74b33556
+  data.tar.gz: c2b26115a0d7c1a035230914d54aa47fa9d4de16
+SHA512:
+  metadata.gz: 5e3720c7264c8ca31db45f5393778f3f3795c655e5f440bc5e49cda15bdf7c50988e1bccf48ed7871b3fc80d286b4181bf8f3c0228a854acb987e76ef32b4655
+  data.tar.gz: 78c319fb3bd03c79094f72268dfaa589930985809e5ff2bcd524420980e01f30ebd2fb9e10e2174e2dee93fec50dcf2c499e0d27bde165256ff044a0b451e0c4

data/.gitignore

@@ -0,0 +1,3 @@
+spec/tmp
+pkg
+*.gem

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: .rubocop_todo.yml
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120

data/.rubocop_todo.yml

@@ -0,0 +1,40 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-10-29 12:58:41 +0000 using RuboCop version 0.32.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
+Style/TrailingComma:
+  Enabled: false
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: WordRegex.
+Style/WordArray:
+  MinSize: 2

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.3
+  - 2.1.2
+  - 2.2.3
+gemfile:
+  - Gemfile

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    filterable-by (0.4.0)
+      activerecord
+      activesupport
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+    activerecord (4.2.4)
+      activemodel (= 4.2.4)
+      activesupport (= 4.2.4)
+      arel (~> 6.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.2)
+    parser (2.2.2.5)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.32.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    sqlite3 (1.3.10)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  filterable-by!
+  rake
+  rspec
+  rubocop
+  sqlite3
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,62 @@
+# Filterable By
+
+ActiveRecord plugin to parse e.g. a `filter` query parameter apply scopes. Useful for [JSON-API][jsonapi] compatibility.
+
+[jsonapi]: http://jsonapi.org/format/#fetching-filtering
+
+## Installation
+
+Add `gem 'filterable-by'` to your Gemfile.
+
+## Usage
+
+```ruby
+class Comment < ActiveRecord::Base
+  belongs_to :post
+
+  filterable_by :post_id, :user_id
+  filterable_by :post_author_id do |scope, value|
+    scope.joins(:posts).where(:"posts.author_id" => value)
+  end
+end
+
+Comment.filter_by(params[:filter])  # => ActiveRecord::Relation
+```
+
+Simple use cases:
+
+```ruby
+Comment.filter_by({ "post_id" => "1" })
+# => WHERE post_id = 1
+
+Comment.filter_by({ "user_id" => "2", "ignored" => "3" })
+# => WHERE user_id = 2
+
+Comment.filter_by({ "post_author_id" => "5" })
+# => JOINS posts ON posts.id = comments.post_id WHERE posts.author_id = 5
+```
+
+## LICENCE
+
+```
+Copyright (c) 2015 Black Square Media
+
+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/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:spec, :rubocop]

data/filterable-by.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name        = 'filterable-by'
+  s.version     = '0.4.0'
+  s.authors     = ['Dimitrij Denissenko']
+  s.email       = ['dimitrij@blacksquaremedia.com']
+  s.summary     = 'Generate white-listed filter scopes from URL parameter values'
+  s.description = 'ActiveRecord plugin'
+  s.homepage    = 'https://github.com/bsm/filterable-by'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  s.test_files    = `git ls-files -z -- spec/*`.split("\x0")
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'activesupport'
+  s.add_dependency 'activerecord'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'sqlite3'
+end

data/lib/filterable-by.rb

@@ -0,0 +1 @@
+require 'filterable_by'

data/lib/filterable_by.rb

@@ -0,0 +1,45 @@
+require 'active_record'
+require 'active_support/concern'
+require 'set'
+
+module ActiveRecord
+  module FilterableByHelper
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_filterable_by_scope_options, instance_accessor: false
+      self._filterable_by_scope_options = {}
+    end
+
+    module ClassMethods
+
+      def filterable_by(*names, &block)
+        names.each do |name|
+          _filterable_by_scope_options[name.to_s] = block || ->(scope, v) { scope.where(name.to_sym => v) }
+        end
+      end
+
+      # @param [Hash] hash the filter params
+      # @return [ActiveRecord::Relation] the scoped relation
+      def filter_by(hash)
+        scope = all
+        return scope unless hash.is_a?(Hash)
+
+        _filterable_by_scope_options.each do |name, block|
+          next unless hash.key?(name)
+
+          value = hash[name]
+          next unless (value.is_a?(String) && value.present?) || value.is_a?(Numeric)
+
+          scope = block.call(scope, value)
+        end
+        scope
+      end
+
+    end
+  end
+
+  class Base
+    include FilterableByHelper
+  end
+end

data/spec/filterable_by_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe ActiveRecord::FilterableByHelper do
+
+  let(:alice) { AUTHORS[:alice] }
+  let(:bob)   { AUTHORS[:bob] }
+
+  let(:apost) { POSTS[:alices] }
+  let(:bpost) { POSTS[:bobs] }
+
+  it 'should have config' do
+    expect(Comment._filterable_by_scope_options.size).to eq(3)
+  end
+
+  it 'should ignore bad inputs' do
+    expect(Comment.filter_by(nil).count).to eq(4)
+    expect(Comment.filter_by({}).count).to eq(4)
+
+    expect(Comment.filter_by('author_id' => '').count).to eq(4)
+    expect(Comment.filter_by('author_id' => []).count).to eq(4)
+  end
+
+  it 'should generate simple scopes' do
+    expect(Comment.filter_by('author_id' => alice.id).pluck(:title)).to match_array(['AA', 'AB'])
+    expect(Comment.filter_by('author_id' => bob.id).pluck(:title)).to match_array(['BA', 'BB'])
+
+    expect(Comment.filter_by('post_id' => apost.id).pluck(:title)).to match_array(['AA', 'BA'])
+    expect(Comment.filter_by('post_id' => bpost.id).pluck(:title)).to match_array(['AB', 'BB'])
+
+    expect(Comment.filter_by('post_author_id' => alice.id).pluck(:title)).to match_array(['AA', 'BA'])
+    expect(Comment.filter_by('post_author_id' => bob.id).pluck(:title)).to match_array(['AB', 'BB'])
+  end
+
+  it 'should generate combined scopes' do
+    expect(Comment.filter_by('author_id' => alice.id, 'post_id' => apost.id).pluck(:title)).to match_array(['AA'])
+    expect(Comment.filter_by('author_id' => alice.id, 'post_id' => bpost.id).pluck(:title)).to match_array(['AB'])
+    expect(Comment.filter_by('author_id' => bob.id, 'post_id' => apost.id).pluck(:title)).to match_array(['BA'])
+    expect(Comment.filter_by('author_id' => bob.id, 'post_id' => bpost.id).pluck(:title)).to match_array(['BB'])
+  end
+
+  it 'should combine with other scopes' do
+    scope = Comment.where(author_id: alice.id).filter_by('post_id' => apost.id)
+    expect(scope.pluck(:title)).to match_array(['AA'])
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+ENV['RACK_ENV'] ||= 'test'
+require 'filterable-by'
+require 'rspec'
+
+ActiveRecord::Base.configurations['test'] = { 'adapter' => 'sqlite3', 'database' => ':memory:' }
+ActiveRecord::Base.establish_connection :test
+
+ActiveRecord::Base.connection.instance_eval do
+  create_table :authors do |_|
+  end
+  create_table :posts do |t|
+    t.integer :author_id, null: false
+  end
+  create_table :comments do |t|
+    t.string  :title, null: false
+    t.integer :post_id, null: false
+    t.integer :author_id, null: false
+  end
+end
+
+class Author < ActiveRecord::Base
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :author
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :author
+  belongs_to :post
+
+  filterable_by :post_id, :author_id
+  filterable_by :post_author_id do |scope, value|
+    scope.joins(:post).where(Post.arel_table[:author_id].eq(value))
+  end
+end
+
+AUTHORS = {
+  alice: Author.create!,
+  bob:   Author.create!,
+}
+
+POSTS = {
+  alices: Post.create!(author_id: AUTHORS[:alice].id),
+  bobs:   Post.create!(author_id: AUTHORS[:bob].id),
+}
+
+COMMENTS = {
+  alice_on_alice: Comment.create!(title: 'AA', post_id: POSTS[:alices].id, author_id: AUTHORS[:alice].id),
+  bob_on_alice:   Comment.create!(title: 'BA', post_id: POSTS[:alices].id, author_id: AUTHORS[:bob].id),
+  alice_on_bob:   Comment.create!(title: 'AB', post_id: POSTS[:bobs].id, author_id: AUTHORS[:alice].id),
+  bob_on_bob:     Comment.create!(title: 'BB', post_id: POSTS[:bobs].id, author_id: AUTHORS[:bob].id),
+}

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: filterable-by
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+- !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: rubocop
+  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: ActiveRecord plugin
+email:
+- dimitrij@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- filterable-by.gemspec
+- lib/filterable-by.rb
+- lib/filterable_by.rb
+- spec/filterable_by_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bsm/filterable-by
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Generate white-listed filter scopes from URL parameter values
+test_files:
+- spec/filterable_by_spec.rb
+- spec/spec_helper.rb