crono 1.1.0 → 2.0.0

data/lib/crono/job.rb

@@ -9,20 +9,20 @@ module Crono
     attr_accessor :performer, :period, :job_args, :last_performed_at, :job_options,
                   :next_performed_at, :job_log, :job_logger, :healthy, :execution_interval
 
-    def initialize(performer, period, job_args, job_options = {})
+    def initialize(performer, period, job_args, job_options = nil)
       self.execution_interval = 0.minutes
       self.performer, self.period = performer, period
-      self.job_args = JSON.generate(job_args) 
+      self.job_args = JSON.generate(job_args)
       self.job_log = StringIO.new
       self.job_logger = Logger.new(job_log)
-      self.job_options = job_options
+      self.job_options = job_options || {}
       self.next_performed_at = period.next
       @semaphore = Mutex.new
     end
 
     def next
       return next_performed_at if next_performed_at.future?
-      Time.now
+      Time.zone.now
     end
 
     def description
@@ -37,7 +37,7 @@ module Crono
       return Thread.new {} if perform_before_interval?
 
       log "Perform #{performer}"
-      self.last_performed_at = Time.now
+      self.last_performed_at = Time.zone.now
       self.next_performed_at = period.next(since: last_performed_at)
 
       Thread.new { perform_job }
@@ -76,7 +76,11 @@ module Crono
     end
 
     def perform_job
-      performer.new.perform *JSON.parse(job_args)
+      if job_args
+        performer.new.perform(JSON.parse(job_args))
+      else
+        performer.new.perform
+      end
     rescue StandardError => e
       handle_job_fail(e)
     else
@@ -86,7 +90,7 @@ module Crono
     end
 
     def handle_job_fail(exception)
-      finished_time_sec = format('%.2f', Time.now - last_performed_at)
+      finished_time_sec = format('%.2f', Time.zone.now - last_performed_at)
       self.healthy = false
       log_error "Finished #{performer} in #{finished_time_sec} seconds"\
                 " with error: #{exception.message}"
@@ -94,7 +98,7 @@ module Crono
     end
 
     def handle_job_success
-      finished_time_sec = format('%.2f', Time.now - last_performed_at)
+      finished_time_sec = format('%.2f', Time.zone.now - last_performed_at)
       self.healthy = true
       log "Finished #{performer} in #{finished_time_sec} seconds"
     end

data/lib/crono/performer_proxy.rb

@@ -7,8 +7,8 @@ module Crono
       @job_args = job_args
     end
 
-    def every(period, *args)
-      @job = Job.new(@performer, Period.new(period, *args), @job_args, @options)
+    def every(period, **options)
+      @job = Job.new(@performer, Period.new(period, **options), @job_args, @options)
       @scheduler.add_job(@job)
       self
     end

data/lib/crono/period.rb

@@ -27,7 +27,7 @@ module Crono
       @next = @next.beginning_of_week.advance(days: @on) if @on
       @next = @next.change(time_atts)
       return @next if @next.future?
-      Time.now
+      Time.zone.now
     end
 
     def description
@@ -47,8 +47,8 @@ module Crono
     end
 
     def initial_day
-      return Time.now unless @on
-      day = Time.now.beginning_of_week.advance(days: @on)
+      return Time.zone.now unless @on
+      day = Time.zone.now.beginning_of_week.advance(days: @on)
       day = day.change(time_atts)
       return day if day.future?
       @period.from_now.beginning_of_week.advance(days: @on)
@@ -68,7 +68,7 @@ module Crono
 
       case at
       when String
-        time = Time.parse(at)
+        time = Time.zone.parse(at)
         return time.hour, time.min
       when Hash
         return at[:hour], at[:min]
@@ -78,7 +78,8 @@ module Crono
     end
 
     def time_atts
-      { hour: @at_hour, min: @at_min }.compact
+      atts = { hour: @at_hour, min: @at_min }
+      atts.respond_to?(:compact) ? atts.compact : atts.select { |_, value| !value.nil? }
     end
   end
 end

data/lib/crono/time_of_day.rb

@@ -8,8 +8,8 @@ module Crono
     def self.parse(value)
       time =
         case value
-        when String then Time.parse(value).utc
-        when Hash   then Time.now.change(value).utc
+        when String then Time.zone.parse(value).utc
+        when Hash   then Time.zone.now.change(value).utc
         when Time   then value.utc
         else
           fail "Unknown TimeOfDay format: #{value.inspect}"

data/lib/crono/version.rb

@@ -1,3 +1,3 @@
 module Crono
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end

data/lib/crono.rb

@@ -2,8 +2,11 @@
 module Crono
 end
 
+require 'rails'
+require 'sprockets/railtie'
 require 'active_support/all'
 require 'crono/version'
+require 'crono/engine'
 require 'crono/logging'
 require 'crono/period'
 require 'crono/time_of_day'
@@ -13,7 +16,4 @@ require 'crono/scheduler'
 require 'crono/config'
 require 'crono/performer_proxy'
 require 'crono/cronotab'
-require 'crono/orm/active_record/crono_job'
 require 'crono/railtie' if defined?(Rails)
-
-Crono.autoload :Web, 'crono/web'

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

@@ -21,7 +21,18 @@ module Crono
 
       def create_migrations
         migration_template 'migrations/create_crono_jobs.rb',
-                           'db/migrate/create_crono_jobs.rb'
+                           'db/migrate/create_crono_jobs.rb',
+                           migration_version: migration_version
+      end
+
+      def rails5?
+        Rails.version.start_with? '5'
+      end
+
+      def migration_version
+        if rails5?
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
       end
     end
   end

data/lib/generators/crono/install/templates/migrations/create_crono_jobs.rb

@@ -1,16 +1,12 @@
-class CreateCronoJobs < ActiveRecord::Migration
-  def self.up
+class CreateCronoJobs < ActiveRecord::Migration[6.1]
+  def change
     create_table :crono_jobs do |t|
       t.string    :job_id, null: false
-      t.text      :log, limit: 4294967295 # LONGTEXT for MySQL
+      t.text      :log, limit: 1073741823 # LONGTEXT for MySQL
       t.datetime  :last_performed_at
       t.boolean   :healthy
       t.timestamps null: false
     end
     add_index :crono_jobs, [:job_id], unique: true
   end
-
-  def self.down
-    drop_table :crono_jobs
-  end
 end

data/spec/assets/bad_cronotab.rb

@@ -0,0 +1,12 @@
+# This is an example of a bad cronotab for tests
+
+class TestJob
+  def perform
+    puts 'Test!'
+  end
+end
+
+# This is an error, because you can use `on` options with
+# a period less than 7 days.
+
+Crono.perform(TestJob).every 5.days, on: :sunday

data/spec/assets/good_cronotab.rb

@@ -0,0 +1,9 @@
+# This is an example of a good cronotab for tests
+
+class TestJob
+  def perform
+    puts 'Test!'
+  end
+end
+
+Crono.perform(TestJob).every 5.seconds

data/spec/cli_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+require 'crono/cli'
+
+describe Crono::CLI do
+  let(:cli) { Crono::CLI.instance }
+
+  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(:have_jobs?).and_return(true)
+      expect(cli).to receive(:start_working_loop)
+      expect(cli).to receive(:parse_options)
+      expect(cli).to receive(:parse_command)
+      expect(cli).to receive(:write_pid)
+      expect(Crono::Cronotab).to receive(:process)
+      cli.run
+    end
+
+    context 'should run as daemon' do
+      before { cli.config.daemonize = true }
+
+      it 'should initialize rails with #load_rails and start working loop' do
+        expect(cli).to receive(:load_rails)
+        expect(cli).to receive(:have_jobs?).and_return(true)
+        expect(cli).to receive(:start_working_loop_in_daemon)
+        expect(cli).to receive(:parse_options)
+        expect(cli).to receive(:parse_command)
+        expect(cli).not_to receive(:write_pid)
+        expect(Crono::Cronotab).to receive(:process)
+        cli.run
+      end
+    end
+  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'
+    end
+
+    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'
+    end
+
+    it 'should set piddir' do
+      cli.send(:parse_options, ['--piddir', 'tmp/pids'])
+      expect(cli.config.piddir).to be_eql 'tmp/pids'
+    end
+
+    it 'should set process_name' do
+      cli.send(:parse_options, ['--process_name', 'crono0'])
+      expect(cli.config.process_name).to be_eql 'crono0'
+    end
+
+    it 'should set monitor' do
+      cli.send(:parse_options, ['--monitor'])
+      expect(cli.config.monitor).to be true
+    end
+
+    it 'should set environment' do
+      cli.send(:parse_options, ['--environment', 'production'])
+      expect(cli.config.environment).to be_eql('production')
+    end
+  end
+
+  describe '#parse_command' do
+
+    it 'should set daemonize on start' do
+      cli.send(:parse_command, ['start'])
+      expect(cli.config.daemonize).to be true
+    end
+
+    it 'should set daemonize on stop' do
+      cli.send(:parse_command, ['stop'])
+      expect(cli.config.daemonize).to be true
+    end
+
+    it 'should set daemonize on restart' do
+      cli.send(:parse_command, ['restart'])
+      expect(cli.config.daemonize).to be true
+    end
+
+    it 'should set daemonize on run' do
+      cli.send(:parse_command, ['run'])
+      expect(cli.config.daemonize).to be true
+    end
+
+    it 'should set daemonize on zap' do
+      cli.send(:parse_command, ['zap'])
+      expect(cli.config.daemonize).to be true
+    end
+
+    it 'should set daemonize on reload' do
+      cli.send(:parse_command, ['reload'])
+      expect(cli.config.daemonize).to be true
+    end
+
+    it 'should set daemonize on status' do
+      cli.send(:parse_command, ['status'])
+      expect(cli.config.daemonize).to be true
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Crono::Config do
+  let(:config) { Crono::Config.new }
+  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.piddir).to be Crono::Config::PIDDIR
+      expect(@config.process_name).to be Crono::Config::PROCESS_NAME
+      expect(@config.daemonize).to be false
+      expect(@config.monitor).to be false
+      expect(@config.environment).to be_eql ENV['RAILS_ENV']
+    end
+
+    describe "#pidfile" do
+      subject(:pidfile) { config.pidfile }
+
+      context "not explicity configured" do
+        context "daemonize is false" do
+          before { config.daemonize = false }
+
+          specify { expect(pidfile).to be_nil }
+        end
+      end
+
+      context "explicity configured" do
+        let(:path) { "foo/bar/pid.pid" }
+
+        before { config.pidfile = path }
+
+        specify { expect(pidfile).to eq path }
+
+        it "trys to set piddir" do
+          expect(config.piddir).to eq "foo/bar"
+        end
+
+        it "trys to set process_name" do
+          expect(config.process_name).to eq "pid"
+        end
+      end
+
+    end
+  end
+end

data/spec/crono_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Crono do
+  it 'has a version number' do
+    expect(Crono::VERSION).not_to be nil
+  end
+end

data/spec/cronotab_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Crono::Cronotab do
+  describe '#process' do
+    it 'should load cronotab file' do
+      cronotab_path = File.expand_path('../assets/good_cronotab.rb', __FILE__)
+      expect(Crono.scheduler).to receive(:add_job).with(kind_of(Crono::Job))
+      expect {
+        Crono::Cronotab.process(cronotab_path)
+      }.to_not raise_error
+    end
+
+    it 'should raise error when cronotab is invalid' do
+      cronotab_path = File.expand_path('../assets/bad_cronotab.rb', __FILE__)
+      expect {
+        Crono::Cronotab.process(cronotab_path)
+      }.to raise_error
+    end
+  end
+end

data/spec/internal/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/internal/app/controllers/pages_controller.rb

@@ -0,0 +1,5 @@
+class PagesController < ApplicationController
+  def index
+    #
+  end
+end

data/spec/internal/app/views/pages/index.html.erb

@@ -0,0 +1 @@
+<p>Hello World</p>

data/spec/internal/config/application.rb

@@ -0,0 +1,22 @@
+require_relative 'boot'
+
+require 'rails/all'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+require 'crono'
+
+module Dummy
+  class Application < Rails::Application
+    config.load_defaults Rails::VERSION::STRING.to_f
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+  end
+end

data/spec/internal/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require "bundler/setup" if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/crono_test.sqlite

data/spec/internal/config/environment.rb

@@ -0,0 +1,2 @@
+# Load the Rails application.
+require_relative 'application'

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  root 'pages#index'
+end

data/spec/internal/config/storage.yml

@@ -0,0 +1,3 @@
+test:
+  service: Disk
+  root: /Users/chris/Sites/_playground/crono/tmp/storage

data/spec/internal/db/schema.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define do
+  create_table :crono_jobs do |t|
+    t.string    :job_id, null: false
+    t.text      :log, limit: 1_073_741_823 # LONGTEXT for MySQL
+    t.datetime  :last_performed_at
+    t.boolean   :healthy
+    t.timestamps null: false
+  end
+  add_index :crono_jobs, [:job_id], unique: true
+end