acts_as_executor 1.0.0.beta1 → 1.0.0.beta2

data/README.rdoc

@@ -2,13 +2,15 @@
 acts_as_executor seamlessly integrates Java's Executor framework with JRuby on Rails, giving an application the ability to interact with executors in a familiar Rails'eque way.
 
 ==Features
-* Database persisted, scheduled executor and task configurations 
+* Database persisted, executor and task configurations 
+* Create and delete both executors and tasks dynamically at runtime
+* Automatic management of completed tasks
 
 ==Getting Started
 Rails 3 Gemfile
   gem "acts_as_executor"
 Install via
-  gem install acts_as_executor
+  gem install acts_as_executor --pre
   # or
   bundle install
 
@@ -17,21 +19,31 @@ Install via
 
   e.g.
   rails generate executor Executor
+      create  config/initializers/acts_as_executor.rb
       create  app/models/executor.rb
       create  app/models/executor_task.rb
-      create  db/migrate/20110523205511_create_executors.rb
+      create  db/migrate/20110601230311_create_executors.rb
   rake db:migrate
 
-====Seed
-  e = Executor.create(:name => "background_processing",
-                      :kind => ActsAsExecutor::Executor::Kinds::SCHEDULED,
-                      :size => 4)
+====Create Executor
+  Executor.create(:name => "cached_executor",
+                  :kind => ActsAsExecutor::Executor::Kinds::CACHED)
+====Create Scheduled Executor
+  Executor.create(:name => "scheduled_executor",
+                  :kind => ActsAsExecutor::Executor::Kinds::SCHEDULED,
+                  :size => 3)
+====Create Task
+  e = Executor.find_by_name("cached_executor")
   e.tasks.create(:clazz => "HelloWorldTask",
-                 :arguments => { :message => "This is my argument message" },
+                 :arguments => { :message => "This is my message")
+====Create Scheduled Task
+  e = Executor.find_by_name("scheduled_executor")
+  e.tasks.create(:clazz => "HelloWorldTask",
+                 :arguments => { :message => "This is my scheduled message" },
                  :schedule => ActsAsExecutor::Task::Schedules::FIXED_DELAY,
                  :start => 1,
                  :every => 5,
-                 :units => ActsAsExecutor::Common::Units::SECONDS)
+                 :units => ActsAsExecutor::Common::Units::MINUTES)
 
 ====Example Task
   class HelloWorldTask
@@ -44,7 +56,12 @@ Install via
     end
   end
 
-==What's New in Release 1.0.0.beta1
-* Automatic startup only on Rails start. e.g. rake tasks don't trigger executor startup
-* Arguments can now be passed to tasks
-* Logging to <tt>Rails.logger</tt>
+==Notes
+Upon a task completing its execution on a non-scheduled executor, the task will be delete from the database. Due to the possiblity that multiple threads may be attempting to delete records simultaneously, it is recommended NOT to use SQLite as a database provider. In this scenario, database locking may occur causing records to fail deletion and thus exist for tasks that have actually completed thier execution.
+
+==What's New in Release 1.0.0.beta2
+* Support for all executor types, scheduled and non-scheduled
+* Executors can be created and deleted at runtime
+* Tasks can be created and added to executors at runtime
+* Automatic management of completed tasks on non-scheduled executors
+* Custom logger can now be set via initializer

data/acts_as_executor.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_executor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_executor"
+  s.version     = ActsAsExecutor::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Phil Ostler"]
+  s.email       = ["philostler@gmail.com"]
+  s.homepage    = "https://github.com/philostler/acts_as_executor"
+  s.summary     = %q{Java Executor framework integration for Rails}
+  s.description = %q{Seamless integration of Java's Executor framework with JRuby on Rails}
+
+  s.files         = Dir["**/*.rb"] + Dir["*.rdoc"] + Dir["LICENSE"] + Dir["*.gemspec"]
+  s.require_paths = ["lib"]
+end

data/lib/acts_as_executor.rb

@@ -1,3 +1,4 @@
+require "acts_as_executor/common/future_task"
 require "acts_as_executor/common/units"
 
 require "acts_as_executor/executor/factory"
@@ -14,7 +15,9 @@ require "acts_as_executor/task/schedules"
 
 require "acts_as_executor/task/model/actions"
 require "acts_as_executor/task/model/associations"
+require "acts_as_executor/task/model/attributes"
 require "acts_as_executor/task/model/base"
+require "acts_as_executor/task/model/helpers"
 require "acts_as_executor/task/model/validations"
 
 require "acts_as_executor/validators/class_exists_validator"
@@ -29,6 +32,14 @@ module ActsAsExecutor
   def self.logger
     @@logger ||= Rails.logger
   end
+  def self.logger= logger
+    @@logger = logger
+  end
+
+  def self.configure
+    yield self
+  end
+
   def self.rails_startup?
     File.basename($0) == "rails"
   end

data/lib/acts_as_executor/common/future_task.rb

@@ -0,0 +1,11 @@
+module ActsAsExecutor
+  module Common
+    class FutureTask < Java::java.util.concurrent.FutureTask
+      attr_accessor :task
+
+      def done
+       task.destroy
+      end
+    end
+  end
+end

data/lib/acts_as_executor/executor/factory.rb

@@ -3,12 +3,25 @@ module ActsAsExecutor
     class Factory
       def self.create kind, size = nil
         case kind
+          when ActsAsExecutor::Executor::Kinds::CACHED
+            return Java::java.util.concurrent.Executors.new_cached_thread_pool
+
+          when ActsAsExecutor::Executor::Kinds::FIXED
+            raise TypeError, "size cannot be nil" unless size
+            raise ArgumentError, "size must be larger than 0" unless size.to_i > 0
+            return Java::java.util.concurrent.Executors.new_fixed_thread_pool size.to_i
+
+          when ActsAsExecutor::Executor::Kinds::SINGLE
+            return Java::java.util.concurrent.Executors.new_single_thread_executor
+
           when ActsAsExecutor::Executor::Kinds::SCHEDULED
             raise TypeError, "size cannot be nil" unless size
             raise ArgumentError, "size must be larger than 0" unless size.to_i > 0
             return Java::java.util.concurrent.Executors.new_scheduled_thread_pool size.to_i
+
           when ActsAsExecutor::Executor::Kinds::SINGLE_SCHEDULED
             return Java::java.util.concurrent.Executors.new_single_thread_scheduled_executor
+
           else
             return nil
         end

data/lib/acts_as_executor/executor/kinds.rb

@@ -1,12 +1,16 @@
 module ActsAsExecutor
   module Executor
     class Kinds
+      CACHED = "cached"
+      FIXED = "fixed"
+      SINGLE = "single"
+
       SCHEDULED = "scheduled"
       SINGLE_SCHEDULED = "single_scheduled"
 
-      ALL = [ SCHEDULED, SINGLE_SCHEDULED ]
+      ALL = [ CACHED, FIXED, SINGLE, SCHEDULED, SINGLE_SCHEDULED ]
       ALL_SCHEDULED = [ SCHEDULED, SINGLE_SCHEDULED ]
-      REQUIRING_SIZE = [ SCHEDULED ]
+      REQUIRING_SIZE = [ FIXED, SCHEDULED ]
     end
   end
 end

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

@@ -3,68 +3,60 @@ module ActsAsExecutor
     module Model
       module Actions
         def self.included base
-          base.after_find :startup, :if => "ActsAsExecutor.rails_startup?"
-          base.after_destroy :shutdown
+          base.after_find :startup, :if => :startup_now?
+          base.after_save :startup, :if => :startup_now?
+
+          base.after_destroy :shutdown, :if => :shutdown_now?
         end
-        
+
         def startup
-          unless self.executor
-            ActsAsExecutor.log.debug "Executor \"" + name + "\" starting up..."
-            self.executor = ActsAsExecutor::Executor::Factory.create kind, size
-            ActsAsExecutor.log.info "Executor \"" + name + "\" has completed startup"
-            
-            ActsAsExecutor.log.debug "Executor \"" + name + "\" attaching tasks..."
-            tasks.each do |t|
-              submit t
-            end
-            ActsAsExecutor.log.info "Executor \"" + name + "\" has completed attaching tasks"
-          end
-        end
+          ActsAsExecutor.log.debug "Executor \"" + name + "\" starting up..."
+          self.executor = ActsAsExecutor::Executor::Factory.create kind, size
+          ActsAsExecutor.log.info "Executor \"" + name + "\" has completed startup"
 
-        def shutdown
-          if self.executor
-            ActsAsExecutor.log.debug "Executor \"" + name + "\" shutting down..."
-            begin
-              self.executor.shutdown
-            rescue Java::java.lang.RuntimePermission
-              ActsAsExecutor.log.error "Executor \"" + name + "\" has experienced a RuntimePermission error"
-            rescue Java::java.lang.SecurityException
-              ActsAsExecutor.log.error "Executor \"" + name + "\" has experienced a SecurityException error"
-            end
-            ActsAsExecutor.log.info "Executor \"" + name + "\" has completed shutdown"
-          end
+          tasks.all
         end
 
-        def submit task
+        def shutdown
+          ActsAsExecutor.log.debug "Executor \"" + name + "\" shutting down..."
           begin
-            clazz = task.clazz.constantize.new
-          rescue NameError
-            ActsAsExecutor.log.error "Executor \"" + name + "\" attaching task \"" + task.clazz + "\" could not create class"            
-          end
-
-          if task.arguments
-            task.arguments.each_pair do |k, v|
-              attribute = "#{k}="
-              clazz.send attribute, v if clazz.respond_to? attribute
-            end
+            self.executor.shutdown
+          rescue Java::java.lang.RuntimePermission
+            ActsAsExecutor.log.error "Executor \"" + name + "\" has experienced a RuntimePermission error"
+          rescue Java::java.lang.SecurityException
+            ActsAsExecutor.log.error "Executor \"" + name + "\" has experienced a SecurityException error"
           end
+          ActsAsExecutor.log.info "Executor \"" + name + "\" has completed shutdown"
+        end
 
+        def execute clazz, schedule, start, every, units
           begin
-            units = Java::java.util.concurrent.TimeUnit.value_of(task.units.upcase)
-            case task.schedule
-              when ActsAsExecutor::Task::Schedules::ONE_SHOT
-                self.executor.schedule clazz, task.start, units
-              when ActsAsExecutor::Task::Schedules::FIXED_DELAY
-                self.executor.schedule_with_fixed_delay clazz, task.start, task.every, units
-              when ActsAsExecutor::Task::Schedules::FIXED_RATE
-                self.executor.schedule_at_fixed_rate clazz, task.start, task.every, units
+            if schedulable?
+              units = Java::java.util.concurrent.TimeUnit.value_of(units.upcase)
+              case schedule
+                when ActsAsExecutor::Task::Schedules::ONE_SHOT
+                  future = self.executor.schedule clazz, start, units
+                when ActsAsExecutor::Task::Schedules::FIXED_DELAY
+                  future = self.executor.schedule_with_fixed_delay clazz, start, every, units
+                when ActsAsExecutor::Task::Schedules::FIXED_RATE
+                  future = self.executor.schedule_at_fixed_rate clazz, start, every, units
+              end
+            else
+              case clazz
+                when Java::java.util.concurrent.Callable
+                  future = ActsAsExecutor::Common::FutureTask.new clazz
+                when Java::java.lang.Runnable
+                  future = ActsAsExecutor::Common::FutureTask.new clazz, nil
+              end
+              self.executor.execute future
             end
-          rescue Java::java.lang.NullPointerException
-            ActsAsExecutor.log.error "Executor \"" + name + "\" attaching task \"" + task.clazz + "\" threw a NullPointerException"
-          rescue Java::java.lang.IllegalArgumentException
-            ActsAsExecutor.log.error "Executor \"" + name + "\" attaching task \"" + task.clazz + "\" threw a IllegalArgumentException"
-          rescue Java::java.util.concurrent.RejectedExecutionException
-            ActsAsExecutor.log.error "Executor \"" + name + "\" attaching task \"" + task.clazz + "\" threw a RejectedExecutionException"
+            return future
+          rescue Java::java.lang.NullPointerException => e
+            ActsAsExecutor.log.error "Executor \"" + name + "\" attaching task threw a NullPointerException. " + e.to_s
+          rescue Java::java.lang.IllegalArgumentException => e
+            ActsAsExecutor.log.error "Executor \"" + name + "\" attaching task threw a IllegalArgumentException. " + e.to_s
+          rescue Java::java.util.concurrent.RejectedExecutionException => e
+            ActsAsExecutor.log.error "Executor \"" + name + "\" attaching task threw a RejectedExecutionException. " + e.to_s
           end
         end
       end

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

@@ -2,6 +2,20 @@ module ActsAsExecutor
   module Executor
     module Model
       module Helpers
+        def startup_now?
+          if self.executor == nil && ActsAsExecutor.rails_startup?
+            return true
+          end
+          return false
+        end
+
+        def shutdown_now?
+          if self.executor != nill && ActsAsExecutor.rails_startup?
+            return true
+          end
+          return false
+        end
+
         def schedulable?
           ActsAsExecutor::Executor::Kinds::ALL_SCHEDULED.include? kind
         end

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

@@ -4,6 +4,29 @@ module ActsAsExecutor
       module Actions
         def self.included base
           base.serialize :arguments, Hash
+
+          base.after_find :execute, :if => :execute_now?
+          base.after_save :execute, :if => :execute_now?
+        end
+
+        def execute
+          begin
+            instance = clazz.constantize.new
+          rescue NameError
+            ActsAsExecutor.log.error "Task creating task could not create class"
+          end
+
+          if arguments
+            arguments.each_pair do |k, v|
+              attribute = "#{k}="
+              instance.send attribute, v if instance.respond_to? attribute
+            end
+          end
+
+          self.future = executor.execute instance, schedule, start, every, units
+          if !executor.schedulable?
+            self.future.task = self
+          end
         end
       end
     end

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

@@ -0,0 +1,16 @@
+module ActsAsExecutor
+  module Task
+    module Model
+      module Attributes
+        @@futures = Hash.new
+
+        def future
+          @@futures[id]
+        end
+        def future= future
+          @@futures[id] = future
+        end
+      end
+    end
+  end
+end

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

@@ -3,8 +3,10 @@ module ActsAsExecutor
     module Model
       module Base
         def acts_as_executor_task
-          send :include, ActsAsExecutor::Task::Model::Associations
           send :include, ActsAsExecutor::Task::Model::Actions
+          send :include, ActsAsExecutor::Task::Model::Associations
+          send :include, ActsAsExecutor::Task::Model::Attributes
+          send :include, ActsAsExecutor::Task::Model::Helpers
           send :include, ActsAsExecutor::Task::Model::Validations
         end
       end

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

@@ -0,0 +1,14 @@
+module ActsAsExecutor
+  module Task
+    module Model
+      module Helpers
+        def execute_now?
+          if self.future == nil
+            return true
+          end
+          return false
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_executor/version.rb

@@ -1,3 +1,3 @@
 module ActsAsExecutor
-  VERSION = "1.0.0.beta1"
+  VERSION = "1.0.0.beta2"
 end

data/lib/generators/executor_generator.rb

@@ -3,6 +3,10 @@ class ExecutorGenerator < Rails::Generators::NamedBase
 
   source_root File.expand_path("../templates", __FILE__)
 
+  def initializer
+    template File.join("initializer", "acts_as_executor.rb"), File.join("config", "initializers", "acts_as_executor.rb")
+  end
+
   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")

data/lib/generators/templates/initializer/acts_as_executor.rb

@@ -0,0 +1,4 @@
+ActsAsExecutor.configure do |config|
+  # Default = Rails.logger
+  # config.logger = Log4r::Logger["ActsAsExecutor"]
+end

metadata

@@ -2,7 +2,7 @@
 name: acts_as_executor
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 1.0.0.beta1
+  version: 1.0.0.beta2
 platform: ruby
 authors: 
   - Phil Ostler
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-24 00:00:00 +01:00
+date: 2011-06-05 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -26,6 +26,7 @@ extra_rdoc_files: []
 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/units.rb
   - lib/acts_as_executor/executor/factory.rb
   - lib/acts_as_executor/executor/kinds.rb
@@ -38,15 +39,20 @@ files:
   - 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/validators/class_exists_validator.rb
   - lib/generators/executor_generator.rb
+  - lib/generators/templates/initializer/acts_as_executor.rb
   - lib/generators/templates/migration/create_executors.rb
   - lib/generators/templates/models/executor.rb
   - lib/generators/templates/models/executor_task.rb
+  - spec/spec_helper.rb
   - README.rdoc
   - LICENSE
+  - acts_as_executor.gemspec
 has_rdoc: true
 homepage: https://github.com/philostler/acts_as_executor
 licenses: []