filter-base 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82731e35d812e891b06109fe4bf519920a7b22a9
+  data.tar.gz: 733f414bb09ae0703948a74182aefbc957a9e2b5
+SHA512:
+  metadata.gz: acc89414309f30172c5e2333524792ecba5600f2fcd14e0e5894b548ceb1b3f0f2e64a202a67baa18b2a0be57115fb583f95d4c2eb5dec32957686746cb508b1
+  data.tar.gz: fcd584529b45f4abf59c7acab53054edb99404b3b06ba59c7326ab5222ae1cb0ed8a8d2a46eceb1323a404c22cc1caa7b3fc5e828e2d0f7ffa4bbce8a06bf41d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+filter-base-*

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Sourcery
+
+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,39 @@
+# Filter
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/filter`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'filter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install filter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[my-github-username]/active_record-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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'dotenv'
+Dotenv.load
+require "sequel"
+require "filter"
+require "./spec/models"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,12 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+if [ "$(which psql)" = "" ]; then
+  echo "Could not find psql command. Please install psql."
+  exit 1
+fi
+
+setup.rb

data/bin/setup.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'dotenv'
+Dotenv.load
+require "sequel"
+require "filter"
+require "./spec/models"
+
+def drop?
+  ARGV.include?('--drop')
+end
+
+def execute_sql(db, sql)
+  db[sql]
+end
+
+def db_exists?(db, dbname)
+  execute_sql(db, "SELECT 'exists' FROM pg_database WHERE datname = '#{dbname}'").to_a.flatten.any?
+end
+
+[ ENV['DATABASE_URL'], ENV['TEST_DATABASE_URL'] ].each do |url|
+  uri = URI(url)
+  url_without_path = url.gsub(/\/[^\/]+$/, '')
+  name = uri.path[1..-1]
+
+  db = Sequel.connect(url_without_path)
+
+  db["DROP DATABASE \"#{name}\""].to_a if db_exists?(db, name) && drop?
+  db["CREATE DATABASE \"#{name}\""].to_a unless db_exists?(db, name)
+
+  `sequel -m spec/migrate #{url}`
+end

data/filter-base.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# coding: utf-8
+require 'filter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "filter-base"
+  spec.version       = Filter::VERSION
+  spec.authors       = ["Ben Bergstein, Jeff Rosen and Nick Chaffee"]
+  spec.email         = ["pair+ben+jeff+nick@getsourcery.com"]
+
+  spec.summary       = %q{Easy-to-test filtering for Rails' ActiveRecord}
+  spec.description   = %q{Extensions and controller/view helpers for filtering glory}
+  spec.homepage      = "https://github.com/sourcery/filter"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  end
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "sequel"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "rails", "~> 4.2.6"
+  spec.add_dependency "activerecord", "~> 4.2.7.1"
+end

data/lib/filter.rb

@@ -0,0 +1,7 @@
+require "filter/version"
+require "filter/base"
+require "filter/sanitize"
+require "filter/apply_filter"
+
+module Filter
+end

data/lib/filter/active_record_extensions/base.rb

@@ -0,0 +1,15 @@
+module Filter
+  module ActiveRecordExtensions
+    module Base
+      module ClassMethods
+        def filter(**attributes)
+          Filter::Base.new(relation: self, attributes: attributes)
+        end
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  extend Filter::ActiveRecordExtensions::Base::ClassMethods
+end

data/lib/filter/apply_filter.rb

@@ -0,0 +1,49 @@
+module Filter
+  class ApplyFilter
+    class NoFilterError < NoMethodError; end
+    attr_reader :filter_name, :filter_value, :relation, :model_class
+
+    def initialize(filter_name, filter_value, relation)
+      @filter_name = filter_name.to_sym
+      @filter_value = filter_value
+      @relation = relation
+      @model_class = determine_model_class
+    end
+
+    def perform
+      if filter_missing?
+        raise NoFilterError, "#{model_class.model_name} neither responds to nor has a column named `#{filter_name}`."
+      elsif column_exists?
+        relation.where(filter_name => filter_value)
+      elsif filter_accepts_arguments?
+        relation.send(filter_name, filter_value)
+      elsif apply_filter?
+        relation.send(filter_name)
+      else
+        relation
+      end
+    end
+
+    protected
+
+    def filter_missing?
+      !model_class.respond_to?(filter_name) && !column_exists?
+    end
+
+    def column_exists?
+      model_class.column_names.include?(filter_name.to_s)
+    end
+
+    def filter_accepts_arguments?
+      model_class.method(filter_name).arity != 0
+    end
+
+    def apply_filter?
+      ActiveRecord::Type::Boolean.new.type_cast_from_user(filter_value)
+    end
+
+    def determine_model_class
+      relation.try(:model) || relation
+    end
+  end
+end

data/lib/filter/base.rb

@@ -0,0 +1,81 @@
+require 'active_model'
+
+module Filter
+  class Base < SimpleDelegator
+    attr_reader :original_relation, :relation, :attributes
+    include ActiveModel::Model
+
+    DEFAULTS = {}
+
+    delegate :count, to: :relation
+
+    def initialize(attributes: {}, relation: nil)
+      @original_relation = relation || default_relation
+      setup_ostruct(attributes)
+      perform_filtering
+    end
+
+    def fork(attributes: {}, skip: [])
+      skip = Array.wrap(skip)
+      attributes = to_h.merge(attributes)
+      attributes.delete_if { |k, v| skip.include?(k) }
+      self.class.new(attributes: attributes, relation: original_relation)
+    end
+
+    def next(current_record)
+      advance(current_record, 1)
+    end
+
+    def previous(current_record)
+      advance(current_record, -1)
+    end
+
+    def advance(record, advancement)
+      advanced_id = ids[(index(record) + advancement) % ids.count]
+      relation.find(advanced_id)
+    end
+
+    def index(record)
+      ids.index(record.id)
+    end
+
+    def ids
+      @ids ||= relation.pluck(:id).uniq
+    end
+
+    def to_url(path = nil)
+      path ||= ''
+      "#{path}?"+to_query
+    end
+
+    def to_query
+      { filter_base: to_h }.to_query
+    end
+
+    def inspect
+      super.gsub('OpenStruct', "Filter (#{original_relation.to_s})")
+    end
+
+    protected
+
+    def setup_ostruct(attributes)
+      defaults = self.class::DEFAULTS
+      sanitized_attributes = ::Filter::Sanitize.new.sanitize(attributes)
+      attributes_with_defaults = defaults.merge(sanitized_attributes)
+      ostruct = OpenStruct.new(attributes_with_defaults)
+      __setobj__(ostruct)
+    end
+
+    def perform_filtering
+      attributes = to_h.delete_if { |k, v| v.nil? || v == '' }
+
+      @relation = attributes.inject(original_relation) do |relation, (filter_name, filter_value)|
+        ::Filter::ApplyFilter.new(filter_name, filter_value, relation).perform
+      end
+    end
+
+    def default_relation
+      raise NotImplementedError
+    end
+  end
+end

data/lib/filter/railtie.rb

@@ -0,0 +1,4 @@
+module Filter
+  class Railtie < Rails::Railtie
+  end
+end

data/lib/filter/sanitize.rb

@@ -0,0 +1,9 @@
+module Filter
+  class Sanitize
+    include ActiveModel::ForbiddenAttributesProtection
+
+    def sanitize(attributes)
+      sanitize_for_mass_assignment(attributes)
+    end
+  end
+end

data/lib/filter/version.rb

@@ -0,0 +1,3 @@
+module Filter
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: filter-base
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ben Bergstein, Jeff Rosen and Nick Chaffee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-12 00:00:00.000000000 Z
+dependencies:
+- !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: dotenv
+  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: pg
+  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: sequel
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7.1
+description: Extensions and controller/view helpers for filtering glory
+email:
+- pair+ben+jeff+nick@getsourcery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/setup.rb
+- filter-base.gemspec
+- lib/filter.rb
+- lib/filter/active_record_extensions/base.rb
+- lib/filter/apply_filter.rb
+- lib/filter/base.rb
+- lib/filter/railtie.rb
+- lib/filter/sanitize.rb
+- lib/filter/version.rb
+homepage: https://github.com/sourcery/filter
+licenses: []
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Easy-to-test filtering for Rails' ActiveRecord
+test_files: []