por_relation_callbacks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d3e5c8d9992ff72fd494f384302b35add564e9c
+  data.tar.gz: f7590fcc67760b3f70348ed5740daa2ddc1b3174
+SHA512:
+  metadata.gz: 428b5f9eeb175c544ec3a1b6cd7e250aaeaf24c3c88cdd6bfae9d9c13997b41641b2968575f5042783fed87addd66b39086cd14011ee2d534529a7b55cfa589f
+  data.tar.gz: 7f21393b0ad2e3c7b5247a18df71aa3afd4c597ac51e1328991b141c2be8efc14869aa9948fb35f7d9db8735d34e66f504dcfeecb3605aa7bf64d2b63d216d0b

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,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# 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.
+
+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.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 James Mac William
+
+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,76 @@
+# PorRelationCallbacks
+
+This gem makes it easy to extract active record callbacks on relations
+of an object that do not belong in the active record object. an example
+would be any callback that does not manipulate the data of the base
+object directly.
+
+[![Build
+Status](https://travis-ci.org/jamesmacwilliam/por_relation_callbacks.svg?branch=master)](https://travis-ci.org/jamesmacwilliam/por_relation_callbacks)
+
+[![Code
+Climate](https://codeclimate.com/github/jamesmacwilliam/por_relation_callbacks/badges/gpa.svg)](https://codeclimate.com/github/jamesmacwilliam/por_relation_callbacks)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'por_relation_callbacks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install por_relation_callbacks
+
+## Usage
+
+- create a plain old ruby class to house callbacks on relations of an
+object (after_add/after_remove) that do not belong in your model for
+whatever reason (ie: callbacks aren't manipulating data on the base
+model)
+
+- specify your after_add/after_remove actions and which callback these
+apply to, ie: if you want these to trigger when we add or subtract from
+user.addresses then `callbacks_for :addresses`
+
+- We instantiate the class by passing in the base record (in the above
+example an instance of `User` and then pass the params to update the
+record
+
+- define the methods used for after_add/after_remove within the class
+  just like you would an active record object
+
+- to use, instantiate the class and save it just like you would an
+  ActiveRecord Object, SomeClass.new(bas_record,
+  some_params).save
+
+
+```ruby
+include PorRelationCallbacks
+
+after_add :my_method_1, :my_method_2
+after_remove :my_method_3
+
+callbacks_for :my_relation
+```
+
+## 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/jamesmacwilliam/por_relation_callbacks. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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).
+

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 "por_relation_callbacks"
+
+# 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/por_relation_callbacks.rb

@@ -0,0 +1,73 @@
+require "por_relation_callbacks/version"
+require "active_record"
+require "active_support"
+
+module PorRelationCallbacks
+  extend ActiveSupport::Concern
+
+  included do
+    cattr_accessor :_after_add, :_after_remove, :_watched_relation
+    attr_accessor :object, :prms
+  end
+
+  module ClassMethods
+    def after_add(*methods)
+      self._after_add = methods
+    end
+
+    def after_remove(*methods)
+      self._after_remove = methods
+    end
+
+    def callbacks_for(rel)
+      self._watched_relation = rel
+    end
+  end
+
+  def initialize(object, prms)
+    @object = object
+    @prms = prms
+
+    self._after_add    ||= []
+    self._after_remove ||= []
+  end
+
+  def save
+    return unless object
+    ActiveRecord::Base.transaction do
+      @existing_relation_state = object.send(_watched_relation).to_a
+      object.update_attributes(prms)
+      object.reload
+      @updated_relation_state = object.send(_watched_relation).to_a
+      hooks
+    end
+    true
+  end
+
+  private
+
+  def hooks
+    after_add
+    after_remove
+  end
+
+  def after_add
+    return true if _after_add.empty?
+    trigger_callbacks (@updated_relation_state - @existing_relation_state),
+      _after_add
+  end
+
+  def after_remove
+    return true if _after_remove.empty?
+    trigger_callbacks (@existing_relation_state - @updated_relation_state),
+      _after_remove
+  end
+
+  def trigger_callbacks(records, callbacks)
+    records.each do |record|
+      callbacks.each do |method|
+        send(method, record)
+      end
+    end
+  end
+end

data/lib/por_relation_callbacks/version.rb

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

data/por_relation_callbacks.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'por_relation_callbacks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "por_relation_callbacks"
+  spec.version       = PorRelationCallbacks::VERSION
+  spec.authors       = ["James Mac William"]
+  spec.email         = ["jimmy.macwilliam@gmail.com"]
+
+  spec.summary       = %q{Plain old ruby callbacks on active record relations}
+  spec.description   = %q{Handles after_add and after_remove outside of the AR callback flow to keep things that aren't directly tied to the model outside of it}
+  spec.homepage      = "https://github.com/jamesmacwilliam/por_relation_callbacks"
+  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.10"
+  spec.add_development_dependency "rake",         "~> 10.0"
+  spec.add_dependency             "railties",     ">= 4.1.0", "< 5.1"
+  spec.add_dependency             "activerecord", ">= 4.0.0", "< 5.1"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: por_relation_callbacks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Mac William
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !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'
+description: Handles after_add and after_remove outside of the AR callback flow to
+  keep things that aren't directly tied to the model outside of it
+email:
+- jimmy.macwilliam@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/por_relation_callbacks.rb
+- lib/por_relation_callbacks/version.rb
+- por_relation_callbacks.gemspec
+homepage: https://github.com/jamesmacwilliam/por_relation_callbacks
+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.5
+signing_key: 
+specification_version: 4
+summary: Plain old ruby callbacks on active record relations
+test_files: []
+has_rdoc: