active_touch 1.1.0 → 1.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjllZTYxOGYxODMwMmZjMGRjZmRlODMxOTc4MDkyY2MyZDYzOTJkOA==
+    ZWFlZTI2MzdlMmFiOTQ1MTI0ZDg0YmFiMWViYjNhZGE5MWQ0YmNiNw==
   data.tar.gz: !binary |-
-    YzJlM2ExNjBiMTBhNGI4MWIwMjJlNWE5NDdhNDMwNTU5OGRkYjFhYQ==
+    N2RlYTU2MGNmODZjMTBlZTFmYTIwMGI5MTU0NDg1YzI1OWQyMmFjMQ==
 SHA512:
   metadata.gz: !binary |-
-    ZmNkNWM1MGFlZjMxOTRiMDgwZTc3ZTQ4MGE4ZDFmMTNjYjQzNTFhYTI4MjNj
-    ZTc0MGU0M2RmNTE3MzJmOTkwMjAxZDk5OGQ1MTBiZGJmZWVkMWQ5NmRmNDU1
-    OGI4NDdkY2FjOTE1NGM0MGMzOTcwYzUxYmJmNTgwZjBhZmFjN2M=
+    M2JjNTcwMTQ2ZDI3ZWM3ZWUxZjEwZDhlZjJhM2I4YWQ4N2FiYWYzNzM1Njhi
+    MjVjMWFlODNjYTQ3NzcwZjAxNGUxMmJlMzM1ZjYzNGI4NTdlNWNkMjhhZTFl
+    MjYzNDNkOTg0YzQwMWIyZjhlNjZmZDE2ZmI1N2QyN2RmNzNmYTU=
   data.tar.gz: !binary |-
-    ZmYxOTZkZmI2NGM4ZTY2MGZkM2VhODllNGE1ZGE1OTczYjk3YTg1NmRiNDc3
-    ZDZjYmM3NDNkNzFiYzQ1M2I5YThiZjQ5NGE1ZDdjYThhYzEyMmI3YWQ4ZWI5
-    ZTBmODcwZDI2ZDkzYzZhZDY2MmVlYmI5YjgwM2M2MGM4NDVkNmI=
+    ZjM5Y2UwYzUxZWIwNmMyMmJiOWJiM2MzYTZiODczMzFhNzlkMjU1NjgyNDI0
+    Y2JlNmI4YmUxY2YxOTcwMDBjNDMwZGZhMGI0MTdmNzk0Mjg0NmU3ZjFjNjRi
+    N2YzMzdlZDJmMTg0NTA2MmU1YTNhNzZiZjYzMWNhNWRkYzcyYzU=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_touch (1.0.0)
+    active_touch (1.4.0)
       rails (~> 4.2)
 
 GEM

data/README.md

@@ -9,7 +9,13 @@ A more robust touch for ActiveRecord associations.
 Add the gem to your Gemfile:
 
 ```ruby
-gem 'activetouch', '~> 1.0.0'
+gem 'activetouch', '~> 1.4.0'
+```
+
+Then run the installer:
+
+```ruby
+rails g active_touch:install
 ```
 
 ## Usage
@@ -26,6 +32,9 @@ 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.
 
+
+### Attribute specific touches
+
 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
@@ -36,6 +45,9 @@ class Model < ActiveRecord::Base
 end
 ```
 
+
+### After Touch Callback
+
 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
@@ -48,6 +60,9 @@ end
 
 NOTE: The `after_touch` method must be an instance method defined on the associated Class.
 
+
+### Asynchronous touch
+
 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
@@ -59,3 +74,12 @@ end
 ```
 
 NOTE: The default is `async: false`
+
+
+## Options
+
+There are a few options that you can change by updating `config/initializers/active_touch.rb`.
+
+- `async`: Define a default for all touches to run asynchronously by setting this to true.
+- `ignored_attributes`: When no `watch` argument is supplied, all attribute changes can trigger a touch.  Define a default list of ignored attributes here.  Default is `:updated_at`.
+- `queue`: Specify which queue to put asynchronous jobs in.

data/lib/active_touch.rb

@@ -1,4 +1,5 @@
 require 'active_touch/version'
+require 'active_touch/configuration'
 require 'active_touch/define_touch'
 require 'active_touch/touch_job'
 

data/lib/active_touch/configuration.rb

@@ -0,0 +1,25 @@
+module ActiveTouch
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :async, :ignored_attributes, :queue
+
+    def initialize
+      @async = false
+      @ignored_attributes = [:updated_at]
+      @queue = 'default'
+    end
+  end
+
+end

data/lib/active_touch/define_touch.rb

@@ -23,11 +23,17 @@ module ActiveTouch
 
       @klass.send :define_method, @touch_method do |*args|
         changed_attributes = self.previous_changes.keys.map(&:to_sym)
+        watched_changes = (options[:watch] & changed_attributes)
 
-        if (options[:watch] & changed_attributes).any?
+        # watched values changed and conditional procs evaluate to true
+        if watched_changes.any? && options[:if].call(self) && !options[:unless].call(self)
+          Rails.logger.debug "Touch: #{self.class}(#{self.id}) => #{association} due to changes in #{watched_changes}"
 
           if options[:async]
-            TouchJob.perform_later(self, association.to_s, options[:after_touch].to_s)
+            TouchJob
+                .set(queue: ActiveTouch.configuration.queue)
+                .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
@@ -43,9 +49,11 @@ module ActiveTouch
 
     def default_options
       {
-          async: false,
-          watch: @klass.column_names.map(&:to_sym),
-          after_touch: nil
+          async: ActiveTouch.configuration.async,
+          watch: @klass.column_names.map(&:to_sym) - ActiveTouch.configuration.ignored_attributes,
+          after_touch: nil,
+          if: Proc.new { true },
+          unless: Proc.new { false }
       }
     end
 

data/lib/active_touch/touch_job.rb

@@ -12,7 +12,7 @@ module ActiveTouch
         associated.update_columns(updated_at: record.updated_at)
         associated.send(after_touch) unless after_touch.blank?
 
-      else
+      elsif !associated.nil?
         associated.update_all(updated_at: record.updated_at)
         associated.each { |associate| associate.send(after_touch) } unless after_touch.blank?
       end

data/lib/active_touch/version.rb

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

data/lib/generators/active_touch/initializer_generator.rb

@@ -0,0 +1,6 @@
+
+class InitializerGenerator < Rails::Generators::Base
+  def create_initializer_file
+    create_file "config/initializers/initializer.rb", "# Add initialization content here"
+  end
+end

data/lib/generators/active_touch/install/install_generator.rb

@@ -0,0 +1,12 @@
+module ActiveTouch
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_files
+        template 'active_touch.rb', 'config/initializers/active_touch.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/active_touch/install/templates/active_touch.rb

@@ -0,0 +1,13 @@
+ActiveTouch.configure do |config|
+  # All touches to run synchronously or asynchronously, unless specified
+  # Default is false
+  # config.async = false
+
+  # When :watch is not specified, ignore the following attributes.
+  # Default is [:updated_at]
+  # config.ignored_attributes = [:updated_at]
+
+  # Job queue for asynchronous jobs.
+  # Default is 'default'
+  # config.queue = 'default'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_touch
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Kevin Pheasey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2015-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,9 +71,13 @@ files:
 - bin/console
 - bin/setup
 - lib/active_touch.rb
+- lib/active_touch/configuration.rb
 - lib/active_touch/define_touch.rb
 - lib/active_touch/touch_job.rb
 - lib/active_touch/version.rb
+- lib/generators/active_touch/initializer_generator.rb
+- lib/generators/active_touch/install/install_generator.rb
+- lib/generators/active_touch/install/templates/active_touch.rb
 homepage: https://github.com/kpheasey/active_touch
 licenses:
 - MIT