trenni-markdown 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ea12e8aa1b0b8946964aff235560a5be4ed85b6
-  data.tar.gz: 58e70af20a4ea42cd49491fb257805a3539fb3ae
+  metadata.gz: 80c7291285ffcd0dd7eee1a52a381007aa36c6bb
+  data.tar.gz: 271bb81c07044631c1ffd593e25e03975925e5fe
 SHA512:
-  metadata.gz: d19c99b14e9bdf7456b8d6047c93c00ac83fda6501a06508a00ad00debe235b550ff3bdeef322af32c2f91106fb9c1eefa4f0bd47a7f2e684418b3b24515b089
-  data.tar.gz: e2d9b535a17e3595ff41a6c9af6ebef540f1a16057e6aac21fdbc87b09c7788297910b9b0c8b684460a08802da482c2fca893a106bc0c1c29a4c70ae0fc5c1aa
+  metadata.gz: d5ca7845a950149279de439986742b331aecbcf4499bd2ff87dada9045d388bb07b2d7c1ba32df9ad432843d9bd310d9a899513ae3f9bce503042482ddebeb71
+  data.tar.gz: f08e25da04fb56720131cd9f1851a2365a32e3e18b44ab2e9639cfbcf329b40e4bb6e9037b39eb0a93a307549ca59320cb0bea9380cf08fc86d20dac870030ce

data/README.md

@@ -8,9 +8,15 @@ Trenni::Markdown is a light-weight (deliberately) simple Markdown parser. It doe
 
 ## 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?
+I've been writing a bit of C++ code lately and been thinking about how to document it in a way that is actually practically useful. Initially I started working on [ffi-clang](https://github.com/) to extract comments and symbols from C++ code. But, I found this ultimately produced unsatisfying output.
 
-This markdown parser/generator is an experiment to find out if that's a good idea or not. So, far, the results are interesting.
+I discussed this with a friend and reviewed what I thought was good documentation. I found I tended to prefer short tangible examples, high-level use-cases that demonstrate the functionality of the library in a practical sense. He mentioned literate programming.
+
+I started thinking about what would be the ideal documentation. In most cases, I end up copying examples from the unit tests into the main README. This is a bit tedious but I feel it gives a good high level summary of how and why you would use a library. 
+
+I stated thinking, rather than extracting the code, what about if the README could BE code. What about if the unit tests were actual markdown which could be compiled, and used to document the code in a very tangible way?
+
+The name of this gem is a bit misleading but essentially what it does is generate code from an input markdown document according to some generator implemented in Ruby. The idea is that you could write unit tests (there is an included proof of concept for RSpec) as a readable markdown document. This would serve as the basis for the documentation and tie into the automatically generated documentation which is often hard to get a handle on in large projects. It would be the tangible entry point for high-level functionality, while the underlying symbol/comment index would be the foundation.
 
 ## Installation
 
@@ -30,7 +36,7 @@ Or install it yourself as:
 
 ### Command line
 
-A command line binary is included for basic transforms:
+A command line binary is included for basic transforms (using [examples/test.md](examples/test.md) in this example):
 
 	$ trenni-markdown -g RSpec examples/test.md
 	RSpec.describe String.new("Test") do
@@ -71,7 +77,7 @@ The delegate must respond to the following callbacks:
 	@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.
+Keep in mind that this is not a general purpose markdown parser, but specifically for the generation of literate code.
 
 ## Contributing
 

data/examples/unit_test.md

@@ -0,0 +1,41 @@
+	#include <UnitTest/UnitTest.hpp>
+	#include <Dream/Events/Loop.hpp>
+	#include <Dream/Events/Source.hpp>
+
+# Dream::Events
+
+## Timer Test
+
+### A timer is scheduled and called correctly
+
+	auto event_loop = ref(new Loop);
+
+	int ticks = 0;
+
+	event_loop->schedule_timer(new TimerSource([&](Loop *, TimerSource *, Event){
+		event_loop->stop();
+	}, 1.0));
+
+	event_loop->schedule_timer(new TimerSource([&](Loop *, TimerSource *, Event){
+		ticks += 1;
+	}, 0.01, true));
+
+	event_loop->run_forever();
+
+	examiner << "Ticker callback called correctly";
+	examiner.expect(ticks) == 100;
+
+### A timer is scheduled and runs for a limited time
+
+	auto event_loop = ref(new Loop);
+
+	int ticks = 0;
+
+	event_loop->schedule_timer(new TimerSource([&](Loop *, TimerSource *, Event){
+		ticks += 1;
+	}, 0.01, true));
+
+	event_loop->run_until_timeout(0.11);
+
+	examiner << "Ticker callback called correctly within specified timeout";
+	examiner.expect(ticks) == 10;

data/lib/trenni/markdown/generators.rb

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

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

@@ -0,0 +1,69 @@
+# 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 UnitTest < Generator
+				def initialize
+					super('// ')
+				end
+				
+				def namespace(level, name)
+					# C++17 might help us avoid this mess :(
+					parts = name.split(/::/)
+					parts.collect!{|part| "namespace #{part} {"}
+					
+					nest(level, 
+						parts.join(' ') + "\n", 
+						'}' * parts.count + "\n"
+					)
+				end
+				
+				def suite(level, name)
+					nest(level,
+						"Unit::Test #{name.gsub(/\s/, '')}Suite = {\n",
+						"};\n"
+					)
+				end
+				
+				def test(level, name)
+					nest(level,
+						"{\"#{name}\",\n",
+						"},\n"
+					)
+					
+					nest(level+1,
+						"[](UnitTest::Examiner & examiner) {",
+						"}\n"
+					)
+				end
+				
+				def heading(level, text)
+					case level
+					when 1 then namespace(level, text)
+					when 2 then suite(level, text)
+					when 3 then test(level, text)
+					end
+				end
+			end
+		end
+	end
+end

data/lib/trenni/markdown/parser.rb

@@ -59,7 +59,7 @@ module Trenni
 
 			def scan_heading
 				# Match any character data except the open tag character.
-				if self.scan(/\s*(\#+)\s*(.*?)\n/)
+				if self.scan(/\n*(\#+)\s*(.*?)\n/)
 					level = self[1].length
 					
 					unless level <= (@level + 1)

data/lib/trenni/markdown/version.rb

@@ -20,6 +20,6 @@
 
 module Trenni
 	module Markdown
-		VERSION = "0.1.0"
+		VERSION = "0.2.0"
 	end
 end

data/trenni-markdown.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
 	spec.authors       = ["Samuel Williams"]
 	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
 
-	spec.summary       = %q{A simple event-generating Markdown parser.}
+	spec.summary       = %q{A markdown parser and literate programming code generator.}
 	spec.homepage      = "https://github.com/ioquatix/trenni-markdown"
 
 	spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trenni-markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -98,11 +98,13 @@ files:
 - bin/trenni-markdown
 - examples/ruby.md
 - examples/test.md
+- examples/unit_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/generators/unit_test.rb
 - lib/trenni/markdown/parser.rb
 - lib/trenni/markdown/version.rb
 - spec/trenni/markdown/generator_spec.rb
@@ -130,7 +132,7 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A simple event-generating Markdown parser.
+summary: A markdown parser and literate programming code generator.
 test_files:
 - spec/trenni/markdown/generator_spec.rb
 - spec/trenni/markdown/parser_spec.rb