zhong 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81d9294dbbebe0cde178f07a3fcbd03201b13df4
-  data.tar.gz: 4fb2d954f64d9cd5ae03268ba6caeee9a319baad
+  metadata.gz: d80018119a8dad42610c1bf9736cf81eff5e91a7
+  data.tar.gz: d0ebedc85aedfc21e15c3c324525e5a497f56e1d
 SHA512:
-  metadata.gz: 644f3f05965f21cfd18d92c130bbb17734e368b150166ddaec53b0ae76b0f3cfb95b882ca8d54bf991be80b8c33f3a300f7426c7b1f798ff4f1104621002d844
-  data.tar.gz: c21398e6d6e085e06d813dc5d12ffc2cabf303b88e886360b0b37a33d0d9d77883ff4205bc9fe9f6a2d0ba817b45a073181c9eddd0392aad9318c1d608e0309c
+  metadata.gz: 6245f44c4154dcb1c93e08bcc4801b177ac66f33f6531e89d437bf6926c283a777c58cef5514daad6b488c557e2fa5e524423abe48c35812e53c4c917a5fbf38
+  data.tar.gz: 4f9ea33e8d62cca027a0c8383fa0a2683a6a2a8a477090842fb41b7fa484b8139b1ac904f313900bb6f57eb28dc219b011d04915eec7329a25963521774dc3ba

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 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!)

data/README.md

@@ -4,6 +4,7 @@ Useful, reliable distributed cron. Tired of your cron-like scheduler running key
 
 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"])
 
@@ -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/version.rb

@@ -1,3 +1,3 @@
 module Zhong
-  VERSION = "0.2.2".freeze
+  VERSION = "0.2.3".freeze
 end

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/zhong.gemspec

@@ -16,7 +16,7 @@ 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"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zhong
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Nick Elser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-13 00:00:00.000000000 Z
+date: 2017-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: suo
@@ -216,8 +216,6 @@ description: Reliable, distributed cron.
 email:
 - nick.elser@gmail.com
 executables:
-- console
-- setup
 - zhong
 extensions: []
 extra_rdoc_files: []