acts_as_executor 1.0.0.beta2 → 1.0.0.rc1

data/acts_as_executor.gemspec

@@ -10,8 +10,15 @@ Gem::Specification.new do |s|
   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.description = %q{Seamlessly integrates Java's Executor framework with JRuby on Rails}
 
   s.files         = Dir["**/*.rb"] + Dir["*.rdoc"] + Dir["LICENSE"] + Dir["*.gemspec"]
   s.require_paths = ["lib"]
+
+  s.add_dependency "activemodel", ">= 3.0"
+  s.add_dependency "activerecord", ">= 3.0"
+
+  s.add_development_dependency "activerecord-jdbcsqlite3-adapter", "~> 1.1"
+  s.add_development_dependency "machinist", "2.0.0.beta2"
+  s.add_development_dependency "rspec", "~> 2.6"
 end

data/lib/acts_as_executor.rb

@@ -1,46 +1,33 @@
+require "active_model"
+require "active_record"
+
+require "acts_as_executor/version"
+
 require "acts_as_executor/common/future_task"
+require "acts_as_executor/common/instance_support_methods"
 require "acts_as_executor/common/units"
 
 require "acts_as_executor/executor/factory"
-require "acts_as_executor/executor/kinds"
 
-require "acts_as_executor/executor/model/actions"
-require "acts_as_executor/executor/model/associations"
-require "acts_as_executor/executor/model/attributes"
-require "acts_as_executor/executor/model/base"
-require "acts_as_executor/executor/model/helpers"
-require "acts_as_executor/executor/model/validations"
+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/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/task/model/class_methods"
+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"
 
-ActiveRecord::Base.send :extend, ActsAsExecutor::Executor::Model::Base
-ActiveRecord::Base.send :extend, ActsAsExecutor::Task::Model::Base
+ActiveRecord::Base.send :extend, ActsAsExecutor::Executor::Model::ClassMethods
+ActiveRecord::Base.send :extend, ActsAsExecutor::Task::Model::ClassMethods
 
 module ActsAsExecutor
-  def self.log
-    logger
-  end
-  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"
+  def self.rails_initialized?
+    File.basename($0) != "rake"
   end
 end

data/lib/acts_as_executor/common/future_task.rb

@@ -1,10 +1,10 @@
 module ActsAsExecutor
   module Common
     class FutureTask < Java::java.util.concurrent.FutureTask
-      attr_accessor :task
+      attr_writer :done_handler
 
       def done
-       task.destroy
+        @done_handler.call if @done_handler
       end
     end
   end

data/lib/acts_as_executor/common/instance_support_methods.rb

@@ -0,0 +1,15 @@
+module ActsAsExecutor
+  module Common
+    module InstanceSupportMethods
+      private
+      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
+    end
+  end
+end

data/lib/acts_as_executor/executor/factory.rb

@@ -1,30 +1,26 @@
 module ActsAsExecutor
   module Executor
     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
-
+      def self.create max_tasks, schedulable
+        executor = nil
+        if schedulable
+          if max_tasks == nil
+            # No Cached Scheduled Implementation
+          elsif max_tasks >  1
+            executor = Java::java.util.concurrent.Executors.new_scheduled_thread_pool max_tasks.to_i # Scheduled
           else
-            return nil
+            executor = Java::java.util.concurrent.Executors.new_single_thread_scheduled_executor # Single Scheduled
+          end
+        else
+          if max_tasks == nil
+            executor = Java::java.util.concurrent.Executors.new_cached_thread_pool # Cached
+          elsif max_tasks > 1
+            executor = Java::java.util.concurrent.Executors.new_fixed_thread_pool max_tasks.to_i # Fixed
+          else
+            executor = Java::java.util.concurrent.Executors.new_single_thread_executor # Single
+          end
         end
+        executor
       end
     end
   end

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

@@ -0,0 +1,33 @@
+module ActsAsExecutor
+  module Executor
+    module Model
+      module ClassMethods
+        def acts_as_executor *arguments
+          send :include, ActsAsExecutor::Common::InstanceSupportMethods
+          send :include, ActsAsExecutor::Executor::Model::InstanceMethods
+          send :include, ActsAsExecutor::Executor::Model::InstanceSupportMethods
+
+          hash = arguments.last.is_a?(Hash) ? arguments.pop : {}
+          self.log = hash[:log]
+
+          if ActsAsExecutor.rails_initialized?
+            all
+            at_exit do
+              all.each do |e|
+                e.send :shutdown
+              end
+            end
+          end
+        end
+
+        def log
+          @@log ? @@log : Rails.logger
+        end
+
+        def log= log
+          @@log = log
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+module ActsAsExecutor
+  module Executor
+    module Model
+      module InstanceMethods
+        def self.included base
+          # Associations
+          base.has_many :tasks, :class_name => base.table_name.singularize.camelize + "Task", :foreign_key => "executor_id"
+
+          # Callbacks
+          base.after_find :startup, :if => :startupable?
+          base.after_save :startup, :if => :startupable?
+          base.after_destroy :shutdown, :if => :shutdownable?
+
+          # Validations
+          base.validates :name, :presence => true, :uniqueness => true
+          base.validates :max_tasks, :numericality => { :only_integer => true, :greater_than_or_equal_to => 1 }, :allow_nil => true
+        end
+
+        private
+        def startup
+          log.debug log_statement name, "startup triggered"
+          self.executor = ActsAsExecutor::Executor::Factory.create max_tasks, schedulable
+          log.info log_statement name, "started"
+
+          tasks.all
+        end
+
+        def execute clazz, 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 + ")"
+
+            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
+                when ActsAsExecutor::Task::Schedules::FIXED_DELAY
+                  future = executor.schedule_with_fixed_delay clazz, start, every, units
+                when ActsAsExecutor::Task::Schedules::FIXED_RATE
+                  future = executor.schedule_at_fixed_rate clazz, start, every, units
+              end
+            else
+              future = ActsAsExecutor::Common::FutureTask.new clazz, nil
+              executor.execute future
+            end
+
+            log.info log_message name, "enqueued", task_id, clazz.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"
+          rescue Exception => exception
+            log.error log_message name, "preparing", task_id, clazz.class.name, "encountered an unexpected exception. " + exception
+          end
+        end
+
+        def shutdown
+          log.debug log_statement name, "shutdown triggered"
+          begin
+            executor.shutdown
+          rescue Java::java.lang.SecurityException
+            log.warn log_statement name, "shutdown encountered a security exception"
+            forced_shutdown
+          else
+            log.info log_statement name, "shutdown"
+          ensure
+            self.executor = nil
+          end
+        end
+
+        def forced_shutdown
+          log.debug log_statement name, "forced shutdown triggered"
+          begin
+            executor.shutdown_now
+          rescue Java::java.lang.SecurityException
+            log.error log_statement name, "forced shutdown encountered a security exception"
+            log.fatal log_statement name, "forced shutdown failure"
+          else
+            log.info log_statement name, "forced shutdown"
+          ensure
+            self.executor = nil
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module ActsAsExecutor
+  module Executor
+    module Model
+      module InstanceSupportMethods
+        private
+        @@executors = Hash.new
+        def executor
+          @@executors[id]
+        end
+
+        def executor= executor
+          raise ArgumentError, "cannot reference executor against nil id" unless id
+          @@executors[id] = executor
+        end
+
+        def startupable?
+          if executor == nil && ActsAsExecutor.rails_initialized?
+            return true
+          end
+          return false
+        end
+
+        def shutdownable?
+          if executor != nil && ActsAsExecutor.rails_initialized?
+            return true
+          end
+          return false
+        end
+
+        def log
+          self.class.log
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_executor/task/clazz.rb

@@ -0,0 +1,26 @@
+module ActsAsExecutor
+  module Task
+    module Clazz
+      include Java::java.lang.Runnable
+
+      attr_accessor :arguments
+      attr_writer :uncaught_exception_handler
+
+      private
+      def run
+        begin
+          if @arguments
+            @arguments.each_pair do |key, value|
+              class_eval { attr_accessor key } unless respond_to? key
+              send "#{key}=", value
+            end
+          end
+
+          execute
+        rescue Exception => exception
+          @uncaught_exception_handler.call exception if @uncaught_exception_handler
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module ActsAsExecutor
+  module Task
+    module Model
+      module ClassMethods
+        def acts_as_executor_task
+          send :include, ActsAsExecutor::Common::InstanceSupportMethods
+          send :include, ActsAsExecutor::Task::Model::InstanceMethods
+          send :include, ActsAsExecutor::Task::Model::InstanceSupportMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+module ActsAsExecutor
+  module Task
+    module Model
+      module InstanceMethods
+        def self.included base
+          # Associations
+          base.belongs_to :executor, :class_name => base.table_name.sub(/_tasks/, "").camelize
+
+          # Callbacks
+          base.after_find :enqueue, :if => :enqueueable?
+          base.after_save :enqueue, :if => :enqueueable?
+          base.after_destroy :cancel, :if => :cancelable?
+
+          # Serialization
+          base.serialize :arguments, Hash
+
+          # Validations
+          base.validates :executor_id, :presence => true
+          base.validates :clazz, :presence => true, :class_exists => true, :class_includes => { :includes => ActsAsExecutor::Task::Clazz }
+          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
+
+        private
+        def enqueue
+          begin
+            executor.send(:log).debug log_message executor.name, "creating", id.to_s, clazz, arguments
+
+            instance = instantiate clazz, 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
+          end
+        end
+
+        def instantiate class_name, arguments
+          instance = Object.const_get(class_name).new
+          instance.arguments = arguments
+          instance.uncaught_exception_handler = method :uncaught_exception_handler
+          instance
+        end
+
+        def done_handler
+          executor.send(:log).debug log_message executor.name, "completed", id.to_s, clazz
+          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
+        end
+
+        def cancel
+          future.cancel true
+
+          self.future = nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module ActsAsExecutor
+  module Task
+    module Model
+      module InstanceSupportMethods
+        private
+        @@futures = Hash.new
+        def future
+          @@futures[id]
+        end
+
+        def future= future
+          raise ArgumentError, "cannot reference future against nil id" unless id
+          @@futures[id] = future
+        end
+
+        def enqueueable?
+          if future == nil
+            return true
+          end
+          return false
+        end
+
+        def cancelable?
+          if future != nil
+            return true
+          end
+          return false
+        end
+      end
+    end
+  end
+end