cron_swanson 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5b92fde06c654c2a37b0162a87e0d1701db2d24f28ae707bbfa174d168d73aa
-  data.tar.gz: 33d169cfefdb9e1ab75aca3b93f2aedfc2f6c0d6634df1f9a536115b5a964bc9
+  metadata.gz: d117286d60628186a24607e387fb3b51eb4b915d8e75a96d92ebfce8ea51a9ed
+  data.tar.gz: 7d8fb576c1aead5cbe16c2ccd81f1acda7f96149fb725bd780359a4ba8d2360c
 SHA512:
-  metadata.gz: abd309004421dc9cf12886a4e9df6a58717ab51dc74c2cee0ab4fbdbbb4cb4248b462d4d684f6113a0103a8999559eac2cb51580467c6c5ed18b9ac14d73a1b6
-  data.tar.gz: af381bd1b0054755f8a08248962f546db9ce82ea0706657ace6f47fc5c9aa0425266de8295ee39bfe523bfc2b78e3d3243aa94c1eb8a49edd40ac355f7296557
+  metadata.gz: 99a782ff24a871fe8f5ea77f5a4e26c06b0af27519f03873dd62d4e2a5e9a2cd7da478230d3283fcb6b9af28ae03b69d7c3ea64f650683bba7d5f6786017abed
+  data.tar.gz: e054da7a55fd73c7a0f8c00e4912f13572467840984b45cb7a1d3041a4c13efdbc9ab965fd13748f26a16eea94afcdad86dba227cf1e2c487d52b97dacd199c8

data/.rspec

@@ -1 +1 @@
---require spec_helper
+--require spec_helper --format d

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+script:
+  - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.2.0 : "Under my utelage, you will grow from boys to men." : November 3, 2019
+
+Improvements in whenever integration.
+
+  * Jobs are scheduled based on their contents, not their source location.
+  * Added support for `roles`.
+
+## 0.1.0 : "I'm not interested in caring about people." : November 1, 2019
+
+Initial release

data/README.md

@@ -1,8 +1,18 @@
 # CronSwanson
 
-CronSwanson can help if you have many systems running the same cron job, but you
-don't want them all to start at exactly the same time. (To prevent daily load
-spikes at midnight, as every single app starts its maintenance cron jobs.)
+`CronSwanson` helps schedule cron jobs.
+
+![Never half-ass two things.](whole-ass.jpg)
+
+If you've ever had load spikes when many applications all starting the same
+cron job at the same time, `CronSwanson` can help you.
+
+The library generates crontab schedule strings which are consistent (they aren't
+random) but which are fuzzed/shifted depending on some input.
+
+## Build Status
+
+[![Build Status](https://travis-ci.org/alexdean/cron_swanson.svg?branch=master)](https://travis-ci.org/alexdean/cron_swanson)
 
 ## Installation
 
@@ -32,6 +42,17 @@ CronSwanson.schedule 'whiskey'
 #=> "33 18 * * *"
 ```
 
+**To keep two applications running the same job from executing at once**, make the
+application name part of the schedule key.
+
+```ruby
+CronSwanson.schedule 'application-a whiskey'
+#=> "4 19 * * *"
+
+CronSwanson.schedule 'application-b whiskey'
+#=> "11 7 * * *"
+```
+
 An `interval` (in seconds) can be supplied if you want a job to be run more than
 once/day. This `interval` must be a factor of 24 hours.
 
@@ -40,14 +61,27 @@ CronSwanson.schedule 'bacon', interval: 60 * 60 * 4
 #=> "26 2,6,10,14,18,22 * * *"
 ```
 
+You can also use `ActiveSupport::Duration` instances.
+
+```ruby
+CronSwanson.schedule 'bacon', interval: 4.hours
+#=> "26 2,6,10,14,18,22 * * *"
+```
+
 ### Whenever Integration
 
 `CronSwanson` is built to integrate with the fantastic [whenever](https://github.com/javan/whenever) gem.
 
+`CronSwanson::Whenever.add` will calculate a run time for jobs by hashing the text
+of the job definitions in the given block.
+
+**NOTE**: This means that if you change the jobs in the block, you will also change the schedule time
+for these jobs.
+
 #### Daily
 
 ```ruby
-# in the config/schedule.rb file
+# in config/schedule.rb
 CronSwanson::Whenever.add(self) do
   rake 'sample:job'
 end
@@ -59,7 +93,7 @@ determined by `CronSwanson`.
 #### Multiple times/day
 
 ```ruby
-# in the config/schedule.rb file
+# in config/schedule.rb
 
 # with ActiveSupport
 CronSwanson::Whenever.add(self, interval: 4.hours) do
@@ -74,7 +108,7 @@ end
 
 #### job types
 
-The block is evaluated by `whenever`, so any custom job types will work.
+Any custom job types which have been defined will work.
 
 ```ruby
 # in config/schedule.rb
@@ -85,15 +119,21 @@ CronSwanson::Whenever.add(self) do
 end
 ```
 
-#### Limitation
+#### roles
 
-The whenever integration code currently derives a scheduled time from the source
-location of the `add` call. This means that moving the `.add` invocation to
-a different line in schedule.rb will cause it to be run at a different time.
+Roles are supported. See the [whenever documentation](https://github.com/javan/whenever#capistrano-roles)
+for more information on this.
 
-This limitation exists because I (currently) don't know of a way to inspect
-the contents of a block at runtime. If a way to do this can be found, I
-would prefer to calculate the time based on the block's contents.
+```ruby
+CronSwanson::Whenever.add(self) do
+  rake 'will_run_on_all_roles'
+end
+
+# will only be added to servers with the :restricted role
+CronSwanson::Whenever.add(self, roles: [:restricted]) do
+  rake 'restricted_only'
+end
+```
 
 ## Development
 

data/Rakefile

@@ -1,2 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(:spec)
+
 task default: :spec

data/lib/cron_swanson.rb

@@ -15,7 +15,7 @@ module CronSwanson
   # offset within a time period
   #
   # if the interval is 6 hours, the returned offset will be some number of seconds
-  # from 0 to 6 hours.
+  # between 0 and 60 * 60 * 6 seconds (6 hours).
   #
   # @param [String] job_identifier
   #   if nil, method will determine this on its own
@@ -27,7 +27,7 @@ module CronSwanson
     # largest possible hex sha256 value
     max_sha256_value = (16**64).to_f
 
-    # what % of the max sha256 is the current app?
+    # what % of the max sha256 is the job_identifier?
     sha_pct_of_max_sha256 = sha.to_i(16) / max_sha256_value
 
     # apply that same % to the desired interval to get an offset
@@ -49,8 +49,6 @@ module CronSwanson
     # figure out how many times job will happen in a day
     runs_per_day = SECONDS_PER_DAY / interval
 
-    # raise if runs_per_day has a decimal component.
-
     run_at = Time.at(offset(job_identifier, interval: interval)).utc
 
     hours = []

data/lib/cron_swanson/version.rb

@@ -1,3 +1,3 @@
 module CronSwanson
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/cron_swanson/whenever.rb

@@ -1,6 +1,6 @@
 module CronSwanson
   # integration for the whenever gem: https://github.com/javan/whenever
-  module Whenever
+  class Whenever
     # CronSwanson integration for whenever
     #
     # The given block can use any job types understood by your whenever configuration.
@@ -15,13 +15,13 @@ module CronSwanson
     # would prefer to calculate the time based on the block's contents.
     #
     # @example run a job once/day
-    #   # in the config/schedule.rb file
+    #   # in config/schedule.rb
     #   CronSwanson::Whenever.add(self) do
     #     rake 'job'
     #   end
     #
-    # @example run a job four times daily
-    #   # in the config/schedule.rb file
+    # @example schedule a job to four times daily
+    #   # in config/schedule.rb
     #
     #   # with ActiveSupport
     #   CronSwanson::Whenever.add(self, interval: 4.hours) do
@@ -33,19 +33,61 @@ module CronSwanson
     #     rake 'job'
     #   end
     #
+    # @example run a job only on servers with a given role
+    #   # in config/schedule.rb
+    #   CronSwanson::Whenever.add(self, roles: [:app]) do
+    #     rake 'job'
+    #   end
+    #
     # @param [Whenever::JobList] whenever_job_list For code in `config/schedule.rb`
     #   this can be referred to as `self`.
-    # @param [Integer] interval how many seconds do you want between runs of this job
-    def self.add(whenever_job_list, interval: CronSwanson.default_interval, &block)
+    # @param [Integer, ActiveSupport::Duration] interval how many seconds do you want between runs
+    #   of this job
+    # @param [Array<Symbol>] roles capistrano roles that jobs in this block should be deployed to
+    def self.add(whenever_job_list, interval: CronSwanson.default_interval, roles: [], &block)
+      @whenever_jobs = []
+      @whenever_job_list = whenever_job_list
+
       if !whenever_job_list.is_a?(::Whenever::JobList)
         raise ArgumentError, "supply a Whenever::JobList. (In schedule.rb code, use `self`.)"
       end
 
       raise ArgumentError, "provide a block containing jobs to schedule." if !block_given?
 
-      # TODO: ideally we'd hash the contents of the block, not the location it was defined at
-      schedule = CronSwanson.schedule(block.source_location, interval: interval)
-      whenever_job_list.every(schedule, &Proc.new)
+      # execute the block in the context of CronSwanson::Whenever (rather than in the context
+      # of the Whenever::JobList where it will be invoked) so that we can intercept
+      # calls to `rake` and similar (via method_missing below).
+      instance_eval(&block)
+
+      # make a schedule based on the contents of the jobs which were defined in the block
+      schedule_seed = @whenever_jobs.map do |job_config|
+        m, args, _block = *job_config
+        "#{m} #{args.join}"
+      end
+      schedule = CronSwanson.schedule(schedule_seed, interval: interval)
+
+      # now that we know when to schedule the jobs, actually pass the block to Whenever
+      if roles.size > 0
+        whenever_job_list.every(schedule, roles: roles, &Proc.new)
+      else
+        whenever_job_list.every(schedule, &Proc.new)
+      end
+
+      @whenever_job_list = nil
+    end
+
+    # during .add, we accumulate calls to whenever job types
+    # this allows us to make a schedule hash from the actual jobs which are defined.
+    def self.method_missing(m, *args, &block)
+      if @whenever_job_list.nil? || @whenever_jobs.nil?
+        raise "#{self.name}.method_missing invoked outside of #{self.name}.add"
+      end
+
+      if @whenever_job_list.respond_to?(m)
+        @whenever_jobs << [m, args, block]
+      else
+        raise "#{m} is not defined. Call `job_type` to resolve this."
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cron_swanson
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Dean
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-01 00:00:00.000000000 Z
+date: 2019-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,6 +49,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - README.md
@@ -62,6 +64,7 @@ files:
 - lib/cron_swanson.rb
 - lib/cron_swanson/version.rb
 - lib/cron_swanson/whenever.rb
+- whole-ass.jpg
 homepage: https://github.com/alexdean/cron_swanson
 licenses: []
 metadata: {}