acts_as_executor 1.0.0.beta2 → 1.0.0.rc1

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "acts_as_executor"
+
+require "machinist/active_record"
+
+require "support/database_connection"
+require "support/classes"
+require "support/blueprints"
+require "support/custom_matchers"

data/spec/support/blueprints.rb

@@ -0,0 +1,20 @@
+InstanceSupportMethods.blueprint do
+end
+
+Executor.blueprint do
+  id        { "#{sn}" }
+  name      { "name#{sn}" }
+  max_tasks { 1 }
+end
+
+ExecutorTask.blueprint do
+  id        { "#{sn}" }
+  executor
+  clazz     { "Clazz" }
+  arguments { {:attribute_one => "attribute_one_value", :attribute_two => "attribute_two_value"} }
+end
+
+Clazz.blueprint do
+  arguments { {:attribute_one => "attribute_one_value", :attribute_two => "attribute_two_value"} }
+  object.stub :execute
+end

data/spec/support/classes.rb

@@ -0,0 +1,55 @@
+# Rails
+Object.const_set "Rails", Class.new
+
+# Logger
+class Logger
+  def debug message = nil, █ end
+  def info message = nil, █ end
+  def warn message = nil, █ end
+  def error message = nil, █ end
+  def fatal message = nil, █ end
+end
+
+# InstanceSupportMethods
+Object.const_set "InstanceSupportMethods", Class.new
+InstanceSupportMethods.send :extend, Machinist::Machinable
+InstanceSupportMethods.send :include, ActsAsExecutor::Common::InstanceSupportMethods
+
+# Executor
+Object.const_set "Executor", Class.new(ActiveRecord::Base)
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :executors, :force => true do |t|
+    t.string   :name
+    t.integer  :max_tasks
+    t.boolean  :schedulable
+  end
+end
+Executor.acts_as_executor
+Executor.log = Logger.new
+
+# ExecutorWithoutActsAsExecutor
+Object.const_set "ExecutorWithoutActsAsExecutor", Class.new(ActiveRecord::Base)
+
+# ExecutorTask
+Object.const_set "ExecutorTask", Class.new(ActiveRecord::Base)
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :executor_tasks, :force => true do |t|
+    t.integer  :executor_id
+    t.string   :clazz
+    t.string   :arguments
+    t.string   :schedule
+    t.integer  :start
+    t.integer  :every
+    t.string   :units
+  end
+end
+ExecutorTask.acts_as_executor_task
+
+# Clazz
+Object.const_set "Clazz", Class.new
+Clazz.send :extend, Machinist::Machinable
+Clazz.send :include, ActsAsExecutor::Task::Clazz

data/spec/support/custom_matchers.rb

@@ -0,0 +1,26 @@
+RSpec::Matchers.define :allow_public_access_for_methods do |*methods|
+  match_for_should do |object|
+    responded_to_all = true
+    methods.each do |method|
+      responded_to_all = false unless object.respond_to? method
+    end
+    responded_to_all
+  end
+
+  match_for_should_not do |object|
+    not_responded_to_all = true
+    methods.each do |method|
+      not_responded_to_all = false if object.respond_to? method
+    end
+    not_responded_to_all
+  end
+end
+
+def log_statement executor_name, statement
+  "\"" + executor_name + "\" " + statement
+end
+
+def log_message executor_name, doing, task_id, clazz_name, message = ""
+  if message.kind_of? Hash then message = "with \"" + message.inspect + "\"" end 
+  "\"" + executor_name + "\" " + doing + " \"" + task_id + "#" + clazz_name + "\" " + message
+end

data/spec/support/database_connection.rb

@@ -0,0 +1,4 @@
+ActiveRecord::Base.establish_connection(
+  :adapter => "jdbcsqlite3",
+  :database => ":memory:"
+)

data/spec/task/clazz_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe ActsAsExecutor::Task::Clazz do
+  before(:each) { @model = Clazz.make }
+
+  it { @model.should be_a Java::java.lang.Runnable }
+  it { @model.should_not allow_public_access_for_methods :run }
+
+  describe "#run" do
+    it "should invoke execute" do
+      @model.should_receive :execute
+
+      @model.send :run
+    end
+    it "should create accessor for each arguments member" do
+      @model.send :run
+
+      @model.arguments.each_pair do |key, value|
+        @model.should respond_to key
+        @model.send(key).should == value
+      end
+    end
+
+    context "when any exception is thrown" do
+      context "when uncaught exception handler exists" do
+        it "should invoke handler" do
+          handler = double "Handler"
+          handler.stub :uncaught_exception_handler
+          @model.uncaught_exception_handler = handler.method :uncaught_exception_handler
+
+          exception = RuntimeError.new
+
+          @model.should_receive(:execute).and_raise exception
+
+          handler.should_receive(:uncaught_exception_handler).with exception
+
+          @model.send :run
+        end
+      end
+    end
+  end
+end

data/spec/task/model/class_methods_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe ActsAsExecutor::Task::Model::ClassMethods do
+  subject { ActiveRecord::Base }
+  it { should be_a ActsAsExecutor::Task::Model::ClassMethods }
+
+  describe "#acts_as_executor_task" do
+    subject { ExecutorTask }
+    it { should include ActsAsExecutor::Common::InstanceSupportMethods }
+    it { should include ActsAsExecutor::Task::Model::InstanceMethods }
+    it { should include ActsAsExecutor::Task::Model::InstanceSupportMethods }
+  end
+end

data/spec/task/model/instance_methods_spec.rb

@@ -0,0 +1,80 @@
+require "spec_helper"
+
+describe ActsAsExecutor::Task::Model::InstanceMethods do
+  before(:each) { @model = ExecutorTask.make }
+
+  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 }
+
+    it "should enqueue task" do
+      @model.send(:future).should be_nil
+
+      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.send :enqueue
+
+      @model.send(:future).should == future
+    end
+
+    context "when any exception is thrown" do
+      it "should log exception" 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.send :enqueue
+      end
+    end
+  end
+
+  describe "#instantiate" do
+    it "should return an instance" do
+      instance = @model.send :instantiate, @model.clazz, @model.arguments
+
+      instance.class.name.should == @model.clazz
+      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.should_receive :destroy
+
+      @model.send :done_handler
+    end
+  end
+
+  describe "#uncaught_exception_handler" do
+    before(:each) { @clazz = Clazz.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.send :uncaught_exception_handler, exception
+    end
+  end
+
+  describe "#cancel" do
+    it "should cancel task" do
+      future = double "Future"
+      @model.send :future=, future
+
+      @model.send(:future).should_receive(:cancel).with true
+
+      @model.send :cancel
+
+      @model.send(:future).should be_nil
+    end
+  end
+end

data/spec/task/model/instance_support_methods_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe ActsAsExecutor::Task::Model::InstanceSupportMethods do
+  before(:each) { @model = ExecutorTask.make }
+
+  it { @model.should_not allow_public_access_for_methods :future, :future=, :enqueueable?, :cancelable? }
+
+  describe "#future" do
+    it "should return future" do
+      future = double "Future"
+      @model.send :future=, future
+
+      @model.send(:future).should == future
+    end
+
+    context "when id has not been set" do
+      it "should raise an argument error" do
+        @model.id = nil
+
+        expect { @model.send :future=, true }.to raise_error ArgumentError, "cannot reference future against nil id"
+      end
+    end
+  end
+
+  describe "#enqueueable?" do
+    context "when future has not been set" do
+      it "should return true" do
+        @model.should be_enqueueable
+      end
+    end
+
+    context "when future has been set" do
+      it "should return false" do
+        @model.send :future=, true
+
+        @model.should_not be_enqueueable
+      end
+    end
+  end
+
+  describe "#cancelable?" do
+    context "when future has been set" do
+      it "should return true" do
+        @model.send :future=, true
+
+        @model.should be_cancelable
+      end
+    end
+
+    context "when future has not been set" do
+      it "should return false" do
+        @model.should_not be_cancelable
+      end
+    end
+  end
+end

data/spec/task/schedules_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe ActsAsExecutor::Task::Schedules do
+  it { ActsAsExecutor::Task::Schedules::ONE_SHOT.should == "one_shot" }
+  it { ActsAsExecutor::Task::Schedules::FIXED_DELAY.should == "fixed_delay" }
+  it { ActsAsExecutor::Task::Schedules::FIXED_RATE.should == "fixed_rate" }
+  it { ActsAsExecutor::Task::Schedules::ALL.should include ActsAsExecutor::Task::Schedules::ONE_SHOT,
+                                                           ActsAsExecutor::Task::Schedules::FIXED_DELAY,
+                                                           ActsAsExecutor::Task::Schedules::FIXED_RATE
+  }
+end

data/spec/validators/class_exists_validator_spec.rb

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

data/spec/validators/class_includes_validator_spec.rb

@@ -0,0 +1,21 @@
+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

metadata

@@ -2,7 +2,7 @@
 name: acts_as_executor
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 1.0.0.beta2
+  version: 1.0.0.rc1
 platform: ruby
 authors: 
   - Phil Ostler
@@ -10,11 +10,65 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-05 00:00:00 +01:00
+date: 2011-08-25 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
-description: Seamless integration of Java's Executor framework with JRuby on Rails
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: activemodel
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "3.0"
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: activerecord
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "3.0"
+    type: :runtime
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: activerecord-jdbcsqlite3-adapter
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: "1.1"
+    type: :development
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: machinist
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            version: 2.0.0.beta2
+    type: :development
+    version_requirements: *id004
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id005 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: "2.6"
+    type: :development
+    version_requirements: *id005
+description: Seamlessly integrates Java's Executor framework with JRuby on Rails
 email: 
   - philostler@gmail.com
 executables: []
@@ -27,30 +81,43 @@ files:
   - lib/acts_as_executor.rb
   - lib/acts_as_executor/version.rb
   - lib/acts_as_executor/common/future_task.rb
+  - lib/acts_as_executor/common/instance_support_methods.rb
   - lib/acts_as_executor/common/units.rb
   - lib/acts_as_executor/executor/factory.rb
-  - lib/acts_as_executor/executor/kinds.rb
-  - lib/acts_as_executor/executor/model/actions.rb
-  - lib/acts_as_executor/executor/model/associations.rb
-  - lib/acts_as_executor/executor/model/attributes.rb
-  - lib/acts_as_executor/executor/model/base.rb
-  - lib/acts_as_executor/executor/model/helpers.rb
-  - lib/acts_as_executor/executor/model/validations.rb
+  - 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/schedules.rb
-  - lib/acts_as_executor/task/model/actions.rb
-  - lib/acts_as_executor/task/model/associations.rb
-  - lib/acts_as_executor/task/model/attributes.rb
-  - lib/acts_as_executor/task/model/base.rb
-  - lib/acts_as_executor/task/model/helpers.rb
-  - lib/acts_as_executor/task/model/validations.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/generators/executor_generator.rb
-  - lib/generators/templates/initializer/acts_as_executor.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
+  - spec/acts_as_executor_spec.rb
   - spec/spec_helper.rb
-  - README.rdoc
+  - spec/common/future_task_spec.rb
+  - spec/common/instance_support_methods_spec.rb
+  - spec/common/units_spec.rb
+  - spec/executor/factory_spec.rb
+  - spec/executor/model/class_methods_spec.rb
+  - spec/executor/model/instance_methods_spec.rb
+  - spec/executor/model/instance_support_methods_spec.rb
+  - spec/support/blueprints.rb
+  - spec/support/classes.rb
+  - spec/support/custom_matchers.rb
+  - spec/support/database_connection.rb
+  - spec/task/clazz_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