better_mailer_previews 0.2.20

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc50335b20fd694cd623ade83f7b0217324c3713b4dba534817dfc717c43b3a8
+  data.tar.gz: a9d4bf8682df2cf1dd4db468b52a49d89520a04e1d4de5f02cf71883a9bb18d5
+SHA512:
+  metadata.gz: b133c05951985fe354f83f457d8ffcea0a10fe1534c0e844c1f3c6c116c5357cc36cd7df03c65301aa6ff912db9f5bafc0a773e8af50ce6226fc39017801ba53
+  data.tar.gz: cbbc6793b5b47de89f1ba54c990884c367d17685fd3070cc36b9bf8e36a594744c89c4d414060d4d88b339bef8472e8fe35aafb216922644fd94a450845bfdb2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Harrison Broadbent
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# 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 — 
+
+- **Shows _all_ your previews _live_ on the homepage**
+- **Easily resize individual mailers, for testing responsive layouts**
+- **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 ↓
+
+<p align="center">
+  <kbd>
+    <img width=640 src="https://github.com/harrison-broadbent/better_mailer_previews/assets/5293153/07f8ee5c-2363-4d73-a3d6-00376a2d2c6e" />
+  </kbd>
+</p>
+
+## 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. 
+
+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
+group :development do
+  ...
+  gem "better_mailer_previews"
+end
+```
+
+2. And then execute:
+```bash
+$ bundle
+```
+
+3. Finally, you need to mount this engine in your `routes.rb` file — 
+
+```ruby
+# routes.rb
+
+Rails.application.routes.draw do
+  mount BetterMailerPreviews::Engine, at: "/better_mailer_previews" if Rails.env.development?
+  ...
+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? 
+
+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!
+
+## More from me
+
+If you like this gem, you'll probably like some of my other Ruby on Rails stuff — 
+
+- [RailsNotes, my Ruby on Rails blog](https://railsnotes.xyz)
+- [My Ruby on Rails Newsletter](https://railsnotes.xyz/newsletter)
+- [RAILSG, a command builder for Rails generator commands](https://railsg.xyz)
+- [RailsNotes UI, a library of ActionMailer email templates and components](https://railsnotesui.xyz)
+
+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/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/better_mailer_previews_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/better_mailer_previews .css

data/app/assets/stylesheets/better_mailer_previews/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/better_mailer_previews/application_controller.rb

@@ -0,0 +1,4 @@
+module BetterMailerPreviews
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/better_mailer_previews/mailers_controller.rb

@@ -0,0 +1,29 @@
+module BetterMailerPreviews
+  class MailersController < ActionController::Base
+    layout "better_mailer_previews/application"
+
+    def index
+      mailer_previews = ActionMailer::Preview.all
+      preview_emails = mailer_previews.map do |preview|
+        { preview: preview, emails: preview.emails }
+      end
+
+      @urls_by_mailer = {}
+      preview_emails.each do |entry|
+        mailer_name = entry[:preview].name.underscore.gsub("_preview", "")
+        urls = entry[:emails].map do |email|
+          email_name = email.underscore
+          "/rails/mailers/#{mailer_name}/#{email_name}"
+        end
+        @urls_by_mailer[mailer_name] = urls
+      end
+    end
+
+    def show
+      @mailer_name = params[:mailer_name]
+      @email_type = params[:email_type]
+
+      @url_for_mailer = "/rails/mailers/#{@mailer_name}/#{@email_type}"
+    end
+  end
+end

data/app/helpers/better_mailer_previews/application_helper.rb

@@ -0,0 +1,4 @@
+module BetterMailerPreviews
+  module ApplicationHelper
+  end
+end

data/app/jobs/better_mailer_previews/application_job.rb

@@ -0,0 +1,4 @@
+module BetterMailerPreviews
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/better_mailer_previews/application_mailer.rb

@@ -0,0 +1,6 @@
+module BetterMailerPreviews
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/better_mailer_previews/application_record.rb

@@ -0,0 +1,5 @@
+module BetterMailerPreviews
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

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

@@ -0,0 +1,4 @@
+<div class="mt-12 text-sm text-gray-400">
+  <p><a class="text-gray-700 hover:underline" href="https://github.com/harrison-broadbent/better_mailer_previews">better mailer previews</a> is a gem by me, <a class="text-gray-700 hover:underline" href="https://twitter.com/hrrsnbbnt">harrison broadbent.</a></p>
+  <p>you might like my other stuff too; a library of <a class="text-gray-700 hover:underline" href="https://railsnotesui.xyz">email templates for actionmailer</a>, or my <a class="text-gray-700 hover:underline" href="https://railsnotes.xyz">ruby on rails blog.</a></p>
+</div>

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

@@ -0,0 +1,30 @@
+<% @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">
+    <% @urls_by_mailer.each do |mailer_name, urls| %>
+      <%= link_to "▶ #{mailer_name.titleize}", "##{mailer_name}", class: "text-sm hover:underline" unless urls.empty? %>
+    <% end %>
+  </div>
+  <% @urls_by_mailer.each do |mailer_name, urls| %>
+    <% next if urls.empty? %>
+    <div id=<%= mailer_name %> class="flex my-24">
+      <p class="text-xl font-light w-64"><%= mailer_name.titleize %></p>
+      <div class="border p-6 grid grid-cols-3 gap-x-8 gap-y-16">
+        <% 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" %>
+          </div>
+        <% end %>
+      </div>
+    </div>
+  <% end %>
+  <%= render "footer" %>
+</div>

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

@@ -0,0 +1,28 @@
+<h1 class="text-5xl font-medium tracking-tighter"><%= @mailer_name.titleize %> — <%= @email_type.titleize %></h1>
+<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">
+      <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="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>
+    </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>
+    </div>
+  </div>
+  <div class="w-1/4">
+    <div class="relative mx-auto border-gray-800 dark:border-gray-800 bg-gray-800 border-[14px] rounded-[2.5rem] h-[640px] w-[320px] shadow-xl">
+      <div class="w-[148px] h-[18px] bg-gray-800 top-0 rounded-b-[1rem] left-1/2 -translate-x-1/2 absolute"></div>
+      <div class="h-[46px] w-[3px] bg-gray-800 absolute -start-[17px] top-[124px] rounded-s-lg"></div>
+      <div class="h-[46px] w-[3px] bg-gray-800 absolute -start-[17px] top-[178px] rounded-s-lg"></div>
+      <div class="h-[64px] w-[3px] bg-gray-800 absolute -end-[17px] top-[142px] rounded-e-lg"></div>
+      <div class="rounded-[2rem] overflow-hidden w-[292px] h-[612px] bg-white dark:bg-gray-800">
+        <iframe src=<%= @url_for_mailer %> frameborder="0" class="w-[292px] h-[612px]"></iframe>
+      </div>
+    </div>
+  </div>
+</div>
+<%= render "footer" %>

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

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Better mailer previews</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <%= stylesheet_link_tag "better_mailer_previews/application", media: "all" %>
+    <script src="https://cdn.tailwindcss.com"></script>
+    <style>
+      .wrap { width: 300px; height: 450px; padding: 0; overflow: hidden; }
+      .frame { width: 600px; height: 900px; border: 1px solid black; }
+      .frame { transform: scale(0.5); transform-origin: 0 0; }
+      ::-webkit-resizer {
+          background-image: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 20 20' fill='currentColor' class='w-5 h-5'><path fill-rule='evenodd' d='M17 10a.75.75 0 01-.75.75H5.612l4.158 3.96a.75.75 0 11-1.04 1.08l-5.5-5.25a.75.75 0 010-1.08l5.5-5.25a.75.75 0 111.04 1.08L5.612 9.25H16.25A.75.75 0 0117 10z' clip-rule='evenodd' /></svg>");
+      }
+    </style>
+  </head>
+  <body class="w-full h-full p-12 bg-gray-50">
+    <%= yield %>
+  </body>
+</html>

data/config/initializers/assets.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.precompile += %w(better_mailer_previews/application.css better_mailer_previews/application.js)

data/config/routes.rb

@@ -0,0 +1,5 @@
+BetterMailerPreviews::Engine.routes.draw do
+  root to: 'mailers#index'
+
+  get '/:mailer_name/:email_type', to: 'mailers#show', as: :mailer_preview
+end

data/lib/better_mailer_previews/engine.rb

@@ -0,0 +1,5 @@
+module BetterMailerPreviews
+  class Engine < ::Rails::Engine
+    isolate_namespace BetterMailerPreviews
+  end
+end

data/lib/better_mailer_previews/version.rb

@@ -0,0 +1,3 @@
+module BetterMailerPreviews
+  VERSION = "0.2.20"
+end

data/lib/better_mailer_previews.rb

@@ -0,0 +1,6 @@
+require "better_mailer_previews/version"
+require "better_mailer_previews/engine"
+
+module BetterMailerPreviews
+  # Your code goes here...
+end

data/lib/tasks/better_mailer_previews_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :better_mailer_previews do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: better_mailer_previews
+version: !ruby/object:Gem::Version
+  version: 0.2.20
+platform: ruby
+authors:
+- Harrison Broadbent
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+description: Better Mailer Previews is a Ruby on Rails gem that makes it easier to
+  preview ActionMailer email templates.
+email:
+- harrison@railsnotes.xyz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/better_mailer_previews_manifest.js
+- app/assets/stylesheets/better_mailer_previews/application.css
+- app/controllers/better_mailer_previews/application_controller.rb
+- app/controllers/better_mailer_previews/mailers_controller.rb
+- app/helpers/better_mailer_previews/application_helper.rb
+- app/jobs/better_mailer_previews/application_job.rb
+- app/mailers/better_mailer_previews/application_mailer.rb
+- app/models/better_mailer_previews/application_record.rb
+- app/views/better_mailer_previews/mailers/_footer.html.erb
+- app/views/better_mailer_previews/mailers/index.html.erb
+- app/views/better_mailer_previews/mailers/show.html.erb
+- app/views/layouts/better_mailer_previews/application.html.erb
+- config/initializers/assets.rb
+- config/routes.rb
+- lib/better_mailer_previews.rb
+- lib/better_mailer_previews/engine.rb
+- lib/better_mailer_previews/version.rb
+- lib/tasks/better_mailer_previews_tasks.rake
+homepage: https://github.com/harrison-broadbent/better_mailer_previews
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/harrison-broadbent/better_mailer_previews
+  source_code_uri: https://github.com/harrison-broadbent/better_mailer_previews
+  changelog_uri: https://github.com/harrison-broadbent/better_mailer_previews
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Better Mailer Previews is a Ruby on Rails gem that makes it easier to preview
+  ActionMailer email templates.
+test_files: []