clockwork-test 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ae0cfddfe422335668da047a76e3f000bc2d3c47
-  data.tar.gz: 293e4428ae8f1da04648211915b7c7a83b085085
+SHA256:
+  metadata.gz: 0720316ef603e9190a19ebfd87639c2f8db3f5606f809fcae5d82719624ef300
+  data.tar.gz: bebe9b55cfba6288e3d06331edab3196ba2c42434aaa2b830e097d9afd2d59c2
 SHA512:
-  metadata.gz: eb9a8a9c169b32f0923db5ade9e50a0386593b741eeb8a8bce61ec78472109faf7fc6a4afe29079ba34598ee56461b44e579641f539c5da69e09cfff445eef07
-  data.tar.gz: 4d8e20a57c3687a2ca5f2141286ce62d941cf3309803f560819f7a831965f493c70564cc4e947c60ffc71da212ffbce5a9f0acd3212d4279d056d296193b18be
+  metadata.gz: 9838b238b123348e3d692fbbdc799659997e972722006d751f46660b896a1a5536c2854c3ff85c0050009df69a6ab3ba7956a1aff3b8d3cf7fa3dc378519ea24
+  data.tar.gz: 5ba2548b8f6e6bc0846cda612930728a010542564f25da59f227b7b7ff353f8134f85ea52990de7a8b5a134b5a2ff9917f7dbf3542f558f20308d9f5570472f3

data/.travis.yml

@@ -2,9 +2,9 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
   - ruby-head
 script:
   - bundle exec rspec
@@ -12,7 +12,9 @@ matrix:
   allow_failures:
     - rvm: ruby-head
 gemfile:
+  - gemfiles/clockwork_master.gemfile
   - gemfiles/clockwork_1_3_1.gemfile
   - gemfiles/clockwork_2_0_0.gemfile
   - gemfiles/clockwork_2_0_1.gemfile
   - gemfiles/clockwork_2_0_2.gemfile
+  - gemfiles/clockwork_2_0_3.gemfile

data/Appraisals

@@ -1,3 +1,7 @@
+appraise "clockwork-master" do
+  gem "clockwork", git: "https://github.com/Rykian/clockwork"
+end
+
 appraise "clockwork-1-3-1" do
   gem "clockwork", "1.3.1"
 end

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 ## Current release (in development)
 
+## 0.3.0 [2018-06-19]
+
+* Introduce release process documentation [#14](https://github.com/kevin-j-m/clockwork-test/pull/14)
+
+  *Kevin Murphy*
+
+* Test against master branch of clockwork [#18](https://github.com/kevin-j-m/clockwork-test/pull/18)
+
+  *Kevin Murphy*
+
+* Add activesupport as dev dependency [#19](https://github.com/kevin-j-m/clockwork-test/pull/19)
+
+  *Kevin Murphy*
+
+* Update ruby point versions in testing matrix [#22](https://github.com/kevin-j-m/clockwork-test/pull/22)
+
+  *Kevin Murphy*
+
+* Add clockwork 2.0.3, support `skip_first_run` option [#25](https://github.com/kevin-j-m/clockwork-test/pull/25)
+
+  *[Oleksandr Rozumii](https://github.com/brain-geek)*
+
+* Default `end_time` to current time if `start_time` is provided with no end time [#26](https://github.com/kevin-j-m/clockwork-test/pull/26)
+
+  *[Oleksandr Rozumii](https://github.com/brain-geek)*
+
 ## 0.2.0
 
 * Refactor custom matcher to remove repeated code [#8](https://github.com/kevin-j-m/clockwork-test/pull/8)

data/README.md

@@ -51,6 +51,8 @@ end
 The following tests may be run against it:
 
 ```ruby
+require "clockwork/test"
+
 describe Clockwork do
   after(:each) { Clockwork::Test.clear! }
 
@@ -67,9 +69,9 @@ describe Clockwork do
     end_time = Time.new(2015, 11, 2, 3, 0, 0)
 
     Clockwork::Test.run(start_time: start_time, end_time: end_time, tick_speed:
-1.minute)
+      1.minute)
 
-    expect(Clockwork::Test.times_run("Run a job").to eq 60
+    expect(Clockwork::Test.times_run("Run a job")).to eq 60
   end
 
   describe "RSpec Custom Matcher" do
@@ -116,6 +118,8 @@ This specifies the time at which execution of clockwork should terminate. The ru
 
 This is commonly used along with `start_time` and `tick_speed` to quickly see if jobs run as often as expected over a certain period of time.
 
+When `start_time` is set, this setting defaults to `Time.current`.
+
 #### tick_speed
 
 `tick_speed` should be provided as a unit of time, such as `1.minute` or `3.hours`. It is the amount of time that the test will progress time to on every subsequent clock tick.

data/RELEASE_PROCESS.md

@@ -0,0 +1,6 @@
+* Bump version number in `lib/clockwork/test/version.rb`.
+* Update the [CHANGELOG](CHANGELOG.md), moving the current release work to under the version number.
+* Update appraisal gemfiles with the new version number `appraisal install`.
+* Run tests across all clockwork versions `appraisal rake`.
+* Push the release to RubyGems `rake release`.
+* Check the RubyGems [twitter account](https://twitter.com/rubygems) to publicize the release.

data/clockwork-test.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "activesupport"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"

data/gemfiles/clockwork_1_3_1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    clockwork-test (0.1.1)
+    clockwork-test (0.3.0)
       clockwork
       timecop
 
@@ -50,7 +50,7 @@ GEM
     slop (3.6.0)
     thor (0.19.4)
     thread_safe (0.3.6)
-    timecop (0.8.1)
+    timecop (0.9.1)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
 
@@ -58,6 +58,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   appraisal
   bundler (~> 1.7)
   clockwork (= 1.3.1)
@@ -68,4 +69,4 @@ DEPENDENCIES
   rspec-its
 
 BUNDLED WITH
-   1.14.6
+   1.16.2

data/gemfiles/clockwork_2_0_0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    clockwork-test (0.1.1)
+    clockwork-test (0.3.0)
       clockwork
       timecop
 
@@ -50,7 +50,7 @@ GEM
     slop (3.6.0)
     thor (0.19.4)
     thread_safe (0.3.6)
-    timecop (0.8.1)
+    timecop (0.9.1)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
 
@@ -58,6 +58,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   appraisal
   bundler (~> 1.7)
   clockwork (= 2.0.0)
@@ -68,4 +69,4 @@ DEPENDENCIES
   rspec-its
 
 BUNDLED WITH
-   1.14.6
+   1.16.2

data/gemfiles/clockwork_2_0_1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    clockwork-test (0.1.1)
+    clockwork-test (0.3.0)
       clockwork
       timecop
 
@@ -50,7 +50,7 @@ GEM
     slop (3.6.0)
     thor (0.19.4)
     thread_safe (0.3.6)
-    timecop (0.8.1)
+    timecop (0.9.1)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
 
@@ -58,6 +58,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   appraisal
   bundler (~> 1.7)
   clockwork (= 2.0.1)
@@ -68,4 +69,4 @@ DEPENDENCIES
   rspec-its
 
 BUNDLED WITH
-   1.14.6
+   1.16.2

data/gemfiles/clockwork_2_0_2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    clockwork-test (0.1.1)
+    clockwork-test (0.3.0)
       clockwork
       timecop
 
@@ -50,7 +50,7 @@ GEM
     slop (3.6.0)
     thor (0.19.4)
     thread_safe (0.3.6)
-    timecop (0.8.1)
+    timecop (0.9.1)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
 
@@ -58,6 +58,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   appraisal
   bundler (~> 1.7)
   clockwork (= 2.0.2)
@@ -68,4 +69,4 @@ DEPENDENCIES
   rspec-its
 
 BUNDLED WITH
-   1.14.6
+   1.16.2

data/gemfiles/clockwork_2_0_3.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "clockwork", "2.0.3"
+
+gemspec :path => "../"

data/gemfiles/clockwork_2_0_3.gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: ..
+  specs:
+    clockwork-test (0.2.0)
+      clockwork
+      timecop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    clockwork (2.0.3)
+      tzinfo
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    timecop (0.9.1)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  appraisal
+  bundler (~> 1.7)
+  clockwork (= 2.0.3)
+  clockwork-test!
+  pry
+  rake (~> 10.0)
+  rspec
+  rspec-its
+
+BUNDLED WITH
+   1.16.0.pre.3

data/gemfiles/clockwork_master.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "clockwork", :git => "https://github.com/Rykian/clockwork"
+
+gemspec :path => "../"

data/gemfiles/clockwork_master.gemfile.lock

@@ -0,0 +1,75 @@
+GIT
+  remote: https://github.com/Rykian/clockwork
+  revision: 11f80a0f206d17060b07a55bffec23e935279d1c
+  specs:
+    clockwork (2.0.2)
+      tzinfo
+
+PATH
+  remote: ..
+  specs:
+    clockwork-test (0.3.0)
+      clockwork
+      timecop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
+    minitest (5.10.3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    timecop (0.9.1)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  appraisal
+  bundler (~> 1.7)
+  clockwork!
+  clockwork-test!
+  pry
+  rake (~> 10.0)
+  rspec
+  rspec-its
+
+BUNDLED WITH
+   1.16.2

data/lib/clockwork/test.rb

@@ -50,12 +50,12 @@ module Clockwork
           tick_speed: opts[:tick_speed]
         }
 
-        # TODO parse file rather than loading it
-        # and overloading Clockwork::Methods::every 
-        # and Clockwork::Methods::configure
-        load file
-
-        manager.run(run_opts)
+        manager.run(run_opts) do
+          # TODO parse file rather than loading it
+          # and overloading Clockwork::Methods::every
+          # and Clockwork::Methods::configure
+          load file
+        end
       end
 
       def clear!

data/lib/clockwork/test/manager.rb

@@ -1,30 +1,27 @@
 module Clockwork
   module Test
     class Manager < Clockwork::Manager
-      attr_reader :total_ticks, :max_ticks, :end_time
+      attr_reader :total_ticks, :max_ticks, :end_time, :start_time
 
       def initialize(opts = {})
         super()
         @history = JobHistory.new
-
         @total_ticks = 0
-        @max_ticks = opts[:max_ticks]
-        @start_time = opts[:start_time]
-        @end_time = opts[:end_time]
+        set_opts(opts)
+
         config[:logger].level = Logger::ERROR
       end
 
       def run(opts = {})
-        @max_ticks = opts[:max_ticks] if opts[:max_ticks]
-        @start_time = opts[:start_time] if opts[:start_time]
-        @end_time = opts[:end_time] if opts[:end_time]
-        @tick_speed = opts[:tick_speed]
+        set_opts(opts)
 
-        if @start_time
+        if start_time
           @time_altered = true
-          Timecop.travel(@start_time)
+          Timecop.travel(start_time)
         end
 
+        yield if block_given?
+
         tick_loop
 
         Timecop.return if @time_altered
@@ -44,6 +41,19 @@ module Clockwork
 
       private
 
+      def set_opts(opts)
+        @max_ticks = opts[:max_ticks] if opts[:max_ticks]
+        @start_time = opts[:start_time] if opts[:start_time]
+        if opts[:end_time]
+          @end_time = opts[:end_time]
+        elsif @start_time
+          @end_time = Time.current
+        end
+        @tick_speed = opts[:tick_speed]
+
+        raise "End time can't precede start time." if @start_time && (@start_time > @end_time)
+      end
+
       attr_reader :history
 
       def tick_loop

data/lib/clockwork/test/version.rb

@@ -1,5 +1,5 @@
 module Clockwork
   module Test
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/spec/acceptance/clock_spec.rb

@@ -76,4 +76,20 @@ describe "Clockwork" do
       it { should_not have_run("Run at certain time") }
     end
   end
+
+  if Gem::Version.new("2.0.2") < Gem::Version.new(Gem.loaded_specs["clockwork"].version)
+    describe "Runs when skip_first_run is specified" do
+      subject(:clockwork) { Clockwork::Test }
+
+      before(:each) { Clockwork::Test.run(clock_opts) }
+      after(:each) { Clockwork::Test.clear! }
+
+      let(:start_time) { Time.new(2012, 9, 1, 17, 30, 0) }
+      let(:end_time) { start_time + 25.hours }
+
+      let(:clock_opts) { { file: clock_file, start_time: start_time, end_time: end_time, tick_speed: 12.hours } }
+
+      it { should have_run("Run but not at start").once }
+    end
+  end
 end

data/spec/clockwork/test/manager_spec.rb

@@ -8,6 +8,7 @@ describe Clockwork::Test::Manager do
   context "initial state" do
     its(:total_ticks) { should eq 0 }
     its(:max_ticks) { should be_nil }
+    its(:start_time) { should be_nil }
     its(:end_time) { should be_nil }
 
     context "providing a maximum number of ticks" do
@@ -23,6 +24,24 @@ describe Clockwork::Test::Manager do
 
       its(:end_time) { should eq end_time }
     end
+
+    context "start_time provided, while end_time is not" do
+      let(:opts) { { start_time: 5.minutes.ago } }
+
+      before { Timecop.freeze }
+      after { Timecop.return }
+
+      its(:start_time) { should eq opts[:start_time] }
+      its(:end_time) { should eq Time.current }
+    end
+
+    context "start_time happens after the end_time" do
+      let(:opts) { { start_time: 5.minutes.ago, end_time: 10.minutes.ago } }
+
+      it "raises with useful message" do
+        expect { manager }.to raise_error("End time can't precede start time.")
+      end
+    end
   end
 
   describe "#run" do

data/spec/fixtures/clock.rb

@@ -14,4 +14,8 @@ module Clockwork
   every(1.day, "Run at certain time", at: "17:30") do
     "Run at certain time"
   end
+
+  every(1.day, "Run but not at start", skip_first_run: true) do
+    "Run at certain time"
+  end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,9 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'clockwork/test'
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "clockwork/test"
 
-require 'pry'
-require 'rspec/its'
+require "active_support/time"
+require "pry"
+require "rspec/its"
 
 RSpec.configure do |config|
   config.include(Clockwork::Test::RSpec::Matchers)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: clockwork-test
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin Murphy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-14 00:00:00.000000000 Z
+date: 2018-06-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +137,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASE_PROCESS.md
 - Rakefile
 - clockwork-test.gemspec
 - gemfiles/clockwork_1_3_1.gemfile
@@ -133,6 +148,10 @@ files:
 - gemfiles/clockwork_2_0_1.gemfile.lock
 - gemfiles/clockwork_2_0_2.gemfile
 - gemfiles/clockwork_2_0_2.gemfile.lock
+- gemfiles/clockwork_2_0_3.gemfile
+- gemfiles/clockwork_2_0_3.gemfile.lock
+- gemfiles/clockwork_master.gemfile
+- gemfiles/clockwork_master.gemfile.lock
 - lib/clockwork/test.rb
 - lib/clockwork/test/event.rb
 - lib/clockwork/test/job_history.rb
@@ -166,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Test clockwork scheduled jobs