postmortem 0.2.3 → 0.3.1

data/lib/postmortem.rb

@@ -9,6 +9,7 @@ require 'erb'
 require 'json'
 require 'cgi'
 require 'digest'
+require 'securerandom'
 
 require 'postmortem/version'
 require 'postmortem/adapters'
@@ -56,7 +57,7 @@ module Postmortem
     private
 
     def log_delivery(delivery)
-      output_file.write(colorized(delivery.path.to_s) + "\n")
+      output_file.write("#{colorized(delivery.uri)}\n")
       output_file.flush
     end
 
@@ -67,7 +68,7 @@ module Postmortem
     end
 
     def output_file
-      return STDOUT if config.log_path.nil?
+      return $stdout if config.log_path.nil?
 
       @output_file ||= File.open(config.log_path, mode: 'a')
     end

data/lib/postmortem/adapters.rb

@@ -6,7 +6,7 @@ require 'postmortem/adapters/mail'
 require 'postmortem/adapters/pony'
 
 module Postmortem
-  # Adapters for various email senders (e.g. ActionMailer).
+  # Adapters for various email senders (e.g. Mail, Pony).
   module Adapters
   end
 end

data/lib/postmortem/adapters/action_mailer.rb

@@ -7,53 +7,18 @@ module Postmortem
       private
 
       def adapted
-        {
-          from: mail.from,
-          reply_to: mail.reply_to,
-          to: mail.to,
-          cc: mail.cc,
-          bcc: normalized_bcc,
-          subject: mail.subject,
-          text_body: text_part,
-          html_body: html_part
-        }
-      end
-
-      def text_part
-        return nil unless text?
-        return mail.body.decoded unless mail.text_part
-
-        mail.text_part.decoded
-      end
-
-      def html_part
-        return nil unless html?
-        return mail.body.decoded unless mail.html_part
-
-        mail.html_part.decoded
-      end
-
-      def mail
-        @mail ||= ::Mail.new(@data[:mail])
+        %i[from reply_to to cc subject message_id]
+          .map { |field| [field, mail.public_send(field)] }
+          .to_h
+          .merge({ text_body: text_part, html_body: html_part, bcc: normalized_bcc })
       end
 
       def normalized_bcc
         ::Mail.new(to: @data[:bcc]).to
       end
 
-      def text?
-        return true unless mail.has_content_type?
-        return true if mail.content_type.include?('text/plain')
-        return true if mail.multipart? && mail.text_part
-
-        false
-      end
-
-      def html?
-        return true if mail.has_content_type? && mail.content_type.include?('text/html')
-        return true if mail.multipart? && mail.html_part
-
-        false
+      def mail
+        @mail ||= ::Mail.new(@data[:mail])
       end
     end
   end

data/lib/postmortem/adapters/base.rb

@@ -2,7 +2,7 @@
 
 module Postmortem
   module Adapters
-    FIELDS = %i[from reply_to to cc bcc subject text_body html_body].freeze
+    FIELDS = %i[from reply_to to cc bcc subject text_body html_body message_id].freeze
 
     # Base interface implementation for all Postmortem adapters.
     class Base
@@ -16,7 +16,11 @@ module Postmortem
       end
 
       def serializable
-        FIELDS.map { |field| [camelize(field.to_s), public_send(field)] }.to_h
+        (%i[id] + FIELDS).map { |field| [camelize(field.to_s), public_send(field)] }.to_h
+      end
+
+      def id
+        @id ||= SecureRandom.uuid
       end
 
       FIELDS.each do |method_name|
@@ -46,6 +50,35 @@ module Postmortem
           .map { |substring, index| index.zero? ? substring : substring.capitalize }
           .join
       end
+
+      def text_part
+        return nil unless text?
+        return mail.body.decoded unless mail.text_part
+
+        mail.text_part.decoded
+      end
+
+      def html_part
+        return nil unless html?
+        return mail.body.decoded unless mail.html_part
+
+        mail.html_part.decoded
+      end
+
+      def text?
+        return true unless mail.has_content_type?
+        return true if mail.content_type.include?('text/plain')
+        return true if mail.multipart? && mail.text_part
+
+        false
+      end
+
+      def html?
+        return true if mail.has_content_type? && mail.content_type.include?('text/html')
+        return true if mail.multipart? && mail.html_part
+
+        false
+      end
     end
   end
 end

data/lib/postmortem/adapters/mail.rb

@@ -7,10 +7,10 @@ module Postmortem
       private
 
       def adapted
-        %i[from reply_to to cc bcc subject]
-          .map { |field| [field, @data.public_send(field)] }
+        %i[from reply_to to cc bcc subject message_id]
+          .map { |field| [field, mail.public_send(field)] }
           .to_h
-          .merge({ text_body: @data.text_part&.decoded, html_body: @data.html_part&.decoded })
+          .merge({ text_body: text_part, html_body: html_part })
       end
 
       def mail

data/lib/postmortem/adapters/pony.rb

@@ -8,14 +8,11 @@ module Postmortem
 
       def adapted
         {
-          from: mail.from,
-          reply_to: mail.reply_to,
-          to: mail.to,
-          cc: mail.cc,
-          bcc: mail.bcc,
+          from: mail.from, reply_to: mail.reply_to, to: mail.to, cc: mail.cc, bcc: mail.bcc,
           subject: mail.subject,
           text_body: @data[:body],
-          html_body: @data[:html_body]
+          html_body: @data[:html_body],
+          message_id: mail.message_id # We use a synthetic Mail instance so this is a bit useless.
         }
       end
 

data/lib/postmortem/delivery.rb

@@ -20,6 +20,10 @@ module Postmortem
       @identity_path.write(identity.content)
     end
 
+    def uri
+      "file://#{path}##{@mail.id}"
+    end
+
     private
 
     def index

data/lib/postmortem/index.rb

@@ -35,7 +35,7 @@ module Postmortem
     end
 
     def encoded_mail
-      Base64.encode64(mail_data.merge(id: Digest::MD5.hexdigest(mail_data.to_json)).to_json).split("\n").join
+      Base64.encode64(mail_data.to_json).split("\n").join
     end
 
     def mail_data
@@ -43,6 +43,7 @@ module Postmortem
         subject: @mail.subject || '(no subject)',
         timestamp: timestamp,
         path: @mail_path,
+        id: @mail.id,
         content: @mail.serializable
       }
     end

data/lib/postmortem/layout.rb

@@ -37,6 +37,14 @@ module Postmortem
       default_layout_directory.join('headers_template.html').read
     end
 
+    def favicon_b64
+      default_layout_directory.join('favicon.b64').read
+    end
+
+    def upload_url
+      ENV.fetch('POSTMORTEM_DELIVERY_URL', 'https://postmortem.delivery/emails')
+    end
+
     private
 
     def default_layout_directory

data/lib/postmortem/plugins/action_mailer.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
 ActiveSupport::Notifications.subscribe 'deliver.action_mailer' do |*args|
+  delivery_method = Rails.try(:application)
+                         &.try(:config)
+                         &.try(:action_mailer)
+                         &.try(:delivery_method)
+  next if delivery_method.nil?
+  next if %i[sendmail smtp].include?(delivery_method&.to_sym) # Delegate to Mail plugin.
+
   Postmortem.record_delivery(Postmortem::Adapters::ActionMailer.new(args.extract_options!))
 end

data/lib/postmortem/plugins/pony.rb

@@ -6,10 +6,14 @@ module Pony
     alias _original_mail mail
 
     def mail(options)
-      # SMTP delivery is handled by Mail plugin further down the stack
-      return _original_mail(options) if options[:via].to_s == 'smtp'
+      strategy = options[:via].to_s
+      # Pony uses the Mail gem for smtp delivery so we catch these further down the stack to
+      # avoid duplicating deliveries.
+      return _original_mail(options) if strategy == 'smtp'
 
-      result = _original_mail(options) unless Postmortem.config.mail_skip_delivery
+      # When delivery method is "test" we do not want to interfere as ActionMailer.deliveries
+      # (which delegates to Mail::TestMailer) is typically used in tests.
+      result = _original_mail(options) if strategy == 'test' || !Postmortem.config.mail_skip_delivery
       Postmortem.record_delivery(Postmortem::Adapters::Pony.new(options))
       result
     end

data/lib/postmortem/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Postmortem
-  VERSION = '0.2.3'
+  VERSION = '0.3.1'
 end

data/postmortem.gemspec

@@ -12,14 +12,14 @@ Gem::Specification.new do |spec|
   spec.description   = 'Preview HTML emails in your browser during development'
   spec.homepage      = 'https://github.com/bobf/postmortem'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
   spec.metadata['changelog_uri'] = 'https://github.com/bobf/postmortem/blob/master/README.md'
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|doc)/}) }
   end
   spec.bindir        = 'bin'
   spec.executables   = []
@@ -28,10 +28,13 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'mail', '~> 2.7'
 
   spec.add_development_dependency 'actionmailer', '~> 6.0'
+  spec.add_development_dependency 'devpack', '~> 0.3.2'
+  spec.add_development_dependency 'faker', '~> 2.17'
   spec.add_development_dependency 'pony', '~> 1.13'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rspec-its', '~> 1.3'
-  spec.add_development_dependency 'rubocop', '~> 0.88.0'
+  spec.add_development_dependency 'rubocop', '~> 1.10'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.2'
   spec.add_development_dependency 'strong_versions', '~> 0.4.5'
   spec.add_development_dependency 'timecop', '~> 0.9.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postmortem
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: devpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
 - !ruby/object:Gem::Dependency
   name: pony
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +114,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.88.0
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: strong_versions
   requirement: !ruby/object:Gem::Requirement
@@ -140,10 +182,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- doc/screenshot.png
 - layout/default.html.erb
 - layout/dependencies.css
 - layout/dependencies.js
+- layout/favicon.b64
 - layout/headers_template.html
 - layout/layout.css
 - layout/layout.js
@@ -180,7 +222,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -188,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key:
 specification_version: 4
 summary: Development HTML Email Inspection Tool