kramdown 0.13.2 → 0.13.3

data/lib/kramdown/parser/kramdown.rb

@@ -85,7 +85,7 @@ module Kramdown
         @footnotes = {}
 
         @block_parsers = [:blank_line, :codeblock, :codeblock_fenced, :blockquote, :atx_header,
-                          :setext_header, :horizontal_rule, :list, :definition_list, :block_html,
+                          :horizontal_rule, :list, :definition_list, :block_html, :setext_header,
                           :table, :footnote_definition, :link_definition, :abbrev_definition,
                           :block_extensions, :block_math, :eob_marker, :paragraph]
         @span_parsers =  [:emphasis, :codespan, :autolink, :span_html, :footnote_marker, :link, :smart_quotes, :inline_math,
@@ -95,7 +95,7 @@ module Kramdown
       private_class_method(:new, :allocate)
 
 
-      # The source string provided on initialization is parsed into the <tt>@root</tt> element.
+      # The source string provided on initialization is parsed into the @root element.
       def parse
         configure_parser
         parse_blocks(@root, adapt_source(source))
@@ -153,8 +153,8 @@ module Kramdown
         status
       end
 
-      # Update the tree by parsing all <tt>:raw_text</tt> elements with the span-level parser
-      # (resets the environment) and by updating the attributes from the IALs.
+      # Update the tree by parsing all :+raw_text+ elements with the span-level parser (resets the
+      # environment) and by updating the attributes from the IALs.
       def update_tree(element)
         last_blank = nil
         element.children.map! do |child|
@@ -182,7 +182,7 @@ module Kramdown
         end.flatten!
       end
 
-      # Parse all span-level elements in the source string of <tt>@src</tt> into +el+.
+      # Parse all span-level elements in the source string of @src into +el+.
       #
       # If the parameter +stop_re+ (a regexp) is used, parsing is immediately stopped if the regexp
       # matches and if no block is given or if a block is given and it returns +true+.

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

@@ -57,8 +57,8 @@ module Kramdown
         end
       end
 
-      # Parse the generic extension at the current point. The parameter +type+ can either be
-      # <tt>:block</tt> or <tt>:span</tt> depending whether we parse a block or span extension tag.
+      # Parse the generic extension at the current point. The parameter +type+ can either be :block
+      # or :span depending whether we parse a block or span extension tag.
       def parse_extension_start_tag(type)
         orig_pos = @src.pos
         @src.pos += @src.matched_size

data/lib/kramdown/parser/kramdown/link.rb

@@ -44,7 +44,7 @@ module Kramdown
 
 
       # This helper methods adds the approriate attributes to the element +el+ of type +a+ or +img+
-      # and the element itself to the <tt>@tree</tt>.
+      # and the element itself to the @tree.
       def add_link(el, href, title, alt_text = nil)
         if el.type == :a
           el.attr['href'] = href

data/lib/kramdown/parser/kramdown/table.rb

@@ -75,7 +75,7 @@ module Kramdown
             # parse possible code spans on the line and correctly split the line into cells
             env = save_env
             cells = []
-            (@src[1] + ' ').split(/(<code.*?>.*?<\/code>)/).each_with_index do |str, i|
+            @src[1].split(/(<code.*?>.*?<\/code>)/).each_with_index do |str, i|
               if i % 2 == 1
                 (cells.empty? ? cells : cells.last) << str
               else
@@ -86,8 +86,8 @@ module Kramdown
                 root.children.each do |c|
                   if c.type == :raw_text
                     # Only on Ruby 1.9: f, *l = c.value.split(/(?<!\\)\|/).map {|t| t.gsub(/\\\|/, '|')}
-                    f, *l = c.value.split(/\\\|/).map {|t| t.split(/\|/)}.inject([]) do |memo, t|
-                      memo.last << "|" << t.shift if memo.size > 0
+                    f, *l = c.value.split(/\\\|/, -1).map {|t| t.split(/\|/, -1)}.inject([]) do |memo, t|
+                      memo.last << "|#{t.shift}" if memo.size > 0
                       memo.concat(t)
                     end
                     (cells.empty? ? cells : cells.last) << f

data/lib/kramdown/utils/html.rb

@@ -26,9 +26,9 @@ module Kramdown
 
     # Provides convenience methods for HTML related tasks.
     #
-    # *Note* that this module has to be mixed into a class that has a <tt>@root</tt> (containing an
-    # element of type :root) and an <tt>@options</tt> (containing an options hash) instance variable
-    # so that some of the methods can work correctly.
+    # *Note* that this module has to be mixed into a class that has a @root (containing an element
+    # of type :root) and an @options (containing an options hash) instance variable so that some of
+    # the methods can work correctly.
     module Html
 
       # Convert the entity +e+ to a string. The optional parameter +original+ may contain the
@@ -71,10 +71,9 @@ module Kramdown
       # :startdoc:
 
       # Escape the special HTML characters in the string +str+. The parameter +type+ specifies what
-      # is escaped: <tt>:all</tt> - all special HTML characters as well as entities, <tt>:text</tt>
-      # \- all special HTML characters except the quotation mark but no entities and
-      # <tt>:attribute</tt> - all special HTML characters including the quotation mark but no
-      # entities.
+      # is escaped: :all - all special HTML characters as well as entities, :text - all special HTML
+      # characters except the quotation mark but no entities and :attribute - all special HTML
+      # characters including the quotation mark but no entities.
       def escape_html(str, type = :all)
         str.gsub(ESCAPE_RE_FROM_TYPE[type]) {|m| ESCAPE_MAP[m] || m}
       end

data/lib/kramdown/utils/ordered_hash.rb

@@ -51,6 +51,11 @@ module Kramdown
           @data[key]
         end
 
+        # Return +true+ if the hash contains the key.
+        def has_key?(key)
+          @data.has_key?(key)
+        end
+
         # Set the value for the +key+ to +val+.
         def []=(key, val)
           @order << key if !@data.has_key?(key)
@@ -68,6 +73,18 @@ module Kramdown
           self
         end
 
+        def dup #:nodoc:
+          new_object = super
+          new_object.instance_variable_set(:@data, @data.dup)
+          new_object.instance_variable_set(:@order, @order.dup)
+          new_object
+        end
+
+        def ==(other) #:nodoc:
+          return false unless other.kind_of?(self.class)
+          @data == other.instance_variable_get(:@data) && @order == other.instance_variable_get(:@order)
+        end
+
         def inspect #:nodoc:
           "{" + map {|k,v| "#{k.inspect}=>#{v.inspect}"}.join(" ") + "}"
         end

data/lib/kramdown/version.rb

@@ -23,6 +23,6 @@
 module Kramdown
 
   # The kramdown version.
-  VERSION = '0.13.2'
+  VERSION = '0.13.3'
 
 end

data/test/test_files.rb

@@ -159,4 +159,39 @@ class TestFiles < Test::Unit::TestCase
     end
   end
 
+
+
+  # Generate test methods for asserting that converters don't modify the document tree.
+  Dir[File.dirname(__FILE__) + '/testcases/**/*.text'].each do |text_file|
+    basename = text_file.sub(/\.text$/, '')
+    opts_file = text_file.sub(/\.text$/, '.options')
+    options = File.exist?(opts_file) ? YAML::load(File.read(opts_file)) : {:auto_ids => false, :footnote_nr => 1}
+    (Kramdown::Converter.constants.map {|c| c.to_sym} - [:Base]).each do |conv_class|
+      define_method("test_whether_#{conv_class}_modifies_tree_with_file_#{text_file.tr('.', '_')}") do
+        doc = Kramdown::Document.new(File.read(text_file), options)
+        options_before = Marshal.load(Marshal.dump(doc.options))
+        tree_before = Marshal.load(Marshal.dump(doc.root))
+        Kramdown::Converter.const_get(conv_class).convert(doc.root, doc.options)
+        assert_equal(options_before, doc.options)
+        assert_tree_not_changed(tree_before, doc.root)
+      end
+    end
+  end
+
+  def assert_tree_not_changed(old, new)
+    assert_equal(old.type, new.type, "type mismatch")
+    if old.value.kind_of?(Kramdown::Element)
+      assert_tree_not_changed(old.value, new.value)
+    else
+      assert_equal(old.value, new.value, "value mismatch")
+    end
+    assert_equal(old.attr, new.attr, "attr mismatch")
+    assert_equal(old.options, new.options, "options mismatch")
+    assert_equal(old.children.length, new.children.length, "children count mismatch")
+
+    old.children.each_with_index do |child, index|
+      assert_tree_not_changed(child, new.children[index])
+    end
+  end
+
 end

data/test/testcases/block/09_html/content_model/tables.html

@@ -1,14 +1,14 @@
 <table class="examples">
-  <tr>
-    <th><em>Usage</em></th>
-    <th>
+<tr>
+  <th><em>Usage</em></th>
+  <th>
 Output
   </th>
-  </tr>
-  <tr>
-    <td>Some <em>data</em></td>
-    <td>
+</tr>
+<tr>
+  <td>Some <em>data</em></td>
+  <td>
       <h1 id="some-more">Some more</h1>
     </td>
-  </tr>
+</tr>
 </table>

data/test/testcases/block/09_html/content_model/tables.text

@@ -7,7 +7,7 @@ Output
 </tr>
 <tr>
   <td markdown="span">Some *data*</td>
-  <td>
+  <td markdown="1">
 # Some more
   </td>
 </tr>

data/test/testcases/block/09_html/html_and_headers.html

@@ -0,0 +1,5 @@
+<h1>header</h1>
+
+<div>
+======
+</div>

data/test/testcases/block/09_html/html_and_headers.text

@@ -0,0 +1,6 @@
+header
+======
+
+<div>
+======
+</div>

data/test/testcases/block/09_html/html_to_native/emphasis.html

@@ -2,4 +2,5 @@
 
 <p>This is <strong>strong<em>italic</em>, yes!</strong>.</p>
 
-<p>This is <em> not</em> converted, as <em>is </em> this.</p>
+<p>This is <em> not</em> converted, as <em>is
+</em> this.</p>

data/test/testcases/block/09_html/html_to_native/table_normal.html

@@ -1,14 +1,12 @@
 <table class="examples">
-  <tr>
-    <th>Usage</th>
-    <th>Other</th>
-  </tr>
-  <tr>
-    <td>
-Some *data*
-    </td>
-    <td>
-      <p>Some more</p>
-    </td>
-  </tr>
+<tr>
+  <th>Usage</th>
+  <th>Other</th>
+</tr>
+<tr>
+  <td>Some *data*</td>
+  <td>
+    <p>Some more</p>
+  </td>
+</tr>
 </table>

data/test/testcases/block/09_html/html_to_native/table_simple.html

@@ -33,16 +33,16 @@
 </table>
 
 <table class="examples">
-  <tr>
-    <th>Usage</th>
-    <th>Output</th>
-  </tr>
-  <tr>
-    <td>
-Some *data*
-    </td>
-    <td>
+<tr>
+  <th>Usage</th>
+  <th>
+Output
+  </th>
+</tr>
+<tr>
+  <td>Some *data*</td>
+  <td>
 Some more
-    </td>
-  </tr>
+  </td>
+</tr>
 </table>

data/test/testcases/block/14_table/header.html

@@ -35,26 +35,21 @@
 <p>With alignment and superfluous alignment defs</p>
 
 <table>
-  <col />
-  <col align="left" />
-  <col align="center" />
-  <col align="right" />
-  <col />
   <thead>
     <tr>
       <th>default</th>
-      <th>left</th>
-      <th>center</th>
-      <th>right</th>
+      <th style="text-align: left">left</th>
+      <th style="text-align: center">center</th>
+      <th style="text-align: right">right</th>
       <th>default</th>
     </tr>
   </thead>
   <tbody>
     <tr>
       <td>cell1</td>
-      <td>cell2</td>
-      <td>cell3</td>
-      <td>cell4</td>
+      <td style="text-align: left">cell2</td>
+      <td style="text-align: center">cell3</td>
+      <td style="text-align: right">cell4</td>
       <td>cell5</td>
     </tr>
   </tbody>
@@ -80,23 +75,21 @@
 <p>Multiple bodies</p>
 
 <table>
-  <col align="center" />
-  <col />
   <thead>
     <tr>
-      <th>cell1</th>
+      <th style="text-align: center">cell1</th>
       <th>cell2</th>
     </tr>
   </thead>
   <tbody>
     <tr>
-      <td>cell3</td>
+      <td style="text-align: center">cell3</td>
       <td>cell4</td>
     </tr>
   </tbody>
   <tbody>
     <tr>
-      <td>cell5</td>
+      <td style="text-align: center">cell5</td>
       <td>cell6</td>
     </tr>
   </tbody>

data/test/testcases/block/14_table/simple.html

@@ -79,6 +79,25 @@
   </tbody>
 </table>
 
+<p>Special cases regarding codespan syntax</p>
+
+<table>
+  <tbody>
+    <tr>
+      <td>a</td>
+      <td><code>b</code></td>
+    </tr>
+  </tbody>
+</table>
+
+<table>
+  <tbody>
+    <tr>
+      <td><code>a</code></td>
+    </tr>
+  </tbody>
+</table>
+
 <table class="cls">
   <tbody>
     <tr>

data/test/testcases/block/14_table/simple.html.19

@@ -79,6 +79,25 @@
   </tbody>
 </table>
 
+<p>Special cases regarding codespan syntax</p>
+
+<table>
+  <tbody>
+    <tr>
+      <td>a</td>
+      <td><code>b</code></td>
+    </tr>
+  </tbody>
+</table>
+
+<table>
+  <tbody>
+    <tr>
+      <td><code>a</code></td>
+    </tr>
+  </tbody>
+</table>
+
 <table class="cls">
   <tbody>
     <tr>

data/test/testcases/block/14_table/simple.text

@@ -20,6 +20,12 @@ Table with code elements
 | This is a <code>span | with</code> a pipe.
 | Some <em>span | </em> here | a <code>span | with</code> a | pipe.
 
+Special cases regarding codespan syntax
+
+|a|`b`
+
+|`a`
+
 {:.cls}
 | table | with | ial
 

data/test/testcases/block/14_table/table_with_footnote.html

@@ -0,0 +1,25 @@
+<table>
+  <tbody>
+    <tr>
+      <td>this is <sup id="fnref:1"><a href="#fn:1" rel="footnote">1</a></sup></td>
+      <td>a table</td>
+    </tr>
+    <tr>
+      <td>with a</td>
+      <td>footnote</td>
+    </tr>
+  </tbody>
+</table>
+
+<div class="footnotes">
+  <ol>
+    <li id="fn:1">
+      <p>Something</p>
+
+      <blockquote>
+        <p>special here</p>
+      </blockquote>
+      <p><a href="#fnref:1" rev="footnote">&#8617;</a></p>
+    </li>
+  </ol>
+</div>