markdown 0.2.0.beta1 → 0.2.0

data/Manifest.txt

@@ -10,6 +10,7 @@ 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/gen.rb
 lib/markdown/wrapper.rb

data/bin/markdown

@@ -12,8 +12,6 @@
 #    % chmod a+x bin/markdown
 #
 
-
-require 'rubygems'
 require 'markdown'
 
 Markdown.main

data/lib/markdown.rb

@@ -32,6 +32,7 @@ require 'markdown/engines/kramdown'
 require 'markdown/engines/maruku'
 require 'markdown/engines/pandoc_ruby'
 require 'markdown/engines/rdiscount'
+require 'markdown/engines/redcarpet'
 require 'markdown/engines/rpeg_markdown'
 require 'markdown/wrapper'
 require 'markdown/gen'
@@ -39,7 +40,7 @@ require 'markdown/gen'
 
 module Markdown
 
-  VERSION = '0.2.0.beta1'
+  VERSION = '0.2.0'
 
   # version string for generator meta tag (includes ruby version)
   def self.banner

data/lib/markdown/config.rb

@@ -30,8 +30,15 @@ DEFAULTS = { 'libs' => [
                 '.mdown',
                 '.markdn',
                 '.txt',
-                '.text' ]  # todo: check - add .wiki??? ext
-           }
+                '.text' ],  # todo: check - add .wiki??? ext
+             'redcarpet' => {
+                 'extensions' => [
+                    'no_intra_emphasis',
+                    'fenced_code_blocks',
+                    'tables',
+                    'strikethrough' ]   # todo/fix:  merge nested hash??
+              },
+            }
 
   
     def initialize
@@ -39,9 +46,8 @@ DEFAULTS = { 'libs' => [
 
       # check for user settings (markdown.yml) in home folder 
 
-      ## todo/fix: use join path???
       ## todo: use .markdown.yml?? or differnt name ??
-      props_home_file = "#{Env.home}/markdown.yml"      
+      props_home_file = File.join( Env.home, 'markdown.yml' )      
       if File.exists?( props_home_file )
         puts "Loading settings from '#{props_home_file}'..."
         @props = @props_home = Props.load_file( props_home_file, @props )
@@ -49,14 +55,13 @@ DEFAULTS = { 'libs' => [
       
       # check for user settings (markdown.yml) in working folder 
     
-      props_work_file = "./markdown.yml"
+      props_work_file = File.join( '.', 'markdown.yml' )
       if File.exists?( props_work_file )
         puts "Loading settings from '#{props_work_file}'..."
         @props = @props_work = Props.load_file( props_work_file, @props )
       end
 
       @libs   = []
-      @mn     = nil   # markdown converter method name (mn) e.g. kramdown_to_html
       
       require_markdown_libs()
     end
@@ -105,13 +110,17 @@ DEFAULTS = { 'libs' => [
         end
       end
 
-      puts "  Found #{@libs.length} Markdown libraries: #{@libs.join(', ')}"
+      puts "  Found #{@libs.length} Markdown #{(@libs.length == 1) ? 'library' : 'libraries'}: #{@libs.join(', ')}"
     end
 
     def markdown_lib
       @libs.first
     end
     
+    def markdown_lib_defaults
+      opts = @props.fetch( @libs.first, {} )
+    end
+    
     def markdown_to_html_method
       lib  = @libs.first
       opts = @props.fetch( lib, {} )

data/lib/markdown/engines/bluecloth.rb

@@ -1,7 +1,9 @@
 module Markdown
   module Engine
 
-    def bluecloth_to_html( content )
+    def bluecloth_to_html( content, options={} )
+      puts "  Converting Markdown-text (#{@content.length} bytes) to HTML using library bluecloth..."
+
       BlueCloth.new( content ).to_html
     end
     

data/lib/markdown/engines/kramdown.rb

@@ -1,9 +1,51 @@
 module Markdown
   module Engine
 
-    def kramdown_to_html( content )
-      Kramdown::Document.new( content ).to_html
-    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 )
+
+      puts "  Converting Markdown-text (#{@content.length} bytes) to HTML using library kramdown (#{Kramdown::VERSION})"
+      puts "  using options:"
+      pp h    # todo: use inspect? or 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
+      
+      # 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 { !to be done! }
+  -->
+EOS
+
+       banner_end =<<EOS
+<!-- === end markdown block ===================================================== -->
+EOS
+
+      content = banner_begin + content + banner_end
+      
+    end
 
   end # module Engine
-end # module Markdown    
+end # module Markdown

data/lib/markdown/engines/maruku.rb

@@ -1,7 +1,9 @@
 module Markdown
   module Engine
    
-    def maruku_to_html( content )
+    def maruku_to_html( content, options={} )
+      puts "  Converting Markdown-text (#{@content.length} bytes) to HTML using library maruku..."
+            
       Maruku.new( content, {:on_error => :raise} ).to_html
     end
 

data/lib/markdown/engines/pandoc_ruby.rb

@@ -1,11 +1,13 @@
 module Markdown
   module Engine
    
-    def pandoc_ruby_to_html( content )
+    def pandoc_ruby_to_html( content, options={} )
+      puts "  Converting Markdown-text (#{@content.length} bytes) to HTML using library pandoc_ruby..."
+
       content = PandocRuby.new( content, :from => :markdown, :to => :html ).convert
     end
   
-    def pandoc_ruby_to_html_incremental( content )
+    def pandoc_ruby_to_html_incremental( content, options={} )
       content = PandocRuby.new( content, :from => :markdown, :to => :html ).convert
       content = content.gsub(/<(ul|ol)/) do |match|
         "#{Regexp.last_match(0)} class='step'"
@@ -18,13 +20,13 @@ module Markdown
     # pandoc-ruby:
     #  converter: pandoc-ruby-to-s5
   
-    def pandoc_ruby_to_s5( content )
+    def pandoc_ruby_to_s5( content, options={} )
       content = PandocRuby.new( content, {:from => :markdown, :to => :s5}, :smart ).convert
       content = content.gsub(/class="incremental"/,'class="step"')
       content = content.to_a[13..-1].join # remove the layout div
     end
 
-    def pandoc_ruby_to_s5_incremental( content )
+    def pandoc_ruby_to_s5_incremental( content, options={} )
       content = PandocRuby.new( content, {:from => :markdown, :to => :s5 }, :incremental, :smart ).convert
       content = content.gsub(/class="incremental"/,'class="step"')
       content = content.to_a[13..-1].join # remove the layout div

data/lib/markdown/engines/rdiscount.rb

@@ -1,7 +1,9 @@
 module Markdown
   module Engine
    
-    def rdiscount_to_html( content )
+    def rdiscount_to_html( content, options={} )
+      puts "  Converting Markdown-text (#{@content.length} bytes) to HTML using library rdiscount..."      
+      
       RDiscount.new( content ).to_html
     end
 

data/lib/markdown/engines/redcarpet.rb

@@ -0,0 +1,46 @@
+module Markdown
+  module Engine
+
+    def redcarpet_to_html( content, options={} )
+      
+      ## NB: uses redcarpet2
+      #
+      # see https://github.com/tanoku/redcarpet
+      
+      extensions_ary = options.fetch( 'extensions', [] )
+      
+      extensions_hash = {}
+      extensions_ary.each do |e|
+        extensions_hash[ e.to_sym ] = true
+      end
+
+      puts "  Converting Markdown-text (#{@content.length} bytes) to HTML using library redcarpet (#{Redcarpet::VERSION}) w/ HTML render"      
+      puts "  using extensions: [#{extensions_ary.join(', ')}]"
+      
+      redcarpet = Redcarpet::Markdown.new( Redcarpet::Render::HTML, extensions_hash )
+      content = redcarpet.render( content )
+
+      # 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 redcarpet (#{Redcarpet::VERSION}) w/ HTML render
+                  using extensions: [#{extensions_ary.join(', ')}]
+  -->
+EOS
+
+       banner_end =<<EOS
+<!-- === end markdown block ===================================================== -->
+EOS
+
+      content = banner_begin + content + banner_end
+      
+      
+    end
+
+  end # module Engine
+end # module Markdown

data/lib/markdown/engines/rpeg_markdown.rb

@@ -1,7 +1,9 @@
 module Markdown
   module Engine
 
-    def rpeg_markdown_to_html( content )
+    def rpeg_markdown_to_html( content, options={} )
+      puts "  Converting Markdown-text (#{@content.length} bytes) to HTML using library rpeg_markdown..."
+
       PEGMarkdown.new( content ).to_html
     end
 

data/lib/markdown/gen.rb

@@ -25,67 +25,67 @@ module Markdown
       @opts         = Opts.new
     end
 
-
-    def with_output_path( dest, output_path )
-      dest_full = File.expand_path( dest, output_path )
-      logger.debug "dest_full=#{dest_full}"
-      
-      # make sure dest path exists
-      dest_path = File.dirname( dest_full )
-      logger.debug "dest_path=#{dest_path}"
-      FileUtils.makedirs( dest_path ) unless File.directory? dest_path
-      dest_full
-    end
-
     def create_doc( fn )
- 
-      # expand output path in current dir and make sure output path exists
-      outpath = File.expand_path( opts.output_path ) 
-      logger.debug "outpath=#{outpath}"
-      FileUtils.makedirs( outpath ) unless File.directory? outpath 
-
-      dirname  = File.dirname( fn )    
+      dirname  = File.dirname(  fn )    
       basename = File.basename( fn, '.*' )
-      extname  = File.extname( fn )
+      extname  = File.extname(  fn )
+
       logger.debug "dirname=#{dirname}, basename=#{basename}, extname=#{extname}"
 
-      # change working dir to sourcefile dir
+      if opts.output_path == '.'
+        # expand output path in current dir
+        outpath = File.expand_path( dirname ) 
+      else
+        # expand output path in user supplied dir and make sure output path exists
+        outpath = File.expand_path( opts.output_path ) 
+        FileUtils.makedirs( outpath ) unless File.directory? outpath 
+      end
+      logger.debug "outpath=#{outpath}"
+      
       # todo: add a -c option to commandline? to let you set cwd?
-    
+
+
+      # change working dir to sourcefile dir (that is, dirname); push working folder/dir
       newcwd  = File.expand_path( dirname )
       oldcwd  = File.expand_path( Dir.pwd )
     
-      unless newcwd == oldcwd then
-        logger.debug "oldcwd=#{oldcwd}"
-        logger.debug "newcwd=#{newcwd}"
-        Dir.chdir newcwd
+      unless newcwd == oldcwd
+        logger.debug "oldcwd=>#{oldcwd}<, newcwd=>#{newcwd}<"
+        Dir.chdir( newcwd )
       end  
 
-      inname  =  "#{dirname}/#{basename}#{extname}"
-
-      puts "Reading document '#{basename}#{extname} (in folder #{dirname})'..."
+      inname  = "#{basename}#{extname}"
+      outname = "#{basename}.html"
       
+      logger.debug "inname=#{inname}, outname=#{outname}"
+      
+      puts "*** #{inname} (#{dirname}) => #{outname} (#{(opts.output_path == '.') ? dirname : opts.output_path})..."
       
-      logger.debug "inname=#{inname}"
-    
       content = File.read( inname )
+      content = Markdown.new( content ).to_html  # convert light-weight markup to hypertext
 
-      # convert light-weight markup to hypertext
 
-      content = Markdown.new( content ).to_html
-
-      outname = "#{basename}.html"
-      puts "Preparing #{outname} (in folder #{outpath})..."
-
-      out = File.new( with_output_path( outname, outpath ), "w+" )
-      out << "<!-- ======================================================================\n"
-      out << "      generated by #{Markdown.banner}\n"
-      out << "                on #{Time.now} with Markdown engine '#{Markdown.lib}'\n"
-      out << "     ====================================================================== -->\n"
+## todo: add Markdown.lib_options inspect/dump to banner
+            
+      banner =<<EOS
+<!-- ======================================================================
+      generated by #{Markdown.banner}
+                on #{Time.now} with Markdown engine '#{Markdown.lib}'
+     ====================================================================== -->
+EOS
+      
+      out = File.new( File.join( outpath, outname ), "w+" )
+####      out << banner
       out << content
       out.flush
       out.close
 
+      ## pop/restore working folder/dir
+      unless newcwd == oldcwd
+        logger.debug "oldcwd=>#{oldcwd}<, newcwd=>#{newcwd}<"
+        Dir.chdir( oldcwd )
+      end  
+            
     end # method create_doc
 
 
@@ -107,8 +107,9 @@ module Markdown
       logger.debug "dirname=#{dirname}, basename=#{basename}, extname=#{extname}"
 
       Markdown.extnames.each do |e|
-        logger.debug "File.exists? #{dirname}/#{basename}#{e}"
-        return "#{dirname}/#{basename}#{e}" if File.exists?( "#{dirname}/#{basename}#{e}" )
+        newname = File.join( dirname, "#{basename}#{e}" ) 
+        logger.debug "File.exists? #{newname}"
+        return newname if File.exists?( newname )
       end  # each extension (e)
       
       nil   # not found; return nil
@@ -184,7 +185,7 @@ module Markdown
     def run( args )
       opt=OptionParser.new do |cmd|
     
-        cmd.banner = "Usage: markdown [options] name"
+        cmd.banner = "Usage: markdown [options] files_or_dirs"
     
         cmd.on( '-o', '--output PATH', 'Output Path' ) { |path| opts.output_path = path }
 
@@ -203,9 +204,9 @@ markdown - Lets you convert plain text documents (#{Markdown.extnames.join(', ')
 
 Examples:
   markdown                   # Process all documents in working folder (that is, .)
-  markdown ruby_tut          # Process document or folder using Markdown
-  markdown ruby_tut.text     # Process document using Markdown
-  markdown -o site ruby_tut  # Output documents to site folder
+  markdown quickref          # Process document or folder using Markdown
+  markdown quickref.text     # Process document using Markdown
+  markdown -o site quickref  # Output documents to site folder
 
 Further information:
   http://geraldb.github.com/markdown

data/lib/markdown/wrapper.rb

@@ -3,19 +3,16 @@ module Markdown
   class Wrapper
 
     def initialize( lib, mn, content, options={} )
-      @lib     = lib      
-      @mn      = mn
-      @content = content
-      @options = options
+      @lib      = lib      
+      @mn       = mn
+      @content  = content
+      @options  = options
     end
         
     def to_html
       # call markdown filter; turn markdown lib name into method_name (mn)
       # eg. rpeg-markdown =>  rpeg_markdown_to_html
-
-      puts "  Converting Markdown-text (#{@content.length} bytes) to HTML using library '#{@lib}' calling '#{@mn}'..."
-
-      send( @mn, @content )  # call 1st configured markdown engine e.g. kramdown_to_html( content )
+      send( @mn, @content, @options )  # call 1st configured markdown engine e.g. kramdown_to_html( content )
     end    
 
     include Engine
@@ -54,9 +51,13 @@ module Markdown
       @@config = Config.new
     end
 
-    lib = @@config.markdown_lib
-    mn  = @@config.markdown_to_html_method # lets you use differnt options/converters for a single markdown lib   
-    Wrapper.new( lib, mn, content, options )
+    lib      = @@config.markdown_lib
+    mn       = @@config.markdown_to_html_method # lets you use differnt options/converters for a single markdown lib   
+    defaults = @@config.markdown_lib_defaults  ## todo/fix: use mn / converter from defaults hash?? mn no longer needed??    
+
+    props = Props.new( options, 'USER', Props.new( defaults, 'SYSTEM' ))    
+    
+    Wrapper.new( lib, mn, content, props )
   end
 
 end # module Markdown

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: markdown
 version: !ruby/object:Gem::Version 
-  hash: 792793622
-  prerelease: 6
+  hash: 23
+  prerelease: 
   segments: 
   - 0
   - 2
   - 0
-  - beta
-  - 1
-  version: 0.2.0.beta1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Gerald Bauer
@@ -17,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-03 00:00:00 Z
+date: 2012-06-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: props
@@ -102,6 +100,7 @@ files:
 - 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/gen.rb
 - lib/markdown/wrapper.rb
@@ -128,14 +127,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: markdown