filter-base 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 82731e35d812e891b06109fe4bf519920a7b22a9
4
+ data.tar.gz: 733f414bb09ae0703948a74182aefbc957a9e2b5
5
+ SHA512:
6
+ metadata.gz: acc89414309f30172c5e2333524792ecba5600f2fcd14e0e5894b548ceb1b3f0f2e64a202a67baa18b2a0be57115fb583f95d4c2eb5dec32957686746cb508b1
7
+ data.tar.gz: fcd584529b45f4abf59c7acab53054edb99404b3b06ba59c7326ab5222ae1cb0ed8a8d2a46eceb1323a404c22cc1caa7b3fc5e828e2d0f7ffa4bbce8a06bf41d
data/.gitignore ADDED
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ .env
11
+ filter-base-*
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 2.3.1
data/.travis.yml ADDED
@@ -0,0 +1,3 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.1.2
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in active_record-filter.gemspec
4
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2016 Sourcery
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,39 @@
1
+ # Filter
2
+
3
+ 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.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'filter'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install filter
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ 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.
30
+
31
+ 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).
32
+
33
+ ## Contributing
34
+
35
+ 1. Fork it ( https://github.com/[my-github-username]/active_record-filter/fork )
36
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
37
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
38
+ 4. Push to the branch (`git push origin my-new-feature`)
39
+ 5. Create a new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
data/bin/console ADDED
@@ -0,0 +1,11 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require 'dotenv'
5
+ Dotenv.load
6
+ require "sequel"
7
+ require "filter"
8
+ require "./spec/models"
9
+
10
+ require "irb"
11
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,12 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ if [ "$(which psql)" = "" ]; then
8
+ echo "Could not find psql command. Please install psql."
9
+ exit 1
10
+ fi
11
+
12
+ setup.rb
data/bin/setup.rb ADDED
@@ -0,0 +1,33 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require 'dotenv'
5
+ Dotenv.load
6
+ require "sequel"
7
+ require "filter"
8
+ require "./spec/models"
9
+
10
+ def drop?
11
+ ARGV.include?('--drop')
12
+ end
13
+
14
+ def execute_sql(db, sql)
15
+ db[sql]
16
+ end
17
+
18
+ def db_exists?(db, dbname)
19
+ execute_sql(db, "SELECT 'exists' FROM pg_database WHERE datname = '#{dbname}'").to_a.flatten.any?
20
+ end
21
+
22
+ [ ENV['DATABASE_URL'], ENV['TEST_DATABASE_URL'] ].each do |url|
23
+ uri = URI(url)
24
+ url_without_path = url.gsub(/\/[^\/]+$/, '')
25
+ name = uri.path[1..-1]
26
+
27
+ db = Sequel.connect(url_without_path)
28
+
29
+ db["DROP DATABASE \"#{name}\""].to_a if db_exists?(db, name) && drop?
30
+ db["CREATE DATABASE \"#{name}\""].to_a unless db_exists?(db, name)
31
+
32
+ `sequel -m spec/migrate #{url}`
33
+ end
@@ -0,0 +1,34 @@
1
+ lib = File.expand_path('../lib', __FILE__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ # coding: utf-8
4
+ require 'filter/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "filter-base"
8
+ spec.version = Filter::VERSION
9
+ spec.authors = ["Ben Bergstein, Jeff Rosen and Nick Chaffee"]
10
+ spec.email = ["pair+ben+jeff+nick@getsourcery.com"]
11
+
12
+ spec.summary = %q{Easy-to-test filtering for Rails' ActiveRecord}
13
+ spec.description = %q{Extensions and controller/view helpers for filtering glory}
14
+ spec.homepage = "https://github.com/sourcery/filter"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ spec.bindir = "bin"
18
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
19
+ spec.require_paths = ["lib"]
20
+
21
+ if spec.respond_to?(:metadata)
22
+ # 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."
23
+ end
24
+
25
+ spec.add_development_dependency "bundler", "~> 1.9"
26
+ spec.add_development_dependency "rake", "~> 10.0"
27
+ spec.add_development_dependency "dotenv"
28
+ spec.add_development_dependency "pg"
29
+ spec.add_development_dependency "sequel"
30
+ spec.add_development_dependency "rspec"
31
+
32
+ spec.add_dependency "rails", "~> 4.2.6"
33
+ spec.add_dependency "activerecord", "~> 4.2.7.1"
34
+ end
data/lib/filter.rb ADDED
@@ -0,0 +1,7 @@
1
+ require "filter/version"
2
+ require "filter/base"
3
+ require "filter/sanitize"
4
+ require "filter/apply_filter"
5
+
6
+ module Filter
7
+ end
@@ -0,0 +1,15 @@
1
+ module Filter
2
+ module ActiveRecordExtensions
3
+ module Base
4
+ module ClassMethods
5
+ def filter(**attributes)
6
+ Filter::Base.new(relation: self, attributes: attributes)
7
+ end
8
+ end
9
+ end
10
+ end
11
+ end
12
+
13
+ class ActiveRecord::Base
14
+ extend Filter::ActiveRecordExtensions::Base::ClassMethods
15
+ end
@@ -0,0 +1,49 @@
1
+ module Filter
2
+ class ApplyFilter
3
+ class NoFilterError < NoMethodError; end
4
+ attr_reader :filter_name, :filter_value, :relation, :model_class
5
+
6
+ def initialize(filter_name, filter_value, relation)
7
+ @filter_name = filter_name.to_sym
8
+ @filter_value = filter_value
9
+ @relation = relation
10
+ @model_class = determine_model_class
11
+ end
12
+
13
+ def perform
14
+ if filter_missing?
15
+ raise NoFilterError, "#{model_class.model_name} neither responds to nor has a column named `#{filter_name}`."
16
+ elsif column_exists?
17
+ relation.where(filter_name => filter_value)
18
+ elsif filter_accepts_arguments?
19
+ relation.send(filter_name, filter_value)
20
+ elsif apply_filter?
21
+ relation.send(filter_name)
22
+ else
23
+ relation
24
+ end
25
+ end
26
+
27
+ protected
28
+
29
+ def filter_missing?
30
+ !model_class.respond_to?(filter_name) && !column_exists?
31
+ end
32
+
33
+ def column_exists?
34
+ model_class.column_names.include?(filter_name.to_s)
35
+ end
36
+
37
+ def filter_accepts_arguments?
38
+ model_class.method(filter_name).arity != 0
39
+ end
40
+
41
+ def apply_filter?
42
+ ActiveRecord::Type::Boolean.new.type_cast_from_user(filter_value)
43
+ end
44
+
45
+ def determine_model_class
46
+ relation.try(:model) || relation
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,81 @@
1
+ require 'active_model'
2
+
3
+ module Filter
4
+ class Base < SimpleDelegator
5
+ attr_reader :original_relation, :relation, :attributes
6
+ include ActiveModel::Model
7
+
8
+ DEFAULTS = {}
9
+
10
+ delegate :count, to: :relation
11
+
12
+ def initialize(attributes: {}, relation: nil)
13
+ @original_relation = relation || default_relation
14
+ setup_ostruct(attributes)
15
+ perform_filtering
16
+ end
17
+
18
+ def fork(attributes: {}, skip: [])
19
+ skip = Array.wrap(skip)
20
+ attributes = to_h.merge(attributes)
21
+ attributes.delete_if { |k, v| skip.include?(k) }
22
+ self.class.new(attributes: attributes, relation: original_relation)
23
+ end
24
+
25
+ def next(current_record)
26
+ advance(current_record, 1)
27
+ end
28
+
29
+ def previous(current_record)
30
+ advance(current_record, -1)
31
+ end
32
+
33
+ def advance(record, advancement)
34
+ advanced_id = ids[(index(record) + advancement) % ids.count]
35
+ relation.find(advanced_id)
36
+ end
37
+
38
+ def index(record)
39
+ ids.index(record.id)
40
+ end
41
+
42
+ def ids
43
+ @ids ||= relation.pluck(:id).uniq
44
+ end
45
+
46
+ def to_url(path = nil)
47
+ path ||= ''
48
+ "#{path}?"+to_query
49
+ end
50
+
51
+ def to_query
52
+ { filter_base: to_h }.to_query
53
+ end
54
+
55
+ def inspect
56
+ super.gsub('OpenStruct', "Filter (#{original_relation.to_s})")
57
+ end
58
+
59
+ protected
60
+
61
+ def setup_ostruct(attributes)
62
+ defaults = self.class::DEFAULTS
63
+ sanitized_attributes = ::Filter::Sanitize.new.sanitize(attributes)
64
+ attributes_with_defaults = defaults.merge(sanitized_attributes)
65
+ ostruct = OpenStruct.new(attributes_with_defaults)
66
+ __setobj__(ostruct)
67
+ end
68
+
69
+ def perform_filtering
70
+ attributes = to_h.delete_if { |k, v| v.nil? || v == '' }
71
+
72
+ @relation = attributes.inject(original_relation) do |relation, (filter_name, filter_value)|
73
+ ::Filter::ApplyFilter.new(filter_name, filter_value, relation).perform
74
+ end
75
+ end
76
+
77
+ def default_relation
78
+ raise NotImplementedError
79
+ end
80
+ end
81
+ end
@@ -0,0 +1,4 @@
1
+ module Filter
2
+ class Railtie < Rails::Railtie
3
+ end
4
+ end
@@ -0,0 +1,9 @@
1
+ module Filter
2
+ class Sanitize
3
+ include ActiveModel::ForbiddenAttributesProtection
4
+
5
+ def sanitize(attributes)
6
+ sanitize_for_mass_assignment(attributes)
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,3 @@
1
+ module Filter
2
+ VERSION = "0.2.0"
3
+ end
metadata ADDED
@@ -0,0 +1,173 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: filter-base
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.2.0
5
+ platform: ruby
6
+ authors:
7
+ - Ben Bergstein, Jeff Rosen and Nick Chaffee
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2016-09-12 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.9'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.9'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: dotenv
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: pg
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: sequel
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rails
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: 4.2.6
104
+ type: :runtime
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: 4.2.6
111
+ - !ruby/object:Gem::Dependency
112
+ name: activerecord
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: 4.2.7.1
118
+ type: :runtime
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: 4.2.7.1
125
+ description: Extensions and controller/view helpers for filtering glory
126
+ email:
127
+ - pair+ben+jeff+nick@getsourcery.com
128
+ executables: []
129
+ extensions: []
130
+ extra_rdoc_files: []
131
+ files:
132
+ - ".gitignore"
133
+ - ".ruby-version"
134
+ - ".travis.yml"
135
+ - Gemfile
136
+ - LICENSE
137
+ - README.md
138
+ - Rakefile
139
+ - bin/console
140
+ - bin/setup
141
+ - bin/setup.rb
142
+ - filter-base.gemspec
143
+ - lib/filter.rb
144
+ - lib/filter/active_record_extensions/base.rb
145
+ - lib/filter/apply_filter.rb
146
+ - lib/filter/base.rb
147
+ - lib/filter/railtie.rb
148
+ - lib/filter/sanitize.rb
149
+ - lib/filter/version.rb
150
+ homepage: https://github.com/sourcery/filter
151
+ licenses: []
152
+ metadata: {}
153
+ post_install_message:
154
+ rdoc_options: []
155
+ require_paths:
156
+ - lib
157
+ required_ruby_version: !ruby/object:Gem::Requirement
158
+ requirements:
159
+ - - ">="
160
+ - !ruby/object:Gem::Version
161
+ version: '0'
162
+ required_rubygems_version: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - ">="
165
+ - !ruby/object:Gem::Version
166
+ version: '0'
167
+ requirements: []
168
+ rubyforge_project:
169
+ rubygems_version: 2.6.4
170
+ signing_key:
171
+ specification_version: 4
172
+ summary: Easy-to-test filtering for Rails' ActiveRecord
173
+ test_files: []