procrastinator 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3d2c026b206d52c22ad9cb182fa7ea48ff2569eb99647a5cf75aa20e56bde5e
-  data.tar.gz: 1a82220d0b7485bb3de7263fa6bc2265f1612601eab1769eb306c9a5930073ca
+  metadata.gz: 355845de0042676644aa4fd14ba5c37bc173b1f0cac9c73889dbb36aa8e5cd9c
+  data.tar.gz: f4faa2e3644557027c8fc08f88c973deb19cf16e43fb3312106d8d25a3c61054
 SHA512:
-  metadata.gz: bc20963d1541d72024af63effe933823162012deea562f04bbe4303c6c380b26476d8305b6a94551ac50424101e0d7a072d705d01dcbc1ba1f231cd5c51f3184
-  data.tar.gz: 670bc2fe498c40a7c32d2557956321237d9307941397a5bd1c1c7c1718b24e3ceaaa24ee2b8e5960b9967120467b46ad3c3df313ed00ab3a6e77830e626937fb
+  metadata.gz: 3f59116b21f6218d3ef3059e5f5532b1ef23a95e7a5f0b82a1d21a041ff84e64795e2fd7181bd277cba19e6c8fd01fa04146103ec2de9703169e9db7072a817f
+  data.tar.gz: 235b273d6f07e21f492e82083ea89b0f67eb4275233dddbb04d52e25a5a2f3b6a0674e5d0b8dda9b5c43359ea257b081c4d7bf1b7561b4c1a7242f24660b932c

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.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
+
+* none
+
+### Minor Changes
+
+* none
+
+### Bugfixes
+
+* Fixed integration error in rescheduling tasks
+
 ## 1.0.0 (2022-09-18)
 
 ### Major Changes
@@ -32,7 +62,7 @@
     * `load_with` has been removed
 * Removed `task_attr` and `Procrastinator::Task` module. Tasks is now duck-type checked for accessors instead.
 * Added Rake tasks to manage process daemon
-* Times are passed to Task Store as a Ruby Time object instead of an epoch time integer 
+* Times are passed to Task Store as a Ruby Time object instead of an epoch time integer
 * `#delay` is now `#defer`
 
 ### Minor Changes

data/lib/procrastinator/queue.rb

@@ -10,11 +10,11 @@ module Procrastinator
    # @!attribute [r] :task_class
    #    @return [Class] Class that defines the work to be done for jobs in this queue.
    # @!attribute [r] :timeout
-   #    @return [Object] Duration (seconds) after which tasks in this queue should fail for taking too long.
+   #    @return [Numeric] Duration (seconds) after which tasks in this queue should fail for taking too long.
    # @!attribute [r] :max_attempts
-   #    @return [Object] Maximum number of attempts for tasks in this queue.
+   #    @return [Integer] Maximum number of attempts for tasks in this queue.
    # @!attribute [r] :update_period
-   #    @return [Pathname] Delay (seconds) between reloads of tasks from the task store.
+   #    @return [Numeric] Delay (seconds) between reloads of tasks from the task store.
    class Queue
       extend Forwardable
 
@@ -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/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

@@ -3,9 +3,10 @@
 require 'stringio'
 
 module Procrastinator
-   # A Scheduler object provides the API for client applications to manage delayed tasks.
+   # A Scheduler object provides the API for client applications to manage scheduled tasks.
    #
-   # Use #delay to schedule new tasks, #reschedule to alter existing tasks, and #cancel to remove unwanted tasks.
+   # Use Scheduler#defer to schedule new tasks, Scheduler#reschedule to alter existing tasks, and Scheduler#cancel to
+   # remove unwanted tasks.
    #
    # @author Robin Miller
    class Scheduler
@@ -46,7 +47,7 @@ module Procrastinator
       #
       # @see TaskMetaData
       def reschedule(queue, identifier)
-         UpdateProxy.new(@config, identifier: identifier.merge(queue: queue.to_s))
+         UpdateProxy.new(@config.queue(name: queue), identifier: identifier)
       end
 
       # Removes an existing task, as located by the given identifying information.
@@ -88,7 +89,7 @@ module Procrastinator
       class UpdateProxy
          def initialize(queue, identifier:)
             @queue      = queue
-            @identifier = identifier
+            @identifier = identifier.merge(queue: queue.name.to_sym)
          end
 
          def to(run_at: nil, expire_at: nil)
@@ -252,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.
          #
@@ -362,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.0'
+   VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procrastinator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Robin Miller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2022-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -147,7 +147,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.1
-before_install: gem install bundler -v 1.11.2