clockwork 2.0.4 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ad11e2b8e79db572d4240dd9ce2065067b22514919d4debc3758065b438ebca
-  data.tar.gz: 5dec51edf5bbd101a002e8c6ede3f11918441d75281b2baff3091bc0995721c4
+  metadata.gz: 92b0e84804fd39ef988e03c0f76cff4bf6e8af060cc395b150f24622c5a8a43d
+  data.tar.gz: 0d217fe414875b7124f3b0362e6e4fd8c3eff240d09d67bd88a0ae4dc695e934
 SHA512:
-  metadata.gz: f06770eaf4eb2b473ee165a00ddf7b6326f957ccfbf1eb71ee65a3e4a840ea8a42fe052a52a7032f7b786677bad54e94bc58a7f3961a44bb404c16685dcddc48
-  data.tar.gz: 5a60bddb9ae7b7312e8df9a4b01a022d9072a3a4f2fdb7f5790f03a61cf8b31a0d6fc4a76c3b80abeee63eeb269447922b2c065982497f2d6f7becd33082f78e
+  metadata.gz: 7c1b94426a6f419580db0f67ebdb88f20c17a758a055b242c1cc59c40664e4cea0c0f61bda47c06ea3327d95e507cd9bdde9a4d296f099b15bf6903115fcf840
+  data.tar.gz: ccb09e88187c401b435292d36fd4abe4ac82794dec361ff20cdac5e8e458f6225e429c6a1ee2c3d94724a6e3d4bc95f028806aae849662d277a2ff0669668c27

data/.github/workflows/tests.yml

@@ -0,0 +1,36 @@
+name: Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ "2.7", "3.0", "3.1", "3.2", jruby ]
+        active_support: [ "6.0", "7.0" ]
+        exclude:
+          - ruby: "3.0"
+            active_support: "6.0"
+          - ruby: "3.1"
+            active_support: "6.0"
+          - ruby: "3.2"
+            active_support: "6.0"
+    name: Ruby ${{ matrix.ruby }} - ActiveSupport ${{ matrix.active_support }}
+    env:
+      ACTIVE_SUPPORT_VERSION: ${{ matrix.active_support }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run Tests
+        env:
+          RUBYOPT: "-W:deprecated" # Show Ruby's deprecation warnings
+        run: |
+          bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 3.0.1 ##
+
+* Notify error using error handler if configured (49075c2)
+
+## 3.0.0 ##
+
+* BREAKING CHANGE: drop Rubinius support
+* add Ruby 3.0 support (65d71f)
+* fix a bug with OpenStruct (15eb030)
+* allow `:skip_first_run` in database events (429bc0a)
+* add rescue to prevent hung up by exception (cc1b7c9)
+* fix CI errors (16b4e19 & e4480ea)
+* fix a compatibility bug with Rails 7 (5907bc7)
+* Add "Finished" log with duration and error summary (66419ab)
+
 ## 2.0.4 ##
 
 *   Reverts the breaking changes in PR #18 that went out in patch 2.0.3

data/Gemfile

@@ -1,3 +1,8 @@
 source 'https://rubygems.org'
 
 gemspec
+
+rails_version = ENV.fetch("ACTIVE_SUPPORT_VERSION", "7.0")
+
+gem "activesupport", "~> #{rails_version}"
+gem "minitest", "~> 5.0"

data/README.md

@@ -1,4 +1,4 @@
-Clockwork - a clock process to replace cron [![Build Status](https://api.travis-ci.org/Rykian/clockwork.png?branch=master)](https://travis-ci.org/Rykian/clockwork)
+Clockwork - a clock process to replace cron [![Build Status](https://api.travis-ci.com/Rykian/clockwork.svg?branch=master)](https://travis-ci.org/Rykian/clockwork)
 ===========================================
 
 Cron is non-ideal for running scheduled application tasks, especially in an app
@@ -171,6 +171,8 @@ When one of the events is ready to be run (based on it's `frequency`, and possib
 
    - `tz` *(optional)* returning the timezone to use (default is the local timezone)
 
+   - `skip_first_run` *(optional)* self explanatory, see [dedicated section](#skip_first_run)
+
 #### Example Setup
 
 Here's an example of one way of setting up your ActiveRecord models:
@@ -502,7 +504,7 @@ end
 ```
 
 In addition, Clockwork also supports `:before_tick`, `:after_tick`, `:before_run`, and `:after_run` callbacks.
-All callbacks are optional. The `tick` callbacks run every tick (a tick being whatever your `:sleep_timeout`
+All callbacks are optional. All `before` callbacks must return a truthy value otherwise the job will not run. The `tick` callbacks run every tick (a tick being whatever your `:sleep_timeout`
 is set to, default is 1 second):
 
 ```ruby

data/clockwork.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "clockwork"
-  s.version = "2.0.4"
+  s.version = "3.0.1"
 
   s.authors = ["Adam Wiggins", "tomykaira"]
   s.license = 'MIT'

data/lib/clockwork/database_events/event_store.rb

@@ -119,6 +119,7 @@ module Clockwork
         options[:if] = ->(time){ model.if?(time) } if model.respond_to?(:if?)
         options[:tz] = model.tz if model.respond_to?(:tz)
         options[:ignored_attributes] = model.ignored_attributes if model.respond_to?(:ignored_attributes)
+        options[:skip_first_run] = model.skip_first_run if model.respond_to?(:skip_first_run)
 
         # store the state of the model at time of registering so we can
         # easily compare and determine if state has changed later

data/lib/clockwork/database_events/synchronizer.rb

@@ -1,5 +1,3 @@
-require_relative '../database_events'
-
 module Clockwork
 
   module DatabaseEvents

data/lib/clockwork/event.rb

@@ -55,10 +55,19 @@ module Clockwork
 
     private
     def execute
+      start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      error = nil
+
       @block.call(@job, @last)
     rescue => e
+      error = e
       @manager.log_error e
       @manager.handle_error e
+    ensure
+      finish = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      duration = ((finish - start) * 1000).round # milliseconds
+
+      @manager.log "Finished '#{self}' duration_ms=#{duration} error=#{error.inspect}"
     end
 
     def elapsed_ready?(t)

data/lib/clockwork/manager.rb

@@ -37,7 +37,7 @@ module Clockwork
 
     def error_handler(&block)
       @error_handler = block if block_given?
-      @error_handler
+      @error_handler if instance_variable_defined?("@error_handler")
     end
 
     def on(event, options={}, &block)
@@ -160,7 +160,15 @@ module Clockwork
 
     private
     def events_to_run(t)
-      @events.select{ |event| event.run_now?(t) }
+      @events.select do |event|
+        begin
+          event.run_now?(t)
+        rescue => e
+          log_error(e)
+          handle_error(e)
+          false
+        end
+      end
     end
 
     def register(period, job, block, options)

data/lib/clockwork.rb

@@ -1,4 +1,5 @@
 require 'logger'
+require 'active_support'
 require 'active_support/time'
 
 require 'clockwork/at'

data/test/at_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path('../../lib/clockwork', __FILE__)
 require "minitest/autorun"
-require 'mocha/setup'
+require 'mocha/minitest'
 require 'time'
 require 'active_support/time'
 

data/test/clockwork_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path('../../lib/clockwork', __FILE__)
 require 'minitest/autorun'
-require 'mocha/setup'
+require 'mocha/minitest'
 
 describe Clockwork do
   before do
@@ -27,6 +27,7 @@ describe Clockwork do
 
     assert run
     assert @log_output.string.include?('Triggering')
+    assert @log_output.string.include?('Finished')
   end
 
   it 'should log event correctly' do
@@ -39,6 +40,21 @@ describe Clockwork do
     Clockwork.run
     assert run
     assert @log_output.string.include?("Triggering 'an event'")
+    assert_match(/Finished 'an event' duration_ms=\d+ error=nil/, @log_output.string)
+  end
+
+  it 'should log exceptions' do
+    run = false
+    Clockwork.handler do |job|
+      run = job == 'an event'
+      raise 'boom'
+    end
+    Clockwork.every(1.minute, 'an event')
+    Clockwork.manager.stubs(:run_tick_loop).returns(Clockwork.manager.tick)
+    Clockwork.run
+    assert run
+    assert @log_output.string.include?("Triggering 'an event'")
+    assert_match(/Finished 'an event' duration_ms=\d+ error=#<RuntimeError: boom>/, @log_output.string)
   end
 
   it 'should pass event without modification to handler' do

data/test/database_events/event_store_test.rb

@@ -1,6 +1,7 @@
 require "minitest/autorun"
 require 'clockwork/database_events/event_store'
 require 'clockwork/database_events/event_collection'
+require 'ostruct'
 
 describe Clockwork::DatabaseEvents::EventStore do
 

data/test/database_events/support/active_record_fake.rb

@@ -28,8 +28,8 @@ module ActiveRecordFake
   end
 
   module ClassMethods
-    def create *args
-      new *args
+    def create(*args)
+      new(*args)
     end
     
     def delete_all

data/test/database_events/synchronizer_test.rb

@@ -1,5 +1,5 @@
 require "minitest/autorun"
-require 'mocha/setup'
+require 'mocha/minitest'
 require 'time'
 require 'active_support/time'
 

data/test/database_events/test_helpers.rb

@@ -36,19 +36,35 @@ end
 
 class DatabaseEventModel
   include ActiveRecordFake
-  attr_accessor :name, :frequency, :at, :tz
+  attr_accessor :frequency, :at, :tz
 
   def name
-    @name || "#{self.class}:#{id}"
+    if instance_variable_defined?("@name")
+      @name
+    else
+      "#{self.class}:#{id}"
+    end
+  end
+
+  def name=(name)
+    @name = name
   end
 end
 
 class DatabaseEventModel2
   include ActiveRecordFake
-  attr_accessor :name, :frequency, :at, :tz
+  attr_accessor :frequency, :at, :tz
 
   def name
-    @name || "#{self.class}:#{id}"
+    if instance_variable_defined?("@name")
+      @name
+    else
+      "#{self.class}:#{id}"
+    end
+  end
+
+  def name=(name)
+    @name = name
   end
 end
 
@@ -59,10 +75,18 @@ end
 
 class DatabaseEventModelWithIf
   include ActiveRecordFake
-  attr_accessor :name, :frequency, :at, :tz, :if_state
+  attr_accessor :frequency, :at, :tz, :if_state
 
   def name
-    @name || "#{self.class}:#{id}"
+    if instance_variable_defined?("@name")
+      @name
+    else
+      "#{self.class}:#{id}"
+    end
+  end
+
+  def name=(name)
+    @name = name
   end
 
   def if?(time)

data/test/manager_test.rb

@@ -1,6 +1,6 @@
 require File.expand_path('../../lib/clockwork', __FILE__)
 require "minitest/autorun"
-require 'mocha/setup'
+require 'mocha/minitest'
 require 'time'
 require 'active_support/time'
 

data/test/signal_test.rb

@@ -1,5 +1,5 @@
 require 'test/unit'
-require 'mocha/setup'
+require 'mocha/minitest'
 require 'fileutils'
 
 class SignalTest < Test::Unit::TestCase

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: clockwork
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 3.0.1
 platform: ruby
 authors:
 - Adam Wiggins
 - tomykaira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 2022-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -121,8 +121,8 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -133,8 +133,6 @@ files:
 - clockwork.gemspec
 - clockworkd.1
 - example.rb
-- gemfiles/activesupport4.gemfile
-- gemfiles/activesupport5.gemfile
 - lib/clockwork.rb
 - lib/clockwork/at.rb
 - lib/clockwork/database_events.rb
@@ -159,7 +157,7 @@ homepage: http://github.com/Rykian/clockwork
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -174,9 +172,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A scheduler process to replace cron.
 test_files:

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-before_install:
-  - gem update --system
-  # This is required to support ActiveSupport 4
-  # https://docs.travis-ci.com/user/languages/ruby/#bundler-20
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem install bundler -v '< 2'
-rvm:
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - jruby-9.1.17.0
-  - jruby-9.2.6.0
-gemfile:
-  - gemfiles/activesupport4.gemfile
-  - gemfiles/activesupport5.gemfile

data/gemfiles/activesupport4.gemfile

@@ -1,11 +0,0 @@
-source 'https://rubygems.org'
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'rubysl-test-unit'
-  gem 'rubinius-developer_tools'
-end
-
-gem 'activesupport', '~> 4.2'
-gem 'minitest', '~> 5.0'
-gemspec :path=>"../"

data/gemfiles/activesupport5.gemfile

@@ -1,11 +0,0 @@
-source 'https://rubygems.org'
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'rubysl-test-unit'
-  gem 'rubinius-developer_tools'
-end
-
-gem 'activesupport', '~> 5.0'
-gem 'minitest', '~> 5.0'
-gemspec :path=>"../"