procrastinator 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51731c709ddfb60d6a9bd082e2fec2d2c0d71da125311dd54e77778c206f662f
-  data.tar.gz: 95153dd8707910af0a3ee9c54cc48e74ad25e3a2eca8f7f69e7b042a838f8ba2
+  metadata.gz: dc44a4968d52be8482c61e47a86cd1773cd160e827f4ac8a6e4ac5fd3bbe6b8f
+  data.tar.gz: 8e3494bfa1a6494f16736c2937a20385cd8231b7615194c8f3b52dbf1d16a4e5
 SHA512:
-  metadata.gz: 076b5c80dcebb746405dc9a27992bc51665f90d5aeb40a67cd982e0b1eba66f8c4b85e65ba213d7e36ed27a7c736574e3cb396d5619d73a51e6877bc6df7dd99
-  data.tar.gz: 02574c2182eb4f7f6c861a413b6c3764bdb772c3201740b8460381543e16d78779963b9dc64a9e11d8fc12f4bf100196de8e730cab697cb9b495fa3c9e0bd5ff
+  metadata.gz: c0644921316f9db7ef0d1d3ee24fab20a5cf458077b16636e42d793387c9f9198e122ca959f113e777b82eb7d61983229f6a3afb09aab0931dce0fa507c6a13b
+  data.tar.gz: 4a2a86a807672c8b9335f1c835f90a80440045b787b75ff51d2e791e2f7075abb50be8e42362419742573ef1b160f262dae6eebb1d73b6377a635f5f805d85eb

data/.rubocop.yml

@@ -1,10 +1,10 @@
-inherit_from: ../.rubocop.yml
+inherit_from: ~/.config/rubocop/config.yml
 
 AllCops:
   Exclude:
     - 'bin/*'
 
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
 
 Layout/LineLength:
   Exclude:
@@ -23,4 +23,3 @@ Metrics/BlockLength:
 Metrics/ModuleLength:
   Exclude:
     - 'spec/**/*.rb'
-

data/.ruby-version

@@ -1 +1 @@
-ruby-2.4.2
+ruby-2.7.8

data/Gemfile

@@ -2,5 +2,17 @@
 
 source 'https://rubygems.org'
 
+group :development do
+   gem 'bundler', '~> 2.3'
+   gem 'fakefs', '~> 1.8'
+   gem 'rake', '~> 13.0'
+   gem 'rspec', '~> 3.9'
+   gem 'rubocop', '~> 1.12'
+   gem 'rubocop-performance', '~> 1.10'
+   gem 'simplecov', '~> 0.18.0'
+   gem 'timecop', '~> 0.9'
+   gem 'yard', '~> 0.9'
+end
+
 # Specify your gem's dependencies in procrastinator.gemspec
 gemspec

data/README.md

@@ -514,7 +514,7 @@ Procrastinator::Rake::DaemonTasks.define do
 end
 ```
 
-You can name the daemon process by specifying the pid_path with a specific .pid file. If does not end with '.pid' it is
+You can title the daemon process by specifying the pid_path with a specific .pid file. If does not end with '.pid' it is
 assumed to be a directory name, and `procrastinator.pid` is appended.
 
 ```ruby
@@ -531,6 +531,11 @@ Procrastinator::Rake::DaemonTasks.define(pid_path: 'pids') do
 end
 ```
 
+> **Note:** There can be a distinction between process full title (`/proc/*/cmdline`) vs the shorter name
+> (`/proc/*/comm`). Some tools like `ps`  and `top` display the process title, while others like `pstree` show the process name.
+>
+> Procrastinator uses Ruby's `Process.setproctitle`, which only affects the title.
+
 Either run the generated Rake tasks in a terminal or with your daemon monitoring tool of choice (eg. Monit, systemd)
 
 ```bash

data/RELEASE_NOTES.md

@@ -1,5 +1,35 @@
 # Release Notes
 
+## 1.2.0 (         )
+
+### Major Changes
+
+* none
+
+### Minor Changes
+
+* Updated minimum ruby to 2.7
+
+### Bugfixes
+
+* When logging is disabled, it points to `File::NULL` instead of a dead-end StringIO
+
+## 1.1.0 (2022-10-16)
+
+### Major Changes
+
+* none
+
+### Minor Changes
+
+* Removed process name limit.
+
+### Bugfixes
+
+* have_task matcher:
+    * Fixed have_task handling of nested matchers like be_within
+    * Improved have_task handling of string queue names vs symbols
+
 ## 1.0.1 (2022-09-20)
 
 ### Major Changes

data/lib/procrastinator/queue.rb

@@ -81,13 +81,18 @@ module Procrastinator
       # Fetch a task matching the given identifier
       #
       # @param identifier [Hash] attributes to match
+      #
+      # @raise [NoSuchTaskError] when no task matches the identifier.
+      # @raise [AmbiguousTaskFilterError] when many tasks match the identifier, meaning you need to be more specific.
       def fetch_task(identifier)
          identifier[:data] = JSON.dump(identifier[:data]) if identifier[:data]
 
          tasks = read(**identifier)
 
-         raise "no task found matching #{ identifier }" if tasks.nil? || tasks.empty?
-         raise "too many (#{ tasks.size }) tasks match #{ identifier }. Found: #{ tasks }" if tasks.size > 1
+         raise NoSuchTaskError, "no task found matching #{ identifier }" if tasks.nil? || tasks.empty?
+         if tasks.size > 1
+            raise AmbiguousTaskFilterError, "too many (#{ tasks.size }) tasks match #{ identifier }. Found: #{ tasks }"
+         end
 
          TaskMetaData.new(tasks.first.merge(queue: self))
       end
@@ -97,6 +102,9 @@ module Procrastinator
       # @param run_at [Time] Earliest time to attempt running the task
       # @param expire_at [Time, nil] Time after which the task will not be attempted
       # @param data [Hash, String, Numeric, nil] The data to save
+      #
+      # @raise [ArgumentError] when the keyword `:data` is needed by the task handler, but is missing
+      # @raise [MalformedTaskError] when the keyword `:data` is provided but not expected by the task handler.
       def create(run_at:, expire_at:, data:)
          if data.nil? && expects_data?
             raise ArgumentError, "task #{ @task_class } expects to receive :data. Provide :data to #delay."
@@ -220,8 +228,16 @@ module Procrastinator
       include QueueValidation
    end
 
+   # Raised when a task matching certain criteria is requested but nothing matching is found
+   class NoSuchTaskError < RuntimeError
+   end
+
+   # Raised when a task matching certain criteria is requested but more than one option is found
+   class AmbiguousTaskFilterError < RuntimeError
+   end
+
    # Raised when a Task Handler does not conform to the expected API
-   class MalformedTaskError < StandardError
+   class MalformedTaskError < RuntimeError
    end
 
    # Raised when a Task Store strategy does not conform to the expected API

data/lib/procrastinator/queue_worker.rb

@@ -13,6 +13,8 @@ module Procrastinator
       # expected methods for all persistence strategies
       PERSISTER_METHODS = [:read, :update, :delete].freeze
 
+      NULL_FILE = File.open(File::NULL, File::WRONLY)
+
       def initialize(queue:, config:)
          raise ArgumentError, ':queue cannot be nil' if queue.nil?
          raise ArgumentError, ':config cannot be nil' if config.nil?
@@ -26,13 +28,13 @@ module Procrastinator
                   end
 
          @scheduler = Scheduler.new(config)
-         @logger    = Logger.new(StringIO.new)
+         @logger    = Logger.new(File::NULL)
       end
 
       # Works on jobs forever
       def work!
          @logger = open_log!("#{ name }-queue-worker", @config)
-         @logger.info("Started worker thread to consume queue: #{ name }")
+         @logger.info "Started worker thread to consume queue: #{ name }"
 
          loop do
             sleep(@queue.update_period)
@@ -72,12 +74,14 @@ module Procrastinator
 
       # Starts a log file and returns the created Logger
       def open_log!(name, config)
-         return @logger unless config.log_level
-
-         log_path = config.log_dir / "#{ name }.log"
+         if config.log_level
+            log_path = config.log_dir / "#{ name }.log"
 
-         config.log_dir.mkpath
-         FileUtils.touch(log_path)
+            config.log_dir.mkpath
+            FileUtils.touch(log_path)
+         else
+            log_path = NULL_FILE
+         end
 
          Logger.new(log_path.to_path,
                     config.log_shift_age, config.log_shift_size,
@@ -90,6 +94,6 @@ module Procrastinator
    # Raised when a Task Storage strategy is missing a required part of the API.
    #
    # @see TaskStore
-   class MalformedTaskPersisterError < StandardError
+   class MalformedTaskPersisterError < RuntimeError
    end
 end

data/lib/procrastinator/rspec/matchers.rb

@@ -5,23 +5,30 @@ require 'rspec/expectations'
 # Determines if the given task store has a task that matches the expectation hash
 RSpec::Matchers.define :have_task do |expected_task|
    match do |task_store|
-      task_store.read.any? do |task|
-         task_hash        = task.to_h
-         task_hash[:data] = JSON.parse(task_hash[:data], symbolize_names: true) unless task_hash[:data].empty?
-
-         expected_task.all? do |field, expected_value|
-            expected_value = case field
-                             when :queue
-                                expected_value.to_sym
-                             when :run_at, :initial_run_at, :expire_at, :last_fail_at
-                                Time.at(expected_value.to_i)
-                             else
-                                expected_value
-                             end
-
-            values_match? expected_value, task_hash[field]
+      expected_task[:queue] = expected_task[:queue].to_sym if expected_task[:queue]
+
+      Procrastinator::Task::TIME_FIELDS.each do |time_field|
+         if expected_task[time_field]&.respond_to?(:to_i)
+            expected_task[time_field] = Time.at(expected_task[time_field].to_i)
+         end
+      end
+
+      expected = a_hash_including(expected_task)
+
+      actual_tasks = task_store.read.collect do |task|
+         task_hash = task.to_h
+         unless task_hash[:data].nil? || task_hash[:data].empty?
+            task_hash[:data] = JSON.parse(task_hash[:data], symbolize_names: true)
+         end
+         task_hash[:queue] = task_hash[:queue].to_sym if task_hash[:queue]
+         Procrastinator::Task::TIME_FIELDS.each do |time_field|
+            task_hash[time_field] = Time.at(task_hash[time_field].to_i) if task_hash[time_field]&.respond_to?(:to_i)
          end
+
+         task_hash
       end
+
+      values_match? a_collection_including(expected), actual_tasks
    end
 
    description do

data/lib/procrastinator/scheduler.rb

@@ -253,9 +253,6 @@ module Procrastinator
          # Default directory to store PID files in.
          DEFAULT_PID_DIR = Pathname.new('/tmp').freeze
 
-         # Maximum process name size. 15 chars is linux limit
-         MAX_PROC_LEN = 15
-
          # 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.
          #
@@ -363,11 +360,6 @@ module Procrastinator
          def rename_process(pid_path)
             name = pid_path.basename(PID_EXT).to_s
 
-            if name.size > MAX_PROC_LEN
-               @logger.warn "Process name is longer than max length (#{ MAX_PROC_LEN }). Trimming to fit."
-               name = name[0, MAX_PROC_LEN]
-            end
-
             if system('pidof', name, out: File::NULL)
                @logger.warn "Another process is already named '#{ name }'. Consider the 'name:' keyword to distinguish."
             end

data/lib/procrastinator/task.rb

@@ -10,6 +10,9 @@ module Procrastinator
    class Task
       extend Forwardable
 
+      # Fields that store time information
+      TIME_FIELDS = [:run_at, :initial_run_at, :expire_at, :last_fail_at].freeze
+
       def_delegators :@metadata,
                      :id, :run_at, :initial_run_at, :expire_at,
                      :attempts, :last_fail_at, :last_error,

data/lib/procrastinator/task_store/simple_comma_store.rb

@@ -19,9 +19,6 @@ module Procrastinator
          HEADERS = [:id, :queue, :run_at, :initial_run_at, :expire_at,
                     :attempts, :last_fail_at, :last_error, :data].freeze
 
-         # Columns that store time information
-         TIME_FIELDS = [:run_at, :initial_run_at, :expire_at, :last_fail_at].freeze
-
          # CSV file extension
          EXT = 'csv'
 
@@ -34,7 +31,7 @@ module Procrastinator
          READ_CONVERTER = proc do |value, field_info|
             if field_info.header == :data
                value
-            elsif TIME_FIELDS.include? field_info.header
+            elsif Task::TIME_FIELDS.include? field_info.header
                value.empty? ? nil : Time.parse(value)
             else
                begin
@@ -130,7 +127,7 @@ module Procrastinator
          # @return [String] Generated CSV string
          def generate(data)
             lines = data.collect do |d|
-               TIME_FIELDS.each do |field|
+               Task::TIME_FIELDS.each do |field|
                   d[field] = d[field]&.iso8601
                end
                CSV.generate_line(d, headers: HEADERS, force_quotes: true).strip

data/lib/procrastinator/version.rb

@@ -2,5 +2,5 @@
 
 module Procrastinator
    # Version number of this release
-   VERSION = '1.0.1'
+   VERSION = '1.2.0'
 end

data/procrastinator.gemspec

@@ -23,15 +23,5 @@ Gem::Specification.new do |spec|
    spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
    spec.require_paths = ['lib']
 
-   spec.required_ruby_version = '>= 2.4'
-
-   spec.add_development_dependency 'bundler', '~> 2.3'
-   spec.add_development_dependency 'fakefs', '~> 1.8'
-   spec.add_development_dependency 'rake', '~> 13.0'
-   spec.add_development_dependency 'rspec', '~> 3.9'
-   spec.add_development_dependency 'rubocop', '~> 1.12'
-   spec.add_development_dependency 'rubocop-performance', '~> 1.10'
-   spec.add_development_dependency 'simplecov', '~> 0.18.0'
-   spec.add_development_dependency 'timecop', '~> 0.9'
-   spec.add_development_dependency 'yard', '~> 0.9'
+   spec.required_ruby_version = '>= 2.7'
 end

metadata

@@ -1,141 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: procrastinator
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Robin Miller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: fakefs
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.0
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
+date: 2023-06-17 00:00:00.000000000 Z
+dependencies: []
 description: A flexible pure Ruby job queue. Tasks are reschedulable after failures.
 email:
 - robin@tenjin.ca
@@ -184,14 +58,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: For apps to put off work until later