maily 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1e9bad7d3c7b7eb13ed1a089389af4d831cfacc
-  data.tar.gz: 9c4fcf7c4c73886dcdab225b0502063f7c580873
+  metadata.gz: 960fe837fad9d25f9a3c52b45de7540996568f19
+  data.tar.gz: 25f2c237274223154cef523015c4fcfca70a555c
 SHA512:
-  metadata.gz: 13ed37c28422b6fc3e9212fd3f44abcec459d10bcf36a7d050547f7f92b834e4883d9b7c3f2a57b8389585191f66ebd08cb529295a787621006e9e716eec5223
-  data.tar.gz: 49dc5c0869782d4f58dd7d28f20640832a5aa7cf136bef7af807ac86e6298fdba07351cca58309554efa946aa63ff26c48adfecf3b12d7d345d28305b71a22a8
+  metadata.gz: 174935bd4512c31ba40c7426c0520baee46d7ff100283f3d34b0b65a4e3392fc08a9969a6a152b4a0b03d7daf1de9d094da5763554f11edb584707b90fc84754
+  data.tar.gz: 75afed37aab5f3c374d2b78a731d7c40ec91302cd39d627e0d6636ea56d68d34c8c469d31957bc1e17382de848f4c2224f3618e03885367e633de80f011009ac

data/README.md

@@ -4,6 +4,8 @@
 
 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.
 
+Maily automatically picks up all your emails and make them accessible from a kind of dashboard.
+
 ## Features:
 
 * Mountable engine
@@ -11,9 +13,9 @@ Maily is a Rails Engine to manage, test and navigate through all your email temp
 * Template edition (only in development)
 * Email delivery
 * Features configurables per environment
-* Flexible authorization
+* Flexible authorization system
 * Minimalistic and clean interface
-* Easy way (aka `hooks`) to define data for emails
+* Easy way (aka `hooks`) to define and customize data for emails
 * Generator to handle a comfortable installation
 
 ![](screenshot.png)
@@ -130,16 +132,16 @@ Basically, you have 2 ways to restrict the access to `Maily`.
 
 ### Custom base controller
 
-By default `Maily` runs under `ActionController::Base`, but you are able to customize that parent controller (`Maily.base_controller` option) in order to achieve (using `before_action`) a kind of access control system. For example, set a different base controller:
+By default `Maily` runs under `ActionController::Base`, but you are able to customize that parent controller (`Maily.base_controller` option) in order to achieve (using, for example, `before_action` blocks) a kind of access control system. For example, set a different base controller:
 
 ```ruby
-Maily.base_controller = '::AdminController'
+Maily.base_controller = '::SuperAdminController'
 ```
 
-And write your own authorization rules in the defined `base_controller`:
+And then write your own authorization rules in this defined controller:
 
 ```ruby
-class AdminController < ActionController::Base
+class SuperAdminController < ActionController::Base
   before_action :maily_authorized?
 
   private

data/app/controllers/maily/emails_controller.rb

@@ -1,5 +1,5 @@
 module Maily
-  class EmailsController < ApplicationController
+  class EmailsController < Maily::ApplicationController
     before_action :allowed_action?, only: [:edit, :update, :deliver]
     before_action :load_mailers, only: [:index, :show, :edit]
     before_action :load_mailer_and_email, except: [:index]
@@ -9,15 +9,10 @@ module Maily
     end
 
     def show
-      if !@maily_email.correct_number_of_arguments?
-        alert = if @maily_email.optional_arguments.size > 0
-          "#{@maily_email.name} email requires #{@maily_email.required_arguments.size} \
-          to #{@maily_email.required_arguments.size + @maily_email.optional_arguments.size} arguments"
-        else
-          "#{@maily_email.required_arguments.size} arguments needed for #{@maily_email.name} email"
-        end
-
-        redirect_to(root_path, alert: alert)
+      valid, message = @maily_email.validate_arguments
+
+      unless valid
+        redirect_to(root_path, alert: message)
       end
     end
 
@@ -28,11 +23,12 @@ module Maily
         @email.body
       end
 
-      render text: content, layout: false
+      render html: content.raw_source, layout: false
     end
 
     def attachment
       attachment = @email.attachments.find { |elem| elem.filename == params[:attachment] }
+
       send_data attachment.body, filename: attachment.filename, type: attachment.content_type
     end
 

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

@@ -18,7 +18,7 @@
             <em class="icon-maily-earth"></em>
             Languages</li>
             <% Maily.available_locales.each do |locale| %>
-              <li><%= link_to locale.upcase, url_for(params.merge(locale: locale)) %></li>
+              <li><%= link_to locale.upcase, url_for(params.to_unsafe_h.merge(locale: locale)) %></li>
             <% end %>
         </ul>
       <% end %>
@@ -47,8 +47,8 @@
 
     <% if @email.html_part && @email.text_part %>
       <ul class="maily_format_mail">
-        <li><%= link_to 'HTML', url_for(params.merge(part: 'html')), class: part_class('html') %></li>
-        <li><%= link_to 'TEXT', url_for(params.merge(part: 'text')), class: part_class('text') %></li>
+        <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 %>
 

data/lib/generators/maily/install_generator.rb

@@ -13,7 +13,7 @@ module Maily
       private
 
       def generate_routing
-        route "mount Maily::Engine, at: 'maily'"
+        route "mount Maily::Engine, at: '/maily'"
       end
 
       def build_initializer

data/lib/maily/email.rb

@@ -19,18 +19,25 @@ module Maily
     end
 
     def required_arguments
-      parameters.select{ |param| param.first == :req }.map(&:last)
+      parameters.select { |param| param.first == :req }.map(&:last)
     end
 
     def optional_arguments
-      parameters.select{ |param| param.first == :opt }.map(&:last)
+      parameters.select { |param| param.first == :opt }.map(&:last)
     end
 
-    def correct_number_of_arguments?
+    def validate_arguments
       from = required_arguments.size
       to = from + optional_arguments.size
+      passed_by_hook = arguments && arguments.size || 0
 
-      (from..to).cover?(arguments.size)
+      if passed_by_hook < from
+        [false, "#{name} email requires at least #{from} arguments, passed #{passed_by_hook}"]
+      elsif passed_by_hook > to
+        [false, "#{name} email requires at the most #{to} arguments, passed #{passed_by_hook}"]
+      else
+        [true, nil]
+      end
     end
 
     def register_hook(*args)

data/lib/maily/version.rb

@@ -1,3 +1,3 @@
 module Maily
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/spec/email_spec.rb

@@ -50,19 +50,21 @@ describe Maily::Email do
     expect(email.description).to eq('description')
   end
 
-  describe 'correct_number_of_arguments?' do
-    let (:email) { mailer.find_email('invitation') }
-
-    it 'when it lacks of arguments' do
-      allow_any_instance_of(Maily::Email).to receive(:parameters).and_return([])
+  describe 'validate_arguments' do
+    it 'emails with no arguments required' do
+      email = mailer.find_email('welcome')
+      expect(email.validate_arguments).to eq [true, nil]
 
-      expect(email.correct_number_of_arguments?).to be(false)
+      email.arguments = ["asd"]
+      expect(email.validate_arguments[1]).to  eq("welcome email requires at the most 0 arguments, passed 1")
     end
 
-    it 'when there is a correct number of arguments' do
-      allow_any_instance_of(Maily::Email).to receive(:parameters).and_return([[:req, 'email'], [:opt, 'optional']])
+    it 'emails with arguments required' do
+      email = mailer.find_email('invitation')
+      expect(email.validate_arguments).to eq [true, nil]
 
-      expect(email.correct_number_of_arguments?).to be(true)
+      email = mailer.find_email('recommendation')
+      expect(email.validate_arguments[1]).to eq("recommendation email requires at least 1 arguments, passed 0")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maily
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - markets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-26 00:00:00.000000000 Z
+date: 2017-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -196,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Rails Engine to preview emails in the browser.