crono 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64a9cf0a8dfbbb07d720a55e4e8d00fdcf38d792
-  data.tar.gz: b17baffc9f7f8c8c20ea747ff95003cffc2c0593
+  metadata.gz: 88e53a7c4eee894469cb7980928acb90726d65c9
+  data.tar.gz: b0cf49ee7f5edfb936271d5ba4cb7f71319e156e
 SHA512:
-  metadata.gz: e660b9fc13581744848bfa9efcd70d2350c3f97741118f0b29c15b6c544c2f164fab47324d1bd937ecccf0d2e8426bf344d4b521f9e41236da00b8cb19a38d63
-  data.tar.gz: b85e7a57c38a82db19827206dc93bc30033107f21b21857d9ef460472b437f54360f761891b268d7549fd002b5e92363e210a950d2a1c434b87b9c326543ae3d
+  metadata.gz: 283289e7b9ef4cb6840d55513cbbce57b3c4773e816957e3e5394646c2920f2c50954abd240302c0d0c8dff2f623bc576d12ef682d6c3624e74f6486a7de8842
+  data.tar.gz: 5c59231c15eb083f7ca341fdf1d0637cb50cd4ceec8cd05f17661ead5aa68507c664a217598cb1ae858b2ff784058b0fae3db760ffd10ab01fa106916460ea23

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+tmp/*.sqlite3

data/Changes.md

@@ -17,3 +17,8 @@
 -----------
 
 - Persist job state to your database.
+
+0.7.0
+-----------
+
+- Added simple Web UI

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crono (0.6.1)
+    crono (0.7.0)
       activejob (~> 4.0)
       activerecord (~> 4.0)
       activesupport (~> 4.0)
@@ -27,12 +27,23 @@ GEM
       tzinfo (~> 1.1)
     arel (6.0.0)
     builder (3.2.2)
+    byebug (3.5.1)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+      slop (~> 3.6)
+    columnize (0.9.0)
+    debugger-linecache (1.2.0)
     diff-lcs (1.2.5)
     globalid (0.3.3)
       activesupport (>= 4.1.0)
+    haml (4.0.6)
+      tilt
     i18n (0.7.0)
     json (1.8.2)
     minitest (5.5.1)
+    rack (1.6.0)
+    rack-protection (1.5.3)
+      rack
     rake (10.4.2)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
@@ -47,8 +58,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
     rspec-support (3.2.2)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slop (3.6.0)
     sqlite3 (1.3.10)
     thread_safe (0.3.4)
+    tilt (1.4.1)
     timecop (0.7.3)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
@@ -58,8 +75,11 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (>= 1.0.0)
+  byebug
   crono!
+  haml
   rake (~> 10.0)
   rspec (~> 3.0)
+  sinatra
   sqlite3
   timecop (~> 0.7)

data/README.md

@@ -13,6 +13,7 @@ Crono is a time-based background job scheduler daemon (just like Cron) for Ruby
 
 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.
 
+![Web UI](https://github.com/plashchynski/crono/raw/master/examples/crono_web_ui.png)
 
 ## Requirements
 
@@ -24,7 +25,9 @@ Other versions are untested but might work fine.
 
 Add the following line to your application's Gemfile:
 
-    gem 'crono'
+```ruby
+gem 'crono'
+```
 
 Run the `bundle` command to install it.  
 After you install Crono, you can run the generator:
@@ -47,40 +50,48 @@ Crono can use Active Job jobs from `app/jobs/`. The only requirements is that th
 
 Here's an example of a test job:
 
-    # app/jobs/test_job.rb
-    class TestJob < ActiveJob::Base
-      def perform
-        # put you scheduled code here
-        # Comments.deleted.clean_up...
-      end
-    end
+```ruby
+# app/jobs/test_job.rb
+class TestJob < ActiveJob::Base
+  def perform
+    # put you scheduled code here
+    # Comments.deleted.clean_up...
+  end
+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:
 
-    class TestJob # This is not an Active Job job, but pretty legal Crono job.
-      def perform
-        # put you scheduled code here
-        # Comments.deleted.clean_up...
-      end
-    end
-
+```ruby
+class TestJob # This is not an Active Job job, but pretty legal Crono job.
+  def perform
+    # put you scheduled code here
+    # Comments.deleted.clean_up...
+  end
+end
+```
 
 #### Job Schedule
 
 The schedule described in the configuration file `config/cronotab.rb`, that created using `crono:install` or manually. The semantic is pretty straightforward:
 
-    # config/cronotab.rb
-    Crono.perform(TestJob).every 2.days, at: "15:30"
+```ruby
+# config/cronotab.rb
+Crono.perform(TestJob).every 2.days, at: "15:30"
+```
 
 You can schedule one job a few times, if you want a job to be performed a few times a day:
 
-    Crono.perform(TestJob).every 1.day, at: "00:00"
-    Crono.perform(TestJob).every 1.day, at: "12:00"
+```ruby
+Crono.perform(TestJob).every 1.day, at: "00:00"
+Crono.perform(TestJob).every 1.day, at: "12:00"
+```
 
 The `at` can be a Hash:
 
-    Crono.perform(TestJob).every 1.day, at: {hour: 12, min: 15}
-
+```ruby
+Crono.perform(TestJob).every 1.day, at: {hour: 12, min: 15}
+```
 
 #### Run daemon
 
@@ -98,6 +109,28 @@ Usage: crono [options]
     -e, --environment ENV            Application environment (Default: development)
 ```
 
+## Web UI
+
+Crono comes with a Sinatra application that can display the current state of Crono jobs.  
+Add `sinatra` and `haml` to your Gemfile  
+
+```ruby
+gam 'haml'
+gem 'sinatra', require: nil
+```
+
+Add the following to your `config/routes.rb`:
+
+```ruby
+require 'crono/web'
+
+Rails.application.routes.draw do
+    mount Crono::Web, at: '/crono'
+    ...
+```
+
+Access management and other questions described in the [wiki](https://github.com/plashchynski/crono/wiki/Web-UI).
+
 ## Capistrano
 
 Use the `capistrano-crono` gem ([github](https://github.com/plashchynski/capistrano-crono/)).

data/crono.gemspec

@@ -21,6 +21,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency  "rspec", "~> 3.0"
   s.add_development_dependency  "timecop", "~> 0.7"
   s.add_development_dependency  "sqlite3"
+  s.add_development_dependency  "byebug"
+  s.add_development_dependency  "sinatra"
+  s.add_development_dependency  "haml"
 
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact

data/examples/cronotab.rb

@@ -1,15 +1,15 @@
-# cronotab.rb — Crono configuration example file
+# cronotab.rb — Crono configuration file
 #
-# Here you can specify periodic jobs and their schedule.
-# You can specify a periodic job as a ActiveJob class in `app/jobs/`
-# Actually you can use any class. The only requirement is that
-# the class should implement a method `perform` without arguments.
+# Here you can specify periodic jobs and schedule.
+# You can use ActiveJob's jobs from `app/jobs/`
+# You can use any class. The only requirement is that
+# class should have a method `perform` without arguments.
 #
-
 class TestJob
   def perform
     puts "Test!"
   end
 end
 
-Crono.perform(TestJob).every 5.second
+Crono.perform(TestJob).every 2.days, at: "15:30"
+

data/lib/crono/cli.rb

@@ -56,7 +56,7 @@ module Crono
 
       logger.info "Jobs:"
       Crono.scheduler.jobs.each do |job|
-        logger.info job.description
+        logger.info %{"#{job.performer}" with rule "#{job.period.description}" next time will perform at #{job.next}}
       end
     end
 
@@ -75,7 +75,6 @@ module Crono
     end
 
     def start_working_loop
-      Thread.abort_on_exception = true
       while job = Crono.scheduler.next do
         sleep(job.next - Time.now)
         job.perform

data/lib/crono/job.rb

@@ -1,3 +1,6 @@
+require 'stringio'
+require 'logger'
+
 module Crono
   class Job
     include Logging
@@ -5,9 +8,14 @@ module Crono
     attr_accessor :performer
     attr_accessor :period
     attr_accessor :last_performed_at
+    attr_accessor :job_log
+    attr_accessor :job_logger
 
     def initialize(performer, period)
       self.performer, self.period = performer, period
+      self.job_log = StringIO.new
+      self.job_logger = Logger.new(job_log)
+      @semaphore = Mutex.new
     end
 
     def next
@@ -24,17 +32,30 @@ module Crono
     end
 
     def perform
-      logger.info "Perform #{performer}"
+      log "Perform #{performer}"
       self.last_performed_at = Time.now
-      save
+
       Thread.new do
-        performer.new.perform
-        logger.info "Finished #{performer} in %.2f seconds" % (Time.now - last_performed_at)
+        begin
+          performer.new.perform
+        rescue Exception => e
+          log "Finished #{performer} in %.2f seconds with error: #{e.message}" % (Time.now - last_performed_at)
+          log e.backtrace.join("\n")
+        else
+          log "Finished #{performer} in %.2f seconds" % (Time.now - last_performed_at)
+        ensure
+          save
+        end
       end
     end
 
     def save
-      model.update(last_performed_at: last_performed_at)
+      @semaphore.synchronize do
+        log = model.reload.log || ""
+        log << job_log.string
+        job_log.truncate(job_log.rewind)
+        model.update(last_performed_at: last_performed_at, log: log)
+      end
     end
 
     def load
@@ -42,6 +63,13 @@ module Crono
     end
 
   private
+    def log(message)
+      @semaphore.synchronize do
+        logger.info message
+        job_logger.info message
+      end
+    end
+
     def model
       @model ||= Crono::CronoJob.find_or_create_by(job_id: job_id)
     end

data/lib/crono/period.rb

@@ -6,8 +6,13 @@ module Crono
     end
 
     def next(since: nil)
-      since ||= Time.now
-      @period.since(since).change({hour: @at_hour, min: @at_min}.compact)
+      if since.nil?
+        @next = Time.now.change(time_atts)
+        return @next if @next.future?
+        since = Time.now
+      end
+
+      @period.since(since).change(time_atts)
     end
 
     def description
@@ -27,5 +32,10 @@ module Crono
         raise "Unknown 'at' format"
       end
     end
+
+  private
+    def time_atts
+      {hour: @at_hour, min: @at_min}.compact
+    end
   end
 end

data/lib/crono/version.rb

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

data/lib/crono/web.rb

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

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

@@ -1,9 +1,15 @@
 # cronotab.rb — Crono configuration file
 #
-# Here you can specify periodic jobs and their schedule.
-# You can specify a periodic job as a ActiveJob class in `app/jobs/`
-# Actually you can use any class. The only requirement is that
-# the class should implement a method `perform` without arguments.
+# Here you can specify periodic jobs and schedule.
+# You can use ActiveJob's jobs from `app/jobs/`
+# You can use any class. The only requirement is that
+# class should have a method `perform` without arguments.
+#
+# class TestJob
+#   def perform
+#     puts "Test!"
+#   end
+# end
 #
 # Crono.perform(TestJob).every 2.days, at: "15:30"
 #

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

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

data/spec/job_spec.rb

@@ -4,9 +4,16 @@ class TestJob
   def perform;end
 end
 
+class TestFailingJob
+  def perform
+    raise "Some error"
+  end
+end
+
 describe Crono::Job do
   let(:period) { Crono::Period.new(2.day) }
   let(:job) { Crono::Job.new(TestJob, period) } 
+  let(:failing_job) { Crono::Job.new(TestFailingJob, period) }
 
   it "should contain performer and period" do
     expect(job.performer).to be TestJob
@@ -15,14 +22,17 @@ describe Crono::Job do
 
   describe "#perform" do
     it "should run performer in separate thread" do
+      expect(job).to receive(:save)
       thread = job.perform.join
       expect(thread).to be_stop
+      job.send(:model).destroy
     end
 
-    it "should call Job#save after run" do
-      expect(job).to receive(:save)
-      job.perform.join
-      job.send(:model).destroy
+    it "should save performin errors to log" do
+      thread = failing_job.perform.join
+      expect(thread).to be_stop
+      saved_log = Crono::CronoJob.find_by(job_id: failing_job.job_id).log
+      expect(saved_log).to include "Some error"
     end
   end
 
@@ -43,7 +53,15 @@ describe Crono::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)
+      expect(@crono_job.last_performed_at.utc.to_s).to be_eql job.last_performed_at.utc.to_s
+    end
+
+    it "should save and truncate job log" do
+      message = "test message"
+      job.send(:log, message)
+      job.save
+      expect(job.send(:model).reload.log).to include message
+      expect(job.job_log.string).to be_empty
     end
   end
 
@@ -53,10 +71,25 @@ describe Crono::Job do
       job.save
     end
 
-    it "should load info from DB" do
+    it "should load last_performed_at from DB" do
       @job = Crono::Job.new(TestJob, period)
       @job.load
-      expect(@job.last_performed_at).to be_eql @saved_last_performed_at
+      expect(@job.last_performed_at.utc.to_s).to be_eql @saved_last_performed_at.utc.to_s
+    end
+  end
+
+  describe "#log" do
+    it "should write log messages to both common and job log" do
+      message = "Test message"
+      expect(job.logger).to receive(:info).with(message)
+      expect(job.job_logger).to receive(:info).with(message)
+      job.send(:log, message)
+    end
+
+    it "should write job log to Job#job_log" do
+      message = "Test message"
+      job.send(:log, message)
+      expect(job.job_log.string).to include(message)
     end
   end
 end

data/spec/period_spec.rb

@@ -22,12 +22,14 @@ describe Crono::Period do
       end
 
       it "should set time to 'at' time as a string" do
-        @period = Crono::Period.new(2.day, at: "15:20")
-        expect(@period.next).to be_eql(2.day.from_now.change(hour: 15, min: 20))
+        time = 10.minutes.ago
+        @period = Crono::Period.new(2.day, at: [time.hour, time.min].join(':'))
+        expect(@period.next).to be_eql(2.day.from_now.change(hour: time.hour, min: time.min))
       end
 
       it "should set time to 'at' time as a hash" do
-        at = {hour: 18, min: 45}
+        time = 10.minutes.ago
+        at = {hour: time.hour, min: time.min}
         @period = Crono::Period.new(2.day, at: at)
         expect(@period.next).to be_eql(2.day.from_now.change(at))
       end
@@ -42,6 +44,13 @@ describe Crono::Period do
         @period = Crono::Period.new(2.day)
         expect(@period.next(since: 1.day.ago)).to be_eql(1.day.from_now)
       end
+
+      it "should return today time if it is first run and not too late" do
+        time = 10.minutes.from_now
+        at = {hour: time.hour, min: time.min}
+        @period = Crono::Period.new(2.day, at: at)
+        expect(@period.next).to be_eql(Time.now.change(at))
+      end
     end
   end
 end

data/spec/scheduler_spec.rb

@@ -8,9 +8,9 @@ describe Crono::Scheduler do
   before(:each) do
     @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")
+      Crono::Period.new(3.day, 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.day, at: 40.minutes.from_now.strftime("%H:%M"))
     ].map { |period| Crono::Job.new(TestJob, period) }
     @scheduler.jobs = @jobs
   end
@@ -25,11 +25,7 @@ describe Crono::Scheduler do
 
   describe "#next" do
     it "should return next job in schedule" do
-      expect(@scheduler.next).to be @jobs[1]
-    end
-
-    it "should return next based on last" do
-      expect(@scheduler.next)
+      expect(@scheduler.next).to be @jobs[0]
     end
   end
 end

data/spec/spec_helper.rb

@@ -2,10 +2,11 @@ require 'bundler/setup'
 Bundler.setup
 
 require 'timecop'
+require 'byebug'
 require 'crono'
 require 'generators/crono/install/templates/migrations/create_crono_jobs.rb'
 
-ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: "file::memory:?cache=shared")
 ActiveRecord::Base.logger = Logger.new(STDOUT)
 CreateCronoJobs.up
 

data/web/assets/custom.css

@@ -0,0 +1,20 @@
+.container {
+  background-color: #CFD8DC;
+}
+
+body {
+  background-color: #455A64;
+}
+
+.page-header {
+  border-bottom: 1px solid #B6B6B6;
+}
+
+#job_list td,#job_list th {
+  border-top: 1px solid #B6B6B6;
+  color: #212121;
+}
+
+.breadcrumb {
+  background-color: #FFFFFF;
+}

data/web/views/dashboard.haml

@@ -0,0 +1,17 @@
+%ol.breadcrumb
+  %li.active Home
+
+%h3 Running Jobs
+%table.table#job_list
+  %tr
+    %th Job
+    %th Last performed at
+    %th
+  - for job in @jobs
+    %tr
+      %td= job.job_id
+      %td= job.last_performed_at || "—"
+      %td
+        %a{href: url("/jobs/#{job.id}")}
+          Log
+          %span.glyphicon.glyphicon-menu-right

data/web/views/job.haml

@@ -0,0 +1,8 @@
+%ol.breadcrumb
+  %li
+    %a{href: url("/")} Home
+  %li.active= @job.job_id
+
+%h2
+  "#{@job.job_id}" Log:
+%pre= @job.log

data/web/views/layout.haml

@@ -0,0 +1,25 @@
+!!! 5
+%html{lang: "en"}
+  %head
+    %meta{charset: "utf-8"}
+    %meta{"http-equiv" => "X-UA-Compatible", content: "IE=edge"}
+    %meta{name: "viewport", content: "width=device-width, initial-scale=1"}
+
+    %title Crono Dashboard
+
+    %link{href: "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css", rel: "stylesheet"}
+    %link{href: "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap-theme.min.css", rel: "stylesheet"}
+    %link{href: "#{env['SCRIPT_NAME']}/custom.css", rel: "stylesheet"}
+
+  %body
+    %br
+    %br
+    .container
+      .page-header
+        %h1
+          Crono #{Crono::VERSION}
+          %small Dashboard
+      = yield
+
+    %script{src: "https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"}
+    %script{src: "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/js/bootstrap.min.js"}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crono
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Dzmitry Plashchynski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -122,6 +122,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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'
+- !ruby/object:Gem::Dependency
+  name: haml
+  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
@@ -142,6 +184,7 @@ files:
 - Rakefile
 - bin/crono
 - crono.gemspec
+- examples/crono_web_ui.png
 - examples/cronotab.rb
 - examples/monitrc.conf
 - lib/crono.rb
@@ -154,6 +197,7 @@ files:
 - lib/crono/period.rb
 - lib/crono/scheduler.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
@@ -165,6 +209,11 @@ files:
 - spec/period_spec.rb
 - spec/scheduler_spec.rb
 - spec/spec_helper.rb
+- tmp/.gitkeep
+- web/assets/custom.css
+- web/views/dashboard.haml
+- web/views/job.haml
+- web/views/layout.haml
 homepage: https://github.com/plashchynski/crono
 licenses:
 - Apache-2.0