winever 0.1.0 → 0.1.1

data/README.md

@@ -51,16 +51,17 @@ end
 ```
 
 The pipes (|) are important, so make sure not to remove any.
-If your task doesn't need to be run in the folder of your application (like the existing job_type "command" of Whenever),
+If your job_type doesn't need to be run in the folder of your application (like the existing job_type "command" of Whenever),
 then remove the :path (leaving the pipes around it intact).
 
 As of right now the only type of schedule that is supported are the daily ones (run once per day, at a specific time, every day).
-Pull requests welcomed to add more, cron_entry.rb should be the only file needing edit for that.
+Pull requests welcomed to add more, cron_time.rb and test_cron_time.rb should be the only files needing edit for that.
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Run test (`bundle install` followed by `rake`).
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*/*_test.rb"
+end
+
+
+task :default => [:test]

data/lib/winever.rb

@@ -1,13 +1,19 @@
 require 'winever/version'
 require 'whenever'
 
-# A very tiny monkey patch of whatever, adding a function useable in the schedule to know if this is going through winever.
+# A very tiny monkey patch of Whenever, adding some helper functions in the schedule.
 module Whenever
   class JobList
-    # We are running from winever
+    # We are running from winever? If you need tasks only on your Windows or your Linux servers, you can use #winever?
     def winever?
       Winever::WheneverInterface.run_from_winever?
     end
+
+    # If transitionning to Winever and you already have scheduled tasks that you also want removed when installing
+    # your Winever schedule, you can give their paths to this functions and Winever will take care of it!
+    def remove_existing_tasks *names
+      Winever::WheneverInterface.remove_existing_tasks *names
+    end
   end
 end
 
@@ -15,6 +21,7 @@ end
 module Winever
   autoload :CommandLine, 'winever/command_line'
   autoload :CronEntry, 'winever/cron_entry'
+  autoload :CronTime, 'winever/cron_time'
   autoload :TaskManager, 'winever/task_manager'
   autoload :WheneverInterface, 'winever/whenever_interface'
 end

data/lib/winever/cron_entry.rb

@@ -8,51 +8,27 @@ module Winever
       entries
     end
 
-    def triggers
-      # For now, we don't support anything other than specific time.
-      # But it is possible to handle almost all cron schedule options in the task scheduler of Windows.
-      # It doesn't help that win32-taskscheduler also seems to only support one trigger per task.
-      return [] unless valid_triggers?
-
-      cron_minute, cron_hour, cron_day, cron_month, cron_dow = @cron_time_parts
-      trigger = {
-          :start_year => Date.today.year,
-          :start_month => Date.today.month,
-          :start_day => Date.today.day,
-          :start_hour => cron_hour.to_i,
-          :start_minute => cron_minute.to_i,
-          :trigger_type => Win32::TaskScheduler::TASK_TIME_TRIGGER_DAILY
-      }
-
-      [trigger]
-    end
-
     def initialize(cron_line)
       @cron_line = cron_line
       @cron_parts = cron_line.split("|", 5)
-      @cron_time, @task_folder, @task_name, @working_directory, @parameters = @cron_parts
-      @cron_time_parts = @cron_time.split(/ +/)
+      cron_time_string, @task_folder, @task_name, @working_directory, @parameters = @cron_parts
+      @cron_time = Winever::CronTime.new(cron_time_string)
     end
 
-    def valid?
-      invalid_reason.nil?
+    def triggers
+      @cron_time.triggers
     end
 
-    def valid_triggers?
-      return false if @cron_time_parts.length < 5
-      cron_minute, cron_hour, cron_day, cron_month, cron_dow = @cron_time_parts
-
-      return false if [cron_day, cron_month, cron_dow].detect{|v| v != '*'}
-      return false if [cron_minute, cron_hour].detect{|v| (v =~ /^\d+$/).nil? }
-
-      true
+    def valid?
+      invalid_reason.nil?
     end
 
     def invalid_reason
       return "Doesn't match the Winever format" unless @cron_parts.length == 5
       return "Doesn't have a task_name specified" unless @task_name.present?
-      return "The schedule is either invalid or not supported" unless valid_triggers?
+      return "Problem with schedule: #{@cron_time.unsupported_reason}" unless @cron_time.supported?
       nil
     end
+
   end
 end

data/lib/winever/cron_time.rb

@@ -0,0 +1,44 @@
+module Winever
+  class CronTime
+    attr_accessor :string, :parts, :minute, :hour, :day, :month, :dow
+
+    def initialize cron_time_string
+      @string = cron_time_string
+
+      @parts = Array.new(5, '')
+      string_parts = cron_time_string.split(/ +/)
+      @parts[0...string_parts.size] = string_parts
+
+      @minute, @hour, @day, @month, @dow = @parts
+    end
+
+    def triggers
+      # For now, we don't support anything other than specific time.
+      # But it is possible to handle almost all cron schedule options in the task scheduler of Windows.
+      # It doesn't help that win32-taskscheduler also seems to only support one trigger per task.
+
+      return [] unless supported?
+      trigger = {
+          :start_year => Date.today.year,
+          :start_month => Date.today.month,
+          :start_day => Date.today.day,
+          :start_hour => hour.to_i,
+          :start_minute => minute.to_i,
+          :trigger_type => Win32::TaskScheduler::TASK_TIME_TRIGGER_DAILY
+      }
+
+      [trigger]
+    end
+
+    def supported?
+      unsupported_reason.nil?
+    end
+
+    def unsupported_reason
+      return "Need 5 parts delimited by spaces" if parts.select(&:present?).length != 5
+      return "Only '*' is supported for day, month and day or week parts" if [day, month, dow].detect{|v| v != '*'}
+      return "Only single number is supported for minute and hour parts" if [minute, hour].detect{|v| (v =~ /^\d+$/).nil? }
+      nil
+    end
+  end
+end

data/lib/winever/task_manager.rb

@@ -79,9 +79,11 @@ module Winever
     def clear_tasks_except keep_tasks=[]
       ts = Win32::TaskScheduler.new
       task_names = ts.tasks.select{|tn| tn.end_with?('.' + identifier)}
+      task_names.concat(Winever::WheneverInterface::existing_tasks_to_remove)
+
       task_names = task_names.reject{|tn| keep_tasks.include?(tn)}
 
-      task_names.each{|tn| ts.delete(tn)}
+      task_names.each{|tn| ts.delete(tn) if ts.exists?(tn)}
     end
 
     def create_task cron_entry

data/lib/winever/version.rb

@@ -1,3 +1,3 @@
 module Winever
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/winever/whenever_interface.rb

@@ -4,6 +4,15 @@ module Winever
       @run_from_winever || false
     end
 
+    def self.remove_existing_tasks *names
+      @existing_tasks_to_remove ||= []
+      @existing_tasks_to_remove.concat(names.flatten)
+    end
+
+    def self.existing_tasks_to_remove
+      @existing_tasks_to_remove ||= []
+    end
+
     def self.raw_cron options={}
       # The output of whenever with the custom job_types and job_template.
       options[:file]       ||= 'config/schedule.rb'
@@ -36,6 +45,7 @@ module Winever
     end
 
     def self.cron options={}
+      # Content of a printable cron in internal Winever format. Also displays entry that are not handled and why.
       entries = all_cron_entries(options)
       valid_entries = entries.select(&:valid?)
       invalid_entries = entries.reject(&:valid?)
@@ -56,6 +66,19 @@ module Winever
           output << "#{invalid_entry.cron_line}\n\n"
         end
       end
+
+      if existing_tasks_to_remove.present?
+        if existing_tasks_to_remove.size <= 15
+          output << "\n# Additionnal task names that will be removed if they exist:\n"
+          existing_tasks_to_remove.each do |path|
+            output << "# - #{path}\n"
+          end
+        else
+          output << "\n# Additionnal task names that will be removed if they exist:\n"
+          output << "#  (More than #{15} task names, not displaying.)\n"
+        end
+        output << "\n"
+      end
       output
     end
   end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'winever'
+require 'minitest/autorun'
+require 'minitest/spec'

data/test/unit/cron_time_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+describe Winever::CronTime do
+
+  it "must support daily jobs with single specific time" do
+    Winever::CronTime.new('12 10 * * *').supported?.must_equal true
+  end
+
+  it "must only support 5 time parts" do
+    Winever::CronTime.new('12 10 * *').supported?.must_equal false
+    Winever::CronTime.new('12 10 * * * *').supported?.must_equal false
+  end
+
+  it "must return a trigger" do
+    skip unless windows?
+    Winever::CronTime.new('12 10 * * *').triggers.size.must_equal 1
+  end
+
+  describe "current limitations" do
+    it "doesn't currently support daily jobs without single specific time" do
+      Winever::CronTime.new('12 10,20 * * *').supported?.must_equal false
+      Winever::CronTime.new('*/2 10 * * *').supported?.must_equal false
+    end
+
+    it "doesn't support jobs that are not daily" do
+      Winever::CronTime.new('12 10 1 * *').supported?.must_equal false
+      Winever::CronTime.new('12 10 */2 * *').supported?.must_equal false
+      Winever::CronTime.new('12 10 3,4,5 * *').supported?.must_equal false
+
+      Winever::CronTime.new('12 10 * 1 *').supported?.must_equal false
+      Winever::CronTime.new('12 10 * */2 *').supported?.must_equal false
+      Winever::CronTime.new('12 10 * 3,4,5 *').supported?.must_equal false
+
+      Winever::CronTime.new('12 10 * * 1').supported?.must_equal false
+      Winever::CronTime.new('12 10 * * */2').supported?.must_equal false
+      Winever::CronTime.new('12 10 * * 3,4,5').supported?.must_equal false
+    end
+  end
+
+
+end

data/winever.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Winever::VERSION
   spec.authors       = ["Maxime Handfield Lapointe"]
   spec.email         = ["hunter_spawn@hotmail.com"]
-  spec.description   = %q{Make it possible to use the Whenever gem's clean ruby syntax for writing and deploying tasks in the windows scheduler, using the same schedule file.}
-  spec.summary       = %q{Make it possible to use the Whenever gem on Windows.}
+  spec.description   = %q{Clean ruby syntax for writing and deploying tasks in Windows' task scheduler. Extension of gem whenever.}
+  spec.summary       = %q{Add tasks in Windows' task scheduler from a ruby configuration file.}
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: winever
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: whenever
@@ -75,8 +75,24 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Make it possible to use the Whenever gem's clean ruby syntax for writing
-  and deploying tasks in the windows scheduler, using the same schedule file.
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Clean ruby syntax for writing and deploying tasks in Windows' task scheduler.
+  Extension of gem whenever.
 email:
 - hunter_spawn@hotmail.com
 executables:
@@ -93,10 +109,13 @@ files:
 - lib/winever.rb
 - lib/winever/command_line.rb
 - lib/winever/cron_entry.rb
+- lib/winever/cron_time.rb
 - lib/winever/setup_schedule.rb
 - lib/winever/task_manager.rb
 - lib/winever/version.rb
 - lib/winever/whenever_interface.rb
+- test/test_helper.rb
+- test/unit/cron_time_test.rb
 - winever.gemspec
 homepage: ''
 licenses:
@@ -113,7 +132,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2189449078382166788
+      hash: -1691464168230782844
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -122,11 +141,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2189449078382166788
+      hash: -1691464168230782844
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Make it possible to use the Whenever gem on Windows.
-test_files: []
+summary: Add tasks in Windows' task scheduler from a ruby configuration file.
+test_files:
+- test/test_helper.rb
+- test/unit/cron_time_test.rb