sidetiq 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe87e48535b00a33d15395b564b62fce3a4ed68d
-  data.tar.gz: 1cb3287fdd6312b1792c11d46561b495cba27114
+  metadata.gz: d5176aed9abba4157c9913ff2b421ae5c355e1d3
+  data.tar.gz: 1a6f8f296756a2f8b86d7bd2583e95aedbf3f530
 SHA512:
-  metadata.gz: 040024621688bf956b27cee9f85235d348886e09d315cd07ada3c85faa991f02068a3e37b705307aac499aef0b7dc0f6cbaef498271149dab602a50e04a2a9e5
-  data.tar.gz: 6de537a1815d7cf3a1e3830efd36883b84a79ff034f54012d7c63ca809eddac5ec7e8315c0b291889cade9b63e4d73aa604606553c10116045c60cc79e9f65f2
+  metadata.gz: 52b4e965ffad546335b40203c8fb93be9d45659736b37e207f26a41954fb3db999b5b1bd0cd0f9b3ef06bccca8f24ffe6e772fe1ee22c441cef99697cb3086d6
+  data.tar.gz: 2dd87568bbda265f76e7bd061e2044b404f08242bee266ff4086fdc994c8c22ce866a4ba969bfcd34f189bd267676004517eac977a8185035d865e4690143656

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.3.3
+-----
+
+- Deprecate Sidekiq::Schedulable.tiq in favor of .recurrence.
+  Sidekiq::Schedulable.tiq will still work until v0.4.0 but log
+  a deprecation warning.
+
 0.3.2
 -----
 

data/README.md

@@ -71,7 +71,7 @@ class MyWorker
   include Sidetiq::Schedulable
 
   # Daily at midnight
-  tiq { daily }
+  recurrence { daily }
 
   def perform
     # do stuff ...
@@ -86,7 +86,7 @@ class MyWorker
   include Sidekiq::Worker
   include Sidetiq::Schedulable
 
-  tiq do
+  recurrence do
     # Every third year in March
     yearly(3).month_of_year(:march)
 
@@ -108,7 +108,7 @@ class MyWorker
   include Sidetiq::Schedulable
 
   # Every other month on the first monday and last tuesday at 12 o'clock.
-  tiq { monthly(2).day_of_week(1 => [1], 2 => [-1]).hour_of_day(12) }
+  recurrence { monthly(2).day_of_week(1 => [1], 2 => [-1]).hour_of_day(12) }
 
   def perform
     # do stuff ...
@@ -125,7 +125,7 @@ class MyWorker
   include Sidekiq::Worker
   include Sidetiq::Schedulable
 
-  tiq { daily }
+  recurrence { daily }
 
   # Receive last and current occurrence times.
   def perform(last_occurrence, current_occurrence)
@@ -152,7 +152,7 @@ Backfills
 
 In certain cases it is desirable that missed jobs will be enqueued
 retroactively, for example when a critical, hourly job isn't run due to
-server downtime. To solve this, `#tiq` takes a *backfill* option. If
+server downtime. To solve this, `#recurrence` takes a *backfill* option. If
 missing job occurrences have been detected, Sidetiq will then enqueue
 the jobs automatically. It will also ensure that the timestamps passed to
 `#perform` are as expected:
@@ -162,7 +162,7 @@ class MyWorker
   include Sidekiq::Worker
   include Sidetiq::Schedulable
 
-  tiq backfill: true do
+  recurrence backfill: true do
     hourly
   end
 
@@ -219,7 +219,8 @@ Sidetiq.schedules
 ```
 
 `Sidetiq.workers` returns an `Array` of all workers currently tracked by
-Sidetiq (workers which include `Sidetiq::Schedulable` and a `.tiq` call):
+Sidetiq (workers which include `Sidetiq::Schedulable` and a `.recurrence`
+call):
 
 ```ruby
 Sidetiq.workers
@@ -285,7 +286,7 @@ class MyWorker
   include Sidekiq::Worker
   include Sidetiq::Schedulable
 
-  tiq { minutely(15) }
+  recurrence { minutely(15) }
 end
 ```
 
@@ -296,7 +297,7 @@ class MyWorker
   include Sidekiq::Worker
   include Sidetiq::Schedulable
 
-  tiq { hourly.minute_of_hour(0, 15, 30, 45) }
+  recurrence { hourly.minute_of_hour(0, 15, 30, 45) }
 end
 ```
 

data/examples/simple.rb

@@ -13,7 +13,7 @@ class MyWorker
   include Sidekiq::Worker
   include Sidetiq::Schedulable
 
-  tiq { secondly }
+  recurrence { secondly }
 
   def perform(*args)
     Sidekiq.logger.info "#perform"

data/lib/sidetiq/schedulable.rb

@@ -22,7 +22,14 @@ module Sidetiq
         get_timestamp "next"
       end
 
-      def tiq(options = {}, &block) # :nodoc:
+      def tiq(*args, &block) # :nodoc:
+        Sidetiq.logger.warn "DEPRECATION WARNING: Sidetiq::Schedulable#tiq" <<
+          " is deprecated and will be removed. Use" <<
+          " Sidetiq::Schedulable#recurrence instead."
+        recurrence(*args, &block)
+      end
+
+      def recurrence(options = {}, &block) # :nodoc:
         clock = Sidetiq::Clock.instance
         clock.synchronize do
           schedule = clock.schedule_for(self)

data/lib/sidetiq/version.rb

@@ -8,7 +8,7 @@ module Sidetiq
     MINOR = 3
 
     # Public: Sidetiq patch level.
-    PATCH = 2
+    PATCH = 3
 
     # Public: String representation of the current Sidetiq version.
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')

data/test/fixtures/backfill_worker.rb

@@ -2,7 +2,7 @@ class BackfillWorker
   include Sidekiq::Worker
   include Sidetiq::Schedulable
 
-  tiq backfill: true do
+  recurrence backfill: true do
     daily
   end
 

data/test/fixtures/scheduled_worker.rb

@@ -2,7 +2,7 @@ class ScheduledWorker
   include Sidekiq::Worker
   include Sidetiq::Schedulable
 
-  tiq do
+  recurrence do
     daily.hour_of_day(1)
     yearly.month_of_year(2)
     monthly.day_of_month(3)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidetiq
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Tobias Svensson