taskmaster 0.0.1 → 0.1.1

data/Gemfile

@@ -4,7 +4,7 @@ source "http://rubygems.org"
 #   gem "activesupport", ">= 2.3.5"
 
 gem 'whenever'
-gem 'activesupport', '~> 2.3'
+gem 'activesupport'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/README.rdoc

@@ -5,6 +5,8 @@ Make your Ruby classes cron-aware!
 
 == Example
 
+The base case is simple -- just include the `Taskmaster::Henchman` module, define a `run` class method, and use `whenever` syntax to specify when and how often the method should run:
+
     require 'taskmaster'
 
     class FootSoldier
@@ -19,9 +21,18 @@ Make your Ruby classes cron-aware!
 
     puts FootSoldier.cron_output # => "5,15,25,35,45,55 * * * * /bin/bash -l -c 'cd /... && script/runner -e production '\''BulkTask.run'\'''"
 
+You can override various pieces of this, including the name of the class method to run:
+
+    every 10.minutes, :run => :special_method
+
+    def self.special_method
+      # I'm not the default!
+    end
+
+Check the documentation on `Taskmaster::Henchman.every` for details on all the allowed options.
+
 == TODO
 
-* figure out different task types
 * add a Rake task to output and save crontab for all Taskmaster-including classes (fall back to whenever)
 
 == Contributing to taskmaster

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.1

data/lib/taskmaster.rb

@@ -1,9 +1,15 @@
 require 'whenever'
 
-require './lib/taskmaster/henchman'
+require 'taskmaster/henchman'
+require 'taskmaster/railtie'
 
 module Taskmaster
   def self.cron_output
+    # make sure all the models that could include Henchman are loaded
+    if defined?(Rails)
+      Dir[Rails.root.join('app', 'models', '**', '*.rb')].each { |file| require file }
+    end
+
     Henchman.included_in.map { |klass| klass.cron_output.strip }.join("\n")
   end
 end

data/lib/taskmaster/henchman.rb

@@ -1,3 +1,5 @@
+require 'taskmaster'
+
 module Taskmaster
   module Henchman
     def self.included(base)
@@ -13,8 +15,11 @@ module Taskmaster
 
     module ClassMethods
       def every(frequency, options = {})
-        @schedule = "every #{frequency.to_s}, #{options.inspect} do
-  runner \'#{self.name}.run\'
+        @scheduled_jobs ||= []
+        method  = options.delete(:run) || :run
+        command = options.delete(:command) || :runner
+        @scheduled_jobs << "every #{frequency.to_s}, #{options.inspect} do
+  #{command.to_s} \'#{self.name}.#{method.to_s}\'
 end"
       end
 
@@ -23,7 +28,7 @@ end"
       end
 
       def cron_output
-        Whenever::JobList.new(@schedule).generate_cron_output
+        Whenever::JobList.new(@scheduled_jobs.join("\n")).generate_cron_output
       end
     end
   end

data/lib/taskmaster/railtie.rb

@@ -0,0 +1,12 @@
+require 'taskmaster'
+
+module Taskmaster
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load "tasks/taskmaster.rake"
+      end
+    end
+  end
+end

data/lib/tasks/taskmaster.rake

@@ -0,0 +1,8 @@
+namespace :taskmaster do
+
+  desc "Generate crontab"
+  task :generate do
+    output = Taskmaster.cron_output
+    puts output
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'taskmaster/railtie'

data/taskmaster.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{taskmaster}
-  s.version = "0.0.1"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Scofield"]
-  s.date = %q{2011-06-16}
+  s.date = %q{2011-06-17}
   s.description = %q{Taskmaster allows you to easily make your Ruby classes aware of cron.}
   s.email = %q{git@turrean.com}
   s.extra_rdoc_files = [
@@ -25,8 +25,11 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/taskmaster.rb",
     "lib/taskmaster/henchman.rb",
+    "lib/taskmaster/railtie.rb",
+    "lib/tasks/taskmaster.rake",
+    "rails/init.rb",
     "taskmaster.gemspec",
-    "test/foot_soldier.rb",
+    "test/classes/foot_soldier.rb",
     "test/helper.rb",
     "test/test_henchman.rb",
     "test/test_taskmaster.rb"
@@ -42,14 +45,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<whenever>, [">= 0"])
-      s.add_runtime_dependency(%q<activesupport>, ["~> 2.3"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<rake>, ["= 0.8.7"])
     else
       s.add_dependency(%q<whenever>, [">= 0"])
-      s.add_dependency(%q<activesupport>, ["~> 2.3"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
@@ -57,7 +60,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<whenever>, [">= 0"])
-    s.add_dependency(%q<activesupport>, ["~> 2.3"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
     s.add_dependency(%q<rcov>, [">= 0"])

data/test/classes/foot_soldier.rb

@@ -0,0 +1,64 @@
+class FootSoldier
+  include Taskmaster::Henchman
+
+  every 10.minutes
+
+  def self.run
+    # get beaten up by a superhero
+  end
+end
+
+class SpecialSoldier
+  include Taskmaster::Henchman
+
+  every 1.hour, :run => :specialty
+
+  def self.specialty
+    # run this one
+  end
+end
+
+class MultiSoldier
+  include Taskmaster::Henchman
+
+  every 1.minute
+  every 1.hour, :run => :specialty
+
+  def self.specialty
+    # run this one
+  end
+
+  def self.run
+    # do something cool
+  end
+end
+
+class SpecificSoldier
+  include Taskmaster::Henchman
+
+  every 1.hour, :at => 20
+
+  def self.run
+    # get beaten up by a superhero
+  end
+end
+
+class CommandSoldier
+  include Taskmaster::Henchman
+
+  every 1.hour, :command => :command
+
+  def self.run
+    # nothing to see here
+  end
+end
+
+class FrequencySoldier
+  include Taskmaster::Henchman
+
+  every 1.hour, :command => :command
+
+  def self.run
+    # nothing to see here
+  end
+end

data/test/helper.rb

@@ -13,7 +13,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'taskmaster'
 
-require './test/foot_soldier'
+require 'classes/foot_soldier'
 
 class Test::Unit::TestCase
 end

data/test/test_henchman.rb

@@ -1,13 +1,38 @@
 require 'helper'
 
-class TestTaskmaster < Test::Unit::TestCase
+class TestHenchman < Test::Unit::TestCase
   def test_class_should_be_definable
     assert_nothing_raised do
       FootSoldier
+      SpecialSoldier
     end
   end
 
-  def test_footsoldier_should_have_expected_cron_output
+  def test_the_base_case_should_work
     assert_equal "0,10,20,30,40,50 * * * * /bin/bash -l -c 'cd /Users/benscofield/personal/util/taskmaster && script/runner -e production '\\''FootSoldier.run'\\'''", FootSoldier.cron_output.strip
   end
+
+  def test_scheduled_methods_should_be_overradble
+    assert_equal "0 * * * * /bin/bash -l -c 'cd /Users/benscofield/personal/util/taskmaster && script/runner -e production '\\''SpecialSoldier.specialty'\\'''", SpecialSoldier.cron_output.strip
+  end
+
+  def test_multiple_tasks_can_live_in_a_class
+    output = MultiSoldier.cron_output.split(/\n+/)
+    assert_equal 2, output.size
+
+    assert_equal "* * * * * /bin/bash -l -c 'cd /Users/benscofield/personal/util/taskmaster && script/runner -e production '\\''MultiSoldier.run'\\'''", output[0]
+    assert_equal "0 * * * * /bin/bash -l -c 'cd /Users/benscofield/personal/util/taskmaster && script/runner -e production '\\''MultiSoldier.specialty'\\'''", output[1]
+  end
+
+  def test_whenever_options_should_be_respected
+    assert_equal "20 * * * * /bin/bash -l -c 'cd /Users/benscofield/personal/util/taskmaster && script/runner -e production '\\''SpecificSoldier.run'\\'''", SpecificSoldier.cron_output.strip
+  end
+
+  def test_different_whenever_commands_should_be_usable
+    assert_equal "0 * * * * /bin/bash -l -c 'CommandSoldier.run'", CommandSoldier.cron_output.strip
+  end
+
+  def test_whenever_alternative_names_should_be_usable
+    assert_equal "0 * * * * /bin/bash -l -c 'FrequencySoldier.run'", FrequencySoldier.cron_output.strip
+  end
 end

data/test/test_taskmaster.rb

@@ -9,6 +9,10 @@ class TestTaskmaster < Test::Unit::TestCase
   end
 
   def test_taskmaster_should_know_all_output
-    assert_equal "0,10,20,30,40,50 * * * * /bin/bash -l -c 'cd /Users/benscofield/personal/util/taskmaster && script/runner -e production '\\''FootSoldier.run'\\'''", Taskmaster.cron_output.strip
+    output = Taskmaster.cron_output.split(/\n+/)
+    assert_equal "0,10,20,30,40,50 * * * * /bin/bash -l -c 'cd /Users/benscofield/personal/util/taskmaster && script/runner -e production '\\''FootSoldier.run'\\'''", output[0]
+    assert_equal "0 * * * * /bin/bash -l -c 'cd /Users/benscofield/personal/util/taskmaster && script/runner -e production '\\''SpecialSoldier.specialty'\\'''", output[1]
+    assert_equal "* * * * * /bin/bash -l -c 'cd /Users/benscofield/personal/util/taskmaster && script/runner -e production '\\''MultiSoldier.run'\\'''", output[2]
+    assert_equal "0 * * * * /bin/bash -l -c 'cd /Users/benscofield/personal/util/taskmaster && script/runner -e production '\\''MultiSoldier.specialty'\\'''", output[3]
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taskmaster
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-16 00:00:00.000000000 -04:00
+date: 2011-06-17 00:00:00.000000000 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: whenever
-  requirement: &2160379820 !ruby/object:Gem::Requirement
+  requirement: &2152144960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,21 +22,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160379820
+  version_requirements: *2152144960
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2160379120 !ruby/object:Gem::Requirement
+  requirement: &2152143680 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160379120
+  version_requirements: *2152143680
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2160377580 !ruby/object:Gem::Requirement
+  requirement: &2152142280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2160377580
+  version_requirements: *2152142280
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2160376300 !ruby/object:Gem::Requirement
+  requirement: &2152140880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *2160376300
+  version_requirements: *2152140880
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2160375040 !ruby/object:Gem::Requirement
+  requirement: &2152139660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160375040
+  version_requirements: *2152139660
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2160373360 !ruby/object:Gem::Requirement
+  requirement: &2152138620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -77,7 +77,7 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *2160373360
+  version_requirements: *2152138620
 description: Taskmaster allows you to easily make your Ruby classes aware of cron.
 email: git@turrean.com
 executables: []
@@ -94,8 +94,11 @@ files:
 - VERSION
 - lib/taskmaster.rb
 - lib/taskmaster/henchman.rb
+- lib/taskmaster/railtie.rb
+- lib/tasks/taskmaster.rake
+- rails/init.rb
 - taskmaster.gemspec
-- test/foot_soldier.rb
+- test/classes/foot_soldier.rb
 - test/helper.rb
 - test/test_henchman.rb
 - test/test_taskmaster.rb
@@ -115,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2376148929927607973
+      hash: -4405291791740595885
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/test/foot_soldier.rb

@@ -1,9 +0,0 @@
-class FootSoldier
-  include Taskmaster::Henchman
-
-  every 10.minutes
-
-  def self.run
-    # get beaten up by a superhero
-  end
-end