markdown_views 2.4.0 → 3.0.0

data/app/assets/stylesheets/rouge.thankful_eyes.css

@@ -12,14 +12,13 @@
   color: #a8e1fe;
   font-weight: bold;
 }
-.rouge-highlight .c, .rouge-highlight .cd, .rouge-highlight .cm, .rouge-highlight .c1, .rouge-highlight .cs {
+.rouge-highlight .c, .rouge-highlight .ch, .rouge-highlight .cd, .rouge-highlight .cm, .rouge-highlight .cpf, .rouge-highlight .c1, .rouge-highlight .cs {
   color: #6c8b9f;
   font-style: italic;
 }
 .rouge-highlight .cp {
   color: #b2fd6d;
   font-weight: bold;
-  font-style: italic;
 }
 .rouge-highlight .err {
   color: #fefeec;
@@ -50,6 +49,10 @@
 .rouge-highlight .ge {
   font-style: italic;
 }
+.rouge-highlight .ges {
+  font-weight: bold;
+  font-style: italic;
+}
 .rouge-highlight .gs {
   font-weight: bold;
 }
@@ -117,7 +120,7 @@
   color: #ffb000;
   font-weight: bold;
 }
-.rouge-highlight .m, .rouge-highlight .mf, .rouge-highlight .mh, .rouge-highlight .mi, .rouge-highlight .il, .rouge-highlight .mo, .rouge-highlight .mb, .rouge-highlight .mx {
+.rouge-highlight .m, .rouge-highlight .mb, .rouge-highlight .mf, .rouge-highlight .mh, .rouge-highlight .mi, .rouge-highlight .il, .rouge-highlight .mo, .rouge-highlight .mx {
   color: #f696db;
   font-weight: bold;
 }
@@ -129,10 +132,14 @@
   color: #f696db;
   font-weight: bold;
 }
-.rouge-highlight .s, .rouge-highlight .sb, .rouge-highlight .sd, .rouge-highlight .s2, .rouge-highlight .sh, .rouge-highlight .sx, .rouge-highlight .sr, .rouge-highlight .s1 {
+.rouge-highlight .s, .rouge-highlight .sb, .rouge-highlight .dl, .rouge-highlight .sd, .rouge-highlight .s2, .rouge-highlight .sh, .rouge-highlight .sx, .rouge-highlight .sr, .rouge-highlight .s1 {
   color: #fff0a6;
   font-weight: bold;
 }
+.rouge-highlight .sa {
+  color: #f6dd62;
+  font-weight: bold;
+}
 .rouge-highlight .se {
   color: #4df4ff;
   font-weight: bold;
@@ -158,7 +165,7 @@
 .rouge-highlight .go {
   color: #BBBBBB;
 }
-.rouge-highlight .nf {
+.rouge-highlight .nf, .rouge-highlight .fm {
   color: #a8e1fe;
 }
 .rouge-highlight .py {
@@ -167,7 +174,7 @@
 .rouge-highlight .na {
   color: #a8e1fe;
 }
-.rouge-highlight .nv, .rouge-highlight .vc, .rouge-highlight .vg, .rouge-highlight .vi {
+.rouge-highlight .nv, .rouge-highlight .vc, .rouge-highlight .vg, .rouge-highlight .vi, .rouge-highlight .vm {
   color: #a8e1fe;
   font-weight: bold;
 }

data/app/assets/stylesheets/rouge.tulip.css

@@ -4,14 +4,13 @@
   color: #FFFFFF;
   background-color: #231529;
 }
-.rouge-highlight .c, .rouge-highlight .cd, .rouge-highlight .cm, .rouge-highlight .c1, .rouge-highlight .cs {
+.rouge-highlight .c, .rouge-highlight .ch, .rouge-highlight .cd, .rouge-highlight .cm, .rouge-highlight .cpf, .rouge-highlight .c1, .rouge-highlight .cs {
   color: #6D6E70;
   font-style: italic;
 }
 .rouge-highlight .cp {
   color: #41ff5b;
   font-weight: bold;
-  font-style: italic;
 }
 .rouge-highlight .err {
   color: #FFFFFF;
@@ -40,6 +39,10 @@
 .rouge-highlight .ge {
   font-style: italic;
 }
+.rouge-highlight .ges {
+  font-weight: bold;
+  font-style: italic;
+}
 .rouge-highlight .gs {
   font-weight: bold;
 }
@@ -111,7 +114,7 @@
   color: #9f93e6;
   font-weight: bold;
 }
-.rouge-highlight .m, .rouge-highlight .mf, .rouge-highlight .mh, .rouge-highlight .mi, .rouge-highlight .il, .rouge-highlight .mo, .rouge-highlight .mb, .rouge-highlight .mx {
+.rouge-highlight .m, .rouge-highlight .mb, .rouge-highlight .mf, .rouge-highlight .mh, .rouge-highlight .mi, .rouge-highlight .il, .rouge-highlight .mo, .rouge-highlight .mx {
   color: #9f93e6;
   font-weight: bold;
 }
@@ -123,10 +126,14 @@
   color: #9f93e6;
   font-weight: bold;
 }
-.rouge-highlight .s, .rouge-highlight .sb, .rouge-highlight .sd, .rouge-highlight .s2, .rouge-highlight .sh, .rouge-highlight .sx, .rouge-highlight .sr, .rouge-highlight .s1 {
+.rouge-highlight .s, .rouge-highlight .sb, .rouge-highlight .dl, .rouge-highlight .sd, .rouge-highlight .s2, .rouge-highlight .sh, .rouge-highlight .sx, .rouge-highlight .sr, .rouge-highlight .s1 {
   color: #fff0a6;
   font-weight: bold;
 }
+.rouge-highlight .sa {
+  color: #FFF02A;
+  font-weight: bold;
+}
 .rouge-highlight .se {
   color: #FAAF4C;
   font-weight: bold;
@@ -149,7 +156,7 @@
 .rouge-highlight .w {
   color: #BBBBBB;
 }
-.rouge-highlight .nf {
+.rouge-highlight .nf, .rouge-highlight .fm {
   color: #41ff5b;
 }
 .rouge-highlight .py {
@@ -158,7 +165,7 @@
 .rouge-highlight .na {
   color: #41ff5b;
 }
-.rouge-highlight .nv, .rouge-highlight .vc, .rouge-highlight .vg, .rouge-highlight .vi {
+.rouge-highlight .nv, .rouge-highlight .vc, .rouge-highlight .vg, .rouge-highlight .vi, .rouge-highlight .vm {
   color: #41ff5b;
   font-weight: bold;
 }

data/lib/markdown_views/config.rb

@@ -6,20 +6,36 @@ module MarkdownViews
   self.preprocessor = :erb
 
   mattr_accessor :extensions
-  self.extensions = %i(autolink strikethrough table tagfilter)
+  self.extensions = Commonmarker::Config::OPTIONS[:extension].merge(
+    strikethrough: true,
+    tagfilter: true,
+    table: true,
+    autolink: true,
+    tasklist: false,
+    header_ids: nil,
+    shortcodes: false,
+  )
 
   mattr_accessor :transformers
   self.transformers = %i(code_blocks)
 
   mattr_accessor :rendering_opts
-  self.rendering_opts = %i(UNSAFE GITHUB_PRE_LANG HARDBREAKS TABLE_PREFER_STYLE_ATTRIBUTES)
-    # DEFAULT UNSAFE GITHUB_PRE_LANG HARDBREAKS NOBREAKS SOURCEPOS
-    # TABLE_PREFER_STYLE_ATTRIBUTES FULL_INFO_STRING
+  self.rendering_opts = Commonmarker::Config::OPTIONS[:render].merge(
+    unsafe: true,
+    github_pre_lang: true,
+    hardbreaks: true,
+    escaped_char_spans: false,
+  )
 
   mattr_accessor :parsing_opts
-  self.parsing_opts = %i(UNSAFE SMART VALIDATE_UTF8)
-    # DEFAULT, UNSAFE, FOOTNOTES, LIBERAL_HTML_TAG, SMART
-    # STRIKETHROUGH_DOUBLE_TILDE, VALIDATE_UTF8
+  self.parsing_opts = Commonmarker::Config::OPTIONS[:parse].merge(
+    smart: true,
+  )
+
+  mattr_accessor :plugins
+  self.plugins = Commonmarker::Config::PLUGINS.merge(
+    syntax_highlighter: nil,
+  )
 
   mattr_accessor :rouge_opts
   self.rouge_opts = {

data/lib/markdown_views/handler.rb

@@ -1,25 +1,4 @@
 module MarkdownViews
-  class Handler52
-    class << self
-
-      def call(template)
-        source = preprocessor.call(template)
-
-        <<-R1
-          MarkdownViews::Renderer.render(begin;#{source};end)
-        R1
-      end
-
-      def preprocessor
-        @@preprocessor ||= begin
-          pp = MarkdownViews.preprocessor || :raw
-          ActionView::Template.registered_template_handler(pp) || raise('Unknown template handler')
-        end
-      end
-
-    end
-  end
-
   class Handler
     class << self
 

data/lib/markdown_views/renderer.rb

@@ -13,11 +13,26 @@ module MarkdownViews
       # remainder all considered private
 
       def render_md(input)
-        doc = CommonMarker.render_doc(input, MarkdownViews.parsing_opts, MarkdownViews.extensions)
+        doc = Commonmarker.parse(input, options: {
+          extension: MarkdownViews.extensions,
+          parse: MarkdownViews.parsing_opts,
+        })
 
-        MarkdownViews.transformers.each {|name| send("transform_#{name}", doc) }
+        if MarkdownViews.transformers.include? :code_blocks
+          code_blocks = transform_code_blocks(doc)
+        end
 
-        doc.to_html(MarkdownViews.rendering_opts, MarkdownViews.extensions)
+        out = doc.to_html(
+          options: {
+            extension: MarkdownViews.extensions,
+            render: MarkdownViews.rendering_opts,
+          },
+          plugins: MarkdownViews.plugins
+        )
+        code_blocks&.each do |uuid, cb|
+          out.sub! uuid, cb
+        end
+        out
       end
 
       def rouge_formatter
@@ -52,6 +67,7 @@ module MarkdownViews
       end
 
       def transform_code_blocks(doc)
+        code_blocks = {}
         doc.walk do |node|
           next unless node.type == :code_block
           next if node.fence_info == ''
@@ -64,11 +80,12 @@ module MarkdownViews
             html = %Q{<pre lang="#{lang.gsub(/[^a-z0-9_-]/,'')}"><code class="rouge-highlight">#{html}</code></pre>}
           end
 
-          new_node = CommonMarker::Node.new(:html)
-          new_node.string_content = html
-          node.insert_before new_node
-          node.delete
+          uuid = SecureRandom.uuid
+          code_blocks[uuid] = html
+          new_node = Commonmarker::Node.new(:text, content: "#{uuid}\n")
+          node.replace new_node
         end
+        code_blocks
       end
 
     end

data/lib/markdown_views/version.rb

@@ -1,3 +1,3 @@
 module MarkdownViews
-  VERSION = '2.4.0'
+  VERSION = '3.0.0'
 end

data/lib/markdown_views.rb

@@ -2,13 +2,10 @@ require 'action_view'
 require 'commonmarker'
 require 'rails'
 require 'rouge'
+require 'securerandom'
 
 %w(config engine handler renderer version).each do |f|
   require "markdown_views/#{f}"
 end
 
-if ActionView.version < Gem::Version.new('6.0.0.a')
-  ActionView::Template.register_template_handler(:md, MarkdownViews::Handler52)
-else
-  ActionView::Template.register_template_handler(:md, MarkdownViews::Handler)
-end
+ActionView::Template.register_template_handler(:md, MarkdownViews::Handler)

data/markdown_views.gemspec

@@ -18,9 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'commonmarker', '>= 0.18.2', '< 2'
-  spec.add_dependency 'rails', '>= 5.0', '< 8.1'
-  spec.add_dependency 'rouge', '>= 3.3', '< 5.0'
+  spec.required_ruby_version = '~> 3.1'
+
+  spec.add_dependency 'commonmarker', '~> 1.1'
+  spec.add_dependency 'rails', '>= 6.1', '< 8.1'
+  spec.add_dependency 'rouge', '~> 4'
+  spec.add_dependency 'securerandom'
 
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "rake"

data/test/config_test.rb

@@ -0,0 +1,69 @@
+require "test_helper"
+
+class ConfigTest < Minitest::Test
+
+  def test_extensions
+    processed = Commonmarker::Config.process_options(extension: MarkdownViews.extensions)[:extension]
+    expected = {
+      strikethrough:               true,
+      tagfilter:                   true,
+      table:                       true,
+      autolink:                    true,
+      tasklist:                    false,
+      superscript:                 false,
+      # header_ids:                '',
+      footnotes:                   false,
+      description_lists:           false,
+      front_matter_delimiter:      '',
+      multiline_block_quotes:      false,
+      math_dollars:                false,
+      math_code:                   false,
+      shortcodes:                  false,
+      wikilinks_title_before_pipe: false,
+      wikilinks_title_after_pipe:  false,
+      underline:                   false,
+      spoiler:                     false,
+      greentext:                   false,
+    }
+    assert_equal expected, processed
+  end
+
+  def test_parsing_opts
+    processed = Commonmarker::Config.process_options(parse: MarkdownViews.parsing_opts)[:parse]
+    expected = {
+      smart:                     true,
+      default_info_string:       '',
+      relaxed_tasklist_matching: false,
+      relaxed_autolinks:         false,
+    }
+    assert_equal expected, processed
+  end
+
+  def test_plugins
+    processed = Commonmarker::Config.process_plugins(MarkdownViews.plugins)
+    expected = {
+      syntax_highlighter: nil
+    }
+    assert_equal expected, processed
+  end
+
+  def test_rendering_opts
+    processed = Commonmarker::Config.process_options(render: MarkdownViews.rendering_opts)[:render]
+    expected = {
+      hardbreaks:         true,
+      github_pre_lang:    true,
+      full_info_string:   false,
+      width:              80,
+      unsafe:             true,
+      escape:             false,
+      sourcepos:          false,
+      escaped_char_spans: false,
+      ignore_setext:      false,
+      ignore_empty_links: false,
+      gfm_quirks:         false,
+      prefer_fenced:      false,
+    }
+    assert_equal expected, processed
+  end
+
+end

data/test/render_test.rb

@@ -0,0 +1,50 @@
+require "test_helper"
+
+class RenderTest < Minitest::Test
+
+  def test_markdown
+    s = <<~MD
+      # header
+      this is *amazing*!
+    MD
+    o = <<~HTML
+      <h1>header</h1>
+      <p>this is <em>amazing</em>!</p>
+    HTML
+    assert_equal o, render(s)
+  end
+
+  def test_inline_html
+    s = <<~MD
+      ---
+      <em>inline</em> html
+    MD
+    o = <<~HTML
+      <hr />
+      <p><em>inline</em> html</p>
+    HTML
+    assert_equal o, render(s)
+  end
+
+  def test_code_block
+    s = <<~MD
+      ```ruby
+      def syntax_highlighting
+        'works too!'
+      end
+      ```
+    MD
+    o = <<~HTML
+      <pre lang=\"ruby\"><code class=\"rouge-highlight\"><span class=\"k\">def</span> <span class=\"nf\">syntax_highlighting</span>
+        <span class=\"s1\">'works too!'</span>
+      <span class=\"k\">end</span></code></pre>
+    HTML
+    assert_equal o, render(s)
+  end
+
+
+  def render(*args)
+    MarkdownViews::Renderer.render(*args)
+  end
+
+end

data/test/strip_comments_test.rb

@@ -53,10 +53,4 @@ class StripCommentsTest < Minitest::Test
     MarkdownViews::Renderer.strip_comments(*args)
   end
 
-  # hack to make diffs more understandable
-  # otherwise minitest sometimes truncates multi-lines diffs, making them unusable
-  def mu_pp(obj)
-    super obj.gsub("\n", '\n').gsub("\t", '\t')
-  end
-
 end

data/test/test_helper.rb

@@ -5,3 +5,19 @@ $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "markdown_views"
 
 require "minitest/autorun"
+
+
+module TestHelpers
+
+  # hack to make diffs more understandable
+  # otherwise minitest sometimes truncates multi-lines diffs, making them unusable
+  def mu_pp(obj)
+    if obj.is_a? String
+      super obj.gsub("\n", '\n').gsub("\t", '\t')
+    else
+      super
+    end
+  end
+
+end
+Minitest::Test.include TestHelpers

metadata

@@ -1,42 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: markdown_views
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.0.0
 platform: ruby
 authors:
 - thomas morgan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-31 00:00:00.000000000 Z
+date: 2024-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.18.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.18.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.1'
@@ -46,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.1'
@@ -54,22 +48,30 @@ dependencies:
   name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.3'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: securerandom
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
-    - - "<"
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
@@ -118,8 +120,10 @@ files:
 - app/assets/stylesheets/rouge.base16.monokai.light.css
 - app/assets/stylesheets/rouge.base16.solarized.dark.css
 - app/assets/stylesheets/rouge.base16.solarized.light.css
+- app/assets/stylesheets/rouge.bw.css
 - app/assets/stylesheets/rouge.colorful.css
-- app/assets/stylesheets/rouge.github.css
+- app/assets/stylesheets/rouge.github.dark.css
+- app/assets/stylesheets/rouge.github.light.css
 - app/assets/stylesheets/rouge.gruvbox.dark.css
 - app/assets/stylesheets/rouge.gruvbox.light.css
 - app/assets/stylesheets/rouge.igorpro.css
@@ -137,6 +141,8 @@ files:
 - lib/markdown_views/renderer.rb
 - lib/markdown_views/version.rb
 - markdown_views.gemspec
+- test/config_test.rb
+- test/render_test.rb
 - test/strip_comments_test.rb
 - test/test_helper.rb
 homepage: https://github.com/zarqman/markdown_views
@@ -149,9 +155,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -163,5 +169,7 @@ signing_key:
 specification_version: 4
 summary: Add .md template handler to Rails.
 test_files:
+- test/config_test.rb
+- test/render_test.rb
 - test/strip_comments_test.rb
 - test/test_helper.rb