Bump 1.1.0

schedule on: today if at: time not passed

.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+log/*.log
+.byebug_history

.travis.yml

@@ -3,13 +3,12 @@ os:
   - linux
   - osx
 rvm:
-  - 2.0.0
-  - 2.1
-  - 2.2
+  - 2.2.6
+  - 2.3.3
 notifications:
   webhooks:
     urls:
       - https://webhooks.gitter.im/e/907e95dada362be2a13c
     on_success: change  # options: [always|never|change] default: always
     on_failure: always  # options: [always|never|change] default: always
-    on_start: false     # default: false
+    on_start: never     # options: [always|never|change] default: always

Changes.md

@@ -1,3 +1,44 @@
+1.1.0
+-----------
+- Rails 3 and old Rubies are not supported anymore, sorry rails 3 guys...
+- Requires Ruby 2.2.2 or newer
+- Fixed crash when no jobs defined in your cronotab
+- Some doc updates (thanks to @pachacamac)
+- Job will schedule on: today if at: time not passed (thanks to @acolyer)
+- Job log truncating (thanks to @reiz)
+
+
+1.0.3
+-----------
+- "every 1 week" jobs now displaying on Rails 5 as "1 week" not as "7 days"
+- Liberal gem dependencies to support both Rails 4 and Rails 5
+
+
+1.0.2
+-----------
+- Fix table_name_suffix/prefix issue: https://github.com/plashchynski/crono/issues/33
+
+
+1.0.1
+-----------
+- Fix job saving
+
+
+1.0.0
+-----------
+- Rails 5 support (thanks to @adamico)
+- Possibility to schedule jobs with arguments (thanks to @preisanalytics)
+- Added :within option to run only within given time interval (thanks to @lhz)
+- daemon gem support (thanks to @preisanalytics) https://github.com/plashchynski/crono/pull/37
+- Support multiple nodes (thanks to @Natural-Intelligence)
+- Fixed DB connection pool issue (thanks to @ChandravatiSG)
+
+
+0.9.1
+-----------
+- Add ability to define minimal time between job executions to support multiple corno nodes, so two different nodes will not execute the same job
+
+
 0.8.9
 -----------
 

Gemfile.lock

@@ -1,64 +1,60 @@
 PATH
   remote: .
   specs:
-    crono (0.9.0)
-      activerecord (~> 4.0)
-      activesupport (~> 4.0)
+    crono (1.1.0)
+      activerecord (>= 4.0)
+      activesupport (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.1)
-      activesupport (= 4.2.1)
-      builder (~> 3.1)
-    activerecord (4.2.1)
-      activemodel (= 4.2.1)
-      activesupport (= 4.2.1)
-      arel (~> 6.0)
-    activesupport (4.2.1)
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activerecord (5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    arel (6.0.0)
-    builder (3.2.2)
-    byebug (5.0.0)
-      columnize (= 0.9.0)
-    columnize (0.9.0)
+    arel (7.1.4)
+    byebug (9.0.6)
+    concurrent-ruby (1.0.2)
+    daemons (1.2.4)
     diff-lcs (1.2.5)
-    haml (4.0.6)
+    haml (4.0.7)
       tilt
     i18n (0.7.0)
-    json (1.8.2)
-    minitest (5.6.1)
-    rack (1.6.1)
+    minitest (5.9.1)
+    rack (1.6.5)
     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)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.2)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.0)
+    rake (11.3.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
-    sinatra (1.4.6)
-      rack (~> 1.4)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    sinatra (1.4.7)
+      rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
-    sqlite3 (1.3.10)
+    sqlite3 (1.3.12)
     thread_safe (0.3.5)
-    tilt (2.0.1)
-    timecop (0.7.3)
+    tilt (2.0.5)
+    timecop (0.8.1)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
 
@@ -69,10 +65,14 @@ DEPENDENCIES
   bundler (>= 1.0.0)
   byebug
   crono!
+  daemons
   haml
   rack-test
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  rake (>= 10.0)
+  rspec (>= 3.0)
   sinatra
   sqlite3
-  timecop (~> 0.7)
+  timecop (>= 0.7)
+
+BUNDLED WITH
+   1.13.6

README.md

@@ -4,21 +4,20 @@ Crono — Job scheduler for Rails
 [![Build Status](https://travis-ci.org/plashchynski/crono.svg?branch=master)](https://travis-ci.org/plashchynski/crono)
 [![Code Climate](https://codeclimate.com/github/plashchynski/crono/badges/gpa.svg)](https://codeclimate.com/github/plashchynski/crono)
 [![security](https://hakiri.io/github/plashchynski/crono/master.svg)](https://hakiri.io/github/plashchynski/crono/master)
-[![Join the chat at https://gitter.im/plashchynski/crono](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/plashchynski/crono?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Crono is a time-based background job scheduler daemon (just like Cron) for Ruby on Rails.
 
 
 ## The Purpose
 
-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.
+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 can't manage 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+  
+Tested with latest MRI Ruby 2.2+, 2.3+, Rails 4.\*, and Rails 5.\*.
 Other versions are untested but might work fine.
 
 
@@ -47,7 +46,7 @@ Now you are ready to move forward to create a job and schedule it.
 
 #### Create Job
 
-Crono can use Active Job jobs from `app/jobs/`. The only requirements is that the `perform` method should take no arguments.
+Crono can use Active Job jobs from `app/jobs/`. The only requirement is that the `perform` method should take no arguments.
 
 Here's an example of a job:
 
@@ -61,11 +60,11 @@ class TestJob < ActiveJob::Base
 end
 ```
 
-The ActiveJob jobs is convenient because you can use one job in both periodic and enqueued ways. But Active Job is not required. Any class can be used as a crono job if it implements a method `perform` without arguments:
+The ActiveJob jobs are convenient because you can use one job in both periodic and enqueued ways. But Active Job is not required. Any class can be used as a crono job if it implements a method `perform`:
 
 ```ruby
 class TestJob # This is not an Active Job job, but pretty legal Crono job.
-  def perform
+  def perform(*args)
     # put you scheduled code here
     # Comments.deleted.clean_up...
   end
@@ -77,8 +76,8 @@ Here's an example of a Rake Task within a job:
 ```ruby
 # config/cronotab.rb
 require 'rake'
-# Be sure to change AppName to your application name!
-AppName::Application.load_tasks
+
+Rails.app_class.load_tasks
 
 class Test
   def perform
@@ -111,7 +110,7 @@ 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 the job to be performed a few times a day or a week:
+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.week, on: :monday
@@ -124,22 +123,51 @@ The `at` can be a Hash:
 Crono.perform(TestJob).every 1.day, at: {hour: 12, min: 15}
 ```
 
-#### Run daemon
+You can schedule a job with arguments, which can contain objects that can be
+serialized using JSON.generate
 
-To run Crono daemon, in your Rails project root directory:
+```ruby
+Crono.perform(TestJob, 'some', 'args').every 1.day, at: {hour: 12, min: 15}
+```
+
+You can set some options that not passed to the job but affect how the job will be treated by Crono. For example, you can set to truncate job logs (which stored in the database) to a certain number of records:
+
+```ruby
+Crono.perform(TestJob).with_options(truncate_log: 100).every 1.week, on: :monday
+```
+
+#### Run
+
+To run Crono, in your Rails project root directory:
 
     bundle exec crono RAILS_ENV=development
 
 crono usage:
 ```
-Usage: crono [options]
+Usage: crono [options] [start|stop|restart|run]
     -C, --cronotab PATH              Path to cronotab file (Default: config/cronotab.rb)
     -L, --logfile PATH               Path to writable logfile (Default: log/crono.log)
-    -P, --pidfile PATH               Path to pidfile (Default: tmp/pids/crono.pid)
-    -d, --[no-]daemonize             Daemonize process (Default: false)
+    -P, --pidfile PATH               Deprecated! use --piddir with --process_name; Path to pidfile (Default: )
+    -D, --piddir PATH                Path to piddir (Default: tmp/pids)
+    -N, --process_name NAME          Name of the process (Default: crono)
+    -d, --[no-]daemonize             Deprecated! Instead use crono [start|stop|restart] without this option; Daemonize process (Default: false)
+    -m, --monitor                    Start monitor process for a deamon (Default false)
     -e, --environment ENV            Application environment (Default: development)
 ```
 
+#### Run as a daemon
+
+To run Crono as a daemon, please add to your Gemfile:
+
+```ruby
+gem 'daemons'
+```
+
+Then:
+
+    bundle install; bundle exec crono start RAILS_ENV=development
+
+There are "start", "stop", and "restart" commands.
 
 ## Web UI
 
@@ -161,6 +189,14 @@ Rails.application.routes.draw do
 
 Access management and other questions described in the [wiki](https://github.com/plashchynski/crono/wiki/Web-UI).
 
+#### Known issues
+
+For Rails 5, in case of the errors:
+```
+`require': cannot load such file -- rack/showexceptions (LoadError)
+```
+See the related issue [#52](https://github.com/plashchynski/crono/issues/52)
+
 
 ## Capistrano
 
@@ -172,6 +208,11 @@ Use the `capistrano-crono` gem ([github](https://github.com/plashchynski/capistr
 Feel free to create [issues](https://github.com/plashchynski/crono/issues)
 
 
+## Known Issues
+
+* Is not compatible with the `protected_attributes` gem. See: [https://github.com/plashchynski/crono/issues/43](https://github.com/plashchynski/crono/issues/43)
+
+
 ## License
 
 Please see [LICENSE](https://github.com/plashchynski/crono/blob/master/LICENSE) for licensing details.

crono.gemspec

@@ -19,15 +19,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activesupport', '~> 4.0'
-  spec.add_runtime_dependency 'activerecord', '~> 4.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_runtime_dependency 'activesupport', '>= 4.0'
+  spec.add_runtime_dependency 'activerecord', '>= 4.0'
+  spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'bundler', '>= 1.0.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'timecop', '~> 0.7'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'timecop', '>= 0.7'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'haml'
   spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'daemons'
 end

lib/crono.rb

@@ -6,6 +6,8 @@ require 'active_support/all'
 require 'crono/version'
 require 'crono/logging'
 require 'crono/period'
+require 'crono/time_of_day'
+require 'crono/interval'
 require 'crono/job'
 require 'crono/scheduler'
 require 'crono/config'

lib/crono/cli.rb

@@ -1,3 +1,5 @@
+Thread.abort_on_exception = true
+
 require 'crono'
 require 'optparse'
 
@@ -7,6 +9,8 @@ module Crono
     include Singleton
     include Logging
 
+    COMMANDS = %w(start stop restart run zap reload status)
+
     attr_accessor :config
 
     def initialize
@@ -16,30 +20,45 @@ module Crono
 
     def run
       parse_options(ARGV)
+      parse_command(ARGV)
 
-      setup_log
+      setup_log 
 
-      write_pid
+      write_pid unless config.daemonize
       load_rails
       Cronotab.process(File.expand_path(config.cronotab))
       print_banner
 
-      check_jobs
-      start_working_loop
+      unless have_jobs?
+        logger.error "You have no jobs in you cronotab file #{config.cronotab}"
+        return
+      end
+
+      if config.daemonize
+        start_working_loop_in_daemon
+      else
+        start_working_loop
+      end
     end
 
     private
 
+    def have_jobs?
+      Crono.scheduler.jobs.present?
+    end
+
     def setup_log
       if config.daemonize
         self.logfile = config.logfile
-        daemonize
+      elsif config.deprecated_daemonize
+        self.logfile = config.logfile
+        deprecated_daemonize
       else
         self.logfile = STDOUT
       end
     end
 
-    def daemonize
+    def deprecated_daemonize
       ::Process.daemon(true, true)
 
       [$stdout, $stderr].each do |io|
@@ -74,9 +93,28 @@ module Crono
       ::Rails.application.eager_load!
     end
 
-    def check_jobs
-      return if Crono.scheduler.jobs.present?
-      logger.error "You have no jobs in you cronotab file #{config.cronotab}"
+    def start_working_loop_in_daemon
+      unless ENV['RAILS_ENV'] == 'test'
+        begin
+          require 'daemons'
+        rescue LoadError
+          raise "You need to add gem 'daemons' to your Gemfile if you wish to use it."
+        end
+      end
+      Daemons.run_proc(config.process_name, dir: config.piddir, dir_mode: :normal, monitor: config.monitor, ARGV: @argv) do |*_argv|
+        Dir.chdir(root)
+        Crono.logger = Logger.new(config.logfile)
+
+        start_working_loop
+      end
+    end
+
+    def root
+      @root ||= rails_root_defined? ? ::Rails.root : DIR_PWD
+    end
+
+    def rails_root_defined?
+      defined?(::Rails.root)
     end
 
     def start_working_loop
@@ -88,8 +126,8 @@ module Crono
     end
 
     def parse_options(argv)
-      OptionParser.new do |opts|
-        opts.banner = "Usage: crono [options]"
+      @argv = OptionParser.new do |opts|
+        opts.banner = "Usage: crono [options] [start|stop|restart|run]"
 
         opts.on("-C", "--cronotab PATH", "Path to cronotab file (Default: #{config.cronotab})") do |cronotab|
           config.cronotab = cronotab
@@ -99,12 +137,24 @@ module Crono
           config.logfile = logfile
         end
 
-        opts.on("-P", "--pidfile PATH", "Path to pidfile (Default: #{config.pidfile})") do |pidfile|
+        opts.on("-P", "--pidfile PATH", "Deprecated! use --piddir with --process_name; Path to pidfile (Default: #{config.pidfile})") do |pidfile|
           config.pidfile = pidfile
         end
 
-        opts.on("-d", "--[no-]daemonize", "Daemonize process (Default: #{config.daemonize})") do |daemonize|
-          config.daemonize = daemonize
+        opts.on("-D", "--piddir PATH", "Path to piddir (Default: #{config.piddir})") do |piddir|
+          config.piddir = piddir
+        end
+
+        opts.on("-N", "--process_name NAME", "Name of the process (Default: #{config.process_name})") do |process_name|
+          config.process_name = process_name
+        end
+
+        opts.on("-d", "--[no-]daemonize", "Deprecated! Instead use crono [start|stop|restart] without this option; Daemonize process (Default: #{config.daemonize})") do |daemonize|
+          config.deprecated_daemonize = daemonize
+        end
+
+        opts.on("-m", "--monitor", "Start monitor process for a deamon (Default #{config.monitor})") do
+          config.monitor = true
         end
 
         opts.on '-e', '--environment ENV', "Application environment (Default: #{config.environment})" do |env|
@@ -112,5 +162,12 @@ module Crono
         end
       end.parse!(argv)
     end
+
+    def parse_command(argv)
+      if COMMANDS.include? argv[0]
+        config.daemonize = true
+      end
+    end
+
   end
 end

lib/crono/config.rb

@@ -4,18 +4,31 @@ module Crono
     CRONOTAB  = 'config/cronotab.rb'
     LOGFILE   = 'log/crono.log'
     PIDFILE   = 'tmp/pids/crono.pid'
+    PIDDIR    = 'tmp/pids'
+    PROCESS_NAME = 'crono'
 
-    attr_accessor :cronotab, :logfile, :pidfile, :daemonize, :environment
+    attr_accessor :cronotab, :logfile, :pidfile, :piddir, :process_name,
+                  :monitor, :daemonize, :deprecated_daemonize, :environment
 
     def initialize
       self.cronotab = CRONOTAB
       self.logfile  = LOGFILE
+      self.piddir = PIDDIR
+      self.process_name = PROCESS_NAME
       self.daemonize = false
+      self.deprecated_daemonize = false
+      self.monitor = false
       self.environment = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
     end
 
+    def pidfile=(pidfile)
+      @pidfile = pidfile
+      self.process_name = Pathname.new(pidfile).basename(".*").to_s
+      self.piddir = Pathname.new(pidfile).dirname.to_s 
+    end
+
     def pidfile
-      @pidfile || (daemonize ? PIDFILE : nil)
+      @pidfile || (deprecated_daemonize ? PIDFILE : nil)
     end
   end
 end

lib/crono/interval.rb

@@ -0,0 +1,43 @@
+module Crono
+  # Interval describes a period between two specific times of day
+  class Interval
+    attr_accessor :from, :to
+
+    def self.parse(value)
+      from_to =
+        case value
+        when Array  then value
+        when Hash   then value.values_at(:from, :to)
+        when String then value.split('-')
+        else
+          fail "Unknown interval format: #{value.inspect}"
+        end
+      from, to = from_to.map { |v| TimeOfDay.parse(v) }
+      new from, to
+    end
+
+    def initialize(from, to)
+      @from, @to = from, to
+    end
+
+    def within?(value)
+      tod = ((value.is_a? TimeOfDay) ? value : TimeOfDay.parse(value))
+      if @from <= @to
+        tod >= @from && tod < @to
+      else
+        tod >= @from || tod < @to
+      end
+    end
+
+    def next_within(time, period)
+      begin
+        time = period.since(time)
+      end until within? TimeOfDay.parse(time)
+      time
+    end
+
+    def to_s
+      "#{@from}-#{@to}"
+    end
+  end
+end

lib/crono/job.rb

@@ -6,13 +6,16 @@ module Crono
   class Job
     include Logging
 
-    attr_accessor :performer, :period, :last_performed_at,
-                  :next_performed_at, :job_log, :job_logger, :healthy
+    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)
+    def initialize(performer, period, job_args, job_options = {})
+      self.execution_interval = 0.minutes
       self.performer, self.period = performer, period
+      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.next_performed_at = period.next
       @semaphore = Mutex.new
     end
@@ -31,6 +34,8 @@ module Crono
     end
 
     def perform
+      return Thread.new {} if perform_before_interval?
+
       log "Perform #{performer}"
       self.last_performed_at = Time.now
       self.next_performed_at = period.next(since: last_performed_at)
@@ -42,6 +47,7 @@ module Crono
       @semaphore.synchronize do
         update_model
         clear_job_log
+        ActiveRecord::Base.clear_active_connections!
       end
     end
 
@@ -56,15 +62,21 @@ module Crono
       job_log.truncate(job_log.rewind)
     end
 
+    def truncate_log(log)
+      return log.lines.last(job_options[:truncate_log]).join if job_options[:truncate_log]
+      return log
+    end
+
     def update_model
       saved_log = model.reload.log || ''
       log_to_save = saved_log + job_log.string
+      log_to_save = truncate_log(log_to_save)
       model.update(last_performed_at: last_performed_at, log: log_to_save,
                    healthy: healthy)
     end
 
     def perform_job
-      performer.new.perform
+      performer.new.perform *JSON.parse(job_args)
     rescue StandardError => e
       handle_job_fail(e)
     else
@@ -93,7 +105,7 @@ module Crono
 
     def log(message, severity = Logger::INFO)
       @semaphore.synchronize do
-        logger.log severity, message
+        logger.log(severity, message) if logger
         job_logger.log severity, message
       end
     end
@@ -101,5 +113,27 @@ module Crono
     def model
       @model ||= Crono::CronoJob.find_or_create_by(job_id: job_id)
     end
+
+    def perform_before_interval?
+      return false if execution_interval == 0.minutes
+
+      return true if self.last_performed_at.present? && self.last_performed_at > execution_interval.ago
+      return true if model.updated_at.present? && model.created_at != model.updated_at && model.updated_at > execution_interval.ago
+
+      Crono::CronoJob.transaction do
+        job_record = Crono::CronoJob.where(job_id: job_id).lock(true).first
+
+        return true if  job_record.updated_at.present? &&
+                        job_record.updated_at != job_record.created_at &&
+                        job_record.updated_at > execution_interval.ago
+
+        job_record.touch
+
+        return true unless job_record.save
+      end
+
+      # Means that this node is permit to perform the job.
+      return false
+    end
   end
 end

lib/crono/orm/active_record/crono_job.rb

@@ -3,7 +3,6 @@ require 'active_record'
 module Crono
   # Crono::CronoJob is a ActiveRecord model to store job state
   class CronoJob < ActiveRecord::Base
-    self.table_name = 'crono_jobs'
     validates :job_id, presence: true, uniqueness: true
 
     def self.outdated

lib/crono/performer_proxy.rb

@@ -1,18 +1,30 @@
 module Crono
   # Crono::PerformerProxy is a proxy used in cronotab.rb semantic
   class PerformerProxy
-    def initialize(performer, scheduler)
+    def initialize(performer, scheduler, job_args)
       @performer = performer
       @scheduler = scheduler
+      @job_args = job_args
     end
 
     def every(period, *args)
-      job = Job.new(@performer, Period.new(period, *args))
-      @scheduler.add_job(job)
+      @job = Job.new(@performer, Period.new(period, *args), @job_args, @options)
+      @scheduler.add_job(@job)
+      self
+    end
+
+    def once_per(execution_interval)
+      @job.execution_interval = execution_interval if @job
+      self
+    end
+
+    def with_options(options)
+      @options = options
+      self
     end
   end
 
-  def self.perform(performer)
-    PerformerProxy.new(performer, Crono.scheduler)
+  def self.perform(performer, *job_args)
+    PerformerProxy.new(performer, Crono.scheduler, job_args)
   end
 end

lib/crono/period.rb

@@ -4,15 +4,26 @@ module Crono
     DAYS = [:monday, :tuesday, :wednesday, :thursday, :friday, :saturday,
             :sunday]
 
-    def initialize(period, at: nil, on: nil)
+    def initialize(period, at: nil, on: nil, within: nil)
       @period = period
       @at_hour, @at_min = parse_at(at) if at
+      @interval = Interval.parse(within) if within
       @on = parse_on(on) if on
     end
 
     def next(since: nil)
-      return initial_next unless since
-      @next = @period.since(since)
+      if @interval
+        if since
+          @next = @interval.next_within(since, @period)
+        else
+          return initial_next if @interval.within?(initial_next)
+          @next = @interval.next_within(initial_next, @period)
+        end
+      else
+        return initial_next unless since
+        @next = @period.since(since)
+      end
+
       @next = @next.beginning_of_week.advance(days: @on) if @on
       @next = @next.change(time_atts)
       return @next if @next.future?
@@ -21,6 +32,7 @@ module Crono
 
     def description
       desc = "every #{@period.inspect}"
+      desc += " between #{@interval.from} and #{@interval.to} UTC" if @interval
       desc += format(' at %.2i:%.2i', @at_hour, @at_min) if @at_hour && @at_min
       desc += " on #{DAYS[@on].capitalize}" if @on
       desc
@@ -37,6 +49,7 @@ module Crono
     def initial_day
       return Time.now unless @on
       day = Time.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)
     end

lib/crono/time_of_day.rb

@@ -0,0 +1,36 @@
+module Crono
+  # TimeOfDay describes a certain hour and minute (on any day)
+  class TimeOfDay
+    include Comparable
+
+    attr_accessor :hour, :min
+
+    def self.parse(value)
+      time =
+        case value
+        when String then Time.parse(value).utc
+        when Hash   then Time.now.change(value).utc
+        when Time   then value.utc
+        else
+          fail "Unknown TimeOfDay format: #{value.inspect}"
+        end
+      new time.hour, time.min
+    end
+
+    def initialize(hour, min)
+      @hour, @min = hour, min
+    end
+
+    def to_i
+      @hour * 60 + @min
+    end
+
+    def to_s
+      '%02d:%02d' % [@hour, @min]
+    end
+
+    def <=>(other)
+      to_i <=> other.to_i
+    end
+  end
+end

lib/crono/version.rb

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

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

@@ -2,7 +2,7 @@ class CreateCronoJobs < ActiveRecord::Migration
   def self.up
     create_table :crono_jobs do |t|
       t.string    :job_id, null: false
-      t.text      :log
+      t.text      :log, limit: 4294967295 # LONGTEXT for MySQL
       t.datetime  :last_performed_at
       t.boolean   :healthy
       t.timestamps null: false

spec/cli_spec.rb

@@ -7,12 +7,29 @@ describe Crono::CLI 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(: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
@@ -31,9 +48,24 @@ describe Crono::CLI do
       expect(cli.config.pidfile).to be_eql 'tmp/pids/crono.0.log'
     end
 
-    it 'should set daemonize' do
+    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 deprecated_daemonize' do
       cli.send(:parse_options, ['--daemonize'])
-      expect(cli.config.daemonize).to be true
+      expect(cli.config.deprecated_daemonize).to be true
     end
 
     it 'should set environment' do
@@ -41,4 +73,42 @@ describe Crono::CLI do
       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

spec/config_spec.rb

@@ -8,8 +8,11 @@ describe Crono::Config do
       @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 nil
+      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.deprecated_daemonize).to be false
+      expect(@config.monitor).to be false
       expect(@config.environment).to be_eql ENV['RAILS_ENV']
     end
 
@@ -23,8 +26,8 @@ describe Crono::Config do
           specify { expect(pidfile).to be_nil }
         end
 
-        context "daemonize is true" do
-          before { config.daemonize = true }
+        context "deprecated_daemonize is true" do
+          before { config.deprecated_daemonize = true }
 
           specify { expect(pidfile).to eq Crono::Config::PIDFILE }
         end
@@ -36,7 +39,16 @@ describe Crono::Config do
         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

spec/job_spec.rb

@@ -2,14 +2,20 @@ require 'spec_helper'
 
 describe Crono::Job do
   let(:period) { Crono::Period.new(2.day, at: '15:00') }
-  let(:job) { Crono::Job.new(TestJob, period) }
-  let(:failing_job) { Crono::Job.new(TestFailingJob, period) }
+  let(:job_args) {[{some: 'data'}]}
+  let(:job) { Crono::Job.new(TestJob, period, []) }
+  let(:job_with_args) { Crono::Job.new(TestJob, period, job_args) }
+  let(:failing_job) { Crono::Job.new(TestFailingJob, period, []) }
 
   it 'should contain performer and period' do
     expect(job.performer).to be TestJob
     expect(job.period).to be period
   end
 
+  it 'should contain data as JSON String' do
+    expect(job_with_args.job_args).to eq '[{"some":"data"}]'
+  end
+
   describe '#next' do
     it 'should return next performing time according to period' do
       expect(job.next).to be_eql period.next
@@ -36,6 +42,46 @@ describe Crono::Job do
       failing_job.perform.join
       expect(failing_job.healthy).to be false
     end
+
+    it 'should execute one' do
+      job.execution_interval = 5.minutes
+
+      expect(job).to receive(:perform_job).once
+      job.perform.join
+      thread = job.perform.join
+      expect(thread).to be_stop
+    end
+
+    it 'should execute twice' do
+      job.execution_interval = 0.minutes
+
+      test_preform_job_twice
+    end
+
+    it 'should execute twice without initialize execution_interval' do
+      test_preform_job_twice
+    end
+
+    it 'should call perform of performer' do
+      expect(TestJob).to receive(:new).with(no_args)
+      thread = job.perform.join
+      expect(thread).to be_stop
+    end
+
+    it 'should call perform of performer with data' do
+      test_job = double()
+      expect(TestJob).to receive(:new).and_return(test_job)
+      expect(test_job).to receive(:perform).with({'some' => 'data'})
+      thread = job_with_args.perform.join
+      expect(thread).to be_stop
+    end
+
+    def test_preform_job_twice
+      expect(job).to receive(:perform_job).twice
+      job.perform.join
+      thread = job.perform.join
+      expect(thread).to be_stop
+    end
   end
 
   describe '#description' do
@@ -54,19 +100,36 @@ describe Crono::Job do
     it 'should update saved job' do
       job.last_performed_at = Time.now
       job.healthy = true
+      job.job_args = JSON.generate([{some: 'data'}])
       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
+    it 'should save log' do
       message = 'test message'
       job.send(:log, message)
       job.save
       expect(job.send(:model).reload.log).to include message
       expect(job.job_log.string).to be_empty
     end
+
+    it 'should not truncate log if not specified' do
+      log = (1..100).map {|n| "line #{n}" }.join("\n")
+      job = Crono::Job.new(TestJob, period, [])
+      job.send(:log, log)
+      job.save
+      expect(job.send(:model).reload.log.lines.size).to be >= log.lines.size
+    end
+
+    it 'should truncate log if specified' do
+      log = (1..100).map {|n| "line #{n}" }.join("\n")
+      job = Crono::Job.new(TestJob, period, [], truncate_log: 50)
+      job.send(:log, log)
+      job.save
+      expect(job.send(:model).reload.log.lines.size).to be 50
+    end
   end
 
   describe '#load' do
@@ -76,7 +139,7 @@ describe Crono::Job do
     end
 
     it 'should load last_performed_at from DB' do
-      @job = Crono::Job.new(TestJob, period)
+      @job = Crono::Job.new(TestJob, period, job_args)
       @job.load
       expect(@job.last_performed_at.utc.to_s).to be_eql @saved_last_performed_at.utc.to_s
     end
@@ -85,6 +148,7 @@ describe Crono::Job do
   describe '#log' do
     it 'should write log messages to both common and job log' do
       message = 'Test message'
+      job.logfile = "/dev/null"
       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)

spec/performer_proxy_spec.rb

@@ -5,4 +5,29 @@ describe Crono::PerformerProxy do
     expect(Crono.scheduler).to receive(:add_job).with(kind_of(Crono::Job))
     Crono.perform(TestJob).every(2.days, at: '15:30')
   end
+
+  it 'should set execution interval' do
+    allow(Crono).to receive(:scheduler).and_return(Crono::Scheduler.new)
+    expect_any_instance_of(Crono::Job).to receive(:execution_interval=).with(0.minutes).once
+    expect_any_instance_of(Crono::Job).to receive(:execution_interval=).with(10.minutes).once
+    Crono.perform(TestJob).every(2.days, at: '15:30').once_per 10.minutes
+  end
+
+  it 'do nothing when job not initalized' do
+    expect_any_instance_of(Crono::Job).not_to receive(:execution_interval=)
+    expect_any_instance_of(described_class).to receive(:once_per)
+    Crono.perform(TestJob).once_per 10.minutes
+  end
+
+  it 'should add job with args to schedule' do
+    expect(Crono::Job).to receive(:new).with(TestJob, kind_of(Crono::Period), [:some, {some: 'data'}], nil)
+    allow(Crono.scheduler).to receive(:add_job)
+    Crono.perform(TestJob, :some, {some: 'data'}).every(2.days, at: '15:30')
+  end
+
+  it 'should add job with options to schedule' do
+    expect(Crono::Job).to receive(:new).with(TestJob, kind_of(Crono::Period), [], {some_option: true})
+    allow(Crono.scheduler).to receive(:add_job)
+    Crono.perform(TestJob).with_options(some_option: true).every(2.days, at: '15:30')
+  end
 end

spec/period_spec.rb

@@ -4,7 +4,12 @@ describe Crono::Period do
   describe '#description' do
     it 'should return period description' do
       @period = Crono::Period.new(1.week, on: :monday, at: '15:20')
-      expect(@period.description).to be_eql('every 7 days at 15:20 on Monday')
+      expected_description = if ActiveSupport::VERSION::MAJOR >= 5
+          'every 1 week at 15:20 on Monday'
+        else
+          'every 7 days at 15:20 on Monday'
+        end
+      expect(@period.description).to be_eql(expected_description)
     end
   end
 
@@ -44,6 +49,16 @@ describe Crono::Period do
           expect(@period.next).to be_eql(tuesday)
         end
       end
+
+      it 'should return today on the first run if not too late' do
+        @period = Crono::Period.new(1.week, on: :sunday, at: '22:00')
+        Timecop.freeze(Time.now.beginning_of_week.advance(days: 6)
+                           .change(hour: 21, min: 0)) do
+          expect(@period.next).to be_eql(
+            Time.now.beginning_of_week.advance(days: 6).change(hour: 22, min: 0)
+          )
+        end
+      end
     end
 
     context 'in daily basis' do
@@ -61,14 +76,14 @@ describe Crono::Period do
         time = 10.minutes.ago
         at = [time.hour, time.min].join(':')
         @period = Crono::Period.new(2.days, at: at)
-        expect(@period.next).to be_eql(2.days.from_now.change(hour: time.hour, min: time.min))
+        expect(@period.next.to_s).to be_eql(2.days.from_now.change(hour: time.hour, min: time.min).to_s)
       end
 
       it "should set time to 'at' time as a hash" do
         time = 10.minutes.ago
         at = { hour: time.hour, min: time.min }
         @period = Crono::Period.new(2.days, at: at)
-        expect(@period.next).to be_eql(2.days.from_now.change(at))
+        expect(@period.next.to_s).to be_eql(2.days.from_now.change(at).to_s)
       end
 
       it "should raise error when 'at' is wrong" do
@@ -110,6 +125,17 @@ describe Crono::Period do
           expect(@period.next.utc.to_s).to be_eql Time.now.beginning_of_hour.advance(minutes: 15).utc.to_s
         end
       end
+
+      it 'should return next hour minutes within the given interval' do
+        Timecop.freeze(Time.now.change(hour: 16, min: 10)) do
+          @period = Crono::Period.new(1.hour, at: { min: 15 }, within: '08:00-16:00')
+          expect(@period.next.utc.to_s).to be_eql Time.now.tomorrow.change(hour: 8, min: 15).utc.to_s
+        end
+        Timecop.freeze(Time.now.change(hour: 16, min: 10)) do
+          @period = Crono::Period.new(1.hour, at: { min: 15 }, within: '23:00-07:00')
+          expect(@period.next.utc.to_s).to be_eql Time.now.change(hour: 23, min: 15).utc.to_s
+        end
+      end
     end
   end
 end

spec/scheduler_spec.rb

@@ -5,7 +5,7 @@ describe Crono::Scheduler do
 
   describe '#add_job' do
     it 'should call Job#load on Job' do
-      @job = Crono::Job.new(TestJob, Crono::Period.new(10.day, at: '04:05'))
+      @job = Crono::Job.new(TestJob, Crono::Period.new(10.day, at: '04:05'), [])
       expect(@job).to receive(:load)
       scheduler.add_job(@job)
     end
@@ -17,7 +17,7 @@ describe Crono::Scheduler do
         Crono::Period.new(3.days, at: 10.minutes.from_now.strftime('%H:%M')),
         Crono::Period.new(1.day, at: 20.minutes.from_now.strftime('%H:%M')),
         Crono::Period.new(7.days, at: 40.minutes.from_now.strftime('%H:%M'))
-      ].map { |period| Crono::Job.new(TestJob, period) }
+      ].map { |period| Crono::Job.new(TestJob, period, []) }
 
       time, jobs = scheduler.next_jobs
       expect(jobs).to be_eql [jobs[0]]
@@ -29,7 +29,7 @@ describe Crono::Scheduler do
         Crono::Period.new(1.day, at: time.strftime('%H:%M')),
         Crono::Period.new(1.day, at: time.strftime('%H:%M')),
         Crono::Period.new(1.day, at: 10.minutes.from_now.strftime('%H:%M'))
-      ].map { |period| Crono::Job.new(TestJob, period) }
+      ].map { |period| Crono::Job.new(TestJob, period, []) }
 
       time, jobs = scheduler.next_jobs
       expect(jobs).to be_eql [jobs[0], jobs[1]]
@@ -40,7 +40,7 @@ describe Crono::Scheduler do
         Crono::Period.new(10.seconds),
         Crono::Period.new(10.seconds),
         Crono::Period.new(1.day, at: 10.minutes.from_now.strftime('%H:%M'))
-      ].map { |period| Crono::Job.new(TestJob, period) }
+      ].map { |period| Crono::Job.new(TestJob, period, []) }
 
       _, next_jobs = scheduler.next_jobs
       expect(next_jobs).to be_eql [jobs[0]]