belated 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 639e202c5feb0ecb2af5bcd7f22815128f670f36c2aa793ce5bc0c107477a92f
-  data.tar.gz: 65864414d040a9b1cd3e92897a97b5f596683c42cb6941c5cdbaee731502a622
+  metadata.gz: 3264ca317aa687386cf4f87b45a358b25197e0a8442d79c28116abbdf373cd5c
+  data.tar.gz: fc520d4de51b80b7ec87622f7ef66fd17a60423800a72a402fde7f7361e52a2e
 SHA512:
-  metadata.gz: bda697be3405328560b19afbf9a90cc8cac0a8487e627ba0d6ee02ef2bbd6bf933cf3235fa312a1f817224ade6837da390d6794742a5110b255ca6052cafb838
-  data.tar.gz: da4c2c0b49901ca28aed07eff2d279293c28a3121031500cc4846627d01619fbd24c52b0c382c8c4091d46238df53d827449c7092a85286072a1b74600402313
+  metadata.gz: 5512108388bf979973d471f9107b8f11f1af79320029324053ca748eeac3940635efdbff744410305e185e781de6732fa003ca7251d5d26be1c706e59818f960
+  data.tar.gz: 25045c09fbd423b0169cc4eda7a01a4cbf1e93c6a3ee13d0b574f24fabfd3fae9a58768eb6bef962b8613536c3585fb542e02151950eda82d6867c34a0d6e85f

data/.gitignore

@@ -14,3 +14,4 @@
 /dummy/log/
 /dummy/log/test.log
 belated_dump
+stackprof*

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.4.0] - 2021-08-03
+
+- Now you can enqueue jobs to be done at a later time. Just pass an `at:` keyword param to the client. 
+- Does not save the jobs when you quit. 
+
 ## [0.3.3] - 2021-08-01
 
 - Shutdown trapped signal thread, make sure :shutdown is not recorded as a job. 

data/Gemfile

@@ -11,5 +11,8 @@ gem 'rspec', '~> 3.0'
 
 gem 'rubocop', '~> 1.7'
 
+gem 'database_cleaner-active_record'
 gem 'rails', '>= 6.1.3'
+gem 'rspec-rails'
 gem 'sqlite3'
+gem 'stackprof'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    belated (0.3.3)
+    belated (0.4.0)
       drb
       dry-configurable
 
@@ -72,6 +72,10 @@ GEM
     byebug (11.1.3)
     concurrent-ruby (1.1.9)
     crass (1.0.6)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
     diff-lcs (1.4.4)
     drb (2.0.4)
     dry-configurable (0.12.1)
@@ -145,6 +149,14 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
     rspec-support (3.10.2)
     rubocop (1.18.3)
       parallel (~> 1.10)
@@ -166,6 +178,7 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.2)
+    stackprof (0.2.16)
     thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
@@ -181,11 +194,14 @@ PLATFORMS
 DEPENDENCIES
   belated!
   byebug
+  database_cleaner-active_record
   rails (>= 6.1.3)
   rake (~> 13.0)
   rspec (~> 3.0)
+  rspec-rails
   rubocop (~> 1.7)
   sqlite3
+  stackprof
 
 BUNDLED WITH
    2.2.17

data/README.md

@@ -13,7 +13,8 @@ TODO LIST:
 - Catch SIGTERM and friends
   - Now supports it, partly. 
 - Don't crash on errors (Partially done)
-- Make it possible to schedule jobs
+- Save jobs enqueued at a future date too when quitting (now it only saves the jobs in the queue)
+- Have multiple queues?
 - Maybe support ActiveJob?
 - Have a web UI
 - Do some performance testing
@@ -21,6 +22,7 @@ TODO LIST:
 
 DONE
 
+- ~~Make it possible to schedule jobs~~
 - ~~Marshal the job queue into a file so you don't lose all progress~~
   (Ended up using YAML)
 - ~~Add a logger~~
@@ -98,6 +100,12 @@ client.perform_belated(job)
 
 If you want to pass a job to Belated.
 
+If you don't want the job to run right away, you can also pass it a keyword param `at:` like so:
+
+```ruby
+client.perform_belated(job, Time.now + 1.month)
+```
+
 # Settings
 
 Configuring Belated:
@@ -113,15 +121,15 @@ end
 
 From command line:
 
-$ bundle exec belated --rails=true
+    $ bundle exec belated --rails=true
 
 Use Rails or not.
 
-$ bundle exec belated --rails_path=/my_rails_project
+    $ bundle exec belated --rails_path=/my_rails_project
 
 Path to Rails project.
 
-$ bundle exec belated --workers=10
+    $ bundle exec belated --workers=10
 
 Number of workers.
 

data/lib/belated.rb

@@ -9,6 +9,7 @@ require 'singleton'
 require 'dry-configurable'
 require 'belated/client'
 require 'logger'
+require 'belated/queue'
 
 # Belated is a pure Ruby job backend.
 # It has limited functionality, as it only accepts
@@ -22,7 +23,7 @@ class Belated
   include Singleton unless $TESTING
   URI = 'druby://localhost:8788'
   FILE_NAME = 'belated_dump'
-  @@queue = Queue.new
+  @@queue = Belated::Queue.new
 
   setting :rails, true
   setting :rails_path, '.'
@@ -38,15 +39,15 @@ class Belated
   def start
     boot_app && load_jobs
     @worker_list = []
-    Belated.config.workers.times do |_i|
-      @worker_list << Thread.new { Worker.new }
+    Belated.config.workers.times do |i|
+      @worker_list << Thread.new { Worker.new(number: i.next) }
     end
     return unless Belated.config.connect
 
     connect!
     banner_and_info
     trap_signals
-    DRb.thread.join
+    enqueue_future_jobs
   end
   alias initialize start
 
@@ -55,7 +56,6 @@ class Belated
     DRb.start_service(URI, @@queue, verbose: true)
   rescue DRb::DRbConnError, Errno::EADDRINUSE
     Belated.logger.error 'Could not connect to DRb server.'
-    retry
   end
 
   def trap_signals
@@ -65,7 +65,7 @@ class Belated
           @@queue.push(:shutdown)
         end
         Thread.new { stop_workers }
-        sleep 0.1 until @@queue.empty?
+        sleep 0.1 until @@queue.empty? || $TESTING
         exit
       end
     end
@@ -84,6 +84,19 @@ class Belated
     Belated.config.rails
   end
 
+  def enqueue_future_jobs
+    log 'starting future jobs thread'
+    loop do
+      @@queue.future_jobs.each_with_index do |job, i|
+        if job[:at] <= Time.now.utc
+          log @@queue.future_jobs.delete_at(i)
+          @@queue.push(job[:klass])
+        end
+      end
+      sleep 0.01
+    end
+  end
+
   def load_jobs
     log "reloading... if file exists #{File.exist?(Belated::FILE_NAME)}"
     return unless File.exist?(Belated::FILE_NAME)
@@ -106,7 +119,7 @@ class Belated
       Thread.kill(worker)
     end
     class_array = []
-    @@queue.size.times do |_i|
+    @@queue.length.times do |_i|
       unless (klass = @@queue.pop).instance_of?(Proc) || klass == :shutdown
         class_array << klass
       end

data/lib/belated/client.rb

@@ -1,7 +1,16 @@
 class Belated
+  # The client class is responsible for managing the connection to the
+  # DRb server.
+  # You can enqueue jobs to be processed by the server.
+  # Example:
+  #   client = Belated::Client.new
+  #   client.enqueue(JubJub.new, at: Time.now + 5.seconds)
   class Client
     attr_accessor :queue
 
+    # Starts up the client.
+    # Connects to the queue through DRb.
+    # @return [void]
     def initialize
       server_uri = Belated::URI
       # @bank =
@@ -9,8 +18,12 @@ class Belated
       self.queue = DRbObject.new_with_uri(server_uri)
     end
 
-    def perform(job)
-      queue.push(job)
+    # The method that pushes the jobs to the queue.
+    # @param job [Object] - The the job to be pushed.
+    # @param at [Date] - The time at which the job should be executed.
+    # @return [Object] - The job that was pushed.
+    def perform(job, at: nil)
+      queue.push(job, at: at)
     end
     alias perform_belated perform
     alias perform_later perform

data/lib/belated/job.rb

@@ -0,0 +1 @@
+Job = Struct.new(:klass, :at)

data/lib/belated/queue.rb

@@ -0,0 +1,37 @@
+require 'belated/job'
+
+class Belated
+  class Queue
+    attr_accessor :future_jobs
+
+    def initialize(queue: Thread::Queue.new, future_jobs: [])
+      @queue = queue
+      self.future_jobs = future_jobs
+    end
+
+    def push(job, at: nil)
+      if at.nil?
+        @queue.push(job)
+      else
+        @future_jobs << Job.new(job, at)
+      end
+    end
+
+    def pop
+      @queue.pop
+    end
+
+    def clear
+      @queue.clear
+      self.future_jobs = []
+    end
+
+    def empty?
+      @queue.empty?
+    end
+
+    def length
+      @queue.length
+    end
+  end
+end

data/lib/belated/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Belated
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

data/lib/belated/worker.rb

@@ -1,22 +1,24 @@
 require_relative 'logging'
 class Belated
   # The worker class that actually gets the jobs from the queue
-  # and calls them. Expects the jobs to be procs.
+  # and calls them. Expects the jobs to be procs or
+  # classes that have a perform method.
   class Worker
     include Logging
 
-    def initialize
+    def initialize(number: 1)
+      @number = number
       start_working
     end
 
     def start_working
       loop do
+        log "Worker #{@number} fetching jobs!"
         next unless (job = Belated.fetch_job)
 
         break if job == :shutdown
 
         log call_job(job)
-        log 'fetching jobs...'
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belated
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Sampo Kuokkanen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-01 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: drb
@@ -80,7 +80,9 @@ files:
 - bin/setup
 - lib/belated.rb
 - lib/belated/client.rb
+- lib/belated/job.rb
 - lib/belated/logging.rb
+- lib/belated/queue.rb
 - lib/belated/rails.rb
 - lib/belated/version.rb
 - lib/belated/worker.rb