letter_opener_web 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5bbf11cbd296887063a7375ac18b4d9b42f5eac5
-  data.tar.gz: acf61512d9bce3f98624705042ab254334cb1567
+SHA256:
+  metadata.gz: 5a52b402271aaa9c2010cfd193fd3858e186328f0c13b4fafb3f449ed768eb62
+  data.tar.gz: ad574fc2698517185a7b43a3dc02a431a12edf895f6bceb7b012d0cf61923f3b
 SHA512:
-  metadata.gz: d1b1e7c448ec52d8f57514e38019067859ae0ad992f18547d52f4c4223fbc793d436bfee8b6f2dd4ca11f684ecddbab57d2150bf082ff1da80337e04c0800acc
-  data.tar.gz: 29d25a8263fc9d300029ad74fd880ab885d3f6335633821c8a697a48483f0a73665f47201fb6009aa3772f89357bada89f0199a0e4c9dbecff9932857153e37f
+  metadata.gz: a1c1eccaa4ac748e90f57069697724a9d5b9f4482f29c5e5cf1766407dc32ac85161fca9f9cce89db063b73b84b9f7ece72538eb6a78adf6f34bc02ab250a52d
+  data.tar.gz: 272edf9e6edf6912074367770a454dcc824ab1cec0eabba3b464b83eb319f744dbd6e42d0b77d5c4ef1ccc812c6df692ce8bb95d45f53b65d9e70469fb1bacb5

data/.gitignore

@@ -11,6 +11,9 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/dummy/log/
 test/tmp
 test/version_tmp
 tmp
+Gemfile.lock
+

data/.rspec

@@ -1 +1,4 @@
+--order rand
 --color
+--format progress
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+---
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - "spec/dummy/bin/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+
+# not available in older versions of Ruby
+Layout/IndentHeredoc:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -1,7 +1,24 @@
+sudo: false
 language: ruby
+
 rvm:
-  - 2.2.0
-  - 2.1.5
-  - 2.0.0
-sudo: false
+  - 2.3.3
+  - 2.2.6
+  - 2.1.10
+
 cache: bundler
+
+before_install:
+  - gem update --system
+
+notifications:
+  email: false
+
+deploy:
+  provider: rubygems
+  gem: letter_opener_web
+  api_key:
+    secure: Rv1IgeIhnfIV9NVr3iPwb2UCXe0UEtuZHfgkGruu3yvfoSGmQQ0xnc45ZhOH8ANl6tjzYNuilSDYbhz3fWOmniHsnzLGbFbccz/CWHmldUpPgVnKQ0d0Bm2EeNuVpmHwdnG7KEqMC0x1gxFYks62BGpx4C/2Kh5nWbvvPxN8X0U=
+  on:
+    tags: true
+    repo: fgrehm/letter_opener_web

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.3.2](https://github.com/fgrehm/letter_opener_web/compare/v1.3.1...v1.3.2) (Jan 14, 2018)
+
+  - Disable Launchy with ENV to avoid redefining the whole delivery method [#73](https://github.com/fgrehm/letter_opener_web/pull/73)
+  - Fix new Rubocop warnings [#72](https://github.com/fgrehm/letter_opener_web/pull/72)
+  - Hover state fixed to only highlight `tbody>tr` [#70](https://github.com/fgrehm/letter_opener_web/pull/70)
+  - Use `ActiveSupport.on_load` to make sure we don't have load order issues [#66](https://github.com/fgrehm/letter_opener_web/pull/66)
+
 ## [1.3.1](https://github.com/fgrehm/letter_opener_web/compare/v1.3.0...v1.3.1) (Feb 04, 2017)
 
   - Remove warnings about unused variables [#45](https://github.com/fgrehm/letter_opener_web/pull/45)

data/Gemfile

@@ -1,12 +1,8 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
 
 # Declare your gem's dependencies in letter_opener_web.gemspec.
 # Bundler will treat runtime dependencies like base dependencies, and
 # development dependencies will be added by default to the :development group.
 gemspec
-
-group :development do
-  gem 'rb-inotify'
-  gem 'guard'
-  gem 'guard-rspec'
-end

data/README.md

@@ -1,6 +1,6 @@
 # letter_opener_web
 
-[![Build Status](https://travis-ci.org/fgrehm/letter_opener_web.png?branch=master)](https://travis-ci.org/fgrehm/letter_opener_web) [![Gem Version](https://badge.fury.io/rb/letter_opener_web.png)](http://badge.fury.io/rb/letter_opener_web) [![Code Climate](https://codeclimate.com/github/fgrehm/letter_opener_web.png)](https://codeclimate.com/github/fgrehm/letter_opener_web) [![Gittip](http://img.shields.io/gittip/fgrehm.svg)](https://www.gittip.com/fgrehm/) [![Gitter chat](https://badges.gitter.im/fgrehm/letter_opener_web.png)](https://gitter.im/fgrehm/letter_opener_web)
+[![Build Status](https://travis-ci.org/fgrehm/letter_opener_web.png?branch=master)](https://travis-ci.org/fgrehm/letter_opener_web) [![Gem Version](https://badge.fury.io/rb/letter_opener_web.png)](http://badge.fury.io/rb/letter_opener_web) [![Code Climate](https://codeclimate.com/github/fgrehm/letter_opener_web.png)](https://codeclimate.com/github/fgrehm/letter_opener_web) [![Gitter chat](https://badges.gitter.im/fgrehm/letter_opener_web.png)](https://gitter.im/fgrehm/letter_opener_web)
 
 Gives [letter_opener](https://github.com/ryanb/letter_opener) an interface for
 browsing sent emails.
@@ -12,7 +12,9 @@ Check out http://letter-opener-web.herokuapp.com to see it in action.
 First add the gem to your development environment and run the `bundle` command to install it.
 
 ```ruby
-gem 'letter_opener_web', '~> 1.2.0', :group => :development
+group :development do
+  gem 'letter_opener_web'
+end
 ```
 
 ## Usage
@@ -52,6 +54,15 @@ config.action_mailer.delivery_method = :letter_opener_web
 config.action_mailer.delivery_method = ENV['USER'] == 'vagrant' ? :letter_opener_web : :letter_opener
 ```
 
+If you're using `:letter_opener_web` as your delivery method, you can change the location of the letters by adding the
+following to an initializer (or in development.rb):
+
+```ruby
+LetterOpenerWeb.configure do |config|
+  config.letters_location = Rails.root.join('your', 'new', 'path')
+end
+```
+
 ## Usage on Heroku
 
 Some people use this gem on staging environments on Heroku and to set that up
@@ -61,7 +72,7 @@ the route for all environments on your `routes.rb`.
 In order words, your `Gemfile` will have:
 
 ```ruby
-gem 'letter_opener_web', '~> 1.2.0'
+gem 'letter_opener_web'
 ```
 
 And your `routes.rb`:
@@ -85,7 +96,7 @@ ideas on [this pull request](https://github.com/ryanb/letter_opener/pull/12).
 
 ## Contributing
 
-1. Fork it
+1. Fork it and run `bin/setup`
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,39 +1,10 @@
 #!/usr/bin/env rake
-
-desc 'Print out all defined routes in match order, with names. Target specific controller with CONTROLLER=x.'
-task :routes do
-  require 'combustion'
-  Bundler.require :default, :development
-
-  Combustion.initialize! :action_controller, :action_view, :sprockets, :action_mailer
-
-  all_routes = LetterOpenerWeb::Engine.routes.routes
-
-  require 'rails/application/route_inspector'
-  inspector = Rails::Application::RouteInspector.new
-  puts inspector.format(all_routes, ENV['CONTROLLER']).join "\n"
-end
-
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'LetterOpenerWeb'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+# frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-  task :default => :spec
-rescue LoadError; end
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+task default: %i[spec rubocop]

data/app/assets/javascripts/letter_opener_web/application.js

@@ -10,7 +10,7 @@ jQuery(function($) {
   var favicon = new Favcount($('link[rel="icon"]').attr('href'));
   update_favicon(favicon);
 
-  $('.letter-opener').on('click', 'tr', function() {
+  $('.letter-opener').on('click', 'tbody > tr', function() {
     var $this = $(this);
     $('iframe').attr('src', $this.find('a').attr('href'));
     $this.parent().find('.active').removeClass('active');

data/app/controllers/letter_opener_web/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LetterOpenerWeb
   class ApplicationController < ActionController::Base
   end

data/app/controllers/letter_opener_web/letters_controller.rb

@@ -1,55 +1,53 @@
-require_dependency "letter_opener_web/application_controller"
+# frozen_string_literal: true
 
 module LetterOpenerWeb
   class LettersController < ApplicationController
-    before_action :check_style, :only => [:show]
-    before_action :load_letter, :only => [:show, :attachment, :destroy]
+    before_action :check_style, only: [:show]
+    before_action :load_letter, only: %i[show attachment destroy]
 
     def index
       @letters = Letter.search
     end
 
     def show
-      text = @letter.send("#{params[:style]}_text").
-        gsub(/"plain\.html"/, "\"#{LetterOpenerWeb.railtie_routes_url_helpers.letter_path(:id => @letter.id, :style => 'plain')}\"").
-        gsub(/"rich\.html"/, "\"#{LetterOpenerWeb.railtie_routes_url_helpers.letter_path(:id => @letter.id, :style => 'rich')}\"")
+      text = @letter.send("#{params[:style]}_text")
+                    .gsub(/"plain\.html"/, "\"#{routes.letter_path(id: @letter.id, style: 'plain')}\"")
+                    .gsub(/"rich\.html"/, "\"#{routes.letter_path(id: @letter.id, style: 'rich')}\"")
 
-      render :html => text.html_safe
+      render html: text.html_safe
     end
 
     def attachment
-      @letter = Letter.find(params[:id])
       filename = "#{params[:file]}.#{params[:format]}"
+      file     = @letter.attachments[filename]
 
-      if file = @letter.attachments[filename]
-        send_file(file, :filename => filename, :disposition => 'inline')
-      else
-        render :plain => 'Attachment not found!', :status => 404
-      end
+      return render plain: 'Attachment not found!', status: 404 unless file.present?
+      send_file(file, filename: filename, disposition: 'inline')
     end
 
     def clear
       Letter.destroy_all
-      redirect_to LetterOpenerWeb.railtie_routes_url_helpers.letters_path
+      redirect_to routes.letters_path
     end
 
     def destroy
-      @letter = Letter.find(params[:id])
       @letter.delete
-      redirect_to LetterOpenerWeb.railtie_routes_url_helpers.letters_path
+      redirect_to routes.letters_path
     end
 
     private
 
     def check_style
-      params[:style] = 'rich' unless ['plain', 'rich'].include? params[:style]
+      params[:style] = 'rich' unless %w[plain rich].include?(params[:style])
     end
 
     def load_letter
-      if params[:id]
-        @letter = Letter.find(params[:id])
-        head :not_found unless @letter.exists?
-      end
+      @letter = Letter.find(params[:id])
+      head :not_found unless @letter.exists?
+    end
+
+    def routes
+      LetterOpenerWeb.railtie_routes_url_helpers
     end
   end
 end

data/app/models/letter_opener_web/letter.rb

@@ -1,24 +1,31 @@
+# frozen_string_literal: true
+
 module LetterOpenerWeb
   class Letter
-    cattr_accessor :letters_location do
-      Rails.root.join("tmp", "letter_opener")
+    attr_reader :id, :sent_at
+
+    def self.letters_location
+      @letters_location ||= LetterOpenerWeb.config.letters_location
     end
 
-    attr_reader :id, :sent_at
+    def self.letters_location=(directory)
+      LetterOpenerWeb.configure { |config| config.letters_location = directory }
+      @letters_location = nil
+    end
 
     def self.search
-      letters = Dir.glob("#{letters_location}/*").map do |folder|
-        new :id => File.basename(folder), :sent_at => File.mtime(folder)
+      letters = Dir.glob("#{LetterOpenerWeb.config.letters_location}/*").map do |folder|
+        new(id: File.basename(folder), sent_at: File.mtime(folder))
       end
       letters.sort_by(&:sent_at).reverse
     end
 
     def self.find(id)
-      new :id => id
+      new(id: id)
     end
 
     def self.destroy_all
-      FileUtils.rm_rf(letters_location)
+      FileUtils.rm_rf(LetterOpenerWeb.config.letters_location)
     end
 
     def initialize(params)
@@ -27,11 +34,11 @@ module LetterOpenerWeb
     end
 
     def plain_text
-      @plain_text ||= adjust_link_targets read_file(:plain)
+      @plain_text ||= adjust_link_targets(read_file(:plain))
     end
 
     def rich_text
-      @rich_text ||= adjust_link_targets read_file(:rich)
+      @rich_text ||= adjust_link_targets(read_file(:rich))
     end
 
     def to_param
@@ -39,9 +46,7 @@ module LetterOpenerWeb
     end
 
     def default_style
-      style_exists?('rich') ?
-        'rich' :
-        'plain'
+      style_exists?('rich') ? 'rich' : 'plain'
     end
 
     def attachments
@@ -51,17 +56,17 @@ module LetterOpenerWeb
     end
 
     def delete
-      FileUtils.rm_rf("#{letters_location}/#{self.id}")
+      FileUtils.rm_rf("#{LetterOpenerWeb.config.letters_location}/#{id}")
     end
 
     def exists?
-      File.exists?(base_dir)
+      File.exist?(base_dir)
     end
 
     private
 
     def base_dir
-      "#{letters_location}/#{id}"
+      "#{LetterOpenerWeb.config.letters_location}/#{id}"
     end
 
     def read_file(style)
@@ -69,7 +74,7 @@ module LetterOpenerWeb
     end
 
     def style_exists?(style)
-      File.exists?("#{base_dir}/#{style}.html")
+      File.exist?("#{base_dir}/#{style}.html")
     end
 
     def adjust_link_targets(contents)
@@ -77,14 +82,13 @@ module LetterOpenerWeb
       # "complete" (as in they have the whole <html> structure) and letter_opener
       # prepends some information about the mail being sent, making REXML
       # complain about it
-      contents.scan(/<a\s[^>]+>(?:.|\s)*?<\/a>/).each do |link|
+      contents.scan(%r{<a\s[^>]+>(?:.|\s)*?</a>}).each do |link|
         fixed_link = fix_link_html(link)
         xml        = REXML::Document.new(fixed_link).root
-        unless xml.attributes['href'] =~ /(plain|rich).html/
-          xml.attributes['target'] = '_blank'
-          xml.add_text('') unless xml.text
-          contents.gsub!(link, xml.to_s)
-        end
+        next if xml.attributes['href'] =~ /(plain|rich).html/
+        xml.attributes['target'] = '_blank'
+        xml.add_text('') unless xml.text
+        contents.gsub!(link, xml.to_s)
       end
       contents
     end
@@ -95,7 +99,7 @@ module LetterOpenerWeb
         fixed_link.gsub!('<br>', '<br/>')
         fixed_link.scan(/<img(?:[^>]+?)>/).each do |img|
           fixed_img = img.dup
-          fixed_img.gsub!(/>$/, '/>') unless img =~ /\/>$/
+          fixed_img.gsub!(/>$/, '/>') unless img =~ %r{/>$}
           fixed_link.gsub!(img, fixed_img)
         end
       end

data/app/views/layouts/letter_opener_web/{application.html.erb → letters.html.erb}

@@ -8,8 +8,6 @@
   <%= csrf_meta_tags %>
 </head>
 <body>
-
   <%= yield %>
-
 </body>
 </html>

data/app/views/letter_opener_web/letters/index.html.erb

@@ -2,17 +2,17 @@
   <h1>
     Letters
     <span class="pull-right">
-      <%= link_to letter_opener_web.letters_path, class: 'btn refresh' do %>
+      <%= link_to letters_path, class: 'btn refresh' do %>
         <i class="icon-refresh"></i>
         Refresh
       <% end %>
-      <%= link_to letter_opener_web.clear_letters_path, method: 'delete', data: { confirm: 'Are you sure?' }, class: 'btn btn-danger' do %>
+      <%= link_to clear_letters_path, method: 'delete', data: { confirm: 'Are you sure?' }, class: 'btn btn-danger' do %>
         <i class="icon-trash icon-white"></i>
         Clear
       <% end %>
     </span>
   </h1>
-  <table class="table table-hover letter-opener" data-letters-path="<%= letter_opener_web.letters_path %>">
+  <table class="table table-hover letter-opener" data-letters-path="<%= letters_path %>">
     <thead>
       <tr>
         <th>ID</th>
@@ -24,11 +24,11 @@
       <% if first_letter = @letters.shift %>
         <tr class="active">
           <td>
-            <%= link_to(first_letter.id, letter_opener_web.letter_path(first_letter, style: first_letter.default_style), target: 'mail') %>
+            <%= link_to(first_letter.id, letter_path(first_letter, style: first_letter.default_style), target: 'mail') %>
           </td>
           <td><%= first_letter.sent_at %></td>
           <td>
-            <%= link_to letter_opener_web.delete_letter_path(first_letter), method: 'delete', data: { confirm: 'Are you sure you want to delete this email?' } do %>
+            <%= link_to delete_letter_path(first_letter), method: 'delete', data: { confirm: 'Are you sure you want to delete this email?' } do %>
               <span class="pull-right">
                 <i class="icon-remove-circle" title="Delete"></i>
               </span>
@@ -39,11 +39,11 @@
       <% @letters.each do |letter| %>
         <tr>
           <td>
-            <%= link_to(letter.id, letter_opener_web.letter_path(letter, style: letter.default_style), target: 'mail') %>
+            <%= link_to(letter.id, letter_path(letter, style: letter.default_style), target: 'mail') %>
           </td>
           <td><%= letter.sent_at %></td>
           <td>
-            <%= link_to letter_opener_web.delete_letter_path(letter), :method => 'delete', data: { confirm: 'Are you sure you want to delete this email?' } do %>
+            <%= link_to delete_letter_path(letter), :method => 'delete', data: { confirm: 'Are you sure you want to delete this email?' } do %>
               <span class="pull-right">
                 <i class="icon-remove-circle"></i>
               </span>
@@ -55,5 +55,5 @@
   </table>
 </div>
 <div class="col right">
-  <iframe name="mail" id="mail" src="<%= first_letter.present? ? letter_opener_web.letter_path(first_letter, style: first_letter.default_style) : 'about:blank' %>"></iframe>
+  <iframe name="mail" id="mail" src="<%= first_letter.present? ? letter_path(first_letter, style: first_letter.default_style) : 'about:blank' %>"></iframe>
 </div>