yard-commonmarker 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23468e62744ead14d2f005ca1295e7f7a2586edf
-  data.tar.gz: 88d34c0df0445424907f46191f49b9f1ff3ab041
+  metadata.gz: 288d3701b1964ce4c5de46447caad0c6b0497d9b
+  data.tar.gz: e57fc7b36e94cf4834aa19db887610f9bbaed5b7
 SHA512:
-  metadata.gz: f6ea24e6a3a87a2c1dae29a968b05aa9ac040a6816acdb2c87ed196b5b3b8abbf8467c3a4e94fa6785078e56393b7490f7ae5ac92c85cd9426d079466b1d1f05
-  data.tar.gz: c114714010979922fb2a3c63579591cad36dfc867ff7b151bff96db624b4a8e88427bd2d7e752419a91c1098abf7c95da79e0d892a2a367a730fed804b5b07c1
+  metadata.gz: 52aeab8edef2e2210ae9e63769194cd3ab74143b5ff3c84fe7eeb9adb9b95cecfba4985e0e71ad1cd3dd9f350dbdf7fc9f8e5630492cd417f6d5e1953234ed55
+  data.tar.gz: 218566b948e02e879e277f645749bf3a984d8367f2154f532b76b91ca1b974bb0654f1822a72d180ac66b19a99e5210bc65e0d4e5f0d448468e997e8d52666e2

data/.rubocop_todo.yml

@@ -12,4 +12,4 @@
 # SupportedStyles: final_newline, final_blank_line
 Layout/TrailingBlankLines:
   Exclude:
-    - 'lib/yard/templates/helpers/markup_helper/commonmarker.rb'
+    - 'lib/yard/commonmarker.rb'

data/Gemfile

@@ -4,3 +4,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in yard-commonmarker.gemspec
 gemspec
+
+group :development do
+  gem 'github-markup'
+  gem 'redcarpet'
+end

data/README.md

@@ -57,6 +57,13 @@ or
 --markup markdown
 ```
 
+## Markup
+
+Markup       | Description
+-------------|-----
+`commonmark` | See http://commonmark.org/
+`markdown`   | See `commonmark`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/commonmarker/compat_renderer.rb

@@ -8,20 +8,15 @@ module CommonMarker
   class CompatRenderer
     attr_accessor :text
 
-    GITHUB_EXTENSIONS = %i[tagfilter autolink table strikethrough].freeze
+    DEFAULT_EXTENSIONS = %i[tagfilter autolink table strikethrough].freeze
+    DEFAULT_OPTIONS = %i[GITHUB_PRE_LANG].freeze
 
-    def initialize(text, exts = GITHUB_EXTENSIONS, options: :GITHUB_PRE_LANG)
+    def initialize(text, *exts, options: DEFAULT_OPTIONS)
       @text = text
-      @extensions = GITHUB_EXTENSIONS | exts
-      @options = options
+      @extensions = DEFAULT_EXTENSIONS + exts
+      @options = options || DEFAULT_OPTIONS
     end
 
-    def to_html(*_dummy)
-      CommonMarker.render_html(text, options, extensions)
-    end
-
-    private
-
     # @return [String]
     attr_reader :text
 
@@ -30,5 +25,9 @@ module CommonMarker
 
     # @return [<Symbol>]
     attr_reader :extensions
+
+    def to_html(*_dummy)
+      CommonMarker.render_html(text, options, extensions)
+    end
   end
 end

data/lib/yard/commonmarker.rb

@@ -1,3 +1,11 @@
 # frozen_string_literal: true
 
-require 'yard/templates/helpers/markup_helper/commonmarker'
+require 'yard'
+require 'yard/templates/helpers/markup_helper'
+require 'commonmarker/compat_renderer'
+
+# @see https://github.com/lsegal/yard/blob/master/lib/yard/templates/helpers/markup_helper.rb#L26
+YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:markdown] <<
+  { lib: :commonmarker, const: 'CommonMarker::CompatRenderer' }
+YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:commonmark] =
+  [{ lib: :commonmarker, const: 'CommonMarker::CompatRenderer' }]

data/lib/yard/commonmarker/version.rb

@@ -2,6 +2,6 @@
 
 module YARD
   module CommonMarker
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-commonmarker
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Alex Semyonov
@@ -92,7 +92,6 @@ files:
 - lib/yard-commonmarker.rb
 - lib/yard/commonmarker.rb
 - lib/yard/commonmarker/version.rb
-- lib/yard/templates/helpers/markup_helper/commonmarker.rb
 - yard-commonmarker.gemspec
 homepage: https://alsemyonov.gitlab.com/yard-commonmarker/
 licenses:

data/lib/yard/templates/helpers/markup_helper/commonmarker.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'yard'
-require 'yard/templates/helpers/markup_helper'
-require 'commonmarker/compat_renderer'
-
-# @see https://github.com/lsegal/yard/blob/master/lib/yard/templates/helpers/markup_helper.rb#L26
-YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:markdown] <<
-  { lib: :commonmarker, const: 'CommonMarker::CompatRenderer' }
-YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:commonmark] =
-  [{ lib: :commonmarker, const: 'CommonMarker::CompatRenderer' }]