rules_engine 0.1.1 → 0.1.3

data/rails_generators/templates/app/views/re_workflows/update.js.erb

@@ -0,0 +1,17 @@
+$.fancybox.close();
+$.re_unblock();
+
+<%= re_alert_js %>
+
+$('#re_workflow_change').html('<%=escape_javascript(render('/re_workflows/show'))%>');
+
+$('#re_rule_change').html('<%=escape_javascript(render('/re_workflows/rule_empty':hide => !@re_workflow.re_rules.empty?))%>');
+<% @re_workflow.re_rules.each do |re_rule | %>
+  $('#re_rule_change').append('<%=escape_javascript(render('/re_workflows/rule_change',  :re_rule => re_rule, 
+																																													:re_plan_id => 0,
+																																													:delete_path => re_workflow_rule_path(@re_workflow, re_rule),
+																																													:move_up_path => move_up_re_workflow_rule_path(@re_workflow, re_rule),
+																																													:move_down_path => move_down_re_workflow_rule_path(@re_workflow, re_rule),
+																																													:first_rule => re_rule == @re_workflow.re_rules[0], 
+																																													:last_rule => re_rule == @re_workflow.re_rules[-1]))%>');
+<% end %>

data/rails_generators/templates/config/initializers/rules_engine.rb

@@ -0,0 +1,9 @@
+require 'rules_engine_view'
+RulesEngine::Discovery.discover!
+
+RulesEngine::Publish.publisher = :db_publisher
+RulesEngine::Process.runner = :db_runner
+RulesEngine::Process.auditor = :db_auditor
+RulesEngine::Process.auditor.audit_level = RulesEngine::Process::AUDIT_INFO
+
+RulesEngineView::Defer.prefix_breadcrumbs = nil

data/rails_generators/templates/db/migrate/20100308225008_create_rules_engine.rb

@@ -0,0 +1,113 @@
+class CreateRulesEngine < ActiveRecord::Migration
+  def self.up
+
+    create_table :re_plans do |t|
+      t.string  :code
+      t.string  :title
+      t.text    :description
+      
+      t.integer :plan_status
+      t.integer :plan_version
+      
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+    create_table :re_plan_workflows do |t|
+      t.integer :re_plan_id
+      t.integer :re_workflow_id  
+      t.integer :position          
+    end
+      
+    create_table :re_workflows do |t|
+      t.string  :code
+      t.string  :title
+      t.text    :description
+      
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+    
+    #################################
+    create_table :re_rules do |t|
+      t.integer :re_workflow_id
+      
+      t.integer :position
+
+      t.string  :rule_class_name
+
+      t.string  :title
+      t.string  :summary      
+      t.text    :data
+      
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+    add_index :re_rules, [:re_workflow_id]
+    add_index :re_rules, [:re_workflow_id, :position]
+
+    #################################
+    create_table :re_rule_expected_outcomes do |t|
+      t.integer :re_rule_id
+      
+      t.integer :outcome
+      t.string  :workflow_code      
+      
+      t.datetime :created_at
+      t.datetime :updated_at
+    end    
+
+    add_index :re_rule_expected_outcomes, [:re_rule_id]
+    
+    #################################
+    create_table :re_published_plans do |t|
+      t.string   :plan_code
+      t.integer  :plan_version
+      t.string   :version_tag
+            
+      t.datetime :published_at
+      t.text     :data
+    end    
+
+    add_index :re_published_plans, [:plan_code]
+    add_index :re_published_plans, [:plan_code, :plan_version]
+    
+    create_table :re_process_runs do |t|
+      t.string   :plan_code
+      t.integer  :plan_version
+      t.integer  :process_status
+      t.datetime :created_at
+      t.datetime :started_at
+      t.datetime :finished_at
+    end    
+
+    add_index :re_process_runs, [:plan_code]
+    add_index :re_process_runs, [:process_status]
+    add_index :re_process_runs, [:started_at]
+    add_index :re_process_runs, [:finished_at]
+
+    create_table :re_process_audits do |t|
+      t.integer  :process_id
+            
+      t.datetime :created_at
+      t.integer  :code
+      t.string   :message            
+    end    
+
+    add_index :re_process_audits, [:process_id]
+    
+  end
+
+  def self.down
+    drop_table :re_published_plans
+    drop_table :re_process_runs
+    drop_table :re_process_audits
+    
+    drop_table :re_rule_expected_outcomes
+    drop_table :re_rules
+    drop_table :re_workflows
+    drop_table :re_plan_workflows
+    drop_table :re_plans
+  end
+end

data/rails_generators/templates/doc/README.rules_engine

@@ -4,151 +4,166 @@
 ## Installation Guide
 ###################################### 
 # 1. Install the Gem
-  sudo gem install rules_engine
-  sudo gem install rspec cucumber
+sudo gem install rules_engine
+sudo gem install rspec cucumber
 
 ######################################
 # 2. Create the Rails App
-  rails MyCoolNewApp	
-  cd MyCoolNewApp
-  rm ./public/index.html
+rails MyCoolNewApp	
+cd MyCoolNewApp
+rm ./public/index.html
 
-  ./script/generate rspec
-  ./script/generate cucumber --rspec
+./script/generate rspec
+./script/generate cucumber --rspec
 
-  ./script/generate rules_engine
-
-  rake db:migrate	
+./script/generate rules_engine
 
 ######################################
 # 3. Setup the Rails Environments
  - ./config/environment.rb
  
-  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!
+Rails::Initializer.run do |config|
+  ...
+  config.gem 'rules_engine'
+  config.gem 'will_paginate'
+  config.gem 'acts_as_list'
+  ...
+end
 
  - ./config/environments/production.rb
  - ./config/environments/development.rb
  
-  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")
+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")
 
  - ./config/environments/test.rb
  - ./config/environments/cucumber.rb
  
-  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 "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
+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'
+require 'machinist/active_record'
+require 'sham'
+require 'faker'
+require 'remarkable_rails'
 
 ######################################
-# 4. Install the Required Gems
-
-rake gems:install
-rake gems:install RAILS_ENV=test  	
-
-######################################
-# 5. Add the Routes
+# 4. Add the Routes
  - ./config/routes.rb
-  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}, 
+
+ActionController::Routing::Routes.draw do |map|
+  ...
+  
+  ### remove map.root if already defined
+  map.root :controller => :re_plans, :action => 'template'
+  map.resources :re_plans, :member => {:change => :get,
+                                      :preview => :get,
+                                      :publish => :put, 
+                                      :revert => :put,
+                                      :re_process => :get} do |re_map|  
+    
+    re_map.resources :workflows, :controller => :re_plan_workflows, 
+                          :except => [:index],
                           :member => {:change => :get, 
-                                          :activate => :put, 
-                                          :deactivate => :put, 
-                                          :revert => :put} do |re_pipeline|  
-    re_pipeline.resources :re_rules, 
-                              :controller => :re_pipeline_rules, 
+                                      :default => :put, 
+                                      :add => :put, 
+                                      :remove => :put} do |re_pipeline|
+      re_pipeline.resources :rules, :controller => :re_plan_workflow_rules, 
+                                :except => [:index, :show],
+                                :collection => {:help => :get, :error => :get}, 
+                                :member => {:move_up => :put, :move_down => :put}
+                                        
+    end  
+  end
+
+  map.resources :re_workflows, :collection => {:add => :get},
+                               :member => {:plan => :get,
+                                           :change => :get, 
+                                           :preview => :get} do |re_pipeline|
+    re_pipeline.resources :rules, :controller => :re_workflow_rules, 
+                              :except => [:index, :show],
                               :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  
 
+  map.resources :re_processes,    :only => [:index, :show]
+  map.resources :re_publications, :only => [:show]
+
+  ...
+
+
 ######################################
-# 6. Define the Access Levels
+# 5. Define the Access Levels
  - ./app/controllers/application_controller.rb
- class ApplicationController < ActionController::Base
+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'
+  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_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
+  def rules_engine_editor_access_required
+    unless rules_engine_editor?    
+      redirect_to(root_path) 
+      flash[:success] = 'Rules Engine Editor Access Denied.'
     end
+  end
+
+######################################
+# 6. Install the Required Gems
+  rake gems:install
+  rake gems:install RAILS_ENV=test  	
+
+######################################
+# 7. Migrate the Database
+  rake db:migrate	
+  rake db:migrate RAILS_ENV=test
 
 ######################################
-# 7. Create a Simple Rule
-  ./script/generate rules_engine simple my_simple_rule
+# 8. Create a Simple Rule
+  ./script/generate rules_engine rule_simple does_nothing
 
 ######################################
-# 8. Create a more Complex Rule
-  ./script/generate rules_engine complex another_complex_rule
+# 9. Create a Complex Rule
+  ./script/generate rules_engine rule_complex match_words
 
 ######################################
-# 9. Run the Tests
+# 10. Run the Tests
   rake spec
   rake spec:rcov
   rake cucumber
   open coverage/index.html
 
 ######################################
-# 10. Start the Server
+# 11. Start the Server
   ./script/server
-  open http://localhost:3000/re_pipelines
+  open http://localhost:3000/re_plans
 
 ######################################
-# 11. Create Pipelines and Rules
+# 12. Create Pipelines and Rules
   Watch the demo at "TODO":http://www.r3ef.com/

data/rails_generators/templates/lib/tasks/rules_engine.rake

@@ -1,17 +1,36 @@
-desc "run a rules pipeline with the complex rule"   
-task :rules_engine => :environment do
+require 'active_record'  
+require 'rules_engine'
 
-  if ENV['re_pipeline_code'].blank?
-    raise "usage: rake rules_engine re_pipeline_code=[pipeline code] re_param='[value]'"
+desc "run a rules engine plan"   
+task :rules_engine do
+
+  if ENV['re_plan'].blank?
+    raise "usage: rake rules_engine re_plan=[plan code] re_param='[value]'"
+  end    
+        
+  environment = ENV["RAILS_ENV"] || "development"
+
+  dbconfig = YAML::load(File.open("#{File.dirname(__FILE__)}/../../config/database.yml"))[environment]    
+  ActiveRecord::Base.establish_connection(dbconfig)
+        
+  RulesEngine::Publish.publisher = :db_publisher
+  RulesEngine::Process.runner = :db_runner
+  RulesEngine::Process.auditor = :db_auditor
+  RulesEngine::Process.auditor.audit_level = RulesEngine::Process::AUDIT_INFO
+  RulesEngine::Discovery.rules_path = File.expand_path(File.join(File.dirname(__FILE__), '/../../app/rules'))
+  RulesEngine::Discovery.discover! 
+  
+  plan = RulesEngine::Publish.publisher.get(ENV['re_plan'])
+  if plan.nil?
+    raise "published plan \"ENV['re_plan']\" not found"
   end    
     
-  data = ENV.inject({}){ |data, value| data[value[0].sub(/^re_/, '').to_sym] = value[1] if value[0] =~ /^re_/; data }
+  data = ENV.inject({}){ |data, value| data[value[0].sub(/^re_/, '').to_sym] = value[1] if value[0] =~ /^re_/; data }  
+  process_id = RulesEngine::Process.runner.create  
+  success = RulesEngine::Process.runner.run(process_id, plan, data)
   
-  job = RulesEngine::Job.create
-  # job = RulesEngine::Job.open(job.re_job.id)
+  # process = RulesEngine::Process.open(process.re_process.id)
       
-  success = job.run(data[:pipeline_code], data)
-  
-  puts "rule #{success ? 'succeeded' : 'failed'} : data = #{data.inspect}"
+  puts "plan #{success ? 'succeeded' : 'failed'} : process_id = #{process_id} : data = #{data.inspect}"
 end