active_outbox 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e7706d5483124adb87010ceb0c1dc612dbbef07e4cbb6f52eee2a0f817f99e9
-  data.tar.gz: f8762e7bc2517a5f2720d2d9617a29d8720cc18fa1cad2129ba017c5e95ef012
+  metadata.gz: 2d0e31246689108b94262916f2128e1f1085dadb8b75cb62016a23d7c1a23236
+  data.tar.gz: 50caba92044342c95532737086eaebac4422f9a6fc370c84b75763d28f2360e4
 SHA512:
-  metadata.gz: 277b1350289860ef9c2a33406fee80d8858ddf7dae84b62c0e960fe442e1645087d7c15ecd610e03e937faf8de8114c15a884f5b7807e276be0b7f58fcbff17b
-  data.tar.gz: a93fb735486c3ed1abfc524798e260b2945844b72bbf2a671e8ef04b48de15ed52fca3756e79882359599040a69055871d97f29c15a07bab94617590c38d2b68
+  metadata.gz: 906a6d7f317a8d178e20852601d3a52a89655e8bca6d72ebd0adb8dda5aca8d7385ab8fe8a9822380274b8e8c3c9a118e2fe14cf2f9e27c5cb926387b8dd0313
+  data.tar.gz: 3523ac574209865c4e061559a9517a434fb8fb43b37756abf512dc67d309bc6cedd6a870a98212de81325f2b0ab128456c42c0f4a05ee943d35c9d9213c60828

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/outboxable.rb

@@ -10,16 +10,21 @@ module ActiveOutbox
       *namespace, klass = name.underscore.upcase.split('/')
       namespace = namespace.reverse.join('.')
 
-      module_parent.const_set('Events', Module.new) unless module_parent.const_defined?('Events')
+      module_parent.const_set('ActiveOutbox', Module.new) unless module_parent.const_defined?('ActiveOutbox', false)
+
+      unless module_parent::ActiveOutbox.const_defined?('Events', false)
+        module_parent::ActiveOutbox.const_set('Events', Module.new)
+      end
 
       { 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}")
+        unless module_parent::ActiveOutbox::Events.const_defined?(const_name)
+          module_parent::ActiveOutbox::Events.const_set(const_name,
+            "#{const_name}#{namespace.blank? ? '' : '.'}#{namespace}")
         end
 
-        event_name = module_parent::Events.const_get(const_name)
+        event_name = module_parent::ActiveOutbox::Events.const_get(const_name)
 
         send("after_#{key}") { create_outbox!(key, event_name) }
       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,7 +49,21 @@ 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

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.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Guillermo Aguirre
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-10 00:00:00.000000000 Z
+date: 2024-04-25 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
@@ -75,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: A Transactional Outbox implementation for ActiveRecord