multi_markdown 0.1.0.pre1

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.*
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+doc/
+pkg/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "multi_markdown Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2012-05-17
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gemspec
+
+gem 'rspec', '~> 2.4'
+
+gem 'kramdown',      :require => nil, :group => [:kramdown]
+gem 'rdiscount',     :require => nil, :group => [:rdiscount]
+gem 'redcarpet',     :require => nil, :group => [:redcarpet]
+gem 'rpeg-markdown', :require => nil, :group => [:rpeg_markdown]

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Hal Brodigan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# multi_markdown
+
+* [Homepage](https://github.com/postmodern/multi_markdown#readme)
+* [Issues](https://github.com/postmodern/multi_markdown/issues)
+* [Documentation](http://rubydoc.info/gems/multi_markdown/frames)
+* [Email](mailto:postmodern.mod3 at gmail.com)
+
+## Description
+
+multi_markdown allows projects to use a wide variety of Markdown libraries,
+without having to depend on a specific one.
+
+## Supported
+
+* [kramdown](http://kramdown.rubyforge.org/)
+* [rdiscount](https://github.com/rtomayko/rdiscount#readme)
+* [redcarpet](https://github.com/tanoku/redcarpet#readme)
+* [rpeg_markdown](https://github.com/rtomayko/rpeg-markdown#readme)
+
+## Examples
+
+    require 'multi_markdown'
+
+    MultiMarkdown.new('hello _world_').to_html
+    # => "<p>hello <em>world</em></p>\n"
+
+## Install
+
+    $ gem install multi_markdown
+
+## Copyright
+
+Copyright (c) 2012 Hal Brodigan
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'rubygems-tasks', '~> 0.2'
+  require 'rubygems/tasks'
+
+  Gem::Tasks.new
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rubygems-tasks` to install 'rubygems/tasks'."
+end
+
+begin
+  gem 'rspec', '~> 2.4'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new('spec:multi_markdown') do |spec|
+    spec.pattern = 'spec/multi_markdown_spec.rb'
+  end
+  task :spec => 'spec:multi_markdown'
+
+  Dir.glob('spec/libraries/*_spec.rb') do |path|
+    name = File.basename(path).chomp('_spec.rb')
+
+    namespace :spec do
+      RSpec::Core::RakeTask.new(name) do |spec|
+        spec.pattern = path
+      end
+    end
+
+    task :spec => "spec:#{name}"
+  end
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+
+task :test => :spec
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.7'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end
+task :doc => :yard

data/gemspec.yml

@@ -0,0 +1,15 @@
+name: multi_markdown
+summary: Allows switching between multiple Markdown libraries.
+description:
+  multi_markdown allows projects to use a wide variety of Markdown libraries,
+  without having to depend on a specific one.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: https://github.com/postmodern/multi_markdown#readme
+
+development_dependencies:
+  rubygems-tasks: ~> 0.2
+  rspec: ~> 2.4
+  yard: ~> 0.7

data/lib/multi_markdown.rb

@@ -0,0 +1,2 @@
+require 'multi_markdown/multi_markdown'
+require 'multi_markdown/version'

data/lib/multi_markdown/multi_markdown.rb

@@ -0,0 +1,125 @@
+module MultiMarkdown
+  # Markdown library names
+  LIBRARIES = {
+    :kramdown      => 'kramdown',
+    :rdiscount     => 'rdiscount',
+    :redcarpet     => 'redcarpet',
+    :rpeg_markdown => 'peg_markdown'
+  }
+
+  # Markdown Constants
+  CONSTANTS = {
+    :kramdown      => 'Kramdown::Document',
+    :rdiscount     => 'RDiscount',
+    :redcarpet     => 'RedcarpetCompat',
+    :rpeg_markdown => 'PEGMarkdown'
+  }
+
+  # The loading priority
+  PRIORITY = [
+    :kramdown,
+    :rdiscount,
+    :redcarpet,
+    :rpeg_markdown
+  ]
+
+  @@markdown = nil
+
+  #
+  # Attempts to find the specific Markdown library.
+  #
+  # @param [Symbol] library
+  #   The name of the markdown library.
+  #
+  # @raise [ArgumentError]
+  #   Unknown Markdown library name.
+  #
+  # @raise [NameError]
+  #   The constant for the Markdown library could not be found.
+  #
+  def self.find(library)
+    unless CONSTANTS.has_key?(library)
+      raise(ArgumentError,"unknown Markdown library: #{library}")
+    end
+
+    eval(CONSTANTS[library])
+  end
+
+  #
+  # Uses a specific Markdown library.
+  #
+  # @param [Symbol] library
+  #   The name of the markdown library.
+  #
+  # @return [#new]
+  #   The Markdown class.
+  #
+  # @raise [ArgumentError]
+  #   Unknown Markdown library name.
+  #
+  # @raise [LoadError]
+  #   The Markdown library could not be loaded.
+  #
+  # @raise [NameError]
+  #   The constant for the Markdown library could not be found.
+  #
+  def self.use(library)
+    unless LIBRARIES.has_key?(library)
+      raise(ArgumentError,"unknown Markdown library: #{library}")
+    end
+
+    require LIBRARIES[library]
+
+    @@markdown = find(library)
+  end
+
+  #
+  # Attempts to find or load the first available Markdown library.
+  #
+  # @return [#new]
+  #   The Markdown class.
+  #
+  # @raise [LoadError]
+  #   None of the supported Markdown libraries could be found or loaded.
+  #
+  def self.load
+    # attempt to find an already loaded markdown library
+    PRIORITY.each do |library|
+      begin
+        return(@@markdown = find(library))
+      rescue NameError
+      end
+    end
+
+    PRIORITY.each do |library|
+      begin
+        return use(library)
+      rescue Gem::LoadError => e
+        # re-raise Gem::LoadErrors, as they are a sign of dependency issues
+        raise(e)
+      rescue LoadError
+      end
+    end
+
+    raise(LoadError,"could not load any of the markdown libraries")
+  end
+
+  #
+  # Loads the first available Markdown library and creates a Markdown document.
+  #
+  # @param [String] text
+  #   Markdown text.
+  #
+  # @param [Hash{Symbol => Object}] options
+  #   Additional options for the Markdown document.
+  #
+  # @return [#to_html]
+  #   The Markdown document.
+  #
+  def self.new(text,options={})
+    load unless @@markdown
+
+    @@markdown.new(text,options)
+  end
+
+end

data/lib/multi_markdown/version.rb

@@ -0,0 +1,4 @@
+module MultiMarkdown
+  # multi_markdown version
+  VERSION = "0.1.0.pre1"
+end

data/multi_markdown.gemspec

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gemspec|
+  root    = File.dirname(__FILE__)
+  lib_dir = File.join(root,'lib')
+  files   = `git ls-files`.split($/)
+
+  filter_files = lambda { |paths|
+    files & case paths
+            when Array
+              paths
+            when String
+              Dir[paths]
+            end
+  }
+
+  version = {
+    :file     => 'multi_markdown/version',
+    :constant => 'MultiMarkdown::VERSION'
+  }
+
+  defaults = {
+    'name'            => File.basename(root),
+    'files'           => files,
+    'require_paths'   => ['ext', 'lib'].select { |dir| File.directory?(dir) },
+    'executables'     => filter_files['bin/*'].map { |path| File.basename(path) },
+    'test_files'      => filter_files['{test/{**/}*_test.rb,spec/{**/}*_spec.rb}'],
+    'doc_files'       => filter_files['*.{txt,rdoc,md,markdown,tt,textile}'],
+    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}']
+  }
+
+  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
+
+  gemspec.name    = metadata['name']
+  gemspec.version = if metadata['version']
+                      metadata['version']
+                    else
+                      $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                      require version[:file]
+                      eval(version[:constant])
+                    end
+
+  gemspec.summary     = metadata.fetch('summary',metadata['description'])
+  gemspec.description = metadata.fetch('description',metadata['summary'])
+
+  gemspec.licenses = Array(metadata['license'])
+  gemspec.authors  = Array(metadata['authors'])
+
+  gemspec.email    = metadata['email']
+  gemspec.homepage = metadata['homepage']
+
+  gemspec.require_paths = Array(metadata['require_paths'])
+  gemspec.files         = filter_files[metadata['files']]
+  gemspec.executables   = metadata['executables']
+  gemspec.extensions    = metadata['extensions']
+
+  if Gem::VERSION < '1.7.'
+    gemspec.default_executable = gemspec.executables.first
+  end
+
+  gemspec.test_files       = filter_files[metadata['test_files']]
+  gemspec.extra_rdoc_files = Array(metadata['extra_doc_files'])
+
+  gemspec.post_install_message = metadata['post_install_message']
+  gemspec.requirements         = metadata['requirements']
+
+  if gemspec.respond_to?(:required_ruby_version=)
+    gemspec.required_ruby_version = metadata['required_ruby_version']
+  end
+
+  if gemspec.respond_to?(:required_rubygems_version=)
+    gemspec.required_rubygems_version = metadata['required_ruby_version']
+  end
+
+  parse_versions = lambda { |versions|
+    case versions
+    when Array
+      versions.map { |v| v.to_s }
+    when String
+      versions.split(/,\s*/)
+    end
+  }
+
+  if metadata['dependencies']
+    metadata['dependencies'].each do |name,versions|
+      gemspec.add_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['runtime_dependencies']
+    metadata['runtime_dependencies'].each do |name,versions|
+      gemspec.add_runtime_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['development_dependencies']
+    metadata['development_dependencies'].each do |name,versions|
+      gemspec.add_development_dependency(name,parse_versions[versions])  
+    end
+  end
+end

data/spec/libraries/kramdown_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe MultiMarkdown do
+  context "with kramdown" do
+    let(:library)  { :kramdown            }
+    let(:constant) { 'Kramdown::Document' }
+
+    before { Bundler.setup(library) }
+
+    describe "find" do
+      before { require 'kramdown' }
+
+      it "should find the Kramdown::Document" do
+        subject.find(library).name.should == constant
+      end
+    end
+
+    describe "use" do
+      it "should load and find Kramdown::Document" do
+        subject.use(library).name.should == constant
+      end
+    end
+  end
+end

data/spec/libraries/rdiscount_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe MultiMarkdown do
+  context "with rdiscount" do
+    let(:library)  { :rdiscount  }
+    let(:constant) { 'RDiscount' }
+
+    before { Bundler.setup(library) }
+
+    describe "find" do
+      before { require 'rdiscount' }
+
+      it "should find the RDiscount" do
+        subject.find(library).name.should == constant
+      end
+    end
+
+    describe "use" do
+      it "should load and find RDiscount" do
+        subject.use(library).name.should == constant
+      end
+    end
+  end
+end

data/spec/libraries/redcarpet_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe MultiMarkdown do
+  context "with redcarpet" do
+    let(:library)  { :redcarpet        }
+    let(:constant) { 'RedcarpetCompat' }
+
+    before { Bundler.setup(library) }
+
+    describe "find" do
+      before { require 'redcarpet' }
+
+      it "should find the RedcarpetCompat" do
+        subject.find(library).name.should == constant
+      end
+    end
+
+    describe "use" do
+      it "should load and find RedcarpetCompat" do
+        subject.use(library).name.should == constant
+      end
+    end
+  end
+end

data/spec/libraries/rpeg_markdown_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe MultiMarkdown do
+  context "with rpeg_markdown" do
+    let(:library)  { :rpeg_markdown }
+    let(:constant) { 'PEGMarkdown'  }
+
+    before { Bundler.setup(library) }
+
+    describe "find" do
+      before { require 'peg_markdown' }
+
+      it "should find the PEGMarkdown" do
+        subject.find(library).name.should == constant
+      end
+    end
+
+    describe "use" do
+      it "should load and find PEGMarkdown" do
+        subject.use(library).name.should == constant
+      end
+    end
+  end
+end

data/spec/multi_markdown_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'multi_markdown'
+
+describe MultiMarkdown do
+  it "should have a VERSION constant" do
+    subject.const_get('VERSION').should_not be_empty
+  end
+
+  describe "find" do
+    it "should raise an ArgumentError for unknown libraries" do
+      lambda {
+        subject.find(:foo)
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should raise a NameError when the library could not be found" do
+      lambda {
+        subject.find(:kramdown)
+      }.should raise_error(NameError)
+    end
+  end
+
+  describe "use" do
+    it "should raise an ArgumentError for unknown libraries" do
+      lambda {
+        subject.use(:foo)
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should raise a LoadError when the library could not be found" do
+      lambda {
+        subject.use(:kramdown)
+      }.should raise_error(LoadError)
+    end
+  end
+
+  describe "load" do
+    before { Bundler.setup(:redcarpet, :rdiscount) }
+
+    it "should load the first available library" do
+      subject.load.name.should == 'RDiscount'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:default)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rspec'
+require 'multi_markdown'

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: multi_markdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre1
+  prerelease: 6
+platform: ruby
+authors:
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: multi_markdown allows projects to use a wide variety of Markdown libraries,
+  without having to depend on a specific one.
+email: postmodern.mod3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .gitignore
+- .rspec
+- .yardopts
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemspec.yml
+- lib/multi_markdown.rb
+- lib/multi_markdown/multi_markdown.rb
+- lib/multi_markdown/version.rb
+- multi_markdown.gemspec
+- spec/libraries/kramdown_spec.rb
+- spec/libraries/rdiscount_spec.rb
+- spec/libraries/redcarpet_spec.rb
+- spec/libraries/rpeg_markdown_spec.rb
+- spec/multi_markdown_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/postmodern/multi_markdown#readme
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Allows switching between multiple Markdown libraries.
+test_files:
+- spec/libraries/kramdown_spec.rb
+- spec/libraries/rdiscount_spec.rb
+- spec/libraries/redcarpet_spec.rb
+- spec/libraries/rpeg_markdown_spec.rb
+- spec/multi_markdown_spec.rb