kramdown 0.13.7 → 0.13.8

data/CONTRIBUTERS

@@ -1,11 +1,15 @@
   Count Name
 ======= ====
-    513 Thomas Leitner <t_leitner@gmx.at>
+    528 Thomas Leitner <t_leitner@gmx.at>
       3 gettalong <t_leitner@gmx.at>
       3 Ben Armston <ben.armston@googlemail.com>
       3 Alex Marandon <contact@alexmarandon.com>
+      2 Bran <m.versum@gmail.com>
       1 tomykaira <tomykaira@gmail.com>
       1 Postmodern <postmodern.mod3@gmail.com>
+      1 Michal Till <michal.till@gmail.com>
       1 John Croisant <jacius@gmail.com>
       1 Joe Fiorini <joe@faithfulgeek.org>
+      1 Gioele Barabucci <gioele@svario.it>
       1 Damien Pollet <damien.pollet@gmail.com>
+      1 Alex Tomlins <alex.tomlins@digital.cabinet-office.gov.uk>

data/ChangeLog

@@ -1,3 +1,228 @@
+commit 69fbdcbf2b3585f92819f941f695f2ab10d2051f
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Aug 31 18:35:39 2012 +0200
+
+    Fixed API index page documentation
+    
+    Since the README.md file now contains Markdown and RDoc markup,
+    the API index page documentation was moved to another file.
+
+Rakefile
+lib/kramdown/document.rb
+
+commit 03c304e4dc8e996c48c5aa517d881985023915c3
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Aug 31 18:13:09 2012 +0200
+
+    Updated release notes and version number
+
+doc/news/release_0_13_8.page
+doc/sidebar.template
+lib/kramdown/version.rb
+
+commit 0daf6f3452517602590349398f743e91c95ee053
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Aug 31 18:06:07 2012 +0200
+
+    Fixed enable_coderay patch
+    
+    * Fixed code of enable_coderay option to generate backwards-compatible
+      output
+    * Updated documentation
+
+doc/converter/html.page
+lib/kramdown/converter/html.rb
+lib/kramdown/options.rb
+test/test_files.rb
+test/testcases/block/06_codeblock/disable-highlighting.html
+
+commit 0b9d8fc2346b346ffc437fe546db47d500ff8415
+Merge: 9085ede 4b5c0f8
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Aug 31 17:34:50 2012 +0200
+
+    Merge branch 'option-enable-coderay' of https://github.com/unibr/kramdown
+
+commit 9085ede998c4a1cc7d0869a43d4ea511ce649a89
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Aug 31 16:35:16 2012 +0200
+
+    Updated description of :coderay_default_lang to make it clear that it is only used for code blocks
+
+lib/kramdown/options.rb
+
+commit f0efc41dba131cfd6965cf16f852218b7936d4b8
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Aug 31 16:19:28 2012 +0200
+
+    Fixed double output of markdown attribute on HTML elements in kramdown converter
+
+lib/kramdown/converter/kramdown.rb
+
+commit a22b5d32623b5ae7f1ce7b38684fc8bb3228caed
+Merge: 46bd5f6 df8ff9d
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Thu Aug 30 01:57:56 2012 -0700
+
+    Merge pull request #17 from gioele/tests-on-ruby193
+    
+    Work around RakeTest problems with Ruby 1.9.3
+
+commit 4b5c0f8d59dac123a088b73a4f3a4b4a282fb5b9
+Author: Bran <m.versum@gmail.com>
+Date:   Thu Aug 30 10:45:44 2012 +0800
+
+    support disable coderay
+    
+    + add option `:enable_coderay`, which can be used to disable coderay.
+    the default vaule is `true` to be compatible with current behavior
+    + add content about it in doc
+
+doc/converter/html.page
+lib/kramdown/converter/html.rb
+lib/kramdown/options.rb
+test/testcases/block/06_codeblock/disable-highlighting.html
+test/testcases/block/06_codeblock/disable-highlighting.options
+test/testcases/block/06_codeblock/disable-highlighting.text
+
+commit df8ff9df6968993e73fcc3a8a08db94e4683a23d
+Author: Gioele Barabucci <gioele@svario.it>
+Date:   Wed Aug 29 18:52:39 2012 +0200
+
+    Work around RakeTest problems with Ruby 1.9.3
+    
+    Suggested by <https://github.com/jimweirich/rake/issues/51> and
+    <https://github.com/colszowka/simplecov/commit/9d64656555e0e75c04bd826f7a22d8cfcc58bfbd>.
+
+Rakefile
+
+commit 46bd5f670b674fe3dcd310069e334ac4d7a0b008
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue Aug 28 18:12:07 2012 +0200
+
+    Fixed line breaks and links in README.md
+
+README.md
+
+commit 7721cb3158d88c31218977cff478a0f1b4fdbb98
+Author: Bran <m.versum@gmail.com>
+Date:   Tue Aug 28 16:33:14 2012 +0800
+
+    Revise README
+    
+    + rename README to README.md
+    + revise the content
+
+README
+README.md
+
+commit 0c7ee71cde6eaf67b76ed048fda0c2dbdbd6480f
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Aug 10 22:09:50 2012 +0200
+
+    Fixed RF#29626: Link obfuscation did too much
+    
+    The text of a link with a mailto-scheme is now only obfuscated,
+    if the text of the link is the same as the linked-to email address.
+
+lib/kramdown/converter/html.rb
+test/testcases/span/autolinks/url_links.html
+test/testcases/span/autolinks/url_links.text
+
+commit 3b2a3abc41ab61ff3d581e78d527c89a1d6e61ed
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Aug 10 00:41:39 2012 +0200
+
+    Fixed problem with multiple similar abbreviatons
+    
+    When one abbreviation definition contains another (like CSS and CSS3), the
+    parser did not always do the right thing. Fixed that by making sure that
+    the longest abbreviations are replaced first.
+
+lib/kramdown/parser/kramdown/abbreviation.rb
+test/testcases/span/abbreviations/abbrev.html
+test/testcases/span/abbreviations/abbrev.text
+
+commit 0820af7cbd308fb857b93f7ca23c5c233598f696
+Merge: 70d9342 b5ec9e4
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Thu Aug 9 15:37:15 2012 -0700
+
+    Merge pull request #13 from alphagov/entities_in_abbr_titles
+    
+    Convert HMTL entities in abbreviation titles
+
+commit 70d9342820f6b146417a7e9b7f00d1c0d98407f0
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Thu Aug 9 23:45:36 2012 +0200
+
+    Fixed invalid documentation of default value of latex_headers option
+
+lib/kramdown/options.rb
+
+commit 1264a17dbd04c1e6abe7510961a7a4a57c33494c
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Thu Aug 9 16:22:10 2012 +0200
+
+    Updated implementation of header offsets
+    
+    * Updated header_offset documentation
+    * Moved implementation of header level calculation into helper method
+      defined on Converter::Base
+    * Latex and kramdown converters now use the header_offset option, too
+
+lib/kramdown/converter/base.rb
+lib/kramdown/converter/html.rb
+lib/kramdown/converter/kramdown.rb
+lib/kramdown/converter/latex.rb
+lib/kramdown/options.rb
+test/test_files.rb
+test/testcases/block/04_header/header_type_offset.html
+test/testcases/block/04_header/header_type_offset.kramdown
+test/testcases/block/04_header/header_type_offset.latex
+test/testcases/block/04_header/header_type_offset.text
+
+commit bfcd994349f7224d95b699235dc3755708112959
+Merge: be56987 e1ac291
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Wed Aug 8 22:49:52 2012 +0200
+
+    Merge branch 'master' of https://github.com/tillda/kramdown
+
+commit b5ec9e4fd765da62c1bfdbb307d379d955d0b0a4
+Author: Alex Tomlins <alex.tomlins@digital.cabinet-office.gov.uk>
+Date:   Fri Aug 3 13:01:47 2012 +0100
+
+    Convert entities in abbreviation titles
+    
+    previously if entities in abbreviation titles had reserved HTML chars in
+    them (e.g. &), these weren't converted to entities.  This causes errors
+    when processing the resulting markup in nokogiri and the like.
+
+lib/kramdown/converter/html.rb
+test/testcases/span/abbreviations/abbrev.html
+test/testcases/span/abbreviations/abbrev.text
+
+commit e1ac291052deb9e9e4185e13666446a8a784f533
+Author: Michal Till <michal.till@gmail.com>
+Date:   Thu Jul 5 15:32:15 2012 +0200
+
+    Add the ability to shift levels of all <Hx> elements by :header_offset option.
+
+lib/kramdown/converter/html.rb
+lib/kramdown/options.rb
+test/testcases/block/04_header/header_type_offset.html
+test/testcases/block/04_header/header_type_offset.options
+test/testcases/block/04_header/header_type_offset.text
+
+commit be56987fc283db3997d47a47ba93f7b6c48d562f
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Wed Jul 4 13:07:18 2012 +0200
+
+    Re-enabled MathJax on the kramdown website
+
+doc/default.template
+
 commit 0914bb652dad9ab1d48abc6de6da7a5ccc0e7996
 Author: Thomas Leitner <t_leitner@gmx.at>
 Date:   Sun Jun 3 09:48:58 2012 +0200

data/README.md

@@ -0,0 +1,50 @@
+# kramdown
+
+## Introduction
+
+kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and
+supporting several common extensions.
+
+The syntax definition for the kramdown syntax can be found in **doc/syntax.page** (or online at
+<http://kramdown.rubyforge.org/syntax.html>) and a quick reference is available in
+**doc/quickref.page** or online at <http://kramdown.rubyforge.org/quickref.html>.
+
+The kramdown library is mainly written to support the kramdown-to-HTML conversion chain. However,
+due to its flexibility it supports other input and output formats as well. Here is a list of the
+supported formats:
+
+* input formats: kramdown (a Markdown superset), Markdown, HTML
+* output formats: HTML, kramdown, LaTeX (and therefore PDF)
+
+All the documentation on the available input and output formats is available in the **doc/**
+directory and online at <http://kramdown.rubyforge.org>.
+
+
+## Usage
+
+kramdown has a basic *Cloth API, so using kramdown is as easy as
+
+```ruby
+require 'kramdown'
+
+Kramdown::Document.new(text).to_html
+```
+
+For detailed information have a look at the API documentation of the `Kramdown::Document` class.
+
+The full API documentation is available at <http://kramdown.rubyforge.org/rdoc/>, other sites with an
+API documentation for kramdown probably don't provide the complete documentation!
+
+
+## Development
+
+Just clone the git repository as described in **doc/installation.page** and you are good to go. You
+probably want to install `rake` so that you can use the provided rake tasks. Aside from that:
+
+* The `tidy` binary needs to be installed for the automatically derived tests to work.
+* The `latex` binary needs to be installed for the latex-compilation tests to work.
+
+
+## License
+
+GPLv3 - see the **COPYING** file.

data/Rakefile

@@ -85,6 +85,7 @@ if defined? Webgen
   Webgen::WebgenTask.new('htmldoc') do |site|
     site.clobber_outdir = true
     site.config_block = lambda do |config|
+      YAML::ENGINE.yamler = 'syck'
       config['sources'] = [['/', "Webgen::Source::FileSystem", 'doc']]
       config['output'] = ['Webgen::Output::FileSystem', 'htmldoc']
       config.default_processing_pipeline('Page' => 'erb,tags,kramdown,blocks,fragments')
@@ -103,8 +104,8 @@ if defined? RDoc::Task
   rd = RDoc::Task.new do |rdoc|
     rdoc.rdoc_dir = 'htmldoc/rdoc'
     rdoc.title = 'kramdown'
-    rdoc.main = 'README'
-    rdoc.rdoc_files.include('lib', 'README')
+    rdoc.main = 'lib/kramdown/document.rb'
+    rdoc.rdoc_files.include('lib')
   end
 end
 
@@ -116,6 +117,7 @@ end
 tt = Rake::TestTask.new do |test|
   test.warning = true
   test.libs << 'test'
+  test.test_files = FileList['test/test_*.rb']
 end
 
 # Release tasks and development tasks ############################################
@@ -137,7 +139,7 @@ EOF
   PKG_FILES = FileList.new([
                             'Rakefile',
                             'setup.rb',
-                            'COPYING', 'GPL', 'README', 'AUTHORS',
+                            'COPYING', 'GPL', 'README.md', 'AUTHORS',
                             'VERSION', 'ChangeLog', 'CONTRIBUTERS',
                             'bin/*',
                             'benchmark/*',
@@ -202,8 +204,7 @@ EOF
       #### Documentation
 
       s.has_rdoc = true
-      s.rdoc_options = ['--main', 'README']
-      s.extra_rdoc_files = 'README'
+      s.rdoc_options = ['--main', 'lib/kramdown/document.rb']
 
       #### Author and project details
 

data/VERSION

@@ -1 +1 @@
-0.13.7
+0.13.8

data/doc/default.template

@@ -8,7 +8,7 @@
     <meta name="keywords" content="ruby, kramdown, markdown, text markup" />
     <link href="{relocatable: default.css}" type="text/css" rel="stylesheet" media="screen,projection" />
     <link href="{relocatable: news.atom}" type="application/atom+xml" rel="alternate" />
-<!--    <script src="http://kramdown.rubyforge.org/MathJax/MathJax.js" type="text/javascript"></script> -->
+    <script src="http://kramdown.rubyforge.org/MathJax/MathJax.js" type="text/javascript"></script>
     <title>{title:} | kramdown</title>
   </head>
   <body>

data/doc/sidebar.template

@@ -1,7 +1,7 @@
 <h2>News</h2>
 
-<p>The latest version of kramdown is <b>0.13.7</b> and it was released
-on <b>2012-06-03</b>.</p>
+<p>The latest version of kramdown is <b>0.13.8</b> and it was released
+on <b>2012-08-31</b>.</p>
 
 <p>More <a href="{relocatable: news.html}">news</a>…</p>
 

data/lib/kramdown/converter/base.rb

@@ -135,6 +135,13 @@ module Kramdown
         @options[:toc_levels].include?(el.options[:level])
       end
 
+      # Return the output header level given a level.
+      #
+      # Uses the +header_offset+ option for adjusting the header level.
+      def output_header_level(level)
+        [[level + @options[:header_offset], 6].min, 1].max
+      end
+
       # Generate an unique alpha-numeric ID from the the string +str+ for use as a header ID.
       #
       # Uses the option +auto_id_prefix+: the value of this option is prepended to every generated

data/lib/kramdown/converter/html.rb

@@ -64,6 +64,7 @@ module Kramdown
         @toc_code = nil
         @indent = 2
         @stack = []
+        @coderay_enabled = @options[:enable_coderay] && HIGHLIGHTING_AVAILABLE
       end
 
       # The mapping of element type to conversion method.
@@ -108,7 +109,7 @@ module Kramdown
       end
 
       def convert_codeblock(el, indent)
-        if (el.attr['lang'] || @options[:coderay_default_lang]) && HIGHLIGHTING_AVAILABLE
+        if @coderay_enabled && (el.attr['lang'] || @options[:coderay_default_lang])
           attr = el.attr.dup
           opts = {:wrap => @options[:coderay_wrap], :line_numbers => @options[:coderay_line_numbers],
             :line_number_start => @options[:coderay_line_number_start], :tab_width => @options[:coderay_tab_width],
@@ -144,7 +145,8 @@ module Kramdown
           attr['id'] = generate_id(el.options[:raw_text])
         end
         @toc << [el.options[:level], attr['id'], el.children] if attr['id'] && in_toc?(el)
-        "#{' '*indent}<h#{el.options[:level]}#{html_attributes(attr)}>#{inner(el, indent)}</h#{el.options[:level]}>\n"
+        level = output_header_level(el.options[:level])
+        "#{' '*indent}<h#{level}#{html_attributes(attr)}>#{inner(el, indent)}</h#{level}>\n"
       end
 
       def convert_hr(el, indent)
@@ -253,8 +255,9 @@ module Kramdown
         res = inner(el, indent)
         attr = el.attr.dup
         if attr['href'] =~ /^mailto:/
-          attr['href'] = obfuscate('mailto') << ":" << obfuscate(attr['href'].sub(/^mailto:/, ''))
-          res = obfuscate(res)
+          mail_addr = attr['href'].sub(/^mailto:/, '')
+          attr['href'] = obfuscate('mailto') << ":" << obfuscate(mail_addr)
+          res = obfuscate(res) if res == mail_addr
         end
         "<a#{html_attributes(attr)}>#{res}</a>"
       end
@@ -264,7 +267,7 @@ module Kramdown
       end
 
       def convert_codespan(el, indent)
-        if el.attr['lang'] && HIGHLIGHTING_AVAILABLE
+        if @coderay_enabled && el.attr['lang']
           attr = el.attr.dup
           result = CodeRay.scan(el.value, attr.delete('lang').to_sym).html(:wrap => :span, :css => @options[:coderay_css]).chomp
           "<code#{html_attributes(attr)}>#{result}</code>"
@@ -322,7 +325,7 @@ module Kramdown
 
       def convert_abbreviation(el, indent)
         title = @root.options[:abbrev_defs][el.value]
-        "<abbr#{!title.empty? ? " title=\"#{title}\"" : ''}>#{el.value}</abbr>"
+        "<abbr#{!title.empty? ? html_attributes(:title => title) : ''}>#{el.value}</abbr>"
       end
 
       def convert_root(el, indent)

data/lib/kramdown/converter/kramdown.rb

@@ -117,7 +117,7 @@ module Kramdown
 
       def convert_header(el, opts)
         res = ''
-        res << "#{'#' * el.options[:level]} #{inner(el, opts)}"
+        res << "#{'#' * output_header_level(el.options[:level])} #{inner(el, opts)}"
         res << "   {##{el.attr['id']}}" if el.attr['id'] && !el.attr['id'].strip.empty?
         res << "\n"
       end
@@ -201,8 +201,9 @@ module Kramdown
           "<#{el.value}#{html_attributes(el.attr)}" << (!res.empty? || HTML_TAGS_WITH_BODY.include?(el.value) ? ">#{res}</#{el.value}>" : " />")
         else
           output = ''
-          output << "<#{el.value}#{html_attributes(el.attr)}"
-          output << " markdown=\"1\"" if markdown_attr
+          attr = el.attr.dup
+          attr['markdown'] = '1' if markdown_attr
+          output << "<#{el.value}#{html_attributes(attr)}"
           if !res.empty? && el.options[:content_model] != :block
             output << ">#{res}</#{el.value}>"
           elsif !res.empty?