rules_engine 0.1.1 → 0.1.3

data/rails_generators/templates/app/controllers/re_plans_controller.rb

@@ -0,0 +1,131 @@
+class RePlansController < ApplicationController    
+  helper :rules_engine 
+  layout 'rules_engine'
+
+  # before_filter :login_required
+  before_filter :rules_engine_editor_access_required,  :only => [:new, :create, :edit, :update, :destroy, :change, :publish, :revert]
+  before_filter :rules_engine_reader_access_required,  :only => [:index, :show, :preview, :re_process]
+
+  before_filter :only => [:show, :edit, :update, :destroy, :change, :preview, :publish, :revert, :re_process] do |controller|
+    controller.re_load_model :re_plan
+  end    
+
+  def index    
+    klass = RePlan
+    klass = klass.order_title
+    @re_plans = klass.find(:all)
+  end
+
+  def show
+  end
+
+  def new
+    @re_plan = RePlan.new
+  end
+  
+  def create
+    @re_plan = RePlan.new(params[:re_plan])
+    
+    if @re_plan.save
+      flash[:success] = 'Plan Created.'
+      
+      respond_to do |format|
+        format.html do
+          redirect_to(re_plans_path)
+        end  
+        format.js do
+          render :action => "create"
+        end
+      end
+    else
+      render :action => "new"
+    end    
+  end
+
+  def edit    
+  end
+
+  def update
+    update_params = params[:re_plan] || {}
+    @re_plan.attributes = update_params.except(:code)
+    if @re_plan.save
+      flash[:success] = 'Plan Updated.'
+      
+      respond_to do |format|
+        format.html do          
+          redirect_to(change_re_plan_path(@re_plan))
+        end  
+        format.js do
+          render :action => "update"
+        end
+      end
+    else
+      render :action => "edit"
+    end    
+  end
+
+  def destroy
+    RulesEngine::Publish.publisher.remove(@re_plan.code)
+    @re_plan.destroy
+    flash[:success] = 'Plan Deleted.'
+    
+    respond_to do |format|
+      format.html do
+        redirect_to(re_plans_path)
+      end  
+      format.js do
+        render :inline => "window.location.href = '#{re_plans_path}';"
+      end
+    end
+  end
+
+  def change
+  end
+  
+  def preview
+  end
+
+  def publish
+    if @re_plan.plan_error || params['tag'].blank?
+      flash[:error] = 'Cannot Publish Plan.'
+    else  
+      @re_plan.plan_version = RulesEngine::Publish.publisher.publish(@re_plan.code, params['tag'], @re_plan.publish)
+      @re_plan.plan_status = RePlan::PLAN_STATUS_PUBLISHED
+      @re_plan.save
+      flash[:success] = 'Plan Published.'
+    end  
+  
+    respond_to do |format|
+      format.html do
+        redirect_to(change_re_plan_path(@re_plan))
+      end  
+      format.js do
+        render :action => "update"
+      end
+    end
+  end
+
+  def revert
+    plan = RulesEngine::Publish.publisher.get(@re_plan.code)    
+    if plan.nil?
+      flash[:error] = 'Cannot Find Published Plan.'
+    else
+      @re_plan.revert!(plan)
+      @re_plan.save!
+      flash[:success] = 'Changes Discarded.'
+    end  
+    
+    respond_to do |format|
+      format.html do
+        redirect_to(change_re_plan_path(@re_plan))
+      end  
+      format.js do
+        render :action => "update"
+      end
+    end
+  end
+  
+  def re_process
+    @re_processes = RulesEngine::Process.runner.history(@re_plan.code, :page => params[:page] || 1, :per_page => 5)    
+  end
+end

data/rails_generators/templates/app/controllers/re_processes_controller.rb

@@ -0,0 +1,15 @@
+class ReProcessesController < ApplicationController    
+  helper :rules_engine 
+  layout 'rules_engine'
+
+  # before_filter :login_required
+  before_filter :rules_engine_reader_access_required,  :only => [:index, :show]
+
+  def index
+    @re_processes = RulesEngine::Process.runner.history(nil, :page => params[:page] || 1, :per_page => 5)
+  end
+
+  def show
+    @re_audits = RulesEngine::Process.auditor.history(params[:id])
+  end
+end

data/rails_generators/templates/app/controllers/re_publications_controller.rb

@@ -0,0 +1,15 @@
+class RePublicationsController < ApplicationController    
+  helper :rules_engine 
+  layout 'rules_engine'
+
+  # before_filter :login_required
+  before_filter :rules_engine_reader_access_required,  :only => [:show]
+
+  before_filter :only => [:show] do |controller|
+    controller.re_load_model :re_plan
+  end    
+
+  def show
+    @re_publications = RulesEngine::Publish.publisher.history(@re_plan.code, :page => params[:page] || 1, :per_page => 5)
+  end
+end

data/rails_generators/templates/app/controllers/{re_pipeline_rules_controller.rb → re_workflow_rules_controller.rb}

@@ -1,5 +1,5 @@
-class RePipelineRulesController < ApplicationController    
-  helper :re_pipeline 
+class ReWorkflowRulesController < ApplicationController    
+  helper :rules_engine 
   layout 'rules_engine'
   
   # before_filter :login_required
@@ -7,11 +7,11 @@ class RePipelineRulesController < ApplicationController
   before_filter :rules_engine_reader_access_required, :only => [:help, :error]
   
   before_filter do |controller|
-    controller.re_load_model :re_pipeline, {:param_id => :re_pipeline_id, :redirect_path => :re_pipelines_path}    
+    controller.re_load_model :re_workflow, {:param_id => :re_workflow_id, :redirect_path => :re_workflows_path}    
   end
   
   before_filter :only => [:edit, :update, :destroy, :move_up, :move_down] do |controller|
-    controller.re_load_model :re_rule, {:param_id => :id, :parents => [:re_pipeline], :redirect_path => :re_pipeline_path}
+    controller.re_load_model :re_rule, {:param_id => :id, :parents => [:re_workflow], :redirect_path => :change_re_workflow_path}
   end    
   
   def help
@@ -28,7 +28,7 @@ class RePipelineRulesController < ApplicationController
   end  
   
   def new
-    @re_rule = ReRule.new(:re_pipeline_id => @re_pipeline.id, :rule_class_name => params[:rule_class_name])
+    @re_rule = ReRule.new(:re_workflow_id => @re_workflow.id, :rule_class_name => params[:rule_class_name])
     if @re_rule.rule.nil? 
       render :action => "error"
       return
@@ -38,7 +38,7 @@ class RePipelineRulesController < ApplicationController
   end
   
   def create
-    @re_rule = ReRule.new(:re_pipeline_id => @re_pipeline.id, :rule_class_name => params[:rule_class_name])
+    @re_rule = ReRule.new(:re_workflow_id => @re_workflow.id, :rule_class_name => params[:rule_class_name])
     if @re_rule.rule.nil? 
       render :action => "error"
       return      
@@ -50,7 +50,7 @@ class RePipelineRulesController < ApplicationController
     
       respond_to do |format|
         format.html do          
-          redirect_to(change_re_pipeline_path(@re_pipeline))
+          redirect_to(change_re_workflow_path(@re_workflow))
         end  
         format.js do
           render :action => "update"
@@ -82,7 +82,7 @@ class RePipelineRulesController < ApplicationController
       
       respond_to do |format|
         format.html do          
-          redirect_to(change_re_pipeline_path(@re_pipeline))
+          redirect_to(change_re_workflow_path(@re_workflow))
         end  
         format.js do
           render :action => "update"
@@ -99,10 +99,10 @@ class RePipelineRulesController < ApplicationController
 
     respond_to do |format|
       format.html do
-        redirect_to(change_re_pipeline_path(@re_pipeline))
+        redirect_to(change_re_workflow_path(@re_workflow))
       end  
       format.js do
-        render :action => "destroy"
+        render :action => "update"
       end
     end
     
@@ -114,7 +114,7 @@ class RePipelineRulesController < ApplicationController
     
     respond_to do |format|
       format.html do          
-        redirect_to(change_re_pipeline_path(@re_pipeline))
+        redirect_to(change_re_workflow_path(@re_workflow))
       end  
       format.js do
         render :action => "update"
@@ -128,7 +128,7 @@ class RePipelineRulesController < ApplicationController
     
     respond_to do |format|
       format.html do          
-        redirect_to(change_re_pipeline_path(@re_pipeline))
+        redirect_to(change_re_workflow_path(@re_workflow))
       end  
       format.js do
         render :action => "update"

data/rails_generators/templates/app/controllers/re_workflows_controller.rb

@@ -0,0 +1,96 @@
+class ReWorkflowsController < ApplicationController    
+  helper :rules_engine 
+  layout 'rules_engine'
+  
+  # before_filter :login_required
+  before_filter :rules_engine_editor_access_required,  :only => [:new, :create, :edit, :update, :destroy, :change]
+  before_filter :rules_engine_reader_access_required,  :only => [:index, :show, :preview, :plan, :add]
+
+  before_filter :only => [:show, :edit, :update, :destroy, :change, :preview, :plan] do |controller|
+    controller.re_load_model :re_workflow
+  end    
+
+  def index
+    @re_workflows = ReWorkflow.order_title.find(:all)
+  end
+  
+  def show
+  end
+
+  def new
+    @re_workflow = ReWorkflow.new
+  end
+  
+  def create
+    @re_workflow = ReWorkflow.new(params[:re_workflow])
+    
+    if @re_workflow.save
+      flash[:success] = 'Workflow Created.'
+      
+      respond_to do |format|
+        format.html do
+          redirect_to(change_re_workflow_path(@re_workflow))
+        end  
+        format.js do
+          render :action => "create"
+        end
+      end
+    else
+      render :action => "new"
+    end    
+  end
+
+  def edit    
+  end
+
+  def update
+    update_params = params[:re_workflow] || {}
+    @re_workflow.attributes = update_params.except(:code)
+    if @re_workflow.save
+      flash[:success] = 'Workflow Updated.'
+      
+      respond_to do |format|
+        format.html do          
+          redirect_to(change_re_workflow_path(@re_workflow))
+        end  
+        format.js do
+          render :action => "update"
+        end
+      end
+    else
+      render :action => "edit"
+    end    
+  end
+
+  def destroy
+    @re_workflow.destroy
+    flash[:success] = 'Workflow Removed.'
+    
+    respond_to do |format|
+      format.html do
+        redirect_to(re_workflows_path)
+      end  
+      format.js do
+        render :inline => "window.location.href = '#{re_workflows_path}';"
+      end
+    end
+  end
+
+  def change
+    RulesEngine::Discovery.discover!
+  end
+  
+  def preview
+  end
+
+  def plan
+    klass = RePlanWorkflow
+    klass = klass.order_plan_title
+    klass = klass.by_workflow_id(@re_workflow.id)
+    @re_plan_workflows = klass.paginate(:include => :re_plan, :page => params[:page] || 1, :per_page => 10)
+  end
+
+  def add
+    @re_workflows = ReWorkflow.order_title.find(:all)
+  end
+end

data/rails_generators/templates/app/helpers/rules_engine_helper.rb

@@ -0,0 +1,42 @@
+module RulesEngineHelper
+
+  def re_plan_status re_plan
+    case re_plan.plan_status
+    when RePlan::PLAN_STATUS_PUBLISHED
+      'published'
+    when RePlan::PLAN_STATUS_CHANGED
+      'changed'
+    else # when RePlan::PLAN_STATUS_DRAFT
+      'draft'
+    end
+  end    
+  
+  def re_plan_version re_plan
+    return '' if re_plan.nil? || re_plan.plan_version.nil?
+    "Ver.#{re_plan.plan_version}"    
+  end
+  
+  def re_process_status process_status
+    case process_status.to_i
+    when RulesEngine::Process::PROCESS_STATUS_RUNNING
+      'running'
+    when RulesEngine::Process::PROCESS_STATUS_SUCCESS
+      'success'
+    when RulesEngine::Process::PROCESS_STATUS_FAILURE
+      'error'      
+    else # RulesEngine::Process::PROCESS_STATUS_NONE
+      'info'
+    end    
+  end    
+
+  def re_audit_status audit_status
+    case audit_status.to_i
+    when RulesEngine::Process::AUDIT_SUCCESS
+      'success'
+    when RulesEngine::Process::AUDIT_FAILURE
+      'error'      
+    else # RulesEngine::Process::AUDIT_INFO
+      'info'
+    end    
+  end      
+end

data/rails_generators/templates/app/models/re_plan.rb

@@ -0,0 +1,126 @@
+class RePlan < ActiveRecord::Base    
+  has_many :re_plan_workflows, :dependent => :destroy
+  has_many :re_workflows, :through => :re_plan_workflows, :order => 're_plan_workflows.position'
+  
+  PLAN_STATUS_DRAFT      = 0
+  PLAN_STATUS_CHANGED    = 1
+  PLAN_STATUS_PUBLISHED  = 2
+  PLAN_STATUS_REVERTED   = 3
+  
+  validates_presence_of   :code
+  validates_presence_of   :title
+  validates_uniqueness_of :code, :case_sensitive => false, :message=>"alread taken."
+  
+  named_scope :order_code,  :order => 'code ASC'
+  named_scope :order_title, :order => 'title ASC'
+  
+  before_create :before_create_plan
+  before_save :before_save_plan
+
+  def before_create_plan
+    self.plan_status = PLAN_STATUS_DRAFT
+  end  
+
+  def before_save_plan
+    if (plan_status == PLAN_STATUS_REVERTED)
+      self.plan_status = PLAN_STATUS_PUBLISHED
+    elsif changes.detect { |change| !ignore_attributes.include?(change[0])}  
+      self.changed!(false) 
+    end  
+  end  
+
+  def code=(new_code)
+    self[:code] = new_code.strip.downcase.gsub(/[^a-zA-Z0-9]+/i, '_') if new_code && new_record?
+  end
+  
+  def publish
+    data = { 
+      "code" => code, 
+      "title" => title, 
+      "description" => description,
+      "first_workflow" => re_workflows.empty? ? '' : re_workflows[0].code,
+    }
+    re_workflows.each_with_index do | re_workflow, index | 
+      data["workflow_#{re_workflow.code}"] = re_workflow.publish 
+
+      if re_workflows[-1] == re_workflow
+        data["workflow_#{re_workflow.code}"]["next_workflow"] = ''
+      else  
+        data["workflow_#{re_workflow.code}"]["next_workflow"] = re_workflows[index+1].code
+      end  
+    end
+    data
+  end  
+
+  def revert!(rule_data)
+    self.plan_status = RePlan::PLAN_STATUS_REVERTED
+    self.code = rule_data["code"]
+    self.title = rule_data["title"]
+    self.description = rule_data["description"]
+    
+    orig_re_workflows = []
+    workflow_data = rule_data["workflow_#{rule_data["first_workflow"]}"]
+    while (workflow_data && orig_re_workflows.length < 500)
+      workflow_code = workflow_data["code"]
+      re_workflow = ReWorkflow.find_by_code(workflow_code) || ReWorkflow.new
+      re_workflow.revert!(workflow_data)
+      orig_re_workflows << re_workflow
+      
+      next_workflow = workflow_data["next_workflow"]
+      workflow_data = next_workflow.blank? ? nil : rule_data["workflow_#{next_workflow}"]
+    end  
+    
+    self.re_workflows = orig_re_workflows
+    self
+  end  
+
+  def add_workflow re_workflow
+    return false if self.re_workflows.include?(re_workflow)
+    self.re_workflows << re_workflow 
+    changed!
+    true
+  end
+
+  def remove_workflow re_workflow
+    return false unless self.re_workflows.include?(re_workflow)
+    self.re_workflows.delete(re_workflow)
+    changed!
+    true
+  end  
+  
+  
+  def default_workflow= re_workflow
+    return if self.re_workflows.empty? || self.re_workflows[0] == re_workflow
+    re_plan_workflow = re_plan_workflows.detect { | re_plan_workflow | re_plan_workflow.re_workflow_id == re_workflow.id}
+    return unless re_plan_workflow
+    re_plan_workflow.move_to_top
+    changed!
+  end
+  
+  def default_workflow
+    self.re_workflows.empty? ? nil : self.re_workflows[0]
+  end
+  
+  def plan_error
+    return 'workflows req\'d' if re_workflows.empty?
+    return 'workflow error' if re_workflows.any? { | re_workflow | re_workflow.workflow_error }    
+    nil
+  end
+
+  def published!
+    self.plan_status = PLAN_STATUS_PUBLISHED
+    self.save!
+  end
+
+  def changed!(update = true)
+    if self.plan_status == PLAN_STATUS_PUBLISHED
+      self.plan_status = PLAN_STATUS_CHANGED
+      self.save! if update
+    end  
+  end
+  
+  protected
+    def ignore_attributes 
+      [self.class.primary_key, self.class.inheritance_column, "plan_status", "plan_version", "created_at", "updated_at"]
+    end
+end