maily 0.12.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e2d3eb5fa12bff5214c0c3bf8279fa4ae87e1c2a1fa7e0d3ff15600576f836f
-  data.tar.gz: 5cb5fb89ad2e8a3c710f91e42c4ddaf7003a5673d96e71a5d23d9132a8036388
+  metadata.gz: f5d36fc2996857665c3ca2722d87efacccdd1a389e2ff2c96e00ce4f8a2d0de4
+  data.tar.gz: e48248be9469c2f524434855a48ccbe11743631456b4659c941cc7c6cb4c2e68
 SHA512:
-  metadata.gz: 3c4bcb08461590baedc7d0db69e49e9df161db4c79aa9339b1623147a89e66a0e1e4e9af4cf97b213b6370687c1ba9afef940640473af665f93fa10172536967
-  data.tar.gz: 50b5ad7a8155169dcda86df69b76fae8d30eed92d1634b9dfbec5aedfc1db07ba8b39129069b4b98efc786412fb115940820f8d409d8786c941549c73c8c5daf
+  metadata.gz: eb0e6fac2533eaf67e2c946ca7a7a18faa8d3765114d33cc7ae82036c010812f8a5849f445da776047a07a9cdcf8359b84a0279bf77068b23e1b707a42a6d90e
+  data.tar.gz: ad9bce77b87ed40340f2a3c491f17d722dab9d0922e11d34f0d1ebf94b5d2aca9218c7d8ba22bdea2ebf3e30f13f14a650049d1548b4f7b989efebf986d27966

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.0.1]
+
+- 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)
+
+## [0.12.3]
+
+- Styles: fix input placeholder color in Firefox
+
+## [0.12.2]
+
+- Refine logo and UI (#45)
+
 ## [0.12.1]
 
 - Sprockets v4 fixes (#44)
@@ -131,6 +153,11 @@ All notable changes to this project will be documented in this file.
 
 - First real usable release :tada:
 
+[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
 [0.12.1]: https://github.com/markets/maily/compare/v0.12.0...v0.12.1
 [0.12.0]: https://github.com/markets/maily/compare/v0.11.0...v0.12.0
 [0.11.0]: https://github.com/markets/maily/compare/v0.10.1...v0.11.0

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://travis-ci.com/markets/maily"><img src="https://travis-ci.com/markets/maily.svg?branch=master"></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 rake
+```
+
+Run the test suite against all supported versions:
+
+```
+> bundle exec appraisal install
+> bundle exec appraisal rake
+```
+
+Run specs against specific version:
+
+```
+> bundle exec appraisal rails-6.0 rake
+```
+
+### 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

@@ -43,7 +43,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 +51,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 +66,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

data/app/helpers/maily/application_helper.rb

@@ -14,8 +14,25 @@ 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('logo.png', 'image/png'))
+    end
+
     def icon(name)
-      image_tag "maily/icons/#{name}.svg", 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/maily').join(path)
+      base64_contents = Base64.strict_encode64(file.read)
+
+      "data:#{mime_type};base64,#{base64_contents}"
     end
   end
 end

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/layouts/maily/application.html.erb

@@ -3,7 +3,7 @@
 <head>
   <title><%= title %></title>
   <%= csrf_meta_tags %>
-  <%= stylesheet_link_tag "maily/application", media: "all" %>
+  <%= render 'maily/shared/stylesheet' %>
   <%= render 'maily/shared/javascript' %>
 </head>
 <body>

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">
@@ -21,7 +21,7 @@
   <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 %>
+    <%= 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>
@@ -31,6 +31,17 @@
   </li>
 </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 +60,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 +71,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/_flash_messages.html.erb

@@ -1,7 +1,7 @@
 <% if flash[:alert].present? %>
-  <div class="alert alert-warning"><%= flash[:alert].html_safe %></div>
+  <div class="alert"><%= flash[:alert].html_safe %></div>
 <% end %>
 
 <% if flash[:notice].present? %>
-  <div class="alert alert-success"><%= flash[:notice].html_safe %></div>
-<% end %>
+  <div class="alert"><%= flash[:notice].html_safe %></div>
+<% end %>

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

@@ -1,6 +1,9 @@
 <header class="header">
   <a href="<%= root_path %>" class="logo_link">
-    <%= image_tag 'maily/logo.png', align: 'center', width: 40 %>
-    <span>Maily</span>
+    <%= logo %>
+  </a>
+
+  <a href="<%= main_app.root_path %>" class="back_to_app">
+    Back to app
   </a>
 </header>

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

@@ -0,0 +1,283 @@
+<%
+  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: <%= text_color %>;
+    font-size: 1em;
+    font-family: "Helvetica Neue", Helvetica, sans-serif;
+  }
+
+  /* Links & Buttons */
+  a {
+    color: <%= link_color %>;
+    text-decoration: none;
+  }
+  a:hover {
+    color: <%= hover_color %>;
+  }
+  .button {
+    cursor: pointer;
+    box-sizing: border-box;
+    -moz-box-sizing: border-box;
+    padding: 0;
+    border: none;
+    background: none;
+    color: <%= link_color %>;
+  }
+  .button:hover {
+    color: <%= hover_color %>;
+  }
+
+  /* Inputs */
+  input {
+    font-size: 100%;
+    font-family: inherit;
+    height: 1.2em;
+    border: solid 1px <%= grey %>;
+    border-radius: <%= border_radius %>;
+    background: #ffffff
+    line-height: 1;
+    padding-left: 0.5em;
+  }
+
+  ::-webkit-input-placeholder, ::-moz-placeholder {
+    font-weight: 300;
+    font-size: 0.9em;
+    color: <%= dark_grey %>;
+  }
+
+  /* Header */
+  header.header, footer.footer {
+    position: fixed;
+    left: 0;
+    z-index: 99;
+    width: 100%;
+    background-color: rgba(255, 255, 255, 0.95);
+  }
+  header.header {
+    padding: 0.6em;
+    top: 0;
+    box-shadow: 0 0.0625em 0.3125em rgba(0, 0, 0, 0.15);
+  }
+  header.header .logo_link {
+    margin-left: 1em;
+  }
+  header.header .logo_link img {
+    height: 45px;
+  }
+  header.header .back_to_app {
+    float: right;
+    margin-right: 2em;
+    margin-top: 1em;
+  }
+
+  /* Footer */
+  footer.footer {
+    padding: 0 1em;
+    bottom: 0;
+    box-shadow: 0 -0.0625em 0.3125em rgba(0, 0, 0, 0.15);
+    font-family: inherit;
+    font-size: 0.9em;
+  }
+
+  /* Main content */
+  .wrap_content {
+    display: inline-block;
+    box-sizing: border-box;
+    -moz-box-sizing: border-box;
+    padding: 6em 0.75em 4em;
+    width: 100%;
+  }
+  .content {
+    margin-right: 2em;
+    margin-left: 1em;
+    padding-left: 20%;
+  }
+  ul.action_bar, ul.version_list {
+    margin: 0 0 5px;
+    padding: 0;
+    list-style: none;
+    font-size: 1.2em;
+  }
+  ul.action_bar, ul.action_bar ul {
+    display: inline-block;
+    width: 100%;
+  }
+  ul.action_bar li, ul.action_bar ul li {
+    float: left;
+    margin-right: 0.5em;
+  }
+  ul.action_bar li:last-child, ul.action_bar ul li:last-child {
+    margin-right: 0;
+  }
+  ul.action_bar ul {
+    margin: 0;
+    padding: 0;
+    list-style: none;
+  }
+  ul.action_bar li.languages {
+    float: right;
+  }
+  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;
+    text-indent: -999999em;
+  }
+  .mail_description {
+    margin-bottom: 2em;
+  }
+  .mail_deliver ul li {
+    float: left;
+    margin-right: 0.4em;
+  }
+  .mail_preview {
+    height: 100%;
+    box-sizing: border-box;
+    -moz-box-sizing: border-box;
+    padding: 1em;
+    border: solid 1px <%= grey %>;
+    border-radius: <%= border_radius %>;
+  }
+  .mail_preview .mail_details {
+    margin: 0 0 1em 0;
+    padding: 0;
+    color: <%= dark_grey %>;
+    list-style: none;
+    font-size: 0.9em;
+  }
+  .mail_preview .mail_details li {
+    line-height: 1em;
+  }
+  .mail_preview .mail_attachments {
+    padding: 1em 0 0 0;
+    border-top: solid 1px <%= grey %>;
+    color: <%= dark_grey %>;
+    list-style: none;
+    font-size: 0.9em;
+  }
+  .mail_preview .mail_attachments ul {
+    display: inline-block;
+    margin: 0;
+    padding: 0;
+    width: 100%;
+    list-style: none;
+  }
+  .mail_preview .mail_attachments ul li {
+    float: left;
+    margin: 1em 1em 0 0;
+  }
+  .mail_preview iframe.mail_iframe {
+    padding-top: 1em;
+    border: none;
+    border-top: solid 1px <%= grey %>;
+    border-radius: <%= border_radius %>;
+    min-height: 100px;
+  }
+  .welcome_message {
+    margin-top: 3em;
+    max-width: 80%;
+  }
+  .format_mail {
+    position: relative;
+    display: inline-block;
+    float: right;
+    margin: -2em 0 0 0;
+    padding: 0;
+    width: 6.5em;
+    list-style: none;
+  }
+  .format_mail li {
+    float: left;
+  }
+  .format_mail li a.format_selected {
+    color: <%= hover_color %>;
+    font-weight: bold;
+  }
+  .format_mail li + li {
+    margin: 0 0 0 0.4em;
+    padding: 0 0 0 0.4em;
+    border-left: solid 1px <%= grey %>;
+  }
+  .mail_updatearea {
+    position: relative;
+    overflow: visible;
+    min-height: 450px;
+    width: 100%;
+    height: 100%;
+    border: none;
+  }
+
+  /* Sidebar */
+  aside.sidebar {
+    float: left;
+    width: 20%;
+    max-height: 90vh;
+    overflow-y: scroll;
+  }
+  section.nav_list {
+    margin: 0 0 1em 0em;
+  }
+  section.nav_list .nav_title {
+    margin: 0 0 0.4em;
+    font-weight: 400;
+    font-size: 1.2em;
+  }
+  section.nav_list ul {
+    margin: 0;
+    padding: 0;
+    list-style: none;
+  }
+  section.nav_list ul li {
+    margin-bottom: 0.4em;
+    list-style: none;
+  }
+  section.nav_list a {
+    text-decoration: none;
+    font-size: 0.9em;
+  }
+  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: <%= border_radius %>;
+    padding: 16px;
+    margin-bottom: 1.1em;
+    color: #ffffff;
+    background-color: <%= dark_blue %>;
+  }
+
+  /* Icons */
+  img.icon {
+    width: 20px;
+    font-size: 0.9em;
+    vertical-align: bottom;
+  }
+</style>

data/lib/generators/maily/install_generator.rb

@@ -29,4 +29,4 @@ module Maily
       end
     end
   end
-end
+end

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.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

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
 
@@ -109,5 +119,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/engine.rb

@@ -2,12 +2,5 @@ module Maily
   class Engine < ::Rails::Engine
     isolate_namespace Maily
     load_generators
-
-    config.assets.precompile << %w(
-      maily/application.css
-      maily/logo.png
-      maily/icons/globe.svg
-      maily/icons/paperclip.svg
-    )
   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 = "0.12.1"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maily
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 2.0.1
 platform: ruby
 authors:
 - markets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-21 00:00:00.000000000 Z
+date: 2021-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: sassc-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -80,8 +66,6 @@ files:
 - app/assets/images/maily/icons/globe.svg
 - app/assets/images/maily/icons/paperclip.svg
 - app/assets/images/maily/logo.png
-- app/assets/stylesheets/maily/_variables.scss
-- app/assets/stylesheets/maily/application.scss
 - app/controllers/maily/application_controller.rb
 - app/controllers/maily/emails_controller.rb
 - app/helpers/maily/application_helper.rb
@@ -95,6 +79,7 @@ files:
 - app/views/maily/shared/_header.html.erb
 - app/views/maily/shared/_javascript.html.erb
 - app/views/maily/shared/_sidebar.html.erb
+- app/views/maily/shared/_stylesheet.html.erb
 - config/routes.rb
 - lib/generators/maily/install_generator.rb
 - lib/generators/templates/initializer.rb

data/app/assets/stylesheets/maily/_variables.scss

@@ -1,6 +0,0 @@
-$blue: #59abc6;
-$red: #a94442;
-$grey: #ccc;
-$darkgrey: #666;
-$textColor: #444;
-$linkColor: $blue;

data/app/assets/stylesheets/maily/application.scss

@@ -1,305 +0,0 @@
-@import url("https://fonts.googleapis.com/css?family=Josefin+Sans:light");
-
-@import "maily/variables";
-
-/* Body */
-body {
-  color: $textColor;
-  font-size: 1em;
-  font-family: "Helvetica Neue", Helvetica, sans-serif;
-
-  a {
-    color: $linkColor;
-    text-decoration: none;
-    &:hover {
-      color: darken($linkColor, 20%);
-    }
-  }
-}
-
-/* Inputs */
-input {
-  font-size: 100%;
-  font-family: inherit;
-  height: 1.2em;
-  border: solid 1px $grey;
-  border-radius: 2px;
-  background: #fff;
-  line-height: 1;
-}
-
-::-webkit-input-placeholder {
-  padding: 0 .2em;
-  vertical-align: bottom;
-  font-weight: 300;
-}
-:-moz-placeholder { font-size: 0.6em; }
-::-moz-placeholder { font-size: 0.6em; }
-:-ms-input-placeholder { font-size: 0.6em; }
-
-/* Header */
-header.header, footer.footer {
-  position: fixed;
-  left: 0;
-  z-index: 99;
-  width: 100%;
-  background-color: rgba(255,255,255, .95);
-}
-
-header.header {
-  padding: 1em;
-  top: 0;
-  box-shadow: 0 .0625em .3125em rgba(0,0,0, .15);
-
-  .logo_link {
-    color: $textColor;
-    font: 400 2em/1 'Josefin Sans';
-    margin-left: 10px;
-
-    img, span {
-      vertical-align: text-bottom;
-    }
-  }
-}
-
-/* Footer */
-footer.footer {
-  padding: 0 1em;
-  bottom: 0;
-  box-shadow: 0 -.0625em .3125em rgba(0,0,0, .15);
-  font-family: "Helvetica Neue", Helvetica, sans-serif;
-  font-size: .9em;
-}
-
-/* Main content */
-.wrap_content {
-  display: inline-block;
-  box-sizing: border-box;
-  -moz-box-sizing: border-box;
-  padding: 6em .75em 4em;
-  width: 100%;
-}
-
-.content {
-  margin-right: 2em;
-  margin-left: 1em;
-  padding-left: 20%;
-
-  ul.action_bar {
-    margin: 0 0 5px;
-    padding: 0;
-    list-style: none;
-    font-size: 1.2em;
-
-    &, & ul {
-      display: inline-block;
-      width: 100%;
-    }
-
-    li, ul li {
-      float: left;
-      margin-right: .5em;
-      &:last-child { margin-right: 0; }
-    }
-
-    ul {
-      margin: 0;
-      padding: 0;
-      list-style: none;
-    }
-
-    li.languages {
-      float: right;
-    }
-  }
-
-  li.splitter {
-    width: 1px;
-    border-left: 1px $grey solid;
-    text-indent: -999999em;
-  }
-
-  .mail_description {
-    margin-bottom: 2em;
-  }
-
-  .mail_deliver {
-    ul {
-      li {
-        float: left;
-        margin-right: .4em;
-      }
-    }
-  }
-
-  .mail_preview {
-    height: 100%;
-    box-sizing: border-box;
-    -moz-box-sizing: border-box;
-    padding: 1em;
-    border: solid 1px $grey;
-    border-radius: 3px;
-
-    .mail_details {
-      margin: 0 0 1em 0;
-      padding: 0;
-      color: $darkgrey;
-      list-style: none;
-      font-size: .8em;
-
-      li { line-height: 1.5em; }
-    }
-
-    .mail_attachments {
-      padding: 1em 0 0 0;
-      border-top: solid 1px $grey;
-      color: $darkgrey;
-      list-style: none;
-      font-size: .8em;
-
-      ul {
-        display: inline-block;
-        margin: 0;
-        padding: 0;
-        width: 100%;
-        list-style: none;
-
-        li {
-          float: left;
-          margin: 1em 1em 0 0;
-        }
-      }
-    }
-
-    iframe.mail_iframe {
-      padding-top: 1em;
-      border: none;
-      border-top: solid 1px $grey;
-      border-radius: 2px;
-      min-height: 100px;
-    }
-  }
-
-  .welcome_message {
-    margin-top: 3em;
-    max-width: 80%;
-  }
-
-  .button {
-    box-sizing: border-box;
-    -moz-box-sizing: border-box;
-    padding: 0;
-    border: none;
-    background: none;
-    color: $linkColor;
-    &:hover {
-      color: darken($linkColor, 20%);
-    }
-  }
-
-  .format_mail {
-    position: relative;
-    display: inline-block;
-    float: right;
-    margin: -2em 0 0 0;
-    padding: 0;
-    width: 6.5em;
-    list-style: none;
-
-    li {
-      float: left;
-
-      a.format_selected {
-        color: darken($linkColor, 20%);
-        font-weight: bold;
-      }
-
-      + li {
-        margin: 0 0 0 .4em;
-        padding: 0 0 0 .4em;
-        border-left: solid 1px $grey;
-      }
-    }
-  }
-
-  .mail_updatearea {
-    position: relative;
-    overflow: visible;
-    min-height: 450px;
-    width: 100%;
-    height: 100%;
-    border: none;
-  }
-}
-
-/* Sidebar */
-aside.sidebar {
-  float: left;
-  width: 20%;
-  max-height: 90vh;
-  overflow-y: scroll;
-
-  section.nav_list {
-    margin: 0 0 1.5em 1.5em;
-
-    .nav_title {
-      margin: 0 0 .4em;
-      font-weight: 400;
-      font-size: 1.2em;
-    }
-
-    ul {
-      margin: 0;
-      padding: 0;
-      list-style: none;
-
-      li {
-        margin-bottom: .4em;
-        list-style: none;
-
-        a {
-          color: $linkColor;
-          text-decoration: none;
-          font-size: .9em;
-
-          &.selected_mail {
-            color: darken($linkColor, 20%);
-            font-weight: bold;
-
-            &:before {
-              content: "\003E";
-              font-weight: bolder;
-              font-size: 1.2em;
-              margin-right: 2px;
-            }
-          }
-          &:hover {
-            color: darken($linkColor, 20%);
-          }
-        }
-      }
-    }
-  }
-}
-
-/* Alert messages */
-.alert {
-  border-radius: 3px;
-  padding: 16px;
-  margin-bottom: 1.1em;
-}
-.alert-warning {
-  color: $red;
-  background-color: lighten($red, 40%);
-}
-.alert-success {
-  color: #fff;
-  background-color: darken($blue, 20%);
-}
-
-/* Icons */
-img.icon {
-  width: 20px;
-  font-size: .9em;
-  vertical-align: bottom;
-}