missive 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06220491a9066084b07838222a15676c94543dcec8d6d7a9e3c84137e8efab14'
-  data.tar.gz: cd08afa7a073de913d16f3ffe6251c31c196696420a2f5ccd51d8c1d6bff48f0
+  metadata.gz: 2524889a76072d9a0c8a32bcbcf644a47b53ef388eeb5937ab2d643f9f7943e9
+  data.tar.gz: 27050e567ac00cbf4a1d784a2495601b68fe8bfb481c14d3d822d99a33d0d086
 SHA512:
-  metadata.gz: d32d340f9c5c473f320f3590339455b83408fc5854022bb4ad5888f59ee002a08cca4f8ec95bfec9b022d4557af3bad45554f44db137778c5337683c842cfbd2
-  data.tar.gz: d15612829c698aa1f4bfa5f2177033da4745a9f4d2b835972d24dea1023a186c7bfe6227b9b2fe61cdecc78cee62b955977089d7f57d775a0ab326063b992072
+  metadata.gz: 6d58ad49167ba5a32acc92dd1e74e69c74ccd83748465f48497eef9a1d212bd092c5938a3fa1f3fa9357f3bdb8e5cc29c82152ac10cca3b89b094b51cd4ac94e
+  data.tar.gz: 5292722bfed62d90c92d6d61ec831c46fa495bb29609469da887711557e3e8f60a9ceb3bc4084a4fdf04c3b99cbbcf041cd7945100550a7bfbe20c1481ea4f82

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.0.4] - 2026-02-04
+
+- Fix associations collision checks and configuration
+
 ## [0.0.3] - 2026-02-04
 
 - Add associations collision checks and configuration

data/README.md

@@ -91,21 +91,21 @@ This is equivalent to:
 ```rb
 class User < ApplicationRecord
   # Missive::UserAsSender
-  has_one :sender # ...
-  has_many :sent_dispatches # ...
-  has_many :sent_lists # ...
-  has_many :sent_messages # ...
+  has_one :missive_sender # ...
+  has_many :missive_sent_dispatches # ...
+  has_many :missive_sent_lists # ...
+  has_many :missive_sent_messages # ...
 
   def init_sender(attributes = {});
     # ...
   end
 
   # Missive::UserAsSubscriber
-  has_one :subscriber # ...
-  has_many :dispatches # ...
-  has_many :subscriptions # ...
-  has_many :subscribed_lists # ...
-  has_many :unsubscribed_lists # ...
+  has_one :missive_subscriber # ...
+  has_many :missive_dispatches # ...
+  has_many :missive_subscriptions # ...
+  has_many :missive_subscribed_lists # ...
+  has_many :missive_unsubscribed_lists # ...
 
   def init_subscriber(attributes = {})
     # ...
@@ -115,23 +115,24 @@ end
 
 #### Customizing association names
 
-If your User model already has associations named `sender` or `subscriber`, you can customize the association names:
+By default, association names are prefixed with `missive_` to avoid collisions with existing associations. If you want to use shorter names (e.g., `sender` instead of `missive_sender`), you can customize them using the `.with` method:
 
 ```rb
 class User < ApplicationRecord
-  include Missive::User
-  configure_missive_sender(
-    sender: :missive_sender,
-    sent_dispatches: :missive_sent_dispatches,
-    sent_lists: :missive_sent_lists,
-    sent_messages: :missive_sent_messages
-  )
-  configure_missive_subscriber(
-    subscriber: :missive_subscriber,
-    dispatches: :missive_dispatches,
-    subscriptions: :missive_subscriptions,
-    subscribed_lists: :missive_subscribed_lists,
-    unsubscribed_lists: :missive_unsubscribed_lists
+  include Missive::User.with(
+    sender: {
+      sender: :sender,
+      sent_dispatches: :sent_dispatches,
+      sent_lists: :sent_lists,
+      sent_messages: :sent_messages
+    },
+    subscriber: {
+      subscriber: :subscriber,
+      dispatches: :dispatches,
+      subscriptions: :subscriptions,
+      subscribed_lists: :subscribed_lists,
+      unsubscribed_lists: :unsubscribed_lists
+    }
   )
 end
 ```
@@ -140,26 +141,24 @@ Or, if including the concerns separately:
 
 ```rb
 class User < ApplicationRecord
-  include Missive::UserAsSender
-  configure_missive_sender(
-    sender: :missive_sender,
-    sent_dispatches: :missive_sent_dispatches,
-    sent_lists: :missive_sent_lists,
-    sent_messages: :missive_sent_messages
+  include Missive::UserAsSender.with(
+    sender: :sender,
+    sent_dispatches: :sent_dispatches,
+    sent_lists: :sent_lists,
+    sent_messages: :sent_messages
   )
 
-  include Missive::UserAsSubscriber
-  configure_missive_subscriber(
-    subscriber: :missive_subscriber,
-    dispatches: :missive_dispatches,
-    subscriptions: :missive_subscriptions,
-    subscribed_lists: :missive_subscribed_lists,
-    unsubscribed_lists: :missive_unsubscribed_lists
+  include Missive::UserAsSubscriber.with(
+    subscriber: :subscriber,
+    dispatches: :dispatches,
+    subscriptions: :subscriptions,
+    subscribed_lists: :subscribed_lists,
+    unsubscribed_lists: :unsubscribed_lists
   )
 end
 ```
 
-You only need to customize the associations that conflict - any unconfigured associations will use their default names.
+You only need to customize the associations you want to rename - any unconfigured associations will use their default `missive_` prefixed names.
 
 #### Manage subscriptions
 
@@ -173,17 +172,17 @@ list = Missive::List.first
 user.init_subscriber
 
 # List the subscriptions
-user.subscriptions # returns a `Missive::Subscription` collection
+user.missive_subscriptions # returns a `Missive::Subscription` collection
 
 # List the (un)subscribed lists
-user.subscribed_lists # returns a `Missive::List` collection
-user.unsubscribed_lists # returns a `Missive::List` collection
+user.missive_subscribed_lists # returns a `Missive::List` collection
+user.missive_unsubscribed_lists # returns a `Missive::List` collection
 
 # Subscribe to an existing Missive::List
-user.subscriber.subscriptions.create!(list:)
+user.missive_subscriber.subscriptions.create!(list:)
 
 # Unsubscribe from the list
-user.subscriptions.find_by(list:).suppress!(reason: :manual_suppression)
+user.missive_subscriptions.find_by(list:).suppress!(reason: :manual_suppression)
 ```
 
 #### Manage senders
@@ -199,7 +198,7 @@ list = Missive::List.first
 user.init_sender(name: user.full_name)
 
 # Make them the default sender for a list
-user.sent_lists << list
+user.missive_sent_lists << list
 ```
 
 #### Manage lists

data/app/models/concerns/missive/user.rb

@@ -2,6 +2,28 @@ module Missive
   module User
     extend ActiveSupport::Concern
 
+    def self.with(sender: {}, subscriber: {})
+      Module.new do
+        extend ActiveSupport::Concern
+
+        define_singleton_method(:inspect) { "Missive::User.with(sender: #{sender.inspect}, subscriber: #{subscriber.inspect})" }
+
+        included do
+          if sender.empty?
+            include Missive::UserAsSender
+          else
+            include Missive::UserAsSender.with(sender)
+          end
+
+          if subscriber.empty?
+            include Missive::UserAsSubscriber
+          else
+            include Missive::UserAsSubscriber.with(subscriber)
+          end
+        end
+      end
+    end
+
     included do
       include Missive::UserAsSender
       include Missive::UserAsSubscriber

data/app/models/concerns/missive/user_as_sender.rb

@@ -4,16 +4,33 @@ module Missive
 
     class AssociationAlreadyDefinedError < StandardError; end
 
-    ASSOCIATION_NAMES = %i[sender sent_dispatches sent_lists sent_messages].freeze
+    DEFAULT_ASSOCIATION_NAMES = {
+      sender: :missive_sender,
+      sent_dispatches: :missive_sent_dispatches,
+      sent_lists: :missive_sent_lists,
+      sent_messages: :missive_sent_messages
+    }.freeze
 
-    class_methods do
-      def missive_sender_config
-        @missive_sender_config ||= ASSOCIATION_NAMES.index_with { |name| name }
+    def self.with(options = {})
+      config = DEFAULT_ASSOCIATION_NAMES.merge(options)
+
+      Module.new do
+        extend ActiveSupport::Concern
+
+        define_singleton_method(:inspect) { "Missive::UserAsSender.with(#{options.inspect})" }
+
+        included do |base|
+          base.instance_variable_set(:@missive_sender_config, config)
+          base.extend(ClassMethods)
+          base.include(InstanceMethods)
+          base._define_missive_sender_associations
+        end
       end
+    end
 
-      def configure_missive_sender(options = {})
-        missive_sender_config.merge!(options)
-        _define_missive_sender_associations
+    module ClassMethods
+      def missive_sender_config
+        @missive_sender_config ||= DEFAULT_ASSOCIATION_NAMES.dup
       end
 
       def _define_missive_sender_associations
@@ -32,14 +49,12 @@ module Missive
 
         raise AssociationAlreadyDefinedError,
           "Association :#{name} is already defined on #{self.name}. " \
-          "Use configure_missive_sender to specify a different name. " \
-          "Example: configure_missive_sender(sender: :missive_sender)"
+          "Use Missive::UserAsSender.with to specify a different name. " \
+          "Example: include Missive::UserAsSender.with(sender: :missive_sender)"
       end
     end
 
-    included do
-      _define_missive_sender_associations
-
+    module InstanceMethods
       def init_sender(attributes = {})
         assoc = self.class.missive_sender_config[:sender]
         send("#{assoc}=", Missive::Sender.find_or_initialize_by(email:))
@@ -48,5 +63,11 @@ module Missive
         send(assoc)
       end
     end
+
+    included do |base|
+      base.extend(ClassMethods)
+      base.include(InstanceMethods)
+      base._define_missive_sender_associations
+    end
   end
 end

data/app/models/concerns/missive/user_as_subscriber.rb

@@ -4,16 +4,34 @@ module Missive
 
     class AssociationAlreadyDefinedError < StandardError; end
 
-    ASSOCIATION_NAMES = %i[subscriber dispatches subscriptions subscribed_lists unsubscribed_lists].freeze
+    DEFAULT_ASSOCIATION_NAMES = {
+      subscriber: :missive_subscriber,
+      dispatches: :missive_dispatches,
+      subscriptions: :missive_subscriptions,
+      subscribed_lists: :missive_subscribed_lists,
+      unsubscribed_lists: :missive_unsubscribed_lists
+    }.freeze
 
-    class_methods do
-      def missive_subscriber_config
-        @missive_subscriber_config ||= ASSOCIATION_NAMES.index_with { |name| name }
+    def self.with(options = {})
+      config = DEFAULT_ASSOCIATION_NAMES.merge(options)
+
+      Module.new do
+        extend ActiveSupport::Concern
+
+        define_singleton_method(:inspect) { "Missive::UserAsSubscriber.with(#{options.inspect})" }
+
+        included do |base|
+          base.instance_variable_set(:@missive_subscriber_config, config)
+          base.extend(ClassMethods)
+          base.include(InstanceMethods)
+          base._define_missive_subscriber_associations
+        end
       end
+    end
 
-      def configure_missive_subscriber(options = {})
-        missive_subscriber_config.merge!(options)
-        _define_missive_subscriber_associations
+    module ClassMethods
+      def missive_subscriber_config
+        @missive_subscriber_config ||= DEFAULT_ASSOCIATION_NAMES.dup
       end
 
       def _define_missive_subscriber_associations
@@ -22,8 +40,8 @@ module Missive
         _check_missive_association_collision!(config[:subscriber])
 
         has_one config[:subscriber], class_name: "Missive::Subscriber", foreign_key: :user_id, dependent: :destroy
-        has_many config[:dispatches], class_name: "Missive::Dispatch", through: config[:subscriber]
-        has_many config[:subscriptions], class_name: "Missive::Subscription", through: config[:subscriber]
+        has_many config[:dispatches], class_name: "Missive::Dispatch", through: config[:subscriber], source: :dispatches
+        has_many config[:subscriptions], class_name: "Missive::Subscription", through: config[:subscriber], source: :subscriptions
         has_many config[:subscribed_lists], class_name: "Missive::List", through: config[:subscriber], source: :lists
         has_many config[:unsubscribed_lists], -> { where.not(missive_subscriptions: {suppressed_at: nil}) },
           class_name: "Missive::List",
@@ -36,14 +54,12 @@ module Missive
 
         raise AssociationAlreadyDefinedError,
           "Association :#{name} is already defined on #{self.name}. " \
-          "Use configure_missive_subscriber to specify a different name. " \
-          "Example: configure_missive_subscriber(subscriber: :missive_subscriber)"
+          "Use Missive::UserAsSubscriber.with to specify a different name. " \
+          "Example: include Missive::UserAsSubscriber.with(subscriber: :missive_subscriber)"
       end
     end
 
-    included do
-      _define_missive_subscriber_associations
-
+    module InstanceMethods
       def init_subscriber(attributes = {})
         assoc = self.class.missive_subscriber_config[:subscriber]
         send("#{assoc}=", Missive::Subscriber.find_or_initialize_by(email:))
@@ -52,5 +68,11 @@ module Missive
         send(assoc)
       end
     end
+
+    included do |base|
+      base.extend(ClassMethods)
+      base.include(InstanceMethods)
+      base._define_missive_subscriber_associations
+    end
   end
 end

data/lib/missive/version.rb

@@ -1,3 +1,3 @@
 module Missive
-  VERSION = "0.0.3".freeze
+  VERSION = "0.0.4".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: missive
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Hans Lemuet