coil 1.3.0

data/rbi/coil.rbi

@@ -0,0 +1,326 @@
+# typed: true
+
+module Coil
+  AnyMessage = T.type_alias {
+    T.any(
+      Inbox::Message,
+      Outbox::Message
+    )
+  }
+
+  AnyMessageClass = T.type_alias {
+    T.any(
+      T.class_of(Inbox::Message),
+      T.class_of(Outbox::Message)
+    )
+  }
+end
+
+class Coil::ApplicationJob
+  include ::Sidekiq::Worker
+end
+
+class Coil::ApplicationRecord < ::ActiveRecord::Base
+end
+
+class Coil::Engine < ::Rails::Engine
+end
+
+module Coil::Inbox
+  class << self
+    sig { returns(String) }
+    def table_name_prefix; end
+  end
+end
+
+class Coil::Inbox::Completion < ::Coil::ApplicationRecord
+  include ::Coil::PreventDestruction
+end
+
+class Coil::Inbox::Message < ::Coil::ApplicationRecord
+  include ::Coil::TransactionalMessage
+  include ::Coil::PreventDestruction
+
+  abstract!
+
+  sig { params(processor_name: String).void }
+  def enqueue_job(processor_name = T.unsafe(nil)); end
+
+  sig { abstract.returns(T.class_of(::Coil::TransactionalMessagesJob)) }
+  def job_class; end
+
+  sig { params(interval: T.untyped, processor_name: String).void }
+  def perform_job_in(interval, processor_name = T.unsafe(nil)); end
+
+  class << self
+    sig do
+      type_parameters(:P)
+        .params(
+          keys: T::Array[T.untyped],
+          wait: T::Boolean,
+          blk: T.proc.returns(T.type_parameter(:P))
+        ).returns(T.type_parameter(:P))
+    end
+    def locking_persistence_queue(keys:, wait: true, &blk); end
+
+    sig do
+      type_parameters(:P)
+        .params(
+          keys: T::Array[T.untyped],
+          wait: T::Boolean,
+          blk: T.proc.returns(T.type_parameter(:P))
+        ).returns(T.type_parameter(:P))
+    end
+    def locking_process_queue(keys:, wait: true, &blk); end
+  end
+end
+
+Coil::Inbox::Message::COMPLETION = Coil::Inbox::Completion
+Coil::Inbox::Message::PERSISTENCE_QUEUE = T.let(T.unsafe(nil), String)
+Coil::Inbox::Message::PROCESS_QUEUE = T.let(T.unsafe(nil), String)
+
+class Coil::Inbox::MessagesPeriodicJob < ::Coil::TransactionalMessagesPeriodicJob
+  private
+
+  sig { override.returns(T.class_of(::Coil::Inbox::Message)) }
+  def message_parent_class; end
+end
+
+module Coil::Outbox
+  class << self
+    sig { returns(String) }
+    def table_name_prefix; end
+  end
+end
+
+class Coil::Outbox::Completion < ::Coil::ApplicationRecord
+  include ::Coil::PreventDestruction
+end
+
+class Coil::Outbox::Message < ::Coil::ApplicationRecord
+  include ::Coil::TransactionalMessage
+  include ::Coil::PreventDestruction
+  extend ::Coil::TransactionalMessage::ClassMethods
+
+  abstract!
+
+  sig { params(processor_name: String).void }
+  def enqueue_job(processor_name = T.unsafe(nil)); end
+
+  sig { abstract.returns(T.class_of(::Coil::TransactionalMessagesJob)) }
+  def job_class; end
+
+  sig { params(interval: T.untyped, processor_name: String).void }
+  def perform_job_in(interval, processor_name = T.unsafe(nil)); end
+
+  class << self
+    sig do
+      type_parameters(:P)
+        .params(
+          keys: T::Array[T.untyped],
+          wait: T::Boolean,
+          blk: T.proc.returns(T.type_parameter(:P))
+        ).returns(T.type_parameter(:P))
+    end
+    def locking_persistence_queue(keys:, wait: true, &blk); end
+
+    sig do
+      type_parameters(:P)
+        .params(
+          keys: T::Array[T.untyped],
+          wait: T::Boolean,
+          blk: T.proc.returns(T.type_parameter(:P))
+        ).returns(T.type_parameter(:P))
+    end
+    def locking_process_queue(keys:, wait: true, &blk); end
+  end
+end
+
+Coil::Outbox::Message::COMPLETION = Coil::Outbox::Completion
+Coil::Outbox::Message::PERSISTENCE_QUEUE = T.let(T.unsafe(nil), String)
+Coil::Outbox::Message::PROCESS_QUEUE = T.let(T.unsafe(nil), String)
+
+class Coil::Outbox::MessagesPeriodicJob < ::Coil::TransactionalMessagesPeriodicJob
+  private
+
+  sig { override.returns(T.class_of(::Coil::Outbox::Message)) }
+  def message_parent_class; end
+end
+
+module Coil::PreventDestruction
+  extend ::ActiveSupport::Concern
+
+  private
+
+  def prevent_destruction; end
+end
+
+module Coil::QueueLocking
+  include ::Kernel
+  extend ::Coil::QueueLocking
+  extend self
+
+  sig do
+    type_parameters(:P)
+      .params(
+        queue_type: String,
+        message_type: String,
+        message_keys: T::Array[T.untyped],
+        wait: T::Boolean,
+        blk: T.proc.returns(T.type_parameter(:P))
+      ).returns(T.type_parameter(:P))
+  end
+  def locking(queue_type:, message_type:, message_keys:, wait: T.unsafe(nil), &blk); end
+
+  private
+
+  sig { returns(ActiveRecord::ConnectionAdapters::AbstractAdapter) }
+  def connection; end
+
+  sig { params(key: Key).void }
+  def lock(key:); end
+
+  sig { params(fn: String, key: Key).returns(String) }
+  def sql(fn:, key:); end
+
+  sig { params(key: Key).void }
+  def try_lock(key:); end
+
+  sig do
+    type_parameters(:P)
+      .params(
+        key: Key,
+        wait: T::Boolean,
+        blk: T.proc.returns(T.type_parameter(:P))
+      ).returns(T.type_parameter(:P))
+  end
+  def with_lock(key:, wait:, &blk); end
+end
+
+Coil::QueueLocking::ACQUIRE_LOCK = T.let(T.unsafe(nil), String)
+
+class Coil::QueueLocking::Key
+  sig { params(queue_type: String, message_type: String, message_key: T.untyped).void }
+  def initialize(queue_type:, message_type:, message_key:); end
+
+  def int64; end
+
+  def text; end
+
+  private
+
+  sig { params(obj: T.untyped).returns(T.untyped) }
+  def normalize(obj); end
+
+  sig { params(message_key: T.untyped).returns(String) }
+  def stringify(message_key); end
+end
+
+Coil::QueueLocking::Key::PREFIX = T.let(T.unsafe(nil), String)
+
+class Coil::QueueLocking::LockWaitTimeout < ::StandardError; end
+
+Coil::QueueLocking::TRY_ACQUIRE_LOCK = T.let(T.unsafe(nil), String)
+
+module Coil::TransactionalMessage
+  extend ::ActiveSupport::Concern
+
+  sig do
+    type_parameters(:P)
+      .params(
+        wait: T::Boolean,
+        blk: T.proc.returns(T.type_parameter(:P))
+      ).returns(T.type_parameter(:P))
+  end
+  def locking_persistence_queue(wait: T.unsafe(nil), &blk); end
+
+  sig { params(processor_name: String).void }
+  def processed(processor_name:); end
+
+  sig { params(processor_name: String).returns(T::Boolean) }
+  def processed?(processor_name:); end
+
+  sig { params(processor_name: String).returns(ActiveRecord::Relation) }
+  def unprocessed_predecessors(processor_name:); end
+
+  private
+
+  sig { returns(ActiveRecord::Relation) }
+  def completions; end
+end
+
+module Coil::TransactionalMessage::ClassMethods
+  def locking_persistence_queue(keys:, wait: T.unsafe(nil), &blk); end
+  def locking_process_queue(keys:, wait: T.unsafe(nil), &blk); end
+  def next_in_line(key:, processor_name:); end
+  def processed(processor_name:); end
+  def unprocessed(processor_name:); end
+end
+
+class Coil::TransactionalMessagesJob < ::Coil::ApplicationJob
+  abstract!
+
+  sig { params(key: T.untyped, processor_name: String).void }
+  def perform(key, processor_name = T.unsafe(nil)); end
+
+  private
+
+  sig do
+    type_parameters(:P)
+      .params(
+        key: T.untyped,
+        blk: T.proc.returns(T.type_parameter(:P))
+      ).returns(T.type_parameter(:P))
+  end
+  def locking(key, &blk); end
+
+  sig { abstract.returns(::Coil::AnyMessageClass) }
+  def message_class; end
+
+  sig { params(key: T.untyped, processor_name: String).returns(T.nilable(::Coil::AnyMessage)) }
+  def next_message(key:, processor_name:); end
+
+  sig do
+    overridable
+      .type_parameters(:P)
+      .params(
+        message: ::Coil::AnyMessage,
+        processor_name: String,
+        blk: T.proc.returns(T.type_parameter(:P))
+      ).returns(T.type_parameter(:P))
+  end
+  def around_process(message, processor_name:, &blk); end
+
+  sig { overridable.params(message: ::Coil::AnyMessage).void }
+  def pre_process(message); end
+
+  sig { abstract.params(message: ::Coil::AnyMessage).void }
+  def process(message); end
+
+  sig do
+    params(
+      key: T.untyped,
+      processor_name: String,
+      deadline: ActiveSupport::TimeWithZone
+    ).returns(T.nilable(::Coil::AnyMessage))
+  end
+  def process_messages(key:, processor_name:, deadline:); end
+end
+
+class Coil::TransactionalMessagesJob::DuplicateJobError < ::StandardError; end
+Coil::TransactionalMessagesJob::MAX_DURATION = T.let(T.unsafe(nil), ActiveSupport::Duration)
+class Coil::TransactionalMessagesJob::RetryableError < ::StandardError; end
+
+class Coil::TransactionalMessagesPeriodicJob < ::Coil::ApplicationJob
+  abstract!
+
+  sig { void }
+  def perform; end
+
+  private
+
+  sig { abstract.returns(::Coil::AnyMessageClass) }
+  def message_parent_class; end
+end
+
+Coil::VERSION = T.let(T.unsafe(nil), String)

metadata

@@ -0,0 +1,263 @@
+--- !ruby/object:Gem::Specification
+name: coil
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Odeko
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.6
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.6
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: tapioca
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: parlour
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+description: Transactional inbox/outbox
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/jobs/coil/application_job.rb
+- app/jobs/coil/inbox/messages_periodic_job.rb
+- app/jobs/coil/outbox/messages_periodic_job.rb
+- app/jobs/coil/transactional_messages_job.rb
+- app/jobs/coil/transactional_messages_periodic_job.rb
+- app/models/coil/application_record.rb
+- app/models/coil/inbox.rb
+- app/models/coil/inbox/completion.rb
+- app/models/coil/inbox/message.rb
+- app/models/coil/outbox.rb
+- app/models/coil/outbox/completion.rb
+- app/models/coil/outbox/message.rb
+- app/models/concerns/coil/prevent_destruction.rb
+- app/models/concerns/coil/transactional_message.rb
+- config/routes.rb
+- db/migrate/20240604163650_create_coil_tables.rb
+- lib/coil.rb
+- lib/coil/engine.rb
+- lib/coil/queue_locking.rb
+- lib/coil/version.rb
+- lib/tasks/coil_tasks.rake
+- rbi/coil.rbi
+homepage:
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Transactional inbox/outbox
+test_files: []