missive 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63e8195762299f95bdc217efcf1a81dbd8be46ec029ea90b8b4db430af37eabd
-  data.tar.gz: 94532fa3c3cd42c9086b35385773c0d2f8483dad96690b0d78523512736aa86e
+  metadata.gz: 2524889a76072d9a0c8a32bcbcf644a47b53ef388eeb5937ab2d643f9f7943e9
+  data.tar.gz: 27050e567ac00cbf4a1d784a2495601b68fe8bfb481c14d3d822d99a33d0d086
 SHA512:
-  metadata.gz: d365c0b22c19489e7d61d46746bec34d58834c167066f02eb71cec287e855a7e820e1eb535e066c2f871cc948338bbbd5151efac7838ca037e2455b36c4dbe07
-  data.tar.gz: d7c9d72e65bbac0b683b6f5b69b888547f7ebc5245c35b6b9f582042ad8ef524b775acaed2aa47d17dd4a2be689315c02e41570913edebf7c213b5d0dc728f6f
+  metadata.gz: 6d58ad49167ba5a32acc92dd1e74e69c74ccd83748465f48497eef9a1d212bd092c5938a3fa1f3fa9357f3bdb8e5cc29c82152ac10cca3b89b094b51cd4ac94e
+  data.tar.gz: 5292722bfed62d90c92d6d61ec831c46fa495bb29609469da887711557e3e8f60a9ceb3bc4084a4fdf04c3b99cbbcf041cd7945100550a7bfbe20c1481ea4f82

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [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
+
+## [0.0.2] - 2025-12-14
+
 - Add install generator
 - Add Postmark Bulk API implementation
 

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 = {})
     # ...
@@ -113,6 +113,53 @@ class User < ApplicationRecord
 end
 ```
 
+#### Customizing 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.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
+```
+
+Or, if including the concerns separately:
+
+```rb
+class User < ApplicationRecord
+  include Missive::UserAsSender.with(
+    sender: :sender,
+    sent_dispatches: :sent_dispatches,
+    sent_lists: :sent_lists,
+    sent_messages: :sent_messages
+  )
+
+  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 you want to rename - any unconfigured associations will use their default `missive_` prefixed names.
+
 #### Manage subscriptions
 
 ```rb
@@ -125,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
@@ -151,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

@@ -2,18 +2,72 @@ module Missive
   module UserAsSender
     extend ActiveSupport::Concern
 
-    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
+    class AssociationAlreadyDefinedError < StandardError; end
 
+    DEFAULT_ASSOCIATION_NAMES = {
+      sender: :missive_sender,
+      sent_dispatches: :missive_sent_dispatches,
+      sent_lists: :missive_sent_lists,
+      sent_messages: :missive_sent_messages
+    }.freeze
+
+    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
+
+    module ClassMethods
+      def missive_sender_config
+        @missive_sender_config ||= DEFAULT_ASSOCIATION_NAMES.dup
+      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 Missive::UserAsSender.with to specify a different name. " \
+          "Example: include Missive::UserAsSender.with(sender: :missive_sender)"
+      end
+    end
+
+    module InstanceMethods
       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
+
+    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

@@ -2,22 +2,77 @@ module Missive
   module UserAsSubscriber
     extend ActiveSupport::Concern
 
-    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
+    class AssociationAlreadyDefinedError < StandardError; end
 
+    DEFAULT_ASSOCIATION_NAMES = {
+      subscriber: :missive_subscriber,
+      dispatches: :missive_dispatches,
+      subscriptions: :missive_subscriptions,
+      subscribed_lists: :missive_subscribed_lists,
+      unsubscribed_lists: :missive_unsubscribed_lists
+    }.freeze
+
+    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
+
+    module ClassMethods
+      def missive_subscriber_config
+        @missive_subscriber_config ||= DEFAULT_ASSOCIATION_NAMES.dup
+      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], 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",
+          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 Missive::UserAsSubscriber.with to specify a different name. " \
+          "Example: include Missive::UserAsSubscriber.with(subscriber: :missive_subscriber)"
+      end
+    end
+
+    module InstanceMethods
       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
+
+    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.2".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.2
+  version: 0.0.4
 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: []