crono 0.7.0 → 0.8.0

data/lib/crono/logging.rb

@@ -1,8 +1,9 @@
 module Crono
   mattr_accessor :logger
 
+  # Crono::Logging is a standart Ruby logger wrapper
   module Logging
-    def set_log_to(logfile)
+    def logfile=(logfile)
       Crono.logger = Logger.new(logfile)
     end
 

data/lib/crono/orm/active_record/crono_job.rb

@@ -1,8 +1,9 @@
 require 'active_record'
 
 module Crono
+  # Crono::CronoJob is a ActiveRecord model to store job state
   class CronoJob < ActiveRecord::Base
-    self.table_name = "crono_jobs"
+    self.table_name = 'crono_jobs'
     validates :job_id, presence: true, uniqueness: true
   end
 end

data/lib/crono/performer_proxy.rb

@@ -1,4 +1,5 @@
 module Crono
+  # Crono::PerformerProxy is a proxy used in cronotab.rb semantic
   class PerformerProxy
     def initialize(performer, scheduler)
       @performer = performer

data/lib/crono/period.rb

@@ -1,27 +1,53 @@
 module Crono
+  # Period describe frequency of performing a task
   class Period
-    def initialize(period, at: nil)
+    DAYS = [:monday, :tuesday, :wednesday, :thursday, :friday, :saturday,
+            :sunday]
+
+    def initialize(period, at: nil, on: nil)
       @period = period
       @at_hour, @at_min = parse_at(at) if at
+      @on = parse_on(on) if on
     end
 
     def next(since: nil)
-      if since.nil?
-        @next = Time.now.change(time_atts)
-        return @next if @next.future?
-        since = Time.now
-      end
-
-      @period.since(since).change(time_atts)
+      return initial_next unless since
+      @next = @period.since(since)
+      @next = @next.beginning_of_week.advance(days: @on) if @on
+      @next.change(time_atts)
     end
 
     def description
       desc = "every #{@period.inspect}"
-      desc += " at %.2i:%.2i" % [@at_hour, @at_min] if @at_hour && @at_min
+      desc += format(' at %.2i:%.2i', @at_hour, @at_min) if @at_hour && @at_min
+      desc += " on #{DAYS[@on].capitalize}" if @on
       desc
     end
 
+    private
+
+    def initial_next
+      next_time = initial_day.change(time_atts)
+      return next_time if next_time.future?
+      @period.from_now.change(time_atts)
+    end
+
+    def initial_day
+      return Time.now unless @on
+      day = Time.now.beginning_of_week.advance(days: @on)
+      return day if day.future?
+      @period.from_now.beginning_of_week.advance(days: @on)
+    end
+
+    def parse_on(on)
+      day_number = DAYS.index(on)
+      fail "Wrong 'on' day" unless day_number
+      fail "period should be at least 1 week to use 'on'" if @period < 1.week
+      day_number
+    end
+
     def parse_at(at)
+      fail "period should be at least 1 day to use 'at'" if @period < 1.day
       case at
       when String
         time = Time.parse(at)
@@ -29,13 +55,12 @@ module Crono
       when Hash
         return at[:hour], at[:min]
       else
-        raise "Unknown 'at' format"
+        fail "Unknown 'at' format"
       end
     end
 
-  private
     def time_atts
-      {hour: @at_hour, min: @at_min}.compact
+      { hour: @at_hour, min: @at_min }.compact
     end
   end
 end

data/lib/crono/scheduler.rb

@@ -1,4 +1,5 @@
 module Crono
+  # Scheduler is a container for job list and queue
   class Scheduler
     attr_accessor :jobs
 
@@ -15,7 +16,8 @@ module Crono
       queue.first
     end
 
-  private
+    private
+
     def queue
       jobs.sort_by(&:next)
     end

data/lib/crono/version.rb

@@ -1,3 +1,3 @@
 module Crono
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/lib/crono/web.rb

@@ -1,18 +1,20 @@
 require 'haml'
 require 'sinatra/base'
+require 'crono'
 
 module Crono
+  # Web is a Web UI Sinatra app
   class Web < Sinatra::Base
-    set :root, File.expand_path(File.dirname(__FILE__) + "/../../web")
-    set :public_folder, Proc.new { "#{root}/assets" }
-    set :views, Proc.new { "#{root}/views" }
+    set :root, File.expand_path(File.dirname(__FILE__) + '/../../web')
+    set :public_folder, proc { "#{root}/assets" }
+    set :views, proc { "#{root}/views" }
 
     get '/' do
       @jobs = Crono::CronoJob.all
       haml :dashboard, format: :html5
     end
 
-    get '/jobs/:id' do
+    get '/job/:id' do
       @job = Crono::CronoJob.find(params[:id])
       haml :job
     end

data/lib/generators/crono/install/install_generator.rb

@@ -4,6 +4,7 @@ require 'rails/generators/active_record'
 
 module Crono
   module Generators
+    # rails generate crono:install
     class InstallGenerator < ::Rails::Generators::Base
       include Rails::Generators::Migration
 
@@ -11,15 +12,16 @@ module Crono
         ActiveRecord::Generators::Base.next_migration_number(path)
       end
 
-      desc "Installs crono and generates the necessary configuration files"
-      source_root File.expand_path("../templates", __FILE__)
+      desc 'Installs crono and generates the necessary configuration files'
+      source_root File.expand_path('../templates', __FILE__)
 
       def copy_config
         template 'cronotab.rb.erb', 'config/cronotab.rb'
       end
 
       def create_migrations
-        migration_template 'migrations/create_crono_jobs.rb', 'db/migrate/create_crono_jobs.rb'
+        migration_template 'migrations/create_crono_jobs.rb',
+                           'db/migrate/create_crono_jobs.rb'
       end
     end
   end

data/lib/generators/crono/install/templates/cronotab.rb.erb

@@ -7,9 +7,9 @@
 #
 # 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/generators/crono/install/templates/migrations/create_crono_jobs.rb

@@ -4,6 +4,7 @@ class CreateCronoJobs < ActiveRecord::Migration
       t.string    :job_id, null: false
       t.text      :log
       t.datetime  :last_performed_at
+      t.boolean   :healthy
       t.timestamps null: false
     end
     add_index :crono_jobs, [:job_id], unique: true

data/spec/cli_spec.rb

@@ -1,15 +1,16 @@
-require "spec_helper"
+require 'spec_helper'
 require 'crono/cli'
 
 class TestJob
-  def perform;end
+  def perform
+  end
 end
 
 describe Crono::CLI do
   let(:cli) { Crono::CLI.instance }
 
-  describe "#run" do
-    it "should try to initialize rails with #load_rails and start working loop" do
+  describe '#run' do
+    it 'should initialize rails with #load_rails and start working loop' do
       expect(cli).to receive(:load_rails)
       expect(cli).to receive(:start_working_loop)
       expect(cli).to receive(:parse_options)
@@ -18,34 +19,30 @@ describe Crono::CLI do
     end
   end
 
-  describe "#start_working_loop" do
-    it "should start working loop"
-  end
-
-  describe "#parse_options" do
-    it "should set cronotab" do
-      cli.send(:parse_options, ["--cronotab", "/tmp/cronotab.rb"])
-      expect(cli.config.cronotab).to be_eql "/tmp/cronotab.rb"
+  describe '#parse_options' do
+    it 'should set cronotab' do
+      cli.send(:parse_options, ['--cronotab', '/tmp/cronotab.rb'])
+      expect(cli.config.cronotab).to be_eql '/tmp/cronotab.rb'
     end
 
-    it "should set logfile" do
-      cli.send(:parse_options, ["--logfile", "log/crono.log"])
-      expect(cli.config.logfile).to be_eql "log/crono.log"
+    it 'should set logfile' do
+      cli.send(:parse_options, ['--logfile', 'log/crono.log'])
+      expect(cli.config.logfile).to be_eql 'log/crono.log'
     end
 
-    it "should set pidfile" do
-      cli.send(:parse_options, ["--pidfile", "tmp/pids/crono.0.log"])
-      expect(cli.config.pidfile).to be_eql "tmp/pids/crono.0.log"
+    it 'should set pidfile' do
+      cli.send(:parse_options, ['--pidfile', 'tmp/pids/crono.0.log'])
+      expect(cli.config.pidfile).to be_eql 'tmp/pids/crono.0.log'
     end
 
-    it "should set daemonize" do
-      cli.send(:parse_options, ["--daemonize"])
+    it 'should set daemonize' do
+      cli.send(:parse_options, ['--daemonize'])
       expect(cli.config.daemonize).to be true
     end
 
-    it "should set environment" do
-      cli.send(:parse_options, ["--environment", "production"])
-      expect(cli.config.environment).to be_eql("production")
+    it 'should set environment' do
+      cli.send(:parse_options, ['--environment', 'production'])
+      expect(cli.config.environment).to be_eql('production')
     end
   end
 end

data/spec/config_spec.rb

@@ -1,15 +1,15 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Crono::Config do
-  describe "#initialize" do
-    it "should initialize with default configuration options" do
-      ENV["RAILS_ENV"] = "test"
+  describe '#initialize' do
+    it 'should initialize with default configuration options' do
+      ENV['RAILS_ENV'] = 'test'
       @config = Crono::Config.new
       expect(@config.cronotab).to be Crono::Config::CRONOTAB
       expect(@config.logfile).to be Crono::Config::LOGFILE
       expect(@config.pidfile).to be Crono::Config::PIDFILE
       expect(@config.daemonize).to be false
-      expect(@config.environment).to be_eql ENV["RAILS_ENV"]
+      expect(@config.environment).to be_eql ENV['RAILS_ENV']
     end
   end
 end

data/spec/job_spec.rb

@@ -1,63 +1,77 @@
-require "spec_helper"
+require 'spec_helper'
 
 class TestJob
-  def perform;end
+  def perform
+  end
 end
 
 class TestFailingJob
   def perform
-    raise "Some error"
+    fail 'Some error'
   end
 end
 
 describe Crono::Job do
   let(:period) { Crono::Period.new(2.day) }
-  let(:job) { Crono::Job.new(TestJob, period) } 
+  let(:job) { Crono::Job.new(TestJob, period) }
   let(:failing_job) { Crono::Job.new(TestFailingJob, period) }
 
-  it "should contain performer and period" do
+  it 'should contain performer and period' do
     expect(job.performer).to be TestJob
     expect(job.period).to be period
   end
 
-  describe "#perform" do
-    it "should run performer in separate thread" do
+  describe '#perform' do
+    after { job.send(:model).destroy }
+
+    it 'should run performer in separate thread' do
       expect(job).to receive(:save)
       thread = job.perform.join
       expect(thread).to be_stop
-      job.send(:model).destroy
     end
 
-    it "should save performin errors to log" do
+    it 'should save performin errors to log' do
       thread = failing_job.perform.join
       expect(thread).to be_stop
       saved_log = Crono::CronoJob.find_by(job_id: failing_job.job_id).log
-      expect(saved_log).to include "Some error"
+      expect(saved_log).to include 'Some error'
+    end
+
+    it 'should set Job#healthy to true if perform ok' do
+      job.perform.join
+      expect(job.healthy).to be true
+    end
+
+    it 'should set Job#healthy to false if perform with error' do
+      failing_job.perform.join
+      expect(failing_job.healthy).to be false
     end
   end
 
-  describe "#description" do
-    it "should return job identificator" do
-      expect(job.description).to be_eql("Perform TestJob every 2 days")
+  describe '#description' do
+    it 'should return job identificator' do
+      expect(job.description).to be_eql('Perform TestJob every 2 days')
     end
   end
 
-  describe "#save" do
-    it "should save new job to DB" do
+  describe '#save' do
+    it 'should save new job to DB' do
       expect(Crono::CronoJob.where(job_id: job.job_id)).to_not exist
       job.save
       expect(Crono::CronoJob.where(job_id: job.job_id)).to exist
     end
 
-    it "should update saved job" do
+    it 'should update saved job' do
       job.last_performed_at = Time.now
+      job.healthy = true
       job.save
       @crono_job = Crono::CronoJob.find_by(job_id: job.job_id)
       expect(@crono_job.last_performed_at.utc.to_s).to be_eql job.last_performed_at.utc.to_s
+      expect(@crono_job.healthy).to be true
     end
 
-    it "should save and truncate job log" do
-      message = "test message"
+    it 'should save and truncate job log' do
+      message = 'test message'
       job.send(:log, message)
       job.save
       expect(job.send(:model).reload.log).to include message
@@ -65,31 +79,39 @@ describe Crono::Job do
     end
   end
 
-  describe "#load" do
+  describe '#load' do
     before do
       @saved_last_performed_at = job.last_performed_at = Time.now
       job.save
     end
 
-    it "should load last_performed_at from DB" do
+    it 'should load last_performed_at from DB' do
       @job = Crono::Job.new(TestJob, period)
       @job.load
       expect(@job.last_performed_at.utc.to_s).to be_eql @saved_last_performed_at.utc.to_s
     end
   end
 
-  describe "#log" do
-    it "should write log messages to both common and job log" do
-      message = "Test message"
-      expect(job.logger).to receive(:info).with(message)
-      expect(job.job_logger).to receive(:info).with(message)
+  describe '#log' do
+    it 'should write log messages to both common and job log' do
+      message = 'Test message'
+      expect(job.logger).to receive(:log).with(Logger::INFO, message)
+      expect(job.job_logger).to receive(:log).with(Logger::INFO, message)
       job.send(:log, message)
     end
 
-    it "should write job log to Job#job_log" do
-      message = "Test message"
+    it 'should write job log to Job#job_log' do
+      message = 'Test message'
       job.send(:log, message)
       expect(job.job_log.string).to include(message)
     end
   end
+
+  describe '#log_error' do
+    it 'should call log with ERROR severity' do
+      message = 'Test message'
+      expect(job).to receive(:log).with(message, Logger::ERROR)
+      job.send(:log_error, message)
+    end
+  end
 end

data/spec/orm/active_record/crono_job_spec.rb

@@ -1,26 +1,26 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Crono::CronoJob do
   let(:valid_attrs) do
     {
-      job_id: "Perform TestJob every 3 days"
+      job_id: 'Perform TestJob every 3 days'
     }
   end
 
-  it "should validate presence of job_id" do
-    @crono_job = Crono::CronoJob.new()
+  it 'should validate presence of job_id' do
+    @crono_job = Crono::CronoJob.new
     expect(@crono_job).not_to be_valid
     expect(@crono_job.errors.added?(:job_id, :blank)).to be true
   end
 
-  it "should validate uniqueness of job_id" do
-    Crono::CronoJob.create!(job_id: "TestJob every 2 days")
-    @crono_job = Crono::CronoJob.create(job_id: "TestJob every 2 days")
+  it 'should validate uniqueness of job_id' do
+    Crono::CronoJob.create!(job_id: 'TestJob every 2 days')
+    @crono_job = Crono::CronoJob.create(job_id: 'TestJob every 2 days')
     expect(@crono_job).not_to be_valid
     expect(@crono_job.errors.added?(:job_id, :taken)).to be true
   end
 
-  it "should save job_id to DB" do
+  it 'should save job_id to DB' do
     Crono::CronoJob.create!(valid_attrs)
     @crono_job = Crono::CronoJob.find_by(job_id: valid_attrs[:job_id])
     expect(@crono_job).to be_present