maily 0.6.3 → 0.7.0

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

@@ -1,73 +1,70 @@
-<div class="content">
-  <% if @maily_email.description %>
-    <div>
-      <b>Description </b><%= @maily_email.description %>
-    </div><br>
-  <% end %>
-
-  <ul class="maily_action_bar">
-    <li>
-      <em class="icon-maily-pencil"></em>
-      <%= link_to 'Edit', edit_maily_email_path(mailer: params[:mailer], email: params[:email], part: params[:part]) %>
-    </li>
-
-    <li class="maily_languages">
-      <% if Maily.available_locales.present? %>
-        <ul>
-          <li>
-            <em class="icon-maily-earth"></em>
-            Languages</li>
-            <% Maily.available_locales.each do |locale| %>
-              <li><%= link_to locale.upcase, url_for(params.to_unsafe_h.merge(locale: locale)) %></li>
-            <% end %>
-        </ul>
-      <% end %>
-    </li>
-
-    <li class="maily_splitter">|</li>
-    <li>
-      <%= form_tag(deliver_maily_email_path(mailer: params[:mailer], email: params[:email], locale: params[:locale]), method: :post, class: 'maily_send') do %>
-        <ul>
-          <li>Send to</li>
-          <li><%= email_field_tag :to, nil, class: 'maily_textfield', placeholder: "Enter email", required: true %></li>
-          <li><%= submit_tag 'Send', class: 'maily_button' %></li>
-        </ul>
-      <% end %>
-    </li>
-  </ul>
+<%= email_description(@maily_email) %>
 
-  <div class="maily_mail_preview">
-    <ul class="maily_mail_details">
-      <% if @email.subject %><li><b>Subject</b> <%= @email.subject %></li><% end %>
-      <% if @email.from %><li><b>From</b> <%= @email.from.join(', ') %></li><% end %>
-      <% if @email.to %><li><b>To</b> <%= @email.to.join(', ') %></li><% end %>
-      <% if @email.cc %><li><b>Cc</b> <%= @email.cc.join(', ') %></li><% end %>
-      <% if @email.bcc %><li><b>Bcc</b> <%= @email.bcc.join(', ') %></li><% end %>
-      <% if @email.reply_to %><li><b>Reply to</b> <%= @email.reply_to.join(', ') %></li><% end %>
-    </ul>
+<ul class="action_bar">
+  <li>
+    <%= link_to 'Edit', edit_maily_email_path(mailer: params[:mailer], email: params[:email], part: params[:part]) %>
+  </li>
 
-    <% if @email.html_part && @email.text_part %>
-      <ul class="maily_format_mail">
-        <li><%= link_to 'HTML', url_for(params.to_unsafe_h.merge(part: 'html')), class: part_class('html') %></li>
-        <li><%= link_to 'TEXT', url_for(params.to_unsafe_h.merge(part: 'text')), class: part_class('text') %></li>
+  <li class="languages">
+    <% if Maily.available_locales.present? %>
+      <ul>
+        <li>
+          <%= icon 'globe' %> Languages
+        </li>
+        <% Maily.available_locales.each do |locale| %>
+          <li><%= link_to locale.upcase, url_for(params.to_unsafe_h.merge(locale: locale)) %></li>
+        <% end %>
       </ul>
     <% end %>
+  </li>
 
-    <% if @email.html_part || @email.text_part || @email.body.present? %>
-      <iframe class="maily_preview"  onload='javascript:resizeIframe(this);' src="<%= raw_maily_email_path(mailer: params[:mailer], email: params[:email], locale: params[:locale], part: params[:part]) %>" frameborder="1" width="100%"></iframe>
-    <% end %>
+  <li class="splitter">|</li>
 
-    <% if @email.attachments.present? %>
-      <ul class="maily_mail_attachments">
-        <li>Attachments:</li>
-        <li>
-          <ul>
-            <% @email.attachments.each do |attachment| %>
-              <li><em class="icon-maily-attachment"></em><%= link_to attachment.filename, attachment_maily_email_path(mailer: params[:mailer], email: params[:email], attachment: attachment.filename) %></li>
-            <% end %>
-          </ul>
-        </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 %>
-  </div>
+  </li>
+</ul>
+
+<div class="mail_preview">
+  <ul class="mail_details">
+    <% if @email.subject %><li><b>Subject</b> <%= @email.subject %></li><% end %>
+    <% if @email.from %><li><b>From</b> <%= @email.from.join(', ') %></li><% end %>
+    <% if @email.to %><li><b>To</b> <%= @email.to.join(', ') %></li><% end %>
+    <% if @email.cc %><li><b>Cc</b> <%= @email.cc.join(', ') %></li><% end %>
+    <% if @email.bcc %><li><b>Bcc</b> <%= @email.bcc.join(', ') %></li><% end %>
+    <% if @email.reply_to %><li><b>Reply to</b> <%= @email.reply_to.join(', ') %></li><% end %>
+  </ul>
+
+  <% if @email.html_part && @email.text_part %>
+    <ul class="format_mail">
+      <li><%= link_to 'HTML', url_for(params.to_unsafe_h.merge(part: 'html')), class: part_class('html') %></li>
+      <li><%= link_to 'TEXT', url_for(params.to_unsafe_h.merge(part: 'text')), class: part_class('text') %></li>
+    </ul>
+  <% 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>
+  <% end %>
+
+  <% if @email.attachments.present? %>
+    <ul class="mail_attachments">
+      <li>Attachments:</li>
+      <li>
+        <ul>
+          <% @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) %>
+            </li>
+          <% end %>
+        </ul>
+      </li>
+    </ul>
+  <% end %>
 </div>

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

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

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

@@ -1,3 +1,6 @@
 <header class="header">
-  <a href="<%= root_path %>" class="logo_link"><em class="icon-maily-envelope"></em>Maily</a>
+  <a href="<%= root_path %>" class="logo_link">
+    <%= image_tag 'maily/logo.png', align: 'center', width: 45 %>
+    <span>Maily</span>
+  </a>
 </header>

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

@@ -1,9 +1,9 @@
 <aside class="sidebar">
   <% @mailers.sort_by(&:name).each do |mailer| %>
     <section class="nav_list">
-      <h3 class="title nav_title"><%= "#{mailer.name.humanize} (#{mailer.emails.length})" %></h3>
+      <h3 class="nav_title"><%= "#{mailer.name.humanize} (#{mailer.total_emails})" %></h3>
       <ul>
-        <% mailer.emails.sort_by(&:name).each do |email| %>
+        <% mailer.emails.values.sort_by(&:name).each do |email| %>
           <li><%= link_to email.name.humanize, maily_email_path(mailer: mailer.name, email: email.name), class: sidebar_class(mailer, email) %></li>
         <% end %>
       </ul>

data/gemfiles/rails_4.2.gemfile

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", github: "rails/rails", branch: "4-2-stable"
+gem "rails", :github => "rails/rails", :branch => "4-2-stable"
 
-gemspec path: "../"
+gemspec :path => "../"

data/gemfiles/rails_5.0.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 5.0.0"
 
-gemspec path: "../"
+gemspec :path => "../"

data/gemfiles/rails_5.1.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "~> 5.1.0"
 
-gemspec path: "../"
+gemspec :path => "../"

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+
+gemspec :path => "../"

data/lib/maily.rb

@@ -23,9 +23,7 @@ module Maily
       # Load emails from file system
       Dir[Rails.root + 'app/mailers/*.rb'].each do |mailer|
         klass_name = File.basename(mailer, '.rb')
-        klass = klass_name.camelize.constantize
-        methods = klass.send(:public_instance_methods, false)
-        Maily::Mailer.new(klass_name, methods)
+        Maily::Mailer.new(klass_name)
       end
 
       # Load hooks

data/lib/maily/email.rb

@@ -1,15 +1,20 @@
 module Maily
   class Email
-    attr_accessor :name, :mailer, :arguments, :template_path, :description
+    attr_accessor :name, :mailer, :arguments, :template_path, :template_name, :description
 
     def initialize(name, mailer)
-      self.name          = name.to_s
+      self.name          = name
       self.mailer        = mailer
       self.arguments     = nil
-      self.template_path = mailer
+      self.template_path = mailer.name
+      self.template_name = name
       self.description   = nil
     end
 
+    def mailer_klass
+      mailer.klass
+    end
+
     def parameters
       mailer_klass.instance_method(name).parameters
     end
@@ -45,21 +50,21 @@ module Maily
 
       if args.last.is_a?(Hash)
         self.description = args.last.delete(:description)
-        self.template_path = args.last.delete(:template_path)
+
+        if tpl_path = args.last.delete(:template_path)
+          self.template_path = tpl_path
+        end
+
+        if tpl_name = args.last.delete(:template_name)
+          self.template_name = tpl_name
+        end
+
         args.pop
       end
 
       self.arguments = args
     end
 
-    def mailer_klass_name
-      mailer.camelize
-    end
-
-    def mailer_klass
-      mailer_klass_name.constantize
-    end
-
     def call
       *args = arguments && arguments.map { |arg| arg.respond_to?(:call) ? arg.call : arg }
 
@@ -71,7 +76,7 @@ module Maily
     end
 
     def base_path(part)
-      "#{Rails.root}/app/views/#{template_path}/#{name}.#{part}.erb"
+      "#{Rails.root}/app/views/#{template_path}/#{template_name}.#{part}.erb"
     end
 
     def path(part = nil)

data/lib/maily/mailer.rb

@@ -1,13 +1,17 @@
 module Maily
   class Mailer
     cattr_accessor :collection
-    attr_accessor :name, :emails
+    attr_accessor :name, :emails, :klass
 
-    def initialize(name, methods)
-      self.collection ||= []
-      self.name       = name
-      self.emails     = self.class.build_emails(methods, name)
-      self.collection << self
+    def initialize(name)
+      self.name   = name
+      self.klass  = name.camelize.constantize
+      self.emails = {}
+
+      parse_emails
+
+      self.class.collection ||= {}
+      self.class.collection[name] = self
     end
 
     def self.all
@@ -16,22 +20,36 @@ module Maily
     end
 
     def self.find(mailer_name)
-      all.find { |mailer| mailer.name == mailer_name }
+      all[mailer_name]
     end
 
-    def self.build_emails(methods, mailer)
-      methods.map do |email|
-        Maily::Email.new(email, mailer)
-      end
+    def find_email(email_name)
+      emails[email_name.to_s]
+    end
+
+    def total_emails
+      emails.size
     end
 
     def register_hook(email_name, *args)
       email = find_email(email_name)
-      email.register_hook(args)
+      email && email.register_hook(args)
     end
 
-    def find_email(email_name)
-      emails.find { |email| email.name == email_name.to_s }
+    def hide_email(*email_names)
+      email_names.each do |email_name|
+        emails.delete(email_name.to_s)
+      end
+    end
+
+    private
+
+    def parse_emails
+      _emails = klass.send(:public_instance_methods, false)
+
+      _emails.map(&:to_s).each do |email|
+        self.emails[email] = Maily::Email.new(email, self)
+      end
     end
   end
 end

data/lib/maily/version.rb

@@ -1,3 +1,3 @@
 module Maily
-  VERSION = "0.6.3"
+  VERSION = "0.7.0"
 end

data/maily.gemspec

@@ -19,6 +19,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rspec-rails"
   s.add_development_dependency "appraisal"
-  s.add_development_dependency 'test-unit', '~> 3.0'
-  s.add_development_dependency "byebug" if RUBY_VERSION.to_i >= 2
+  s.add_development_dependency "byebug"
 end

data/spec/controllers_spec.rb

@@ -1,6 +1,15 @@
 require 'spec_helper'
 
 describe Maily::EmailsController, type: :controller do
+  # Rails 4 <-> 5 compatibility
+  def compatible_get(action, **params)
+    if ::Rails::VERSION::STRING > '5'
+      get action, params: params
+    else
+      get action, params
+    end
+  end
+
   routes { Maily::Engine.routes }
 
   before(:each) do
@@ -11,22 +20,52 @@ describe Maily::EmailsController, type: :controller do
     expect { get :index }.not_to raise_error
   end
 
-  it 'raise error if disabled' do
+  it 'raises 404 if disabled' do
     Maily.enabled = false
+
     get :index
+
     expect(response.status).to eq(404)
   end
 
   it 'responds with 401 if http authorization fails' do
     Maily.http_authorization = { username: 'admin', password: 'admin' }
+
     get :index
+
     expect(response.status).to eq(401)
   end
 
   it 'responds ok with valid http authorization' do
     Maily.http_authorization = { username: 'admin', password: 'admin' }
     request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials('admin', 'admin')
+
     get :index
+
     expect(response.status).to eq(200)
   end
+
+  describe 'non-existent emails' do
+    it 'email not in the system -> 302' do
+      compatible_get :show, mailer: 'notifier', email: 'non_existent_email'
+
+      expect(response.status).to eq(302)
+      expect(flash.alert).to eq("Email not found!")
+    end
+
+    it 'hidden emails -> 302' do
+      compatible_get :show, mailer: 'notifier', email: 'hidden'
+
+      expect(response.status).to eq(302)
+      expect(flash.alert).to eq("Email not found!")
+    end
+  end
+
+  describe 'GET #raw' do
+    it 'renders the template' do
+      compatible_get :raw, mailer: 'notifier', email: 'invitation'
+
+      expect(response.body).to match("<h1>Invitation</h1>")
+    end
+  end
 end

data/spec/dummy/app/mailers/notifier.rb

@@ -12,4 +12,12 @@ class Notifier < ActionMailer::Base
   def recommendation(email)
     mail template_path: 'notifications'
   end
+
+  def custom_template_name
+    mail template_name: 'invitation'
+  end
+
+  def hidden
+    mail
+  end
 end

data/spec/dummy/lib/maily_hooks.rb

@@ -3,4 +3,7 @@ email = -> { 'foo@foo.com' }
 Maily.hooks_for('Notifier') do |mailer|
   mailer.register_hook(:invitation, email)
   mailer.register_hook(:recommendation, template_path: 'notifications', description: 'description')
+  mailer.register_hook(:custom_template_name, template_name: 'invitation')
+
+  mailer.hide_email(:hidden)
 end