active_outbox 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ef51af40668768f1f8b3acfcb1e81417f78bd676a1639beb6de68d0dd51b728
-  data.tar.gz: 9e86368e8681ac70a24b4fce107bf786685f14ec1b0a8e89bd9e9a31eaae2117
+  metadata.gz: ef235321d10ec48e78a45e7b894ef50bffb6e73bf6e7d94971f19ed5f945e137
+  data.tar.gz: df6f204e1644416d5351af321e8f2cd832b0a7fad22e9d38385902f48e1e146b
 SHA512:
-  metadata.gz: c79cd51c61496564df983885127498d97317df6ff891f6b524aca691fbb52d396a49f1d7226f25e8cb5f09b7261adc40dc817991ddbd4e8c852cfa43fab6ce69
-  data.tar.gz: 047f6720232490e3cb89379012ff6204e7f89e53b888cd20d2c45228bcb6f0ab9e0a04d6885087d5daedda2856e22640948cd35785b7c64108580195f34e78c0
+  metadata.gz: f3322c31bd2dd05f239d5373fb772033583407576b5be4b14b184c5d97abc5ba1dd0aa7516e27b0f11519848d381948c8031c79c0d0916eaadd1566e78709d30
+  data.tar.gz: 803e2a29abded8d24ecd32492c39f19b26103769b47a7952d16114b5073bf5e42711d369e43f8d09e25cd9ce6d446c7492051e661d22f2c24becc66e25e7b66f

data/README.md

@@ -37,13 +37,16 @@ gem install active_outbox
 
 ## Usage
 ### Setup
-Create an initializer under `config/initializers/active_outbox.rb` and setup the default outbox class to the `Outbox` model you will create in the next step.
+Create the outbox table and model using the provided generator. Any model name can be passed as an argument but if empty it will default to `outboxes` and `Outbox` respectively.
 ```bash
-rails g active_outbox:install
+rails g active_outbox:model <optional model_name>
+
+  create  db/migrate/20231115182800_active_outbox_create_<model_name_>outboxes.rb
+  create  app/models/<model_name_>outbox.rb
 ```
-After creating the initializer, 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 `outboxes`. The generated table name will be `model_name_outboxes`.
+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.
 ```bash
-rails g active_outbox:model <optional model_name>
+rails g active_outbox:install
 ```
 
 To allow models to store Outbox records on changes, you will have to include the `Outboxable` concern.
@@ -71,8 +74,15 @@ By default our Outbox migration has an `aggregate_identifier` field which serves
 ```bash
 rails g active_outbox:model <optional model_name> --uuid
 ```
-### Multiple Outbox mappings
-If more granularity is desired multiple `Outbox` classes can be configured. After creating the needed `Outbox` classes for each module you can specify multiple mappings in the initializer.
+### Modularized Outbox Mappings
+If more granularity is desired multiple outbox classes can be configured. Using the provided generators we can specify namespaces and the folder structure. 
+```bash
+rails g active_outbox:model user_access/ --component-path packs/user_access
+
+  create  packs/user_access/db/migrate/20231115181205_active_outbox_create_user_access_outboxes.rb
+  create  packs/user_access/app/models/user_access/outbox.rb
+```
+After creating the needed `Outbox` classes for each module you can specify multiple mappings in the initializer.
 ```ruby
 # frozen_string_literal: true
 

data/lib/active_outbox/adapter_helper.rb

@@ -16,6 +16,12 @@ module ActiveOutbox
       'string'
     end
 
+    def self.bigint_type
+      return 'bigint' if postgres? || mysql?
+
+      'integer'
+    end
+
     def self.postgres?
       ActiveRecord::Base.connection.adapter_name.downcase == 'postgresql'
     end

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

@@ -35,10 +35,13 @@ module ActiveOutbox
           "#{migration_path}/active_outbox_create_#{table_name}.rb",
           migration_version: migration_version
         )
+
+        template('model.rb', "#{root_path}/app/models/#{path_name}.rb")
       end
 
       def root_path
-        options['component_path'] || Rails.root
+        path = options['component_path'].blank? ? '' : "/#{options['component_path']}"
+        "#{Rails.root}#{path}"
       end
 
       def migration_version
@@ -46,11 +49,25 @@ module ActiveOutbox
       end
 
       def table_name
-        model_name.blank? ? 'outboxes' : "#{model_name}_outboxes"
+        *namespace, name = model_name.downcase.split('/')
+        name = name.blank? ? 'outboxes' : "#{name}_outboxes"
+        namespace = namespace.join('_')
+        namespace.blank? ? name : "#{namespace}_#{name}"
+      end
+
+      def path_name
+        name = ''
+        *namespace = model_name.downcase.split('/')
+        if (model_name.include?('/') && model_name.last != '/' && namespace.length > 1) || !model_name.include?('/')
+          name = namespace.pop
+        end
+        name = name.blank? ? 'outbox' : "#{name}_outbox"
+        namespace = namespace.join('/')
+        namespace.blank? ? name : "#{namespace}/#{name}"
       end
 
       def aggregate_identifier_type
-        options['uuid'].present? ? ActiveOutbox::AdapterHelper.uuid_type : 'integer'
+        options['uuid'].present? ? ActiveOutbox::AdapterHelper.uuid_type : ActiveOutbox::AdapterHelper.bigint_type
       end
     end
   end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class <%= path_name.camelize %> < ApplicationRecord
+  validates_presence_of :identifier, :payload, :aggregate, :aggregate_identifier, :event
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_outbox
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Guillermo Aguirre
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-10 00:00:00.000000000 Z
+date: 2023-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -56,6 +56,7 @@ files:
 - lib/generators/active_outbox/model/model_generator.rb
 - lib/generators/active_outbox/templates/initializer.rb
 - lib/generators/active_outbox/templates/migration.rb
+- lib/generators/active_outbox/templates/model.rb
 homepage: https://rubygems.org/gems/active_outbox
 licenses:
 - MIT