rubycron 0.2.5 → 0.3.0

data/README.md

@@ -25,24 +25,26 @@ By default, RubyCron assumes you have a local smtp server running on port 25 in
 
 * ruby-1.8.7-p371 [ i686 ]
 * ruby-1.9.2-p320 [ x86_64 ]
-* ruby-1.9.3-p327 [ x86_64 ]
-* jruby-1.7.3 [ x86_64 ]
+* ruby-1.9.3-p448 [ x86_64 ]
+* ruby-2.0.0-p247 [ x86_64 ]
+* jruby-1.7.4 [ x86_64 ]
 
 ## Usage
 
 ### Configure the basics
 
 Open a new file, require and include RubyCron, and then initialize a new RubyCronJob as follows:
-
+```ruby
 	rcj = RubyCronJob.new( 	:author => 'John Doe',
   							:name   => 'test',
 							:mailto => 'john@doe.com' )
-
+```
 ### Write your cronjob
 
-Call RubyCronJob's execute method, and define your cronjob within the do-end block.
-
+Call RubyCronJob's execute method, and define your cronjob within the do-end block. Use the *info*, *warning* and *error* methods to create your reports.
+```ruby
 	rcj.execute do 
+	  info "Starting run on #{`uname -n`}"
 	  unless File.directory?('/tmp')
 	    warning "Something awry is going on with /tmp."
 	  end
@@ -54,7 +56,7 @@ Call RubyCronJob's execute method, and define your cronjob within the do-end blo
 	    error "Something went wrong trying to write to file: #{e.message}"
 	  end
 	end
-	
+```	
 That's it! Now when you run this cronjob, you will receive a report by email.
 
 ## Set up Cron
@@ -64,7 +66,7 @@ To activate the cronjob, add it to your crontab like any other cronjob. There ar
 ### Stand-alone
 
 For the stand-alone option, add a crontab entry like so:
-	
+
 	min		hour	mday	month	wday	command
 	* 		* 		* 		* 		* 		test.rcj
 
@@ -82,23 +84,23 @@ Simply feed your rubycronjob to rcjrunner.rb as a command-line argument in your
 ### I now get all these reports, but I really only care if the job fails! 
 
 Sorting through hundreds of cron mails per day that report successful runs may be gratifying at times, but most sane people only care to be notified when their cronjobs fail. Not to worry, just add the following line to the RubyCronJob's initialization hash. 
-
+```ruby
 	:mailon	=> :error
-
-RubyCron will now only report when errors occurred during the run. Other options are :none, :warning and :all (default).
+```
+RubyCron will now only report when errors occurred during the run. Other options are *:none*, *:warning* and **:all** (default).
 
 ### All emails originate from root@localhost. Can I change that?
 
 Of course. Use 
-
+```ruby
 	:mailfrom => 'root@doe.com'
-
+```
 to change the From:-header.
 
 ### Do I really have to configure a local smtp server to send mail?
 
 No. You can use other smtp servers for delivery like so:
-
+```ruby
 	smtpsettings = { 	:address              => 'smtp.gmail.com',
             			:port                 => 587,
             			:domain               => 'your.host.name',
@@ -112,58 +114,67 @@ No. You can use other smtp servers for delivery like so:
 						 	:mailto     	=> 'john@doe.com',
 						 	:mailfrom   	=> 'root@doe.com',
 							:smtpsettings 	=> smtpsettings )
-
+```
 ### I want my cronjob to stop running when there are errors.
 
 No problem. You can configure this behavior with
-
+```ruby
 	:exiton	=> :all
-
-Valid values are :none, :warning, :error, :all.
+```
+Valid values are **:none** (default), *:warning*, *:error*, *:all*.
 
 ### Is there a way to manipulate the content of the email reports?
 
 There sure is. Simply write your own ERB template, and tell the RubyCronJob about it with the :template directive.
-
+```ruby
 	rcj = RubyCronJob.new(
 		:author     	=> 'John Doe',
 	 	:name       	=> 'test',
 	 	:mailto     	=> 'john@doe.com',
 	 	:mailfrom   	=> 'root@doe.com',
-		:template 		=> 'my_template.erb' )
-
+		:template 	=> 'my_template.erb' )
+```
 Note that from inside the ERB template (my_template.erb in the above example) you have access to the @warnings and @errors arrays.
 
 ### May I please see some output while I'm developing my cronjob?
 
 Output to stdout and stderr can be very useful when debugging your cronjob. Just set the verbose flag to true:
-
+```ruby
 	:verbose => true
+```
 
-### As a sysadmin, I like grepping through files. Can I have a log file please?
+### Is er there a debug mode?
 
-Yes. Set a file path in RubyCronJob's logfile variable, and all output will be redirected to file:
+Absolutely: 
+```ruby
+	:debug => true
+```
+This is roughly the equivalent of setting :verbose to true and :mailon to :none. It allows you to test your cronjobs without being spammed.
 
-	:logfile => '/tmp/rcjlogfile'
+### As a sysadmin, I like grepping through files. Can I have a log file please?
 
+Yes. Set a file path in RubyCronJob's logfile variable, and all output will be redirected to file:
+```ruby
+	:logfile => '/tmp/rcjlogfile.log'
+```
 Note that you will still receive email reports when you enable file logging. 
 
 ### I like all these different options, but can't I set some of them globally for all my cronjobs?
 
 Anything to prevent redundancy, right? Use the :configfile and :configurl directives to point towards YAML files that hold your configuration hashes. For instance, this works:
-
+```ruby
 	rcj = RubyCronJob.new( :configfile => "my_config_file.yml" )
-
+```
 Or this:
-
+```ruby
 	rcj = RubyCronJob.new( :configurl => "http://www.foo.bar/my_config.yml")
-
+```
 Or even a combination:
-
+```ruby
 	rcj = RubyCronJob.new(  :configfile => "my_config_file.yml",
 							:configurl 	=> "http://www.foo.bar/my_config.yml",
 							:author    	=> 'John Doe' )
-	
+```	
 Note that in the latter case the values of the directives specified within the RubyCronJob itself will take precedence over the file or url directives.
 
 ## License

data/lib/rubycron/main.rb

@@ -13,13 +13,13 @@ module RubyCron
   require 'erb'
   
   attr_accessor :name, :author, :mailto, :mailfrom, :mailsubject, :mailon, :exiton, :template, :smtpsettings, :debug, :logfile, :verbose
-  attr_reader   :warnings, :errors, :report
+  attr_reader   :messages, :warnings, :errors, :report
   
   DEFAULT_SERVER = 'localhost'
   DEFAULT_PORT   = 25
   
     def initialize(args = nil)
-      @warnings, @errors = [], []
+      @messages, @warnings, @errors = [], [], []
       
       case args
         when NilClass then yield self if block_given?
@@ -125,12 +125,19 @@ module RubyCron
       end 
     end
    
-   def produce_summary
-     puts "Run ended at #{@endtime}.\n----"  
-     puts "Number of warnings: #{@warnings.size}" 
-     puts "Number of errors  : #{@errors.size}"
-   end
+    def produce_summary
+      puts "Run ended at #{@endtime}.\n----"  
+      puts "Number of messages: #{@messages.size}"
+      puts "Number of warnings: #{@warnings.size}" 
+      puts "Number of errors  : #{@errors.size}"
+    end
    
+    def message(message)
+      $stderr.puts "[INFO ] #{message}" if self.verbose || self.logfile
+      @messages << message
+    end
+    alias_method :info, :message
+    
     def warning(message)
      $stderr.puts "[WARN ] #{message}" if self.verbose || self.logfile
      @warnings << message

data/lib/rubycron/report.erb

@@ -2,6 +2,12 @@ This is your RubyCron mailer reporting on <%= self.name %>.
 
 There were <%= @warnings.size %> warnings and <%= @errors.size %> errors during the last run, which started at 
 <%= @starttime %> and ended at <%= @endtime %>.
+<% unless @messages.empty? %>
+<%= "These were the informational messages:" %>
+<% @messages.each_with_index do |message, index| %> 
+<%=	index + 1 %>: <%= message %>
+<%=	"============================================================" %>
+<% end %> <% end %>
 <% unless @warnings.empty? %>
 <%= "These were the warnings:" %>
 <% @warnings.each_with_index do |warning, index| %> 

data/lib/rubycron/version.rb

@@ -1,3 +1,3 @@
 module RubyCron
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubycron
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-22 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail