metadown 0.9.0 → 1.0.0

data/.travis.yml

@@ -0,0 +1,10 @@
+script: "rspec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - ree
+

data/lib/metadown.rb

@@ -1,10 +1,18 @@
 require "metadown/renderer"
 require "metadown/version"
 
+# This module namespaces everything in the gem. It's also where the factory
+# #render method lives.
 module Metadown
 
+  # This struct is what gets returned from a call to #render.
+  # 
+  # It has two attributes, one for the metadata, and one for the rendered
+  # output.
   Data = Struct.new(:metadata, :output)
 
+  # The render method is a convenient factory. It parses some text via our
+  # Renderer class and Redcarpet's own class, and gives us a Data back.
   def render(text)
     renderer = Metadown::Renderer.new
     markdown = Redcarpet::Markdown.new(renderer)

data/lib/metadown/renderer.rb

@@ -2,7 +2,14 @@ require 'redcarpet'
 require 'yaml'
 
 module Metadown
+  # This class is our own flavor of Redcarpet. It grabs out
+  # all the metadata before letting the rest of Redcarpet do
+  # all the work.
   class Renderer < Redcarpet::Render::HTML
+
+    # This hook is provided to us by Redcarpet. We get access
+    # to the whole text before anything else kicks off, which
+    # means we can snag out the YAML at the beginning.
     def preprocess(full_document)
       full_document =~ /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
       @metadata = YAML.load($1) if $1
@@ -10,6 +17,8 @@ module Metadown
       $' or full_document
     end
 
+    # This accessor lets us access our metadata after the
+    # processing is all done.
     def metadata
       @metadata || {}
     end

data/lib/metadown/version.rb

@@ -1,3 +1,4 @@
 module Metadown
-  VERSION = "0.9.0"
+  # The current released version of Metadown
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metadown
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &2160435780 !ruby/object:Gem::Requirement
+  requirement: &2152680980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160435780
+  version_requirements: *2152680980
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160434900 !ruby/object:Gem::Requirement
+  requirement: &2152680120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160434900
+  version_requirements: *2152680120
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2160434460 !ruby/object:Gem::Requirement
+  requirement: &2152679680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160434460
+  version_requirements: *2152679680
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2160433940 !ruby/object:Gem::Requirement
+  requirement: &2152679160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160433940
+  version_requirements: *2152679160
 description: This gem gives you a custom markdown parser that allows you to prefix
   the markdown itself with YAML metadata.
 email:
@@ -65,6 +65,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
+- .travis.yml
 - .yardopts
 - Gemfile
 - LICENSE