github-markdown 0.1.3

data/ext/markdown/markdown.h

@@ -0,0 +1,130 @@
+/* markdown.h - generic markdown parser */
+
+/*
+ * Copyright (c) 2009, Natacha Porté
+ *
+ * Permission to use, copy, modify, and 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.
+ */
+
+#ifndef UPSKIRT_MARKDOWN_H
+#define UPSKIRT_MARKDOWN_H
+
+#include "buffer.h"
+#include "autolink.h"
+
+#define UPSKIRT_VERSION "1.15.2"
+#define UPSKIRT_VER_MAJOR 1
+#define UPSKIRT_VER_MINOR 15
+#define UPSKIRT_VER_REVISION 2
+
+/********************
+ * TYPE DEFINITIONS *
+ ********************/
+
+/* mkd_autolink - type of autolink */
+enum mkd_autolink {
+	MKDA_NOT_AUTOLINK,	/* used internally when it is not an autolink*/
+	MKDA_NORMAL,		/* normal http/http/ftp/mailto/etc link */
+	MKDA_EMAIL,			/* e-mail link without explit mailto: */
+};
+
+enum mkd_tableflags {
+	MKD_TABLE_ALIGN_L = 1,
+	MKD_TABLE_ALIGN_R = 2,
+	MKD_TABLE_ALIGN_CENTER = 3,
+	MKD_TABLE_ALIGNMASK = 3,
+	MKD_TABLE_HEADER = 4
+};
+
+enum mkd_extensions {
+	MKDEXT_NO_INTRA_EMPHASIS = (1 << 0),
+	MKDEXT_TABLES = (1 << 1),
+	MKDEXT_FENCED_CODE = (1 << 2),
+	MKDEXT_AUTOLINK = (1 << 3),
+	MKDEXT_STRIKETHROUGH = (1 << 4),
+	MKDEXT_LAX_HTML_BLOCKS = (1 << 5),
+	MKDEXT_SPACE_HEADERS = (1 << 6),
+	MKDEXT_SUPERSCRIPT = (1 << 7),
+};
+
+/* sd_callbacks - functions for rendering parsed data */
+struct sd_callbacks {
+	/* block level callbacks - NULL skips the block */
+	void (*blockcode)(struct buf *ob, const struct buf *text, const struct buf *lang, void *opaque);
+	void (*blockquote)(struct buf *ob, const struct buf *text, void *opaque);
+	void (*blockhtml)(struct buf *ob,const  struct buf *text, void *opaque);
+	void (*header)(struct buf *ob, const struct buf *text, int level, void *opaque);
+	void (*hrule)(struct buf *ob, void *opaque);
+	void (*list)(struct buf *ob, const struct buf *text, int flags, void *opaque);
+	void (*listitem)(struct buf *ob, const struct buf *text, int flags, void *opaque);
+	void (*paragraph)(struct buf *ob, const struct buf *text, void *opaque);
+	void (*table)(struct buf *ob, const struct buf *header, const struct buf *body, void *opaque);
+	void (*table_row)(struct buf *ob, const struct buf *text, void *opaque);
+	void (*table_cell)(struct buf *ob, const struct buf *text, int flags, void *opaque);
+
+
+	/* span level callbacks - NULL or return 0 prints the span verbatim */
+	int (*autolink)(struct buf *ob, const struct buf *link, enum mkd_autolink type, void *opaque);
+	int (*codespan)(struct buf *ob, const struct buf *text, void *opaque);
+	int (*double_emphasis)(struct buf *ob, const struct buf *text, void *opaque);
+	int (*emphasis)(struct buf *ob, const struct buf *text, void *opaque);
+	int (*image)(struct buf *ob, const struct buf *link, const struct buf *title, const struct buf *alt, void *opaque);
+	int (*linebreak)(struct buf *ob, void *opaque);
+	int (*link)(struct buf *ob, const struct buf *link, const struct buf *title, const struct buf *content, void *opaque);
+	int (*raw_html_tag)(struct buf *ob, const struct buf *tag, void *opaque);
+	int (*triple_emphasis)(struct buf *ob, const struct buf *text, void *opaque);
+	int (*strikethrough)(struct buf *ob, const struct buf *text, void *opaque);
+	int (*superscript)(struct buf *ob, const struct buf *text, void *opaque);
+
+	/* low level callbacks - NULL copies input directly into the output */
+	void (*entity)(struct buf *ob, const struct buf *entity, void *opaque);
+	void (*normal_text)(struct buf *ob, const struct buf *text, void *opaque);
+
+	/* header and footer */
+	void (*doc_header)(struct buf *ob, void *opaque);
+	void (*doc_footer)(struct buf *ob, void *opaque);
+};
+
+struct sd_markdown;
+
+/*********
+ * FLAGS *
+ *********/
+
+/* list/listitem flags */
+#define MKD_LIST_ORDERED	1
+#define MKD_LI_BLOCK		2  /* <li> containing block data */
+
+/**********************
+ * EXPORTED FUNCTIONS *
+ **********************/
+
+extern struct sd_markdown *
+sd_markdown_new(
+	unsigned int extensions,
+	size_t max_nesting,
+	const struct sd_callbacks *callbacks,
+	void *opaque);
+
+extern void
+sd_markdown_render(struct buf *ob, const uint8_t *document, size_t doc_size, struct sd_markdown *md);
+
+extern void
+sd_markdown_free(struct sd_markdown *md);
+
+extern void
+sd_version(int *major, int *minor, int *revision);
+
+#endif
+
+/* vim: set filetype=c: */

data/ext/markdown/stack.c

@@ -0,0 +1,81 @@
+#include "stack.h"
+#include <string.h>
+
+int
+stack_grow(struct stack *st, size_t new_size)
+{
+	void **new_st;
+
+	if (st->asize >= new_size)
+		return 0;
+
+	new_st = realloc(st->item, new_size * sizeof(void *));
+	if (new_st == NULL)
+		return -1;
+
+	memset(new_st + st->asize, 0x0,
+		(new_size - st->asize) * sizeof(void *));
+
+	st->item = new_st;
+	st->asize = new_size;
+
+	if (st->size > new_size)
+		st->size = new_size;
+
+	return 0;
+}
+
+void
+stack_free(struct stack *st)
+{
+	if (!st)
+		return;
+
+	free(st->item);
+
+	st->item = NULL;
+	st->size = 0;
+	st->asize = 0;
+}
+
+int
+stack_init(struct stack *st, size_t initial_size)
+{
+	st->item = NULL;
+	st->size = 0;
+	st->asize = 0;
+
+	if (!initial_size)
+		initial_size = 8;
+
+	return stack_grow(st, initial_size);
+}
+
+void *
+stack_pop(struct stack *st)
+{
+	if (!st->size)
+		return NULL;
+
+	return st->item[--st->size];
+}
+
+int
+stack_push(struct stack *st, void *item)
+{
+	if (stack_grow(st, st->size * 2) < 0)
+		return -1;
+
+	st->item[st->size++] = item;
+	return 0;
+}
+
+void *
+stack_top(struct stack *st)
+{
+	if (!st->size)
+		return NULL;
+
+	return st->item[st->size - 1];
+}
+

data/ext/markdown/stack.h

@@ -0,0 +1,21 @@
+#ifndef STACK_H__
+#define STACK_H__
+
+#include <stdlib.h>
+
+struct stack {
+	void **item;
+	size_t size;
+	size_t asize;
+};
+
+void stack_free(struct stack *);
+int stack_grow(struct stack *, size_t);
+int stack_init(struct stack *, size_t);
+
+int stack_push(struct stack *, void *);
+
+void *stack_pop(struct stack *);
+void *stack_top(struct stack *);
+
+#endif

data/github-markdown.gemspec

@@ -0,0 +1,40 @@
+# encoding: utf-8
+Gem::Specification.new do |s|
+  s.name = 'github-markdown'
+  s.version = '0.1.3'
+  s.summary = 'The Markdown parser for GitHub.com'
+  s.description = 'Self-contained Markdown parser for GitHub, with all our custom extensions'
+  s.date = '2012-04-04'
+  s.email = 'vicent@github.com'
+  s.homepage = 'http://github.github.com/github-flavored-markdown/'
+  s.authors = ['GitHub, Inc']
+  # = 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/stack.c
+    ext/markdown/stack.h
+    github-markdown.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"
+end

data/lib/github/markdown.rb

@@ -0,0 +1,38 @@
+
+# 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'

data/test/gfm_test.rb

@@ -0,0 +1,26 @@
+# 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
+  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
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: github-markdown
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
+platform: ruby
+authors: 
+- GitHub, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake-compiler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Self-contained Markdown parser for GitHub, with all our custom extensions
+email: vicent@github.com
+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/stack.c
+- ext/markdown/stack.h
+- github-markdown.gemspec
+- lib/github/markdown.rb
+- test/gfm_test.rb
+homepage: http://github.github.com/github-flavored-markdown/
+licenses: []
+
+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.8.15
+signing_key: 
+specification_version: 3
+summary: The Markdown parser for GitHub.com
+test_files: 
+- test/gfm_test.rb