active_touch 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjllZTYxOGYxODMwMmZjMGRjZmRlODMxOTc4MDkyY2MyZDYzOTJkOA==
+  data.tar.gz: !binary |-
+    YzJlM2ExNjBiMTBhNGI4MWIwMjJlNWE5NDdhNDMwNTU5OGRkYjFhYQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZmNkNWM1MGFlZjMxOTRiMDgwZTc3ZTQ4MGE4ZDFmMTNjYjQzNTFhYTI4MjNj
+    ZTc0MGU0M2RmNTE3MzJmOTkwMjAxZDk5OGQ1MTBiZGJmZWVkMWQ5NmRmNDU1
+    OGI4NDdkY2FjOTE1NGM0MGMzOTcwYzUxYmJmNTgwZjBhZmFjN2M=
+  data.tar.gz: !binary |-
+    ZmYxOTZkZmI2NGM4ZTY2MGZkM2VhODllNGE1ZGE1OTczYjk3YTg1NmRiNDc3
+    ZDZjYmM3NDNkNzFiYzQ1M2I5YThiZjQ5NGE1ZDdjYThhYzEyMmI3YWQ4ZWI5
+    ZTBmODcwZDI2ZDkzYzZhZDY2MmVlYmI5YjgwM2M2MGM4NDVkNmI=

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.idea

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: .
+  specs:
+    active_touch (1.0.0)
+      rails (~> 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.5)
+      actionpack (= 4.2.5)
+      actionview (= 4.2.5)
+      activejob (= 4.2.5)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.5)
+      actionview (= 4.2.5)
+      activesupport (= 4.2.5)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.5)
+      activesupport (= 4.2.5)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.5)
+      activesupport (= 4.2.5)
+      globalid (>= 0.3.0)
+    activemodel (4.2.5)
+      activesupport (= 4.2.5)
+      builder (~> 3.1)
+    activerecord (4.2.5)
+      activemodel (= 4.2.5)
+      activesupport (= 4.2.5)
+      arel (~> 6.0)
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    concurrent-ruby (1.0.0)
+    erubis (2.7.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.99)
+    mini_portile2 (2.0.0)
+    minitest (5.8.3)
+    nokogiri (1.6.7)
+      mini_portile2 (~> 2.0.0.rc2)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.5)
+      actionmailer (= 4.2.5)
+      actionpack (= 4.2.5)
+      actionview (= 4.2.5)
+      activejob (= 4.2.5)
+      activemodel (= 4.2.5)
+      activerecord (= 4.2.5)
+      activesupport (= 4.2.5)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.5)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.5)
+      actionpack (= 4.2.5)
+      activesupport (= 4.2.5)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    sprockets (3.5.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (2.3.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_touch!
+  bundler (~> 1.10)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kevin Pheasey
+
+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,61 @@
+# ActiveTouch
+A more robust touch for ActiveRecord associations.
+- Touch specific associations when specific attributes change
+- Call an optional method on those touched records
+- Perform the touch synchronously or asynchronously
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'activetouch', '~> 1.0.0'
+```
+
+## Usage
+
+Basic touch that runs `after_commit`.  This will update the association's updated_at.
+
+```ruby
+class Model < ActiveRecord::Base
+  has_many :relations
+
+  touch :relations
+end
+```
+
+NOTE: It doesn't matter what type of association is given.  The association can even reference an instance method that returns an `ActiveRecord` collection or record.
+
+To only call the touch when specific attributes are changed, supply an array of attributes with `:watch`.  The following example will only touch `:relations` when `:name` or `:code` changes.
+
+```ruby
+class Model < ActiveRecord::Base
+  has_many :relations
+
+  touch :relations, watch: [:name, :code]
+end
+```
+
+To call a method on the touched records, use `:after_touch`.  The following example will call `:do_something` on the associated records after a tocuh.
+
+```ruby
+class Model < ActiveRecord::Base
+  has_many :relations
+
+  touch :relations, after_touch: :do_something
+end
+```
+
+NOTE: The `after_touch` method must be an instance method defined on the associated Class.
+
+The touch can also be queued and run in the background using `ActiveJob` by setting the `:async` flag.  The following example will run a touch in the background.
+
+```ruby
+class Model < ActiveRecord::Base
+  has_many :relations
+
+  touch :relations, async: true
+end
+```
+
+NOTE: The default is `async: false`

data/Rakefile

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

data/active_touch.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_touch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_touch'
+  spec.version       = ActiveTouch::VERSION
+  spec.authors       = ['Kevin Pheasey']
+  spec.email         = ['kevin@kpheasey.com']
+  spec.licenses      = ['MIT']
+
+  spec.summary       = %q{A more robust touch for ActiveRecord associations.}
+  spec.description   = %q{Touch specific associations when specific attributes change.  Call an optional method on those touched records.  Perform the touch synchronously or asynchronously.}
+  spec.homepage      = 'https://github.com/kpheasey/active_touch'
+
+  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 'rails', '~> 4.2'
+end

data/bin/console

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

@@ -0,0 +1,23 @@
+require 'active_touch/version'
+require 'active_touch/define_touch'
+require 'active_touch/touch_job'
+
+require 'active_support/concern'
+require 'active_job/base'
+require 'active_record/base'
+
+module ActiveTouch
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+    def touch(association, options = {})
+      DefineTouch.on(self, association, options)
+    end
+
+  end
+end
+
+class ActiveRecord::Base
+  include ActiveTouch
+end

data/lib/active_touch/define_touch.rb

@@ -0,0 +1,53 @@
+module ActiveTouch
+  class DefineTouch
+
+    def self.on(klass, association, options)
+      new(klass, association, options).define
+    end
+
+    def initialize(klass, association, options)
+      @klass = klass
+      @association = association
+      @options = default_options.merge(options)
+      @touch_method = "touch_#{SecureRandom.uuid}"
+    end
+
+    def define
+      define_touch_method
+      add_active_record_callback
+    end
+
+    def define_touch_method
+      association = @association
+      options = @options
+
+      @klass.send :define_method, @touch_method do |*args|
+        changed_attributes = self.previous_changes.keys.map(&:to_sym)
+
+        if (options[:watch] & changed_attributes).any?
+
+          if options[:async]
+            TouchJob.perform_later(self, association.to_s, options[:after_touch].to_s)
+          else
+            TouchJob.perform_now(self, association.to_s, options[:after_touch].to_s)
+          end
+
+        end
+      end
+    end
+
+    def add_active_record_callback
+      touch_method = @touch_method
+      @klass.send(:after_commit) { send(touch_method) }
+    end
+
+    def default_options
+      {
+          async: false,
+          watch: @klass.column_names.map(&:to_sym),
+          after_touch: nil
+      }
+    end
+
+  end
+end

data/lib/active_touch/touch_job.rb

@@ -0,0 +1,22 @@
+module ActiveTouch
+  class TouchJob < ActiveJob::Base
+
+    def perform(record, association, after_touch)
+      if association == 'self'
+        associated = record
+      else
+        associated = record.send(association)
+      end
+
+      if associated.is_a? ActiveRecord::Base
+        associated.update_columns(updated_at: record.updated_at)
+        associated.send(after_touch) unless after_touch.blank?
+
+      else
+        associated.update_all(updated_at: record.updated_at)
+        associated.each { |associate| associate.send(after_touch) } unless after_touch.blank?
+      end
+    end
+
+  end
+end

data/lib/active_touch/version.rb

@@ -0,0 +1,3 @@
+module ActiveTouch
+  VERSION = '1.1.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: active_touch
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Kevin Pheasey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-15 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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Touch specific associations when specific attributes change.  Call an
+  optional method on those touched records.  Perform the touch synchronously or asynchronously.
+email:
+- kevin@kpheasey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- active_touch.gemspec
+- bin/console
+- bin/setup
+- lib/active_touch.rb
+- lib/active_touch/define_touch.rb
+- lib/active_touch/touch_job.rb
+- lib/active_touch/version.rb
+homepage: https://github.com/kpheasey/active_touch
+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.8
+signing_key: 
+specification_version: 4
+summary: A more robust touch for ActiveRecord associations.
+test_files: []