rocketjob 2.0.0.rc3 → 2.0.0

data/lib/rocket_job/plugins/rufus/zo_time.rb

@@ -0,0 +1,291 @@
+#--
+# Copyright (c) 2006-2016, John Mettraux, jmettraux@gmail.com
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+module RocketJob::Plugins::Rufus
+
+  TIMEZONES = %w[
+GB NZ UCT EET CET PRC ROC WET GMT EST ROK UTC MST HST MET Zulu Cuba Iran W-SU
+Eire GMT0 Libya Japan Egypt GMT+0 GMT-0 Israel Poland Navajo Turkey GB-Eire
+Iceland PST8PDT Etc/UCT CST6CDT NZ-CHAT MST7MDT Jamaica EST5EDT Etc/GMT Etc/UTC
+US/Samoa Etc/GMT0 Portugal Hongkong Etc/Zulu Singapore Asia/Baku Etc/GMT-9
+Etc/GMT+1 Etc/GMT+0 Asia/Aden Etc/GMT+2 Etc/GMT+3 Etc/GMT+4 Etc/GMT+5 Etc/GMT+6
+Etc/GMT+7 Etc/GMT+8 Etc/GMT+9 Etc/GMT-0 Etc/GMT-1 Universal Asia/Dili Greenwich
+Asia/Gaza Etc/GMT-8 Etc/GMT-7 US/Alaska Asia/Oral Etc/GMT-6 Etc/GMT-5 Etc/GMT-4
+Asia/Hovd Etc/GMT-3 US/Hawaii Etc/GMT-2 Kwajalein Asia/Omsk Asia/Macao
+Etc/GMT-14 Asia/Kabul US/Central Etc/GMT-13 US/Arizona Asia/Macau Asia/Qatar
+Asia/Seoul Asia/Tokyo Asia/Dubai US/Pacific Etc/GMT-12 Etc/GMT-11 Etc/GMT-10
+Asia/Dhaka Asia/Dacca Asia/Chita Etc/GMT+12 Etc/GMT+10 Asia/Amman Asia/Aqtau
+Etc/GMT+11 US/Eastern Asia/Thimbu Asia/Brunei Asia/Tehran Asia/Beirut
+Europe/Rome Europe/Riga Brazil/Acre Brazil/East Europe/Oslo Brazil/West
+Africa/Lome Asia/Taipei Asia/Saigon Asia/Riyadh Asia/Aqtobe Asia/Anadyr
+Europe/Kiev Asia/Almaty Africa/Juba Pacific/Yap US/Aleutian Asia/Muscat
+US/Mountain Asia/Harbin Asia/Hebron Asia/Manila Asia/Kuwait Asia/Urumqi
+US/Michigan Indian/Mahe SystemV/EST5 Asia/Kashgar Indian/Cocos Asia/Jakarta
+Asia/Kolkata Asia/Kuching America/Atka Asia/Irkutsk Pacific/Apia Asia/Magadan
+Africa/Dakar America/Lima Pacific/Fiji Pacific/Guam Europe/Vaduz Pacific/Niue
+Asia/Nicosia Africa/Ceuta Pacific/Truk America/Adak Pacific/Wake Africa/Tunis
+Africa/Cairo Asia/Colombo SystemV/AST4 SystemV/CST6 Asia/Karachi Asia/Rangoon
+SystemV/MST7 Asia/Baghdad Europe/Malta Africa/Lagos Europe/Minsk SystemV/PST8
+Canada/Yukon Asia/Tbilisi America/Nome Asia/Bahrain Africa/Accra Europe/Paris
+Asia/Bangkok Asia/Bishkek Asia/Thimphu SystemV/YST9 Asia/Yerevan Asia/Yakutsk
+Europe/Sofia Asia/Ust-Nera Australia/ACT Australia/LHI Europe/Tirane
+Asia/Tel_Aviv Australia/NSW Africa/Luanda Asia/Tashkent Africa/Lusaka
+Asia/Shanghai Africa/Malabo Asia/Sakhalin Africa/Maputo Africa/Maseru
+SystemV/HST10 Africa/Kigali Africa/Niamey Pacific/Samoa America/Sitka
+Pacific/Palau Pacific/Nauru Pacific/Efate Asia/Makassar Pacific/Chuuk
+Africa/Harare Africa/Douala America/Aruba America/Thule America/Bahia
+America/Jujuy America/Belem Asia/Katmandu America/Boise Indian/Comoro
+Indian/Chagos Asia/Jayapura Europe/Zurich Asia/Istanbul Europe/Zagreb
+Etc/Greenwich Europe/Warsaw Europe/Vienna Etc/Universal Asia/Dushanbe
+Europe/Athens Europe/Berlin Africa/Bissau Asia/Damascus Africa/Banjul
+Europe/Dublin Africa/Bangui Africa/Bamako Europe/Jersey Africa/Asmera
+Europe/Lisbon Africa/Asmara Europe/London Asia/Ashgabat Asia/Calcutta
+Europe/Madrid Europe/Monaco Europe/Moscow Europe/Prague Europe/Samara
+Europe/Skopje Asia/Khandyga Canada/Pacific Africa/Abidjan America/Manaus
+Asia/Chongqing Asia/Chungking Africa/Algiers America/Maceio US/Pacific-New
+Africa/Conakry America/La_Paz America/Juneau America/Nassau America/Inuvik
+Europe/Andorra Africa/Kampala Asia/Ashkhabad Asia/Hong_Kong America/Havana
+Canada/Eastern Europe/Belfast Canada/Central Australia/West Asia/Jerusalem
+Africa/Mbabane Asia/Kamchatka America/Virgin America/Guyana Asia/Kathmandu
+Mexico/General America/Panama Europe/Nicosia America/Denver Europe/Tallinn
+Africa/Nairobi America/Dawson Europe/Vatican Europe/Vilnius America/Cuiaba
+Africa/Tripoli Pacific/Wallis Atlantic/Faroe Pacific/Tarawa Pacific/Tahiti
+Pacific/Saipan Pacific/Ponape America/Cayman America/Cancun Asia/Pontianak
+Asia/Pyongyang Asia/Vientiane Asia/Qyzylorda Pacific/Noumea America/Bogota
+Pacific/Midway Pacific/Majuro Asia/Samarkand Indian/Mayotte Pacific/Kosrae
+Asia/Singapore Indian/Reunion America/Belize America/Regina America/Recife
+Pacific/Easter Mexico/BajaSur America/Merida Pacific/Chatham Pacific/Fakaofo
+Pacific/Gambier America/Rosario Asia/Ulan_Bator Indian/Maldives Pacific/Norfolk
+America/Antigua Asia/Phnom_Penh America/Phoenix America/Caracas America/Cayenne
+Atlantic/Azores Pacific/Pohnpei Atlantic/Canary America/Chicago Atlantic/Faeroe
+Africa/Windhoek America/Cordoba America/Creston Africa/Timbuktu America/Curacao
+Africa/Sao_Tome Africa/Ndjamena SystemV/AST4ADT Europe/Uzhgorod Europe/Tiraspol
+SystemV/CST6CDT Africa/Monrovia America/Detroit Europe/Sarajevo Australia/Eucla
+America/Tijuana America/Toronto America/Godthab America/Grenada Europe/Istanbul
+America/Ojinaga America/Tortola Australia/Perth Europe/Helsinki Australia/South
+Europe/Guernsey SystemV/EST5EDT Europe/Chisinau SystemV/MST7MDT Europe/Busingen
+Europe/Budapest Europe/Brussels America/Halifax America/Mendoza America/Noronha
+America/Nipigon Canada/Atlantic America/Yakutat SystemV/PST8PDT SystemV/YST9YDT
+Canada/Mountain Africa/Kinshasa Africa/Khartoum Africa/Gaborone Africa/Freetown
+America/Iqaluit America/Jamaica US/East-Indiana Africa/El_Aaiun America/Knox_IN
+Africa/Djibouti Africa/Blantyre America/Moncton America/Managua Asia/Choibalsan
+America/Marigot Australia/North Europe/Belgrade America/Resolute
+America/Mazatlan Pacific/Funafuti Pacific/Auckland Pacific/Honolulu
+Pacific/Johnston America/Miquelon America/Santarem Mexico/BajaNorte
+America/Santiago Antarctica/Troll America/Asuncion America/Atikokan
+America/Montreal America/Barbados Africa/Bujumbura Pacific/Pitcairn
+Asia/Ulaanbaatar Indian/Mauritius America/New_York Antarctica/Syowa
+America/Shiprock Indian/Kerguelen Asia/Novosibirsk America/Anguilla
+Indian/Christmas Asia/Vladivostok Asia/Ho_Chi_Minh Antarctica/Davis
+Atlantic/Bermuda Europe/Amsterdam Antarctica/Casey America/St_Johns
+Atlantic/Madeira America/Winnipeg America/St_Kitts Europe/Volgograd
+Brazil/DeNoronha Europe/Bucharest Africa/Mogadishu America/St_Lucia
+Atlantic/Stanley Europe/Stockholm Australia/Currie Europe/Gibraltar
+Australia/Sydney Asia/Krasnoyarsk Australia/Darwin America/Dominica
+America/Edmonton America/Eirunepe Europe/Podgorica America/Ensenada
+Europe/Ljubljana Australia/Hobart Europe/Mariehamn Africa/Lubumbashi
+America/Goose_Bay Europe/Luxembourg America/Menominee America/Glace_Bay
+America/Fortaleza Africa/Nouakchott America/Matamoros Pacific/Galapagos
+America/Guatemala Pacific/Kwajalein Pacific/Marquesas America/Guayaquil
+Asia/Kuala_Lumpur Europe/San_Marino America/Monterrey Europe/Simferopol
+America/Araguaina Antarctica/Vostok Europe/Copenhagen America/Catamarca
+Pacific/Pago_Pago America/Sao_Paulo America/Boa_Vista America/St_Thomas
+Chile/Continental America/Vancouver Africa/Casablanca Europe/Bratislava
+Pacific/Enderbury Pacific/Rarotonga Europe/Zaporozhye US/Indiana-Starke
+Antarctica/Palmer Asia/Novokuznetsk Africa/Libreville America/Chihuahua
+America/Anchorage Pacific/Tongatapu Antarctica/Mawson Africa/Porto-Novo
+Asia/Yekaterinburg America/Paramaribo America/Hermosillo Atlantic/Jan_Mayen
+Antarctica/McMurdo America/Costa_Rica Antarctica/Rothera America/Grand_Turk
+Atlantic/Reykjavik Atlantic/St_Helena Australia/Victoria Chile/EasterIsland
+Asia/Ujung_Pandang Australia/Adelaide America/Montserrat America/Porto_Acre
+Africa/Brazzaville Australia/Brisbane America/Kralendijk America/Montevideo
+America/St_Vincent America/Louisville Australia/Canberra Australia/Tasmania
+Europe/Isle_of_Man Europe/Kaliningrad Africa/Ouagadougou America/Rio_Branco
+Pacific/Kiritimati Africa/Addis_Ababa America/Metlakatla America/Martinique
+Asia/Srednekolymsk America/Guadeloupe America/Fort_Wayne Australia/Lindeman
+America/Whitehorse Arctic/Longyearbyen America/Pangnirtung America/Mexico_City
+America/Los_Angeles America/Rainy_River Atlantic/Cape_Verde Pacific/Guadalcanal
+Indian/Antananarivo America/El_Salvador Australia/Lord_Howe Africa/Johannesburg
+America/Tegucigalpa Canada/Saskatchewan America/Thunder_Bay Canada/Newfoundland
+America/Puerto_Rico America/Yellowknife Australia/Melbourne America/Porto_Velho
+Australia/Queensland Australia/Yancowinna America/Santa_Isabel
+America/Blanc-Sablon America/Scoresbysund America/Danmarkshavn
+Pacific/Port_Moresby Antarctica/Macquarie America/Buenos_Aires
+Africa/Dar_es_Salaam America/Campo_Grande America/Dawson_Creek
+America/Indianapolis Pacific/Bougainville America/Rankin_Inlet
+America/Indiana/Knox America/Lower_Princes America/Coral_Harbour
+America/St_Barthelemy Australia/Broken_Hill America/Cambridge_Bay
+America/Indiana/Vevay America/Swift_Current America/Port_of_Spain
+Antarctica/South_Pole America/Santo_Domingo Atlantic/South_Georgia
+America/Port-au-Prince America/Bahia_Banderas America/Indiana/Winamac
+America/Indiana/Marengo America/Argentina/Jujuy America/Argentina/Salta
+Canada/East-Saskatchewan America/Indiana/Vincennes America/Argentina/Tucuman
+America/Argentina/Ushuaia Antarctica/DumontDUrville America/Indiana/Tell_City
+America/Argentina/Mendoza America/Argentina/Cordoba America/Indiana/Petersburg
+America/Argentina/San_Luis America/Argentina/San_Juan America/Argentina/La_Rioja
+America/North_Dakota/Center America/Kentucky/Monticello
+America/North_Dakota/Beulah America/Kentucky/Louisville
+America/Argentina/Catamarca America/Indiana/Indianapolis
+America/North_Dakota/New_Salem America/Argentina/Rio_Gallegos
+America/Argentina/Buenos_Aires America/Argentina/ComodRivadavia
+]
+  TIMEZONEs = TIMEZONES.collect(&:downcase)
+
+  #
+  # Zon{ing|ed}Time, whatever.
+  #
+  class ZoTime
+
+    attr_accessor :seconds
+    attr_accessor :zone
+
+    def initialize(s, zone)
+
+      @seconds = s.to_f
+      @zone = zone
+    end
+
+    def time
+
+      in_zone do
+
+        t = Time.at(@seconds)
+
+        #if t.isdst
+        #  t1 = Time.at(@seconds + 3600)
+        #  t = t1 if t.zone != t1.zone && t.hour == t1.hour && t.min == t1.min
+        #    # ambiguous TZ (getting out of DST)
+        #else
+        #  t.hour # force t to compute itself
+        #end
+        #
+        # jump out of DST as soon as possible, jumps 1h as seen from UTC
+
+        t.hour # force t to compute itself
+        #
+        # stay in DST as long as possible, no jump seen from UTC
+
+        t
+      end
+    end
+
+    def utc
+
+      time.utc
+    end
+
+    def add(s)
+
+      @seconds += s.to_f
+    end
+
+    def substract(s)
+
+      @seconds -= s.to_f
+    end
+
+    def to_f
+
+      @seconds
+    end
+
+    #DELTA_TZ_REX = /^[+-][0-1][0-9]:?[0-5][0-9]$/
+
+    def self.envtzable?(s)
+
+      TIMEZONES.include?(s)
+    end
+
+    def self.parse(str, opts={})
+
+      if defined?(::Chronic) && t = ::Chronic.parse(str, opts)
+        return ZoTime.new(t, ENV['TZ'])
+      end
+
+      begin
+        DateTime.parse(str)
+      rescue
+        fail ArgumentError, "no time information in #{o.inspect}"
+      end if RUBY_VERSION < '1.9.0'
+
+      zone = nil
+
+      s =
+        str.gsub(/\S+/) { |m|
+          if envtzable?(m)
+            zone ||= m
+            ''
+          else
+            m
+          end
+        }
+
+      return nil unless zone.nil? || is_timezone?(zone)
+
+      zt = ZoTime.new(0, zone || ENV['TZ'])
+      zt.in_zone { zt.seconds = Time.parse(s).to_f }
+
+      zt.seconds == nil ? nil : zt
+    end
+
+    def self.is_timezone?(str)
+
+      return false if str == nil
+      return false if str == '*'
+
+      return false if str.index('#')
+      # "sun#2", etc... On OSX would go all the way to true
+
+      return true if Time.zone_offset(str)
+
+      return !! (::TZInfo::Timezone.get(str) rescue nil) if defined?(::TZInfo)
+
+      return true if TIMEZONES.include?(str)
+      return true if TIMEZONEs.include?(str)
+
+      t = ZoTime.new(0, str).time
+
+      return false if t.zone == ''
+      return false if t.zone == 'UTC'
+      return false if t.utc_offset == 0 && str.start_with?(t.zone)
+      # 3 common fallbacks...
+
+      return false if RUBY_PLATFORM.include?('java') && ! envtzable?(str)
+
+      true
+    end
+
+    def in_zone(&block)
+
+      current_timezone = ENV['TZ']
+      ENV['TZ'] = @zone
+
+      block.call
+
+    ensure
+
+      ENV['TZ'] = current_timezone
+    end
+  end
+end

data/lib/rocket_job/version.rb

@@ -1,4 +1,4 @@
 # encoding: UTF-8
 module RocketJob #:nodoc
-  VERSION = '2.0.0.rc3'
+  VERSION = '2.0.0'
 end

data/lib/rocket_job/worker.rb

@@ -344,7 +344,7 @@ module RocketJob
       skip_job_ids = []
       processed    = false
       while (job = Job.rocket_job_next_job(name, skip_job_ids)) && !shutting_down?
-        logger.fast_tag("Job #{job.id}") do
+        logger.fast_tag("job:#{job.id}") do
           if job.rocket_job_work(self)
             # Need to skip the specified job due to throttling or no work available
             skip_job_ids << job.id

data/lib/rocketjob.rb

@@ -7,33 +7,39 @@ require 'rocket_job/version'
 
 # @formatter:off
 module RocketJob
-  autoload :CLI,               'rocket_job/cli'
-  autoload :Config,            'rocket_job/config'
-  autoload :DirmonEntry,       'rocket_job/dirmon_entry'
-  autoload :Heartbeat,         'rocket_job/heartbeat'
-  autoload :Job,               'rocket_job/job'
-  autoload :JobException,      'rocket_job/job_exception'
-  autoload :Worker,            'rocket_job/worker'
+  autoload :CLI,                'rocket_job/cli'
+  autoload :Config,             'rocket_job/config'
+  autoload :DirmonEntry,        'rocket_job/dirmon_entry'
+  autoload :Heartbeat,          'rocket_job/heartbeat'
+  autoload :Job,                'rocket_job/job'
+  autoload :JobException,       'rocket_job/job_exception'
+  autoload :Worker,             'rocket_job/worker'
 
   module Plugins
     module Job
-      autoload :Callbacks,     'rocket_job/plugins/job/callbacks'
-      autoload :Defaults,      'rocket_job/plugins/job/defaults'
-      autoload :StateMachine,  'rocket_job/plugins/job/state_machine'
-      autoload :Logger,        'rocket_job/plugins/job/logger'
-      autoload :Model,         'rocket_job/plugins/job/model'
-      autoload :Persistence,   'rocket_job/plugins/job/persistence'
-      autoload :Worker,        'rocket_job/plugins/job/worker'
+      autoload :Callbacks,      'rocket_job/plugins/job/callbacks'
+      autoload :Defaults,       'rocket_job/plugins/job/defaults'
+      autoload :StateMachine,   'rocket_job/plugins/job/state_machine'
+      autoload :Logger,         'rocket_job/plugins/job/logger'
+      autoload :Model,          'rocket_job/plugins/job/model'
+      autoload :Persistence,    'rocket_job/plugins/job/persistence'
+      autoload :Worker,         'rocket_job/plugins/job/worker'
     end
-    autoload :Document,        'rocket_job/plugins/document'
-    autoload :Restart,         'rocket_job/plugins/restart'
-    autoload :Singleton,       'rocket_job/plugins/singleton'
-    autoload :StateMachine,    'rocket_job/plugins/state_machine'
+    module Rufus
+      autoload :CronLine,       'rocket_job/plugins/rufus/cron_line'
+      autoload :ZoTime,         'rocket_job/plugins/rufus/zo_time'
+    end
+    autoload :Cron,             'rocket_job/plugins/cron'
+    autoload :Document,         'rocket_job/plugins/document'
+    autoload :ProcessingWindow, 'rocket_job/plugins/processing_window'
+    autoload :Restart,          'rocket_job/plugins/restart'
+    autoload :Singleton,        'rocket_job/plugins/singleton'
+    autoload :StateMachine,     'rocket_job/plugins/state_machine'
   end
 
   module Jobs
-    autoload :DirmonJob,       'rocket_job/jobs/dirmon_job'
-    autoload :SimpleJob,       'rocket_job/jobs/simple_job'
+    autoload :DirmonJob,        'rocket_job/jobs/dirmon_job'
+    autoload :SimpleJob,        'rocket_job/jobs/simple_job'
   end
 
   # @formatter:on

data/test/plugins/cron_test.rb

@@ -0,0 +1,78 @@
+require_relative '../test_helper'
+
+# Unit Test for RocketJob::Job
+module Plugins
+  class CronTest < Minitest::Test
+    class CronJob < RocketJob::Job
+      include RocketJob::Plugins::Cron
+
+      def perform
+        'DONE'
+      end
+    end
+
+    describe RocketJob::Plugins::Cron do
+      before do
+        # destroy_all could create new instances
+        CronJob.delete_all
+        assert_equal 0, CronJob.count
+      end
+
+      after do
+        @job.destroy if @job && !@job.new_record?
+        CronJob.delete_all
+      end
+
+      describe '#create!' do
+        it 'queues a new job' do
+          @job = CronJob.create!(cron_schedule: '* 1 * * *')
+          assert @job.valid?
+          refute @job.new_record?
+        end
+
+        describe 'timezones are supported' do
+          it 'handles UTC' do
+            time = Time.parse('2015-12-09 17:50:05 +0000')
+            Time.stub(:now, time) do
+              @job = CronJob.create!(cron_schedule: '* 1 * * * UTC')
+            end
+            assert @job.valid?
+            refute @job.new_record?
+            assert_equal Time.parse('2015-12-10 01:00:00 UTC'), @job.run_at
+          end
+
+          it 'handles Eastern' do
+            time = Time.parse('2015-12-09 17:50:05 +0000')
+            Time.stub(:now, time) do
+              @job = CronJob.create!(cron_schedule: '* 1 * * * America/New_York')
+            end
+            assert @job.valid?
+            refute @job.new_record?
+            assert_equal Time.parse('2015-12-10 06:00:00 UTC'), @job.run_at
+          end
+        end
+
+      end
+
+      describe '#valid?' do
+        it 'fails on missing cron schedule' do
+          @job = CronJob.new
+          refute @job.valid?
+          assert_equal "can't be blank", @job.errors.messages[:cron_schedule].first
+        end
+
+        it 'fails on bad cron schedule' do
+          @job = CronJob.new(cron_schedule: 'blah')
+          refute @job.valid?
+          assert_equal "not a valid cronline : 'blah'", @job.errors.messages[:cron_schedule].first
+        end
+
+        it 'passes on valid cron schedule' do
+          @job = CronJob.new(cron_schedule: '* 1 * * *')
+          assert @job.valid?
+        end
+      end
+
+    end
+  end
+end

data/test/plugins/job/logger_test.rb

@@ -43,12 +43,12 @@ module Plugins
           end
 
           it 'adds completed logging' do
-            @job             = LoggerJob.new
-            benchmark_called = false
-            @job.logger.stub(:benchmark_info, -> description, *args { benchmark_called = true if description == 'Completed #perform' }) do
+            @job           = LoggerJob.new
+            measure_called = false
+            @job.logger.stub(:measure_info, -> description, *args { measure_called = true if description == 'Completed #perform' }) do
               @job.perform_now
             end
-            assert benchmark_called, "In Plugins::Job::Logger.around_perform logger.benchmark_info('Completed #perform') not called"
+            assert measure_called, "In Plugins::Job::Logger.around_perform logger.measure_info('Completed #perform') not called"
           end
         end