active_outbox 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88b2644a74013b8c15f3ce2f4bb270cdb6603c19eba19221fe4cefa1bb0ac859
-  data.tar.gz: 6ea80cb79adbe607ca93ca5710fce0a5b0fef1a22f24209811082b8ab7993261
+  metadata.gz: b2e8f16f629c433d2963d5e96dfc3e1b12031fafa5ea58ab4dc215a01a2f3517
+  data.tar.gz: 23d0bee29bb81d3bebf53f8e63efb1cb3356f365e6e662a2b0c1fb575843f347
 SHA512:
-  metadata.gz: 6a5bce340343c741fd131938504c2040cdf130c6c8b0e989c2600744501e5ab57e248e373ddc6e16241d0d9967242d9885245b8a2a6252027a048bbede4175ae
-  data.tar.gz: 3ae68085af021db07572b7d23b81c85b7e7a16f7c80e340e8fd3e1c68c3e0b37314ad1f4eefe37bc44bdf3b8b3f37329c31f83d76703896855ad211e8a0e2636
+  metadata.gz: 0ffb5a506f89addc09301f10401319de0aaccb6531a0a3532104fb62172a899cbbd36d08e56cf92297cacd999494b41f1ca22c0f6a4d579f7d3f29b47c2d1d5a
+  data.tar.gz: 0caa250db4098bbf5ad294da3fa487d75c5e6f58c0678933e4314ecc72f69e7600e747ed1149cdc89f892485a24da3381c0a9195242f1b4a9a61d8480271e8c7

data/README.md

@@ -37,21 +37,13 @@ gem install active_outbox
 
 ## Usage
 ### Setup
-Create an `Outbox` table using the provided generator and corresponding model.
+Create an `Outbox` table using the provided generator and corresponding model. Any model name can be passed as an argument but if empty it will default to just `Outobx`. The generated table name will be `model_name_outboxes`.
 ```bash
-rails g active_outbox outbox
+rails g active_outbox:model <optional model_name>
 ```
 After running the migration, create an initializer under `config/initializers/active_outbox.rb` and setup the default outbox class to the new `Outbox` model you just created.
-```ruby
-# frozen_string_literal: true
-
-Rails.application.reloader.to_prepare do
-  ActiveOutbox.configure do |config|
-    config.outbox_mapping = {
-      'default' => 'Outbox'
-    }
-  end
-end
+```bash
+rails g active_outbox:install
 ```
 
 To allow models to store Outbox records on changes, you will have to include the `Outboxable` concern.

data/lib/active_outbox/adapter_helper.rb

@@ -3,15 +3,25 @@
 module ActiveOutbox
   module AdapterHelper
     def self.uuid_type
-      postgres? ? 'uuid' : 'string'
+      return 'uuid' if postgres?
+      return 'string' if mysql?
+
+      'string'
     end
 
     def self.json_type
-      postgres? ? 'jsonb' : 'string'
+      return 'jsonb' if postgres?
+      return 'json' if mysql?
+
+      'string'
     end
 
     def self.postgres?
       ActiveRecord::Base.connection.adapter_name.downcase == 'postgresql'
     end
+
+    def self.mysql?
+      ActiveRecord::Base.connection.adapter_name.downcase == 'mysql2'
+    end
   end
 end

data/lib/active_outbox/outboxable.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/concern'
+
 module ActiveOutbox
   module Outboxable
     extend ActiveSupport::Concern

data/lib/active_outbox.rb

@@ -2,7 +2,6 @@
 
 require 'active_outbox/adapter_helper'
 require 'active_outbox/errors'
-require 'active_outbox/generators/active_outbox_generator'
 require 'active_outbox/outboxable'
 require 'active_outbox/railtie' if defined?(Rails::Railtie)
 require 'dry-configurable'

data/lib/generators/active_outbox/install/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module ActiveOutbox
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      desc 'Creates an initializer file at config/initializers/active_outbox.rb'
+
+      def create_initializer_file
+        copy_file('initializer.rb', Rails.root.join('config', 'initializers', 'active_outbox.rb'))
+      end
+    end
+  end
+end

data/lib/generators/active_outbox/model/model_generator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'rails'
+require 'rails/generators/active_record'
+require 'rails/generators/base'
+require 'rails/generators/migration'
+
+module ActiveOutbox
+  module Generators
+    class ModelGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      include ActiveOutbox::AdapterHelper
+      include Rails::Generators::Migration
+
+      class << self
+        delegate :next_migration_number, to: ActiveRecord::Generators::Base
+      end
+
+      desc 'Creates the Outbox model migration'
+
+      argument :model_name, type: :string, default: ''
+      class_option :component_path, type: :string, desc: 'Indicates where to create the outbox migration'
+
+      def create_migration_file
+        migration_path = "#{root_path}/db/migrate"
+        migration_template(
+          'migration.rb',
+          "#{migration_path}/active_outbox_create_#{table_name}.rb",
+          migration_version: migration_version
+        )
+      end
+
+      def root_path
+        options['component_path'] || Rails.root
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+
+      def table_name
+        model_name.blank? ? 'outboxes' : "#{model_name}_outboxes"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+Rails.application.reloader.to_prepare do
+  ActiveOutbox.configure do |config|
+    # To configure which Outbox class maps to which domain
+    # See https://github.com/rootstrap/active_outbox#advanced-usage for advanced examples
+    config.outbox_mapping = {
+      'default' => 'Outbox'
+    }
+
+    # Configure database adapter
+    # config.adapter = :postgresql
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class ActiveOutboxCreate<%= table_name.camelize.singularize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= table_name %> do |t|
+      t.<%= ActiveOutbox::AdapterHelper.uuid_type %> :identifier, null: false, index: { unique: true }
+      t.string :event, null: false
+      t.<%= ActiveOutbox::AdapterHelper.json_type %> :payload
+      t.string :aggregate, null: false
+      t.<%= ActiveOutbox::AdapterHelper.uuid_type %> :aggregate_identifier, null: false, index: true
+
+      t.timestamps
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_outbox
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Guillermo Aguirre
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-24 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -50,10 +50,12 @@ files:
 - lib/active_outbox.rb
 - lib/active_outbox/adapter_helper.rb
 - lib/active_outbox/errors.rb
-- lib/active_outbox/generators/active_outbox_generator.rb
-- lib/active_outbox/generators/templates/migration.rb
 - lib/active_outbox/outboxable.rb
 - lib/active_outbox/railtie.rb
+- lib/generators/active_outbox/install/install_generator.rb
+- lib/generators/active_outbox/model/model_generator.rb
+- lib/generators/active_outbox/templates/initializer.rb
+- lib/generators/active_outbox/templates/migration.rb
 homepage: https://rubygems.org/gems/active_outbox
 licenses:
 - MIT

data/lib/active_outbox/generators/active_outbox_generator.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails'
-require 'rails/generators'
-require 'rails/generators/active_record'
-
-class ActiveOutboxGenerator < ActiveRecord::Generators::Base
-  include ActiveOutbox::AdapterHelper
-  source_root File.expand_path('templates', __dir__)
-
-  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

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