plok 0.2.3 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c83d448013e7832bf4b624c51592b39f336a642b9edf197135792ac4418a63e
-  data.tar.gz: c7ea5c310c9f68f4005b04750bc1bc93696846ec0f8c6b4ec7147c298d978af7
+  metadata.gz: 9f3772752bb79fb0e5c754451f428a38ffbc921f994c77baace8d553dc3c8534
+  data.tar.gz: 535cc01459273ea5486507ac0ac2c226462040985dc2aa4874170cf770ac568b
 SHA512:
-  metadata.gz: 48743033cccfda8512c87be249cf4e1441e47821183aeb95a6fe1451b0a301daff5bbd7c0543f121e9742ac5009f68ae9c3adf74ddf7791ec27ba0fa5c42407a
-  data.tar.gz: 13da11c0ed6a34dda6acae4f9d28a7d3db3cf20f549d2cbfd0365d9e60ebaac7c8f15c8c06e951ea7f545bfee75fdc9d2cade0261fb0c074ac567cecd07cfe9b
+  metadata.gz: a7242f280f4bc453387b191685b8a1b8857e4371379e5e4f9520cd47bd743c083344e9d9f50911657a0f129db7ce9d0ae793eeca56304bb3d6e8d2aba60432c7
+  data.tar.gz: eacde236f96f7a4109dcda5cf3f1647813ab82a11e7f3ba2e65e541e2106485d4964f854f9f7cdf4cc2371dede4eeb6e84374a3dcb6353421c06f0b7cab26ba6

data/app/models/queued_task.rb

@@ -0,0 +1,64 @@
+class QueuedTask < ActiveRecord::Base
+  include Plok::Loggable
+
+  serialize :data, Hash
+
+  validates :klass, presence: true
+
+  scope :locked, -> { where(locked: true) }
+  scope :unlocked, -> { where('locked = 0 OR locked IS NULL') }
+  scope :in_past, -> { where(perform_at: nil).or(where('perform_at <= ?', Time.zone.now)) }
+  scope :in_future, -> { where('perform_at > ?', Time.zone.now) }
+
+  def lock!
+    update_attribute :locked, true
+  end
+
+  def unlock!
+    update_attribute :locked, false
+  end
+
+  def unlocked?
+    !locked?
+  end
+
+  def execute!
+    klass.to_s.constantize.new(data).execute!
+  end
+
+  def self.queue(klass, data)
+    task = create!(klass: klass.to_s, data: data.except(:perform_at))
+    task.update(perform_at: data[:perform_at]) if data[:perform_at].present?
+    task
+  end
+
+  def self.queue_unless_already_queued(klass, data)
+    task = find_by(klass: klass, data: data)
+    return task if task.present?
+    self.queue(klass, data)
+  end
+
+  def dequeue!
+    destroy
+  end
+
+  def process!
+    lock!
+
+    begin
+      execute!
+      dequeue!
+    rescue
+      raise
+    ensure
+      unlock! unless destroyed?
+    end
+  end
+
+  def stuck?
+    return false if locked?
+    # Make sure task is past its perform_at timestamp.
+    return perform_at <= 30.minutes.ago if perform_at.present?
+    created_at <= 30.minutes.ago
+  end
+end

data/db/migrate/20211015141837_create_plok_queued_tasks.rb

@@ -0,0 +1,14 @@
+class CreatePlokQueuedTasks < ActiveRecord::Migration[6.1]
+  def change
+    return if table_exists?(:queued_tasks)
+
+    create_table :queued_tasks do |t|
+      t.string :klass
+      t.text :data
+      t.boolean :locked
+      t.datetime :perform_at
+
+      t.timestamps
+    end
+  end
+end

data/lib/plok/engine.rb

@@ -1,6 +1,6 @@
 # Can't use Plok::Engine.root yet at this point.
 engine_root = File.expand_path('../..', __dir__)
-Dir.glob("#{engine_root}/app/models/**/*.rb").each { |file| require file }
+Dir.glob("#{engine_root}/app/models/**/*.rb").sort.each { |file| require file }
 
 module Plok
   class Engine < ::Rails::Engine
@@ -40,7 +40,7 @@ module Plok
     # You cannot call it in the engine itself, because RSpec won't have the same
     # context available when tests are ran.
     def load_spec_supports
-      Dir.glob("#{root}/spec/{factories,support}/**/*.rb").each { |f| require f }
+      Dir.glob("#{root}/spec/{factories,support}/**/*.rb").sort.each { |f| require f }
     end
   end
 end

data/lib/plok/version.rb

@@ -1,3 +1,3 @@
 module Plok
-  VERSION = '0.2.3'
+  VERSION = '0.2.7'
 end

data/spec/factories/logs.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory 'log' do
+    content { 'foo' }
+  end
+end

data/spec/factories/queued_tasks.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :queued_task do
+    klass { 'SomeClass' }
+  end
+end

data/spec/support/plok/loggable.rb

@@ -0,0 +1,16 @@
+require 'rails_helper'
+
+shared_examples_for :loggable do
+  let(:klass) { described_class.to_s.underscore.to_sym }
+
+  it :logs do
+    a = create(klass)
+    a.log 'foo'
+    expect(a.logs.count).to be >= 1
+    expect(a.logs.unscoped.last.content).to eq 'foo'
+  end
+
+  it '#respond_to?' do
+    expect(subject).to respond_to(:logs, :log)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plok
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.7
 platform: ruby
 authors:
 - Davy Hellemans
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -82,12 +82,17 @@ files:
 - app/controllers/plok/version_controller.rb
 - app/models/concerns/plok/loggable.rb
 - app/models/log.rb
+- app/models/queued_task.rb
 - config/routes.rb
 - db/migrate/20211008130809_create_plok_logs.rb
+- db/migrate/20211015141837_create_plok_queued_tasks.rb
 - lib/plok.rb
 - lib/plok/engine.rb
 - lib/plok/version.rb
 - lib/tasks/plok_tasks.rake
+- spec/factories/logs.rb
+- spec/factories/queued_tasks.rb
+- spec/support/plok/loggable.rb
 homepage: https://plok.blimp.be
 licenses:
 - MIT