rules_engine_templates 0.0.2 → 0.0.3

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/rails_generators/manifests/plan_start.rb

@@ -0,0 +1,26 @@
+class PlanStartManifest
+  def self.populate_record(m, rule_name ,rule_class)
+
+    %W(
+      app/rules
+      app/views/re_rule_definitions/#{rule_name}
+      lib/tasks
+      spec/lib/rules
+    ).each do |dirname|
+      m.directory dirname
+    end
+
+    %W(
+    ).each do |filename|
+      m.file filename, filename
+    end
+
+   m.template "app/rules/plan_start.rb",  "app/rules/#{rule_name}.rb"
+   m.template "app/views/re_rule_definitions/plan_start/_edit.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_edit.html.erb"
+   m.template "app/views/re_rule_definitions/plan_start/_form.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_form.html.erb"
+   m.template "app/views/re_rule_definitions/plan_start/_help.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_help.html.erb"
+   m.template "app/views/re_rule_definitions/plan_start/_new.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_new.html.erb"
+   m.template "spec/lib/rules/plan_start_spec.rb",  "spec/lib/rules/#{rule_name}_spec.rb"
+
+  end
+end

data/rails_generators/manifests/plan_start.yml

@@ -0,0 +1,20 @@
+directories :
+  - app/rules
+  - spec/lib/rules
+  - lib/tasks
+
+templates :
+  replacements :
+    - plan_start : rule_name
+    - PlanStart : rule_class
+    
+  directories : 
+    - app/views/re_rule_definitions/plan_start
+
+  files : 
+    - app/rules/plan_start.rb
+    - app/views/re_rule_definitions/plan_start/_edit.html.erb
+    - app/views/re_rule_definitions/plan_start/_form.html.erb
+    - app/views/re_rule_definitions/plan_start/_help.html.erb
+    - app/views/re_rule_definitions/plan_start/_new.html.erb
+    - spec/lib/rules/plan_start_spec.rb

data/rails_generators/manifests/tweet_filter.rb

@@ -17,12 +17,10 @@ class TweetFilterManifest
 
    m.template "app/rules/tweet_filter.rb",  "app/rules/#{rule_name}.rb"
    m.template "app/views/re_rule_definitions/tweet_filter/_edit.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_edit.html.erb"
+   m.template "app/views/re_rule_definitions/tweet_filter/_form.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_form.html.erb"
+   m.template "app/views/re_rule_definitions/tweet_filter/_form_word.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_form_word.html.erb"
    m.template "app/views/re_rule_definitions/tweet_filter/_help.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_help.html.erb"
    m.template "app/views/re_rule_definitions/tweet_filter/_new.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_new.html.erb"
-   m.template "app/views/re_rule_definitions/tweet_filter/_script.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_script.html.erb"
-   m.template "app/views/re_rule_definitions/tweet_filter/_title.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_title.html.erb"
-   m.template "app/views/re_rule_definitions/tweet_filter/_word.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_word.html.erb"
-   m.template "app/views/re_rule_definitions/tweet_filter/_words.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_words.html.erb"
    m.template "spec/lib/rules/tweet_filter_spec.rb",  "spec/lib/rules/#{rule_name}_spec.rb"
 
   end

data/rails_generators/manifests/tweet_filter.yml

@@ -14,11 +14,8 @@ templates :
   files : 
     - app/rules/tweet_filter.rb
     - app/views/re_rule_definitions/tweet_filter/_edit.html.erb
+    - app/views/re_rule_definitions/tweet_filter/_form_word.html.erb
+    - app/views/re_rule_definitions/tweet_filter/_form.html.erb
     - app/views/re_rule_definitions/tweet_filter/_help.html.erb
     - app/views/re_rule_definitions/tweet_filter/_new.html.erb
-    - app/views/re_rule_definitions/tweet_filter/_script.html.erb
-    - app/views/re_rule_definitions/tweet_filter/_title.html.erb
-    - app/views/re_rule_definitions/tweet_filter/_word.html.erb
-    - app/views/re_rule_definitions/tweet_filter/_words.html.erb
     - spec/lib/rules/tweet_filter_spec.rb
-  

data/rails_generators/manifests/tweet_reader.rb

@@ -0,0 +1,26 @@
+class TweetReaderManifest
+  def self.populate_record(m, rule_name ,rule_class)
+
+    %W(
+      app/rules
+      app/views/re_rule_definitions/#{rule_name}
+      lib/tasks
+      spec/lib/rules
+    ).each do |dirname|
+      m.directory dirname
+    end
+
+    %W(
+    ).each do |filename|
+      m.file filename, filename
+    end
+
+   m.template "app/rules/tweet_reader.rb",  "app/rules/#{rule_name}.rb"
+   m.template "app/views/re_rule_definitions/tweet_reader/_edit.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_edit.html.erb"
+   m.template "app/views/re_rule_definitions/tweet_reader/_form.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_form.html.erb"
+   m.template "app/views/re_rule_definitions/tweet_reader/_help.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_help.html.erb"
+   m.template "app/views/re_rule_definitions/tweet_reader/_new.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_new.html.erb"
+   m.template "spec/lib/rules/tweet_reader_spec.rb",  "spec/lib/rules/#{rule_name}_spec.rb"
+
+  end
+end

data/rails_generators/manifests/tweet_reader.yml

@@ -0,0 +1,20 @@
+directories :
+  - app/rules
+  - spec/lib/rules
+  - lib/tasks
+
+templates :
+  replacements :
+    - tweet_reader : rule_name
+    - TweetReader : rule_class
+    
+  directories : 
+    - app/views/re_rule_definitions/tweet_reader
+
+  files : 
+    - app/rules/tweet_reader.rb
+    - app/views/re_rule_definitions/tweet_reader/_edit.html.erb
+    - app/views/re_rule_definitions/tweet_reader/_form.html.erb
+    - app/views/re_rule_definitions/tweet_reader/_help.html.erb
+    - app/views/re_rule_definitions/tweet_reader/_new.html.erb
+    - spec/lib/rules/tweet_reader_spec.rb

data/rails_generators/manifests/workflow_start.rb

@@ -0,0 +1,26 @@
+class WorkflowStartManifest
+  def self.populate_record(m, rule_name ,rule_class)
+
+    %W(
+      app/rules
+      app/views/re_rule_definitions/#{rule_name}
+      lib/tasks
+      spec/lib/rules
+    ).each do |dirname|
+      m.directory dirname
+    end
+
+    %W(
+    ).each do |filename|
+      m.file filename, filename
+    end
+
+   m.template "app/rules/workflow_start.rb",  "app/rules/#{rule_name}.rb"
+   m.template "app/views/re_rule_definitions/workflow_start/_edit.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_edit.html.erb"
+   m.template "app/views/re_rule_definitions/workflow_start/_form.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_form.html.erb"
+   m.template "app/views/re_rule_definitions/workflow_start/_help.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_help.html.erb"
+   m.template "app/views/re_rule_definitions/workflow_start/_new.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_new.html.erb"
+   m.template "spec/lib/rules/workflow_start_spec.rb",  "spec/lib/rules/#{rule_name}_spec.rb"
+
+  end
+end

data/rails_generators/manifests/workflow_start.yml

@@ -0,0 +1,20 @@
+directories :
+  - app/rules
+  - spec/lib/rules
+  - lib/tasks
+
+templates :
+  replacements :
+    - workflow_start : rule_name
+    - WorkflowStart : rule_class
+    
+  directories : 
+    - app/views/re_rule_definitions/workflow_start
+
+  files : 
+    - app/rules/workflow_start.rb
+    - app/views/re_rule_definitions/workflow_start/_edit.html.erb
+    - app/views/re_rule_definitions/workflow_start/_form.html.erb
+    - app/views/re_rule_definitions/workflow_start/_help.html.erb
+    - app/views/re_rule_definitions/workflow_start/_new.html.erb
+    - spec/lib/rules/workflow_start_spec.rb

data/rails_generators/manifests/workflow_stop.rb

@@ -0,0 +1,26 @@
+class WorkflowStopManifest
+  def self.populate_record(m, rule_name ,rule_class)
+
+    %W(
+      app/rules
+      app/views/re_rule_definitions/#{rule_name}
+      lib/tasks
+      spec/lib/rules
+    ).each do |dirname|
+      m.directory dirname
+    end
+
+    %W(
+    ).each do |filename|
+      m.file filename, filename
+    end
+
+   m.template "app/rules/workflow_stop.rb",  "app/rules/#{rule_name}.rb"
+   m.template "app/views/re_rule_definitions/workflow_stop/_edit.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_edit.html.erb"
+   m.template "app/views/re_rule_definitions/workflow_stop/_form.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_form.html.erb"
+   m.template "app/views/re_rule_definitions/workflow_stop/_help.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_help.html.erb"
+   m.template "app/views/re_rule_definitions/workflow_stop/_new.html.erb",  "app/views/re_rule_definitions/#{rule_name}/_new.html.erb"
+   m.template "spec/lib/rules/workflow_stop_spec.rb",  "spec/lib/rules/#{rule_name}_spec.rb"
+
+  end
+end

data/rails_generators/manifests/workflow_stop.yml

@@ -0,0 +1,20 @@
+directories :
+  - app/rules
+  - spec/lib/rules
+  - lib/tasks
+
+templates :
+  replacements :
+    - workflow_stop : rule_name
+    - WorkflowStop : rule_class
+    
+  directories : 
+    - app/views/re_rule_definitions/workflow_stop
+
+  files : 
+    - app/rules/workflow_stop.rb
+    - app/views/re_rule_definitions/workflow_stop/_edit.html.erb
+    - app/views/re_rule_definitions/workflow_stop/_form.html.erb
+    - app/views/re_rule_definitions/workflow_stop/_help.html.erb
+    - app/views/re_rule_definitions/workflow_stop/_new.html.erb
+    - spec/lib/rules/workflow_stop_spec.rb

data/rails_generators/templates/app/rules/plan_start.rb

@@ -0,0 +1,89 @@
+module RulesEngine
+  module Rule
+    class <%=rule_class%> < RulesEngine::Rule::Definition
+
+      attr_reader :plan
+
+      ##################################################################
+      # class options
+      self.options = 
+        {
+          :group => 'Workflow',
+          :display_name => 'Plan Start',    
+          :help_partial => '/re_rule_definitions/<%=rule_name%>/help',
+          :new_partial => '/re_rule_definitions/<%=rule_name%>/new',
+          :edit_partial => '/re_rule_definitions/<%=rule_name%>/edit'
+        } 
+  
+      ##################################################################
+      # set the rule data
+      def data= data
+        if data.nil?
+          @title = nil
+          @plan = nil
+        else
+          @title, @plan = ActiveSupport::JSON.decode(data)
+        end  
+      end
+  
+      ##################################################################
+      # get the rule attributes
+      def title
+        @title
+      end
+
+      def summary
+        "Run the plan : #{plan}"
+      end
+  
+      def data
+        [title, plan].to_json
+      end
+  
+      def expected_outcomes
+        [{:outcome => RulesEngine::Rule::Outcome::NEXT}, {:outcome => RulesEngine::Rule::Outcome::STOP_FAILURE}]
+      end
+  
+      ##################################################################
+      # set the rule attributes
+      def attributes=(params)
+        param_hash = params.symbolize_keys
+
+        @title = param_hash[:<%=rule_name%>_title]
+        @plan = param_hash[:<%=rule_name%>_plan]
+      end
+  
+      ##################################################################
+      # validation and errors
+      def valid?
+        @errors = {}
+        @errors[:<%=rule_name%>_title] = "Title required" if title.blank?    
+        @errors[:<%=rule_name%>_plan] = "Plan required" if plan.blank?
+        return @errors.empty?
+      end
+
+      ##################################################################
+      # callbacks when the rule is added and removed from a workflow
+      def before_create()
+      end
+  
+      def before_update()
+      end
+      
+      def before_destroy()
+      end
+  
+      ##################################################################
+      # execute the rule
+      def process(process_id, data)
+        sub_process_id = RulesEngine::Process.runner.create  
+        
+        RulesEngine::Process.auditor.audit(process_id, "Starting Sub Plan #{sub_process_id}", RulesEngine::Process::AUDIT_INFO)
+        success = RulesEngine::Process.runner.run(sub_process_id, plan, data)
+        RulesEngine::Process.auditor.audit(process_id, "Finished Sub Plan #{sub_process_id}", success ? RulesEngine::Process::AUDIT_SUCCESS : RulesEngine::Process::AUDIT_FAILURE)
+        
+        return success ? RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::NEXT) : RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::STOP_FAILURE)
+      end  
+    end
+  end
+end  

data/rails_generators/templates/app/rules/tweet_filter.rb

@@ -72,10 +72,13 @@ module RulesEngine
 
       ##################################################################
       # callbacks when the rule is added and removed from a workflow
-      def after_add_to_workflow(workflow_code)
+      def before_create()
       end
   
-      def before_remove_from_workflow(workflow_code)
+      def before_update()
+      end
+      
+      def before_destroy()
       end
   
       ##################################################################
@@ -91,7 +94,7 @@ module RulesEngine
     
         words.each do |word|
           if /#{word}/i =~ tweet        
-            RulesEngine::Process.auditor.audit(process_id, "#{title} Found #{word}", RulesEngine::Process::AUDIT_INFO)
+            RulesEngine::Process.auditor.audit(process_id, "Found #{word}", RulesEngine::Process::AUDIT_INFO)
             data[:match] = word
             return RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::STOP_SUCCESS)
           end

data/rails_generators/templates/app/rules/tweet_reader.rb

@@ -0,0 +1,99 @@
+require 'twitter'
+
+MAX_PAGES = 5     unless defined?(MAX_PAGES)
+TWITTER_RPP = 40  unless defined?(TWITTER_RPP)
+
+module RulesEngine
+  module Rule
+    class <%=rule_class%> < RulesEngine::Rule::Definition
+
+      attr_reader :message
+      attr_reader :plan
+
+      ##################################################################
+      # class options
+      self.options = 
+        {
+          :group => 'Twitter',
+          :display_name => 'Twitter Reader',    
+          :help_partial => '/re_rule_definitions/<%=rule_name%>/help',
+          :new_partial => '/re_rule_definitions/<%=rule_name%>/new',
+          :edit_partial => '/re_rule_definitions/<%=rule_name%>/edit'
+        } 
+  
+      ##################################################################
+      # set the rule data
+      def data= data
+        if data.nil?
+          @title = nil
+          @message = nil
+          @plan = nil
+        else
+          @title, @message, @plan = ActiveSupport::JSON.decode(data)
+        end  
+      end
+  
+      ##################################################################
+      # get the rule attributes
+      def title
+        @title
+      end
+
+      def summary
+        "Look for \"#{message}\" and send matches to the plan : #{plan}"
+      end
+  
+      def data
+        [title, message, plan].to_json
+      end
+  
+      def expected_outcomes
+        [{:outcome => RulesEngine::Rule::Outcome::NEXT}, {:outcome => RulesEngine::Rule::Outcome::STOP_FAILURE}]
+      end
+  
+      ##################################################################
+      # set the rule attributes
+      def attributes=(params)
+        param_hash = params.symbolize_keys
+
+        @title = param_hash[:<%=rule_name%>_title]
+        @message = param_hash[:<%=rule_name%>_message]
+        @plan = param_hash[:<%=rule_name%>_plan]
+      end
+  
+      ##################################################################
+      # validation and errors
+      def valid?
+        @errors = {}
+        @errors[:<%=rule_name%>_title] = "Title required" if title.blank?    
+        @errors[:<%=rule_name%>_message] = "Message required" if message.blank?    
+        @errors[:<%=rule_name%>_plan] = "Plan required" if plan.blank?
+        return @errors.empty?
+      end
+
+      ##################################################################
+      # callbacks when the rule is added and removed from a workflow
+      def before_create()
+      end
+  
+      def before_update()
+      end
+      
+      def before_destroy()
+      end
+  
+      ##################################################################
+      # execute the rule
+      def process(process_id, data)
+        
+        sub_process_id = RulesEngine::Process.runner.create  
+        
+        RulesEngine::Process.auditor.audit(process_id, "Starting Sub Plan #{sub_process_id}", RulesEngine::Process::AUDIT_INFO)
+        success = RulesEngine::Process.runner.run(sub_process_id, plan, data.merge(:message => message))
+        RulesEngine::Process.auditor.audit(process_id, "Finished Sub Plan #{sub_process_id}", success ? RulesEngine::Process::AUDIT_SUCCESS : RulesEngine::Process::AUDIT_FAILURE)
+        
+        return success ? RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::NEXT) : RulesEngine::Rule::Outcome.new(RulesEngine::Rule::Outcome::STOP_FAILURE)
+      end  
+    end
+  end
+end