gfm2confluence 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "redcarpet", "~> 2.1.1"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.8.4"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 ablagoev
+
+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.rdoc

@@ -0,0 +1,46 @@
+= gfm2confluence
+
+This is a simple tool, which converts gfm documents (GitHub Flavored Markdown[http://github.github.com/github-flavored-markdown/]) to the {Atlassian Wiki Format}[https://confluence.atlassian.com/display/DOC/Confluence+Wiki+Markup]. This format is mostly used inside jira and confluence.
+
+The implementation was greatly inspired by markdown2confluence[https://github.com/jedi4ever/markdown2confluence].
+
+The gem is based on Redcarpet[https://github.com/vmg/redcarpet].
+
+== Installation:
+
+=== Via gem:
+
+`gem install gfm2confluence`
+
+=== From github:
+
+`gem install bundler`
+`git clone git://github.com/ablagoev/gfm2confluence.git`
+`bundle install vendor`
+
+== Usage:
+
+`gfm2confluence <inputfile>`
+`gfm2confluence <inputtext>`
+
+== Known Issues:
+
+* Since redcarper/sundown mostly remove newlines, extra newlines have been added to the parsing of paragraphs, list items, etc.
+* Tables are not yet supported
+* Nested lists are not supported
+
+== Contributing to gfm2confluence
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 ablagoev. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "gfm2confluence"
+  gem.homepage = "http://github.com/ablagoev/gfm2confluence"
+  gem.license = "MIT"
+  gem.summary = "Convert git hub flavoured markdown to atlassian confluence format"
+  gem.description = "This tool can be used to convert the git hub flavoured markdown format to the wiki markup used in atlassian products (jira, confluence, etc.)"
+  gem.email = "alexander.i.blagoev@gmail.com"
+  gem.authors = ["ablagoev"]
+  # dependencies defined in Gemfile
+  gem.add_dependency 'redcarpet', '~> 2.1.1'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gfm2confluence #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/gfm2confluence

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require 'gfm2confluence'
+
+abort "You need to specify at least one argument" if ARGV.size < 1
+
+#Check if argument is a file
+if File.exist? ARGV[0]
+	begin
+	  text = File.read(ARGV[0])
+	rescue Exception => ex
+	  abort "There was an error reading the file"
+	end
+else
+	text = ARGV[0]
+end
+
+puts Gfm2Confluence.convert(text)

data/gfm2confluence.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gfm2confluence}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["ablagoev"]
+  s.date = %q{2012-08-31}
+  s.default_executable = %q{gfm2confluence}
+  s.description = %q{This tool can be used to convert the git hub flavoured markdown format to the wiki markup used in atlassian products (jira, confluence, etc.)}
+  s.email = %q{alexander.i.blagoev@gmail.com}
+  s.executables = ["gfm2confluence"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/gfm2confluence",
+    "gfm2confluence.gemspec",
+    "lib/gfm2confluence.rb",
+    "lib/gfm2confluence/converter.rb",
+    "test/helper.rb",
+    "test/test_gfm2confluence-gem.rb"
+  ]
+  s.homepage = %q{http://github.com/ablagoev/gfm2confluence}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Convert git hub flavoured markdown to atlassian confluence format}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<redcarpet>, ["~> 2.1.1"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<redcarpet>, ["~> 2.1.1"])
+    else
+      s.add_dependency(%q<redcarpet>, ["~> 2.1.1"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<redcarpet>, ["~> 2.1.1"])
+    end
+  else
+    s.add_dependency(%q<redcarpet>, ["~> 2.1.1"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<redcarpet>, ["~> 2.1.1"])
+  end
+end
+

data/lib/gfm2confluence.rb

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+# The base class which is used to convert the text
+require 'redcarpet'
+
+class Gfm2Confluence
+	def self.convert(text)
+		markdown = Redcarpet::Markdown.new(Gfm2Confluence::Converter,
+								:autolink => true, :fenced_code_blocks => true, 
+								:hard_wrap => true, :strikethrough => true, 
+								:superscript => true, :no_intra_emphasis => true)
+		result = markdown.render(text)
+	end
+end
+
+require 'gfm2confluence/converter.rb'

data/lib/gfm2confluence/converter.rb

@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*-
+# The class which extends Redcarpet::Render::Base and converts the text
+
+require 'redcarpet'
+
+#TODO: parse <pre> tags for {code} tags
+#TODO: parse <p> tags to paragraphs
+#TODO: parse <iframe> tags
+class Gfm2Confluence::Converter < Redcarpet::Render::Base
+	def block_code(code, language)
+		"{code}\n#{code}{code}\n\n"
+	end
+
+	def block_quote(quote)
+		"{quote}\n#{quote}{quote}\n"
+	end
+
+	def block_html(raw_html)
+		#TODO: try to parse the html body and replce tags where possible
+		raw_html
+	end
+
+	def header(text, header_level)
+		"h#{header_level}. #{text}\n"
+	end
+
+	def hrule()
+		"----\n"
+	end
+
+	def list(contents, list_type)
+		"#{contents}\n"
+	end
+
+	def list_item(text, list_type)
+		marker = '-'
+		if list_type.to_s == "ordered"
+			marker = '#'
+		end
+		"#{marker} #{text}"
+	end
+
+	def paragraph(text)
+		"#{text}\n\n"
+	end
+
+	def autolink(link, link_type)
+		"[#{link}]"
+	end
+
+	def codespan(code)
+		"{code}#{code}{code}"
+	end
+
+	def double_emphasis(text)
+		"*#{text}*"
+	end
+
+	def emphasis(text)
+		"_#{text}_"
+	end
+
+	def image(link, title, alt_text)
+		alt_text.to_s.empty? ? "!#{link}!" : "!#{link}|alt=#{alt_text}!"
+	end
+
+	def linebreak()
+		"\n"
+	end
+
+	def link(link, title, alt_text)
+		alt_text.to_s.empty? ? "[#{link}]" : "[#{alt_text}|#{link}]"
+	end
+
+	def raw_html(raw_html)
+		#TODO: parse the separate tags along with block_html and make replacements where applicable
+		raw_html
+	end
+
+	def triple_emphasis(text)
+		"*#{text}*"
+	end
+
+	def strikethrough(text)
+		"-#{text}-"
+	end
+
+	def superscript(text)
+		"^#{text}^"
+	end
+
+	def entity(text)
+		"#{text}"
+	end
+
+	def normal_text(text)
+		escape "#{text}"
+	end
+
+	def escape(text)
+		#TODO: Check if anything else needs to be escaped
+		text.gsub(/\{|\}/, '\\\\\0') #This replaces { with \{
+	end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gfm2confluence'
+
+class Test::Unit::TestCase
+end

data/test/test_gfm2confluence-gem.rb

@@ -0,0 +1,159 @@
+require 'rubygems'
+require 'helper'
+
+class TestGfm2Confluence < Test::Unit::TestCase
+	context 'the converter' do
+		should "generate code block" do
+			text = "```js\n//code\n```"
+			expect = "{code}\n//code\n{code}\n\n"
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate block quote" do
+			text = ">Blockquote"
+			expect = "{quote}\nBlockquote\n\n{quote}\n"
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate block html" do
+			text = "<div>\n<span>Test</span>\n</div>"
+			expect = "<div>\n<span>Test</span>\n</div>\n"
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate header" do
+			for i in 1..3 do
+				level = "#" * i
+				text = "#{level} Level#{i}"
+				expect = "h#{i}. Level#{i}\n"
+				assert_equal(expect, Gfm2Confluence.convert(text))
+			end
+		end
+
+		should "generate hr" do
+			expect = "----\n"
+			assert_equal(expect, Gfm2Confluence.convert('***'))
+			assert_equal(expect, Gfm2Confluence.convert('- - -'))
+			assert_equal(expect, Gfm2Confluence.convert('---------------'))
+		end
+
+		should "generate list" do
+			#Ordered lsits
+			expect = "# Item 1\n# Item 2\n# Item 3\n\n"
+			text = "1. Item 1\n2. Item 2\n3. Item 3"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+
+			#Unorderd lists
+			expect = "- Item 1\n- Item 2\n- Item 3\n\n"
+			text = "* Item 1\n* Item 2\n* Item 3"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+			text = "- Item 1\n- Item 2\n- Item 3"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate a paragraph" do
+			expect = "Paragraph text\n\n"
+			text = expect
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "autolink" do
+			expect = "[http://google.com/]\n\n"
+			text = "http://google.com/"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate code span" do
+			text = "`//code`"
+			expect = "{code}//code{code}\n\n"
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate double emphasis" do
+			text = "**emphasis**"
+			expect = "*emphasis*\n\n"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))			
+		end
+
+		should "generate emphasis" do
+			text = "*emphasis*"
+			expect = "_emphasis_\n\n"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate image" do
+			text = "![Alt text](/path/to/img.jpg)"
+			expect = "!/path/to/img.jpg|alt=Alt text!\n\n"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+
+			#Titles are not handled
+			text = "![Alt text](/path/to/img.jpg \"Optional title\")"
+			expect = "!/path/to/img.jpg|alt=Alt text!\n\n"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate link" do
+			#Link titles are not handled
+			text = "This is [an example](http://example.com/ \"Title\") inline link."
+			expect = "This is [an example|http://example.com/] inline link.\n\n"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate raw html" do
+			text = "<span>Test</span>"
+			expect = "<span>Test</span>\n\n"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate triple emphasis" do
+			text = "***empahsis***"
+			expect = "*empahsis*\n\n"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate strikethrough" do
+			text = "~~strike~~"
+			expect = "-strike-\n\n"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate superscript" do
+			text = "^super"
+			expect = "^super^\n\n"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate entity" do
+			text = "&amp;"
+			expect = "&amp;\n\n"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+
+		should "generate normal text" do
+			text = "normal text"
+			expect = "normal text\n\n"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+
+			text = "test if { } are escaped properly"
+			expect = "test if \\{ \\} are escaped properly\n\n"
+
+			assert_equal(expect, Gfm2Confluence.convert(text))
+		end
+	end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification 
+name: gfm2confluence
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- ablagoev
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-31 00:00:00 +03:00
+default_executable: gfm2confluence
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: redcarpet
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rdoc
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 1
+        - 8
+        - 4
+        version: 1.8.4
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: redcarpet
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  requirement: *id007
+description: This tool can be used to convert the git hub flavoured markdown format to the wiki markup used in atlassian products (jira, confluence, etc.)
+email: alexander.i.blagoev@gmail.com
+executables: 
+- gfm2confluence
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/gfm2confluence
+- gfm2confluence.gemspec
+- lib/gfm2confluence.rb
+- lib/gfm2confluence/converter.rb
+- test/helper.rb
+- test/test_gfm2confluence-gem.rb
+has_rdoc: true
+homepage: http://github.com/ablagoev/gfm2confluence
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Convert git hub flavoured markdown to atlassian confluence format
+test_files: []
+