crono 0.5.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d44592e0e575b43cbfbc08ae70a3ba2b48fe4c56
-  data.tar.gz: f7155bff1058414b3772e008a497e5932e1117f1
+  metadata.gz: 64a9cf0a8dfbbb07d720a55e4e8d00fdcf38d792
+  data.tar.gz: b17baffc9f7f8c8c20ea747ff95003cffc2c0593
 SHA512:
-  metadata.gz: cc7a404b38391f25500e7ac662e06426d7bd9129c8911bc909a82262f4d231a824852b33a30f4a52ae58503c7e6ec7eacddd27a3379d1292de0bc61ab5cb5dd9
-  data.tar.gz: 6c101c91fc475b626baacd442725cdd7bd55b86b6e77c5d3cf3bbfa312062fa0931215ba683cb593c7ec9371972657d0968144f37e9a355f89c95f4a4adbbe40
+  metadata.gz: e660b9fc13581744848bfa9efcd70d2350c3f97741118f0b29c15b6c544c2f164fab47324d1bd937ecccf0d2e8426bf344d4b521f9e41236da00b8cb19a38d63
+  data.tar.gz: b85e7a57c38a82db19827206dc93bc30033107f21b21857d9ef460472b437f54360f761891b268d7549fd002b5e92363e210a950d2a1c434b87b9c326543ae3d

data/Changes.md

@@ -4,11 +4,16 @@
 - Initial release!
 
 0.5.1
-———————————
+-----------
 
 - Added -e/--environment ENV option to set the daemon rails environment.
 
 0.5.2
-———————————
+-----------
+
+- Fix: Scheduled time now related to the last performing time.
+
+0.6.1
+-----------
 
-- Fix: Scheduled time now related to the last performing time.
+- Persist job state to your database.

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    crono (0.5.1)
+    crono (0.6.1)
       activejob (~> 4.0)
+      activerecord (~> 4.0)
       activesupport (~> 4.0)
 
 GEM
@@ -11,12 +12,21 @@ GEM
     activejob (4.2.0)
       activesupport (= 4.2.0)
       globalid (>= 0.3.0)
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activerecord (4.2.0)
+      activemodel (= 4.2.0)
+      activesupport (= 4.2.0)
+      arel (~> 6.0)
     activesupport (4.2.0)
       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)
     diff-lcs (1.2.5)
     globalid (0.3.3)
       activesupport (>= 4.1.0)
@@ -37,6 +47,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
     rspec-support (3.2.2)
+    sqlite3 (1.3.10)
     thread_safe (0.3.4)
     timecop (0.7.3)
     tzinfo (1.2.2)
@@ -50,4 +61,5 @@ DEPENDENCIES
   crono!
   rake (~> 10.0)
   rspec (~> 3.0)
+  sqlite3
   timecop (~> 0.7)

data/README.md

@@ -11,7 +11,7 @@ Crono is a time-based background job scheduler daemon (just like Cron) for Ruby
 
 ## The Idea
 
-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. You have total control of jobs performing process. You have the code in Ruby, so you can understand and modify it to fit your needs.
+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.
 
 
 ## Requirements
@@ -31,7 +31,11 @@ After you install Crono, you can run the generator:
 
     rails generate crono:install
 
-It will create a configuration file `config/cronotab.rb`  
+It will create a configuration file `config/cronotab.rb` and migration  
+Run the migration:
+
+    rake db:migrate
+
 Now you are ready to move forward to create a job and schedule it.
 
 

data/bin/crono

@@ -5,8 +5,7 @@ $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "crono/cli"
 
 begin
-  cli = Crono::CLI.instance
-  cli.run
+  Crono::CLI.instance.run
 rescue => e
   raise e if $DEBUG
   STDERR.puts e.message

data/crono.gemspec

@@ -15,10 +15,12 @@ Gem::Specification.new do |s|
 
   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.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact

data/examples/monitrc.conf

@@ -1,6 +1,6 @@
 check process crono_myapp
   with pidfile /path/to/crono.pid
-  start program = "bundle exec crono" with timeout 30 seconds
+  start program = "bundle exec crono -e production" with timeout 30 seconds
   stop program = "kill -s TERM `cat /path/to/crono.pid`" with timeout 30 seconds
   if totalmem is greater than 500 MB for 2 cycles then restart
   group myapp_crono

data/lib/crono.rb

@@ -3,8 +3,10 @@ end
 
 require "active_support/all"
 require "crono/version.rb"
+require "crono/logging.rb"
 require "crono/period.rb"
 require "crono/job.rb"
-require "crono/schedule.rb"
+require "crono/scheduler.rb"
 require "crono/config.rb"
 require "crono/performer_proxy.rb"
+require "crono/orm/active_record/crono_job.rb"

data/lib/crono/cli.rb

@@ -2,25 +2,34 @@ require 'crono'
 require 'optparse'
 
 module Crono
-  mattr_accessor :schedule
-  mattr_accessor :logger
+  mattr_accessor :scheduler
 
   class CLI
     include Singleton
+    include Logging
+
     attr_accessor :config
 
     def initialize
       self.config = Config.new
-      Crono.schedule = Schedule.new
+      Crono.scheduler = Scheduler.new
     end
 
     def run
       parse_options(ARGV)
-      init_logger
-      daemonize if config.daemonize
+
+      if config.daemonize
+        set_log_to(config.logfile)
+        daemonize 
+      else
+        set_log_to(STDOUT)
+      end
+
       write_pid
       load_rails
       print_banner
+
+      check_jobs
       start_working_loop
     end
 
@@ -32,6 +41,7 @@ module Crono
         File.open(config.logfile, 'ab') { |f| io.reopen(f) }
         io.sync = true
       end
+
       $stdin.reopen("/dev/null")
     end
 
@@ -40,14 +50,14 @@ module Crono
       File.write(pidfile, ::Process.pid)
     end
 
-    def init_logger
-      logfile = config.daemonize ? config.logfile : STDOUT
-      Crono.logger = Logger.new(logfile)
-    end
-
     def print_banner
-      Crono.logger.info "Loading Crono #{Crono::VERSION}"
-      Crono.logger.info "Running in #{RUBY_DESCRIPTION}"
+      logger.info "Loading Crono #{Crono::VERSION}"
+      logger.info "Running in #{RUBY_DESCRIPTION}"
+
+      logger.info "Jobs:"
+      Crono.scheduler.jobs.each do |job|
+        logger.info job.description
+      end
     end
 
     def load_rails
@@ -58,9 +68,15 @@ module Crono
       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
+    end
+
     def start_working_loop
-      loop do
-        job = Crono.schedule.next
+      Thread.abort_on_exception = true
+      while job = Crono.scheduler.next do
         sleep(job.next - Time.now)
         job.perform
       end

data/lib/crono/job.rb

@@ -1,5 +1,7 @@
 module Crono
   class Job
+    include Logging
+
     attr_accessor :performer
     attr_accessor :period
     attr_accessor :last_performed_at
@@ -9,13 +11,39 @@ module Crono
     end
 
     def next
-      period.next(since: last_performed_at)
+      next_time = period.next(since: last_performed_at)
+      next_time.past? ? period.next : next_time
+    end
+
+    def description
+      "Perform #{performer} #{period.description}"
+    end
+
+    def job_id
+      description
     end
 
     def perform
-      Crono.logger.info "Perform #{performer}"
+      logger.info "Perform #{performer}"
       self.last_performed_at = Time.now
-      Thread.new { performer.new.perform }
+      save
+      Thread.new do
+        performer.new.perform
+        logger.info "Finished #{performer} in %.2f seconds" % (Time.now - last_performed_at)
+      end
+    end
+
+    def save
+      model.update(last_performed_at: last_performed_at)
+    end
+
+    def load
+      self.last_performed_at = model.last_performed_at
+    end
+
+  private
+    def model
+      @model ||= Crono::CronoJob.find_or_create_by(job_id: job_id)
     end
   end
 end

data/lib/crono/logging.rb

@@ -0,0 +1,13 @@
+module Crono
+  mattr_accessor :logger
+
+  module Logging
+    def set_log_to(logfile)
+      Crono.logger = Logger.new(logfile)
+    end
+
+    def logger
+      Crono.logger
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+require 'active_record'
+
+module Crono
+  class CronoJob < ActiveRecord::Base
+    self.table_name = "crono_jobs"
+    validates :job_id, presence: true, uniqueness: true
+  end
+end

data/lib/crono/performer_proxy.rb

@@ -1,17 +1,17 @@
 module Crono
   class PerformerProxy
-    def initialize(performer, schedule)
+    def initialize(performer, scheduler)
       @performer = performer
-      @schedule = schedule
+      @scheduler = scheduler
     end
 
     def every(period, *args)
       job = Job.new(@performer, Period.new(period, *args))
-      @schedule.add(job)
+      @scheduler.add_job(job)
     end
   end
 
   def self.perform(performer)
-    PerformerProxy.new(performer, Crono.schedule)
+    PerformerProxy.new(performer, Crono.scheduler)
   end
 end

data/lib/crono/period.rb

@@ -10,6 +10,12 @@ module Crono
       @period.since(since).change({hour: @at_hour, min: @at_min}.compact)
     end
 
+    def description
+      desc = "every #{@period.inspect}"
+      desc += " at %.2i:%.2i" % [@at_hour, @at_min] if @at_hour && @at_min
+      desc
+    end
+
     def parse_at(at)
       case at
       when String

data/lib/crono/scheduler.rb

@@ -0,0 +1,23 @@
+module Crono
+  class Scheduler
+    attr_accessor :jobs
+
+    def initialize
+      self.jobs = []
+    end
+
+    def add_job(job)
+      job.load
+      jobs << job
+    end
+
+    def next
+      queue.first
+    end
+
+  private
+    def queue
+      jobs.sort_by(&:next)
+    end
+  end
+end

data/lib/crono/version.rb

@@ -1,3 +1,3 @@
 module Crono
-  VERSION = "0.5.2"
+  VERSION = '0.6.1'
 end

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

@@ -1,12 +1,26 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
 module Crono
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      def self.next_migration_number(path)
+        ActiveRecord::Generators::Base.next_migration_number(path)
+      end
+
       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'
+      end
     end
   end
 end

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

@@ -0,0 +1,15 @@
+class CreateCronoJobs < ActiveRecord::Migration
+  def self.up
+    create_table :crono_jobs do |t|
+      t.string    :job_id, null: false
+      t.text      :log
+      t.datetime  :last_performed_at
+      t.timestamps
+    end
+    add_index :crono_jobs, [:job_id], unique: true
+  end
+
+  def self.down
+    drop_table :crono_jobs
+  end
+end

data/spec/job_spec.rb

@@ -18,5 +18,45 @@ describe Crono::Job do
       thread = job.perform.join
       expect(thread).to be_stop
     end
+
+    it "should call Job#save after run" do
+      expect(job).to receive(:save)
+      job.perform.join
+      job.send(:model).destroy
+    end
+  end
+
+  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
+      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
+      job.last_performed_at = Time.now
+      job.save
+      @crono_job = Crono::CronoJob.find_by(job_id: job.job_id)
+      expect(@crono_job.last_performed_at).to be_eql(job.last_performed_at)
+    end
+  end
+
+  describe "#load" do
+    before do
+      @saved_last_performed_at = job.last_performed_at = Time.now
+      job.save
+    end
+
+    it "should load info from DB" do
+      @job = Crono::Job.new(TestJob, period)
+      @job.load
+      expect(@job.last_performed_at).to be_eql @saved_last_performed_at
+    end
   end
 end

data/spec/orm/active_record/crono_job_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe Crono::CronoJob do
+  let(:valid_attrs) do
+    {
+      job_id: "Perform TestJob every 3 days"
+    }
+  end
+
+  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")
+    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
+    Crono::CronoJob.create!(valid_attrs)
+    @crono_job = Crono::CronoJob.find_by(job_id: valid_attrs[:job_id])
+    expect(@crono_job).to be_present
+  end
+end

data/spec/performer_proxy_spec.rb

@@ -6,7 +6,7 @@ end
 
 describe Crono::PerformerProxy do
   it "should add job to schedule" do
-    expect(Crono.schedule).to receive(:add).with(kind_of(Crono::Job))
+    expect(Crono.scheduler).to receive(:add_job).with(kind_of(Crono::Job))
     Crono.perform(TestJob).every(2.days, at: "15:30")
   end
 end

data/spec/period_spec.rb

@@ -7,6 +7,13 @@ describe Crono::Period do
     end
   end
 
+  describe "#description" do
+    it "should return period description" do
+      @period = Crono::Period.new(2.day, at: "15:20")
+      expect(@period.description).to be_eql("every 2 days at 15:20")
+    end
+  end
+
   describe "#next" do
     context "in daily basis" do
       it "should return the time 2 days from now" do

data/spec/{schedule_spec.rb → scheduler_spec.rb}

@@ -4,24 +4,32 @@ class TestJob
   def perform;end
 end
 
-describe Crono::Schedule do
+describe Crono::Scheduler do
   before(:each) do
-    @schedule = Crono::Schedule.new
+    @scheduler = Crono::Scheduler.new
     @jobs = [
       Crono::Period.new(3.day, at: "18:55"),
       Crono::Period.new(1.day, at: "15:30"),
       Crono::Period.new(7.day, at: "06:05")
     ].map { |period| Crono::Job.new(TestJob, period) }
-    @schedule.schedule = @jobs
+    @scheduler.jobs = @jobs
+  end
+
+  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"))
+      expect(@job).to receive(:load)
+      @scheduler.add_job(@job)
+    end
   end
 
   describe "#next" do
     it "should return next job in schedule" do
-      expect(@schedule.next).to be @jobs[1]
+      expect(@scheduler.next).to be @jobs[1]
     end
 
     it "should return next based on last" do
-      expect(@schedule.next)
+      expect(@scheduler.next)
     end
   end
 end

data/spec/spec_helper.rb

@@ -3,6 +3,11 @@ Bundler.setup
 
 require 'timecop'
 require 'crono'
+require 'generators/crono/install/templates/migrations/create_crono_jobs.rb'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+CreateCronoJobs.up
 
 RSpec.configure do |config|
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crono
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.1
 platform: ruby
 authors:
 - Dzmitry Plashchynski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-04 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Job scheduler for Rails
 email:
 - plashchynski@gmail.com
@@ -120,18 +148,22 @@ files:
 - lib/crono/cli.rb
 - lib/crono/config.rb
 - lib/crono/job.rb
+- lib/crono/logging.rb
+- lib/crono/orm/active_record/crono_job.rb
 - lib/crono/performer_proxy.rb
 - lib/crono/period.rb
-- lib/crono/schedule.rb
+- lib/crono/scheduler.rb
 - lib/crono/version.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
 - spec/cli_spec.rb
 - spec/config_spec.rb
 - spec/job_spec.rb
+- spec/orm/active_record/crono_job_spec.rb
 - spec/performer_proxy_spec.rb
 - spec/period_spec.rb
-- spec/schedule_spec.rb
+- spec/scheduler_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/plashchynski/crono
 licenses:

data/lib/crono/schedule.rb

@@ -1,22 +0,0 @@
-module Crono
-  class Schedule
-    attr_accessor :schedule
-
-    def initialize
-      self.schedule = []
-    end
-
-    def add(job)
-      schedule << job
-    end
-
-    def next
-      queue.first
-    end
-
-  private
-    def queue
-      schedule.sort { |a,b| a.next <=> b.next }
-    end
-  end
-end