acts_as_executor 1.0.0.beta1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Phil Ostler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,50 @@
+=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, scheduled executor and task configurations 
+
+==Getting Started
+Rails 3 Gemfile
+  gem "acts_as_executor"
+Install via
+  gem install acts_as_executor
+  # or
+  bundle install
+
+====Generate & Migrate
+  rails generate executor <ModelName>
+
+  e.g.
+  rails generate executor Executor
+      create  app/models/executor.rb
+      create  app/models/executor_task.rb
+      create  db/migrate/20110523205511_create_executors.rb
+  rake db:migrate
+
+====Seed
+  e = Executor.create(:name => "background_processing",
+                      :kind => ActsAsExecutor::Executor::Kinds::SCHEDULED,
+                      :size => 4)
+  e.tasks.create(:clazz => "HelloWorldTask",
+                 :arguments => { :message => "This is my argument message" },
+                 :schedule => ActsAsExecutor::Task::Schedules::FIXED_DELAY,
+                 :start => 1,
+                 :every => 5,
+                 :units => ActsAsExecutor::Common::Units::SECONDS)
+
+====Example Task
+  class HelloWorldTask
+    include Java::java.lang.Runnable
+  
+    attr_accessor :message
+
+    def run
+      p "Hello World. " + message
+    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>

data/lib/acts_as_executor.rb

@@ -0,0 +1,35 @@
+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/task/schedules"
+
+require "acts_as_executor/task/model/actions"
+require "acts_as_executor/task/model/associations"
+require "acts_as_executor/task/model/base"
+require "acts_as_executor/task/model/validations"
+
+require "acts_as_executor/validators/class_exists_validator"
+
+ActiveRecord::Base.send :extend, ActsAsExecutor::Executor::Model::Base
+ActiveRecord::Base.send :extend, ActsAsExecutor::Task::Model::Base
+
+module ActsAsExecutor
+  def self.log
+    logger
+  end
+  def self.logger
+    @@logger ||= Rails.logger
+  end
+  def self.rails_startup?
+    File.basename($0) == "rails"
+  end
+end

data/lib/acts_as_executor/common/units.rb

@@ -0,0 +1,15 @@
+module ActsAsExecutor
+  module Common
+    class Units
+      NANOSECONDS = "nanoseconds"
+      MICROSECONDS = "microseconds"
+      MILLISECONDS = "milliseconds"
+      SECONDS = "seconds"
+      MINUTES = "minutes"
+      HOURS = "hours"
+      DAYS = "days"
+
+      ALL = [ NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS ]
+    end
+  end
+end

data/lib/acts_as_executor/executor/factory.rb

@@ -0,0 +1,18 @@
+module ActsAsExecutor
+  module Executor
+    class Factory
+      def self.create kind, size = nil
+        case kind
+          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
+      end
+    end
+  end
+end

data/lib/acts_as_executor/executor/kinds.rb

@@ -0,0 +1,12 @@
+module ActsAsExecutor
+  module Executor
+    class Kinds
+      SCHEDULED = "scheduled"
+      SINGLE_SCHEDULED = "single_scheduled"
+
+      ALL = [ SCHEDULED, SINGLE_SCHEDULED ]
+      ALL_SCHEDULED = [ SCHEDULED, SINGLE_SCHEDULED ]
+      REQUIRING_SIZE = [ SCHEDULED ]
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+module ActsAsExecutor
+  module Executor
+    module Model
+      module Actions
+        def self.included base
+          base.after_find :startup, :if => "ActsAsExecutor.rails_startup?"
+          base.after_destroy :shutdown
+        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
+
+        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
+        end
+
+        def submit task
+          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
+          end
+
+          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
+            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"
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

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

@@ -0,0 +1,11 @@
+module ActsAsExecutor
+  module Executor
+    module Model
+      module Helpers
+        def schedulable?
+          ActsAsExecutor::Executor::Kinds::ALL_SCHEDULED.include? kind
+        end
+      end
+    end
+  end
+end

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

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

@@ -0,0 +1,11 @@
+module ActsAsExecutor
+  module Task
+    module Model
+      module Actions
+        def self.included base
+          base.serialize :arguments, Hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+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/base.rb

@@ -0,0 +1,13 @@
+module ActsAsExecutor
+  module Task
+    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::Validations
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+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/acts_as_executor/task/schedules.rb

@@ -0,0 +1,11 @@
+module ActsAsExecutor
+  module Task
+    class Schedules
+      ONE_SHOT = "one_shot"
+      FIXED_DELAY = "fixed_delay"
+      FIXED_RATE = "fixed_rate"
+
+      ALL = [ ONE_SHOT, FIXED_DELAY, FIXED_RATE ]
+    end
+  end
+end

data/lib/acts_as_executor/validators/class_exists_validator.rb

@@ -0,0 +1,9 @@
+class ClassExistsValidator < ActiveModel::EachValidator
+  def validate_each record, attribute, value
+    begin
+      value.constantize.new
+    rescue NameError
+      record.errors[attribute] << "does not exist as a Class"
+    end
+  end
+end

data/lib/acts_as_executor/version.rb

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

data/lib/generators/executor_generator.rb

@@ -0,0 +1,18 @@
+class ExecutorGenerator < 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/lib/generators/templates/migration/create_executors.rb

@@ -0,0 +1,26 @@
+class Create<%= class_name.pluralize %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      t.string   :name
+      t.string   :kind
+      t.integer  :size
+      t.timestamps
+    end
+
+    create_table :<%= singular_table_name %>_tasks do |t|
+      t.integer  :executor_id
+      t.string   :clazz
+      t.string   :arguments
+      t.string   :schedule
+      t.integer  :start
+      t.integer  :every
+      t.string   :units
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+    drop_table :<%= singular_table_name %>_tasks
+  end
+end

data/lib/generators/templates/models/executor.rb

@@ -0,0 +1,3 @@
+class <%= class_name %> < ActiveRecord::Base
+  acts_as_executor
+end

data/lib/generators/templates/models/executor_task.rb

@@ -0,0 +1,3 @@
+class <%= class_name %>Task < ActiveRecord::Base
+  acts_as_executor_task
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_executor
+version: !ruby/object:Gem::Version 
+  prerelease: 6
+  version: 1.0.0.beta1
+platform: ruby
+authors: 
+  - Phil Ostler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-24 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Seamless integration of Java's Executor framework with JRuby on Rails
+email: 
+  - philostler@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - lib/acts_as_executor.rb
+  - lib/acts_as_executor/version.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/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/base.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/migration/create_executors.rb
+  - lib/generators/templates/models/executor.rb
+  - lib/generators/templates/models/executor_task.rb
+  - README.rdoc
+  - LICENSE
+has_rdoc: true
+homepage: https://github.com/philostler/acts_as_executor
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 3
+summary: Java Executor framework integration for Rails
+test_files: []
+