markdown-rails 2.0.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b38453e5c369cffc57667a7b5fa7ae44f5ff1b3627f85c5968348f1f7b86604
-  data.tar.gz: 8f890184a209ed11e929f0f65cdef966f3c7fcbabec8924ff06d195a567b6c3c
+  metadata.gz: 2cce6aedcf3e854a5907729d8ef780db22f9c69a20e92dd34603a4dcbfb6e699
+  data.tar.gz: 13374d49447c0d025e5d17a84f927c9027b7031c8a0c938ba3e64a44e179c66d
 SHA512:
-  metadata.gz: e84a055e1b3ff490bbbb701983e664e0ff2496e8039e531020cee7290b1447665b9476a0eea510538dd71a5a13fd06a61f0e2dc3a3c312bdccd6e53aaa5a9c26
-  data.tar.gz: 82f67fb1eed9c4358e7ad507b15fa2881daf0571e49615bb08d37c205e6be704a67751c0b28abb9c4151842751d16f3843317eb59c67c00828fa74173e49f530
+  metadata.gz: eaf381f89c5d0105ef005a3008e71fac4ae726c5bc137f02c8a4e6b291ca95f491a018ee008248ada11af0842f2ae0efefa3b561ed061c1ab2450dfc5b4b1cea
+  data.tar.gz: 7d2e28141e71907f81a0fed9efca8b673708c9031adfdd19b94ed59823f51cd350687018ed74091085ebb949a736fa40fc8e3edc9c9103461ac434653d712f82

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/Rakefile

@@ -1,5 +1,7 @@
 require "bundler/setup"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-load "rails/tasks/statistics.rake"
+RSpec::Core::RakeTask.new(:spec)
 
-require "bundler/gem_tasks"
+task default: :spec

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

@@ -6,20 +6,21 @@ 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
-  # and adding to the list below. Several are already included for you in the `MarkdownRails::Renderer::Rails`,
-  # but you can add more here.
+  # The renderer has access to the view_context, which provides access to:
+  # - View helpers (image_tag, link_to, content_tag, etc.)
+  # - Asset helpers (image_path, image_url, asset_path, etc.)
+  # - URL helpers (root_path, user_path, etc.)
   #
-  # To see a list of methods available run `bin/rails runner "puts ActionController::Base.helpers.public_methods.sort"`
+  # Many common helpers are already delegated. You can add more by uncommenting
+  # and extending the delegate list in your subclass:
   #
   # delegate \
-  #   :request,
-  #   :cache,
-  #   :turbo_frame_tag,
-  # to: :helpers
+  #   :current_user,
+  #   :some_custom_helper,
+  # to: :view_context
 
   # These flags control features in the Redcarpet renderer, which you can read
   # about at https://github.com/vmg/redcarpet#and-its-like-really-simple-to-use
@@ -28,16 +29,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
-end
+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,47 @@
+module MarkdownRails
+  # We cannot use MarkdownRails because it conflicts with RDiscount's Markdown class
+  class Handler
+    DEFAULT_EXTENSION = :md
+    @@handlers = {}
+
+    def initialize(extension, &block)
+      @extension = extension
+      @markdown = block
+      @@handlers[@extension] = self
+    end
+
+    def call(template, source = template.source)
+      # Generate code that fetches the handler and calls the block at render time
+      extension = @extension
+      <<~RUBY
+        begin
+          handler = MarkdownRails::Handler.handler_for(#{extension.inspect})
+          renderer = handler.create_renderer
+          renderer.view_context = self
+          renderer.renderer.render(#{source.inspect}).html_safe
+        end
+      RUBY
+    end
+
+    def create_renderer
+      @markdown.call
+    end
+
+    def self.handler_for(extension)
+      @@handlers[extension]
+    end
+
+    def self.handle(*extensions, &block)
+      Array(extensions).each do |extension|
+        handler = new(extension, &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
+  end
+end

data/lib/markdown-rails/renderer/base.rb

@@ -16,7 +16,9 @@ module MarkdownRails
       end
 
       def renderer
-        ::Redcarpet::Markdown.new(self.class, **features)
+        # I can get away passing fatures into this class because they don't
+        # overlap and RedCarpet is happy accepting both.
+        ::Redcarpet::Markdown.new(self.class.new(**features), **features)
       end
 
       private

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

@@ -3,15 +3,31 @@ module MarkdownRails
     class Rails < Base
       include ::Rails.application.routes.url_helpers
 
-      # Rendering from Markdown is actually outside of the view
-      # context, so we need to delegate render to the ApplicationController
-      # render method that can render outside of the view context.
-      delegate \
-        :helpers,
-        :render,
-      to: :base_controller
+      attr_accessor :view_context
+
+      def initialize(**options)
+        super(**options)
+      end
+
+      def image(link, title, alt)
+        image_tag link, title: title, alt: alt
+      end
 
+      def view_context
+        @view_context ||= self.class.default_view_context
+      end
+
+      # Delegate view helpers to view_context since they need view state.
+      # The view_context has all helpers properly configured with @output_buffer, etc.
+      # For custom helpers, access them via view_context:
+      #   view_context.my_custom_helper
+      # Or delegate them explicitly in your subclass:
+      #   delegate :my_custom_helper, to: :view_context
       delegate \
+        :render,
+        :link_to,
+        :button_to,
+        :mail_to,
         :asset_digest_path,
         :asset_path,
         :asset_url,
@@ -26,21 +42,32 @@ module MarkdownRails
         :video_path,
         :video_tag,
         :video_url,
+        :javascript_include_tag,
+        :stylesheet_link_tag,
         :tag,
         :content_tag,
         :request,
         :turbo_frame_tag,
         :controller,
         :raw,
-      to: :helpers
+        :safe_join,
+        :capture,
+      to: :view_context
 
-      def image(link, title, alt)
-        image_tag link, title: title, alt: alt
+      def renderer
+        # Override Base#renderer to pass view_context to the new instance
+        new_instance = self.class.new(**features)
+        new_instance.view_context = view_context
+        ::Redcarpet::Markdown.new(new_instance, **features)
+      end
+
+      def self.default_view_context
+        ::ApplicationController.new.view_context
       end
 
-      protected
-        def base_controller
-          ::ApplicationController
+      private
+        def features
+          Hash[Array(enable).map{ |feature| [ feature, true ] }]
         end
     end
   end

data/lib/markdown-rails/version.rb

@@ -1,3 +1,3 @@
 module MarkdownRails
-  VERSION = "2.0.2"
+  VERSION = "2.2.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,13 @@
 --- !ruby/object:Gem::Specification
 name: markdown-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Brad Gessler
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-12 00:00:00.000000000 Z
+date: 2025-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -66,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: Markdown Rails is a comprehensive stack for rendering Markdown templates
   and partials in Rails.
 email:
@@ -81,11 +94,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
@@ -100,7 +113,6 @@ metadata:
   homepage_uri: https://github.com/sitepress/markdown-rails
   source_code_uri: https://github.com/sitepress/markdown-rails
   changelog_uri: https://github.com/sitepress/markdown-rails
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,8 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Markdown templates and partials in Rails.
 test_files: []

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