tasks_scheduler 0.3.0 → 0.5.1

data/app/models/scheduled_task/log.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 class ScheduledTask < ActiveRecord::Base
   module Log
     def log_file(identifier)
       unless log_identifiers.include?(identifier)
-        fail "Log identifier unknown: \"#{identifier}\" (Valid: #{log_identifiers})"
+        raise "Log identifier unknown: \"#{identifier}\" (Valid: #{log_identifiers})"
       end
+
       Rails.root.join('log', 'tasks_scheduler', "#{id}_#{identifier}.log")
     end
 
@@ -24,11 +27,11 @@ class ScheduledTask < ActiveRecord::Base
 
     def log_on_end(exception)
       running_log = log_file(LOG_RUNNING)
-      if ::File.exist?(running_log)
-        target_log = exception ? log_file(LOG_UNSUCCESSFUL) : log_file(LOG_SUCCESSFUL)
-        File.unlink(target_log) if File.exist?(target_log)
-        File.rename(running_log, target_log)
-      end
+      return unless ::File.exist?(running_log)
+
+      target_log = exception ? log_file(LOG_UNSUCCESSFUL) : log_file(LOG_SUCCESSFUL)
+      File.unlink(target_log) if File.exist?(target_log)
+      File.rename(running_log, target_log)
     end
   end
 end

data/app/models/scheduled_task/runner.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 class ScheduledTask < ActiveRecord::Base
   module Runner
     def run
       log_on_start
       run_banner
       return if process_running? && pid != Process.pid
+
       status_on_start
       exception = invoke_task
       on_end_running(exception, STATUS_FAILED)
@@ -33,7 +36,7 @@ class ScheduledTask < ActiveRecord::Base
 
     def run_banner
       run_log("Task: #{self}")
-      run_log("PID: #{pid ? pid : '-'} (Current: #{Process.pid})")
+      run_log("PID: #{pid || '-'} (Current: #{Process.pid})")
       run_log("Process running? #{process_running? ? 'Yes' : 'No'}")
       run_log("Rails.env: #{Rails.env}")
     end
@@ -44,15 +47,16 @@ class ScheduledTask < ActiveRecord::Base
         Rake::Task.clear
         Rails.application.load_tasks
         Rake::Task[task].invoke(*invoke_args)
-      rescue StandardError => ex
-        run_log(ex, :fatal)
-        exception = ex
+      rescue StandardError => e
+        run_log(e, :fatal)
+        exception = e
       end
       exception
     end
 
     def invoke_args
-      return [] unless args.present?
+      return [] if args.blank?
+
       args.split('|')
     end
   end

data/app/models/scheduled_task/status.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 class ScheduledTask < ActiveRecord::Base
   module Status
     def status
       return STATUS_DISABLED unless enabled?
       return STATUS_RUNNING if running?
       return STATUS_WAITING if waiting?
-      last_fail_status.present? ? last_fail_status : STATUS_FAILED
+
+      last_fail_status.presence || STATUS_FAILED
     end
 
     def failed?
@@ -17,6 +20,7 @@ class ScheduledTask < ActiveRecord::Base
 
     def waiting?
       return true if ended?(last_run_successful_end, last_run_unsuccessful_end)
+
       status_attributes.all? { |a| send(a).blank? }
     end
 
@@ -27,11 +31,11 @@ class ScheduledTask < ActiveRecord::Base
     end
 
     def status_on_start
-      update_attributes!(last_run_start: Time.zone.now)
+      update!(last_run_start: Time.zone.now)
     end
 
     def status_on_end(exception, last_fail_status)
-      update_attributes!(
+      update!(
         next_run: calculate_next_run,
         (exception ? :last_run_unsuccessful_start : :last_run_successful_start) => last_run_start,
         (exception ? :last_run_unsuccessful_end : :last_run_successful_end) => Time.zone.now,
@@ -42,7 +46,7 @@ class ScheduledTask < ActiveRecord::Base
     end
 
     def status_attributes
-      %w(start successful_start successful_end unsuccessful_start unsuccessful_end).map do |a|
+      %w[start successful_start successful_end unsuccessful_start unsuccessful_end].map do |a|
         "last_run_#{a}"
       end
     end

data/config/initializers/assets.rb

@@ -1 +1,3 @@
-Rails.application.config.assets.precompile += %w( active_scaffold/indicator.gif )
+# frozen_string_literal: true
+
+Rails.application.config.assets.precompile += %w[active_scaffold/indicator.gif]

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Rails.application.routes.draw do
   resources(:scheduled_tasks) do
     as_routes

data/db/migrate/20161122123828_create_scheduled_tasks.rb

@@ -1,4 +1,8 @@
-class CreateScheduledTasks < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class CreateScheduledTasks < (
+    Rails.version < '5.2' ? ActiveRecord::Migration : ActiveRecord::Migration[4.2]
+  )
   def change
     create_table :scheduled_tasks do |t|
       t.string :scheduling

data/db/migrate/20161123130153_add_status_attributes_to_scheduled_tasks.rb

@@ -1,4 +1,8 @@
-class AddStatusAttributesToScheduledTasks < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddStatusAttributesToScheduledTasks < (
+    Rails.version < '5.2' ? ActiveRecord::Migration : ActiveRecord::Migration[4.2]
+  )
   def change
     add_column :scheduled_tasks, :last_run_start, :datetime
     add_column :scheduled_tasks, :last_run_successful_start, :datetime

data/db/migrate/20161124200712_add_pid_to_scheduled_tasks.rb

@@ -1,4 +1,8 @@
-class AddPidToScheduledTasks < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddPidToScheduledTasks < (
+    Rails.version < '5.2' ? ActiveRecord::Migration : ActiveRecord::Migration[4.2]
+  )
   def change
     add_column :scheduled_tasks, :pid, :integer
   end

data/db/migrate/20161128163702_add_args_to_scheduled_tasks.rb

@@ -1,4 +1,8 @@
-class AddArgsToScheduledTasks < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddArgsToScheduledTasks < (
+    Rails.version < '5.2' ? ActiveRecord::Migration : ActiveRecord::Migration[4.2]
+  )
   def change
     add_column :scheduled_tasks, :args, :string
   end

data/db/migrate/20180223155025_add_last_fail_status_to_scheduled_tasks.rb

@@ -1,4 +1,8 @@
-class AddLastFailStatusToScheduledTasks < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddLastFailStatusToScheduledTasks < (
+    Rails.version < '5.2' ? ActiveRecord::Migration : ActiveRecord::Migration[4.2]
+  )
   def change
     add_column :scheduled_tasks, :last_fail_status, :string
   end

data/db/migrate/20180302170138_add_enabled_to_scheduled_tasks.rb

@@ -1,4 +1,8 @@
-class AddEnabledToScheduledTasks < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddEnabledToScheduledTasks < (
+    Rails.version < '5.2' ? ActiveRecord::Migration : ActiveRecord::Migration[4.2]
+  )
   def change
     add_column :scheduled_tasks, :enabled, :boolean, null: false, default: true
   end

data/exe/tasks_scheduler

@@ -1,12 +1,14 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'daemons'
 require 'fileutils'
 
 def find_rails_root(dir = Dir.pwd)
-  fail 'Rails root not found' if dir == '' || dir == '/' || dir == '.'
+  raise 'Rails root not found' if ['', '/', '.'].include?(dir)
   return dir if File.exist?(File.expand_path('config/environment.rb', dir))
+
   rails_root(File.dirname(dir))
 end
 

data/exe/tasks_scheduler_run_task

@@ -1,11 +1,13 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'daemons'
 
 def find_rails_root(dir = Dir.pwd)
-  fail 'Rails root not found' if dir == '' || dir == '/' || dir == '.'
+  raise 'Rails root not found' if ['', '/', '.'].include?(dir)
   return dir if File.exist?(File.expand_path('config/environment.rb', dir))
+
   rails_root(File.dirname(dir))
 end
 

data/lib/tasks_scheduler.rb

@@ -1,11 +1,7 @@
-require 'tasks_scheduler/engine'
-require 'active_scaffold'
-require 'js-routes'
-require 'parse-cron'
-require 'tasks_scheduler/cron_scheduling_validator'
-require 'tasks_scheduler/cron_parser_patch'
-require 'tasks_scheduler/checker'
-require 'tasks_scheduler/daemon'
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
 
 module TasksScheduler
+  ::EacRubyUtils.require_sub __FILE__
 end

data/lib/tasks_scheduler/app_gem.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_gems_utils/gem'
+require 'singleton'
+
+module TasksScheduler
+  class AppGem < ::SimpleDelegator
+    include ::Singleton
+
+    def initialize
+      super(::EacRubyGemsUtils::Gem.new(::Rails.root))
+    end
+
+    def bundle(*args)
+      super(*args).chdir_root.envvar('RAILS_ENV', ::Rails.env)
+    end
+  end
+end

data/lib/tasks_scheduler/checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tasks_scheduler/checker/log'
 
 module TasksScheduler
@@ -5,8 +7,8 @@ module TasksScheduler
     include Singleton
 
     CHECK_INTERVAL = 15
-    LOG_ON_FILE_ENV_KEY = 'TASKS_SCHEDULER_LOG_ON_FILE'.freeze
-    LOGS_KEYS = %w(rails stdout stderr).freeze
+    LOG_ON_FILE_ENV_KEY = 'TASKS_SCHEDULER_LOG_ON_FILE'
+    LOGS_KEYS = %w[rails stdout stderr].freeze
 
     def run
       check_log
@@ -40,6 +42,7 @@ CODE
 
     def check_log
       return unless log_on_file?
+
       ::Rails.logger = ::Logger.new(rails_log.path)
       $stdout.reopen(stdout_log.path, 'w')
       $stderr.reopen(stderr_log.path, 'w')

data/lib/tasks_scheduler/checker/log.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 
 module TasksScheduler

data/lib/tasks_scheduler/cron_parser_patch.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
+require 'parse-cron'
+
 module TasksScheduler
   module CronParserPatch
     class TasksSchedulerTimeSource
       class << self
-        def local(year, month, day, hour, min, second)
+        def local(year, month, day, hour, min, second) # rubocop:disable Metrics/ParameterLists
           Time.utc(year, month, day, hour, min, second)
         end
 

data/lib/tasks_scheduler/cron_scheduling_validator.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module TasksScheduler
   class CronSchedulingValidator < ActiveModel::EachValidator
     def validate_each(record, attribute, value)
       return if value_valid?(value)
+
       record.errors[attribute] << (options[:message] ||
           I18n.translate(:cron_scheduling_validator_error_message))
     end

data/lib/tasks_scheduler/daemon.rb

@@ -1,28 +1,35 @@
-require 'open3'
+# frozen_string_literal: true
+
+require 'tasks_scheduler/app_gem'
 
 module TasksScheduler
   class Daemon
-    ACTIONS = %w(status start stop restart).freeze
+    ACTIONS = %w[status start stop restart].freeze
 
     class << self
-      def execute(action)
+      def daemon_command(action)
         raise "Action not allowed: #{action} (Allowed: #{ACTIONS})" unless ACTIONS.include?(action)
-        command = ['bundle', 'exec', 'tasks_scheduler', action]
-        Dir.chdir(Rails.root) do
-          Open3.popen3(env_args, *command) do |_stdin, stdout, stderr, wait_thr|
-            { action: action, env_args: env_args.map { |k, v| "#{k}=#{v}" }.join(' | '),
-              command: command.join(' '), status: wait_thr.value.to_i, stdout: stdout.read,
-              stderr: stderr.read }
-          end
-        end
+
+        ::TasksScheduler::AppGem.instance.bundle('exec', 'tasks_scheduler', action)
+                                .envvar(::TasksScheduler::Checker::LOG_ON_FILE_ENV_KEY, '1')
+      end
+
+      def execute(action)
+        command = daemon_command(action)
+        result = command.execute
+        {
+          action: action, env_args: env_args_to_s(command), command: command.to_s,
+          status: result.fetch(:exit_code), stdout: result.fetch(:stdout),
+          stderr: result.fetch(:stderr)
+        }
       end
 
       def running?
         execute('status')[:status].zero?
       end
 
-      def env_args
-        { 'RAILS_ENV' => Rails.env, ::TasksScheduler::Checker::LOG_ON_FILE_ENV_KEY => '1' }
+      def env_args_to_s(command)
+        command.send(:extra_options).fetch(:envvars).map { |k, v| "#{k}=#{v}" }.join(' | ')
       end
     end
   end

data/lib/tasks_scheduler/engine.rb

@@ -1,3 +1,8 @@
+# frozen_string_literal: true
+
+require 'active_scaffold'
+require 'js-routes'
+
 module TasksScheduler
   class Engine < ::Rails::Engine
     initializer :append_migrations do |app|

data/lib/tasks_scheduler/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TasksScheduler
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.5.1'
 end

data/test/dummy/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path('config/application', __dir__)
 
 Rails.application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ApplicationController < ActionController::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 module ApplicationHelper
 end

data/test/dummy/bin/bundle

@@ -1,3 +1,5 @@
 #!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+# frozen_string_literal: true
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application', __FILE__)
+# frozen_string_literal: true
+
+APP_PATH = File.expand_path('../config/application', __dir__)
 require_relative '../config/boot'
 require 'rails/commands'

data/test/dummy/bin/rake

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require_relative '../config/boot'
 require 'rake'
 Rake.application.run

data/test/dummy/bin/setup

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'pathname'
 
 # path to your application root.
-APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+APP_ROOT = Pathname.new File.expand_path('..', __dir__)
 
 Dir.chdir APP_ROOT do
   # This script is a starting point to setup your application.