rules_engine 0.0.1 → 0.0.3

data/README.textile

@@ -0,0 +1,178 @@
+h1. Ruby and Rails Rules Engine Framework
+
+h4. More detailed documentation at "www.r3ef.com":http://www.r3ef.com
+
+h2. Installation Guide
+
+h3. 1. Install the Gem
+
+<pre>
+sudo gem install rules_engine
+sudo gem install rspec cucumber
+</pre>
+
+h3. 2. Create the Rails App
+
+<pre>
+rails MyCoolNewApp	
+cd MyCoolNewApp
+rm ./public/index.html
+
+./script/generate rspec
+./script/generate cucumber --rspec
+
+./script/generate rules_engine
+
+rake db:migrate	
+</pre>
+
+h3. 3. Setup the Rails Environments
+
+./config/environment.rb
+
+<pre>
+Rails::Initializer.run do |config|
+  ...
+  config.gem 'rules_engine'
+  config.gem 'will_paginate'
+  config.gem 'acts_as_list'
+  ...
+  config.active_record.observers = :re_pipeline_activated_observer
+  ...
+end
+
+RulesEngine::Discovery.discover!
+</pre>
+
+./config/environments/production.rb<br/>
+./config/environments/development.rb
+
+<pre>
+RulesEngine::Cache.cache_store = :mem_cache_store, "localhost:11210"
+  #   RulesEngine::Cache.cache_store = :memory_store
+  #   RulesEngine::Cache.cache_store = :file_store, "/path/to/cache/directory"
+  #   RulesEngine::Cache.cache_store = :drb_store, "druby://localhost:9192"
+  #   RulesEngine::Cache.cache_store = :mem_cache_store, "localhost"
+  #   RulesEngine::Cache.cache_store = MyOwnStore.new("parameter")
+</pre>
+
+./config/environments/test.rb <br/>
+./config/environments/cucumber.rb
+
+<pre>
+  config.gem "rspec",             :version => '>=1.3.0', :lib => false
+  config.gem "rspec-rails",       :version => '>=1.3.2', :lib => false
+  config.gem "faker",             :version => '>=0.3.1', :lib => false
+
+  config.gem "machinist",         :version => '>=1.0.6', :lib => false
+  config.gem 'rcov',              :version => '>=0.9.8', :lib => false
+  config.gem 'remarkable_rails',  :version => '>=3.1.13', :lib => false
+
+  require 'machinist/active_record'
+  require 'sham'
+  require 'faker'
+  require 'remarkable_rails'
+</pre>
+
+h3. 4. Install the Required Gems
+
+<pre>
+rake gems:install
+rake gems:install RAILS_ENV=test  	
+</pre>
+
+h3. 5. Add the Routes
+
+./config/routes.rb
+
+<pre>
+ActionController::Routing::Routes.draw do |map|
+  ...
+  ### remove map.root if already defined
+  map.root :controller => 're_pipelines', :action => 'template'
+  ### map.preview '/preview', :controller => 're_pipelines', :action => 'template'
+  map.resources :re_pipelines, 
+                        :collection => {:lookup => :get, 
+                                        :activate_all => :put}, 
+                        :member => {:change => :get, 
+                                        :activate => :put, 
+                                        :deactivate => :put, 
+                                        :revert => :put} do |re_pipeline|  
+    re_pipeline.resources :re_rules, 
+                        :collection => {:help => :get, :error => :get}, 
+                        :member => {:move_up => :put, :move_down => :put}
+    re_pipeline.resources :re_jobs, :controller => :re_pipeline_jobs, :only => [:index]
+  end
+  	
+  map.resources :re_jobs, :only => [:index, :show]
+  ...
+end  
+</pre>
+
+h3. 6. Define the Access Levels
+
+./app/controllers/application_controller.rb
+
+<pre>
+class ApplicationController < ActionController::Base
+
+  helper_method :rules_engine_reader?, :rules_engine_editor?
+  
+  def rules_engine_reader?
+    # why cookies[:rules_engine_reader] ? It's a workaround for cucumber testing
+    return cookies[:rules_engine_reader].nil? ? true : 
+                                                cookies[:rules_engine_reader].downcase == 'true'
+  end  
+  
+  def rules_engine_editor?
+    # why cookies[:rules_engine_editor] ? It's a workaround for cucumber testing
+    return cookies[:rules_engine_editor].nil? ? true : 
+                                                cookies[:rules_engine_editor].downcase == 'true'
+  end  
+
+  def rules_engine_reader_access_required
+    unless rules_engine_reader?    
+      redirect_to(root_path) 
+      flash[:success] = 'Rules Engine Access Denied.'
+    end  
+  end
+  
+  def rules_engine_editor_access_required
+    unless rules_engine_editor?    
+      redirect_to(root_path) 
+      flash[:success] = 'Rules Engine Editor Access Denied.'
+    end
+  end
+</pre>
+
+h3. 7. Create a Simple Rule
+
+<pre>
+./script/generate rules_engine simple my_simple_rule
+</pre>
+
+h3. 8. Create a more Complex Rule
+
+<pre>
+./script/generate rules_engine complex another_complex_rule
+</pre>
+
+h3. 9. Run the Tests
+
+<pre>
+rake spec
+rake spec:rcov
+rake cucumber
+open coverage/index.html
+</pre>
+
+h3. 10. Start the Server
+
+<pre>
+./script/server
+open http://localhost:3000/re_pipelines
+</pre>
+
+h3. 11. Create Pipelines and Rules
+
+Watch the demo at "TODO":http://www.r3ef.com/

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.3

data/lib/rules_engine.rb

@@ -1,6 +1,22 @@
 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/cache")
-require File.expand_path(File.dirname(__FILE__) + "/rules_engine/job_runner")
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine/job")
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine/rule_outcome")
+
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine_view/form_styles")
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine_view/form_fields")
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine_view/form_builder")
+
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine_view/buttons")
+
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine_view/boxes")
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine_view/navigate")
+
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine_view/alerts")
+
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine_view/defer")
+
+require File.expand_path(File.dirname(__FILE__) + "/rules_engine_view/model_loader")
 
 

data/lib/rules_engine/discovery.rb

@@ -1,5 +1,4 @@
 module RulesEngine
-  ##################################################################
   class Discovery
     
     RULES_PATH = File.expand_path(File.join(RAILS_ROOT, '/app/rules'))
@@ -38,10 +37,10 @@ module RulesEngine
         @rule_groups
       end
     
-      def rule_class(rule_class)
+      def rule_class(rule_class_name)
         throw Exception.new("RulesEngine::Discovery.discover! required in environment.rb") if @rule_classes.nil?
         @rule_classes.each do |rule|
-          return rule if rule.rule_class == rule_class
+          return rule if rule.rule_class_name == rule_class_name
         end
         nil
       end

data/lib/rules_engine/job.rb

@@ -0,0 +1,120 @@
+module RulesEngine  
+  class Job
+    
+    @@max_rules = 500
+    attr_reader :re_job, :re_pipeline, :re_rule
+  
+    def initialize(re_job)
+      @re_job = re_job
+    end
+    
+    def self.create()
+      re_job = ReJob.create(:job_status => ReJob::JOB_STATUS_NONE)
+      RulesEngine::Job.new(re_job)
+    end
+    
+    def self.open(job_id)      
+      re_job = ReJob.find_by_id(job_id) || ReJob.create(:job_status => ReJob::JOB_STATUS_NONE)
+      re_job.update_attributes(:job_status => ReJob::JOB_STATUS_NONE)
+      
+      RulesEngine::Job.new(re_job)
+    end      
+    
+    def run(pipeline_code, data = {})
+      if @re_job.nil?
+        audit("Job missing", ReJobAudit::AUDIT_FAILURE)
+        return false
+      end
+      
+      rule_count = 0
+      done = false
+      error = false
+            
+      @re_job.update_attributes(:job_status => ReJob::JOB_STATUS_RUNNING)  
+      
+      while (!done && rule_count < @@max_rules)
+        rule_count += 1 
+        
+        activated_pipeline = RePipelineActivated.find_by_code(pipeline_code)
+        unless activated_pipeline
+          audit("Activated Pipleine : #{pipeline_code} not found", ReJobAudit::AUDIT_FAILURE) 
+          error = done = true 
+          next
+        end  
+        
+        
+        if activated_pipeline.re_rules.empty?
+          audit("Pipleine : #{pipeline_code} has no rules", ReJobAudit::AUDIT_FAILURE) 
+          error = done = true 
+          next
+        end
+
+        @re_pipeline = activated_pipeline.re_pipeline
+        audit("Pipleine : #{pipeline_code} started", ReJobAudit::AUDIT_SUCCESS)
+        
+        activated_pipeline.re_rules.each do | re_rule |
+          rule = re_rule.rule
+          unless rule
+            audit("Rule : #{re_rule.rule_class_name} not found", ReJobAudit::AUDIT_FAILURE) 
+            error = done = true 
+            break 
+          end  
+        
+          @re_rule = re_rule
+          audit("Rule : #{re_rule.title} starting")                    
+          rule_outcome = rule.process(self, data)
+          audit("Rule : #{re_rule.title} finished")
+          @re_rule = nil
+          
+          if !rule_outcome.nil? && rule_outcome.outcome == RulesEngine::RuleOutcome::OUTCOME_STOP_SUCCESS
+            audit("Pipeline : #{pipeline_code} stop success", ReJobAudit::AUDIT_SUCCESS)
+            done = true 
+            break
+          end
+        
+          if !rule_outcome.nil? && rule_outcome.outcome == RulesEngine::RuleOutcome::OUTCOME_STOP_FAILURE
+            audit("Pipeline : #{pipeline_code} stop failure", ReJobAudit::AUDIT_FAILURE)
+            error = done = true 
+            break
+          end
+        
+          if !rule_outcome.nil? && rule_outcome.outcome == RulesEngine::RuleOutcome::OUTCOME_START_PIPELINE
+            audit("Pipeline : #{pipeline_code} start pipeline #{rule_outcome.pipeline_code}", ReJobAudit::AUDIT_SUCCESS)
+            pipeline_code = rule_outcome.pipeline_code
+            break
+          end
+          
+          if activated_pipeline.re_rules[-1] == re_rule
+            audit("Pipeline : #{pipeline_code} complete", ReJobAudit::AUDIT_SUCCESS)
+            done = true 
+            break
+          end                  
+        end
+        
+        @re_pipeline = nil
+      end  
+
+      if rule_count >= @@max_rules
+        audit("Maximum pipeline depth #{@@max_rules} exceeded", ReJob::JOB_STATUS_FAILURE)
+        error = true
+      end
+      
+      @re_job.update_attributes(:job_status => error ? ReJob::JOB_STATUS_FAILURE : ReJob::JOB_STATUS_SUCCESS)
+      
+      !error
+    end
+
+    def audit(message, code=ReJobAudit::AUDIT_INFO)
+        ReJobAudit.create({
+          :re_job_id => re_job ? re_job.id : nil,
+          :re_pipeline_id => re_pipeline ? re_pipeline.id : nil, 
+          :re_rule_id => re_rule ? re_rule.id : nil,
+          :audit_date => Time.now,  
+          :audit_code => code,
+          :audit_message => message});
+      
+      # puts "#{'*' * 5} #{re_job ? re_job.id : nil}, #{re_pipeline ? re_pipeline.id : nil}, #{re_rule ? re_rule.id : nil}, #{code}, #{message}"
+    end
+        
+  end
+end

data/lib/rules_engine/rule.rb

@@ -1,52 +1,77 @@
 module RulesEngine  
   class Rule
-    class_inheritable_accessor :options
-    @@options = {}
-
     def self.inherited(base)
       base.extend(ClassMethods) 
     end
 
     module ClassMethods  
-      def rule_class
-        self.to_s
+      def rule_class_name
+        self.name.classify
       end
     end
-      
+
     ##################################################################
-    def attributes=(params)
+    # 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 valid?
-      true
+    def summary
+      return nil
     end
-
-    def errors
-      @errors ||= []
-      return @errors
+    
+    def data
+      return nil
+    end
+    
+    def expected_outcomes
+      return [:outcome => RulesEngine::RuleOutcome::OUTCOME_NEXT, :pipeline_code => nil]
+    end
+    
+    ##################################################################
+    # set the rule attributes
+    def attributes=(params)
     end
 
-    def load(re_rule)
+    ##################################################################
+    # validation and errors
+    def valid?
       true
     end
 
-    def save(re_rule)
-      re_rule.rule_class = self.class.rule_class
-      true
+    def errors
+      @errors ||= {}
+      return @errors
     end    
-    
-    def after_create(re_rule)
-    end
-    
-    def after_update(re_rule)
+
+    ##################################################################
+    # callbacks when the rule is added and removed from a pipeline
+    def after_add_to_pipeline(re_pipeline_id, re_rule_id)
     end
     
-    def before_destroy(re_rule)
+    def before_remove_from_pipeline(re_pipeline_id, re_rule_id)
     end
     
     ##################################################################
+    # execute the rule
     # return an RulesEngine::RuleOutcome object to define what to do next
-    # or nil to continue to the next rule
+    # if nil to continue to the next rule
     def process(job_id, data)
       rule_outcome = RulesEngine::RuleOutcome.new