kramdown 2.0.0.beta2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f737523fd370cb69aff3ae9bb1c7fbad526081be7d3df2275de8fb9563d9c4c2
-  data.tar.gz: 81ca8a7bb1aa6feecbad1cbe0cba3eeebb26751ff9b1e33692f0f0f663f76a3d
+  metadata.gz: 1e61a5f6dbf5b13bfcf0164acaf6a0c6e8fa2cd2c39fc7368bf9f54be38e0552
+  data.tar.gz: e03352fce83854b256596c7718dd2c48251b5851f7e1ca06012d433526b6015b
 SHA512:
-  metadata.gz: 5e5cd66bdc510a27fa640fe0ed18d598c3f4acda9dcd8fe54b931f00ea08011e16772881f6e3b3a17338412cd03ea6af57e8687102601cdde24c6da195fa67f4
-  data.tar.gz: 06202fba99c3a55af853235d3c1d355856b085d30cc5d4d29bfbde3587a01c258663a4b47b12ce60e649ceeb2b1e72cca66c1d434ae662bfdd07221ba75d8d73
+  metadata.gz: 3bf07ed2b152212b8aa8e50383b7cfc7a38a16d11441f6c5b2790c834020e3ef8ab82e6978bd86b3334740cc4b23a407f66b744ded4ee22bb6e75b210d3668cc
+  data.tar.gz: 0206cd73d6c8d75470701c197fb89d151e6f3c2c694b20af1068f8c4d03386f065194e92c2c3cea5ec37e72c5f52132ce282d2c80888f229811cefc62f2049ed

data/CONTRIBUTERS

@@ -1,6 +1,6 @@
   Count Name
 ======= ====
-    895 Thomas Leitner <t_leitner@gmx.at>
+    909 Thomas Leitner <t_leitner@gmx.at>
       7 Christian Cornelssen <ccorn@1tein.de>
       6 Gioele Barabucci <gioele@svario.it>
       4 Ted Pak <powerpak006@gmail.com>
@@ -61,6 +61,7 @@
       1 Cédric Boutillier <cedric.boutillier@gmail.com>
       1 Ashwin Maroli <ashmaroli@gmail.com>
       1 Ashe Connor <ashe@kivikakk.ee>
+      1 Antoine Cotten <hello@acotten.com>
       1 Andrew <andrew.dale.wylie@gmail.com>
       1 Alpha Chen <alpha.chen@gmail.com>
       1 Alex Tomlins <alex.tomlins@digital.cabinet-office.gov.uk>

data/VERSION

@@ -1 +1 @@
-2.0.0.beta1
+2.0.0

data/lib/kramdown/converter/html.rb

@@ -84,11 +84,26 @@ module Kramdown
       def convert_p(el, indent)
         if el.options[:transparent]
           inner(el, indent)
+        elsif el.children.size == 1 && el.children.first.type == :img &&
+            el.children.first.options[:ial]&.[](:refs)&.include?('standalone')
+          convert_standalone_image(el.children.first, indent)
         else
           format_as_block_html(el.type, el.attr, inner(el, indent), indent)
         end
       end
 
+      # Helper method used by +convert_p+ to convert a paragraph that only contains a single :img
+      # element.
+      def convert_standalone_image(el, indent)
+        attr = el.attr.dup
+        figure_attr = {}
+        figure_attr['class'] = attr.delete('class') if attr.key?('class')
+        figure_attr['id'] = attr.delete('id') if attr.key?('id')
+        body = "#{' ' * (indent + @indent)}<img#{html_attributes(attr)} />\n" \
+          "#{' ' * (indent + @indent)}<figcaption>#{attr['alt']}</figcaption>\n"
+        format_as_indented_block_html("figure", figure_attr, body, indent)
+      end
+
       def convert_codeblock(el, indent)
         attr = el.attr.dup
         lang = extract_code_language!(attr)
@@ -271,17 +286,19 @@ module Kramdown
 
       def convert_footnote(el, _indent)
         repeat = ''
-        if (footnote = @footnotes_by_name[el.options[:name]])
+        name = @options[:footnote_prefix] + el.options[:name]
+        if (footnote = @footnotes_by_name[name])
           number = footnote[2]
           repeat = ":#{footnote[3] += 1}"
         else
           number = @footnote_counter
           @footnote_counter += 1
-          @footnotes << [el.options[:name], el.value, number, 0]
-          @footnotes_by_name[el.options[:name]] = @footnotes.last
+          @footnotes << [name, el.value, number, 0]
+          @footnotes_by_name[name] = @footnotes.last
         end
-        "<sup id=\"fnref:#{el.options[:name]}#{repeat}\">" \
-          "<a href=\"#fn:#{el.options[:name]}\" class=\"footnote\">#{number}</a></sup>"
+        "<sup id=\"fnref:#{name}#{repeat}\">" \
+          "<a href=\"#fn:#{name}\" class=\"footnote\">" \
+          "#{number}</a></sup>"
       end
 
       def convert_raw(el, _indent)

data/lib/kramdown/converter/syntax_highlighter/rouge.rb

@@ -24,6 +24,7 @@ module Kramdown::Converter::SyntaxHighlighter
     def self.call(converter, text, lang, type, call_opts)
       opts = options(converter, type)
       call_opts[:default_lang] = opts[:default_lang]
+      return nil unless lang || opts[:default_lang] || opts[:guess_lang]
       lexer = ::Rouge::Lexer.find_fancy(lang || opts[:default_lang], text)
       return nil if opts[:disable] || !lexer || lexer.tag == "plaintext"
       opts[:css_class] ||= 'highlight' # For backward compatibility when using Rouge 2.0

data/lib/kramdown/element.rb

@@ -42,6 +42,7 @@ module Kramdown
   #
   # :options:: This key may be used to store options that were set during parsing of the document.
   #
+  # :footnote_count:: This key stores the number of actually referenced footnotes of the document.
   #
   # === :blank
   #
@@ -500,9 +501,11 @@ module Kramdown
     end
 
     def inspect #:nodoc:
-      "<kd:#{@type}#{@value.nil? ? '' : ' ' + @value.inspect} " \
-        "#{@attr.inspect}#{options.empty? ? '' : ' ' + @options.inspect} " \
-        "#{@children.empty? ? '' : ' ' + @children.inspect}>"
+      "<kd:#{@type}" \
+        "#{value.nil? ? '' : ' value=' + value.inspect}" \
+        "#{attr.empty? ? '' : ' attr=' + attr.inspect}" \
+        "#{options.empty? ? '' : ' options=' + options.inspect}" \
+        "#{children.empty? ? '' : ' children=' + children.inspect}>"
     end
 
     CATEGORY = {} # :nodoc:

data/lib/kramdown/options.rb

@@ -550,6 +550,18 @@ module Kramdown
       Used by: HTML converter
     EOF
 
+    define(:footnote_prefix, String, '', <<~EOF)
+      Prefix used for footnote IDs
+
+      This option can be used to set a prefix for footnote IDs. This is useful
+      when rendering multiple documents into the same output file to avoid
+      duplicate IDs. The prefix should only contain characters that are valid
+      in an ID!
+
+      Default: ''
+      Used by: HTML
+    EOF
+
   end
 
 end

data/lib/kramdown/parser/kramdown.rb

@@ -93,11 +93,13 @@ module Kramdown
           update_tree(data[:content])
           replace_abbreviations(data[:content])
         end
+        footnote_count = 0
         @footnotes.each do |name, data|
-          next if data.key?(:marker)
+          (footnote_count += 1; next) if data.key?(:marker)
           line = data[:content].options[:location]
           warning("Footnote definition for '#{name}' on line #{line} is unreferenced - ignoring")
         end
+        @root.options[:footnote_count] = footnote_count
       end
 
       protected

data/lib/kramdown/parser/kramdown/extensions.rb

@@ -39,7 +39,7 @@ module Kramdown
 
       # Update the +ial+ with the information from the inline attribute list +opts+.
       def update_ial_with_ial(ial, opts)
-        (ial[:refs] ||= []) << opts[:refs]
+        (ial[:refs] ||= []).concat(opts[:refs]) if opts.key?(:refs)
         opts.each do |k, v|
           if k == IAL_CLASS_ATTR
             ial[k] = "#{ial[k]} #{v}".lstrip

data/lib/kramdown/version.rb

@@ -10,6 +10,6 @@
 module Kramdown
 
   # The kramdown version.
-  VERSION = '2.0.0.beta2'
+  VERSION = '2.0.0'
 
 end

data/man/man1/kramdown.1

@@ -102,6 +102,15 @@ This option can be used to specify the number that is used for the first footnot
 Default: 1 Used by: HTML converter
 .RE
 .TP
+\fB\-\-footnote\-prefix\fP \fIARG\fP
+Prefix used for footnote IDs
+.RS
+.P
+This option can be used to set a prefix for footnote IDs\. This is useful when rendering multiple documents into the same output file to avoid duplicate IDs\. The prefix should only contain characters that are valid in an ID!
+.P
+Default: \[u2018]\[u2019] Used by: HTML
+.RE
+.TP
 \fB\-\-header\-offset\fP \fIARG\fP
 Sets the output offset for headers
 .RS

data/test/test_files.rb

@@ -134,6 +134,7 @@ class TestFiles < Minitest::Test
       'test/testcases/span/04_footnote/markers.text', # bc of footnote in header
       'test/testcases/block/06_codeblock/with_lang_in_fenced_block_name_with_dash.text',
       'test/testcases/block/06_codeblock/with_lang_in_fenced_block_any_char.text',
+      'test/testcases/block/03_paragraph/standalone_image.text', # bc of standalone image
     ].compact
     Dir[File.dirname(__FILE__) + '/testcases/**/*.text'].each do |text_file|
       next if EXCLUDE_LATEX_FILES.any? {|f| text_file =~ /#{f}$/ }
@@ -177,6 +178,7 @@ class TestFiles < Minitest::Test
       'test/testcases/span/05_html/mark_element.text', # bc of tidy
       'test/testcases/block/09_html/xml.text', # bc of tidy
       'test/testcases/span/05_html/xml.text', # bc of tidy
+      'test/testcases/block/03_paragraph/standalone_image.text', # bc of standalone image
     ].compact
     Dir[File.dirname(__FILE__) + '/testcases/**/*.text'].each do |text_file|
       next if EXCLUDE_TEXT_FILES.any? {|f| text_file =~ /#{f}$/ }
@@ -225,6 +227,7 @@ class TestFiles < Minitest::Test
       'test/testcases/span/05_html/mark_element.html', # bc of tidy
       'test/testcases/block/09_html/xml.html', # bc of tidy
       'test/testcases/span/05_html/xml.html', # bc of tidy
+      'test/testcases/block/03_paragraph/standalone_image.html', # bc of standalone image
     ].compact
     Dir[File.dirname(__FILE__) + '/testcases/**/*.html'].each do |html_file|
       next if EXCLUDE_HTML_KD_FILES.any? {|f| html_file =~ /#{f}$/ }

data/test/testcases/block/03_paragraph/standalone_image.html

@@ -0,0 +1,8 @@
+<p>para</p>
+
+<figure class="class" id="id">
+  <img src="some.jpg" alt="standalone image" key="value" />
+  <figcaption>standalone image</figcaption>
+</figure>
+
+<p>para</p>

data/test/testcases/block/03_paragraph/standalone_image.text

@@ -0,0 +1,6 @@
+para
+{:standalone}
+
+![standalone image](some.jpg){:#id .class key="value" standalone}
+
+para

data/test/testcases/span/04_footnote/footnote_prefix.html

@@ -0,0 +1,12 @@
+<p>This is a<sup id="fnref:adf123-ab"><a href="#fn:adf123-ab" class="footnote">1</a></sup> footnote<sup id="fnref:adf123-ab:1"><a href="#fn:adf123-ab" class="footnote">1</a></sup>. And another<sup id="fnref:adf123-bc"><a href="#fn:adf123-bc" class="footnote">2</a></sup>.</p>
+
+<div class="footnotes">
+  <ol>
+    <li id="fn:adf123-ab">
+      <p>Some text. <a href="#fnref:adf123-ab" class="reversefootnote">&#8617;</a> <a href="#fnref:adf123-ab:1" class="reversefootnote">&#8617;<sup>2</sup></a></p>
+    </li>
+    <li id="fn:adf123-bc">
+      <p>Some other text. <a href="#fnref:adf123-bc" class="reversefootnote">&#8617;</a></p>
+    </li>
+  </ol>
+</div>

data/test/testcases/span/04_footnote/footnote_prefix.options

@@ -0,0 +1 @@
+:footnote_prefix: adf123-

data/test/testcases/span/04_footnote/footnote_prefix.text

@@ -0,0 +1,4 @@
+This is a[^ab] footnote[^ab]. And another[^bc].
+
+[^ab]: Some text.
+[^bc]: Some other text.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta2
+  version: 2.0.0
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-13 00:00:00.000000000 Z
+date: 2019-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -148,6 +148,8 @@ files:
 - test/testcases/block/03_paragraph/no_newline_at_end.text
 - test/testcases/block/03_paragraph/one_para.html
 - test/testcases/block/03_paragraph/one_para.text
+- test/testcases/block/03_paragraph/standalone_image.html
+- test/testcases/block/03_paragraph/standalone_image.text
 - test/testcases/block/03_paragraph/two_para.html
 - test/testcases/block/03_paragraph/two_para.text
 - test/testcases/block/03_paragraph/with_html_to_native.html
@@ -522,6 +524,9 @@ files:
 - test/testcases/span/04_footnote/footnote_nr.latex
 - test/testcases/span/04_footnote/footnote_nr.options
 - test/testcases/span/04_footnote/footnote_nr.text
+- test/testcases/span/04_footnote/footnote_prefix.html
+- test/testcases/span/04_footnote/footnote_prefix.options
+- test/testcases/span/04_footnote/footnote_prefix.text
 - test/testcases/span/04_footnote/inside_footnote.html
 - test/testcases/span/04_footnote/inside_footnote.text
 - test/testcases/span/04_footnote/markers.html
@@ -626,9 +631,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3