ruby_front_matter 0.0.1

data/.gitignore

@@ -0,0 +1,30 @@
+*.gem
+*.rbc
+.bundle
+.config
+<<<<<<< HEAD
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+=======
+coverage
+InstalledFiles
+>>>>>>> 918d660549aa1dfc8b91d49dea346975144b2cad
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+<<<<<<< HEAD
+=======
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+>>>>>>> 918d660549aa1dfc8b91d49dea346975144b2cad

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 F-3r
+
+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 @@
+# RubyFrontMatter
+
+simple & extensible front matter parsing in text documents for ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby_front_matter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_front_matter
+
+## Usage
+
+
+### configuring front matter format and delimiter
+
+  **RubyFrontMatter::Parser** allows to inject a custom parser for customizing the front matter format.
+
+  For example, if you want **JSON** format
+
+```ruby
+ 
+   str = '
+---
+  {
+    "front":   "matters",
+    "matters": "front"
+  }
+---
+'
+  RubyFrontMatter::Parser(parser: JSON).parse(str)
+  #=>  [{'front' => 'matters', 'matters' => 'front'}, '']
+```
+
+Any ruby object that responds to ```.load(string)``` can be used as parser.
+
+
+### configuring delimiter string
+
+```ruby
+str = '
+====
+  {
+    "front":   "matters",
+    "matters": "front"
+  }
+====
+'
+
+p = RubyFrontMatter::Parser.new(delimiter: '====', parser: JSON)
+#=> [{'front' => 'matters', 'matters' => 'front'}, '']
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs = ["lib"]
+  t.warning = false
+  t.verbose = false
+  t.test_files = FileList['spec/*_spec.rb']
+end

data/lib/ruby_front_matter/version.rb

@@ -0,0 +1,3 @@
+module RubyFrontMatter
+  VERSION = "0.0.1"
+end

data/lib/ruby_front_matter.rb

@@ -0,0 +1,22 @@
+require "ruby_front_matter/version"
+
+module RubyFrontMatter
+  class Parser
+    attr_reader :parser
+
+    def initialize(options = {})
+      options = {delimiter: '---', parser: YAML}.merge(options)
+      @delimiter = options[:delimiter]
+      @parser = options[:parser]
+    end
+
+    def parse(string = '')
+      res = [{},'']
+      res[1] = string.lstrip.gsub(/#{@delimiter}(.*)#{@delimiter}/m) do |match|
+        res[0] = @parser.load($~.captures.first.strip)
+        ''
+      end.strip
+      res
+    end
+  end
+end

data/ruby_front_matter.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_front_matter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_front_matter"
+  spec.version       = RubyFrontMatter::VERSION
+  spec.authors       = ["F-3r"]
+  spec.email         = ["f.fernando.martinez@gmail.com"]
+  spec.description   = "simple & extensible front matter parsing for ruby"
+  spec.summary       = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/ruby_front_matter_spec.rb

@@ -0,0 +1,76 @@
+require 'minitest/autorun'
+require 'yaml'
+require 'json'
+require 'bundler'
+Bundler.require
+
+describe RubyFrontMatter::Parser do
+  describe ".parse" do
+    describe "when input string is empty" do
+      it "returns an [{}, '']" do
+        str = ''
+        RubyFrontMatter::Parser.new.parse(str).must_equal [{}, '']
+      end
+    end
+
+    describe "when input string has no front matter" do
+      it "returns an empty hash and the string" do
+        str = "i'm just a piece of text"
+        RubyFrontMatter::Parser.new.parse(str).must_equal [{}, str]
+      end
+    end
+
+    describe "when input has only a front matter" do
+      it "returns a hash with an empty string" do
+        str = "
+---
+front:
+  matter: 'yes, matters'
+---
+"
+        RubyFrontMatter::Parser.new.parse(str).must_equal [{'front' => {'matter' => 'yes, matters'}}, '']
+      end
+
+      describe "when input has both" do
+        it "returns parsed front matter and rest of the string contents" do
+          str = "
+---
+a:
+  b: 123
+---
+
+some text
+"
+          RubyFrontMatter::Parser.new.parse(str).must_equal [{'a' => {'b' => 123}}, "some text"]
+        end
+      end
+
+      it "allows to inject the parser" do
+          #thus changing the front matter format
+          p = RubyFrontMatter::Parser.new(parser: JSON)
+          str = '
+---
+{
+  "front":   "matters",
+  "matters": "front"
+}
+---
+'
+          p.parse(str).must_equal [{'front' => 'matters', 'matters' => 'front'}, '']
+      end
+
+      it "allows to change the delimiter string" do
+          p = RubyFrontMatter::Parser.new(delimiter: '====', parser: JSON)
+          str = '
+====
+{
+  "front":   "matters",
+  "matters": "front"
+}
+====
+'
+          p.parse(str).must_equal [{'front' => 'matters', 'matters' => 'front'}, '']
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ruby_front_matter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- F-3r
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: simple & extensible front matter parsing for ruby
+email:
+- f.fernando.martinez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_front_matter.rb
+- lib/ruby_front_matter/version.rb
+- ruby_front_matter.gemspec
+- spec/ruby_front_matter_spec.rb
+homepage: ''
+licenses:
+- MIT
+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.23
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/ruby_front_matter_spec.rb