triggerable 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01cc155d845bc2afb7c7eb308113e74819a00d4f
-  data.tar.gz: 81074d512740a11417bc35480d4ffc1e3192dfef
+  metadata.gz: 4675b09599d91ea600d5b96c346746323a4c99b0
+  data.tar.gz: 057af4afa9a42e2fa9a09eb02d3bf728d115f6ec
 SHA512:
-  metadata.gz: 01af1a6893ed82e2878e57ab66578c6b05f5dae25eb822faf06ba66faf5071af0329b0ab266a306b0ef2b2a4b39b7b0e75d0b40f7f8651009ae4de3efffe70ee
-  data.tar.gz: e0d69053d213d38377dcaa496ded6d51cbc630933f2e623ba79a0d53b384037dc1db94a94b3c657d1d9566f4682b1d2b4ac7bf3dab085c5746d5fa4ac3978b00
+  metadata.gz: 3df5712b4a6e059cfbd2a7e5c5f90d7cbbbe4941f2ee761d08c84a58b0bc6ac0dba60b2089c54cb724f24a0d180fc6a0c3f5f00b99b72e4fb1f21dc5979cd136
+  data.tar.gz: 88c14b4067cba8a5816c1d93c2987b101631c7bc4869f9bba42e8ea757593adce708fedeb316e203b2bb2ae9c391eea449c5bc23b658e978ec1ed451bec2161c

data/README.md

@@ -28,7 +28,7 @@ class User < ActiveRecord::Base
     user.send_welcome_sms
   end
 
-  automation if: { created_at: { after: 24 }, confirmed: false } do
+  automation if: { created_at: { after: 24.hours }, confirmed: false } do
     send_confirmation_email
   end
 end
@@ -56,7 +56,7 @@ trigger on: :after_create, if: { and: [{ field1: '1' }, { field2: 1 }] }, ...
 trigger on: :after_create, if: { or: [{ field1: '1' }, { field2: 1 }] }, ...
 ```
 
-Triggerable does not run automations by itself, you should call `Engine.run_automations(interval)` using any scheduling script. Interval is a time difference between calling the method (e.g. `1.hour`). *You should avoid situations when your interval is less then the time your automations need to complete!*
+Triggerable does not run automations by itself, you should call `Triggerable::Engine.run_automations(interval)` using any scheduling script. Interval is a time difference between calling the method (e.g. `1.hour`). *You should avoid situations when your interval is less then the time your automations need to complete!*
 
 If you have more complex condition or need to check associations (not supported in DSL now), you should use a lambda condition form:
 
@@ -66,10 +66,10 @@ trigger on: :after_update, if: -> { orders.any? } do
 end
 ```
 
-If you need to share logic between triggers/automations bodies you can move it into separate class. It should be inherited from `Triggerable::Action` and implement a single method `run_for!(obj, trigger_name)` where trigger_name is a string passed to rule in :name option and obj is a triggered object. Then you can pass a name of your action class instead of do block.
+If you need to share logic between triggers/automations bodies you can move it into separate class. It should be inherited from `Triggerable::Actions::Action` and implement a single method `run_for!(object, rule_name)` where trigger_name is a string passed to rule in :name option and obj is a triggered object. Then you can pass a name of your action class instead of do block.
 
 ```ruby
-class SendWelcomeSms < Triggerable::Action
+class SendWelcomeSms < Triggerable::Actions::Action
   def run_for! object, trigger_name
     SmsGateway.send_to object.phone, welcome_text
   end
@@ -80,6 +80,16 @@ class User
 end
 ```
 
+## Logging and debugging
+
+You can easily turn on logging and debugging (using `puts`):
+
+```ruby
+Triggerable::Engine.logger = Logger.new(File.join(Rails.root, 'log', 'triggers.log'))
+Triggerable::Engine.debug = true
+```
+
+
 ## Contributing
 
 1. Fork it

data/lib/triggerable.rb

@@ -23,7 +23,8 @@ require "triggerable/conditions/schedule/schedule_condition"
 require "triggerable/conditions/schedule/before"
 require "triggerable/conditions/schedule/after"
 
-require "triggerable/actions"
+require "triggerable/actions/action"
+require "triggerable/actions/lambda_action"
 
 module Triggerable
   extend ActiveSupport::Concern
@@ -55,13 +56,13 @@ module Triggerable
 end
 
 COMPARSIONS = [
-  { name: 'Is',          ancestor: Conditions::FieldCondition, args: { ruby_comparator: '==', db_comparator: 'eq' }  },
-  { name: 'GreaterThan', ancestor: Conditions::FieldCondition, args: { ruby_comparator: '>',  db_comparator: 'gt' }  },
-  { name: 'LessThan',    ancestor: Conditions::FieldCondition, args: { ruby_comparator: '<',  db_comparator: 'lt' }  },
-  { name: 'IsNot',       ancestor: Conditions::FieldCondition, args: { ruby_comparator: '!=', db_comparator: 'not_eq'}  },
+  { name: 'Is',          ancestor: Triggerable::Conditions::FieldCondition, args: { ruby_comparator: '==', db_comparator: 'eq' }  },
+  { name: 'GreaterThan', ancestor: Triggerable::Conditions::FieldCondition, args: { ruby_comparator: '>',  db_comparator: 'gt' }  },
+  { name: 'LessThan',    ancestor: Triggerable::Conditions::FieldCondition, args: { ruby_comparator: '<',  db_comparator: 'lt' }  },
+  { name: 'IsNot',       ancestor: Triggerable::Conditions::FieldCondition, args: { ruby_comparator: '!=', db_comparator: 'not_eq'}  },
 
-  { name: 'GreaterThanOrEqualTo', ancestor: Conditions::OrEqualTo, args: { db_comparator: 'gteq', additional_condition: 'Conditions::GreaterThan' } },
-  { name: 'LessThanOrEqualTo',    ancestor: Conditions::OrEqualTo, args: { db_comparator: 'lteq', additional_condition: 'Conditions::LessThan'    } }
+  { name: 'GreaterThanOrEqualTo', ancestor: Triggerable::Conditions::OrEqualTo, args: { db_comparator: 'gteq', additional_condition: 'Triggerable::Conditions::GreaterThan' } },
+  { name: 'LessThanOrEqualTo',    ancestor: Triggerable::Conditions::OrEqualTo, args: { db_comparator: 'lteq', additional_condition: 'Triggerable::Conditions::LessThan'    } }
 ]
 
 COMPARSIONS.each do |desc|
@@ -72,7 +73,7 @@ COMPARSIONS.each do |desc|
     end
   end
 
-  Conditions.const_set(desc[:name], klass)
+  Triggerable::Conditions.const_set(desc[:name], klass)
 end
 
 ActiveSupport.on_load(:active_record) { include Triggerable }

data/lib/triggerable/actions/action.rb

@@ -0,0 +1,18 @@
+module Triggerable
+  module Actions
+    class Action
+      def self.build source
+        if source.is_a?(Proc)
+          [LambdaAction.new(source)]
+        else
+          Array(source).map do |source|
+            descendant = descendants.find { |d| d == source.to_s.camelize.constantize }
+            descendant.new if descendant.present?
+          end.compact
+        end
+      end
+
+      def run_for!(object, rule_name); end
+    end
+  end
+end

data/lib/triggerable/actions/lambda_action.rb

@@ -0,0 +1,28 @@
+module Triggerable
+  module Actions
+    class LambdaAction < Action
+      def initialize block
+        @block = block
+      end
+
+      def run_for! object, trigger_name
+        proc = @block
+        object.instance_eval do
+          change_whodunnit = trigger_name.present? && defined?(PaperTrail)
+          old_whodunnit = nil
+
+          if change_whodunnit
+            old_whodunnit = PaperTrail.whodunnit
+            PaperTrail.whodunnit = trigger_name
+          end
+
+          begin
+            instance_exec(&proc)
+          ensure
+            PaperTrail.whodunnit = old_whodunnit if change_whodunnit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/triggerable/conditions/condition.rb

@@ -1,42 +1,44 @@
-module Conditions
-  class Condition
-    def self.build condition
-      return Condition.new if condition.blank?
-      return LambdaCondition.new(condition) if condition.is_a?(Proc)
-      return MethodCondition.new(condition) if condition.is_a?(Symbol)
-
-      key = condition.keys.first
-      value = condition[key]
-
-      if [:and, :or].include?(key)
-        predicate_condition(key, value)
-      else
-        field_condition(key, value)
+module Triggerable
+  module Conditions
+    class Condition
+      def self.build condition
+        return Condition.new if condition.blank?
+        return LambdaCondition.new(condition) if condition.is_a?(Proc)
+        return MethodCondition.new(condition) if condition.is_a?(Symbol)
+
+        key = condition.keys.first
+        value = condition[key]
+
+        if [:and, :or].include?(key)
+          predicate_condition(key, value)
+        else
+          field_condition(key, value)
+        end
       end
-    end
 
-    def true_for?(object); true; end
+      def true_for?(object); true; end
 
-    def scope; ''; end
+      def scope; ''; end
 
-    private
+      private
 
-    def self.predicate_condition class_name, value
-      condition_class(class_name).new(value)
-    end
+      def self.predicate_condition class_name, value
+        condition_class(class_name).new(value)
+      end
 
-    def self.field_condition field, value
-      if value.is_a?(Array)
-        Conditions::In.new(field, value)
-      elsif value.is_a?(Hash)
-        condition_class(value.keys.first).new(field, value.values.first)
-      else
-        Conditions::Is.new(field, value)
+      def self.field_condition field, value
+        if value.is_a?(Array)
+          In.new(field, value)
+        elsif value.is_a?(Hash)
+          condition_class(value.keys.first).new(field, value.values.first)
+        else
+          Is.new(field, value)
+        end
       end
-    end
 
-    def self.condition_class sym
-      "Conditions::#{sym.to_s.camelize}".constantize
+      def self.condition_class sym
+        "Triggerable::Conditions::#{sym.to_s.camelize}".constantize
+      end
     end
   end
 end

data/lib/triggerable/conditions/field/exists.rb

@@ -1,12 +1,18 @@
-module Conditions
-  class Exists < FieldCondition
-    def true_for? object
-      v = field_value(object)
-      @value ? v.present? : v.blank?
-    end
+module Triggerable
+  module Conditions
+    class Exists < FieldCondition
+      def true_for? object
+        v = field_value(object)
+        @value ? v.present? : v.blank?
+      end
+
+      def scope
+        "#{@field} IS #{'NOT ' if @value}NULL"
+      end
 
-    def scope
-      "#{@field} IS #{'NOT ' if @value}NULL"
+      def desc
+        "#{@field} exists"
+      end
     end
   end
 end

data/lib/triggerable/conditions/field/field_condition.rb

@@ -1,28 +1,34 @@
-module Conditions
-  class FieldCondition < Condition
-    def initialize field, value
-      @field = field
-      @value = value
-    end
+module Triggerable
+  module Conditions
+    class FieldCondition < Condition
+      def initialize field, value
+        @field = field
+        @value = value
+      end
 
-    def true_for? object
-      field_value(object).send(@ruby_comparator, @value)
-    end
+      def true_for? object
+        field_value(object).send(@ruby_comparator, @value)
+      end
 
-    def scope table
-      table[@field].send(@db_comparator, @value)
-    end
+      def scope table
+        table[@field].send(@db_comparator, @value)
+      end
 
-    private
-    def field_value object
-      object.send(@field)
-    end
+      def desc
+        "#{@field} #{@ruby_comparator} #{@value}"
+      end
+
+      private
+      def field_value object
+        object.send(@field)
+      end
 
-    def sanitized_value
-      if @value.is_a?(Array)
-        @value.map { |v| ActiveRecord::Base::sanitize(v) }
-      else
-        ActiveRecord::Base::sanitize(@value)
+      def sanitized_value
+        if @value.is_a?(Array)
+          @value.map { |v| ActiveRecord::Base::sanitize(v) }
+        else
+          ActiveRecord::Base::sanitize(@value)
+        end
       end
     end
   end

data/lib/triggerable/conditions/field/in.rb

@@ -1,17 +1,23 @@
-module Conditions
-  class In < FieldCondition
-    def initialize field, condition
-      super
-      @db_comparator = 'in'
-    end
+module Triggerable
+  module Conditions
+    class In < FieldCondition
+      def initialize field, condition
+        super
+        @db_comparator = 'in'
+      end
 
-    def true_for? object
-      @value.include?(field_value(object))
-    end
+      def true_for? object
+        @value.include?(field_value(object))
+      end
+
+      def desc
+        "#{@field} #{@db_comparator} #{@value}"
+      end
 
-    private
-    def sanitized_value
-      "(#{super.join(',')})"
+      private
+      def sanitized_value
+        "(#{super.join(',')})"
+      end
     end
   end
 end

data/lib/triggerable/conditions/field/or_equal_to.rb

@@ -1,15 +1,17 @@
-module Conditions
-  class OrEqualTo < FieldCondition
-    def initialize field, value
-      super
-      @condition = Or.new [
-        @additional_condition.constantize.new(field, value),
-        Is.new(field, value)
-      ]
-    end
+module Triggerable
+  module Conditions
+    class OrEqualTo < FieldCondition
+      def initialize field, value
+        super
+        @condition = Or.new [
+          @additional_condition.constantize.new(field, value),
+          Is.new(field, value)
+        ]
+      end
 
-    def true_for? object
-      @condition.true_for?(object)
+      def true_for? object
+        @condition.true_for?(object)
+      end
     end
   end
 end

data/lib/triggerable/conditions/lambda_condition.rb

@@ -1,12 +1,18 @@
-module Conditions
-  class LambdaCondition < Condition
-    def initialize block
-      @block = block
-    end
+module Triggerable
+  module Conditions
+    class LambdaCondition < Condition
+      def initialize block
+        @block = block
+      end
+
+      def true_for? object
+        proc = @block
+        object.instance_eval { instance_exec(&proc) }
+      end
 
-    def true_for? object
-      proc = @block
-      object.instance_eval { instance_exec(&proc) }
+      def desc
+        'lambda'
+      end
     end
   end
 end

data/lib/triggerable/conditions/method_condition.rb

@@ -1,11 +1,17 @@
-module Conditions
-  class MethodCondition < Condition
-    def initialize method_name
-      @method_name = method_name
-    end
+module Triggerable
+  module Conditions
+    class MethodCondition < Condition
+      def initialize method_name
+        @method_name = method_name
+      end
+
+      def true_for? object
+        object.send(@method_name)
+      end
 
-    def true_for? object
-      object.send(@method_name)
+      def desc
+        @method_name
+      end
     end
   end
 end

data/lib/triggerable/conditions/predicate/and.rb

@@ -1,7 +1,13 @@
-module Conditions
-  class And < PredicateCondition
-    def true_for? object
-      true_conditions(object).count == @conditions.count
+module Triggerable
+  module Conditions
+    class And < PredicateCondition
+      def true_for? object
+        true_conditions(object).count == @conditions.count
+      end
+
+      def desc
+        @conditions.map { |c| c.try(:desc) || c }.join(' && ')
+      end
     end
   end
 end