Add baes Supermail::Rails::Base

Author: bradgessler

Gemfile.lock

@@ -2,25 +2,84 @@ PATH
   remote: .
   specs:
     supermail (0.1.0)
-      mail (~> 2.0)
+      actionmailer (~> 7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionmailer (7.2.2.2)
+      actionpack (= 7.2.2.2)
+      actionview (= 7.2.2.2)
+      activejob (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (7.2.2.2)
+      actionview (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4, < 3.2)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actionview (7.2.2.2)
+      activesupport (= 7.2.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.2.2.2)
+      activesupport (= 7.2.2.2)
+      globalid (>= 0.3.6)
+    activesupport (7.2.2.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.3)
+    builder (3.3.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
+    crass (1.0.6)
     date (3.4.1)
-    diff-lcs (1.6.1)
-    io-console (0.8.0)
-    irb (1.15.1)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    erb (5.0.2)
+    erubi (1.13.1)
+    globalid (1.3.0)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.1)
+    irb (1.15.2)
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
+    logger (1.7.0)
+    loofah (2.24.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
     mail (2.8.1)
       mini_mime (>= 0.1.1)
       net-imap
       net-pop
       net-smtp
     mini_mime (1.1.5)
-    net-imap (0.5.6)
+    mini_portile2 (2.8.9)
+    minitest (5.25.5)
+    net-imap (0.5.10)
       date
       net-protocol
     net-pop (0.1.2)
@@ -29,32 +88,56 @@ GEM
       timeout
     net-smtp (0.5.1)
       net-protocol
+    nokogiri (1.18.10)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm64-darwin)
+      racc (~> 1.4)
     pp (0.6.2)
       prettyprint
     prettyprint (0.2.0)
-    psych (5.2.3)
+    psych (5.2.6)
       date
       stringio
-    rake (13.2.1)
-    rdoc (6.13.0)
+    racc (1.8.1)
+    rack (3.1.16)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    rake (13.3.0)
+    rdoc (6.14.2)
+      erb
       psych (>= 4.0.0)
-    reline (0.6.0)
+    reline (0.6.2)
       io-console (~> 0.5)
-    rspec (3.13.0)
+    rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.5)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
-    stringio (3.1.6)
+    rspec-support (3.13.6)
+    securerandom (0.4.1)
+    stringio (3.1.7)
     timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    useragent (0.16.11)
 
 PLATFORMS
   arm64-darwin-24

README.md

@@ -16,23 +16,21 @@ Then install it in Rails.
 rails generate supermail:install
 ```
 
-This creates the `app/emails/application_email.rb` file that you can customize as the base for all emails.
+This creates the `ApplicationEmail` class at `app/emails/application_email.rb` where you can customize the base for all emails, including setting defaults like the `from` address.
 
 ```ruby
-class ApplicationEmail < Supermail::Email
-  def from = "Supermail <[email protected]>"
-
-  class HTML
-    def after_template
-      p { "Best, The Supermail Team" }
-    end
-  end
-
-  class Text
-    def after_template = <<~_
-      Best,
-      The Supermail Team"
-    _
+class ApplicationEmail < Supermail::Rails::Base
+  def from = "[email protected]"
+  def to = nil
+  def subject = nil
+  def body
+     <<~_
+     #{yield if block_given?}
+
+     Best,
+
+     The Example.com Team
+     _
   end
 end
 ```
@@ -45,30 +43,35 @@ To generate a new email, run the following command:
 rails generate supermail:email User::Welcome
 ```
 
-This will create a new email class in `app/mailers/user/welcome.rb`.
+This will create a new email class in `app/mailers/user/welcome_email.rb`.
 
 ```ruby
 # ./app/email/user/welcome.rb
-class User::Welcome < ApplicationEmail
-  def initialize(user:)
-    @user = user
-  end
+class User::WelcomeEmail < ApplicationEmail
+  def body = <<~PLAIN
+    Hello there!
+  PLAIN
+end
+```
 
-  def subject = "Welcome to Supermail!"
 
-  class HTML
-    def view_template
-      h1 { "Welcome, #{@user.name}!" }
-      p { "We're excited to have you on board." }
-    end
+```ruby
+# ./app/email/user/welcome.rb
+class User::WelcomeEmail < ApplicationEmail
+  def initialize(person:)
+    @person = person
   end
 
-  class Text
-    def view_template = <<~_
-      Welcome, #{@user.name}!
+  def to = @person.email
+  def subject = "Welcome to the website"
+  def body
+    super do
+      <<~_
+      Hi #{@person.name},
 
-      We're excited to have you on board.
-    _
+      Welcome to the website We're excited to have you on board.
+      _
+    end
   end
 end
 ```

lib/supermail.rb

@@ -1,85 +1,23 @@
 # frozen_string_literal: true
 
 require_relative "supermail/version"
-
-require 'mail'
-require "supermail/version"
+require "action_mailer"
 
 module Supermail
   class Error < StandardError; end
 
-  # A simple Email builder that wraps Mail::Message
-  class Email
-    # Hook to ensure default initialization runs before any subclass initialize
-    module Defaults
-      def initialize(*args, &block)
-        # default fields
-        @cc = []
-        @bcc = []
-        @headers = {}
-        @attachments = []
-        super
-      end
-    end
-
-    # Whenever subclassing, prepend Defaults to ensure it wraps initialize
-    def self.inherited(subclass)
-      subclass.prepend Defaults
-      super
-    end
-
-    attr_accessor :from, :to, :cc, :bcc, :subject,
-                  :reply_to, :return_path, :date, :message_id,
-                  :in_reply_to, :references, :headers,
-                  :text_body, :html_body, :attachments
-
-    # Builds a Mail::Message from this Email's attributes
-    # @return [Mail::Message]
-    def message
-      mail = Mail.new
-      mail.from        = Array(from) if from
-      mail.to          = Array(to)
-      mail.cc          = cc if cc.any?
-      mail.bcc         = bcc if bcc.any?
-      mail.reply_to    = Array(reply_to) if reply_to
-      mail.return_path = return_path if return_path
-      mail.date        = date if date
-      mail.message_id  = message_id if message_id
-      mail.in_reply_to = in_reply_to if in_reply_to
-      mail.references  = references if references
-
-      # Custom headers
-      headers.each { |key, value| mail.header[key] = value }
+  module Rails
+    class Base
+      delegate :deliver, :deliver_now, :deliver_later, to: :message
 
-      mail.subject = subject if subject
+      def to = nil
+      def from = nil
+      def subject = nil
+      def body = ""
 
-      # Bodies
-      if text_body
-        mail.text_part = Mail::Part.new do
-          body text_body
-        end
+      def message
+        ActionMailer::Base.mail(to:, from:, subject:, body:)
       end
-
-      if html_body
-        mail.html_part = Mail::Part.new do
-          content_type 'text/html; charset=UTF-8'
-          body html_body
-        end
-      end
-
-      # Attachments (each as a hash: { filename:, content: })
-      attachments.each do |att|
-        mail.add_file filename: att[:filename], content: att[:content]
-      end
-
-      mail
-    end
-
-    # Delivers the built Mail::Message via its configured delivery_method
-    # @return [Mail::Message]
-    def deliver
-      raise Error, "`to` address is required" unless to
-      message.deliver!
     end
   end
 end

spec/supermail_spec.rb

@@ -33,8 +33,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "mail", "~> 2.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_dependency "actionmailer", ">= 7.0"
 end