front_matter_parser 0.0.4 → 1.0.0

data/spec/front_matter_parser/parser_spec.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe FrontMatterParser::Parser do
+  let(:front_matter) { { 'title' => 'hello' } }
+  let(:content) { "Content\n" }
+
+  describe '#call' do
+    let(:string) do
+      <<~STRING
+        <!--
+        ---
+        title: hello
+        ---
+        -->
+        Content
+      STRING
+    end
+
+    it 'parses using given parser' do
+      parser = described_class.new(FrontMatterParser::SyntaxParser::Html.new)
+
+      parsed = parser.call(string)
+
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+
+    it 'infers parser if it is a symbol' do
+      parser = described_class.new(:html)
+
+      parsed = parser.call(string)
+
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+
+    it 'parses front matter as an empty hash if it is not present' do
+      string = 'Content'
+      parser = described_class.new(:html)
+
+      parsed = parser.call(string)
+
+      expect(parsed.front_matter).to eq({})
+    end
+
+    it 'parses content as the whole string if front matter is not present' do
+      string = 'Content'
+      parser = described_class.new(:html)
+
+      parsed = parser.call(string)
+
+      expect(parsed.content).to eq(string)
+    end
+
+    it 'can specify custom front matter loader with loader: param' do
+      front_matter = { 'a' => 'b' }
+      parser = described_class.new(:html,
+                                   loader: ->(_string) { front_matter })
+
+      parsed = parser.call(string)
+
+      expect(parsed.front_matter).to eq(front_matter)
+    end
+  end
+
+  describe '::parse_file' do
+    # :reek:UtilityFunction
+    def pathname(file)
+      File.expand_path("../../fixtures/#{file}", __FILE__)
+    end
+
+    it 'parses inferring syntax from given pathname' do
+      pathname = pathname('example.html')
+
+      parsed = described_class.parse_file(
+        pathname
+      )
+
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+
+    it 'can specify custom parser through :syntax_parser param' do
+      pathname = pathname('example')
+
+      parsed = described_class.parse_file(
+        pathname, syntax_parser: FrontMatterParser::SyntaxParser::Html.new
+      )
+
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+
+    it 'can specify custom parser as symbol through :syntax_parser param' do
+      pathname = pathname('example')
+
+      parsed = described_class.parse_file(
+        pathname, syntax_parser: :html
+      )
+
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+
+    it 'can specify custom front matter loader with loader: param' do
+      pathname = pathname('example.html')
+      front_matter = { 'a' => 'b' }
+      parsed = described_class.parse_file(pathname,
+                                          loader: ->(_string) { front_matter })
+
+      expect(parsed.front_matter).to eq(front_matter)
+    end
+  end
+end

data/spec/front_matter_parser/syntax_parser/indentation_comment_spec.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe FrontMatterParser::SyntaxParser::IndentationComment do
+  subject(:parsed) { FrontMatterParser::Parser.new(syntax).call(string) }
+
+  let(:front_matter) { { 'title' => 'hello', 'author' => 'me' } }
+  let(:content) { "Content\n" }
+
+  context 'when syntax is slim' do
+    let(:syntax) { :slim }
+    let(:string) do
+      <<~STRING
+        /
+         ---
+         title: hello
+         author: me
+         ---
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'when syntax is haml' do
+    let(:syntax) { :haml }
+    let(:string) do
+      <<~STRING
+        -#
+          ---
+          title: hello
+          author: me
+          ---
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with space before comment delimiter' do
+    let(:syntax) { :slim }
+    let(:string) do
+      <<~STRING
+
+          /
+           ---
+           title: hello
+           author: me
+           ---
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with front matter starting in comment delimiter line' do
+    let(:syntax) { :slim }
+    let(:string) do
+      <<~STRING
+        /---
+         title: hello
+         author: me
+         ---
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with space before front matter' do
+    let(:syntax) { :slim }
+    let(:string) do
+      <<~STRING
+        /
+
+             ---
+          title: hello
+          author: me
+         ---
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with space within front matter' do
+    let(:syntax) { :slim }
+    let(:string) do
+      <<~STRING
+        /
+          ---
+            title: hello
+
+            author: me
+          ---
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with comment delimiter in the front matter' do
+    let(:syntax) { :slim }
+    let(:string) do
+      <<~STRING
+        /
+         ---
+         title: /hello
+         author: me
+         ---
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      front_matter = { 'title' => '/hello', 'author' => 'me' }
+
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with front matter delimiter chars in the content' do
+    let(:syntax) { :slim }
+    let(:string) do
+      <<~STRING
+        /
+         ---
+         title: hello
+         ---
+        Content
+        ---
+      STRING
+    end
+
+    it 'is not greedy' do
+      front_matter = { 'title' => 'hello' }
+
+      expect(parsed).to be_parsed_result_with(front_matter, "Content\n---\n")
+    end
+  end
+
+  it 'returns nil if no front matter is found' do
+    string = 'Content'
+
+    expect(FrontMatterParser::SyntaxParser::Slim.new.call(string)).to be_nil
+  end
+end

data/spec/front_matter_parser/syntax_parser/multi_line_comment_spec.rb

@@ -0,0 +1,267 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe FrontMatterParser::SyntaxParser::MultiLineComment do
+  subject(:parsed) { FrontMatterParser::Parser.new(syntax).call(string) }
+
+  let(:front_matter) { { 'title' => 'hello', 'author' => 'me' } }
+  let(:content) { "Content\n" }
+
+  context 'when syntax is html' do
+    let(:syntax) { :html }
+    let(:string) do
+      <<~STRING
+        <!--
+        ---
+        title: hello
+        author: me
+        ---
+        -->
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'when syntax is erb' do
+    let(:syntax) { :erb }
+    let(:string) do
+      <<~STRING
+        <%#
+        ---
+        title: hello
+        author: me
+        ---
+        %>
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'when syntax is liquid' do
+    let(:syntax) { :liquid }
+    let(:string) do
+      <<~STRING
+        {% comment %}
+        ---
+        title: hello
+        author: me
+        ---
+        {% endcomment %}
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'when syntax is md' do
+    let(:syntax) { :md }
+    let(:string) do
+      <<~STRING
+        ---
+        title: hello
+        author: me
+        ---
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with space before start comment delimiter' do
+    let(:syntax) { :html }
+    let(:string) do
+      <<~STRING
+
+           <!--
+        ---
+        title: hello
+        author: me
+        ---
+        -->
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with front matter starting in comment delimiter line' do
+    let(:syntax) { :html }
+    let(:string) do
+      <<~STRING
+        <!-- ---
+        title: hello
+        author: me
+        ---
+        -->
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with space before front matter' do
+    let(:syntax) { :html }
+    let(:string) do
+      <<~STRING
+        <!--
+
+           ---
+        title: hello
+        author: me
+        ---
+        -->
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with space within front matter' do
+    let(:syntax) { :html }
+    let(:string) do
+      <<~STRING
+        <!--
+        ---
+          title: hello
+
+          author: me
+        ---
+        -->
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with space after front matter' do
+    let(:syntax) { :html }
+    let(:string) do
+      <<~STRING
+        <!--
+        ---
+        title: hello
+        author: me
+        ---
+
+        -->
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with space before end comment delimiter' do
+    let(:syntax) { :html }
+    let(:string) do
+      <<~STRING
+        <!--
+        ---
+        title: hello
+        author: me
+        ---
+           -->
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with start comment delimiter in the front matter' do
+    let(:syntax) { :html }
+    let(:string) do
+      <<~STRING
+        <!--
+        ---
+        title: <!--hello
+        author: me
+        ---
+           -->
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      front_matter = { 'title' => '<!--hello', 'author' => 'me' }
+
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with start and end comment delimiter in the front matter' do
+    let(:syntax) { :html }
+    let(:string) do
+      <<~STRING
+        <!--
+        ---
+        title: <!--hello-->
+        author: me
+        ---
+           -->
+        Content
+      STRING
+    end
+
+    it 'can parse it' do
+      front_matter = { 'title' => '<!--hello-->', 'author' => 'me' }
+
+      expect(parsed).to be_parsed_result_with(front_matter, content)
+    end
+  end
+
+  context 'with front matter delimiter chars in the content' do
+    let(:syntax) { :md }
+    let(:string) do
+      <<~STRING
+        ---
+        title: hello
+        ---
+        Content---
+      STRING
+    end
+
+    it 'is not greedy' do
+      front_matter = { 'title' => 'hello' }
+
+      expect(parsed).to be_parsed_result_with(front_matter, "Content---\n")
+    end
+  end
+
+  it 'returns nil if no front matter is found' do
+    string = 'Content'
+
+    expect(FrontMatterParser::SyntaxParser::Html.new.call(string)).to be_nil
+  end
+end