crono 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88e53a7c4eee894469cb7980928acb90726d65c9
-  data.tar.gz: b0cf49ee7f5edfb936271d5ba4cb7f71319e156e
+  metadata.gz: 6935e065a4c161dafada3370230b5f00ee0321e3
+  data.tar.gz: d1667f7a5efc7f356bab0ae8b867dd9f6d65e612
 SHA512:
-  metadata.gz: 283289e7b9ef4cb6840d55513cbbce57b3c4773e816957e3e5394646c2920f2c50954abd240302c0d0c8dff2f623bc576d12ef682d6c3624e74f6486a7de8842
-  data.tar.gz: 5c59231c15eb083f7ca341fdf1d0637cb50cd4ceec8cd05f17661ead5aa68507c664a217598cb1ae858b2ff784058b0fae3db760ffd10ab01fa106916460ea23
+  metadata.gz: f727c28c3d2d909fe1a8f12fb26074ca0ce7f574cc4323da62ec638f92514b4e4256b882f81b8685496f6c87ffe0e280e94d8204642c1ca54b6e3d035036819b
+  data.tar.gz: 54aadbd50534a87e59396c020da59ca8efeb04b708a209cf0cf891409034669781ec0ff54899ee0ae7432ecaba96a37a06d061c2942287a07e7e672170e75c63

data/Changes.md

@@ -1,24 +1,35 @@
-0.5.0
+0.8.0
 -----------
 
-- Initial release!
+- Added `on` (day of week) option to cronotab.rb semantic
+- Added job health check and job health indicator to the Web UI
 
-0.5.1
+
+0.7.0
 -----------
 
-- Added -e/--environment ENV option to set the daemon rails environment.
+- Added simple Web UI
+
+
+0.6.1
+-----------
+
+- Persist job state to your database.
+
 
 0.5.2
 -----------
 
 - Fix: Scheduled time now related to the last performing time.
 
-0.6.1
+
+0.5.1
 -----------
 
-- Persist job state to your database.
+- Added -e/--environment ENV option to set the daemon rails environment.
 
-0.7.0
+
+0.5.0
 -----------
 
-- Added simple Web UI
+- Initial release!

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crono (0.7.0)
+    crono (0.8.0)
       activejob (~> 4.0)
       activerecord (~> 4.0)
       activesupport (~> 4.0)
@@ -44,6 +44,8 @@ GEM
     rack (1.6.0)
     rack-protection (1.5.3)
       rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
     rake (10.4.2)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
@@ -64,7 +66,7 @@ GEM
       tilt (~> 1.3, >= 1.3.4)
     slop (3.6.0)
     sqlite3 (1.3.10)
-    thread_safe (0.3.4)
+    thread_safe (0.3.5)
     tilt (1.4.1)
     timecop (0.7.3)
     tzinfo (1.2.2)
@@ -78,6 +80,7 @@ DEPENDENCIES
   byebug
   crono!
   haml
+  rack-test
   rake (~> 10.0)
   rspec (~> 3.0)
   sinatra

data/README.md

@@ -9,12 +9,13 @@ Crono — Job scheduler for Rails
 Crono is a time-based background job scheduler daemon (just like Cron) for Ruby on Rails.
 
 
-## The Idea
+## The Purpose
 
-Currently there is no such thing as Cron in Ruby for Rails. Well, there's [Whenever](https://github.com/javan/whenever) but it works on top of Unix Cron, so you have no total control of it from Ruby. Crono is pure Ruby. It doesn't use Unix Cron and other platform-dependent things. So you can use it on all platforms supported by Ruby. It persists job state to your database using Active Record. You have full control of jobs performing process. You have Ruby code, so you can understand and modify it to fit your needs.
+Currently there is no such thing as Ruby Cron for Rails. Well, there's [Whenever](https://github.com/javan/whenever) but it works on top of Unix Cron, so you haven't control of it from Ruby. Crono is pure Ruby. It doesn't use Unix Cron and other platform-dependent things. So you can use it on all platforms supported by Ruby. It persists job states to your database using Active Record. You have full control of jobs performing process. It's Ruby, so you can understand and modify it to fit your needs.
 
 ![Web UI](https://github.com/plashchynski/crono/raw/master/examples/crono_web_ui.png)
 
+
 ## Requirements
 
 Tested with latest MRI Ruby (2.2, 2.1 and 2.0) and Rails 3.2+  
@@ -73,18 +74,19 @@ end
 
 #### Job Schedule
 
-The schedule described in the configuration file `config/cronotab.rb`, that created using `crono:install` or manually. The semantic is pretty straightforward:
+Schedule list is defined in the file `config/cronotab.rb`, that created using `crono:install`. The semantic is pretty straightforward:
 
 ```ruby
 # config/cronotab.rb
-Crono.perform(TestJob).every 2.days, at: "15:30"
+Crono.perform(TestJob).every 2.days, at: {hour: 15, min: 30}
+Crono.perform(TestJob).every 1.week, on: :monday, at: "15:30"
 ```
 
-You can schedule one job a few times, if you want a job to be performed a few times a day:
+You can schedule one job a few times, if you want the job to be performed a few times a day or a week:
 
 ```ruby
-Crono.perform(TestJob).every 1.day, at: "00:00"
-Crono.perform(TestJob).every 1.day, at: "12:00"
+Crono.perform(TestJob).every 1.week, on: :monday
+Crono.perform(TestJob).every 1.week, on: :thursday
 ```
 
 The `at` can be a Hash:
@@ -109,6 +111,7 @@ Usage: crono [options]
     -e, --environment ENV            Application environment (Default: development)
 ```
 
+
 ## Web UI
 
 Crono comes with a Sinatra application that can display the current state of Crono jobs.  
@@ -122,8 +125,6 @@ gem 'sinatra', require: nil
 Add the following to your `config/routes.rb`:
 
 ```ruby
-require 'crono/web'
-
 Rails.application.routes.draw do
     mount Crono::Web, at: '/crono'
     ...
@@ -131,6 +132,7 @@ Rails.application.routes.draw do
 
 Access management and other questions described in the [wiki](https://github.com/plashchynski/crono/wiki/Web-UI).
 
+
 ## Capistrano
 
 Use the `capistrano-crono` gem ([github](https://github.com/plashchynski/capistrano-crono/)).

data/bin/crono

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
-require "crono/cli"
+require 'crono/cli'
 
 begin
   Crono::CLI.instance.run

data/crono.gemspec

@@ -2,30 +2,31 @@
 require File.expand_path('../lib/crono/version', __FILE__)
 
 Gem::Specification.new do |s|
-  s.name        = "crono"
+  s.name        = 'crono'
   s.version     = Crono::VERSION
-  s.authors     = ["Dzmitry Plashchynski"]
-  s.email       = ["plashchynski@gmail.com"]
-  s.homepage    = "https://github.com/plashchynski/crono"
-  s.description = s.summary = "Job scheduler for Rails"
-  s.license     = "Apache-2.0"
+  s.authors     = ['Dzmitry Plashchynski']
+  s.email       = ['plashchynski@gmail.com']
+  s.homepage    = 'https://github.com/plashchynski/crono'
+  s.description = s.summary = 'Job scheduler for Rails'
+  s.license     = 'Apache-2.0'
 
-  s.required_rubygems_version = ">= 1.3.6"
-  s.rubyforge_project         = "crono"
+  s.required_rubygems_version = '>= 1.3.6'
+  s.rubyforge_project         = 'crono'
 
-  s.add_runtime_dependency      "activejob", "~> 4.0"
-  s.add_runtime_dependency      "activesupport", "~> 4.0"
-  s.add_runtime_dependency      "activerecord", "~> 4.0"
-  s.add_development_dependency  "rake", "~> 10.0"
-  s.add_development_dependency  "bundler", ">= 1.0.0"
-  s.add_development_dependency  "rspec", "~> 3.0"
-  s.add_development_dependency  "timecop", "~> 0.7"
-  s.add_development_dependency  "sqlite3"
-  s.add_development_dependency  "byebug"
-  s.add_development_dependency  "sinatra"
-  s.add_development_dependency  "haml"
+  s.add_runtime_dependency 'activejob', '~> 4.0'
+  s.add_runtime_dependency 'activesupport', '~> 4.0'
+  s.add_runtime_dependency 'activerecord', '~> 4.0'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'bundler', '>= 1.0.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'timecop', '~> 0.7'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'byebug'
+  s.add_development_dependency 'sinatra'
+  s.add_development_dependency 'haml'
+  s.add_development_dependency 'rack-test'
 
   s.files        = `git ls-files`.split("\n")
-  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.executables  = ['crono']
   s.require_path = 'lib'
 end

data/examples/cronotab.rb

@@ -1,4 +1,4 @@
-# cronotab.rb — Crono configuration file
+# cronotab.rb - Crono configuration file
 #
 # Here you can specify periodic jobs and schedule.
 # You can use ActiveJob's jobs from `app/jobs/`
@@ -7,9 +7,8 @@
 #
 class TestJob
   def perform
-    puts "Test!"
+    puts 'Test!'
   end
 end
 
-Crono.perform(TestJob).every 2.days, at: "15:30"
-
+Crono.perform(TestJob).every 2.days, at: '15:30'

data/lib/crono.rb

@@ -1,12 +1,15 @@
+# Crono main module
 module Crono
 end
 
-require "active_support/all"
-require "crono/version.rb"
-require "crono/logging.rb"
-require "crono/period.rb"
-require "crono/job.rb"
-require "crono/scheduler.rb"
-require "crono/config.rb"
-require "crono/performer_proxy.rb"
-require "crono/orm/active_record/crono_job.rb"
+require 'active_support/all'
+require 'crono/version'
+require 'crono/logging'
+require 'crono/period'
+require 'crono/job'
+require 'crono/scheduler'
+require 'crono/config'
+require 'crono/performer_proxy'
+require 'crono/orm/active_record/crono_job'
+
+Crono.autoload :Web, 'crono/web'

data/lib/crono/cli.rb

@@ -4,6 +4,7 @@ require 'optparse'
 module Crono
   mattr_accessor :scheduler
 
+  # Crono::CLI - The main class for the crono daemon exacutable `bin/crono`
   class CLI
     include Singleton
     include Logging
@@ -18,12 +19,7 @@ module Crono
     def run
       parse_options(ARGV)
 
-      if config.daemonize
-        set_log_to(config.logfile)
-        daemonize 
-      else
-        set_log_to(STDOUT)
-      end
+      setup_log
 
       write_pid
       load_rails
@@ -33,7 +29,17 @@ module Crono
       start_working_loop
     end
 
-  private
+    private
+
+    def setup_log
+      if config.daemonize
+        self.logifile = config.logfile
+        daemonize
+      else
+        self.logfile = STDOUT
+      end
+    end
+
     def daemonize
       ::Process.daemon(true, true)
 
@@ -42,7 +48,7 @@ module Crono
         io.sync = true
       end
 
-      $stdin.reopen("/dev/null")
+      $stdin.reopen('/dev/null')
     end
 
     def write_pid
@@ -54,28 +60,28 @@ module Crono
       logger.info "Loading Crono #{Crono::VERSION}"
       logger.info "Running in #{RUBY_DESCRIPTION}"
 
-      logger.info "Jobs:"
+      logger.info 'Jobs:'
       Crono.scheduler.jobs.each do |job|
-        logger.info %{"#{job.performer}" with rule "#{job.period.description}" next time will perform at #{job.next}}
+        logger.info "'#{job.performer}' with rule '#{job.period.description}'"\
+                    "next time will perform at #{job.next}"
       end
     end
 
     def load_rails
       ENV['RACK_ENV'] = ENV['RAILS_ENV'] = config.environment
       require 'rails'
-      require File.expand_path("config/environment.rb")
+      require File.expand_path('config/environment.rb')
       ::Rails.application.eager_load!
       require File.expand_path(config.cronotab)
     end
 
     def check_jobs
-      if Crono.scheduler.jobs.empty?
-        logger.error "You have no jobs defined in you cronotab file #{config.cronotab}"
-      end
+      return if Crono.scheduler.jobs.present?
+      logger.error "You have no jobs in you cronotab file #{config.cronotab}"
     end
 
     def start_working_loop
-      while job = Crono.scheduler.next do
+      while (job = Crono.scheduler.next)
         sleep(job.next - Time.now)
         job.perform
       end

data/lib/crono/config.rb

@@ -1,21 +1,18 @@
 module Crono
+  # Crono::Config stores Crono configuration
   class Config
-    CRONOTAB  = "config/cronotab.rb"
-    LOGFILE   = "log/crono.log"
-    PIDFILE   = "tmp/pids/crono.pid"
+    CRONOTAB  = 'config/cronotab.rb'
+    LOGFILE   = 'log/crono.log'
+    PIDFILE   = 'tmp/pids/crono.pid'
 
-    attr_accessor :cronotab
-    attr_accessor :logfile
-    attr_accessor :pidfile
-    attr_accessor :daemonize
-    attr_accessor :environment
+    attr_accessor :cronotab, :logfile, :pidfile, :daemonize, :environment
 
     def initialize
       self.cronotab = CRONOTAB
       self.logfile  = LOGFILE
       self.pidfile  = PIDFILE
       self.daemonize = false
-      self.environment = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || "development"
+      self.environment = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
     end
   end
 end

data/lib/crono/job.rb

@@ -2,14 +2,12 @@ require 'stringio'
 require 'logger'
 
 module Crono
+  # Crono::Job represents a Crono job
   class Job
     include Logging
 
-    attr_accessor :performer
-    attr_accessor :period
-    attr_accessor :last_performed_at
-    attr_accessor :job_log
-    attr_accessor :job_logger
+    attr_accessor :performer, :period, :last_performed_at, :job_log,
+                  :job_logger, :healthy
 
     def initialize(performer, period)
       self.performer, self.period = performer, period
@@ -35,26 +33,13 @@ module Crono
       log "Perform #{performer}"
       self.last_performed_at = Time.now
 
-      Thread.new do
-        begin
-          performer.new.perform
-        rescue Exception => e
-          log "Finished #{performer} in %.2f seconds with error: #{e.message}" % (Time.now - last_performed_at)
-          log e.backtrace.join("\n")
-        else
-          log "Finished #{performer} in %.2f seconds" % (Time.now - last_performed_at)
-        ensure
-          save
-        end
-      end
+      Thread.new { perform_job }
     end
 
     def save
       @semaphore.synchronize do
-        log = model.reload.log || ""
-        log << job_log.string
-        job_log.truncate(job_log.rewind)
-        model.update(last_performed_at: last_performed_at, log: log)
+        update_model
+        clear_job_log
       end
     end
 
@@ -62,11 +47,50 @@ module Crono
       self.last_performed_at = model.last_performed_at
     end
 
-  private
-    def log(message)
+    private
+
+    def clear_job_log
+      job_log.truncate(job_log.rewind)
+    end
+
+    def update_model
+      saved_log = model.reload.log || ''
+      log_to_save = saved_log + job_log.string
+      model.update(last_performed_at: last_performed_at, log: log_to_save,
+                   healthy: healthy)
+    end
+
+    def perform_job
+      performer.new.perform
+      finished_time_sec = format('%.2f', Time.now - last_performed_at)
+    rescue StandardError => e
+      handle_job_fail(e, finished_time_sec)
+    else
+      handle_job_success(finished_time_sec)
+    ensure
+      save
+    end
+
+    def handle_job_fail(exception, finished_time_sec)
+      self.healthy = false
+      log_error "Finished #{performer} in #{finished_time_sec} seconds"\
+                "with error: #{exception.message}"
+      log_error exception.backtrace.join("\n")
+    end
+
+    def handle_job_success(finished_time_sec)
+      self.healthy = true
+      log "Finished #{performer} in #{finished_time_sec} seconds"
+    end
+
+    def log_error(message)
+      log(message, Logger::ERROR)
+    end
+
+    def log(message, severity = Logger::INFO)
       @semaphore.synchronize do
-        logger.info message
-        job_logger.info message
+        logger.log severity, message
+        job_logger.log severity, message
       end
     end