quartz-jruby 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.1.0 2010-12-01
+
+* Basic cron ability with java quartz
+  * Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010, Vagmi Mudumbai
+
+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/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+LICENSE
+Manifest.txt
+README.markdown
+Rakefile
+lib/quartz.rb
+lib/quartz/cron_job.rb
+lib/quartz/cronify.rb
+lib/quartz/job_detail.rb
+lib/quartz/job_factory.rb
+lib/quartz/scheduler.rb
+lib/quartz/version.rb
+test/test_helper.rb
+test/test_quartz-jruby.rb

data/README.markdown

@@ -0,0 +1,42 @@
+## Quartz for JRuby
+
+From [Quartz Scheduler's website](http://www.quartz-scheduler.org/)
+
+> Quartz is a full-featured, open source job scheduling service that can be integrated with, or used along side virtually any Java EE or Java SE application - from the smallest stand-alone application to the largest e-commerce system. Quartz can be used to create simple or complex schedules for executing tens, hundreds, or even tens-of-thousands of jobs; jobs whose tasks are defined as standard Java components that may executed virtually anything you may program them to do. The Quartz Scheduler includes many enterprise-class features, such as JTA transactions and clustering.
+
+
+## Usage
+
+        class TestScheduler
+          include Quartz::Scheduler
+          schedule(:say_hello_5, :every=>5.seconds) { info "every 5 seconds" }
+          schedule(:say_hello_30, :every=>30.seconds) { error "every 30 seconds" }
+        end
+        TestScheduler.instance.run
+
+## Feedback
+
+If you have any feedback, send me an email vagmi <at> [artha42.com](http://www.artha42.com).
+
+## License
+
+Copyright (c) 2010, Vagmi Mudumbai
+
+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/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/quartz/version'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'quartz-jruby' do
+  self.readme_file = 'quartz-jruby.rdoc'
+  self.version = Quartz::VERSION
+  self.developer 'Vagmi Mudumbai', 'vagmi@artha42.com'
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['activesupport','>= 3.0.3']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/quartz.rb

@@ -0,0 +1,14 @@
+require 'java'
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'singleton'
+require 'active_support'
+require 'quartz/version'
+require 'quartz/job_factory'
+require 'quartz/job_detail'
+require 'quartz/cron_job'
+require 'quartz/cronify'
+require 'quartz/scheduler'
+

data/lib/quartz/cron_job.rb

@@ -0,0 +1,15 @@
+require 'java'
+import org.quartz.Job
+module Quartz
+  class CronJob
+    include org.quartz.Job
+    attr_accessor :name
+    def initialize(name)
+      @name=name
+    end
+    def execute(context)
+      job_block = JobFactory.instance.jobs[@name]
+      job_block.call
+    end
+  end
+end

data/lib/quartz/cronify.rb

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/core_ext'
+
+# this stuff is based on whenver
+# https://github.com/javan/whenever/
+
+module Quartz
+  class Cronify
+    def self.comma_separated_timing(frequency, max, start = 0)
+      return start     if frequency.blank? || frequency.zero?
+      return frequency if frequency > (max * 0.5).ceil
+
+      original_start = start
+
+      start += frequency unless (max + 1).modulo(frequency).zero? || start > 0
+      output = (start..max).step(frequency).to_a
+
+      max_occurances = (max.to_f  / (frequency.to_f)).round
+      max_occurances += 1 if original_start.zero?
+
+      output[0, max_occurances].join(',')
+    end
+
+
+    def self.cronify(time,at=0)
+      timing = %w(0 * * * * ?)
+      case time
+        when 0.seconds...1.minute
+          timing[0] = "0/#{time.to_s}"
+        when 1.minute...1.hour
+          minute_frequency = time / 60
+          timing[1] = comma_separated_timing(minute_frequency, 59, at || 0)
+        when 1.hour...1.day
+          hour_frequency = (time / 60 / 60).round
+          timing[1] = at.is_a?(Time) ? at.min : at
+          timing[2] = comma_separated_timing(hour_frequency, 23)
+        when 1.day...1.month
+          day_frequency = (time / 24 / 60 / 60).round
+          timing[1] = at.is_a?(Time) ? at.min  : 0
+          timing[2] = at.is_a?(Time) ? at.hour : at
+          timing[3] = comma_separated_timing(day_frequency, 31, 1)
+        when 1.month..12.months
+          month_frequency = (time / 30  / 24 / 60 / 60).round
+          timing[1] = at.is_a?(Time) ? at.min  : 0
+          timing[2] = at.is_a?(Time) ? at.hour : 0
+          timing[3] = at.is_a?(Time) ? at.day  : (at.zero? ? 1 : at)
+          timing[4] = comma_separated_timing(month_frequency, 12, 1)
+        else
+          return 'bummer'
+      end
+      timing.join(' ')
+    end
+  end
+end

data/lib/quartz/job_detail.rb

@@ -0,0 +1,13 @@
+module Quartz
+  class JobDetail < Java::OrgQuartz::JobDetail
+    attr_accessor :job
+    def initialize(name,group,job)
+      super()
+      set_name name
+      set_group group
+      @job = job
+    end
+    def validate
+    end
+  end
+end

data/lib/quartz/job_factory.rb

@@ -0,0 +1,14 @@
+module Quartz
+  class JobFactory
+    include Singleton
+    include org.quartz.spi.JobFactory
+    attr_accessor :jobs
+    def initialize
+      @jobs||={}
+    end
+    def new_job(event)
+      event.get_job_detail.job
+      
+    end
+  end
+end

data/lib/quartz/scheduler.rb

@@ -0,0 +1,66 @@
+require 'java'
+
+# java quartz imports
+import org.quartz.CronTrigger
+import org.quartz.impl.StdSchedulerFactory
+
+
+module Quartz
+  module Scheduler
+    
+    def self.included(base)
+      base.class_eval <<-EOF
+        include InstanceMethods
+        extend ClassMethods
+        include Singleton
+      EOF
+    end
+
+    module ClassMethods
+      def schedule(name,options,&block)
+        instance.schedule(name,options,block)
+      end
+      def log
+        org.apache.log4j.Logger.get_logger(self.name)
+      end
+      def info(msg)
+        log.log(org.apache.log4j.Level::INFO,msg)
+      end
+      def error(msg)
+        log.log(org.apache.log4j.Level::ERROR,msg)
+      end
+      def warn(msg)
+        log.log(org.apache.log4j.Level::WARN,msg)
+      end
+    end
+
+    module InstanceMethods
+      def schedule(name, options, block)
+        options=defaults.merge options
+        job_factory.jobs[name.to_s] = block
+        job_detail = JobDetail.new(name.to_s, "cronjob",CronJob.new(name.to_s))
+        cron_expression = Cronify.cronify(options[:every],options[:at])
+        trigger=CronTrigger.new("#{name.to_s}_crontrig","cront_trig_group",name.to_s,"cronjob",cron_expression)
+        scheduler.set_job_factory(job_factory)
+        scheduler.schedule_job(job_detail,trigger)
+      end
+      def defaults
+        {
+          :at=>0
+        }
+      end
+      def scheduler_factory
+        @scheduler_factor ||= StdSchedulerFactory.new
+      end
+      def scheduler
+        scheduler_factory.get_scheduler
+      end
+      def job_factory
+        JobFactory.instance
+      end
+      def run
+        scheduler.start
+      end
+    end
+  end
+end

data/lib/quartz/version.rb

@@ -0,0 +1,3 @@
+module Quartz
+  VERSION="0.1.0"
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'stringio'
+#require 'test/unit'
+
+JAVA_HOME = File.expand_path(File.join(File.dirname(__FILE__),"..","java"))
+JARS = Dir.glob(JAVA_HOME+"/*.jar").collect { |e| e.split(JAVA_HOME)[1].slice(1..-1) }
+$:.unshift(JAVA_HOME)
+JARS.each { |jar| 
+  puts "requiring #{jar}"
+  require jar 
+}
+
+require File.dirname(__FILE__) + '/../lib/quartz'

data/test/test_quartz-jruby.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+org.apache.log4j.BasicConfigurator.configure
+class TestScheduler
+  include Quartz::Scheduler
+  schedule(:say_hello_5, :every=>5.seconds) { info "every 5 seconds" }
+  schedule(:say_hello_30, :every=>30.seconds) { error "every 30 seconds" }
+
+end
+TestScheduler.instance.run

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: quartz-jruby
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+    - 0
+    - 1
+    - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+  - Vagmi Mudumbai
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-02 00:00:00 +05:30
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: activesupport
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 3
+              - 0
+              - 3
+            version: 3.0.3
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rubyforge
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 2
+              - 0
+              - 4
+            version: 2.0.4
+    type: :development
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: hoe
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 2
+              - 7
+              - 0
+            version: 2.7.0
+    type: :development
+    version_requirements: *id003
+description: |-
+  From {Quartz Scheduler's website}[http://www.quartz-scheduler.org/]
+  
+  Quartz is a full-featured, open source job scheduling service that can be integrated with, or used along side virtually any Java EE or Java SE application - from the smallest stand-alone application to the largest e-commerce system. Quartz can be used to create simple or complex schedules for executing tens, hundreds, or even tens-of-thousands of jobs; jobs whose tasks are defined as standard Java components that may executed virtually anything you may program them to do. The Quartz Scheduler includes many enterprise-class features, such as JTA transactions and clustering.
+  
+  This gem makes these available in a ruby friendly syntax
+email: 
+  - vagmi@artha42.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - History.txt
+  - Manifest.txt
+files: 
+  - History.txt
+  - LICENSE
+  - Manifest.txt
+  - README.markdown
+  - Rakefile
+  - lib/quartz.rb
+  - lib/quartz/cron_job.rb
+  - lib/quartz/cronify.rb
+  - lib/quartz/job_detail.rb
+  - lib/quartz/job_factory.rb
+  - lib/quartz/scheduler.rb
+  - lib/quartz/version.rb
+  - test/test_helper.rb
+  - test/test_quartz-jruby.rb
+has_rdoc: true
+homepage: http://github.com/artha42/quartz-jruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --main
+  - quartz-jruby.rdoc
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+requirements: []
+
+rubyforge_project: quartz-jruby
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: From {Quartz Scheduler's website}[http://www.quartz-scheduler.org/]  Quartz is a full-featured, open source job scheduling service that can be integrated with, or used along side virtually any Java EE or Java SE application - from the smallest stand-alone application to the largest e-commerce system
+test_files: 
+  - test/test_helper.rb
+  - test/test_quartz-jruby.rb