active_outbox 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2cd8cbc9b8aae5d2d62bdb50a0a9e8680f5eecee05009b26c9690853a71680a6
+  data.tar.gz: a12cf4a81586d3a1cae47f38d1685d47cf7f96b655bd39b3abbdc9411448981f
+SHA512:
+  metadata.gz: cbcbd18628600a8d67e7fae2fa4d6ecdff185d0c038bca08c21d84bc2532a82afefe512a18a61dd7bba868d02c2032b6ed65e045b069dbf5169764018a462ac7
+  data.tar.gz: 4990897cf50199b4267ba8df57541570d3e644ea8c3c71f51898c4b19be16dacffff9c03596c0c4c12c706dc9ffeb15332934f8c273b6cf8efa60339e3a54f95

data/README.md

@@ -0,0 +1,2 @@
+# active-outbox
+A Transactional Outbox implementation for ActiveRecord

data/lib/active_outbox/base.rb

@@ -0,0 +1,5 @@
+module ActiveOutbox
+  class Base < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/lib/active_outbox/generators/outbox_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/active_record'
+
+class OutboxGenerator < ActiveRecord::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+
+  argument :domains, type: :array, default: [], banner: "domain domain"
+  class_option :root_components_path, type: :string, default: Rails.root
+
+  def create_migration_files
+    migration_path = "#{options['root_components_path']}/db/migrate"
+    migration_template(
+      "migration.rb",
+      "#{migration_path}/outbox_create_#{table_name}.rb",
+      migration_version: migration_version
+    )
+  end
+
+  def migration_version
+    "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+  end
+
+  def table_name
+    "#{name}_outboxes"
+  end
+end

data/lib/active_outbox/generators/templates/migration.rb

@@ -0,0 +1,13 @@
+class OutboxCreate<%= table_name.camelize.singularize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= table_name %> do |t|
+      t.uuid :identifier, null: false, index: { unique: true }
+      t.string :event, null: false
+      t.jsonb :payload
+      t.string :aggregate, null: false
+      t.uuid :aggregate_identifier, null: false, index: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/active_outbox/outboxable.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module ActiveOutbox
+  module Outboxable
+    extend ActiveSupport::Concern
+
+    included do |base|
+      base.extend(ClassMethods)
+      *namespace, klass = name.underscore.upcase.split('/')
+      namespace = namespace.reverse.join('.')
+
+      module_parent.const_set('Events', Module.new) unless module_parent.const_defined?('Events')
+
+      { create: 'CREATED', update: 'UPDATED', destroy: 'DESTROYED' }.each do |key, value|
+        const_name = "#{klass}_#{value}"
+
+        unless module_parent::Events.const_defined?(const_name)
+          module_parent::Events.const_set(const_name, "#{const_name}#{namespace.blank? ? '' : '.'}#{namespace}")
+        end
+
+        event_name = module_parent::Events.const_get(const_name)
+
+        send("after_#{key}") { create_outbox!(key, event_name) }
+      end
+    end
+
+    def save(**options, &block)
+      if options[:outbox_event].present?
+        @outbox_event = options[:outbox_event].underscore.upcase
+      end
+
+      super(**options, &block)
+    end
+
+    def save!(**options, &block)
+      if options[:outbox_event].present?
+        @outbox_event = options[:outbox_event].underscore.upcase
+      end
+
+      super(**options, &block)
+    end
+
+    module ClassMethods
+      def parent_module_name
+        module_parent == Object ? '' : module_parent.name
+      end
+
+      def outbox_model
+        @outbox_model ||= ActiveOutbox::Base.subclasses.find do |klass|
+          klass.name.include?(parent_module_name)
+        end
+      end
+    end
+
+    private
+
+    def create_outbox!(action, event_name)
+      outbox = self.class.outbox_model.new(
+        aggregate: self.class.name,
+        aggregate_identifier: try(:identifier) || id,
+        event: @outbox_event || event_name,
+        identifier: SecureRandom.uuid,
+        payload: payload(action)
+      )
+      @outbox_event = nil
+
+      if outbox.invalid?
+        outbox.errors.each do |error|
+          self.errors.import(error, attribute: "outbox.#{error.attribute}")
+        end
+      end
+
+      outbox.save!
+    end
+
+    def payload(action)
+      payload = { before: nil, after: nil }
+      case action
+      when :create
+        payload[:after] = as_json
+      when :update
+        # previous_changes => { 'name' => ['bob', 'robert']  }
+        changes = previous_changes.transform_values(&:first)
+        payload[:before] = as_json.merge(changes)
+        payload[:after] = as_json
+      when :destroy
+        payload[:before] = as_json
+      else
+        raise ActiveRecord::RecordNotSaved.new("Failed to create Outbox payload for #{self.class.name}: #{identifier}", self)
+      end
+      payload
+    end
+  end
+end

data/lib/active_outbox.rb

@@ -0,0 +1,2 @@
+require 'active_outbox/base'
+require 'active_outbox/outboxable'

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: active_outbox
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Guillermo Aguirre
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+- !ruby/object:Gem::Dependency
+  name: reek
+  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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+description: A Transactional Outbox implementation for ActiveRecord
+email: guillermoaguirre1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/active_outbox.rb
+- lib/active_outbox/base.rb
+- lib/active_outbox/generators/outbox_generator.rb
+- lib/active_outbox/generators/templates/migration.rb
+- lib/active_outbox/outboxable.rb
+homepage: https://rubygems.org/gems/active_outbox
+licenses:
+- MIT
+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.4.1
+signing_key:
+specification_version: 4
+summary: ActiveOutbox
+test_files: []