sequel-pgt_outbox 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cc58b4c71809dcbcde313ac69309d2377c683e99e40e8f84a08e940cbabbaaf
-  data.tar.gz: 2ade2c54c240874a84d5fbea716b0b805ca657616723d74f90be6244046efd6d
+  metadata.gz: 7123de7b64b4420a074b4582b45cd14265a37fde7d4d21f3c2299412ea79075d
+  data.tar.gz: e75d210ca899710840bbca70a54a185f56b95938c1d2dce01658c802db7b04c5
 SHA512:
-  metadata.gz: 17f3c2c624d42c0facdf4ac9498b38697df42baf8f013af60ee91610589453f09c38db9874fb86204a9ab0d6cd2e338b11e978f45d0bdfd38cd362211d496342
-  data.tar.gz: 1809b9b0a183a9a0a611e55dcd993c210e500c80392741d656eadef5d47d68568c0d961fbfeab310f797d45aa97705e26b192168ce38780d7586d1a0bdbde9b0
+  metadata.gz: 5fe2b0a4e292ed30fdd7ee41a96d250483f29e1e57849394666ab48bcf5442f551b1971b476c197a261206fbe3cf7a1b18523ddb15d04a7eb5f098e0ca52632e
+  data.tar.gz: 917ffb09105f2ece1e19ca870ba7ab5e9bd4fd2977676f5b0a80160f6eb0251182be9f962b15bf0b6638f23dd8a9fa4fd057201134e376a84cf2596695b484a6

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.2.5"
+  ".": "0.2.7"
 }

data/.version.txt

@@ -1 +1 @@
-0.2.5
+0.2.7

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [0.2.7](https://github.com/rubyists/sequel-pgt_outbox/compare/v0.2.6...v0.2.7) (2025-02-16)
+
+
+### Bug Fixes
+
+* Removes the github gem publish action which was broken ([#23](https://github.com/rubyists/sequel-pgt_outbox/issues/23)) ([d16e096](https://github.com/rubyists/sequel-pgt_outbox/commit/d16e096fd3659786c30114ca6116e221ad81ddfc))
+
+## [0.2.6](https://github.com/rubyists/sequel-pgt_outbox/compare/v0.2.5...v0.2.6) (2025-02-16)
+
+
+### Bug Fixes
+
+* Again with the transactional language, and force a release ([#21](https://github.com/rubyists/sequel-pgt_outbox/issues/21)) ([18b1824](https://github.com/rubyists/sequel-pgt_outbox/commit/18b1824c2592fbca2ca83928c521436c04696703))
+
 ## [0.2.5](https://github.com/rubyists/sequel-pgt_outbox/compare/v0.2.4...v0.2.5) (2025-02-16)
 
 

data/Readme.adoc

@@ -1,12 +1,46 @@
-= Transaction Outbox for Postgres
-:context: https://morningcoffee.io/what-is-a-transaction-outbox-and-why-you-need-it.html[outbox pattern]
+= Transactional Outbox for PostgreSQL
+:toc:
+:outbox-pattern: https://morningcoffee.io/what-is-a-transaction-outbox-and-why-you-need-it.html[outbox pattern]
+:postgresql: https://www.postgresql.org/[PostgreSQL]
+:sequel: https://sequel.jeremyevans.net/[Sequel]
+:eventide: https://eventide-project.org/[Eventide]
+:rails-event-store: https://railseventstore.org/[Rails Event Store]
+:tobox: https://gitlab.com/os85/tobox[Tobox]
+:release-please: https://github.com/googleapis/release-please[release-please]
+:conventional-commits: https://www.conventionalcommits.org/en/v1.0.0/[Conventional Commits]
+:github-home: https://github.com/rubyists/sequel-pgt_outbox
+:coc: https://github.com/rubyists/sequel-pgt_outbox/blob/main/CODE_OF_CONDUCT.md[Code of Conduct]
+:mit: https://opensource.org/licenses/MIT[MIT License]
+:container-registry: https://github.com/rubyists/sequel-pgt_outbox/pkgs/container/sequel-pgt_outbox[Container Registry]
+
+image::https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg[Conventional Commits,link=https://www.conventionalcommits.org/en/v1.0.0/]
+
+== Wtf?
+
+This gem provides a way to implement the transactional {outbox-pattern} using triggers
+(stored procedures) in the {postgresql} RDBMS.
+
+This only provides the "writing events to the outbox table" part of the outbox pattern.
+It does not provide the "reading and handling events from the outbox table" part.
+That is up to the application to implement.
+
+There are many libraries that can be used to read and handle events from the outbox table,
+among them are:
+
+- {eventide}
+- {rails-event-store}
+- {tobox}
+
+PgtOutbox 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.
 
-This gem provides a way to implement the transaction {context} using triggers (stored procedures) in Postgres.
+== Features
 
-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.
+* Create outbox table(s) to store events
+* Create function(s) to write events to outbox table
+* Create trigger(s) to attach to tables so their changes write events to the outbox(es)
 
 == Installation
 
@@ -22,6 +56,11 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install sequel-pgt_outbox
 ```
 
+=== Container
+
+If you do not want to install the gem, you can use the provided Docker image,
+available at the Rubyists Github {container-registry}.
+
 ## Usage
 
 ### Using the sequel cli
@@ -85,7 +124,7 @@ spgt_test=# \d
 
 spgt_test=# \q
 bougyman@framezotz ~/rubyists/sequel-pgt_outbox
- % be ./exe/outboxify postgres:///spgt_test foo
+ % outboxify postgres:///spgt_test foo
 bougyman@framezotz ~/rubyists/sequel-pgt_outbox
  % psql spgt_test
 psql (16.4)
@@ -108,18 +147,33 @@ spgt_test=#
 
 ## 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.
+After checking out the repo, run `bundle install` or `bin/setup` to install dependencies.
+
+Then, either set the PGT_SPEC_DB environment variable to an existing PostgreSQL db of your choice,
+or run `rake createdb` to create a testing one (`spgt_test`).
+
+Finally run `rake spec` to run the tests.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem from source onto your local machine, run `bundle exec rake install`.
+
+### Conventional Commits & Commit Messages
 
-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).
+This project uses the {conventional-commits} specification for commit messages, as well as for PR titles.
+This allows for automated (by {release-please}) release management, changelog generation, and versioning.
+Please follow the specification when writing commit messages.
 
 ## 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).
+Bug reports and pull requests are welcome on GitHub at {github-home}.
+Discussions are welcome in the discussions section of the repository.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the {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).
+Everyone interacting in the PgtOutbox project's codebases, issue trackers,
+and discussions is expected to follow the {coc}.

data/lib/sequel/pgt_outbox/version.rb

@@ -3,7 +3,7 @@
 module Rubyists
   module PgtOutbox
     # x-release-please-start-version
-    VERSION = '0.2.5'
+    VERSION = '0.2.7'
     # x-release-please-end
   end
 end

data/oci/Gemfile

@@ -3,5 +3,5 @@
 source 'https://rubygems.org'
 
 # x-release-please-start-version
-gem 'sequel-pgt_outbox', '= 0.2.5'
+gem 'sequel-pgt_outbox', '= 0.2.7'
 # x-release-please-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-pgt_outbox
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors:
 - bougyman
@@ -81,5 +81,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: Triggers to implement a transaction outbox pattern.
+summary: Triggers to implement (an important) part of a transactional outbox pattern.
 test_files: []