trenni-markdown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ea12e8aa1b0b8946964aff235560a5be4ed85b6
+  data.tar.gz: 58e70af20a4ea42cd49491fb257805a3539fb3ae
+SHA512:
+  metadata.gz: d19c99b14e9bdf7456b8d6047c93c00ac83fda6501a06508a00ad00debe235b550ff3bdeef322af32c2f91106fb9c1eefa4f0bd47a7f2e684418b3b24515b089
+  data.tar.gz: e2d9b535a17e3595ff41a6c9af6ebef540f1a16057e6aac21fdbc87b09c7788297910b9b0c8b684460a08802da482c2fca893a106bc0c1c29a4c70ae0fc5c1aa

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--backtrace
+--warnings

data/.simplecov

@@ -0,0 +1,9 @@
+
+SimpleCov.start do
+	add_filter "/spec/"
+end
+
+if ENV['TRAVIS']
+	require 'coveralls'
+	Coveralls.wear!
+end

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.3.0
+env: COVERAGE=true

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+	gem 'pry'
+	gem 'ruby-prof', platforms: [:mri]
+end
+
+group :test do
+	gem 'coveralls', platforms: [:mri]
+end

data/README.md

@@ -0,0 +1,106 @@
+# Trenni::Markdown
+
+Trenni::Markdown is a light-weight (deliberately) simple Markdown parser. It doesn't cover the entire spec but only a small subset required for implementing [literate](https://en.wikipedia.org/wiki/Literate_programming) unit tests, which are markdown documents which include unit tests.
+
+[![Build Status](https://secure.travis-ci.org/ioquatix/trenni-markdown.svg)](http://travis-ci.org/ioquatix/trenni-markdown)
+[![Code Climate](https://codeclimate.com/github/ioquatix/trenni-markdown.svg)](https://codeclimate.com/github/ioquatix/trenni-markdown)
+[![Coverage Status](https://coveralls.io/repos/ioquatix/trenni-markdown/badge.svg)](https://coveralls.io/r/ioquatix/trenni-markdown)
+
+## Motivation
+
+I've been working with [ffi-clang](https://github.com/) to generate documentation for C++ code and I was thinking about what would be the ideal documentation. In most cases, I end up copying examples from the unit tests into the main README. What about if the unit tests were actual markdown which could be compiled, and used to document the code in a very tangible way?
+
+This markdown parser/generator is an experiment to find out if that's a good idea or not. So, far, the results are interesting.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+	gem 'trenni-markdown'
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install trenni-markdown
+
+## Usage
+
+### Command line
+
+A command line binary is included for basic transforms:
+
+	$ trenni-markdown -g RSpec examples/test.md
+	RSpec.describe String.new("Test") do
+
+		# This test checks that strings report the inclusion of letters correctly.
+
+		it "should contain the letter e" do
+			expect(subject).to include('e')
+		end
+
+		it "shoudn't contain the letter m" do
+			expect(subject).to_not include('m')
+		end
+	end
+
+### Generator
+
+The command line is essentially implemented as follows:
+
+	buffer = Trenni::FileBuffer.new(path)
+	generator = Trenni::Markdown::Generators::RSpec.new
+
+	Trenni::Markdown::Parser.new(buffer, generator).parse!
+
+	puts generator.output
+
+### Parser
+
+If you just want to parse the subset of markdown supported by `Trenni::Markdown`, you can do so:
+
+	input = "# Title\nParagraph\n"
+	buffer = Trenni::Buffer.new(input)
+	Trenni::Markdown::Parser.new(buffer, delegate).parse!
+
+The delegate must respond to the following callbacks:
+
+	@delegate.heading(level, text)
+	@delegate.paragraph(text)
+	@delegate.code(lines)
+
+Keep in mind that this is not a general purpose markdown parser, but specifically for the generation of literate programming code.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2012, 2016, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+
+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/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+	begin
+		require('simplecov/version')
+		task.rspec_opts = %w{--require simplecov} if ENV['COVERAGE']
+	rescue LoadError
+	end
+end
+
+task :default => :spec
+
+task :console do
+	require "bundler/setup"
+	require_relative "lib/trenni/markdown"
+	
+	require "pry"
+	Pry.start
+end

data/bin/trenni-markdown

@@ -0,0 +1,21 @@
+#!/usr/bin/env Ruby
+
+require 'trenni/markdown'
+require 'trenni/markdown/generators'
+
+require 'trollop'
+
+OPTIONS = Trollop::options do
+	opt :generator, "Which generator to use for converting markdown.", :type => :string, :default => 'Ruby'
+end
+
+generator_class = Trenni::Markdown::Generators.const_get(OPTIONS[:generator])
+
+ARGV.each do |path|
+	buffer = Trenni::FileBuffer.new(path)
+	generator = generator_class.new
+	
+	Trenni::Markdown::Parser.new(buffer, generator).parse!
+	
+	puts generator.output
+end

data/examples/ruby.md

@@ -0,0 +1,31 @@
+Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+
+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.
+
+# module Trenni::Markdown::Generators
+
+This module implements a generator for creating Ruby output. Headings map to module and class blocks.
+
+## class Ruby < Trenni::Markdown::Generator
+
+### def heading(level, text)
+
+Every heading generates a new scope:
+	nest(level, "#{text}\n", "end\n")
+

data/examples/test.md

@@ -0,0 +1,11 @@
+# Describe `String.new("Test")`
+
+This test checks that strings report the inclusion of letters correctly.
+
+## Should contain the letter e
+
+	expect(subject).to include('e')
+
+## Shoudn't contain the letter m
+
+	expect(subject).to_not include('m')

data/lib/trenni/markdown.rb

@@ -0,0 +1,23 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative "markdown/version"
+require_relative "markdown/parser"
+require_relative "markdown/generator"

data/lib/trenni/markdown/generator.rb

@@ -0,0 +1,109 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Trenni
+	module Markdown
+		# This parser delegate generates nested code output.
+		class Generator
+			def initialize(comment_prefix = '# ')
+				@comment_prefix = comment_prefix
+				@stack = []
+				
+				@whitespace = String.new
+				@output = String.new
+			end
+			
+			attr :output
+			
+			def indentation
+				"\t" * @stack.size
+			end
+			
+			def append_whitespace
+				unless @whitespace.empty?
+					@output << @whitespace
+					@whitespace = String.new
+				end
+			end
+			
+			def append(lines, prefix = nil, ignore_whitespace: false)
+				append_whitespace unless ignore_whitespace
+				
+				if prefix
+					prefix = indentation + prefix
+				else
+					prefix = indentation
+				end
+				
+				Array(lines).each do |line|
+					@output << prefix << line
+				end
+			end
+			
+			def outdent(level)
+				# Outdent until we can indent one level:
+				while level <= @stack.size
+					append(@stack.pop, ignore_whitespace: true)
+				end
+				
+				append_whitespace
+			end
+			
+			def begin_parse(parser)
+			end
+			
+			def end_parse(parser)
+				outdent(1)
+			end
+			
+			def open(text)
+				@output << text
+			end
+			
+			def close(text)
+				@stack.push(text)
+			end
+			
+			def nest(level, first_line, last_line)
+				outdent(level)
+				
+				# We should now be at the point where we can indent:
+				append(first_line)
+				@stack.push(last_line)
+			end
+			
+			def whitespace(text)
+				@whitespace << text
+			end
+			
+			def heading(level, text)
+				nest(level, "module #{text}\n", "end\n")
+			end
+			
+			def paragraph(text)
+				append(text, @comment_prefix)
+			end
+			
+			def code(text)
+				append(text)
+			end
+		end
+	end
+end

data/lib/trenni/markdown/generators.rb

@@ -0,0 +1,3 @@
+
+require_relative 'generators/ruby'
+require_relative 'generators/rspec'

data/lib/trenni/markdown/generators/rspec.rb

@@ -0,0 +1,34 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Trenni
+	module Markdown
+		module Generators
+			class RSpec < Generator
+				def heading(level, text)
+					case level
+						when 1 then nest(level, "RSpec.describe #{text} do\n", "end\n")
+						when 2 then nest(level, "it #{text.downcase.dump} do", "end\n")
+					end
+				end
+			end
+		end
+	end
+end

data/lib/trenni/markdown/generators/ruby.rb

@@ -0,0 +1,31 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Trenni
+	module Markdown
+		module Generators
+			class Ruby < Generator
+				def heading(level, text)
+					nest(level, "#{text}\n", "end\n")
+				end
+			end
+		end
+	end
+end

data/lib/trenni/markdown/parser.rb

@@ -0,0 +1,110 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'trenni/scanner'
+
+module Trenni
+	module Markdown
+		# This parser processes general markup into a sequence of events which are passed to a delegate.
+		class Parser < StringScanner
+			def initialize(buffer, delegate)
+				super(buffer)
+				
+				@delegate = delegate
+				@level = 0
+			end
+
+			def parse!
+				@delegate.begin_parse(self)
+				
+				until eos?
+					start_pos = self.pos
+
+					scan_heading
+					scan_paragraph
+					scan_code
+					scan_newlines
+
+					raise_if_stuck(start_pos)
+				end
+				
+				@delegate.end_parse(self)
+			end
+
+			protected
+
+			def scan_newlines
+				# Consume all newlines.
+				if self.scan(/\n*/)
+					@delegate.whitespace(self.matched)
+				end
+			end
+
+			def scan_heading
+				# Match any character data except the open tag character.
+				if self.scan(/\s*(\#+)\s*(.*?)\n/)
+					level = self[1].length
+					
+					unless level <= (@level + 1)
+						parse_error!("Cannot nest heading more than one level deep at a time!")
+					else
+						@level = level
+					end
+					
+					text = self[2]
+					
+					# If the title has a inline code fence, e.g. "# Testing `String`"
+					# we only pass along the part in the code fence.
+					text = $1 if text =~ /`(.*?)`/
+					
+					@delegate.heading(level, text)
+				end
+			end
+			
+			PARAGRAPH_LINE = /([^\s#].*?\n)/
+			
+			def scan_paragraph
+				if self.scan(PARAGRAPH_LINE)
+					lines = [self[1]]
+					
+					while self.scan(PARAGRAPH_LINE)
+						lines << self[1]
+					end
+					
+					@delegate.paragraph(lines)
+				end
+			end
+			
+			CODE_LINE = /\t(.*?\n)/
+			
+			def scan_code
+				if self.scan(CODE_LINE)
+					lines = [self[1]]
+					
+					while self.scan(CODE_LINE)
+						lines << self[1]
+					end
+					
+					@delegate.code(lines)
+				end
+			end
+		end
+	end
+end

data/lib/trenni/markdown/version.rb

@@ -0,0 +1,25 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Trenni
+	module Markdown
+		VERSION = "0.1.0"
+	end
+end

data/spec/trenni/markdown/generator_spec.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env rspec
+
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'trenni/markdown'
+
+module Trenni::Markdown::GeneratorSpec
+	RSpec.describe Trenni::Markdown::Generator do
+		def parse(input)
+			buffer = Trenni::Buffer.new(input)
+			
+			Trenni::Markdown::Parser.new(buffer, subject).parse!
+			
+			return subject
+		end
+		
+		it "should parse a heading" do
+			generator = parse(<<~EOS)
+			# MyModule
+			
+			This constant has a value.
+				CONSTANT = value
+			EOS
+			
+			puts generator.output
+		end
+	end
+end

data/spec/trenni/markdown/parser_spec.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env rspec
+
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'trenni/markdown'
+
+module Trenni::Markdown::ParserSpec
+	class ParserDelegate
+		def initialize
+			@events = []
+		end
+		
+		attr :events
+		
+		def begin_parse(parser)
+		end
+		
+		def end_parse(parser)
+		end
+		
+		def whitespace(text)
+		end
+		
+		def method_missing(*args)
+			@events << args
+		end
+	end
+
+	RSpec.describe Trenni::Markdown::Parser do
+		let(:delegate) {ParserDelegate.new}
+		
+		def parse(input)
+			buffer = Trenni::Buffer.new(input)
+			Trenni::Markdown::Parser.new(buffer, delegate).parse!
+			
+			return delegate
+		end
+		
+		it "should parse a heading" do
+			delegate = parse("# Heading 1\n## Heading 2\n")
+			
+			expect(delegate.events).to be == [
+				[:heading, 1, "Heading 1"],
+				[:heading, 2, "Heading 2"],
+			]
+		end
+		
+		it "should parse single line paragraph" do
+			delegate = parse("# Heading 1\nparagraph\n")
+			
+			expect(delegate.events).to be == [
+				[:heading, 1, "Heading 1"],
+				[:paragraph, ["paragraph\n"]],
+			]
+		end
+		
+		it "should parse multiple line paragraph" do
+			delegate = parse("# Heading 1\nfoo bar\nbaz bob\n")
+			
+			expect(delegate.events).to be == [
+				[:heading, 1, "Heading 1"],
+				[:paragraph, ["foo bar\n", "baz bob\n"]],
+			]
+		end
+		
+		it "should parse a code block" do
+			delegate = parse("\tfoo = 10\n\tbar = foo * 2\n")
+			
+			expect(delegate.events).to be == [
+				[:code, ["foo = 10\n", "bar = foo * 2\n"]]
+			]
+		end
+	end
+end

data/trenni-markdown.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trenni/markdown/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "trenni-markdown"
+	spec.version       = Trenni::Markdown::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+
+	spec.summary       = %q{A simple event-generating Markdown parser.}
+	spec.homepage      = "https://github.com/ioquatix/trenni-markdown"
+
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_dependency "trenni", "~> 1.6.0"
+  spec.add_dependency "trollop", "~> 2.0.0"
+
+	spec.add_development_dependency "bundler", "~> 1.11"
+	spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: trenni-markdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trenni
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
+executables:
+- trenni-markdown
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/trenni-markdown
+- examples/ruby.md
+- examples/test.md
+- lib/trenni/markdown.rb
+- lib/trenni/markdown/generator.rb
+- lib/trenni/markdown/generators.rb
+- lib/trenni/markdown/generators/rspec.rb
+- lib/trenni/markdown/generators/ruby.rb
+- lib/trenni/markdown/parser.rb
+- lib/trenni/markdown/version.rb
+- spec/trenni/markdown/generator_spec.rb
+- spec/trenni/markdown/parser_spec.rb
+- trenni-markdown.gemspec
+homepage: https://github.com/ioquatix/trenni-markdown
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A simple event-generating Markdown parser.
+test_files:
+- spec/trenni/markdown/generator_spec.rb
+- spec/trenni/markdown/parser_spec.rb