maily 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d04efbf8deab269bdfd889cc251b73b91c891b0
-  data.tar.gz: 4a8714c648898f417898417e0d91fede4c35b8eb
+  metadata.gz: 50e254d6048356a08a30e2175e4bc1809c9cccc7
+  data.tar.gz: 799e7de87f596fe17ed4981f8025ee1156639e4f
 SHA512:
-  metadata.gz: 233ce105c646910c4f71f76979debba629942fb1250005c2395d82b8d45d2be5b99bcd3e05f94e7d9a8a5b53b1df408945603a770e5ef7981ae3e490d30214e8
-  data.tar.gz: 1f3254b68cafaa2d1bc0fa1b2d93f7853d149994a30d9dfc67e9183ee83e429afc5e993d28000832ca70c86ab52416cc49de37ee3cfa0c97a435061f3dbdc226
+  metadata.gz: 1c870ea516edd08cfb71cb46519784009e0945b905ff6e85fdb559468042bffae144bf7c8227e9555cb4415164481f6b3c3d76f22124a7bc61905db3ad91236f
+  data.tar.gz: 17dd9afc7e7b4024bb1789771c07a0946e32d8a70b150560b1ec365c31b4cb46661bcb3a87d11ce10e595bbfd814e9dfd5f4f8de01d12c97d2a34d04bd2d7560

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.7.2]
+
+- Definitive fix for newer apps using `webpacker` and without `sass-rails` (#22)
+- Fix regression in generator, from v0.7.0 (#24)
+- Allow to edit emails with different templates engines: Slim, Haml, ... (#25)
+
 ## [0.7.1]
 
 - Fix assets pipeline integration for applications using `webpacker` instead of `sprockets` (#22)
@@ -79,6 +85,7 @@ All notable changes to this project will be documented in this file.
 
 - First real usable release :tada:
 
+[0.7.2]: https://github.com/markets/maily/compare/v0.7.1...v0.7.2
 [0.7.1]: https://github.com/markets/maily/compare/v0.7.0...v0.7.1
 [0.7.0]: https://github.com/markets/maily/compare/v0.6.3...v0.7.0
 [0.6.3]: https://github.com/markets/maily/compare/v0.6.2...v0.6.3

data/README.md

@@ -1,6 +1,8 @@
 # Maily
 
-[![Gem Version](https://badge.fury.io/rb/maily.svg)](http://badge.fury.io/rb/maily) [![Build Status](https://travis-ci.org/markets/maily.svg?branch=master)](https://travis-ci.org/markets/maily)
+[![Gem Version](https://badge.fury.io/rb/maily.svg)](http://badge.fury.io/rb/maily)
+[![Build Status](https://travis-ci.org/markets/maily.svg?branch=master)](https://travis-ci.org/markets/maily)
+[![Maintainability](https://api.codeclimate.com/v1/badges/fff01b2137fd73070b14/maintainability)](https://codeclimate.com/github/markets/maily/maintainability)
 
 Maily is a Rails Engine to manage, test and navigate through all your email templates of your app, being able to preview them directly in your browser.
 

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

@@ -1,4 +1,3 @@
-@import "maily/normalize";
 @import "maily/variables";
 
 /* Title font */
@@ -26,6 +25,8 @@ body {
 
 /* Inputs */
 input {
+  font-size: 100%;
+  font-family: inherit;
   height: 1.2em;
   border: solid 1px $grey;
   border-radius: 2px;

data/app/controllers/maily/emails_controller.rb

@@ -57,7 +57,7 @@ module Maily
     end
 
     def load_mailers
-      @mailers = Maily::Mailer.all.values
+      @mailers = Maily::Mailer.list
     end
 
     def load_mailer_and_email

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

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

data/lib/generators/maily/install_generator.rb

@@ -5,9 +5,11 @@ module Maily
       source_root File.expand_path("../../templates", __FILE__)
 
       def install
+        puts "==> Installing Maily components ..."
         generate_routing
-        build_initializer
+        copy_initializer
         build_hooks
+        puts "Ready! You can now access Maily at /maily"
       end
 
       private
@@ -16,29 +18,13 @@ module Maily
         route "mount Maily::Engine, at: '/maily'"
       end
 
-      def build_initializer
+      def copy_initializer
         template 'initializer.rb', 'config/initializers/maily.rb'
       end
 
       def build_hooks
-        Maily.init!
-
-        fixtures = []
-        hooks    = []
-
-        Maily::Mailer.all.each do |mailer|
-          hooks << "\nMaily.hooks_for('#{mailer.name.classify}') do |mailer|"
-          mailer.emails.each do |email|
-            if email.require_hook?
-              fixtures << email.required_arguments
-              hooks << "  mailer.register_hook(:#{email.name}, #{email.required_arguments.join(', ')})"
-            end
-          end
-          hooks << "end"
-        end
-
         create_file "lib/maily_hooks.rb" do
-          fixtures.flatten.uniq.map{ |f| f = "#{f.to_s} = ''" }.join("\n") + "\n" + hooks.join("\n") + "\n"
+          Maily::Generator.run
         end
       end
     end

data/lib/maily.rb

@@ -1,7 +1,8 @@
-require 'maily/engine'
 require 'maily/version'
+require 'maily/engine'
 require 'maily/mailer'
 require 'maily/email'
+require 'maily/generator'
 
 module Maily
   class << self
@@ -33,6 +34,8 @@ module Maily
 
     def hooks_for(mailer_name)
       mailer = Maily::Mailer.find(mailer_name.underscore)
+      return unless mailer
+
       yield(mailer) if block_given?
     end
 

data/lib/maily/email.rb

@@ -76,18 +76,17 @@ module Maily
     end
 
     def base_path(part)
-      "#{Rails.root}/app/views/#{template_path}/#{template_name}.#{part}.erb"
+      Dir["#{Rails.root}/app/views/#{template_path}/#{template_name}.#{part}.*"].first
     end
 
     def path(part = nil)
-      if part
-        base_path(part)
+      return base_path(part) if part
+
+      html_part = base_path('html')
+      if html_part && File.exist?(html_part)
+        html_part
       else
-        if File.exist?(path('html'))
-          base_path('html')
-        else
-          base_path('text')
-        end
+        base_path('text')
       end
     end
 

data/lib/maily/generator.rb

@@ -0,0 +1,26 @@
+module Maily
+  module Generator
+    def self.run
+      Maily.init!
+
+      fixtures = []
+      hooks    = []
+
+      Maily::Mailer.list.each do |mailer|
+        hooks << "\nMaily.hooks_for('#{mailer.name.classify}') do |mailer|"
+        mailer.emails_list.each do |email|
+          if email.require_hook?
+            fixtures << email.required_arguments
+            hooks << "  mailer.register_hook(:#{email.name}, #{email.required_arguments.join(', ')})"
+          end
+        end
+        hooks << "end"
+      end
+
+      fixtures = fixtures.flatten.uniq.map { |f| "#{f.to_s} = ''" }.join("\n")
+      hooks    = hooks.join("\n")
+
+      fixtures + "\n" + hooks + "\n"
+    end
+  end
+end

data/lib/maily/mailer.rb

@@ -19,6 +19,10 @@ module Maily
       collection
     end
 
+    def self.list
+      all.values.sort_by(&:name)
+    end
+
     def self.find(mailer_name)
       all[mailer_name]
     end
@@ -27,6 +31,10 @@ module Maily
       emails[email_name.to_s]
     end
 
+    def emails_list
+      emails.values.sort_by(&:name)
+    end
+
     def total_emails
       emails.size
     end

data/lib/maily/version.rb

@@ -1,3 +1,3 @@
 module Maily
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end

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

@@ -20,4 +20,12 @@ class Notifier < ActionMailer::Base
   def hidden
     mail
   end
+
+  def multipart
+    mail
+  end
+
+  def with_slim_template
+    mail
+  end
 end

data/spec/dummy/app/views/notifier/multipart.html.erb

@@ -0,0 +1 @@
+<h1>Multipart HTML</h1>

data/spec/dummy/app/views/notifier/multipart.text.erb

@@ -0,0 +1 @@
+Multipart plain text

data/spec/dummy/app/views/notifier/with_slim_template.html.slim

@@ -0,0 +1 @@
+p Hi from a Slim template

data/spec/email_spec.rb

@@ -31,6 +31,7 @@ describe Maily::Email do
 
     it 'should handle not lazy arguments successfully' do
       allow(email).to receive(:email).and_return('foo@foo.com')
+
       expect(email.arguments).to be_present
       expect(email.arguments.size).to eq(email.required_arguments.size)
     end
@@ -42,20 +43,23 @@ describe Maily::Email do
 
   it "should handle template_path via hook" do
     email = mailer.find_email('recommendation')
+
     expect(email.template_path).to eq('notifications')
   end
 
   it "should handle template_name via hook" do
     email = mailer.find_email('custom_template_name')
+
     expect(email.template_name).to eq('invitation')
   end
 
   it "should handle description via hook" do
     email = mailer.find_email('recommendation')
+
     expect(email.description).to eq('description')
   end
 
-  describe 'validate_arguments' do
+  describe '#validate_arguments' do
     it 'emails with no arguments required' do
       email = mailer.find_email('welcome')
       expect(email.validate_arguments).to eq [true, nil]
@@ -72,4 +76,20 @@ describe Maily::Email do
       expect(email.validate_arguments[1]).to eq("recommendation email requires at least 1 arguments, passed 0")
     end
   end
+
+  describe '#path' do
+    it 'with a multipart email defaults to html' do
+      email = mailer.find_email('multipart')
+
+      expect(email.path).to include('multipart.html.erb')
+      expect(email.path('text')).to include('multipart.text.erb')
+      expect(email.path('foo')).to eq nil
+    end
+
+    it 'with other template engines (e.g. Slim)' do
+      email = mailer.find_email('with_slim_template')
+
+      expect(email.path).to include('with_slim_template.html.slim')
+    end
+  end
 end

data/spec/generator_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Maily::Generator do
+  it '.run generates valid fixtures and hooks for current application' do
+    expect(Maily::Generator.run).to eq <<-HOOKS.strip_heredoc
+      email = ''
+
+      Maily.hooks_for('Notifier') do |mailer|
+        mailer.register_hook(:invitation, email)
+        mailer.register_hook(:recommendation, email)
+      end
+    HOOKS
+  end
+end

data/spec/mailer_spec.rb

@@ -2,12 +2,13 @@ require 'spec_helper'
 
 describe Maily::Mailer do
   it "should load mailers" do
-    expect(Maily::Mailer.all.size).to eq(1)
+    expect(Maily::Mailer.all.keys).to eq(['notifier'])
   end
 
   it "should build emails" do
     mailer = Maily::Mailer.find('notifier')
-    expect(mailer.emails.size).to eq(4)
+
+    expect(mailer.emails.size).to eq(6)
   end
 
   it "should find mailers by name" do
@@ -16,11 +17,27 @@ describe Maily::Mailer do
 
   it "should find emails by name" do
     mailer = Maily::Mailer.find('notifier')
+
     expect(mailer.find_email('welcome').name).to eq('welcome')
   end
 
   it "allows to hide email" do
     mailer = Maily::Mailer.find('notifier')
+
     expect(mailer.find_email('hidden')).to be nil
   end
+
+  it ".list returns an array with all mailers" do
+    list = Maily::Mailer.list
+
+    expect(list).to be_an_instance_of(Array)
+    expect(list.sample).to be_an_instance_of(Maily::Mailer)
+  end
+
+  it "#emails_list returns an array with all emails" do
+    mailer = Maily::Mailer.find('notifier')
+
+    expect(mailer.emails_list).to be_an_instance_of(Array)
+    expect(mailer.emails_list.sample).to be_an_instance_of(Maily::Email)
+  end
 end

data/spec/maily_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Maily do
-  it "should initialize with some defaults if no block is provided" do
+  it "#setup should initialize with some defaults if no block is provided" do
     Maily.setup
 
     expect(Maily.enabled).to be true
@@ -12,16 +12,18 @@ describe Maily do
     expect(Maily.http_authorization).to be nil
   end
 
-  it "should not allow edition if edition is disabled" do
-    Maily.allow_edition = false
+  describe '#allowed_action?' do
+    it "should not allow edition if edition is disabled" do
+      Maily.allow_edition = false
 
-    expect(Maily.allowed_action?(:edit)).to be false
-    expect(Maily.allowed_action?(:update)).to be false
-  end
+      expect(Maily.allowed_action?(:edit)).to be false
+      expect(Maily.allowed_action?(:update)).to be false
+    end
 
-  it "should not allow delivery if delivery is disabled" do
-    Maily.allow_delivery = false
+    it "should not allow delivery if delivery is disabled" do
+      Maily.allow_delivery = false
 
-    expect(Maily.allowed_action?(:deliver)).to be false
+      expect(Maily.allowed_action?(:deliver)).to be false
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maily
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - markets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-21 00:00:00.000000000 Z
+date: 2018-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -103,7 +103,6 @@ files:
 - app/assets/javascripts/maily/application.js
 - app/assets/stylesheets/maily/_variables.scss
 - app/assets/stylesheets/maily/application.scss
-- app/assets/stylesheets/maily/normalize.css
 - app/controllers/maily/application_controller.rb
 - app/controllers/maily/emails_controller.rb
 - app/helpers/maily/application_helper.rb
@@ -126,6 +125,7 @@ files:
 - lib/maily.rb
 - lib/maily/email.rb
 - lib/maily/engine.rb
+- lib/maily/generator.rb
 - lib/maily/mailer.rb
 - lib/maily/version.rb
 - maily.gemspec
@@ -145,7 +145,10 @@ files:
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/app/views/notifications/recommendation.html.erb
 - spec/dummy/app/views/notifier/invitation.html.erb
+- spec/dummy/app/views/notifier/multipart.html.erb
+- spec/dummy/app/views/notifier/multipart.text.erb
 - spec/dummy/app/views/notifier/welcome.html.erb
+- spec/dummy/app/views/notifier/with_slim_template.html.slim
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
 - spec/dummy/bin/rake
@@ -173,6 +176,7 @@ files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/email_spec.rb
+- spec/generator_spec.rb
 - spec/mailer_spec.rb
 - spec/maily_spec.rb
 - spec/spec_helper.rb
@@ -216,7 +220,10 @@ test_files:
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/app/views/notifications/recommendation.html.erb
 - spec/dummy/app/views/notifier/invitation.html.erb
+- spec/dummy/app/views/notifier/multipart.html.erb
+- spec/dummy/app/views/notifier/multipart.text.erb
 - spec/dummy/app/views/notifier/welcome.html.erb
+- spec/dummy/app/views/notifier/with_slim_template.html.slim
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
 - spec/dummy/bin/rake
@@ -244,6 +251,7 @@ test_files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/email_spec.rb
+- spec/generator_spec.rb
 - spec/mailer_spec.rb
 - spec/maily_spec.rb
 - spec/spec_helper.rb

data/app/assets/stylesheets/maily/normalize.css

@@ -1,341 +0,0 @@
-/*! normalize.css v8.0.0 | MIT License | github.com/necolas/normalize.css */
-
-/* Document
-   ========================================================================== */
-
-/**
- * 1. Correct the line height in all browsers.
- * 2. Prevent adjustments of font size after orientation changes in iOS.
- */
-
-html {
-  line-height: 1.15; /* 1 */
-  -webkit-text-size-adjust: 100%; /* 2 */
-}
-
-/* Sections
-   ========================================================================== */
-
-/**
- * Remove the margin in all browsers.
- */
-
-body {
-  margin: 0;
-}
-
-/**
- * Correct the font size and margin on `h1` elements within `section` and
- * `article` contexts in Chrome, Firefox, and Safari.
- */
-
-h1 {
-  font-size: 2em;
-  margin: 0.67em 0;
-}
-
-/* Grouping content
-   ========================================================================== */
-
-/**
- * 1. Add the correct box sizing in Firefox.
- * 2. Show the overflow in Edge and IE.
- */
-
-hr {
-  box-sizing: content-box; /* 1 */
-  height: 0; /* 1 */
-  overflow: visible; /* 2 */
-}
-
-/**
- * 1. Correct the inheritance and scaling of font size in all browsers.
- * 2. Correct the odd `em` font sizing in all browsers.
- */
-
-pre {
-  font-family: monospace, monospace; /* 1 */
-  font-size: 1em; /* 2 */
-}
-
-/* Text-level semantics
-   ========================================================================== */
-
-/**
- * Remove the gray background on active links in IE 10.
- */
-
-a {
-  background-color: transparent;
-}
-
-/**
- * 1. Remove the bottom border in Chrome 57-
- * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
- */
-
-abbr[title] {
-  border-bottom: none; /* 1 */
-  text-decoration: underline; /* 2 */
-  text-decoration: underline dotted; /* 2 */
-}
-
-/**
- * Add the correct font weight in Chrome, Edge, and Safari.
- */
-
-b,
-strong {
-  font-weight: bolder;
-}
-
-/**
- * 1. Correct the inheritance and scaling of font size in all browsers.
- * 2. Correct the odd `em` font sizing in all browsers.
- */
-
-code,
-kbd,
-samp {
-  font-family: monospace, monospace; /* 1 */
-  font-size: 1em; /* 2 */
-}
-
-/**
- * Add the correct font size in all browsers.
- */
-
-small {
-  font-size: 80%;
-}
-
-/**
- * Prevent `sub` and `sup` elements from affecting the line height in
- * all browsers.
- */
-
-sub,
-sup {
-  font-size: 75%;
-  line-height: 0;
-  position: relative;
-  vertical-align: baseline;
-}
-
-sub {
-  bottom: -0.25em;
-}
-
-sup {
-  top: -0.5em;
-}
-
-/* Embedded content
-   ========================================================================== */
-
-/**
- * Remove the border on images inside links in IE 10.
- */
-
-img {
-  border-style: none;
-}
-
-/* Forms
-   ========================================================================== */
-
-/**
- * 1. Change the font styles in all browsers.
- * 2. Remove the margin in Firefox and Safari.
- */
-
-button,
-input,
-optgroup,
-select,
-textarea {
-  font-family: inherit; /* 1 */
-  font-size: 100%; /* 1 */
-  line-height: 1.15; /* 1 */
-  margin: 0; /* 2 */
-}
-
-/**
- * Show the overflow in IE.
- * 1. Show the overflow in Edge.
- */
-
-button,
-input { /* 1 */
-  overflow: visible;
-}
-
-/**
- * Remove the inheritance of text transform in Edge, Firefox, and IE.
- * 1. Remove the inheritance of text transform in Firefox.
- */
-
-button,
-select { /* 1 */
-  text-transform: none;
-}
-
-/**
- * Correct the inability to style clickable types in iOS and Safari.
- */
-
-button,
-[type="button"],
-[type="reset"],
-[type="submit"] {
-  -webkit-appearance: button;
-}
-
-/**
- * Remove the inner border and padding in Firefox.
- */
-
-button::-moz-focus-inner,
-[type="button"]::-moz-focus-inner,
-[type="reset"]::-moz-focus-inner,
-[type="submit"]::-moz-focus-inner {
-  border-style: none;
-  padding: 0;
-}
-
-/**
- * Restore the focus styles unset by the previous rule.
- */
-
-button:-moz-focusring,
-[type="button"]:-moz-focusring,
-[type="reset"]:-moz-focusring,
-[type="submit"]:-moz-focusring {
-  outline: 1px dotted ButtonText;
-}
-
-/**
- * Correct the padding in Firefox.
- */
-
-fieldset {
-  padding: 0.35em 0.75em 0.625em;
-}
-
-/**
- * 1. Correct the text wrapping in Edge and IE.
- * 2. Correct the color inheritance from `fieldset` elements in IE.
- * 3. Remove the padding so developers are not caught out when they zero out
- *    `fieldset` elements in all browsers.
- */
-
-legend {
-  box-sizing: border-box; /* 1 */
-  color: inherit; /* 2 */
-  display: table; /* 1 */
-  max-width: 100%; /* 1 */
-  padding: 0; /* 3 */
-  white-space: normal; /* 1 */
-}
-
-/**
- * Add the correct vertical alignment in Chrome, Firefox, and Opera.
- */
-
-progress {
-  vertical-align: baseline;
-}
-
-/**
- * Remove the default vertical scrollbar in IE 10+.
- */
-
-textarea {
-  overflow: auto;
-}
-
-/**
- * 1. Add the correct box sizing in IE 10.
- * 2. Remove the padding in IE 10.
- */
-
-[type="checkbox"],
-[type="radio"] {
-  box-sizing: border-box; /* 1 */
-  padding: 0; /* 2 */
-}
-
-/**
- * Correct the cursor style of increment and decrement buttons in Chrome.
- */
-
-[type="number"]::-webkit-inner-spin-button,
-[type="number"]::-webkit-outer-spin-button {
-  height: auto;
-}
-
-/**
- * 1. Correct the odd appearance in Chrome and Safari.
- * 2. Correct the outline style in Safari.
- */
-
-[type="search"] {
-  -webkit-appearance: textfield; /* 1 */
-  outline-offset: -2px; /* 2 */
-}
-
-/**
- * Remove the inner padding in Chrome and Safari on macOS.
- */
-
-[type="search"]::-webkit-search-decoration {
-  -webkit-appearance: none;
-}
-
-/**
- * 1. Correct the inability to style clickable types in iOS and Safari.
- * 2. Change font properties to `inherit` in Safari.
- */
-
-::-webkit-file-upload-button {
-  -webkit-appearance: button; /* 1 */
-  font: inherit; /* 2 */
-}
-
-/* Interactive
-   ========================================================================== */
-
-/*
- * Add the correct display in Edge, IE 10+, and Firefox.
- */
-
-details {
-  display: block;
-}
-
-/*
- * Add the correct display in all browsers.
- */
-
-summary {
-  display: list-item;
-}
-
-/* Misc
-   ========================================================================== */
-
-/**
- * Add the correct display in IE 10+.
- */
-
-template {
-  display: none;
-}
-
-/**
- * Add the correct display in IE 10.
- */
-
-[hidden] {
-  display: none;
-}