scope_delegation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b8e3d5202a9186bfd041a1781364431c35b464e
+  data.tar.gz: 271216f634f0b014733b5980afebb5e7d2a56369
+SHA512:
+  metadata.gz: 8c096298fa45258c8a3cae991c60e7a3e2eebbc90b73f7437d7fa4dfd4e53f2b6a6fd74016fe94d04f240595d172d60dc79f43e2618d33719ab2504e29702977
+  data.tar.gz: 42688d4cfe528ec6d2e5d4d4c219c1bc7ecbad26f403b37473902599431cd5bb1d885aa98fa535bf738ff4f47319f86d6d1b7ee49b409f607e1ec46479ed8807

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,31 @@
+Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all
+people who contribute through reporting issues, posting feature requests,
+updating documentation, submitting pull requests or patches, and other
+activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling, public
+or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not
+follow the Code of Conduct may be removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the Contributor Covenant
+(http://contributor-covenant.org), version 1.1.0, available at
+http://contributor-covenant.org/version/1/1/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jon Evans
+
+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,101 @@
+# ScopeDelegation
+
+Every application needs to be able to scope data, and every developer hates
+writing boilerplate code.
+
+With `ScopeDelegation`, you can easily define scopes
+in one model that rely on scopes that are defined on an associated model.
+
+## Usage
+
+Let's look at an example.
+
+```ruby
+class Whole < ActiveRecord::Base
+  extend ScopeDelegation
+
+  has_many :parts
+
+  delegate_scope :named, to: :parts, prefix: :part
+end
+
+class Part < ActiveRecord::Base
+  belongs_to :whole
+
+  def self.named(name)
+    where(name: name)
+  end
+end
+```
+
+This now enables you to call `Whole.part_named("some name")` to easily scope
+your `Whole`s.
+
+The `prefix` option is optional, and you can also specify the `scope` on the
+associated model if it does not match the first parameter.
+
+## Explanation
+
+In a previous life, you might have been tempted to do something like:
+
+```ruby
+# whole.rb
+def self.part_named(name)
+  joins(:parts).where(name: name)
+end
+```
+
+This is unfortunate because now `Whole` knows about a column name for `Part`,
+which is none of its business. Isolating knowledge about the persistence for a
+given model to that model itself makes changing things easier.
+
+We can get around this with `merge`, like so:
+
+```ruby
+# whole.rb
+def self.part_named(name)
+  joins(:parts).merge(Part.named(name))
+end
+```
+
+This is what `ScopeDelegation` does, but with a friendly DSL that allows you to
+avoid writing boilerplate while discouraging knowing things about your neighbor
+that you shouldn't.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scope_delegation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scope_delegation
+
+## 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]/scope_delegation/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
+
+## About Foraker Labs
+
+<img src="http://assets.foraker.com/foraker_logo.png" width="400" height="62">
+
+This project is maintained by Foraker Labs. The names and logos of Foraker Labs are fully owned and copyright Foraker Design, LLC.
+
+Foraker Labs is a Boulder-based Ruby on Rails and iOS development shop. Please reach out if we can [help build your product](http://www.foraker.com).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scope_delegation"
+
+# 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

data/bin/setup

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

data/lib/scope_delegation.rb

@@ -0,0 +1,13 @@
+require "scope_delegation/version"
+
+module ScopeDelegation
+  def delegate_scope(name, options)
+    source      = options[:scope] || name
+    association = reflect_on_association(options[:to]) || raise("Unknown association")
+    name        = [options[:prefix], name].compact.join("_")
+
+    scope name, Proc.new { |*args|
+      joins(association.name).merge(association.klass.send(source, *args))
+    }
+  end
+end

data/lib/scope_delegation/version.rb

@@ -0,0 +1,3 @@
+module ScopeDelegation
+  VERSION = "0.1.0"
+end

data/scope_delegation.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scope_delegation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scope_delegation"
+  spec.version       = ScopeDelegation::VERSION
+  spec.authors       = ["Foraker"]
+  spec.email         = ["jle@foraker.com"]
+
+  spec.summary       = %q{Easily delegate scopes to associations in Rails.}
+  spec.description   = %q{Helps to reduce boilerplate for joining and merging scopes. Write fewer characters and be happier.}
+  spec.homepage      = "https://github.com/foraker/scope_delegation"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: scope_delegation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Foraker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-26 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'
+description: Helps to reduce boilerplate for joining and merging scopes. Write fewer
+  characters and be happier.
+email:
+- jle@foraker.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/scope_delegation.rb
+- lib/scope_delegation/version.rb
+- scope_delegation.gemspec
+homepage: https://github.com/foraker/scope_delegation
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Easily delegate scopes to associations in Rails.
+test_files: []