rules_engine 0.0.1 → 0.0.3

data/rails_generators/templates/app/views/re_rules/_new.html.erb

@@ -1,25 +1,16 @@
-<div class="clear prepend-1 span-18">
-  <h2 class="rule-class-new"> New : <%= @rule_class.options[:name] %></h2>
+<div class="clear span-18">
+  <h2 class="re-rule-class-new"> New : <%= @re_rule.rule.options[:display_name] %></h2>
   <div class="clear top-10"></div>
 
-  <% dougo_form_for(@re_rule, :url => re_pipeline_re_rules_path(@re_pipeline), :method => :post, :span => "3x13", :html => {:id => "rule_new_form"}) do |f| %>
-    <%= hidden_field_tag('rule_class', @rule_class) %>
-    <%= f.error_messages :message => "Unable To Create Rule : #{@rule_class.options[:name]}" %>
-    <% unless @rule.errors.empty? %>
-      <div id="errorExplanation" class="errorExplanation">
-        <% @rule.errors.each do |error| %>
-          <p><%= error %></p>
-        <% end %>  
-      </div>
-    <% end %>  
-    
-    <% whitebox do %>    
-    
-      <%= render(@rule_class.options[:new_template], :f => f) %>
+  <% re_form_for(@re_rule, :url => re_pipeline_re_rules_path(@re_pipeline), :method => :post, :span => "3x15", :html => {:id => "re_rule_new_form"}) do |f| %>
+    <%= hidden_field_tag('rule_class_name', @re_rule.rule_class_name) %>
+    <%= f.error_messages :message => "Unable To Create Rule : #{@re_rule.rule.options[:display_name]}" %>
+    <% re_whitebox do %>        
+      <%= render(@re_rule.rule.options[:new_partial], :f => f) %>
       
       <div class="clear"></div>
-  	  <%= button_submit_green('Create', :id => "rule_new_insert") %>
-  	  <%= button_link_orange('Cancel', change_re_pipeline_path(@re_pipeline), :id => "rule_new_cancel") %>
+  	  <%= re_button_submit_green('Create', :id => "re_rule_new_insert") %>
+  	  <%= re_button_link_orange('Cancel', change_re_pipeline_path(@re_pipeline), :id => "re_rule_new_cancel") %>
     <% end %>
   <% end %>
 </div>  

data/rails_generators/templates/app/views/re_rules/_show.html.erb

@@ -1,37 +1,37 @@
-<% re_rule_verify = re_rule.verify %>
+<% re_rule_error = re_rule.rule_error %>
 <% local_first_rule = local_assigns[:first_rule] && first_rule  %>
 <% local_last_rule = local_assigns[:last_rule] && last_rule  %>
 
-<div class="span-15 last rule-change" id="change_rule_<%= re_rule.id %>">
-  <div class="<%= re_rule_verify.blank? ? 'bluebox' : 'redbox' %> rule-status-<%= re_rule_verify.blank? ? 'valid' : 'verify' %>">
+<div class="span-15 last re-rule-change" id="re_rule_change_<%= re_rule.id %>">
+  <div class="<%= re_rule_error.blank? ? 're-bluebox' : 're-redbox' %> re-rule-status-<%= re_rule_error.blank? ? 'valid' : 'verify' %>">
     <h3 class="float-left"><%= re_rule.title %></h3>
     <div class="float-right">
 			<!-- NO ACTIONS ON THE RULE	 -->
     </div>
     <div class="clear"></div>    
   </div>
-  <div class="<%= re_rule_verify.blank? ? 'bluebox' : 'redbox' %> no-top"> 
-      <div class="span-10">
+  <div class="<%= re_rule_error.blank? ? 're-bluebox' : 're-redbox' %> no-top"> 
+      <div class="span-9">
         <p class="top-5 left-10">
           <%= re_rule.summary %>
         </p>
       </div>
       
-      <div class="prepend-10 top-10">
-        <% if re_rule.re_rule_outcomes.empty? %>
-          <div class="rule-continue">Continue</div>
+      <div class="prepend-9 top-10">
+        <% if re_rule.re_rule_expected_outcomes.empty? %>
+          <div class="re-rule-continue">Continue</div>
         <% end %>        
-        <% unless re_rule.re_rule_outcome_next.nil? %>
-          <div class="rule-continue">Continue</div>
+        <% unless re_rule.re_rule_expected_outcome_next.nil? %>
+          <div class="re-rule-continue">Continue</div>
         <% end %>  
-        <% re_rule.re_rule_outcomes_start_pipeline.each do |re_rule_outcome| %>
-          <div class="rule-goto-pipeline"><%= re_rule_outcome.pipeline_code %></div>
+        <% re_rule.re_rule_expected_outcomes_start_pipeline.each do |re_rule_expected_outcome| %>
+          <div class="re-rule-start-pipeline">Start : <%= re_rule_expected_outcome.pipeline_code %></div>
         <% end %>  
-        <% unless re_rule.re_rule_outcome_failure.nil? %>
-          <div class="rule-stop-failure">Stop Failure</div>
+        <% unless re_rule.re_rule_expected_outcome_failure.nil? %>
+          <div class="re-rule-stop-failure">Stop Failure</div>
         <% end %>  
-        <% unless re_rule.re_rule_outcome_success.nil? %>
-          <div class="rule-stop-success">Stop Success</div>
+        <% unless re_rule.re_rule_expected_outcome_success.nil? %>
+          <div class="re-rule-stop-success">Stop Success</div>
         <% end %>  
       </div>
       <div class="clear"></div>  
@@ -39,5 +39,5 @@
 </div>
 
 <% unless local_last_rule %>
-  <div class="prepend-7 span-2"><div class="rule-next-change"></div></div>
+  <div class="prepend-7 span-2"><div class="re-rule-next-change"></div></div>
 <% end %>

data/rails_generators/templates/app/views/re_rules/destroy.js.erb

@@ -1,13 +1,14 @@
-<%= javascript_alert_messages %>
+$.re_unblock();
+$.fancybox.close();
 
-self.parent.tb_remove();
+<%= re_alert_js %>
 
-$('#change_pipeline').html('<%=escape_javascript(render('/re_pipelines/change'))%>');
-$('#change_pipeline_actions').html('<%=escape_javascript(render('/re_pipelines/change_actions'))%>');
+$('#re_pipeline_change').html('<%=escape_javascript(render('/re_pipelines/change'))%>');
+$('#re_pipeline_change_actions').html('<%=escape_javascript(render('/re_pipelines/change_actions'))%>');
 
-$('#change_rules').html('')
+$('#re_rules_change').html('')
 <% @re_pipeline.re_rules.each do |re_rule | %>
-  $('#change_rules').append('<%=escape_javascript(render('/re_rules/change', :re_rule => re_rule, :first_rule => re_rule == @re_pipeline.re_rules[0], :last_rule => re_rule == @re_pipeline.re_rules[-1]))%>');
+  $('#re_rules_change').append('<%=escape_javascript(render('/re_rules/change', :re_rule => re_rule, :first_rule => re_rule == @re_pipeline.re_rules[0], :last_rule => re_rule == @re_pipeline.re_rules[-1]))%>');
 <% end %>
 
 <%= render('/re_rules/empty', :re_pipeline => @re_pipeline) %>

data/rails_generators/templates/app/views/re_rules/edit.html.erb

@@ -1,9 +1,10 @@
-<% set_subnav @re_pipeline.title, 
-              link_to("All Pipelines", re_pipelines_path, :class => "pipeline-list"), 
-              link_to("Edit Pipeline", change_re_pipeline_path(@re_pipeline), :class => "pipeline-change") %>
+<% set_re_breadcrumbs link_to("All Pipelines", re_pipelines_path, :class => "re-pipeline-list"), 
+											link_to("View Pipelines", re_pipeline_path(@re_pipeline), :class => "re-pipeline-show"), 
+											link_to("Edit Pipelines", change_re_pipeline_path(@re_pipeline), :class => "re-pipeline-change"), 
+											'<span class="re-rule-edit">Edit Rule</span>' %>
 																	
-<div class="prepend-1 span-22 append-1">      
-  <div class="infobox">
+<div class="prepend-1 span-20 append-1">      
+  <div class="re-infobox">
     <%= render :partial => 'edit' %>
     <div class="clear"></div>
   </div>  

data/rails_generators/templates/app/views/re_rules/edit.js.erb

@@ -1,5 +1,8 @@
-$('#tb_temp_container').html('<%=escape_javascript(render(:partial => 'edit'))%>');
+$('#re_content').html('<%=escape_javascript(render(:partial => 'edit'))%>');
 
-$('#rule_edit_update').closest('div.form-button').dougo_form_button(); 
+$('#re_rule_edit_update').closest('div.re-form-button').re_form_button(); 
 
-$("#rule_edit_form").submit(function() { return false; });
+$("#re_rule_edit_form").submit(function() { return false; });
+
+$.re_unblock();
+$.fancybox({ href: '#re_content'});

data/rails_generators/templates/app/views/re_rules/error.html.erb

@@ -1,9 +1,10 @@
-<% set_subnav "Rule Error", 
-              link_to("All Pipelines", re_pipelines_path, :class => "pipeline-list"), 
-              link_to("Edit Pipeline", change_re_pipeline_path(@re_pipeline), :class => "pipeline-change") %>
+<% set_re_breadcrumbs link_to("All Pipelines", re_pipelines_path, :class => "re-pipeline-list"), 
+											link_to("View Pipelines", re_pipeline_path(@re_pipeline), :class => "re-pipeline-show"), 
+											link_to("Edit Pipelines", change_re_pipeline_path(@re_pipeline), :class => "re-pipeline-change"), 
+											'<span class="re-rule-error">Rule Error</span>' %>
 
-<div class="prepend-1 span-22 append-1">      
-  <div class="infobox">
+<div class="prepend-1 span-20 append-1">      
+  <div class="re-infobox">
     <%= render :partial => 'error' %>
     <div class="clear"></div>
   </div>  

data/rails_generators/templates/app/views/re_rules/error.js.erb

@@ -1,3 +1,7 @@
-<%= javascript_alert_messages %>
+<%= re_alert_js %>
+
+$('#re_content').html('<%=escape_javascript(render(:partial => 'error'))%>');
+
+$.re_unblock();
+$.fancybox({ href: '#re_content'});          
 
-$('#tb_temp_container').html('<%=escape_javascript(render(:partial => 'error'))%>');

data/rails_generators/templates/app/views/re_rules/help.html.erb

@@ -1,9 +1,10 @@
-<% set_subnav "Help #{@rule_class.options[:name]}", 
-              link_to("All Pipelines", re_pipelines_path, :class => "pipeline-list"), 
-              link_to("Edit Pipeline", change_re_pipeline_path(@re_pipeline), :class => "pipeline-change") %>
+<% set_re_breadcrumbs link_to("All Pipelines", re_pipelines_path, :class => "re-pipeline-list"), 
+											link_to("View Pipelines", re_pipeline_path(@re_pipeline), :class => "re-pipeline-show"), 
+											link_to("Edit Pipelines", change_re_pipeline_path(@re_pipeline), :class => "re-pipeline-change"), 
+											'<span class="re-rule-help">Rule Help</span>' %>
 
-<div class="prepend-1 span-22 append-1">      
-  <div class="infobox">
+<div class="prepend-1 span-20 append-1">      
+  <div class="re-infobox">
     <%= render :partial => 'help' %>
     <div class="clear"></div>
   </div>  

data/rails_generators/templates/app/views/re_rules/help.js.erb

@@ -1,2 +1,4 @@
-$('#tb_temp_container').html('<%=escape_javascript(render(:partial => 'help'))%>');
+$('#re_content').html('<%=escape_javascript(render(:partial => 'help'))%>');
 
+$.re_unblock();
+$.fancybox({ href: '#re_content'});          

data/rails_generators/templates/app/views/re_rules/new.html.erb

@@ -1,11 +1,15 @@
-<% set_subnav @re_pipeline.title, 
-              link_to("All Pipelines", re_pipelines_path, :class => "pipeline-list"), 
-              link_to("Edit Pipeline", change_re_pipeline_path(@re_pipeline), :class => "pipeline-change") %>
+<% set_re_breadcrumbs link_to("All Pipelines", re_pipelines_path, :class => "re-pipeline-list"), 
+											link_to("View Pipelines", re_pipeline_path(@re_pipeline), :class => "re-pipeline-show"), 
+											link_to("Edit Pipelines", change_re_pipeline_path(@re_pipeline), :class => "re-pipeline-change"), 
+											'<span class="re-rule-new">New Rule</span>' %>
 
-<div class="prepend-1 span-22 append-1">      
-  <div class="infobox">
-    <%= render :partial => 'new' %>
-    <div class="clear"></div>
-  </div>  
-</div>  
-<div class="clear"></div>
+<div class="prepend-1 span-20 append-1">      
+	<div class="re-infobox">
+		<div class="prepend-1 span-18 append-1">      
+    	<%= render :partial => 'new' %>
+    	<div class="clear"></div>
+  	</div>  
+		<div class="clear"></div>
+	</div>  
+	<div class="clear"></div>
+</div>	

data/rails_generators/templates/app/views/re_rules/new.js.erb

@@ -1,5 +1,9 @@
-$('#tb_temp_container').html('<%=escape_javascript(render(:partial => 'new'))%>');
+$('#re_content').html('<%=escape_javascript(render(:partial => 'new'))%>');
 
-$('#rule_new_insert').closest('div.form-button').dougo_form_button(); 
+$('#re_rule_new_insert').closest('div.re-form-button').re_form_button(); 
 
-$("#rule_new_form").submit(function() { return false; });
+$("#re_rule_new_form").submit(function() { return false; });
+
+$.re_unblock();
+$.fancybox({ href: '#re_content'});
+$.fancybox.resize();

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

@@ -1,20 +1,21 @@
-<%= javascript_alert_messages %>
+$.fancybox.close();
+$.re_unblock();
 
-self.parent.tb_remove();
+<%= re_alert_js %>
 
-$('#change_pipeline').html('<%=escape_javascript(render('/re_pipelines/change'))%>');
-$('#change_pipeline_actions').html('<%=escape_javascript(render('/re_pipelines/change_actions'))%>');
+$('#re_pipeline_change').html('<%=escape_javascript(render('/re_pipelines/change'))%>');
+$('#re_pipeline_change_actions').html('<%=escape_javascript(render('/re_pipelines/change_actions'))%>');
 
 <%= render('/re_rules/empty', :re_pipeline => @re_pipeline) %>
 
-$('#change_rules').html('')
+$('#re_rules_change').html('')
 <% @re_pipeline.re_rules.each do |re_rule | %>
-  $('#change_rules').append('<%=escape_javascript(render('/re_rules/change', :re_rule => re_rule, :first_rule => re_rule == @re_pipeline.re_rules[0], :last_rule => re_rule == @re_pipeline.re_rules[-1]))%>');
+  $('#re_rules_change').append('<%=escape_javascript(render('/re_rules/change', :re_rule => re_rule, :first_rule => re_rule == @re_pipeline.re_rules[0], :last_rule => re_rule == @re_pipeline.re_rules[-1]))%>');
 <% end %>
 
-$('#change_rule_<%=@re_rule.id%>').attr('style', 'background-color: #fff6bf;');
-$('#change_rule_<%=@re_rule.id%>').fadeTo(750, 0.44, function() {
-  $('#change_rule_<%=@re_rule.id%>').attr('style', '');
-  $('#change_rule_<%=@re_rule.id%>').fadeTo(1000, 1.00, function() {
+$('#re_rule_change_<%=@re_rule.id%> .re-bluebox:first').attr('style', 'background-color: #fff6bf;');
+$('#re_rule_change_<%=@re_rule.id%> .re-bluebox:first').fadeTo(750, 0.85, function() {
+  $('#re_rule_change_<%=@re_rule.id%> .re-bluebox:first').attr('style', '');
+  $('#re_rule_change_<%=@re_rule.id%> .re-bluebox:first').fadeTo(1000, 1.00, function() {
   });
 });

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

@@ -21,20 +21,21 @@ class CreateRePipelines < ActiveRecord::Migration
       
       t.integer :position
 
-      t.string  :rule_class
+      t.string  :rule_class_name
 
       t.string  :title
       t.string  :summary      
-      t.integer :data_version
-      t.text    :data      
-      t.string  :error
+      t.text    :data
       
       t.datetime :created_at
       t.datetime :updated_at
     end
 
+    add_index :re_rules, [:re_pipeline_id]
+    add_index :re_rules, [:re_pipeline_id, :position]
+
     #################################
-    create_table :re_rule_outcomes do |t|
+    create_table :re_rule_expected_outcomes do |t|
       t.integer :re_rule_id
       
       t.integer :outcome
@@ -43,6 +44,7 @@ class CreateRePipelines < ActiveRecord::Migration
       t.datetime :created_at
       t.datetime :updated_at
     end    
+    add_index :re_rule_expected_outcomes, [:re_rule_id]
     
     #################################
     create_table :re_jobs do |t|
@@ -57,17 +59,18 @@ class CreateRePipelines < ActiveRecord::Migration
             
       t.datetime :audit_date
       t.integer  :audit_code
-      t.boolean  :audit_success
-      t.text     :audit_data      
-      
+      t.string   :audit_message            
     end    
-    
+
+    add_index :re_job_audits, [:re_job_id]
+    add_index :re_job_audits, [:re_pipeline_id]
+    add_index :re_job_audits, [:audit_date]
   end
 
   def self.down
     drop_table :re_job_audits
     drop_table :re_jobs
-    drop_table :re_rule_outcomes
+    drop_table :re_rule_expected_outcomes
     drop_table :re_rules
     drop_table :re_pipelines
   end

data/rails_generators/templates/doc/README.rules_engine

@@ -0,0 +1,151 @@
+## Ruby and Rails Rules Engine Framework
+# More detailed documentation at http://www.r3ef.com
+
+## Installation Guide
+###################################### 
+# 1. Install the Gem
+  sudo gem install rules_engine
+  sudo gem install rspec cucumber
+
+######################################
+# 2. Create the Rails App
+  rails MyCoolNewApp	
+  cd MyCoolNewApp
+  rm ./public/index.html
+
+  ./script/generate rspec
+  ./script/generate cucumber --rspec
+
+  ./script/generate rules_engine
+
+  rake db:migrate	
+
+######################################
+# 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!
+
+ - ./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")
+
+ - ./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 "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'
+
+######################################
+# 4. Install the Required Gems
+
+rake gems:install
+rake gems:install RAILS_ENV=test  	
+
+######################################
+# 5. 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}, 
+                          :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  
+
+######################################
+# 6. Define the Access Levels
+ - ./app/controllers/application_controller.rb
+ 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
+
+######################################
+# 7. Create a Simple Rule
+  ./script/generate rules_engine simple my_simple_rule
+
+######################################
+# 8. Create a more Complex Rule
+  ./script/generate rules_engine complex another_complex_rule
+
+######################################
+# 9. Run the Tests
+  rake spec
+  rake spec:rcov
+  rake cucumber
+  open coverage/index.html
+
+######################################
+# 10. Start the Server
+  ./script/server
+  open http://localhost:3000/re_pipelines
+
+######################################
+# 11. Create Pipelines and Rules
+  Watch the demo at "TODO":http://www.r3ef.com/