maildown 2.0.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3015c6cd2855144aaa66368e064f210e38b9558f07eaeef739f4330e5d7325cb
-  data.tar.gz: 3e7ce8df93af569dad9ead634a7df86f9fcf75a5797858ab64f9485e0cbc95c7
+  metadata.gz: 26ca653dc43004e76229cd6ae163a8f67b3682cefa478b6daf03c5322e8877c1
+  data.tar.gz: e4cf385979d5adcd82a6b020065a616f936db4b7f692d81f7d90ffa908614284
 SHA512:
-  metadata.gz: fb872109df5155820dbc63005e45afef0af5db00688f5bb69210166422e9a2c1233ae7a4e7cedf63c1f000fec75cddb057be51903daa7ba2309ce94ae4045526
-  data.tar.gz: dd047ceec3b6898e5488aefe6c131ce74b6136fbac8855c03c691c83cc16e83db692539df16bb02856e7a17066b76369dc6b0050cd0dff55be9de5b8f3238169
+  metadata.gz: eab147c20f6c250e74a4f018f0a1ca0dfb568ad357ab17f7bcc1745b255e1519f1a7f6af0f97e71192d33e1a610e3fdfa7c4241c03883c6b49ce570112c48f9d
+  data.tar.gz: 3ea0e175ea11f1abb2d706aaeed2eac4f36e5b2859b141a2a5b74526caeeb5c745e98c156caf9191ab96629a8557b3580f3502c9dbd342ddbbb70d7639d6ec9b

data/lib/maildown/ext/action_mailer.rb

@@ -1,34 +1,54 @@
-require 'action_mailer'
+# frozen_string_literal: true
 
-mail_view_klass = ActionMailer::Base.view_context_class
-mail_view_klass.default_formats = (mail_view_klass.default_formats << :md)
-Mime::Type.register "text/md", :md, [], %w(md)
+require 'action_mailer'
+require 'action_mailer/base'
 
+# Monkeypatch to allow mailer to auto generate text/html
+#
+# If you generate a mailer action, by default it will only
+# render an html email:
+#
+#   def welcome
+#     mail(
+#       to:       "foo@example.com",
+#       reply_to: "noreply@schneems.com",
+#       subject:  "hello world"
+#     )
+#   end
+#
+# You can add a format block to have it produce html
+# and text emails:
+#
+#   def welcome
+#     mail(
+#       to:       "foo@example.com",
+#       reply_to: "noreply@schneems.com",
+#       subject:  "hello world"
+#     ) do |format|
+#      format.text
+#      format.html
+#    end
+#   end
+#
+# For the handler to work correctly and produce both HTML
+# and text emails this would need to be required similar to
+# how https://github.com/plataformatec/markerb works.
+#
+# This monkeypatch detects when a markdown email is being
+# used and generates both a markdown and text template
 class ActionMailer::Base
-  alias :original_collect_responses :collect_responses
-
-  def collect_responses(*args, &block)
-    responses = original_collect_responses(*args, &block)
-    md = ::Maildown::Md.new(responses)
-    if md.contains_md?
-      rendered_response = md.to_responses
+  alias :original_each_template :each_template
 
-      if Maildown.enable_layouts
-        text = rendered_response[0]
-        html = rendered_response[1]
+  def each_template(paths, name, &block)
+    templates = original_each_template(paths, name, &block)
 
-        layout_name   = _layout(text[:content_type])
-        text[:layout] = "#{layout_name}.text.erb"
-        text[:body]   = render(text)
+    return templates if templates.first.handler != Maildown::Handlers::Markdown
 
-        layout_name   = _layout(html[:content_type])
-        html[:layout] = "#{layout_name}.html.erb"
-        html[:body]   = render(html)
-      end
+    html_template = templates.first
+    text_template = html_template.dup
+    formats = html_template.formats.dup.tap { |f| f.delete(:html) }
 
-      return rendered_response
-    else
-      return responses
-    end
+    text_template.formats = formats
+    return [html_template, text_template]
   end
 end

data/lib/maildown/ext/action_view.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+# This monkeypatch allows the use of `.md.erb` file extensions
+# in addition to `.md+erb` and `.md`
+module ActionView
+  class OptimizedFileSystemResolver
+    alias :original_extract_handler_and_format_and_variant :extract_handler_and_format_and_variant
+
+    # Different versions of rails have different
+    # method signatures here, path is always first
+    def extract_handler_and_format_and_variant(*args)
+      if args.first.end_with?('md.erb')
+        path = args.shift
+        path = path.gsub(/\.md\.erb\z/, '.md+erb')
+        args.unshift(path)
+      end
+      return original_extract_handler_and_format_and_variant(*args)
+    end
+  end
+end

data/lib/maildown/handlers/markdown.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+require 'action_view'
+
+module Maildown
+  module Handlers
+    # The handler is what allows Rails to render markdown
+    #
+    # See docs/rails_template_handler.pdf for detailed tutorial on
+    # using a template handler with Rails.
+    #
+    # The TLDR; is you define a handler that responds to `call` and then
+    # you register it against an file extension with `ActionView::Template.register_template_handler`
+    #
+    # At runtime if Rails finds a template with the same file extension that was
+    # registered it will use you handler and pass the template into `call` to
+    # render the template
+    module Markdown
+      def self.erb_handler
+        @erb_handler ||= ActionView::Template.registered_template_handler(:erb)
+      end
+
+      # Expected return value is valid ruby code wrapped in a string.
+      #
+      # This handler takes care of both text and html email templates
+      # by inspectig the available `"formats"` and rendering the
+      # markdown to HTML if one of the formats is `:html`.
+      def self.call(template)
+        # Match beginning whitespace but not newline http://rubular.com/r/uCXQ58OOC8
+        template.source.gsub!(/^[^\S\n]+/, ''.freeze) if Maildown.allow_indentation
+
+        compiled_source = erb_handler.call(template)
+
+        if template.formats.include?(:html)
+          return "Maildown::MarkdownEngine.to_html(begin;#{compiled_source}; end)"
+        else
+          return "Maildown::MarkdownEngine.to_text(begin;#{compiled_source}; end)"
+        end
+      end
+    end
+  end
+end
+
+# Allows for templates like `contact.md` or `contact.md+erb` to be rendered as
+# markdown.
+ActionView::Template.register_template_handler :"md+erb", Maildown::Handlers::Markdown
+ActionView::Template.register_template_handler :"md",     Maildown::Handlers::Markdown
+
+# Used in conjunction with ext/action_view.rb monkey patch
+# to allow for using the ".md.erb" file "extension".
+#
+# Rails only considers the last part of the file extension
+# i.e the "erb" from "md.erb" to be an extension.
+#
+# The monkeypatch in `ext/action_view.rb` detects "md.erb" and converts
+# it to md+erb which is an extension with a "variant". However
+# to allow rails to even attempt to process the file, it needs this
+# handler with ".md.erb" to be registered.
+ActionView::Template.register_template_handler :"md.erb", Maildown::Handlers::Markdown
+

data/lib/maildown/markdown_engine.rb

@@ -1,5 +1,25 @@
+# frozen_string_literal: true
+
 module Maildown
+  # This module provides the API for Replacing the Markdown engine
+  #
+  # Maildown uses [kramdown](https://github.com/gettalong/kramdown) by default.
+  # Kramdown is pure ruby, so it runs the same across all ruby implementations:
+  # jruby, rubinius, MRI, etc. You can configure another parser if you like using
+  # the `Maildown::MarkdownEngine.set_html` method and pasing it a block.
+  #
+  # For example, if you wanted to use Redcarpet you could set it like this:
+  #
+  #
+  #   Maildown::MarkdownEngine.set_html do |text|
+  #     carpet = Redcarpet::Markdown.new(Redcarpet::Render::HTML, {})
+  #     carpet.render(text).html_safe
+  #   end
+  #
   module MarkdownEngine
+    @maildown_markdown_engine_html_block = nil
+    @maildown_markdown_engine_text_block = nil
+
     def self.to_html(string)
       html_block.call(string)
     end
@@ -16,17 +36,10 @@ module Maildown
       set_html(&block)
     end
 
-    class << self
-      extend Gem::Deprecate
-      deprecate :set, :set_html, 2017, 6
-    end
-
     def self.set_text(&block)
       @maildown_markdown_engine_text_block = block
     end
 
-    @maildown_markdown_engine_html_block = nil
-    @maildown_markdown_engine_text_block = nil
     def self.html_block
       @maildown_markdown_engine_html_block || default_html_block
     end

data/lib/maildown/version.rb

@@ -1,3 +1,3 @@
 module Maildown
-  VERSION = "2.0.3"
+  VERSION = "3.0.0"
 end

data/lib/maildown.rb

@@ -1,3 +1,4 @@
+# Top level module, all module methods are used for configuration
 module Maildown
   @allow_indentations = false
   @enable_layouts     = false
@@ -11,14 +12,17 @@ module Maildown
   end
 
   def self.enable_layouts
+    puts "Maildown.enable_layouts is deprecated, setting this does nothing"
     @enable_layouts
   end
 
   def self.enable_layouts=(enable_layouts)
+    puts "Maildown.enable_layouts= is deprecated, setting this does nothing"
     @enable_layouts = enable_layouts
   end
 end
 
 require 'maildown/markdown_engine'
-require 'maildown/md'
 require 'maildown/ext/action_mailer'
+require 'maildown/ext/action_view'
+require 'maildown/handlers/markdown'

data/test/dummy/app/controllers/handlers_controller.rb

@@ -0,0 +1,6 @@
+class HandlersController < ApplicationController
+
+  def show
+    render params[:id]
+  end
+end

data/test/dummy/app/mailers/user_no_layout_mailer.rb

@@ -8,4 +8,28 @@ class UserNoLayoutMailer < ApplicationMailer
       subject:  "hello world"
     )
   end
+
+  def leading_whitespace
+    mail(
+      to:       "foo@example.com",
+      reply_to: "noreply@schneems.com",
+      subject:  "hello world"
+    )
+  end
+
+  def leading_whitespace_again
+    mail(
+      to:       "foo@example.com",
+      reply_to: "noreply@schneems.com",
+      subject:  "hello world"
+    )
+  end
+
+  def contact
+    mail(
+      to:       "foo@example.com",
+      reply_to: "noreply@schneems.com",
+      subject:  "hello world"
+    )
+  end
 end

data/test/dummy/app/views/handlers/plain_markdown.html.md

@@ -0,0 +1 @@
+Hello

data/test/dummy/app/views/user_no_layout_mailer/contact.md.erb

@@ -0,0 +1 @@
+Dual templates **rock**!

data/test/dummy/app/views/user_no_layout_mailer/leading_whitespace.md+erb

@@ -0,0 +1 @@
+         ## Leading

data/test/dummy/app/views/user_no_layout_mailer/leading_whitespace_again.md+erb

@@ -0,0 +1 @@
+         ## Leading again

data/test/dummy/app/views/user_with_layout_mailer/welcome.md+erb

@@ -0,0 +1 @@
+## Welcome!

data/test/dummy/config/routes.rb

@@ -1,3 +1,3 @@
 Rails.application.routes.draw do
-
+  get "handlers/:id", to: "handlers#show"
 end