markdown-rails 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b38453e5c369cffc57667a7b5fa7ae44f5ff1b3627f85c5968348f1f7b86604
-  data.tar.gz: 8f890184a209ed11e929f0f65cdef966f3c7fcbabec8924ff06d195a567b6c3c
+  metadata.gz: e552ca56be38b384f153880f11a5edb336f61b12e1e85448278b7e2f81723767
+  data.tar.gz: 9bbd303fb44492ffd820e0894144b51e387db88ed35197c3c4c76902a352118c
 SHA512:
-  metadata.gz: e84a055e1b3ff490bbbb701983e664e0ff2496e8039e531020cee7290b1447665b9476a0eea510538dd71a5a13fd06a61f0e2dc3a3c312bdccd6e53aaa5a9c26
-  data.tar.gz: 82f67fb1eed9c4358e7ad507b15fa2881daf0571e49615bb08d37c205e6be704a67751c0b28abb9c4151842751d16f3843317eb59c67c00828fa74173e49f530
+  metadata.gz: 78566da895833c13a2e604ad9462d98be9e9c710a8cef12435be8e765204da9a5404a93a51824155b804de743646d54193fb9fd1af208ef986a3c9121dc9f5aa
+  data.tar.gz: 017a386e646f20a08364d75827b956d8a12b933b360ff86e4105180e92ee5cb4ca58ed05a14ae6db5b8569568ce2dad300558ffab866aa81df986d154b0a9091

data/README.md

@@ -68,12 +68,10 @@ end
 
 Only enable Erb in Markdown if you trust the source of the file. Do not enable it for markdown provided by users or they will be able to execute arbitrary Ruby code.
 
-To enable Erb, you can tell Rails to render all view files ending with `.markerb` using the `MarkdownRails::Handler::Erb` handler.
-
 ```ruby
 # ./config/initializers/markdown.rb
-MarkdownRails.handle :markerb, with: MarkdownRails::Handler::Erb do
-  ApplicationMarkdown.new
+MarkdownRails.handle :markerb do
+  ErbMarkdown.new
 end
 ```
 
@@ -88,11 +86,13 @@ MarkdownRails.handle :md do
   ApplicationMarkdown.new
 end
 
-MarkdownRails.handle :markerb, with: MarkdownRails::Handler::Erb do
-  ApplicationMarkdown.new
+MarkdownRails.handle :markerb do
+  ErbMarkdown.new
 end
 ```
 
+The same technique can be used for preprocessing Markdown with other handlers, like liquid.
+
 ## Customizing renderer
 
 You might want to customize your Markdown handler to do things like syntax code highlighting, etc.

data/lib/generators/markdown_rails/install/templates/app/markdown/application_markdown.rb

@@ -6,7 +6,7 @@ class ApplicationMarkdown < MarkdownRails::Renderer::Rails
   # and feel smarter. Read the docs at https://github.com/vmg/redcarpet#also-now-our-pants-are-much-smarter
   include Redcarpet::Render::SmartyPants
 
-  # Uncomment and run `bundle add rouge` for syntax highlighting
+  # Run `bundle add rouge` and uncomment the include below for syntax highlighting
   # include MarkdownRails::Helper::Rouge
 
   # If you need access to ActionController::Base.helpers, you can delegate by uncommenting
@@ -28,16 +28,6 @@ class ApplicationMarkdown < MarkdownRails::Renderer::Rails
     [:fenced_code_blocks]
   end
 
-  # These methods are called as the Markdown document is parsed. Block-level calls are
-  # documented at https://github.com/vmg/redcarpet#block-level-calls and span level calls
-  # are documented at https://github.com/vmg/redcarpet#block-level-calls so feel free to
-  # add more as you see fit.
-  def block_code(code, language)
-    content_tag :pre, class: language do
-      code # You could implement syntax highlighting here with Rouge.
-    end
-  end
-
   # Example of how you might override the images to show embeds, like a YouTube video.
   def image(link, title, alt)
     url = URI(link)

data/lib/generators/markdown_rails/install/templates/app/markdown/erb_markdown.rb

@@ -0,0 +1,11 @@
+# DANGER! This parses Erb, which means arbitrary Ruby can be run. Make sure
+# you trust the source of your markdown and that its not user input.
+
+class ErbMarkdown < ApplicationMarkdown
+  # Enables Erb to render for the entire doc before the markdown is rendered.
+  # This works great, except when you have an `erb` code fence.
+  def preprocess(html)
+    # Read more about this render call at https://guides.rubyonrails.org/layouts_and_rendering.html
+    render inline: html, handler: :erb
+  end
+end

data/lib/generators/markdown_rails/install/templates/config/initializers/markdown.rb

@@ -8,6 +8,6 @@ end
 # Don't use Erb for untrusted markdown content created by users; otherwise they
 # can execute arbitrary code on your server. This should only be used for input you
 # trust, like content files from your code repo.
-MarkdownRails.handle :markerb, with: MarkdownRails::Handler::Erb do
-  ApplicationMarkdown.new
+MarkdownRails.handle :markerb do
+  ErbMarkdown.new
 end

data/lib/markdown-rails/engine.rb

@@ -4,7 +4,7 @@ module MarkdownRails
     # config/initializer files are processed. This makes the `:md`
     # extension work if the user forgot to install the initializers.
     config.before_initialize do
-      MarkdownRails::Handler::Markdown.register_default_handler
+      MarkdownRails::Handler.register_default
     end
   end
 end

data/lib/markdown-rails/handler.rb

@@ -0,0 +1,43 @@
+module MarkdownRails
+  # We cannot use MarkdownRails because it conflicts with RDiscount's Markdown class
+  class Handler
+    DEFAULT_EXTENSION = :md
+
+    def initialize(&block)
+      @markdown = block
+    end
+
+    def call(template, source = template.source)
+      renderer.render(source).inspect + '.html_safe'
+    end
+
+    def self.handle(*extensions, &block)
+      Array(extensions).each do |extension|
+        handler = new &block
+        ActionView::Template.register_template_handler extension, handler
+      end
+    end
+
+    # Registers a default `.md` handler for Rails templates. This might be
+    # replaced by a handler in the `config/initializers/markdown.rb` file.
+    def self.register_default
+      handle(DEFAULT_EXTENSION) { MarkdownRails::Renderer::Rails.new }
+    end
+
+    private
+
+    def markdown
+      @cache = nil unless cache_enabled?
+      @cache ||= @markdown.call
+    end
+
+    def renderer
+      @renderer = nil unless cache_enabled?
+      @renderer ||= markdown.renderer
+    end
+
+    def cache_enabled?
+      ::Rails.configuration.cache_classes
+    end
+  end
+end

data/lib/markdown-rails/version.rb

@@ -1,3 +1,3 @@
 module MarkdownRails
-  VERSION = "2.0.2"
+  VERSION = "2.1.0"
 end

data/lib/markdown-rails.rb

@@ -2,14 +2,11 @@ require "markdown-rails/version"
 require "markdown-rails/engine"
 
 module MarkdownRails
-  def self.handle(*extensions, with: Handler::Markdown, &block)
-    with.handle *extensions, &block
+  def self.handle(*extensions, &block)
+    Handler.handle(*extensions, &block)
   end
 
-  module Handler
-    autoload :Markdown,   "markdown-rails/handler/markdown"
-    autoload :Erb,        "markdown-rails/handler/erb"
-  end
+  autoload :Handler,   "markdown-rails/handler"
 
   module Renderer
     autoload :Base,       "markdown-rails/renderer/base"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-12 00:00:00.000000000 Z
+date: 2023-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -81,11 +81,11 @@ files:
 - lib/generators/markdown_rails/install/USAGE
 - lib/generators/markdown_rails/install/install_generator.rb
 - lib/generators/markdown_rails/install/templates/app/markdown/application_markdown.rb
+- lib/generators/markdown_rails/install/templates/app/markdown/erb_markdown.rb
 - lib/generators/markdown_rails/install/templates/config/initializers/markdown.rb
 - lib/markdown-rails.rb
 - lib/markdown-rails/engine.rb
-- lib/markdown-rails/handler/erb.rb
-- lib/markdown-rails/handler/markdown.rb
+- lib/markdown-rails/handler.rb
 - lib/markdown-rails/helper/rouge.rb
 - lib/markdown-rails/railtie.rb
 - lib/markdown-rails/renderer/base.rb

data/lib/markdown-rails/handler/erb.rb

@@ -1,22 +0,0 @@
-module MarkdownRails
-  module Handler
-    class Erb < Markdown
-      def call(template, source = template.source)
-        compiled_source = compile_erb template, source
-        # TODO: This won't properly handle initializer blocks. Somehow
-        # I need to pass a reference to the block that's passed in.
-        "#{markdown.class.name}.new.renderer.render(begin;#{compiled_source};end).html_safe"
-      end
-
-      private
-
-      def compile_erb(template, source)
-        erb.call(template, source)
-      end
-
-      def erb
-        ActionView::Template.registered_template_handler(:erb)
-      end
-    end
-  end
-end

data/lib/markdown-rails/handler/markdown.rb

@@ -1,45 +0,0 @@
-module MarkdownRails
-  module Handler
-    # We cannot use MarkdownRails because it conflicts with RDiscount's Markdown class
-    class Markdown
-      DEFAULT_EXTENSION = :md
-
-      def initialize(&block)
-        @markdown = block
-      end
-
-      def call(template, source = template.source)
-        renderer.render(source).inspect + '.html_safe'
-      end
-
-      def self.handle(*extensions, &block)
-        Array(extensions).each do |extension|
-          handler = new &block
-          ActionView::Template.register_template_handler extension, handler
-        end
-      end
-
-      # Registers a default `.md` handler for Rails templates. This might be
-      # replaced by a handler in the `config/initializers/markdown.rb` file.
-      def self.register_default_handler
-        handle(DEFAULT_EXTENSION) { MarkdownRails::Renderer::Rails.new }
-      end
-
-      private
-
-      def markdown
-        @cache = nil unless cache_enabled?
-        @cache ||= @markdown.call
-      end
-
-      def renderer
-        @renderer = nil unless cache_enabled?
-        @renderer ||= markdown.renderer
-      end
-
-      def cache_enabled?
-        ::Rails.configuration.cache_classes
-      end
-    end
-  end
-end