stagger 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aea07a97eb08adfb0b987354b8146f2178595f7a
-  data.tar.gz: e2afd6e33044f41c77075429e71f0cb447c3a42f
+  metadata.gz: f219ca29cb8639825bccec42c9f37267e80609d0
+  data.tar.gz: 5d61f7cdecbe5ead509e5d933959cc071215d4de
 SHA512:
-  metadata.gz: 543a5bc36e6b6c59224d3cd8f14075e4874d88ab7bbfe99989ec8114ffcd9cdd8ad4fc9d5924e72fd14efbcf264890e2cb723e6306285797d4dd0bd000fd542c
-  data.tar.gz: d0942f54379748f62cb77dc54e8e72347ba3467631195d3ea86f4681e8f4696ef1a50e547197f9a06142f997dbfcda1e66c8533c1477f0d5c6959adbb53c8de2
+  metadata.gz: a8607c7cc1731e7dbf0d90d4de769ab7339b494a14a518cb2ffe186a5cb605e1f702be938a39ac118a9a96c9edead217c827b4f90931f649f8099ada01e8f9e2
+  data.tar.gz: 7343e17149e12f843eb5be374cd7fb64b99f1355ee3180ebdebce24b7b99deef18d9b4dc16dab25f81c43cdc1e91f489984e03e3b59682a8366a393b20046610

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  enabled: true

data/README.md

@@ -9,7 +9,10 @@ days.
 On the surface, this tasks seems simple, but when you have a lot of
 tasks,
 that should be scheduled across business days, that span several weeks,
-it gets complicated. Stagger has good test coverage, I covered all cases
+it gets complicated. When you have both plain ruby `Time` and
+`ActiveSupport::TimeWithZone`, it gets even more hairy.
+
+Stagger has good test coverage, I covered all cases
 I could think of with specs.
 
 Stagger has no runtime dependencies.
@@ -24,12 +27,22 @@ emails = get_emails()
 schedule = Stagger.distribute(emails, 14)
 ```
 
-Schedule one item to be sent as soon as possible but on business day only:
+Schedule one item to be sent as soon as possible but on a business day only:
 
 ```ruby
 email = get_email() # only one email
 schedule = Stagger.distribute([email], 1) # i.e. distribute across 1
 business day
+
+Schedule one item to be sent after a delay of 5 minutes, but on a business day only:
+
+```ruby
+email = get_email() # only one email
+# specify delay in seconds
+schedule = Stagger.distribute([email], 1, delay: 5 * 60) # i.e. distribute across 1
+business day
+```
+
 ```
 
 Schedule 1000 emails to be sent across next 30 business days:
@@ -59,9 +72,20 @@ But when `ActiveSupport` is available, it returns instances of rails'
 In other words, you don't need to do anything when using this gem with
 Rails.
 
+## Options
+
+### Delay
+
+Specified in seconds, default is 0.
+Will make the first and subsequent items to be shifted ahead in time.
+Useful to make for scenarios when first item w/out an initial delay will
+have been in the past by the time the processing logic will pick it up.
+If the delay makes the first item to be scheduled on a weekend, it will
+be sent on Monday at 00 hours.
+
 ## Plans
 
-Plans to add support for holidays / initial delay and working hours in the future.**
+Plans to add support for holidays and working hours in the future.**
 
 
 ## Installation

data/lib/stagger.rb

@@ -3,9 +3,14 @@ require "stagger/version"
 module Stagger
   SECONDS_IN_DAY = 86_400
   class << self
-    def distribute(items, number_of_days)
+    # Evenly distributes items acros business days
+    # @param [Array, items] items to stagger
+    # @param [Integer, number_of_days] number of business days to distribute within
+    # @param [Integer, delay] number of seconds to delay the staggering
+    # @return [Array] array of arrays, where first subarray element is a scheduled DateTime, second is the staggered item
+    def distribute(items, number_of_days, delay: 0)
       return [] if Array(items).empty? || number_of_days.to_i < 1
-      time = get_starting_time
+      time = get_starting_time(delay)
       period_in_seconds = get_period_in_seconds(items.size, number_of_days, time)
       items.reduce [] do |arr, item|
         if business_day?(time)
@@ -29,8 +34,8 @@ module Stagger
       end
     end
 
-    def get_starting_time
-      tc = current_time
+    def get_starting_time(delay)
+      tc = current_time + delay
       if tc.saturday?
         at_beginning_of_day(tc) + SECONDS_IN_DAY * 2
       elsif tc.sunday?

data/lib/stagger/version.rb

@@ -1,3 +1,3 @@
 module Stagger
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/stagger_spec.rb

@@ -47,6 +47,24 @@ RSpec.describe Stagger do
           end
         end
 
+        it 'schedules to run after a delay if today is a business day' do
+          t = Time.local(2014, 6, 27, 18) # 6pm, Friday
+          Timecop.freeze(t) do
+            # stagger after a delay of 5 minutes
+            pair = Stagger.distribute([1], 1, delay: 300).first
+            expect(pair.last).to eq Time.local(2014, 6, 27, 18, 5)
+          end
+        end
+
+        it 'schedules to run after a big delay that spans over the weekend' do
+          t = Time.local(2014, 6, 27, 18) # 6pm, Friday
+          Timecop.freeze(t) do
+            # stagger after a delay of 72 hours
+            pair = Stagger.distribute([1], 1, delay: 72 * 60 * 60).first
+            expect(pair.last).to eq Time.local(2014, 6, 30, 18)
+          end
+        end
+
         it 'schedules immediately if today is a business day and number of days > 1' do
           # a dumb test, actually, but I need to cover it
           t = Time.local(2014, 6, 27, 18) # 6pm, Friday
@@ -56,6 +74,33 @@ RSpec.describe Stagger do
           end
         end
 
+        it 'schedules to run after a delay if today is a business day and number of days > 1' do
+          t = Time.local(2014, 6, 27, 18) # 6pm, Friday
+          Timecop.freeze(t) do
+            # stagger after a delay of 5 minutes
+            pair = Stagger.distribute([1], 2, delay: 300).first
+            expect(pair.last).to eq Time.local(2014, 6, 27, 18, 5)
+          end
+        end
+
+        it 'schedules to run on Monday business day if delay will schedule the first item run on Saturday' do
+          t = Time.local(2014, 6, 27, 18) # 6pm, Friday
+          Timecop.freeze(t) do
+            # stagger after a delay of 7 hours
+            pair = Stagger.distribute([1], 1, delay: 7 * 60 * 60).first
+            expect(pair.last).to eq Time.local(2014, 6, 30) # Midnight, Monday
+          end
+        end
+
+        it 'schedules to run on Monday business day if delay will schedule the first item run on Sunday' do
+          t = Time.local(2014, 6, 27, 18) # 6pm, Friday
+          Timecop.freeze(t) do
+            # stagger after a delay of 31 hours (1 in the morning of Sunday)
+            pair = Stagger.distribute([1], 1, delay: 31 * 60 * 60).first
+            expect(pair.last).to eq Time.local(2014, 6, 30) # Midnight, Monday
+          end
+        end
+
         it 'schedules to run on Monday (00:00) if today is Sunday' do
           t = Time.local(2014, 6, 29, 14) # - 2pm, Sunday
           Timecop.freeze(t) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stagger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Valentin Vasilyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2014-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
@@ -147,11 +148,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Gem evenly distributes items across business days
 test_files:
 - spec/spec_helper.rb
 - spec/stagger_spec.rb
-has_rdoc: