sequel-pgt_outbox 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 24d2ec8fd8ddefdc27af445348e42d8324a5a4dc7591694ac9646df1ca8675e1
+  data.tar.gz: 3b5865ee09aa89409ae47cc3b61a364a95ae40365705cf354b028b5d22012c6e
+SHA512:
+  metadata.gz: e9d7f8d7545faa4e8f86532520f74aef45332612a3824c0ae52122da160a67ac2241bde894234a3939df27dc6f2daa58be7d322cea76c84ebb8c210fc95ae87a
+  data.tar.gz: 6157a47c7e2f103389be623968dd4d1f095d85ae70381b4f90aa9990180f7cd9f350e41fe5161980fce1a74fdc38fe12bf326a9cad28030cd0ef9a86d186445a

data/.overcommit.yml

@@ -0,0 +1,345 @@
+---
+PreCommit:
+  AuthorEmail:
+    enabled: true
+  AuthorName:
+    enabled: true
+  BerksfileCheck:
+    enabled: false
+  BrokenSymlinks:
+    enabled: true
+  BundleAudit:
+    enabled: true
+  BundleCheck:
+    enabled: true
+  BundleOutdated:
+    enabled: true
+  CaseConflicts:
+    enabled: true
+  ChamberCompare:
+    enabled: false
+  ChamberSecurity:
+    enabled: false
+  ChamberVerification:
+    enabled: false
+  CodeSpellCheck:
+    enabled: false
+  CoffeeLint:
+    enabled: false
+  CookStyle:
+    enabled: false
+  Credo:
+    enabled: false
+  CssLint:
+    enabled: false
+  DartAnalyzer:
+    enabled: false
+  Dogma:
+    enabled: false
+  ErbLint:
+    enabled: false
+  EsLint:
+    enabled: false
+  ExecutePermissions:
+    enabled: false
+  Fasterer:
+    enabled: false
+  FixMe:
+    enabled: true
+  FileSize:
+    enabled: false
+  Flay:
+    enabled: false
+  Foodcritic:
+    enabled: false
+  ForbiddenBranches:
+    enabled: true
+    branch_patterns: ['main', 'master']
+  GinkgoFocus:
+    enabled: false
+  GoFmt:
+    enabled: false
+  GolangciLint:
+    enabled: false
+  GoLint:
+    enabled: false
+  GoVet:
+    enabled: false
+  Hadolint:
+    enabled: false
+  HamlLint:
+    enabled: false
+  HardTabs:
+    enabled: false
+  Hlint:
+    enabled: false
+  HtmlHint:
+    enabled: false
+  HtmlTidy:
+    enabled: false
+  ImageOptim:
+    enabled: false
+  JavaCheckstyle:
+    enabled: false
+  Jscs:
+    enabled: false
+  JsHint:
+    enabled: false
+  JsLint:
+    enabled: false
+  Jsl:
+    enabled: false
+  JsonSyntax:
+    enabled: false
+  KtLint:
+    enabled: false
+  LicenseFinder:
+    enabled: false
+  LicenseHeader:
+    enabled: false
+  LocalPathsInGemfile:
+    enabled: false
+  Mdl:
+    enabled: false
+  MergeConflicts:
+    enabled: true
+  MixFormat:
+    enabled: false
+  PuppetMetadataJsonLint:
+    enabled: false
+  NginxTest:
+    enabled: false
+  Pep257:
+    enabled: false
+  Pep8:
+    enabled: false
+  PhpLint:
+    enabled: false
+  PhpCs:
+    enabled: false
+  PhpCsFixer:
+    enabled: false
+  PhpStan:
+    enabled: false
+  Pronto:
+    enabled: false
+  PuppetLint:
+    enabled: false
+  Pycodestyle:
+    enabled: false
+  Pydocstyle:
+    enabled: false
+  Pyflakes:
+    enabled: false
+  Pylint:
+    enabled: false
+  PythonFlake8:
+    enabled: false
+  RakeTarget:
+    enabled: false
+  RailsBestPractices:
+    enabled: false
+  RailsSchemaUpToDate:
+    enabled: false
+  Reek:
+    enabled: false
+  RstLint:
+    enabled: false
+  RSpec:
+    enabled: false
+  RuboCop:
+    enabled: true
+  RubyLint:
+    enabled: false
+  RubySyntax:
+    enabled: false
+  Scalariform:
+    enabled: false
+  Scalastyle:
+    enabled: false
+  ScssLint:
+    enabled: false
+  SemiStandard:
+    enabled: false
+  ShellCheck:
+    enabled: true
+  SlimLint:
+    enabled: false
+  Sorbet:
+    enabled: false
+  Sqlint:
+    enabled: false
+  Standard:
+    enabled: false
+  Stylelint:
+    enabled: false
+  SwiftLint:
+    enabled: false
+  TerraformFormat:
+    enabled: false
+  TsLint:
+    enabled: false
+  TrailingWhitespace:
+    enabled: true
+  TravisLint:
+    enabled: false
+  Vint:
+    enabled: false
+  W3cCss:
+    enabled: false
+  W3cHtml:
+    enabled: false
+  LineEndings:
+    enabled: false
+  XmlLint:
+    enabled: false
+  XmlSyntax:
+    enabled: false
+  YamlLint:
+    enabled: false
+  YamlSyntax:
+    enabled: true
+  YardCoverage:
+    enabled: false
+  YarnCheck:
+    enabled: false
+CommitMsg:
+  CapitalizedSubject:
+    enabled: false
+  EmptyMessage:
+    enabled: true
+  GerritChangeId:
+    enabled: false
+  HardTabs:
+    enabled: false
+  MessageFormat:
+    enabled: true
+    expected_pattern_message: |-
+      /^(?<type>[a-z]+)(?<scope>\(\w+\))?!?: (?<subject>[A-Z].*)$/
+      The scope and ! are optional see
+      https://www.conventionalcommits.org/en/v1.0.0/#specification
+      Subject must start with a capital letter
+    pattern: '^(?<type>[a-z]+)(?<scope>\(\w+\))?!?: (?<subject>[A-Z].*)$'
+    sample_message: 'docs(readme): ISSUE-10 - Correct typo'
+  RussianNovel:
+    enabled: true
+  SingleLineSubject:
+    enabled: true
+  SpellCheck:
+    enabled: false
+  TextWidth:
+    enabled: true
+    max_subject_width: 72
+  TrailingPeriod:
+    enabled: true
+PostCheckout:
+  BowerInstall:
+    enabled: false
+  BundleInstall:
+    enabled: false
+  ComposerInstall:
+    enabled: false
+  GitLfs:
+    enabled: false
+  IndexTags:
+    enabled: false
+  NpmInstall:
+    enabled: false
+  SubmoduleStatus:
+    enabled: false
+  YarnInstall:
+    enabled: false
+PostCommit:
+  BowerInstall:
+    enabled: false
+  BundleInstall:
+    enabled: false
+  Commitplease:
+    enabled: false
+  ComposerInstall:
+    enabled: false
+  GitGuilt:
+    enabled: false
+  GitLfs:
+    enabled: false
+  IndexTags:
+    enabled: false
+  NpmInstall:
+    enabled: false
+  SubmoduleStatus:
+    enabled: false
+  YarnInstall:
+    enabled: false
+PostMerge:
+  BowerInstall:
+    enabled: false
+  BundleInstall:
+    enabled: false
+  ComposerInstall:
+    enabled: false
+  GitLfs:
+    enabled: false
+  IndexTags:
+    enabled: false
+  NpmInstall:
+    enabled: false
+  SubmoduleStatus:
+    enabled: false
+  YarnInstall:
+    enabled: false
+PostRewrite:
+  BowerInstall:
+    enabled: false
+  BundleInstall:
+    enabled: false
+  ComposerInstall:
+    enabled: false
+  IndexTags:
+    enabled: false
+  NpmInstall:
+    enabled: false
+  SubmoduleStatus:
+    enabled: false
+  YarnInstall:
+    enabled: false
+PrePush:
+  Brakeman:
+    enabled: false
+  CargoTest:
+    enabled: false
+  FlutterTest:
+    enabled: false
+  GitLfs:
+    enabled: false
+  GolangciLint:
+    enabled: false
+  GoTest:
+    enabled: false
+  Minitest:
+    enabled: false
+  MixTest:
+    enabled: false
+  PhpUnit:
+    enabled: false
+  Pronto:
+    enabled: false
+  ProtectedBranches:
+    enabled: true
+  PubTest:
+    enabled: false
+  Pytest:
+    enabled: false
+  PythonNose:
+    enabled: false
+  RSpec:
+    enabled: false
+  RakeTarget:
+    enabled: false
+  TestUnit:
+    enabled: false
+PreRebase:
+  MergedCommits:
+    enabled: false
+PrepareCommitMsg:
+  ReplaceBranch:
+    enabled: false

data/.rubocop.yml

@@ -0,0 +1,19 @@
+---
+require:
+  - rubocop-rake
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-14
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Tj (bougyman) Vanderpoel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+desc 'Run tests'
+task :spec do
+  ENV['COVERAGE'] = 'true'
+  sh 'bundle exec ./test/sequel/test_pgt_outbox.rb'
+end
+
+desc 'Create the test database'
+task :createdb do
+  require 'uri'
+  uri = URI.parse(ENV.fetch("PGT_SPEC_DB", "postgres:///spgt_test"))
+  sh "createdb '#{File.basename(uri.path)}'"
+end
+
+desc 'Drop the test database'
+task :dropdb do
+  require 'uri'
+  uri = URI.parse(ENV.fetch("PGT_SPEC_DB", "postgres:///spgt_test"))
+  sh "dropdb --if-exists '#{File.basename(uri.path)}'"
+end
+
+task resetdb: %i[dropdb createdb]
+
+task default: %i[rubocop spec]

data/Readme.adoc

@@ -0,0 +1,82 @@
+= Transaction Outbox for Postgres
+
+This gem provides a way to implement the transaction outbox pattern using triggers (stored procedures) in Postgres.
+
+It utilizes the ruby Sequel ORM to interact with the database, but once it's set up,
+it doesn't require any ruby nor Sequel code for the outbox population to operate. It
+all runs on the PostgreSQL cluster, guaranteeing no matter how the database writes
+occur, the outbox events will always be generated.
+
+== Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add sequel-pgt_outbox
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install sequel-pgt_outbox
+```
+
+## Usage
+
+### Using the sequel cli
+
+```bash
+sequel -r sequel/pgt_outbox postgres://localhost/mydb
+Your database is stored in DB...
+irb(main):001> DB.create_table(:foo) { primary_key :id; String :s; Integer :i }
+=> nil
+irb(main):002> function = DB.pgt_setup_outbox(:foo)
+=> "pgt_outbox_foo_outbox"
+irb(main):003> DB[:foo].insert(s: 'foo', i: 1)
+=> 1
+irb(main):004> DB[:foo_outbox].first
+=> nil
+irb(main):005> DB.pgt_outbox_events(:foo, function)
+=>
+#<Rubyists::PgtOutbox::Trigger:0x00007f1ae2fbc2b0
+ @db=#<Sequel::Postgres::Database database=spgt_test>,
+ @events=[:insert, :update, :delete],
+ @function="pgt_outbox_foo_outbox",
+ @name="pgt_outbox_foo_outbox",
+ @opts={when: nil},
+ @table=:foo,
+ @trigger_opts={after: true, each_row: true}>
+irb(main):006> DB[:foo].insert(s: 'bar', i: 2)
+=> 2
+irb(main):007> DB[:foo_outbox].first
+=>
+{id: 1,
+ attempts: 0,
+ completed: nil,
+ created: 2025-02-15 18:20:30.28394 +0000,
+ updated: 2025-02-15 18:20:30.28394 +0000,
+ attempted: nil,
+ event_type: "foo_created",
+ last_error: nil,
+ data_before: nil,
+ data_after: "{\"i\": 2, \"s\": \"bar\", \"id\": 2}",
+ metadata: nil}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubyists/sequel-pgt_outbox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rubyists/sequel-pgt_outbox/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sequel::PgtOutbox project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rubyists/sequel-pgt_outbox/blob/main/CODE_OF_CONDUCT.md).