simple_column-scopes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ed39193a453d22aaf1d331120110a36efc7c1da
+  data.tar.gz: 8f44765dcee98e34a7962e9ac3ab1aca0c29bffd
+SHA512:
+  metadata.gz: d17c9cb99858eddb2061a9f41711804ea2dc519ca782784a5bc11772c726c6f6a26983e2447a76984aa338f2e7519315048160c3387992dece3f2872b230991f
+  data.tar.gz: 2bd845f7947f048213528ebebc6f2059f630d8ae23e8e768b1a28d02aefebb6431006e2a11c2640b4b63ea9def564ed90bec221eb498aaf797ec532b1176d85e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at peter.boling@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Peter Boling
+
+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,87 @@
+# SimpleColumn::Scopes
+
+Create dynamic modules which define dynamic methods for scopes based on a dynamic array of column names!
+
+## Why?
+
+Why replace a simple `where` query with a method from a DSL like this?
+  
+* Tokenizing your logic makes it easy to find with grep or other search tools.
+  - Do a search for `.where(` in a large codebase, and may wish the specific thing you are looking for was tokenized.
+* Creating small blocks of logic on which to build, of a uniform nature, can make applications
+  - more robust (this will raise a noisy error on a typo - if the column doesn't exist, or the scope prefix is incorrect)
+  - reduce typos (see above)
+  - reduce mental overhead (the same pattern every time, no variation; `for_<column_name>` always means the same thing)
+* Profit
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_column-scopes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_column-scopes
+
+## Usage
+
+Given an ActiveRecord model with a column: `user_id`
+Create a scope that queries it, by prefixing `for_` to the column name:
+
+```ruby
+include SimpleColumn::Scopes.new(:for_user_id)
+```
+is equivalent to:
+```ruby
+def self.for_user_id(user_id)
+  where(user_id: user_id)
+end
+```
+
+Complete example\*:
+
+```ruby
+# == Schema Information
+#
+# Table name: monkeys
+#
+#  id             :integer(4)       not null, primary key
+#  user_id        :integer(4)
+#  seller_id  :integer(4)
+class Monkey < ActiveRecord::Base
+
+  include SimpleColumn::Scopes.new(:for_user_id, :for_seller_id, :etc)
+  # => for_user_id, and for_seller_id scopes are added to the model,
+  #       and they query on the user_id and seller_id columns, respectively
+end
+
+Monkey.for_user_id(1)
+Monkey.for_seller_id(2)
+```
+
+\* This software may not be suitable for buying and selling of Monkeys.  This is simply a contrived example.
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_column/scopes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_column/scopes.rb

@@ -0,0 +1,65 @@
+require 'simple_column/scopes'
+require 'simple_column/scopes/version'
+
+# Purpose:
+# Create dynamic modules which define dynamic methods for scopes based on a dynamic array of column names
+#
+# Library Usage:
+#
+# class Monkey < ActiveRecord::Base
+#
+#   include SimpleColumn::Scopes.new(:for_user_id, :for_seller_id, ... etc)
+#   # => for_user_id, and for_seller_id scopes are added to the model,
+#         and they query on the user_id and seller_id columns, respectively
+#
+module SimpleColumn
+  SCOPE_PREFIX = 'for_'.freeze
+  SCOPE_PREFIX_REGEX = Regexp.new("\\A#{SimpleColumn::SCOPE_PREFIX}")
+  class << self
+    # returns an anonymous (nameless) Module instance
+    def to_mod(scope_names_hash)
+      Module.new do
+        scope_names_hash.each do |scope_name, column_name|
+          # methods are defined at the instance level, so will become class methods when this module extends a class.
+          define_method(scope_name) do |value|
+            where(column_name => value)
+          end
+        end
+      end
+    end
+  end
+
+  # This is a Class / Module Hybrid (see simple_column/scopes/version.rb)
+  Scopes.class_eval do
+    def initialize(*scope_names)
+      # => { :for_user_id => "user_id" }
+      @simple_scope_names_hash = scope_names.map(&:to_sym).each_with_object({}) do |scope_name, memo|
+        # method name definitions are best with symbols, and gsub only works on strings.
+        memo[scope_name] = scope_name.to_s.sub(SimpleColumn::SCOPE_PREFIX_REGEX, '')
+      end
+      # Raising an error here is safe, because it will fail on boot if there is an implementation problem (early!)
+      unless (bad_scopes = @simple_scope_names_hash.select { |scope_name, column_name| scope_name.to_s == column_name }).blank?
+        bad_scope_names(bad_scopes)
+      end
+    end
+
+    def included(base)
+      # How to do this without breaking the build?
+      # if ActiveRecord::Base.connection.active?
+      #   # Invoking this requires that a database be present.
+      #   unless (bad_scopes = @simple_scope_names_hash.reject { |_, column_name| base.column_names.include?(column_name) }).blank?
+      #     bad_scope_names(bad_scopes)
+      #   end
+      # end
+      anonymous_module = SimpleColumn.to_mod(@simple_scope_names_hash)
+      # This will override methods defined in the including class with the same name, if any,
+      #   because extend has the effect of injecting the code into the bottom of the class file, lexically,
+      #   making these definitions highest priority.
+      base.send(:extend, anonymous_module)
+    end
+
+    def bad_scope_names(bad_scopes)
+      raise ArgumentError, "SimpleColumn::Scopes need to be named like #{SimpleColumn::SCOPE_PREFIX}<column_name>, but provided #{bad_scopes.keys}"
+    end
+  end
+end

data/lib/simple_column/scopes/version.rb

@@ -0,0 +1,6 @@
+module SimpleColumn
+  # This is a Class / Module Hybrid (see simple_column/scopes.rb)
+  class Scopes < Module
+    VERSION = "0.1.0"
+  end
+end

data/simple_column-scopes.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simple_column/scopes/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_column-scopes"
+  spec.version       = SimpleColumn::Scopes::VERSION
+  spec.authors       = ["Peter Boling"]
+  spec.email         = ["peter.boling@gmail.com"]
+
+  spec.summary       = %q{Easily add named scopes that query on single columns for specific values}
+  spec.description   = %q{Dynamic modules which define dynamic methods for scopes based on a dynamic array of column names}
+  spec.homepage      = "https://github.com/tophatter/simple_column-scopes"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: simple_column-scopes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Boling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Dynamic modules which define dynamic methods for scopes based on a dynamic
+  array of column names
+email:
+- peter.boling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_column/scopes.rb
+- lib/simple_column/scopes/version.rb
+- simple_column-scopes.gemspec
+homepage: https://github.com/tophatter/simple_column-scopes
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Easily add named scopes that query on single columns for specific values
+test_files: []