rails_mail 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a5b082815997cb25d49acaec8336d565dd9c03a1a4a0d98d453fd16cf4eb515
-  data.tar.gz: a1c6f9008760194eb79874ae695db11ffce158316fb14cac0ed6584889fa0bae
+  metadata.gz: c0111e011c108a5b717fcb3f4074985e58faaeef49d4247587697be29facff12
+  data.tar.gz: edbcf7e6c0856e325c7d3fba6d0d03ac024eb26874a194d9554b0b39685d2ddb
 SHA512:
-  metadata.gz: b48e6c395e19ba01bea9290bd66e1f006347868f8f327b80c5c2dca5002cd1b14de5d00cfea7d1f4bfb5b4be80e153967b26597ff16e105fde4903b4bdb57ded
-  data.tar.gz: d8821e83718954273d9fe6d1211ae8ae4b6f88762cab0a05c4c7dc9a9e35efc1f5a62bc3424a9e80bf50e2c9739dec8404c267e8d05c69dfe79614fccd46c097
+  metadata.gz: 1d4e8443a570257b4f3fd15b1a807610968968de29ad779a21e2073611b7efdd5f062e2073a250f2b3834a7af2f2b154ff92daba835fd9492747536178d49e42
+  data.tar.gz: 27d2f45c1ffb9db48e0916078c6afe565aeaa9be29c6d6bf9dddb53fad28706501313539352c1e1857b29c3ba364a5474397a02ab6dd042999e87b149974f104

data/README.md

@@ -17,6 +17,7 @@ RailsMail saves all outgoing emails to your database instead of actually sending
 * Trimming emails older than a specified duration or a maximum number of emails
 * Ability to manually clear emails out and turn on/off that functionality based on environment (eg, so that in Staging, other stakeholders can't clear emails out, but in dev sometimes you want a clean slate)
 * Dynamic time ago in words using date-fns
+* Ability to customize how the job that trims emails is enqueued
 
 ## Installation
 

data/app/controllers/rails_mail/base_controller.rb

@@ -1,7 +1,9 @@
 module RailsMail
   class BaseController < ActionController::Base
     layout "rails_mail/application"
-    helper TurboHelper if defined?(TurboHelper)
+    helper RailsMail::TurboHelper
+    include RailsMail::TurboHelper
+
     before_action :authenticate!
 
     private

data/app/controllers/rails_mail/emails_controller.rb

@@ -25,15 +25,10 @@ module RailsMail
     end
 
     def destroy_all
-      # Email.destroy_all
+      Email.destroy_all
       respond_to do |format|
         format.html { redirect_to emails_path }
-        format.turbo_stream {
-          render turbo_stream: [
-            turbo_stream.update("email-sidebar", ""),
-            turbo_stream.update("email_content", partial: "empty_state")
-          ]
-        }
+        format.turbo_stream
       end
     end
   end

data/app/frontend/rails_mail/modules/email_highlight_controller.js

@@ -4,7 +4,7 @@ export default class extends Controller {
   static targets = ["link"]
   
   // Define the Tailwind class as a static property
-  static activeClass = "bg-gray-100"
+  static activeClass = "bg-gray-300"
 
   connect() {
     console.log("EmailHighlightController connected")

data/app/helpers/rails_mail/turbo_helper.rb

@@ -1,6 +1,6 @@
 module RailsMail
   module TurboHelper
-    def turbo_frame_tag(name, src: nil, &block)
+    def rails_mail_turbo_frame_tag(name, src: nil, &block)
       tag.turbo_frame id: name, src: src do
         if block_given?
           yield
@@ -8,7 +8,7 @@ module RailsMail
       end
     end
 
-    def turbo_stream_from(*streamables, **attributes)
+    def rails_mail_turbo_stream_from(*streamables, **attributes)
       return unless defined?(::ActionCable)
 
       raise ArgumentError, "streamables can't be blank" unless streamables.any?(&:present?)
@@ -18,7 +18,7 @@ module RailsMail
       tag.turbo_cable_stream_source(**attributes)
     end
 
-    def turbo_stream
+    def rails_mail_turbo_stream
       TurboStreamBuilder.new
     end
 
@@ -31,6 +31,10 @@ module RailsMail
         build_stream("prepend", target, content)
       end
 
+      def update(target:, content:)
+        build_stream("update", target, content)
+      end
+
       private
 
       def build_stream(action, target, content)

data/app/jobs/rails_mail/trim_emails_job.rb

@@ -12,6 +12,8 @@ module RailsMail
       if RailsMail.configuration.trim_emails_max_count
         trim_by_count
       end
+    rescue StandardError => e
+      Rails.logger.error "RailsMail::TrimJob#perform Failed: #{e.message}"
     end
 
     private

data/app/models/rails_mail/email.rb

@@ -6,7 +6,7 @@ module RailsMail
     validates :to, presence: true
 
     after_create_commit :broadcast_email
-    after_create :schedule_trim_job
+    after_create_commit :enqueue_trim_job
 
     scope :search, ->(query) {
       where("CAST(data AS CHAR) LIKE :q", q: "%#{query}%")
@@ -19,6 +19,7 @@ module RailsMail
     def html?
       content_type&.include?("text/html")
     end
+
     private
 
     def broadcast_email
@@ -30,16 +31,14 @@ module RailsMail
         partial: "rails_mail/shared/email",
         locals: { email: self }
       )
-    rescue NameError => e
-      Rails.logger.debug "Skipping broadcast: #{e.message}"
+    rescue StandardError => e
+      Rails.logger.error "RailsMail::Email#broadcast_email failed: #{e.message}"
     end
 
-    def schedule_trim_job
-      if RailsMail.configuration.trim_via == :perform_now
-        RailsMail::TrimEmailsJob.perform_now
-      else
-        RailsMail::TrimEmailsJob.perform_later
-      end
+    def enqueue_trim_job
+      RailsMail.configuration.enqueue_trim_job.call(self)
+    rescue StandardError => e
+      Rails.logger.error "RailsMail::Email#enqueue_trim_job Failed: #{e.message}"
     end
   end
 end

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

@@ -1,4 +1,4 @@
-<%= turbo_frame_tag "email_content" do %>
+<%= rails_mail_turbo_frame_tag "email_content" do %>
   <div class="bg-white shadow rounded-lg" data-email-id="<%= email.id %>" 
        data-email-highlight-current-id-value="<%= email.id %>">
     <div class="px-6 py-4 border-b border-gray-200">

data/app/views/rails_mail/emails/destroy_all.turbo_stream.erb

@@ -0,0 +1,9 @@
+<turbo-stream action="update" target="email-sidebar">
+  <template>
+  </template>
+</turbo-stream>
+<turbo-stream action="update" target="email_content">
+  <template>
+    <%= render(partial: "rails_mail/emails/empty_state", formats: [ :html ]) %>
+  </template>
+</turbo-stream>

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

@@ -1,5 +1,5 @@
 <% if @email.present? %>
-  <%= turbo_frame_tag "email_content", src: email_path(@email) do %>
+  <%= rails_mail_turbo_frame_tag "email_content", src: email_path(@email) do %>
     <div class="bg-white shadow rounded-lg">
       <div class="px-6 py-4">
         <div class="animate-pulse">

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

@@ -1,4 +1,4 @@
-<%= turbo_frame_tag "email_content" do %>
+<%= rails_mail_turbo_frame_tag "email_content" do %>
   <div class="bg-white shadow rounded-lg">
     <div class="px-6 py-4 border-b border-gray-200">
       <h1 class="text-2xl font-semibold text-gray-900"><%= @email.subject %></h1>

data/app/views/rails_mail/shared/_email.html.erb

@@ -1,9 +1,9 @@
 <%
   on_current_page = current_page?(RailsMail::Engine.routes.url_helpers.email_path(email))
-  highlight_class = on_current_page ? 'bg-gray-100' : ''
+  highlight_class = on_current_page ? 'bg-gray-300' : ''
 %>
 <%= link_to RailsMail::Engine.routes.url_helpers.email_path(email), 
-      class: "block px-3 py-2 rounded-md hover:bg-gray-50 #{highlight_class} active:bg-gray-100 focus:bg-gray-100", 
+      class: "block px-3 py-2 rounded-md hover:bg-gray-200 #{highlight_class} active:bg-gray-300 focus:bg-gray-300", 
       data: { 
         "turbo-frame": "email_content",
         "turbo-action": "advance",

data/app/views/rails_mail/shared/_email_sidebar.html.erb

@@ -1,5 +1,5 @@
 <% if defined?(::ActionCable) %>
-  <%= turbo_stream_from "rails_mail:emails", channel: "RailsMail::EmailsChannel" %>
+  <%= rails_mail_turbo_stream_from "rails_mail:emails", channel: "RailsMail::EmailsChannel" %>
 <% end %>
 
 <div id="email-sidebar" data-controller="email-highlight">

data/lib/generators/rails_mail/install/templates/initializer.rb

@@ -1,23 +1,38 @@
 # rubocop:disable Layout/CommentIndentation
 
-RailsMail.configure do |config|
-  # Authentication setup
-  # if left blank, authentication is skipped
-  # config.authentication_callback do
-    # Example implementation for Authlogic:
-    # user_session = UserSession.find
-    # msg = Rails.env.development? ? 'Forbidden - make sure you have the correct permission in config/initializers/rails_mail.rb' : 'Not Found'
-    # raise ActionController::RoutingError.new(msg) unless user_session&.user&.admin?
-  # end
+Rails.configuration.to_prepare do
+  RailsMail.configure do |config|
+    # Authentication setup
+    # if left blank, authentication is skipped
+    # config.authentication_callback do
+      # Example implementation for Authlogic:
+      # user_session = UserSession.find
+      # msg = Rails.env.development? ? 'Forbidden - make sure you have the correct permission in config/initializers/rails_mail.rb' : 'Not Found'
+      # raise ActionController::RoutingError.new(msg) unless user_session&.user&.admin?
+    # end
 
-  config.show_clear_button do
-    # show clear button in development
-    # and prefer to trim in non-development environments
-    # to prevent accidental deletion of emails
-    Rails.env.development?
-  end
+    config.show_clear_button do
+      # show clear button in development
+      # and prefer to trim in non-development environments
+      # to prevent accidental deletion of emails
+      Rails.env.development?
+    end
+
+    config.trim_emails_older_than = 30.days
+    config.trim_emails_max_count = 1000
+
+    # Configure how trim jobs are enqueued
+    # You can use perform_now for immediate execution (default):
+    # config.enqueue_trim_job = ->(email) { RailsMail::TrimEmailsJob.perform_now }
 
-  config.trim_emails_older_than = 30.days
-  config.trim_emails_max_count = 1000
-  config.trim_via = :perform_later
+    # Or create a custom job class:
+    # class CustomTrimEmailsJob < RailsMail::TrimEmailsJob
+    #   def perform
+    #     Rails.logger.debug "CustomTrimEmailsJob#perform"
+    #     super
+    #   end
+    # end
+
+    # config.enqueue_trim_job = ->(email) { CustomTrimEmailsJob.perform_later }
+  end
 end

data/lib/rails_mail/configuration.rb

@@ -1,21 +1,15 @@
 module RailsMail
   class Configuration
     attr_accessor :authentication_callback, :show_clear_button,
-                  :trim_emails_older_than, :trim_emails_max_count, :trim_via
+                  :trim_emails_older_than, :trim_emails_max_count,
+                  :enqueue_trim_job
 
     def initialize
       @authentication_callback = nil
       @show_clear_button = nil
       @trim_emails_older_than = nil
       @trim_emails_max_count = nil
-      @trim_via = :perform_later
-    end
-
-    def trim_via=(value)
-      unless [ :perform_now, :perform_later ].include?(value)
-        raise ArgumentError, "trim_via must be :now or :later"
-      end
-      @trim_via = value
+      @enqueue_trim_job = ->(email) { RailsMail::TrimEmailsJob.perform_later }
     end
 
     def authentication_callback=(callback)

data/lib/rails_mail/version.rb

@@ -1,3 +1,3 @@
 module RailsMail
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_mail
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Peter Philips
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -85,6 +85,7 @@ files:
 - app/views/rails_mail/emails/_empty_state.html.erb
 - app/views/rails_mail/emails/_form.html.erb
 - app/views/rails_mail/emails/_show.html.erb
+- app/views/rails_mail/emails/destroy_all.turbo_stream.erb
 - app/views/rails_mail/emails/edit.html.erb
 - app/views/rails_mail/emails/index.html.erb
 - app/views/rails_mail/emails/index.turbo_stream.erb