markdown 0.0.1

data/History.markdown

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

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.markdown
+Manifest.txt
+README.markdown
+Rakefile
+lib/markdown_select.rb
+lib/markdown_select/config.rb
+lib/markdown_select/engine.rb
+lib/markdown_select/markdown_select.rb

data/README.markdown

@@ -0,0 +1,42 @@
+# Markdown Select - Use Your Markdown Library of Choice
+
+* [geraldb.github.com/markdown_select](http://geraldb.github.com/markdown_select)
+
+## Description
+
+The Markdown Select (`markdown_select`) Ruby gem lets you use your markdown library of choice.
+Preconfigured markdown libraries include:
+
+* `kramdown`
+* `bluecloth`
+* `maruku`
+* `rpeg-markdown`
+* `rdiscount`
+* `pandoc-ruby`
+
+
+## Usage
+
+    require 'markdown_select'
+    
+    MarkdownSelect.new( 'Hello World' ).to_html
+
+
+## Install
+
+Just install the gem:
+
+    $ gem install markdown_select
+
+
+## Questions? Comments?
+
+Send them along to the
+[Free Web Slide Show Alternatives (S5, S6, S9, Slidy And Friends) Forum/Mailing List](http://groups.google.com/group/webslideshow).
+Thanks!
+
+
+## License
+
+The `markdown_select` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'hoe'
+require './lib/markdown_select.rb'
+
+Hoe.spec 'markdown' do
+  
+  self.version = MarkdownSelect::VERSION
+  
+  self.summary = 'Markdown - Use Your Markdown Library of Choice'
+  self.url     = 'http://geraldb.github.com/markdown_select'
+  
+  self.author  = 'Gerald Bauer'
+  self.email   = 'webslideshow@googlegroups.com'
+  
+  self.extra_deps = [
+    ['kramdown','>= 0.13.6']
+  ]
+  
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.markdown'
+  self.history_file = 'History.markdown'
+  
+end

data/lib/markdown_select.rb

@@ -0,0 +1,22 @@
+
+$LOAD_PATH.unshift( File.expand_path( File.dirname(__FILE__) ) )
+
+# core and stlibs
+
+require 'yaml'
+
+
+# our own code
+
+require 'markdown_select/config'
+require 'markdown_select/engine'
+require 'markdown_select/markdown_select'
+
+
+## todo: add main for bin (see slideshow)
+
+module MarkdownSelect
+
+  VERSION = '0.0.1'
+  
+end

data/lib/markdown_select/config.rb

@@ -0,0 +1,64 @@
+module MarkdownSelect
+
+  class Config
+  
+    def initialize
+      @hash = {}
+    end
+
+    
+    def load   
+      # todo/fix: check more locations; merge config files
+
+      # check for user settings in working folder (check for slideshow.yml)
+    
+      config_user_file = "./markdown.yml"
+      if File.exists?( config_user_file )
+        puts "Loading settings from '#{config_user_file}'..."
+        @hash[ 'user' ] = YAML.load_file( config_user_file )   
+      end         
+    end
+
+    
+    def markdown_to_html_method( lib )    
+      method = @hash.fetch( 'user', {} ).fetch( lib, {} ).fetch( 'converter', nil )
+    
+      # use default name
+      if method.nil?
+        method = "#{lib.downcase}_to_html"
+      end
+    
+      method.tr('-','_').to_sym
+    end  
+
+    
+# 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)
+
+  BUILTIN_LIBS = [
+    'pandoc-ruby',
+    'rdiscount',
+    'rpeg-markdown',
+    'maruku',
+    'bluecloth',
+    'kramdown'    
+  ]
+  
+    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
+    
+      user_libs = @hash.fetch( 'user', {} ).fetch( 'libs', [] )
+    
+      user_libs.length > 0 ? user_libs : BUILTIN_LIBS
+    end
+
+  end # class Config
+end # module MarkdownSelect

data/lib/markdown_select/engine.rb

@@ -0,0 +1,59 @@
+module MarkdownSelect
+  module Engine
+   
+    def pandoc_ruby_to_html( content )
+      content = PandocRuby.new( content, :from => :markdown, :to => :html ).convert
+    end
+  
+    def pandoc_ruby_to_html_incremental( content )
+      content = PandocRuby.new( content, :from => :markdown, :to => :html ).convert
+      content = content.gsub(/<(ul|ol)/) do |match|
+        "#{Regexp.last_match(0)} class='step'"
+      end
+      content
+    end
+  
+    # sample how to use your own converter
+    # configure in markdown.yml
+    # pandoc-ruby:
+    #  converter: pandoc-ruby-to-s5
+  
+    def pandoc_ruby_to_s5( content )
+      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 )
+      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
+    end
+    
+
+    def rdiscount_to_html( content )
+      RDiscount.new( content ).to_html
+    end
+  
+
+    def rpeg_markdown_to_html( content )
+      PEGMarkdown.new( content ).to_html
+    end
+  
+
+    def maruku_to_html( content )
+      Maruku.new( content, {:on_error => :raise} ).to_html
+    end
+  
+
+    def bluecloth_to_html( content )
+      BlueCloth.new( content ).to_html
+    end
+  
+
+    def kramdown_to_html( content )
+      Kramdown::Document.new( content ).to_html
+    end      
+  
+  end # module Engine
+end # module MarkdownSelect  

data/lib/markdown_select/markdown_select.rb

@@ -0,0 +1,80 @@
+module MarkdownSelect
+ 
+  class Proxy   
+
+    def initialize( lib, mn, content, 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 )
+    end    
+
+    include Engine
+    
+  end # class Proxy
+
+  @@markdown_config = nil    
+  @@markdown_libs   = []
+  @@markdown_mn     = nil
+  
+  def self.load_markdown_libs
+
+    # check for available markdown libs/gems
+    # try to require each lib and remove any not installed
+
+    @@markdown_config.known_markdown_libs.each do |lib|
+      begin
+        require lib
+        @@markdown_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
+
+    puts "  Found #{@@markdown_libs.length} Markdown libraries: #{@@markdown_libs.join(', ')}"
+  end
+   
+  def self.lib
+    if @@markdown_config.nil?
+      @@markdown_config = Config.new
+      @@markdown_config.load
+      
+      load_markdown_libs
+    
+      # lets you use differnt options/converters for a single markdown lib
+      @@markdown_mn = @@markdown_config.markdown_to_html_method( @@markdown_libs.first )
+    end
+
+    @@markdown_libs.first
+  end
+  
+  def self.new( content, options={} )
+
+    ## todo: allow options to pass in
+    ##   lets you change markdown engine/converter for every call
+    ##   e.g. lets you add config properties (as headers) to your document (for example)
+    
+    if @@markdown_config.nil?
+      @@markdown_config = Config.new
+      @@markdown_config.load
+      
+      load_markdown_libs
+    
+      # lets you use differnt options/converters for a single markdown lib
+      @@markdown_mn = @@markdown_config.markdown_to_html_method( @@markdown_libs.first )    
+    end
+
+    Proxy.new( @@markdown_libs.first, @@markdown_mn, content, options )
+  end
+
+end # module MarkdownSelect

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: markdown
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: kramdown
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 0
+        - 13
+        - 6
+        version: 0.13.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 10
+        version: "3.10"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 2
+        - 15
+        version: "2.15"
+  type: :development
+  version_requirements: *id003
+description: |-
+  The Markdown Select (`markdown_select`) Ruby gem lets you use your markdown library of choice.
+  Preconfigured markdown libraries include:
+  
+  * `kramdown`
+  * `bluecloth`
+  * `maruku`
+  * `rpeg-markdown`
+  * `rdiscount`
+  * `pandoc-ruby`
+email: webslideshow@googlegroups.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+files: 
+- History.markdown
+- Manifest.txt
+- README.markdown
+- Rakefile
+- lib/markdown_select.rb
+- lib/markdown_select/config.rb
+- lib/markdown_select/engine.rb
+- lib/markdown_select/markdown_select.rb
+homepage: http://geraldb.github.com/markdown_select
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: markdown
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Markdown - Use Your Markdown Library of Choice
+test_files: []
+