better_mailer_previews 0.2.30 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b69a7e6cf0bfd892b006a6cb3fbf95ac2fe67beb51882baca76310471e1f0e8
-  data.tar.gz: 96e7341144c8b995f6036aff7daaf3a56b7a8864714b710b6bc7f111ff6fd65c
+  metadata.gz: 2023202e8ffad5fa3e2424ed4378230e037dff217325143ff3dc97e544a07533
+  data.tar.gz: 5c02e8e2d4a3a25cec4a882b0ed198ed58543771fbfc7e6617b9786796ba1292
 SHA512:
-  metadata.gz: ac1acb09231a4bccc01de215200a2067b7a0c61be1b4408fac15458b7c1b5a0082bdf08821eeaff2067c5f45c6873fd296cf83b0235ce925140b89a55ada47a1
-  data.tar.gz: 95d4a6a587d7b63f660d8a2a6c62267c126f6530445437d24d1d7b38654aaaf3dbc8eae242fb446370ddca18f998374868be5d1ee2f9695b07061191d19130bb
+  metadata.gz: a447a4c6f88f5e855531440de083b1dbe58d69da3b4f9eb8706c8bcc53539aca88dfd4b595d5307d02b9b656e686d93d2d741331be8368b2af9eec5d8135587c
+  data.tar.gz: a1ba2983470482ff3f75584cabd771a2c7850832275ea9faeb1893d96a73e56342f86ae9db11868f7c9e5a0d6a245bc16003cc73d6d0ca0f4f315f5a994ef6c9

data/README.md

@@ -6,6 +6,7 @@ This gem/engine builds on top of native Rails mailer previews, with a few key en
 
 - **Shows _all_ your previews _live_ on the homepage**
 - **Easily resize individual mailers, for testing responsive layouts**
+- **Forward your previews to an email address (uses the default ActionMailer delivery method for your app).**
 - **Fully compatible with, and can live alongside, native [Rails ActionMailer Previews](https://guides.rubyonrails.org/action_mailer_basics.html#previewing-emails)**
 
 Here's a little demo I've put together ↓

data/app/controllers/better_mailer_previews/mailers_controller.rb

@@ -20,23 +20,25 @@ module BetterMailerPreviews
     end
 
     def show
-      @mailer_name = params[:mailer_name]
+      @mailer_path = params[:mailer_path]
       @email_type = params[:email_type]
 
-      @url_for_mailer = "/rails/mailers/#{@mailer_name}/#{@email_type}"
+      @url_for_mailer = "/rails/mailers/#{@mailer_path}/#{@email_type}"
     end
 
     def send_email
-      # mailer_name: underscore_case of base mailer name | invoice_mailer
+      # mailer_path: underscore_case of base mailer path | test/invoice_mailer
       # email_type: string mailer method to call on class | "round"
       # email_address: string email address to send to | "test@t.com"
-      mailer_name = params[:mailer_name]
+      mailer_path = params[:mailer_path]
       email_type = params[:email_type]
       email_address = params[:email_address]
 
       # Instantiate the preview class (ie: InvoiceMailerPreview),
       # then render it's preview html into a string.
-      preview_class = mailer_name.concat("_preview").camelize.constantize
+      preview_class_string = mailer_path.split("/").map(&:camelize).join("::").concat("Preview")
+      preview_class = preview_class_string.constantize
+
       preview_method = email_type.to_sym
       mail = preview_class.new.public_send(preview_method).message
       html_content = mail.body.decoded
@@ -46,7 +48,7 @@ module BetterMailerPreviews
         content_type: "text/html",
         from: "better-mailer-previews@railsnotes.xyz",
         to: email_address,
-        subject: "#{preview_class.to_s}.#{preview_method} (via BetterMailerPreviews)",
+        subject: "#{preview_class_string}.#{preview_method} (via BetterMailerPreviews)",
         body: html_content,
       ).deliver_now
 

data/app/helpers/better_mailer_previews/application_helper.rb

@@ -1,4 +1,28 @@
 module BetterMailerPreviews
   module ApplicationHelper
+
+    # For generating mailer preview link names on mailers/index,
+    # including namespaced methods.
+    #
+    # input: "/rails/mailers/invoice_mailer/saas"
+    # output: "Preview InvoiceMailer.SaaS →"
+    #
+    def preview_text_for_url(url)
+      camelized = url.split("/")[3...].map { |element| element.camelize }
+      last_element = camelized.pop
+      pretty_mailer_preview_name = camelized.join("/") + "." + last_element
+
+      return "Preview #{pretty_mailer_preview_name} →"
+    end
+
+    # For generating mailer preview link paths on mailers/index
+    #
+    # input: "/rails/mailers/invoice_mailer/saas"
+    # output: /better_mailer_previews/invoice_mailer/basic
+    #
+    def preview_path_for_url(url)
+      mounted_engine_path = BetterMailerPreviews::Engine.routes.find_script_name({})
+      url.split("/")[3..].join("/").prepend("#{mounted_engine_path}/")
+    end
   end
 end

data/app/views/better_mailer_previews/mailers/index.html.erb

@@ -13,7 +13,7 @@
         <% urls.each do |url| %>
           <div class="flex flex-col space-y-4 wrap">
             <iframe src=<%= url %> frameborder="0" class="frame border border-gray-300" loading="lazy"></iframe>
-            <%= link_to "Preview #{url.split('/')[-2...].map { |segment| segment.split('_').map(&:capitalize).join }.join('.')} →", url.split('/')[-2...].join('/').prepend("/better_mailer_previews/"), class: "!-mt-[400px] hover:underline" %>
+            <%= link_to preview_text_for_url(url), preview_path_for_url(url), class: "!-mt-[400px] hover:underline" %>
           </div>
         <% end %>
       </div>

data/app/views/better_mailer_previews/mailers/show.html.erb

@@ -1,7 +1,7 @@
 <div class="w-full flex justify-between items-end">
-  <h1 class="text-5xl font-medium tracking-tighter"><%= @mailer_name.titleize %> — <%= @email_type.titleize %></h1>
+  <h1 class="text-5xl font-medium tracking-tighter"><%= @mailer_path.titleize %> — <%= @email_type.titleize %></h1>
   <div class="">
-    <%= form_with url: send_mailer_email_path(mailer_name: @mailer_name, email_type: @email_type),
+    <%= form_with url: send_mailer_email_path(mailer_path: @mailer_path, email_type: @email_type),
                   method: :post,
                   local: true,
                   class: "flex items-end gap-x-2" do |form| %>
@@ -22,7 +22,7 @@
       <div class="hidden sm:block shrink-0 mr-2 h-4 w-4 bg-gray-600 rounded-full"></div>
       <div class="hidden sm:block shrink-0 mr-2 h-4 w-4 bg-gray-600 rounded-full"></div>
       <div class="flex-grow flex items-center justify-center sm:ml-6 sm:mr-24 py-2 px-4 bg-gray-600 rounded-full leading-5 text-sm text-gray-200 text-center truncate">
-        <div class="truncate"><span class="font-medium text-gray-100">Mailer Preview</span> — <%= "#{@mailer_name}/#{@email_type}" %></div>
+        <div class="truncate"><span class="font-medium text-gray-100">Mailer Preview</span> — <%= "#{@mailer_path}/#{@email_type}" %></div>
       </div>
     </div>
     <div class="bg-gray-950 px-2 rounded-b-lg pb-2">

data/config/routes.rb

@@ -1,6 +1,7 @@
 BetterMailerPreviews::Engine.routes.draw do
-  root to: 'mailers#index'
+  root to: "mailers#index"
 
-  get '/:mailer_name/:email_type', to: 'mailers#show', as: :mailer_preview
-  post '/:mailer_name/:email_type/send', to: 'mailers#send_email', as: :send_mailer_email
+  # Wildcard routes to handle namespaced mailers
+  get "/*mailer_path/:email_type", to: "mailers#show", as: :mailer_preview
+  post "/*mailer_path/:email_type/send", to: "mailers#send_email", as: :send_mailer_email
 end

data/lib/better_mailer_previews/version.rb

@@ -1,3 +1,3 @@
 module BetterMailerPreviews
-  VERSION = "0.2.30"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_mailer_previews
 version: !ruby/object:Gem::Version
-  version: 0.2.30
+  version: 1.0.1
 platform: ruby
 authors:
 - Harrison Broadbent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-04 00:00:00.000000000 Z
+date: 2023-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails