missive 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63e8195762299f95bdc217efcf1a81dbd8be46ec029ea90b8b4db430af37eabd
-  data.tar.gz: 94532fa3c3cd42c9086b35385773c0d2f8483dad96690b0d78523512736aa86e
+  metadata.gz: '06220491a9066084b07838222a15676c94543dcec8d6d7a9e3c84137e8efab14'
+  data.tar.gz: cd08afa7a073de913d16f3ffe6251c31c196696420a2f5ccd51d8c1d6bff48f0
 SHA512:
-  metadata.gz: d365c0b22c19489e7d61d46746bec34d58834c167066f02eb71cec287e855a7e820e1eb535e066c2f871cc948338bbbd5151efac7838ca037e2455b36c4dbe07
-  data.tar.gz: d7c9d72e65bbac0b683b6f5b69b888547f7ebc5245c35b6b9f582042ad8ef524b775acaed2aa47d17dd4a2be689315c02e41570913edebf7c213b5d0dc728f6f
+  metadata.gz: d32d340f9c5c473f320f3590339455b83408fc5854022bb4ad5888f59ee002a08cca4f8ec95bfec9b022d4557af3bad45554f44db137778c5337683c842cfbd2
+  data.tar.gz: d15612829c698aa1f4bfa5f2177033da4745a9f4d2b835972d24dea1023a186c7bfe6227b9b2fe61cdecc78cee62b955977089d7f57d775a0ab326063b992072

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.0.3] - 2026-02-04
+
+- Add associations collision checks and configuration
+
+## [0.0.2] - 2025-12-14
+
 - Add install generator
 - Add Postmark Bulk API implementation
 

data/README.md

@@ -113,6 +113,54 @@ class User < ApplicationRecord
 end
 ```
 
+#### Customizing association names
+
+If your User model already has associations named `sender` or `subscriber`, you can customize the association names:
+
+```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
+  )
+end
+```
+
+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::UserAsSubscriber
+  configure_missive_subscriber(
+    subscriber: :missive_subscriber,
+    dispatches: :missive_dispatches,
+    subscriptions: :missive_subscriptions,
+    subscribed_lists: :missive_subscribed_lists,
+    unsubscribed_lists: :missive_unsubscribed_lists
+  )
+end
+```
+
+You only need to customize the associations that conflict - any unconfigured associations will use their default names.
+
 #### Manage subscriptions
 
 ```rb

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

@@ -2,17 +2,50 @@ module Missive
   module UserAsSender
     extend ActiveSupport::Concern
 
+    class AssociationAlreadyDefinedError < StandardError; end
+
+    ASSOCIATION_NAMES = %i[sender sent_dispatches sent_lists sent_messages].freeze
+
+    class_methods do
+      def missive_sender_config
+        @missive_sender_config ||= ASSOCIATION_NAMES.index_with { |name| name }
+      end
+
+      def configure_missive_sender(options = {})
+        missive_sender_config.merge!(options)
+        _define_missive_sender_associations
+      end
+
+      def _define_missive_sender_associations
+        config = missive_sender_config
+
+        _check_missive_association_collision!(config[:sender])
+
+        has_one config[:sender], class_name: "Missive::Sender", foreign_key: :user_id, dependent: :nullify
+        has_many config[:sent_dispatches], class_name: "Missive::Dispatch", through: config[:sender], source: :dispatches
+        has_many config[:sent_lists], class_name: "Missive::List", through: config[:sender], source: :lists
+        has_many config[:sent_messages], class_name: "Missive::Message", through: config[:sender], source: :messages
+      end
+
+      def _check_missive_association_collision!(name)
+        return unless reflect_on_association(name)
+
+        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)"
+      end
+    end
+
     included do
-      has_one :sender, class_name: "Missive::Sender", dependent: :nullify
-      has_many :sent_dispatches, class_name: "Missive::Dispatch", through: :sender, source: :dispatches
-      has_many :sent_lists, class_name: "Missive::List", through: :sender, source: :lists
-      has_many :sent_messages, class_name: "Missive::Message", through: :sender, source: :messages
+      _define_missive_sender_associations
 
       def init_sender(attributes = {})
-        self.sender = Missive::Sender.find_or_initialize_by(email:)
-        sender.assign_attributes(attributes)
-        sender.save!
-        sender
+        assoc = self.class.missive_sender_config[:sender]
+        send("#{assoc}=", Missive::Sender.find_or_initialize_by(email:))
+        send(assoc).assign_attributes(attributes)
+        send(assoc).save!
+        send(assoc)
       end
     end
   end

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

@@ -2,21 +2,54 @@ module Missive
   module UserAsSubscriber
     extend ActiveSupport::Concern
 
+    class AssociationAlreadyDefinedError < StandardError; end
+
+    ASSOCIATION_NAMES = %i[subscriber dispatches subscriptions subscribed_lists unsubscribed_lists].freeze
+
+    class_methods do
+      def missive_subscriber_config
+        @missive_subscriber_config ||= ASSOCIATION_NAMES.index_with { |name| name }
+      end
+
+      def configure_missive_subscriber(options = {})
+        missive_subscriber_config.merge!(options)
+        _define_missive_subscriber_associations
+      end
+
+      def _define_missive_subscriber_associations
+        config = missive_subscriber_config
+
+        _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[: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",
+          through: config[:subscriber],
+          source: :lists
+      end
+
+      def _check_missive_association_collision!(name)
+        return unless reflect_on_association(name)
+
+        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)"
+      end
+    end
+
     included do
-      has_one :subscriber, class_name: "Missive::Subscriber", dependent: :destroy
-      has_many :dispatches, class_name: "Missive::Dispatch", through: :subscriber
-      has_many :subscriptions, class_name: "Missive::Subscription", through: :subscriber
-      has_many :subscribed_lists, class_name: "Missive::List", through: :subscriber, source: :lists
-      has_many :unsubscribed_lists, -> { where.not(missive_subscriptions: {suppressed_at: nil}) },
-        class_name: "Missive::List",
-        through: :subscriber,
-        source: :lists
+      _define_missive_subscriber_associations
 
       def init_subscriber(attributes = {})
-        self.subscriber = Missive::Subscriber.find_or_initialize_by(email:)
-        subscriber.assign_attributes(attributes)
-        subscriber.save!
-        subscriber
+        assoc = self.class.missive_subscriber_config[:subscriber]
+        send("#{assoc}=", Missive::Subscriber.find_or_initialize_by(email:))
+        send(assoc).assign_attributes(attributes)
+        send(assoc).save!
+        send(assoc)
       end
     end
   end

data/lib/missive/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: missive
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Hans Lemuet
@@ -130,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.4
 specification_version: 4
 summary: Toolbox for managing newsletters in Rails, sending them with Postmark.
 test_files: []