github-markdown-jekyll 0.7.0

data/github-markdown-jekyll.gemspec

@@ -0,0 +1,43 @@
+# encoding: utf-8
+Gem::Specification.new do |s|
+  s.name = 'github-markdown-jekyll'
+  s.version = '0.7.0'
+  s.summary = 'The Markdown parser with support for jekyll yaml frontmatter'
+  s.description = 'Self-contained Markdown parser for GitHub, with all our custom extensions'
+  s.date = '2013-10-01'
+  s.email = 'username@franzoni.eu'
+  s.homepage = 'https://github.com/alanfranz/github-markdown-jekyll'
+  s.authors = ['GitHub, Inc', 'Alan Franzoni']
+  # = MANIFEST =
+  s.files = %w[
+    Rakefile
+    bin/gfm
+    ext/markdown/autolink.c
+    ext/markdown/autolink.h
+    ext/markdown/buffer.c
+    ext/markdown/buffer.h
+    ext/markdown/extconf.rb
+    ext/markdown/gh-markdown.c
+    ext/markdown/houdini.h
+    ext/markdown/houdini_href_e.c
+    ext/markdown/houdini_html_e.c
+    ext/markdown/html.c
+    ext/markdown/html.h
+    ext/markdown/html_blocks.h
+    ext/markdown/markdown.c
+    ext/markdown/markdown.h
+    ext/markdown/plaintext.c
+    ext/markdown/plaintext.h
+    ext/markdown/stack.c
+    ext/markdown/stack.h
+    github-markdown-jekyll.gemspec
+    lib/github/markdown.rb
+    test/gfm_test.rb
+  ]
+  # = MANIFEST =
+  s.test_files = ["test/gfm_test.rb"]
+  s.extensions = ["ext/markdown/extconf.rb"]
+  s.require_paths = ["lib"]
+  s.add_development_dependency 'rake-compiler', '~> 0.9.2'
+  s.add_development_dependency 'nokogiri', '~> 1.6.2.1'
+end

data/lib/github/markdown.rb

@@ -0,0 +1,62 @@
+
+# GitHub Markdown Rendering class
+#
+# Provides a Markdown rendering method as a singleton, and two
+# auxiliary functions
+#
+# There are two kinds of Markdown in GitHub.com:
+#
+# - Plain Markdown: used in Wikis, Pages and GitHub::Markup (READMEs).
+#   This is standards-compliant Markdown, with some of the PHP-Markdown
+#   extensions:
+#
+# - GitHub-flavored Markdown: used in user-input text, such as comments.
+#   Same extensions as Plain Markdown, and additionally the following
+#   extensions:
+#
+# GitHub::Markdown.render(content)
+# #=> Rendered Markdown as HTML plaintext with the default extensions
+#
+# GitHub::Markdown.render_gfm(content)
+# #=> Rendered GitHub-flavored Markdown as HTML plaintext
+#
+# GitHub::Markdown._to_html(content, mode) { |code, lang| ... }
+# #=> Rendered Markdown with the given mode as HTML plaintext
+module GitHub
+  class Markdown
+    def self.render(content)
+      self.to_html(content, :markdown)
+    end
+
+    def self.render_gfm(content)
+      self.to_html(content, :gfm)
+    end
+  end
+end
+
+# Load the actual C extension
+require 'github/markdown.so'
+
+module GitHub
+  Markdown.class_eval do
+    class << self
+      alias_method :original_to_html, :to_html
+
+      def to_html(content, mode)
+        pattern = /\A\s*---\s*?\n(?:(.*?)\n|)---\s*?(?:\n(.*))?\z/m
+        match = pattern.match(content)
+        if match.nil?
+          return original_to_html(content, mode)
+        end
+
+        yaml_frontmatter = match[1] || ''
+        md_content = match[2] || ''
+
+        return original_to_html("```yaml\n#{yaml_frontmatter}\n```\n#{md_content}", mode)
+
+
+      end
+    end
+
+  end
+end

data/test/gfm_test.rb

@@ -0,0 +1,100 @@
+# coding: UTF-8
+rootdir = File.dirname(File.dirname(__FILE__))
+$LOAD_PATH.unshift "#{rootdir}/lib"
+
+if defined? Encoding
+  Encoding.default_internal = 'UTF-8'
+end
+
+require 'test/unit'
+require 'github/markdown'
+require 'nokogiri'
+
+def html_equal(html_a, html_b)
+  assert_equal Nokogiri::HTML::DocumentFragment.parse(html_a).to_html,
+    Nokogiri::HTML::DocumentFragment.parse(html_b).to_html
+end
+
+class GFMBasicTest < Test::Unit::TestCase
+  Dir['test/fixtures/*.text', 'test/fixtures/Markdown_Redcarpet/**/*.text'].each do |md_file|
+    dirname = File.dirname(md_file)
+    markup = md_file.split('/').last.gsub(/\.text/, '').gsub(/(\s+)/, "_")
+    define_method "test_#{dirname}_#{markup}" do
+      source = File.read(md_file)
+
+      expected_file = "#{dirname}/#{markup}.html"
+      expected = File.read(expected_file).rstrip
+      actual = GitHub::Markdown.render(source).rstrip
+
+      if source != expected
+        assert(source != actual, "#{markup} did not render anything")
+      end
+
+      diff = IO.popen("diff -u - #{expected_file}", 'r+') do |f|
+        f.write actual
+        f.close_write
+        f.read
+      end
+
+      assert expected == actual, <<message
+#{File.basename expected_file}'s contents don't match command output:
+#{diff}
+message
+    end
+  end
+
+  def test_that_render_works
+    GitHub::Markdown.to_html("Hello **world**!", :gfm)
+  end
+
+  def test_that_code_blocks_work
+    GitHub::Markdown.to_html("~~~~~~~~~~\nhello world!\n~~~~~~~~~\n", :gfm)
+  end
+
+  def test_yaml_is_rendered_in_frontmatter
+    html = GitHub::Markdown.render("---\npippo: 123\n---\n**Hello**")
+    parsed = Nokogiri::HTML::DocumentFragment.parse(html)
+    node = parsed.xpath('.//pre/code')
+    assert_equal "pippo: 123", node.text.strip
+  end
+
+  def test_if_no_frontmatter_normal_rendering_happens
+    html = GitHub::Markdown.render("**Hello**")
+    parsed = Nokogiri::HTML::DocumentFragment.parse(html)
+    node = parsed.xpath('.//p/strong')
+    assert_equal "Hello", node.text.strip
+  end
+
+  # With GITHUB_MD_NESTING set to 32, we can handle up to 10 levels of list
+  # nesting.  We do not go to 11.
+  def test_nested_list
+    items = [
+      'Item 1',
+      'Item 1a',
+      'Item 1a1',
+      'Item 1a1a',
+      'Item 1a1a1',
+      'Item 1a1a1a',
+      'Item 1a1a1a1',
+      'Item 1a1a1a1a',
+      'Item 1a1a1a1a1',
+      'Item 1a1a1a1a1a'
+    ]
+
+    pre = -3
+    markdown = items.inject('') do |md, item|
+      pre += 3
+      md.concat(' '*pre + '+ ' + item + "\n")
+    end
+
+    html = GitHub::Markdown.render(markdown)
+    parsed = Nokogiri::HTML::DocumentFragment.parse(html)
+
+    items.inject(parsed) do |node, expected_item|
+      child = node.xpath('.//ul/li')
+      child_item = child.children.detect{|e| e.text?}.text.strip
+      assert_equal expected_item, child_item
+      node = child
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: github-markdown-jekyll
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- GitHub, Inc
+- Alan Franzoni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.2.1
+description: Self-contained Markdown parser for GitHub, with all our custom extensions
+email: username@franzoni.eu
+executables: []
+extensions:
+- ext/markdown/extconf.rb
+extra_rdoc_files: []
+files:
+- Rakefile
+- bin/gfm
+- ext/markdown/autolink.c
+- ext/markdown/autolink.h
+- ext/markdown/buffer.c
+- ext/markdown/buffer.h
+- ext/markdown/extconf.rb
+- ext/markdown/gh-markdown.c
+- ext/markdown/houdini.h
+- ext/markdown/houdini_href_e.c
+- ext/markdown/houdini_html_e.c
+- ext/markdown/html.c
+- ext/markdown/html.h
+- ext/markdown/html_blocks.h
+- ext/markdown/markdown.c
+- ext/markdown/markdown.h
+- ext/markdown/plaintext.c
+- ext/markdown/plaintext.h
+- ext/markdown/stack.c
+- ext/markdown/stack.h
+- github-markdown-jekyll.gemspec
+- lib/github/markdown.rb
+- test/gfm_test.rb
+homepage: https://github.com/alanfranz/github-markdown-jekyll
+licenses: []
+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: The Markdown parser with support for jekyll yaml frontmatter
+test_files:
+- test/gfm_test.rb