md2dw 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f54031624c612c43ffba948c99fd76b10d0a393
+  data.tar.gz: 14d39b6c2c83d2f748d64645c099b1fa3fe65331
+SHA512:
+  metadata.gz: 566f9f14e0d4604f4ed119d2b3d05d5b733cf02836722767da03c62b3bf93b8b616e8089018e6193411b7953675eae8fba66883154b8a2358625432d4388f68a
+  data.tar.gz: 075286cda8a1c3b05b095ab9411d3d4004d5e2904e38c00349e4547dabd194f257df6dc4c3111facbd749b33c7f3844e38e7535e972afa1a013e3c573b2f8f49

data/.gitignore

@@ -0,0 +1,11 @@
+*~
+*.gem
+*.log
+*.out
+*.pid
+*.swp
+*.lock
+.DS_Store
+.yardoc
+doc
+pkg

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'version'
+  gem 'rubygems-tasks'
+end
+
+group :test do
+  gem 'minitest'
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2014 Sean Clemmer
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,10 @@
+# md2dw
+
+`md2dw` is a simple command-line utility to convert Markdown files into DokuWiki
+syntax.
+
+    $ git clone http://github.com/sczizzo/md2dw.git
+    $ cd md2dw
+    $ gem build md2dw.gemspec
+    $ gem install md2dw-VERSION.gem
+    $ md2dw --help

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+require 'rake'
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/test*.rb']
+end
+
+require 'rubygems/tasks'
+Gem::Tasks.new push: false, sign: {}
+Gem::Tasks::Sign::Checksum.new sha2: true
+
+require 'rake/version_task'
+Rake::VersionTask.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/md2dw

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require 'trollop'
+require 'md2dw'
+
+argv = ARGV.empty? ? %w[ --help ] : ARGV
+
+Trollop::options(argv) do
+  version MD2DW::VERSION
+  banner MD2DW::ART + "\n\n" + <<-EOS.gsub(/^ {4}/, '')
+    #{MD2DW::SUMMARY}
+
+    Usage: md2dw [OPTIONS] MARKDOWN_FILE
+
+    Options:
+  EOS
+end
+
+puts MD2DW.render(ARGF.read)

data/lib/md2dw.rb

@@ -0,0 +1,2 @@
+require_relative 'md2dw/md2dw'
+require_relative 'md2dw/metadata'

data/lib/md2dw/dokuwiki_renderer.rb

@@ -0,0 +1,144 @@
+module MD2DW
+  class DokuwikiRenderer < Redcarpet::Render::Base
+
+    def block_code code, language
+      language = " #{language}" unless language.nil?
+      "\n<code%s>\n%s</code>\n" % [ language, code ]
+    end
+
+    def quote text
+      text
+    end
+
+    def block_quote quote
+      "\n<blockquote>%s</blockquote>\n" % quote
+    end
+
+    def block_html raw_html
+      raw_html
+    end
+
+    def footnotes content
+      "\n%s\n\n" % content
+    end
+
+    def footnote_def content, number
+      '[(r%s>%s)]' % [ number, content.strip ]
+    end
+
+    def header text, header_level
+      level = 7 - header_level
+      "\n%s %s %s\n" % [ '=' * level, text, '=' * level ]
+    end
+
+    def hrule
+      "\n-----\n"
+    end
+
+    def list contents, list_type
+      "\n" + contents
+    end
+
+    def list_item text, list_type
+      char = list_type =~ /unordered/ ? '*' : '-'
+      "  %s %s" % [ char, text ]
+    end
+
+    def paragraph text
+      "\n%s\n" % text
+    end
+
+    def table header, body
+      "\n^ %s ^\n%s\n" % [ header.strip, body.strip ]
+    end
+
+    def table_row content
+      "| %s |\n" % content.strip
+    end
+
+    def table_cell content, alignment
+      '| %s |' % content.strip
+    end
+
+    def autolink link, link_type
+      link
+    end
+
+    def codespan code
+      "''%s''" % code
+    end
+
+    def image link, title, alt_text
+      '{{%s}}' % link
+    end
+
+    def linebreak
+      "\n"
+    end
+
+    def link link, title, content
+      '[[%s|%s]]' % [ link, content ]
+    end
+
+    def raw_html raw_html
+      '<html>%s</html>' % raw_html
+    end
+
+    def strikethrough text
+      '<del>%s</del>' % text
+    end
+
+    def superscript text
+      '<sup>%s</sup>' % text
+    end
+
+    def highlight text
+      '<mark>%s</mark>' % text
+    end
+
+    def footnote_ref number
+      '[(r%s)]' % number
+    end
+
+    def preprocess full_document
+      full_document.gsub!(/(\b|[^\\])??~~([^~].*?)~~/, '\1%_s_%\2%_s_%')     # Strike
+      full_document.gsub!(/(\b|[^\\])??\*\*([^*].*?)\*\*/, '\1%_b_%\2%_b_%') # Bold
+      full_document.gsub!(/(\b|[^\\])??\*([^*].*?)\*/, '\1%_i_%\2%_i_%')     # Italic
+      full_document.gsub!(/<sup>(.*?)<\/sup>/, '%_x_%\1%_x_%')               # Superscript
+      full_document.gsub!(/<cite>(.*?)<\/cite>/, '%_q_%\1%_q_%')             # Cite
+
+      # Fix tables
+      full_document = full_document.lines.map do |line|
+        if line =~ /\^\| (.*?) \|$/
+          "%s\n" % $1
+        else
+          line
+        end
+      end.join.strip
+
+      full_document
+    end
+
+    def postprocess full_document
+      full_document.gsub!(/%_s_%(.*?)%_s_%/, '<del>\1</del>') # Strike
+      full_document.gsub!(/%_b_%(.*?)%_b_%/, '**\1**')        # Bold
+      full_document.gsub!(/%_i_%(.*?)%_i_%/, '//\1//')        # Italic
+      full_document.gsub!(/%_x_%(.*?)%_x_%/, '<sup>\1</sup>') # Superscript
+      full_document.gsub!(/%_q_%(.*?)%_q_%/, '<q>\1</q>')     # Cite
+
+      # Fix tables
+      full_document = full_document.lines.map do |line|
+        if line =~ /\^ \| \| (.+) \| \| \^$/
+          "^ %s ^\n" % $1.gsub(' || ', ' ^ ')
+        elsif line =~ /^\| \| (.+) \| \|$/
+          "| %s |\n" % $1.gsub(' || ', ' | ')
+        else
+          line
+        end
+      end.join.strip
+
+      full_document
+    end
+
+  end
+end

data/lib/md2dw/md2dw.rb

@@ -0,0 +1,16 @@
+require 'redcarpet'
+
+require_relative 'dokuwiki_renderer'
+
+module MD2DW
+  def self.render markdown
+    renderer = Redcarpet::Markdown.new \
+      DokuwikiRenderer,
+      no_intra_emphasis: true,
+      fenced_code_blocks: true,
+      strikethrough: true,
+      footnotes: true,
+      tables: true
+    renderer.render markdown
+  end
+end

data/lib/md2dw/metadata.rb

@@ -0,0 +1,16 @@
+module MD2DW
+  VERSION  = File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).strip
+  SUMMARY  = 'Convert Markdown to DokuWiki syntax'
+  AUTHOR   = 'Sean Clemmer'
+  EMAIL    = 'sczizzo@gmail.com'
+  HOMEPAGE = 'https://github.com/sczizzo/md2dw'
+  ART      = <<-'EOART' % VERSION
+
+                        _____       __
+         ____ ___  ____/ /__ \ ____/ /      __
+        / __ `__ \/ __  /__/ // __  / | /| / /
+       / / / / / / /_/ // __// /_/ /| |/ |/ /
+      /_/ /_/ /_/\__,_//____/\__,_/ |__/|__/
+                                           v%s
+  EOART
+end

data/md2dw.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path(File.join('..', 'lib'), __FILE__)
+require 'md2dw/metadata'
+
+Gem::Specification.new do |s|
+  s.name        = 'md2dw'
+  s.version     = MD2DW::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = MD2DW::AUTHOR
+  s.email       = MD2DW::EMAIL
+  s.summary     = MD2DW::SUMMARY
+  s.description = MD2DW::SUMMARY + '.'
+  s.homepage    = MD2DW::HOMEPAGE
+  s.licenses    = %w[ MIT ]
+
+  s.add_runtime_dependency 'trollop', '~> 2'
+  s.add_runtime_dependency 'redcarpet', '~> 3'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File::basename(f) }
+  s.require_paths = %w[ lib ]
+end

data/test/test_md2dw.rb

@@ -0,0 +1,203 @@
+require 'tmpdir'
+require 'tempfile'
+require 'fileutils'
+require 'minitest/autorun'
+
+require_relative '../lib/md2dw'
+
+
+class TestMD2DW < MiniTest::Test
+
+  def test_converts_markdown_to_dokuwiki
+    [ # Markdown => DokuWiki
+
+      # Text
+      [ '*EM*', '//EM//' ],
+      [ '**BOLD**', '**BOLD**' ],
+      [ '<sup>SUP</sup>', '<sup>SUP</sup>' ],
+      [ '`MONO`', "''MONO''" ],
+      [ '~~STRIKE~~', '<del>STRIKE</del>' ],
+
+      # Links
+      [ '[LINK](THIS)', '[[THIS|LINK]]' ],
+
+      # Headings
+      [ '# TEST', '====== TEST ======' ],
+      [ '## TEST', '===== TEST =====' ],
+      [ '### TEST', '==== TEST ====' ],
+      [ '#### TEST', '=== TEST ===' ],
+      [ '##### TEST', '== TEST ==' ],
+      [ '###### TEST', '= TEST =' ],
+
+      # Images
+      [ '![ALT](IMG.jpg)', '{{IMG.jpg}}' ],
+
+      # Lists
+      [ ul_list_md, ul_list_dw ],
+      [ ol_list_md, ol_list_dw ],
+
+      # Quotes
+      [ '<cite>CITE</cite>', '<q>CITE</q>' ],
+      [ blockquote_md, blockquote_dw ],
+
+      # Tables
+      [ table_md1, table_dw ],
+      [ table_md2, table_dw ],
+
+      # Code
+      [ code_block_md, code_block_dw ],
+      [ code_block_mde_md, code_block_mde_dw ],
+      [ code_block_gfm_md, code_block_gfm_dw ]
+
+    ].map { |tag| assert_renders tag[0], tag[1] }
+  end
+
+private
+  def assert_renders md, dw
+    assert_equal dw, MD2DW.render(md)
+  end
+
+  def ul_list_md
+    <<-EOL.gsub(/^ {4}/, '').chomp
+    TEST
+
+    - ONE
+    - TWO
+    EOL
+  end
+
+  def ul_list_dw
+    <<-EOL.gsub(/^ {4}/, '').chomp
+    TEST
+
+      * ONE
+      * TWO
+    EOL
+  end
+
+  def ol_list_md
+    <<-EOL.gsub(/^ {4}/, '').chomp
+    TEST
+
+    1. ONE
+    2. TWO
+    EOL
+  end
+
+  def ol_list_dw
+    <<-EOL.gsub(/^ {4}/, '').chomp
+    TEST
+
+      - ONE
+      - TWO
+    EOL
+  end
+
+  def blockquote_md
+    <<-EOB.gsub(/^ {4}/, '').chomp
+    > ONE
+    > TWO
+    > THREE
+    EOB
+  end
+
+  def blockquote_dw
+    <<-EOB.gsub(/^ {4}/, '').chomp
+    <blockquote>
+    ONE
+    TWO
+    THREE
+    </blockquote>
+    EOB
+  end
+
+  def table_md1
+    <<-EOT.gsub(/^ {4}/, '')
+    First Header  | Second Header
+    ------------- | -------------
+    Content Cell  | Content Cell
+    Content Cell  | Content Cell
+    EOT
+  end
+
+  def table_md2
+    <<-EOT.gsub(/^ {4}/, '')
+    | First Header  | Second Header |
+    | ------------- | ------------- |
+    | Content Cell  | Content Cell  |
+    | Content Cell  | Content Cell  |
+    EOT
+  end
+
+  def table_dw
+    <<-EOT.gsub(/^ {4}/, '').chomp
+    ^ First Header ^ Second Header ^
+    | Content Cell | Content Cell |
+    | Content Cell | Content Cell |
+    EOT
+  end
+
+  def code_block_md
+    <<-EOC.gsub(/^ {4}/, '')
+    TEST
+
+        ONE
+        TWO
+    EOC
+  end
+
+  def code_block_dw
+    <<-EOC.gsub(/^ {4}/, '').chomp
+    TEST
+
+    <code>
+    ONE
+    TWO
+    </code>
+    EOC
+  end
+
+  def code_block_mde_md
+    <<-EOC.gsub(/^ {4}/, '')
+    TEST
+
+    ~~~
+    ONE
+    TWO
+    ~~~
+    EOC
+  end
+
+  def code_block_mde_dw
+    <<-EOC.gsub(/^ {4}/, '').chomp
+    TEST
+
+    <code>
+    ONE
+    TWO
+    </code>
+    EOC
+  end
+
+  def code_block_gfm_md
+    <<-EOC.gsub(/^ {4}/, '')
+    TEST
+
+    ```ruby
+    ONE
+    TWO
+    ```
+    EOC
+  end
+
+  def code_block_gfm_dw
+    <<-EOC.gsub(/^ {4}/, '').chomp
+    TEST
+
+    <code ruby>
+    ONE
+    TWO
+    </code>
+    EOC
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: md2dw
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sean Clemmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Convert Markdown to DokuWiki syntax.
+email: sczizzo@gmail.com
+executables:
+- md2dw
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/md2dw
+- lib/md2dw.rb
+- lib/md2dw/dokuwiki_renderer.rb
+- lib/md2dw/md2dw.rb
+- lib/md2dw/metadata.rb
+- md2dw.gemspec
+- test/test_md2dw.rb
+homepage: https://github.com/sczizzo/md2dw
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Convert Markdown to DokuWiki syntax
+test_files:
+- test/test_md2dw.rb