crono 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6935e065a4c161dafada3370230b5f00ee0321e3
-  data.tar.gz: d1667f7a5efc7f356bab0ae8b867dd9f6d65e612
+  metadata.gz: 2fe5cc8fdfa89bc633c58c8f83c5c7f324753a97
+  data.tar.gz: 59cd54c8f5dfc6ab98ea2969aab1c9821528e426
 SHA512:
-  metadata.gz: f727c28c3d2d909fe1a8f12fb26074ca0ce7f574cc4323da62ec638f92514b4e4256b882f81b8685496f6c87ffe0e280e94d8204642c1ca54b6e3d035036819b
-  data.tar.gz: 54aadbd50534a87e59396c020da59ca8efeb04b708a209cf0cf891409034669781ec0ff54899ee0ae7432ecaba96a37a06d061c2942287a07e7e672170e75c63
+  metadata.gz: d3d4c392b0d88d5c11d5eee6a1a138bfcda13c81369bacfa6400beeb87eef6a38e04184127d6f0f051ecc916ec577d066683a274ae0df2d49f2a75b3745a7ec4
+  data.tar.gz: b2b03f125d780069004609f23dd95b3fb9d044e9aa3003a573a6d61016a6260a20ecdf8ebc6f8157facda0602613d297407c57d11a1bbb3334a63d4f9b8ecb21

data/README.md

@@ -1,6 +1,8 @@
 Crono — Job scheduler for Rails
 ------------------------
-[![Gem Version](https://badge.fury.io/rb/crono.svg)](http://badge.fury.io/rb/crono)
+[![Gem Version](https://badge.fury.io/rb/crono.svg)](http://badge.fury.io/rb/crono)Here's an example of a test job:
+
+
 [![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)
@@ -49,7 +51,7 @@ Now you are ready to move forward to create a job and schedule it.
 
 Crono can use Active Job jobs from `app/jobs/`. The only requirements is that the `perform` method should take no arguments.
 
-Here's an example of a test job:
+Here's an example of a job:
 
 ```ruby
 # app/jobs/test_job.rb
@@ -72,6 +74,8 @@ class TestJob # This is not an Active Job job, but pretty legal Crono job.
 end
 ```
 
+_Please note that crono uses threads, so your code should be thread-safe_
+
 #### Job Schedule
 
 Schedule list is defined in the file `config/cronotab.rb`, that created using `crono:install`. The semantic is pretty straightforward:

data/lib/crono.rb

@@ -11,5 +11,6 @@ require 'crono/scheduler'
 require 'crono/config'
 require 'crono/performer_proxy'
 require 'crono/orm/active_record/crono_job'
+require 'crono/railtie' if defined?(Rails)
 
 Crono.autoload :Web, 'crono/web'

data/lib/crono/cli.rb

@@ -2,8 +2,6 @@ require 'crono'
 require 'optparse'
 
 module Crono
-  mattr_accessor :scheduler
-
   # Crono::CLI - The main class for the crono daemon exacutable `bin/crono`
   class CLI
     include Singleton
@@ -33,7 +31,7 @@ module Crono
 
     def setup_log
       if config.daemonize
-        self.logifile = config.logfile
+        self.logfile = config.logfile
         daemonize
       else
         self.logfile = STDOUT

data/lib/crono/job.rb

@@ -61,7 +61,9 @@ module Crono
     end
 
     def perform_job
-      performer.new.perform
+      performer_instance = performer.new
+      performer_instance.instance_variable_set(:@_crono_job, self)
+      performer_instance.perform
       finished_time_sec = format('%.2f', Time.now - last_performed_at)
     rescue StandardError => e
       handle_job_fail(e, finished_time_sec)

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

@@ -5,5 +5,9 @@ module Crono
   class CronoJob < ActiveRecord::Base
     self.table_name = 'crono_jobs'
     validates :job_id, presence: true, uniqueness: true
+
+    def self.outdated
+      self
+    end
   end
 end

data/lib/crono/railtie.rb

@@ -0,0 +1,9 @@
+module Crono
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__), '../tasks/*.rake')].each do |file|
+        load file
+      end
+    end
+  end
+end

data/lib/crono/scheduler.rb

@@ -22,4 +22,6 @@ module Crono
       jobs.sort_by(&:next)
     end
   end
+
+  mattr_accessor :scheduler
 end

data/lib/crono/version.rb

@@ -1,3 +1,3 @@
 module Crono
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

data/lib/tasks/crono_tasks.rake

@@ -0,0 +1,26 @@
+module Crono
+  def self.load_cronotab
+    cronotab_path = ENV['CRONOTAB'] || (defined?(Rails) &&
+                      File.join(Rails.root, cronotab_path))
+    fail 'No cronotab defined' unless cronotab_path
+    puts "Load cronotab #{cronotab_path}"
+    require cronotab_path
+  end
+end
+
+namespace :crono do
+  desc 'Clean unused job stats from DB'
+  task clean: :environment do
+    Crono.scheduler = Crono::Scheduler.new
+    Crono.load_cronotab
+    current_job_ids = Crono.scheduler.jobs.map(&:job_id)
+    Crono::CronoJob.where.not(job_id: current_job_ids).destroy_all
+  end
+
+  desc 'Check cronotab.rb syntax'
+  task check: :environment do
+    Crono.scheduler = Crono::Scheduler.new
+    Crono.load_cronotab
+    puts 'Syntax ok'
+  end
+end

data/spec/assets/bad_cronotab.rb

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

data/spec/assets/good_cronotab.rb

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

data/spec/cli_spec.rb

@@ -1,11 +1,6 @@
 require 'spec_helper'
 require 'crono/cli'
 
-class TestJob
-  def perform
-  end
-end
-
 describe Crono::CLI do
   let(:cli) { Crono::CLI.instance }
 

data/spec/job_spec.rb

@@ -1,16 +1,5 @@
 require 'spec_helper'
 
-class TestJob
-  def perform
-  end
-end
-
-class TestFailingJob
-  def perform
-    fail 'Some error'
-  end
-end
-
 describe Crono::Job do
   let(:period) { Crono::Period.new(2.day) }
   let(:job) { Crono::Job.new(TestJob, period) }
@@ -37,15 +26,23 @@ describe Crono::Job do
       expect(saved_log).to include 'Some error'
     end
 
-    it 'should set Job#healthy to true if perform ok' do
+    xit 'should set Job#healthy to true if perform ok' do
+      class TestJob
+        def perform
+          @_crono_job
+        end
+      end
       job.perform.join
-      expect(job.healthy).to be true
     end
 
     it 'should set Job#healthy to false if perform with error' do
       failing_job.perform.join
       expect(failing_job.healthy).to be false
     end
+
+    it 'should set @_crono_job variable to instance' do
+      job.perform
+    end
   end
 
   describe '#description' do

data/spec/performer_proxy_spec.rb

@@ -1,10 +1,5 @@
 require 'spec_helper'
 
-class TestJob
-  def perform
-  end
-end
-
 describe Crono::PerformerProxy do
   it 'should add job to schedule' do
     expect(Crono.scheduler).to receive(:add_job).with(kind_of(Crono::Job))

data/spec/scheduler_spec.rb

@@ -1,10 +1,5 @@
 require 'spec_helper'
 
-class TestJob
-  def perform
-  end
-end
-
 describe Crono::Scheduler do
   before(:each) do
     @scheduler = Crono::Scheduler.new

data/spec/spec_helper.rb

@@ -13,3 +13,14 @@ ActiveRecord::Base.establish_connection(
 
 ActiveRecord::Base.logger = Logger.new(STDOUT)
 CreateCronoJobs.up
+
+class TestJob
+  def perform
+  end
+end
+
+class TestFailingJob
+  def perform
+    fail 'Some error'
+  end
+end

data/spec/tasks/crono_tasks_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'rake'
+
+load 'tasks/crono_tasks.rake'
+Rake::Task.define_task(:environment)
+
+describe 'rake' do
+  describe 'crono:clean' do
+    it 'should clean unused tasks from DB' do
+      Crono::CronoJob.create!(job_id: 'used_job')
+      ENV['CRONOTAB'] = File.expand_path('../../assets/good_cronotab.rb', __FILE__)
+      Rake::Task['crono:clean'].invoke
+      expect(Crono::CronoJob.where(job_id: 'used_job')).not_to exist
+    end
+  end
+
+  describe 'crono:check' do
+    it 'should check cronotab syntax' do
+      ENV['CRONOTAB'] = File.expand_path('../../assets/bad_cronotab.rb', __FILE__)
+      expect { Rake::Task['crono:check'].invoke }.to raise_error
+    end
+  end
+end

data/spec/web_spec.rb

@@ -6,6 +6,7 @@ describe Crono::Web do
   let(:app) { Crono::Web }
 
   before do
+    Crono::CronoJob.destroy_all
     @test_job_id = 'Perform TestJob every 5 seconds'
     @test_job_log = 'All runs ok'
     @test_job = Crono::CronoJob.create!(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crono
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Dzmitry Plashchynski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2015-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -209,12 +209,16 @@ files:
 - lib/crono/orm/active_record/crono_job.rb
 - lib/crono/performer_proxy.rb
 - lib/crono/period.rb
+- lib/crono/railtie.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
+- lib/tasks/crono_tasks.rake
+- spec/assets/bad_cronotab.rb
+- spec/assets/good_cronotab.rb
 - spec/cli_spec.rb
 - spec/config_spec.rb
 - spec/job_spec.rb
@@ -223,6 +227,7 @@ files:
 - spec/period_spec.rb
 - spec/scheduler_spec.rb
 - spec/spec_helper.rb
+- spec/tasks/crono_tasks_spec.rb
 - spec/web_spec.rb
 - tmp/.gitkeep
 - web/assets/custom.css