clockwork 2.0.2 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 28995c167b599267520fc42d5c489da9cf3ea3a7
-  data.tar.gz: c185ef12635ae8fcaaf300edb133adf86e3d9ac6
+SHA256:
+  metadata.gz: 7ad11e2b8e79db572d4240dd9ce2065067b22514919d4debc3758065b438ebca
+  data.tar.gz: 5dec51edf5bbd101a002e8c6ede3f11918441d75281b2baff3091bc0995721c4
 SHA512:
-  metadata.gz: 6311c6f7d6dd160c2b5beb6cad59c87c571d7ec50e54bb50e3c8cbb656ae2fb756168a404d143ed699772c334ab2323681202509cbb9d740f954ce23bca61725
-  data.tar.gz: c4c3b8f20fdc6da06dc73ea4f0de9ab798dfb2e8e7716777952c51bbf9a3c88fb6df5841e979ac180dbb1d4f326f3bdc78ecd7bf5e13a487fce250f3a79809ec
+  metadata.gz: f06770eaf4eb2b473ee165a00ddf7b6326f957ccfbf1eb71ee65a3e4a840ea8a42fe052a52a7032f7b786677bad54e94bc58a7f3961a44bb404c16685dcddc48
+  data.tar.gz: 5a60bddb9ae7b7312e8df9a4b01a022d9072a3a4f2fdb7f5790f03a61cf8b31a0d6fc4a76c3b80abeee63eeb269447922b2c065982497f2d6f7becd33082f78e

data/.travis.yml

@@ -1,14 +1,18 @@
 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:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
-  - ruby-2.3.1
-  - jruby-19mode
-  - # rbx-2.2.7
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - jruby-9.1.17.0
+  - jruby-9.2.6.0
 gemfile:
-  - gemfiles/activesupport3.gemfile
   - gemfiles/activesupport4.gemfile
+  - gemfiles/activesupport5.gemfile

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 2.0.4 ##
+
+*   Reverts the breaking changes in PR #18 that went out in patch 2.0.3
+
+    *Javier Julio*
+
+## 2.0.3 (February 15, 2018) ##
+
+*   [See the version release](https://github.com/Rykian/clockwork/releases) for the commits that were included.

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) [![Dependency Status](https://gemnasium.com/Rykian/clockwork.png)](https://gemnasium.com/Rykian/clockwork)
+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)
 ===========================================
 
 Cron is non-ideal for running scheduled application tasks, especially in an app
@@ -18,6 +18,8 @@ Create clock.rb:
 
 ```ruby
 require 'clockwork'
+require 'active_support/time' # Allow numeric durations (eg: 1.minutes)
+
 module Clockwork
   handler do |job|
     puts "Running #{job}"
@@ -58,8 +60,8 @@ Quickstart for Heroku
 
 Clockwork fits well with heroku's cedar stack.
 
-Consider to use [clockwork-init.sh](https://gist.github.com/1312172) to create
-a new project for heroku.
+Consider using [clockwork-init.sh](https://gist.github.com/tomykaira/1312172) to create
+a new project for Heroku.
 
 Use with queueing
 -----------------
@@ -80,6 +82,7 @@ For example, if you're using Beanstalk/Stalker:
 
 ```ruby
 require 'stalker'
+require 'active_support/time'
 
 module Clockwork
   handler { |job| Stalker.enqueue(job) }
@@ -142,31 +145,31 @@ module Clockwork
 end
 ```
 
-This tells clockwork to fetch all `ClockworkDatabaseEvent` instances from the database, and create an internal clockwork event for each one. Each clockwork event will be configured based on the instance's `frequency` and, optionally, its `at`, `name`, `if?` and `tz` methods. The code above also says to reload the events from the database every `1.minute`; we need pick up any changes in the database frequently (choose a sensible reload frequency by changing the `every:` option).
+This tells clockwork to fetch all `ClockworkDatabaseEvent` instances from the database, and create an internal clockwork event for each one. Each clockwork event will be configured based on the instance's `frequency` and, optionally, its `at`, `if?`, `ignored_attributes`, `name`, and, `tz` methods. The code above also says to reload the events from the database every `1.minute`; we need pick up any changes in the database frequently (choose a sensible reload frequency by changing the `every:` option).
 
-When one of the events is ready to be run (based on it's `frequency`, and possible `at`, `if?` and `tz` methods), clockwork arranges for the block passed to `sync_database_events` to be run. The above example shows how you could use either DelayedJob or Sidekiq to kick off a worker job. This approach is good because the ideal is to use clockwork as a simple scheduler, and avoid making it carry out any long-running tasks.
+When one of the events is ready to be run (based on it's `frequency`, and possible `at`, `if?`, `ignored attributes`, and `tz` methods), clockwork arranges for the block passed to `sync_database_events` to be run. The above example shows how you could use either DelayedJob or Sidekiq to kick off a worker job. This approach is good because the ideal is to use clockwork as a simple scheduler, and avoid making it carry out any long-running tasks.
 
 ### Your Model Classes
 
 `ActiveRecord` models are a perfect candidate for the model class. Having said that, the only requirements are:
 
-  1. the class responds to `all` returning an array of instances from the database
-
-  2. the instances returned respond to:
+1. the class responds to `all` returning an array of instances from the database
 
-    - `id` returning a unique identifier (this is needed to track changes to event settings)
+2. the instances returned respond to:
+   - `id` returning a unique identifier (this is needed to track changes to event settings)
+   - `frequency` returning the how frequently (in seconds) the database event should be run
 
-    - `frequency` returning the how frequently (in seconds) the database event should be run
+   - `attributes` returning a hash of [attribute name] => [attribute value] values (or really anything that we can use store on registering the event, and then compare again to see if the state has changed later)
 
-    - `attributes` returning a hash of [attribute name] => [attribute value] values (or really anything that we can use store on registering the event, and then compare again to see if the state has changed later)
+   - `at` *(optional)* return any acceptable clockwork `:at` string
 
-    - (optionally) `at` return any acceptable clockwork `:at` string
+   - `name` *(optional)* returning the name for the event (used to identify it in the Clockwork output)
 
-    - (optionally) `name` returning the name for the event (used to identify it in the Clockwork output)
+   - `if?`*(optional)*  returning either true or false, depending on whether the database event should run at the given time (this method will be passed the time as a parameter, much like the standard clockwork `:if`)
 
-    - (optionally) `if?` returning either true or false, depending on whether the database event should run at the given time (this method will be passed the time as a parameter, much like the standard clockwork `:if`)
+   - `ignored_attributes` *(optional)* returning an array of model attributes (as symbols) to ignore when determining whether the database event has been modified since our last run
 
-    - (optionally) `tz` returning the timezone to use (default is the local timezone)
+   - `tz` *(optional)* returning the timezone to use (default is the local timezone)
 
 #### Example Setup
 
@@ -245,6 +248,28 @@ class ClockworkDatabaseEvent < ActiveRecord::Base
 end
 ```
 
+#### Example use of `ignored_attributes`
+
+Clockwork compares all attributes of the model between runs to determine if the model has changed, and if it has, it runs the event if all other conditions are met.
+
+However, in certain cases, you may want to store additional attributes in your model that you don't want to affect whether a database event is executed prior to its next interval.
+
+So for example, you may update an attribute of your model named `last_scheduled_at` on each run to track the last time it was successfully scheduled. You can tell Clockwork to ignore that attribute in its comparison as follows:
+
+```ruby
+# app/models/clockwork_database_event.rb
+class ClockworkDatabaseEvent < ActiveRecord::Base
+
+  ...
+
+  def ignored_attributes
+    [ :last_scheduled_at ]
+  end
+
+  ...
+end
+```
+
 
 Event Parameters
 ----------
@@ -305,7 +330,8 @@ If this is a problem, please use the `:thread` option to prevent the long runnin
 ```ruby
 every(1.day, 'reminders.send', :at => '00:00', :tz => 'UTC')
 # Runs the job each day at midnight, UTC.
-# The value for :tz can be anything supported by [TZInfo](http://tzinfo.rubyforge.org/)
+# The value for :tz can be anything supported by [TZInfo](https://github.com/tzinfo/tzinfo)
+# Using the 'tzinfo' gem, run TZInfo::Timezone.all_identifiers to get a list of acceptable identifiers.
 ```
 
 ### :if
@@ -341,6 +367,19 @@ Clockwork.every(1.day, 'run.me.in.new.thread', :thread => true)
 
 If a job is long-running or IO-intensive, this option helps keep the clock precise.
 
+### :skip_first_run
+
+Normally, a clockwork process that is defined to run in a specified period will run at startup.
+This is sometimes undesired behaviour, if the action being run relies on other processes booting which may be slower than clock.
+To avoid this problem, `:skip_first_run` can be used.
+
+```ruby
+Clockwork.every(5.minutes, 'myjob', :skip_first_run => true)
+```
+
+The above job will not run at initial boot, and instead run every 5 minutes after boot.
+
+
 Configuration
 -----------------------
 
@@ -357,7 +396,6 @@ Clockwork wakes up once a second and performs its duties. To change the number o
 sleeps, set the `sleep_timeout` configuration option as shown below in the example.
 
 From 1.1.0, Clockwork does not accept `sleep_timeout` less than 1 seconds.
-This restriction is introduced to solve more severe bug [#135](https://github.com/tomykaira/clockwork/pull/135).
 
 ### :tz
 
@@ -524,10 +562,17 @@ clockworkd -c YOUR_CLOCK.rb start
 
 For more details, you can run `clockworkd -h`.
 
+Integration Testing
+-------------------
+
+You could take a look at:
+* [clockwork-mocks](https://github.com/dpoetzsch/clockwork-mocks) that helps with running scheduled tasks during integration testing.
+* [clockwork-test](https://github.com/kevin-j-m/clockwork-test) which ensures that tasks are triggered at the right time
+
 Issues and Pull requests
 ------------------------
 
-If you find a bug, please create an issue - [Issues · tomykaira/clockwork](https://github.com/tomykaira/clockwork/issues).
+If you find a bug, please create an issue - [Issues · Rykian/clockwork](https://github.com/Rykian/clockwork/issues).
 
 For a bug fix or a feature request, please send a pull-request.
 Do not forget to add tests to show how your feature works, or what bug is fixed.
@@ -543,8 +588,8 @@ Use cases
 
 Feel free to add your idea or experience and send a pull-request.
 
-- [Sending errors to Airbrake](https://github.com/tomykaira/clockwork/issues/58)
-- [Read events from a database](https://github.com/tomykaira/clockwork/issues/25)
+- Sending errors to Airbrake
+- Read events from a database
 
 Meta
 ----
@@ -559,4 +604,4 @@ Patches contributed by Mark McGranaghan and Lukáš Konarovský
 
 Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
 
-http://github.com/tomykaira/clockwork
+https://github.com/Rykian/clockwork

data/bin/clockwork

@@ -4,7 +4,7 @@ STDERR.sync = STDOUT.sync = true
 
 require 'clockwork'
 
-usage = 'clockwork <clock.rb>'
+usage = 'Usage: clockwork <clock.rb>'
 file = ARGV.shift or abort usage
 
 file = "./#{file}" unless file.match(/^[\/.]/)

data/bin/clockworkd

@@ -4,6 +4,7 @@ STDERR.sync = STDOUT.sync = true
 
 require 'clockwork'
 require 'optparse'
+require 'pathname'
 
 begin
   require 'daemons'
@@ -45,7 +46,7 @@ opts = OptionParser.new do |opts|
   end
   opts.on('-c', '--clock=FILE',"Clock .rb file. Default is #{@options[:file]}.") do |clock_file|
     @options[:file] = clock_file
-    @options[:file] = "./#{@options[:file]}" unless @options[:file].match(/^[\/.]/)
+    @options[:file] = "./#{@options[:file]}" unless Pathname.new(@options[:file]).absolute?
     @options[:file] = File.expand_path(@options[:file])
   end
   opts.on('-d', '--dir=DIR', 'Directory to change to once the process starts') do |dir|

data/clockwork.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "clockwork"
-  s.version = "2.0.2"
+  s.version = "2.0.4"
 
   s.authors = ["Adam Wiggins", "tomykaira"]
   s.license = 'MIT'
@@ -20,7 +20,6 @@ Gem::Specification.new do |s|
   s.add_dependency(%q<tzinfo>)
   s.add_dependency(%q<activesupport>)
 
-  s.add_development_dependency "bundler", "~> 1.3"
   s.add_development_dependency "rake"
   s.add_development_dependency "daemons"
   s.add_development_dependency "minitest", "~> 5.8"

data/gemfiles/activesupport4.gemfile

@@ -6,6 +6,6 @@ platforms :rbx do
   gem 'rubinius-developer_tools'
 end
 
-gem 'activesupport', '~> 4.0.0'
-gem 'minitest', '~> 4.2'
+gem 'activesupport', '~> 4.2'
+gem 'minitest', '~> 5.0'
 gemspec :path=>"../"

data/gemfiles/{activesupport3.gemfile → activesupport5.gemfile}

@@ -6,5 +6,6 @@ platforms :rbx do
   gem 'rubinius-developer_tools'
 end
 
-gem 'activesupport', '~> 3.2.14'
+gem 'activesupport', '~> 5.0'
+gem 'minitest', '~> 5.0'
 gemspec :path=>"../"

data/lib/clockwork/database_events/event_collection.rb

@@ -14,7 +14,14 @@ module Clockwork
       def has_changed?(model)
         return true if event.nil?
 
-        event.model_attributes != model.attributes
+        ignored_attributes = model.ignored_attributes if model.respond_to?(:ignored_attributes)
+        ignored_attributes ||= []
+
+        model_attributes = model.attributes.select do |k, _|
+          not ignored_attributes.include?(k.to_sym)
+        end
+
+        event.model_attributes != model_attributes
       end
 
       def unregister

data/lib/clockwork/database_events/event_store.rb

@@ -112,15 +112,19 @@ module Clockwork
         options = {
           :from_database => true,
           :synchronizer => self,
+          :ignored_attributes => [],
         }
 
         options[:at] = at_strings_for(model) if model.respond_to?(:at)
         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)
 
         # store the state of the model at time of registering so we can
         # easily compare and determine if state has changed later
-        options[:model_attributes] = model.attributes
+        options[:model_attributes] = model.attributes.select do |k, v|
+          not options[:ignored_attributes].include?(k.to_sym)
+        end
 
         options
       end

data/lib/clockwork/event.rb

@@ -8,11 +8,12 @@ module Clockwork
       @period = period
       @job = job
       @at = At.parse(options[:at])
-      @last = nil
       @block = block
       @if = options[:if]
       @thread = options.fetch(:thread, @manager.config[:thread])
       @timezone = options.fetch(:tz, @manager.config[:tz])
+      @skip_first_run = options[:skip_first_run]
+      @last = @skip_first_run ? convert_timezone(Time.now) : nil
     end
 
     def convert_timezone(t)
@@ -21,7 +22,10 @@ module Clockwork
 
     def run_now?(t)
       t = convert_timezone(t)
-      elapsed_ready(t) and (@at.nil? or @at.ready?(t)) and (@if.nil? or @if.call(t))
+      return false unless elapsed_ready?(t)
+      return false unless run_at?(t)
+      return false unless run_if?(t)
+      true
     end
 
     def thread?
@@ -57,10 +61,18 @@ module Clockwork
       @manager.handle_error e
     end
 
-    def elapsed_ready(t)
+    def elapsed_ready?(t)
       @last.nil? || (t - @last.to_i).to_i >= @period
     end
 
+    def run_at?(t)
+      @at.nil? || @at.ready?(t)
+    end
+
+    def run_if?(t)
+      @if.nil? || @if.call(t)
+    end
+
     def validate_if_option(if_option)
       if if_option && !if_option.respond_to?(:call)
         raise ArgumentError.new(':if expects a callable object, but #{if_option} does not respond to call')

data/test/event_test.rb

@@ -34,4 +34,41 @@ describe Clockwork::Event do
       end
     end
   end
+
+  describe '#run_now?' do
+    before do
+      @manager = Class.new
+      @manager.stubs(:config).returns({})
+    end
+
+    describe 'event skip_first_run option set to true' do
+      it 'returns false on first attempt' do
+        event = Clockwork::Event.new(@manager, 1, nil, nil, :skip_first_run => true)
+        assert_equal false, event.run_now?(Time.now)
+      end
+
+      it 'returns true on subsequent attempts' do
+        event = Clockwork::Event.new(@manager, 1, nil, nil, :skip_first_run => true)
+        # first run
+        event.run_now?(Time.now)
+
+        # second run
+        assert_equal true, event.run_now?(Time.now + 1)
+      end
+    end
+
+    describe 'event skip_first_run option not set' do
+      it 'returns true on first attempt' do
+        event = Clockwork::Event.new(@manager, 1, nil, nil)
+        assert_equal true, event.run_now?(Time.now + 1)
+      end
+    end
+
+    describe 'event skip_first_run option set to false' do
+      it 'returns true on first attempt' do
+        event = Clockwork::Event.new(@manager, 1, nil, nil, :skip_first_run => false)
+        assert_equal true, event.run_now?(Time.now)
+      end
+    end
+  end
 end

data/test/samples/signal_test.rb

@@ -1,4 +1,5 @@
 require 'clockwork'
+require 'active_support/time'
 
 module Clockwork
   LOGFILE = File.expand_path('../../tmp/signal_test.log', __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clockwork
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.4
 platform: ruby
 authors:
 - Adam Wiggins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-18 00:00:00.000000000 Z
+date: 2019-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -39,20 +39,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +123,7 @@ extra_rdoc_files:
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -146,8 +133,8 @@ files:
 - clockwork.gemspec
 - clockworkd.1
 - example.rb
-- gemfiles/activesupport3.gemfile
 - gemfiles/activesupport4.gemfile
+- gemfiles/activesupport5.gemfile
 - lib/clockwork.rb
 - lib/clockwork/at.rb
 - lib/clockwork/database_events.rb
@@ -188,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A scheduler process to replace cron.