markdown-rails 2.0.0.alpha10 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 322bc825210d3a2bfc37e22665366325be25e77e438adb4b81fd3fb671151433
-  data.tar.gz: bd95381cdc14695bd1dbde902ad85d3b1724c91c4f04b41932f45bfcba0ea227
+  metadata.gz: 9b123f6a0e803b1c36b5c6aac4080054d45a1171b70cab5449e7df9d579f288c
+  data.tar.gz: b01e3956dd4b35a4d84043401daaf6c3be3a95ccda735226c6b5880d0e85ed08
 SHA512:
-  metadata.gz: 9c4c978ffdd52d865fc73c9636f51eef60ce84d902eaa9727100d52bfa4f831b67b842cbc05489e43c424dee36a6ff8efc8bdda6642fc72bf29313bbe1a54e67
-  data.tar.gz: ed00ba127ec4e455c7c492be6ffe50d1a87bdcc3a60fba6378fd85e821bce9d6a9ab79733177ccfd06186050825fc491bdfee91b357d311672681571ab9e766e
+  metadata.gz: bdd18e0d15ac48fb3c20a787aeac027b999d9b83b79e7dde76ea82b87dd0fc2d1de11ac6e150528b48ddab8f9c5026d2f843052acf1ec5be1bad8bf76391dc27
+  data.tar.gz: 0eee23b19609af6466ccc7fcd58bbacb9c4aeac5cf4d24b31b4682cc2bfee6ca3e5c433054140319b4c7457886e97b25498b634078ae1aa99b2bafc6a630e74e

data/README.md

@@ -1,8 +1,5 @@
 # markdown-rails
 
-> **Note**
-> **Everything below is implemented in 2.0.0.alpha.** . You can start using this by adding to `gem "markdown-rails", version: "2.0.0.alpha"` to your Gemfile or by looking at it being used in the https://github.com/bradgessler/view-playground repo.
-
 This gem allows you to write static Rails views and partials using the [Markdown](http://daringfireball.net/projects/markdown/syntax) syntax. No more editing prose in HTML!
 
 It is a comprehensive Markdown library for Rails that addresses the following pain points:
@@ -58,29 +55,45 @@ Applications commonly need various markdown variants within one application. For
 # Restart the server to see changes made to this file.
 
 # Setup markdown stacks to work with different template handler in Rails.
-MarkdownRails.handle :md, :markdown, with: :ApplicationMarkdown
-MarkdownRails.handle :smd, with: :SafeMarkdown
+MarkdownRails.handle :md do
+  ApplicationMarkdown.new
+end
+
+MarkdownRails.handle :crazymd do
+  MyCrazyMarkdown.new
+end
 ```
 
 ### Enable Erb in Markdown
 
 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 `ErbMarkdown` handler.
+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
+end
+```
+
+You *could* change `:markerb` to `:md`, but I don't recommend it for all Markdown files or you'll run into problems if you have content like `<%= Time.current %>` inside of an `erb` codefence. You're better off having two configurations: one that handles Erb and another that doesn't, like this:
 
 ```ruby
 # ./config/initializers/markdown.rb
 # Restart the server to see changes made to this file.
 
 # Setup markdown stacks to work with different template handler in Rails.
-MarkdownRails.handle :md, :markdown, with: :ApplicationMarkdown
-# This is a bad idea for a few reasons, but sometimes its needed
-MarkdownRails.handle :markerb, with: :ErbMarkdown
-```
+MarkdownRails.handle :md do
+  ApplicationMarkdown.new
+end
 
-You *could* change `:markerb` to `:md`, but I don't recommend it for all Markdown files or you'll run into problems if you have content like `<%= Time.current %>` inside of an `erb` codefence. You're better off having two configurations: one that handles Erb and another that doesn't.
+MarkdownRails.handle :markerb, with: MarkdownRails::Handler::Erb do
+  ApplicationMarkdown.new
+end
+```
 
-## Customizing Markdown
+## 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

@@ -9,7 +9,7 @@ class ApplicationMarkdown < MarkdownRails::Renderer::Rails
   # Uncomment and run `bundle add rouge` for syntax highlighting
   # include MarkdownRails::Helper::Rouge
 
-  # If you need access to methods from the view context, you can delegate by uncommenting
+  # 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.
   #
@@ -19,7 +19,7 @@ class ApplicationMarkdown < MarkdownRails::Renderer::Rails
   #   :request,
   #   :cache,
   #   :turbo_frame_tag,
-  # to: :view
+  # to: :helpers
 
   # 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

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

@@ -1,12 +1,13 @@
 # Restart the server to see changes made to this file.
 
 # Setup markdown stacks to work with different template handler in Rails.
-MarkdownRails.handle :md, :markdown,
-  with: :ApplicationMarkdown
+MarkdownRails.handle :md, :markdown do
+  ApplicationMarkdown.new
+end
 
-# Ideally you can modify `ApplicationMarkdown` to suit your needs without
-# needing ERB, but for some reason enabling ERB with markdown is insanely
-# popular, so here it is if that's your jam.
-
-# MarkdownRails.handle :markerb,
-#   with: :ErbMarkdown
+# 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

data/lib/markdown-rails/engine.rb

@@ -1,4 +1,10 @@
 module MarkdownRails
   class Engine < ::Rails::Engine
+    # Check if the `.md` extension has been registered after the
+    # 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
+    end
   end
 end

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

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,45 @@
+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

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

@@ -15,8 +15,8 @@ module MarkdownRails
         ]
       end
 
-      def markdown_renderer
-        @markdown_renderer ||= ::Redcarpet::Markdown.new(self, **features)
+      def renderer
+        ::Redcarpet::Markdown.new(self.class, **features)
       end
 
       private

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

@@ -3,18 +3,14 @@ module MarkdownRails
     class Rails < Base
       include ::Rails.application.routes.url_helpers
 
-      def initialize(view:, **extensions)
-        super(extensions)
-        @view = view
-      end
-
-      # The Rails render sets the view, which we can use to delegate everything
-      # to from the renderer.
-      attr_reader :view
-
       # 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
+
       delegate \
         :asset_digest_path,
         :asset_path,
@@ -36,13 +32,16 @@ module MarkdownRails
         :turbo_frame_tag,
         :controller,
         :raw,
-        :request,
-        :controller,
-      to: :view
+      to: :helpers
 
       def image(link, title, alt)
         image_tag link, title: title, alt: alt
       end
+
+      protected
+        def base_controller
+          ::ApplicationController
+        end
     end
   end
 end

data/lib/markdown-rails/version.rb

@@ -1,3 +1,3 @@
 module MarkdownRails
-  VERSION = "2.0.0.alpha10"
+  VERSION = "2.0.1"
 end

data/lib/markdown-rails.rb

@@ -2,22 +2,21 @@ require "markdown-rails/version"
 require "markdown-rails/engine"
 
 module MarkdownRails
-  def self.handle(*extensions, with:)
-    handler = TemplateHandler.new(with)
-
-    extensions.each do |extension|
-      ActionView::Template.register_template_handler extension, handler
-    end
+  def self.handle(*extensions, with: Handler::Markdown, &block)
+    with.handle *extensions, &block
   end
 
-  autoload :TemplateHandler,  "markdown-rails/template_handler"
+  module Handler
+    autoload :Markdown,   "markdown-rails/handler/markdown"
+    autoload :Erb,        "markdown-rails/handler/erb"
+  end
 
   module Renderer
-    autoload :Base,           "markdown-rails/renderer/base"
-    autoload :Rails,          "markdown-rails/renderer/rails"
+    autoload :Base,       "markdown-rails/renderer/base"
+    autoload :Rails,      "markdown-rails/renderer/rails"
   end
 
   module Helper
-    autoload :Rouge,          "markdown-rails/helper/rouge"
+    autoload :Rouge,      "markdown-rails/helper/rouge"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha10
+  version: 2.0.1
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2023-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,15 +53,15 @@ 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/helper/rouge.rb
 - lib/markdown-rails/railtie.rb
 - lib/markdown-rails/renderer/base.rb
 - lib/markdown-rails/renderer/rails.rb
-- lib/markdown-rails/template_handler.rb
 - lib/markdown-rails/version.rb
 - lib/tasks/markdown/rails_tasks.rake
 homepage: https://github.com/sitepress/markdown-rails
@@ -83,11 +83,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Markdown templates and partials in Rails.

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

@@ -1,10 +0,0 @@
-# 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)
-    view.render inline: html, handler: :erb
-  end
-end

data/lib/markdown-rails/template_handler.rb

@@ -1,15 +0,0 @@
-module MarkdownRails
-  # We cannot use MarkdownRails because it conflicts with RDiscount's Markdown class
-  class TemplateHandler
-    def initialize(klass)
-      @markdown = klass
-    end
-
-    def call(template, source = template.source)
-      %[
-        markdown = #{@markdown.name}.new(view: self);
-        markdown.markdown_renderer.render(#{source.inspect}).html_safe;
-      ]
-    end
-  end
-end