active_outbox 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cd8cbc9b8aae5d2d62bdb50a0a9e8680f5eecee05009b26c9690853a71680a6
-  data.tar.gz: a12cf4a81586d3a1cae47f38d1685d47cf7f96b655bd39b3abbdc9411448981f
+  metadata.gz: aa92d48552facbc79e9ec9ae9f58a599d533267a490f7199c5b4e87b9f62f83b
+  data.tar.gz: a04f7dbe86d0b7e53296079be077db720c50baa48f2b53237cb18423fb33209d
 SHA512:
-  metadata.gz: cbcbd18628600a8d67e7fae2fa4d6ecdff185d0c038bca08c21d84bc2532a82afefe512a18a61dd7bba868d02c2032b6ed65e045b069dbf5169764018a462ac7
-  data.tar.gz: 4990897cf50199b4267ba8df57541570d3e644ea8c3c71f51898c4b19be16dacffff9c03596c0c4c12c706dc9ffeb15332934f8c273b6cf8efa60339e3a54f95
+  metadata.gz: acfbc64c4ad058a44d56c170fd194d300841cdfd8bdcaa950b9d63b90ae23f392f3bfdf7c1240e0564d7312680362057360114e9e98e9aaafec842639dd0ab98
+  data.tar.gz: 6449a7b730797fb16e55fca130e0ee7d4813bda5d06c34c4093f23bb6e20d77e5bca07cdcc5ed212d30c42617b6035ffcb31c2fc0033b90ebb0653dd6fe6bf25

data/README.md

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

data/bin/outbox

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rails'
+require 'active_outbox'
+
+rails g outbox ARGV[0]

data/lib/active_outbox/configuration.rb

@@ -0,0 +1,26 @@
+module ActiveOutbox
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= ActiveOutbox::Configuration.new
+    end
+
+    def reset
+      @configuration = ActiveOutbox::Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  class Configuration
+    attr_accessor :adapter, :outbox_mapping
+
+    def initialize
+      @adapter = :sqlite
+      @outbox_mapping = {}
+    end
+  end
+end

data/lib/active_outbox/errors.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActiveOutbox
+  class OutboxConfigurationError < StandardError; end
+  class OutboxClassNotFoundError < OutboxConfigurationError
+    def message
+      <<~MESSAGE
+Missing Outbox class definition in module. Use `rails generate outbox <outbox model name>`.
+Define default class in `config/initializers/active_outbox.rb`:
+
+Rails.application.reloader.to_prepare do
+  ActiveOutbox.configure do |config|
+    config.outbox_mapping = {
+      'Default' => <outbox model name>,
+      'Meetings' => 'Meetings::Outbox'
+    }
+  end
+end
+MESSAGE
+    end
+  end
+end

data/lib/active_outbox/generators/outbox_generator.rb

@@ -1,9 +1,10 @@
+require 'rails'
+require 'rails/generators'
 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
@@ -22,4 +23,16 @@ class OutboxGenerator < ActiveRecord::Generators::Base
   def table_name
     "#{name}_outboxes"
   end
+
+  def uuid_type
+    postgres? ? 'uuid' : 'string'
+  end
+
+  def json_type
+    postgres? ? 'jsonb' : 'string'
+  end
+
+  def postgres?
+    ActiveRecord::Base.connection.adapter_name.downcase == 'postgresql'
+  end
 end

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

@@ -1,11 +1,11 @@
 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.<%= uuid_type %> :identifier, null: false, index: { unique: true }
       t.string :event, null: false
-      t.jsonb :payload
+      t.<%= json_type %> :payload
       t.string :aggregate, null: false
-      t.uuid :aggregate_identifier, null: false, index: true
+      t.<%= uuid_type %> :aggregate_identifier, null: false, index: true
 
       t.timestamps
     end

data/lib/active_outbox/outboxable.rb

@@ -4,8 +4,7 @@ module ActiveOutbox
   module Outboxable
     extend ActiveSupport::Concern
 
-    included do |base|
-      base.extend(ClassMethods)
+    included do
       *namespace, klass = name.underscore.upcase.split('/')
       namespace = namespace.reverse.join('.')
 
@@ -40,27 +39,26 @@ module ActiveOutbox
       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(
+      unless self.class.module_parent.const_defined?('OUTBOX_MODEL')
+        *namespace, klass = self.class.name.underscore.upcase.split('/')
+        namespace = namespace.reverse.join('.')
+        outbox_model_name = ActiveOutbox.configuration.outbox_mapping[self.class.module_parent.name.underscore] ||
+                              ActiveOutbox.configuration.outbox_mapping['default']
+        raise OutboxClassNotFoundError if outbox_model_name.nil?
+      
+        outbox_model = outbox_model_name.safe_constantize
+        self.class.module_parent.const_set('OUTBOX_MODEL', outbox_model)
+      end
+      
+      outbox = self.class.module_parent.const_get('OUTBOX_MODEL').new(
         aggregate: self.class.name,
         aggregate_identifier: try(:identifier) || id,
         event: @outbox_event || event_name,
         identifier: SecureRandom.uuid,
-        payload: payload(action)
+        payload: formatted_payload(action)
       )
       @outbox_event = nil
 
@@ -73,6 +71,16 @@ module ActiveOutbox
       outbox.save!
     end
 
+    def formatted_payload(action)
+      payload = payload(action)
+      case ActiveRecord::Base.connection.adapter_name.downcase
+      when 'postgresql'
+        payload
+      else
+        payload.to_json
+      end
+    end
+
     def payload(action)
       payload = { before: nil, after: nil }
       case action

data/lib/active_outbox/railtie.rb

@@ -0,0 +1,4 @@
+module ActiveOutbox
+  class Railtie < Rails::Railtie
+  end
+end

data/lib/active_outbox.rb

@@ -1,2 +1,5 @@
-require 'active_outbox/base'
+require 'active_outbox/configuration'
+require 'active_outbox/errors'
 require 'active_outbox/outboxable'
+require 'active_outbox/generators/outbox_generator'
+require 'active_outbox/railtie' if defined?(Rails::Railtie)

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: active_outbox
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
 platform: ruby
 authors:
 - Guillermo Aguirre
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-18 00:00:00.000000000 Z
+date: 2023-07-05 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
@@ -124,21 +124,25 @@ dependencies:
         version: 11.1.3
 description: A Transactional Outbox implementation for ActiveRecord
 email: guillermoaguirre1@gmail.com
-executables: []
+executables:
+- outbox
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- bin/outbox
 - lib/active_outbox.rb
-- lib/active_outbox/base.rb
+- lib/active_outbox/configuration.rb
+- lib/active_outbox/errors.rb
 - lib/active_outbox/generators/outbox_generator.rb
 - lib/active_outbox/generators/templates/migration.rb
 - lib/active_outbox/outboxable.rb
+- lib/active_outbox/railtie.rb
 homepage: https://rubygems.org/gems/active_outbox
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -153,8 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: ActiveOutbox
 test_files: []

data/lib/active_outbox/base.rb

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