whenever 0.9.2 → 0.10.0

data/test/unit/executable_test.rb

@@ -0,0 +1,142 @@
+require 'test_helper'
+
+describe 'Executable' do
+  describe 'bin/wheneverize' do
+    describe 'ARGV is not empty' do
+      describe 'file does not exist' do
+        file = '/tmp/this_does_not_exist'
+
+        it 'prints STDERR' do
+          out, err = capture_subprocess_io do
+            system('wheneverize', file)
+          end
+
+          assert_empty(out)
+          assert_match(/`#{file}' does not exist./, err)
+        end
+      end
+
+      describe 'file exists, but not a directory' do
+        file = '/tmp/this_is_a_file.txt'
+        before { FileUtils.touch(file) }
+
+        it 'prints STDERR' do
+          begin
+            out, err = capture_subprocess_io do
+              system('wheneverize', file)
+            end
+
+            assert_empty(out)
+            assert_match(/`#{file}' is not a directory./, err)
+          ensure
+            FileUtils.rm(file)
+          end
+        end
+      end
+
+      describe 'file is a directory, but another param(s) are given as well' do
+        file = '/tmp/this_is_a_directory'
+        before { FileUtils.mkdir(file) }
+
+        it 'prints STDERR' do
+          begin
+            out, err = capture_subprocess_io do
+              system('wheneverize', file, 'another', 'parameters')
+            end
+
+            assert_empty(out)
+            assert_match(/#{"Too many arguments; please specify only the " \
+                         "directory to wheneverize."}/, err)
+          ensure
+            FileUtils.rmdir(file)
+          end
+        end
+      end
+    end
+
+    describe 'ARGV is empty' do
+      dir  = '.'
+      file = 'config/schedule.rb'
+      path = File.join(dir, file)
+
+      describe 'config file already exists' do
+        before do
+          FileUtils.mkdir(File.dirname(path))
+          FileUtils.touch(path)
+        end
+
+        it 'prints STDOUT and STDERR' do
+          begin
+            out, err = capture_subprocess_io do
+              system('wheneverize')
+            end
+
+            assert_match(/\[done\] wheneverized!/, out)
+            assert_match(/\[skip\] `#{path}' already exists/, err)
+          ensure
+            FileUtils.rm_rf(File.dirname(path))
+          end
+        end
+      end
+
+      describe 'config directory does not exist' do
+        it 'prints STDOUT and STDERR' do
+          begin
+            out, err = capture_subprocess_io do
+              system('wheneverize')
+            end
+
+            assert_match(/\[add\] creating `#{File.dirname(path)}'\n/, err)
+            assert_match(/\[done\] wheneverized!/, out)
+          ensure
+            FileUtils.rm_rf(File.dirname(path))
+          end
+        end
+      end
+
+      describe 'config directory exists, but file does not' do
+        before { FileUtils.mkdir(File.dirname(path)) }
+
+        it 'writes config file and prints STDOUT' do
+          begin
+            out, err = capture_subprocess_io do
+              system('wheneverize')
+            end
+
+            assert_empty(err)
+            assert_match(
+              /\[add\] writing `#{path}'\n\[done\] wheneverized!/,
+              out
+            )
+
+            assert_match((<<-FILE
+# Use this file to easily define all of your cron jobs.
+#
+# It's helpful, but not entirely necessary to understand cron before proceeding.
+# http://en.wikipedia.org/wiki/Cron
+
+# Example:
+#
+# set :output, "/path/to/my/cron_log.log"
+#
+# every 2.hours do
+#   command "/usr/bin/some_great_command"
+#   runner "MyModel.some_method"
+#   rake "some:great:rake:task"
+# end
+#
+# every 4.days do
+#   runner "AnotherModel.prune_old_records"
+# end
+
+# Learn more: http://github.com/javan/whenever
+FILE
+                         ), IO.read(path))
+          ensure
+            FileUtils.rm_rf(File.dirname(path))
+          end
+        end
+      end
+    end
+  end
+end

data/test/unit/job_test.rb

@@ -1,124 +1,114 @@
-require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
-
-class JobTest < Test::Unit::TestCase
-
-  context "A Job" do
-    should "return the :at set when #at is called" do
-      assert_equal 'foo', new_job(:at => 'foo').at
-    end
-
-    should "return the :roles set when #roles is called" do
-      assert_equal ['foo', 'bar'], new_job(:roles => ['foo', 'bar']).roles
-    end
-
-    should "return whether it has a role from #has_role?" do
-      assert new_job(:roles => 'foo').has_role?('foo')
-      assert_equal false, new_job(:roles => 'bar').has_role?('foo')
-    end
-
-    should "substitute the :task when #output is called" do
-      job = new_job(:template => ":task", :task => 'abc123')
-      assert_equal 'abc123', job.output
-    end
-
-    should "substitute the :path when #output is called" do
-      assert_equal 'foo', new_job(:template => ':path', :path => 'foo').output
-    end
-
-    should "substitute the :path with the default Whenever.path if none is provided when #output is called" do
-      Whenever.expects(:path).returns('/my/path')
-      assert_equal '/my/path', new_job(:template => ':path').output
-    end
-
-    should "not substitute parameters for which no value is set" do
-      assert_equal 'Hello :world', new_job(:template => ':matching :world', :matching => 'Hello').output
-    end
-
-    should "escape the :path" do
-      assert_equal '/my/spacey\ path', new_job(:template => ':path', :path => '/my/spacey path').output
-    end
-
-    should "escape percent signs" do
-      job = new_job(
-        :template => "before :foo after",
-        :foo => "percent -> % <- percent"
-      )
-      assert_equal %q(before percent -> \% <- percent after), job.output
-    end
-
-    should "assume percent signs are not already escaped" do
-      job = new_job(
-        :template => "before :foo after",
-        :foo => %q(percent preceded by a backslash -> \% <-)
-      )
-      assert_equal %q(before percent preceded by a backslash -> \\\% <- after), job.output
-    end
-
-    should "squish spaces and newlines" do
-      job = new_job(
-        :template => "before :foo after",
-        :foo => "newline -> \n <- newline space ->     <- space"
-      )
-
-      assert_equal "before newline -> <- newline space -> <- space after", job.output
-    end
-  end
-
-
-  context "A Job with quotes" do
-    should "output the :task if it's in single quotes" do
-      job = new_job(:template => "':task'", :task => 'abc123')
-      assert_equal %q('abc123'), job.output
-    end
-
-    should "output the :task if it's in double quotes" do
-      job = new_job(:template => '":task"', :task => 'abc123')
-      assert_equal %q("abc123"), job.output
-    end
-
-    should "output escaped single quotes in when it's wrapped in them" do
-      job = new_job(
-        :template => "before ':foo' after",
-        :foo => "quote -> ' <- quote"
-      )
-      assert_equal %q(before 'quote -> '\'' <- quote' after), job.output
-    end
-
-    should "output escaped double quotes when it's wrapped in them" do
-      job = new_job(
-        :template => 'before ":foo" after',
-        :foo => 'quote -> " <- quote'
-      )
-      assert_equal %q(before "quote -> \" <- quote" after), job.output
-    end
-  end
-
-  context "A Job with a job_template" do
-    should "use the job template" do
-      job = new_job(:template => ':task', :task => 'abc123', :job_template => 'left :job right')
-      assert_equal 'left abc123 right', job.output
-    end
-
-    should "reuse parameter in the job template" do
-      job = new_job(:template => ':path :task', :path => 'path', :task => "abc123", :job_template => ':path left :job right')
-      assert_equal 'path left path abc123 right', job.output
-    end
-
-    should "escape single quotes" do
-      job = new_job(:template => "before ':task' after", :task => "quote -> ' <- quote", :job_template => "left ':job' right")
-      assert_equal %q(left 'before '\''quote -> '\\''\\'\\'''\\'' <- quote'\'' after' right), job.output
-    end
-
-    should "escape double quotes" do
-      job = new_job(:template => 'before ":task" after', :task => 'quote -> " <- quote', :job_template => 'left ":job" right')
-      assert_equal %q(left "before \"quote -> \\\" <- quote\" after" right), job.output
-    end
-  end
-
-private
-
-  def new_job(options={})
-    Whenever::Job.new(options)
+require 'test_helper'
+
+class JobTest < Whenever::TestCase
+  should "return the :at set when #at is called" do
+    assert_equal 'foo', new_job(:at => 'foo').at
+  end
+
+  should "return the :roles set when #roles is called" do
+    assert_equal ['foo', 'bar'], new_job(:roles => ['foo', 'bar']).roles
+  end
+
+  should "return whether it has a role from #has_role?" do
+    assert new_job(:roles => 'foo').has_role?('foo')
+    assert_equal false, new_job(:roles => 'bar').has_role?('foo')
+  end
+
+  should "substitute the :task when #output is called" do
+    job = new_job(:template => ":task", :task => 'abc123')
+    assert_equal 'abc123', job.output
+  end
+
+  should "substitute the :path when #output is called" do
+    assert_equal 'foo', new_job(:template => ':path', :path => 'foo').output
+  end
+
+  should "substitute the :path with the default Whenever.path if none is provided when #output is called" do
+    Whenever.expects(:path).returns('/my/path')
+    assert_equal '/my/path', new_job(:template => ':path').output
+  end
+
+  should "not substitute parameters for which no value is set" do
+    assert_equal 'Hello :world', new_job(:template => ':matching :world', :matching => 'Hello').output
+  end
+
+  should "escape the :path" do
+    assert_equal '/my/spacey\ path', new_job(:template => ':path', :path => '/my/spacey path').output
+  end
+
+  should "escape percent signs" do
+    job = new_job(
+      :template => "before :foo after",
+      :foo => "percent -> % <- percent"
+    )
+    assert_equal %q(before percent -> \% <- percent after), job.output
+  end
+
+  should "assume percent signs are not already escaped" do
+    job = new_job(
+      :template => "before :foo after",
+      :foo => %q(percent preceded by a backslash -> \% <-)
+    )
+    assert_equal %q(before percent preceded by a backslash -> \\\% <- after), job.output
+  end
+
+  should "squish spaces and newlines" do
+    job = new_job(
+      :template => "before :foo after",
+      :foo => "newline -> \n <- newline space ->     <- space"
+    )
+
+    assert_equal "before newline -> <- newline space -> <- space after", job.output
+  end
+end
+
+
+class JobWithQuotesTest < Whenever::TestCase
+  should "output the :task if it's in single quotes" do
+    job = new_job(:template => "':task'", :task => 'abc123')
+    assert_equal %q('abc123'), job.output
+  end
+
+  should "output the :task if it's in double quotes" do
+    job = new_job(:template => '":task"', :task => 'abc123')
+    assert_equal %q("abc123"), job.output
+  end
+
+  should "output escaped single quotes in when it's wrapped in them" do
+    job = new_job(
+      :template => "before ':foo' after",
+      :foo => "quote -> ' <- quote"
+    )
+    assert_equal %q(before 'quote -> '\'' <- quote' after), job.output
   end
 
+  should "output escaped double quotes when it's wrapped in them" do
+    job = new_job(
+      :template => 'before ":foo" after',
+      :foo => 'quote -> " <- quote'
+    )
+    assert_equal %q(before "quote -> \" <- quote" after), job.output
+  end
+end
+
+class JobWithJobTemplateTest < Whenever::TestCase
+  should "use the job template" do
+    job = new_job(:template => ':task', :task => 'abc123', :job_template => 'left :job right')
+    assert_equal 'left abc123 right', job.output
+  end
+
+  should "reuse parameter in the job template" do
+    job = new_job(:template => ':path :task', :path => 'path', :task => "abc123", :job_template => ':path left :job right')
+    assert_equal 'path left path abc123 right', job.output
+  end
+
+  should "escape single quotes" do
+    job = new_job(:template => "before ':task' after", :task => "quote -> ' <- quote", :job_template => "left ':job' right")
+    assert_equal %q(left 'before '\''quote -> '\\''\\'\\'''\\'' <- quote'\'' after' right), job.output
+  end
+
+  should "escape double quotes" do
+    job = new_job(:template => 'before ":task" after', :task => 'quote -> " <- quote', :job_template => 'left ":job" right')
+    assert_equal %q(left "before \"quote -> \\\" <- quote\" after" right), job.output
+  end
 end

data/whenever.gemspec

@@ -9,18 +9,19 @@ Gem::Specification.new do |s|
   s.authors     = ["Javan Makhmali"]
   s.email       = ["javan@javan.us"]
   s.license     = "MIT"
-  s.homepage    = ""
+  s.homepage    = "https://github.com/javan/whenever"
   s.summary     = %q{Cron jobs in ruby.}
   s.description = %q{Clean ruby syntax for writing and deploying cron jobs.}
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/{functional,unit}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  s.required_ruby_version = ">= 1.9.3"
 
   s.add_dependency "chronic", ">= 0.6.3"
-  s.add_dependency "activesupport", ">= 2.3.4"
 
-  s.add_development_dependency "shoulda", ">= 2.1.1"
-  s.add_development_dependency "mocha", ">= 0.9.5"
+  s.add_development_dependency "bundler"
   s.add_development_dependency "rake"
+  s.add_development_dependency "mocha", ">= 0.9.5"
+  s.add_development_dependency "minitest"
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: whenever
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Javan Makhmali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-04 00:00:00.000000000 Z
+date: 2017-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.3
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.4
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.5
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Clean ruby syntax for writing and deploying cron jobs.
@@ -89,8 +89,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -98,6 +98,8 @@ files:
 - Rakefile
 - bin/whenever
 - bin/wheneverize
+- gemfiles/activesupport4.1.gemfile
+- gemfiles/activesupport4.2.gemfile
 - lib/whenever.rb
 - lib/whenever/capistrano.rb
 - lib/whenever/capistrano/v2/hooks.rb
@@ -108,9 +110,11 @@ files:
 - lib/whenever/cron.rb
 - lib/whenever/job.rb
 - lib/whenever/job_list.rb
+- lib/whenever/numeric.rb
+- lib/whenever/numeric_seconds.rb
+- lib/whenever/os.rb
 - lib/whenever/output_redirection.rb
 - lib/whenever/setup.rb
-- lib/whenever/tasks/whenever.rake
 - lib/whenever/version.rb
 - test/functional/command_line_test.rb
 - test/functional/output_at_test.rb
@@ -118,13 +122,16 @@ files:
 - test/functional/output_defined_job_test.rb
 - test/functional/output_env_test.rb
 - test/functional/output_jobs_for_roles_test.rb
+- test/functional/output_jobs_with_mailto_test.rb
 - test/functional/output_redirection_test.rb
+- test/test_case.rb
 - test/test_helper.rb
 - test/unit/capistrano_support_test.rb
 - test/unit/cron_test.rb
+- test/unit/executable_test.rb
 - test/unit/job_test.rb
 - whenever.gemspec
-homepage: ''
+homepage: https://github.com/javan/whenever
 licenses:
 - MIT
 metadata: {}
@@ -134,17 +141,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Cron jobs in ruby.
@@ -155,7 +162,9 @@ test_files:
 - test/functional/output_defined_job_test.rb
 - test/functional/output_env_test.rb
 - test/functional/output_jobs_for_roles_test.rb
+- test/functional/output_jobs_with_mailto_test.rb
 - test/functional/output_redirection_test.rb
 - test/unit/capistrano_support_test.rb
 - test/unit/cron_test.rb
+- test/unit/executable_test.rb
 - test/unit/job_test.rb

data/lib/whenever/tasks/whenever.rake

@@ -1,43 +0,0 @@
-namespace :whenever do
-  def setup_whenever_task(*args, &block)
-    args = Array(fetch(:whenever_command)) + args
-
-    on roles fetch(:whenever_roles) do |host|
-      host_args = Array(yield(host))
-      within release_path do
-        with fetch(:whenever_command_environment_variables) do
-          execute *(args + host_args)
-        end
-      end
-    end
-  end
-
-  desc "Update application's crontab entries using Whenever"
-  task :update_crontab do
-    setup_whenever_task do |host|
-      roles = host.roles_array.join(",")
-      [fetch(:whenever_update_flags),  "--roles=#{roles}"]
-    end
-  end
-
-  desc "Clear application's crontab entries using Whenever"
-  task :clear_crontab do
-    setup_whenever_task(fetch(:whenever_clear_flags))
-  end
-
-  after "deploy:updated",  "whenever:update_crontab"
-  after "deploy:reverted", "whenever:update_crontab"
-end
-
-namespace :load do
-  task :defaults do
-    set :whenever_roles,        ->{ :db }
-    set :whenever_command,      ->{ [:bundle, :exec, :whenever] }
-    set :whenever_command_environment_variables, ->{ {} }
-    set :whenever_identifier,   ->{ fetch :application }
-    set :whenever_environment,  ->{ fetch :rails_env, "production" }
-    set :whenever_variables,    ->{ "environment=#{fetch :whenever_environment}" }
-    set :whenever_update_flags, ->{ "--update-crontab #{fetch :whenever_identifier} --set #{fetch :whenever_variables}" }
-    set :whenever_clear_flags,  ->{ "--clear-crontab #{fetch :whenever_identifier}" }
-  end
-end