kramdown 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fd1d5abb103643686848dd667d1e3106c4f5bcc
-  data.tar.gz: 6e14c9a736721e2bb5aab181d6c11f861f9edf83
+  metadata.gz: b045f72be4add1c589c1aa766c9e5645cbd8cae8
+  data.tar.gz: 8e957bbb6eb55cbbde3f8a6c12cf6105d9ba0732
 SHA512:
-  metadata.gz: 5c6b26d0390aa2a2afdfad39cfcfadd782cc04c7e5c6d4ef00f5ccd66c78108b3271675adfd63c7182482024f6a817e104c7e4added160e895dd52d515a7d69f
-  data.tar.gz: bc3c786078e444d72d27985cd349b74e69b523d3419bd9bd78ac24ca0766a7a8275efaa52e99b425c45f4675b5963e2bdbaa408b5682fa6066c0e4a86491765f
+  metadata.gz: f9e6675ca778e414d8add2d34d20f618c8b7181c273d2370329488533c451aa58dbd151d67cc0e5ececf852080f16782e342fd6a3f197389dcf43d9806fa31a8
+  data.tar.gz: 39db36de2b2b8c216111e31a091b3f8e4fc9ed2c8bd8cb12d0dc0e0a635f9281a919ff2df503cc0e4e770c1e3c3e9d0a95a5cf8cd5625aa3c8b490525ce51b72

data/CONTRIBUTERS

@@ -1,6 +1,6 @@
   Count Name
 ======= ====
-    772 Thomas Leitner <t_leitner@gmx.at>
+    781 Thomas Leitner <t_leitner@gmx.at>
       6 Gioele Barabucci <gioele@svario.it>
       4 Ted Pak <powerpak006@gmail.com>
       4 Arne Brasseur <arne@arnebrasseur.net>
@@ -29,12 +29,14 @@
       1 myqlarson <myqlarson@gmail.com>
       1 Michal Till <michal.till@gmail.com>
       1 Matt Hickford <matt.hickford@gmail.com>
+      1 Marek Tuchowski <marek@tuchowski.com.pl>
       1 Marcus Stollsteimer <sto.mar@web.de>
       1 Luca Barbato <luca.barbato@gmail.com>
       1 l3kn <hello@l3kn.de>
       1 John Croisant <jacius@gmail.com>
       1 Joe Fiorini <joe@faithfulgeek.org>
       1 Jens Kraemer <jk@jkraemer.net>
+      1 Hector Correa <hector@hectorcorrea.com>
       1 Floreal Morandat florealm@gmail.com <florealm@gmail.com>
       1 Damien Pollet <damien.pollet@gmail.com>
       1 Alex Tomlins <alex.tomlins@digital.cabinet-office.gov.uk>

data/README.md

@@ -34,6 +34,9 @@ Starting from version 1.0.0 kramdown is using a versioning scheme with major, mi
 in the version number where the major number changes on backwards-incompatible changes, the minor
 number on the introduction of new features and the patch number on everything else.
 
+For information about changes between versions, have a look at
+<http://kramdown.gettalong.org/news.html> or the commit history!
+
 
 ## Usage
 

data/Rakefile

@@ -75,7 +75,7 @@ end
 if defined?(Webgen)
   desc "Generate the HTML documentation"
   task :htmldoc do
-    ruby "-Ilib -S webgen"
+    ruby "-S webgen"
   end
   CLOBBER << "htmldoc/"
   CLOBBER << "webgen-tmp"

data/VERSION

@@ -1 +1 @@
-1.8.0
+1.9.0

data/benchmark/testing.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-source ~/.bashrc
+source ~/.profile
 
 COMMAND="$@"
 if [[ -z "$COMMAND" ]]; then COMMAND="rake test"; fi

data/doc/index.page

@@ -97,8 +97,8 @@ extensions that have been made popular by the [PHP Markdown Extra] package and [
 It is probably the fastest pure-Ruby Markdown converter available (September 2014), being about 3x
 faster than [Maruku] and about 4.5x faster than [BlueFeather].
 
-Version **1.8.0**{:itemprop="softwareVersion"} released on
-**2015-07-04**{:itemprop="datePublished"}, [more news](news.html)
+Version **1.9.0**{:itemprop="softwareVersion"} released on
+**2015-10-01**{:itemprop="datePublished"}, [more news](news.html)
 {: style="text-align: center; font-size: 80%"}
 
 </div>

data/lib/kramdown/converter.rb

@@ -26,6 +26,7 @@ module Kramdown
     autoload :Toc, 'kramdown/converter/toc'
     autoload :RemoveHtmlTags, 'kramdown/converter/remove_html_tags'
     autoload :Pdf, 'kramdown/converter/pdf'
+    autoload :HashAST, 'kramdown/converter/hash_ast'
 
     extend ::Kramdown::Utils::Configurable
 

data/lib/kramdown/converter/hash_ast.rb

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2015 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown which is licensed under the MIT.
+#++
+#
+
+require 'kramdown/parser'
+require 'kramdown/converter'
+require 'kramdown/utils'
+
+module Kramdown
+
+  module Converter
+
+    # Converts a Kramdown::Document to a nested hash for further processing or debug output.
+    class HashAST < Base
+
+      def convert(el)
+        hash = {:type => el.type}
+        hash[:attr] = el.attr unless el.attr.empty?
+        hash[:value] = el.value unless el.value.nil?
+        hash[:options] = el.options unless el.options.empty?
+        unless el.children.empty?
+          hash[:children] = []
+          el.children.each {|child| hash[:children] << convert(child)}
+        end
+        hash
+      end
+
+    end
+
+  end
+end

data/lib/kramdown/converter/html.rb

@@ -444,9 +444,11 @@ module Kramdown
             insert_space = false
           end
 
-          para.children << Element.new(:raw, FOOTNOTE_BACKLINK_FMT % [insert_space ? ' ' : '', name, backlink_text])
-          (1..repeat).each do |index|
-            para.children << Element.new(:raw, FOOTNOTE_BACKLINK_FMT % [" ", "#{name}:#{index}", "#{backlink_text}<sup>#{index+1}</sup>"])
+          unless @options[:footnote_backlink].empty?
+            para.children << Element.new(:raw, FOOTNOTE_BACKLINK_FMT % [insert_space ? ' ' : '', name, backlink_text])
+            (1..repeat).each do |index|
+              para.children << Element.new(:raw, FOOTNOTE_BACKLINK_FMT % [" ", "#{name}:#{index}", "#{backlink_text}<sup>#{index+1}</sup>"])
+            end
           end
 
           ol.children << Element.new(:raw, convert(li, 4))

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

@@ -22,16 +22,37 @@ module Kramdown::Converter::SyntaxHighlighter
     end
 
     def self.call(converter, text, lang, type, _unused_opts)
-      opts = converter.options[:syntax_highlighter_opts].dup
+      opts = options(converter, type)
       lexer = ::Rouge::Lexer.find_fancy(lang || opts[:default_lang], text)
-      return nil unless lexer
-
-      opts[:wrap] = false if type == :span
+      return nil if opts[:disable] || !lexer
 
       formatter = (opts.delete(:formatter) || ::Rouge::Formatters::HTML).new(opts)
       formatter.format(lexer.lex(text))
     end
 
+    def self.options(converter, type)
+      prepare_options(converter)
+      converter.data[:syntax_highlighter_rouge][type]
+    end
+
+    def self.prepare_options(converter)
+      return if converter.data.key?(:syntax_highlighter_rouge)
+
+      cache = converter.data[:syntax_highlighter_rouge] = {}
+
+      opts = converter.options[:syntax_highlighter_opts].dup
+      span_opts = (opts.delete(:span) || {}).dup
+      block_opts = (opts.delete(:block) || {}).dup
+      [span_opts, block_opts].each do |hash|
+        hash.keys.each do |k|
+          hash[k.kind_of?(String) ? Kramdown::Options.str_to_sym(k) : k] = hash.delete(k)
+        end
+      end
+
+      cache[:span] = opts.merge(span_opts).update(:wrap => false)
+      cache[:block] = opts.merge(block_opts)
+    end
+
   end
 
 end

data/lib/kramdown/options.rb

@@ -586,6 +586,9 @@ Defines the text that should be used for the footnote backlinks
 The footnote backlink is just text, so any special HTML characters will
 be escaped.
 
+If the footnote backlint text is an empty string, no footnote backlinks
+will be generated.
+
 Default: '&8617;'
 Used by: HTML converter
 EOF

data/lib/kramdown/parser/gfm.rb

@@ -38,8 +38,10 @@ module Kramdown
             omit_trailing_br = (Kramdown::Element.category(element) == :block && element.children[-1] == child &&
                                 lines[-1].empty?)
             lines.each_with_index do |line, index|
-              children << Element.new(:text, (index > 0 ? "\n#{line}" : line))
-              children << Element.new(:br) if index < lines.size - 2 ||
+              new_element_options = { :location => child.options[:location] + index }
+
+              children << Element.new(:text, (index > 0 ? "\n#{line}" : line), nil, new_element_options)
+              children << Element.new(:br, nil, nil, new_element_options) if index < lines.size - 2 ||
                 (index == lines.size - 2 && !omit_trailing_br)
             end
             children

data/lib/kramdown/utils/ordered_hash.rb

@@ -43,6 +43,11 @@ module Kramdown
           @data.has_key?(key)
         end
 
+        # Return +true+ if the hash contains no keys.
+        def empty?
+          @data.empty?
+        end
+
         # Set the value for the +key+ to +val+.
         def []=(key, val)
           @order << key if !@data.has_key?(key)

data/lib/kramdown/version.rb

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

data/man/man1/kramdown.1

@@ -189,6 +189,9 @@ Defines the text that should be used for the footnote backlinks
 The footnote backlink is just text, so any special HTML characters will
 be escaped.
 
+If the footnote backlint text is an empty string, no footnote backlinks
+will be generated.
+
 Default: '&8617;'
 Used by: HTML converter
 

data/test/test_files.rb

@@ -17,14 +17,14 @@ Encoding.default_external = 'utf-8' if RUBY_VERSION >= '1.9'
 class TestFiles < Minitest::Test
 
   EXCLUDE_KD_FILES = [('test/testcases/block/04_header/with_auto_ids.text' if RUBY_VERSION <= '1.8.6'), # bc of dep stringex not working
-                      ('test/testcases/span/03_codespan/highlighting-rouge.text' if RUBY_VERSION < '2.0'), #bc of rouge
-                      ('test/testcases/block/06_codeblock/highlighting-rouge.text' if RUBY_VERSION < '2.0'), #bc of rouge
+                      ('test/testcases/span/03_codespan/rouge/' if RUBY_VERSION < '2.0'), #bc of rouge
+                      ('test/testcases/block/06_codeblock/rouge/' if RUBY_VERSION < '2.0'), #bc of rouge
 
                      ].compact
 
   # Generate test methods for kramdown-to-xxx conversion
   Dir[File.dirname(__FILE__) + '/testcases/**/*.text'].each do |text_file|
-    next if EXCLUDE_KD_FILES.any? {|f| text_file =~ /#{f}$/}
+    next if EXCLUDE_KD_FILES.any? {|f| text_file =~ /#{f}/}
     basename = text_file.sub(/\.text$/, '')
     opts_file = text_file.sub(/\.text$/, '.options')
     (Dir[basename + ".*"] - [text_file, opts_file]).each do |output_file|
@@ -51,8 +51,9 @@ class TestFiles < Minitest::Test
                           'test/testcases/span/03_codespan/highlighting.html', # bc of span elements inside code element
                           'test/testcases/block/04_header/with_auto_ids.html', # bc of auto_ids=true option
                           'test/testcases/block/04_header/header_type_offset.html', # bc of header_offset option
-                          'test/testcases/block/06_codeblock/highlighting-rouge.html', # bc of double surrounding <div>
-                          ('test/testcases/span/03_codespan/highlighting-rouge.html' if RUBY_VERSION < '2.0'),
+                          'test/testcases/block/06_codeblock/rouge/simple.html', # bc of double surrounding <div>
+                          ('test/testcases/span/03_codespan/rouge/simple.html' if RUBY_VERSION < '2.0'),
+                          ('test/testcases/span/03_codespan/rouge/disabled.html' if RUBY_VERSION < '2.0'),
                           'test/testcases/block/15_math/ritex.html', # bc of tidy
                           'test/testcases/span/math/ritex.html', # bc of tidy
                           'test/testcases/block/15_math/itex2mml.html', # bc of tidy
@@ -153,8 +154,9 @@ class TestFiles < Minitest::Test
                           'test/testcases/span/extension/comment.text',      # bc of comment text modifications (can this be avoided?)
                           'test/testcases/block/04_header/header_type_offset.text', # bc of header_offset being applied twice
                           ('test/testcases/block/04_header/with_auto_ids.text' if RUBY_VERSION <= '1.8.6'), # bc of dep stringex not working
-                          ('test/testcases/span/03_codespan/highlighting-rouge.text' if RUBY_VERSION < '2.0'),
-                          ('test/testcases/block/06_codeblock/highlighting-rouge.text' if RUBY_VERSION < '2.0'), #bc of rouge
+                          ('test/testcases/span/03_codespan/rouge/simple.text' if RUBY_VERSION < '2.0'), #bc of rouge
+                          ('test/testcases/span/03_codespan/rouge/disabled.text' if RUBY_VERSION < '2.0'), #bc of rouge
+                          ('test/testcases/block/06_codeblock/rouge/simple.text' if RUBY_VERSION < '2.0'), #bc of rouge
                           'test/testcases/block/15_math/ritex.text', # bc of tidy
                           'test/testcases/span/math/ritex.text', # bc of tidy
                           'test/testcases/block/15_math/itex2mml.text', # bc of tidy
@@ -193,14 +195,15 @@ class TestFiles < Minitest::Test
                              'test/testcases/block/09_html/markdown_attr.html',   # bc of markdown attr
                              'test/testcases/block/09_html/html_to_native/table_simple.html', # bc of invalidly converted simple table
                              'test/testcases/block/06_codeblock/whitespace.html', # bc of entity to char conversion
-                             'test/testcases/block/06_codeblock/highlighting-rouge.html', # bc of double surrounding <div>
+                             'test/testcases/block/06_codeblock/rouge/simple.html', # bc of double surrounding <div>
                              'test/testcases/block/11_ial/simple.html',           # bc of change of ordering of attributes in header
                              'test/testcases/span/03_codespan/highlighting.html', # bc of span elements inside code element
                              'test/testcases/block/04_header/with_auto_ids.html', # bc of auto_ids=true option
                              'test/testcases/block/04_header/header_type_offset.html', # bc of header_offset option
                              'test/testcases/block/16_toc/toc_exclude.html',      # bc of different attribute ordering
                              'test/testcases/span/autolinks/url_links.html',      # bc of quot entity being converted to char
-                             ('test/testcases/span/03_codespan/highlighting-rouge.html' if RUBY_VERSION < '2.0'),
+                             ('test/testcases/span/03_codespan/rouge/simple.html' if RUBY_VERSION < '2.0'),
+                             ('test/testcases/span/03_codespan/rouge/disabled.html' if RUBY_VERSION < '2.0'),
                              'test/testcases/block/15_math/ritex.html', # bc of tidy
                              'test/testcases/span/math/ritex.html', # bc of tidy
                              'test/testcases/block/15_math/itex2mml.html', # bc of tidy
@@ -284,8 +287,10 @@ class TestFiles < Minitest::Test
                        'test/testcases/span/text_substitutions/entities_as_char.text',
                        'test/testcases/span/text_substitutions/entities.text',
                        'test/testcases/span/text_substitutions/typography.text',
-                       ('test/testcases/span/03_codespan/highlighting-rouge.text' if RUBY_VERSION < '2.0'),
-                       ('test/testcases/block/06_codeblock/highlighting-rouge.text' if RUBY_VERSION < '2.0'), #bc of rouge
+                       ('test/testcases/span/03_codespan/rouge/simple.text' if RUBY_VERSION < '2.0'),
+                       ('test/testcases/span/03_codespan/rouge/disabled.text' if RUBY_VERSION < '2.0'),
+                       ('test/testcases/block/06_codeblock/rouge/simple.text' if RUBY_VERSION < '2.0'), #bc of rouge
+                       ('test/testcases/block/06_codeblock/rouge/disabled.text' if RUBY_VERSION < '2.0'), #bc of rouge
                       ].compact
 
   # Generate test methods for gfm-to-html conversion

data/test/test_location.rb

@@ -216,4 +216,14 @@ describe 'location' do
     end
   end
 
+  it 'handles hard wrapped paragraphs with the GFM parser' do
+    str = "A*b*C\nA*b*C\nA*b*C"
+    doc = Kramdown::Document.new(str, :input => 'GFM', :hard_wrap => true)
+    para = doc.root.children.first
+    1.upto(3) do |line|
+      0.upto(line == 3 ? 2 : 3) do |element|
+        assert_equal(line, para.children[4*(line - 1) + element].options[:location])
+      end
+    end
+  end
 end

data/test/testcases/block/06_codeblock/rouge/disabled.html

@@ -0,0 +1,2 @@
+<pre><code>x = Class.new
+</code></pre>

data/test/testcases/block/06_codeblock/rouge/disabled.options

@@ -0,0 +1,4 @@
+:syntax_highlighter: rouge
+:syntax_highlighter_opts:
+  block:
+    disable: true

data/test/testcases/block/06_codeblock/rouge/disabled.text

@@ -0,0 +1 @@
+    x = Class.new

data/test/testcases/span/03_codespan/rouge/disabled.html

@@ -0,0 +1 @@
+<p>You can say <code class="language-ruby">Class</code>.</p>

data/test/testcases/span/03_codespan/rouge/disabled.options

@@ -0,0 +1,4 @@
+:syntax_highlighter: rouge
+:syntax_highlighter_opts:
+  span:
+    disable: true

data/test/testcases/span/03_codespan/rouge/disabled.text

@@ -0,0 +1 @@
+You can say `Class`{:.language-ruby}.

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

@@ -0,0 +1,9 @@
+<p>Some footnote here<sup id="fnref:fn"><a href="#fn:fn" class="footnote">1</a></sup></p>
+
+<div class="footnotes">
+  <ol>
+    <li id="fn:fn">
+      <p>Some text here</p>
+    </li>
+  </ol>
+</div>

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

@@ -0,0 +1 @@
+:footnote_backlink: ''

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

@@ -0,0 +1,3 @@
+Some footnote here[^fn]
+
+[^fn]: Some text here

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-04 00:00:00.000000000 Z
+date: 2015-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -156,6 +156,7 @@ files:
 - lib/kramdown/compatibility.rb
 - lib/kramdown/converter.rb
 - lib/kramdown/converter/base.rb
+- lib/kramdown/converter/hash_ast.rb
 - lib/kramdown/converter/html.rb
 - lib/kramdown/converter/kramdown.rb
 - lib/kramdown/converter/latex.rb
@@ -285,9 +286,6 @@ files:
 - test/testcases/block/06_codeblock/highlighting-opts.html
 - test/testcases/block/06_codeblock/highlighting-opts.options
 - test/testcases/block/06_codeblock/highlighting-opts.text
-- test/testcases/block/06_codeblock/highlighting-rouge.html
-- test/testcases/block/06_codeblock/highlighting-rouge.options
-- test/testcases/block/06_codeblock/highlighting-rouge.text
 - test/testcases/block/06_codeblock/highlighting.html
 - test/testcases/block/06_codeblock/highlighting.options
 - test/testcases/block/06_codeblock/highlighting.text
@@ -301,6 +299,12 @@ files:
 - test/testcases/block/06_codeblock/no_newline_at_end_1.text
 - test/testcases/block/06_codeblock/normal.html
 - test/testcases/block/06_codeblock/normal.text
+- test/testcases/block/06_codeblock/rouge/disabled.html
+- test/testcases/block/06_codeblock/rouge/disabled.options
+- test/testcases/block/06_codeblock/rouge/disabled.text
+- test/testcases/block/06_codeblock/rouge/simple.html
+- test/testcases/block/06_codeblock/rouge/simple.options
+- test/testcases/block/06_codeblock/rouge/simple.text
 - test/testcases/block/06_codeblock/tilde_syntax.html
 - test/testcases/block/06_codeblock/tilde_syntax.text
 - test/testcases/block/06_codeblock/whitespace.html
@@ -556,13 +560,16 @@ files:
 - test/testcases/span/03_codespan/highlighting-minted.latex
 - test/testcases/span/03_codespan/highlighting-minted.options
 - test/testcases/span/03_codespan/highlighting-minted.text
-- test/testcases/span/03_codespan/highlighting-rouge.html
-- test/testcases/span/03_codespan/highlighting-rouge.options
-- test/testcases/span/03_codespan/highlighting-rouge.text
 - test/testcases/span/03_codespan/highlighting.html
 - test/testcases/span/03_codespan/highlighting.text
 - test/testcases/span/03_codespan/normal.html
 - test/testcases/span/03_codespan/normal.text
+- test/testcases/span/03_codespan/rouge/disabled.html
+- test/testcases/span/03_codespan/rouge/disabled.options
+- test/testcases/span/03_codespan/rouge/disabled.text
+- test/testcases/span/03_codespan/rouge/simple.html
+- test/testcases/span/03_codespan/rouge/simple.options
+- test/testcases/span/03_codespan/rouge/simple.text
 - test/testcases/span/04_footnote/backlink_text.html
 - test/testcases/span/04_footnote/backlink_text.options
 - test/testcases/span/04_footnote/backlink_text.text
@@ -582,6 +589,9 @@ files:
 - test/testcases/span/04_footnote/placement.text
 - test/testcases/span/04_footnote/regexp_problem.html
 - test/testcases/span/04_footnote/regexp_problem.text
+- test/testcases/span/04_footnote/without_backlink.html
+- test/testcases/span/04_footnote/without_backlink.options
+- test/testcases/span/04_footnote/without_backlink.text
 - test/testcases/span/05_html/across_lines.html
 - test/testcases/span/05_html/across_lines.text
 - test/testcases/span/05_html/button.html