triggerable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eccbfd503b44b892a1247b8dde94381fba3017ed
+  data.tar.gz: a159bb8a7559a264be77616c3d8bd83f144aa0ff
+SHA512:
+  metadata.gz: bf594d01a28d8a826c38d13db346027233b5419147406d725d53e35e4e39bfb260689693ceec44e83000b83eb708a5d2b3343498d64c4d167b8dc06435dd4c9a
+  data.tar.gz: 6bef7a97e9236f09954cacdc30c76b4f3b9012864b2168115c0e2a482ea136630267c5d99f8bae96bd1bf34c75f8c1da9938acae1cb093790d067ffe75f4f51e

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 DmitryTsepelev
+
+MIT License
+
+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,89 @@
+# Triggerable
+
+[![Code Climate](https://codeclimate.com/github/anjlab/triggerable/badges/gpa.svg)](https://codeclimate.com/github/anjlab/triggerable)
+
+Triggerable is a powerful engine for adding a conditional behaviour for ActiveRecord models. This logic can be defined in two ways - as triggers and automations. Triggers are called right after model creating, updating or saving, and automations are run on schedule (e.g. 2 hours after update).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'triggerable'
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+## Usage
+
+Setup and defining trigger and automation:
+
+```ruby
+class User < ActiveRecord::Base
+  trigger on: :after_create, if: { receives_sms: true }, do
+    user.send_welcome_sms
+  end
+
+  automation if: { created_at: { after: 24 }, confirmed: false } do
+    send_confirmation_email
+  end
+end
+```
+
+Combining different conditions and predicates:
+
+```ruby
+trigger on: :after_create, if: { field: { is: 1 } }, ...
+# short form
+trigger on: :after_create, if: { field: 1 }, ...
+
+trigger on: :after_create, if: { field: { is_not: 1 } }, ...
+
+trigger on: :after_create, if: { field: { in: [1, 2, 3] } }, ...
+# short form
+trigger on: :after_create, if: { field: [1, 2, 3] }, ...
+
+trigger on: :after_create, if: { field: { greater_then: 1 } }, ...
+trigger on: :after_create, if: { field: { less_then: 1 } }, ...
+
+trigger on: :after_create, if: { field: { exists: true } }, ...
+
+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!*
+
+If you have more complex condition or need to check associations (not supported in DSL now), you should use a lambda condition form:
+
+```ruby
+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)` where obj is a triggered object. Then you can pass a name of your action class instead of do block.
+
+```ruby
+class SendWelcomeSms < Triggerable::Action
+  def run_for! object
+    SmsGateway.send_to object.phone, welcome_text
+  end
+end
+
+class User
+  trigger on: :after_create, if: { receives_sms: true }, do: :send_welcome_sms
+end
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/triggerable.rb

@@ -0,0 +1,78 @@
+require "triggerable/version"
+
+require "triggerable/engine"
+
+require "triggerable/rules/rule"
+require "triggerable/rules/trigger"
+require "triggerable/rules/automation"
+
+require "triggerable/conditions/condition"
+require "triggerable/conditions/lambda_condition"
+require "triggerable/conditions/method_condition"
+
+require "triggerable/conditions/field/field_condition"
+require "triggerable/conditions/field/exists"
+require "triggerable/conditions/field/in"
+require "triggerable/conditions/field/or_equal_to"
+
+require "triggerable/conditions/predicate/predicate_condition"
+require "triggerable/conditions/predicate/and"
+require "triggerable/conditions/predicate/or"
+
+require "triggerable/conditions/schedule/schedule_condition"
+require "triggerable/conditions/schedule/before"
+require "triggerable/conditions/schedule/after"
+
+require "triggerable/actions"
+
+module Triggerable
+  extend ActiveSupport::Concern
+
+  included do
+    CALLBACKS = [:before_create, :before_save, :before_update, :after_create, :after_save, :after_update]
+    CALLBACKS.each do |callback|
+      method_name = "run_#{callback}_triggers"
+      define_method(method_name) { run_triggers(callback) }
+      send(callback, method_name)
+    end
+
+    private
+
+    def run_triggers callback
+      Engine.triggers_for(self.class, callback).each{|t| t.execute!(self)}
+    end
+  end
+
+  module ClassMethods
+    def trigger options, &block
+      Engine.trigger(self, options, block)
+    end
+
+    def automation options, &block
+      Engine.automation(self, options, block)
+    end
+  end
+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: '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'    } }
+]
+
+COMPARSIONS.each do |desc|
+  klass = Class.new(desc[:ancestor]) do
+    define_method :initialize do |field, value|
+      desc[:args].each_pair { |name, val| instance_variable_set("@#{name}".to_sym, val) }
+      super(field, value)
+    end
+  end
+
+  Conditions.const_set(desc[:name], klass)
+end
+
+ActiveSupport.on_load(:active_record) { include Triggerable }

data/lib/triggerable/actions.rb

@@ -0,0 +1,27 @@
+module Triggerable
+  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); end
+  end
+
+  class LambdaAction < Action
+    def initialize block
+      @block = block
+    end
+
+    def run_for! object
+      proc = @block
+      object.instance_eval { instance_exec(&proc) }
+    end
+  end
+end

data/lib/triggerable/conditions/condition.rb

@@ -0,0 +1,42 @@
+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
+
+    def true_for?(object); true; end
+
+    def scope; ''; end
+
+    private
+
+    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)
+      end
+    end
+
+    def self.condition_class sym
+      "Conditions::#{sym.to_s.camelize}".constantize
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+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
+  end
+end

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

@@ -0,0 +1,29 @@
+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 scope table
+      table[@field].send(@db_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)
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,15 @@
+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)
+    end
+  end
+end

data/lib/triggerable/conditions/lambda_condition.rb

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

data/lib/triggerable/conditions/method_condition.rb

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

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

@@ -0,0 +1,7 @@
+module Conditions
+  class And < PredicateCondition
+    def true_for? object
+      true_conditions(object).count == @conditions.count
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Conditions
+  class Or < PredicateCondition
+    def true_for? object
+      true_conditions(object).any?
+    end
+  end
+end