zhong 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 902b025d6f1afe4edfa0f2cb6f6639bc0ff558ff
-  data.tar.gz: 939fedf9667d0dc26f7fb1adcddedd5cbe76deba
+SHA256:
+  metadata.gz: 577d8f17b30c591def82d4f69b184e233ba9a3b66d690616880c6e311dd85e4c
+  data.tar.gz: a838490cfa7cf4b3dbd451009cd0278d9a7ab391934e6e39a8d897af4a81926a
 SHA512:
-  metadata.gz: 16ce76fbea779cffa736f3c48f99bca3fa0ac0ba27e46261f20c41c037143317cb406715e8e866da4495dcf33a20a11830a37b6bd1b41ac9d64c39568c7e1896
-  data.tar.gz: 85abd697abfe5fa1ffd7513ae8e146f34c3360234f2685f9f89aec5224b259d086e25097614836ba90ebe8bc2347b8ea324051d87ea5e6813acc845267de96bf
+  metadata.gz: 30259b64b127a57c3ae44cfe5ad5a8339c7009512eeb26d08e69b417bf0c6d682de87d73f20ac23efc9fd2e2863aa9a62f2ca6c6b07eee89e77228c017f49007
+  data.tar.gz: 36e88630340b371f38c511d9b716456b7a2112c5c4555c197ec18d3c176cad22f52be34c43262c06cf670d2bddafcbfe9c2c60124780075987228c548df11d3e

data/.github/workflows/CI.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - ruby-head
+    continue-on-error: ${{ matrix.ruby == 'ruby-head' }}
+    services:
+      redis:
+        image: redis
+        ports:
+          - 6379:6379
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: |
+          bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 0.3.0
+
+- Update version requirements, and switch to Github actions (thank you @mlarraz!)
+
+## 0.2.4
+
+- Compatibility with Sinatra/Tilt (thank you Brian Storti!)
+
+## 0.2.3
+
+- Much improved documentation, and executable file naming (thank you Antoine Augusti!)
+- Fixes to the time parsing & to_s (thank you Antoine Augusti!)
+
+## 0.2.2
+
+- Re-licensed as LGPL, as I lifted Sidekiq-web code to power Zhong web (thanks Mike Perham for the great gem and the code!)
+
+## 0.2.1
+
+- Fix manually specifying a Redis connection (thanks, Richard Adams!)
+
 ## 0.2.0
 
 - Configuring Redis and the heartbeat key now correctly updates even after Zhong is configured initially.

data/LICENSE.txt

@@ -1,22 +1,5 @@
-Copyright (c) 2015 Nick Elser
+Copyright (c) Nick Elser
 
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Zhong is an Open Source project licensed under the terms of
+the LGPLv3 license. Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+for license text.

data/README.md

@@ -1,9 +1,10 @@
-# Zhong [![Build Status](https://travis-ci.org/nickelser/zhong.svg?branch=master)](https://travis-ci.org/nickelser/zhong) [![Code Climate](https://codeclimate.com/github/nickelser/zhong/badges/gpa.svg)](https://codeclimate.com/github/nickelser/zhong) [![Test Coverage](https://codeclimate.com/github/nickelser/zhong/badges/coverage.svg)](https://codeclimate.com/github/nickelser/zhong) [![Gem Version](https://badge.fury.io/rb/zhong.svg)](http://badge.fury.io/rb/zhong)
+# Zhong [![Build Status](https://github.com/nickelser/zhong/workflows/CI/badge.svg)](https://github.com/nickelser/zhong/actions?query=workflow%3ACI) [![Code Climate](https://codeclimate.com/github/nickelser/zhong/badges/gpa.svg)](https://codeclimate.com/github/nickelser/zhong) [![Gem Version](https://badge.fury.io/rb/zhong.svg)](http://badge.fury.io/rb/zhong)
 
 Useful, reliable distributed cron. Tired of your cron-like scheduler running key jobs twice? Would you like to be able to run your cron server on multiple machines and have it "just work"? Have we got the gem for you.
 
 Zhong uses Redis to acquire exclusive locks on jobs, as well as recording when they last ran. This means that you can rest easy at night, knowing that your customers are getting their monthly Goat Fancy magazine subscriptions and you are rolling around in your piles of money without a care in the world.
 
+:tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 # Installation
 
 Add this line to your application’s Gemfile:
@@ -14,6 +15,9 @@ gem 'zhong'
 
 ## Usage
 
+### Zhong schedule
+Create a definition file, let's call it `zhong.rb`:
+
 ```ruby
 Zhong.redis = Redis.new(url: ENV["ZHONG_REDIS_URL"])
 
@@ -23,9 +27,9 @@ Zhong.schedule do
       puts "foo"
     end
 
-    every(1.minute, "biz", at: ["**:26", "**:27"]) { puts "biz" }
-    every(1.week, "baz", at: ["mon 22:45", "wed 23:13"]) { puts "baz" }
-    every(10.seconds, "boom") { raise "fail" }
+    every(1.minute, "running biz at 26th and 27th minute", at: ["**:26", "**:27"]) { puts "biz" }
+    every(1.week, "running baz on mon and wed", at: ["mon 22:45", "wed 23:13"]) { puts "baz" }
+    every(10.seconds, "boom every 10 seconds") { raise "fail" }
   end
 
   category "clutter" do
@@ -75,18 +79,55 @@ Zhong.schedule do
 end
 ```
 
+This file only describes what should be the schedule. Nothing will be executed
+until we actually run
+```ruby
+Zhong.start
+```
+after describing the Zhong schedule.
+
+### Zhong cron process
+
+You can run the cron process that will execute your code from the definitions
+in the `zhong.rb` file by running:
+```sh
+zhong zhong.rb
+```
+
 ## Web UI
 
 Zhong comes with a web application that can display jobs, their last run and
 enable/disable them.
 
-### Rails
+This is a Sinatra application that requires at least `v2.0.0`. You can add to your Gemfile
+```ruby
+gem 'sinatra', "~>2.0"
+```
+
+It can be protected by HTTP basic authentication by
+setting the following environment variables:
+- `ZHONG_WEB_USERNAME`: the username
+- `ZHONG_WEB_PASSWORD`: the password
 
-Add the following to your config/routes.rb:
+You'll need to load the Zhong schedule to be able to see jobs in the web UI, typically
+by requiring your `zhong.rb` definition file.
 
+### Rails
+Load the Zhong schedule by creating an initializer at `config/initializers/zhong.rb`,
+with the following content:
+```ruby
+require "#{Rails.root}/zhong.rb"
+```
+
+Add the following to your `config/routes.rb`:
 ```ruby
 require 'zhong/web'
-mount Zhong::Web, at: "zhong"
+
+Rails.application.routes.draw do
+  # Other routes here...
+
+  mount Zhong::Web, at: "/zhong"
+end
 ```
 
 ## History

data/lib/zhong/every.rb

@@ -20,7 +20,7 @@ module Zhong
 
     def to_s
       EVERY_KEYWORDS.to_a.reverse.each do |friendly, period|
-        next unless @period % period == 0
+        next unless @period.to_i % period.to_i == 0
 
         rem = @period / period
 

data/lib/zhong/job.rb

@@ -23,6 +23,7 @@ module Zhong
       @long_running_timeout = config[:long_running_timeout]
       @running = false
       @first_run = true
+      @last_ran = nil
       @id = Digest::SHA256.hexdigest(@name)
     end
 
@@ -183,7 +184,7 @@ module Zhong
     end
 
     def redis_lock
-      @lock ||= Suo::Client::Redis.new(lock_key, client: @redis, stale_lock_expiration: @long_running_timeout)
+      @lock ||= Suo::Client::Redis.new(lock_key, client: redis, stale_lock_expiration: @long_running_timeout)
     end
   end
 end

data/lib/zhong/version.rb

@@ -1,3 +1,3 @@
 module Zhong
-  VERSION = "0.2.0".freeze
+  VERSION = "0.3.0".freeze
 end

data/lib/zhong/web.rb

@@ -6,6 +6,8 @@ require "zhong"
 require "zhong/web_helpers"
 
 module Zhong
+  # Most of the following helpers are copied from a previous version of the Sidekiq project
+  # available here: https://github.com/mperham/sidekiq/blob/2c9f7662fcdcb52d59b72ba0fe7dc5f963de4904/lib/sidekiq/web.rb
   class Web < Sinatra::Base
     enable :sessions
     use ::Rack::Protection, use: :authenticity_token unless ENV["RACK_ENV"] == "test"

data/lib/zhong/web_helpers.rb

@@ -2,6 +2,8 @@
 require "uri"
 
 module Zhong
+  # Most of the following helpers are copied from a previous version of the Sidekiq project
+  # available here: https://github.com/mperham/sidekiq/blob/2c9f7662fcdcb52d59b72ba0fe7dc5f963de4904/lib/sidekiq/web_helpers.rb
   module WebHelpers
     # Simple capture method for erb templates. The origin was
     # capture method from sinatra-contrib library.

data/test/test_every.rb

@@ -77,6 +77,18 @@ class TestEvery < Minitest::Test
     assert_equal time_in_day(0, 0, 7, 10), every.next_at(time_in_day(0, 0, 0, 10))
   end
 
+  def test_to_s
+    assert_equal "3 minutes", Zhong::Every.parse(3.minute).to_s
+    assert_equal "3 hours", Zhong::Every.parse(3.hour).to_s
+    assert_equal "1 hour", Zhong::Every.parse(1.hour).to_s
+    assert_equal "3 days", Zhong::Every.parse(3.day).to_s
+    assert_equal "3 weeks", Zhong::Every.parse(3.week).to_s
+    assert_equal "3 months", Zhong::Every.parse(3.month).to_s
+    assert_equal "1 month", Zhong::Every.parse(1.month).to_s
+    assert_equal "3 years", Zhong::Every.parse(3.year).to_s
+    assert_equal "3 decades", Zhong::Every.parse(30.years).to_s
+  end
+
   def test_invalid_string_foo
     assert_raises Zhong::Every::FailedToParse do
       Zhong::Every.parse("foo")

data/web/views/index.erb

@@ -1,4 +1,5 @@
 <!DOCTYPE html>
+<!-- This view based on ankane/clockwork_web's interface https://github.com/ankane/clockwork_web/blob/master/app/views/clockwork_web/home/index.html.erb -->
 <html>
   <head>
     <title><%= environment_title_prefix %>Zhong</title>
@@ -69,7 +70,7 @@
         <tbody>
           <% @jobs.each do |job| %>
             <% enabled = !@disabled[job.to_s] %>
-            <% enabled_str = enabled ? 'disable' : 'enable' -%>
+            <% enabled_str = enabled ? 'disable' : 'enable' %>
             <% last_run = @last_runs[job.to_s] %>
             <tr class="<%= enabled ? "" : "disabled" %>">
               <td><%= h(job) %></td>
@@ -87,7 +88,7 @@
                 <form method="POST" style="margin-top: 20px; margin-bottom: 10px;">
                   <%= csrf_tag %>
                   <div>
-                    <button type="submit" name="<%= enabled_str -%>" value="<%= job.id -%>" data-confirm="Are you sure you want to <%= enabled_str -%> this job?"><%= enabled_str.capitalize -%></button>
+                    <button type="submit" name="<%= enabled_str %>" value="<%= job.id %>" data-confirm="Are you sure you want to <%= enabled_str %> this job?"><%= enabled_str.capitalize %></button>
                   </div>
                 </form>
               </td>
@@ -99,15 +100,15 @@
     <div>
       <h3>Hosts</h3>
       <ul>
-      <% @hosts.each do |host| -%>
+      <% @hosts.each do |host| %>
         <li>
-          <strong><%= h(host[:host]) -%></strong> <em>(PID <%= host[:pid] -%>)</em>: last seen <%= relative_time(host[:last_seen]) -%>.
+          <strong><%= h(host[:host]) %></strong> <em>(PID <%= host[:pid] %>)</em>: last seen <%= relative_time(host[:last_seen]) %>.
         </li>
-      <% end -%>
+      <% end %>
       </ul>
     </div>
     <div>
-      <small><%= product_version -%></small>
+      <small><%= product_version %></small>
     </div>
   </body>
 </html>

data/zhong.gemspec

@@ -16,20 +16,20 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = ["zhong"]
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = "~> 2.1"
+  spec.required_ruby_version = ">= 2.5.0"
 
   spec.add_dependency "suo"
   spec.add_dependency "redis"
   spec.add_dependency "tzinfo"
   spec.add_dependency "activesupport"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rubocop", "~> 0.30.0"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rubocop", "~> 0.49.0"
   spec.add_development_dependency "minitest", "~> 5.5.0"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4.7"
   spec.add_development_dependency "sinatra", "~> 1.4", ">= 1.4.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zhong
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nick Elser
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: suo
@@ -72,42 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: 0.49.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -216,8 +216,6 @@ description: Reliable, distributed cron.
 email:
 - nick.elser@gmail.com
 executables:
-- console
-- setup
 - zhong
 extensions: []
 extra_rdoc_files: []
@@ -225,9 +223,9 @@ files:
 - ".codeclimate.yml"
 - ".eslintignore"
 - ".eslintrc"
+- ".github/workflows/CI.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -260,24 +258,23 @@ homepage: https://www.github.com/nickelser/zhong
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Reliable, distributed cron.
 test_files:

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.0
-services:
-  - redis-server