kramdown 1.17.0 → 2.0.0.beta1

data/lib/kramdown/converter/man.rb

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -17,14 +17,14 @@ module Kramdown
     # man-pages(7) for information regarding the output.
     class Man < Base
 
-      def convert(el, opts = {:indent => 0, :result => ''}) #:nodoc:
+      def convert(el, opts = {indent: 0, result: +''}) #:nodoc:
         send("convert_#{el.type}", el, opts)
       end
 
       private
 
       def inner(el, opts, use = :all)
-        arr = el.children.reject {|e| e.type == :blank}
+        arr = el.children.reject {|e| e.type == :blank }
         arr.each_with_index do |inner_el, index|
           next if use == :rest && index == 0
           break if use == :first && index > 0
@@ -39,15 +39,15 @@ module Kramdown
 
       def convert_root(el, opts)
         @title_done = false
-        opts[:result] = ".\\\" generated by kramdown\n"
+        opts[:result] = +".\\\" generated by kramdown\n"
         inner(el, opts)
         opts[:result]
       end
 
       def convert_blank(*)
       end
-      alias :convert_hr :convert_blank
-      alias :convert_xml_pi :convert_blank
+      alias convert_hr convert_blank
+      alias convert_xml_pi convert_blank
 
       def convert_p(el, opts)
         if (opts[:index] != 0 && opts[:prev].type != :header) ||
@@ -104,8 +104,8 @@ module Kramdown
         inner(el, opts)
         opts[:result] << macro("PD") if compact
       end
-      alias :convert_dl :convert_ul
-      alias :convert_ol :convert_ul
+      alias convert_dl convert_ul
+      alias convert_ol convert_ul
 
       def convert_li(el, opts)
         sym = (opts[:parent].type == :ul ? '\(bu' : "#{opts[:index] + 1}.")
@@ -134,19 +134,19 @@ module Kramdown
         opts[:result] << macro("sp") if opts[:next] && opts[:next].type == :dd
       end
 
-      TABLE_CELL_ALIGNMENT = {:left => 'l', :center => 'c', :right => 'r', :default => 'l'}
+      TABLE_CELL_ALIGNMENT = {left: 'l', center: 'c', right: 'r', default: 'l'}
 
       def convert_table(el, opts)
-        opts[:alignment] = el.options[:alignment].map {|a| TABLE_CELL_ALIGNMENT[a]}
+        opts[:alignment] = el.options[:alignment].map {|a| TABLE_CELL_ALIGNMENT[a] }
         table_options = ["box"]
         table_options << "center" if el.attr['class'] =~ /\bcenter\b/
-        opts[:result] << macro("TS") << "#{table_options.join(" ")} ;\n"
+        opts[:result] << macro("TS") << "#{table_options.join(' ')} ;\n"
         inner(el, opts)
         opts[:result] << macro("TE") << macro("sp")
       end
 
       def convert_thead(el, opts)
-        opts[:result] << opts[:alignment].map {|a| "#{a}b"}.join(' ') << " .\n"
+        opts[:result] << opts[:alignment].map {|a| "#{a}b" }.join(' ') << " .\n"
         inner(el, opts)
         opts[:result] << "=\n"
       end
@@ -169,7 +169,7 @@ module Kramdown
 
       def convert_td(el, opts)
         result = opts[:result]
-        opts[:result] = ''
+        opts[:result] = +''
         inner(el, opts)
         if opts[:result] =~ /\n/
           warning("Table cells using links are not supported")
@@ -186,8 +186,7 @@ module Kramdown
       def convert_xml_comment(el, opts)
         newline(opts[:result]) << ".\"#{escape(el.value, true).rstrip.gsub(/\n/, "\n.\"")}\n"
       end
-      alias :convert_comment :convert_xml_comment
-
+      alias convert_comment convert_xml_comment
 
       def convert_a(el, opts)
         if el.children.size == 1 && el.children[0].type == :text &&
@@ -203,7 +202,7 @@ module Kramdown
         end
       end
 
-      def convert_img(el, opts)
+      def convert_img(_el, _opts)
         warning("Images are not supported")
       end
 
@@ -223,7 +222,7 @@ module Kramdown
         opts[:result] << "\\fB#{escape(el.value)}\\fP"
       end
 
-      def convert_br(el, opts)
+      def convert_br(_el, opts)
         newline(opts[:result]) << macro("br")
       end
 
@@ -247,11 +246,9 @@ module Kramdown
         warning("Raw content is not supported")
       end
 
-
-
       def convert_text(el, opts)
         text = escape(el.value)
-        text.lstrip! if opts[:result][-1] == ?\n
+        text.lstrip! if opts[:result][-1] == "\n"
         opts[:result] << text
       end
 
@@ -264,8 +261,8 @@ module Kramdown
       end
 
       TYPOGRAPHIC_SYMS_MAP = {
-        :mdash => '\(em', :ndash => '\(em', :hellip => '\.\.\.',
-        :laquo_space => '\[Fo]', :raquo_space => '\[Fc]', :laquo => '\[Fo]', :raquo => '\[Fc]'
+        mdash: '\(em', ndash: '\(em', hellip: '\.\.\.',
+        laquo_space: '\[Fo]', raquo_space: '\[Fc]', laquo: '\[Fo]', raquo: '\[Fc]'
       }
 
       def convert_typographic_sym(el, opts)
@@ -277,7 +274,7 @@ module Kramdown
       end
 
       def newline(text)
-        text << "\n" unless text[-1] == ?\n
+        text << "\n" unless text[-1] == "\n"
         text
       end
 
@@ -289,7 +286,7 @@ module Kramdown
         text = (preserve_whitespace ? text.dup : text.gsub(/\s+/, ' '))
         text.gsub!('\\', "\\e")
         text.gsub!(/^\./, '\\\\&.')
-        text.gsub!(/[.'-]/) {|m| "\\#{m}"}
+        text.gsub!(/[.'-]/) {|m| "\\#{m}" }
         text
       end
 

data/lib/kramdown/converter/math_engine/mathjax.rb

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -17,17 +17,17 @@ module Kramdown::Converter::MathEngine
 
     def self.call(converter, el, opts)
       type = el.options[:category]
-      text = (el.value =~ /<|&/ ? "% <![CDATA[\n#{el.value} %]]>" : el.value)
+      text = (el.value =~ /<|&/ ? "% <![CDATA[\n#{el.value} %]]>" : el.value).dup
       text.gsub!(/<\/?script>?/, '')
 
-      preview = preview_string(converter, el, opts)
+      preview = preview_string(converter, el, opts).dup
 
-      attr = {:type => "math/tex#{type == :block ? '; mode=display' : ''}"}
-      if type == :block
-        preview << converter.format_as_block_html('script', attr, text, opts[:indent])
-      else
-        preview << converter.format_as_span_html('script', attr, text)
-      end
+      attr = {type: "math/tex#{type == :block ? '; mode=display' : ''}"}
+      preview << if type == :block
+                   converter.format_as_block_html('script', attr, text, opts[:indent])
+                 else
+                   converter.format_as_span_html('script', attr, text)
+                 end
     end
 
     def self.preview_string(converter, el, opts)

data/lib/kramdown/converter/remove_html_tags.rb

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

data/lib/kramdown/converter/syntax_highlighter.rb

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

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

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

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

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -18,14 +18,14 @@ module Kramdown::Converter::SyntaxHighlighter
       # Highlighting via Rouge is available if this constant is +true+.
       AVAILABLE = true
     rescue LoadError, SyntaxError
-      AVAILABLE = false  # :nodoc:
+      AVAILABLE = false # :nodoc:
     end
 
     def self.call(converter, text, lang, type, call_opts)
       opts = options(converter, type)
       call_opts[:default_lang] = opts[:default_lang]
       lexer = ::Rouge::Lexer.find_fancy(lang || opts[:default_lang], text)
-      return nil if opts[:disable] || !lexer
+      return nil if opts[:disable] || !lexer || lexer.tag == "plaintext"
       opts[:css_class] ||= 'highlight' # For backward compatibility when using Rouge 2.0
       formatter = formatter_class(opts).new(opts)
       formatter.format(lexer.lex(text))
@@ -50,7 +50,7 @@ module Kramdown::Converter::SyntaxHighlighter
         end
       end
 
-      cache[:span] = opts.merge(span_opts).update(:wrap => false)
+      cache[:span] = opts.merge(span_opts).update(wrap: false)
       cache[:block] = opts.merge(block_opts)
     end
 

data/lib/kramdown/converter/toc.rb

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -37,7 +37,7 @@ module Kramdown
           attr['id'] = generate_id(el.options[:raw_text]) if @options[:auto_ids] && !attr['id']
           add_to_toc(el, attr['id']) if attr['id']
         else
-          el.children.each {|child| convert(child)}
+          el.children.each {|child| convert(child) }
         end
         @toc
       end
@@ -45,10 +45,10 @@ module Kramdown
       private
 
       def add_to_toc(el, id)
-        toc_element = Element.new(:toc, el, :id => id)
+        toc_element = Element.new(:toc, el, id: id)
 
         success = false
-        while !success
+        until success
           if @stack.empty?
             @toc.children << toc_element
             @stack << toc_element

data/lib/kramdown/document.rb

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -47,16 +47,15 @@ module Kramdown
 
   # Return the data directory for kramdown.
   def self.data_dir
-    unless defined?(@@data_dir)
+    unless defined?(@data_dir)
       require 'rbconfig'
-      @@data_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'data', 'kramdown'))
-      @@data_dir = File.expand_path(File.join(RbConfig::CONFIG["datadir"], "kramdown")) if !File.exist?(@@data_dir)
-      raise "kramdown data directory not found! This is a bug, please report it!" unless File.directory?(@@data_dir)
+      @data_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'data', 'kramdown'))
+      @data_dir = File.expand_path(File.join(RbConfig::CONFIG["datadir"], "kramdown")) unless File.exist?(@data_dir)
+      raise "kramdown data directory not found! This is a bug, please report it!" unless File.directory?(@data_dir)
     end
-    @@data_dir
+    @data_dir
   end
 
-
   # The main interface to kramdown.
   #
   # This class provides a one-stop-shop for using kramdown to convert text into various output
@@ -84,7 +83,6 @@ module Kramdown
     # ::new) and the conversion phase.
     attr_reader :warnings
 
-
     # Create a new Kramdown document from the string +source+ and use the provided +options+. The
     # options that can be used are defined in the Options module.
     #
@@ -103,7 +101,8 @@ module Kramdown
       if Parser.const_defined?(parser)
         @root, @warnings = Parser.const_get(parser).parse(source, @options)
       else
-        raise Kramdown::Error.new("kramdown has no parser to handle the specified input format: #{@options[:input]}")
+        raise Kramdown::Error, "kramdown has no parser to handle the specified " \
+          "input format: #{@options[:input]}"
       end
     end
 
@@ -138,4 +137,3 @@ module Kramdown
   end
 
 end
-

data/lib/kramdown/element.rb

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -482,17 +482,16 @@ module Kramdown
     # The child elements of this element.
     attr_accessor :children
 
-
     # Create a new Element object of type +type+. The optional parameters +value+, +attr+ and
     # +options+ can also be set in this constructor for convenience.
     def initialize(type, value = nil, attr = nil, options = nil)
-      @type, @value, @attr, @options = type, value, (Utils::OrderedHash.new.merge!(attr) if attr), options
+      @type, @value, @attr, @options = type, value, attr, options
       @children = []
     end
 
-    # The attributes of the element. Uses an Utils::OrderedHash to retain the insertion order.
+    # The attributes of the element.
     def attr
-      @attr ||= Utils::OrderedHash.new
+      @attr ||= {}
     end
 
     # The options hash for the element. It is used for storing arbitray options.
@@ -501,13 +500,16 @@ module Kramdown
     end
 
     def inspect #:nodoc:
-      "<kd:#{@type}#{@value.nil? ? '' : ' ' + @value.inspect} #{@attr.inspect}#{options.empty? ? '' : ' ' + @options.inspect}#{@children.empty? ? '' : ' ' + @children.inspect}>"
+      "<kd:#{@type}#{@value.nil? ? '' : ' ' + @value.inspect} " \
+        "#{@attr.inspect}#{options.empty? ? '' : ' ' + @options.inspect} " \
+        "#{@children.empty? ? '' : ' ' + @children.inspect}>"
     end
 
     CATEGORY = {} # :nodoc:
-    [:blank, :p, :header, :blockquote, :codeblock, :ul, :ol, :li, :dl, :dt, :dd, :table, :td, :hr].each {|b| CATEGORY[b] = :block}
+    [:blank, :p, :header, :blockquote, :codeblock, :ul, :ol, :li, :dl, :dt, :dd,
+     :table, :td, :hr].each {|b| CATEGORY[b] = :block }
     [:text, :a, :br, :img, :codespan, :footnote, :em, :strong, :entity, :typographic_sym,
-     :smart_quote, :abbreviation].each {|b| CATEGORY[b] = :span}
+     :smart_quote, :abbreviation].each {|b| CATEGORY[b] = :span }
 
     # Return the category of +el+ which can be :block, :span or +nil+.
     #

data/lib/kramdown/error.rb

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++

data/lib/kramdown/options.rb

@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2016 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
 # This file is part of kramdown which is licensed under the MIT.
 #++
@@ -49,8 +49,8 @@ module Kramdown
     # a value given as string and as the opaque type.
     def self.define(name, type, default, desc, &block)
       name = name.to_sym
-      raise ArgumentError, "Option name #{name} is already used" if @options.has_key?(name)
-      raise ArgumentError, "Invalid option type #{type} specified" if !ALLOWED_TYPES.include?(type)
+      raise ArgumentError, "Option name #{name} is already used" if @options.key?(name)
+      raise ArgumentError, "Invalid option type #{type} specified" unless ALLOWED_TYPES.include?(type)
       raise ArgumentError, "Invalid type for default value" if !(type === default) && !default.nil?
       raise ArgumentError, "Missing validator block" if type == Object && block.nil?
       @options[name] = Definition.new(name, type, default, desc, block)
@@ -63,13 +63,13 @@ module Kramdown
 
     # Return +true+ if an option called +name+ is defined.
     def self.defined?(name)
-      @options.has_key?(name.to_sym)
+      @options.key?(name.to_sym)
     end
 
     # Return a Hash with the default values for all options.
     def self.defaults
       temp = {}
-      @options.each {|n, o| temp[o.name] = o.default}
+      @options.each {|_n, o| temp[o.name] = o.default }
       temp
     end
 
@@ -77,9 +77,9 @@ module Kramdown
     # names are considered and their value is run through the #parse method.
     def self.merge(hash)
       temp = defaults
-      hash.each do |k,v|
+      hash.each do |k, v|
         k = k.to_sym
-        @options.has_key?(k) ? temp[k] = parse(k, v) : temp[k] = v
+        temp[k] = @options.key?(k) ? parse(k, v) : v
       end
       temp
     end
@@ -91,8 +91,8 @@ module Kramdown
     # String and then to the correct type.
     def self.parse(name, data)
       name = name.to_sym
-      raise ArgumentError, "No option named #{name} defined" if !@options.has_key?(name)
-      if !(@options[name].type === data)
+      raise ArgumentError, "No option named #{name} defined" unless @options.key?(name)
+      unless @options[name].type === data
         data = data.to_s
         data = if @options[name].type == String
                  data
@@ -117,7 +117,7 @@ module Kramdown
     # - An empty value or a value equal to "nil" results in +nil+.
     def self.str_to_sym(data)
       data = data.strip
-      data = data[1..-1] if data[0] == ?:
+      data = data[1..-1] if data[0] == ':'
       (data.empty? || data == 'nil' ? nil : data.to_sym)
     end
 
@@ -154,12 +154,12 @@ module Kramdown
     def self.simple_hash_validator(val, name)
       if String === val
         begin
-          val = YAML.load(val)
+          val = YAML.safe_load(val)
         rescue RuntimeError, ArgumentError, SyntaxError
           raise Kramdown::Error, "Invalid YAML value for option #{name}"
         end
       end
-      raise Kramdown::Error, "Invalid type #{val.class} for option #{name}" if !(Hash === val)
+      raise Kramdown::Error, "Invalid type #{val.class} for option #{name}" unless Hash === val
       val
     end
 
@@ -170,134 +170,134 @@ module Kramdown
     # parsers/converters.
     # ----------------------------
 
-    define(:template, String, '', <<EOF)
-The name of an ERB template file that should be used to wrap the output
-or the ERB template itself.
+    define(:template, String, '', <<~EOF)
+      The name of an ERB template file that should be used to wrap the output
+      or the ERB template itself.
 
-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.
+      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.
 
-When resolving the template file, the given template name is used first.
-If such a file is not found, the converter extension (the same as the
-converter name) 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). If the file is still not
-found, the template name is checked if it starts with 'string://' and if
-it does, this prefix is removed and the rest is used as template
-content.
+      When resolving the template file, the given template name is used first.
+      If such a file is not found, the converter extension (the same as the
+      converter name) 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). If the file is still not
+      found, the template name is checked if it starts with 'string://' and if
+      it does, this prefix is removed and the rest is used as template
+      content.
 
-kramdown provides a default template named 'document' for each converter.
+      kramdown provides a default template named 'document' for each converter.
 
-Default: ''
-Used by: all converters
-EOF
+      Default: ''
+      Used by: all converters
+    EOF
 
-    define(:auto_ids, Boolean, true, <<EOF)
-Use automatic header ID generation
+    define(:auto_ids, Boolean, true, <<~EOF)
+      Use automatic header ID generation
 
-If this option is `true`, ID values for all headers are automatically
-generated if no ID is explicitly specified.
+      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
-EOF
+      Default: true
+      Used by: HTML/Latex converter
+    EOF
 
-    define(:auto_id_stripping, Boolean, false, <<EOF)
-Strip all formatting from header text for automatic ID generation
+    define(:auto_id_stripping, Boolean, false, <<~EOF)
+      Strip all formatting from header text for automatic ID generation
 
-If this option is `true`, only the text elements of a header are used
-for generating the ID later (in contrast to just using the raw header
-text line).
+      If this option is `true`, only the text elements of a header are used
+      for generating the ID later (in contrast to just using the raw header
+      text line).
 
-This option will be removed in version 2.0 because this will be the
-default then.
+      This option will be removed in version 2.0 because this will be the
+      default then.
 
-Default: false
-Used by: kramdown parser
-EOF
+      Default: false
+      Used by: kramdown parser
+    EOF
 
-    define(:auto_id_prefix, String, '', <<EOF)
-Prefix used for automatically generated header IDs
+    define(:auto_id_prefix, String, '', <<~EOF)
+      Prefix used for automatically generated header 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!
+      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
-EOF
+      Default: ''
+      Used by: HTML/Latex converter
+    EOF
 
-    define(:transliterated_header_ids, Boolean, false, <<EOF)
-Transliterate the header text before generating the ID
+    define(:transliterated_header_ids, Boolean, false, <<~EOF)
+      Transliterate the header text before generating the ID
 
-Only ASCII characters are used in headers IDs. This is not good for
-languages with many non-ASCII characters. By enabling this option
-the header text is transliterated to ASCII as good as possible so that
-the resulting header ID is more useful.
+      Only ASCII characters are used in headers IDs. This is not good for
+      languages with many non-ASCII characters. By enabling this option
+      the header text is transliterated to ASCII as good as possible so that
+      the resulting header ID is more useful.
 
-The stringex library needs to be installed for this feature to work!
+      The stringex library needs to be installed for this feature to work!
 
-Default: false
-Used by: HTML/Latex converter
-EOF
+      Default: false
+      Used by: HTML/Latex converter
+    EOF
 
-    define(:parse_block_html, Boolean, false, <<EOF)
-Process kramdown syntax in block HTML tags
+    define(:parse_block_html, Boolean, false, <<~EOF)
+      Process kramdown syntax in block HTML tags
 
-If this option is `true`, the kramdown parser processes the content of
-block HTML tags as text containing block-level elements. Since this is
-not wanted normally, the default is `false`. It is normally better to
-selectively enable kramdown processing via the markdown attribute.
+      If this option is `true`, the kramdown parser processes the content of
+      block HTML tags as text containing block-level elements. Since this is
+      not wanted normally, the default is `false`. It is normally better to
+      selectively enable kramdown processing via the markdown attribute.
 
-Default: false
-Used by: kramdown parser
-EOF
+      Default: false
+      Used by: kramdown parser
+    EOF
 
-    define(:parse_span_html, Boolean, true, <<EOF)
-Process kramdown syntax in span HTML tags
+    define(:parse_span_html, Boolean, true, <<~EOF)
+      Process kramdown syntax in span HTML tags
 
-If this option is `true`, the kramdown parser processes the content of
-span HTML tags as text containing span-level elements.
+      If this option is `true`, the kramdown parser processes the content of
+      span HTML tags as text containing span-level elements.
 
-Default: true
-Used by: kramdown parser
-EOF
+      Default: true
+      Used by: kramdown parser
+    EOF
 
-    define(:html_to_native, Boolean, false, <<EOF)
-Convert HTML elements to native elements
+    define(:html_to_native, Boolean, false, <<~EOF)
+      Convert HTML elements to native elements
 
-If this option is `true`, the parser converts HTML elements to native
-elements. For example, when parsing `<em>hallo</em>` the emphasis tag
-would normally be converted to an `:html` element with tag type `:em`.
-If `html_to_native` is `true`, then the emphasis would be converted to a
-native `:em` element.
+      If this option is `true`, the parser converts HTML elements to native
+      elements. For example, when parsing `<em>hallo</em>` the emphasis tag
+      would normally be converted to an `:html` element with tag type `:em`.
+      If `html_to_native` is `true`, then the emphasis would be converted to a
+      native `:em` element.
 
-This is useful for converters that cannot deal with HTML elements.
+      This is useful for converters that cannot deal with HTML elements.
 
-Default: false
-Used by: kramdown parser
-EOF
+      Default: false
+      Used by: kramdown parser
+    EOF
 
-    define(:link_defs, Object, {}, <<EOF) do |val|
-Pre-defines link definitions
+    define(:link_defs, Object, {}, <<~EOF) do |val|
+      Pre-defines link definitions
 
-This option can be used to pre-define link definitions. The value needs
-to be a Hash where the keys are the link identifiers and the values are
-two element Arrays with the link URL and the link title.
+      This option can be used to pre-define link definitions. The value needs
+      to be a Hash where the keys are the link identifiers and the values are
+      two element Arrays with the link URL and the link title.
 
-If the value is a String, it has to contain a valid YAML hash and the
-hash has to follow the above guidelines.
+      If the value is a String, it has to contain a valid YAML hash and the
+      hash has to follow the above guidelines.
 
-Default: {}
-Used by: kramdown parser
-EOF
+      Default: {}
+      Used by: kramdown parser
+    EOF
       val = simple_hash_validator(val, :link_defs)
-      val.each do |k,v|
-        if !(Array === v) || v.size > 2 || v.size < 1
+      val.each do |_k, v|
+        if !(Array === v) || v.size > 2 || v.empty?
           raise Kramdown::Error, "Invalid structure for hash value of option #{name}"
         end
         v << nil if v.size == 1
@@ -305,198 +305,118 @@ EOF
       val
     end
 
-    define(:footnote_nr, Integer, 1, <<EOF)
-The number of the first footnote
+    define(:footnote_nr, Integer, 1, <<~EOF)
+      The number of the first footnote
 
-This option can be used to specify the number that is used for the first
-footnote.
+      This option can be used to specify the number that is used for the first
+      footnote.
 
-Default: 1
-Used by: HTML converter
-EOF
+      Default: 1
+      Used by: HTML converter
+    EOF
 
-    define(:enable_coderay, Boolean, true, <<EOF)
-Use coderay for syntax highlighting
+    define(:entity_output, Symbol, :as_char, <<~EOF)
+      Defines how entities are output
 
-If this option is `true`, coderay is used by the HTML converter for
-syntax highlighting the content of code spans and code blocks.
+      The possible values are :as_input (entities are output in the same
+      form as found in the input), :numeric (entities are output in numeric
+      form), :symbolic (entities are output in symbolic form if possible) or
+      :as_char (entities are output as characters if possible, only available
+      on Ruby 1.9).
 
-Default: true
-Used by: HTML converter
-EOF
+      Default: :as_char
+      Used by: HTML converter, kramdown converter
+    EOF
 
-    define(:coderay_wrap, Symbol, :div, <<EOF)
-Defines how the highlighted code should be wrapped
+    define(:toc_levels, Object, (1..6).to_a, <<~EOF) do |val|
+      Defines the levels that are used for the table of contents
 
-The possible values are :span, :div or nil.
+      The individual levels can be specified by separating them with commas
+      (e.g. 1,2,3) or by using the range syntax (e.g. 1..3). Only the
+      specified levels are used for the table of contents.
 
-Default: :div
-Used by: HTML converter
-EOF
-
-    define(:coderay_line_numbers, Symbol, :inline, <<EOF)
-Defines how and if line numbers should be shown
-
-The possible values are :table, :inline or nil. If this option is
-nil, no line numbers are shown.
-
-Default: :inline
-Used by: HTML converter
-EOF
-
-    define(:coderay_line_number_start, Integer, 1, <<EOF)
-The start value for the line numbers
-
-Default: 1
-Used by: HTML converter
-EOF
-
-    define(:coderay_tab_width, Integer, 8, <<EOF)
-The tab width used in highlighted code
-
-Used by: HTML converter
-EOF
-
-    define(:coderay_bold_every, Object, 10, <<EOF) do |val|
-Defines how often a line number should be made bold
-
-Can either be an integer or false (to turn off bold line numbers
-completely).
-
-Default: 10
-Used by: HTML converter
-EOF
-      if val == false || val.to_s == 'false'
-        false
-      else
-        Integer(val.to_s) rescue raise Kramdown::Error, "Invalid value for option 'coderay_bold_every'"
-      end
-end
-
-    define(:coderay_css, Symbol, :style, <<EOF)
-Defines how the highlighted code gets styled
-
-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: style
-Used by: HTML converter
-EOF
-
-    define(:coderay_default_lang, Symbol, nil, <<EOF)
-Sets the default language for highlighting code blocks
-
-If no language is set for a code block, the default language is used
-instead. The value has to be one of the languages supported by coderay
-or nil if no default language should be used.
-
-Default: nil
-Used by: HTML converter
-EOF
-
-    define(:entity_output, Symbol, :as_char, <<EOF)
-Defines how entities are output
-
-The possible values are :as_input (entities are output in the same
-form as found in the input), :numeric (entities are output in numeric
-form), :symbolic (entities are output in symbolic form if possible) or
-:as_char (entities are output as characters if possible, only available
-on Ruby 1.9).
-
-Default: :as_char
-Used by: HTML converter, kramdown converter
-EOF
-
-    define(:toc_levels, Object, (1..6).to_a, <<EOF) do |val|
-Defines the levels that are used for the table of contents
-
-The individual levels can be specified by separating them with commas
-(e.g. 1,2,3) or by using the range syntax (e.g. 1..3). Only the
-specified levels are used for the table of contents.
-
-Default: 1..6
-Used by: HTML/Latex converter
-EOF
+      Default: 1..6
+      Used by: HTML/Latex converter
+    EOF
       case val
       when String
         if val =~ /^(\d)\.\.(\d)$/
           val = Range.new($1.to_i, $2.to_i).to_a
         elsif val =~ /^\d(?:,\d)*$/
-          val = val.split(/,/).map {|s| s.to_i}.uniq
+          val = val.split(/,/).map(&:to_i).uniq
         else
           raise Kramdown::Error, "Invalid syntax for option toc_levels"
         end
       when Array, Range
-        val = val.map {|s| s.to_i}.uniq
+        val = val.map(&:to_i).uniq
       else
         raise Kramdown::Error, "Invalid type #{val.class} for option toc_levels"
       end
-      if val.any? {|i| !(1..6).include?(i)}
+      if val.any? {|i| !(1..6).cover?(i) }
         raise Kramdown::Error, "Level numbers for option toc_levels have to be integers from 1 to 6"
       end
       val
     end
 
-    define(:line_width, Integer, 72, <<EOF)
-Defines the line width to be used when outputting a document
+    define(:line_width, Integer, 72, <<~EOF)
+      Defines the line width to be used when outputting a document
 
-Default: 72
-Used by: kramdown converter
-EOF
+      Default: 72
+      Used by: kramdown converter
+    EOF
 
-    define(:latex_headers, Object, %w{section subsection subsubsection paragraph subparagraph subparagraph}, <<EOF) do |val|
-Defines the LaTeX commands for different header levels
+    define(:latex_headers, Object, %w[section subsection subsubsection paragraph subparagraph subparagraph], <<~EOF) do |val|
+      Defines the LaTeX commands for different header levels
 
-The commands for the header levels one to six can be specified by
-separating them with commas.
+      The commands for the header levels one to six can be specified by
+      separating them with commas.
 
-Default: section,subsection,subsubsection,paragraph,subparagraph,subparagraph
-Used by: Latex converter
-EOF
+      Default: section,subsection,subsubsection,paragraph,subparagraph,subparagraph
+      Used by: Latex converter
+    EOF
       simple_array_validator(val, :latex_headers, 6)
     end
 
-    define(:smart_quotes, Object, %w{lsquo rsquo ldquo rdquo}, <<EOF) do |val|
-Defines the HTML entity names or code points for smart quote output
+    define(:smart_quotes, Object, %w[lsquo rsquo ldquo rdquo], <<~EOF) do |val|
+      Defines the HTML entity names or code points for smart quote output
 
-The entities identified by entity name or code point that should be
-used for, in order, a left single quote, a right single quote, a left
-double and a right double quote are specified by separating them with
-commas.
+      The entities identified by entity name or code point that should be
+      used for, in order, a left single quote, a right single quote, a left
+      double and a right double quote are specified by separating them with
+      commas.
 
-Default: lsquo,rsquo,ldquo,rdquo
-Used by: HTML/Latex converter
-EOF
+      Default: lsquo,rsquo,ldquo,rdquo
+      Used by: HTML/Latex converter
+    EOF
       val = simple_array_validator(val, :smart_quotes, 4)
-      val.map! {|v| Integer(v) rescue v}
+      val.map! {|v| Integer(v) rescue v }
       val
     end
 
-    define(:typographic_symbols, Object, {}, <<EOF) do |val|
-Defines a mapping from typographical symbol to output characters
+    define(:typographic_symbols, Object, {}, <<~EOF) do |val|
+      Defines a mapping from typographical symbol to output characters
 
-Typographical symbols are normally output using their equivalent Unicode
-codepoint. However, sometimes one wants to change the output, mostly to
-fallback to a sequence of ASCII characters.
+      Typographical symbols are normally output using their equivalent Unicode
+      codepoint. However, sometimes one wants to change the output, mostly to
+      fallback to a sequence of ASCII characters.
 
-This option allows this by specifying a mapping from typographical
-symbol to its output string. For example, the mapping {hellip: ...} would
-output the standard ASCII representation of an ellipsis.
+      This option allows this by specifying a mapping from typographical
+      symbol to its output string. For example, the mapping {hellip: ...} would
+      output the standard ASCII representation of an ellipsis.
 
-The available typographical symbol names are:
+      The available typographical symbol names are:
 
-* hellip: ellipsis
-* mdash: em-dash
-* ndash: en-dash
-* laquo: left guillemet
-* raquo: right guillemet
-* laquo_space: left guillemet followed by a space
-* raquo_space: right guillemet preceeded by a space
+      * hellip: ellipsis
+      * mdash: em-dash
+      * ndash: en-dash
+      * laquo: left guillemet
+      * raquo: right guillemet
+      * laquo_space: left guillemet followed by a space
+      * raquo_space: right guillemet preceeded by a space
 
-Default: {}
-Used by: HTML/Latex converter
-EOF
+      Default: {}
+      Used by: HTML/Latex converter
+    EOF
       val = simple_hash_validator(val, :typographic_symbols)
       val.keys.each do |k|
         val[k.kind_of?(String) ? str_to_sym(k) : k] = val.delete(k).to_s
@@ -504,73 +424,63 @@ EOF
       val
     end
 
-    define(:remove_block_html_tags, Boolean, true, <<EOF)
-Remove block HTML tags
+    define(:remove_block_html_tags, Boolean, true, <<~EOF)
+      Remove block HTML tags
 
-If this option is `true`, the RemoveHtmlTags converter removes
-block HTML tags.
+      If this option is `true`, the RemoveHtmlTags converter removes
+      block HTML tags.
 
-Default: true
-Used by: RemoveHtmlTags converter
-EOF
+      Default: true
+      Used by: RemoveHtmlTags converter
+    EOF
 
-    define(:remove_span_html_tags, Boolean, false, <<EOF)
-Remove span HTML tags
+    define(:remove_span_html_tags, Boolean, false, <<~EOF)
+      Remove span HTML tags
 
-If this option is `true`, the RemoveHtmlTags converter removes
-span HTML tags.
+      If this option is `true`, the RemoveHtmlTags converter removes
+      span HTML tags.
 
-Default: false
-Used by: RemoveHtmlTags converter
-EOF
+      Default: false
+      Used by: RemoveHtmlTags converter
+    EOF
 
-    define(:header_offset, Integer, 0, <<EOF)
-Sets the output offset for headers
+    define(:header_offset, Integer, 0, <<~EOF)
+      Sets the output offset for headers
 
-If this option is c (may also be negative) then a header with level n
-will be output as a header with level c+n. If c+n is lower than 1,
-level 1 will be used. If c+n is greater than 6, level 6 will be used.
+      If this option is c (may also be negative) then a header with level n
+      will be output as a header with level c+n. If c+n is lower than 1,
+      level 1 will be used. If c+n is greater than 6, level 6 will be used.
 
-Default: 0
-Used by: HTML converter, Kramdown converter, Latex converter
-EOF
+      Default: 0
+      Used by: HTML converter, Kramdown converter, Latex converter
+    EOF
 
-    define(:hard_wrap, Boolean, true, <<EOF)
-Interprets line breaks literally
+    define(:syntax_highlighter, Symbol, :rouge, <<~EOF)
+      Set the syntax highlighter
 
-Insert HTML `<br />` tags inside paragraphs where the original Markdown
-document had newlines (by default, Markdown ignores these newlines).
+      Specifies the syntax highlighter that should be used for highlighting
+      code blocks and spans. If this option is set to +nil+, no syntax
+      highlighting is done.
 
-Default: true
-Used by: GFM parser
-EOF
+      Options for the syntax highlighter can be set with the
+      syntax_highlighter_opts configuration option.
 
-    define(:syntax_highlighter, Symbol, :coderay, <<EOF)
-Set the syntax highlighter
+      Default: rouge
+      Used by: HTML/Latex converter
+    EOF
 
-Specifies the syntax highlighter that should be used for highlighting
-code blocks and spans. If this option is set to +nil+, no syntax
-highlighting is done.
+    define(:syntax_highlighter_opts, Object, {}, <<~EOF) do |val|
+      Set the syntax highlighter options
 
-Options for the syntax highlighter can be set with the
-syntax_highlighter_opts configuration option.
+      Specifies options for the syntax highlighter set via the
+      syntax_highlighter configuration option.
 
-Default: coderay
-Used by: HTML/Latex converter
-EOF
+      The value needs to be a hash with key-value pairs that are understood by
+      the used syntax highlighter.
 
-    define(:syntax_highlighter_opts, Object, {}, <<EOF) do |val|
-Set the syntax highlighter options
-
-Specifies options for the syntax highlighter set via the
-syntax_highlighter configuration option.
-
-The value needs to be a hash with key-value pairs that are understood by
-the used syntax highlighter.
-
-Default: {}
-Used by: HTML/Latex converter
-EOF
+      Default: {}
+      Used by: HTML/Latex converter
+    EOF
       val = simple_hash_validator(val, :syntax_highlighter_opts)
       val.keys.each do |k|
         val[k.kind_of?(String) ? str_to_sym(k) : k] = val.delete(k)
@@ -578,32 +488,32 @@ EOF
       val
     end
 
-    define(:math_engine, Symbol, :mathjax, <<EOF)
-Set the math engine
+    define(:math_engine, Symbol, :mathjax, <<~EOF)
+      Set the math engine
 
-Specifies the math engine that should be used for converting math
-blocks/spans. If this option is set to +nil+, no math engine is used and
-the math blocks/spans are output as is.
+      Specifies the math engine that should be used for converting math
+      blocks/spans. If this option is set to +nil+, no math engine is used and
+      the math blocks/spans are output as is.
 
-Options for the selected math engine can be set with the
-math_engine_opts configuration option.
+      Options for the selected math engine can be set with the
+      math_engine_opts configuration option.
 
-Default: mathjax
-Used by: HTML converter
-EOF
+      Default: mathjax
+      Used by: HTML converter
+    EOF
 
-    define(:math_engine_opts, Object, {}, <<EOF) do |val|
-Set the math engine options
+    define(:math_engine_opts, Object, {}, <<~EOF) do |val|
+      Set the math engine options
 
-Specifies options for the math engine set via the math_engine
-configuration option.
+      Specifies options for the math engine set via the math_engine
+      configuration option.
 
-The value needs to be a hash with key-value pairs that are understood by
-the used math engine.
+      The value needs to be a hash with key-value pairs that are understood by
+      the used math engine.
 
-Default: {}
-Used by: HTML converter
-EOF
+      Default: {}
+      Used by: HTML converter
+    EOF
       val = simple_hash_validator(val, :math_engine_opts)
       val.keys.each do |k|
         val[k.kind_of?(String) ? str_to_sym(k) : k] = val.delete(k)
@@ -611,70 +521,34 @@ EOF
       val
     end
 
-    define(:footnote_backlink, String, '&#8617;', <<EOF)
-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.
+    define(:footnote_backlink, String, '&#8617;', <<~EOF)
+      Defines the text that should be used for the footnote backlinks
 
-Default: '&8617;'
-Used by: HTML converter
-EOF
+      The footnote backlink is just text, so any special HTML characters will
+      be escaped.
 
-    define(:footnote_backlink_inline, Boolean, false, <<EOF)
-Specifies whether the footnote backlink should always be inline
+      If the footnote backlint text is an empty string, no footnote backlinks
+      will be generated.
 
-With the default of false the footnote backlink is placed at the end of
-the last paragraph if there is one, or an extra paragraph with only the
-footnote backlink is created.
+      Default: '&8617;'
+      Used by: HTML converter
+    EOF
 
-Setting this option to true tries to place the footnote backlink in the
-last, possibly nested paragraph or header. If this fails (e.g. in the
-case of a table), an extra paragraph with only the footnote backlink is
-created.
+    define(:footnote_backlink_inline, Boolean, false, <<~EOF)
+      Specifies whether the footnote backlink should always be inline
 
-Default: false
-Used by: HTML converter
-EOF
+      With the default of false the footnote backlink is placed at the end of
+      the last paragraph if there is one, or an extra paragraph with only the
+      footnote backlink is created.
 
-    define(:gfm_quirks, Object, [:paragraph_end], <<EOF) do |val|
-Enables a set of GFM specific quirks
+      Setting this option to true tries to place the footnote backlink in the
+      last, possibly nested paragraph or header. If this fails (e.g. in the
+      case of a table), an extra paragraph with only the footnote backlink is
+      created.
 
-The way how GFM is transformed on Github often differs from the way
-kramdown does things. Many of these differences are negligible but
-others are not.
-
-This option allows one to enable/disable certain GFM quirks, i.e. ways
-in which GFM parsing differs from kramdown parsing.
-
-The value has to be a list of quirk names that should be enabled,
-separated by commas. Possible names are:
-
-* paragraph_end
-
-  Disables the kramdown restriction that at least one blank line has to
-  be used after a paragraph before a new block element can be started.
-
-  Note that if this quirk is used, lazy line wrapping does not fully
-  work anymore!
-
-* no_auto_typographic
-
-  Disables automatic conversion of some characters into their
-  corresponding typographic symbols (like `--` to em-dash etc).
-  This helps to achieve results closer to what GitHub Flavored
-  Markdown produces.
-
-Default: paragraph_end
-Used by: GFM parser
-EOF
-      val = simple_array_validator(val, :gfm_quirks)
-      val.map! {|v| str_to_sym(v.to_s)}
-      val
-    end
+      Default: false
+      Used by: HTML converter
+    EOF
 
   end