rules_engine 0.1.3 → 0.1.4

data/spec/railsenv/log/test.log

@@ -490,3 +490,81 @@
 ***** 1009, 1, Plan : mock_plan : started
 ***** 1009, 3, First Workflow :  : missing
 ***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 3, Process missing
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 3, Process missing
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 3, Process missing
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 3, Process missing
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 3, Process missing
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure
+***** 1009, 3, Process missing
+***** 1009, 1, Plan : mock_plan : started
+***** 1009, 3, First Workflow :  : missing
+***** 1009, 3, Plan : mock_plan : failure

data/spec/rules_engine/discovery_spec.rb

@@ -39,30 +39,40 @@ describe "RulesEngine::Discovery" do
   end
 
   it "should use the rules filename to define the rule class name" do
-    RulesEngine::Discovery.discover!      
-    RulesEngine::Discovery.rule_classes.should include(MockRule)
+    RulesEngine::Discovery.discover!
+    puts RulesEngine::Discovery.rule_classes
+    RulesEngine::Discovery.rule_classes.should include(RulesEngine::Rule::MockRule)
   end
 
   it "should undefine an existing the rule class" do
     RulesEngine::Discovery.discover! 
-    RulesEngine::Discovery.rule_class('MockRule').options.should == {:group=>"mock group"}
-    RulesEngine::Discovery.rule_class('MockRule').options[:name] = "test"
+    RulesEngine::Discovery.rule_class('RulesEngine::Rule::MockRule').options.should == {:group=>"mock group"}
+    RulesEngine::Discovery.rule_class('RulesEngine::Rule::MockRule').options[:name] = "test"
     RulesEngine::Discovery.discover! 
-    RulesEngine::Discovery.rule_class('MockRule').options.should == {:group=>"mock group"}
+    RulesEngine::Discovery.rule_class('RulesEngine::Rule::MockRule').options.should == {:group=>"mock group"}
   end
 
   it "should add the rule to the rule group" do
     RulesEngine::Discovery.discover!      
-    RulesEngine::Discovery.rule_groups['mock group'].should include(MockRule)
+    RulesEngine::Discovery.rule_groups['mock group'].should include(RulesEngine::Rule::MockRule)
   end
   
   it "should return the class that matches the name" do
     RulesEngine::Discovery.discover!      
-    RulesEngine::Discovery.rule_class('MockRule').should == MockRule
+    RulesEngine::Discovery.rule_class('RulesEngine::Rule::MockRule').should == RulesEngine::Rule::MockRule
   end
 
   it "should return nil if the class is unknown" do
     RulesEngine::Discovery.discover!      
     RulesEngine::Discovery.rule_class('unknown').should be_nil
   end
+  
+  describe "the rule class" do
+    it "should have a matching rule_class_name" do
+      RulesEngine::Discovery.discover!      
+      rule = RulesEngine::Discovery.rule_class('RulesEngine::Rule::MockRule')
+      rule.rule_class_name.should == 'RulesEngine::Rule::MockRule'
+    end        
+  end
+  
 end

data/spec/rules_engine/process/runner_spec.rb

@@ -55,7 +55,7 @@ describe "RulesEngine::Process::Runner" do
       @rule_class.stub!(:new).and_return(@rule_class)
       @rule_class.stub!(:title).and_return('mock title')
       @rule_class.stub!(:data=)
-      @rule_class.stub!(:process).and_return(RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_NEXT))
+      @rule_class.stub!(:process).and_return(RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::NEXT))
       RulesEngine::Discovery.stub!(:rule_class).and_return(@rule_class)
 
       RulesEngine::Process.auditor.stub!(:audit)# {|one, two, three| puts two }
@@ -183,7 +183,7 @@ describe "RulesEngine::Process::Runner" do
 
         describe "rule returns NEXT" do
           it "should proceed to the next rule" do
-            @test_rule.stub!(:process).and_return(RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_NEXT))
+            @test_rule.stub!(:process).and_return(RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::NEXT))
             RulesEngine::Discovery.should_receive(:rule_class).with("one_two")
             @runner.run(10001, @plan, {})
           end
@@ -191,39 +191,39 @@ describe "RulesEngine::Process::Runner" do
         
         describe "rule returns STOP_SUCCESS" do
           it "should not proceed to the next rule" do
-            @test_rule.stub!(:process).and_return(RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_STOP_SUCCESS))
+            @test_rule.stub!(:process).and_return(RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::STOP_SUCCESS))
             RulesEngine::Discovery.should_not_receive(:rule_class).with("one_two")
             @runner.run(10001, @plan, {})
           end
 
           it "should return success" do
-            @test_rule.stub!(:process).and_return(RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_STOP_SUCCESS))
+            @test_rule.stub!(:process).and_return(RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::STOP_SUCCESS))
             @runner.run(10001, @plan, {}) == true
           end
         end
 
         describe "rule returns STOP_FAILURE" do
           it "should not proceed to the next rule" do
-            @test_rule.stub!(:process).and_return(RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_STOP_FAILURE))
+            @test_rule.stub!(:process).and_return(RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::STOP_FAILURE))
             RulesEngine::Discovery.should_not_receive(:rule_class).with("one_two")
             @runner.run(10001, @plan, {})
           end
 
           it "should return failure" do
-            @test_rule.stub!(:process).and_return(RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_STOP_FAILURE))
+            @test_rule.stub!(:process).and_return(RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::STOP_FAILURE))
             @runner.run(10001, @plan, {}) == false
           end
         end
 
         describe "rule returns START_WORKFLOW" do
           it "should not proceed to the next rule" do
-            @test_rule.stub!(:process).and_return(RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_START_WORKFLOW, 'three'))
+            @test_rule.stub!(:process).and_return(RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::START_WORKFLOW, 'three'))
             RulesEngine::Discovery.should_not_receive(:rule_class).with("one_two")
             @runner.run(10001, @plan, {})
           end
 
           it "should start the defined workflow" do
-            @test_rule.stub!(:process).and_return(RulesEngine::RuleOutcome.new(RulesEngine::RuleOutcome::OUTCOME_START_WORKFLOW, 'three'))
+            @test_rule.stub!(:process).and_return(RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::START_WORKFLOW, 'three'))
             RulesEngine::Discovery.should_not_receive(:rule_class).with("two_one")
             RulesEngine::Discovery.should_receive(:rule_class).with("three_one")
             @runner.run(10001, @plan, {})

data/spec/rules_engine/{rule_spec.rb → rule/definition_spec.rb}

@@ -1,9 +1,9 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
-class MockRule < RulesEngine::Rule
+class MockRule < RulesEngine::Rule::Definition
 end
 
-describe "RulesEngine::Rule" do
+describe "RulesEngine::Rule::Definition" do
   it "should add a class method rule_class_name" do
     MockRule.methods.should include("rule_class_name")
   end
@@ -13,32 +13,32 @@ describe "RulesEngine::Rule" do
   end
 
   it "should be able to set the attribute 'data'" do
-    RulesEngine::Rule.new.methods.should include("data=")
+    RulesEngine::Rule::Definition.new.methods.should include("data=")
   end
 
   describe "title" do
     it "should be nil by default" do
-      RulesEngine::Rule.new.title.should be_nil
+      RulesEngine::Rule::Definition.new.title.should be_nil
     end
   end
   
   describe "summary" do
     it "should be nil by default" do
-      RulesEngine::Rule.new.summary.should be_nil
+      RulesEngine::Rule::Definition.new.summary.should be_nil
     end
   end
   
   describe "data" do
     it "should be nil by default" do
-      RulesEngine::Rule.new.data.should be_nil
+      RulesEngine::Rule::Definition.new.data.should be_nil
     end
   end
   
   describe "expected_outcomes" do
     it "should be set the default as NEXT" do
-      RulesEngine::Rule.new.expected_outcomes.should be_instance_of(Array)
-      RulesEngine::Rule.new.expected_outcomes[0][:outcome].should == RulesEngine::RuleOutcome::OUTCOME_NEXT
-      RulesEngine::Rule.new.expected_outcomes[0][:workflow_code].should be_nil
+      RulesEngine::Rule::Definition.new.expected_outcomes.should be_instance_of(Array)
+      RulesEngine::Rule::Definition.new.expected_outcomes[0][:outcome].should == RulesEngine::Rule::Outcome::NEXT
+      RulesEngine::Rule::Definition.new.expected_outcomes[0][:workflow_code].should be_nil
     end
   end
   
@@ -50,26 +50,26 @@ describe "RulesEngine::Rule" do
 
   describe "errors" do
     it "should be a hash" do
-      RulesEngine::Rule.new.errors.should be_instance_of(Hash)
-      rule = RulesEngine::Rule.new 
+      RulesEngine::Rule::Definition.new.errors.should be_instance_of(Hash)
+      rule = RulesEngine::Rule::Definition.new 
     end    
   end
 
   it "should have the helper function 'after_add_to_workflow' to tell the rule has been added to a workflow" do
-    RulesEngine::Rule.new.methods.should include("after_add_to_workflow")
+    RulesEngine::Rule::Definition.new.methods.should include("after_add_to_workflow")
   end
 
   it "should have the helper function 'before_remove_from_workflow' to tell the rule is about to be removed from a workflow" do
-    RulesEngine::Rule.new.methods.should include("before_remove_from_workflow")
+    RulesEngine::Rule::Definition.new.methods.should include("before_remove_from_workflow")
   end
   
   describe "processing a rule" do
     it "should return a rule_outcome" do
-      MockRule.new.process(101, {}).should be_instance_of(RulesEngine::RuleOutcome)
+      MockRule.new.process(101, {}).should be_instance_of(RulesEngine::Rule::Outcome)
     end
 
-    it "should set the outcome to OUTCOME_NEXT by default" do
-      MockRule.new.process(101, {}).outcome.should == RulesEngine::RuleOutcome::OUTCOME_NEXT
+    it "should set the outcome to NEXT by default" do
+      MockRule.new.process(101, {}).outcome.should == RulesEngine::Rule::Outcome::NEXT
     end        
   end
   

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rules_engine
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Chris Douglas
@@ -56,8 +56,8 @@ files:
 - lib/rules_engine/process/runner/db_runner.rb
 - lib/rules_engine/publish/publisher.rb
 - lib/rules_engine/publish/publisher/db_publisher.rb
-- lib/rules_engine/rule.rb
-- lib/rules_engine/rule_outcome.rb
+- lib/rules_engine/rule/definition.rb
+- lib/rules_engine/rule/outcome.rb
 - lib/rules_engine_view.rb
 - lib/rules_engine_view/alerts.rb
 - lib/rules_engine_view/boxes.rb
@@ -68,12 +68,12 @@ files:
 - lib/rules_engine_view/form_styles.rb
 - lib/rules_engine_view/model_loader.rb
 - lib/rules_engine_view/navigate.rb
-- rails_generators/manifests/rule_complex.rb
-- rails_generators/manifests/rule_complex.yml
-- rails_generators/manifests/rule_simple.rb
-- rails_generators/manifests/rule_simple.yml
+- rails_generators/manifests/complex.rb
+- rails_generators/manifests/complex.yml
 - rails_generators/manifests/rules_engine.rb
 - rails_generators/manifests/rules_engine.yml
+- rails_generators/manifests/simple.rb
+- rails_generators/manifests/simple.yml
 - rails_generators/rules_engine_generator.rb
 - rails_generators/templates/app/controllers/re_plan_workflow_rules_controller.rb
 - rails_generators/templates/app/controllers/re_plan_workflows_controller.rb
@@ -88,8 +88,8 @@ files:
 - rails_generators/templates/app/models/re_rule.rb
 - rails_generators/templates/app/models/re_rule_expected_outcome.rb
 - rails_generators/templates/app/models/re_workflow.rb
-- rails_generators/templates/app/rules/rule_complex.rb
-- rails_generators/templates/app/rules/rule_simple.rb
+- rails_generators/templates/app/rules/complex.rb
+- rails_generators/templates/app/rules/simple.rb
 - rails_generators/templates/app/views/layouts/rules_engine.html.erb
 - rails_generators/templates/app/views/re_plan_workflow_rules/edit.html.erb
 - rails_generators/templates/app/views/re_plan_workflow_rules/edit.js.erb
@@ -144,18 +144,18 @@ files:
 - rails_generators/templates/app/views/re_publications/_show_update.html.erb
 - rails_generators/templates/app/views/re_publications/show.html.erb
 - rails_generators/templates/app/views/re_publications/show.js.erb
-- rails_generators/templates/app/views/re_rule_definitions/rule_complex/_edit.html.erb
-- rails_generators/templates/app/views/re_rule_definitions/rule_complex/_help.html.erb
-- rails_generators/templates/app/views/re_rule_definitions/rule_complex/_new.html.erb
-- rails_generators/templates/app/views/re_rule_definitions/rule_complex/_script.html.erb
-- rails_generators/templates/app/views/re_rule_definitions/rule_complex/_title.html.erb
-- rails_generators/templates/app/views/re_rule_definitions/rule_complex/_word.html.erb
-- rails_generators/templates/app/views/re_rule_definitions/rule_complex/_words.html.erb
-- rails_generators/templates/app/views/re_rule_definitions/rule_complex/_workflow.html.erb
-- rails_generators/templates/app/views/re_rule_definitions/rule_simple/_edit.html.erb
-- rails_generators/templates/app/views/re_rule_definitions/rule_simple/_form.html.erb
-- rails_generators/templates/app/views/re_rule_definitions/rule_simple/_help.html.erb
-- rails_generators/templates/app/views/re_rule_definitions/rule_simple/_new.html.erb
+- rails_generators/templates/app/views/re_rule_definitions/complex/_edit.html.erb
+- rails_generators/templates/app/views/re_rule_definitions/complex/_help.html.erb
+- rails_generators/templates/app/views/re_rule_definitions/complex/_new.html.erb
+- rails_generators/templates/app/views/re_rule_definitions/complex/_script.html.erb
+- rails_generators/templates/app/views/re_rule_definitions/complex/_title.html.erb
+- rails_generators/templates/app/views/re_rule_definitions/complex/_word.html.erb
+- rails_generators/templates/app/views/re_rule_definitions/complex/_words.html.erb
+- rails_generators/templates/app/views/re_rule_definitions/complex/_workflow.html.erb
+- rails_generators/templates/app/views/re_rule_definitions/simple/_edit.html.erb
+- rails_generators/templates/app/views/re_rule_definitions/simple/_form.html.erb
+- rails_generators/templates/app/views/re_rule_definitions/simple/_help.html.erb
+- rails_generators/templates/app/views/re_rule_definitions/simple/_new.html.erb
 - rails_generators/templates/app/views/re_workflow_rules/_edit.html.erb
 - rails_generators/templates/app/views/re_workflow_rules/_error.html.erb
 - rails_generators/templates/app/views/re_workflow_rules/_help.html.erb
@@ -378,8 +378,8 @@ files:
 - rails_generators/templates/public/stylesheets/rules_engine/screen.css
 - rails_generators/templates/spec/controllers/re_plans_controller_spec.rb
 - rails_generators/templates/spec/helpers/rules_engine_helper_spec.rb
-- rails_generators/templates/spec/lib/rules/rule_complex_spec.rb
-- rails_generators/templates/spec/lib/rules/rule_simple_spec.rb
+- rails_generators/templates/spec/lib/rules/complex_spec.rb
+- rails_generators/templates/spec/lib/rules/simple_spec.rb
 - rails_generators/templates/spec/models/re_plan_spec.rb
 - rails_generators/templates/spec/models/re_plan_workflow_spec.rb
 - rails_generators/templates/spec/models/re_rule_expected_outcome_spec.rb
@@ -415,7 +415,7 @@ files:
 - spec/rules_engine/process/runner_spec.rb
 - spec/rules_engine/publish/publisher/db_publisher_spec.rb
 - spec/rules_engine/publish/publisher_spec.rb
-- spec/rules_engine/rule_spec.rb
+- spec/rules_engine/rule/definition_spec.rb
 - spec/rules_engine_view/alerts_spec.rb
 - spec/rules_engine_view/boxes_spec.rb
 - spec/rules_engine_view/buttons_spec.rb
@@ -486,7 +486,7 @@ test_files:
 - spec/rules_engine/process/runner_spec.rb
 - spec/rules_engine/publish/publisher/db_publisher_spec.rb
 - spec/rules_engine/publish/publisher_spec.rb
-- spec/rules_engine/rule_spec.rb
+- spec/rules_engine/rule/definition_spec.rb
 - spec/rules_engine_view/alerts_spec.rb
 - spec/rules_engine_view/boxes_spec.rb
 - spec/rules_engine_view/buttons_spec.rb

data/lib/rules_engine/rule.rb

@@ -1,84 +0,0 @@
-module RulesEngine  
-  class Rule
-    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::RuleOutcome::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::RuleOutcome 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::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
-end