clockwork-mocks 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b436d9635aa6860b72e5bac1b000a593d4ef227
-  data.tar.gz: 7b83532781c99ab48aa9fbc5fc779edbfb6250c9
+  metadata.gz: 17b8f640f1ade961325aa2a3f09024a14afc5eea
+  data.tar.gz: acca7e106a0e1e1fef75a3d3da5c2fdf2c91a294
 SHA512:
-  metadata.gz: 33323cf68d95c4adca58d2f829ae6a6ec0e18564944abec53c941cb369f57ce2d6e3a570c345246420239a7db1495240399e3daacb273f3cd1da21b2c5adde46
-  data.tar.gz: 0106ded73688114d79879b0a9b5a315af1dc292fd614de25d98c6d80c7921d790823882786694d439116d600e069d23988d3c3b564c819290e673de6b5e8797b
+  metadata.gz: 736060ca732b91939c22dd0f7df7fd3c898111de6ddc4acdfab8c2256fe4457b3718b1baa768bb34682b5c7d0af564396d8923ef8a3bef34b37bc139321accf6
+  data.tar.gz: 432f1b04c841fd621d6ca6b2df0adf95aa38213f4b9bb1521a17f7e1d407e7db25cfca9c4f100cf9c06aba5f6037cdfaa847dd1902952035b17a911d76d4c316

data/README.md

@@ -26,42 +26,35 @@ Or install it yourself as:
 
 ```ruby
 RSpec.describe ... do
-  let!(:clockwork_scheduler) { ClockworkMocks::Scheduler.init_rspec(->(a) { allow a }, ->(a) { receive a }, 'path/to/clock.rb') }
+  before(:all) { ClockworkMocks.init_rspec(method(:allow), method(:receive), 'path/to/clock.rb') }
+  before { ClockworkMocks.reset! }
 end
 ```
 
-If you do not pass a clock file path to `ClockworkMocks::Scheduler.new` and you are in a rails environment it will assume `"#{Rails.root}/clock.rb"` by default.
-This reloads the `clock.rb` file in every test.
-If you care about that performance leak, there is a more verbose initialization option:
-
-```ruby
-RSpec.describe ... do
-  clockwork_scheduler = nil
-  
-  before do
-    clockwork_scheduler ||= ClockworkMocks::Scheduler.init_rspec(metod(:allow), method(:receive), 'path/to/clock.rb')
-    clockwork_scheduler.reset!
-  end
-end
-```
+If you do not pass a clock file path to `ClockworkMocks.init_rspec` and you are in a rails environment it will assume `"#{Rails.root}/clock.rb"` by default.
 
 ### General Initialization
 
 ```ruby
-clockwork_scheduler = ClockworkMocks::Scheduler.new
-
-# ...
+ClockworkMocks.scheduler.handler do |job, time|
+  # something
+end
 
-clockwork_scheduler.every(1.day, 'some task', at: '23:00') do
+ClockworkMocks.scheduler.every(1.day, 'some task', at: '23:00') do
   # something
 end
 ```
 
-Using this interface, you can use any stub provider to stub `Clockwork.every` and call `clockwork_scheduler.every` instead, e.g. with rspec-mock:
+Using this interface, you can use any stub provider to stub `Clockwork`'s methods and call `ClockworkMocks.scheduler`'s methods instead.
+For example with rspec-mock:
 
 ```ruby
+allow.call(Clockwork).to receive.call(:handler) do |&block|
+  ClockworkMocks.scheduler.handler(&block)
+end
+
 allow.call(Clockwork).to receive.call(:every) do |interval, name, hash, &block|
-  clockwork_scheduler.every interval, name, hash, &block
+  ClockworkMocks.scheduler.every interval, name, hash, &block
 end
 
 load 'path/to/clock.rb'
@@ -69,12 +62,12 @@ load 'path/to/clock.rb'
 
 ### Executing clockwork tasks
 
-At any time you can call `clockwork_scheduler.work` to execute all tasks that are due.
+At any time you can call `ClockworkMocks.work` to execute all tasks that are due.
 This works especially well in combination with timecop (although the latter is not a requirement):
 
 ```ruby
 Timecop.freeze(2.days.from_now) do
-  clockwork_scheduler.work
+  ClockworkMocks.work
 end
 ```
 
@@ -82,11 +75,11 @@ Tasks will be executed in correct order.
 If enough time passed, tasks will be executed multiple times:
 
 ```ruby
-clockwork_scheduler.every(1.second, 'often') { puts 'often' }
-clockwork_scheduler.every(2.seconds, 'not-so-often') { puts 'not so often' }
+ClockworkMocks.scheduler.every(1.second, 'often') { puts 'often' }
+ClockworkMocks.scheduler.every(2.seconds, 'not-so-often') { puts 'not so often' }
 
 Timecop.freeze(3.seconds.from_now) do
-  clockwork_scheduler.work
+  ClockworkMocks.work
 end
 ```
 
@@ -95,7 +88,7 @@ outputs
 ```
 often
 often
-not-so-often
+not so often
 often
 ```
 

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "clockwork/mocks"
+require "clockwork_mocks"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/clockwork_mocks.rb

@@ -5,3 +5,21 @@ require 'clockwork'
 require 'clockwork_mocks/version'
 require 'clockwork_mocks/clockwork_task'
 require 'clockwork_mocks/scheduler'
+
+module ClockworkMocks
+  def self.init_rspec(allow, receive, clock_file = nil, &block)
+    scheduler.init_rspec(allow, receive, clock_file, &block)
+  end
+
+  def self.scheduler
+    @scheduler ||= Scheduler.new
+  end
+
+  def self.reset!
+    scheduler.reset!
+  end
+
+  def self.work
+    scheduler.work
+  end
+end

data/lib/clockwork_mocks/clockwork_task.rb

@@ -25,7 +25,7 @@ module ClockworkMocks
       @due = calc_due
     end
 
-    attr_reader :due
+    attr_reader :due, :name
 
     private
 

data/lib/clockwork_mocks/scheduler.rb

@@ -8,15 +8,17 @@ module ClockworkMocks
       @tasks = []
     end
 
-    def self.init_rspec(allow, receive, clock_file = nil)
-      scheduler = Scheduler.new
+    def self.init_rspec(allow, receive, clock_file = nil, &block)
+      Scheduler.new.tap { |s| s.init_rspec(allow, receive, clock_file, &block) }
+    end
 
+    def init_rspec(allow, receive, clock_file = nil)
       allow.call(Clockwork).to receive.call(:handler) do |&block|
-        scheduler.handler(&block)
+        handler(&block)
       end
 
       allow.call(Clockwork).to receive.call(:every) do |interval, name, hash, &block|
-        scheduler.every interval, name, hash, &block
+        every interval, name, hash, &block
       end
 
       if block_given?
@@ -29,8 +31,6 @@ module ClockworkMocks
 
         load clock_file if clock_file
       end
-
-      scheduler
     end
 
     def work

data/lib/clockwork_mocks/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clockwork-mocks
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - David Poetzsch-Heffter