rules_engine_templates 0.0.2 → 0.0.3

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

@@ -0,0 +1,84 @@
+module RulesEngine
+  module Rule
+    class <%=rule_class%> < RulesEngine::Rule::Definition
+
+      attr_reader :workflow
+
+      ##################################################################
+      # class options
+      self.options = 
+        {
+          :group => 'Workflow',
+          :display_name => 'Workflow Start',    
+          :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
+          @workflow = nil
+        else
+          @title, @workflow = ActiveSupport::JSON.decode(data)
+        end  
+      end
+  
+      ##################################################################
+      # get the rule attributes
+      def title
+        @title
+      end
+
+      def summary
+        "Start the workflow : #{workflow}"
+      end
+  
+      def data
+        [title, workflow].to_json
+      end
+  
+      def expected_outcomes
+        [:outcome => RulesEngine::Rule::Outcome::START_WORKFLOW, :workflow_code => workflow]
+      end
+  
+      ##################################################################
+      # set the rule attributes
+      def attributes=(params)
+        param_hash = params.symbolize_keys
+
+        @title = param_hash[:<%=rule_name%>_title]
+        @workflow = param_hash[:<%=rule_name%>_workflow]
+      end
+  
+      ##################################################################
+      # validation and errors
+      def valid?
+        @errors = {}
+        @errors[:<%=rule_name%>_title] = "Title required" if title.blank?    
+        @errors[:<%=rule_name%>_workflow] = "Workflow required" if workflow.blank?
+        return @errors.empty?
+      end
+
+      ##################################################################
+      # callbacks when the rule is added and removed from a workflow
+      def before_create()
+      end
+  
+      def before_update()
+      end
+      
+      def before_destroy()
+      end
+  
+      ##################################################################
+      # execute the rule
+      # start the workflow
+      def process(process_id, data)
+        return RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::START_WORKFLOW, workflow)
+      end  
+    end
+  end
+end  

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

@@ -0,0 +1,80 @@
+module RulesEngine
+  module Rule
+    class <%=rule_class%> < RulesEngine::Rule::Definition
+
+      attr_reader :description
+      ##################################################################
+      # class options
+      self.options = 
+        {
+          :group => 'Workflow',
+          :display_name => 'Workflow Stop',    
+          :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::Rule::Outcome::STOP_SUCCESS]
+      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 before_add_to_workflow()
+      end
+  
+      def before_remove_from_workflow()
+      end
+  
+      ##################################################################
+      # execute the rule
+      # this rule stops the plan
+      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)
+      end  
+    end
+  end
+end  

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

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

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

@@ -0,0 +1,21 @@
+<%% javascript_tag do %>
+  
+  $(document).ready(function() {	
+    $('#<%=rule_name%>_title').focus();	
+  });
+
+<%% end %>
+
+<%%= re_text_field "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 "Plan Code", "<%=rule_name%>_plan", @re_rule.rule.plan || params[:<%=rule_name%>_plan], 
+																:size => 20, 
+																:required => true, 
+																:span => '4x13',
+																:error => @re_rule.rule.errors[:<%=rule_name%>_plan] %>

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

@@ -0,0 +1 @@
+<p>Run the plan passing the data to the new plan</p>

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

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

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

@@ -1,5 +1 @@
-<%%= render '/re_rule_definitions/<%=rule_name%>/script' %>
-
-<%%= render '/re_rule_definitions/<%=rule_name%>/title' %>
-
-<%%= render '/re_rule_definitions/<%=rule_name%>/words', :f => f %>
+<%%= render '/re_rule_definitions/<%=rule_name%>/form', :f => f %>

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

@@ -0,0 +1,34 @@
+<%% javascript_tag do %>
+  var new_<%=rule_name%> = '<%%=escape_javascript(render("/re_rule_definitions/<%=rule_name%>/form_word"))%>'  
+  
+  $(document).ready(function() {	
+    $('#<%=rule_name%>_title').focus();	
+  });
+
+<%% end %>
+
+
+<%%= re_text_field "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' %>
+
+<%% position = 0 %>
+<%% (@re_rule.rule.words || []).each do | word | %>  
+  <%% f.fields_for :rule_data, {:first => false} do |frd| %>
+    <%%= render '/re_rule_definitions/<%=rule_name%>/form_word', :f => frd, :position => position, :word => word %>
+    <%% position += 1 %>        
+  <%% end %>
+<%% end %>  
+<%% if position == 0 %>
+  <%% f.fields_for :rule_data, {:first => false} do |frd| %>
+    <%%= render '/re_rule_definitions/<%=rule_name%>/form_word', :f => frd, :position => position %>      
+  <%% end %>
+<%% end %>
+
+<div id="new_position_<%=rule_name%>"></div>
+<%%= re_form_text "", re_add_link('Add another word to filter', '<%=rule_name%>') %>    
+

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

@@ -1 +1 @@
-<p>Twitter Filter : This will filter out any tweets with the matching text</p>
+<p>This will filter out any tweets with the matching text</p>

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

@@ -1,5 +1 @@
-<%%= render '/re_rule_definitions/<%=rule_name%>/script' %>
-
-<%%= render '/re_rule_definitions/<%=rule_name%>/title' %>
-
-<%%= render '/re_rule_definitions/<%=rule_name%>/words', :f => f %>
+<%%= render '/re_rule_definitions/<%=rule_name%>/form', :f => f %>

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

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

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

@@ -0,0 +1,29 @@
+<%% javascript_tag do %>
+  
+  $(document).ready(function() {	
+    $('#<%=rule_name%>_title').focus();	
+  });
+
+<%% end %>
+
+<%%= re_text_field "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 "Message", 
+                        "<%=rule_name%>_message", 
+                        params[:<%=rule_name%>_message] || @re_rule.rule.message,
+                        :size => 60, 
+                        :required => true, 
+												:error => @re_rule.rule.errors[:<%=rule_name%>_message],
+                        :span => '4x13' %>
+
+<%%= re_text_field "Plan Code", "<%=rule_name%>_plan", @re_rule.rule.plan || params[:<%=rule_name%>_plan], 
+																:size => 20, 
+																:required => true, 
+																:span => '4x13',
+																:error => @re_rule.rule.errors[:<%=rule_name%>_plan] %>

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

@@ -0,0 +1 @@
+<p>This read the tweet message and send each tweet to the defined plan</p>

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

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

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

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

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

@@ -0,0 +1,21 @@
+<%% javascript_tag do %>
+  
+  $(document).ready(function() {	
+    $('#<%=rule_name%>_title').focus();	
+  });
+
+<%% end %>
+
+<%%= re_text_field "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 "Workflow Code", "<%=rule_name%>_workflow", @re_rule.rule.workflow || params[:<%=rule_name%>_workflow], 
+																:size => 20, 
+																:required => true, 
+																:span => '4x13',
+																:error => @re_rule.rule.errors[:<%=rule_name%>_workflow] %>

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

@@ -0,0 +1 @@
+<p>This will start the given workflow</p>

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

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

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

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

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

@@ -0,0 +1,25 @@
+<%% javascript_tag do %>
+  
+  $(document).ready(function() {	
+    $('#<%=rule_name%>_title').focus();	
+  });
+
+<%% end %>
+
+
+<%%= re_text_field "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/workflow_stop/_help.html.erb

@@ -0,0 +1 @@
+<p> stop the workflow and plan </p>

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

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

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

@@ -0,0 +1,237 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+def valid_<%=rule_name%>_rule_data
+  '["Rule Title", "Other Plan"]'
+end
+  
+
+describe RulesEngine::Rule::<%=rule_class%> do
+
+  def valid_attributes
+    {
+      :<%=rule_name%>_title => 'Rule Title',
+      :<%=rule_name%>_plan => 'Next Plan'
+    }
+  end
+  
+  it "should be discoverable" do
+    RulesEngine::Discovery.rule_class("RulesEngine::Rule::<%=rule_class%>").should == RulesEngine::Rule::<%=rule_class%>
+  end
+
+  describe "the expected class options" do    
+    it "should be in the 'General' group" do
+      RulesEngine::Rule::<%=rule_class%>.options[:group].should == "Workflow"
+    end
+    
+    it "should have the diplay name of '<%=rule_class%> Rule'" do
+      RulesEngine::Rule::<%=rule_class%>.options[:display_name].should == "Plan Start"
+    end
+
+    it "should have the help template of '/re_rule_definitions/<%=rule_name%>/help'" do
+      RulesEngine::Rule::<%=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
+      RulesEngine::Rule::<%=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
+      RulesEngine::Rule::<%=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%> = RulesEngine::Rule::<%=rule_class%>.new
+      @<%=rule_name%>.data = valid_<%=rule_name%>_rule_data
+    end  
+    
+    describe "the json 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 == "Rule Title"        
+      end
+
+      it "should set the plan" do
+        @<%=rule_name%>.plan.should == "Other Plan"
+      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 'plan' to nil" do
+        @<%=rule_name%>.plan.should_not be_nil
+        @<%=rule_name%>.data = nil
+        @<%=rule_name%>.plan.should be_nil
+      end              
+    end
+  end
+  
+  describe "the summary" do
+    it "should show the plan" do
+      <%=rule_name%> = RulesEngine::Rule::<%=rule_class%>.new
+      <%=rule_name%>.stub!(:plan).and_return("mock")
+      <%=rule_name%>.summary.should == "Run the plan : mock"
+    end
+  end
+  
+  describe "the data" do
+    it "should be converted to a json string" do
+      <%=rule_name%> = RulesEngine::Rule::<%=rule_class%>.new
+      <%=rule_name%>.should_receive(:title).and_return("mock title")
+      <%=rule_name%>.should_receive(:plan).and_return("plan")
+      <%=rule_name%>.data.should == '["mock title","plan"]'
+    end
+  end
+  
+  describe "the expected_outcomes" do
+    it "should be next and stop failure" do
+      <%=rule_name%> = RulesEngine::Rule::<%=rule_class%>.new
+      <%=rule_name%>.expected_outcomes.should include(:outcome => RulesEngine::Rule::Outcome::NEXT)
+      <%=rule_name%>.expected_outcomes.should include(:outcome => RulesEngine::Rule::Outcome::STOP_FAILURE)
+    end
+  end
+  
+  describe "setting the rule attributes" do
+    before(:each) do
+      @<%=rule_name%> = RulesEngine::Rule::<%=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 == 'Rule 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%>_plan" do
+      it "should be valid with valid '<%=rule_name%>_plan'" do
+        @<%=rule_name%>.attributes = valid_attributes
+        @<%=rule_name%>.should be_valid
+        @<%=rule_name%>.plan.should == 'Next Plan'
+      end            
+      
+      it "should not be valid if the '<%=rule_name%>_plan' attribute is missing" do
+        @<%=rule_name%>.attributes = valid_attributes.except(:<%=rule_name%>_plan)        
+        @<%=rule_name%>.should_not be_valid
+        @<%=rule_name%>.errors.should include(:<%=rule_name%>_plan)
+      end            
+
+      it "should not be valid if the '<%=rule_name%>_plan' attribute is blank" do
+        @<%=rule_name%>.attributes = valid_attributes.merge(:<%=rule_name%>_plan => "")        
+        @<%=rule_name%>.should_not be_valid
+        @<%=rule_name%>.errors.should include(:<%=rule_name%>_plan)
+      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
+    before(:each) do
+      @<%=rule_name%> = RulesEngine::Rule::<%=rule_class%>.new
+      @<%=rule_name%>.stub!(:plan).and_return('sub_plan')
+      
+      RulesEngine::Process.runner.stub!(:create).and_return(1003)
+      RulesEngine::Process.runner.stub!(:run)
+    end
+    
+    it "should create a rules process to run" do
+      RulesEngine::Process.runner.should_receive(:create).and_return(1003)
+      RulesEngine::Process.runner.should_receive(:run).with(1003, 'sub_plan', {:origional => "data"})      
+      @<%=rule_name%>.process(1003, {:origional => "data"})
+    end
+
+    it "should return outcome next if the plan was successful" do
+      RulesEngine::Process.runner.stub!(:run).and_return(true)
+      @<%=rule_name%>.process(1003, {}).outcome.should == RulesEngine::Rule::Outcome::NEXT
+    end
+
+    it "should return outcome stop failure if the plan failed" do
+      RulesEngine::Process.runner.stub!(:run).and_return(false)
+      @<%=rule_name%>.process(1003, {}).outcome.should == RulesEngine::Rule::Outcome::STOP_FAILURE
+    end
+  end
+end
+
+
+describe ReWorkflowRulesController, :type => :controller  do
+  integrate_views
+  
+  before(:each) do
+    controller.instance_eval { flash.stub!(:sweep) }
+
+    RulesEngine::Discovery.discover!
+    
+    controller.stub!(:rules_engine_reader_access_required).and_return(true)
+    controller.stub!(:rules_engine_editor_access_required).and_return(true)
+
+    @re_workflow = ReWorkflow.make
+    ReWorkflow.stub!(:find).and_return(@re_workflow)
+  end  
+  
+  describe "help" do
+    it "should assign the tweet reader_rule class" do
+      get :help, :rule_class_name => "RulesEngine::Rule::<%=rule_class%>"
+      assigns[:rule_class].should == RulesEngine::Rule::<%=rule_class%>
+    end
+  end
+  
+  describe "new" do
+    it "show the new form class" do
+      get :new, :rule_class_name => "RulesEngine::Rule::<%=rule_class%>"
+      response.should have_tag("form#re_rule_new_form") do
+        with_tag("input#<%=rule_name%>_title")
+        with_tag("input#<%=rule_name%>_plan")
+      end  
+    end
+  end
+
+  describe "edit" do
+    it "show the edit form" do
+      re_rule = ReRule.make(:re_workflow_id => @re_workflow.id, 
+                            :rule_class_name => "RulesEngine::Rule::<%=rule_class%>",
+                            :data => valid_<%=rule_name%>_rule_data)
+      ReRule.stub!(:find).and_return(re_rule)
+      
+      get :edit, :re_workflow_id => @re_workflow.id, :re_rule_id => 1001, :rule_class_name => "RulesEngine::Rule::<%=rule_class%>"
+      response.should have_tag("form#re_rule_edit_form") do
+        with_tag("input#<%=rule_name%>_title", :value => 'Rule Title')     
+        with_tag("input#<%=rule_name%>_plan", :value => 'Other Plan')     
+      end  
+    end
+  end
+  
+end
+