crono 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0045e60df85bab889a28dd9de6563cbb4f9797d0
-  data.tar.gz: c282718940378a5d41fe75e73780149b46f75a62
+  metadata.gz: c146a6ca9be59f261b40b2716337e6db97962c60
+  data.tar.gz: f0889fab37a17460d0c676dead916f0c36e315ac
 SHA512:
-  metadata.gz: 9b983b15c72eb8f1f813eb0744d51ca286ac8b35f9a35d1bdffb89b297358f4ecc5916a816410609ae0c6c132122c67c546cefc61092c3e0e309614449a33f8e
-  data.tar.gz: f5fd72d6addae0d7d800ef7b266d01fa47ee1eb28aae9e24add2a1a9b6fcef95ec5fe9961d74b6040e406afbaed10f083db9ec7336c4a680f9e84b881c3b4f40
+  metadata.gz: 5498ec9e3ef28a21fa38ffb372d6807f7e34bd4088346a6381151dabf925a26b68857b6c5d5ba74af092a2470a6afc47844875d5c700775d4843d75f0678e614
+  data.tar.gz: f4b21a9fe445df51770cff88da34a888fa3e03666c1371b74efe45267c2c0f4d44cba76ebb3571e6e644be366da78c7b41f89114cfe3c51dae91f7c10e91dd84

data/Changes.md

@@ -0,0 +1,9 @@
+0.5.0
+-----------
+
+- Initial release!
+
+0.5.1
+———————————
+
+- Added -e/--environment ENV option to set the daemon rails environment.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crono (0.0.1)
+    crono (0.5.1)
       activejob (~> 4.0)
       activesupport (~> 4.0)
 

data/README.md

@@ -1,15 +1,22 @@
 Crono — Job scheduler for Rails
 ------------------------
+[![Gem Version](https://badge.fury.io/rb/crono.svg)](http://badge.fury.io/rb/crono)
 [![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. It's pure Ruby. It doesn't use Unix Cron and other platform-dependent things. So you can use it everywhere.
+Crono is a time-based background job scheduler daemon (just like Cron) for Ruby on Rails.
+
+
+## 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.
 
 
 ## 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.1 and 2.0) and Rails 3.2+  
 Other versions are untested but might work fine.
 
 
@@ -19,12 +26,12 @@ Add the following line to your application's Gemfile:
 
     gem 'crono'
 
-Run the bundle command to install it.
+Run the bundle command to install it.  
 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`  
 Now you are ready to move forward to create a job and schedule it.
 
 
@@ -32,7 +39,7 @@ Now you are ready to move forward to create a job and schedule it.
 
 #### Create Job
 
-Crono can use Active Job jobs in `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 requirements is that the `perform` method should take no arguments.
 
 Here's an example of a test job:
 app/jobs/test_job.rb
@@ -44,9 +51,9 @@ app/jobs/test_job.rb
       end
     end
 
-The Active Job jobs is convenient because you can use one class in both periodic and enqueued ways. But it doesn't necessarily. Any class can be used as Job if it has 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` without arguments:
 
-    class TestJob # this is not active job class
+    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...
@@ -54,20 +61,20 @@ The Active Job jobs is convenient because you can use one class in both periodic
     end
 
 
-#### Schedule Jobs
+#### Job Schedule
 
-The schedule described in the configuration file `config/cronotab.rb`, that we created using `rails generate crono:install` or manually. The semantic is pretty straightforward:
+The schedule described in the configuration file `config/cronotab.rb`, that created using `crono:install` or manually. The semantic is pretty straightforward:
 
     Crono.perform(TestJob).every 2.days, at: "15:30"
 
-You can schedule one job a few times if you want the job to be performed a few times a day:
+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.days, at: "00:00"
-    Crono.perform(TestJob).every 1.days, at: "12:00"
+    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.days, at: {hour: 12, min: 15}
+    Crono.perform(TestJob).every 1.day, at: {hour: 12, min: 15}
 
 
 #### Run daemon
@@ -76,9 +83,21 @@ To run Crono daemon, in your Rails project root directory:
 
     bundle exec crono RAILS_ENV=development
 
+crono usage:
+```
+Usage: crono [options]
+    -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)
+```
+
+## Capistrano
+Use the `capistrano-crono` gem ([github](https://github.com/plashchynski/capistrano-crono/)).
 
 ## License
 
 Copyright 2015 Dzmitry Plashchynski <plashchynski@gmail.com>  
 Licensed under the Apache License, Version 2.0  
-Please see [LICENSE](https://github.com/plashchynski/crono/blob/master/LICENSE) for licensing details.
+Please see [LICENSE](https://github.com/plashchynski/crono/blob/master/LICENSE) for licensing details.

data/examples/monitrc.conf

@@ -0,0 +1,6 @@
+check process crono_myapp
+  with pidfile /path/to/crono.pid
+  start program = "bundle exec crono" 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/cli.rb

@@ -53,6 +53,7 @@ module Crono
     end
 
     def load_rails
+      ENV['RACK_ENV'] = ENV['RAILS_ENV'] = config.environment
       require 'rails'
       require File.expand_path("config/environment.rb")
       ::Rails.application.eager_load!
@@ -91,7 +92,10 @@ module Crono
         opts.on("-d", "--[no-]daemonize", "Daemonize process (Default: #{config.daemonize})") do |daemonize|
           config.daemonize = daemonize
         end
-        
+
+        opts.on '-e', '--environment ENV', "Application environment (Default: #{config.environment})" do |env|
+          config.environment = env
+        end
       end.parse!(argv)
     end
   end

data/lib/crono/config.rb

@@ -8,12 +8,14 @@ module Crono
     attr_accessor :logfile
     attr_accessor :pidfile
     attr_accessor :daemonize
+    attr_accessor :environment
 
     def initialize
       self.cronotab = CRONOTAB
       self.logfile  = LOGFILE
       self.pidfile  = PIDFILE
       self.daemonize = false
+      self.environment = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || "development"
     end
   end
 end

data/lib/crono/version.rb

@@ -1,3 +1,3 @@
 module Crono
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/spec/cli_spec.rb

@@ -49,5 +49,10 @@ describe Crono::CLI do
       cli.send(:parse_options, ["--daemonize"])
       expect(cli.config.daemonize).to be true
     end
+
+    it "should set environment" do
+      cli.send(:parse_options, ["--environment", "production"])
+      expect(cli.config.environment).to be_eql("production")
+    end
   end
 end

data/spec/config_spec.rb

@@ -3,11 +3,13 @@ require "spec_helper"
 describe Crono::Config do
   describe "#initialize" do
     it "should initialize with default configuration options" do
+      ENV["RAILS_ENV"] = "test"
       @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 Crono::Config::PIDFILE
       expect(@config.daemonize).to be false
+      expect(@config.environment).to be_eql ENV["RAILS_ENV"]
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crono
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Dzmitry Plashchynski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -105,6 +105,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Changes.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -113,6 +114,7 @@ files:
 - Rakefile
 - bin/crono
 - crono.gemspec
+- examples/monitrc.conf
 - lib/crono.rb
 - lib/crono/cli.rb
 - lib/crono/config.rb