github-markup 0.5.3 → 0.7.0

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+gem "redcarpet"
+gem "RedCloth"
+gem "rdoc", "~>3.6"
+gem "org-ruby"
+gem "creole", "~>0.3.6"
+gem "wikicloth", "=0.6.0"
+gem "rake"

data/HISTORY.md

@@ -0,0 +1,76 @@
+## 0.5.1 (2010-09-30)
+
+* Support relative path links in rdoc
+
+## 0.5.0 (2010-07-07)
+
+* Added creole support
+
+## 0.4.0 (2010-04-23)
+
+* Removed man page support until it's ready.
+
+## 0.3.3 (2010-03-29)
+
+* UTF-8 works with ReST now.
+
+## 0.3.2 (2010-03-25)
+
+* Improved test runner
+* Forgive ReST problems that aren't user errors.
+
+## 0.3.1 (2010-03-22)
+
+* Add .rst.txt extension
+* Fix ASCII encoding error while using print u'\u010c' non-ASCII char and similar.
+
+## 0.3.0 (2010-03-11)
+
+* man rendering
+* `github-markup` command line runner
+
+## 0.2.2 (2010-02-09)
+
+* pod fixes from Ricardo Signes
+
+## 0.2.1 (2010-01-25)
+
+* ReST fixes from Michael Jones
+
+## 0.2.0 (2010-01-10)
+
+* org-mode support
+
+## 0.1.7 (2009-11-17)
+
+* Ditch asciidoc2html, call asciidoc directly
+
+## 0.1.6 (2009-11-17)
+
+* mdown
+
+## 0.1.5 (2009-11-17)
+
+* Actually, if we can't render a thing then don't. Not once, not never.
+
+## 0.1.4 (2009-11-17)
+
+* Bugfix: Missing commands return the input (instead of nothing)
+
+## 0.1.3 (2009-11-02)
+
+* Strip the INDEX comments from POD
+
+## 0.1.2 (2009-11-02)
+
+* Renamed to `github-markup`
+* Bugfix: POD rendering works now, not just index
+
+## 0.1.1 (2009-11-02)
+
+* Added `GitHub::Markup.can_render?` helper.
+* Bugfix: Actually check file extensions
+
+## 0.1.0 (2009-11-02)
+
+* First release

data/README.md

@@ -10,16 +10,16 @@ Markups
 The following markups are supported.  The dependencies listed are required if
 you wish to run the library.
 
-* [.markdown](http://daringfireball.net/projects/markdown/) -- `gem install rdiscount`
+* [.markdown](http://daringfireball.net/projects/markdown/) -- `gem install redcarpet` (https://github.com/tanoku/redcarpet)
 * [.textile](http://www.textism.com/tools/textile/) -- `gem install RedCloth`
-* [.rdoc](http://rdoc.sourceforge.net/)
+* [.rdoc](http://rdoc.sourceforge.net/) -- `gem install rdoc -v 3.6.1`
 * [.org](http://orgmode.org/) -- `gem install org-ruby`
 * [.creole](http://wikicreole.org/) -- `gem install creole`
+* [.mediawiki](http://www.mediawiki.org/wiki/Help:Formatting) -- `gem install wikicloth`
 * [.rst](http://docutils.sourceforge.net/rst.html) -- `easy_install docutils`
 * [.asciidoc](http://www.methods.co.nz/asciidoc/) -- `brew install asciidoc`
 * [.pod](http://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::HTML`
   comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN.
-* .1 - Requires [`groff`](http://www.gnu.org/software/groff/)
 
 
 Contributing

data/Rakefile

@@ -1,11 +1,133 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
 task :default => :test
 
-desc "Run tests"
-task :test do
-  Dir['test/**/*_test.rb'].each { |file| require file }
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
 end
 
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
 desc "Kick it"
 task :kick do
   exec "kicker -e rake test lib"
 end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end
+

data/github-markup.gemspec

@@ -0,0 +1,103 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'github-markup'
+  s.version           = '0.7.0'
+  s.date              = '2011-12-07'
+  s.rubyforge_project = 'github-markup'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "The code GitHub uses to render README.markup"
+  s.description = <<desc
+  This gem is used by GitHub to render any fancy markup such as
+  Markdown, Textile, Org-Mode, etc. Fork it and add your own!
+desc
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Chris Wanstrath"]
+  s.email    = 'chris@ozmm.org'
+  s.homepage = 'https://github.com/github/markup'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  #s.add_dependency('simple_uuid', "~> 0.1.2")
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  #s.add_development_dependency("test-unit", "~> 2.3.0")
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    HISTORY.md
+    LICENSE
+    README.md
+    Rakefile
+    bin/github-markup
+    github-markup.gemspec
+    lib/github-markup.rb
+    lib/github/commands/asciidoc2html
+    lib/github/commands/asciidocapi.py
+    lib/github/commands/rest2html
+    lib/github/markup.rb
+    lib/github/markup/rdoc.rb
+    lib/github/markups.rb
+    test/markup_test.rb
+    test/markups/README.asciidoc
+    test/markups/README.asciidoc.html
+    test/markups/README.creole
+    test/markups/README.creole.html
+    test/markups/README.markdown
+    test/markups/README.markdown.html
+    test/markups/README.mediawiki
+    test/markups/README.mediawiki.html
+    test/markups/README.noformat
+    test/markups/README.noformat.html
+    test/markups/README.org
+    test/markups/README.org.html
+    test/markups/README.pod
+    test/markups/README.pod.html
+    test/markups/README.rdoc
+    test/markups/README.rdoc.html
+    test/markups/README.rst
+    test/markups/README.rst.html
+    test/markups/README.rst.txt
+    test/markups/README.rst.txt.html
+    test/markups/README.textile
+    test/markups/README.textile.html
+    test/markups/README.txt
+    test/markups/README.txt.html
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end
+

data/lib/github-markup.rb

@@ -0,0 +1,6 @@
+module GitHub
+  module Markup
+    VERSION = '0.7.0'
+    Version = VERSION
+  end
+end

data/lib/github/markup.rb

@@ -22,8 +22,9 @@ module GitHub
     def markup(file, pattern, &block)
       require file.to_s
       add_markup(pattern, &block)
+      true
     rescue LoadError
-      nil
+      false
     end
 
     def command(command, regexp, &block)

data/lib/github/markup/rdoc.rb

@@ -1,5 +1,5 @@
-require 'rdoc/generators/html_generator'
-require 'ostruct'
+require "rdoc"
+require "rdoc/markup/to_html"
 
 module GitHub
   module Markup
@@ -9,11 +9,8 @@ module GitHub
       end
 
       def to_html
-        simple_markup = SM::SimpleMarkup.new
-        generator = Generators::HyperlinkHtml.new('', OpenStruct.new)
-        simple_markup.add_special(/((link:|https?:|mailto:|ftp:|www\.)\S+\w)/, :HYPERLINK)
-        simple_markup.add_special(/(((\{.*?\})|\b\S+?)\[\S+?\.\S+?\])/, :TIDYLINK)
-        simple_markup.convert(@content, generator)
+        h = ::RDoc::Markup::ToHtml.new
+        h.convert(@content)
       end
     end
   end

data/lib/github/markups.rb

@@ -1,5 +1,20 @@
-markup(:markdown, /md|mkdn?|mdown|markdown/) do |content|
-  Markdown.new(content).to_html
+MD_FILES = /md|mkdn?|mdown|markdown/
+
+if markup(:redcarpet, MD_FILES) do |content|
+    RedcarpetCompat.new(content).to_html
+  end 
+elsif markup(:rdiscount, MD_FILES) do |content|
+    RDiscount.new(content).to_html
+  end 
+elsif markup(:maruku, MD_FILES) do |content|
+    Maruku.new(content).to_html
+  end 
+elsif markup(:kramdown, MD_FILES) do |content|
+    Kramdown::Document.new(content).to_html
+  end
+elsif markup(:bluecloth, MD_FILES) do |content|
+    BlueCloth.new(content).to_html
+  end
 end
 
 markup(:redcloth, /textile/) do |content|

data/test/markups/README.markdown.html

@@ -2,4 +2,3 @@
 <li>One</li>
 <li>Two</li>
 </ul>
-

data/test/markups/README.rdoc.html

@@ -1,16 +1,11 @@
-<ul>
-<li>One
+<ul><li>
+<p>One</p>
+</li><li>
+<p>Two</p>
+</li></ul>
 
-</li>
-<li>Two
+<p>This is an <a href="http://github.com">absolute link</a>.  So is this: <a
+href="http://github.com">github.com</a></p>
 
-</li>
-</ul>
-<p>
-This is an <a href="http://github.com">absolute link</a>. So is this: <a
-href="http://github.com">github.com</a>
-</p>
-<p>
-This is a <a href="rawr.html">relative link</a>. So is this: <a
-href="rawr.html">rawr.html</a>
-</p>
+<p>This is a <a href="rawr.html">relative link</a>.  So is this: <a
+href="rawr.html">rawr.html</a></p>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: github-markup
 version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
+  hash: 3
+  prerelease: 
   segments: 
   - 0
-  - 5
-  - 3
-  version: 0.5.3
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-03 00:00:00 -08:00
-default_executable: 
+date: 2011-12-07 00:00:00 Z
 dependencies: []
 
 description: "  This gem is used by GitHub to render any fancy markup such as\n  Markdown, Textile, Org-Mode, etc. Fork it and add your own!\n"
@@ -25,20 +24,24 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.md
+- LICENSE
 files: 
+- Gemfile
+- HISTORY.md
+- LICENSE
 - README.md
 - Rakefile
-- LICENSE
+- bin/github-markup
+- github-markup.gemspec
+- lib/github-markup.rb
 - lib/github/commands/asciidoc2html
 - lib/github/commands/asciidocapi.py
 - lib/github/commands/rest2html
-- lib/github/markup/rdoc.rb
-- lib/github/markup/version.rb
 - lib/github/markup.rb
+- lib/github/markup/rdoc.rb
 - lib/github/markups.rb
-- bin/github-markup
 - test/markup_test.rb
 - test/markups/README.asciidoc
 - test/markups/README.asciidoc.html
@@ -64,13 +67,12 @@ files:
 - test/markups/README.textile.html
 - test/markups/README.txt
 - test/markups/README.txt.html
-has_rdoc: true
-homepage: http://github.com/github/markup
+homepage: https://github.com/github/markup
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -93,10 +95,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: github-markup
+rubygems_version: 1.8.10
 signing_key: 
-specification_version: 3
+specification_version: 2
 summary: The code GitHub uses to render README.markup
 test_files: []
 

data/lib/github/markup/version.rb

@@ -1,5 +0,0 @@
-module GitHub
-  module Markup
-    Version = VERSION = '0.5.3'
-  end
-end