wristwatch 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in wristwatch.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/core_ext/numeric.rb

@@ -0,0 +1,5 @@
+class Numeric
+  def divisible_by?(int, offset = 0)
+    modulo(int) == offset
+  end
+end

data/lib/wristwatch.rb

@@ -0,0 +1,19 @@
+require "core_ext/numeric"
+require "wristwatch/version"
+require "wristwatch/intervals"
+require "wristwatch/schedule"
+require "wristwatch/manifest"
+require "wristwatch/task"
+require "wristwatch/dispatch"
+
+if defined?(Rails)
+  require 'wristwatch/railtie'
+end
+
+module Wristwatch
+  extend self
+
+  def run
+    Dispatch.new(Manifest.new.build, Schedule.new).execute
+  end
+end

data/lib/wristwatch/cron.rake

@@ -0,0 +1,4 @@
+desc "Hourly cron master task"
+task :cron => :environment do
+  Wristwatch.run
+end

data/lib/wristwatch/dispatch.rb

@@ -0,0 +1,17 @@
+module Wristwatch
+  class Dispatch
+
+    def initialize(tasks, schedule)
+      @tasks = tasks
+      @schedule = schedule
+    end
+
+    def list
+      @schedule.inject([]) {|list, interval| list += @tasks[interval] }
+    end
+
+    def execute
+      list.each(&:call)
+    end
+  end
+end

data/lib/wristwatch/intervals.rb

@@ -0,0 +1,51 @@
+module Wristwatch
+  module Intervals
+    def hourly
+      true
+    end
+
+    def bi_hourly
+      now.hour.divisible_by?(2)
+    end
+
+    def quarter_hourly
+      now.hour.divisible_by?(6)
+    end
+
+    def bi_daily
+      now.hour.divisible_by?(12)
+    end
+
+    def daily
+      now.hour.eql?(0)
+    end
+
+    def weekly
+      daily and now.wday.eql?(0)
+    end
+
+    def bi_weekly
+      daily and ( now.day.eql?(1) or now.day.eql?(15) )
+    end
+
+    def monthly
+      daily and now.day.eql?(1)
+    end
+
+    def bi_monthly
+      daily and monthly and now.month.divisible_by?(2, 1)
+    end
+
+    def quarterly
+      daily and monthly and now.month.divisible_by?(3, 1)
+    end
+
+    def semiannually
+      daily and monthly and now.month.divisible_by?(6, 1)
+    end
+
+    def annually
+      daily and monthly and now.month.eql?(1)
+    end
+  end
+end

data/lib/wristwatch/manifest.rb

@@ -0,0 +1,32 @@
+module Wristwatch
+  class Manifest < Hash
+
+    def build
+      instance_eval instructions
+    end
+
+    def add_task(name, *args, &blk)
+      raise ArgumentError, "Wristwatch manifests require that you pass a block to be executed" unless block_given?
+      self[name] = [] unless has_key?(name)
+      self[name] << build_task(*args, &blk)
+    end
+
+    def instructions
+      File.read('config/wristwatch_jobs.rb')
+    end
+
+    private
+
+    def build_task(*args, &blk)
+      Wristwatch::Task.new(*args, &blk)
+    end
+
+    def method_missing(meth, *args, &blk)
+      if blk
+        add_task(meth, *args, &blk)
+      else
+        super(meth, *args, &blk)
+      end
+    end
+  end
+end

data/lib/wristwatch/railtie.rb

@@ -0,0 +1,7 @@
+module Wristwatch
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "wristwatch/cron.rake"
+    end
+  end
+end

data/lib/wristwatch/schedule.rb

@@ -0,0 +1,38 @@
+module Wristwatch
+  class Schedule
+    include Intervals
+    include Enumerable
+
+    attr_reader :now
+
+    def initialize(time = Time.now)
+      @now = time
+    end
+
+    def intervals
+      available_intervals.select { |interval| send(interval) }
+    end
+
+    def available_intervals
+      Intervals.instance_methods
+    end
+
+    def each
+      intervals.each do |interval|
+        yield interval
+      end
+    end
+
+    def method_missing(meth, *args, &blk)
+      if meth.to_s[meth.to_s.length - 1, 1] === "?"
+        begin
+          send(meth[0, meth.to_s.length - 1], *args, &blk)
+        rescue NoMethodError
+          super(meth, *args, &blk)
+        end
+      else
+        super(meth, *args, &blk)
+      end
+    end
+  end
+end

data/lib/wristwatch/slices.rb

@@ -0,0 +1,51 @@
+module Wristwatch
+  module Intervals
+    def hourly
+      true
+    end
+
+    def bi_hourly
+      now.hour.divisible_by?(2)
+    end
+
+    def quarter_hourly
+      now.hour.divisible_by?(6)
+    end
+
+    def bi_daily
+      now.hour.divisible_by?(12)
+    end
+
+    def daily
+      now.hour.eql?(0)
+    end
+
+    def weekly
+      daily and now.wday.eql?(0)
+    end
+
+    def bi_weekly
+      daily and ( now.day.eql?(1) or now.day.eql?(15) )
+    end
+
+    def monthly
+      daily and now.day.eql?(1)
+    end
+
+    def bi_monthly
+      daily and monthly and now.month.divisible_by?(2, 1)
+    end
+
+    def quarterly
+      daily and monthly and now.month.divisible_by?(3, 1)
+    end
+
+    def semiannually
+      daily and monthly and now.month.divisible_by?(6, 1)
+    end
+
+    def annually
+      daily and monthly and now.month.eql?(1)
+    end
+  end
+end

data/lib/wristwatch/task.rb

@@ -0,0 +1,15 @@
+module Wristwatch
+  class Task
+    attr_reader :name
+    def initialize(*args, &blk)
+      @options = args.last.is_a?(Hash) ? args.last : {}
+      @name = args[0]
+      @proc = blk
+    end
+
+    def call
+      puts "running '#{name}'"
+      @proc.call
+    end
+  end
+end

data/lib/wristwatch/version.rb

@@ -0,0 +1,3 @@
+module Wristwatch
+  VERSION = "0.0.1"
+end

data/spec/dispatch_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Wristwatch::Dispatch do
+  let(:schedule) { Wristwatch::Schedule.new }
+  let(:tasks) { {
+      :daily   => ["daily_task_1", "daily_task_2", "daily_task_3"],
+      :monthly => ["monthly_task"],
+      :weekly  => ["weekly_task_1", "weekly_task_2"]
+  } }
+  before(:each) do
+    schedule.stub(:intervals).and_return([:daily, :weekly])
+  end
+
+  subject { Wristwatch::Dispatch.new(tasks, schedule) }
+
+  its(:list) { should eql ["daily_task_1", "daily_task_2", "daily_task_3", "weekly_task_1", "weekly_task_2"] }
+
+  describe "#execute" do
+    let(:proc_1) { "a proc" }
+    let(:proc_2) { "another proc" }
+    before(:each) do
+      subject.stub(:list).and_return([proc_1, proc_2])
+    end
+
+    it "executes each proc in the dispatch in order" do
+      proc_1.should_receive(:call)
+      proc_2.should_receive(:call)
+      subject.execute
+    end
+  end
+end

data/spec/manifest_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Wristwatch::Manifest do
+  describe "building tasks from a file" do
+    before(:each) do
+      subject.stub(:instructions).and_return( <<-RUBY
+
+daily "A daily job" do
+  "contents of a daily job"
+end
+
+hourly "An hourly job" do
+  "contents of an hourly job"
+end
+
+hourly "Another hourly job" do
+  "contents of another hourly job"
+end
+
+RUBY
+      )
+      subject.should_receive(:build_task).exactly(3).times
+      subject.build
+    end
+
+    it { should have_key(:daily) }
+    it { should have_key(:hourly) }
+
+    it "should have two tasks in the hourly array" do
+      subject[:hourly].should have(2).tasks
+    end
+
+  end
+end

data/spec/schedule_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe Wristwatch::Schedule do
+  before(:each) { Time.stub!(:now).and_return(time) }
+
+  context "whenever" do
+    let(:time) { Time.new }
+    it {should be_hourly}
+    its(:intervals) {should include(:hourly)}
+  end
+
+  context "on even hours" do
+    let(:time) { Time.new(2011, 3, 3, 2) }
+    it {should be_bi_hourly}
+    its(:intervals) {should include(:bi_hourly)}
+  end
+
+  describe "quarter-daily" do
+    [6, 18].each do |hour|
+      context "at #{hour} o'clock daily" do
+        let(:time) {Time.new(2011, 3, 3, hour) }
+        its(:intervals) { should eql [:hourly, :bi_hourly, :quarter_hourly]}
+        it {should be_quarter_hourly }
+      end
+    end
+  end
+
+  describe "bi-daily" do
+    context "at 12 o'clock daily" do
+      let(:time) {Time.new(2011, 3, 3, 12) }
+      its(:intervals) { should eql [:hourly, :bi_hourly, :quarter_hourly, :bi_daily]}
+      it {should be_bi_daily }
+    end
+  end
+
+  context "at midnight" do
+    let(:time) { Time.new(2011, 3, 3) }
+    its(:intervals) { should eql [:hourly, :bi_hourly, :quarter_hourly, :bi_daily, :daily]}
+    it {should be_daily}
+  end
+
+  context "on Sunday" do
+    let(:time) { Time.new(2011, 3, 6) }
+    its(:intervals) { should eql [:hourly, :bi_hourly, :quarter_hourly, :bi_daily, :daily, :weekly] }
+    it { should be_weekly }
+  end
+
+  context "on the 15th of the month" do
+    let(:time) { Time.new(2011, 3, 15) }
+    its(:intervals) { should eql [:hourly, :bi_hourly, :quarter_hourly, :bi_daily, :daily, :bi_weekly] }
+    it { should be_bi_weekly }
+  end
+
+  context "monthly" do
+    let(:time) { Time.new(2011, 2, 1) }
+    its(:intervals) { should eql [:hourly, :bi_hourly, :quarter_hourly, :bi_daily, :daily, :bi_weekly, :monthly ] }
+    it { should be_monthly }
+  end
+
+  context "bi-monthly" do
+    let(:time) { Time.new(2011, 3, 1) }
+    its(:intervals) { should eql [:hourly, :bi_hourly, :quarter_hourly, :bi_daily, :daily, :bi_weekly, :monthly, :bi_monthly ] }
+    it { should be_bi_monthly }
+  end
+
+  describe "quarterly" do
+    [4, 10].each do |month|
+      context "on month #{month}" do
+        let(:time) { Time.new(2011, month, 1) }
+        its(:intervals) { should eql [:hourly, :bi_hourly, :quarter_hourly, :bi_daily, :daily, :bi_weekly, :monthly, :quarterly] }
+        it { should be_quarterly }
+      end
+    end
+  end
+
+  describe "semiannually" do
+    let(:time) { Time.new(2011, 7, 1) }
+    its(:intervals) { should eql [:hourly, :bi_hourly, :quarter_hourly, :bi_daily, :daily, :bi_weekly, :monthly, :bi_monthly, :quarterly, :semiannually] }
+    it { should be_semiannually }
+  end
+
+  describe "annually" do
+    let(:time) { Time.new(2011, 1, 1) }
+    its(:intervals) { should eql [:hourly, :bi_hourly, :quarter_hourly, :bi_daily, :daily, :bi_weekly, :monthly, :bi_monthly, :quarterly, :semiannually, :annually] }
+    it { should be_annually }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler.setup
+require 'rspec'
+$:.unshift(File.join(File.expand_path(__FILE__), "..", "lib"))
+require 'wristwatch.rb'
+

data/wristwatch.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "wristwatch/version"
+
+Gem::Specification.new do |s|
+  s.name        = "wristwatch"
+  s.version     = Wristwatch::VERSION
+  s.authors     = ["Scott Burton"]
+  s.email       = ["scott@chaione.com"]
+  s.homepage    = "http://github.com/chaione/wristwatch"
+  s.summary     = %q{Easy cron dispatching}
+  s.description = %q{Easy cron dispatching}
+
+  s.rubyforge_project = "wristwatch"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  #s.add_runtime_dependency "rails", ">= 3.0"
+  s.add_development_dependency "rspec", ">= 2.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: wristwatch
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Scott Burton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-31 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :development
+  version_requirements: *id001
+description: Easy cron dispatching
+email: 
+- scott@chaione.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/core_ext/numeric.rb
+- lib/wristwatch.rb
+- lib/wristwatch/cron.rake
+- lib/wristwatch/dispatch.rb
+- lib/wristwatch/intervals.rb
+- lib/wristwatch/manifest.rb
+- lib/wristwatch/railtie.rb
+- lib/wristwatch/schedule.rb
+- lib/wristwatch/slices.rb
+- lib/wristwatch/task.rb
+- lib/wristwatch/version.rb
+- spec/dispatch_spec.rb
+- spec/manifest_spec.rb
+- spec/schedule_spec.rb
+- spec/spec_helper.rb
+- wristwatch.gemspec
+homepage: http://github.com/chaione/wristwatch
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: wristwatch
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Easy cron dispatching
+test_files: 
+- spec/dispatch_spec.rb
+- spec/manifest_spec.rb
+- spec/schedule_spec.rb
+- spec/spec_helper.rb