rules_engine 0.2.0 → 0.3.0

data/{rails_generators → generators/manifests}/templates/spec/lib/rules/complex_spec.rb

@@ -83,10 +83,10 @@ describe RulesEngine::Rule::<%=rule_class%> do
         @<%=rule_name%>.match_words.should be_nil
       end
 
-      it "should se the workflow action to 'continue'" do
-        @<%=rule_name%>.workflow_action.should_not == 'continue'
+      it "should se the workflow action to 'next'" do
+        @<%=rule_name%>.workflow_action.should_not == 'next'
         @<%=rule_name%>.data = nil
-        @<%=rule_name%>.workflow_action.should == 'continue'
+        @<%=rule_name%>.workflow_action.should == 'next'
       end
       
       it "should set the 'workflow' to nil" do
@@ -229,10 +229,10 @@ describe RulesEngine::Rule::<%=rule_class%> do
         @<%=rule_name%>.workflow_action.should == 'mock action'
       end
 
-      it "should set the workflow action to 'continue' by default" do
+      it "should set the workflow action to 'next' by default" do
         @<%=rule_name%>.attributes = valid_attributes.except(:<%=rule_name%>_workflow_action)        
         @<%=rule_name%>.should be_valid
-        @<%=rule_name%>.workflow_action.should == 'continue'
+        @<%=rule_name%>.workflow_action.should == 'next'
       end
 
       it "should set the workflow_code" do
@@ -335,8 +335,10 @@ describe RulesEngine::Rule::<%=rule_class%> do
   end
 end
 
-describe ReWorkflowRulesController, :type => :controller  do
-  integrate_views
+describe ReWorkflowRulesController  do
+  include RSpec::Rails::ControllerExampleGroup
+  
+  render_views
   
   describe "RulesEngine::Rule::<%=rule_class%>" do
     before(:each) do
@@ -347,43 +349,58 @@ describe ReWorkflowRulesController, :type => :controller  do
       controller.stub!(:rules_engine_reader_access_required).and_return(true)
       controller.stub!(:rules_engine_editor_access_required).and_return(true)
 
-      @re_workflow = ReWorkflow.make
+      @re_workflow = ReWorkflow.create!(:code => "valid code", :title => 'Valid title', :description => 'Test Workflow')
       ReWorkflow.stub!(:find).and_return(@re_workflow)
     end  
   
     describe "<%=rule_name%> rule help" do
       it "should assign the <%=rule_name%> rule class" do
-        get :help, :rule_class_name => "RulesEngine::Rule::<%=rule_class%>"
+        get :help, :re_workflow_id => @re_workflow.id, :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" 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%>_match_words_0_word")
-          with_tag("select#<%=rule_name%>_workflow_action")
-          with_tag("input#<%=rule_name%>_workflow_code")
+        get :new, :re_workflow_id => @re_workflow.id, :rule_class_name => "RulesEngine::Rule::<%=rule_class%>"
+        response.should have_selector("form#re_rule_new_form") do |form|
+          form.should have_selector("input#<%=rule_name%>_title")     
+          form.should have_selector("input#<%=rule_name%>_match_words_0_word")
+          form.should have_selector("select#<%=rule_name%>_workflow_action") do |selector|
+            selector.should have_selector("option", :content => "Continue Next") do |option|
+              option.attr("selected").should_not be_nil
+              option.attr("selected").value.should == "selected"
+            end
+            selector.should have_selector("option", :content => "Stop Success")
+            selector.should have_selector("option", :content => "Stop Failure")
+            selector.should have_selector("option", :content => "Start another Workflow")
+          end  
+          form.should have_selector("input#<%=rule_name%>_workflow_code")
         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)
+        re_rule = ReRule.create!(: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%>_match_words_0_word", :value => 'word one')
-          with_tag("input#<%=rule_name%>_match_words_1_word", :value => 'word two')
-          with_tag("select#<%=rule_name%>_workflow_action", :value => 'start_workflow')
-          with_tag("input#<%=rule_name%>_workflow_code", :value => 'Other Workflow')
+        get :edit, :re_workflow_id => @re_workflow.id, :id => 1001, :rule_class_name => "RulesEngine::Rule::<%=rule_class%>"
+        response.should have_selector("form#re_rule_edit_form") do |form|
+          form.should have_selector("input#<%=rule_name%>_title", :value => 'Rule Title')     
+          form.should have_selector("input#<%=rule_name%>_match_words_0_word", :value => 'word one')
+          form.should have_selector("input#<%=rule_name%>_match_words_1_word", :value => 'word two')
+          form.should have_selector("select#<%=rule_name%>_workflow_action") do |selector|
+            selector.should have_selector("option", :content => "Continue Next")
+            selector.should have_selector("option", :content => "Stop Success")
+            selector.should have_selector("option", :content => "Stop Failure")
+            selector.should have_selector("option", :content => "Start another Workflow") do |option|
+              option.attr("selected").should_not be_nil
+              option.attr("selected").value.should == "selected"
+            end
+          end  
+          form.should have_selector("input#<%=rule_name%>_workflow_code", :value => 'Other Workflow')
         end  
       end
     end

data/{rails_generators → generators/manifests}/templates/spec/lib/rules/simple_spec.rb

@@ -4,7 +4,7 @@ def valid_<%=rule_name%>_rule_data
   '["Rule Title", "Rule Description"]'
 end
   
-describe RulesEngine::Rule::Simple do
+describe RulesEngine::Rule::<%=rule_class%> do
 
   def valid_attributes
     {
@@ -14,34 +14,34 @@ describe RulesEngine::Rule::Simple do
   end
   
   it "should be discoverable" do
-    RulesEngine::Discovery.rule_class("RulesEngine::Rule::Simple").should == RulesEngine::Rule::Simple
+    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::Simple.options[:group].should == "General"
+      RulesEngine::Rule::<%=rule_class%>.options[:group].should == "General"
     end
     
-    it "should have the diplay name of 'Simple'" do
-      RulesEngine::Rule::Simple.options[:display_name].should == "Simple"
+    it "should have the diplay name of '<%=rule_class%>'" do
+      RulesEngine::Rule::<%=rule_class%>.options[:display_name].should == "<%=rule_class%>"
     end
 
     it "should have the help template of '/re_rules/<%=rule_name%>/help'" do
-      RulesEngine::Rule::Simple.options[:help_partial].should == '/re_rules/<%=rule_name%>/help'
+      RulesEngine::Rule::<%=rule_class%>.options[:help_partial].should == '/re_rules/<%=rule_name%>/help'
     end
 
     it "should have the new template of '/re_rules/<%=rule_name%>/new'" do
-      RulesEngine::Rule::Simple.options[:new_partial].should == '/re_rules/<%=rule_name%>/new'
+      RulesEngine::Rule::<%=rule_class%>.options[:new_partial].should == '/re_rules/<%=rule_name%>/new'
     end
 
     it "should have the edit view partial template of '/re_rules/<%=rule_name%>/edit'" do
-      RulesEngine::Rule::Simple.options[:edit_partial].should == '/re_rules/<%=rule_name%>/edit'
+      RulesEngine::Rule::<%=rule_class%>.options[:edit_partial].should == '/re_rules/<%=rule_name%>/edit'
     end
   end
   
   describe "setting the rule data" do
     before(:each) do
-      @<%=rule_name%> = RulesEngine::Rule::Simple.new
+      @<%=rule_name%> = RulesEngine::Rule::<%=rule_class%>.new
       @<%=rule_name%>.data = valid_<%=rule_name%>_rule_data
     end  
     
@@ -77,14 +77,14 @@ describe RulesEngine::Rule::Simple do
   describe "the summary" do
     describe "description set" do
       it "should be the rule description" do
-        <%=rule_name%> = RulesEngine::Rule::Simple.new
+        <%=rule_name%> = RulesEngine::Rule::<%=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%> = RulesEngine::Rule::Simple.new
+        <%=rule_name%> = RulesEngine::Rule::<%=rule_class%>.new
         <%=rule_name%>.should_receive(:description).and_return(nil)
         <%=rule_name%>.summary.should == "Does Nothing"
       end
@@ -93,7 +93,7 @@ describe RulesEngine::Rule::Simple do
 
   describe "the data" do
     it "should be converted to a json string" do
-      <%=rule_name%> = RulesEngine::Rule::Simple.new
+      <%=rule_name%> = RulesEngine::Rule::<%=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"]'
@@ -102,14 +102,14 @@ describe RulesEngine::Rule::Simple do
   
   describe "the expected_outcomes" do
     it "should be outcome next" do
-      <%=rule_name%> = RulesEngine::Rule::Simple.new
+      <%=rule_name%> = RulesEngine::Rule::<%=rule_class%>.new
       <%=rule_name%>.expected_outcomes[0][:outcome].should == RulesEngine::Rule::Outcome::NEXT
     end
   end
   
   describe "setting the rule attributes" do
     before(:each) do
-      @<%=rule_name%> = RulesEngine::Rule::Simple.new
+      @<%=rule_name%> = RulesEngine::Rule::<%=rule_class%>.new
     end  
     
     it "should be valid with valid attributes" do
@@ -158,17 +158,19 @@ describe RulesEngine::Rule::Simple do
   
   describe "processing the rule" do
     it "should do nothing" do
-      @<%=rule_name%> = RulesEngine::Rule::Simple.new
+      @<%=rule_name%> = RulesEngine::Rule::<%=rule_class%>.new
       @<%=rule_name%>.process(1001, {:plan => "plan"}, {}).outcome.should == RulesEngine::Rule::Outcome::NEXT
     end        
   end
 end
 
 
-describe ReWorkflowRulesController, :type => :controller  do
-  integrate_views
+describe ReWorkflowRulesController  do
+  include RSpec::Rails::ControllerExampleGroup
   
-  describe "RulesEngine::Rule::Simple" do
+  render_views
+  
+  describe "RulesEngine::Rule::<%=rule_class%>" do
   
     before(:each) do
       controller.instance_eval { flash.stub!(:sweep) }
@@ -178,38 +180,37 @@ describe ReWorkflowRulesController, :type => :controller  do
       controller.stub!(:rules_engine_reader_access_required).and_return(true)
       controller.stub!(:rules_engine_editor_access_required).and_return(true)
 
-      @re_workflow = ReWorkflow.make
+      @re_workflow = ReWorkflow.create!(:code => "valid code", :title => 'Valid title', :description => 'Test Workflow')
       ReWorkflow.stub!(:find).and_return(@re_workflow)
     end  
   
     describe "help" do
       it "should assign the <%=rule_name%> rule class" do
-        get :help, :rule_class_name => "RulesEngine::Rule::Simple"
-        assigns[:rule_class].should == RulesEngine::Rule::Simple
+        get :help, :re_workflow_id => @re_workflow.id, :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" do
-        get :new, :rule_class_name => "RulesEngine::Rule::Simple"
-        response.should have_tag("form#re_rule_new_form") do
-          with_tag("input#<%=rule_name%>_title")
-          with_tag("input#<%=rule_name%>_description")      
+        get :new, :re_workflow_id => @re_workflow.id, :rule_class_name => "RulesEngine::Rule::<%=rule_class%>"
+        response.should have_selector("form#re_rule_new_form") do |form|
+          form.should have_selector("input#<%=rule_name%>_title")
+          form.should have_selector("input#<%=rule_name%>_description")      
         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::Simple",
-                              :data => valid_<%=rule_name%>_rule_data)
+        re_rule = ReRule.create!(: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::Simple"
-        response.should have_tag("form#re_rule_edit_form") do
-          with_tag("input#<%=rule_name%>_title", :value => 'Rule Title')     
-          with_tag("input#<%=rule_name%>_description", :value => 'Rule Description')     
+        get :edit, :re_workflow_id => @re_workflow.id, :id => 1001, :rule_class_name => "RulesEngine::Rule::<%=rule_class%>"
+        response.should have_selector("form#re_rule_edit_form") do |form|
+          form.should have_selector("input#<%=rule_name%>_title", :value => 'Rule Title')     
+          form.should have_selector("input#<%=rule_name%>_description", :value => 'Rule Description')     
         end  
       end
     end

data/generators/rule_generator.rb

@@ -0,0 +1,57 @@
+Dir["#{File.dirname(__FILE__)}/manifests/*.rb"].each {|f| require f}
+
+module RulesEngine
+  module Generators
+
+    class RuleGenerator < Rails::Generators::Base
+  
+      source_root File.expand_path(File.dirname(__FILE__) + "/manifests/templates")      
+  
+      def initialize(runtime_args, *runtime_options)
+        super
+        @rule_type = runtime_args[0] unless runtime_args.length < 1
+        @rule_name = runtime_args[1].downcase.gsub(/[^a-zA-Z0-9]+/i, '_') unless runtime_args.length < 2
+        @rule_class = @rule_name.camelize unless runtime_args.length < 2
+      end
+  
+      def install
+        if @rule_type.blank? || @rule_name.blank? 
+          puts "    ***************** rule_type and rule_name required ***************** "
+        else  
+          begin
+            manifest = Kernel.const_get("#{@rule_type.classify}Manifest")
+            manifest.populate_record(self, @rule_name)
+          rescue
+            puts "    ***************** Failed to generate rule #{@rule_type.classify}Manifest ***************** "  
+          end  
+        end
+        puts RuleGenerator.description
+      end
+  
+      def self.description
+        <<-DESCRIPTION 
+        *******************************************************************    
+        To create a new rule from the simple or complex templates
+        > rails generate rules_engine:rule [rule_type : simple|complex] [rule_name: new_rule_name]    
+        Example : 
+        > rails generate rules_engine:rule simple my_simple_rule
+    
+        Or to see other rule templates install the rules_engine_templates gem
+        > gem install rules_engine_templates
+        *******************************************************************    
+        DESCRIPTION
+      end      
+  
+      desc(description)
+
+      protected
+        def rule_name
+          @rule_name
+        end
+
+        def rule_class
+          @rule_class
+        end
+    end      
+  end
+end    

data/init.rb

@@ -1 +1 @@
-require File.expand_path(File.dirname(__FILE__) + "/lib/rules_engine")
+require "rules_engine"

data/lib/rules_engine.rb

@@ -1,8 +1,13 @@
-require File.expand_path(File.dirname(__FILE__) + "/rules_engine/discovery")
-require File.expand_path(File.dirname(__FILE__) + "/rules_engine/rule/definition")
-require File.expand_path(File.dirname(__FILE__) + "/rules_engine/rule/outcome")
+require 'rules_engine/discovery'
+require 'rules_engine/rule/definition'
+require '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")
-require File.expand_path(File.dirname(__FILE__) + "/rules_engine/process/auditor")
-require File.expand_path(File.dirname(__FILE__) + "/rules_engine/process/runner")
+require 'rules_engine/cache'
+require 'rules_engine/publish/publisher'
+require 'rules_engine/process/auditor'
+require 'rules_engine/process/runner'
+
+if defined?(Rails)
+  require File.expand_path(File.dirname(__FILE__) + "/rules_engine_view") 
+  require File.expand_path(File.dirname(__FILE__) + "/rules_engine/engine")
+end  

data/lib/rules_engine/engine.rb

@@ -0,0 +1,33 @@
+require "rules_engine"
+require "rails"
+
+module RulesEngine
+  class Engine < Rails::Engine
+      
+    initializer "rules_engine.action_view" do |app|
+      ActionView::Base.send(:include, RulesEngineView::Alerts)
+      ActionView::Base.send(:include, RulesEngineView::Boxes)
+      ActionView::Base.send(:include, RulesEngineView::Buttons)
+      ActionView::Base.send(:include, RulesEngineView::Navigate)
+      ActionView::Base.send(:include, RulesEngineView::Defer)
+      
+      ActionView::Base.send(:include, RulesEngineView::FormStyles)
+      ActionView::Base.send(:include, RulesEngineView::FormFields)
+      ActionView::Base.send(:include, RulesEngineView::FormBuilderView)          
+    end
+
+    initializer "rules_engine.action_controller" do |app|
+      ActionController::Base.send(:include, RulesEngineView::ModelLoader)
+    end
+
+    rake_tasks do
+      load File.expand_path(File.dirname(__FILE__) + "./../../tasks/rules_engine.rake")
+    end    
+    
+    generators do
+      require File.expand_path(File.dirname(__FILE__) + "./../../generators/install_generator")
+      require File.expand_path(File.dirname(__FILE__) + "./../../generators/layout_generator")
+      require File.expand_path(File.dirname(__FILE__) + "./../../generators/rule_generator")
+    end    
+  end
+end

data/lib/rules_engine/process/auditor/db_auditor.rb

@@ -4,8 +4,8 @@ module RulesEngine
   
       validates_presence_of :code
     
-      named_scope :by_process_id, lambda {|process_id| {:conditions => ['process_id = ?', process_id]} }
-      named_scope :order_created_at, lambda {|order| {:order => "created_at #{order}, id #{order}"} }
+      scope :by_process_id, lambda {|process_id| where('process_id = ?', process_id)}
+      scope :order_created_at, lambda {|order| order("created_at #{order}, id #{order}") }
       
       def self.history(process_id, options = {})
         klass = self

data/lib/rules_engine/process/runner/db_runner.rb

@@ -6,9 +6,9 @@ module RulesEngine
     class ReProcessRun < ActiveRecord::Base
       validates_presence_of :process_status
       
-      named_scope :by_plan_code, lambda {|plan_code| {:conditions => ['plan_code = ?', plan_code]} }
-      named_scope :by_process_status_gt, lambda {|process_status| {:conditions => "process_status > #{process_status}"} }
-      named_scope :order_started_at, lambda {|order| {:order => "started_at #{order}, id #{order}"} }
+      scope :by_plan_code, lambda {|plan_code| where('plan_code = ?', plan_code) }
+      scope :by_process_status_gt, lambda {|process_status| where("process_status > #{process_status}") }
+      scope :order_started_at, lambda {|order| order("started_at #{order}, id #{order}") }
       
       def self.history(plan_code, options = {})
 
@@ -16,7 +16,7 @@ module RulesEngine
         klass = klass.by_plan_code(plan_code) unless plan_code.nil?
         klass = klass.by_process_status_gt(RulesEngine::Process::PROCESS_STATUS_NONE)
         klass = klass.order_started_at('DESC')
-        
+                
         klass.paginate({:page => 1, :per_page => 10}.merge(options))
       end
     end

data/lib/rules_engine/publish/publisher/db_publisher.rb

@@ -2,9 +2,9 @@ module RulesEngine
   module Publish
     
     class RePublishedPlan < ActiveRecord::Base
-      named_scope :by_plan_code, lambda {|plan_code| {:conditions => ['plan_code = ?', plan_code]} }
-      named_scope :by_plan_version, lambda {|plan_version| {:conditions => ['plan_version = ?', plan_version]} }
-      named_scope :order_plan_version, lambda {|order| {:order => "plan_version #{order}"} }
+      scope :by_plan_code, lambda {|plan_code| where('plan_code = ?', plan_code) }
+      scope :by_plan_version, lambda {|plan_version| where('plan_version = ?', plan_version) }
+      scope :order_plan_version, lambda {|order| order("plan_version #{order}") }
 
       def self.plan(plan_code, options = {})
         klass = self
@@ -86,7 +86,7 @@ module RulesEngine
       
         def get_plan_without_caching(plan_code, plan_version = nil)
           re_plan = RePublishedPlan.plan(plan_code, {:version => plan_version})
-          re_plan.nil? ? nil : JSON.parse(re_plan.data)
+          re_plan.nil? ? nil : ActiveSupport::JSON.backend.decode(re_plan.data)
         end
     end  
   end