letter_opener_web 1.3.1 → 1.3.2

data/{script → bin}/rails

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
-# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+# frozen_string_literal: true
+
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your
+# application.
 
 ENGINE_ROOT = File.expand_path('../..', __FILE__)
 ENGINE_PATH = File.expand_path('../../lib/letter_opener_web/engine', __FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -euo pipefail
+
+bundle check || bundle install
+
+ln -sf "$(git rev-parse --show-toplevel)/script/pre-push" .git/hooks/pre-push

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 LetterOpenerWeb::Engine.routes.draw do
   delete 'clear'                 => 'letters#clear',    :as => :clear_letters
   delete ':id'                   => 'letters#destroy',  :as => :delete_letter

data/letter_opener_web.gemspec

@@ -1,28 +1,30 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'letter_opener_web/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "letter_opener_web"
+  gem.name          = 'letter_opener_web'
   gem.version       = LetterOpenerWeb::VERSION
-  gem.authors       = ["Fabio Rehm"]
-  gem.email         = ["fgrehm@gmail.com"]
-  gem.description   = %q{Gives letter_opener an interface for browsing sent emails}
+  gem.authors       = ['Fabio Rehm']
+  gem.email         = ['fgrehm@gmail.com']
+  gem.description   = 'Gives letter_opener an interface for browsing sent emails'
   gem.summary       = gem.description
-  gem.homepage      = "https://github.com/fgrehm/letter_opener_web"
+  gem.homepage      = 'https://github.com/fgrehm/letter_opener_web'
   gem.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^exe/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.add_dependency 'railties', '>= 3.2'
   gem.add_dependency 'actionmailer', '>= 3.2'
   gem.add_dependency 'letter_opener', '~> 1.0'
+  gem.add_dependency 'railties', '>= 3.2'
 
+  gem.add_development_dependency 'rails', '~> 4.2.0'
   gem.add_development_dependency 'rspec-rails', '~> 3.0'
+  gem.add_development_dependency 'rubocop', '~> 0.47'
   gem.add_development_dependency 'shoulda-matchers', '~> 2.5'
-  gem.add_development_dependency 'combustion', '~> 0.5'
 end

data/lib/letter_opener_web.rb

@@ -1,5 +1,24 @@
-require "letter_opener_web/engine"
+# frozen_string_literal: true
+
+require 'letter_opener_web/engine'
 require 'rexml/document'
 
 module LetterOpenerWeb
+  class Config
+    attr_accessor :letters_location
+  end
+
+  def self.config
+    @config ||= Config.new.tap do |conf|
+      conf.letters_location = Rails.root.join('tmp', 'letter_opener')
+    end
+  end
+
+  def self.configure
+    yield config if block_given?
+  end
+
+  def self.reset!
+    @config = nil
+  end
 end

data/lib/letter_opener_web/delivery_method.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'letter_opener/delivery_method'
 
 module LetterOpenerWeb
   class DeliveryMethod < LetterOpener::DeliveryMethod
     def deliver!(mail)
-      location = File.join(settings[:location], "#{Time.now.to_i}_#{Digest::SHA1.hexdigest(mail.encoded)[0..6]}")
-      LetterOpener::Message.rendered_messages(location, mail)
-      # Launchy.open(URI.parse(URI.escape(messages.first.filepath)))
+      ENV['LAUNCHY_DRY_RUN'] = 'true'
+      super
+      ENV['LAUNCHY_DRY_RUN'] = 'false'
     end
   end
 end

data/lib/letter_opener_web/engine.rb

@@ -1,5 +1,4 @@
-# Fix for ruby 1.8.7
-require 'active_support/core_ext/kernel/singleton_class'
+# frozen_string_literal: true
 
 require 'letter_opener'
 require 'letter_opener_web/delivery_method'
@@ -8,18 +7,24 @@ module LetterOpenerWeb
   class Engine < ::Rails::Engine
     isolate_namespace LetterOpenerWeb
 
-    initializer "letter_opener_web.add_delivery_method" do
-      ActionMailer::Base.add_delivery_method :letter_opener_web, LetterOpenerWeb::DeliveryMethod, :location => Rails.root.join("tmp", "letter_opener")
+    initializer 'letter_opener_web.add_delivery_method' do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method(
+          :letter_opener_web,
+          LetterOpenerWeb::DeliveryMethod,
+          location: LetterOpenerWeb.config.letters_location
+        )
+      end
     end
 
-    initializer "assets" do |app|
-      Rails.application.config.assets.precompile += %w(
+    initializer 'assets' do |_app|
+      Rails.application.config.assets.precompile += %w[
         letter_opener_web/application.js
         letter_opener_web/application.css
         letter_opener_web/glyphicons-halflings.png
         letter_opener_web/glyphicons-halflings-white.png
         letter_opener_web/blue-dot.ico
-      )
+      ]
     end
   end
 end

data/lib/letter_opener_web/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LetterOpenerWeb
-  VERSION = "1.3.1"
+  VERSION = '1.3.2'
 end

data/script/pre-push

@@ -0,0 +1,2 @@
+#!/bin/bash
+bundle exec rubocop -a

data/spec/controllers/letter_opener_web/letters_controller_spec.rb

@@ -1,60 +1,76 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
+require 'rails_helper'
 
 describe LetterOpenerWeb::LettersController do
+  routes { LetterOpenerWeb::Engine.routes }
+
+  after(:each) { LetterOpenerWeb.reset! }
+
   describe 'GET index' do
     before do
-      allow(LetterOpenerWeb::Letter).to receive_messages(:search => :all_letters)
+      allow(LetterOpenerWeb::Letter).to receive(:search)
       get :index
     end
-    it 'should assign all letters to @letters' do
-      expect(assigns[:letters]).to eq(:all_letters)
+
+    it 'searches for all letters' do
+      expect(LetterOpenerWeb::Letter).to have_received(:search)
+    end
+
+    it 'returns an HTML 200 response' do
+      expect(response.status).to eq(200)
+      expect(response.content_type).to eq('text/html')
     end
   end
 
   describe 'GET show' do
     let(:id)         { 'an-id' }
-    # TODO: Move these to fixture files
-    let(:rich_text)  { "rich text href=\"plain.html\"" }
-    let(:plain_text) { "plain text href=\"rich.html\"" }
-    let(:letter)     { double(:letter, :rich_text => rich_text, :plain_text => plain_text, :id => id) }
+    let(:rich_text)  { 'rich text href="plain.html"' }
+    let(:plain_text) { 'plain text href="rich.html"' }
+    let(:letter)     { double(:letter, rich_text: rich_text, plain_text: plain_text, id: id) }
+
+    shared_examples 'found letter examples' do |letter_style|
+      before(:each) do
+        expect(LetterOpenerWeb::Letter).to receive(:find).with(id).and_return(letter)
+        expect(letter).to receive(:exists?).and_return(true)
+        get :show, id: id, style: letter_style
+      end
 
-    context 'rich text version' do
-      before do
-        allow(LetterOpenerWeb::Letter).to receive_messages(:find => letter)
-        allow(letter).to receive_messages(:exists? => true)
-        get :show, :id => id, :style => 'rich'
+      it 'renders an HTML 200 response' do
+        expect(response.status).to eq(200)
+        expect(response.content_type).to eq('text/html')
       end
+    end
 
-      it "returns letter's rich text contents" do
+    context 'rich text version' do
+      include_examples 'found letter examples', 'rich'
+
+      it 'renders the rich text contents' do
         expect(response.body).to match(/^rich text/)
       end
 
       it 'fixes plain text link' do
         expect(response.body).not_to match(/href="plain.html"/)
-        expect(response.body).to match(/href="#{Regexp.escape letter_path(:id => letter.id, :style => 'plain')}"/)
+        expect(response.body).to match(/href="#{Regexp.escape letter_path(id: id, style: 'plain')}"/)
       end
     end
 
     context 'plain text version' do
-      before do
-        allow(LetterOpenerWeb::Letter).to receive_messages(:find => letter)
-        allow(letter).to receive_messages(:exists? => true)
-        get :show, :id => id, :style => 'plain'
-      end
+      include_examples 'found letter examples', 'plain'
 
-      it "returns letter's plain text contents" do
+      it 'renders the plain text contents' do
         expect(response.body).to match(/^plain text/)
       end
 
       it 'fixes rich text link' do
         expect(response.body).not_to match(/href="rich.html"/)
-        expect(response.body).to match(/href="#{Regexp.escape letter_path(:id => letter.id, :style => 'rich')}"/)
+        expect(response.body).to match(/href="#{Regexp.escape letter_path(id: id, style: 'rich')}"/)
       end
     end
 
     context 'with wrong parameters' do
       it 'should return 404 when invalid id given' do
-        get :show, :id => id, :style => 'rich'
+        get :show, id: id, style: 'rich'
         expect(response.status).to eq(404)
       end
     end
@@ -62,24 +78,26 @@ describe LetterOpenerWeb::LettersController do
 
   describe 'GET attachment' do
     let(:id)              { 'an-id' }
-    let(:attachment_path) { "path/to/attachment" }
+    let(:attachment_path) { 'path/to/attachment' }
     let(:file_name)       { 'image.jpg' }
-    let(:letter)          { double(:letter, :attachments => { file_name => attachment_path}, :id => id) }
+    let(:letter)          { double(:letter, attachments: { file_name => attachment_path }, id: id) }
 
     before do
-      allow(LetterOpenerWeb::Letter).to receive_messages(:find => letter)
-      allow(controller).to receive(:send_file) { controller.render :nothing => true }
-      allow(letter).to receive_messages(:exists? => true)
+      allow(LetterOpenerWeb::Letter).to receive(:find).with(id).and_return(letter)
+      allow(letter).to receive(:exists?).and_return(true)
     end
 
     it 'sends the file as an inline attachment' do
-      expect(controller).to receive(:send_file).with(attachment_path, :filename => file_name, :disposition => 'inline')
-      get :attachment, :id => id, :file => file_name.gsub(/\.\w+/, ''), :format => File.extname(file_name)[1..-1]
+      allow(controller).to receive(:send_file) { controller.head :ok }
+      get :attachment, id: id, file: file_name.gsub(/\.\w+/, ''), format: File.extname(file_name)[1..-1]
+
       expect(response.status).to eq(200)
+      expect(controller).to have_received(:send_file)
+        .with(attachment_path, filename: file_name, disposition: 'inline')
     end
 
     it "throws a 404 if attachment file can't be found" do
-      get :attachment, :id => id, :file => 'unknown', :format => 'woot'
+      get :attachment, id: id, file: 'unknown', format: 'woot'
       expect(response.status).to eq(404)
     end
   end
@@ -102,7 +120,7 @@ describe LetterOpenerWeb::LettersController do
     it 'removes the selected letter' do
       allow_any_instance_of(LetterOpenerWeb::Letter).to receive(:exists?).and_return(true)
       expect_any_instance_of(LetterOpenerWeb::Letter).to receive(:delete)
-      delete :destroy, :id => id
+      delete :destroy, id: id
     end
   end
 end

data/spec/dummy/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link letter_opener_web_manifest.js

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,31 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+body {
+  padding-top: 20px;
+}
+
+.alert {
+  margin-top: 20px;
+}
+
+h1, .footer {
+  text-align: center;
+}
+
+.icon-white {
+  background-image: url(<%=asset_path "letter_opener_web/glyphicons-halflings-white.png"%>);
+}

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class HomeController < ApplicationController
+  def index; end
+
+  def create
+    ContactMailer.new_message(params[:email], params[:message], params[:attachment]).deliver
+    redirect_to '/', notice: "Email sent successfully, please check letter_opener_web's inbox."
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module ApplicationHelper
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class ContactMailer < ApplicationMailer
+  default to: 'admin@letter_opener_web.org', from: 'no-reply@letter_opener_web.org'
+
+  def new_message(from, message, attachment)
+    @from    = from
+    @message = message
+
+    attachments[attachment.original_filename] = attachment.tempfile.read if attachment.present?
+
+    mail(subject: 'Testing letter_opener_web')
+  end
+end

data/spec/dummy/app/views/contact_mailer/new_message.html.erb

@@ -0,0 +1,21 @@
+<style type="text/css">
+  label                  { font-weight: bold; }
+  .from                  { color: #888; font-style: italic }
+  .message               { padding-left: 10px; }
+  .message p:first-child { margin-top: 0; }
+</style>
+
+<h1>New message!</h1>
+
+<p>
+  <label>From:</label>
+  <span class="from"><%= @from %></span>
+</p>
+
+<p>
+  <label>Message:</label>
+</p>
+
+<div class="message">
+  <%= simple_format @message %>
+</div>