front_matter_parser 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 747db28088db295148c0d41fbcd79c9a861b900c
-  data.tar.gz: 455ff93bddc82da6139f449e24b52010b257d3cb
+  metadata.gz: f4c2e7f42d072334636f3781de92e513279c0505
+  data.tar.gz: 06c3a80b9b53bedbb4c48b2d479f44478bf9d6b2
 SHA512:
-  metadata.gz: 015bd32903bf893ab8a8a162b682b7fcb7197a9bd5f9a56cdec6db6056b7f88797d5278f0aa57e421e040442def75aeb3e691e3f4384cb2fead12c9a69b4b285
-  data.tar.gz: 77405afc93d9ace168815d5f0b6f92d0e50dffc110aa74a07456afb9927e9b104fd2f88f9fa8876053cdcc59874f876611aec7eb92385042547763b058507ea1
+  metadata.gz: 2ccfb0f6c35751cd44f4b4140f14873390ddc38b400f83f7771a5665d4b81abdc56ea1b8825714101a6c5f1ffc39cecf5ccc4e3537081830de0fe7591f9cde24
+  data.tar.gz: 38dcc37664adaf5b4add747aa9958d5415a5c1833ce01b22aa501faca438306cf33cefb8a26088286042e52b51b4bba718c42fc25c3c24994ee408d2c7b72af0

data/.rspec

@@ -1,2 +1 @@
---format documentation
 --color

data/README.md

@@ -1,6 +1,6 @@
 # FrontMatterParser
 
-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.
+FrontMatterParser is a library to parse files or strings with YAML front matters. 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.
 
 ## Installation
 
@@ -8,6 +8,10 @@ Add this line to your application's Gemfile:
 
     gem 'front_matter_parser'
 
+or, to get the development version:
+
+    gem 'front_matter_parser', github: 'laMarciana/front_matter_parser'
+
 And then execute:
 
     $ bundle
@@ -22,37 +26,47 @@ Front matters must be between two lines with three dashes `---`.
 
 Given a file `example.md`:
 
-    ---
-    title: Hello World
-    category: Greetings
-    ---
-    Some actual content
+```md
+---
+title: Hello World
+category: Greetings
+---
+Some actual content
+```
 
 You can parse it:
 
-    parsed = FrontMatterParser.parse_file('example.md')
-    parsed.front_matter #=> {'title' => 'Hello World'}
-    parsed.content #=> 'Some actual content'
+```ruby
+parsed = FrontMatterParser.parse_file('example.md')
+parsed.front_matter #=> {'title' => 'Hello World', 'category' => 'Greetings'}
+parsed.content #=> 'Some actual content'
+```
 
 You can apply directly `[]` method to get a front matter value:
 
-    parsed['category'] #=> 'Greetings'
+```ruby
+parsed['category'] #=> 'Greetings'
+```
 
 ### Syntax autodetection
 
-`FrontMatterParser` detects the syntax of a file by its extension and suppose that the front matter is within that syntax comments delimiters.
+`FrontMatterParser` detects the syntax of a file by its extension and it supposes that the front matter is within that syntax comments delimiters.
 
 Given a file `example.haml`:
 
-    -#
-       ---
-       title: Hello
-       ---
-    Content
+```haml
+-#
+   ---
+   title: Hello
+   ---
+Content
+```
 
-The `-#` and the indentation enclose the front matter as a comment. `FrontMatterParser` is aware of it and you can simply do:
+The `-#` and the indentation enclose the front matter as a comment. `FrontMatterParser` is aware of that, so you can simply do:
 
-    title = FrontMatterParser.parse_file('example.haml')['title'] #=> 'Hello'
+```ruby
+title = FrontMatterParser.parse_file('example.haml')['title'] #=> 'Hello'
+```
 
 Following there is a relation of known syntaxes and their known comment delimiters:
 
@@ -61,26 +75,38 @@ Following there is a relation of known syntaxes and their known comment delimite
 | ------ | ------------------- | ----------------------- | ---------------------- |
 | haml   |                     | -#                      | (indentation)          |
 | slim   |                     | /                       | (indentation)          |
-| liquid |                     | <% comment %>           | <% endcomment %>       |
+| liquid |                     | {% comment %}           | {% endcomment %}       |
 | md     |                     |                         |                        |
 | html   |                     | &lt;!--                    | --&gt;                    |
+| erb    |                     | &lt;%#                     | %&gt;                     |
 | coffee | #                   |                         |                        |
 | sass   | //                  |                         |                        |
 | scss   | //                  |                         |                        |
 </pre>
 
-You can provide your own by passing `autodetect: false` and options for single line comment delimiter (`:comment`) or start multiline comment (`:start_comment`) and end multiline comment (`:end_comment`) delimiters. If `:start_comment` is provided but it isn't `:end_comment`, then it is supposed that the multiline comment is ended by indentation.
+For unknown syntaxes or alternative ones, you can provide your own single line comment delimiter with the `:comment` option, or multiline comment delimiters with `:start_comment` and `:end_comment`. If `:start_comment` is provided but it isn't `:end_comment`, then it is supposed that the multiline comment is ended by indentation.
 
-    FrontMatterParser.parse_file('example.haml', autodetect: false, start_comment: '<!--', end_comment: '-->') # start and end multiline comment delimiters
-    FrontMatterParser.parse_file('example.slim', autodetect: false, start_comment: '/!') # multiline comment closed by indentation
-    FrontMatterParser.parse_file('example.foo', autodetect: false, comment: '#') # single line comments
+```ruby
+FrontMatterParser.parse_file('example.haml', start_comment: '<!--', end_comment: '-->') # start and end multiline comment delimiters
+FrontMatterParser.parse_file('example.slim', start_comment: '/!') # multiline comment closed by indentation
+FrontMatterParser.parse_file('example.foo', comment: '#') # single line comments
+```
 
 ### Parsing a string
 
-You can as well parse a string, providing manually its comment delimiters if needed:
+You can as well parse a string, providing manually the `syntax`:
+
+```ruby
+string = File.read('example.slim')
+FrontMatterParser.parse(string, syntax: :slim)
+```
+
+or the comment delimiters:
 
-    string = File.read('example.slim')
-    FrontMatterParser.parse(string, start_comment: '/')
+```ruby
+string = File.read('example.slim')
+FrontMatterParser.parse(string, start_comment: '/!')
+```
 
 ## Contributing
 

data/lib/front_matter_parser.rb

@@ -4,7 +4,7 @@ require "front_matter_parser/parsed"
 
 # FrontMatterParser module is the entry point to parse strings or files 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.
 module FrontMatterParser
-  # {Hash {Symbol => Array}} Comments delimiters used in FrontMatterParser known syntaxes. Keys are file extensions, and values are three elements array:
+  # {Hash {Symbol => Array}} Comments delimiters for FrontMatterParser known syntaxes. Keys are file extensions for {FrontMatterParser.parse_file} or :syntax option values for {FrontMatterParser.parse}, and values are three elements array:
   #
   # * First element is single line comment delimiter.
   # * Second element is the start multiline comment delimiter.
@@ -12,31 +12,44 @@ module FrontMatterParser
   COMMENT_DELIMITERS = {
     slim: [nil, '/', nil],
     html: [nil, '<!--', '-->'],
+    erb: [nil, '<%#', '%>'],
     coffee: ['#', nil, nil],
     haml: [nil, '-#', nil],
-    liquid: [nil, '<% comment %>', '<% endcomment %>'],
+    liquid: [nil, '{% comment %}', '{% endcomment %}'],
     sass: ['//', nil, nil],
     scss: ['//', nil, nil],
     md: [nil, nil, nil],
   }
 
-  # Parses a string into a {Parsed} instance. For comment options, see {COMMENT_DELIMITERS} values (but they are not limited to those for the known syntaxes).
+  # Parses a string into a {Parsed} instance. The syntax of the string can be set with :syntax option. Otherwise, comment marks can be manually indicated with :comment, :start_comment and :end_comment options.
   #
   # @param string [String] The string to parse
   # @param opts [Hash] Options
+  # @option opts [Symbol] :syntax The syntax used in the string. See {FrontMatterParser::COMMENT_DELIMITERS} for allowed values and the comment delimiters that are supposed.
   # @option opts [String, nil] :comment Single line comment delimiter
   # @option opts [String, nil] :start_comment Start multiline comment delimiter
-  # @option opts [String, nil] :end_comment End multiline comment delimiter
+  # @option opts [String, nil] :end_comment End multiline comment delimiter. If it is `nil` and :start_comment isn't, the multiline comment is supposed to be closed by indentation
   # @return [Parsed]
-  # @raise [ArgumentError] If end_comment option is provided but not start_comment
+  # @raise [ArgumentError] If :syntax is not within {COMMENT_DELIMITERS} keys
+  # @raise [ArgumentError] If :end_comment option is given but not :start_comment
+  # @raise [ArgumentError] If :comment and :start_comment options are given
   # @see COMMENT_DELIMITERS
   def self.parse(string, opts = {})
     opts = {
       comment: nil,
       start_comment: nil,
       end_comment: nil,
+      syntax: nil,
     }.merge(opts)
-    raise(ArgumentError, "If you provide the `end_comment` option, you must provide also the `start_comment` option") if (opts[:end_comment] != nil and opts[:start_comment] == nil)
+
+    raise(ArgumentError, "If you provide :end_comment, you must also provide :start_comment") if (opts[:end_comment] != nil and opts[:start_comment] == nil)
+    raise(ArgumentError, "You can not provide :comment and :start_comment options at the same time") if (opts[:start_comment] != nil and opts[:comment] != nil)
+
+    if opts[:comment].nil? and opts[:start_comment].nil? and not opts[:syntax].nil?
+      raise(ArgumentError, "#{opts[:syntax]} syntax not known. Please call parse providing manually comment delimiters for that syntax.") unless COMMENT_DELIMITERS.has_key?(opts[:syntax])
+      opts[:comment], opts[:start_comment], opts[:end_comment] = COMMENT_DELIMITERS[opts[:syntax]]
+    end
+
     parsed = Parsed.new
     if matches = (string.match(/
                                # Start of string
@@ -59,7 +72,7 @@ module FrontMatterParser
                                # End of string
                                \z
                                /mx))
-      front_matter = matches[:front_matter].gsub(/^#{opts[:comment]}/, '')
+      front_matter = matches[:front_matter].gsub(/^[[:blank:]]*#{opts[:comment]}/, '')
       parsed.front_matter = YAML.load(front_matter)
       parsed.content = matches[:content]
     else
@@ -69,35 +82,36 @@ module FrontMatterParser
     parsed
   end
 
-  # Parses a file into a {Parsed} instance. If autodetect option is `true`, comment delimiters are guessed from the file extension. If it is `false` comment options are taken into consideration. See {COMMENT_DELIMITERS} for a list of known syntaxes and the comment delimiters values.
+  # Parses a file into a {Parsed} instance. Syntax is automatically guessed from the file extension, unless :comment, :start_comment or :end_comment options are given. See {COMMENT_DELIMITERS} for a list of known extensions and the comment delimiters values that are supposed.
   #
   # @param pathname [String] The path to the file
   # @param opts [Hash] Options
-  # @option opts [Boolean] :autodetect If it is true, FrontMatterParser uses the comment delimiters known for the syntax of the file and comment options are ignored. If it is false, comment options are taken into consideration.
   # @option opts [String, nil] :comment Single line comment delimiter
   # @option opts [String, nil] :start_comment Start multiline comment delimiter
-  # @option opts [String, nil] :end_comment End multiline comment delimiter
+  # @option opts [String, nil] :end_comment End multiline comment delimiter. If it is `nil`, the multiline comment is supposed to be closed by indentation.
   # @return [Parsed]
-  # @raise [ArgumentError] If autodetect option is false, and start_comment option is provided but not end_comment
-  # @raise [RuntimeError] If the syntax of the file (the extension) is not within the keys of {COMMENT_DELIMITERS}
+  # @raise [ArgumentError] If :start_comment option is provided but not :end_comment
+  # @raise [ArgumentError] If :comment and :start_comment options are both provided
+  # @raise [ArgumentError] If :end_comment is provided but :start_comment isn't
+  # @raise [RuntimeError] If the syntax of the file (the extension) is not within the keys of {COMMENT_DELIMITERS} or the file has no extension, and none of :comment, :start_comment or :end_comment are provided
   # @see COMMENT_DELIMITERS
   def self.parse_file(pathname, opts={})
     opts = {
-      autodetect: true,
       comment: nil,
       start_comment: nil,
       end_comment: nil,
     }.merge(opts)
-    if opts[:autodetect]
-      ext = File.extname(pathname)[1 .. -1].to_sym
-      raise(RuntimeError, "Comment delimiters for extension #{ext.to_s} not known. Please, call #parse_file without autodetect option and provide comment delimiters.") unless COMMENT_DELIMITERS.has_key?(ext)
-      comment_delimiters = COMMENT_DELIMITERS[ext]
-      opts[:comment] = comment_delimiters[0]
-      opts[:start_comment] = comment_delimiters[1]
-      opts[:end_comment] = comment_delimiters[2]
-    end
-    File.open(pathname) do |file|
-      parse(file.read, comment: opts[:comment], start_comment: opts[:start_comment], end_comment: opts[:end_comment])
+    if opts[:comment].nil? and opts[:start_comment].nil?
+      ext = File.extname(pathname)[1 .. -1]
+      ext = ext.to_sym unless ext.nil?
+      raise(RuntimeError, "Comment delimiters for extension #{ext.to_s} not known. Please, call #parse_file providing manually comment delimiters for that extension.") unless COMMENT_DELIMITERS.has_key?(ext)
+      File.open(pathname) do |file|
+        parse(file.read, syntax: ext)
+      end
+    else
+      File.open(pathname) do |file|
+        parse(file.read, comment: opts[:comment], start_comment: opts[:start_comment], end_comment: opts[:end_comment])
+      end
     end
   end
 end

data/lib/front_matter_parser/version.rb

@@ -1,3 +1,3 @@
 module FrontMatterParser
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/fixtures/example.coffee

@@ -1,4 +1,4 @@
 # ---
-# title: Hello
+# title: hello
 # ---
 Content

data/spec/fixtures/example.erb

@@ -0,0 +1,6 @@
+<%#
+  ---
+  title: hello
+  ---
+%>
+Content

data/spec/fixtures/example.haml

@@ -1,5 +1,5 @@
 -#
    ---
-   title: Hello
+   title: hello
    ---
 Content

data/spec/fixtures/example.html

@@ -1,6 +1,6 @@
 <!--
   ---
-  title: Hello
+  title: hello
   ---
 -->
 Content

data/spec/fixtures/example.liquid

@@ -1,6 +1,6 @@
-{ %comment% }
+{% comment %}
 ---
-title: Hello
+title: hello
 ---
-{ %endcomment% }
+{% endcomment %}
 Content

data/spec/fixtures/example.md

@@ -1,4 +1,4 @@
 ---
-title: Hello
+title: hello
 ---
 Content

data/spec/fixtures/example.sass

@@ -1,4 +1,4 @@
 // ---
-// title: Hello
+// title: hello
 // ---
 Content

data/spec/fixtures/example.scss

@@ -1,4 +1,4 @@
 // ---
-// title: Hello
+// title: hello
 // ---
 Content

data/spec/fixtures/example.slim

@@ -1,5 +1,5 @@
 /
   ---
-  title: Hello
+  title: hello
   ---
 Content

data/spec/front_matter_parser_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
 describe FrontMatterParser do
-  let(:sample) { {'title' => 'hello'} }
+  let(:sample_fm) { {'title' => 'hello'} }
+  let(:sample_c) { 'Content' }
 
   it 'has a version number' do
     expect(FrontMatterParser::VERSION).to_not be_nil
@@ -9,32 +10,22 @@ describe FrontMatterParser do
 
   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)
+        expect(parsed.front_matter).to eq(sample_fm)
       end
 
       it "parses the content as a string" do
-        expect(parsed.content).to eq("Content")
+        expect(parsed.content).to eq(sample_c)
       end
     end
 
     context "when the string only has front matter" do
-      let(:string) { %Q(
----
-title: hello
----
-) }
-      let(:parsed) { FrontMatterParser.parse(string) }
+      let(:parsed) { FrontMatterParser.parse(string_no_content) }
 
       it "parses the front matter as a hash" do
-        expect(parsed.front_matter).to eq(sample)
+        expect(parsed.front_matter).to eq(sample_fm)
       end
 
       it "parses the content as an empty string" do
@@ -43,15 +34,14 @@ title: hello
     end
 
     context "when an empty front matter is supplied" do
-      let(:string) { %Q(Hello) }
-      let(:parsed) { FrontMatterParser.parse(string) }
+      let(:parsed) { FrontMatterParser.parse(string_no_front_matter) }
 
       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)
+        expect(parsed.content).to eq(sample_c)
       end
     end
 
@@ -67,56 +57,176 @@ title: hello
       end
     end
 
-    context "when the end multiline comment delimiter is provided but not the start one" do
+    context "when :comment option is given" do
+      it "takes it as the single line comment mark for the front matter" do
+        parsed = FrontMatterParser.parse(string_comment('#'), comment: '#')
+        expect(parsed.front_matter).to eq(sample_fm)
+      end
+
+      context "when :start_comment is given" do
+        it "raises an ArgumentError" do
+          expect { FrontMatterParser.parse(string_comment('#'), comment: '#', start_comment: '/')}.to raise_error ArgumentError
+        end
+      end
+    end
+
+    context "when :start_comment option is given" do
+      context "when :end_comment option is not given" do
+        it "takes :start_comment as the mark for a multiline comment closed by indentation for the front matter" do
+          parsed = FrontMatterParser.parse(string_start_comment('/'), start_comment: '/')
+          expect(parsed.front_matter).to eq(sample_fm)
+        end
+      end
+
+      context "when :end_comment option is provided" do
+        it "takes :start_comment and :end_comment as the multiline comment mark delimiters for the front matter" do
+          parsed = FrontMatterParser.parse(string_start_end_comment('<!--', '-->'), start_comment: '<!--', end_coment: '-->')
+          expect(parsed.front_matter).to eq(sample_fm)
+        end
+      end
+    end
+
+    context "when :end_comment option is given but :start_comment is not" do
       it "raises an ArgumentError" do
-        string = %Q(
-<!--
----
-title: hello
----
--->
-Content)
-        expect {FrontMatterParser.parse(string, end_comment: '-->')}.to raise_error(ArgumentError)
+        expect {FrontMatterParser.parse(string_start_end_comment, end_comment: '-->')}.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when :syntax is given" do
+      context "when :comment and :start_comment are not given" do
+        syntaxs.each_pair do |name, value|
+          it "can detect a #{name} syntax when its value is #{value}" do
+            parsed = FrontMatterParser.parse(File.read(File.expand_path("../fixtures/example.#{value}", __FILE__)), syntax: value)
+            expect(parsed.front_matter).to eq(sample_fm)
+          end
+        end
+
+        it "raises an ArgumentError if syntax is not whithin COMMENT_DELIMITERS keys" do
+          expect { FrontMatterParser.parse(string, syntax: :foo) }.to raise_error ArgumentError
+        end
+      end
+
+      context "when :comment is given" do
+        it ":syntax is ignored" do
+          parsed = FrontMatterParser.parse(File.read(File.expand_path("../fixtures/example.coffee", __FILE__)), syntax: :slim, comment: '#' )
+          expect(parsed.front_matter).to eq(sample_fm)
+        end
+      end
+
+      context "when :start_comment is given" do
+        it ":syntax is ignored" do
+          parsed = FrontMatterParser.parse(File.read(File.expand_path("../fixtures/example.slim", __FILE__)), syntax: :coffee, start_comment: '/' )
+          expect(parsed.front_matter).to eq(sample_fm)
+        end
       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)
+    context "when the file has both front matter and content" do
+      let(:parsed) { FrontMatterParser.parse_file(file_fixture(string), comment: '') }
+
+      it "parses the front matter as a hash" do
+        expect(parsed.front_matter).to eq(sample_fm)
+      end
+
+      it "parses the content as a string" do
+        expect(parsed.content).to eq(sample_c)
+      end
+    end
+
+    context "when the file only has front matter" do
+      let(:parsed) { FrontMatterParser.parse_file(file_fixture(string_no_content), comment: '') }
+
+      it "parses the front matter as a hash" do
+        expect(parsed.front_matter).to eq(sample_fm)
+      end
+
+      it "parses the content as an empty string" do
+        expect(parsed.content).to eq('')
+      end
+    end
+
+    context "when the file has an empty front matter is supplied" do
+      let(:parsed) { FrontMatterParser.parse_file(file_fixture(string_no_front_matter), comment: '') }
+
+      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(sample_c)
+      end
+    end
+
+    context "when the file has no content" do
+      let(:parsed) { FrontMatterParser.parse_file(file_fixture(''), comment: '') }
+
+      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 :comment option is given" do
+      it "takes it as the single line comment mark for the front matter" do
+        parsed = FrontMatterParser.parse_file(file_fixture(string_comment('#')), comment: '#')
+        expect(parsed.front_matter).to eq(sample_fm)
+      end
+
+      context "when :start_comment is given" do
+        it "raises an ArgumentError" do
+          expect { FrontMatterParser.parse_file(file_fixture(string_comment('#')), comment: '#', start_comment: '/')}.to raise_error ArgumentError
+        end
+      end
+    end
+
+    context "when :start_comment option is given" do
+      context "when :end_comment option is not given" do
+        it "takes :start_comment as the mark for a multiline comment closed by indentation for the front matter" do
+          parsed = FrontMatterParser.parse_file(file_fixture(string_start_comment('/')), start_comment: '/')
+          expect(parsed.front_matter).to eq(sample_fm)
         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)
+      context "when :end_comment option is provided" do
+        it "takes :start_comment and :end_comment as the multiline comment mark delimiters for the front matter" do
+          parsed = FrontMatterParser.parse_file(file_fixture(string_start_end_comment('<!--', '-->')), start_comment: '<!--', end_coment: '-->')
+          expect(parsed.front_matter).to eq(sample_fm)
         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)
+    context "when :end_comment option is given but :start_comment is not" do
+      it "raises an ArgumentError" do
+        expect {FrontMatterParser.parse_file(file_fixture(string_start_end_comment), end_comment: '-->')}.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when :comment and :start_comment are not given" do
+      syntaxs.each_pair do |name, value|
+        it "can detect a #{name} syntax file when its extension is #{value}" do
+          parsed = FrontMatterParser.parse_file(File.expand_path("../fixtures/example.#{value}", __FILE__))
+          expect(parsed.front_matter).to eq(sample_fm)
+        end
+      end
+
+      it "raises an ArgumentError if the file extension is not whithin COMMENT_DELIMITERS keys" do
+        expect { FrontMatterParser.parse_file(File.expand_path("../fixtures/example.foo, __FILE__")) }.to raise_error RuntimeError
+      end
+
+      it "raises an ArgumentError if the file has no extension" do
+        expect { FrontMatterParser.parse_file(File.expand_path("../fixtures/example, __FILE__")) }.to raise_error RuntimeError
       end
     end
   end
 end
 
 describe "the front matter" do
-  let(:sample) { {'title' => 'hello'} }
+  let(:sample_fm) { {'title' => 'hello'} }
 
   it "can be indented" do
     string = %Q(
@@ -124,7 +234,7 @@ describe "the front matter" do
   title: hello
   ---
 Content)
-    expect(FrontMatterParser.parse(string).front_matter).to eq(sample)
+    expect(FrontMatterParser.parse(string).front_matter).to eq(sample_fm)
   end
 
   it "can have each line commented" do
@@ -133,7 +243,7 @@ Content)
 #title: hello
 #---
 Content)
-    expect(FrontMatterParser.parse(string, comment: '#').front_matter).to eq(sample)
+    expect(FrontMatterParser.parse(string, comment: '#').front_matter).to eq(sample_fm)
   end
 
   it "can be indented after the comment delimiter" do
@@ -142,7 +252,7 @@ Content)
 #  title: hello
 #  ---
 Content)
-    expect(FrontMatterParser.parse(string, comment: '#').front_matter).to eq(sample)
+    expect(FrontMatterParser.parse(string, comment: '#').front_matter).to eq(sample_fm)
   end
 
   it "can be between a multiline comment" do
@@ -153,7 +263,7 @@ title: hello
 ---
 -->
 Content)
-    expect(FrontMatterParser.parse(string, start_comment: '<!--', end_comment: '-->').front_matter).to eq(sample)
+    expect(FrontMatterParser.parse(string, start_comment: '<!--', end_comment: '-->').front_matter).to eq(sample_fm)
   end
 
   it "can have the multiline comment delimiters indented" do
@@ -164,7 +274,7 @@ Content)
     ---
     -->
 Content)
-    expect(FrontMatterParser.parse(string, start_comment: '<!--', end_comment: '-->').front_matter).to eq(sample)
+    expect(FrontMatterParser.parse(string, start_comment: '<!--', end_comment: '-->').front_matter).to eq(sample_fm)
   end
 
   it "can have empty lines between the multiline comment delimiters and the front matter" do
@@ -174,10 +284,10 @@ Content)
 ---
 title: hello
 ---
-  
+
 -->
 Content)
-    expect(FrontMatterParser.parse(string, start_comment: '<!--', end_comment: '-->').front_matter).to eq(sample)
+    expect(FrontMatterParser.parse(string, start_comment: '<!--', end_comment: '-->').front_matter).to eq(sample_fm)
   end
 
   it "can have multiline comment delimited by indentation" do
@@ -187,6 +297,6 @@ Content)
     title: hello
     ---
   Content)
-    expect(FrontMatterParser.parse(string, start_comment: '/').front_matter).to eq(sample)
+    expect(FrontMatterParser.parse(string, start_comment: '/').front_matter).to eq(sample_fm)
   end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,6 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'front_matter_parser'
+require 'tempfile'
+Dir["#{File.expand_path('../support', __FILE__)}/*.rb"].each do |file|
+  require file
+end

data/spec/support/strings.rb

@@ -0,0 +1,41 @@
+def string
+  "---
+title: hello
+---
+Content"
+end
+
+def string_no_front_matter
+  "Content"
+end
+
+def string_no_content
+"---
+title: hello
+---
+"
+end
+
+def string_comment(comment)
+  "#{comment} ---
+  #{comment} title: hello
+  #{comment} ---
+Content"
+end
+
+def string_start_comment(start_comment)
+  "#{start_comment}
+  ---
+  title: hello
+  ---
+Content"
+end
+
+def string_start_end_comment(start_comment, end_comment)
+  "#{start_comment}
+---
+title: hello
+---
+  #{end_comment}
+Content"
+end

data/spec/support/syntaxs.rb

@@ -0,0 +1,14 @@
+# key is a human name, value is :syntax value or file extension
+def syntaxs
+  {
+    slim: :slim,
+    'coffee script' => :coffee,
+    html: :html,
+    haml: :haml,
+    liquid: :liquid,
+    sass: :sass,
+    scss: :scss,
+    md: :md,
+    erb: :erb,
+  }
+end

data/spec/support/utils.rb

@@ -0,0 +1,6 @@
+def file_fixture(string)
+  file = Tempfile.new('foo')
+  file.write(string)
+  file.rewind
+  file.path
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: front_matter_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - marc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,10 +62,7 @@ description: Library to parse files or strings with YAML front matters with synt
   autodetection.
 email:
 - marc@lamarciana.com
-executables:
-- autospec
-- rake
-- rspec
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -80,14 +77,13 @@ files:
 - 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
 - spec/fixtures/example.coffee
+- spec/fixtures/example.erb
 - spec/fixtures/example.foo
 - spec/fixtures/example.haml
 - spec/fixtures/example.html
@@ -99,6 +95,9 @@ files:
 - spec/front_matter_parser/parsed_spec.rb
 - spec/front_matter_parser_spec.rb
 - spec/spec_helper.rb
+- spec/support/strings.rb
+- spec/support/syntaxs.rb
+- spec/support/utils.rb
 homepage: https://github.com/laMarciana/front_matter_parser
 licenses:
 - LGPL3
@@ -127,7 +126,9 @@ summary: FrontMatterParser is a library to parse files or strings with YAML fron
   from its extension and it supposes that the front matter is marked as that syntax
   comments.
 test_files:
+- spec/fixtures/example
 - spec/fixtures/example.coffee
+- spec/fixtures/example.erb
 - spec/fixtures/example.foo
 - spec/fixtures/example.haml
 - spec/fixtures/example.html
@@ -139,3 +140,6 @@ test_files:
 - spec/front_matter_parser/parsed_spec.rb
 - spec/front_matter_parser_spec.rb
 - spec/spec_helper.rb
+- spec/support/strings.rb
+- spec/support/syntaxs.rb
+- spec/support/utils.rb

data/bin/autospec

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'autospec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('rspec-core', 'autospec')

data/bin/rake

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'rake' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('rspec-core', 'rspec')