front_matter_parser 0.0.1

data/spec/front_matter_parser_spec.rb

@@ -0,0 +1,192 @@
+require 'spec_helper'
+
+describe FrontMatterParser do
+  let(:sample) { {'title' => 'hello'} }
+
+  it 'has a version number' do
+    expect(FrontMatterParser::VERSION).to_not be_nil
+  end
+
+  describe "#parse" do
+    context "when the string has both front matter and content" do
+      let(:string) { %Q(
+---
+title: hello
+---
+Content) }
+      let(:parsed) { FrontMatterParser.parse(string) }
+
+      it "parses the front matter as a hash" do
+        expect(parsed.front_matter).to eq(sample)
+      end
+
+      it "parses the content as a string" do
+        expect(parsed.content).to eq("Content")
+      end
+    end
+
+    context "when the string only has front matter" do
+      let(:string) { %Q(
+---
+title: hello
+---
+) }
+      let(:parsed) { FrontMatterParser.parse(string) }
+
+      it "parses the front matter as a hash" do
+        expect(parsed.front_matter).to eq(sample)
+      end
+
+      it "parses the content as an empty string" do
+        expect(parsed.content).to eq('')
+      end
+    end
+
+    context "when an empty front matter is supplied" do
+      let(:string) { %Q(Hello) }
+      let(:parsed) { FrontMatterParser.parse(string) }
+
+      it "parses the front matter as an empty hash" do
+        expect(parsed.front_matter).to eq({})
+      end
+
+      it "parses the content as the whole string" do
+        expect(parsed.content).to eq(string)
+      end
+    end
+
+    context "when an empty string is supplied" do
+      let(:parsed) { FrontMatterParser.parse('') }
+
+      it "parses the front matter as an empty hash" do
+        expect(parsed.front_matter).to eq({})
+      end
+
+      it  "parses the content as an empty string" do
+        expect(parsed.content).to eq('')
+      end
+    end
+
+    context "when the end multiline comment delimiter is provided but not the start one" do
+      it "raises an ArgumentError" do
+        string = %Q(
+<!--
+---
+title: hello
+---
+-->
+Content)
+        expect {FrontMatterParser.parse(string, end_comment: '-->')}.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "#parse_file" do
+    context "when autodetect is true" do
+      {
+        slim: ['slim', nil, '/', nil],
+        coffee: ['coffee', '#', nil, nil],
+        html: ['html', nil, '<!--', '-->'],
+        haml: ['haml', nil, '-#', nil],
+        liquid: ['liquid', nil, '<% comment %>', '<% endcomment %>'],
+        sass: ['sass', '//', nil, nil],
+        scss: ['scss', '//', nil, nil],
+        md: ['md', nil, nil, nil],
+      }.each_pair do |format, prop|
+        it "can detect a #{format} file" do
+          expect(FrontMatterParser).to receive(:parse).with(File.read(File.expand_path("../fixtures/example.#{prop[0]}", __FILE__)), comment: prop[1], start_comment: prop[2], end_comment: prop[3])
+          FrontMatterParser.parse_file(File.expand_path("../fixtures/example.#{prop[0]}", __FILE__), autodetct: true)
+        end
+      end
+
+      context "when the file extension is unknown" do
+        it "raises a RuntimeError" do
+          expect {FrontMatterParser.parse_file(File.expand_path('../fixtures/example.foo', __FILE__), autodetect: true)}.to raise_error(RuntimeError)
+        end
+      end
+    end
+
+    context "when autodetect is false" do
+      it "calls #parse with the content of the file and given comment delimiters" do
+        expect(FrontMatterParser).to receive(:parse).with(File.read(File.expand_path('../fixtures/example.md', __FILE__)), comment: nil, start_comment: nil, end_comment: nil)
+        FrontMatterParser.parse_file(File.expand_path('../fixtures/example.md', __FILE__), autodetect: false)
+      end
+    end
+  end
+end
+
+describe "the front matter" do
+  let(:sample) { {'title' => 'hello'} }
+
+  it "can be indented" do
+    string = %Q(
+  ---
+  title: hello
+  ---
+Content)
+    expect(FrontMatterParser.parse(string).front_matter).to eq(sample)
+  end
+
+  it "can have each line commented" do
+    string = %Q(
+#---
+#title: hello
+#---
+Content)
+    expect(FrontMatterParser.parse(string, comment: '#').front_matter).to eq(sample)
+  end
+
+  it "can be indented after the comment delimiter" do
+    string = %Q(
+#  ---
+#  title: hello
+#  ---
+Content)
+    expect(FrontMatterParser.parse(string, comment: '#').front_matter).to eq(sample)
+  end
+
+  it "can be between a multiline comment" do
+    string = %Q(
+<!--
+---
+title: hello
+---
+-->
+Content)
+    expect(FrontMatterParser.parse(string, start_comment: '<!--', end_comment: '-->').front_matter).to eq(sample)
+  end
+
+  it "can have the multiline comment delimiters indented" do
+    string = %Q(
+    <!--
+    ---
+    title: hello
+    ---
+    -->
+Content)
+    expect(FrontMatterParser.parse(string, start_comment: '<!--', end_comment: '-->').front_matter).to eq(sample)
+  end
+
+  it "can have empty lines between the multiline comment delimiters and the front matter" do
+    string = %Q(
+<!--
+
+---
+title: hello
+---
+  
+-->
+Content)
+    expect(FrontMatterParser.parse(string, start_comment: '<!--', end_comment: '-->').front_matter).to eq(sample)
+  end
+
+  it "can have multiline comment delimited by indentation" do
+    string = %Q(
+  /
+    ---
+    title: hello
+    ---
+  Content)
+    expect(FrontMatterParser.parse(string, start_comment: '/').front_matter).to eq(sample)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'front_matter_parser'

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: front_matter_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- marc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Library to parse files or strings with YAML front matters with syntax
+  autodetection.
+email:
+- marc@lamarciana.com
+executables:
+- autospec
+- rake
+- rspec
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- ".yardopts"
+- COPYING.LESSER
+- COPYING.txt
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/autospec
+- bin/rake
+- bin/rspec
+- front_matter_parser.gemspec
+- lib/front_matter_parser.rb
+- lib/front_matter_parser/parsed.rb
+- lib/front_matter_parser/version.rb
+- spec/fixtures/example.coffee
+- spec/fixtures/example.foo
+- spec/fixtures/example.haml
+- spec/fixtures/example.html
+- spec/fixtures/example.liquid
+- spec/fixtures/example.md
+- spec/fixtures/example.sass
+- spec/fixtures/example.scss
+- spec/fixtures/example.slim
+- spec/front_matter_parser/parsed_spec.rb
+- spec/front_matter_parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/laMarciana/front_matter_parser
+licenses:
+- LGPL3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: FrontMatterParser is a library to parse files or strings with YAML front
+  matters. When working with files, it can automatically detect the syntax of a file
+  from its extension and it supposes that the front matter is marked as that syntax
+  comments.
+test_files:
+- spec/fixtures/example.coffee
+- spec/fixtures/example.foo
+- spec/fixtures/example.haml
+- spec/fixtures/example.html
+- spec/fixtures/example.liquid
+- spec/fixtures/example.md
+- spec/fixtures/example.sass
+- spec/fixtures/example.scss
+- spec/fixtures/example.slim
+- spec/front_matter_parser/parsed_spec.rb
+- spec/front_matter_parser_spec.rb
+- spec/spec_helper.rb