maruku 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bad4cd7fdaa9ab0bb7c14962ca76fcb81bc37813
-  data.tar.gz: d31cadf635ffcb320049286355d719b54c9b0ea8
+  metadata.gz: 683162dc0e147b79e1df24f79949ba8521f4ca68
+  data.tar.gz: 6fa761f0e28fa67213236f05c07a97937cd98101
 SHA512:
-  metadata.gz: 59c940bc7b4586dfff68b0508f9630ac1cd20efeb87d64a7d555681c243112ca6c980667b2560a3a2e4d2f03b4dd67c15734659e84d94c38ce3cb2a5d0d241a9
-  data.tar.gz: e7e518850d8fe65a841d621bea1d7ffa1349402162bc6ba92bf078e884f256d8f0ce8bf91e41f5cf53630fae5c183ab296dafb495d89fdbfc4a29a9b5f5f66e4
+  metadata.gz: f8d53ba730189a09d616f91ed91635701334454ff114737769f2e5189db2e52c647ca5815bce72c6faa43f83c9c1daf0a1a115cc0a00916c152004c537c8fbeb
+  data.tar.gz: 8330490c4b4787cc1bbc27f470f21c985df7f1847db2238732cb48a73e60374a52910e1a4c49c66b6edb995087cf08080cf41b2b2e1a0f2cf740631983edf6e6

data/docs/markdown_syntax.md

@@ -1,17 +1,6 @@
-css: style.css
-
 Markdown: Syntax
 ================
 
-<ul id="ProjectSubmenu">
-    <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li>
-    <li><a href="/projects/markdown/basics" title="Markdown Basics">Basics</a></li>
-    <li><a class="selected" title="Markdown Syntax Documentation">Syntax</a></li>
-    <li><a href="/projects/markdown/license" title="Pricing and License Information">License</a></li>
-    <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li>
-</ul>
-
-
 *   [Overview](#overview)
     *   [Philosophy](#philosophy)
     *   [Inline HTML](#html)
@@ -256,7 +245,7 @@ wrap the text and put a `>` before every line:
     > This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
     > consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
     > Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
-    > 
+    >
     > Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
     > id sem consectetuer libero luctus adipiscing.
 
@@ -283,12 +272,12 @@ Blockquotes can contain other Markdown elements, including headers, lists,
 and code blocks:
 
 	> ## This is a header.
-	> 
+	>
 	> 1.   This is the first list item.
 	> 2.   This is the second list item.
-	> 
+	>
 	> Here's some example code:
-	> 
+	>
 	>     return shell_exec("echo $input | $markdown_script");
 
 Any decent text editor should make email-style quoting easy. For
@@ -569,7 +558,7 @@ Will produce:
 If you're referring to a local resource on the same server, you can
 use relative paths:
 
-    See my [About](/about/) page for details.   
+    See my [About](/about/) page for details.
 
 Reference-style links use a second set of square brackets, inside
 which you place a label of your choosing to identify the link:
@@ -643,7 +632,7 @@ multiple words in the link text:
 	Visit [Daring Fireball][] for more information.
 
 And then define the link:
-	
+
 	[Daring Fireball]: http://daringfireball.net/
 
 Link definitions can be placed anywhere in your Markdown document. I
@@ -767,13 +756,13 @@ one after the opening, one before the closing. This allows you to place
 literal backtick characters at the beginning or end of a code span:
 
 	A single backtick in a code span: `` ` ``
-	
+
 	A backtick-delimited string in a code span: `` `foo` ``
 
 will produce:
 
 	<p>A single backtick in a code span: <code>`</code></p>
-	
+
 	<p>A backtick-delimited string in a code span: <code>`foo`</code></p>
 
 With a code span, ampersands and angle brackets are encoded as HTML
@@ -844,7 +833,7 @@ use regular HTML `<img>` tags.
 Markdown supports a shortcut style for creating "automatic" links for URLs and email addresses: simply surround the URL or email address with angle brackets. What this means is that if you want to show the actual text of a URL or email address, and also have it be a clickable link, you can do this:
 
     <http://example.com/>
-    
+
 Markdown will turn this into:
 
     <a href="http://example.com/">http://example.com/</a>
@@ -896,4 +885,3 @@ Markdown provides backslash escapes for the following characters:
 	-	minus sign (hyphen)
     .   dot
     !   exclamation mark
-

data/lib/maruku/defaults.rb

@@ -23,7 +23,7 @@ module MaRuKu
     :html_png_url => 'pngs/',
     :html_png_resolution => 200,
 
-    :fenced_code_blocks => false, 
+    :fenced_code_blocks => false,
     :html_use_syntax => false,
 
     :latex_use_listings => false,

data/lib/maruku/element.rb

@@ -82,9 +82,24 @@ module MaRuKu
     # If `e_node_type` is specified, only yields nodes of that type.
     def each_element(e_node_type=nil, &block)
       @children.each do |c|
-        next unless c.is_a? MDElement
-        yield c if e_node_type.nil? || c.node_type == e_node_type
-        c.each_element(e_node_type, &block)
+        if c.is_a? MDElement then
+          yield c if e_node_type.nil? || c.node_type == e_node_type
+          c.each_element(e_node_type, &block)
+        #
+        # This handles the case where the children of an
+        # element are arranged in a multi-dimensional array
+        # (as in the case of a table)
+        elsif c.is_a? Array then
+          c.each do |cc|
+            # A recursive call to each_element will ignore the current element
+            # so we handle this case inline
+            if cc.is_a? MDElement then
+              yield cc if e_node_type.nil? || cc.node_type == e_node_type
+              cc.each_element(e_node_type, &block)
+            end
+          end
+        end
+
       end
     end
 

data/lib/maruku/ext/fenced_code.rb

@@ -90,7 +90,7 @@ MaRuKu::In::Markdown::register_block_extension(
       al = ial && doc.read_attribute_list(cs.new(inside))
     end
 
-    source = "\n" + lines.join("\n") + "\n"
+    source = lines.join("\n")
     context.push doc.md_codeblock(source, lang, al)
     true
   end

data/lib/maruku/ext/math/mathml_engines/blahtex.rb

@@ -80,7 +80,7 @@ module MaRuKu::Out::HTML
 
   # Run blahtex, return output
   def run_blahtex(tex, args)
-    IO.popen(['blahtex', *args], 'w+') do |blahtex|
+    IO.popen(['blahtex', *args].join(' '), 'w+') do |blahtex|
       blahtex.write tex
       blahtex.close_write
 

data/lib/maruku/ext/math/to_html.rb

@@ -53,7 +53,7 @@ module MaRuKu
         end
 
         # TODO: Warn here
-        puts "A method called #{method} should be defined."
+        raise "A method called #{method} should be defined."
         convert_to_mathml_none(kind, tex)
       end
 
@@ -68,7 +68,7 @@ module MaRuKu
         method = "convert_to_png_#{engine}".to_sym
         return self.send(method, kind, tex) if self.respond_to? method
 
-        puts "A method called #{method} should be defined."
+        raise "A method called #{method} should be defined."
         nil
       end
 
@@ -143,13 +143,6 @@ module MaRuKu
           end
         end
 
-        source_span = xelem('span')
-        add_class_to(source_span, 'maruku-eq-tex')
-        code = convert_to_mathml_none(:equation, self.math.strip)
-        code['style'] = 'display: none'
-        source_span << code
-        div << source_span
-
         div
       end
 

data/lib/maruku/html.rb

@@ -5,7 +5,7 @@ $warned_nokogiri = false
 module MaRuKu
   HTML_INLINE_ELEMS = Set.new %w[a abbr acronym audio b bdi bdo big br button canvas caption cite code
     col colgroup command datalist del details dfn dir em fieldset font form i img input ins
-    kbd label legend mark meter optgroup option progress q rp rt ruby s samp section select small
+    kbd label legend mark meter optgroup option progress q rp rt ruby s samp select small
     source span strike strong sub summary sup tbody td tfoot th thead time tr track tt u var video wbr
     animate animateColor animateMotion animateTransform circle clipPath defs desc ellipse
     feGaussianBlur filter font-face font-face-name font-face-src foreignObject g glyph hkern
@@ -16,7 +16,7 @@ module MaRuKu
     mtd mtext mtr munder munderover none semantics]
 
   # Parse block-level markdown elements in these HTML tags
-  BLOCK_TAGS = %w(div)
+  BLOCK_TAGS = Set.new %w[div section]
 
   # This gets mixed into HTML MDElement nodes to hold the parsed document fragment
   module HTMLElement
@@ -94,7 +94,7 @@ module MaRuKu
 
         # Select all text children of e
         e.xpath("./text()").each do |original_text|
-          s = CGI.escapeHTML(original_text.text)
+          s = MaRuKu::Out::HTML.escapeHTML(original_text.text)
           unless s.strip.empty?
             parsed = parse_blocks ? doc.parse_text_as_markdown(s) : doc.parse_span(s)
 
@@ -172,9 +172,6 @@ module MaRuKu
     # Process markdown within the contents of some elements and
     # replace their contents with the processed version.
     def process_markdown_inside_elements(doc)
-      # parse block-level markdown elements in these HTML tags
-      block_tags = ['div']
-
       elts = []
       @fragment.each_element('//*[@markdown]') do |e|
         elts << e
@@ -193,11 +190,11 @@ module MaRuKu
         e.attributes.delete('markdown')
 
         next if "0" == how # user requests no markdown parsing inside
-        parse_blocks = (how == 'block') || block_tags.include?(e.name)
+        parse_blocks = (how == 'block') || BLOCK_TAGS.include?(e.name)
 
         # Select all text children of e
         e.texts.each do |original_text|
-          s = CGI.escapeHTML(original_text.value)
+          s = MaRuKu::Out::HTML.escapeHTML(original_text.value)
           unless s.strip.empty?
             # TODO extract common functionality
             parsed = parse_blocks ? doc.parse_text_as_markdown(s) : doc.parse_span(s)

data/lib/maruku/input/html_helper.rb

@@ -10,14 +10,10 @@ module MaRuKu::In::Markdown::SpanLevelParser
     EverythingElse = %r{^[^<]+}m
     CommentStart = %r{^<!--}x
     CommentEnd = %r{-->}
-    TO_SANITIZE = ['img','hr','br']
+    TO_SANITIZE = ['img', 'hr', 'br']
 
     attr_reader :rest, :first_tag
 
-    def my_debug(s)
-      #    puts "---" * 10 + "\n" + inspect + "\t>>>\t" + s
-    end
-
     def initialize
       @rest = ""
       @tag_stack = []
@@ -26,7 +22,7 @@ module MaRuKu::In::Markdown::SpanLevelParser
       self.state = :inside_element
     end
 
-    attr_accessor :state # = :inside_element, :inside_tag, :inside_comment, :inside_cdata, :inside_script_style
+    attr_accessor :state # = :inside_element, :inside_tag, :inside_comment, :inside_cdata
 
     def eat_this(line)
       @rest = line + @rest
@@ -35,40 +31,44 @@ module MaRuKu::In::Markdown::SpanLevelParser
         case self.state
         when :inside_comment
           if @m = CommentEnd.match(@rest)
-            my_debug "#{@state}: Comment End: #{@m.to_s.inspect}"
-            @already << @m.pre_match << @m.to_s
+            debug_state 'Comment End'
+            # Workaround for https://bugs.ruby-lang.org/issues/9277 and another bug in 1.9.2 where even a
+            # single dash in a comment will cause REXML to error.
+            @already << @m.pre_match.gsub(/-(?![^\-])/, '- ') << @m.to_s
             @rest = @m.post_match
             self.state = :inside_element
           else
-            @already << @rest
+            @already << @rest.gsub(/-(?![^\-])/, '- ') # Workaround for https://bugs.ruby-lang.org/issues/9277
             @rest = ""
             self.state = :inside_comment
           end
         when :inside_element
           if @m = CommentStart.match(@rest)
-            my_debug "#{@state}: Comment: #{@m.to_s.inspect}"
+            debug_state 'Comment'
             things_read += 1
             @already << @m.pre_match << @m.to_s
             @rest = @m.post_match
             self.state = :inside_comment
           elsif @m = Tag.match(@rest)
-            my_debug "#{@state}: Tag: #{@m.to_s.inspect}"
+            debug_state 'Tag'
             things_read += 1
             self.state = :inside_element
             handle_tag
           elsif @m = CData.match(@rest)
-            my_debug "#{@state}: CDATA: #{@m.to_s.inspect}"
-            @already << @m.pre_match << @m.to_s
+            debug_state 'CDATA'
+            @already << @m.pre_match
+            close_script_style if script_style?
+            @already << @m.to_s
             @rest = @m.post_match
             self.state = :inside_cdata
           elsif @m = PartialTag.match(@rest)
-            my_debug "#{@state}: PartialTag: #{@m.to_s.inspect}"
+            debug_state 'PartialTag'
             @already << @m.pre_match
             @rest = @m.post_match
             @partial_tag = @m.to_s
             self.state = :inside_tag
           elsif @m = EverythingElse.match(@rest)
-            my_debug "#{@state}: Everything: #{@m.to_s.inspect}"
+            debug_state 'EverythingElse'
             @already << @m.pre_match << @m.to_s
             @rest = @m.post_match
             self.state = :inside_element
@@ -77,12 +77,14 @@ module MaRuKu::In::Markdown::SpanLevelParser
           end
         when :inside_tag
           if @m = /^[^>]*>/.match(@rest)
-            my_debug "#{@state}: matched #{@m.to_s.inspect}"
             @partial_tag << @m.to_s
-            my_debug "#{@state}: matched TOTAL: #{@partial_tag.to_s.inspect}"
             @rest = @partial_tag + @m.post_match
             @partial_tag = nil
             self.state = :inside_element
+            if @m = Tag.match(@rest)
+              things_read += 1
+              handle_tag
+            end
           else
             @partial_tag << @rest
             @rest = ""
@@ -90,60 +92,25 @@ module MaRuKu::In::Markdown::SpanLevelParser
           end
         when :inside_cdata
           if @m = CDataEnd.match(@rest)
-            my_debug "#{@state}: matched #{@m.to_s.inspect}"
+            self.state = :inside_element
             @already << @m.pre_match << @m.to_s
             @rest = @m.post_match
-            self.state = %(script style).include?(@tag_stack.last) ? :inside_script_style : :inside_element
+            start_script_style if script_style?
           else
             @already << @rest
             @rest = ""
             self.state = :inside_cdata
           end
-        when :inside_script_style
-          if @m = CData.match(@rest)
-            if @already.rstrip.end_with?('<![CDATA[')
-              @already << @m.pre_match
-              @rest = @m.post_match
-            else
-              my_debug "#{@state}: CDATA: #{@m.to_s.inspect}"
-              @already << @m.pre_match << @m.to_s
-              @rest = @m.post_match
-              self.state = :inside_cdata
-            end
-          elsif @m = Tag.match(@rest)
-            is_closing = !!@m[1]
-            tag = @m[2]
-            if is_closing && tag == @tag_stack.last
-              my_debug "#{@state}: matched #{@m.to_s.inspect}"
-              @already << @m.pre_match
-              @rest = @m.post_match
-              # This is necessary to properly parse
-              # script tags
-              @already << "]]>" unless @already.rstrip.end_with?("]]>")
-              self.state = :inside_element
-              handle_tag false # don't double-add pre_match
-            else
-              @already << @rest
-              @rest = ""
-            end
-          elsif @m = EverythingElse.match(@rest)
-            my_debug "#{@state}: Everything: #{@m.to_s.inspect}"
-            @already << @m.pre_match << @m.to_s
-            @rest = @m.post_match
-          else
-            @already << @rest
-            @rest = ""
-          end
         else
           raise "Bug bug: state = #{self.state.inspect}"
-        end # not inside comment
+        end
 
         break if is_finished? && things_read > 0
       end
     end
 
-    def handle_tag(add_pre_match = true)
-      @already << @m.pre_match if add_pre_match
+    def handle_tag
+      @already << @m.pre_match
       @rest = @m.post_match
 
       is_closing = !!@m[1]
@@ -157,44 +124,50 @@ module MaRuKu::In::Markdown::SpanLevelParser
         is_single = true
       end
 
-      my_debug "Attributes: #{attributes.inspect}"
-      my_debug "READ TAG #{@m.to_s.inspect} tag = #{tag} closing? #{is_closing} single = #{is_single}"
-
       if TO_SANITIZE.include? tag
         attributes.strip!
-        #   puts "Attributes: #{attributes.inspect}"
         if attributes.size > 0
-          @already <<  '<%s %s />' % [tag, attributes]
+          @already << '<%s %s />' % [tag, attributes]
         else
-          @already <<  '<%s />' % [tag]
+          @already << '<%s />' % [tag]
         end
       elsif is_closing
         if @tag_stack.empty?
           error "Malformed: closing tag #{tag.inspect} in empty list"
-        end
-        if @tag_stack.last != tag
+        elsif @tag_stack.last != tag
           error "Malformed: tag <#{tag}> closes <#{@tag_stack.last}>"
         end
 
+        close_script_style if script_style?
+
         @already << @m.to_s
         @tag_stack.pop
       else
         @already << @m.to_s
+        @tag_stack.push(tag) unless is_single
 
-        if not is_single
-          @tag_stack.push(tag)
-          my_debug "Pushing #{tag.inspect} when read #{@m.to_s.inspect}"
-        end
-
-        if %w(script style).include?(@tag_stack.last)
-          # This is necessary to properly parse
-          # script tags
-          @already << "<![CDATA["
-          self.state = :inside_script_style
-        end
+        start_script_style if script_style?
       end
     end
 
+    def stuff_you_read
+      @already
+    end
+
+    def is_finished?
+      self.state == :inside_element && @tag_stack.empty?
+    end
+
+    private
+
+    def debug_state(note)
+      my_debug "#{@state}: #{note}: #{@m.to_s.inspect}"
+    end
+
+    def my_debug(s)
+      #    puts "---" * 10 + "\n" + inspect + "\t>>>\t" + s
+    end
+
     def error(s)
       raise "Error: #{s} \n" + inspect, caller
     end
@@ -209,12 +182,52 @@ module MaRuKu::In::Markdown::SpanLevelParser
         @rest.gsub(/^/, '|') + "\n"
     end
 
-    def stuff_you_read
-      @already
+    # Script and style tag handling
+    # -----------------------------
+    #
+    # XHTML, and XML parsers like REXML, require that certain characters be
+    # escaped within script or style tags. However, there are conflicts between
+    # documents served as XHTML vs HTML. So we need to be extra careful about
+    # how we escape these tags so they will even parse correctly. However, we
+    # also try to avoid adding that escaping unnecessarily.
+    #
+    # See http://dorward.me.uk/www/comments-cdata/ for a good explanation.
+
+    # Are we within a script or style tag?
+    def script_style?
+      %w(script style).include?(@tag_stack.last)
     end
 
-    def is_finished?
-      (self.state == :inside_element) and @tag_stack.empty?
+    # Save our @already buffer elsewhere, and switch to using @already for the
+    # contents of this script or style tag.
+    def start_script_style
+      @before_already, @already = @already, ""
+    end
+
+    # Finish script or style tag content, wrapping it in CDATA if necessary,
+    # and add it to our original @already buffer.
+    def close_script_style
+      tag = @tag_stack.last
+
+      # See http://www.w3.org/TR/xhtml1/#C_4 for character sequences not allowed within an element body.
+      if @already =~ /<|&|\]\]>|--/
+        new_already = script_style_cdata_start(tag)
+        new_already << "\n" unless @already.start_with?("\n")
+        new_already << @already
+        new_already << "\n" unless @already.end_with?("\n")
+        new_already << script_style_cdata_end(tag)
+        @already = new_already
+      end
+      @before_already << @already
+      @already = @before_already
+    end
+
+    def script_style_cdata_start(tag)
+      (tag == 'script') ? "//<![CDATA[" : "/*<![CDATA[*/"
+    end
+
+    def script_style_cdata_end(tag)
+      (tag == 'script') ? "//]]>" : "/*]]>*/"
     end
-  end # html helper
+  end
 end