metadown 0.9.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create 1.9.3@metadown

data/.yardopts

@@ -0,0 +1,4 @@
+--protected
+--no-private
+-
+LICENSE

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in metadown.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Steve Klabnik
+
+MIT License
+
+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/README.md

@@ -0,0 +1,67 @@
+# Metadown
+
+tl;dr... This gem gives you a custom markdown parser that allows you to prefix the
+markdown itself with YAML metadata.
+
+Sometimes, just having plain markdown isn't good enough. Say you're writing
+a blog post, and you want to include some information about the post itself,
+such as the date and time it was posted.  Keeping it in a separate file seems
+like a bad idea, but Markdown doesn't have any good way of doing this.
+
+Enter [Jekyll](https://github.com/mojombo/jekyll). It lets you put some YAML
+at the head of your file:
+
+    ---
+    layout: post
+    title: An Awesome Blog Post
+    ---
+    
+    Four score and seven years ago,
+
+Woudn't that be neat to use on other projects? I thought so too! Hence,
+metadown.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'metadown'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metadown
+
+## Usage
+
+Metadown might have the simplest API I've ever written: one method! Just send
+the string with the metadown you want rendered, and boom! You get an object
+back with two attributes: output and metadata.
+
+    require 'metadown'
+    
+    data = Metadown.render("hello world")
+    data.output #=> "<p>hello, world</p>"
+    data.metadata #=> "{}"
+    
+    text = <<-MARKDOWN
+    ---
+    key: "value"
+    ---
+    hello world
+    MARKDOWN
+    
+    data = Metadown.render(text)
+    data.output #=> "<p>hello, world</p>\n"
+    data.metadata #=> {"key" => "value"}
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/metadown.rb

@@ -0,0 +1,15 @@
+require "metadown/renderer"
+require "metadown/version"
+
+module Metadown
+
+  Data = Struct.new(:metadata, :output)
+
+  def render(text)
+    renderer = Metadown::Renderer.new
+    markdown = Redcarpet::Markdown.new(renderer)
+    output = markdown.render(text)
+    Data.new(renderer.metadata, output)
+  end
+  module_function :render
+end

data/lib/metadown/renderer.rb

@@ -0,0 +1,17 @@
+require 'redcarpet'
+require 'yaml'
+
+module Metadown
+  class Renderer < Redcarpet::Render::HTML
+    def preprocess(full_document)
+      full_document =~ /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
+      @metadata = YAML.load($1) if $1
+
+      $' or full_document
+    end
+
+    def metadata
+      @metadata || {}
+    end
+  end
+end

data/lib/metadown/version.rb

@@ -0,0 +1,3 @@
+module Metadown
+  VERSION = "0.9.0"
+end

data/metadown.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/metadown/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Steve Klabnik"]
+  gem.email         = ["steve@steveklabnik.com"]
+  gem.description   = %q{This gem gives you a custom markdown parser that allows you to prefix the markdown itself with YAML metadata.}
+  gem.summary       = %q{Annotate your Markdown files with metadata.}
+  gem.homepage      = "http://rubydoc.info/github/steveklabnik/metadown/1.0.0/file/README.md"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "metadown"
+  gem.require_paths = ["lib"]
+  gem.version       = Metadown::VERSION
+
+  gem.add_dependency "redcarpet"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "yard"
+end

data/spec/metadown_spec.rb

@@ -0,0 +1,19 @@
+$:.unshift("lib")
+require 'metadown'
+
+describe Metadown do
+  it "provides a factory" do
+    text = <<-MARKDOWN
+---
+key: "value"
+---
+hello world
+MARKDOWN
+
+    Metadown.render(text).tap do |data|
+      data.should be_kind_of(Metadown::Data)
+      data.metadata.should eql({"key" => "value"})
+      data.output.should eql("<p>hello world</p>\n")
+    end
+  end
+end

data/spec/renderer_spec.rb

@@ -0,0 +1,33 @@
+$:.unshift("lib")
+require 'metadown/renderer'
+
+describe Metadown::Renderer do
+  it "is a redcarpet renderer" do
+    subject.should be_kind_of(Redcarpet::Render::HTML)
+  end
+
+  it "renders markdown" do
+    r = Redcarpet::Markdown.new(subject)
+    r.render("hello world").should eql("<p>hello world</p>\n")
+  end
+
+  it "extracts YAML" do
+    r = Redcarpet::Markdown.new(subject)
+    text = <<-MARKDOWN
+---
+key: "value"
+---
+hello world
+MARKDOWN
+    
+    r.render text
+    
+    subject.metadata.should eql({"key"=>"value"})
+  end
+
+  it "gives {} for no metadata" do
+    Redcarpet::Markdown.new(subject).render("hello world")
+
+    subject.metadata.should eql({})
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: metadown
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Steve Klabnik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &2160435780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160435780
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2160434900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160434900
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2160434460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160434460
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2160433940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160433940
+description: This gem gives you a custom markdown parser that allows you to prefix
+  the markdown itself with YAML metadata.
+email:
+- steve@steveklabnik.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/metadown.rb
+- lib/metadown/renderer.rb
+- lib/metadown/version.rb
+- metadown.gemspec
+- spec/metadown_spec.rb
+- spec/renderer_spec.rb
+homepage: http://rubydoc.info/github/steveklabnik/metadown/1.0.0/file/README.md
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Annotate your Markdown files with metadata.
+test_files:
+- spec/metadown_spec.rb
+- spec/renderer_spec.rb
+has_rdoc: