sequel-pgt_outbox 0.2.0

data/lib/sequel/pgt_outbox.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'sequel'
+require 'sequel_postgresql_triggers'
+Sequel.extension :pg_triggers
+require_relative 'pgt_outbox/version'
+
+module Rubyists
+  # The main namespace for the PgtOutbox library
+  module PgtOutbox
+    DEFINITION = proc do
+      def pgt_outbox_setup(table, opts = {})
+        outbox = Rubyists::PgtOutbox.outbox_table(table, self, opts:)
+        pgt_created_at outbox.name, outbox.created_column
+        pgt_updated_at outbox.name, outbox.updated_column
+        outbox.function.name
+      end
+
+      def pgt_outbox_events(table, function, events: %i[insert update delete], when: nil, opts: {})
+        Rubyists::PgtOutbox::Trigger.create!(self, table, function, events:, opts: opts.merge(when:))
+      end
+    end
+
+    def self.outbox_table(table, db, opts: {})
+      require_relative 'pgt_outbox/table'
+      require_relative 'pgt_outbox/trigger'
+      Table.create!(table, db, opts:)
+    end
+
+    # Helper instance methods
+
+    # Guards against recursive triggers
+    # NOTE: Taken from sequel_postgresql_triggers
+    # @param [Integer] depth_limit The maximum trigger depth to allow before returning NEW
+    def depth_guard_clause(depth_limit = nil)
+      return unless depth_limit
+
+      depth_limit = 1 if depth_limit == true
+      depth_limit = depth_limit.to_i
+      raise ArgumentError, ':trigger_depth_limit option must be at least 1' unless depth_limit >= 1
+
+      <<-SQL
+      IF pg_trigger_depth() > #{depth_limit} THEN
+          RETURN NEW;
+        END IF;
+      SQL
+    end
+
+    # Mangle the schema name so it can be used in an unquoted_identifier
+    # NOTE: Taken from sequel_postgresql_triggers
+    # @param [String] table The table name to mangle
+    def mangled_table_name(db, table)
+      db.send(:quote_schema_table, table).gsub('"', '').gsub(/[^A-Za-z0-9]/, '_').gsub(/_+/, '_')
+    end
+  end
+end

data/sig/sequel/pgt_outbox.rbs

@@ -0,0 +1,6 @@
+module Sequel
+  module PgtOutbox
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: sequel-pgt_outbox
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- bougyman
+bindir: exe
+cert_chain: []
+date: 2025-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel_postgresql_triggers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: This implements a configurable outbox and triggers to populate it with
+  events. See https://microservices.io/patterns/data/transactional-outbox.html for
+  details. To be this clear, this only handles the insert of events into the outbox
+email:
+- bougyman@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".overcommit.yml"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- Rakefile
+- Readme.adoc
+- ci/build_image.sh
+- ci/publish-gem.sh
+- lib/sequel/extensions/pgt_outbox.rb
+- lib/sequel/pgt_outbox.rb
+- lib/sequel/pgt_outbox/database_methods.rb
+- lib/sequel/pgt_outbox/function.rb
+- lib/sequel/pgt_outbox/table.rb
+- lib/sequel/pgt_outbox/trigger.rb
+- lib/sequel/pgt_outbox/version.rb
+- sig/sequel/pgt_outbox.rbs
+homepage: https://github.com/rubyists/sequel-pgt_outbox
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rubyists/sequel-pgt_outbox
+  source_code_uri: https://github.com/rubyists/sequel-pgt_outbox
+  changelog_uri: https://github.com/rubyists/sequel-pgt_outbox/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: Triggers to implement a transaction outbox pattern.
+test_files: []