arask 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0ccff09799aceb6f771f22a6d9d981ee0edcfcd
-  data.tar.gz: 015acd74815a762ef5f837e0388e268613519952
+  metadata.gz: 655fe5d9cc2a34ed951492948dfb6074d5d2dc78
+  data.tar.gz: 96e999e71c7da10bd302a2e531ac03c151a6cf29
 SHA512:
-  metadata.gz: b599908a948826e65cbfc794a1c94ca245199a47a75dad79711fe5880c8a9f912265b4b07342d84017ee7646612bdb701653d94bbe2600151f24df28910e476e
-  data.tar.gz: d8a2fc39027e99da66b37be2fe442449f8c8257f6d61cd27a6752c3f7ebe924135237316a99fdf810f3816528f5c20b02e07c3944000155b4633bb9229201fe0
+  metadata.gz: 33142e354cdd8bacefa017f47bfded3bc1b2c91d4a48b3895e10e99dc0cb37906fd13ec9d4fc84faeea02744c5e362cc451fa1937248b6d0aee10ac58b21b63d
+  data.tar.gz: ec4ba50c19be1c1baabb22612bffff7649a765f8bcf019b747b3c0262eb93665b3ee2ae66803cddf5175c7b23d5402479ce9a0d78a8df307738ccfbdbf8f82c8

data/README.md

@@ -1,7 +1,10 @@
 # Arask
+[![Build Status](https://travis-ci.org/Ebbe/arask.svg?branch=master)](https://travis-ci.org/Ebbe/arask)
+[![Gem Version](https://badge.fury.io/rb/arask.svg)](https://badge.fury.io/rb/arask)
+
 Automatic RAils taSKs (with minimal setup).
 
-No need to setup anything outside of Rails. If Rails is running, so is Arask.
+No need to setup anything outside of Rails. If Rails is running, so is Arask. If Rails has been stopped, the next time rails starts, Arask will go through overdue jobs and perform them.
 
 Use cron syntax or simply define the interval.
 
@@ -10,13 +13,25 @@ After installation, you can edit config/initializers/arask.rb with your tasks.
 
 ### Examples of jobs in the initializer
 ```ruby
-arask.create script: 'puts "IM ALIVE!"', interval: :daily, run_first_time: true
-arask.create script: 'Attachment.process_new', interval: 5.hours if Rails.env.production?
+# Rake tasks with cron syntax
 arask.create task: 'send:logs', cron: '0 2 * * *' # At 02:00 every day
 arask.create task: 'update:cache', cron: '*/5 * * * *' # Every 5 minutes
-# Run rake task:
+
+# Scripts with interval (when time of day or month etc doesn't matter)
+arask.create script: 'puts "IM ALIVE!"', interval: :daily
 arask.create task: 'my:awesome_task', interval: :hourly
-# On exceptions, send email
+arask.create task: 'my:awesome_task', interval: 3.minutes
+
+# Run an ActiveJob.
+arask.create job: 'ImportCurrenciesJob', interval: 1.month
+
+# Only run on production
+arask.create script: 'Attachment.process_new', interval: 5.hours if Rails.env.production?
+
+# Run first time. If the job didn't exist already when starting rails, run it:
+arask.create script: 'Attachment.process_new', interval: 5.hours, run_first_time: true
+
+# On exceptions, send email with details
 arask.on_exception email: 'errors@example.com'
 ```
 
@@ -45,7 +60,6 @@ Setup your tasks in config/initializers/arask.rb. Initially it looks [like this]
 
 ## Todos
 * Have a "try again" feature. For instance `arask.create script: 'raise "I failed"', interval: :daily, fail_retry: 5.minutes, retry_at_most: 2`
-* Tests
 
 ## Setup for Heroku
 None. But if you use a hobby dyno and it falls to sleep, so will Arask. As soon as the dyno wakes up, Arask will run any pending jobs.

data/Rakefile

@@ -22,6 +22,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
 task default: :test

data/lib/arask/initialize.rb

@@ -1,11 +1,24 @@
 Arask.setup do |arask|
-  # Examples
-  #arask.create script: 'puts "IM ALIVE!"', interval: :daily, run_first_time: true
-  #arask.create script: 'Attachment.process_new', interval: 5.hours if Rails.env.production?
+  ## Examples
+
+  # Rake tasks with cron syntax
   #arask.create task: 'send:logs', cron: '0 2 * * *' # At 02:00 every day
   #arask.create task: 'update:cache', cron: '*/5 * * * *' # Every 5 minutes
-  # Run rake task:
+
+  # Scripts with interval (when time of day or month etc doesn't matter)
+  #arask.create script: 'puts "IM ALIVE!"', interval: :daily
   #arask.create task: 'my:awesome_task', interval: :hourly
-  # On exceptions, send email
+  #arask.create task: 'my:awesome_task', interval: 3.minutes
+
+  # Run an ActiveJob.
+  #arask.create job: 'ImportCurrenciesJob', interval: 1.month
+
+  # Only run on production
+  #arask.create script: 'Attachment.process_new', interval: 5.hours if Rails.env.production?
+
+  # Run first time. If the job didn't exist already when starting rails, run it:
+  #arask.create script: 'Attachment.process_new', interval: 5.hours, run_first_time: true
+
+  # On exceptions, send email with details
   #arask.on_exception email: 'errors@example.com'
 end

data/lib/arask/setup.rb

@@ -6,21 +6,8 @@ module Arask
       puts "Arask could not parse parameter for on_exception!" unless email.class == String
     end
 
-    def self.create(script: nil, task: nil, interval: nil, cron: nil, run_first_time: false)
-      unless interval.nil?
-        case interval
-        when :hourly
-          interval = 1.hour
-        when :daily
-          interval = 1.day
-        when :monthly
-          interval = 1.month
-        end
-        interval = interval.to_s.to_i
-      end
-      unless cron.nil?
-        interval = 'cron: ' + cron
-      end
+    def self.create(script: nil, task: nil, job: nil, interval: nil, cron: nil, run_first_time: false)
+      interval = parse_interval_or_cron(interval, cron)
       if interval.nil?
         puts 'Arask: You did not specify either cron: or interval:! When should the task run?'
         return
@@ -28,6 +15,9 @@ module Arask
       unless task.nil?
         script = "Rake::Task['#{task}'].invoke"
       end
+      unless job.nil?
+        script = "#{job}.perform_now"
+      end
       if script.nil?
         puts 'Arask: You did not specify a script or task to run!'
         return
@@ -40,12 +30,32 @@ module Arask
           job = AraskJob.create(job: script, interval: interval)
           Arask.jobs_touched << job.id
           if run_first_time===true
-            job.run
+            job.update_attribute(:execute_at, Time.now)
           end
         end
       rescue ActiveRecord::StatementInvalid => e
         puts 'Could not create arask job! Looks like the database is not migrated? Remember to run `rails generate arask:install` and `rails db:migrate`'
       end
     end
+
+    private
+    def self.parse_interval_or_cron(interval, cron)
+      unless interval.nil?
+        case interval
+        when :hourly
+          interval = 1.hour
+        when :daily
+          interval = 1.day
+        when :monthly
+          interval = 1.month
+        end
+        interval = interval.to_s.to_i
+      end
+      unless cron.nil?
+        interval = 'cron: ' + cron
+      end
+      return interval
+    end
+
   end
 end

data/lib/arask/version.rb

@@ -1,3 +1,3 @@
 module Arask
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/arask.rb

@@ -8,6 +8,8 @@ module Arask
   class << self; attr_accessor :jobs_touched, :exception_email, :exception_email_from; end
 
   def self.setup
+    # Make sure we only run setup if Rails is actually run as a server or testing.
+    return unless defined?(Rails::Server) or Rails.env.test?
     Arask.jobs_touched = []
     yield Setup
     begin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arask
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Esben Damgaard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-14 00:00:00.000000000 Z
+date: 2018-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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: With minimal setup, be able to regularly run tasks in Rails. Either user
   cron syntax or simply define an interval.
 email: