Add generator specs

Author: bradgessler

Gemfile.lock

@@ -2,11 +2,26 @@ PATH
   remote: .
   specs:
     supermail (0.1.0)
-      actionmailer (>= 7.0)
+      actionmailer (~> 7.0)
+      activesupport (~> 7.0)
+      railties (~> 7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (7.2.2.2)
+      actionpack (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.2.2.2)
+      actionpack (= 7.2.2.2)
+      activejob (= 7.2.2.2)
+      activerecord (= 7.2.2.2)
+      activestorage (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      mail (>= 2.8.0)
     actionmailer (7.2.2.2)
       actionpack (= 7.2.2.2)
       actionview (= 7.2.2.2)
@@ -25,6 +40,13 @@ GEM
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
       useragent (~> 0.16)
+    actiontext (7.2.2.2)
+      actionpack (= 7.2.2.2)
+      activerecord (= 7.2.2.2)
+      activestorage (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
     actionview (7.2.2.2)
       activesupport (= 7.2.2.2)
       builder (~> 3.1)
@@ -34,6 +56,18 @@ GEM
     activejob (7.2.2.2)
       activesupport (= 7.2.2.2)
       globalid (>= 0.3.6)
+    activemodel (7.2.2.2)
+      activesupport (= 7.2.2.2)
+    activerecord (7.2.2.2)
+      activemodel (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      timeout (>= 0.4.0)
+    activestorage (7.2.2.2)
+      actionpack (= 7.2.2.2)
+      activejob (= 7.2.2.2)
+      activerecord (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      marcel (~> 1.0)
     activesupport (7.2.2.2)
       base64
       benchmark (>= 0.3)
@@ -76,6 +110,7 @@ GEM
       net-imap
       net-pop
       net-smtp
+    marcel (1.1.0)
     mini_mime (1.1.5)
     mini_portile2 (2.8.9)
     minitest (5.25.5)
@@ -88,6 +123,7 @@ GEM
       timeout
     net-smtp (0.5.1)
       net-protocol
+    nio4r (2.7.4)
     nokogiri (1.18.10)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
@@ -106,13 +142,37 @@ GEM
       rack (>= 3.0.0)
     rack-test (2.2.0)
       rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (7.2.2.2)
+      actioncable (= 7.2.2.2)
+      actionmailbox (= 7.2.2.2)
+      actionmailer (= 7.2.2.2)
+      actionpack (= 7.2.2.2)
+      actiontext (= 7.2.2.2)
+      actionview (= 7.2.2.2)
+      activejob (= 7.2.2.2)
+      activemodel (= 7.2.2.2)
+      activerecord (= 7.2.2.2)
+      activestorage (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      bundler (>= 1.15.0)
+      railties (= 7.2.2.2)
     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)
+    railties (7.2.2.2)
+      actionpack (= 7.2.2.2)
+      activesupport (= 7.2.2.2)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rake (13.3.0)
     rdoc (6.14.2)
       erb
@@ -134,17 +194,24 @@ GEM
     rspec-support (3.13.6)
     securerandom (0.4.1)
     stringio (3.1.7)
+    thor (1.4.0)
     timeout (0.4.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     useragent (0.16.11)
+    websocket-driver (0.8.0)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   arm64-darwin-24
   ruby
 
 DEPENDENCIES
   irb
+  rails (~> 7.0)
   rake (~> 13.0)
   rspec (~> 3.0)
   supermail!

lib/generators/supermail/email/email_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+module Supermail
+  class EmailGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('templates', __dir__)
+
+    desc "Generate a new email class"
+
+    def create_email_file
+      template 'email.rb', "app/emails/#{file_path}_email.rb"
+    end
+
+    private
+
+    def file_path
+      name.underscore
+    end
+
+    def class_name
+      name.camelize
+    end
+  end
+end

lib/generators/supermail/email/templates/email.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class <%= class_name %>Email < ApplicationEmail
+  def body = <<~PLAIN
+
+  PLAIN
+end

lib/generators/supermail/install/install_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Supermail
+  class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc "Install Supermail in a Rails application"
+
+      def create_application_email
+        template 'application_email.rb', 'app/emails/application_email.rb'
+      end
+
+      def create_emails_directory
+        empty_directory 'app/emails'
+      end
+  end
+end

lib/generators/supermail/install/templates/application_email.rb

@@ -0,0 +1,13 @@
+class ApplicationEmail < Supermail::Base
+  def from = "[email protected]"
+
+  def body
+     <<~_
+     #{yield if block_given?}
+
+     Best,
+
+     The Example.com Team
+     _
+  end
+end

lib/supermail.rb

@@ -6,22 +6,25 @@
 module Supermail
   class Error < StandardError; end
 
-  module Rails
-    class Base
-      delegate :deliver, :deliver_now, :deliver_later, to: :message_delivery
+  class Base
+    delegate :deliver, :deliver_now, :deliver_later, to: :message_delivery
 
-      def to = nil
-      def from = nil
-      def subject = nil
-      def body = ""
+    def to = nil
+    def from = nil
+    def subject = nil
+    def body = ""
 
-      def message
-        message_delivery.message
-      end
+    def message
+      message_delivery.message
+    end
 
-      def message_delivery
-        ActionMailer::Base.mail(to:, from:, subject:, body:)
-      end
+    def message_delivery
+      ActionMailer::Base.mail(to:, from:, subject:, body:)
     end
   end
 end
+
+# Load generators only when Rails is available
+if defined?(::Rails)
+  require 'rails'
+end

spec/generators/email_generator_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "generators/supermail/email/email_generator"
+
+RSpec.describe Supermail::EmailGenerator, type: :generator do
+  tests Supermail::EmailGenerator
+
+  EMAIL_DESTINATION_PATH = Pathname.new(__dir__).join("../tmp/generators")
+  destination EMAIL_DESTINATION_PATH.to_s
+
+  before { prepare_destination }
+  after { FileUtils.rm_rf(EMAIL_DESTINATION_PATH) }
+
+  describe "with namespaced email" do
+    before { run_generator ["User::Welcome"] }
+
+    describe "app/emails/user/welcome_email.rb" do
+      subject { File.read(EMAIL_DESTINATION_PATH.join("app/emails/user/welcome_email.rb")) }
+      it { is_expected.to match(/class User::WelcomeEmail < ApplicationEmail/) }
+      it { is_expected.to match(/def body = <<~PLAIN/) }
+    end
+  end
+
+  describe "with simple email" do
+    before { run_generator ["Welcome"] }
+
+    describe "app/emails/welcome_email.rb" do
+      subject { File.read(EMAIL_DESTINATION_PATH.join("app/emails/welcome_email.rb")) }
+      it { is_expected.to match(/class WelcomeEmail < ApplicationEmail/) }
+      it { is_expected.to match(/def body = <<~PLAIN/) }
+    end
+  end
+end

spec/generators/install_generator_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "generators/supermail/install/install_generator"
+
+RSpec.describe Supermail::InstallGenerator, type: :generator do
+  tests Supermail::InstallGenerator
+  
+  INSTALL_DESTINATION_PATH = Pathname.new(__dir__).join("../tmp/generators")
+  destination INSTALL_DESTINATION_PATH.to_s
+  
+  before { prepare_destination }
+  after { FileUtils.rm_rf(INSTALL_DESTINATION_PATH) }
+
+  describe "after running generator" do
+    before { run_generator }
+
+    describe "app/emails/application_email.rb" do
+      subject { File.read(INSTALL_DESTINATION_PATH.join("app/emails/application_email.rb")) }
+      it { is_expected.to match(/class ApplicationEmail < Supermail::Base/) }
+      it { is_expected.to match(/def from = "[email protected]"/) }
+      it { is_expected.to match(/The Example.com Team/) }
+    end
+
+    describe "app/emails directory" do
+      subject { File.directory?(INSTALL_DESTINATION_PATH.join("app/emails")) }
+      it { is_expected.to be true }
+    end
+  end
+end

spec/spec_helper.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'rails/all'
+require 'rails/generators/test_case'
+require 'minitest/assertions'
 require "supermail"
 
 RSpec.configure do |config|
@@ -13,3 +16,15 @@
     c.syntax = :expect
   end
 end
+
+require "rails/generators/testing/behavior"
+require "rails/generators/testing/setup_and_teardown"
+require "rails/generators/testing/assertions"
+
+RSpec.configure do |config|
+  config.include Rails::Generators::Testing::Behavior,         type: :generator
+  config.include Rails::Generators::Testing::SetupAndTeardown, type: :generator
+  config.include Rails::Generators::Testing::Assertions,       type: :generator
+  config.include Minitest::Assertions,                         type: :generator
+  config.include FileUtils,                                    type: :generator
+end

spec/supermail_spec.rb

@@ -2,7 +2,7 @@
 
 require "spec_helper"
 
-class ExampleMailer < Supermail::Rails::Base
+class ExampleMailer < Supermail::Base
   def initialize(to:, from:, subject:, body:)
     @to = to
     @from = from