acts_as_executor 1.0.0.rc1 → 1.0.0.rc3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--tty

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gem "rake"
+gemspec

data/README.markdown

@@ -0,0 +1,97 @@
+# acts_as_executor
+
+acts_as_executor seamlessly integrates Java’s Executor framework with JRuby on Rails, enabling an application to use executors in a familiar Rails’eque way.
+
+[RubyGems][ruby_gems] | [GitHub][github] | [Travis CI][travis_ci] | [RubyDoc][ruby_doc] | [Wiki][wiki]
+
+## Features
+* **Abstraction** from low-level executor type configuration
+* **ActiveRecord** interface so creating an executor or task is as simple is creating a record
+* **Automatic Task Setup** so you can concentrate on business logic and not task management
+* **Database Persisted Configuration** so executors can be managed through migrations and seeds
+* **Logging** of executor and task states to Rails or custom logger
+
+## 1. Install
+```ruby
+gem "acts_as_executor"
+```
+...or for life on the edge, use the [master branch][github_master] [![Build Status][travis_ci_build_status]][travis_ci]
+
+```ruby
+gem "acts_as_executor", :git => "git@github.com:philostler/acts_as_executor.git"
+```
+
+## 2. Generate
+Generate models and migration using...
+
+```
+rails g acts_as_executor:install <model_name>
+```
+
+Example
+
+```
+rails g acts_as_executor:install Executor
+      create  app/models/executor.rb
+      create  app/models/executor_task.rb
+      create  db/migrate/20110922223408_create_executors.rb
+```
+
+## 3. Execute!
+You'll first need to create an executor to schedule tasks upon.
+
+```ruby
+Executor.create :name => "background"
+```
+
+These can be created on the fly at runtime (be sure to save the record before you schedule any tasks) or preconfigured via records already present in the database. The recommended method is to add the applications required executors to the database seed file and running ```rake db:seed```.
+
+Attributes ```max_tasks``` and ```schedulable``` exist on the executors model for task limiting and schedulable ability enabling. Check out the wiki documentation for details of how these work.
+
+[Using Executors][wiki_using_executors]
+
+Once you have an executor available, it's time to add some tasks. Do this like you would any associated record.
+
+```ruby
+Executor.find_by_name("background").tasks.create(:executable => "BackgroundTask",
+                                                 :arguments => { :data => "This is my data"})
+```
+
+The ```executable``` attribute references a class that must...
+
+* Be available in the load path
+* Subclass ```ActsAsExecutor::Task::Executable```
+* Define an ```execute``` method
+
+Use the provided generator to create new executables...
+
+```
+rails g acts_as_executor:executable <executable_name>
+```
+
+Example
+
+```
+rails g acts_as_executor:executable Executable
+      create  app/executables/executable.rb
+```
+
+Anything passed into the ```attributes``` hash will be available to the instance when it is executed.
+
+Attributes ```schedule```, ```start```, ```every``` and ```units``` exist on the tasks model for defining the type and periods for scheduling and their units. Check out the wiki documentation for details of how these work.
+
+[Using Tasks][wiki_using_tasks]
+
+## Compatibility
+* JRuby 1.6.x (1.8.7 and 1.9.2 modes)
+* Rails 3.x
+
+[github]: https://github.com/philostler/acts_as_executor
+[github_master]: https://github.com/philostler/acts_as_executor/tree/master
+[ruby_doc]: http://rubydoc.info/github/philostler/acts_as_executor/master/frames
+[ruby_gems]: http://rubygems.org/gems/acts_as_executor
+[travis_ci]: http://travis-ci.org/philostler/acts_as_executor
+[travis_ci_build_status]: https://secure.travis-ci.org/philostler/acts_as_executor.png
+[wiki]: https://github.com/philostler/acts_as_executor/wiki
+[wiki_using_executors]: https://github.com/philostler/acts_as_executor/wiki/Using-Executors
+[wiki_using_tasks]: https://github.com/philostler/acts_as_executor/wiki/Using-Tasks

data/Rakefile

@@ -0,0 +1,5 @@
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new :spec

data/acts_as_executor.gemspec

@@ -12,7 +12,13 @@ Gem::Specification.new do |s|
   s.summary     = %q{Java Executor framework integration for Rails}
   s.description = %q{Seamlessly integrates Java's Executor framework with JRuby on Rails}
 
-  s.files         = Dir["**/*.rb"] + Dir["*.rdoc"] + Dir["LICENSE"] + Dir["*.gemspec"]
+  s.files = Dir[".rspec"] +
+            Dir["acts_as_executor.gemspec"] +
+            Dir["Gemfile"] +
+            Dir["LICENSE"] +
+            Dir["Rakefile"] +
+            Dir["README.markdown"] +
+            Dir["**/*.rb"]
   s.require_paths = ["lib"]
 
   s.add_dependency "activemodel", ">= 3.0"

data/lib/acts_as_executor.rb

@@ -13,7 +13,7 @@ require "acts_as_executor/executor/model/class_methods"
 require "acts_as_executor/executor/model/instance_methods"
 require "acts_as_executor/executor/model/instance_support_methods"
 
-require "acts_as_executor/task/clazz"
+require "acts_as_executor/task/executable"
 require "acts_as_executor/task/schedules"
 
 require "acts_as_executor/task/model/class_methods"
@@ -21,7 +21,7 @@ require "acts_as_executor/task/model/instance_methods"
 require "acts_as_executor/task/model/instance_support_methods"
 
 require "acts_as_executor/validators/class_exists_validator"
-require "acts_as_executor/validators/class_includes_validator"
+require "acts_as_executor/validators/class_subclasses_validator"
 
 ActiveRecord::Base.send :extend, ActsAsExecutor::Executor::Model::ClassMethods
 ActiveRecord::Base.send :extend, ActsAsExecutor::Task::Model::ClassMethods

data/lib/acts_as_executor/common/instance_support_methods.rb

@@ -6,9 +6,9 @@ module ActsAsExecutor
         "\"" + executor_name + "\" " + statement
       end
 
-      def log_message executor_name, doing, task_id, clazz_name, message = ""
+      def log_message executor_name, doing, task_id, executable_name, message = ""
         if message.kind_of? Hash then message = "with \"" + message.inspect + "\"" end 
-        "\"" + executor_name + "\" " + doing + " \"" + task_id + "#" + clazz_name + "\" " + message
+        "\"" + executor_name + "\" " + doing + " \"" + task_id + "#" + executable_name + "\" " + message
       end
     end
   end

data/lib/acts_as_executor/executor/model/instance_methods.rb

@@ -25,32 +25,32 @@ module ActsAsExecutor
           tasks.all
         end
 
-        def execute clazz, task_id, schedule = nil, start = nil, every = nil, units = nil
+        def execute instance, task_id, schedule = nil, start = nil, every = nil, units = nil
           begin
             humanized_schedule = schedule ? schedule.gsub("_", " ") : "one time"
-            log.debug log_message name, "preparing", task_id, clazz.class.name, "for execution (" + humanized_schedule + ")"
+            log.debug log_message name, "preparing", task_id, instance.class.name, "for execution (" + humanized_schedule + ")"
 
             if schedulable?
               units = Java::java.util.concurrent.TimeUnit.value_of(units.upcase)
               case schedule
                 when ActsAsExecutor::Task::Schedules::ONE_SHOT
-                  future = executor.schedule clazz, start, units
+                  future = executor.schedule instance, start, units
                 when ActsAsExecutor::Task::Schedules::FIXED_DELAY
-                  future = executor.schedule_with_fixed_delay clazz, start, every, units
+                  future = executor.schedule_with_fixed_delay instance, start, every, units
                 when ActsAsExecutor::Task::Schedules::FIXED_RATE
-                  future = executor.schedule_at_fixed_rate clazz, start, every, units
+                  future = executor.schedule_at_fixed_rate instance, start, every, units
               end
             else
-              future = ActsAsExecutor::Common::FutureTask.new clazz, nil
+              future = ActsAsExecutor::Common::FutureTask.new instance, nil
               executor.execute future
             end
 
-            log.info log_message name, "enqueued", task_id, clazz.class.name
+            log.info log_message name, "enqueued", task_id, instance.class.name
             future
           rescue Java::java.util.concurrent.RejectedExecutionException
-            log.warn log_message name, "preparing", task_id, clazz.class.name, "encountered a rejected execution exception"
+            log.warn log_message name, "preparing", task_id, instance.class.name, "encountered a rejected execution exception"
           rescue Exception => exception
-            log.error log_message name, "preparing", task_id, clazz.class.name, "encountered an unexpected exception. " + exception
+            log.error log_message name, "preparing", task_id, instance.class.name, "encountered an unexpected exception. " + exception.to_s
           end
         end
 

data/lib/acts_as_executor/task/{clazz.rb → executable.rb}

@@ -1,6 +1,6 @@
 module ActsAsExecutor
   module Task
-    module Clazz
+    class Executable
       include Java::java.lang.Runnable
 
       attr_accessor :arguments

data/lib/acts_as_executor/task/model/instance_methods.rb

@@ -16,7 +16,7 @@ module ActsAsExecutor
 
           # Validations
           base.validates :executor_id, :presence => true
-          base.validates :clazz, :presence => true, :class_exists => true, :class_includes => { :includes => ActsAsExecutor::Task::Clazz }
+          base.validates :executable, :presence => true, :class_exists => true, :class_subclasses => { :superclass => ActsAsExecutor::Task::Executable }
           base.validates :schedule, :inclusion => { :in => ActsAsExecutor::Task::Schedules::ALL }, :if => "executor and executor.schedulable?"
           base.validates :start, :numericality => { :only_integer => true, :greater_than_or_equal_to => 0 }, :if => "executor and executor.schedulable?"
           base.validates :every, :numericality => { :only_integer => true, :greater_than_or_equal_to => 1 }, :if => "executor and executor.schedulable? and schedule != ActsAsExecutor::Task::Schedules::ONE_SHOT"
@@ -26,14 +26,14 @@ module ActsAsExecutor
         private
         def enqueue
           begin
-            executor.send(:log).debug log_message executor.name, "creating", id.to_s, clazz, arguments
+            executor.send(:log).debug log_message executor.name, "creating", id.to_s, executable, arguments
 
-            instance = instantiate clazz, arguments
+            instance = instantiate executable, arguments
 
             self.future = executor.send(:execute, instance, id.to_s, schedule, start, every, units)
             future.done_handler = method :done_handler
           rescue Exception => exception
-            executor.send(:log).error log_message executor.name, "creating", id.to_s, clazz, "encountered an unexpected exception. " + exception
+            executor.send(:log).error log_message executor.name, "creating", id.to_s, executable, "encountered an unexpected exception. " + exception.to_s
           end
         end
 
@@ -45,12 +45,12 @@ module ActsAsExecutor
         end
 
         def done_handler
-          executor.send(:log).debug log_message executor.name, "completed", id.to_s, clazz
+          executor.send(:log).debug log_message executor.name, "completed", id.to_s, executable
           destroy
         end
 
         def uncaught_exception_handler exception
-          executor.send(:log).error log_message executor.name, "executing", id.to_s, clazz, "encountered an uncaught exception. " + exception
+          executor.send(:log).error log_message executor.name, "executing", id.to_s, executable, "encountered an uncaught exception. " + exception.to_s
         end
 
         def cancel

data/lib/acts_as_executor/validators/class_subclasses_validator.rb

@@ -0,0 +1,11 @@
+class ClassSubclassesValidator < ActiveModel::EachValidator
+  def validate_each record, attribute, value
+    begin
+      unless Object.const_get(value).new.kind_of? options[:superclass]
+        record.errors[attribute] << "does not subclass " + options[:superclass].to_s
+      end
+    rescue NameError
+      # Ignore error if class does not exist.
+    end
+  end
+end

data/lib/acts_as_executor/version.rb

@@ -1,3 +1,3 @@
 module ActsAsExecutor
-  VERSION = "1.0.0.rc1"
+  VERSION = "1.0.0.rc3"
 end

data/lib/generators/acts_as_executor/executable/executable_generator.rb

@@ -0,0 +1,9 @@
+module ActsAsExecutor
+  class ExecutableGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("../templates", __FILE__)
+
+    def models
+      template File.join("executables", "executable.rb"), File.join("app", "executables", file_name + ".rb")
+    end
+  end
+end

data/lib/generators/acts_as_executor/executable/templates/executables/executable.rb

@@ -0,0 +1,5 @@
+class <%= class_name %> < ActsAsExecutor::Task::Executable
+  def execute
+    #
+  end
+end

data/lib/generators/acts_as_executor/install/install_generator.rb

@@ -0,0 +1,20 @@
+module ActsAsExecutor
+  class InstallGenerator < Rails::Generators::NamedBase
+    include Rails::Generators::Migration
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    def models
+      template File.join("models", "executor.rb"), File.join("app", "models", file_name + ".rb")
+      template File.join("models", "executor_task.rb"), File.join("app", "models", file_name + "_task.rb")
+    end
+
+    def migration
+      migration_template File.join("migration", "create_executors.rb"), File.join("db", "migrate", "create_" + table_name + ".rb")
+    end
+
+    def self.next_migration_number dirname
+      Time.now.utc.strftime "%Y%m%d%H%M%S"
+    end
+  end
+end

data/lib/generators/{templates → acts_as_executor/install/templates}/migration/create_executors.rb

@@ -9,7 +9,7 @@ class Create<%= class_name.pluralize %> < ActiveRecord::Migration
 
     create_table :<%= singular_table_name %>_tasks do |t|
       t.integer  :executor_id
-      t.string   :clazz
+      t.string   :executable
       t.string   :arguments
       t.string   :schedule
       t.integer  :start

data/spec/acts_as_executor_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe ActsAsExecutor do
-	it { ActsAsExecutor::VERSION.should == "1.0.0.rc1" }
+	it { ActsAsExecutor::VERSION.should == "1.0.0.rc3" }
 
   describe "#rails_initialized?" do
     context "when rails initialized" do

data/spec/common/future_task_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe ActsAsExecutor::Common::FutureTask do
-  before(:each) { @model = ActsAsExecutor::Common::FutureTask.new Clazz.make, nil }
+  before(:each) { @model = ActsAsExecutor::Common::FutureTask.new Executable.make, nil }
 
   it { @model.should be_a Java::java.util.concurrent.FutureTask }
 

data/spec/common/instance_support_methods_spec.rb

@@ -13,12 +13,12 @@ describe ActsAsExecutor::Common::InstanceSupportMethods do
 
   describe "#log_message" do
     it "should return a string" do
-      @model.send(:log_message, "name", "doing", 1.to_s, "clazz", "message").should == log_message("name", "doing", 1.to_s, "clazz", "message")
+      @model.send(:log_message, "name", "doing", 1.to_s, "executable", "message").should == log_message("name", "doing", 1.to_s, "executable", "message")
     end
 
     context "when message is a hash" do
       it "should return a string" do
-        @model.send(:log_message, "name", "doing", 1.to_s, "clazz", {:attribute_one => "attribute_one_value", :attribute_two => "attribute_two_value"}).should == log_message("name", "doing", 1.to_s, "clazz", {:attribute_one => "attribute_one_value", :attribute_two => "attribute_two_value"})
+        @model.send(:log_message, "name", "doing", 1.to_s, "executable", {:attribute_one => "attribute_one_value", :attribute_two => "attribute_two_value"}).should == log_message("name", "doing", 1.to_s, "executable", {:attribute_one => "attribute_one_value", :attribute_two => "attribute_two_value"})
       end
     end
   end

data/spec/executor/model/instance_methods_spec.rb

@@ -19,16 +19,16 @@ describe ActsAsExecutor::Executor::Model::InstanceMethods do
   end
 
   describe "#execute" do
-    before(:each) { @clazz = Clazz.make }
+    before(:each) { @executable = Executable.make }
     after(:each) { @model.send(:executor).shutdown }
 
     it "should execute a task" do
       @model.send :startup
 
-      @model.send(:log).should_receive(:debug).with log_message(@model.name, "preparing", 1.to_s, @clazz.class.name, "for execution (one time)")
-      @model.send(:log).should_receive(:info).with log_message(@model.name, "enqueued", 1.to_s, @clazz.class.name)
+      @model.send(:log).should_receive(:debug).with log_message(@model.name, "preparing", 1.to_s, @executable.class.name, "for execution (one time)")
+      @model.send(:log).should_receive(:info).with log_message(@model.name, "enqueued", 1.to_s, @executable.class.name)
 
-      future = @model.send :execute, @clazz, 1.to_s
+      future = @model.send :execute, @executable, 1.to_s
       future.get
 
       future.is_done.should be_true
@@ -38,10 +38,10 @@ describe ActsAsExecutor::Executor::Model::InstanceMethods do
       @model = Executor.make :max_tasks => 1, :schedulable => true
       @model.send :startup
 
-      @model.send(:log).should_receive(:debug).with log_message(@model.name, "preparing", 1.to_s, @clazz.class.name, "for execution (one shot)")
-      @model.send(:log).should_receive(:info).with log_message(@model.name, "enqueued", 1.to_s, @clazz.class.name)
+      @model.send(:log).should_receive(:debug).with log_message(@model.name, "preparing", 1.to_s, @executable.class.name, "for execution (one shot)")
+      @model.send(:log).should_receive(:info).with log_message(@model.name, "enqueued", 1.to_s, @executable.class.name)
 
-      future = @model.send :execute, @clazz, 1.to_s, ActsAsExecutor::Task::Schedules::ONE_SHOT, 0, nil, ActsAsExecutor::Common::Units::SECONDS
+      future = @model.send :execute, @executable, 1.to_s, ActsAsExecutor::Task::Schedules::ONE_SHOT, 0, nil, ActsAsExecutor::Common::Units::SECONDS
       future.get
 
       future.is_done.should be_true
@@ -51,10 +51,10 @@ describe ActsAsExecutor::Executor::Model::InstanceMethods do
       @model = Executor.make :max_tasks => 1, :schedulable => true
       @model.send :startup
 
-      @model.send(:log).should_receive(:debug).with log_message(@model.name, "preparing", 1.to_s, @clazz.class.name, "for execution (fixed delay)")
-      @model.send(:log).should_receive(:info).with log_message(@model.name, "enqueued", 1.to_s, @clazz.class.name)
+      @model.send(:log).should_receive(:debug).with log_message(@model.name, "preparing", 1.to_s, @executable.class.name, "for execution (fixed delay)")
+      @model.send(:log).should_receive(:info).with log_message(@model.name, "enqueued", 1.to_s, @executable.class.name)
 
-      future = @model.send :execute, @clazz, 1.to_s, ActsAsExecutor::Task::Schedules::FIXED_DELAY, 0, 2, ActsAsExecutor::Common::Units::SECONDS
+      future = @model.send :execute, @executable, 1.to_s, ActsAsExecutor::Task::Schedules::FIXED_DELAY, 0, 2, ActsAsExecutor::Common::Units::SECONDS
 
       future.should_not be_nil
     end
@@ -63,10 +63,10 @@ describe ActsAsExecutor::Executor::Model::InstanceMethods do
       @model = Executor.make :max_tasks => 1, :schedulable => true
       @model.send :startup
 
-      @model.send(:log).should_receive(:debug).with log_message(@model.name, "preparing", 1.to_s, @clazz.class.name, "for execution (fixed rate)")
-      @model.send(:log).should_receive(:info).with log_message(@model.name, "enqueued", 1.to_s, @clazz.class.name)
+      @model.send(:log).should_receive(:debug).with log_message(@model.name, "preparing", 1.to_s, @executable.class.name, "for execution (fixed rate)")
+      @model.send(:log).should_receive(:info).with log_message(@model.name, "enqueued", 1.to_s, @executable.class.name)
 
-      future = @model.send :execute, @clazz, 1.to_s, ActsAsExecutor::Task::Schedules::FIXED_RATE, 0, 2, ActsAsExecutor::Common::Units::SECONDS
+      future = @model.send :execute, @executable, 1.to_s, ActsAsExecutor::Task::Schedules::FIXED_RATE, 0, 2, ActsAsExecutor::Common::Units::SECONDS
 
       future.should_not be_nil
     end
@@ -75,11 +75,11 @@ describe ActsAsExecutor::Executor::Model::InstanceMethods do
       it "should log exception" do
         @model.send :startup
 
-        @model.send(:log).should_receive(:debug).with log_message(@model.name, "preparing", 1.to_s, @clazz.class.name, "for execution (one time)")
+        @model.send(:log).should_receive(:debug).with log_message(@model.name, "preparing", 1.to_s, @executable.class.name, "for execution (one time)")
         @model.send(:executor).should_receive(:execute).and_raise Java::java.util.concurrent.RejectedExecutionException.new
-        @model.send(:log).should_receive(:warn).with log_message(@model.name, "preparing", 1.to_s, @clazz.class.name, "encountered a rejected execution exception")
+        @model.send(:log).should_receive(:warn).with log_message(@model.name, "preparing", 1.to_s, @executable.class.name, "encountered a rejected execution exception")
 
-        @model.send :execute, @clazz, 1.to_s
+        @model.send :execute, @executable, 1.to_s
       end
     end
 
@@ -88,10 +88,10 @@ describe ActsAsExecutor::Executor::Model::InstanceMethods do
         @model = Executor.make :max_tasks => 1, :schedulable => true
         @model.send :startup
 
-        @model.send(:log).should_receive(:debug).with log_message(@model.name, "preparing", 1.to_s, @clazz.class.name, "for execution (one time)")
-        @model.send(:log).should_receive(:error).with log_message(@model.name, "preparing", 1.to_s, @clazz.class.name, "encountered an unexpected exception. java.lang.IllegalArgumentException: No enum const class java.util.concurrent.TimeUnit.RANDOM")
+        @model.send(:log).should_receive(:debug).with log_message(@model.name, "preparing", 1.to_s, @executable.class.name, "for execution (one time)")
+        @model.send(:log).should_receive(:error).with log_message(@model.name, "preparing", 1.to_s, @executable.class.name, "encountered an unexpected exception. java.lang.IllegalArgumentException: No enum const class java.util.concurrent.TimeUnit.RANDOM")
 
-        @model.send :execute, @clazz, 1.to_s, nil, nil, nil, "random"
+        @model.send :execute, @executable, 1.to_s, nil, nil, nil, "random"
       end
     end
   end

data/spec/support/blueprints.rb

@@ -8,13 +8,13 @@ Executor.blueprint do
 end
 
 ExecutorTask.blueprint do
-  id        { "#{sn}" }
+  id         { "#{sn}" }
   executor
-  clazz     { "Clazz" }
-  arguments { {:attribute_one => "attribute_one_value", :attribute_two => "attribute_two_value"} }
+  executable { "Executable" }
+  arguments  { {:attribute_one => "attribute_one_value", :attribute_two => "attribute_two_value"} }
 end
 
-Clazz.blueprint do
+Executable.blueprint do
   arguments { {:attribute_one => "attribute_one_value", :attribute_two => "attribute_two_value"} }
   object.stub :execute
 end

data/spec/support/classes.rb

@@ -39,7 +39,7 @@ ActiveRecord::Schema.define do
 
   create_table :executor_tasks, :force => true do |t|
     t.integer  :executor_id
-    t.string   :clazz
+    t.string   :executable
     t.string   :arguments
     t.string   :schedule
     t.integer  :start
@@ -49,7 +49,6 @@ ActiveRecord::Schema.define do
 end
 ExecutorTask.acts_as_executor_task
 
-# Clazz
-Object.const_set "Clazz", Class.new
-Clazz.send :extend, Machinist::Machinable
-Clazz.send :include, ActsAsExecutor::Task::Clazz
+# Executable
+Object.const_set "Executable", Class.new(ActsAsExecutor::Task::Executable)
+Executable.send :extend, Machinist::Machinable

data/spec/support/custom_matchers.rb

@@ -20,7 +20,7 @@ def log_statement executor_name, statement
   "\"" + executor_name + "\" " + statement
 end
 
-def log_message executor_name, doing, task_id, clazz_name, message = ""
+def log_message executor_name, doing, task_id, executable_name, message = ""
   if message.kind_of? Hash then message = "with \"" + message.inspect + "\"" end 
-  "\"" + executor_name + "\" " + doing + " \"" + task_id + "#" + clazz_name + "\" " + message
+  "\"" + executor_name + "\" " + doing + " \"" + task_id + "#" + executable_name + "\" " + message
 end

data/spec/task/{clazz_spec.rb → executable_spec.rb}

@@ -1,7 +1,7 @@
 require "spec_helper"
 
-describe ActsAsExecutor::Task::Clazz do
-  before(:each) { @model = Clazz.make }
+describe ActsAsExecutor::Task::Executable do
+  before(:each) { @model = Executable.make }
 
   it { @model.should be_a Java::java.lang.Runnable }
   it { @model.should_not allow_public_access_for_methods :run }

data/spec/task/model/instance_methods_spec.rb

@@ -6,7 +6,7 @@ describe ActsAsExecutor::Task::Model::InstanceMethods do
   it { @model.should_not allow_public_access_for_methods :enqueue, :instantiate, :cancel, :done_handler, :uncaught_exception_handler }
 
   describe "#enqueue" do
-    before(:each) { @clazz = Clazz.make }
+    before(:each) { @executable = Executable.make }
 
     it "should enqueue task" do
       @model.send(:future).should be_nil
@@ -14,9 +14,9 @@ describe ActsAsExecutor::Task::Model::InstanceMethods do
       future = double "Future"
       future.stub :done_handler=
 
-      @model.executor.send(:log).should_receive(:debug).with log_message(@model.executor.name, "creating", @model.id.to_s, @model.clazz, @model.arguments)
-      @model.should_receive(:instantiate).and_return @clazz
-      @model.executor.should_receive(:execute).with(@clazz, @model.id.to_s, @model.schedule, @model.start, @model.every, @model.units).and_return future
+      @model.executor.send(:log).should_receive(:debug).with log_message(@model.executor.name, "creating", @model.id.to_s, @model.executable, @model.arguments)
+      @model.should_receive(:instantiate).and_return @executable
+      @model.executor.should_receive(:execute).with(@executable, @model.id.to_s, @model.schedule, @model.start, @model.every, @model.units).and_return future
 
       @model.send :enqueue
 
@@ -28,7 +28,7 @@ describe ActsAsExecutor::Task::Model::InstanceMethods do
         exception = RuntimeError.new
 
         @model.should_receive(:instantiate).and_raise exception
-        @model.executor.send(:log).should_receive(:error).with log_message(@model.executor.name, "creating", @model.id.to_s, @model.clazz, "encountered an unexpected exception. " + exception)
+        @model.executor.send(:log).should_receive(:error).with log_message(@model.executor.name, "creating", @model.id.to_s, @model.executable, "encountered an unexpected exception. " + exception.to_s)
 
         @model.send :enqueue
       end
@@ -37,16 +37,16 @@ describe ActsAsExecutor::Task::Model::InstanceMethods do
 
   describe "#instantiate" do
     it "should return an instance" do
-      instance = @model.send :instantiate, @model.clazz, @model.arguments
+      instance = @model.send :instantiate, @model.executable, @model.arguments
 
-      instance.class.name.should == @model.clazz
+      instance.class.name.should == @model.executable
       instance.arguments.should == @model.arguments
     end
   end
 
   describe "#done_handler" do
     it "should invoke destroy" do
-      @model.executor.send(:log).should_receive(:debug).with log_message(@model.executor.name, "completed", @model.id.to_s, @model.clazz)
+      @model.executor.send(:log).should_receive(:debug).with log_message(@model.executor.name, "completed", @model.id.to_s, @model.executable)
       @model.should_receive :destroy
 
       @model.send :done_handler
@@ -54,12 +54,12 @@ describe ActsAsExecutor::Task::Model::InstanceMethods do
   end
 
   describe "#uncaught_exception_handler" do
-    before(:each) { @clazz = Clazz.make }
+    before(:each) { @executable = Executable.make }
 
     it "should log exception" do
       exception = RuntimeError.new
 
-      @model.executor.send(:log).should_receive(:error).with log_message(@model.executor.name, "executing", @model.id.to_s, @model.clazz, "encountered an uncaught exception. " + exception)
+      @model.executor.send(:log).should_receive(:error).with log_message(@model.executor.name, "executing", @model.id.to_s, @model.executable, "encountered an uncaught exception. " + exception.to_s)
 
       @model.send :uncaught_exception_handler, exception
     end

data/spec/validators/class_exists_validator_spec.rb

@@ -8,7 +8,7 @@ describe ClassExistsValidator do
   describe "#validate_each" do
     context "when class does not exist" do
       it "should set error message" do
-        attribute = "clazz"
+        attribute = "executable"
         record = double "Record"
         record.stub(:errors).and_return( { attribute => [] } )
 

data/spec/validators/class_subclasses_validator_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe ClassSubclassesValidator do
+  before(:each) { @model = ClassSubclassesValidator.new Hash[ :attributes => true, :superclass => Comparable ] }
+
+  it { @model.should be_a ActiveModel::EachValidator }
+
+  describe "#validate_each" do
+    context "when class does not subclass" do
+      it "should set error message" do
+        attribute = "executable"
+        record = double "Record"
+        record.stub(:errors).and_return( { attribute => [] } )
+
+        @model.validate_each record, attribute, "Object"
+
+        record.errors[attribute].should include "does not subclass Comparable"
+      end
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: acts_as_executor
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 1.0.0.rc1
+  version: 1.0.0.rc3
 platform: ruby
 authors: 
   - Phil Ostler
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-25 00:00:00 +01:00
-default_executable: 
+date: 2011-09-22 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: activemodel
@@ -78,6 +77,12 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+  - .rspec
+  - acts_as_executor.gemspec
+  - Gemfile
+  - LICENSE
+  - Rakefile
+  - README.markdown
   - lib/acts_as_executor.rb
   - lib/acts_as_executor/version.rb
   - lib/acts_as_executor/common/future_task.rb
@@ -87,17 +92,19 @@ files:
   - lib/acts_as_executor/executor/model/class_methods.rb
   - lib/acts_as_executor/executor/model/instance_methods.rb
   - lib/acts_as_executor/executor/model/instance_support_methods.rb
-  - lib/acts_as_executor/task/clazz.rb
+  - lib/acts_as_executor/task/executable.rb
   - lib/acts_as_executor/task/schedules.rb
   - lib/acts_as_executor/task/model/class_methods.rb
   - lib/acts_as_executor/task/model/instance_methods.rb
   - lib/acts_as_executor/task/model/instance_support_methods.rb
   - lib/acts_as_executor/validators/class_exists_validator.rb
-  - lib/acts_as_executor/validators/class_includes_validator.rb
-  - lib/generators/acts_as_executor_generator.rb
-  - lib/generators/templates/migration/create_executors.rb
-  - lib/generators/templates/models/executor.rb
-  - lib/generators/templates/models/executor_task.rb
+  - lib/acts_as_executor/validators/class_subclasses_validator.rb
+  - lib/generators/acts_as_executor/executable/executable_generator.rb
+  - lib/generators/acts_as_executor/executable/templates/executables/executable.rb
+  - lib/generators/acts_as_executor/install/install_generator.rb
+  - lib/generators/acts_as_executor/install/templates/migration/create_executors.rb
+  - lib/generators/acts_as_executor/install/templates/models/executor.rb
+  - lib/generators/acts_as_executor/install/templates/models/executor_task.rb
   - spec/acts_as_executor_spec.rb
   - spec/spec_helper.rb
   - spec/common/future_task_spec.rb
@@ -111,16 +118,13 @@ files:
   - spec/support/classes.rb
   - spec/support/custom_matchers.rb
   - spec/support/database_connection.rb
-  - spec/task/clazz_spec.rb
+  - spec/task/executable_spec.rb
   - spec/task/schedules_spec.rb
   - spec/task/model/class_methods_spec.rb
   - spec/task/model/instance_methods_spec.rb
   - spec/task/model/instance_support_methods_spec.rb
   - spec/validators/class_exists_validator_spec.rb
-  - spec/validators/class_includes_validator_spec.rb
-  - LICENSE
-  - acts_as_executor.gemspec
-has_rdoc: true
+  - spec/validators/class_subclasses_validator_spec.rb
 homepage: https://github.com/philostler/acts_as_executor
 licenses: []
 
@@ -144,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.1
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Java Executor framework integration for Rails

data/lib/acts_as_executor/validators/class_includes_validator.rb

@@ -1,10 +0,0 @@
-class ClassIncludesValidator < ActiveModel::EachValidator
-  def validate_each record, attribute, value
-    begin
-      throw TypeError unless Object.const_get(value).new.kind_of? options[:includes]
-    rescue NameError
-    rescue TypeError
-      record.errors[attribute] << "does not include " + options[:includes].to_s
-    end
-  end
-end

data/lib/generators/acts_as_executor_generator.rb

@@ -1,18 +0,0 @@
-class ActsAsExecutorGenerator < Rails::Generators::NamedBase
-  include Rails::Generators::Migration
-
-  source_root File.expand_path("../templates", __FILE__)
-
-  def models
-    template File.join("models", "executor.rb"), File.join("app", "models", file_name + ".rb")
-    template File.join("models", "executor_task.rb"), File.join("app", "models", file_name + "_task.rb")
-  end
-
-  def migration
-    migration_template File.join("migration", "create_executors.rb"), File.join("db", "migrate", "create_" + table_name + ".rb")
-  end
-
-  def self.next_migration_number dirname
-    Time.now.utc.strftime "%Y%m%d%H%M%S"
-  end
-end

data/spec/validators/class_includes_validator_spec.rb

@@ -1,21 +0,0 @@
-require "spec_helper"
-
-describe ClassIncludesValidator do
-  before(:each) { @model = ClassIncludesValidator.new Hash[ :attributes => true, :includes => Comparable ] }
-
-  it { @model.should be_a ActiveModel::EachValidator }
-
-  describe "#validate_each" do
-    context "when class does not include" do
-      it "should set error message" do
-        attribute = "clazz"
-        record = double "Record"
-        record.stub(:errors).and_return( { attribute => [] } )
-
-        @model.validate_each record, attribute, "Object"
-
-        record.errors[attribute].should include "does not include Comparable"
-      end
-    end
-  end
-end