rails_mail 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0111e011c108a5b717fcb3f4074985e58faaeef49d4247587697be29facff12
-  data.tar.gz: edbcf7e6c0856e325c7d3fba6d0d03ac024eb26874a194d9554b0b39685d2ddb
+  metadata.gz: 3b68a7af3f8450340634593140b18052ec4ca26d240c7779a639c80b5b03f3c9
+  data.tar.gz: 48c3cc14e90bc5948eae038b7be1b0ce0501efe81e46974a4d1d469a56acee54
 SHA512:
-  metadata.gz: 1d4e8443a570257b4f3fd15b1a807610968968de29ad779a21e2073611b7efdd5f062e2073a250f2b3834a7af2f2b154ff92daba835fd9492747536178d49e42
-  data.tar.gz: 27d2f45c1ffb9db48e0916078c6afe565aeaa9be29c6d6bf9dddb53fad28706501313539352c1e1857b29c3ba364a5474397a02ab6dd042999e87b149974f104
+  metadata.gz: 47a9c4410d756bb79a7475f0e7f207458d40aa5163007155dfc7bfa52bf9587526119a426f1c8e57829abf9b762470fccdf0639b8815858bcda8846f210fe061
+  data.tar.gz: 911f7d8d8cefe26660bc32a07c736d47a4d9d9c82cb38f4385aff2c349a9cee3a4ec50a4528d0844750d44658d9bf2979499ae7b77614010536d394d64786324

data/README.md

@@ -15,9 +15,10 @@ RailsMail saves all outgoing emails to your database instead of actually sending
 * Clean, responsive UI for viewing email contents
 * Optional authentication support
 * 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)
+* Ability to manually clear emails in bulk or individually. The bulk delete can be turned on/off 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
+* Ability to customize the title in the top left of the page via a standard Rails view that overrides the engine's default view.
 
 ## Installation
 
@@ -79,7 +80,7 @@ To use RailsMail in your application:
 3. **Configure the initializer**
    See the [Configuration](#configuration) section for more details.
 
-4. **Visit `/rails_mail` in your browser to view all captured emails.**
+4. **Visit `/rails_mail` (or where ever you mounted the engine) in your browser to view all captured emails.**
 
 ### Configuration
 
@@ -113,6 +114,13 @@ 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)
 
+### 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`.
+
+```erb
+<h1 class="text-xl font-bold">My apps mails</h1>
+```
+
 ## Authentication
 Authentication is optional, but recommended and will depend on your application's authentication setup. This gem provides an `authentication_callback` that you can configure in the initializer which is helpful for Authlogic. If you are using Devise, you can simply wrap the mount point of the engine. 
 

data/app/controllers/rails_mail/emails_controller.rb

@@ -17,6 +17,8 @@ module RailsMail
     def show
       @emails = Email.order(created_at: :desc)
       @email = Email.find(params[:id])
+      session[:current_email_id] = @email.id
+
       if request.headers["Turbo-Frame"]
         render partial: "rails_mail/emails/show", locals: { email: @email }
       else
@@ -24,6 +26,17 @@ module RailsMail
       end
     end
 
+    def destroy
+      @email = Email.find(params[:id])
+      @current_email_id = session[:current_email_id]
+      @email.destroy
+
+      respond_to do |format|
+        format.html { redirect_to emails_path }
+        format.turbo_stream
+      end
+    end
+
     def destroy_all
       Email.destroy_all
       respond_to do |format|

data/app/frontend/rails_mail/application.js

@@ -1,12 +1,14 @@
 import { Application } from "stimulus";
 import "turbo";
 import EmailHighlightController from "email_highlight_controller";
+import RedirectController from "redirect_controller";
 import AutoSubmit from 'auto_submit'
 import Timeago from 'timeago'
 
 const application = Application.start();
 
 application.register("email-highlight", EmailHighlightController);
+application.register("redirect", RedirectController);
 application.register('auto-submit', AutoSubmit)
 application.register('timeago', Timeago)
 

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

@@ -19,14 +19,14 @@ export default class extends Controller {
 
   // Called when a link is clicked
   highlight(event) {
-    // Remove active class from all links
+    // Remove active class from all email containers
     this.linkTargets.forEach(link => {
-      link.classList.remove(this.constructor.activeClass)
+      link.closest(".group").classList.remove(this.constructor.activeClass)
     })
 
-    // Add active class to clicked link
+    // Add active class to clicked email's container
     const clickedLink = event.currentTarget
-    clickedLink.classList.add(this.constructor.activeClass)
+    clickedLink.closest(".group").classList.add(this.constructor.activeClass)
   }
 
   highlightCurrentEmail() {
@@ -35,12 +35,13 @@ export default class extends Controller {
     if (emailContent) {
       const currentEmailId = emailContent.dataset.emailId
 
-      // Highlight the link with the matching email ID
+      // Highlight the container with the matching email ID
       this.linkTargets.forEach(link => {
+        const container = link.closest(".group")
         if (link.dataset.emailId === currentEmailId) {
-          link.classList.add(this.constructor.activeClass)
+          container.classList.add(this.constructor.activeClass)
         } else {
-          link.classList.remove(this.constructor.activeClass)
+          container.classList.remove(this.constructor.activeClass)
         }
       })
     }

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

@@ -0,0 +1,9 @@
+import { Controller } from 'stimulus'
+
+export default class extends Controller {
+  static values = { url: String }
+  connect () {
+    // window.location.href = this.urlValue
+    Turbo.visit(this.urlValue)
+  }
+}

data/app/models/rails_mail/email.rb

@@ -20,6 +20,10 @@ module RailsMail
       content_type&.include?("text/html")
     end
 
+    def next_email
+      RailsMail::Email.where("id < ?", id).last || RailsMail::Email.first
+    end
+
     private
 
     def broadcast_email

data/app/views/layouts/rails_mail/_title.html.erb

@@ -0,0 +1 @@
+<h1 class="text-xl font-bold">Rails Mail</h1>

data/app/views/layouts/rails_mail/application.html.erb

@@ -17,18 +17,35 @@
   </head>
 
   <body class="bg-gray-100">
-    <div class="flex h-screen">
+    <div class="flex h-screen relative">
+      <!-- Mobile menu checkbox (hidden) -->
+      <input type="checkbox" class="hidden peer" id="sidebar-toggle">
+
+      <!-- Collapsed menu button -->
+      <label for="sidebar-toggle" class="lg:hidden fixed top-4 left-4 z-20 p-2 rounded-md text-gray-600 hover:text-gray-900 hover:bg-gray-100 cursor-pointer peer-checked:hidden">
+        <svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6" fill="none" viewBox="0 0 24 24" stroke="currentColor">
+          <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 6h16M4 12h16M4 18h16" />
+        </svg>
+      </label>
+
       <!-- Sidebar -->
-      <div class="w-80 bg-white border-r border-gray-200 flex flex-col">
+      <div class="fixed lg:static inset-y-0 left-0 transform -translate-x-full peer-checked:translate-x-0 lg:translate-x-0 transition duration-200 ease-in-out w-80 bg-white border-r border-gray-200 flex flex-col z-10">
         <div class="flex-none p-4">
-          <div class="flex items-center justify-between">
-            <div class="flex items-center">
-              <%= link_to root_path, class: "text-gray-900" do %>
-                <h1 class="text-xl font-bold">Rails Mail</h1>
-              <% end %>
-            </div>
+          <div class="flex items-center justify-between w-full">
+            <!-- Menu icon (visible only on mobile) -->
+            <label for="sidebar-toggle" class="lg:hidden p-2 rounded-md text-gray-600 hover:text-gray-900 hover:bg-gray-100 cursor-pointer">
+              <svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6" fill="none" viewBox="0 0 24 24" stroke="currentColor">
+                <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 6h16M4 12h16M4 18h16" />
+              </svg>
+            </label>
+            
+            <!-- Title (centered) -->
+            <%= link_to root_path, class: "text-gray-900" do %>
+              <%= render "layouts/rails_mail/title" %>
+            <% end %>
 
-            <% if instance_eval(&RailsMail.show_clear_button?) %>                
+            <!-- Clear All button (or empty div for spacing when button is hidden) -->
+            <% if instance_eval(&RailsMail.show_clear_button?) %>
               <%= button_to destroy_all_emails_path, 
                   class: "text-sm text-gray-600 hover:text-gray-900",
                   form: { data: { turbo_confirm: "Are you sure you want to clear all emails?" } },
@@ -40,6 +57,8 @@
                   Clear All
                 </div>
               <% end %>
+            <% else %>
+              <div class="w-[88px]"></div> <!-- Placeholder to maintain spacing when button is hidden -->
             <% end %>
           </div>
         </div>
@@ -60,8 +79,8 @@
       </div>
 
       <!-- Main content -->
-      <div class="flex-1 overflow-y-auto">
-        <div class="p-8">
+      <div class="flex-1 overflow-y-auto lg:ml-0">
+        <div class="p-8 lg:p-8 sm:p-4">
           <turbo-frame id="email_content">
             <%= yield %>
           </turbo-frame>

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

@@ -0,0 +1,21 @@
+<turbo-stream action="remove" target="<%= dom_id(@email) %>">
+</turbo-stream>
+
+<% if RailsMail::Email.count == 0 %>
+  <turbo-stream action="update" target="email_content">
+    <template>
+      <%= render(partial: "rails_mail/emails/empty_state", formats: [ :html ]) %>
+    </template>
+  </turbo-stream>
+<% elsif @email.id == @current_email_id.to_i%>
+  <turbo-stream action="update" target="email_content">
+    <template>
+      <div class="" data-controller="redirect" data-redirect-url-value="<%= email_path(@email.next_email) %>">
+        <div class="flex justify-center items-center min-h-screen">
+          <div class="animate-spin rounded-full h-12 w-12 border-b-2 border-gray-900"></div>
+        </div>
+      </div>
+    </template>
+  </turbo-stream>
+
+<% end %> 

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

@@ -2,24 +2,42 @@
   on_current_page = current_page?(RailsMail::Engine.routes.url_helpers.email_path(email))
   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-200 #{highlight_class} active:bg-gray-300 focus:bg-gray-300", 
-      data: { 
-        "turbo-frame": "email_content",
-        "turbo-action": "advance",
-        "turbo-prefetch": "false",
-        "email-highlight-target": "link",
-        "email-id": email.id,
-        action: "click->email-highlight#highlight"
-      } do %>
-  <div class="text-sm font-medium text-gray-900 truncate"><%= email.subject %></div>
-  <div class="text-xs text-gray-500">
-    <span class="truncate"><%= email.from %></span>
-    <time 
-      data-controller="timeago" 
-      data-timeago-datetime-value="<%= email.created_at.iso8601 %>" 
-      data-timeago-refresh-interval-value="1000" 
-      data-timeago-include-seconds-value="true" 
-      class="ml-2 text-gray-400"><%= time_ago_in_words(email.created_at) %> ago</time>
-  </div>
+<%= content_tag :div, id: dom_id(email), class: "group flex items-center px-3 py-2 hover:bg-gray-200 #{highlight_class} active:bg-gray-300 focus:bg-gray-300" do %>
+  <%= link_to RailsMail::Engine.routes.url_helpers.email_path(email), 
+        class: "flex-1 min-w-0 rounded-md", 
+        data: { 
+          "turbo-frame": "email_content",
+          "turbo-action": "advance",
+          "turbo-prefetch": "false",
+          "email-highlight-target": "link",
+          "email-id": email.id,
+          action: "click->email-highlight#highlight"
+        } do %>
+    <div class="min-w-0">
+      <div class="text-sm font-medium text-gray-900 truncate"><%= email.subject %></div>
+      <div class="text-xs text-gray-500">
+        <span class="truncate"><%= email.from %></span>
+        <time 
+          data-controller="timeago" 
+          data-timeago-datetime-value="<%= email.created_at.iso8601 %>" 
+          data-timeago-refresh-interval-value="1000" 
+          data-timeago-include-seconds-value="true" 
+          class="ml-2 text-gray-400"><%= time_ago_in_words(email.created_at) %> ago</time>
+      </div>
+    </div>
+  <% end %>
+
+  <%= button_to email_path(email, current_email_id: @email.id),
+        method: :delete,
+        class: "hidden group-hover:block p-1 hover:bg-gray-300 rounded",
+        form: { 
+          data: { 
+            turbo_confirm: "Are you sure you want to delete this email?",
+            turbo_frame: "_top"
+          }
+        } do %>
+    <svg xmlns="http://www.w3.org/2000/svg" class="h-4 w-4 text-gray-500 transition-colors" fill="none" viewBox="0 0 24 24" stroke="currentColor">
+      <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M19 7l-.867 12.142A2 2 0 0116.138 21H7.862a2 2 0 01-1.995-1.858L5 7m5 4v6m4-6v6m1-10V4a1 1 0 00-1-1h-4a1 1 0 00-1 1v3M4 7h16" />
+    </svg>
+  <% end %>
 <% end %> 

data/config/routes.rb

@@ -4,7 +4,7 @@ RailsMail::Engine.routes.draw do
     get "static/:name", action: :static, as: :frontend_static, constraints: { format: %w[css js] }
   end
 
-  resources :emails, only: [ :index, :show ] do
+  resources :emails, only: [ :index, :show, :destroy ] do
     collection do
       delete "emails/destroy_all", to: "emails#destroy_all", as: :destroy_all
     end

data/lib/rails_mail/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_mail
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Peter Philips
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-09 00:00:00.000000000 Z
+date: 2025-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -69,6 +69,7 @@ files:
 - app/frontend/rails_mail/modules/consumer.js
 - app/frontend/rails_mail/modules/email_highlight_controller.js
 - app/frontend/rails_mail/modules/emails_channel.js
+- app/frontend/rails_mail/modules/redirect_controller.js
 - app/frontend/rails_mail/modules/timeago.js
 - app/frontend/rails_mail/style.css
 - app/frontend/rails_mail/vendor/action_cable.js
@@ -80,11 +81,13 @@ files:
 - app/helpers/rails_mail/turbo_helper.rb
 - app/jobs/rails_mail/trim_emails_job.rb
 - app/models/rails_mail/email.rb
+- app/views/layouts/rails_mail/_title.html.erb
 - app/views/layouts/rails_mail/application.html.erb
 - app/views/rails_mail/emails/_email.html.erb
 - 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.turbo_stream.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