maily 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50074da78185e506a4d209f802c81c22cdc62837
-  data.tar.gz: eaddfeabcc75b5ff0bc0da5a5f633570f4078d5f
+  metadata.gz: 291636ca60a98e766c9bce67b7c8727c7afb004d
+  data.tar.gz: d271b7309ac06279f1696b7acd095f022ad3b39d
 SHA512:
-  metadata.gz: 709e63a4f1734a301e35325a734f47558f68e8d980630284b31c111f3a701d72230bcc2c7c96c3855de92831d9c68d352f14d6f9b6b5e38af73495c151c1732e
-  data.tar.gz: 3c91aea7375c944a7ca09b5add559d22e9b28f5d76288e98d0bc537d8a9fa04af36eca282593295ddd25302b9d0fc99ffb1c678e0ca98ee2afd6464d4f60f79f
+  metadata.gz: 85df3565ec395d61ed85170a571ed222041e0dc2ef876689ffdbc6b4104f2df4708ecec105a87d9cf1f683634710e392f8027b48425a8ad3389b14f8b150bfe5
+  data.tar.gz: 888cbd6256c7aa44a4d745ba2c785acd5e7a50449aec17dbbda1449ea58793090ecf57e4b07034b4ef51bec87783aaa70e1270df9a06bfeb2128af02003f1b44

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 *.gemfile.lock
 spec/dummy/log/*.log
 spec/dummy/tmp/
+.byebug_history

data/.travis.yml

@@ -5,19 +5,13 @@ cache: bundler
 sudo: false
 
 rvm:
-  - 2.4.1
-  - 2.3.4
-  - 2.2.7
-  - 2.1
+  - 2.5.1
+  - 2.4.4
+  - 2.3.6
+  - 2.2.9
 
 gemfile:
+  - gemfiles/rails_5.2.gemfile
   - gemfiles/rails_5.1.gemfile
   - gemfiles/rails_5.0.gemfile
   - gemfiles/rails_4.2.gemfile
-
-matrix:
-  exclude:
-    - rvm: 2.1
-      gemfile: gemfiles/rails_5.0.gemfile
-    - rvm: 2.1
-      gemfile: gemfiles/rails_5.1.gemfile

data/Appraisals

@@ -1,3 +1,7 @@
+appraise "rails-5.2" do
+  gem "rails", "~> 5.2.0"
+end
+
 appraise "rails-5.1" do
   gem "rails", "~> 5.1.0"
 end

data/CHANGELOG.md

@@ -0,0 +1,90 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.7.0]
+
+- Allow to hide emails (#11)
+- Allow to override `template_name`
+- New project logo
+- Internal classes refactor
+- Front-end cleanup and simplification (remove font icons, update normalize.css, CSS/HTML refactor, better page titles, better flash messages)
+- Drop Ruby 2.1 (EOL) from CI
+- CI against Rails 5.2
+
+## [0.6.3]
+
+- Add support for `reply_to`
+
+## [0.6.2]
+
+- Rails 5.1 fixes (#19, #20)
+- Hooks: improve arguments validation (#20)
+
+## [0.6.1]
+
+- Fix Rails automatic generator (#18)
+- UI: display better error messages (#17)
+- UI: alphabetically sort mailers and emails in sidebar (#17)
+
+## [0.6.0]
+
+- Lazy hooks (#14)
+- Better capture and dispatch internal exceptions (#13)
+- Allow to define a description per email (#10)
+- Remove HTML5 Shiv (front-end dependency)
+- Fix assets pipeline integration
+- Lots of front-end tweaks
+- Basic dashboard with customizable welcome message
+- CI suite: officially supported Rails versions: 4.2, 5.0 and 5.1
+
+## [0.5.0]
+
+- Appraisals integration: Rails 3.2, 4.X and 5.0
+- Modernize CI Rubies: add 2.2, 2.3 and 2.4 (remove 1.9.3 and 2.0)
+- Fix Ruby warnings (#12)
+- Docs typos (#8)
+
+## [0.4.0]
+
+- Allow to setup HTTP basic authentication
+
+## [0.3.5]
+
+- CI: run tests against ruby 2.1
+- Properly define dependencies
+
+## [0.3.4]
+
+- Fix syntax error introduced in v0.3.3 :(
+
+## [0.3.3]
+
+- Disallow templates edition in production mode
+
+## [0.3.2]
+
+- Fix #3: email container not displayed properly in Firefox
+
+## [0.3.1]
+
+- Add basic specs
+- CI integration
+
+## [0.3.0]
+
+- First real usable release :tada:
+
+[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
+[0.6.2]: https://github.com/markets/maily/compare/v0.6.1...v0.6.2
+[0.6.1]: https://github.com/markets/maily/compare/v0.6.0...v0.6.1
+[0.6.0]: https://github.com/markets/maily/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/markets/maily/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/markets/maily/compare/v0.4.0...v0.5.0
+[0.3.5]: https://github.com/markets/maily/compare/v0.3.5...v0.4.0
+[0.3.4]: https://github.com/markets/maily/compare/v0.3.3...v0.3.4
+[0.3.3]: https://github.com/markets/maily/compare/v0.3.2...v0.3.3
+[0.3.2]: https://github.com/markets/maily/compare/v0.3.1...v0.3.2
+[0.3.1]: https://github.com/markets/maily/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/markets/maily/compare/v0.1.0...v0.3.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013-2017 Marc Anguera Insa
+Copyright 2013-2018 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

@@ -108,11 +108,12 @@ Maily.hooks_for('PaymentNotifier') do |mailer|
 end
 ```
 
-Note that you are able to override `template_path` like can be done in Rails. You must pass this option as a hash and last argument:
+Note that you are able to override the `template_path` and the `template_name` like can be done in Rails. You must pass these options as a hash and last argument:
 
 ```ruby
 Maily.hooks_for('YourMailerClass') do |mailer|
-  mailer.register_hook(:your_mail, template_path: 'notifications')
+  mailer.register_hook(:a_random_email, template_path: 'notifications')
+  mailer.register_hook(:another_email, template_name: 'email_base')
 end
 ```
 
@@ -126,6 +127,16 @@ Maily.hooks_for('BookingNotifier') do |mailer|
 end
 ```
 
+### Hide emails
+
+You are also able to hide emails:
+
+```ruby
+Maily.hooks_for('Notifier') do |mailer|
+  mailer.hide_email(:sensible_email, :secret_email)
+end
+```
+
 ## Authorization
 
 Basically, you have 2 ways to restrict the access to `Maily`.
@@ -166,6 +177,14 @@ Rails 4.1 introduced a built-in mechanism to preview the application emails. It
 
 Alternatively, there are some other plugins to get a similar functionality 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).
 
+## Development
+
+Any kind of feedback, bug report, idea or enhancement are really appreciated :tada:
+
+To contribute, just fork the repo, hack on it and send a pull request. Don't forget to add specs for behaviour changes and run the test suite:
+
+    > bundle exec appraisal rake
+
 ## License
 
 Copyright (c) Marc Anguera. Maily is released under the [MIT](MIT-LICENSE) License.

data/app/assets/images/maily/icons/globe.svg

@@ -0,0 +1,13 @@
+<!--?xml version="1.0" encoding="UTF-8" standalone="no"?-->
+<svg viewBox="0 0 16 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>Globe</title>
+    <defs></defs>
+    <g stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g fill="#434343">
+            <path d="M8.048,0 C3.63045083,0 0.048,3.582 0.048,8 C0.048,12.418 3.63045083,16 8.048,16 C12.4665577,16 16.048,12.418 16.048,8 C16.048,3.582 12.4665577,0 8.048,0 L8.048,0 Z M8,15 C4.13533409,15 1,11.8671467 1,8 C1,4.13384159 4.13533409,1 8,1 C11.8646659,1 15,4.13384159 15,8 C15,11.868135 11.8646659,15 8,15 L8,15 Z" class="si-glyph-fill"></path>
+            <path d="M2.959,2.684 C2.689,4.028 3.694,6.083 5.831,6.583 C7.967,7.083 7.049,6.667 6.717,6 C6.383,5.333 6.682,4.833 7.199,4.667 C7.717,4.5 7.586,4.96 8.354,4 C8.548,2 6.882,3.973 6.716,3.14 C8.366,1.223 5.95,0.5 5.249,0.75 C4.548,1 3.229,1.339 2.959,2.684 L2.959,2.684 Z" class="si-glyph-fill"></path>
+            <path d="M6.873,7.694 C6.749,7.749 6.171,8.11 5.972,8.36 C5.773,8.61 5.686,9.138 5.972,9.36 C6.258,9.583 5.956,10.639 6.727,10.833 C7.498,11.027 8.27,11.14 8.299,11.75 C8.326,12.36 8.227,13.777 7.856,13.917 C8.356,14.194 9.573,12.722 10.001,11.944 C10.43,11.167 10.573,10.055 10.544,9.777 C10.515,9.5 10.715,8.917 10.801,8.167 C10.886,7.417 10.231,7.367 10.146,7.034 C10.059,6.7 9.943,6.333 6.873,7.694 L6.873,7.694 Z" class="si-glyph-fill"></path>
+            <path d="M13.125,4 C13.125,4 11.113,4.861 12.481,6.14 C13.847,7.417 14.543,8.63 14.476,8.908 C14.414,9.184 13.096,10.614 13.853,10.502 C14.614,10.391 15.175,8.891 15.296,8.001 C15.415,7.111 14.372,5.362 14.329,5.224 C14.293,5.083 13.607,4.015 13.125,4 L13.125,4 Z" class="si-glyph-fill"></path>
+        </g>
+    </g>
+</svg>

data/app/assets/images/maily/icons/paperclip.svg

@@ -0,0 +1,8 @@
+<!--?xml version="1.0" encoding="UTF-8" standalone="no"?-->
+<svg viewBox="0 0 16 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>Paperclip</title>
+    <defs></defs>
+    <g stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <path d="M6.346,16 C5.009,16 4,14.907 4,13.725 L4,3.99799991 C4,1.63391113 5.25378418,0 7.69795109,0 L8.3671875,0 C11.046,0 12,1.56054688 12,3.99799991 L12,11.0050049 L11.046,11.0050049 L11.046,3.99799991 C11.046,2.4140625 10.4089355,1 8.3671875,1 L7.68199992,1 C5.87280273,1 5,2.31750488 5,3.99799991 L5,13.725 C5,14.463 5.448,14.999 6.345,14.999 L7.683,14.999 C8.535,14.999 9.062,14.511 9.062,13.725 L9.062,5.756 C9.062,5.225 8.98100008,5.03984473 7.94300008,4.99084473 C6.88400008,5.04284473 7,5.262 7,5.756 L6.99999995,10.0100098 L5.99899995,10.0100098 L5.999,5.756 C5.999,4.635 6.635,4.06 7.943,3.998 C9.249,4.058 10,4.616 10,5.756 L10,13.725 C10,14.947 8.966,16 7.682,16 L6.346,16 Z" fill="#434343" class="si-glyph-fill"></path>
+    </g>
+</svg>

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

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

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

@@ -1,6 +1,7 @@
 @import "maily/normalize";
-@import "maily/icons";
+@import "maily/variables";
 
+/* Title font */
 @font-face {
   font-weight: light;
   font-style: normal;
@@ -8,28 +9,7 @@
   src: asset-url('maily/fonts/JosefinSans-Light.ttf') format('truetype');
 }
 
-::-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; }
-
-
-$textColor: #444;
-$linkColor: #59abc6;
-
-.clearfix:before,
-.clearfix:after {
-  display: table;
-  content: " ";
-}
-
-.clearfix:after { clear: both; }
-
+/* Body */
 body {
   color: $textColor;
   font-size: 1em;
@@ -38,52 +18,64 @@ body {
   a {
     color: $linkColor;
     text-decoration: none;
+    &:hover {
+      color: darken($linkColor, 20%);
+    }
   }
 }
 
-.title { margin-top: 0; }
+/* Inputs */
+input {
+  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;
-  padding: .75em;
+  padding: .5em 1em;
   width: 100%;
   background-color: rgba(255,255,255, .95);
 }
 
-/* HEADER */
 header.header {
   top: 0;
   box-shadow: 0 .0625em .3125em rgba(0,0,0, .15);
 
   .logo_link {
     color: $textColor;
-    text-decoration: none;
     font: 400 2em/1 'Josefin Sans';
+    margin-left: 10px;
 
-    em:before {
-      font-size: .8em;
-      font-family: 'maily';
+    img, span {
+      vertical-align: middle;
     }
   }
 }
 
-/* FOOTER */
+/* Footer */
 footer.footer {
   bottom: 0;
   box-shadow: 0 -.0625em .3125em rgba(0,0,0, .15);
   font-family: "Helvetica Neue", Helvetica, sans-serif;
   font-size: .9em;
-
-  a {
-    color: $linkColor;
-    text-decoration: none;
-  }
 }
 
-/* CONTENT */
+/* Main content */
 .wrap_content {
   display: inline-block;
   box-sizing: border-box;
@@ -97,17 +89,12 @@ footer.footer {
   margin-left: 2em;
   padding-left: 20%;
 
-  ul.maily_action_bar {
-    margin: 0;
+  ul.action_bar {
+    margin: 0 0 5px;
     padding: 0;
     list-style: none;
     font-size: 1.2em;
 
-    em:before {
-      margin-right: .2em;
-      font-size: .9em;
-    }
-
     &, & ul {
       display: inline-block;
       width: 100%;
@@ -125,18 +112,22 @@ footer.footer {
       list-style: none;
     }
 
-    li.maily_languages {
+    li.languages {
       float: right;
     }
   }
 
-  li.maily_splitter {
+  li.splitter {
     width: 1px;
-    border-left: 1px #ccc solid;
+    border-left: 1px $grey solid;
     text-indent: -999999em;
   }
 
-  .maily_send {
+  .mail_description {
+    margin-bottom: 2em;
+  }
+
+  .mail_deliver {
     ul {
       li {
         float: left;
@@ -145,28 +136,28 @@ footer.footer {
     }
   }
 
-  .maily_mail_preview {
+  .mail_preview {
     height: 100%;
     box-sizing: border-box;
     -moz-box-sizing: border-box;
     padding: 1em;
-    border: solid 1px #ccc;
+    border: solid 1px $grey;
     border-radius: 3px;
 
-    .maily_mail_details {
+    .mail_details {
       margin: 0 0 1em 0;
       padding: 0;
-      color: #666;
+      color: $darkgrey;
       list-style: none;
       font-size: .8em;
 
       li { line-height: 1.5em; }
     }
 
-    .maily_mail_attachments {
+    .mail_attachments {
       padding: 1em 0 0 0;
-      border-top: solid 1px #ccc;
-      color: #666;
+      border-top: solid 1px $grey;
+      color: $darkgrey;
       list-style: none;
       font-size: .8em;
 
@@ -184,32 +175,27 @@ footer.footer {
       }
     }
 
-    iframe.maily_preview {
+    iframe.mail_iframe {
       padding-top: 1em;
       border: none;
-      border-top: solid 1px #ccc;
+      border-top: solid 1px $grey;
       border-radius: 2px;
     }
   }
 
-  .maily_textfield {
-    height: 1em;
-    border: solid 1px #ccc;
-    border-radius: 2px;
-    background: #fff;
-    line-height: 1;
-  }
-
-  .maily_button {
+  .button {
     box-sizing: border-box;
     -moz-box-sizing: border-box;
     padding: 0;
     border: none;
     background: none;
     color: $linkColor;
+    &:hover {
+      color: darken($linkColor, 20%);
+    }
   }
 
-  .maily_format_mail {
+  .format_mail {
     position: relative;
     display: inline-block;
     float: right;
@@ -218,7 +204,6 @@ footer.footer {
     width: 6.5em;
     list-style: none;
 
-
     li {
       float: left;
 
@@ -230,12 +215,12 @@ footer.footer {
       + li {
         margin: 0 0 0 .4em;
         padding: 0 0 0 .4em;
-        border-left: solid 1px #ccc;
+        border-left: solid 1px $grey;
       }
     }
   }
 
-  .maily_mail_updatearea {
+  .mail_updatearea {
     position: relative;
     overflow: visible;
     min-height: 450px;
@@ -245,16 +230,11 @@ footer.footer {
   }
 }
 
-/* SIDEBAR */
+/* Sidebar */
 aside.sidebar {
   float: left;
   width: 20%;
 
-  .main_title {
-    margin: 0 0 1em;
-    font-size: 1.5em;
-  }
-
   section.nav_list {
     margin: 0 0 1.5em 2.1em;
 
@@ -278,26 +258,17 @@ aside.sidebar {
           text-decoration: none;
           font-size: .9em;
 
-          &.maily_selected_mail {
-
+          &.selected_mail {
             color: darken($linkColor, 20%);
             font-weight: bold;
+
             &:before {
-              content: "\e63e";
-              text-transform: none;
-              font-weight: normal;
+              content: "\003E";
               font-weight: bolder;
-              font-style: normal;
-              font-variant: normal;
-              font-size: .6em;
-              font-family: 'maily';
-              line-height: 1;
-              speak: none;
-              -webkit-font-smoothing: antialiased;
-              -moz-osx-font-smoothing: grayscale;
+              font-size: 1.2em;
+              margin-right: 2px;
             }
           }
-
           &:hover {
             color: darken($linkColor, 20%);
           }
@@ -307,11 +278,32 @@ aside.sidebar {
   }
 }
 
-/* ALERT */
+/* Alert messages */
 .alert {
-  color: #a94442;
-  background-color: #f2dede;
-  padding: 15px;
-  margin-bottom: 20px;
-  display: flex;
+  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;
+}
+
+/* Utils */
+.clearfix:before,
+.clearfix:after {
+  display: table;
+  content: " ";
 }
+.clearfix:after { clear: both; }