Commonmarker 1.0+ support

Ruby 2.x install CommonMarker < 1.0 and is tested there.

Closes #1601

Author: lsegal

CHANGELOG.md

@@ -3,6 +3,7 @@
 - Add support for Ruby .rbs files (docstrings included) (#1673)
 - Add built-in hybrid RDoc/Markdown renderer (`HybridMarkdown`) requiring no external gems (#1674)
 - Add support for `#-` as a comment-block separator. See Getting Started Guide.
+- Add support for `commonmarker` version `>= 1.0`.
 - Remove usage of jQuery in default templates. jQuery library is still packaged in templates for backward compatibility (#1675)
 - Fix false self-referential mixin when bare name matches ancestor namespace (#1672)
 - Fix bracket/brace map corruption from Ruby 3.0+ pattern matching deconstruction (#1671)

lib/yard/templates/helpers/html_helper.rb

@@ -93,10 +93,16 @@ def html_markup_markdown(text)
                              :tables,
                              :with_toc_data,
                              :no_intraemphasis).to_html
+        when 'Commonmarker'
+          provider.to_html(text, :options => { }, :plugins => { :syntax_highlighter => nil })
         when 'CommonMarker'
-          CommonMarker.render_html(text, %i[DEFAULT GITHUB_PRE_LANG], %i[autolink table])
+          provider.render_html(text, %i[DEFAULT GITHUB_PRE_LANG], %i[autolink table])
         else
-          provider.new(text).to_html
+          if provider.respond_to?(:to_html)
+            provider.to_html(text)
+          else
+            provider.new(text).to_html
+          end
         end
       end
 

lib/yard/templates/helpers/markup_helper.rb

@@ -31,7 +31,7 @@ def clear_markup_cache
           {:lib => :maruku, :const => 'Maruku'},
           {:lib => :'rpeg-markdown', :const => 'PEGMarkdown'},
           {:lib => :rdoc, :const => 'YARD::Templates::Helpers::Markup::RDocMarkdown'},
-          {:lib => :commonmarker, :const => 'CommonMarker'}
+          {:lib => :commonmarker, :const => defined?(CommonMarker) ? 'CommonMarker' : 'Commonmarker' }
         ],
         :textile => [
           {:lib => :redcloth, :const => 'RedCloth'}

spec/templates/markup_processor_integrations/markdown_spec.rb

@@ -82,16 +82,12 @@
     end
   end
 
-  describe 'CommonMarker', if:  RUBY_VERSION >= '2.3' do
+  describe 'Commonmarker', if:  RUBY_VERSION >= '2.3' do
     let(:markup) { :markdown }
     let(:markup_provider) { :commonmarker }
 
     include_examples 'shared examples for markdown processors'
 
-    it 'generates level 2 header without id' do
-      expect(rendered_document).to include('<h2>Example code listings</h2>')
-    end
-
     it 'creates line break via backslash' do
       expect(rendered_document).to include("commonmark line break with<br />\na backslash")
     end