rails_mail 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 713d9716c2e0f883038bb954b1266575fa1f254e04367fa116b25dde46a69bd6
-  data.tar.gz: 05f5791bb498a169f7ab2a90f8fa1165dba264666e39b3559ad1f25c4660970d
+  metadata.gz: 536a20c5a826b0b73dfa72b4fc50e2b3ec3821bf7af3407973c2c6aa02151072
+  data.tar.gz: ef136ee4aae7150889c7383850fd18ca37fa1f72decc3683d933e38b1d555cb4
 SHA512:
-  metadata.gz: 20b6563ee2449cd8cc9f76a43c79ae35514c30365ef832f89d773e0722967a27a2aebeb5b89da8999fc7be857263e698120be66673229d1715af612ffcf6c951
-  data.tar.gz: 17410e94c060fada4766fdd97238864386e2b4866ae4152b74b4279394448e1e6a9178df17c64cbd411e0f09ff69502569b9c393c3fed0fc419ec09eb948b66f
+  metadata.gz: 5d48f19287f7bc951ce9b293bfbbedec5850eb22cfd39f7339328122bea226d80cfeddfd1559e121e20419379553982c0bea22dd7a6de198340ca98a366c8e63
+  data.tar.gz: 9972c2e2f77d9202ea1b5b737a4168cf819371f44590eca9ea3dbd5e455dbcf00b2d0e164a601de860749f30b7d971842a89f6dfd2a84eed688359a157950593

data/README.md

@@ -19,6 +19,7 @@ RailsMail saves all outgoing emails to your database instead of actually sending
 * Dynamic time ago in words using date-fns
 * Ability to customize how the job that trims emails is enqueued
 * Ability to customize the title in the top left of the page via a standard Rails view that overrides the engine's default view.
+* Toggle between HTML & text-only views for emails.
 
 ## Installation
 
@@ -120,6 +121,86 @@ end
 - `trim_emails_max_count`: Keeps only the N most recent emails, deleting older ones.
 - `sync_via`: Controls whether the trimming job runs synchronously (:now) or asynchronously (:later)
 
+### Custom Renderers
+
+RailsMail supports custom renderers that allow you to add new ways to display emails. For example, you could add a renderer for markdown emails or a special format your application uses.
+
+By default, RailsMail includes these renderers:
+- HTML renderer: Displays HTML email content
+- Text renderer: Displays plain text email content
+- Exception Notifier renderer: Provides formatted display of exception emails from the ExceptionNotifier gem
+
+#### Creating a Custom Renderer
+
+1. Create a new renderer class that inherits from `RailsMail::Renderer::Base`:
+
+```ruby
+# app/renderers/markdown_renderer.rb
+module RailsMail
+  module Renderer
+    class MarkdownRenderer < Base
+      def self.handles?(email)
+        email.content_type&.include?("text/markdown")
+      end
+
+      def self.partial_name
+        "rails_mail/emails/markdown_content"
+      end
+
+      def self.title
+        "Markdown"
+      end
+
+      def self.priority
+        5 # Between Text and Exception renderers
+      end
+
+      def self.data(email)
+        { markdown_content: process_markdown(email.text_body) }
+      end
+
+      private
+
+      def self.process_markdown(text)
+        # Your markdown processing logic here
+        text
+      end
+    end
+  end
+end
+```
+
+2. Create a partial for your renderer:
+
+```erb
+# app/views/rails_mail/emails/_markdown_content.html.erb
+<div class="mt-3 markdown-content">
+  <%= markdown_content %>
+</div>
+```
+
+3. Register your renderer in an initializer:
+
+```ruby
+# config/initializers/rails_mail.rb
+RailsMail.configure do |config|
+  # ... other configuration ...
+end
+
+# Register custom renderers after configuration
+RailsMail::RendererRegistry.register(RailsMail::Renderer::MarkdownRenderer)
+```
+
+#### Renderer API
+
+Custom renderers must implement these class methods:
+
+- `handles?(email)`: Returns true if this renderer should handle the email
+- `partial_name`: Returns the path to the partial that renders the content
+- `title`: (optional) The tab title. Defaults to the class name without "Renderer"
+- `priority`: (optional) Order in which renderers appear. Lower numbers appear first
+- `data(email)`: (optional) Additional data to pass to the partial. Returns a hash
+
 ### Customize the title
 Since this is a Rails engine, you can customize the title by creating a file at `app/views/layouts/rails_mail/_title.html.erb`.
 
@@ -165,6 +246,7 @@ RailsMail uses Turbo, TurboStreams, and ActionCable to provide real-time updates
 
 - In development environment, the typical default for ActionCable (cable.yml) is to use the async adapter which is an in-memory adapter. If you try to send an email from the rails console, it will not auto-update the ui. You can change the adapter to the development adapter by running `cable.yml` to use something like the redis, postgresql adapter, or solidcable. 
 - In staging environments, the same idea typically applies that you need to use a multi-process adapter like redis, postgresql, or solidcable.
+- Inline `<style>` tags will be sanitized in email bodies.
 
 ## Future work / ideas
 
@@ -176,6 +258,7 @@ RailsMail uses Turbo, TurboStreams, and ActionCable to provide real-time updates
 - Implement read/unread functionality
 - Implement individual email delete
 - Implement multi-part (text/html) email support
+- Allow clients to add additional acceptable HTML tags to render
 
 ## Contributing
 Contribution directions go here.

data/app/helpers/rails_mail/emails_helper.rb

@@ -1,4 +1,14 @@
 module RailsMail
   module EmailsHelper
+    def prepare_email_html(raw_html)
+      doc = Nokogiri::HTML::DocumentFragment.parse(raw_html)
+      doc.css("a[href]").each do |a|
+        a.set_attribute("target", "_blank")
+        a.set_attribute("data-turbo", "false")
+      end
+      sanitize(doc.to_html,
+        tags: ActionView::Base.sanitized_allowed_tags + [ "table", "tbody", "tr", "td" ],
+        attributes: ActionView::Base.sanitized_allowed_attributes + [ "style", "target", "data-turbo" ])
+    end
   end
 end

data/app/models/rails_mail/email.rb

@@ -13,12 +13,8 @@ module RailsMail
       where("CAST(data AS CHAR) LIKE :q", q: "%#{query}%")
     }
 
-    def text?
-      content_type&.include?("text/plain") || content_type&.include?("multipart/alternative")
-    end
-
-    def html?
-      content_type&.include?("text/html") || content_type&.include?("multipart/alternative")
+    def exception_parser
+      @exception_parser ||= ExceptionParser.new(text_body)
     end
 
     def next_email
@@ -26,15 +22,19 @@ module RailsMail
     end
 
     def html_body
-      return nil unless html?
-
-      html_part["raw_source"]
+      html_part&.dig("raw_source")
     end
 
     def text_body
-      return nil unless text?
+      text_part&.dig("raw_source")
+    end
+
+    def renderers
+      RailsMail::RendererRegistry.matching_renderers(self)
+    end
 
-      text_part["raw_source"]
+    def render_partials
+      renderers.map(&:partial_name)
     end
 
     private

data/app/views/rails_mail/emails/_email_tabs.html.erb

@@ -1,28 +1,28 @@
 <div class="prose max-w-none break-words">
-  <input type="radio" name="email_tab" id="html_tab" class="hidden peer/html" <%= email.html? ? 'checked' : '' %> <%= email.html? ? '' : 'disabled' %> />
-  <label
-    for="html_tab"
-    class="px-4 py-2 text-sm font-medium cursor-pointer peer-checked/html:text-blue-600 peer-checked/html:border-blue-600 peer-checked/html:border-b-2 peer-disabled/html:text-gray-400 peer-disabled/html:cursor-not-allowed">
-    HTML
-  </label>
-  
-  <input type="radio" name="email_tab" id="text_tab" class="hidden peer/text" <%= email.text? ? (!email.html? ? 'checked' : '') : 'disabled' %> />
-  <label
-    for="text_tab"
-    class="px-4 py-2 text-sm font-medium cursor-pointer peer-checked/text:text-blue-600 peer-checked/text:border-blue-600 peer-checked/text:border-b-2 peer-disabled/text:text-gray-400 peer-disabled/text:cursor-not-allowed">
-    Text
-  </label>
+  <% @email.renderers.each_with_index do |renderer, index| %>
+    <input
+      type="radio"
+      name="email_tab"
+      id="<%= renderer.partial_name.parameterize %>_tab"
+      class="hidden peer/<%= renderer.partial_name.parameterize %>"
+      <%= index == 0 ? 'checked' : '' %>
+    />
+    <label
+      for="<%= renderer.partial_name.parameterize %>_tab"
+      class="px-4 py-2 text-sm font-medium cursor-pointer
+        peer-checked/<%= renderer.partial_name.parameterize %>:text-blue-600
+        peer-checked/<%= renderer.partial_name.parameterize %>:border-blue-600
+        peer-checked/<%= renderer.partial_name.parameterize %>:border-b-2
+        peer-disabled/<%= renderer.partial_name.parameterize %>:text-gray-400
+        peer-disabled/<%= renderer.partial_name.parameterize %>:cursor-not-allowed">
+      <%= renderer.title %>
+    </label>
+  <% end %>
 
-  <div class="hidden peer-checked/html:block mt-3">
-    <% if email.html? %>
-      <%= sanitize(email.html_body,
-        tags: ActionView::Base.sanitized_allowed_tags + ['table', 'tbody', 'tr', 'td'],
-        attributes: ActionView::Base.sanitized_allowed_attributes + ['style']) %>
-    <% end %>
-  </div>
-  <div class="hidden peer-checked/text:block mt-3 bg-black text-white font-mono p-4 rounded">
-    <% if email.text? %>
-      <%= simple_format email.text_body %>
-    <% end %>
-  </div>
+  <% @email.renderers.each do |renderer| %>
+    <div class="hidden peer-checked/<%= renderer.partial_name.parameterize %>:block">
+      <%= render partial: renderer.partial_name,
+                 locals: { email: @email }.merge(renderer.data(@email)) %>
+    </div>
+  <% end %>
 </div>

data/app/views/rails_mail/emails/_exception.html.erb

@@ -0,0 +1,54 @@
+<div class="max-w-5xl mx-auto p-6 space-y-6">
+  <div class="bg-red-50 p-4 rounded-xl shadow">
+    <h2 class="text-xl font-semibold text-red-800">⚠️ <%= exception.dig(:error, :type) %> in <%= exception.dig(:error, :location) %></h2>
+    <p class="text-red-700 mt-2"><%= exception.dig(:error, :message) %></p>
+    <% if exception.dig(:error, :backtrace_line).present? %>
+      <p class="text-gray-700 mt-2 font-mono text-sm"><%= exception.dig(:error, :backtrace_line) %></p>
+    <% end %>
+  </div>
+
+  <% # Reorder the sections for better logical flow %>
+  <% [:request, :session, :data].each do |section| %>
+    <% if exception[section].present? %>
+      <div class="bg-white border border-gray-200 rounded-xl shadow p-4">
+        <h3 class="text-lg font-bold text-gray-800 capitalize"><%= section %></h3>
+        <dl class="mt-2 grid grid-cols-1 md:grid-cols-2 gap-x-6 gap-y-3 text-sm">
+          <% exception[section].each do |k, v| %>
+            <div>
+              <dt class="text-gray-500"><%= k %></dt>
+              <dd class="text-gray-800 font-mono break-words"><%= v %></dd>
+            </div>
+          <% end %>
+        </dl>
+      </div>
+    <% end %>
+  <% end %>
+
+  <% if exception[:backtrace].present? %>
+    <div class="bg-gray-100 border border-gray-200 rounded-xl shadow p-4">
+      <h3 class="text-lg font-bold text-gray-800">Backtrace</h3>
+      <ul class="mt-2 list-disc list-inside text-sm text-gray-700 font-mono space-y-1">
+        <% exception[:backtrace].each do |line| %>
+          <li><%= line %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <% if exception[:environment].present? %>
+    <div class="bg-white border border-gray-200 rounded-xl shadow p-4">
+      <h3 class="text-lg font-bold text-gray-800">Environment</h3>
+      <details>
+        <summary class="cursor-pointer text-blue-600 hover:text-blue-800 mb-2">Show Environment Variables</summary>
+        <dl class="mt-2 grid grid-cols-1 md:grid-cols-2 gap-x-6 gap-y-3 text-sm">
+          <% exception[:environment].each do |k, v| %>
+            <div>
+              <dt class="text-gray-500"><%= k %></dt>
+              <dd class="text-gray-800 font-mono break-words"><%= v %></dd>
+            </div>
+          <% end %>
+        </dl>
+      </details>
+    </div>
+  <% end %>
+</div>

data/app/views/rails_mail/emails/_html_content.html.erb

@@ -0,0 +1,5 @@
+<div class="mt-3">
+  <%= sanitize(email.html_body,
+    tags: ActionView::Base.sanitized_allowed_tags + ['table', 'tbody', 'tr', 'td'],
+    attributes: ActionView::Base.sanitized_allowed_attributes + ['style']) %>
+</div> 

data/app/views/rails_mail/emails/_text_content.html.erb

@@ -0,0 +1,3 @@
+<div class="mt-3 bg-black text-white font-mono p-4 rounded">
+  <%= simple_format email.text_body %>
+</div>

data/lib/rails_mail/configuration.rb

@@ -1,3 +1,5 @@
+require "rails_mail/renderer"
+
 module RailsMail
   class Configuration
     attr_accessor :authentication_callback, :show_clear_all_button_callback,
@@ -10,6 +12,7 @@ module RailsMail
       @trim_emails_older_than = nil
       @trim_emails_max_count = nil
       @enqueue_trim_job = ->(email) { RailsMail::TrimEmailsJob.perform_later }
+      register_default_renderers
     end
 
     def authenticate(&callback)
@@ -25,5 +28,13 @@ module RailsMail
       end
       @show_clear_all_button_callback = callback
     end
+
+    private
+
+    def register_default_renderers
+      RailsMail::RendererRegistry.register(RailsMail::Renderer::HtmlRenderer)
+      RailsMail::RendererRegistry.register(RailsMail::Renderer::TextRenderer)
+      RailsMail::RendererRegistry.register(RailsMail::Renderer::ExceptionNotifierRenderer)
+    end
   end
 end

data/lib/rails_mail/exception_parser.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module RailsMail
+  class ExceptionParser
+    attr_reader :raw
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def valid_format?
+      return false unless @raw.present?
+      @raw.include?("occurred in")
+    end
+
+    def parse
+      return {} unless @raw
+
+      # Extract the error information from the first few lines
+      error_info = extract_error
+
+      # Extract sections using a more direct approach
+      sections = {
+        "Data" => extract_section("Data"),
+        "Request" => extract_section("Request"),
+        "Session" => extract_section("Session"),
+        "Backtrace" => extract_section("Backtrace"),
+        "Environment" => extract_section("Environment")
+      }
+
+      {
+        error: error_info,
+        data: parse_section_content(sections["Data"]),
+        request: parse_section_content(sections["Request"]),
+        session: parse_section_content(sections["Session"]),
+        backtrace: parse_backtrace(sections["Backtrace"]),
+        environment: parse_section_content(sections["Environment"])
+      }
+    end
+
+    def extract_error
+      # Look for the error line pattern - supporting both "A" and "An"
+      error_match = @raw.match(/^A(?:n)? ([\w:]+) occurred in ([^:]+):\r\n\r\n\s+(.*?)\r\n\s+(.+?)\r\n/m)
+      return {} unless error_match
+
+      {
+        type: error_match[1],
+        location: error_match[2],
+        message: error_match[3],
+        backtrace_line: error_match[4]
+      }
+    end
+
+    def extract_section(section_name)
+      # Match the section header and everything until the next section header or end of string
+      section_regex = /^-+\r\n#{Regexp.escape(section_name)}:\r\n-+\r\n(.*?)(?=\r\n-+\r\n|\z)/m
+      match = @raw.match(section_regex)
+      match ? match[1] : ""
+    end
+
+    def parse_section_content(content)
+      return {} unless content && !content.empty?
+
+      result = {}
+      content.split("\r\n").each do |line|
+        line = line.strip
+        # Handle lines that start with * and have indentation
+        if line.start_with?("*")
+          # Remove the asterisk and any leading whitespace
+          key_value = line.sub(/^\*\s*/, "").split(":", 2)
+          if key_value.length == 2
+            key = key_value[0].strip
+            value = key_value[1].strip
+            result[key] = value if key && !key.empty?
+          end
+        end
+      end
+      result
+    end
+
+    def parse_backtrace(content)
+      return [] unless content && !content.empty?
+
+      # Split by Windows-style line endings and extract non-empty lines
+      lines = content.split("\r\n").map(&:strip).reject(&:empty?)
+      # Filter out lines that start with * (which would be key-value pairs)
+      lines.reject { |line| line.start_with?("*") }
+    end
+  end
+end

data/lib/rails_mail/renderer/base.rb

@@ -0,0 +1,25 @@
+module RailsMail
+  module Renderer
+    class Base
+      def self.handles?(email)
+        raise NotImplementedError, "#{self.name} must implement .handles?"
+      end
+
+      def self.partial_name
+        raise NotImplementedError, "#{self.name} must implement .partial_name"
+      end
+
+      def self.title
+        self.name.demodulize.sub("Renderer", "")
+      end
+
+      def self.priority
+        0 # Lower numbers render first
+      end
+
+      def self.data(email)
+        {} # Override to provide additional data to the partial
+      end
+    end
+  end
+end

data/lib/rails_mail/renderer/exception_notifier_renderer.rb

@@ -0,0 +1,25 @@
+module RailsMail
+  module Renderer
+    class ExceptionNotifierRenderer < Base
+      def self.handles?(email)
+        email.exception_parser.valid_format?
+      end
+
+      def self.partial_name
+        "rails_mail/emails/exception"
+      end
+
+      def self.title
+        "Exception"
+      end
+
+      def self.priority
+        1 # After standard renderers
+      end
+
+      def self.data(email)
+        { exception: email.exception_parser.parse }
+      end
+    end
+  end
+end

data/lib/rails_mail/renderer/html_renderer.rb

@@ -0,0 +1,22 @@
+module RailsMail
+  module Renderer
+    class HtmlRenderer < Base
+      def self.handles?(email)
+        email.content_type&.include?("text/html") ||
+          email.content_type&.include?("multipart/alternative")
+      end
+
+      def self.partial_name
+        "rails_mail/emails/html_content"
+      end
+
+      def self.title
+        "HTML"
+      end
+
+      def self.priority
+        10 # Base priority for standard content
+      end
+    end
+  end
+end

data/lib/rails_mail/renderer/text_renderer.rb

@@ -0,0 +1,22 @@
+module RailsMail
+  module Renderer
+    class TextRenderer < Base
+      def self.handles?(email)
+        email.content_type&.include?("text/plain") ||
+          email.content_type&.include?("multipart/alternative")
+      end
+
+      def self.partial_name
+        "rails_mail/emails/text_content"
+      end
+
+      def self.title
+        "Text"
+      end
+
+      def self.priority
+        20 # Just after HTML
+      end
+    end
+  end
+end

data/lib/rails_mail/renderer.rb

@@ -0,0 +1,10 @@
+require "rails_mail/renderer/base"
+require "rails_mail/renderer/html_renderer"
+require "rails_mail/renderer/text_renderer"
+require "rails_mail/renderer/exception_notifier_renderer"
+require "rails_mail/renderer_registry"
+
+module RailsMail
+  module Renderer
+  end
+end

data/lib/rails_mail/renderer_registry.rb

@@ -0,0 +1,19 @@
+module RailsMail
+  class RendererRegistry
+    class << self
+      def register(renderer_class)
+        renderers << renderer_class
+      end
+
+      def renderers
+        @renderers ||= []
+      end
+
+      def matching_renderers(email)
+        renderers
+          .select { |renderer| renderer.handles?(email) }
+          .sort_by(&:priority)
+      end
+    end
+  end
+end

data/lib/rails_mail/version.rb

@@ -1,3 +1,3 @@
 module RailsMail
-  VERSION = "0.10.1"
+  VERSION = "0.10.2"
 end

data/lib/rails_mail.rb

@@ -2,6 +2,8 @@ require "rails_mail/version"
 require "rails_mail/engine"
 require "rails_mail/delivery_method"
 require "rails_mail/configuration"
+require "rails_mail/exception_parser"
+require "rails_mail/renderer"
 
 module RailsMail
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_mail
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Peter Philips
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-15 00:00:00.000000000 Z
+date: 2025-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -87,7 +87,10 @@ files:
 - app/views/rails_mail/emails/_email.html.erb
 - app/views/rails_mail/emails/_email_tabs.html.erb
 - app/views/rails_mail/emails/_empty_state.html.erb
+- app/views/rails_mail/emails/_exception.html.erb
 - app/views/rails_mail/emails/_form.html.erb
+- app/views/rails_mail/emails/_html_content.html.erb
+- app/views/rails_mail/emails/_text_content.html.erb
 - app/views/rails_mail/emails/destroy.turbo_stream.erb
 - app/views/rails_mail/emails/destroy_all.turbo_stream.erb
 - app/views/rails_mail/emails/edit.html.erb
@@ -105,6 +108,13 @@ files:
 - lib/rails_mail/configuration.rb
 - lib/rails_mail/delivery_method.rb
 - lib/rails_mail/engine.rb
+- lib/rails_mail/exception_parser.rb
+- lib/rails_mail/renderer.rb
+- lib/rails_mail/renderer/base.rb
+- lib/rails_mail/renderer/exception_notifier_renderer.rb
+- lib/rails_mail/renderer/html_renderer.rb
+- lib/rails_mail/renderer/text_renderer.rb
+- lib/rails_mail/renderer_registry.rb
 - lib/rails_mail/version.rb
 - lib/tasks/rails_mail_tasks.rake
 homepage: https://github.com/synth/rails_mail