letter_opener 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ef387f446fe58d7fbe039333d493cc644dbb388323e098f2b4a0a48dfad93ac
-  data.tar.gz: 3d6da1bcc7fa1d575e00d361677e36a73dfd26ea331416cfbb31c14cdd8f87ac
+  metadata.gz: 3b5ce93130e74aeaf3c51e330b1cdeb039fe8161d40a832792af5da3bbc46d4d
+  data.tar.gz: 01bfe8f9f88f2a1f5db6f68c3a28d829bb7984b586e5a3e4bec0e471e7b54371
 SHA512:
-  metadata.gz: 62fc742943f4904086cfdddcd0908c7bb67fd602530e340852eb213644bce32e664e6da00058767fd80cfc8f13735e757e2d4fa32cb4459be74df8bdf7348030
-  data.tar.gz: 827cb033ed7805de3399f2c32427e69190a15420314d2f4ad6b4f3856a8209d6cbf0b0d5701ea6e47dd996fd919ef5e9185389df3b151ce24b3ad67a693492a6
+  metadata.gz: 32e5d64b76e25905b511eaa939aa56cbeb0f1741005912ed8f7b35d89eef03b86ece4e9bab5cc8f859ae7bdbaa8ce9ec99483b1dee9d4bf566d42496b8452de4
+  data.tar.gz: 3df336bcbab473c8f15c15dee759d78f57403b1fb1026e2aa82cfd1cf40e0bcd3648506007484a104263e222c6ac97945a0ce8768b0e3cd920ca00031ff1863d

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-## master ##
+## 1.8.0 ##
+ * Allow configuration of the 'file///' part in Launchy.open path (thanks [
+Regis Millet](https://github.com/Kulgar))
+ * Enhance 'tmp:clear' task to delete 'tmp/letter_opener' files (thanks [Joaquín Vicente](https://github.com/wacko))
+ * Convert mail's subject to UTF-8. (thanks [kuroponzu](https://github.com/kuroponzu))
+ * Use proper attachment's filename sanitization so we don't escape Japanese characters.
+
+## 1.7.0 ##
  * Use default configuration in `Message::rendered_messages` (thanks [Krystan HuffMenne
 ](https://github.com/gitKrystan))
  * Do not use `Rails.root` path if LetterOpener is used outside of Rails (thanks [centrevillage](https://github.com/centrevillage))
@@ -80,4 +87,4 @@
 
 ## 0.0.1 ##
 
-  * Initial relase
+  * Initial release

data/Gemfile

@@ -1,4 +1,10 @@
 source "https://rubygems.org"
 gemspec
 
+if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.1")
+  gem "net-imap", require: false
+  gem "net-pop", require: false
+  gem "net-smtp", require: false
+end
+
 gem "rake"

data/README.md

@@ -0,0 +1,100 @@
+# Letter Opener [![Ruby](https://github.com/ryanb/letter_opener/actions/workflows/ruby.yml/badge.svg)](https://github.com/ryanb/letter_opener/actions/workflows/ruby.yml)
+
+Preview email in the default browser instead of sending it. This means you do not need to set up email delivery in your development environment, and you no longer need to worry about accidentally sending a test email to someone else's address.
+
+## Rails Setup
+
+First add the gem to your development environment and run the `bundle` command to install it.
+
+```rb
+gem "letter_opener", group: :development
+```
+
+Then set the delivery method in `config/environments/development.rb`
+
+```rb
+config.action_mailer.delivery_method = :letter_opener
+config.action_mailer.perform_deliveries = true
+```
+
+Now any email will pop up in your browser instead of being sent. The messages are stored in `tmp/letter_opener`.
+If you want to change application that will be used to open your emails you should override `LAUNCHY_APPLICATION` environment variable or set `Launchy.application` in the initializer.
+
+### Configuration
+
+```rb
+LetterOpener.configure do |config|
+  # To overrider the location for message storage.
+  # Default value is `tmp/letter_opener`
+  config.location = Rails.root.join('tmp', 'my_mails')
+
+  # To render only the message body, without any metadata or extra containers or styling.
+  # Default value is `:default` that renders styled message with showing useful metadata.
+  config.message_template = :light
+
+  # To change default file URI scheme you can provide `file_uri_scheme` config.
+  # It might be useful when you use WSL (Windows Subsystem for Linux) and default
+  # scheme doesn't work for you.
+  # Default value is blank
+  config.file_uri_scheme = 'file://///wsl$/Ubuntu-18.04'
+end
+```
+
+### For Rails 2.3.x support
+
+There is a fork that add support for Rails 2.3.x, in order to use that or just check it out you should go to https://github.com/cavi21/letter_opener
+
+## Non Rails Setup
+
+If you aren't using Rails, this can be easily set up with the Mail gem. Just set the delivery method when configuring Mail and specify a location.
+
+```rb
+require "letter_opener"
+Mail.defaults do
+  delivery_method LetterOpener::DeliveryMethod, location: File.expand_path('../tmp/letter_opener', __FILE__)
+end
+```
+
+The method is similar if you're using the Pony gem:
+
+```rb
+require "letter_opener"
+Pony.options = {
+  via: LetterOpener::DeliveryMethod,
+  via_options: {location: File.expand_path('../tmp/letter_opener', __FILE__)}
+}
+```
+
+Alternatively, if you are using ActionMailer directly (without Rails) you will need to add the delivery method.
+
+```rb
+require "letter_opener"
+ActionMailer::Base.add_delivery_method :letter_opener, LetterOpener::DeliveryMethod, :location => File.expand_path('../tmp/letter_opener', __FILE__)
+ActionMailer::Base.delivery_method = :letter_opener
+```
+
+## Remote Alternatives
+
+Letter Opener uses [Launchy](https://github.com/copiousfreetime/launchy) to open sent mail in the browser. This assumes the Ruby process is running on the local development machine. If you are using a separate staging server or VM this will not work. In that case consider using [Mailtrap](http://mailtrap.io/) or [MailCatcher](http://mailcatcher.me/).
+
+If you are running your application within a Docker Container or VM and do not have a browser available to open emails received by Letter Opener, you may see the following error:
+
+```
+WARN: Launchy::CommandNotFoundError: Unable to find a browser command. If this is unexpected, Please rerun with environment variable LAUNCHY_DEBUG=true or the '-d' commandline option and file a bug at https://github.com/copiousfreetime/launchy/issues/new
+```
+
+To resolve this, simply set the following ENV variables:
+
+```
+LAUNCHY_DRY_RUN=true
+BROWSER=/dev/null
+```
+
+In order to keep this project simple, I don't have plans to turn it into a Rails engine with an interface for browsing the sent mail but there is a [gem you can use for that](https://github.com/fgrehm/letter_opener_web).
+
+
+## Development & Feedback
+
+Questions or problems? Please use the [issue tracker](https://github.com/ryanb/letter_opener/issues). If you would like to contribute to this project, fork this repository and run `bundle` and `rake` to run the tests. Pull requests appreciated.
+
+Special thanks to the [mail_view](https://github.com/37signals/mail_view/) gem for inspiring this project and for their mail template. Also thanks to [Vasiliy Ermolovich](https://github.com/nashby) for helping manage this project.

data/lib/letter_opener/configuration.rb

@@ -1,10 +1,11 @@
 module LetterOpener
   class Configuration
-    attr_accessor :location, :message_template
+    attr_accessor :location, :message_template, :file_uri_scheme
 
     def initialize
-      @location = Rails.root.join('tmp', 'letter_opener') if defined?(Rails) && Rails.respond_to?(:root)
+      @location = Rails.root.join('tmp', 'letter_opener') if defined?(Rails) && Rails.respond_to?(:root) && Rails.root
       @message_template = 'default'
+      @file_uri_scheme = nil
     end
   end
 end

data/lib/letter_opener/delivery_method.rb

@@ -10,6 +10,7 @@ module LetterOpener
     def initialize(options = {})
       options[:message_template] ||= LetterOpener.configuration.message_template
       options[:location] ||= LetterOpener.configuration.location
+      options[:file_uri_scheme] ||= LetterOpener.configuration.file_uri_scheme
 
       raise InvalidOption, "A location option is required when using the Letter Opener delivery method" if options[:location].nil?
 
@@ -21,7 +22,7 @@ module LetterOpener
       location = File.join(settings[:location], "#{Time.now.to_f.to_s.tr('.', '_')}_#{Digest::SHA1.hexdigest(mail.encoded)[0..6]}")
 
       messages = Message.rendered_messages(mail, location: location, message_template: settings[:message_template])
-      Launchy.open("file:///#{messages.first.filepath}")
+      ::Launchy.open("#{settings[:file_uri_scheme]}#{messages.first.filepath}")
     end
 
     private

data/lib/letter_opener/message.rb

@@ -2,6 +2,7 @@ require "cgi"
 require "erb"
 require "fileutils"
 require "uri"
+require "kconv"
 
 module LetterOpener
   class Message
@@ -43,7 +44,7 @@ module LetterOpener
             File.open(path, 'wb') { |f| f.write(attachment.body.raw_source) }
           end
 
-          @attachments << [attachment.filename, "attachments/#{CGI.escape(filename)}"]
+          @attachments << [attachment.filename, "attachments/#{filename}"]
         end
       end
 
@@ -84,6 +85,10 @@ module LetterOpener
       @sender ||= Array(@mail['sender']).join(", ")
     end
 
+    def subject
+      @subject ||= @mail.subject.toutf8
+    end
+
     def to
       @to ||= Array(@mail['to']).join(", ")
     end
@@ -119,7 +124,10 @@ module LetterOpener
     end
 
     def attachment_filename(attachment)
-      attachment.filename.gsub(/[^\w\-.]/, '_')
+      # Copied from https://github.com/rails/rails/blob/6bfc637659248df5d6719a86d2981b52662d9b50/activestorage/app/models/active_storage/filename.rb#L57
+      attachment.filename.encode(
+        Encoding::UTF_8, invalid: :replace, undef: :replace, replace: "�").strip.tr("\u{202E}%$|:;/\t\r\n\\", "-"
+      )
     end
 
     def <=>(other)

data/lib/letter_opener/railtie.rb

@@ -8,5 +8,9 @@ module LetterOpener
         )
       end
     end
+
+    rake_tasks do
+      load 'letter_opener/tasks/letter_opener.rake'
+    end
   end
 end

data/lib/letter_opener/tasks/letter_opener.rake

@@ -0,0 +1,9 @@
+require 'rails/tasks'
+
+namespace :tmp do
+  task :letter_opener do
+    rm_rf Dir["tmp/letter_opener/[^.]*"], verbose: false
+  end
+end
+
+Rake::Task['tmp:clear'].enhance(['tmp:letter_opener'])

data/spec/letter_opener/delivery_method_spec.rb

@@ -1,7 +1,8 @@
 require "spec_helper"
 
 describe LetterOpener::DeliveryMethod do
-  let(:location)   { File.expand_path('../../../tmp/letter_opener', __FILE__) }
+  let(:location)        { File.expand_path('../../../tmp/letter_opener', __FILE__) }
+  let(:file_uri_scheme) { nil }
 
   let(:plain_file) { Dir["#{location}/*/plain.html"].first }
   let(:plain)      { CGI.unescape_html(File.read(plain_file)) }
@@ -12,7 +13,7 @@ describe LetterOpener::DeliveryMethod do
     context = self
 
     Mail.defaults do
-      delivery_method LetterOpener::DeliveryMethod, :location => context.location
+      delivery_method LetterOpener::DeliveryMethod, location: context.location, file_uri_scheme: context.file_uri_scheme
     end
   end
 
@@ -282,19 +283,18 @@ describe LetterOpener::DeliveryMethod do
     end
 
     it 'creates attachments dir with attachment' do
-      attachment = Dir["#{location}/*/attachments/non_word_chars_used_01-02.txt"].first
+      attachment = Dir["#{location}/*/attachments/non word-chars-used,01-02.txt"].first
       expect(File.exist?(attachment)).to be_truthy
     end
 
     it 'saves attachment name' do
       plain = File.read(Dir["#{location}/*/plain.html"].first)
-      expect(plain).to include('non_word_chars_used_01-02.txt')
+      expect(plain).to include('non word-chars-used,01-02.txt')
     end
 
     it 'replaces inline attachment names' do
       text = File.read(Dir["#{location}/*/rich.html"].first)
-      expect(text).to_not include('attachments/non word:chars/used,01-02.txt')
-      expect(text).to include('attachments/non_word_chars_used_01-02.txt')
+      expect(text).to include('attachments/non word-chars-used,01-02.txt')
     end
   end
 
@@ -373,4 +373,44 @@ describe LetterOpener::DeliveryMethod do
       expect(File.exist?(plain_file)).to be_truthy
     end
   end
+
+  context 'specifying custom file_uri_scheme configuration option' do
+    after do
+      Mail.defaults do
+        delivery_method LetterOpener::DeliveryMethod, location: File.expand_path('../../../tmp/letter_opener', __FILE__)
+      end
+
+      Mail.deliver do
+        subject  'Foo subject'
+        from     'Foo foo@example.com'
+        reply_to 'No Reply no-reply@example.com'
+        to       'Bar bar@example.com'
+        body     'World! http://example.com'
+      end
+
+      LetterOpener.configure do |config|
+        config.file_uri_scheme = file_uri_scheme
+      end
+    end
+
+    context 'file_uri_scheme is not set in configuration' do
+      it "sends the path to Launchy with the 'file://' prefix by default" do
+        allow(Launchy).to receive(:open) do |path|
+          expect(path).not_to match(/^file:\/\//)
+        end
+      end
+    end
+
+    context 'file_uri_scheme is set in configuration' do
+      it "sends the path to Launchy with the 'file://///wsl$/Ubuntu-18.04' prefix" do
+        allow(Launchy).to receive(:open) do |path|
+          expect(path).to match(/^file:\/\/\/\/\/wsl\$\/Ubuntu-18.04/)
+        end
+
+        LetterOpener.configure do |config|
+          config.file_uri_scheme = 'file://///wsl$/Ubuntu-18.04'
+        end
+      end
+    end
+  end
 end

data/spec/letter_opener/message_spec.rb

@@ -35,6 +35,20 @@ describe LetterOpener::Message do
 
   end
 
+  describe '#subject' do
+    it 'handles UTF-8 charset subject' do
+      mail = mail(:subject => 'test_mail')
+      message = described_class.new(mail, location: location)
+      expect(message.subject).to eq('test_mail')
+    end
+
+    it 'handles encode ISO-2022-JP charset subject' do
+      mail = mail(:subject => '=?iso-2022-jp?B?GyRCJUYlOSVIJWEhPCVrGyhC?=')
+      message = described_class.new(mail, location: location)
+      expect(message.subject).to eq('テストメール')
+    end
+  end
+
   describe '#to' do
     it 'handles one email as a string' do
       mail   = mail(:to => 'test@example.com')

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: letter_opener
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Ryan Bates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-10 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -62,22 +68,28 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/letter_opener.rb
 - lib/letter_opener/configuration.rb
 - lib/letter_opener/delivery_method.rb
 - lib/letter_opener/message.rb
 - lib/letter_opener/railtie.rb
+- lib/letter_opener/tasks/letter_opener.rake
 - lib/letter_opener/templates/default.html.erb
 - lib/letter_opener/templates/light.html.erb
 - spec/letter_opener/delivery_method_spec.rb
 - spec/letter_opener/message_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/ryanb/letter_opener
+homepage: https://github.com/ryanb/letter_opener
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/ryanb/letter_opener/issues
+  changelog_uri: https://github.com/ryanb/letter_opener/blob/master/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/letter_opener/
+  homepage_uri: https://github.com/ryanb/letter_opener
+  source_code_uri: https://github.com/ryanb/letter_opener/
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -93,8 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.4
 requirements: []
-rubyforge_project: letter_opener
-rubygems_version: 2.7.8
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Preview mail in browser instead of sending.

data/README.rdoc

@@ -1,71 +0,0 @@
-= Letter Opener {<img src="https://secure.travis-ci.org/ryanb/letter_opener.png" />}[http://travis-ci.org/ryanb/letter_opener]
-
-Preview email in the default browser instead of sending it. This means you do not need to set up email delivery in your development environment, and you no longer need to worry about accidentally sending a test email to someone else's address.
-
-
-== Rails Setup
-
-First add the gem to your development environment and run the +bundle+ command to install it.
-
-  gem "letter_opener", :group => :development
-
-Then set the delivery method in <tt>config/environments/development.rb</tt>
-
-  config.action_mailer.delivery_method = :letter_opener
-  config.action_mailer.perform_deliveries = true
-
-Now any email will pop up in your browser instead of being sent. The messages are stored in <tt>tmp/letter_opener</tt>.
-If you want to change application that will be used to open your emails you should override <tt>LAUNCHY_APPLICATION</tt> environment variable or set <tt>Launchy.application</tt> in the initializer.
-
-==== Configuration
-
-  LetterOpener.configure do |config|
-    # To overrider the location for message storage.
-    # Default value is <tt>tmp/letter_opener</tt>
-    config.location = Rails.root.join('tmp', 'my_mails')
-
-    # To render only the message body, without any metadata or extra containers or styling.
-    # Default value is <tt>:default</tt> that renders styled message with showing useful metadata.
-    config.message_template = :light
-  end
-
-==== For Rails 2.3.x support
-
-There is a fork that add support for Rails 2.3.x, in order to use that or just check it out you should go to https://github.com/cavi21/letter_opener
-
-== Non Rails Setup
-
-If you aren't using Rails, this can be easily set up with the Mail gem. Just set the delivery method when configuring Mail and specify a location.
-
-  require "letter_opener"
-  Mail.defaults do
-    delivery_method LetterOpener::DeliveryMethod, :location => File.expand_path('../tmp/letter_opener', __FILE__)
-  end
-
-The method is similar if you're using the Pony gem:
-
-  require "letter_opener"
-  Pony.options = {
-    :via => LetterOpener::DeliveryMethod,
-    :via_options => {:location => File.expand_path('../tmp/letter_opener', __FILE__)}
-  }
-
-Alternatively, if you are using ActionMailer directly (without Rails) you will need to add the delivery method.
-
-  require "letter_opener"
-  ActionMailer::Base.add_delivery_method :letter_opener, LetterOpener::DeliveryMethod, :location => File.expand_path('../tmp/letter_opener', __FILE__)
-  ActionMailer::Base.delivery_method = :letter_opener
-
-
-== Remote Alternatives
-
-Letter Opener uses {Launchy}[https://github.com/copiousfreetime/launchy] to open sent mail in the browser. This assumes the Ruby process is running on the local development machine. If you are using a separate staging server or VM this will not work. In that case consider using {Mailtrap}[http://mailtrap.io/] or {MailCatcher}[http://mailcatcher.me/].
-
-In order to keep this project simple, I don't have plans to turn it into a Rails engine with an interface for browsing the sent mail but there is a {gem you can use for that}[https://github.com/fgrehm/letter_opener_web].
-
-
-== Development & Feedback
-
-Questions or problems? Please use the {issue tracker}[https://github.com/ryanb/letter_opener/issues]. If you would like to contribute to this project, fork this repository and run +bundle+ and +rake+ to run the tests. Pull requests appreciated.
-
-Special thanks to the {mail_view}[https://github.com/37signals/mail_view/] gem for inspiring this project and for their mail template. Also thanks to {Vasiliy Ermolovich}[https://github.com/nashby] for helping manage this project.