rules_engine 0.1.3 → 0.1.4

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/lib/rules_engine.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + "/rules_engine/discovery")
-require File.expand_path(File.dirname(__FILE__) + "/rules_engine/rule")
-require File.expand_path(File.dirname(__FILE__) + "/rules_engine/rule_outcome")
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine/rule/definition")
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine/rule/outcome")
 
 require File.expand_path(File.dirname(__FILE__) + "/rules_engine/cache")
 require File.expand_path(File.dirname(__FILE__) + "/rules_engine/publish/publisher")

data/lib/rules_engine/discovery.rb

@@ -23,7 +23,7 @@ module RulesEngine
         Dir.glob("#{rules_path}/**/*.rb").each do |rule| 
           Kernel.load rule
 
-          rule_class = Kernel.const_get(File.basename(rule, '.rb').classify)
+          rule_class = Rule.const_get(File.basename(rule, '.rb').classify)
           @rule_classes << rule_class
           
           group = rule_class.options[:group]

data/lib/rules_engine/process/runner.rb

@@ -98,19 +98,19 @@ module RulesEngine
               rule_outcome = rule.process(process_id, data)
               RulesEngine::Process.auditor.audit(process_id, "Rule : #{rule.title} : finished")
 
-              if !rule_outcome.nil? && rule_outcome.outcome == RulesEngine::RuleOutcome::OUTCOME_STOP_SUCCESS
+              if !rule_outcome.nil? && rule_outcome.outcome == RulesEngine::Rule::Outcome::STOP_SUCCESS
                 RulesEngine::Process.auditor.audit(process_id, "Workflow : #{current_workflow} : stop success", RulesEngine::Process::AUDIT_SUCCESS)
                 done = true 
                 break
               end
         
-              if !rule_outcome.nil? && rule_outcome.outcome == RulesEngine::RuleOutcome::OUTCOME_STOP_FAILURE
+              if !rule_outcome.nil? && rule_outcome.outcome == RulesEngine::Rule::Outcome::STOP_FAILURE
                 RulesEngine::Process.auditor.audit(process_id, "Workflow : #{current_workflow} : stop failure", RulesEngine::Process::AUDIT_FAILURE)
                 error = done = true 
                 break
               end
         
-              if !rule_outcome.nil? && rule_outcome.outcome == RulesEngine::RuleOutcome::OUTCOME_START_WORKFLOW
+              if !rule_outcome.nil? && rule_outcome.outcome == RulesEngine::Rule::Outcome::START_WORKFLOW
                 RulesEngine::Process.auditor.audit(process_id, "Workflow : #{current_workflow} : start next workflow - #{rule_outcome.workflow_code}", RulesEngine::Process::AUDIT_INFO)
                 next_workflow = rule_outcome.workflow_code
                 break

data/lib/rules_engine/rule/definition.rb

@@ -0,0 +1,85 @@
+module RulesEngine  
+  module Rule
+    class Definition
+      def self.inherited(base)
+        base.extend(ClassMethods) 
+      end
+
+      module ClassMethods  
+        def rule_class_name
+          self.name.classify
+        end
+      end
+
+      ##################################################################
+      # class options
+      class_inheritable_accessor :options
+      @@options = {
+        # :group          => "The group the rule belongs to",
+        # :display_name   => "name to use on forms and views",
+        # :help_partial   => "the help html.erb template",
+        # :new_partial    => "the new html.erb template",
+        # :edit_partial   => "the edit html.erb template"
+      }
+
+      ##################################################################
+      # set the rule data
+      def data= data      
+      end
+
+      ##################################################################
+      # get the rule attributes
+      def title
+        return nil
+      end
+    
+      def summary
+        return nil
+      end
+    
+      def data
+        return nil
+      end
+    
+      def expected_outcomes
+        [:outcome => RulesEngine::Rule::Outcome::NEXT]
+      end
+    
+      ##################################################################
+      # set the rule attributes
+      def attributes=(params)
+      end
+
+      ##################################################################
+      # validation and errors
+      def valid?
+        true
+      end
+
+      def errors
+        @errors ||= {}
+        return @errors
+      end    
+
+      ##################################################################
+      # callbacks when the rule is added and removed from a workflow
+      def after_add_to_workflow(workflow_code)
+      end
+    
+      def before_remove_from_workflow(workflow_code)
+      end
+    
+      ##################################################################
+      # execute the rule
+      # return an RulesEngine::Rule::Outcome object to define what to do next
+      # if nil to continue to the next rule
+      def process(process_id, data)
+        # process.audit("process #{title}", RulesEngine::Process::AUDIT_INFO)                        
+        # RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::STOP_SUCCESS)
+        # RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::STOP_FAILURE)
+        # RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::START_WORKFLOW, 'next_workflow')
+        RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::NEXT)
+      end      
+    end
+  end  
+end

data/lib/rules_engine/rule/outcome.rb

@@ -0,0 +1,19 @@
+module RulesEngine  
+  module Rule
+    class Outcome
+    
+      def initialize(outcome, workflow_code = nil)
+        @outcome = outcome
+        @workflow_code = workflow_code
+      end
+
+      NEXT  =            0
+      STOP_SUCCESS  =    1
+      STOP_FAILURE  =    2
+      START_WORKFLOW  =  3
+
+      attr_accessor :outcome
+      attr_accessor :workflow_code    
+    end
+  end  
+end

data/rails_generators/manifests/complex.rb

@@ -0,0 +1,30 @@
+class ComplexManifest
+  def self.populate_record(m, rule_name ,rule_class)
+
+    %W(
+      app/rules
+      app/views/re_rule_definitions/#{rule_name}
+      lib/tasks
+      spec/lib/rules
+    ).each do |dirname|
+      m.directory dirname
+    end
+
+    %W(
+    ).each do |filename|
+      m.file filename, filename
+    end
+
+   m.template "app/rules/complex.rb",  "app/rules/#{rule_name}.rb"
+   m.template "app/views/re_rule_definitions/complex/_edit.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_edit.html.erb"
+   m.template "app/views/re_rule_definitions/complex/_help.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_help.html.erb"
+   m.template "app/views/re_rule_definitions/complex/_new.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_new.html.erb"
+   m.template "app/views/re_rule_definitions/complex/_script.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_script.html.erb"
+   m.template "app/views/re_rule_definitions/complex/_title.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_title.html.erb"
+   m.template "app/views/re_rule_definitions/complex/_word.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_word.html.erb"
+   m.template "app/views/re_rule_definitions/complex/_words.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_words.html.erb"
+   m.template "app/views/re_rule_definitions/complex/_workflow.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_workflow.html.erb"
+   m.template "spec/lib/rules/complex_spec.rb",  "spec/lib/rules/#{rule_name}_spec.rb"
+
+  end
+end

data/rails_generators/manifests/complex.yml

@@ -0,0 +1,24 @@
+directories :
+  - app/rules
+  - spec/lib/rules
+  - lib/tasks
+
+templates :
+  replacements :
+    - complex : rule_name
+    - Complex : rule_class
+    
+  directories : 
+    - app/views/re_rule_definitions/complex
+
+  files : 
+    - app/rules/complex.rb
+    - app/views/re_rule_definitions/complex/_edit.html.erb
+    - app/views/re_rule_definitions/complex/_help.html.erb
+    - app/views/re_rule_definitions/complex/_workflow.html.erb
+    - app/views/re_rule_definitions/complex/_script.html.erb
+    - app/views/re_rule_definitions/complex/_title.html.erb
+    - app/views/re_rule_definitions/complex/_new.html.erb
+    - app/views/re_rule_definitions/complex/_word.html.erb
+    - app/views/re_rule_definitions/complex/_words.html.erb
+    - spec/lib/rules/complex_spec.rb

data/rails_generators/manifests/simple.rb

@@ -0,0 +1,26 @@
+class SimpleManifest
+  def self.populate_record(m, rule_name ,rule_class)
+
+    %W(
+      app/rules
+      app/views/re_rule_definitions/#{rule_name}
+      lib/tasks
+      spec/lib/rules
+    ).each do |dirname|
+      m.directory dirname
+    end
+
+    %W(
+    ).each do |filename|
+      m.file filename, filename
+    end
+
+   m.template "app/rules/simple.rb",  "app/rules/#{rule_name}.rb"
+   m.template "app/views/re_rule_definitions/simple/_edit.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_edit.html.erb"
+   m.template "app/views/re_rule_definitions/simple/_form.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_form.html.erb"
+   m.template "app/views/re_rule_definitions/simple/_help.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_help.html.erb"
+   m.template "app/views/re_rule_definitions/simple/_new.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_new.html.erb"
+   m.template "spec/lib/rules/simple_spec.rb",  "spec/lib/rules/#{rule_name}_spec.rb"
+
+  end
+end

data/rails_generators/manifests/simple.yml

@@ -0,0 +1,21 @@
+directories :
+  - app/rules
+  - spec/lib/rules
+  - lib/tasks
+
+templates :
+  replacements :
+    - simple : rule_name
+    - RuleSimple : rule_class
+    
+  directories : 
+    - app/views/re_rule_definitions/simple
+
+  files : 
+    - app/rules/simple.rb
+    - app/views/re_rule_definitions/simple/_edit.html.erb
+    - app/views/re_rule_definitions/simple/_help.html.erb
+    - app/views/re_rule_definitions/simple/_new.html.erb
+    - app/views/re_rule_definitions/simple/_form.html.erb
+    - spec/lib/rules/simple_spec.rb
+  

data/rails_generators/rules_engine_generator.rb

@@ -21,8 +21,8 @@ class RulesEngineGenerator < Rails::Generator::Base
       puts ''
     end
     if @rule_name.nil?    
-      puts 'run >script/generate rules_engine rule_simple [rule name]'
-      puts 'run >script/generate rules_engine rule_complex [rule name]'
+      puts 'run >script/generate rules_engine simple [rule name]'
+      puts 'run >script/generate rules_engine complex [rule name]'
       puts ''
       puts "or install the rules_engine_templates gem to see other templates"
       puts ''

data/rails_generators/templates/app/models/re_rule.rb

@@ -89,19 +89,19 @@ class ReRule < ActiveRecord::Base
   end
   
   def re_rule_expected_outcome_next
-    re_rule_expected_outcomes.detect{ |re_rule_expected_outcome| re_rule_expected_outcome.outcome == RulesEngine::RuleOutcome::OUTCOME_NEXT }
+    re_rule_expected_outcomes.detect{ |re_rule_expected_outcome| re_rule_expected_outcome.outcome == RulesEngine::Rule::Outcome::NEXT }
   end
   
   def re_rule_expected_outcome_success
-    re_rule_expected_outcomes.detect{ |re_rule_expected_outcome| re_rule_expected_outcome.outcome == RulesEngine::RuleOutcome::OUTCOME_STOP_SUCCESS }
+    re_rule_expected_outcomes.detect{ |re_rule_expected_outcome| re_rule_expected_outcome.outcome == RulesEngine::Rule::Outcome::STOP_SUCCESS }
   end
 
   def re_rule_expected_outcome_failure
-    re_rule_expected_outcomes.detect{ |re_rule_expected_outcome| re_rule_expected_outcome.outcome == RulesEngine::RuleOutcome::OUTCOME_STOP_FAILURE }
+    re_rule_expected_outcomes.detect{ |re_rule_expected_outcome| re_rule_expected_outcome.outcome == RulesEngine::Rule::Outcome::STOP_FAILURE }
   end
 
   def re_rule_expected_outcomes_start_workflow
-    re_rule_expected_outcomes.select{ |re_rule_expected_outcome| re_rule_expected_outcome.outcome == RulesEngine::RuleOutcome::OUTCOME_START_WORKFLOW }
+    re_rule_expected_outcomes.select{ |re_rule_expected_outcome| re_rule_expected_outcome.outcome == RulesEngine::Rule::Outcome::START_WORKFLOW }
   end
 
   protected

data/rails_generators/templates/app/models/re_rule_expected_outcome.rb

@@ -5,7 +5,7 @@ class ReRuleExpectedOutcome < ActiveRecord::Base
   validates_presence_of :outcome  
 
   def validate    
-    if outcome == RulesEngine::RuleOutcome::OUTCOME_START_WORKFLOW && workflow_code.blank?
+    if outcome == RulesEngine::Rule::Outcome::START_WORKFLOW && workflow_code.blank?
       errors.add(:workflow_code, "workflow code required")
     end
   end

data/rails_generators/templates/app/rules/complex.rb

@@ -0,0 +1,133 @@
+module RulesEngine
+  module Rule
+    class <%=rule_class%> < RulesEngine::Rule::Definition
+
+      attr_reader :words
+      attr_reader :workflow_action
+      attr_reader :workflow
+
+      ##################################################################
+      # class options
+      self.options = 
+        {
+          :group => 'General',
+          :display_name => '<%=rule_class%>',    
+          :help_partial => '/re_rule_definitions/<%=rule_name%>/help',
+          :new_partial => '/re_rule_definitions/<%=rule_name%>/new',
+          :edit_partial => '/re_rule_definitions/<%=rule_name%>/edit'
+        } 
+  
+      ##################################################################
+      # set the rule data
+      def data= data
+        if data.nil?
+          @title = nil
+          @words = nil
+          @workflow_action = 'continue'
+          @workflow = nil
+        else
+          @title, @words, @workflow_action, @workflow = ActiveSupport::JSON.decode(data)
+        end  
+      end
+  
+      ##################################################################
+      # get the rule attributes
+      def title
+        @title
+      end
+
+      def summary
+        "Match the #{words.size == 1 ? 'word' : 'words'} #{words.join(', ')}"
+      end
+  
+      def data
+        [title, words, workflow_action, workflow].to_json
+      end
+  
+      def expected_outcomes
+        case workflow_action    
+        when 'next'
+          [:outcome => RulesEngine::Rule::Outcome::NEXT]
+        when 'stop_success'
+          [:outcome => RulesEngine::Rule::Outcome::STOP_SUCCESS]
+        when 'stop_failure'
+          [:outcome => RulesEngine::Rule::Outcome::STOP_FAILURE]
+        when 'start_workflow'
+          [:outcome => RulesEngine::Rule::Outcome::START_WORKFLOW, :workflow_code => workflow]
+        else
+          [:outcome => RulesEngine::Rule::Outcome::NEXT]  
+        end
+      end
+  
+      ##################################################################
+      # set the rule attributes
+      def attributes=(params)
+        param_hash = params.symbolize_keys
+
+        @title = param_hash[:<%=rule_name%>_title]
+    
+        @words = []
+        return if param_hash[:<%=rule_name%>_words].nil?
+        param_hash[:<%=rule_name%>_words].each do |key, values| 
+          if values.is_a?(Hash)
+            word_hash = values.symbolize_keys
+            @words << word_hash[:word].downcase unless word_hash[:word].blank? || word_hash[:_delete] == '1'
+          end  
+        end
+    
+        @workflow_action = param_hash[:<%=rule_name%>_workflow_action] || 'continue'
+        @workflow = param_hash[:<%=rule_name%>_workflow] || ''
+      end
+  
+      ##################################################################
+      # validation and errors
+      def valid?
+        @errors = {}
+        @errors[:<%=rule_name%>_words] = "At least one word must be defined" if words.nil? || words.empty?
+        @errors[:<%=rule_name%>_title] = "Title required" if title.blank?    
+        @errors[:<%=rule_name%>_workflow] = "Workflow required" if workflow_action == 'start_workflow' && workflow.blank?
+        return @errors.empty?
+      end
+
+      ##################################################################
+      # callbacks when the rule is added and removed from a workflow
+      def after_add_to_workflow(workflow_code)
+      end
+  
+      def before_remove_from_workflow(workflow_code)
+      end
+  
+      ##################################################################
+      # execute the rule
+      # if a match is found procees to the expected outcome
+      # it gets the data parameter :tweet
+      # it sets the data parameter :match
+      def process(process_id, data)
+        tweet = data[:tweet] || data["tweet"]    
+        if tweet.blank?
+          return RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::NEXT) 
+        end
+    
+        words.each do |word|
+          if /#{word}/i =~ tweet        
+            RulesEngine::Process.auditor.audit(process_id, "#{title} Found #{word}", RulesEngine::Process::AUDIT_INFO)
+            data[:match] = word
+        
+            case workflow_action
+            when 'stop_success'
+              return RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::STOP_SUCCESS)
+            when 'stop_failure'
+              return RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::STOP_FAILURE)
+            when 'start_workflow'
+              return RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::START_WORKFLOW, workflow)
+            else #'next'
+              return RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::NEXT)
+            end
+          end
+        end
+        
+        RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::NEXT)
+      end  
+    end
+  end  
+end

data/rails_generators/templates/app/rules/simple.rb

@@ -0,0 +1,83 @@
+module RulesEngine
+  module Rule
+    class Simple < RulesEngine::Rule::Definition
+
+      attr_reader :description
+      ##################################################################
+      # class options
+      self.options = 
+        {
+          :group => 'General',
+          :display_name => 'Simple',    
+          :help_partial => '/re_rule_definitions/rule_<%=rule_name%>/help',
+          :new_partial => '/re_rule_definitions/rule_<%=rule_name%>/new',
+          :edit_partial => '/re_rule_definitions/rule_<%=rule_name%>/edit'
+        } 
+  
+      ##################################################################
+      # set the rule data
+      def data= data
+        if data.nil?
+          @title = nil
+          @description = nil
+        else
+          @title, @description = ActiveSupport::JSON.decode(data)
+        end  
+      end
+  
+      ##################################################################
+      # get the rule attributes
+      def title
+        @title
+      end
+  
+      def summary
+        description || "Does Nothing"
+      end
+  
+      def data
+        [title, description].to_json
+      end
+  
+      def expected_outcomes
+        [:outcome => RulesEngine::Rule::Outcome::NEXT]
+      end
+  
+      ##################################################################
+      # set the rule attributes
+      def attributes=(params)
+        param_hash = params.symbolize_keys
+
+        @title = param_hash[:rule_<%=rule_name%>_title]
+        @description = param_hash[:rule_<%=rule_name%>_description]
+      end
+  
+      ##################################################################
+      # validation and errors
+      def valid?
+        @errors = {}
+        @errors[:rule_<%=rule_name%>_title] = "Title required" if title.blank?    
+        return @errors.empty?
+      end
+
+      ##################################################################
+      # callbacks when the rule is added and removed from a workflow
+      def after_add_to_workflow(workflow_code)
+      end
+  
+      def before_remove_from_workflow(workflow_code)
+      end
+  
+      ##################################################################
+      # execute the rule
+      # this rule does nothing
+      def process(process_id, data)
+        RulesEngine::Process.auditor.audit(process_id, "Inside Rule #{title}", RulesEngine::Process::AUDIT_INFO)                        
+        # RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::STOP_SUCCESS)
+        # RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::STOP_FAILURE)
+        # RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::START_WORKFLOW, 'next_workflow')
+        RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::NEXT)
+      end  
+    end
+  end
+end