zhong 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5945fa0ab193d6a729fdf393166c8d380a06558e
-  data.tar.gz: 8956f5b216934a2ebc5b9014c53b655c46ff462a
+  metadata.gz: 56d5bb0e028b58158fb6078391782b96a4dab9d3
+  data.tar.gz: 1b9dcabc60857d70547c091ddb526d706f258a1d
 SHA512:
-  metadata.gz: 62629516856da87db6bdf7a54dc616efe247b7ce29e039d989ee0b69a7fa9015fb2d43a15b651aea30c604942ce2b2fd0aeecd1961fe63bb9d201bfdbfc0e428
-  data.tar.gz: 7afeb0d7ee86d65eed6964c03f161730bd4050ce5d70c1ce86d137d9ae0f22a95e5ff91a0f10a87080d6e192d399afc0664427ac8bfa231bcc4313c3cc437134
+  metadata.gz: b1e9ecee03c7c42c66440daff973f0273558c5ba3b2925479062a07d35bd340f94315608035ef2e44401efb82b0807a3dab72c91e277bda47d81d83818938c67
+  data.tar.gz: e03cb2a4b7f285021ac254bdd019c2017b0a085a2b3ae51d88a19bbd2af6e9b5330b4ee75e894511c236fed27908c7a96013bed47d1210d7e21b4a304a1658ee

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.4
+
+- Fix several bugs related to time parsing.
+- In a totally unrelated change, add some tests around time parsing.
+
 ## 0.1.3
 
 - Fix several memory leaks.

data/bin/zhong

@@ -4,7 +4,6 @@ STDERR.sync = STDOUT.sync = true
 
 require "bundler/setup"
 require "zhong"
-require "memory_profiler"
 
 usage = "zhong <zhong.rb>"
 file = ARGV.shift || abort(usage)

data/lib/zhong/at.rb

@@ -17,22 +17,35 @@ module Zhong
 
     attr_accessor :minute, :hour, :wday
 
-    def initialize(minute: nil, hour: nil, wday: nil, grace: 0.minutes)
+    def initialize(minute: nil, hour: nil, wday: nil, grace: 0.seconds)
       @minute = minute
       @hour = hour
       @wday = wday
       @grace = grace
+
+      fail ArgumentError unless valid?
     end
 
     def next_at(time = Time.now)
       at_time = @wday.nil? ? time.dup : (time + (@wday - time.wday).days)
 
-      at_time = at_time.change(min: @minute)
-      at_time = at_time.change(hour: @hour) if @hour
+      at_time = if !@minute.nil? && !@hour.nil?
+        at_time.change(hour: @hour, min: @minute)
+      elsif !@minute.nil?
+        at_time.change(min: @minute)
+      elsif !@hour.nil? && @hour != time.hour
+        at_time.change(hour: @hour)
+      else
+        at_time.change(sec: 0)
+      end
 
-      if at_time < @grace.ago
+      if at_time < (time.change(sec: 0) - @grace)
         if @wday.nil?
-          at_time += 1.day
+          if @hour.nil?
+            at_time += 1.hour
+          else
+            at_time += 1.day
+          end
         else
           at_time += 1.week
         end
@@ -41,7 +54,13 @@ module Zhong
       end
     end
 
-    def self.parse(at, grace: 0)
+    private def valid?
+      (@minute.nil? || (0..59).cover?(@minute)) &&
+        (@hour.nil? || (0..23).cover?(@hour)) &&
+        (@wday.nil? || (0..6).cover?(@wday))
+    end
+
+    def self.parse(at, grace: 0.seconds)
       return unless at
 
       # TODO: refactor this mess
@@ -51,7 +70,7 @@ module Zhong
 
       case at
       when /\A([[:alpha:]]+)\s+(.*)\z/
-        wday = WDAYS[$1]
+        wday = WDAYS[$1.downcase]
 
         if wday
           parsed_time = parse($2, grace: grace)
@@ -65,12 +84,12 @@ module Zhong
       when /\A\*{1,2}:(\d\d)\z/
         new(minute: $1.to_i, grace: grace)
       when /\A(\d{1,2}):\*{1,2}\z/
-        new(hour: $1, grace: grace)
+        new(hour: $1.to_i, grace: grace)
       else
         fail FailedToParse, at
       end
     rescue ArgumentError
-      throw FailedToParse, at
+      fail FailedToParse, at
     end
   end
 

data/lib/zhong/every.rb

@@ -8,7 +8,7 @@ module Zhong
       month: 1.month,
       semiannual: 6.months, # enterprise!
       year: 1.year,
-      decade: 10.year
+      decade: 10.years
     }.freeze
 
     def initialize(period)

data/lib/zhong/job.rb

@@ -13,7 +13,7 @@ module Zhong
         @logger.error "warning: #{self} has `at` but no `every`; could run far more often than expected!"
       end
 
-      fail "must specific either `at` or `every` for a job" unless @at || @every
+      fail "must specific either `at` or `every` for job: #{self}" unless @at || @every
 
       @block = block
 

data/lib/zhong/scheduler.rb

@@ -19,7 +19,7 @@ module Zhong
     end
 
     def category(name)
-      fail "cannot nest categories: #{name} would be nested in #{@category}" if @category
+      fail "cannot nest categories: #{name} would be nested in #{@category} (#{caller.first})" if @category
 
       @category = name.to_s
 
@@ -29,6 +29,7 @@ module Zhong
     end
 
     def every(period, name, opts = {}, &block)
+      fail "must specify a period for #{name} (#{caller.first})" unless period
       job = Job.new(name, opts.merge(@config).merge(every: period, category: @category), &block)
       add(job)
     end

data/lib/zhong/version.rb

@@ -1,3 +1,3 @@
 module Zhong
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+if ENV["CODECLIMATE_REPO_TOKEN"]
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+require "zhong"
+require "minitest/autorun"
+
+ENV["ZHONG_TEST"] = "true"

data/test/zhong_test.rb

@@ -1,6 +1,146 @@
-require 'minitest_helper'
+require "test_helper"
 
-class TestZhong < Minitest::Test
+# Many At tests lifted from Clockwork (thanks Clockwork!)
+class TestAt < Minitest::Test
+  def time_in_day(hour, minute, day = 0, sec = 0)
+    Time.new.beginning_of_week(:monday).change(hour: hour, min: minute, sec: sec) + day.days
+  end
+
+  def test_16_20
+    at = Zhong::At.parse("16:20", grace: 0)
+
+    assert_equal time_in_day(16, 20), at.next_at(time_in_day(16, 15))
+    assert_equal time_in_day(16, 20), at.next_at(time_in_day(16, 20))
+    assert_equal time_in_day(16, 20), at.next_at(time_in_day(16, 20, 0, 10))
+    assert_equal time_in_day(16, 20), at.next_at(time_in_day(16, 20, 0, 59))
+    assert_equal time_in_day(16, 20, 1), at.next_at(time_in_day(16, 21))
+    assert_equal time_in_day(16, 20, 1), at.next_at(time_in_day(16, 21, 0, 01))
+    assert_equal time_in_day(16, 20, 2), at.next_at(time_in_day(16, 21, 1, 30))
+  end
+
+  def test_16_20_with_grace
+    at = Zhong::At.parse("16:20", grace: 5.minutes)
+
+    assert_equal time_in_day(16, 20), at.next_at(time_in_day(16, 21))
+    assert_equal time_in_day(16, 20), at.next_at(time_in_day(16, 25))
+    assert_equal time_in_day(16, 20, 1), at.next_at(time_in_day(16, 26))
+  end
+
+  def test_8_20_before
+    at = Zhong::At.parse("8:20")
+
+    assert_equal time_in_day(8, 20), at.next_at(time_in_day(8, 15))
+    assert_equal time_in_day(8, 20, 1), at.next_at(time_in_day(8, 21))
+  end
+
+  def test_two_star_20
+    at = Zhong::At.parse("**:20")
+
+    assert_equal time_in_day(8, 20), at.next_at(time_in_day(8, 15))
+    assert_equal time_in_day(9, 20), at.next_at(time_in_day(9, 15))
+    assert_equal time_in_day(10, 20), at.next_at(time_in_day(9, 45))
+  end
+
+  def test_one_star_20
+    at = Zhong::At.parse("*:45")
+
+    assert_equal time_in_day(8, 45), at.next_at(time_in_day(8, 35))
+    assert_equal time_in_day(9, 45), at.next_at(time_in_day(9, 35))
+    assert_equal time_in_day(10, 45), at.next_at(time_in_day(9, 50))
+  end
+
+  def test_one_star_20_with_grace
+    at = Zhong::At.parse("*:45", grace: 5.minutes)
+
+    assert_equal time_in_day(8, 45), at.next_at(time_in_day(8, 35))
+    assert_equal time_in_day(8, 45), at.next_at(time_in_day(8, 50))
+    assert_equal time_in_day(9, 45), at.next_at(time_in_day(8, 51))
+    assert_equal time_in_day(9, 45), at.next_at(time_in_day(9, 35))
+    assert_equal time_in_day(10, 45), at.next_at(time_in_day(9, 55))
+  end
+
+  def test_16_two_stars
+    at = Zhong::At.parse("16:**")
+
+    assert_equal time_in_day(16, 00), at.next_at(time_in_day(8, 45))
+    assert_equal time_in_day(16, 00), at.next_at(time_in_day(10, 00))
+    assert_equal time_in_day(16, 00), at.next_at(time_in_day(16, 00))
+    assert_equal time_in_day(16, 01), at.next_at(time_in_day(16, 01))
+    assert_equal time_in_day(16, 30), at.next_at(time_in_day(16, 30))
+    assert_equal time_in_day(16, 59), at.next_at(time_in_day(16, 59))
+    assert_equal time_in_day(16, 00, 1), at.next_at(time_in_day(17, 00))
+    assert_equal time_in_day(16, 00, 1), at.next_at(time_in_day(23, 59))
+  end
+
+  def test_8_two_stars
+    at = Zhong::At.parse("8:**")
+
+    assert_equal time_in_day(8, 00), at.next_at(time_in_day(3, 45))
+    assert_equal time_in_day(8, 00), at.next_at(time_in_day(5, 00))
+    assert_equal time_in_day(8, 00), at.next_at(time_in_day(8, 00))
+    assert_equal time_in_day(8, 01), at.next_at(time_in_day(8, 01))
+    assert_equal time_in_day(8, 30), at.next_at(time_in_day(8, 30))
+    assert_equal time_in_day(8, 59), at.next_at(time_in_day(8, 59))
+    assert_equal time_in_day(8, 00, 1), at.next_at(time_in_day(9, 00))
+    assert_equal time_in_day(8, 00, 1), at.next_at(time_in_day(12, 59))
+  end
+
+  def test_saturday_12
+    at = Zhong::At.parse("Saturday 12:00")
+
+    assert_equal time_in_day(12, 00, 5), at.next_at(time_in_day(12, 00))
+    assert_equal time_in_day(12, 00, 5), at.next_at(time_in_day(13, 00, 1))
+    assert_equal time_in_day(12, 00, 5), at.next_at(time_in_day(23, 59, 3))
+    assert_equal time_in_day(12, 00, 5), at.next_at(time_in_day(12, 00, 5))
+    assert_equal time_in_day(12, 00, 12), at.next_at(time_in_day(12, 01, 5))
+    assert_equal time_in_day(12, 00, 12), at.next_at(time_in_day(13, 01, 6, 01))
+  end
+
+  def test_sat_12
+    at = Zhong::At.parse("sat 12:00")
+
+    assert_equal time_in_day(12, 00, 5), at.next_at(time_in_day(12, 00))
+    assert_equal time_in_day(12, 00, 5), at.next_at(time_in_day(13, 00, 1))
+    assert_equal time_in_day(12, 00, 5), at.next_at(time_in_day(23, 59, 3))
+    assert_equal time_in_day(12, 00, 5), at.next_at(time_in_day(12, 00, 5))
+    assert_equal time_in_day(12, 00, 12), at.next_at(time_in_day(12, 01, 5))
+    assert_equal time_in_day(12, 00, 12), at.next_at(time_in_day(13, 01, 6, 01))
+  end
+
+  def test_tue_12_59
+    at = Zhong::At.parse("tue 12:59")
+
+    assert_equal time_in_day(12, 59, 1), at.next_at(time_in_day(7, 00))
+    assert_equal time_in_day(12, 59, 1), at.next_at(time_in_day(12, 00, 1))
+    assert_equal time_in_day(12, 59, 1), at.next_at(time_in_day(12, 59, 1))
+    assert_equal time_in_day(12, 59, 8), at.next_at(time_in_day(13, 00, 1))
+    assert_equal time_in_day(12, 59, 8), at.next_at(time_in_day(13, 01, 6, 01))
+  end
+
+  def test_thr_12_59
+    at = Zhong::At.parse("thr 12:59")
+
+    assert_equal time_in_day(12, 59, 3), at.next_at(time_in_day(7, 00))
+    assert_equal time_in_day(12, 59, 3), at.next_at(time_in_day(12, 00, 3))
+    assert_equal time_in_day(12, 59, 3), at.next_at(time_in_day(12, 59, 3))
+    assert_equal time_in_day(12, 59, 10), at.next_at(time_in_day(13, 00, 3))
+    assert_equal time_in_day(12, 59, 10), at.next_at(time_in_day(13, 01, 6, 01))
+  end
+
+  def test_invalid_time_32
+    assert_raises Zhong::At::FailedToParse do
+      Zhong::At.parse("32:00")
+    end
+  end
+
+  def test_invalid_multi_line_time_sat_12
+    assert_raises Zhong::At::FailedToParse do
+      Zhong::At.parse("sat 12:00\nreally invalid time")
+    end
+  end
+end
+
+class TestLibrary < Minitest::Test
   def test_that_it_has_a_version_number
     refute_nil ::Zhong::VERSION
   end

data/zhong.gemspec

@@ -26,11 +26,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "redis"
   spec.add_dependency "tzinfo"
   spec.add_dependency "activesupport"
-  spec.add_dependency "memory_profiler"
 
   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 "minitest", "~> 5.5.0"
-  # spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4.7"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zhong
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Nick Elser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-07 00:00:00.000000000 Z
+date: 2015-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: suo
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: memory_profiler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.5.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.7
 description: Reliable, distributed cron.
 email:
 - nick.elser@gmail.com
@@ -164,7 +164,7 @@ files:
 - lib/zhong/scheduler.rb
 - lib/zhong/util.rb
 - lib/zhong/version.rb
-- test/minitest_helper.rb
+- test/test_helper.rb
 - test/zhong_test.rb
 - zhong.gemspec
 homepage: https://www.github.com/nickelser/zhong
@@ -192,5 +192,5 @@ signing_key:
 specification_version: 4
 summary: Reliable, distributed cron.
 test_files:
-- test/minitest_helper.rb
+- test/test_helper.rb
 - test/zhong_test.rb

data/test/minitest_helper.rb

@@ -1,4 +0,0 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'zhong'
-
-require 'minitest/autorun'