rules_engine 0.1.3 → 0.1.4

data/lib/rules_engine/rule_outcome.rb

@@ -1,17 +0,0 @@
-module RulesEngine  
-  class RuleOutcome
-    
-    def initialize(outcome, workflow_code = nil)
-      @outcome = outcome
-      @workflow_code = workflow_code
-    end
-
-    OUTCOME_NEXT  =            0
-    OUTCOME_STOP_SUCCESS  =    1
-    OUTCOME_STOP_FAILURE  =    2
-    OUTCOME_START_WORKFLOW  =  3
-
-    attr_accessor :outcome
-    attr_accessor :workflow_code    
-  end
-end

data/rails_generators/manifests/rule_complex.rb

@@ -1,30 +0,0 @@
-class RuleComplexManifest
-  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/rule_complex.rb",  "app/rules/#{rule_name}.rb"
-   m.template "app/views/re_rule_definitions/rule_complex/_edit.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_edit.html.erb"
-   m.template "app/views/re_rule_definitions/rule_complex/_help.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_help.html.erb"
-   m.template "app/views/re_rule_definitions/rule_complex/_new.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_new.html.erb"
-   m.template "app/views/re_rule_definitions/rule_complex/_script.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_script.html.erb"
-   m.template "app/views/re_rule_definitions/rule_complex/_title.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_title.html.erb"
-   m.template "app/views/re_rule_definitions/rule_complex/_word.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_word.html.erb"
-   m.template "app/views/re_rule_definitions/rule_complex/_words.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_words.html.erb"
-   m.template "app/views/re_rule_definitions/rule_complex/_workflow.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_workflow.html.erb"
-   m.template "spec/lib/rules/rule_complex_spec.rb",  "spec/lib/rules/#{rule_name}_spec.rb"
-
-  end
-end

data/rails_generators/manifests/rule_complex.yml

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

data/rails_generators/manifests/rule_simple.rb

@@ -1,26 +0,0 @@
-class RuleSimpleManifest
-  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/rule_simple.rb",  "app/rules/#{rule_name}.rb"
-   m.template "app/views/re_rule_definitions/rule_simple/_edit.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_edit.html.erb"
-   m.template "app/views/re_rule_definitions/rule_simple/_form.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_form.html.erb"
-   m.template "app/views/re_rule_definitions/rule_simple/_help.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_help.html.erb"
-   m.template "app/views/re_rule_definitions/rule_simple/_new.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_new.html.erb"
-   m.template "spec/lib/rules/rule_simple_spec.rb",  "spec/lib/rules/#{rule_name}_spec.rb"
-
-  end
-end

data/rails_generators/manifests/rule_simple.yml

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

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

@@ -1,130 +0,0 @@
-class <%=rule_class%> < RulesEngine::Rule
-
-  attr_reader :words
-  attr_reader :workflow_action
-  attr_reader :workflow
-
-  ##################################################################
-  # class options
-  self.options = 
-    {
-      :group => 'General',
-      :display_name => '<%=rule_class%> Rule',    
-      :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::RuleOutcome::OUTCOME_NEXT]
-    when 'stop_success'
-      [:outcome => RulesEngine::RuleOutcome::OUTCOME_STOP_SUCCESS]
-    when 'stop_failure'
-      [:outcome => RulesEngine::RuleOutcome::OUTCOME_STOP_FAILURE]
-    when 'start_workflow'
-      [:outcome => RulesEngine::RuleOutcome::OUTCOME_START_WORKFLOW, :workflow_code => workflow]
-    else
-      [:outcome => RulesEngine::RuleOutcome::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::RuleOutcome.new(RulesEngine::RuleOutcome::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::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_STOP_SUCCESS)
-        when 'stop_failure'
-          return RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_STOP_FAILURE)
-        when 'start_workflow'
-          return RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_START_WORKFLOW, workflow)
-        else #'next'
-          return RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_NEXT)
-        end
-      end
-    end
-        
-    RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_NEXT)
-  end  
-    
-end

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

@@ -1,79 +0,0 @@
-class <%=rule_class%> < RulesEngine::Rule
-
-  attr_reader :description
-  ##################################################################
-  # class options
-  self.options = 
-    {
-      :group => 'General',
-      :display_name => '<%=rule_class%> Rule',    
-      :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
-      @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::RuleOutcome::OUTCOME_NEXT]
-  end
-  
-  ##################################################################
-  # set the rule attributes
-  def attributes=(params)
-    param_hash = params.symbolize_keys
-
-    @title = param_hash[:<%=rule_name%>_title]
-    @description = param_hash[:<%=rule_name%>_description]
-  end
-  
-  ##################################################################
-  # validation and errors
-  def valid?
-    @errors = {}
-    @errors[:<%=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::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_STOP_SUCCESS)
-    # RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_STOP_FAILURE)
-    # RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_START_WORKFLOW, 'next_workflow')
-    RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_NEXT)
-  end  
-end

data/rails_generators/templates/app/views/re_rule_definitions/rule_simple/_edit.html.erb

@@ -1 +0,0 @@
-<%%= render '/re_rule_definitions/<%=rule_name%>/form' %>

data/rails_generators/templates/app/views/re_rule_definitions/rule_simple/_form.html.erb

@@ -1,16 +0,0 @@
-<%%= re_text_field "<%=rule_class%> Title", 
-                        "<%=rule_name%>_title", 
-                        params[:<%=rule_name%>_title] || @re_rule.rule.title,
-                        :size => 30, 
-                        :required => true, 
-												:error => @re_rule.rule.errors[:<%=rule_name%>_title],
-                        :span => '4x13' %>
-
-
-<%%= re_text_field "Description", 
-                        "<%=rule_name%>_description", 
-                        params[:<%=rule_name%>_description] || @re_rule.rule.description,
-                        :size => 40, 
-                        :required => false, 
-												:error => @re_rule.rule.errors[:<%=rule_name%>_description],
-                        :span => '4x13' %>

data/rails_generators/templates/app/views/re_rule_definitions/rule_simple/_help.html.erb

@@ -1 +0,0 @@
-<p> <%=rule_class%> : This rule does nothing </p>

data/rails_generators/templates/app/views/re_rule_definitions/rule_simple/_new.html.erb

@@ -1 +0,0 @@
-<%%= render '/re_rule_definitions/<%=rule_name%>/form' %>

data/rails_generators/templates/spec/lib/rules/rule_simple_spec.rb

@@ -1,161 +0,0 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
-
-describe <%=rule_class%> do
-
-  def valid_attributes
-    {
-      :<%=rule_name%>_title => 'Valid Title'
-      # :<%=rule_name%>_description => 'Valid Description'
-    }
-  end
-  
-  def valid_json_data
-    '["Valid Title", "Valid Description"]'
-  end
-  
-  it "should be discoverable" do
-    RulesEngine::Discovery.rule_class("<%=rule_class%>").should == <%=rule_class%>
-  end
-
-  describe "the expected class options" do    
-    it "should be in the 'General' group" do
-      <%=rule_class%>.options[:group].should == "General"
-    end
-    
-    it "should have the diplay name of '<%=rule_class%> Rule'" do
-      <%=rule_class%>.options[:display_name].should == "<%=rule_class%> Rule"
-    end
-
-    it "should have the help template of '/re_rule_definitions/<%=rule_name%>/help'" do
-      <%=rule_class%>.options[:help_partial].should == '/re_rule_definitions/<%=rule_name%>/help'
-    end
-
-    it "should have the new template of '/re_rule_definitions/<%=rule_name%>/new'" do
-      <%=rule_class%>.options[:new_partial].should == '/re_rule_definitions/<%=rule_name%>/new'
-    end
-
-    it "should have the edit view partial template of '/re_rule_definitions/<%=rule_name%>/edit'" do
-      <%=rule_class%>.options[:edit_partial].should == '/re_rule_definitions/<%=rule_name%>/edit'
-    end
-  end
-  
-  describe "setting the rule data" do
-    before(:each) do
-      @<%=rule_name%> = <%=rule_class%>.new
-      @<%=rule_name%>.data = valid_json_data
-    end  
-    
-    describe "the data is valid" do
-      it "should be valid" do
-        @<%=rule_name%>.should be_valid
-      end
-            
-      it "should set the title" do
-        @<%=rule_name%>.title.should == "Valid Title"        
-      end
-
-      it "should set the description" do
-        @<%=rule_name%>.description.should == "Valid Description"        
-      end
-    end
-
-    describe "the data is nil" do
-      it "should set the title to nil" do
-        @<%=rule_name%>.title.should_not be_nil
-        @<%=rule_name%>.data = nil
-        @<%=rule_name%>.title.should be_nil
-      end
-
-      it "should set the description to nil" do
-        @<%=rule_name%>.title.should_not be_nil
-        @<%=rule_name%>.data = nil
-        @<%=rule_name%>.description.should be_nil
-      end
-    end
-  end
-  
-  describe "the summary" do
-    describe "description set" do
-      it "should be the rule description" do
-        <%=rule_name%> = <%=rule_class%>.new
-        <%=rule_name%>.should_receive(:description).and_return("mock description")
-        <%=rule_name%>.summary.should == "mock description"
-      end
-    end
-    describe "description not set" do
-      it "should be Does Nothing" do
-        <%=rule_name%> = <%=rule_class%>.new
-        <%=rule_name%>.should_receive(:description).and_return(nil)
-        <%=rule_name%>.summary.should == "Does Nothing"
-      end
-    end
-  end
-
-  describe "the data" do
-    it "should be converted to a json string" do
-      <%=rule_name%> = <%=rule_class%>.new
-      <%=rule_name%>.should_receive(:title).and_return("mock title")
-      <%=rule_name%>.should_receive(:description).and_return("mock description")
-      <%=rule_name%>.data.should == '["mock title","mock description"]'
-    end
-  end
-  
-  describe "the expected_outcomes" do
-    it "should be outcome next" do
-      <%=rule_name%> = <%=rule_class%>.new
-      <%=rule_name%>.expected_outcomes.should == [:outcome => RulesEngine::RuleOutcome::OUTCOME_NEXT]
-    end
-  end
-  
-  describe "setting the rule attributes" do
-    before(:each) do
-      @<%=rule_name%> = <%=rule_class%>.new
-    end  
-    
-    it "should be valid with valid attributes" do
-      @<%=rule_name%>.attributes = valid_attributes
-      @<%=rule_name%>.should be_valid
-    end            
-  
-    describe "setting the <%=rule_name%>_title" do
-      it "should set the title" do
-        @<%=rule_name%>.attributes = valid_attributes
-        @<%=rule_name%>.title.should == 'Valid Title'
-      end            
-    
-      it "should not be valid if the '<%=rule_name%>_title' attribute is missing" do
-        @<%=rule_name%>.attributes = valid_attributes.except(:<%=rule_name%>_title)
-        @<%=rule_name%>.should_not be_valid
-        @<%=rule_name%>.errors.should include(:<%=rule_name%>_title)
-      end            
-    
-      it "should not be valid if the '<%=rule_name%>_title' attribute is blank" do
-        @<%=rule_name%>.attributes = valid_attributes.merge(:<%=rule_name%>_title => "")
-        @<%=rule_name%>.should_not be_valid
-        @<%=rule_name%>.errors.should include(:<%=rule_name%>_title)
-      end                
-    end
-
-    describe "setting the <%=rule_name%>_description" do
-      it "should set the description" do
-        @<%=rule_name%>.attributes = valid_attributes.merge(:<%=rule_name%>_description => 'Valid Description')
-        @<%=rule_name%>.description.should == 'Valid Description'
-      end            
-    end
-  end
-  
-  describe "after a rule is created" do
-    # xit "There is nothing to do here"
-  end
-  
-  describe "after a rule is created" do
-    # xit "There is nothing to do here"
-  end
-  
-  describe "processing the rule" do
-    it "should do nothing" do
-      @<%=rule_name%> = <%=rule_class%>.new
-      @<%=rule_name%>.process(1001, {}).outcome.should == RulesEngine::RuleOutcome::OUTCOME_NEXT
-    end        
-  end
-end