procrastinator 0.6.1 → 1.0.0.pre.rc2

data/lib/procrastinator/task_store/file_transaction.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Procrastinator
+   module TaskStore
+      # The general idea is that there may be two threads that need to do these actions on the same file:
+      #    thread A:   read
+      #    thread B:   read
+      #    thread A/B: write
+      #    thread A/B: write
+      #
+      # When this sequence happens, the second file write is based on old information and loses the info from
+      # the prior write. Using a global mutex per file path prevents this case.
+      #
+      # This situation can also occur with multi processing, so file locking is also used for solitary access.
+      # File locking is only advisory in some systems, though, so it may only work against other applications
+      # that request a lock.
+      #
+      # @author Robin Miller
+      class FileTransaction
+         # Holds the mutual exclusion locks for file paths by name
+         @file_mutex = {}
+
+         class << self
+            attr_reader :file_mutex
+         end
+
+         def initialize(path)
+            @path = ensure_path(path)
+         end
+
+         # Alias for transact(writable: false)
+         def read(&block)
+            transact(writable: false, &block)
+         end
+
+         # Alias for transact(writable: true)
+         def write(&block)
+            transact(writable: true, &block)
+         end
+
+         # Completes the given block as an atomic transaction locked using a global mutex table.
+         # The block is provided the current file contents.
+         # The block's result is written to the file.
+         def transact(writable: false)
+            semaphore = FileTransaction.file_mutex[@path.to_s] ||= Mutex.new
+
+            semaphore.synchronize do
+               @path.open(writable ? 'r+' : 'r') do |file|
+                  file.flock(File::LOCK_EX)
+
+                  yield_result = yield(file.read)
+                  if writable
+                     file.rewind
+                     file.write yield_result
+                     file.truncate(file.pos)
+                  end
+                  yield_result
+               end
+            end
+         end
+
+         private
+
+         def ensure_path(path)
+            path = Pathname.new path
+            unless path.exist?
+               path.dirname.mkpath
+               FileUtils.touch path
+            end
+            path
+         end
+      end
+   end
+end

data/lib/procrastinator/task_store/simple_comma_store.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'pathname'
+
+module Procrastinator
+   module TaskStore
+      # Simple Task I/O adapter that writes task information (ie. TaskMetaData attributes) to a CSV file.
+      #
+      # SimpleCommaStore is not designed for efficiency or large loads (10,000+ tasks).
+      #
+      # For critical production environments, it is strongly recommended to use a more robust storage mechanism like a
+      # proper database.
+      #
+      # @author Robin Miller
+      class SimpleCommaStore
+         # ordered
+         HEADERS = [:id, :queue, :run_at, :initial_run_at, :expire_at,
+                    :attempts, :last_fail_at, :last_error, :data].freeze
+
+         EXT          = 'csv'
+         DEFAULT_FILE = Pathname.new("procrastinator-tasks.#{ EXT }").freeze
+
+         TIME_FIELDS = [:run_at, :initial_run_at, :expire_at, :last_fail_at].freeze
+
+         READ_CONVERTER = proc do |value, field_info|
+            if field_info.header == :data
+               value
+            elsif TIME_FIELDS.include? field_info.header
+               value.empty? ? nil : Time.parse(value)
+            else
+               begin
+                  Integer(value)
+               rescue ArgumentError
+                  value
+               end
+            end
+         end
+
+         attr_reader :path
+
+         def initialize(file_path = DEFAULT_FILE)
+            @path = Pathname.new(file_path)
+
+            if @path.directory? || @path.to_s.end_with?('/')
+               @path /= DEFAULT_FILE
+            elsif @path.extname.empty?
+               @path = @path.dirname / "#{ @path.basename }.csv"
+            end
+
+            @path = @path.expand_path
+
+            freeze
+         end
+
+         def read(filter = {})
+            FileTransaction.new(@path).read do |existing_data|
+               parse(existing_data).select do |row|
+                  filter.keys.all? do |key|
+                     row[key] == filter[key]
+                  end
+               end
+            end
+         end
+
+         # Saves a task to the CSV file.
+         #
+         # @param queue [String] queue name
+         # @param run_at [Time, nil] time to run the task at
+         # @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)
+               max_id = tasks.collect { |task| task[:id] }.max || 0
+
+               new_data = {
+                     id:             max_id + 1,
+                     queue:          queue,
+                     run_at:         run_at,
+                     initial_run_at: initial_run_at || run_at,
+                     expire_at:      expire_at,
+                     attempts:       0,
+                     data:           data
+               }
+
+               generate(tasks + [new_data])
+            end
+         end
+
+         def update(id, data)
+            FileTransaction.new(@path).write do |existing_data|
+               tasks     = parse(existing_data)
+               task_data = tasks.find do |task|
+                  task[:id] == id
+               end
+
+               task_data&.merge!(data)
+
+               generate(tasks)
+            end
+         end
+
+         def delete(id)
+            FileTransaction.new(@path).write do |file_content|
+               existing_data = parse(file_content)
+               generate(existing_data.reject { |task| task[:id] == id })
+            end
+         end
+
+         def generate(data)
+            lines = data.collect do |d|
+               TIME_FIELDS.each do |field|
+                  d[field] = d[field]&.iso8601
+               end
+               CSV.generate_line(d, headers: HEADERS, force_quotes: true).strip
+            end
+
+            lines.unshift(HEADERS.join(','))
+
+            lines.join("\n") << "\n"
+         end
+
+         private
+
+         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
+
+            headers = data.shift || HEADERS
+
+            data = data.collect do |d|
+               headers.zip(d).to_h
+            end
+
+            correct_types(data)
+         end
+
+         def correct_types(data)
+            non_empty_keys = [:run_at, :expire_at, :attempts, :last_fail_at]
+
+            data.collect do |hash|
+               non_empty_keys.each do |key|
+                  hash.delete(key) if hash[key].is_a?(String) && hash[key].empty?
+               end
+
+               hash[:attempts] ||= 0
+
+               # hash[:data]  = (hash[:data] || '').gsub('""', '"')
+               hash[:queue] = hash[:queue].to_sym
+
+               hash
+            end
+         end
+      end
+   end
+end

data/lib/procrastinator/test/mocks.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Procrastinator
+   module Test
+      # Testing mock Task class
+      #
+      # You can use this like:
+      #
+      #    require 'procrastinator/rspec/mocks'
+      #    # ...
+      #    Procrastinator.config do |c|
+      #       c.define_queue :test_queue, Procrastinator::RSpec::MockTask
+      #    end
+      #
+      # @see MockDataTask for data-accepting tasks
+      class MockTask
+         attr_accessor :container, :logger, :scheduler
+
+         def run
+            @run = true
+         end
+
+         def run?
+            @run
+         end
+      end
+
+      # Data-accepting MockTask
+      #
+      # @see MockTask
+      class MockDataTask < MockTask
+         attr_accessor :data
+      end
+   end
+end

data/lib/procrastinator/version.rb

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

data/lib/procrastinator.rb

@@ -1,32 +1,38 @@
+# frozen_string_literal: true
+
 require 'procrastinator/version'
+require 'procrastinator/task_meta_data'
+require 'procrastinator/logged_task'
+require 'procrastinator/queue'
 require 'procrastinator/queue_worker'
-require 'procrastinator/task_worker'
-require 'procrastinator/environment'
-require 'logger'
-
+require 'procrastinator/config'
+require 'procrastinator/task'
+require 'procrastinator/scheduler'
+require 'procrastinator/task_store/file_transaction'
+require 'procrastinator/task_store/simple_comma_store'
 
+require 'logger'
+require 'pathname'
+
+# Top-level module for the Procrastinator Gem.
+#
+# Call Procrastinator.setup with a block to configure task queues.
+#
+# See README for details.
+#
+# @author Robin Miller
+#
+# @see https://github.com/TenjinInc/procrastinator
 module Procrastinator
-   @@test_mode = false
-
+   # Creates a configuration object and passes it into the given block.
+   #
+   # @yield the created configuration object
+   # @return [Scheduler] a scheduler object that can be used to interact with the queues
    def self.setup(&block)
-      raise ArgumentError.new('Procrastinator.setup must be given a block') if block.nil?
-
-      env = Environment.new(test_mode: @@test_mode)
+      raise ArgumentError, 'Procrastinator.setup must be given a block' unless block
 
-      yield(env)
-
-      raise RuntimeError.new('setup block must call #persister_factory on the environment') if env.persister.nil?
-      raise RuntimeError.new('setup block must call #define_queue on the environment') if env.queue_definitions.empty?
-      env.spawn_workers
-
-      env
-   end
-
-   def self.test_mode=(value)
-      @@test_mode = value
-   end
+      config = Config.new(&block)
 
-   def self.test_mode
-      @@test_mode
+      Scheduler.new(config)
    end
 end

data/procrastinator.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'procrastinator/version'
 
@@ -9,22 +10,27 @@ Gem::Specification.new do |spec|
    spec.authors = ['Robin Miller']
    spec.email   = ['robin@tenjin.ca']
 
-   spec.summary     = %q{Delayed task queues made simple.}
-   spec.description = %q{A strightforward job queue that is not dependent on Rails or any particular database or persistence mechanism.}
+   spec.summary     = 'For apps to put off work until later'
+   spec.description = 'A flexible pure Ruby job queue. Tasks are reschedulable after failures.'
    spec.homepage    = 'https://github.com/TenjinInc/procrastinator'
    spec.license     = 'MIT'
+   spec.metadata    = {
+         'rubygems_mfa_required' => 'true'
+   }
 
    spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
    spec.bindir        = 'exe'
    spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
    spec.require_paths = ['lib']
 
-   spec.required_ruby_version = '> 2.0'
+   spec.required_ruby_version = '>= 2.4'
 
-   spec.add_development_dependency 'bundler', '~> 1.11'
-   spec.add_development_dependency 'rake', '~> 10.0'
-   spec.add_development_dependency 'rspec', '~> 3.0'
-   spec.add_development_dependency 'timecop', '~> 0.8'
-   spec.add_development_dependency 'simplecov', '~> 0.11'
-   spec.add_development_dependency 'fakefs', '~> 0.10'
+   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'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procrastinator
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0.pre.rc2
 platform: ruby
 authors:
 - Robin Miller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,86 +16,113 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        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: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  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: '0.8'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 0.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
-  name: fakefs
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
-description: A strightforward job queue that is not dependent on Rails or any particular
-  database or persistence mechanism.
+        version: '0.9'
+description: A flexible pure Ruby job queue. Tasks are reschedulable after failures.
 email:
 - robin@tenjin.ca
 executables: []
@@ -104,43 +131,54 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASE_NOTES.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/procrastinator.rb
-- lib/procrastinator/environment.rb
+- lib/procrastinator/config.rb
+- lib/procrastinator/logged_task.rb
+- lib/procrastinator/queue.rb
 - lib/procrastinator/queue_worker.rb
-- lib/procrastinator/task_worker.rb
+- lib/procrastinator/rake/daemon_tasks.rb
+- lib/procrastinator/rake/tasks.rb
+- lib/procrastinator/scheduler.rb
+- lib/procrastinator/task.rb
+- lib/procrastinator/task_meta_data.rb
+- lib/procrastinator/task_store/file_transaction.rb
+- lib/procrastinator/task_store/simple_comma_store.rb
+- lib/procrastinator/test/mocks.rb
 - lib/procrastinator/version.rb
 - procrastinator.gemspec
 homepage: https://github.com/TenjinInc/procrastinator
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Delayed task queues made simple.
+summary: For apps to put off work until later
 test_files: []