procrastinator 1.0.0.pre.rc2 → 1.0.0.pre.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0d5fdab8cda8f1e8eee673be60373214b9619e6dfccbc8e1859bfd13d8f2709
-  data.tar.gz: 932688bb438481332e0ad0f22bcb243760400fafe54a641db4687fb7242d28f2
+  metadata.gz: 40bd65d0f873fba25ce55e8ab2e00934c15340ae3106d64e461abee8a08ff043
+  data.tar.gz: f28a1f18b563a29f8d4f3030ae8df273b47d387fdde7b03e4ed92dc40eebf810
 SHA512:
-  metadata.gz: c6d67aa9803f623778a2660075be6634f31f23a18463b2cd86cce55ccbba6d4c009febd2be35bcc411a635a530c10beaee8eb6f523d9312767ac77f89e59ca2a
-  data.tar.gz: 2f0dc42e8824e40aee38526e0f4963c7347de9290c4b0b061e77e498282f8c40055ad477c7b0c6dfda78440bbd8d78d7b1c44040356aafc8c2ec0b0d1f582bc5
+  metadata.gz: '084cbefb918ee3193ef0589712d6ddbf2fde592d3f43c0d8b080e6816956c32d7f00fda8f136ee3d0ffa953314c288f195d7343eec110d0156386a72b792fe4f'
+  data.tar.gz: fcdbe66ed04995bdf89a6b4a13ddf5b9dc0302257d3f78521d9c28bbf7b81b227357254884afb56258a5191c7927588266d608e0aabc213121657d9107999a4f

data/lib/procrastinator/rake/daemon_tasks.rb

@@ -19,36 +19,68 @@ module Procrastinator
          #
          # @param (see #define)
          # @see DaemonTasks#define
-         def self.define(**args)
-            new.define(**args)
+         def self.define(**args, &block)
+            new.define(**args, &block)
          end
 
          # Defines procrastinator:start and procrastinator:stop Rake tasks that operate on the given scheduler.
-         # If provided a block, that block will run in the daemon process.
          #
-         # @param scheduler [Procrastinator::Scheduler]
-         # @param pid_path [Pathname, File, String, nil]
-         def define(scheduler:, pid_path: nil, &block)
-            pid_path = Scheduler::DaemonWorking.normalize_pid(pid_path)
+         # @param pid_path [Pathname, File, String, nil] The pid file path
+         # @yieldreturn scheduler [Procrastinator::Scheduler]
+         #
+         # @see Scheduler::DaemonWorking#daemonized!
+         def define(pid_path: nil)
+            raise ArgumentError, 'must provide a scheduler builder block' unless block_given?
+
+            @pid_path = Scheduler::DaemonWorking.normalize_pid pid_path
 
             namespace :procrastinator do
+               desc 'Start the Procrastinator daemon'
                task :start do
-                  scheduler.work.daemonized!(pid_path, &block)
+                  start(yield)
                end
 
+               desc 'Show Procrastinator daemon status'
                task :status do
-                  if Scheduler::DaemonWorking.running?(pid_path)
-                     warn "Procrastinator instance running (pid #{ File.read(pid_path) })"
-                  else
-                     warn "No Procrastinator instance detected for #{ pid_path }"
-                  end
+                  status
                end
 
-               task :stop do
-                  Scheduler::DaemonWorking.halt!(pid_path)
+               desc 'Stop the Procrastinator daemon'
+               task stop: [:status] do
+                  stop
                end
+
+               desc 'Restart Procrastinator daemon'
+               task restart: [:stop, :start]
             end
          end
+
+         private
+
+         def start(scheduler)
+            warn 'Starting Procrastinator'
+            scheduler.work.daemonized!(@pid_path)
+         end
+
+         def status
+            warn "Checking #{ @pid_path }..."
+            msg = if Scheduler::DaemonWorking.running?(@pid_path)
+                     "Procrastinator pid #{ File.read(@pid_path) } instance running."
+                  elsif File.exist?(@pid_path)
+                     "Procrastinator pid #{ File.read(@pid_path) } is not running. Maybe it crashed?"
+                  else
+                     "Procrastinator is not running (No such file - #{ @pid_path })"
+                  end
+
+            warn msg
+         end
+
+         def stop
+            return unless Scheduler::DaemonWorking.running?(@pid_path)
+
+            Scheduler::DaemonWorking.halt!(@pid_path)
+            warn "Procrastinator pid #{ File.read(@pid_path) } halted."
+         end
       end
    end
 end

data/lib/procrastinator/scheduler.rb

@@ -47,7 +47,7 @@ module Procrastinator
          UpdateProxy.new(@config, identifier: identifier.merge(queue: queue.to_s))
       end
 
-      # Removes an existing task, as located by the givne identifying information.
+      # Removes an existing task, as located by the given identifying information.
       #
       # The identifier can include any data field stored in the task loader. Often this is the information in :data.
       #
@@ -249,28 +249,27 @@ module Procrastinator
          # 15 chars is linux limit
          MAX_PROC_LEN = 15
 
-         # Consumes the current process and turns it into a background daemon. A log will be started in the log
-         # directory defined in the configuration block.
+         # Consumes the current process and turns it into a background daemon and proceed as #threaded.
+         # Additional logging is recorded in the directory specified by the Procrastinator.setup configuration.
          #
          # If pid_path ends with extension '.pid', the basename will be requested as process title (depending on OS
          # support). An extensionless path is assumed to be a directory and a default filename (and proctitle) is used.
          #
          # @param pid_path [Pathname, File, String, nil] Path to where the process ID file is to be kept.
-         # @yield [void] Block to run after daemonization
-         def daemonized!(pid_path = nil, &block)
-            spawn_daemon(pid_path, &block)
+         def daemonized!(pid_path = nil)
+            spawn_daemon(pid_path)
 
             threaded
          end
 
          # Normalizes the given pid path, including conversion to absolute path and defaults.
          #
-         # @param pid_path [Pathname, String] path to normalize
+         # @param pid_path [Pathname, File, String, nil] path to normalize
          def self.normalize_pid(pid_path)
-            pid_path = Pathname.new(pid_path || DEFAULT_PID_DIR)
-            pid_path /= "#{ PROG_NAME.downcase }#{ PID_EXT }" unless pid_path.extname == PID_EXT
+            normalized = Pathname.new(pid_path || DEFAULT_PID_DIR)
+            normalized /= "#{ PROG_NAME.downcase }#{ PID_EXT }" unless normalized.extname == PID_EXT
 
-            pid_path.expand_path
+            normalized.expand_path
          end
 
          # Stops the procrastinator process denoted by the provided pid file
@@ -287,15 +286,13 @@ module Procrastinator
             Process.getpgid pid
 
             true
-         rescue Errno::ESRCH
+         rescue Errno::ENOENT, Errno::ESRCH
             false
          end
 
          private
 
-         # "You, search from the spastic dentistry department down through disembowelment. You, cover children's dance
-         #  recitals through holiday weekend IKEA. Go."
-         def spawn_daemon(pid_path, &block)
+         def spawn_daemon(pid_path)
             pid_path = DaemonWorking.normalize_pid pid_path
 
             open_log quiet: true
@@ -303,14 +300,14 @@ module Procrastinator
 
             print_debug_context
 
+            # "You, search from the spastic dentistry department down through disembowelment.
+            #  You, cover children's dance recitals through holiday weekend IKEA. Go."
             Process.daemon
 
             manage_pid pid_path
             rename_process pid_path
-
-            yield if block
          rescue StandardError => e
-            @logger.fatal ([e.message] + e.backtrace).join("\n")
+            @logger&.fatal ([e.message] + e.backtrace).join("\n")
             raise e
          end
 
@@ -346,10 +343,10 @@ module Procrastinator
          end
 
          def print_debug_context
-            @logger.debug "Ruby Path: #{ ENV['RUBY_ROOT'] }"
-            @logger.debug "Bundler Path: #{ ENV['BUNDLE_BIN_PATH'] }"
-            # logname is the posix standard and is set by cron, so probably reliable.
-            @logger.debug "Runtime User: #{ ENV['LOGNAME'] || ENV['USERNAME'] }"
+            @logger.debug "Ruby Path: #{ ENV.fetch 'RUBY_ROOT' }"
+            @logger.debug "Bundler Path: #{ ENV.fetch 'BUNDLE_BIN_PATH' }"
+            # LOGNAME is the posix standard and is set by cron, so probably reliable.
+            @logger.debug "Runtime User: #{ ENV.fetch('LOGNAME') || ENV.fetch('USERNAME') }"
          end
 
          def rename_process(pid_path)

data/lib/procrastinator/task_store/simple_comma_store.rb

@@ -54,8 +54,8 @@ module Procrastinator
          end
 
          def read(filter = {})
-            FileTransaction.new(@path).read do |existing_data|
-               parse(existing_data).select do |row|
+            CSVFileTransaction.new(@path).read do |existing_data|
+               existing_data.select do |row|
                   filter.keys.all? do |key|
                      row[key] == filter[key]
                   end
@@ -70,8 +70,7 @@ module Procrastinator
          # @param initial_run_at [Time, nil] first time to run the task at. Defaults to run_at.
          # @param expire_at [Time, nil] time to expire the task
          def create(queue:, run_at:, expire_at:, data: '', initial_run_at: nil)
-            FileTransaction.new(@path).write do |existing_data|
-               tasks  = parse(existing_data)
+            CSVFileTransaction.new(@path).write do |tasks|
                max_id = tasks.collect { |task| task[:id] }.max || 0
 
                new_data = {
@@ -89,8 +88,7 @@ module Procrastinator
          end
 
          def update(id, data)
-            FileTransaction.new(@path).write do |existing_data|
-               tasks     = parse(existing_data)
+            CSVFileTransaction.new(@path).write do |tasks|
                task_data = tasks.find do |task|
                   task[:id] == id
                end
@@ -102,8 +100,7 @@ module Procrastinator
          end
 
          def delete(id)
-            FileTransaction.new(@path).write do |file_content|
-               existing_data = parse(file_content)
+            CSVFileTransaction.new(@path).write do |existing_data|
                generate(existing_data.reject { |task| task[:id] == id })
             end
          end
@@ -121,39 +118,45 @@ module Procrastinator
             lines.join("\n") << "\n"
          end
 
-         private
+         # Adds CSV parsing to the file reading
+         class CSVFileTransaction < FileTransaction
+            def transact(writable: nil)
+               super(writable: writable) do |file_str|
+                  yield(parse(file_str))
+               end
+            end
 
-         def parse(csv_string)
-            data = CSV.parse(csv_string,
-                             headers:           true,
-                             header_converters: :symbol,
-                             skip_blanks:       true,
-                             converters:        READ_CONVERTER,
-                             force_quotes:      true).to_a
+            private
 
-            headers = data.shift || HEADERS
+            def parse(csv_string)
+               data = CSV.parse(csv_string,
+                                headers:     true, header_converters: :symbol,
+                                skip_blanks: true, converters: READ_CONVERTER, force_quotes: true).to_a
 
-            data = data.collect do |d|
-               headers.zip(d).to_h
-            end
+               headers = data.shift || HEADERS
 
-            correct_types(data)
-         end
+               data = data.collect do |d|
+                  headers.zip(d).to_h
+               end
 
-         def correct_types(data)
-            non_empty_keys = [:run_at, :expire_at, :attempts, :last_fail_at]
+               correct_types(data)
+            end
 
-            data.collect do |hash|
-               non_empty_keys.each do |key|
-                  hash.delete(key) if hash[key].is_a?(String) && hash[key].empty?
-               end
+            def correct_types(data)
+               non_empty_keys = [:run_at, :expire_at, :attempts, :last_fail_at]
 
-               hash[:attempts] ||= 0
+               data.collect do |hash|
+                  non_empty_keys.each do |key|
+                     hash.delete(key) if hash[key].is_a?(String) && hash[key].empty?
+                  end
 
-               # hash[:data]  = (hash[:data] || '').gsub('""', '"')
-               hash[:queue] = hash[:queue].to_sym
+                  hash[:attempts] ||= 0
 
-               hash
+                  # hash[:data]  = (hash[:data] || '').gsub('""', '"')
+                  hash[:queue] = hash[:queue].to_sym
+
+                  hash
+               end
             end
          end
       end

data/lib/procrastinator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Procrastinator
-   VERSION = '1.0.0-rc2'
+   VERSION = '1.0.0-rc3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procrastinator
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc2
+  version: 1.0.0.pre.rc3
 platform: ruby
 authors:
 - Robin Miller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-14 00:00:00.000000000 Z
+date: 2022-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler