zhong 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56d5bb0e028b58158fb6078391782b96a4dab9d3
-  data.tar.gz: 1b9dcabc60857d70547c091ddb526d706f258a1d
+  metadata.gz: 4eafb64d51589613dfcfeca62326319eb839962f
+  data.tar.gz: 66b4fd921dd9ed1795ffa407afbcc5f33b867607
 SHA512:
-  metadata.gz: b1e9ecee03c7c42c66440daff973f0273558c5ba3b2925479062a07d35bd340f94315608035ef2e44401efb82b0807a3dab72c91e277bda47d81d83818938c67
-  data.tar.gz: e03cb2a4b7f285021ac254bdd019c2017b0a085a2b3ae51d88a19bbd2af6e9b5330b4ee75e894511c236fed27908c7a96013bed47d1210d7e21b4a304a1658ee
+  metadata.gz: 267619b1f313f958d2e2e7071bb3fbdcb22efcd9018e64d1cdcf5f07d86d055e5e4e4e87f8b1144550956ded9370c10584212fec1c6c7890bd6ace880af2348b
+  data.tar.gz: e4a9329e22811d4cda8f01882ed7e8755388b30723eb0a424f5b01ff05d526f512be60fae222d77b359326e16f60208cc8452b0ce837b9ad2ea492e9d17bf8a6

data/.codeclimate.yml

@@ -0,0 +1,23 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+  eslint:
+    enabled: true
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.rb"
+exclude_paths:
+- test/
+- "**/*{.,-}min.js"

data/.eslintignore

@@ -0,0 +1 @@
+**/*{.,-}min.js

data/.eslintrc

@@ -0,0 +1,213 @@
+ecmaFeatures:
+  modules: true
+  jsx: true
+
+env:
+  amd: true
+  browser: true
+  es6: true
+  jquery: true
+  node: true
+
+# http://eslint.org/docs/rules/
+rules:
+  # Possible Errors
+  comma-dangle: [2, never]
+  no-cond-assign: 2
+  no-console: 0
+  no-constant-condition: 2
+  no-control-regex: 2
+  no-debugger: 2
+  no-dupe-args: 2
+  no-dupe-keys: 2
+  no-duplicate-case: 2
+  no-empty: 2
+  no-empty-character-class: 2
+  no-ex-assign: 2
+  no-extra-boolean-cast: 2
+  no-extra-parens: 0
+  no-extra-semi: 2
+  no-func-assign: 2
+  no-inner-declarations: [2, functions]
+  no-invalid-regexp: 2
+  no-irregular-whitespace: 2
+  no-negated-in-lhs: 2
+  no-obj-calls: 2
+  no-regex-spaces: 2
+  no-sparse-arrays: 2
+  no-unexpected-multiline: 2
+  no-unreachable: 2
+  use-isnan: 2
+  valid-jsdoc: 0
+  valid-typeof: 2
+
+  # Best Practices
+  accessor-pairs: 2
+  block-scoped-var: 0
+  complexity: [2, 6]
+  consistent-return: 0
+  curly: 0
+  default-case: 0
+  dot-location: 0
+  dot-notation: 0
+  eqeqeq: 2
+  guard-for-in: 2
+  no-alert: 2
+  no-caller: 2
+  no-case-declarations: 2
+  no-div-regex: 2
+  no-else-return: 0
+  no-empty-label: 2
+  no-empty-pattern: 2
+  no-eq-null: 2
+  no-eval: 2
+  no-extend-native: 2
+  no-extra-bind: 2
+  no-fallthrough: 2
+  no-floating-decimal: 0
+  no-implicit-coercion: 0
+  no-implied-eval: 2
+  no-invalid-this: 0
+  no-iterator: 2
+  no-labels: 0
+  no-lone-blocks: 2
+  no-loop-func: 2
+  no-magic-number: 0
+  no-multi-spaces: 0
+  no-multi-str: 0
+  no-native-reassign: 2
+  no-new-func: 2
+  no-new-wrappers: 2
+  no-new: 2
+  no-octal-escape: 2
+  no-octal: 2
+  no-proto: 2
+  no-redeclare: 2
+  no-return-assign: 2
+  no-script-url: 2
+  no-self-compare: 2
+  no-sequences: 0
+  no-throw-literal: 0
+  no-unused-expressions: 2
+  no-useless-call: 2
+  no-useless-concat: 2
+  no-void: 2
+  no-warning-comments: 0
+  no-with: 2
+  radix: 2
+  vars-on-top: 0
+  wrap-iife: 2
+  yoda: 0
+
+  # Strict
+  strict: 0
+
+  # Variables
+  init-declarations: 0
+  no-catch-shadow: 2
+  no-delete-var: 2
+  no-label-var: 2
+  no-shadow-restricted-names: 2
+  no-shadow: 0
+  no-undef-init: 2
+  no-undef: 0
+  no-undefined: 0
+  no-unused-vars: 0
+  no-use-before-define: 0
+
+  # Node.js and CommonJS
+  callback-return: 2
+  global-require: 2
+  handle-callback-err: 2
+  no-mixed-requires: 0
+  no-new-require: 0
+  no-path-concat: 2
+  no-process-exit: 2
+  no-restricted-modules: 0
+  no-sync: 0
+
+  # Stylistic Issues
+  array-bracket-spacing: 0
+  block-spacing: 0
+  brace-style: 0
+  camelcase: 0
+  comma-spacing: 0
+  comma-style: 0
+  computed-property-spacing: 0
+  consistent-this: 0
+  eol-last: 0
+  func-names: 0
+  func-style: 0
+  id-length: 0
+  id-match: 0
+  indent: 0
+  jsx-quotes: 0
+  key-spacing: 0
+  linebreak-style: 0
+  lines-around-comment: 0
+  max-depth: 0
+  max-len: 0
+  max-nested-callbacks: 0
+  max-params: 0
+  max-statements: [2, 30]
+  new-cap: 0
+  new-parens: 0
+  newline-after-var: 0
+  no-array-constructor: 0
+  no-bitwise: 0
+  no-continue: 0
+  no-inline-comments: 0
+  no-lonely-if: 0
+  no-mixed-spaces-and-tabs: 0
+  no-multiple-empty-lines: 0
+  no-negated-condition: 0
+  no-nested-ternary: 0
+  no-new-object: 0
+  no-plusplus: 0
+  no-restricted-syntax: 0
+  no-spaced-func: 0
+  no-ternary: 0
+  no-trailing-spaces: 0
+  no-underscore-dangle: 0
+  no-unneeded-ternary: 0
+  object-curly-spacing: 0
+  one-var: 0
+  operator-assignment: 0
+  operator-linebreak: 0
+  padded-blocks: 0
+  quote-props: 0
+  quotes: 0
+  require-jsdoc: 0
+  semi-spacing: 0
+  semi: 0
+  sort-vars: 0
+  space-after-keywords: 0
+  space-before-blocks: 0
+  space-before-function-paren: 0
+  space-before-keywords: 0
+  space-in-parens: 0
+  space-infix-ops: 0
+  space-return-throw-case: 0
+  space-unary-ops: 0
+  spaced-comment: 0
+  wrap-regex: 0
+
+  # ECMAScript 6
+  arrow-body-style: 0
+  arrow-parens: 0
+  arrow-spacing: 0
+  constructor-super: 0
+  generator-star-spacing: 0
+  no-arrow-condition: 0
+  no-class-assign: 0
+  no-const-assign: 0
+  no-dupe-class-members: 0
+  no-this-before-super: 0
+  no-var: 0
+  object-shorthand: 0
+  prefer-arrow-callback: 0
+  prefer-const: 0
+  prefer-reflect: 0
+  prefer-spread: 0
+  prefer-template: 0
+  require-yield: 0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.5
+
+- Improve the API.
+- Add scheduler test.
+
 ## 0.1.4
 
 - Fix several bugs related to time parsing.

data/README.md

@@ -1,4 +1,4 @@
-# Zhong
+# 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)
 
 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.
 
@@ -15,34 +15,37 @@ gem 'zhong'
 ## Usage
 
 ```ruby
-r = Redis.new
-
-Zhong.schedule(redis: r) do |s|
-  s.category "stuff" do
-    s.every(5.seconds, "foo") { puts "foo" }
-    s.every(1.minute, "biz", at: ["**:26", "**:27"]) { puts "biz" }
-    s.every(1.week, "baz", at: ["mon 22:45", "wed 23:13"]) { puts "baz" }
-    s.every(10.seconds, "boom") { raise "fail" }
+Zhong.redis = Redis.new(url: ENV["ZHONG_REDIS_URL"])
+
+Zhong.schedule do
+  category "stuff" do
+    every 5.seconds, "foo" 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" }
   end
 
-  s.category "clutter" do
-    s.every(1.second, "compute", if: -> (t) { t.wday == 3 && rand < 0.5 }) do
+  category "clutter" do
+    every(1.second, "compute", if: -> (t) { t.wday == 3 && rand < 0.5 }) do
       puts "something happened on wednesday, maybe"
     end
   end
 
   # note: callbacks that return nil or false will cause event to not run
-  s.on(:before_tick) do
+  on(:before_tick) do
     puts "ding"
     true
   end
 
-  s.on(:after_tick) do
+  on(:after_tick) do
     puts "dong"
     true
   end
 
-  s.error_handler do |e, job|
+  error_handler do |e, job|
     puts "damn, #{job} messed up: #{e}"
   end
 end

data/bin/zhong

@@ -2,14 +2,18 @@
 
 STDERR.sync = STDOUT.sync = true
 
-require "bundler/setup"
 require "zhong"
 
-usage = "zhong <zhong.rb>"
-file = ARGV.shift || abort(usage)
+file = ARGV.shift or abort "zhong <path to zhong.rb>"
 
 file = "./#{file}" unless file.match(/^[\/.]/)
 
 require file
 
-Zhong.start
+begin
+  Zhong.start
+rescue => boom
+  STDERR.puts boom.message
+  STDERR.puts boom.backtrace.join("\n")
+  exit 1
+end

data/lib/zhong/at.rb

@@ -17,6 +17,20 @@ module Zhong
 
     attr_accessor :minute, :hour, :wday
 
+    def self.parse(at, grace: 0.seconds)
+      if at.respond_to?(:each)
+        MultiAt.new(at.map { |a| parse_at(a, grace) })
+      else
+        parse_at(at, grace)
+      end
+    rescue ArgumentError
+      fail FailedToParse, at
+    end
+
+    def self.deserialize(at)
+      parse_serialized(MessagePack.unpack(at))
+    end
+
     def initialize(minute: nil, hour: nil, wday: nil, grace: 0.seconds)
       @minute = minute
       @hour = hour
@@ -27,25 +41,13 @@ module Zhong
     end
 
     def next_at(time = Time.now)
-      at_time = @wday.nil? ? time.dup : (time + (@wday - time.wday).days)
-
-      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
+      at_time = at_time_day_hour_minute_adjusted(time)
 
-      if at_time < (time.change(sec: 0) - @grace)
+      grace_cutoff = time.change(sec: 0) - @grace
+
+      if at_time < grace_cutoff
         if @wday.nil?
-          if @hour.nil?
-            at_time += 1.hour
-          else
-            at_time += 1.day
-          end
+          at_time += @hour.nil? ? 1.hour : 1.day
         else
           at_time += 1.week
         end
@@ -54,26 +56,51 @@ module Zhong
       end
     end
 
-    private def valid?
-      (@minute.nil? || (0..59).cover?(@minute)) &&
-        (@hour.nil? || (0..23).cover?(@hour)) &&
-        (@wday.nil? || (0..6).cover?(@wday))
+    def to_s
+      str = "#{formatted_time(@hour)}:#{formatted_time(@minute)}"
+
+      if @wday
+        str += " on #{WDAYS.invert[@wday].capitalize}"
+      end
+
+      str
     end
 
-    def self.parse(at, grace: 0.seconds)
-      return unless at
+    def as_json
+      {m: @minute, h: @hour, w: @wday, g: @grace}
+    end
 
-      # TODO: refactor this mess
-      if at.respond_to?(:each)
-        return MultiAt.new(at.map { |a| parse(a, grace: grace) })
+    def serialize
+      MessagePack.pack(as_json)
+    end
+
+    protected
+
+    def formatted_time(t)
+      if t.nil?
+        "**"
+      else
+        t.to_s.rjust(2, "0")
       end
+    end
+
+    def ==(o)
+      o.class == self.class && o.state == state
+    end
 
+    def state
+      [@minute, @hour, @wday]
+    end
+
+    private
+
+    def self.parse_at(at, grace)
       case at
       when /\A([[:alpha:]]+)\s+(.*)\z/
         wday = WDAYS[$1.downcase]
 
         if wday
-          parsed_time = parse($2, grace: grace)
+          parsed_time = parse_at($2, grace)
           parsed_time.wday = wday
           parsed_time
         else
@@ -88,8 +115,36 @@ module Zhong
       else
         fail FailedToParse, at
       end
-    rescue ArgumentError
-      fail FailedToParse, at
+    end
+
+    def self.parse_serialized(at)
+      if at.is_a?(Array)
+        MultiAt.new(at.map { |a| parse_serialized(a) })
+      else
+        new(minute: at["m"], hour: at["h"], wday: at["w"], grace: at["g"])
+      end
+    end
+
+    def at_time_hour_minute_adjusted(time)
+      if @minute && @hour
+        time.change(hour: @hour, min: @minute)
+      elsif @minute
+        time.change(min: @minute)
+      elsif @hour && @hour != time.hour
+        time.change(hour: @hour)
+      else
+        time.change(sec: 0)
+      end
+    end
+
+    def at_time_day_hour_minute_adjusted(time)
+      at_time_hour_minute_adjusted(time) + (@wday ? (@wday - time.wday) : 0).days
+    end
+
+    def valid?
+      (@minute.nil? || (0..59).cover?(@minute)) &&
+        (@hour.nil? || (0..23).cover?(@hour)) &&
+        (@wday.nil? || (0..6).cover?(@wday))
     end
   end
 
@@ -100,8 +155,24 @@ module Zhong
       @ats = ats
     end
 
+    def ==(o)
+      o.class == self.class && @ats == o.ats
+    end
+
     def next_at(time = Time.now)
       ats.map { |at| at.next_at(time) }.min
     end
+
+    def to_s
+      ats.map(&:to_s).join(", ")
+    end
+
+    def as_json
+      ats.map(&:as_json)
+    end
+
+    def serialize
+      MessagePack.pack(as_json)
+    end
   end
 end