postmortem 0.2.0 → 0.2.6

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|
@@ -25,6 +29,14 @@ module Postmortem
         end
       end
 
+      def html_body
+        @adapted[:html_body].to_s
+      end
+
+      def text_body
+        @adapted[:text_body].to_s
+      end
+
       private
 
       def adapted
@@ -38,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, html_body: @data.html_part })
+          .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/configuration.rb

@@ -3,17 +3,9 @@
 module Postmortem
   # Provides interface for configuring Postmortem and implements sensible defaults.
   class Configuration
-    attr_writer :colorize, :timestamp, :mail_skip_delivery, :token
+    attr_writer :colorize, :mail_skip_delivery
     attr_accessor :log_path
 
-    def timestamp
-      defined?(@timestamp) ? @timestamp : true
-    end
-
-    def token
-      defined?(@token) ? @token : true
-    end
-
     def colorize
       defined?(@colorize) ? @colorize : true
     end

data/lib/postmortem/delivery.rb

@@ -7,33 +7,27 @@ module Postmortem
 
     def initialize(mail)
       @mail = mail
-      @path = Postmortem.config.preview_directory.join(filename)
-      @index_path = Postmortem.config.preview_directory.join('index.html')
+      @path = Postmortem.config.preview_directory.join('index.html')
+      @index_path = Postmortem.config.preview_directory.join('postmortem_index.html')
+      @identity_path = Postmortem.config.preview_directory.join('postmortem_identity.html')
     end
 
     def record
       path.parent.mkpath
       content = Layout.new(@mail).content
       path.write(content)
-      index_path.write(Index.new(index_path, path, timestamp, @mail).content)
+      index_path.write(index.content)
+      @identity_path.write(identity.content)
     end
 
     private
 
-    def filename
-      format = '%Y-%m-%d_%H-%M-%S'
-      timestamp_chunk = Postmortem.config.timestamp ? "#{timestamp.strftime(format)}__" : nil
-      token_chunk = Postmortem.config.token ? "#{token}__" : nil
-
-      "#{timestamp_chunk}#{token_chunk}#{safe_subject}.html"
-    end
-
-    def timestamp
-      @timestamp ||= Time.now
+    def index
+      @index ||= Index.new(index_path, path, @mail)
     end
 
-    def token
-      SecureRandom.hex(4)
+    def identity
+      @identity ||= Identity.new
     end
 
     def subject

data/lib/postmortem/identity.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Postmortem
+  # Provides an HTML document that announces a unique ID to a parent page via JS message events.
+  class Identity
+    def content
+      ERB.new(File.read(path), nil, '-').result(binding)
+    end
+
+    private
+
+    def uuid
+      @uuid ||= SecureRandom.uuid
+    end
+
+    def path
+      File.expand_path(File.join(__dir__, '..', '..', 'layout', 'postmortem_identity.html.erb'))
+    end
+  end
+end

data/lib/postmortem/index.rb

@@ -3,10 +3,9 @@
 module Postmortem
   # Generates and parses an index of previously-sent emails.
   class Index
-    def initialize(index_path, mail_path, timestamp, mail)
+    def initialize(index_path, mail_path, mail)
       @index_path = index_path
       @mail_path = mail_path
-      @timestamp = timestamp.iso8601
       @mail = mail
     end
 
@@ -15,23 +14,36 @@ module Postmortem
       ERB.new(File.read(template_path), nil, '-').result(binding)
     end
 
+    def size
+      encoded_index.size
+    end
+
     private
 
+    def uuid
+      @uuid ||= SecureRandom.uuid
+    end
+
+    def timestamp
+      Time.now.iso8601
+    end
+
     def encoded_index
       return [encoded_mail] unless @index_path.file?
 
-      [encoded_mail] + lines[index(:start)..index(:end)]
+      @encoded_index ||= [encoded_mail] + lines[index(:start)..index(:end)]
     end
 
     def encoded_mail
-      Base64.urlsafe_encode64(mail_data.to_json)
+      Base64.encode64(mail_data.to_json).split("\n").join
     end
 
     def mail_data
       {
         subject: @mail.subject || '(no subject)',
-        timestamp: @timestamp,
+        timestamp: timestamp,
         path: @mail_path,
+        id: @mail.id,
         content: @mail.serializable
       }
     end
@@ -50,7 +62,7 @@ module Postmortem
     end
 
     def template_path
-      File.expand_path(File.join(__dir__, '..', '..', 'layout', 'index.html.erb'))
+      File.expand_path(File.join(__dir__, '..', '..', 'layout', 'postmortem_index.html.erb'))
     end
   end
 end

data/lib/postmortem/layout.rb

@@ -25,10 +25,22 @@ module Postmortem
       default_layout_directory.join('layout.js').read
     end
 
+    def css_dependencies
+      default_layout_directory.join('dependencies.css').read
+    end
+
+    def javascript_dependencies
+      default_layout_directory.join('dependencies.js').read
+    end
+
     def headers_template
       default_layout_directory.join('headers_template.html').read
     end
 
+    def favicon_b64
+      default_layout_directory.join('favicon.b64').read
+    end
+
     private
 
     def default_layout_directory
@@ -38,7 +50,7 @@ module Postmortem
     def with_inlined_images(body)
       parsed = Nokogiri::HTML.parse(body)
       parsed.css('img').each do |img|
-        uri = URI(img['src'])
+        uri = try_uri(img['src'])
         next unless local_file?(uri)
 
         path = located_image(uri)
@@ -48,6 +60,7 @@ module Postmortem
     end
 
     def local_file?(uri)
+      return false if uri.nil?
       return true if uri.host.nil?
       return true if /^www\.example\.[a-z]+$/.match(uri.host)
       return true if %w[127.0.0.1 localhost].include?(uri.host)
@@ -55,6 +68,12 @@ module Postmortem
       false
     end
 
+    def try_uri(uri)
+      URI(uri)
+    rescue URI::InvalidURIError
+      nil
+    end
+
     def located_image(uri)
       path = uri.path.partition('/').last
       common_locations.each do |location|

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Postmortem
-  VERSION = '0.2.0'
+  VERSION = '0.2.6'
 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.0
+  version: 0.2.6
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-10 00:00:00.000000000 Z
+date: 2021-03-16 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,12 +182,15 @@ 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/index.html.erb
 - layout/layout.css
 - layout/layout.js
+- layout/postmortem_identity.html.erb
+- layout/postmortem_index.html.erb
 - lib/postmortem.rb
 - lib/postmortem/adapters.rb
 - lib/postmortem/adapters/action_mailer.rb
@@ -154,6 +199,7 @@ files:
 - lib/postmortem/adapters/pony.rb
 - lib/postmortem/configuration.rb
 - lib/postmortem/delivery.rb
+- lib/postmortem/identity.rb
 - lib/postmortem/index.rb
 - lib/postmortem/layout.rb
 - lib/postmortem/plugins/action_mailer.rb
@@ -176,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:
   - - ">="
@@ -184,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