rules_engine 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Chris Douglas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= dougo_rules_engine
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Chris Douglas. See LICENSE for details.

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/init.rb

@@ -0,0 +1 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/rules_engine")

data/lib/rules_engine/cache.rb

@@ -0,0 +1,26 @@
+module RulesEngine
+  module Cache
+    # Configuration examples (MemoryStore is the default):
+    #
+    #   RulesEngine::SelectorCache.cache_store = :memory_store
+    #   RulesEngine::SelectorCache.cache_store = :file_store, "/path/to/cache/directory"
+    #   RulesEngine::SelectorCache.cache_store = :drb_store, "druby://localhost:9192"
+    #   RulesEngine::SelectorCache.cache_store = :mem_cache_store, "localhost"
+    #   RulesEngine::SelectorCache.cache_store = MyOwnStore.new("parameter")
+
+    class << self
+      def perform_caching?
+        !@cache_store.nil? 
+      end
+
+      def cache_store=(store_option)
+        @cache_store = ActiveSupport::Cache.lookup_store(store_option)
+      end
+
+      def cache_store
+        @cache_store 
+      end      
+    end
+    
+  end
+end

data/lib/rules_engine/discovery.rb

@@ -0,0 +1,51 @@
+module RulesEngine
+  ##################################################################
+  class Discovery
+    
+    RULES_PATH = File.expand_path(File.join(RAILS_ROOT, '/app/rules'))
+    @rule_classes = nil
+    @rule_groups = nil
+        
+    class << self
+      def discover!
+        @rule_classes = []
+        @rule_groups = {}
+        
+        Dir.glob("#{ RULES_PATH }/**/*.rb").each do |rule| 
+          require rule
+          
+          rule_class = Kernel.const_get(File.basename(rule, '.rb').classify)
+          @rule_classes << rule_class
+          
+          group = rule_class.options[:group]
+          @rule_groups[group] = [] unless @rule_groups.include?(group)
+          @rule_groups[group] << rule_class
+          
+        end  
+        
+        @rule_classes.sort! { |left, right| return left.to_s < right.to_s}
+        @rule_groups.each { |group, rule_classes| rule_classes.sort!  { |left, right| return left.to_s < right.to_s} }
+        @rule_groups.each { |key, value| value.sort }
+      end
+    
+      def rule_classes
+        throw Exception.new("RulesEngine::Discovery.discover! required in environment.rb") if @rule_classes.nil?
+        @rule_classes
+      end
+
+      def rule_groups
+        throw Exception.new("RulesEngine::Discovery.discover! required in environment.rb") if @rule_classes.nil?
+        @rule_groups
+      end
+    
+      def rule_class(rule_class)
+        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
+        end
+        nil
+      end
+    end
+  end
+end
+

data/lib/rules_engine/job_runner.rb

@@ -0,0 +1,115 @@
+module RulesEngine  
+  class JobRunner
+    
+    @@max_rules = 500
+    
+    def self.create_job()
+      ReJob.create(:job_status => ReJob::JOB_STATUS_NONE).id
+    end
+    
+    def self.run_pipleine(re_job_id, pipeline_code, data = {})
+      rule_count = 0
+      done = false
+      error = false      
+      
+      re_job = ReJob.find_by_id(re_job_id)
+      re_job.update_attributes(:job_status => ReJob::JOB_STATUS_RUNNING) unless re_job.nil?
+      
+      while (!done && rule_count < @@max_rules)
+        rule_count += 1 
+        
+        activated_pipeline = RePipelineActivated.find_by_code(pipeline_code)
+        unless activated_pipeline
+          audit_pipeline(re_job_id, nil, ReJobAudit::AUDIT_PIPELINE_END, false, "Pipleine #{pipeline_code} not found") 
+          error = done = true 
+          next
+        end  
+        re_pipeline_id = activated_pipeline.re_pipeline.id
+        
+        audit_pipeline(re_job_id, re_pipeline_id, ReJobAudit::AUDIT_PIPELINE_START, true, "Pipleine #{pipeline_code} started") 
+        
+        activated_pipeline.re_rules.each do | re_rule |
+          rule_class = RulesEngine::Discovery.rule_class(re_rule.rule_class)
+          unless rule_class
+            audit_pipeline(re_job_id, re_pipeline_id, ReJobAudit::AUDIT_PIPELINE_END, false, "Rule #{re_rule.rule_class} not found") 
+            error = done = true 
+            break 
+          end  
+        
+          rule = rule_class.new
+          unless rule.load(re_rule)
+            audit_pipeline(re_job_id, re_pipeline_id, ReJobAudit::AUDIT_PIPELINE_END, false, "Rule #{re_rule.rule_class} cannot load")
+            error = done = true 
+            break 
+          end  
+        
+          audit_pipeline(re_job_id, re_pipeline_id, ReJobAudit::AUDIT_PIPELINE_INFO, true, "Rule #{re_rule.title} starting")
+          rule_outcome = rule.process(re_job_id, data)
+          audit_pipeline(re_job_id, re_pipeline_id, ReJobAudit::AUDIT_PIPELINE_INFO, true, "Rule #{re_rule.title} finished")
+        
+          if !rule_outcome.nil? && rule_outcome.outcome == RulesEngine::RuleOutcome::OUTCOME_STOP_SUCCESS
+            audit_pipeline(re_job_id, re_pipeline_id, ReJobAudit::AUDIT_PIPELINE_END, true, "Pipeline #{pipeline_code} complete")
+            done = true 
+            break
+          end
+        
+          if !rule_outcome.nil? && rule_outcome.outcome == RulesEngine::RuleOutcome::OUTCOME_STOP_FAILURE
+            audit_pipeline(re_job_id, re_pipeline_id, ReJobAudit::AUDIT_PIPELINE_END, false, "Pipeline #{pipeline_code} complete")
+            error = done = true 
+            break
+          end
+        
+          if !rule_outcome.nil? && rule_outcome.outcome == RulesEngine::RuleOutcome::OUTCOME_START_PIPELINE
+            audit_pipeline(re_job_id, re_pipeline_id, ReJobAudit::AUDIT_PIPELINE_END, true, "Pipeline #{pipeline_code} complete")
+            pipeline_code = rule_outcome.pipeline_code
+            break
+          end
+          
+          if activated_pipeline.re_rules[-1] == re_rule
+            audit_pipeline(re_job_id, re_pipeline_id, ReJobAudit::AUDIT_PIPELINE_END, true, "Pipeline #{pipeline_code} complete")
+            done = true 
+            break
+          end
+        end
+      end  
+
+      if rule_count >= @@max_rules
+        audit_pipeline(re_job_id, re_pipeline_id, ReJobAudit::AUDIT_PIPELINE_END, false, "Maximum pipeline depth #{@@max_rules} exceeded")
+        error = true
+      end
+      
+      re_job.update_attributes(:job_status => error ? ReJob::JOB_STATUS_FAILED : ReJob::JOB_STATUS_SUCCESS) unless re_job.nil?
+      
+      error
+    end
+
+    def self.audit_pipeline(re_job_id, re_pipeline_id, code, success, message)
+      ReJobAudit.create({
+        :re_job_id => re_job_id,
+        :re_pipeline_id => re_pipeline_id, 
+        :re_rule_id => nil,
+        :audit_date => Time.now,  
+        :audit_code => code,
+        :audit_success => success, 
+        :audit_data => message
+      });
+      
+      puts "#{'*' * 5} #{re_job_id}, #{re_pipeline_id}, #{code} #{success}, #{message}"
+    end
+
+    def self.audit_rule(re_job_id, re_pipeline_id, re_rule_id, code, success, message)
+      ReJobAudit.create({
+        :re_job_id => re_job_id,
+        :re_pipeline_id => re_pipeline_id, 
+        :re_rule_id => re_rule_id,
+        :audit_date => Time.now,  
+        :audit_code => code,
+        :audit_success => success, 
+        :audit_data => message
+      });
+
+      puts "#{'*' * 10} #{re_job_id}, #{re_pipeline_id}, #{re_rule_id}, #{rule_title}, #{success}, #{message}"
+    end
+        
+  end
+end

data/lib/rules_engine/rule.rb

@@ -0,0 +1,60 @@
+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
+      end
+    end
+      
+    ##################################################################
+    def attributes=(params)
+    end
+    
+    def valid?
+      true
+    end
+
+    def errors
+      @errors ||= []
+      return @errors
+    end
+
+    def load(re_rule)
+      true
+    end
+
+    def save(re_rule)
+      re_rule.rule_class = self.class.rule_class
+      true
+    end    
+    
+    def after_create(re_rule)
+    end
+    
+    def after_update(re_rule)
+    end
+    
+    def before_destroy(re_rule)
+    end
+    
+    ##################################################################
+    # return an RulesEngine::RuleOutcome object to define what to do next
+    # or nil to continue to the next rule
+    def process(job_id, data)
+      rule_outcome = RulesEngine::RuleOutcome.new
+      
+      rule_outcome.outcome = RulesEngine::RuleOutcome::OUTCOME_NEXT
+      # rule_outcome.pipeline_code = 
+      
+      rule_outcome
+    end  
+    
+  end
+end

data/lib/rules_engine/rule_outcome.rb

@@ -0,0 +1,13 @@
+module RulesEngine  
+  class RuleOutcome
+
+    OUTCOME_NEXT  =            0
+    OUTCOME_STOP_SUCCESS  =    1
+    OUTCOME_STOP_FAILURE  =    2
+    OUTCOME_START_PIPELINE  =  3
+
+    attr_accessor :outcome
+    attr_accessor :pipeline_code
+        
+  end
+end

data/lib/rules_engine.rb

@@ -0,0 +1,6 @@
+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")
+
+

data/rails_generators/USAGE

@@ -0,0 +1,68 @@
+sudo gem install dougo_view_helpers dougo_model_helpers dougo_user_helpers
+sudo gem install will_paginate acts_as_list
+
+Download and Install 'jquery.autocomplete.pack.js'  into the public/javascripts directory
+Download and Install 'jquery.blockUI.js'            into the public/javascripts directory
+Download and Install 'thickbox.js'                  into the public/javascripts directory
+
+*** RUN ./script/generate dougo_view_helpers
+*** RUN ./script/generate dougo_user_helpers
+  - FOLLOW INSTRUCTIONS
+
+*** EDIT config/environment.rb
+
+Rails::Initializer.run do |config|
+  ...
+  config.gem 'rules_engine'
+  config.gem 'acts_as_list'
+  ...
+  
+  config.active_record.observers = :re_pipeline_activated_observer
+  
+end
+  
+RulesEngine::Discovery.discover!
+
+ActionController::Base.define_access_level(:editor,   10)
+ActionController::Base.define_access_level(:reader,   9)
+
+*** EDIT config/environments/production.rb
+*** EDIT config/environments/development.rb
+*** EDIT config/environments/test.rb
+
+  RulesEngine::Cache.cache_store = :mem_cache_store, "localhost:11210"
+    #   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")
+
+
+*** EDIT config/routes.rb
+
+ActionController::Routing::Routes.draw do |map|
+  ...
+  map.resources :re_pipelines, :collection => {:lookup => :get}, :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  
+
+
+*** EDIT application.html.erb
+  <%= javascript_include_tag ... , 'jquery.blockUI', 'jquery.autocomplete.pack', 'thickbox', 're_pipeline', :cache => true %>
+  <%= stylesheet_link_tag ... , 'thickbox', 'jquery.autocomplete', 're_pipeline', :cache => true %>  
+  ...
+</head>
+<body>
+  ...  
+  <%= render :partial => '/layouts/blockUI'  %>
+</body>
+
+*** RUN rake db:migrate
+
+restart app and goto http://localhost:3000/re_pipelines

data/rails_generators/blacklist_word.yml

@@ -0,0 +1,6 @@
+directories :
+  - app/views/re_rule_definitions/blacklist_word
+  
+
+files :  
+  - app/rules/blacklist_word.rb 

data/rails_generators/blacklist_word_manifest.rb

@@ -0,0 +1,26 @@
+class BlacklistWordManifest
+  def self.populate_record(m)
+
+    %w(
+      app/rules
+      app/views/re_rule_definitions/blacklist_word
+    ).each do |dirname|
+      m.directory dirname
+    end
+
+    %w(
+      app/rules/blacklist_word.rb
+      app/views/re_rule_definitions/blacklist_word/_pipeline.html.erb
+      app/views/re_rule_definitions/blacklist_word/_title.html.erb
+      app/views/re_rule_definitions/blacklist_word/_new.html.erb
+      app/views/re_rule_definitions/blacklist_word/_help.html.erb
+      app/views/re_rule_definitions/blacklist_word/_word.html.erb
+      app/views/re_rule_definitions/blacklist_word/_script.html.erb
+      app/views/re_rule_definitions/blacklist_word/_edit.html.erb
+      app/views/re_rule_definitions/blacklist_word/_words.html.erb
+    ).each do |filename|
+      m.file filename, filename
+    end
+
+  end
+end

data/rails_generators/generator.yml

@@ -0,0 +1,58 @@
+directories :
+  - app/views/re_pipelines
+  - app/views/re_rules
+  - app/views/re_jobs
+  - app/views/re_pipeline_jobs
+  - public/stylesheets/re_pipeline
+  - public/images/re_pipeline
+  - public/images/re_rule
+  - public/images/re_rule_class
+  - public/images/re_job
+  
+
+files :  
+  - app/controllers/re_pipelines_controller.rb 
+  - app/controllers/re_rules_controller.rb
+  - app/controllers/re_jobs_controller.rb
+  - app/controllers/re_pipeline_jobs_controller.rb
+
+  - app/helpers/re_pipeline_helper.rb 
+        
+  - app/models/re_pipeline.rb           
+  - app/models/re_pipeline_activated.rb 
+  - app/models/re_pipeline_activated_observer.rb 
+  - app/models/re_pipeline_base.rb      
+  - app/models/re_rule.rb               
+  - app/models/re_rule_outcome.rb
+  - app/models/re_job.rb               
+  - app/models/re_job_audit.rb               
+
+  - app/views/layouts/_blockUI.html.erb
+
+  - db/migrate/20100308225008_create_re_pipelines.rb
+
+  - lib/tasks/re_runner.rake
+                
+  - public/javascripts/re_pipeline.js        
+  - public/javascripts/re_pipeline_change.js 
+  - public/javascripts/re_pipeline_index.js  
+  - public/javascripts/re_pipeline_new.js
+  - public/javascripts/re_pipeline_jobs.js
+  - public/javascripts/re_jobs.js  
+        
+  - public/stylesheets/re_pipeline.css
+  - public/stylesheets/re_pipeline/accept.png
+  - public/stylesheets/re_pipeline/exclamation.png
+    
+  - spec/controllers/re_pipelines_controller_spec.rb
+    
+  - spec/models/re_pipeline_base_spec.rb
+  - spec/models/re_pipeline_spec.rb
+  - spec/models/re_pipeline_activated_spec.rb
+  - spec/models/re_rule_spec.rb
+  - spec/models/re_rule_outcome_spec.rb
+  - spec/models/re_job_spec.rb
+  - spec/models/re_job_audit_spec.rb
+
+  - spec/support/blueprint_re_pipelines.rb
+