acts_as_executor 1.0.0.beta2 → 1.0.0.rc1

data/README.rdoc

@@ -1,67 +0,0 @@
-=acts_as_executor
-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, 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 --pre
-  # or
-  bundle install
-
-====Generate & Migrate
-  rails generate executor <ModelName>
-
-  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/20110601230311_create_executors.rb
-  rake db:migrate
-
-====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 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::MINUTES)
-
-====Example Task
-  class HelloWorldTask
-    include Java::java.lang.Runnable
-  
-    attr_accessor :message
-
-    def run
-      p "Hello World. " + message
-    end
-  end
-
-==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/lib/acts_as_executor/executor/kinds.rb

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

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

@@ -1,65 +0,0 @@
-module ActsAsExecutor
-  module Executor
-    module Model
-      module Actions
-        def self.included base
-          base.after_find :startup, :if => :startup_now?
-          base.after_save :startup, :if => :startup_now?
-
-          base.after_destroy :shutdown, :if => :shutdown_now?
-        end
-
-        def startup
-          ActsAsExecutor.log.debug "Executor \"" + name + "\" starting up..."
-          self.executor = ActsAsExecutor::Executor::Factory.create kind, size
-          ActsAsExecutor.log.info "Executor \"" + name + "\" has completed startup"
-
-          tasks.all
-        end
-
-        def shutdown
-          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
-
-        def execute clazz, schedule, start, every, units
-          begin
-            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
-            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
-    end
-  end
-end

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

@@ -1,11 +0,0 @@
-module ActsAsExecutor
-  module Executor
-    module Model
-      module Associations
-        def self.included base
-          base.has_many :tasks, :class_name => base.table_name.singularize.camelize + "Task", :foreign_key => "executor_id"
-        end
-      end
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-module ActsAsExecutor
-  module Executor
-    module Model
-      module Attributes
-        @@executors = Hash.new
-
-        def executor
-          @@executors[id]
-        end
-        def executor= executor
-          @@executors[id] = executor
-        end
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-module ActsAsExecutor
-  module Executor
-    module Model
-      module Base
-        def acts_as_executor
-          send :include, ActsAsExecutor::Executor::Model::Actions
-          send :include, ActsAsExecutor::Executor::Model::Associations
-          send :include, ActsAsExecutor::Executor::Model::Attributes
-          send :include, ActsAsExecutor::Executor::Model::Helpers
-          send :include, ActsAsExecutor::Executor::Model::Validations
-
-          if ActsAsExecutor.rails_startup?
-            all
-            at_exit do
-              all.each do |e|
-                e.shutdown
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

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

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

@@ -1,13 +0,0 @@
-module ActsAsExecutor
-  module Executor
-    module Model
-      module Validations
-        def self.included base
-          base.validates :name, :presence => true, :uniqueness => true
-          base.validates :kind, :inclusion => { :in => ActsAsExecutor::Executor::Kinds::ALL }
-          base.validates :size, :numericality => { :only_integer => true, :greater_than_or_equal_to => 1 }, :if => "ActsAsExecutor::Executor::Kinds::REQUIRING_SIZE.include? kind"
-        end
-      end
-    end
-  end
-end

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

@@ -1,34 +0,0 @@
-module ActsAsExecutor
-  module Task
-    module Model
-      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
-  end
-end

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

@@ -1,11 +0,0 @@
-module ActsAsExecutor
-  module Task
-    module Model
-      module Associations
-        def self.included base
-          base.belongs_to :executor, :class_name => base.table_name.sub(/_tasks/, "").camelize
-        end
-      end
-    end
-  end
-end

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

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

@@ -1,15 +0,0 @@
-module ActsAsExecutor
-  module Task
-    module Model
-      module Base
-        def acts_as_executor_task
-          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
-    end
-  end
-end

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

@@ -1,14 +0,0 @@
-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/task/model/validations.rb

@@ -1,16 +0,0 @@
-module ActsAsExecutor
-  module Task
-    module Model
-      module Validations
-        def self.included base
-          base.validates :executor_id, :presence => true
-          base.validates :clazz, :presence => true, :class_exists => true
-          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"
-          base.validates :units, :inclusion => { :in => ActsAsExecutor::Common::Units::ALL }, :if => "executor and executor.schedulable?"
-        end
-      end
-    end
-  end
-end

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

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