crono 0.9.0 → 1.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed856eb002fb736ae1834be39c9922b5baf10b74
-  data.tar.gz: bfcdb4932ea5b7aa500499a2ef8b7285b9fcee2c
+  metadata.gz: 6ca8f0a63d98cd7d7906bfeeaa09e07b6bed50fb
+  data.tar.gz: 434e5621f3c326590477872019732b7764711066
 SHA512:
-  metadata.gz: 13921a40dcc6fdd50f2893974c4c1d39b6351902d77adb36d1f760141b77bc26a23bf352901e0770024ebd9932c3d5bc7e6aa0e29ce369137908c43988d241af
-  data.tar.gz: b2e8ba6c1ad40b8ac45a9cd4e3785a07775a259828787032ed33aaa4db8e91190d2ff5012414d2d14f3f8eeaa4293c99ce7d08f6016e0f5a1b3ac60091de5182
+  metadata.gz: 4cbb0f08ecbf361017d75838ba932a2f629fd58df6a7b00c7c0298a5a5e52e02d6e748df27153f2ec1237b6a61c7a061661b3c8b6097908b5afebbfdd2c8d0bc
+  data.tar.gz: a56a8a2686e5b298ffab856847869f6504f07bc6a3e3c849581e3b11819a2cd1a91327984f8422fd367ea75b82b111e7e488f1e378eee80b08a33972278156d9

data/.gitignore

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

data/.travis.yml

@@ -4,8 +4,8 @@ os:
   - osx
 rvm:
   - 2.0.0
-  - 2.1
-  - 2.2
+  - 2.1.7
+  - 2.2.3
 notifications:
   webhooks:
     urls:

data/Changes.md

@@ -1,3 +1,8 @@
+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
 -----------
 

data/Gemfile.lock

@@ -1,64 +1,63 @@
 PATH
   remote: .
   specs:
-    crono (0.9.0)
+    crono (1.0.0.pre2)
       activerecord (~> 4.0)
       activesupport (~> 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.1)
-      activesupport (= 4.2.1)
+    activemodel (4.2.5)
+      activesupport (= 4.2.5)
       builder (~> 3.1)
-    activerecord (4.2.1)
-      activemodel (= 4.2.1)
-      activesupport (= 4.2.1)
+    activerecord (4.2.5)
+      activemodel (= 4.2.5)
+      activesupport (= 4.2.5)
       arel (~> 6.0)
-    activesupport (4.2.1)
+    activesupport (4.2.5)
       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)
+    arel (6.0.3)
     builder (3.2.2)
-    byebug (5.0.0)
-      columnize (= 0.9.0)
-    columnize (0.9.0)
+    byebug (8.2.1)
+    daemons (1.2.3)
     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)
+    json (1.8.3)
+    minitest (5.8.3)
+    rack (1.6.4)
     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 (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
     sinatra (1.4.6)
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
-    sqlite3 (1.3.10)
+    sqlite3 (1.3.11)
     thread_safe (0.3.5)
-    tilt (2.0.1)
-    timecop (0.7.3)
+    tilt (2.0.2)
+    timecop (0.8.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
 
@@ -69,6 +68,7 @@ DEPENDENCIES
   bundler (>= 1.0.0)
   byebug
   crono!
+  daemons
   haml
   rack-test
   rake (~> 10.0)
@@ -76,3 +76,6 @@ DEPENDENCIES
   sinatra
   sqlite3
   timecop (~> 0.7)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -61,11 +61,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 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`:
 
 ```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
@@ -124,6 +124,13 @@ The `at` can be a Hash:
 Crono.perform(TestJob).every 1.day, at: {hour: 12, min: 15}
 ```
 
+You can schedule a job with arguments, which can contain objects that can be
+serialized using JSON.generate
+
+```ruby
+Crono.perform(TestJob, 'some', 'args').every 1.day, at: {hour: 12, min: 15}
+```
+
 #### Run daemon
 
 To run Crono daemon, in your Rails project root directory:
@@ -132,12 +139,13 @@ To run Crono daemon, in your Rails project root directory:
 
 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)
-    -e, --environment ENV            Application environment (Default: development)
+        --piddir PATH                Path to piddir (Default: tmp/pids)
+    -N, --process_name name          Name of the process (Default: crono)
+    -m, --monitor                    Start monitor process for a deamon (Default false)
+    -e, --environment ENV Application environment (Default: development)
 ```
 
 

data/crono.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'haml'
   spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'daemons'
 end

data/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'

data/lib/crono/cli.rb

@@ -7,6 +7,8 @@ module Crono
     include Singleton
     include Logging
 
+    COMMANDS = %w(start stop restart run zap reload status)
+
     attr_accessor :config
 
     def initialize
@@ -16,16 +18,21 @@ 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
+      if config.daemonize
+        start_working_loop_in_daemon
+      else
+        start_working_loop
+      end
     end
 
     private
@@ -33,13 +40,15 @@ module Crono
     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|
@@ -79,6 +88,30 @@ module Crono
       logger.error "You have no jobs in you cronotab file #{config.cronotab}"
     end
 
+    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
       loop do
         next_time, jobs = Crono.scheduler.next_jobs
@@ -88,8 +121,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 +132,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("--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 +157,12 @@ module Crono
         end
       end.parse!(argv)
     end
+
+    def parse_command(argv)
+      if COMMANDS.include? argv[0]
+        config.daemonize = true
+      end
+    end
+
   end
 end

data/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

data/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

data/lib/crono/job.rb

@@ -6,11 +6,13 @@ 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,
+                  :next_performed_at, :job_log, :job_logger, :healthy, :execution_interval
 
-    def initialize(performer, period)
+    def initialize(performer, period, job_args)
+      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.next_performed_at = period.next
@@ -31,6 +33,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 +46,7 @@ module Crono
       @semaphore.synchronize do
         update_model
         clear_job_log
+        ActiveRecord::Base.clear_active_connections!
       end
     end
 
@@ -60,11 +65,11 @@ module Crono
       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)
+                   healthy: healthy, args: job_args)
     end
 
     def perform_job
-      performer.new.perform
+      performer.new.perform *JSON.parse(job_args)
     rescue StandardError => e
       handle_job_fail(e)
     else
@@ -101,5 +106,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

data/lib/crono/performer_proxy.rb

@@ -1,18 +1,25 @@
 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)
+      @scheduler.add_job(@job)
+      self
+    end
+
+    def once_per(execution_interval)
+      @job.execution_interval = execution_interval if @job
+      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

data/lib/crono/period.rb

@@ -4,15 +4,25 @@ 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 +31,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

data/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

data/lib/crono/version.rb

@@ -1,3 +1,3 @@
 module Crono
-  VERSION = '0.9.0'
+  VERSION = '1.0.0.pre2'
 end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crono
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0.pre2
 platform: ruby
 authors:
 - Dzmitry Plashchynski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-29 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: daemons
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A time-based background job scheduler daemon (just like Cron) for Rails
 email:
 - plashchynski@gmail.com
@@ -193,6 +207,7 @@ files:
 - lib/crono/cli.rb
 - lib/crono/config.rb
 - lib/crono/cronotab.rb
+- lib/crono/interval.rb
 - lib/crono/job.rb
 - lib/crono/logging.rb
 - lib/crono/orm/active_record/crono_job.rb
@@ -200,12 +215,14 @@ files:
 - lib/crono/period.rb
 - lib/crono/railtie.rb
 - lib/crono/scheduler.rb
+- lib/crono/time_of_day.rb
 - lib/crono/version.rb
 - lib/crono/web.rb
 - lib/generators/crono/install/install_generator.rb
 - lib/generators/crono/install/templates/cronotab.rb.erb
 - lib/generators/crono/install/templates/migrations/create_crono_jobs.rb
 - lib/tasks/crono_tasks.rake
+- log/.keep
 - tmp/.gitkeep
 - web/assets/css/custom.css
 - web/assets/css/materialize.min.css
@@ -250,12 +267,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Job scheduler for Rails