literati 0.0.2 → 0.0.3

data/README.md

@@ -13,7 +13,7 @@ Render literate Haskell into HTML using Ruby and magic.  But mostly Ruby.
 
 Simple and straightforward!  
 
-By default, we render using Markdown.  If you want to use another markup language or Markdown renderer, then you can use the extra magical extended API.  The only requirement is that the class takes the content as the sole argument for the initializer and exposes a `to_html` method.  Our `RedCarpet` wrapper looks like this:
+By default, we render using Markdown.  If you want to use another markup language or Markdown renderer, then you can use the extra magical extended API.  The only requirement is that the class takes the content as the sole argument for the initializer and exposes a `to_html` method.  An example `RedCarpet` wrapper would look like this:
 
     # A simple class to wrap passing the right arguments to RedCarpet.
     class RedCarpetRenderer
@@ -33,7 +33,7 @@ By default, we render using Markdown.  If you want to use another markup languag
       end
     end
 
-You can use that as a base for other wrappers.  If you wanted to use, for example, a `reStructuredText` wrapper of some sort with `literati`, you'd do something like this:
+You can easily use that as a base for other wrappers.  If you wanted to use, for example, a `reStructuredText` wrapper of some sort with `literati`, you'd do something like this:
 
     renderer = Literati::Renderer.new("content", RSTRenderer)
     renderer.to_html

data/lib/literati.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 
 module Literati
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 
   # Render the given content to HTML.
   #
@@ -73,7 +73,7 @@ module Literati
     attr_accessor :markdown_class
 
     # Regex used to determine presence of Bird-style comments
-    BIRD_TRACKS_REGEX = /^\> (.*)/
+    BIRD_TRACKS_REGEX = /^\>(\-\-| )(.*)/
 
     # Initialize a new literate Haskell renderer.
     #
@@ -121,7 +121,8 @@ module Literati
     #
     # Returns the given line of text sans bird tracks.
     def remove_bird_tracks(line)
-      line.gsub(BIRD_TRACKS_REGEX, '\1')
+      tracks = line.scan(BIRD_TRACKS_REGEX)[0]
+      (tracks.first == " ") ? tracks[1] : tracks.join
     end
 
     # Given an Array of lines, pulls from the front of the Array

data/literati.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'literati'
-  s.version           = '0.0.2'
-  s.date              = '2012-10-31'
+  s.version           = '0.0.3'
+  s.date              = '2012-11-07'
   s.rubyforge_project = 'literati'
 
   ## Make sure your summary is short. The description may be as long

data/test/test_literati.rb

@@ -14,6 +14,13 @@ TEST_CONTENT = "Hello there.
 
 More *Markdown*..."
 
+TEST_CONTENT_WITH_COMMENT = "Well this is convenient.
+
+>-- A comment, mi lord.
+> WHAT?  WHERE???
+
+Mo' content."
+
 class DummyRenderer
   def initialize(content)
     @content = content
@@ -43,8 +50,30 @@ class LiteratiTest < Test::Unit::TestCase
     end
   end
 
+  context "Markdown rendering with comments" do 
+    setup do 
+      @renderer = Literati::Renderer.new(TEST_CONTENT_WITH_COMMENT)
+    end
+
+    test "renders to Markdown string" do
+      assert_match /\`\`\`haskell/m, @renderer.to_markdown
+    end
+
+    test "removes bird tracks" do
+      assert_equal "-- a wild comment appears!", @renderer.remove_bird_tracks(">-- a wild comment appears!")
+    end
+
+    test "slurps remaining block properly" do
+      assert_equal "\n-- line one\nline two\nline three", @renderer.slurp_remaining_bird_tracks([">-- line one", "> line two", "> line three", ""])
+    end
+
+    test "slurps remaining block properly with multiple comment lines" do
+      assert_equal "\n-- line one\n--line two\nline three\n-- more commenting...", @renderer.slurp_remaining_bird_tracks([">-- line one", ">--line two", "> line three", ">-- more commenting...", ""])
+    end
+  end
+
   context "HTML rendering" do
-    test "renders to HTML using our Smart Renderer™ by default" do
+    test "renders to HTML using our Smart Renderer(tm) by default" do
       Literati::MarkdownRenderer.any_instance.expects(:to_html)
       Literati.render("markdown\n\n> codes\n\nmoar markdown")
     end

metadata

@@ -1,61 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: literati
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Jeremy McAnally
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-31 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: redcarpet
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: contest
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: contest
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Render literate Haskell with Ruby for great good.
 email: jeremy@github.com
-executables: 
+executables:
 - literati
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
 - LICENSE
-files: 
+files:
 - LICENSE
 - README.md
 - Rakefile
@@ -63,39 +59,30 @@ files:
 - lib/literati.rb
 - literati.gemspec
 - test/test_literati.rb
-has_rdoc: true
 homepage: http://github.com/jm/literati
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: literati
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 2
 summary: Render literate Haskell with Ruby.
-test_files: 
+test_files:
 - test/test_literati.rb