arask 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad49ba051c8cfa4ab0b8c3328bfd37bba6f284ae
+  data.tar.gz: 5eeefd82e1a06a6a81fd063c3ef8fc38220aadde
+SHA512:
+  metadata.gz: e54575c4eb12a57d78ebdd7ea408b034869f96bf032dfb2865e984b280a681ff066262232aed03da147cc5768096d87c7511c32fed43adbc961da60b2ddef43e
+  data.tar.gz: edbc56ec38e0373fb80085a63dce63ecb619ede93940c6ea6ae246adef394759ff3b4b8250c58df427488fd96db14359275d267da049480712b2f5112826c91f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Esben Damgaard
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# Arask
+Automatic RAils taSKs.
+
+Beware that these tasks are only run when ActionController has successfully rendered an action. The interval specified is the _least_ time that will go since last run.
+
+## Usage
+After installation, you can edit config/initializers/arask.rb with your tasks.
+
+### Examples
+```ruby
+arask.create script: 'puts "IM ALIVE!"', interval: :daily, run_first_time: true
+arask.create script: 'Attachment.process_new', interval: 5.hours
+# Run rake task:
+arask.create task: 'my:awesome_task', interval: :hourly
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arask'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Then install the initializer template and migration:
+```bash
+$ rails generate arask:install
+```
+
+Setup your tasks in config/initializers/arask.rb.
+
+## Contributing
+Please use https://github.com/Ebbe/arask
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Arask'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/arask/arask_job.rb

@@ -0,0 +1,20 @@
+module Arask
+  require 'rake'
+
+  class AraskJob < ActiveRecord::Base
+    def run
+      self.update_attribute(:execute_at, self.interval.seconds.from_now)
+      begin
+        if self.job.start_with?('Rake::Task')
+          Rake.load_rakefile Rails.root.join( 'Rakefile' )
+        end
+        eval(self.job)
+      rescue Exception => e
+        # TODO: Alert broken job
+        puts 'Arask: Job failed'
+        p self
+        puts e.message
+      end
+    end
+  end
+end

data/lib/arask/initialize.rb

@@ -0,0 +1,7 @@
+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
+  # Run rake task:
+  #arask.create task: 'my:awesome_task', interval: :hourly
+end

data/lib/arask/railtie.rb

@@ -0,0 +1,4 @@
+module Arask
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/arask/version.rb

@@ -0,0 +1,3 @@
+module Arask
+  VERSION = '0.1.1'
+end

data/lib/arask.rb

@@ -0,0 +1,77 @@
+require "arask/railtie"
+require "arask/arask_job"
+
+module Arask
+  class << self; attr_accessor :time_cache; end
+
+  def self.setup
+    @jobs_touched = []
+    yield Arask
+    begin
+      AraskJob.all.where.not(id: @jobs_touched).delete_all
+    rescue
+    end
+  end
+
+  def self.create(script: nil, task: nil, interval:, run_first_time: false)
+    case interval
+    when :hourly
+      interval = 1.hour
+    when :daily
+      interval = 1.day
+    when :monthly
+      interval = 1.month
+    end
+    interval = interval.to_s.to_i
+    unless task.nil?
+      script = "Rake::Task['#{task}'].invoke"
+    end
+    if script.nil?
+      puts 'Arask: You did not specify a script or task to run!'
+      return
+    end
+    begin
+      job = AraskJob.where(job: script, interval: interval).first
+      if job
+        @jobs_touched << job.id
+      else
+        job = AraskJob.create(job: script, interval: interval, execute_at: interval.seconds.from_now)
+        @jobs_touched << job.id
+        if run_first_time===true
+          job.run
+        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
+
+
+  class RunJobs < ActiveJob::Base
+    queue_as :default
+
+    def perform
+      AraskJob.transaction do
+        AraskJob.where('execute_at < ?', DateTime.now).lock.each do |job|
+          job.run
+        end
+      end
+      next_job = AraskJob.order(execute_at: :desc).first
+      if next_job
+        Arask.time_cache = next_job.interval.seconds.from_now
+      else
+        Arask.time_cache = 5.minutes.from_now
+      end
+    end
+  end
+
+  ActionController::Base.instance_eval do
+    after_action do
+      Arask.time_cache ||= Time.now
+      if Arask.time_cache <= Time.now
+        Arask.time_cache = 5.minutes.from_now
+        RunJobs.perform_later
+      end
+    end
+  end
+end

data/lib/generators/arask/install_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+require "rails/generators/active_record"
+
+class Arask::InstallGenerator < Rails::Generators::Base
+  def initialize(*args, &block)
+    super
+
+    Arask::InstallGenerator.source_root File.expand_path('../../arask', __FILE__)
+    copy_file '../../arask/initialize.rb', 'config/initializers/arask.rb'
+
+    generate 'migration', 'create_arask_jobs job:string execute_at:datetime:index interval:integer'
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: arask
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Esben Damgaard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+description: With minimal setup, be able to regularly run tasks.
+email:
+- esben@hvemder.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/arask.rb
+- lib/arask/arask_job.rb
+- lib/arask/initialize.rb
+- lib/arask/railtie.rb
+- lib/arask/version.rb
+- lib/generators/arask/install_generator.rb
+homepage: http://github.com/Ebbe/arask
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Automatic RAils taSKs
+test_files: []