supermail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53951b27c057ea4419f1ffbbc3666189712d30449af65e539148d7df306de7d3
+  data.tar.gz: 789c9f9844880bae6611b9c5cdb958a4fb6b2d7c59888db016c503ebabec3573
+SHA512:
+  metadata.gz: 4de9d3383587ea03cd2eb302c6db564d88972535f286ed3ed2181146a56cc815d893e2a84543435854f92f39b767598bd5cef348516865f6706d290961f38d27
+  data.tar.gz: 6364025594980a3ca8776970cd20be025cbe044cc69dc55766f89e874842f691e0d2b244a0dba773f92976ca6d69ab28bc0956233d25195e1afbbed67723d956

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/README.md

@@ -0,0 +1,94 @@
+# Supermail
+
+Supermail is a slightly more intuitive way of organizing Emails in a Rails application.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add supermail
+```
+
+Then install it in Rails.
+
+```bash
+rails generate supermail:install
+```
+
+This creates the `app/emails/application_email.rb` file that you can customize as the base for all emails.
+
+```ruby
+class ApplicationEmail < Supermail::Email
+  def from = "Supermail <noreply@supermail.com>"
+
+  class HTML
+    def after_template
+      p { "Best, The Supermail Team" }
+    end
+  end
+
+  class Text
+    def after_template
+      "Best,\nThe Supermail Team"
+    end
+  end
+end
+```
+
+## Usage
+
+To generate a new email, run the following command:
+
+```bash
+rails generate supermail:email User::Welcome
+```
+
+This will create a new email class in `app/mailers/user/welcome.rb`.
+
+```ruby
+# ./app/email/user/welcome.rb
+class User::Welcome < ApplicationEmail
+  def initialize(user:)
+    @user = user
+  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
+  end
+
+  class Text
+    def view_template
+      "Welcome, #{@user.name}!\n\nWe're excited to have you on board."
+    end
+  end
+end
+```
+
+Then, to send the email.
+
+```ruby
+User::Welcome.new(user: User.first).deliver_now
+```
+
+If you want to tweak the message on the fly, you can modify the message, then deliver it.
+
+```ruby
+User::Welcome.new(user: User.first).message.tap do
+  it.to << "another@example.com"
+end.deliver_now
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubymonolith/supermail.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/supermail/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Supermail
+  VERSION = "0.1.0"
+end

data/lib/supermail.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "supermail/version"
+
+require 'mail'
+require "supermail/version"
+
+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 }
+
+      mail.subject = subject if subject
+
+      # Bodies
+      if text_body
+        mail.text_part = Mail::Part.new do
+          body text_body
+        end
+      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

data/sig/supermail.rbs

@@ -0,0 +1,4 @@
+module Supermail
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: supermail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brad Gessler
+bindir: exe
+cert_chain: []
+date: 2025-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Build emails with plain ol' Ruby objects.
+email:
+- bradgessler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- README.md
+- Rakefile
+- lib/supermail.rb
+- lib/supermail/version.rb
+- sig/supermail.rbs
+homepage: https://github.com/rubymonolith/supermail
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rubymonolith/supermail
+  source_code_uri: https://github.com/rubymonolith/supermail
+  changelog_uri: https://github.com/rubymonolith/supermail
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Build emails with plain ol' Ruby objects.
+test_files: []