maily 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a71e9271060d187f12a6a5d719548bd79ec2d9518a089374c84b671924a9820
-  data.tar.gz: faf2268d8dccb44e8c4b09d883d16928c786b2774fce5b52eb998edd1eebff78
+  metadata.gz: f235ba37075df3a0f065488b094fe1578e57058dd850313292bfdc41e7af75d8
+  data.tar.gz: 6091d90733c60d465d170f0b8243b1cad0f74d7dc34d0091dd3a9f2dafd89653
 SHA512:
-  metadata.gz: 3e7f4a8e4004a3e39f77bac0b812d7340952eccdda134525a47e3c405bca8a136092e3c6079381f966bad0d3cb17fd90d8fca77d5ded242bf593cc47ad9b25ba
-  data.tar.gz: bd248a071b75a4791408bf7f43837f9bbcd0160fbea84c61d63399836dcb371caf4f6e941ded8481a6a3dd767be7ef8a66df4cf01c9d2df549504b2dd1cd67a3
+  metadata.gz: 96185b6150391a907bff8a17535212ff383b0f400ddd28242802600eeec1d394418426097935bc7200d32a9b0dfaec6ab0744ea0d1da752a279772dd67236fd8
+  data.tar.gz: 14552df9ee81d40ea11e3997aa8bdbc9f4678699cb279116dc0eb74ad9ffdf4d730586562af6dfdf8473d8f33bf26e729819193f21dd8b265f723700c1f4f5bf

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.1.0]
+
+- Use `ActionMailer::InlinePreviewInterceptor` to facilitate integration with other gems like premailer (#55)
+- Move CI from Travis to GitHub Actions
+
+## [2.0.2]
+
+- UI: Hide delivery form if `allow_delivery` is false (#54)
+
+## [2.0.1]
+
+- UI: Don't show empty mailer classes in sidebar (#51)
+
+## [2.0.0]
+
+- Email versions (#49)
+- Drop official support for EOL Rails versions: 5.1, 5.0 and 4.2
+- Drop official support for EOL Rubies: 2.4
+
 ## [1.0.0]
 
 - Avoid the dependency on Sprockets (#48)
@@ -143,6 +162,10 @@ All notable changes to this project will be documented in this file.
 
 - First real usable release :tada:
 
+[2.1.0]: https://github.com/markets/maily/compare/v2.0.2...v2.1.0
+[2.0.2]: https://github.com/markets/maily/compare/v2.0.1...v2.0.2
+[2.0.1]: https://github.com/markets/maily/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/markets/maily/compare/v1.0.0...v2.0.0
 [1.0.0]: https://github.com/markets/maily/compare/v0.12.3...v1.0.0
 [0.12.3]: https://github.com/markets/maily/compare/v0.12.2...v0.12.3
 [0.12.2]: https://github.com/markets/maily/compare/v0.12.1...v0.12.2

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013-2020 Marc Anguera Insa
+Copyright 2013-2021 Marc Anguera Insa
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -4,7 +4,7 @@
   </p>
   <p align="center">
     <a href="https://rubygems.org/gems/maily"><img src="https://img.shields.io/gem/v/maily.svg?style=flat-square"></a>
-    <a href="https://travis-ci.org/markets/maily"><img src="https://travis-ci.org/markets/maily.svg?branch=master"></a>
+    <a href="https://github.com/markets/maily/actions"><img src="https://github.com/markets/maily/workflows/CI/badge.svg"></a>
     <a href="https://codeclimate.com/github/markets/maily/maintainability"><img src="https://api.codeclimate.com/v1/badges/fff01b2137fd73070b14/maintainability"></a>
     <a href="https://github.com/markets/maily/blob/master/MIT-LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/markets/maily.svg?style=flat-square"></a>
   </p>
@@ -20,10 +20,10 @@ Maily automatically picks up all your emails and make them accessible from a kin
 * Visual preview in the browser (attachments as well)
 * Template edition (only in development)
 * Email delivery
-* Features configurables per environment
+* Easy way (aka `Hooks`) to define and customize data for emails
+* Email versions
 * Flexible authorization system
 * Minimalistic and clean interface
-* Easy way (aka `hooks`) to define and customize data for emails
 * Generator to handle a comfortable installation
 
 ![](support/images/screenshot.png)
@@ -50,27 +50,20 @@ This generator runs some tasks for you:
 
 ## Initialization and configuration
 
-You should configure Maily via an initializer. You can set different values per environment:
-
-```ruby
-Maily.enabled = ENV['MAILY_ENABLED']
-
-Maily.enabled = Rails.env.production? ? false : true
-```
-
-Initializer sample (full options list):
+You should use the `setup` method to configure and customize `Maily` settings:
 
  ```ruby
 # config/initializers/maily.rb
+
 Maily.setup do |config|
   # On/off engine
-  # config.enabled = Rails.env.production? ? false : true
+  # config.enabled = !Rails.env.production?
 
   # Allow templates edition
-  # config.allow_edition = Rails.env.production? ? false : true
+  # config.allow_edition = !Rails.env.production?
 
   # Allow deliveries
-  # config.allow_delivery = Rails.env.production? ? false : true
+  # config.allow_delivery = !Rails.env.production?
 
   # Your application available_locales (or I18n.available_locales) by default
   # config.available_locales = [:en, :es, :pt, :fr]
@@ -89,6 +82,13 @@ Maily.setup do |config|
 end
 ```
 
+You can use the following format too:
+
+```ruby
+Maily.enabled = ENV['MAILY_ENABLED']
+Maily.allow_edition = false
+```
+
 ### Templates edition (`allow_edition` option)
 
 This feature was designed for the `development` environment. Since it's based on just a file edition, and while running in `production` mode, code is not reloaded between requests, Rails doesn't take into account your changes (without restarting the server). Actually, allowing arbitrary Ruby code evaluation is potentially dangerous, and that's not a good idea in `production`.
@@ -101,6 +101,7 @@ Most of emails need to populate some data to consume it and do interesting thing
 
 ```ruby
 # lib/maily_hooks.rb
+
 user = User.new(email: 'user@example.com')
 lazy_user = -> { User.with_comments.first } # callable object, lazy evaluation
 comment = Struct.new(:body).new('Lorem ipsum') # stub way
@@ -125,6 +126,20 @@ Maily.hooks_for('YourMailerClass') do |mailer|
 end
 ```
 
+### Email versions
+
+You can add versions for special emails. This is useful in some cases where template content depends on the parameters you provide, for instance, a welcome message for trial accounts and gold accounts.
+
+```ruby
+free_trial_account = -> { Account.free_trial.first }
+gold_account = -> { Account.gold.first }
+
+Maily.hooks_for('Notifier') do |mailer|
+  mailer.register_hook(:welcome, free_trial_account, version: 'Free trial account')
+  mailer.register_hook(:welcome, gold_account, version: 'Gold account')
+end
+```
+
 ### Email description
 
 You can add a description to any email and it will be displayed along with its preview. This is useful in some cases like: someone from another team, for example, a marketing specialist, visiting Maily to review some texts and images; they can easily understand when this email is sent by the system.
@@ -209,7 +224,7 @@ Maily.http_authorization = { username: 'admin', password: 'secret' }
 
 Rails 4.1 introduced a built-in mechanism to preview the application emails. It is in fact, a port of [basecamp/mail_view](https://github.com/basecamp/mail_view) gem to the core.
 
-Alternatively, there are some other plugins to get a similar functionality, but with different approaches and options. For example, [ryanb/letter_opener](https://github.com/ryanb/letter_opener), [sj26/mailcatcher](https://github.com/sj26/mailcatcher) or [glebm/rails_email_preview](https://github.com/glebm/rails_email_preview).
+Alternatively, there are more gems out there to get a similar functionality, but with different approaches and features. Like for example: [ryanb/letter_opener](https://github.com/ryanb/letter_opener), [sj26/mailcatcher](https://github.com/sj26/mailcatcher) or [glebm/rails_email_preview](https://github.com/glebm/rails_email_preview).
 
 ## Development
 
@@ -217,7 +232,30 @@ Any kind of feedback, bug report, idea or enhancement are really appreciated :ta
 
 To contribute, just fork the repo, hack on it and send a pull request. Don't forget to add tests for behaviour changes and run the test suite:
 
-    > bundle exec appraisal rake
+```
+> bundle exec rspec
+```
+
+Run the test suite against all supported versions:
+
+```
+> bundle exec appraisal install
+> bundle exec appraisal rspec
+```
+
+Run specs against specific version:
+
+```
+> bundle exec appraisal rails-6.0 rspec
+```
+
+### Demo
+
+Start a sample Rails app ([source code](spec/dummy)) with `Maily` integrated:
+
+```
+> bundle exec rake web # PORT=4000 (default: 3000)
+```
 
 ## License
 

data/app/controllers/maily/application_controller.rb

@@ -4,6 +4,17 @@ module Maily
 
     layout 'maily/application'
 
+    def maily_params
+      _params = {}
+
+      [:mailer, :email, :version, :part, :locale, :version].each do |key|
+        _params[key] = params[key] if params[key].present?
+      end
+
+      _params
+    end
+    helper_method :maily_params
+
     private
 
     def maily_enabled?

data/app/controllers/maily/emails_controller.rb

@@ -25,7 +25,6 @@ module Maily
 
       content = content.raw_source
       content = view_context.simple_format(content) if @email.sub_type == 'plain' || params[:part] == 'text'
-      content = prepare_inline_attachments(@email, content)
 
       render html: content.html_safe, layout: false
     end
@@ -43,7 +42,7 @@ module Maily
     def update
       @maily_email.update_template(params[:body], params[:part])
 
-      redirect_to maily_email_path(mailer: params[:mailer], email: params[:email], part: params[:part]), notice: 'Template updated!'
+      redirect_to maily_email_path(maily_params), notice: 'Template updated!'
     end
 
     def deliver
@@ -51,7 +50,7 @@ module Maily
 
       @email.deliver
 
-      redirect_to maily_email_path(mailer: params[:mailer], email: params[:email]), notice: "Email sent to <b>#{params[:to]}</b>!"
+      redirect_to maily_email_path(maily_params), notice: "Email sent to <b>#{params[:to]}</b>!"
     end
 
     private
@@ -66,7 +65,7 @@ module Maily
 
     def load_mailer_and_email
       mailer = Maily::Mailer.find(params[:mailer])
-      @maily_email = mailer.find_email(params[:email])
+      @maily_email = mailer.find_email(params[:email], params[:version])
 
       if @maily_email
         @email = @maily_email.call
@@ -80,19 +79,5 @@ module Maily
         yield
       end
     end
-
-    def prepare_inline_attachments(email, content)
-      content.gsub(/src=(?:"cid:[^"]+"|'cid:[^']+')/i) do |match|
-        if part = find_part(email, match[9..-2])
-          %[src="data:#{part.mime_type};base64,#{Base64.encode64(part.body.raw_source)}"]
-        else
-          match
-        end
-      end
-    end
-
-    def find_part(email, cid)
-      email.all_parts.find { |p| p.attachment? && p.cid == cid }
-    end
   end
 end

data/app/helpers/maily/application_helper.rb

@@ -14,18 +14,22 @@ module Maily
       'selected_mail' if mailer.name == params[:mailer] && email.name == params[:email]
     end
 
+    def version_list_class(email)
+      'selected_mail' if email.name == params[:email] && email.version == params[:version]
+    end
+
     def logo
-      image_tag(file_to_base64('maily/logo.png', 'image/png'))
+      image_tag(file_to_base64('logo.png', 'image/png'))
     end
 
     def icon(name)
-      image_tag(file_to_base64("maily/icons/#{name}.svg", 'image/svg+xml'), class: :icon)
+      image_tag(file_to_base64("icons/#{name}.svg", 'image/svg+xml'), class: :icon)
     end
 
     private
 
     def file_to_base64(path, mime_type)
-      file = Maily::Engine.root.join('app/assets/images').join(path)
+      file = Maily::Engine.root.join('app/assets/images/maily').join(path)
       base64_contents = Base64.strict_encode64(file.read)
 
       "data:#{mime_type};base64,#{base64_contents}"

data/app/helpers/maily/emails_helper.rb

@@ -7,14 +7,21 @@ module Maily
     def email_description(email)
       return unless email.description
 
-      content_tag(:div, class: 'mail_description') do
-        concat content_tag(:strong, 'Description ')
+      tag.div(class: 'mail_description') do
+        concat tag.strong('Description ')
         concat email.description
       end
     end
 
     def part_class(part)
-      'format_selected' if (part == params[:part]) || (part == 'html' && !params[:part])
+      'format_selected' if part == params[:part] || (part == 'html' && !params[:part])
+    end
+
+    def uniq_emails(email_list)
+      email_list.inject([]) do |memo, email|
+        memo << email unless memo.map(&:name).include?(email.name)
+        memo
+      end
     end
   end
 end

data/app/views/maily/emails/edit.html.erb

@@ -1,9 +1,9 @@
 <%= email_description(@maily_email) %>
 
-<%= form_tag(update_maily_email_path(mailer: params[:mailer], email: params[:email], part: params[:part]), method: :put) do %>
+<%= form_tag(update_maily_email_path(maily_params), method: :put) do %>
   <ul class="action_bar">
     <li>
-      <%= link_to 'Show', maily_email_path(mailer: params[:mailer], email: params[:email]) %>
+      <%= link_to 'Show', maily_email_path(maily_params) %>
     </li>
 
     <li class="splitter">|</li>

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

@@ -2,7 +2,7 @@
 
 <ul class="action_bar">
   <li>
-    <%= link_to 'Edit', edit_maily_email_path(mailer: params[:mailer], email: params[:email], part: params[:part]) %>
+    <%= link_to 'Edit', edit_maily_email_path(maily_params) %>
   </li>
 
   <li class="languages">
@@ -18,19 +18,32 @@
     <% end %>
   </li>
 
-  <li class="splitter">|</li>
+  <% if Maily.allowed_action?(:deliver) %>
+    <li class="splitter">|</li>
 
-  <li>
-    <%= form_tag(deliver_maily_email_path(mailer: params[:mailer], email: params[:email], locale: params[:locale]), method: :post, class: 'mail_deliver') do %>
-      <ul>
-        <li>Send to</li>
-        <li><%= email_field_tag :to, nil, placeholder: "Enter email", required: true %></li>
-        <li><%= submit_tag 'Send', class: 'button' %></li>
-      </ul>
-    <% end %>
-  </li>
+    <li>
+      <%= form_tag(deliver_maily_email_path(maily_params), method: :post, class: 'mail_deliver') do %>
+        <ul>
+          <li>Send to</li>
+          <li><%= email_field_tag :to, nil, placeholder: "Enter email", required: true %></li>
+          <li><%= submit_tag 'Send', class: 'button' %></li>
+        </ul>
+      <% end %>
+    </li>
+  <% end %>
 </ul>
 
+<% if @maily_email.has_versions? %>
+  <fieldset class="version_list_wrapper">
+    <legend>Versions</legend>
+    <ul class="version_list">
+      <% @maily_email.versions.each do |_version_key, version_email| %>
+        <li><%= link_to version_email.version.humanize, maily_email_path(maily_params.merge(version: version_email.version)), class: version_list_class(version_email) %></li>
+      <% end %>
+    </ul>
+  </fieldset>
+<% end %>
+
 <div class="mail_preview">
   <ul class="mail_details">
     <% if @email.subject %><li><b>Subject</b> <%= @email.subject %></li><% end %>
@@ -49,7 +62,7 @@
   <% end %>
 
   <% if @email.html_part || @email.text_part || @email.body.present? %>
-    <iframe class="mail_iframe" onload='resizeIframe(this)' src="<%= raw_maily_email_path(mailer: params[:mailer], email: params[:email], locale: params[:locale], part: params[:part]) %>" frameborder="1" width="100%"></iframe>
+    <iframe class="mail_iframe" onload='resizeIframe(this)' src="<%= raw_maily_email_path(maily_params) %>" frameborder="1" width="100%"></iframe>
   <% end %>
 
   <% if @email.has_attachments? %>
@@ -60,7 +73,7 @@
           <% @email.attachments.each do |attachment| %>
             <li>
               <%= icon 'paperclip' %>
-              <%= link_to attachment.filename, attachment_maily_email_path(mailer: params[:mailer], email: params[:email], attachment: attachment.filename) %>
+              <%= link_to attachment.filename, attachment_maily_email_path(maily_params.merge(attachment: attachment.filename)) %>
             </li>
           <% end %>
         </ul>

data/app/views/maily/shared/_sidebar.html.erb

@@ -1,12 +1,21 @@
 <aside class="sidebar">
   <% @mailers.each do |mailer| %>
+    <% next if mailer.total_emails.zero? %>
+
     <section class="nav_list">
       <h3 class="nav_title"><%= "#{mailer.name.humanize} (#{mailer.total_emails})" %></h3>
       <ul>
-        <% mailer.emails_list.each do |email| %>
-          <li><%= link_to email.name.humanize, maily_email_path(mailer: mailer.name, email: email.name), class: sidebar_class(mailer, email) %></li>
+        <% uniq_emails(mailer.emails_list).each do |email| %>
+          <li>
+            <%= link_to maily_email_path(mailer: mailer.name, email: email.name, version: email.version), class: sidebar_class(mailer, email) do %>
+              <%= email.name.humanize %>
+              <% if email.has_versions? %>
+                <%= "(#{email.versions.count} #{'version'.pluralize(email.versions.count)})" %>
+              <% end %>
+            <% end %>
+          </li>
         <% end %>
       </ul>
     </section>
   <% end %>
-</aside>
+</aside>

data/app/views/maily/shared/_stylesheet.html.erb

@@ -1,28 +1,29 @@
 <%
-  blue       = "#59abc6"
-  grey       = "#cccccc"
-  bluegrey   = "#2f738a"
-  darkgrey   = "#666666"
-  textColor  = "#333333"
-  linkColor  = blue
-  hoverColor = bluegrey
+  blue          = "#59abc6"
+  grey          = "#cccccc"
+  dark_blue     = "#2f738a"
+  dark_grey     = "#666666"
+  text_color    = "#333333"
+  link_color    = blue
+  hover_color   = dark_blue
+  border_radius = "3px"
 %>
 
 <style>
   /* Body */
   body {
-    color: <%= textColor %>;
+    color: <%= text_color %>;
     font-size: 1em;
     font-family: "Helvetica Neue", Helvetica, sans-serif;
   }
 
   /* Links & Buttons */
   a {
-    color: <%= linkColor %>;
+    color: <%= link_color %>;
     text-decoration: none;
   }
   a:hover {
-    color: <%= hoverColor %>;
+    color: <%= hover_color %>;
   }
   .button {
     cursor: pointer;
@@ -31,10 +32,10 @@
     padding: 0;
     border: none;
     background: none;
-    color: <%= linkColor %>;
+    color: <%= link_color %>;
   }
   .button:hover {
-    color: <%= hoverColor %>;
+    color: <%= hover_color %>;
   }
 
   /* Inputs */
@@ -43,16 +44,16 @@
     font-family: inherit;
     height: 1.2em;
     border: solid 1px <%= grey %>;
-    border-radius: 6px;
-    background: "#ffffff";
+    border-radius: <%= border_radius %>;
+    background: #ffffff
     line-height: 1;
     padding-left: 0.5em;
   }
 
   ::-webkit-input-placeholder, ::-moz-placeholder {
     font-weight: 300;
-    font-size: 0.8em;
-    color: <%= darkgrey %>;
+    font-size: 0.9em;
+    color: <%= dark_grey %>;
   }
 
   /* Header */
@@ -102,7 +103,7 @@
     margin-left: 1em;
     padding-left: 20%;
   }
-  ul.action_bar {
+  ul.action_bar, ul.version_list {
     margin: 0 0 5px;
     padding: 0;
     list-style: none;
@@ -130,6 +131,17 @@
   ul.action_bar li.languages a {
     font-size: 0.9em;
   }
+  .version_list_wrapper {
+    box-sizing: border-box;
+    -moz-box-sizing: border-box;
+    border: solid 1px #cccccc;
+    border-radius: <%= border_radius %>;
+    margin: 2% 0;
+  }
+  ul.version_list {
+    font-size: 1em;
+    line-height: 1.5em;
+  }
   li.splitter {
     width: 1px;
     border-left: 1px <%= grey %> solid;
@@ -148,24 +160,24 @@
     -moz-box-sizing: border-box;
     padding: 1em;
     border: solid 1px <%= grey %>;
-    border-radius: 3px;
+    border-radius: <%= border_radius %>;
   }
   .mail_preview .mail_details {
     margin: 0 0 1em 0;
     padding: 0;
-    color: <%= darkgrey %>;
+    color: <%= dark_grey %>;
     list-style: none;
-    font-size: 0.8em;
+    font-size: 0.9em;
   }
   .mail_preview .mail_details li {
-    line-height: 1.5em;
+    line-height: 1em;
   }
   .mail_preview .mail_attachments {
     padding: 1em 0 0 0;
     border-top: solid 1px <%= grey %>;
-    color: <%= darkgrey %>;
+    color: <%= dark_grey %>;
     list-style: none;
-    font-size: 0.8em;
+    font-size: 0.9em;
   }
   .mail_preview .mail_attachments ul {
     display: inline-block;
@@ -182,7 +194,7 @@
     padding-top: 1em;
     border: none;
     border-top: solid 1px <%= grey %>;
-    border-radius: 3px;
+    border-radius: <%= border_radius %>;
     min-height: 100px;
   }
   .welcome_message {
@@ -202,7 +214,7 @@
     float: left;
   }
   .format_mail li a.format_selected {
-    color: <%= hoverColor %>;
+    color: <%= hover_color %>;
     font-weight: bold;
   }
   .format_mail li + li {
@@ -226,40 +238,40 @@
     max-height: 90vh;
     overflow-y: scroll;
   }
-  aside.sidebar section.nav_list {
-    margin: 0 0 1.5em 1.5em;
+  section.nav_list {
+    margin: 0 0 1em 0em;
   }
-  aside.sidebar section.nav_list .nav_title {
+  section.nav_list .nav_title {
     margin: 0 0 0.4em;
     font-weight: 400;
     font-size: 1.2em;
   }
-  aside.sidebar section.nav_list ul {
+  section.nav_list ul {
     margin: 0;
     padding: 0;
     list-style: none;
   }
-  aside.sidebar section.nav_list ul li {
+  section.nav_list ul li {
     margin-bottom: 0.4em;
     list-style: none;
   }
-  aside.sidebar section.nav_list ul li a {
-    color: <%= linkColor %>;
+  section.nav_list a {
     text-decoration: none;
     font-size: 0.9em;
   }
-  aside.sidebar section.nav_list ul li a:hover, aside.sidebar section.nav_list ul li a.selected_mail {
-    color: <%= hoverColor %>;
+  section.nav_list a.selected_mail, section.nav_list a:hover,
+  .version_list a.selected_mail, .version_list a:hover {
+    color: <%= hover_color %>;
     font-weight: bold;
   }
 
   /* Alert messages */
   .alert {
-    border-radius: 3px;
+    border-radius: <%= border_radius %>;
     padding: 16px;
     margin-bottom: 1.1em;
-    color: "#ffffff";
-    background-color: <%= bluegrey %>;
+    color: #ffffff;
+    background-color: <%= dark_blue %>;
   }
 
   /* Icons */

data/lib/generators/templates/initializer.rb

@@ -1,12 +1,12 @@
 Maily.setup do |config|
   # On/off engine
-  # config.enabled = Rails.env.production? ? false : true
+  # config.enabled = !Rails.env.production?
 
   # Allow templates edition
-  # config.allow_edition = Rails.env.production? ? false : true
+  # config.allow_edition = !Rails.env.production?
 
   # Allow deliveries
-  # config.allow_delivery = Rails.env.production? ? false : true
+  # config.allow_delivery = !Rails.env.production?
 
   # Your application available_locales (or I18n.available_locales) by default
   # config.available_locales = [:en, :es, :pt, :fr]
@@ -22,4 +22,4 @@ Maily.setup do |config|
 
   # Customize welcome message
   # config.welcome_message = "Welcome to our email testing platform. If you have any problem, please contact support team at support@example.com."
-end
+end

data/lib/maily/email.rb

@@ -1,6 +1,20 @@
 module Maily
   class Email
-    attr_accessor :name, :mailer, :arguments, :template_path, :template_name, :description, :with_params
+    DEFAULT_VERSION = 'default'.freeze
+
+    attr_accessor :name, :mailer, :arguments, :template_path, :template_name, :description, :with_params, :version
+
+    class << self
+      def name_with_version(name, version = nil)
+        _version = formatted_version(version)
+        [name, _version].join(':')
+      end
+
+      def formatted_version(version)
+        _version = version.presence || DEFAULT_VERSION
+        _version&.parameterize&.underscore
+      end
+    end
 
     def initialize(name, mailer)
       self.name          = name
@@ -17,12 +31,8 @@ module Maily
     end
 
     def parameterized_mailer_klass
-      if Rails.version >= '5.1'
-        params = with_params && with_params.transform_values { |param| param.respond_to?(:call) ? param.call : param }
-        mailer_klass.with(params)
-      else
-        mailer_klass
-      end
+      params = with_params && with_params.transform_values { |param| param.respond_to?(:call) ? param.call : param }
+      mailer_klass.with(params)
     end
 
     def parameters
@@ -58,6 +68,8 @@ module Maily
     def register_hook(*args)
       if args.last.is_a?(Hash)
         self.description = args.last.delete(:description)
+        self.with_params = args.last.delete(:with_params)
+        self.version = Maily::Email.formatted_version(args.last.delete(:version))
 
         if tpl_path = args.last.delete(:template_path)
           self.template_path = tpl_path
@@ -67,8 +79,6 @@ module Maily
           self.template_name = tpl_name
         end
 
-        self.with_params = args.last.delete(:with_params)
-
         args.pop
       end
 
@@ -78,11 +88,17 @@ module Maily
     def call
       *args = arguments && arguments.map { |arg| arg.respond_to?(:call) ? arg.call : arg }
 
-      if args == [nil]
+      message = if args == [nil]
         parameterized_mailer_klass.public_send(name)
       else
         parameterized_mailer_klass.public_send(name, *args)
       end
+
+      ActionMailer::Base.preview_interceptors.each do |interceptor|
+        interceptor.previewing_email(message)
+      end
+
+      message
     end
 
     def base_path(part)
@@ -109,5 +125,17 @@ module Maily
         f.write(new_content)
       end
     end
+
+    def versions
+      regexp = Regexp.new("^#{self.name}:")
+
+      mailer.emails.select do |email_key, _email|
+        email_key.match?(regexp)
+      end
+    end
+
+    def has_versions?
+      versions.count > 1
+    end
   end
 end

data/lib/maily/mailer.rb

@@ -27,8 +27,9 @@ module Maily
       all[mailer_name]
     end
 
-    def find_email(email_name)
-      emails[email_name.to_s]
+    def find_email(email_name, version = nil)
+      key = Maily::Email.name_with_version(email_name, version)
+      emails[key]
     end
 
     def emails_list
@@ -40,13 +41,15 @@ module Maily
     end
 
     def register_hook(email_name, *args)
-      email = find_email(email_name) || add_email(email_name)
+      version = get_version(*args)
+      email = find_email(email_name, version) || add_email(email_name, version)
       email && email.register_hook(*args)
     end
 
     def hide_email(*email_names)
       email_names.each do |email_name|
-        emails.delete(email_name.to_s)
+        _email_name = Maily::Email.name_with_version(email_name.to_s)
+        emails.delete(_email_name)
       end
     end
 
@@ -60,9 +63,17 @@ module Maily
       end
     end
 
-    def add_email(email_name)
+    def add_email(email_name, version = nil)
+      hide_email(email_name) if version
       email = Maily::Email.new(email_name.to_s, self)
-      self.emails[email.name] = email
+      key   = Maily::Email.name_with_version(email_name, version)
+      emails[key] = email
+    end
+
+    def get_version(*args)
+      return unless args.last.is_a?(Hash)
+
+      Maily::Email.formatted_version(args.last[:version])
     end
   end
 end

data/lib/maily/version.rb

@@ -1,3 +1,3 @@
 module Maily
-  VERSION = "1.0.0"
+  VERSION = "2.1.0"
 end

data/lib/maily.rb

@@ -10,9 +10,9 @@ module Maily
                   :base_controller, :http_authorization, :hooks_path, :welcome_message
 
     def init!
-      self.enabled            = Rails.env.production? ? false : true
-      self.allow_edition      = Rails.env.production? ? false : true
-      self.allow_delivery     = Rails.env.production? ? false : true
+      self.enabled            = !Rails.env.production?
+      self.allow_edition      = !Rails.env.production?
+      self.allow_delivery     = !Rails.env.production?
       self.available_locales  = Rails.application.config.i18n.available_locales || I18n.available_locales
       self.base_controller    = 'ActionController::Base'
       self.http_authorization = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maily
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - markets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-10 00:00:00.000000000 Z
+date: 2021-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Rails Engine to preview emails in the browser.