RubyGems - postmortem - Versions diffs - 0.1.2 → 0.2.4 - Mend

postmortem 0.1.2 → 0.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

checksums.yaml +4 -4
data/.gitignore +2 -0
data/.rubocop.yml +4 -46
data/.ruby-version +1 -0
data/Gemfile +0 -2
data/README.md +20 -16
data/doc/screenshot.png +0 -0
data/layout/default.html.erb +68 -254
data/layout/dependencies.css +11 -0
data/layout/dependencies.js +14 -0
data/layout/favicon.b64 +1 -0
data/layout/headers_template.html +35 -0
data/layout/layout.css +254 -0
data/layout/layout.js +381 -0
data/layout/postmortem_identity.html.erb +20 -0
data/layout/postmortem_index.html.erb +25 -0
data/lib/postmortem.rb +14 -2
data/lib/postmortem/adapters.rb +1 -1
data/lib/postmortem/adapters/base.rb +31 -1
data/lib/postmortem/adapters/mail.rb +3 -3
data/lib/postmortem/adapters/pony.rb +3 -6
data/lib/postmortem/configuration.rb +1 -5
data/lib/postmortem/delivery.rb +20 -13
data/lib/postmortem/identity.rb +20 -0
data/lib/postmortem/index.rb +68 -0
data/lib/postmortem/layout.rb +86 -3
data/lib/postmortem/plugins/action_mailer.rb +7 -0
data/lib/postmortem/version.rb +1 -1
data/postmortem.gemspec +4 -2
metadata +46 -6

data/layout/postmortem_identity.html.erb ADDED Viewed

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+<body>
+<div data-uuid="<%= uuid %>" id="identity">
+</div>
+<script>
+  window.addEventListener('message', function (ev) {
+    const identity = document.querySelector('#identity');
+    const uuid = identity.dataset.uuid;
+    const type = 'identity';
+    ev.source.postMessage({ uuid, type }, '*');
+  });
+  setInterval(function () {
+    window.location.reload();
+  }, 3000);
+</script>
+</body>
+</html>

data/layout/postmortem_index.html.erb ADDED Viewed

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<body>
+<div data-uuid="<%= uuid %>" id="index">
+### INDEX START
+<% encoded_index.each do |encoded| -%>
+<%= encoded %>
+<% end -%>
+### INDEX END
+</div>
+<script>
+  window.addEventListener('message', function (ev) {
+    const filter = (line) => line !== '' && !line.startsWith('### INDEX');
+    const index = document.querySelector('#index');
+    const uuid = index.dataset.uuid;
+    const type = 'index';
+    const mails = index.innerText
+                       .split('\n')
+                       .filter(filter)
+                       .map(line => JSON.parse(atob(line)));
+    ev.source.postMessage({ uuid, type, mails }, '*');
+  });
+</script>
+</body>
+</html>

data/lib/postmortem.rb CHANGED Viewed

@@ -8,12 +8,16 @@ require 'mail'
 require 'erb'
 require 'json'
 require 'cgi'
+require 'digest'
+require 'securerandom'
 require 'postmortem/version'
 require 'postmortem/adapters'
 require 'postmortem/delivery'
 require 'postmortem/layout'
 require 'postmortem/configuration'
+require 'postmortem/identity'
+require 'postmortem/index'
 # HTML email inspection tool.
 module Postmortem
@@ -22,6 +26,10 @@ module Postmortem
   class << self
     attr_reader :config
+    def root
+      Pathname.new(__dir__).parent
+    end
     def record_delivery(mail)
       Delivery.new(mail)
               .tap(&:record)
@@ -42,10 +50,14 @@ module Postmortem
       yield @config if block_given?
     end
+    def clear_inbox
+      config.preview_directory.rmtree
+    end
     private
     def log_delivery(delivery)
-      output_file.write(colorized(delivery.path.to_s) + "\n")
+      output_file.write("#{colorized(delivery.path.to_s)}\n")
       output_file.flush
     end
@@ -56,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 CHANGED Viewed

@@ -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/base.rb CHANGED Viewed

@@ -2,6 +2,8 @@
 module Postmortem
   module Adapters
+    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
       def initialize(data)
@@ -9,17 +11,45 @@ module Postmortem
         @adapted = adapted
       end
-      %i[from reply_to to cc bcc subject text_body html_body].each do |method_name|
+      def html_body=(val)
+        @adapted[:html_body] = val
+      end
+      def serializable
+        (%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|
         define_method method_name do
           @adapted[method_name]
         end
       end
+      def html_body
+        @adapted[:html_body].to_s
+      end
+      def text_body
+        @adapted[:text_body].to_s
+      end
       private
       def adapted
         raise NotImplementedError, 'Adapter child class must implement #adapted'
       end
+      def camelize(string)
+        string
+          .split('_')
+          .each_with_index
+          .map { |substring, index| index.zero? ? substring : substring.capitalize }
+          .join
+      end
     end
   end
 end

data/lib/postmortem/adapters/mail.rb CHANGED Viewed

@@ -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: mail.text_part&.decoded, html_body: mail.html_part&.decoded })
       end
       def mail

data/lib/postmortem/adapters/pony.rb CHANGED Viewed

@@ -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 CHANGED Viewed

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

data/lib/postmortem/delivery.rb CHANGED Viewed

@@ -3,34 +3,41 @@
 module Postmortem
   # Abstraction of an email delivery. Capable of writing email HTML body to disk.
   class Delivery
-    attr_reader :path
+    attr_reader :path, :index_path
-    def initialize(adapter)
-      @adapter = adapter
-      @path = Postmortem.config.preview_directory.join(filename)
+    def initialize(mail)
+      @mail = mail
+      @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
-      File.write(path, Layout.new(@adapter).content)
+      content = Layout.new(@mail).content
+      path.write(content)
+      index_path.write(index.content)
+      @identity_path.write(identity.content)
     end
     private
-    def filename
-      return "#{safe_subject}.html" unless Postmortem.config.timestamp
+    def index
+      @index ||= Index.new(index_path, path, @mail)
+    end
-      "#{timestamp}__#{safe_subject}.html"
+    def identity
+      @identity ||= Identity.new
     end
-    def timestamp
-      Time.now.strftime('%Y-%m-%d_%H-%M-%S')
+    def subject
+      return 'no-subject' if @mail.subject.nil? || @mail.subject.empty?
+      @mail.subject
     end
     def safe_subject
-      return 'no-subject' if @adapter.subject.nil? || @adapter.subject.empty?
-      @adapter.subject.tr(' ', '_').split('').select { |char| safe_chars.include?(char) }.join
+      subject.tr(' ', '_').split('').select { |char| safe_chars.include?(char) }.join
     end
     def safe_chars

data/lib/postmortem/identity.rb ADDED Viewed

@@ -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 ADDED Viewed

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+module Postmortem
+  # Generates and parses an index of previously-sent emails.
+  class Index
+    def initialize(index_path, mail_path, mail)
+      @index_path = index_path
+      @mail_path = mail_path
+      @mail = mail
+    end
+    def content
+      mail_path = @mail_path
+      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_index ||= [encoded_mail] + lines[index(:start)..index(:end)]
+    end
+    def encoded_mail
+      Base64.encode64(mail_data.to_json).split("\n").join
+    end
+    def mail_data
+      {
+        subject: @mail.subject || '(no subject)',
+        timestamp: timestamp,
+        path: @mail_path,
+        id: @mail.id,
+        content: @mail.serializable
+      }
+    end
+    def lines
+      @lines ||= @index_path.read.split("\n")
+    end
+    def index(position)
+      offset = { start: 1, end: -1 }.fetch(position)
+      lines.index(marker(position)) + offset
+    end
+    def marker(position)
+      "### INDEX #{position.to_s.upcase}"
+    end
+    def template_path
+      File.expand_path(File.join(__dir__, '..', '..', 'layout', 'postmortem_index.html.erb'))
+    end
+  end
+end

data/lib/postmortem/layout.rb CHANGED Viewed

@@ -3,8 +3,8 @@
 module Postmortem
   # Wraps provided body in an enclosing layout for presentation purposes.
   class Layout
-    def initialize(adapter)
-      @adapter = adapter
+    def initialize(mail)
+      @mail = mail
     end
     def format_email_array(array)
@@ -12,8 +12,91 @@ module Postmortem
     end
     def content
-      mail = @adapter
+      mail = @mail
+      mail.html_body = with_inlined_images(mail.html_body) if defined?(Nokogiri)
       ERB.new(Postmortem.config.layout.read).result(binding)
     end
+    def styles
+      default_layout_directory.join('layout.css').read
+    end
+    def javascript
+      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
+      Postmortem.root.join('layout')
+    end
+    def with_inlined_images(body)
+      parsed = Nokogiri::HTML.parse(body)
+      parsed.css('img').each do |img|
+        uri = try_uri(img['src'])
+        next unless local_file?(uri)
+        path = located_image(uri)
+        img['src'] = encoded_image(path) unless path.nil?
+      end
+      parsed.to_s
+    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)
+      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|
+        full_path = location.join(path)
+        next unless full_path.file?
+        return full_path
+      end
+      nil
+    end
+    def encoded_image(path)
+      "data:#{mime_type(path)};base64,#{Base64.encode64(path.read)}"
+    end
+    def common_locations
+      ['public/assets', 'app/assets/images'].map { |path| Pathname.new(path) }
+    end
+    def mime_type(path)
+      extension = path.extname.partition('.').last
+      extension == 'jpg' ? 'jpeg' : extension
+    end
   end
 end