clockwork-mocks 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bad3a611b8f9f74f5d53f98f486af7c2f5ac2557
-  data.tar.gz: ab77bd94f870a31e553fde0f7d65c02592b70cf6
+  metadata.gz: d1bad1a54175dbed4dbe8530c589ca6d2d699404
+  data.tar.gz: e515fa9fc4bea5f981a1b410115c55d0e6dd7816
 SHA512:
-  metadata.gz: cca4ce9c635e96241e52316114e5d7e59357c1d42fb07db72b552e08ab0a2aeceae2bd44670ef77c1a2f4e7362f269b088826c853f75fbf88f3a7ff349121393
-  data.tar.gz: 1991ef04ea9fac5d4fd8b949d9ed5ac9bcbd641693afd72cd0609d20c5ce00c3730dd473106d709ac0e88a2c2e424121de6b739b9690ab23d43335ef62d20758
+  metadata.gz: efd69b2649a2d37862af8c01ecd32df2b282bfa3c05aceab75395a2a1a532bfba2fbc88f2df869285790cf3a55c4d0663f8aacb31858476b9b1c64b498c8c771
+  data.tar.gz: 55019f777ec301c4269d595ff217634ab013f1ea197ed7c2c42173db7a7c766855de188eb8161642515c07a4f21bf31a8d70bb68b97927c5a69d2f88d7d72796

data/README.md

@@ -4,12 +4,52 @@ This gem provides **helpers for integration testing with clockwork**.
 [Clockwork](https://github.com/Rykian/clockwork) provides a cron-like utility for ruby.
 It works especially well in combination with [timecop](https://github.com/travisjeffery/timecop).
 
+## Example Usecase
+
+Image you have a rails app with a clockwork task scheduled every night to check for inactive users and sends them reminders via email.
+Your `clock.rb` file would look as follows:
+
+```ruby
+module Clockwork
+  every(1.day, 'inactives', at: '00:00') do
+    User.inactive.each do
+      Mailer.reminder_mail.deliver_later
+    end
+  end
+end
+```
+
+By using ClockworkMocks in combination with RSpec and Timecop, you could test this as follows:
+
+```ruby
+RSpec.describe ... do
+  before { ClockworkMocks.reset_rspec(method(:allow), method(:receive)) }
+  let!(:user) { create(:user) }
+
+  context 'after 7 days without action' do
+    before do
+      Timecop.freeze 7.days.from_now
+      ClockworkMocks.work
+    end
+    after { Timecop.return }
+
+    it 'should have sent the user a reminder' do
+      expect(ActionMailer::Base.deliveries).not_to be_empty
+    end
+  end
+end
+```
+
+Note that this does not replace proper unit tests, but gives you the possibility to additionally test your system as a whole.
+
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this to your application's Gemfile:
 
 ```ruby
-gem 'clockwork-mocks'
+group :test do
+  gem 'clockwork-mocks'
+end
 ```
 
 And then execute:
@@ -48,11 +88,11 @@ Using this interface, you can use any stub provider to stub `Clockwork`'s method
 For example with rspec-mock:
 
 ```ruby
-allow.call(Clockwork).to receive.call(:handler) do |&block|
+allow(Clockwork).to receive(:handler) do |&block|
   ClockworkMocks.scheduler.handler(&block)
 end
 
-allow.call(Clockwork).to receive.call(:every) do |interval, name, hash, &block|
+allow(Clockwork).to receive(:every) do |interval, name, hash, &block|
   ClockworkMocks.scheduler.every interval, name, hash, &block
 end
 
@@ -91,6 +131,17 @@ not so often
 often
 ```
 
+### Sidekiq
+
+If you use clockwork to schedule sidekiq jobs but want them to actually execute during integration testing I recommend one of two options:
+
+1. Use sidekiq's inline mode to execute all jobs immediately during integration testing.
+   This works well if you don't on scheduled jobs or don't care about the execution date.
+2. Use a library like [sidekiq-fake-scheduler](https://github.com/dpoetzsch/sidekiq-fake-scheduler).
+   This is superior to inline mode in that it respects the dates when the jobs are scheduled so you can test your application more fine-grained.
+   The proposed gem neatly integrates with clockwork-mocks.
+   Disclaimer: I am the creator and maintainer of sidekiq-fake-scheduler.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/clockwork_mocks/clockwork_task.rb

@@ -12,7 +12,7 @@ module ClockworkMocks
     end
 
     def reset!
-      @due = Time.now
+      @due = Time.now.utc
       @due = calc_due
     end
 
@@ -20,7 +20,7 @@ module ClockworkMocks
       if @block
         @block.call
       elsif handler
-        handler.call(@name, Time.now)
+        handler.call(@name, Time.now.utc)
       end
       @due = calc_due
     end
@@ -30,7 +30,7 @@ module ClockworkMocks
     private
 
     def calc_due
-      ndue = Time.at((due || Time.now).to_f + @interval)
+      ndue = Time.at((due || Time.now.utc).to_f + @interval).utc
 
       return ndue unless @hash[:at]
 

data/lib/clockwork_mocks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ClockworkMocks
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clockwork-mocks
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - David Poetzsch-Heffter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2017-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clockwork
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Helpers for manual scheduling of clockwork tasks for integration testing