better_mailer_previews 0.2.21 → 0.2.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c8430ba90e00997f5bd09f2eac2a60a848e24c61ffe326a1424f298a4f4f6a6
-  data.tar.gz: fc4871bf0f7a3dde88ec8a0cc3045f8d5e0d9d04cd314e3b6dffe0c72e20e8ac
+  metadata.gz: ed2b8e431d05cc6cce1a49590111765e8d89edfb95af2ddd4f230bf875654e24
+  data.tar.gz: 79d319691b7b7c63db0c5304ecbe7f24a30aac358810d1d641f9e8b4409de456
 SHA512:
-  metadata.gz: d2272b81c5911d602def387dd4f4c71c4f53c1717cbb222b4774983d9304dd24103503144eac3c0a586b2ba2ae0cf748286f288b7a398b9bdaf83ab342c616f9
-  data.tar.gz: 228c1cd0a4a1b6d88833972dbcb3dfbb1acb66509c3a930610d0fd7b81e1c5238bd36ca2d62a3ca7576c5ed68f13b9d3624f6e52ec05a23f57d5dc12598804ba
+  metadata.gz: de462d3acc0e681fac6f96fce65ceac01ab3b2f20b3499949504d077fb6399c75a0a93b9c656c8f0770acaf4d9b60f1fc140fa68ddbfc0a35a329893379b8892
+  data.tar.gz: 7ede2f31ccae45095e56dbc70b324f83e9e92e224f1761bf6bf51127bd5aab991f41d7ded10f7fad94129c95ff3abcf1c93aca811890393c139e9d8bdc33794f

data/README.md

@@ -1,7 +1,8 @@
 # Better Mailer Previews — A lightweight Rails engine for improved email previews.
+
 Better Mailer Previews is a Ruby on Rails gem that **makes previewing all your ActionMailer email templates easier.**
 
-This gem/engine builds on top of native Rails mailer previews, with a few key enhancements like — 
+This gem/engine builds on top of native Rails mailer previews, with a few key enhancements like —
 
 - **Shows _all_ your previews _live_ on the homepage**
 - **Easily resize individual mailers, for testing responsive layouts**
@@ -15,13 +16,14 @@ Here's a little demo I've put together ↓
   </kbd>
 </p>
 
-## Why did I build this? 
+## Why did I build this?
 
-I've used native Rails mailer previews extensively for building my [ActionMailer email templates](https://railsnotesui.xyz), but they're pretty barebones and lacking. In particular, I wanted a way to bulk-preview templates (rather than checking them one by one). I also wanted to be able to easily resize the email container for testing responsive layouts. 
+I've used native Rails mailer previews extensively for building my [ActionMailer email templates](https://railsnotesui.xyz), but they're pretty barebones and lacking. In particular, I wanted a way to bulk-preview templates (rather than checking them one by one). I also wanted to be able to easily resize the email container for testing responsive layouts.
 
 This gem is my idea brought to life, and I hope you'll find it useful!
 
 ## Getting Started
+
 1. Add this line to the development group in your application's Gemfile:
 
 ```ruby
@@ -32,11 +34,12 @@ end
 ```
 
 2. And then execute:
+
 ```bash
 $ bundle
 ```
 
-3. Finally, you need to mount this engine in your `routes.rb` file — 
+3. Finally, you need to mount this engine in your `routes.rb` file —
 
 ```ruby
 # routes.rb
@@ -50,15 +53,38 @@ end
 4. Run your Rails app, and visit `localhost:3000/better_mailer_previews`.
 5. Profit ✨
 
-## How can I get previews to show up for my mailers? 
+## Sending email previews to an email address
+
+This gem let's you send your email previews to an email address, using whatever default delivery method you have configured.
 
-This engine will display all the [Actionmailer Previews](https://guides.rubyonrails.org/action_mailer_basics.html#previewing-emails) defined in the host Ruby on Rails app. These are the mailer previews you've defined in `test/mailers/previews`, for use with native [Actionmailer Previews](https://guides.rubyonrails.org/action_mailer_basics.html#previewing-emails). 
+Better Mailer Previews sends it's emails using whichever `config.action_mailer.delivery_method` is defined for the environment. For example, if you're using [Mailhog](https://github.com/mailhog/MailHog) in development to test your emails, you might have a configuration like this —
+
+```ruby
+# config/environments/development.rb
+#
+Rails.application.configure do
+  ...
+  config.action_mailer.delivery_method = :smtp
+  config.action_mailer.smtp_settings = {address: "127.0.0.1", port: 1025}
+  config.action_mailer.raise_delivery_errors = false
+end
+```
+
+In this case, Better Mailer Previews will send it's emails to Mailhog too (since it uses your existing configuration). If you want to send emails to a _live_ inbox (like your personal email), you'd need to configure a live delivery method for the current environment.
+
+## How can I get previews to show up for my mailers?
+
+This engine will display all the [Actionmailer Previews](https://guides.rubyonrails.org/action_mailer_basics.html#previewing-emails) defined in the host Ruby on Rails app. These are the mailer previews you've defined in `test/mailers/previews`, for use with native [Actionmailer Previews](https://guides.rubyonrails.org/action_mailer_basics.html#previewing-emails).
 
 For all the mailers you'd like to preview, you need to set up the corresponding `ActionMailer::Preview` class. Once you've done that, this engine will automatically pull them all in and let you preview them!
 
+## Other things to note
+
+- You need an internet connection for this to engine to work properly. This engine tries to load the TailwindCSS package via a CDN, to handle the app styling. Your browser will cache the package after you first download it though, which is handy.
+
 ## More from me
 
-If you like this gem, you'll probably like some of my other Ruby on Rails stuff — 
+If you like this gem, you'll probably like some of my other work (all Ruby on Rails stuff) —
 
 - [RailsNotes, my Ruby on Rails blog](https://railsnotes.xyz)
 - [My Ruby on Rails Newsletter](https://railsnotes.xyz/newsletter)
@@ -68,4 +94,5 @@ If you like this gem, you'll probably like some of my other Ruby on Rails stuff
 If you want updates, you can also [follow me on Twitter](https://twitter.com/hrrsnbbnt)
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/better_mailer_previews/mailers_controller.rb

@@ -25,5 +25,33 @@ module BetterMailerPreviews
 
       @url_for_mailer = "/rails/mailers/#{@mailer_name}/#{@email_type}"
     end
+
+    def send_email
+      # mailer_name: underscore_case of base mailer name | 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]
+      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_method = email_type.to_sym
+      mail = preview_class.new.public_send(preview_method).message
+      html_content = mail.body.decoded
+
+      # Send the string we just rendered, to the email from the form submission.
+      ActionMailer::Base.mail(
+        content_type: "text/html",
+        from: "better-mailer-previews@railsnotes.xyz",
+        to: email_address,
+        subject: "#{preview_class.to_s}.#{preview_method} (via BetterMailerPreviews)",
+        body: html_content,
+      ).deliver_now
+
+      flash[:notice] = "sent #{preview_class.to_s}.#{preview_method} to #{email_address} [via #{Rails.application.config.action_mailer.delivery_method}]"
+      redirect_back(fallback_location: root_path)
+    end
   end
 end

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

@@ -1,10 +1,3 @@
-<% @urls_by_mailer = {
-    "bg_mailer" => [],
-    "invoice_mailer" => ["https://en.wikipedia.org/wiki/Game_Boy_Advance", "/rails/mailers/invoice_mailer/dark", "/rails/mailers/invoice_mailer/round", "/rails/mailers/invoice_mailer/square", "/rails/mailers/invoice_mailer/stripe"],
-    "marketing_mailer" => ["/rails/mailers/marketing_mailer/basic", "/rails/mailers/marketing_mailer/dark", "/rails/mailers/marketing_mailer/round", "/rails/mailers/marketing_mailer/square"],
-    "primary_action_mailer" => ["/rails/mailers/primary_action_mailer/basic", "/rails/mailers/primary_action_mailer/dark", "/rails/mailers/primary_action_mailer/round", "/rails/mailers/primary_action_mailer/square"],
-    "special_offers_mailer" => ["/rails/mailers/special_offers_mailer/basic", "/rails/mailers/special_offers_mailer/dark", "/rails/mailers/special_offers_mailer/round", "/rails/mailers/special_offers_mailer/square"],
-  } %>
 <div class="max-w-7xl mx-auto">
   <p class="text-6xl font-medium tracking-tighter">Better Mailer Previews <span class="text-xs font-light tracking-normal">v<%= BetterMailerPreviews::VERSION %></span></p>
   <div class="mt-4 grid grid-cols-4 gap-x-4 sticky top-8 z-10 border p-2 bg-gray-50/30 backdrop-blur-md w-fit rounded-sm">

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

@@ -1,4 +1,20 @@
-<h1 class="text-5xl font-medium tracking-tighter"><%= @mailer_name.titleize %> — <%= @email_type.titleize %></h1>
+<div class="w-full flex justify-between items-end">
+  <h1 class="text-5xl font-medium tracking-tighter"><%= @mailer_name.titleize %> — <%= @email_type.titleize %></h1>
+  <div class="">
+    <%= form_with url: send_mailer_email_path(mailer_name: @mailer_name, email_type: @email_type),
+                  method: :post,
+                  local: true,
+                  class: "flex items-end gap-x-2" do |form| %>
+      <div class="flex-1">
+        <%= form.text_field :email_address, placeholder: "email address...", class: "border text-sm px-1 py-0.5 bg-gray-50 rounded-sm", required: true %>
+      </div>
+      <div>
+        <%= form.submit "Send Email", class: "text-sm border px-1 py-0.5 hover:bg-gray-200 hover:cursor-pointer rounded-sm" %>
+      </div>
+    <% end %>
+    <p class="text-xs text-gray-400 mt-1 w-64"><%= flash[:notice] %></p>
+  </div>
+</div>
 <div class="flex my-4 py-4 border gap-x-8 items-center">
   <div class="w-3/4 pr-12 pb-4 border-r-2 resize-x overflow-auto">
     <div class="shrink-0 flex items-center bg-gray-950 py-2 px-4 z-10 rounded-t-lg">
@@ -10,7 +26,7 @@
       </div>
     </div>
     <div class="bg-gray-950 px-2 rounded-b-lg pb-2">
-      <iframe src=<%= @url_for_mailer %> frameborder="0" class="w-full h-[75vh] rounded-md"></iframe>
+      <iframe src=<%= @url_for_mailer %> frameborder="0" class="w-full h-[75vh] rounded-md bg-white"></iframe>
     </div>
   </div>
   <div class="w-1/4">

data/config/routes.rb

@@ -2,4 +2,5 @@ BetterMailerPreviews::Engine.routes.draw do
   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
 end

data/lib/better_mailer_previews/version.rb

@@ -1,3 +1,3 @@
 module BetterMailerPreviews
-  VERSION = "0.2.21"
+  VERSION = "0.2.29"
 end

metadata

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