simple_column-scopes 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 1ed39193a453d22aaf1d331120110a36efc7c1da
4
+ data.tar.gz: 8f44765dcee98e34a7962e9ac3ab1aca0c29bffd
5
+ SHA512:
6
+ metadata.gz: d17c9cb99858eddb2061a9f41711804ea2dc519ca782784a5bc11772c726c6f6a26983e2447a76984aa338f2e7519315048160c3387992dece3f2872b230991f
7
+ data.tar.gz: 2bd845f7947f048213528ebebc6f2059f630d8ae23e8e768b1a28d02aefebb6431006e2a11c2640b4b63ea9def564ed90bec221eb498aaf797ec532b1176d85e
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.1
5
+ before_install: gem install bundler -v 1.15.0
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at peter.boling@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in simple_column-scopes.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Peter Boling
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
13
+ all 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
21
+ THE SOFTWARE.
@@ -0,0 +1,87 @@
1
+ # SimpleColumn::Scopes
2
+
3
+ Create dynamic modules which define dynamic methods for scopes based on a dynamic array of column names!
4
+
5
+ ## Why?
6
+
7
+ Why replace a simple `where` query with a method from a DSL like this?
8
+
9
+ * Tokenizing your logic makes it easy to find with grep or other search tools.
10
+ - Do a search for `.where(` in a large codebase, and may wish the specific thing you are looking for was tokenized.
11
+ * Creating small blocks of logic on which to build, of a uniform nature, can make applications
12
+ - more robust (this will raise a noisy error on a typo - if the column doesn't exist, or the scope prefix is incorrect)
13
+ - reduce typos (see above)
14
+ - reduce mental overhead (the same pattern every time, no variation; `for_<column_name>` always means the same thing)
15
+ * Profit
16
+
17
+ ## Installation
18
+
19
+ Add this line to your application's Gemfile:
20
+
21
+ ```ruby
22
+ gem 'simple_column-scopes'
23
+ ```
24
+
25
+ And then execute:
26
+
27
+ $ bundle
28
+
29
+ Or install it yourself as:
30
+
31
+ $ gem install simple_column-scopes
32
+
33
+ ## Usage
34
+
35
+ Given an ActiveRecord model with a column: `user_id`
36
+ Create a scope that queries it, by prefixing `for_` to the column name:
37
+
38
+ ```ruby
39
+ include SimpleColumn::Scopes.new(:for_user_id)
40
+ ```
41
+ is equivalent to:
42
+ ```ruby
43
+ def self.for_user_id(user_id)
44
+ where(user_id: user_id)
45
+ end
46
+ ```
47
+
48
+ Complete example\*:
49
+
50
+ ```ruby
51
+ # == Schema Information
52
+ #
53
+ # Table name: monkeys
54
+ #
55
+ # id :integer(4) not null, primary key
56
+ # user_id :integer(4)
57
+ # seller_id :integer(4)
58
+ class Monkey < ActiveRecord::Base
59
+
60
+ include SimpleColumn::Scopes.new(:for_user_id, :for_seller_id, :etc)
61
+ # => for_user_id, and for_seller_id scopes are added to the model,
62
+ # and they query on the user_id and seller_id columns, respectively
63
+ end
64
+
65
+ Monkey.for_user_id(1)
66
+ Monkey.for_seller_id(2)
67
+ ```
68
+
69
+ \* This software may not be suitable for buying and selling of Monkeys. This is simply a contrived example.
70
+
71
+ ## Development
72
+
73
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
74
+
75
+ 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
76
+
77
+ ## Contributing
78
+
79
+ Bug reports and pull requests are welcome on GitHub at https://github.com/tophatter/simple_column-scopes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
80
+
81
+ ## License
82
+
83
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
84
+
85
+ ## Code of Conduct
86
+
87
+ Everyone interacting in the SimpleColumn::Scopes project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tophatter/simple_column-scopes/blob/master/CODE_OF_CONDUCT.md).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "simple_column/scopes"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,65 @@
1
+ require 'simple_column/scopes'
2
+ require 'simple_column/scopes/version'
3
+
4
+ # Purpose:
5
+ # Create dynamic modules which define dynamic methods for scopes based on a dynamic array of column names
6
+ #
7
+ # Library Usage:
8
+ #
9
+ # class Monkey < ActiveRecord::Base
10
+ #
11
+ # include SimpleColumn::Scopes.new(:for_user_id, :for_seller_id, ... etc)
12
+ # # => for_user_id, and for_seller_id scopes are added to the model,
13
+ # and they query on the user_id and seller_id columns, respectively
14
+ #
15
+ module SimpleColumn
16
+ SCOPE_PREFIX = 'for_'.freeze
17
+ SCOPE_PREFIX_REGEX = Regexp.new("\\A#{SimpleColumn::SCOPE_PREFIX}")
18
+ class << self
19
+ # returns an anonymous (nameless) Module instance
20
+ def to_mod(scope_names_hash)
21
+ Module.new do
22
+ scope_names_hash.each do |scope_name, column_name|
23
+ # methods are defined at the instance level, so will become class methods when this module extends a class.
24
+ define_method(scope_name) do |value|
25
+ where(column_name => value)
26
+ end
27
+ end
28
+ end
29
+ end
30
+ end
31
+
32
+ # This is a Class / Module Hybrid (see simple_column/scopes/version.rb)
33
+ Scopes.class_eval do
34
+ def initialize(*scope_names)
35
+ # => { :for_user_id => "user_id" }
36
+ @simple_scope_names_hash = scope_names.map(&:to_sym).each_with_object({}) do |scope_name, memo|
37
+ # method name definitions are best with symbols, and gsub only works on strings.
38
+ memo[scope_name] = scope_name.to_s.sub(SimpleColumn::SCOPE_PREFIX_REGEX, '')
39
+ end
40
+ # Raising an error here is safe, because it will fail on boot if there is an implementation problem (early!)
41
+ unless (bad_scopes = @simple_scope_names_hash.select { |scope_name, column_name| scope_name.to_s == column_name }).blank?
42
+ bad_scope_names(bad_scopes)
43
+ end
44
+ end
45
+
46
+ def included(base)
47
+ # How to do this without breaking the build?
48
+ # if ActiveRecord::Base.connection.active?
49
+ # # Invoking this requires that a database be present.
50
+ # unless (bad_scopes = @simple_scope_names_hash.reject { |_, column_name| base.column_names.include?(column_name) }).blank?
51
+ # bad_scope_names(bad_scopes)
52
+ # end
53
+ # end
54
+ anonymous_module = SimpleColumn.to_mod(@simple_scope_names_hash)
55
+ # This will override methods defined in the including class with the same name, if any,
56
+ # because extend has the effect of injecting the code into the bottom of the class file, lexically,
57
+ # making these definitions highest priority.
58
+ base.send(:extend, anonymous_module)
59
+ end
60
+
61
+ def bad_scope_names(bad_scopes)
62
+ raise ArgumentError, "SimpleColumn::Scopes need to be named like #{SimpleColumn::SCOPE_PREFIX}<column_name>, but provided #{bad_scopes.keys}"
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,6 @@
1
+ module SimpleColumn
2
+ # This is a Class / Module Hybrid (see simple_column/scopes.rb)
3
+ class Scopes < Module
4
+ VERSION = "0.1.0"
5
+ end
6
+ end
@@ -0,0 +1,27 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "simple_column/scopes/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "simple_column-scopes"
8
+ spec.version = SimpleColumn::Scopes::VERSION
9
+ spec.authors = ["Peter Boling"]
10
+ spec.email = ["peter.boling@gmail.com"]
11
+
12
+ spec.summary = %q{Easily add named scopes that query on single columns for specific values}
13
+ spec.description = %q{Dynamic modules which define dynamic methods for scopes based on a dynamic array of column names}
14
+ spec.homepage = "https://github.com/tophatter/simple_column-scopes"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.15"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+ end
metadata ADDED
@@ -0,0 +1,100 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: simple_column-scopes
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Peter Boling
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-06-20 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.15'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.15'
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: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: Dynamic modules which define dynamic methods for scopes based on a dynamic
56
+ array of column names
57
+ email:
58
+ - peter.boling@gmail.com
59
+ executables: []
60
+ extensions: []
61
+ extra_rdoc_files: []
62
+ files:
63
+ - ".gitignore"
64
+ - ".rspec"
65
+ - ".travis.yml"
66
+ - CODE_OF_CONDUCT.md
67
+ - Gemfile
68
+ - LICENSE.txt
69
+ - README.md
70
+ - Rakefile
71
+ - bin/console
72
+ - bin/setup
73
+ - lib/simple_column/scopes.rb
74
+ - lib/simple_column/scopes/version.rb
75
+ - simple_column-scopes.gemspec
76
+ homepage: https://github.com/tophatter/simple_column-scopes
77
+ licenses:
78
+ - MIT
79
+ metadata: {}
80
+ post_install_message:
81
+ rdoc_options: []
82
+ require_paths:
83
+ - lib
84
+ required_ruby_version: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ required_rubygems_version: !ruby/object:Gem::Requirement
90
+ requirements:
91
+ - - ">="
92
+ - !ruby/object:Gem::Version
93
+ version: '0'
94
+ requirements: []
95
+ rubyforge_project:
96
+ rubygems_version: 2.6.12
97
+ signing_key:
98
+ specification_version: 4
99
+ summary: Easily add named scopes that query on single columns for specific values
100
+ test_files: []