front-matter 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c13ca0ef0fde95144499acc1441c4b15c625e5d1
+  data.tar.gz: bc66534262bac3c7cf54f3e9809bb78c685e09a3
+SHA512:
+  metadata.gz: 94e5e58508c2ddbf613abe2fc1a4f6eecd7858ac82f2ef42ecfe3314c02d074ada6b01871b4f5d238f091b363f4acf87ffba0350b15c7dbd7340f0b39a4b1684
+  data.tar.gz: 54ae291129545eb406b1c661b9d4c0f303129fc4f12ead0160cf50e6a1b7b8dff9af0bd364e196baa596baaf9b3c81317150c35c4f42012f73689b0a106ea0e8

data/Gemfile

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+
+source "https://rubygems.org/"
+
+gemspec
+
+
+# vim: syntax=ruby

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    front-matter (1.0.1.20130414202700)
+      facets (>= 2.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.1.0)
+    coderay (1.0.9)
+    diff-lcs (1.2.3)
+    facets (2.9.3)
+    formatador (0.2.4)
+    growl (1.0.3)
+    guard (1.7.0)
+      formatador (>= 0.2.4)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-bundler (1.0.0)
+      bundler (~> 1.0)
+      guard (~> 1.1)
+    guard-rspec (2.5.3)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    hoe (3.5.3)
+      rake (>= 0.8, < 11.0)
+    hoe-gemspec (1.0.0)
+      hoe (>= 2.2.0)
+    hoe-git (1.5.0)
+      hoe (>= 2.2.0)
+    hoe-version (1.2.0)
+    json (1.7.7)
+    listen (0.7.3)
+    lumberjack (1.0.3)
+    method_source (0.8.1)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.4)
+    rb-fsevent (0.9.3)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    slop (3.4.4)
+    terminal-notifier-guard (1.5.3)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (>= 1.1.0)
+  front-matter!
+  growl
+  guard (~> 1.7.0)
+  guard-bundler
+  guard-rspec
+  hoe
+  hoe-gemspec
+  hoe-git
+  hoe-version
+  rake (>= 10.0.0)
+  rb-fsevent (~> 0.9)
+  rdoc (~> 4.0)
+  rspec (>= 2.13)
+  terminal-notifier-guard

data/Guardfile

@@ -0,0 +1,29 @@
+
+require 'guard/bundler'
+require 'guard/rspec'
+
+notification :growl
+# notification :terminal_notifier
+
+group :frontend do
+  guard 'bundler' do
+    watch('Gemfile')
+    # Uncomment next line if Gemfile contain `gemspec' command
+    # watch(/^.+\.gemspec/)
+  end
+end
+
+group :backend do
+
+  guard 'rspec', :rvm => ['2.0.0'], :notification  => true  do
+
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')  { "spec" }
+  end
+
+end
+
+
+
+

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2012-08-25
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,14 @@
+.gemtest
+Gemfile
+Gemfile.lock
+Guardfile
+History.txt
+Manifest.txt
+README.md
+Rakefile
+bin/front_matter
+front-matter.gemspec
+lib/front_matter.rb
+lib/front_matter/core/array.rb
+spec/front_matter_spec.rb
+spec/spec_helper.rb

data/README.md

@@ -0,0 +1,113 @@
+# Front Matter
+
+* home  :: http://zhaocai.github.com/front-matter.rb/
+* rdoc  :: http://rubydoc.info/gems/front-matter.rb/
+* code  :: https://github.com/zhaocai/front-matter.rb
+* bugs  :: https://github.com/zhaocai/front-matter.rb/issues
+
+## DESCRIPTION:
+
+This gem extracts embeded info (yaml front matters, for example ) in source code
+comments with predefined format:
+
+1. the leading comment string can be different based on the language.
+2. the leading column of yaml docs must be aligned to be converted to yaml.
+
+### Format 1
+
+      # ---
+      # Gem           : front_matter
+      # Author        : Zhao Cai
+      # Email         : caizhaoff@gmail.com
+      # Tag           : [ ruby, yaml, comment ]
+      # ---
+
+### Format 2
+
+      # ============= = ============================================================
+      # Gem           : front_matter
+      # Author        : Zhao Cai
+      # Email         : caizhaoff@gmail.com
+      # Homepage      : https://github.com/zhaocai/
+      # Tag           : [ ruby, yaml, comment ]
+      # ============= = ============================================================
+
+  OR
+
+      # ------------- - ------------------------------------------------------------
+      # Gem           : front_matter
+      # Author        : Zhao Cai
+      # Email         : caizhaoff@gmail.com
+      # Homepage      : https://github.com/zhaocai/
+      # Tag           : [ ruby, yaml, comment ]
+      # ------------- - ------------------------------------------------------------
+
+
+
+## SYNOPSIS:
+
+```ruby
+require 'front_matter'
+require 'awesome_print'
+require "yaml"
+
+fm = FrontMatter.new(:unindent => true, :as_yaml => true)
+file = "README.md"
+
+
+ap YAML.load(fm.extract_file(file)[:valid][0])
+
+# {
+#   "Gem"      => "front_matter",
+#   "Author"   => "Zhao Cai",
+#   "Email"    => "caizhaoff@gmail.com",
+#   "Homepage" => "https://github.com/zhaocai/",
+#   "Tag"      => [
+#     "ruby",
+#     "yaml",
+#     "comment"
+#   ]
+# }
+
+
+```
+
+## INSTALL:
+
+`gem install front-matter`
+
+
+
+## DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012, Zhao Cai
+
+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,37 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :gemspec
+Hoe.plugin :git
+Hoe.plugin :version
+
+Hoe.spec 'front-matter' do
+
+  developer('Zhao Cai', 'caizhaoff@gmail.com')
+
+  license 'GPL-3'
+
+  extra_deps << ['facets', '>= 2.9.0']
+
+
+
+  extra_dev_deps << ['rspec', '>= 2.13']
+  extra_dev_deps << ['rake', '>= 10.0.0']
+  extra_dev_deps << ['hoe'] << ['hoe-gemspec'] << ['hoe-git'] << ['hoe-version']
+  extra_dev_deps << ['awesome_print', '>= 1.1.0']
+  extra_dev_deps << ['guard', '~> 1.7.0'] << ['guard-rspec'] << ['guard-bundler']
+  extra_dev_deps << ['terminal-notifier-guard'] << ['growl'] << ['rb-fsevent', '~> 0.9']
+
+end
+
+%w{major minor patch}.each { |v| 
+  desc "Bump #{v.capitalize} Version"
+  task "bump:#{v}", [:message] => ["version:bump:#{v}"] do |t, args|
+    m = args[:message] ? args[:message] : "Bump version to #{ENV["VERSION"]}"
+    sh "git commit -am '#{m}'"
+  end
+}
+
+# vim: syntax=ruby

data/bin/front_matter

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+#
+require "front_matter"
+require 'optparse'
+require 'awesome_print'
+
+def parse_opt()
+  options = {}
+
+  # optparse definition
+  optparse = OptionParser.new do |opts|
+    opts.on('-t', '--to FOLDER', 'save to FOLDER [required]') do |d|
+      if Dir.exist?(d)
+        options[:to] = File.expand_path(d)
+      else
+        puts "Invalid Option: #{d} should be an existing folder!"
+        puts opts
+        exit
+      end
+    end
+
+    opts.on('-h', '--help', 'Help Message') do
+      puts opts
+      exit
+    end
+  end
+
+  # parse and check mandatory options
+  begin
+    optparse.parse!
+    mandatory = []
+    missing = mandatory.select{ |param| options[param].nil? }
+    if not missing.empty?
+      puts "Missing options: #{missing.join(', ')}"
+      puts optparse
+      exit
+    end
+  rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+    puts $!.to_s
+    puts optparse
+    exit
+  end
+
+  return options
+end
+
+
+
+
+
+options = parse_opt()
+ec = FrontMatter.new()
+
+ARGV.each do |f|
+  if File.readable?(f)
+    content = ec.extract_file(f)
+    ap content
+  else
+    puts "File: #{f} is not readable!"
+  end
+end
+
+# begin
+#   comments = ec.extract(f)
+# rescue IOError => e
+#   puts "Could not write to file"
+# end
+# comments.each { |k, v|
+#   File.open(options[:to] + '/' + k, "w") do |file|
+#     file.puts v
+#   end
+# }
+

data/front-matter.gemspec

@@ -0,0 +1,77 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "front-matter"
+  s.version = "1.0.1.20130414202700"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Zhao Cai"]
+  s.date = "2013-04-15"
+  s.description = "extract embeded info (yaml, for example ) in source code comments with\npredefined format.\n\n1. the leading comment string can be different based on the language.\n2. the leading column of yaml docs must be aligned"
+  s.email = ["caizhaoff@gmail.com"]
+  s.executables = ["front_matter"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.files = ["Gemfile", "Gemfile.lock", "History.txt", "Manifest.txt", "README.txt", "Rakefile", "bin/front_matter", "front-matter.gemspec", "lib/front_matter.rb", "spec/front_matter_spec.rb", "spec/spec_helper.rb", "test/test_front_matter.rb", ".gemtest"]
+  s.homepage = "https://github.com/zhaocai/extrComment"
+  s.licenses = ["GPL-3"]
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "front-matter"
+  s.rubygems_version = "2.0.3"
+  s.summary = "extract embeded info (yaml, for example ) in source code comments with predefined format"
+  s.test_files = ["test/test_front_matter.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<facets>, [">= 2.9.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.13"])
+      s.add_development_dependency(%q<rake>, [">= 10.0.0"])
+      s.add_development_dependency(%q<hoe>, [">= 0"])
+      s.add_development_dependency(%q<hoe-gemspec>, [">= 0"])
+      s.add_development_dependency(%q<hoe-git>, [">= 0"])
+      s.add_development_dependency(%q<hoe-version>, [">= 0"])
+      s.add_development_dependency(%q<awesome_print>, [">= 1.1.0"])
+      s.add_development_dependency(%q<guard>, ["~> 1.7.0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<guard-bundler>, [">= 0"])
+      s.add_development_dependency(%q<terminal-notifier-guard>, [">= 0"])
+      s.add_development_dependency(%q<growl>, [">= 0"])
+      s.add_development_dependency(%q<rb-fsevent>, ["~> 0.9"])
+    else
+      s.add_dependency(%q<facets>, [">= 2.9.0"])
+      s.add_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_dependency(%q<rspec>, [">= 2.13"])
+      s.add_dependency(%q<rake>, [">= 10.0.0"])
+      s.add_dependency(%q<hoe>, [">= 0"])
+      s.add_dependency(%q<hoe-gemspec>, [">= 0"])
+      s.add_dependency(%q<hoe-git>, [">= 0"])
+      s.add_dependency(%q<hoe-version>, [">= 0"])
+      s.add_dependency(%q<awesome_print>, [">= 1.1.0"])
+      s.add_dependency(%q<guard>, ["~> 1.7.0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<guard-bundler>, [">= 0"])
+      s.add_dependency(%q<terminal-notifier-guard>, [">= 0"])
+      s.add_dependency(%q<growl>, [">= 0"])
+      s.add_dependency(%q<rb-fsevent>, ["~> 0.9"])
+    end
+  else
+    s.add_dependency(%q<facets>, [">= 2.9.0"])
+    s.add_dependency(%q<rdoc>, ["~> 4.0"])
+    s.add_dependency(%q<rspec>, [">= 2.13"])
+    s.add_dependency(%q<rake>, [">= 10.0.0"])
+    s.add_dependency(%q<hoe>, [">= 0"])
+    s.add_dependency(%q<hoe-gemspec>, [">= 0"])
+    s.add_dependency(%q<hoe-git>, [">= 0"])
+    s.add_dependency(%q<hoe-version>, [">= 0"])
+    s.add_dependency(%q<awesome_print>, [">= 1.1.0"])
+    s.add_dependency(%q<guard>, ["~> 1.7.0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<guard-bundler>, [">= 0"])
+    s.add_dependency(%q<terminal-notifier-guard>, [">= 0"])
+    s.add_dependency(%q<growl>, [">= 0"])
+    s.add_dependency(%q<rb-fsevent>, ["~> 0.9"])
+  end
+end

data/lib/front_matter.rb

@@ -0,0 +1,138 @@
+#!/usr/bin/env ruby
+# =============== ============================================================
+#  Desc          : extract (YAML) front matter from source code
+#  Author        : Zhao Cai <caizhaoff@gmail.com>
+#  HomePage      : https://github.com/zhaocai/front_matter.rb
+#  Date Created  : Sat 25 Aug 2012 01:36:13 AM EDT
+#  Last Modified : Sun 14 Apr 2013 08:05:00 PM EDT
+#  Tag           : [ ruby, YAML, comment, extract ]
+#  Copyright     : (c) 2012 by Zhao Cai,
+#                  Released under current GPL license.
+# =============== ============================================================
+
+require 'facets/hash'
+require 'front_matter/core/array'
+
+class FrontMatter
+  VERSION = '1.0.1'
+  attr_accessor :options
+  def initialize( options={} )
+    comment_marker   = %r{(?<comment> ^\s* \W{1,2} )}x
+    @options = {
+      :patterns => {
+        :header => {
+          :comment_marker  => comment_marker,
+          :filetype => %r{.*},
+          :start    => %r{#{comment_marker} (?<start> \s* [-=]{3,} .* [-=]{3,}$) }x ,
+          :content  => %r{#{comment_marker} (?<content> .* $)                }x ,
+          :end      => %r{#{comment_marker} (?<end> \s* [-=]{3,} .* [-=]{3,}$)   }x ,
+        },
+        :yaml => {
+          :comment_marker  => comment_marker,
+          :filetype => %r{.*},
+          :start    => %r{#{comment_marker} (?<start> \s*  -{3} $) }x ,
+          :content  => %r{#{comment_marker} (?<content> .* $)      }x ,
+          :end      => %r{#{comment_marker} (?<end> \s*    -{3} $)  }x ,
+        },
+      },
+      :unindent => false,
+      :as_yaml => false
+    }
+    @options.merge!(options)
+  end
+
+  def extract_lines(lines, filetype=[])
+    content={}
+    unless filetype.empty?
+      patterns = @options[:patterns].select { |kind, pattern|
+        filetype.any { |ft| pattern[:filetype].match(ft)}
+      }
+    else
+      patterns = @options[:patterns]
+    end
+
+    patterns.each { |kind, pattern|
+      content[kind] = []
+      in_comment = false
+      in_content = {
+        :valid   => [],
+        :invalid => [],
+        :unbound => [],
+      }
+
+      lines.each { |line|
+        if ! in_comment
+          case line
+          when pattern[:start]
+            in_comment = true
+            next
+          end
+        else
+          if pattern[:end] =~ line
+            in_comment = false
+            content[kind].push(in_content)
+            next
+          end
+
+          m = pattern[:content].match(line)
+          begin
+            in_content[:valid].push(m[:content])
+          rescue IndexError,NoMethodError
+            in_content[:invalid].push(line)
+          end
+        end
+      }
+
+      # fail to match ending
+      if in_comment
+        in_content[:unbound] = in_content[:valid]
+        in_content[:valid] = []
+        content[kind].push(in_content)
+      end
+    }
+
+    results = {
+      :valid   => [],
+      :invalid => [],
+      :unbound => [],
+    }
+
+    content.each_pair { |kind, v|
+      v.each { |c| c.each_pair { |status, content|
+        results[status].push(content) unless content.empty? }
+      }
+    }
+    results.delete_if {|status, result| result.empty?}
+
+    if @options[:unindent]
+      results.traverse! { |k,v|
+        [k, v.map {|i| i.unindent }]
+      }
+    end
+
+    if @options[:as_yaml]
+      results.traverse! { |k,v|
+        [k, v.map {|i| "---\n#{i.join("\n")}"}]
+      }
+    end
+    results
+  end
+
+  def extract_file(infile, filetype=[])
+    return self.extract_lines(File.readlines(infile).map(&:chomp), filetype)
+  end
+
+  def unindent(lines)
+    indent = lines.select {|line| !line.strip.empty? }.map {|line| line.index(/[^\s]/) }.compact.min || 0
+    lines.map {|line| line.gsub(/^[[:blank:]]{#{indent}}/, '')}
+  end
+
+end
+
+# ---
+#   a : "b"
+#   c : d
+# ---
+
+
+

data/lib/front_matter/core/array.rb

@@ -0,0 +1,8 @@
+class Array 
+  def unindent
+    indent = select {|line| !line.strip.empty? }.map {|line| line.index(/[^\s]/) }.compact.min || 0
+    map {|line| line.gsub(/^[[:blank:]]{#{indent}}/, '')}
+  end
+
+end
+

data/spec/front_matter_spec.rb

@@ -0,0 +1,176 @@
+require "spec_helper"
+require "yaml"
+describe "Front_Matter" do
+    before :all do
+      Dir.chdir("test/")
+    end
+
+
+  context "Extraction" do
+    before :all do
+      @fm =  FrontMatter.new
+    end
+
+    it "should extract yaml front matter" do
+      code = %Q{
+      # ---
+      #       FileName : extract_sh
+      #       Desc     : extract shell functions from shell script
+      #       Author   : Zhao Cai <caizhaoff@gmail.com>
+      # ---
+      # 
+      }.unindent
+
+      valid_content = [
+        "      FileName : extract_sh"                                ,
+        "      Desc     : extract shell functions from shell script" ,
+        "      Author   : Zhao Cai <caizhaoff@gmail.com>"
+      ]
+      content = @fm.extract_lines(code.split("\n").map(&:chomp))
+
+      content[:valid][0].should == valid_content
+
+    end
+
+    it "should extract header front matter" do
+      code = %Q{
+      # --------------- ------------------------------------------------------------
+      #       FileName : extract_sh
+      #       Desc     : extract shell functions from shell script
+      #       Author   : Zhao Cai <caizhaoff@gmail.com>
+      # --------------- ------------------------------------------------------------
+      }.unindent
+
+      valid_content = [
+        "      FileName : extract_sh"                                ,
+        "      Desc     : extract shell functions from shell script" ,
+        "      Author   : Zhao Cai <caizhaoff@gmail.com>"
+      ]
+      content = @fm.extract_lines(code.split("\n").map(&:chomp))
+
+      content[:valid][0].should == valid_content
+
+    end
+
+    it "should properly extract yaml front matter when there is no ending" do
+      code = %Q{
+      # ---
+      #       FileName : extract_sh
+      #       Desc     : extract shell functions from shell script
+      #       Author   : Zhao Cai <caizhaoff@gmail.com>
+
+      abc
+      }.unindent
+
+      valid_content = [
+        "      FileName : extract_sh"                                ,
+        "      Desc     : extract shell functions from shell script" ,
+        "      Author   : Zhao Cai <caizhaoff@gmail.com>",
+      ]
+      content = @fm.extract_lines(code.split("\n").map(&:chomp))
+
+      content[:unbound][0].should == valid_content
+    end
+  end
+
+
+
+  context "Unindent" do
+    before :all do
+      @fm =  FrontMatter.new(:unindent => true)
+    end
+
+    it "should extract yaml front matter" do
+      code = %Q{
+      # ---
+      #       FileName : extract_sh
+      #       Desc     : extract shell functions from shell script
+      #       Author   : Zhao Cai <caizhaoff@gmail.com>
+      # ---
+      # 
+      }.unindent
+
+      valid_content = [
+        "FileName : extract_sh"                                ,
+        "Desc     : extract shell functions from shell script" ,
+        "Author   : Zhao Cai <caizhaoff@gmail.com>"
+      ]
+      content = @fm.extract_lines(code.split("\n").map(&:chomp))
+
+      content[:valid][0].should == valid_content
+
+    end
+
+    it "should extract header front matter" do
+      code = %Q{
+      # --------------- ------------------------------------------------------------
+      #       FileName : extract_sh
+      #       Desc     : extract shell functions from shell script
+      #       Author   : Zhao Cai <caizhaoff@gmail.com>
+      # --------------- ------------------------------------------------------------
+      }.unindent
+
+      valid_content = [
+        "FileName : extract_sh"                                ,
+        "Desc     : extract shell functions from shell script" ,
+        "Author   : Zhao Cai <caizhaoff@gmail.com>"
+      ]
+      content = @fm.extract_lines(code.split("\n").map(&:chomp))
+
+      content[:valid][0].should == valid_content
+
+    end
+
+    it "should properly extract yaml front matter when there is no ending" do
+      code = %Q{
+      # ---
+      #       FileName : extract_sh
+      #       Desc     : extract shell functions from shell script
+      #       Author   : Zhao Cai <caizhaoff@gmail.com>
+
+      abc
+      }.unindent
+
+      valid_content = [
+        "FileName : extract_sh"                                ,
+        "Desc     : extract shell functions from shell script" ,
+        "Author   : Zhao Cai <caizhaoff@gmail.com>",
+      ]
+      content = @fm.extract_lines(code.split("\n").map(&:chomp))
+
+      content[:unbound][0].should == valid_content
+    end
+  end
+
+  context "YAML" do
+    before :all do
+      @fm =  FrontMatter.new(:unindent => true, :as_yaml => true)
+    end
+
+    it "should extract and convert to valid yaml" do
+      code = %Q{
+      # ---
+      #       FileName : extract_sh
+      #       Desc     : extract shell functions from shell script
+      #       Author   : Zhao Cai <caizhaoff@gmail.com>
+      # ---
+      # 
+      }.unindent
+
+      valid_yaml = YAML.load([
+        "---",
+        "FileName : extract_sh"                                ,
+        "Desc     : extract shell functions from shell script" ,
+        "Author   : Zhao Cai <caizhaoff@gmail.com>"
+      ].join("\n"))
+      content = @fm.extract_lines(code.split("\n"))
+
+      YAML.load(content[:valid][0]).should == valid_yaml
+
+    end
+
+  end
+end
+
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require "rspec"
+
+require 'facets/string'
+require "front_matter"
+
+RSpec.configure do |c|
+  c.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  c.tty = true
+
+  c.formatter = :documentation # :progress, :html, :textmate
+
+  c.mock_with :rspec
+end
+

metadata

@@ -0,0 +1,279 @@
+--- !ruby/object:Gem::Specification
+name: front-matter
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Zhao Cai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hoe-gemspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hoe-git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hoe-version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: |-
+  This gem extracts embeded info (yaml front matters, for example ) in source code
+  comments with predefined format:
+
+  1. the leading comment string can be different based on the language.
+  2. the leading column of yaml docs must be aligned to be converted to yaml.
+email:
+- caizhaoff@gmail.com
+executables:
+- front_matter
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+files:
+- .gemtest
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- History.txt
+- Manifest.txt
+- README.md
+- Rakefile
+- bin/front_matter
+- front-matter.gemspec
+- lib/front_matter.rb
+- lib/front_matter/core/array.rb
+- spec/front_matter_spec.rb
+- spec/spec_helper.rb
+homepage: http://zhaocai.github.com/front-matter.rb/
+licenses:
+- GPL-3
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --main
+- README.md
+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: front-matter
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: 'This gem extracts embeded info (yaml front matters, for example ) in source
+  code comments with predefined format:  1'
+test_files: []