kramdown 0.6.0 → 0.7.0

data/lib/kramdown/parser/kramdown/blank_line.rb

@@ -32,7 +32,7 @@ module Kramdown
         if @tree.children.last && @tree.children.last.type == :blank
           @tree.children.last.value += @src.matched
         else
-          @tree.children << Element.new(:blank, @src.matched)
+          @tree.children << new_block_el(:blank, @src.matched)
         end
         true
       end

data/lib/kramdown/parser/kramdown/blockquote.rb

@@ -30,7 +30,7 @@ module Kramdown
       # Parse the blockquote at the current location.
       def parse_blockquote
         result = @src.scan(BLOCKQUOTE_MATCH).gsub(BLOCKQUOTE_START, '')
-        el = Element.new(:blockquote)
+        el = new_block_el(:blockquote)
         @tree.children << el
         parse_blocks(el, result)
         true

data/lib/kramdown/parser/kramdown/codeblock.rb

@@ -32,7 +32,7 @@ module Kramdown
 
       # Parse the indented codeblock at the current location.
       def parse_codeblock
-        @tree.children << Element.new(:codeblock, @src.scan(CODEBLOCK_MATCH).gsub!(INDENT, ''))
+        @tree.children << new_block_el(:codeblock, @src.scan(CODEBLOCK_MATCH).gsub!(INDENT, ''))
         true
       end
       define_parser(:codeblock, CODEBLOCK_START)
@@ -45,7 +45,7 @@ module Kramdown
       def parse_codeblock_fenced
         if @src.check(FENCED_CODEBLOCK_MATCH)
           @src.pos += @src.matched_size
-          @tree.children << Element.new(:codeblock, @src[2])
+          @tree.children << new_block_el(:codeblock, @src[2])
           true
         else
           false

data/lib/kramdown/parser/kramdown/eob.rb

@@ -29,7 +29,7 @@ module Kramdown
       # Parse the EOB marker at the current location.
       def parse_eob_marker
         @src.pos += @src.matched_size
-        @tree.children << Element.new(:eob)
+        @tree.children << new_block_el(:eob)
         true
       end
       define_parser(:eob_marker, EOB_MARKER)

data/lib/kramdown/parser/kramdown/extension.rb

@@ -70,11 +70,11 @@ module Kramdown
       end
 
 
-      EXT_BLOCK_START_STR = "^#{OPT_SPACE}\\{::(%s):(:)?(#{ALD_ANY_CHARS}*)\\}\s*?\n"
-      EXT_BLOCK_START = /#{EXT_BLOCK_START_STR % ALD_ID_NAME}/
+      EXT_BLOCK_START_STR_DEPR = "^#{OPT_SPACE}\\{::(%s):(:)?(#{ALD_ANY_CHARS}*)\\}\s*?\n"
+      EXT_BLOCK_START_DEPR = /#{EXT_BLOCK_START_STR_DEPR % ALD_ID_NAME}/
 
-      # Parse the extension block at the current location.
-      def parse_extension_block
+      # Parse the block extension at the current location.
+      def parse_extension_block_depr
         @src.pos += @src.matched_size
 
         ext = @src[1]
@@ -82,13 +82,18 @@ module Kramdown
         body = nil
         parse_attribute_list(@src[3], opts)
 
+        warn('DEPRECATION warning: This syntax is deprecated, use the new extension syntax')
+        if !%w{comment nomarkdown options}.include?(ext)
+          warn('DEPRECATION warning: Custom extensions will be removed in a future version - use a template processor like ERB instead')
+        end
+
         if !@extension.public_methods.map {|m| m.to_s}.include?("parse_#{ext}")
           warning("No extension named '#{ext}' found - ignoring extension block")
           body = :invalid
         end
 
         if !@src[2]
-          stop_re = /#{EXT_BLOCK_START_STR % ext}/
+          stop_re = /#{EXT_BLOCK_START_STR_DEPR % ext}/
           if result = @src.scan_until(stop_re)
             parse_attribute_list(@src[3], opts)
             body = result.sub!(stop_re, '') if body != :invalid
@@ -102,7 +107,82 @@ module Kramdown
 
         true
       end
-      define_parser(:extension_block, EXT_BLOCK_START)
+      define_parser(:extension_block_depr, EXT_BLOCK_START_DEPR)
+
+
+      ##########################################
+      ### Code for handling new extension syntax
+      ##########################################
+
+      def parse_extension_start_tag(type)
+        @src.pos += @src.matched_size
+
+        if @src[4] || @src.matched == '{:/}'
+          name = (@src[4] ? "for '#{@src[4]}' " : '')
+          warning("Invalid extension stop tag #{name}found - ignoring it")
+          return
+        end
+
+        ext = @src[1]
+        opts = {}
+        body = nil
+        parse_attribute_list(@src[2] || '', opts)
+
+        if !@src[3]
+          stop_re = (type == :block ? /#{EXT_BLOCK_STOP_STR % ext}/ : /#{EXT_STOP_STR % ext}/)
+          if result = @src.scan_until(stop_re)
+            body = result.sub!(stop_re, '')
+          else
+            warning("No stop tag for extension '#{ext}' found - treating it as extension without body")
+          end
+        end
+
+        handle_extension(ext, opts, body, type)
+      end
+
+      def handle_extension(name, opts, body, type)
+        case name
+        when 'comment'
+          # nothing to do
+        when 'nomarkdown'
+          @tree.children << Element.new(:raw, body, :type => type) if body.kind_of?(String)
+        when 'options'
+          opts.select do |k,v|
+            k = k.to_sym
+            if Kramdown::Options.defined?(k)
+              @doc.options[k] = Kramdown::Options.parse(k, v) rescue @doc.options[k]
+              false
+            else
+              true
+            end
+          end.each do |k,v|
+            warning("Unknown kramdown option '#{k}'")
+          end
+        else
+          warning("Invalid extension name '#{name}' specified - ignoring extension")
+        end
+      end
+
+
+      EXT_STOP_STR = "\\{:/(%s)?\\}"
+      EXT_START_STR = "\\{::(\\w+)(?:\\s(#{ALD_ANY_CHARS}*?)|)(\\/)?\\}"
+      EXT_SPAN_START = /#{EXT_START_STR}|#{EXT_STOP_STR % ALD_ID_NAME}/
+      EXT_BLOCK_START = /^#{OPT_SPACE}(?:#{EXT_START_STR}|#{EXT_STOP_STR % ALD_ID_NAME})\s*?\n/
+      EXT_BLOCK_STOP_STR = "^#{OPT_SPACE}#{EXT_STOP_STR}\s*?\n"
+
+      # Parse the extension block at the current location.
+      def parse_block_extension
+        parse_extension_start_tag(:block)
+        true
+      end
+      define_parser(:block_extension, EXT_BLOCK_START)
+
+
+      # Parse the extension span at the current location.
+      def parse_span_extension
+        parse_extension_start_tag(:span)
+      end
+      define_parser(:span_extension, EXT_SPAN_START, '\{:[:/]')
 
     end
   end

data/lib/kramdown/parser/kramdown/header.rb

@@ -24,19 +24,6 @@ module Kramdown
   module Parser
     class Kramdown
 
-      # Generate an alpha-numeric ID from the the string +str+.
-      def generate_id(str)
-        gen_id = str.gsub(/[^a-zA-Z0-9 -]/, '').gsub(/^[^a-zA-Z]*/, '').gsub(' ', '-').downcase
-        gen_id = 'section' if gen_id.length == 0
-        @used_ids ||= {}
-        if @used_ids.has_key?(gen_id)
-          gen_id += '-' + (@used_ids[gen_id] += 1).to_s
-        else
-          @used_ids[gen_id] = 0
-        end
-        gen_id
-      end
-
       HEADER_ID=/(?:[ \t]\{#((?:\w|\d)[\w\d-]*)\})?/
       SETEXT_HEADER_START = /^(#{OPT_SPACE}[^ \t].*?)#{HEADER_ID}[ \t]*?\n(-|=)+\s*?\n/
 
@@ -47,10 +34,9 @@ module Kramdown
         end
         @src.pos += @src.matched_size
         text, id, level = @src[1].strip, @src[2], @src[3]
-        el = Element.new(:header, nil, :level => (level == '-' ? 2 : 1))
+        el = new_block_el(:header, nil, :level => (level == '-' ? 2 : 1), :raw_text => text)
         add_text(text, el)
         el.options[:attr] = {'id' => id} if id
-        el.options[:attr] = {'id' => generate_id(text)} if @doc.options[:auto_ids] && !id
         @tree.children << el
         true
       end
@@ -67,10 +53,9 @@ module Kramdown
         end
         result = @src.scan(ATX_HEADER_MATCH)
         level, text, id = @src[1], @src[2].strip, @src[3]
-        el = Element.new(:header, nil, :level => level.length)
+        el = new_block_el(:header, nil, :level => level.length, :raw_text => text)
         add_text(text, el)
         el.options[:attr] = {'id' => id} if id
-        el.options[:attr] = {'id' => generate_id(text)} if @doc.options[:auto_ids] && !id
         @tree.children << el
         true
       end

data/lib/kramdown/parser/kramdown/horizontal_rule.rb

@@ -29,7 +29,7 @@ module Kramdown
       # Parse the horizontal rule at the current location.
       def parse_horizontal_rule
         @src.pos += @src.matched_size
-        @tree.children << Element.new(:hr)
+        @tree.children << new_block_el(:hr)
         true
       end
       define_parser(:horizontal_rule, HR_START)

data/lib/kramdown/parser/kramdown/list.rb

@@ -23,6 +23,7 @@
 require 'kramdown/parser/kramdown/blank_line'
 require 'kramdown/parser/kramdown/eob'
 require 'kramdown/parser/kramdown/horizontal_rule'
+require 'kramdown/parser/kramdown/attribute_list'
 
 module Kramdown
   module Parser
@@ -59,7 +60,7 @@ module Kramdown
         end
 
         type, list_start_re = (@src.check(LIST_START_UL) ? [:ul, LIST_START_UL] : [:ol, LIST_START_OL])
-        list = Element.new(type)
+        list = new_block_el(type)
 
         item = nil
         indent_re = nil
@@ -74,6 +75,11 @@ module Kramdown
             item.value, indentation, content_re, indent_re = parse_first_list_line(@src[1].length, @src[2])
             list.children << item
 
+            item.value.sub!(/^#{IAL_SPAN_START}/) do |match|
+              parse_attribute_list($~[1], item.options[:ial] ||= {})
+              ''
+            end
+
             list_start_re = (type == :ul ? /^( {0,#{[3, indentation - 1].min}}[+*-])([\t| ].*?\n)/ :
                              /^( {0,#{[3, indentation - 1].min}}\d+\.)([\t| ].*?\n)/)
             nested_list_found = false
@@ -146,7 +152,7 @@ module Kramdown
         end
 
         first_as_para = false
-        deflist = Element.new(:dl)
+        deflist = new_block_el(:dl)
         para = @tree.children.pop
         if para.type == :blank
           para = @tree.children.pop

data/lib/kramdown/parser/kramdown/math.rb

@@ -33,7 +33,7 @@ module Kramdown
           return false
         end
         @src.pos += @src.matched_size
-        @tree.children << Element.new(:math, @src[2], :type => :block)
+        @tree.children << new_block_el(:math, @src[2], :type => :block)
         true
       end
       define_parser(:block_math, BLOCK_MATH_START)

data/lib/kramdown/parser/kramdown/paragraph.rb

@@ -32,7 +32,7 @@ module Kramdown
         if @tree.children.last && @tree.children.last.type == :p
           @tree.children.last.children.first.value << "\n" << @src.matched.chomp
         else
-          @tree.children << Element.new(:p)
+          @tree.children << new_block_el(:p)
           add_text(@src.matched.lstrip.chomp, @tree.children.last)
         end
         true

data/lib/kramdown/parser/kramdown/smart_quotes.rb

@@ -178,8 +178,8 @@ module Kramdown
                   # Special case for e.g. "<i>Custer</i>'s Last Stand."
                   [/("|')(\s|s\b|$)/, [:rquote1, 2]],
                   # Any remaining single quotes should be opening ones:
-                  [/(.?)'/, [1, :lsquo]],
-                  [/(.?)"/, [1, :ldquo]],
+                  [/(.?)'/m, [1, :lsquo]],
+                  [/(.?)"/m, [1, :ldquo]],
                  ] #'"
 
       SQ_SUBSTS = {

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

@@ -37,7 +37,7 @@ module Kramdown
       # Parse the table at the current location.
       def parse_table
         orig_pos = @src.pos
-        table = Element.new(:table, nil, :alignment => [])
+        table = new_block_el(:table, nil, :alignment => [])
 
         @src.scan(TABLE_SEP_LINE)
 

data/lib/kramdown/version.rb

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

data/man/man1/kramdown.1

@@ -30,15 +30,52 @@ Show the help.
 .SH KRAMDOWN OPTIONS
 
 .TP
-.B \-\-coderay_line_numbers ARG
+.B \-\-template ARG
 
-Defines how and if line numbers should be shown
+The name of an ERB template file that should be used to wrap the output
 
-The possible values are :table, :inline, :list or nil. If this option is
-nil, no line numbers are shown.
+This is used to wrap the output in an environment so that the output can
+be used as a stand-alone document. For example, an HTML template would
+provide the needed header and body tags so that the whole output is a
+valid HTML file. If no template is specified, the output will be just
+the converted text.
 
-Default: :inline
-Used by: HTML converter
+When resolving the template file, the given template name is used first.
+If such a file is not found, the converter extension is appended. If the
+file still cannot be found, the templates name is interpreted as a
+template name that is provided by kramdown (without the converter
+extension).
+
+kramdown provides a default template named 'default' for each converter.
+
+Default: ''
+Used by: all converters
+
+
+.TP
+.B \-\-[no\-]auto_ids
+
+Use automatic header ID generation
+
+If this option is `true`, ID values for all headers are automatically
+generated if no ID is explicitly specified.
+
+Default: true
+Used by: HTML/Latex converter
+
+
+.TP
+.B \-\-auto_id_prefix ARG
+
+Prefix used for automatically generated heaer IDs
+
+This option can be used to set a prefix for the automatically generated
+header IDs so that there is no conflict when rendering multiple kramdown
+documents into one output file separately. The prefix should only
+contain characters that are valid in an ID!
+
+Default: ''
+Used by: HTML/Latex converter
 
 
 .TP
@@ -55,15 +92,6 @@ Default: false
 Used by: kramdown parser
 
 
-.TP
-.B \-\-coderay_line_number_start ARG
-
-The start value for the line numbers
-
-Default: 1
-Used by: HTML converter
-
-
 .TP
 .B \-\-[no\-]parse_span_html
 
@@ -76,14 +104,6 @@ Default: true
 Used by: kramdown parser
 
 
-.TP
-.B \-\-coderay_tab_width ARG
-
-The tab width used in highlighted code
-
-Used by: HTML converter
-
-
 .TP
 .B \-\-footnote_nr ARG
 
@@ -96,15 +116,6 @@ Default: 1
 Used by: HTML converter
 
 
-.TP
-.B \-\-coderay_bold_every ARG
-
-Defines how often a line number should be made bold
-
-Default: 10
-Used by: HTML converter
-
-
 .TP
 .B \-\-filter_html ARG
 
@@ -121,62 +132,65 @@ Used by: HTML converter
 
 
 .TP
-.B \-\-coderay_css ARG
+.B \-\-coderay_wrap ARG
 
-Defines how the highlighted code gets styled
+Defines how the highlighted code should be wrapped
 
-Possible values are :class (CSS classes are applied to the code
-elements, one must supply the needed CSS file) or :style (default CSS
-styles are directly applied to the code elements).
+The possible values are :span, :div or nil.
 
-Default: style
+Default: :div
 Used by: HTML converter
 
 
 .TP
-.B \-\-template ARG
+.B \-\-coderay_line_numbers ARG
 
-The name of an ERB template file that should be used to wrap the output
+Defines how and if line numbers should be shown
 
-This is used to wrap the output in an environment so that the output can
-be used as a stand-alone document. For example, an HTML template would
-provide the needed header and body tags so that the whole output is a
-valid HTML file. If no template is specified, the output will be just
-the converted text.
+The possible values are :table, :inline, :list or nil. If this option is
+nil, no line numbers are shown.
 
-When resolving the template file, the given template name is used first.
-If such a file is not found, the converter extension is appended. If the
-file still cannot be found, the templates name is interpreted as a
-template name that is provided by kramdown (without the converter
-extension).
+Default: :inline
+Used by: HTML converter
 
-kramdown provides a default template named 'default' for each converter.
 
-Default: ''
-Used by: all converters
+.TP
+.B \-\-coderay_line_number_start ARG
+
+The start value for the line numbers
+
+Default: 1
+Used by: HTML converter
 
 
 .TP
-.B \-\-coderay_wrap ARG
+.B \-\-coderay_tab_width ARG
 
-Defines how the highlighted code should be wrapped
+The tab width used in highlighted code
 
-The possible values are :span, :div or nil.
+Used by: HTML converter
 
-Default: :div
+
+.TP
+.B \-\-coderay_bold_every ARG
+
+Defines how often a line number should be made bold
+
+Default: 10
 Used by: HTML converter
 
 
 .TP
-.B \-\-[no\-]auto_ids
+.B \-\-coderay_css ARG
 
-Use automatic header ID generation
+Defines how the highlighted code gets styled
 
-If this option is `true`, ID values for all headers are automatically
-generated if no ID is explicitly specified.
+Possible values are :class (CSS classes are applied to the code
+elements, one must supply the needed CSS file) or :style (default CSS
+styles are directly applied to the code elements).
 
-Default: true
-Used by: kramdown parser
+Default: style
+Used by: HTML converter
 
 
 .SH SEE ALSO