yard-commonmarker 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 23468e62744ead14d2f005ca1295e7f7a2586edf
4
- data.tar.gz: 88d34c0df0445424907f46191f49b9f1ff3ab041
3
+ metadata.gz: 288d3701b1964ce4c5de46447caad0c6b0497d9b
4
+ data.tar.gz: e57fc7b36e94cf4834aa19db887610f9bbaed5b7
5
5
  SHA512:
6
- metadata.gz: f6ea24e6a3a87a2c1dae29a968b05aa9ac040a6816acdb2c87ed196b5b3b8abbf8467c3a4e94fa6785078e56393b7490f7ae5ac92c85cd9426d079466b1d1f05
7
- data.tar.gz: c114714010979922fb2a3c63579591cad36dfc867ff7b151bff96db624b4a8e88427bd2d7e752419a91c1098abf7c95da79e0d892a2a367a730fed804b5b07c1
6
+ metadata.gz: 52aeab8edef2e2210ae9e63769194cd3ab74143b5ff3c84fe7eeb9adb9b95cecfba4985e0e71ad1cd3dd9f350dbdf7fc9f8e5630492cd417f6d5e1953234ed55
7
+ data.tar.gz: 218566b948e02e879e277f645749bf3a984d8367f2154f532b76b91ca1b974bb0654f1822a72d180ac66b19a99e5210bc65e0d4e5f0d448468e997e8d52666e2
@@ -12,4 +12,4 @@
12
12
  # SupportedStyles: final_newline, final_blank_line
13
13
  Layout/TrailingBlankLines:
14
14
  Exclude:
15
- - 'lib/yard/templates/helpers/markup_helper/commonmarker.rb'
15
+ - 'lib/yard/commonmarker.rb'
data/Gemfile CHANGED
@@ -4,3 +4,8 @@ source 'https://rubygems.org'
4
4
 
5
5
  # Specify your gem's dependencies in yard-commonmarker.gemspec
6
6
  gemspec
7
+
8
+ group :development do
9
+ gem 'github-markup'
10
+ gem 'redcarpet'
11
+ end
data/README.md CHANGED
@@ -57,6 +57,13 @@ or
57
57
  --markup markdown
58
58
  ```
59
59
 
60
+ ## Markup
61
+
62
+ Markup | Description
63
+ -------------|-----
64
+ `commonmark` | See http://commonmark.org/
65
+ `markdown` | See `commonmark`
66
+
60
67
  ## Development
61
68
 
62
69
  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.
@@ -8,20 +8,15 @@ module CommonMarker
8
8
  class CompatRenderer
9
9
  attr_accessor :text
10
10
 
11
- GITHUB_EXTENSIONS = %i[tagfilter autolink table strikethrough].freeze
11
+ DEFAULT_EXTENSIONS = %i[tagfilter autolink table strikethrough].freeze
12
+ DEFAULT_OPTIONS = %i[GITHUB_PRE_LANG].freeze
12
13
 
13
- def initialize(text, exts = GITHUB_EXTENSIONS, options: :GITHUB_PRE_LANG)
14
+ def initialize(text, *exts, options: DEFAULT_OPTIONS)
14
15
  @text = text
15
- @extensions = GITHUB_EXTENSIONS | exts
16
- @options = options
16
+ @extensions = DEFAULT_EXTENSIONS + exts
17
+ @options = options || DEFAULT_OPTIONS
17
18
  end
18
19
 
19
- def to_html(*_dummy)
20
- CommonMarker.render_html(text, options, extensions)
21
- end
22
-
23
- private
24
-
25
20
  # @return [String]
26
21
  attr_reader :text
27
22
 
@@ -30,5 +25,9 @@ module CommonMarker
30
25
 
31
26
  # @return [<Symbol>]
32
27
  attr_reader :extensions
28
+
29
+ def to_html(*_dummy)
30
+ CommonMarker.render_html(text, options, extensions)
31
+ end
33
32
  end
34
33
  end
@@ -1,3 +1,11 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'yard/templates/helpers/markup_helper/commonmarker'
3
+ require 'yard'
4
+ require 'yard/templates/helpers/markup_helper'
5
+ require 'commonmarker/compat_renderer'
6
+
7
+ # @see https://github.com/lsegal/yard/blob/master/lib/yard/templates/helpers/markup_helper.rb#L26
8
+ YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:markdown] <<
9
+ { lib: :commonmarker, const: 'CommonMarker::CompatRenderer' }
10
+ YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:commonmark] =
11
+ [{ lib: :commonmarker, const: 'CommonMarker::CompatRenderer' }]
@@ -2,6 +2,6 @@
2
2
 
3
3
  module YARD
4
4
  module CommonMarker
5
- VERSION = '0.4.0'
5
+ VERSION = '0.5.0'
6
6
  end
7
7
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: yard-commonmarker
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Alex Semyonov
@@ -92,7 +92,6 @@ files:
92
92
  - lib/yard-commonmarker.rb
93
93
  - lib/yard/commonmarker.rb
94
94
  - lib/yard/commonmarker/version.rb
95
- - lib/yard/templates/helpers/markup_helper/commonmarker.rb
96
95
  - yard-commonmarker.gemspec
97
96
  homepage: https://alsemyonov.gitlab.com/yard-commonmarker/
98
97
  licenses:
@@ -1,11 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'yard'
4
- require 'yard/templates/helpers/markup_helper'
5
- require 'commonmarker/compat_renderer'
6
-
7
- # @see https://github.com/lsegal/yard/blob/master/lib/yard/templates/helpers/markup_helper.rb#L26
8
- YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:markdown] <<
9
- { lib: :commonmarker, const: 'CommonMarker::CompatRenderer' }
10
- YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:commonmark] =
11
- [{ lib: :commonmarker, const: 'CommonMarker::CompatRenderer' }]