markdown 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 572ba8737dad43b4418095cd939e563c1ff45df5
-  data.tar.gz: 336ed3026c0ccf05aa2fd95f3cb8d13919b435f9
+SHA256:
+  metadata.gz: 0ed84c4b937db4cf349543a726ff16c3ddd365bf7206eafbe2966ed26f6371d1
+  data.tar.gz: e5327c8150f5c110838080fea11eb48806ead136575b250ccc5d3512bc67fc62
 SHA512:
-  metadata.gz: 9612e63c040eee19e2368d5f0dd1409279a21110673ee4832a43b1cf9d3b3eba8d27f488ebae83aebd05c38d223f83bc8f3f4b8d114cce37be0baa00a86fbb3e
-  data.tar.gz: ab3eaef0889868e66ff6817b29556c0edf3fb4cab2723cbe07a25b5caef5c694a5a460b41326e3db36edda3c20a758a166638a4752bcb8d27152522a7a095eaf
+  metadata.gz: 53cb8e0a328532dfda9996b54719f3b3d8337d29171741b34abdb147bb4cb5e6cd1e8851a04a4579aece9b926bdbcc64726679d6bd89edfc8ce735e21586df7f
+  data.tar.gz: 30610a33cdcd3b0c3951f8617e77a81e753c3e84676e07b0ef28802c1a0e7961d3928d33de02a5195b45f1740fb7ceeb69ddb5e52a1173ba20f7fc44c6dcf079

data/HISTORY.md

@@ -1,3 +1,5 @@
+### 1.2.1
+
 ### 0.1 / 2012-05-26
 
 * Everything is new. First release

data/Manifest.txt

@@ -1,18 +1,15 @@
-HISTORY.md
-Manifest.txt
-README.md
-Rakefile
-lib/markdown.rb
-lib/markdown/config.rb
-lib/markdown/engines/bluecloth.rb
-lib/markdown/engines/kramdown.rb
-lib/markdown/engines/maruku.rb
-lib/markdown/engines/pandoc_ruby.rb
-lib/markdown/engines/rdiscount.rb
-lib/markdown/engines/redcarpet.rb
-lib/markdown/engines/rpeg_markdown.rb
-lib/markdown/version.rb
-lib/markdown/wrapper.rb
-test/helper.rb
-test/test_kramdown.rb
-test/test_redcarpet.rb
+HISTORY.md
+Manifest.txt
+README.md
+Rakefile
+lib/markdown.rb
+lib/markdown/config.rb
+lib/markdown/engines/bluecloth.rb
+lib/markdown/engines/kramdown.rb
+lib/markdown/engines/maruku.rb
+lib/markdown/engines/pandoc_ruby.rb
+lib/markdown/engines/rdiscount.rb
+lib/markdown/engines/redcarpet.rb
+lib/markdown/engines/rpeg_markdown.rb
+lib/markdown/version.rb
+lib/markdown/wrapper.rb

data/Rakefile

@@ -8,10 +8,10 @@ Hoe.spec 'markdown' do
   self.summary = 'Markdown Engine Wrapper - Use Your Markdown Library of Choice'
   self.description = summary
 
-  self.urls    = ['https://github.com/rubylibs/markdown']
+  self.urls    = { home: 'https://github.com/rubylibs/markdown' }
 
   self.author  = 'Gerald Bauer'
-  self.email   = 'webslideshow@googlegroups.com'
+  self.email   = 'gerald.bauer@gmail.com'
 
   self.extra_deps = [
     ['props','>= 1.1.2'],
@@ -19,7 +19,7 @@ Hoe.spec 'markdown' do
     ['kramdown','>= 1.5.0']
   ]
 
-  # switch extension to .markdown for gihub formatting
+  # switch extension to .markdown for github formatting
   self.readme_file  = 'README.md'
   self.history_file = 'HISTORY.md'
 

data/lib/markdown/config.rb

@@ -1,202 +1,202 @@
-# encoding: utf-8
-
-module Markdown
-
-  class Config
-
-# note: only kramdown is listed as a dependency in gem specs (because it's Ruby only and, thus, easy to install)
-#  if you want to use other markdown libs install the required/desired lib e.g.
-#  use  gem install rdiscount for rdiscount and so on
-#
-# also note for now the first present markdown library gets used
-#  the search order is first come, first serve, that is: rdiscount, rpeg-markdown, maruku, bluecloth, kramdown (fallback, always present)
-
-
-DEFAULT_EXTNAMES = [
-  '.markdown',
-  '.m',
-  '.mark',
-  '.mkdn',
-  '.md',
-  '.mdown',
-  '.markdn',
-  '.txt',
-  '.text' ]    # todo: check - add .wiki??? ext
-
-DEFAULT_REDCARPET = {
-  'extensions' => [
-    'no_intra_emphasis',
-    'fenced_code_blocks',
-    'tables',
-    'strikethrough' ] }
-
-DEFAULT_FILTERS = [
-  'comments-percent-style' ] # optional (preprocessing) text filters: e.g. comments-percent-style, skip-end-directive, etc. (see textutils gem)
-
-
-DEFAULTS = { 'libs'      => [ 'kramdown' ],    # note: make kramdown default engine
-             'extnames'  => DEFAULT_EXTNAMES,
-             'redcarpet' => DEFAULT_REDCARPET,   # todo/fix:  merge nested hash??
-             'filters' =>  DEFAULT_FILTERS
-           }
-
-#
-# pandoc-ruby  - how to include - gemfile cannot install binary ??
-# rpeg-markdown  - build failure - still active, anyway?
-# rdiscount - # compilation error on heroku; sorry excluded for now
-
-DEFAULTS_SERVICE = { 'libs' => [
-                'kramdown',   # note: make kramdown default engine
-                'maruku',
-                'bluecloth',
-                'redcarpet'
-                ],
-             'extnames'  => DEFAULT_EXTNAMES,
-             'redcarpet' => DEFAULT_REDCARPET
-           }
-
-    def load_props
-      @props = @props_default = Props.new( DEFAULTS, 'DEFAULTS' )
-
-      # check for user settings (markdown.yml) in home folder
-
-      ## todo: use .markdown.yml?? or differnt name ??
-      props_home_file = File.join( Env.home, 'markdown.yml' )
-      if File.exists?( props_home_file )
-        puts "Loading home settings from '#{props_home_file}'..."
-        @props = @props_home = Props.load_file( props_home_file, @props )
-      end
-      
-      # check for user settings (markdown.yml) in working folder
-    
-      props_work_file = File.join( '.', 'markdown.yml' )
-      if File.exists?( props_work_file )
-        puts "Loading work settings from '#{props_work_file}'..."
-        @props = @props_work = Props.load_file( props_work_file, @props )
-      end
-    end
-
-    def load_props_service
-      puts "Loading service settings..."
-      @props = @props_default = Props.new( DEFAULTS_SERVICE, 'DEFAULTS' )
-    end
-
-    def initialize
-
-      # for an example see ./boot.rb
-      if $MARKDOWN_USE_SERVICE_CONFIG == true
-        load_props_service
-      else
-        load_props
-      end
-      
-      @libs   = []
-      
-      require_markdown_libs()
-    end
-
-    def dump  # for debugging dump all settings
-      puts "Markdown settings:"
-      @props_default.dump   if @props_default
-      @props_home.dump      if @props_home
-      @props_work.dump      if @props_work
-      
-      puts
-      puts "Markdown libs:"
-      puts "  #{@libs.length} Markdown #{(@libs.length == 1) ? 'library' : 'libraries'} found: #{@libs.join(', ')}"
-    end
-
-    def markdown_extnames
-      @props.fetch( 'extnames', nil )
-    end
-    
-    def markdown_filters
-      @props.fetch( 'filters', nil )
-    end
-
-    def known_markdown_libs
-      # returns an array of known markdown engines e.g.
-      # [ 'pandoc-ruby', 'rdiscount', 'rpeg-markdown', 'maruku', 'bluecloth', 'kramdown' ]
-    
-      ## todo: allow single lib para instead of libs
-      ##  todo: allow ENV setting markdown_[select]_lib=xxxx
-    
-      ## todo/fix: use lookup with config parent cascade
-    
-    
-      ## lookup order
-      ## 1)  env variable MARKDOWN_LIB
-      ## 2)  lib property (single markdown engine)
-      ## 3)  libs property (first-come first-serve markdown engine list)
-
-      user_lib = Env.markdown_lib || @props.fetch( 'lib', nil )
-
-      if user_lib.nil?
-        user_libs = @props.fetch( 'libs', nil )
-      else
-        [ user_lib ]  # return as array (wrap single lib entry)  
-      end
-    end
-
-    def require_markdown_libs
-      # check for available markdown libs/gems
-      # try to require each lib and remove any not installed
-
-      known_markdown_libs.each do |lib|
-        begin
-          require lib
-          @libs << lib
-        rescue LoadError => ex
-          ## todo: use logger.debug  instead of puts
-          puts "Markdown library #{lib} not found. Use gem install #{lib} to install."
-        end
-      end
-    end
-
-    def markdown_lib=( lib )
-      
-      # fix/todo: check if @libs.first == lib  => do nothing; return
-      
-      # check if value exists in libs array
-      # if yes put it into first position
-      # otherwise issue warning/error - better throw exception; engine not found
-      
-      # try to delete 
-      obj = @libs.delete( lib )
-      if obj.nil?  # nothing deleted; no obj found
-        # try to require; will raise load error exception if not found; know what your're doing! no fallback; sorry; better fail fast
-        require lib
-      end
- 
-      # add it back; make it first entry
-      @libs.unshift( lib )
-    end
-
-    def markdown_lib
-      @libs.first
-    end
-    
-    def markdown_libs
-      @libs  # NB: return all libs - should we return a clone?
-    end
-    
-    def markdown_lib_defaults( lib=nil )
-      lib = @libs.first   if lib.nil?
-      ## todo: return props ? that acts like a hash?? (lets us support section lookup without deep merge???)
-      opts = @props.fetch( lib, {} )
-    end
-
-    def markdown_version_method( lib=nil )
-      lib  = @libs.first   if lib.nil?
-      method = "#{lib.downcase}_version"  # default to <lib>_to_html if converter prop not found    
-      method.tr('-','_').to_sym
-    end
-
-    def markdown_to_html_method( lib=nil )
-      lib  = @libs.first   if lib.nil?
-      method = @props.fetch_from_section( lib, 'converter', "#{lib.downcase}_to_html" )  # default to <lib>_to_html if converter prop not found    
-      method.tr('-','_').to_sym
-    end
-
-  end # class Config
-end # module Markdown
+# encoding: utf-8
+
+module Markdown
+
+  class Config
+
+# note: only kramdown is listed as a dependency in gem specs (because it's Ruby only and, thus, easy to install)
+#  if you want to use other markdown libs install the required/desired lib e.g.
+#  use  gem install rdiscount for rdiscount and so on
+#
+# also note for now the first present markdown library gets used
+#  the search order is first come, first serve, that is: rdiscount, rpeg-markdown, maruku, bluecloth, kramdown (fallback, always present)
+
+
+DEFAULT_EXTNAMES = [
+  '.markdown',
+  '.m',
+  '.mark',
+  '.mkdn',
+  '.md',
+  '.mdown',
+  '.markdn',
+  '.txt',
+  '.text' ]    # todo: check - add .wiki??? ext
+
+DEFAULT_REDCARPET = {
+  'extensions' => [
+    'no_intra_emphasis',
+    'fenced_code_blocks',
+    'tables',
+    'strikethrough' ] }
+
+DEFAULT_FILTERS = [
+  'comments-percent-style' ] # optional (preprocessing) text filters: e.g. comments-percent-style, skip-end-directive, etc. (see textutils gem)
+
+
+DEFAULTS = { 'libs'      => [ 'kramdown' ],    # note: make kramdown default engine
+             'extnames'  => DEFAULT_EXTNAMES,
+             'redcarpet' => DEFAULT_REDCARPET,   # todo/fix:  merge nested hash??
+             'filters' =>  DEFAULT_FILTERS
+           }
+
+#
+# pandoc-ruby  - how to include - gemfile cannot install binary ??
+# rpeg-markdown  - build failure - still active, anyway?
+# rdiscount - # compilation error on heroku; sorry excluded for now
+
+DEFAULTS_SERVICE = { 'libs' => [
+                'kramdown',   # note: make kramdown default engine
+                'maruku',
+                'bluecloth',
+                'redcarpet'
+                ],
+             'extnames'  => DEFAULT_EXTNAMES,
+             'redcarpet' => DEFAULT_REDCARPET
+           }
+
+    def load_props
+      @props = @props_default = Props.new( DEFAULTS, 'DEFAULTS' )
+
+      # check for user settings (markdown.yml) in home folder
+
+      ## todo: use .markdown.yml?? or differnt name ??
+      props_home_file = File.join( Env.home, 'markdown.yml' )
+      if File.exist?( props_home_file )
+        puts "Loading home settings from '#{props_home_file}'..."
+        @props = @props_home = Props.load_file( props_home_file, @props )
+      end
+      
+      # check for user settings (markdown.yml) in working folder
+    
+      props_work_file = File.join( '.', 'markdown.yml' )
+      if File.exist?( props_work_file )
+        puts "Loading work settings from '#{props_work_file}'..."
+        @props = @props_work = Props.load_file( props_work_file, @props )
+      end
+    end
+
+    def load_props_service
+      puts "Loading service settings..."
+      @props = @props_default = Props.new( DEFAULTS_SERVICE, 'DEFAULTS' )
+    end
+
+    def initialize
+
+      # for an example see ./boot.rb
+      if $MARKDOWN_USE_SERVICE_CONFIG == true
+        load_props_service
+      else
+        load_props
+      end
+      
+      @libs   = []
+      
+      require_markdown_libs()
+    end
+
+    def dump  # for debugging dump all settings
+      puts "Markdown settings:"
+      @props_default.dump   if @props_default
+      @props_home.dump      if @props_home
+      @props_work.dump      if @props_work
+      
+      puts
+      puts "Markdown libs:"
+      puts "  #{@libs.length} Markdown #{(@libs.length == 1) ? 'library' : 'libraries'} found: #{@libs.join(', ')}"
+    end
+
+    def markdown_extnames
+      @props.fetch( 'extnames', nil )
+    end
+    
+    def markdown_filters
+      @props.fetch( 'filters', nil )
+    end
+
+    def known_markdown_libs
+      # returns an array of known markdown engines e.g.
+      # [ 'pandoc-ruby', 'rdiscount', 'rpeg-markdown', 'maruku', 'bluecloth', 'kramdown' ]
+    
+      ## todo: allow single lib para instead of libs
+      ##  todo: allow ENV setting markdown_[select]_lib=xxxx
+    
+      ## todo/fix: use lookup with config parent cascade
+    
+    
+      ## lookup order
+      ## 1)  env variable MARKDOWN_LIB
+      ## 2)  lib property (single markdown engine)
+      ## 3)  libs property (first-come first-serve markdown engine list)
+
+      user_lib = Env.markdown_lib || @props.fetch( 'lib', nil )
+
+      if user_lib.nil?
+        user_libs = @props.fetch( 'libs', nil )
+      else
+        [ user_lib ]  # return as array (wrap single lib entry)  
+      end
+    end
+
+    def require_markdown_libs
+      # check for available markdown libs/gems
+      # try to require each lib and remove any not installed
+
+      known_markdown_libs.each do |lib|
+        begin
+          require lib
+          @libs << lib
+        rescue LoadError => ex
+          ## todo: use logger.debug  instead of puts
+          puts "Markdown library #{lib} not found. Use gem install #{lib} to install."
+        end
+      end
+    end
+
+    def markdown_lib=( lib )
+      
+      # fix/todo: check if @libs.first == lib  => do nothing; return
+      
+      # check if value exists in libs array
+      # if yes put it into first position
+      # otherwise issue warning/error - better throw exception; engine not found
+      
+      # try to delete 
+      obj = @libs.delete( lib )
+      if obj.nil?  # nothing deleted; no obj found
+        # try to require; will raise load error exception if not found; know what your're doing! no fallback; sorry; better fail fast
+        require lib
+      end
+ 
+      # add it back; make it first entry
+      @libs.unshift( lib )
+    end
+
+    def markdown_lib
+      @libs.first
+    end
+    
+    def markdown_libs
+      @libs  # NB: return all libs - should we return a clone?
+    end
+    
+    def markdown_lib_defaults( lib=nil )
+      lib = @libs.first   if lib.nil?
+      ## todo: return props ? that acts like a hash?? (lets us support section lookup without deep merge???)
+      opts = @props.fetch( lib, {} )
+    end
+
+    def markdown_version_method( lib=nil )
+      lib  = @libs.first   if lib.nil?
+      method = "#{lib.downcase}_version"  # default to <lib>_to_html if converter prop not found    
+      method.tr('-','_').to_sym
+    end
+
+    def markdown_to_html_method( lib=nil )
+      lib  = @libs.first   if lib.nil?
+      method = @props.fetch_from_section( lib, 'converter', "#{lib.downcase}_to_html" )  # default to <lib>_to_html if converter prop not found    
+      method.tr('-','_').to_sym
+    end
+
+  end # class Config
+end # module Markdown

data/lib/markdown/engines/bluecloth.rb

@@ -1,17 +1,17 @@
-# encoding: utf-8
-
-module Markdown
-  module Engine
-
-    def bluecloth_version
-      BlueCloth::VERSION
-    end
-
-    def bluecloth_to_html( content, options={} )
-      puts "  Converting Markdown-text (#{content.length} bytes) to HTML using library bluecloth..."
-
-      BlueCloth.new( content ).to_html
-    end
-    
-  end # module Engine
-end # module Markdown
+# encoding: utf-8
+
+module Markdown
+  module Engine
+
+    def bluecloth_version
+      BlueCloth::VERSION
+    end
+
+    def bluecloth_to_html( content, options={} )
+      puts "  Converting Markdown-text (#{content.length} bytes) to HTML using library bluecloth..."
+
+      BlueCloth.new( content ).to_html
+    end
+    
+  end # module Engine
+end # module Markdown

data/lib/markdown/engines/kramdown.rb

@@ -1,62 +1,62 @@
-# encoding: utf-8
-
-module Markdown
-  module Engine
-
-    def kramdown_version
-      Kramdown::VERSION
-    end
-
-    def kramdown_to_html( content, options={} )
-
-      h = {}
-      
-      # todo: find an easier (more generic?) way to setup hash - possible?
-      h[ :auto_ids    ]   = options.fetch( 'auto_ids', nil )     if options.fetch( 'auto_ids',      nil )
-      h[ :footnote_nr ]   = options.fetch( 'footnote_nr',nil )   if options.fetch( 'footnote_nr',   nil )
-      h[ :entity_output ] = options.fetch( 'entity_output',nil ) if options.fetch( 'entity_output', nil )
-      h[ :toc_levels ]    = options.fetch( 'toc_levels',nil )    if options.fetch( 'toc_levels',    nil )
-      h[ :smart_quotes ]  = options.fetch( 'smart_quotes',nil )  if options.fetch( 'smart_quotes',  nil )
-      
-      show_banner =  options.fetch( 'banner', true)
-
-      # puts "  Converting Markdown-text (#{content.length} bytes) to HTML using library kramdown (#{Kramdown::VERSION})"
-      # puts "  using options: #{h.to_json}"
-
-      ## allow fenced blocks a la github flavored markup
-      # -- thanks zenweb for inspiration:
-      #  https://github.com/seattlerb/zenweb/blob/master/lib/zenweb/plugins/markdown.rb
-
-      content = content.
-        gsub(/^``` *(\w+)/) { "{:lang=\"#$1\"}\n~~~" }.
-        gsub(/^```/, '~~~')
-      
-      content = Kramdown::Document.new( content, h ).to_html
-      
-      if show_banner
-
-       # todo: check content size and newlines
-       #  check banner option?
-       #  only add banner if some newlines and size > treshold?
-      
-      banner_begin =<<EOS
-<!-- === begin markdown block ===
-
-      generated by #{Markdown.banner}
-                on #{Time.now} with Markdown engine kramdown (#{Kramdown::VERSION})
-                  using options #{h.to_json}
-  -->
-EOS
-
-       banner_end =<<EOS
-<!-- === end markdown block === -->
-EOS
-        content = banner_begin + content + banner_end
-      end # if show_banner
-
-      content
-
-    end
-
-  end # module Engine
-end # module Markdown
+# encoding: utf-8
+
+module Markdown
+  module Engine
+
+    def kramdown_version
+      Kramdown::VERSION
+    end
+
+    def kramdown_to_html( content, options={} )
+
+      h = {}
+      
+      # todo: find an easier (more generic?) way to setup hash - possible?
+      h[ :auto_ids    ]   = options.fetch( 'auto_ids', nil )     if options.fetch( 'auto_ids',      nil )
+      h[ :footnote_nr ]   = options.fetch( 'footnote_nr',nil )   if options.fetch( 'footnote_nr',   nil )
+      h[ :entity_output ] = options.fetch( 'entity_output',nil ) if options.fetch( 'entity_output', nil )
+      h[ :toc_levels ]    = options.fetch( 'toc_levels',nil )    if options.fetch( 'toc_levels',    nil )
+      h[ :smart_quotes ]  = options.fetch( 'smart_quotes',nil )  if options.fetch( 'smart_quotes',  nil )
+      
+      show_banner =  options.fetch( 'banner', true)
+
+      # puts "  Converting Markdown-text (#{content.length} bytes) to HTML using library kramdown (#{Kramdown::VERSION})"
+      # puts "  using options: #{h.to_json}"
+
+      ## allow fenced blocks a la github flavored markup
+      # -- thanks zenweb for inspiration:
+      #  https://github.com/seattlerb/zenweb/blob/master/lib/zenweb/plugins/markdown.rb
+
+      content = content.
+        gsub(/^``` *(\w+)/) { "{:lang=\"#$1\"}\n~~~" }.
+        gsub(/^```/, '~~~')
+      
+      content = Kramdown::Document.new( content, h ).to_html
+      
+      if show_banner
+
+       # todo: check content size and newlines
+       #  check banner option?
+       #  only add banner if some newlines and size > treshold?
+      
+      banner_begin =<<EOS
+<!-- === begin markdown block ===
+
+      generated by #{Markdown.banner}
+                on #{Time.now} with Markdown engine kramdown (#{Kramdown::VERSION})
+                  using options #{h.to_json}
+  -->
+EOS
+
+       banner_end =<<EOS
+<!-- === end markdown block === -->
+EOS
+        content = banner_begin + content + banner_end
+      end # if show_banner
+
+      content
+
+    end
+
+  end # module Engine
+end # module Markdown