ad_hoc_template 0.0.1 → 0.1.0

data/spec/parser_spec.rb

@@ -0,0 +1,399 @@
+#!/usr/bin/env ruby
+
+require 'spec_helper'
+require 'ad_hoc_template'
+
+describe AdHocTemplate do
+  describe AdHocTemplate::Parser do
+    describe "with the default tag type" do
+      it "returns a tree of TagNode and Leaf" do
+        expect(AdHocTemplate::Parser.parse("a test string with tags (<% the first tag %> and <% the second tag %>) in it")).to eq([["a test string with tags ("],
+                                                                                                                                    [[" the first tag "]],
+                                                                                                                                    [" and "],
+                                                                                                                                    [[" the second tag "]],
+                                                                                                                                    [") in it"]])
+      end
+
+      it "allows to have a nested tag" do
+        expect(AdHocTemplate::Parser.parse("a test string with a nested tag; <% an outer tag and <% an inner tag %> %>")).to eq([["a test string with a nested tag; "],
+                                                                                                                                  [[" an outer tag and "],
+                                                                                                                                    [[" an inner tag "]],
+                                                                                                                                    [" "]]])
+      end
+
+      it "may have iteration tags." do
+        tree = AdHocTemplate::Parser.parse("a test string with a nested tag: <%# an iteration tag and <% an inner tag %> #%> and <% another tag %>")
+        expect(tree).to eq([["a test string with a nested tag: "],
+                             [[" an iteration tag and "],
+                               [[" an inner tag "]],
+                               [" "]],
+                             [" and "],
+                             [[" another tag "]]])
+        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationTagNode)
+      end
+
+      it "may contain lines that consist only of an iteration tag" do
+        tree = AdHocTemplate::Parser.parse("<%#iterations
+content
+#%>
+")
+        expect(tree).to eq([[["content\n"]]])
+      end
+
+      it "must return an empty array when template is an empty string" do
+        tree = AdHocTemplate::Parser.parse("")
+        expect(tree).to eq([])
+      end
+
+
+      it "does not remove indents from the lines which contain only iteration tag" do
+        template_without_indent = <<TEMPLATE_WITHOUT_INDENT
+A template with an iteration tag
+
+<%#
+    This part will be repeated with <!--% variable %-->
+#%>
+
+TEMPLATE_WITHOUT_INDENT
+
+        template_with_indent = <<TEMPLATE
+A template with an iteration tag
+
+  <%#
+    This part will be repeated with <!--% variable %-->
+  #%>
+
+TEMPLATE
+
+        without_indent = AdHocTemplate::Parser.parse(template_without_indent)
+        with_indent = AdHocTemplate::Parser.parse(template_with_indent)
+
+        expect(with_indent).not_to eq(without_indent)
+      end
+    end
+
+    describe "with the square brackets tag type" do
+      it "returns a tree of TagNode and Leaf" do
+        expect(AdHocTemplate::Parser.parse("a test string with tags ([[ the first tag ]] and [[ the second tag ]]) in it", :square_brackets)).to eq([["a test string with tags ("],
+                                                                                                                                    [[" the first tag "]],
+                                                                                                                                    [" and "],
+                                                                                                                                    [[" the second tag "]],
+                                                                                                                                    [") in it"]])
+      end
+
+      it "allows to have a nested tag" do
+        expect(AdHocTemplate::Parser.parse("a test string with a nested tag; [[ an outer tag and [[ an inner tag ]] ]]", :square_brackets)).to eq([["a test string with a nested tag; "],
+                                                                                                                                  [[" an outer tag and "],
+                                                                                                                                    [[" an inner tag "]],
+                                                                                                                                    [" "]]])
+      end
+
+      it "may have iteration tags." do
+        tree = AdHocTemplate::Parser.parse("a test string with a nested tag: [[# an iteration tag and [[ an inner tag ]] #]] and [[ another tag ]]", :square_brackets)
+        expect(tree).to eq([["a test string with a nested tag: "],
+                             [[" an iteration tag and "],
+                               [[" an inner tag "]],
+                               [" "]],
+                             [" and "],
+                             [[" another tag "]]])
+        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationTagNode)
+      end
+
+      it "may contain lines that consist only of an iteration tag" do
+        tree = AdHocTemplate::Parser.parse("[[#iterations
+content
+#]]
+", :square_brackets)
+        expect(tree).to eq([[["content\n"]]])
+      end
+
+      it "must return an empty array when template is an empty string" do
+        tree = AdHocTemplate::Parser.parse("", :square_brackets)
+        expect(tree).to eq([])
+      end
+    end
+
+    describe "with the curly brackets tag type" do
+      it "returns a tree of TagNode and Leaf" do
+        expect(AdHocTemplate::Parser.parse("a test string with tags ({{ the first tag }} and {{ the second tag }}) in it", :curly_brackets)).to eq([["a test string with tags ("],
+                                                                                                                                    [[" the first tag "]],
+                                                                                                                                    [" and "],
+                                                                                                                                    [[" the second tag "]],
+                                                                                                                                    [") in it"]])
+      end
+
+      it "allows to have a nested tag" do
+        expect(AdHocTemplate::Parser.parse("a test string with a nested tag; {{ an outer tag and {{ an inner tag }} }}", :curly_brackets)).to eq([["a test string with a nested tag; "],
+                                                                                                                                  [[" an outer tag and "],
+                                                                                                                                    [[" an inner tag "]],
+                                                                                                                                    [" "]]])
+      end
+
+      it "may have iteration tags." do
+        tree = AdHocTemplate::Parser.parse("a test string with a nested tag: {{# an iteration tag and {{ an inner tag }} #}} and {{ another tag }}", :curly_brackets)
+        expect(tree).to eq([["a test string with a nested tag: "],
+                             [[" an iteration tag and "],
+                               [[" an inner tag "]],
+                               [" "]],
+                             [" and "],
+                             [[" another tag "]]])
+        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationTagNode)
+      end
+
+      it "may contain lines that consist only of an iteration tag" do
+        tree = AdHocTemplate::Parser.parse("{{#iterations
+content
+#}}
+", :curly_brackets)
+        expect(tree).to eq([[["content\n"]]])
+      end
+
+      it "must return an empty array when template is an empty string" do
+        tree = AdHocTemplate::Parser.parse("", :curly_brackets)
+        expect(tree).to eq([])
+      end
+    end
+
+    it("spaces at the head of a line should be preserved when the line is just after a start tag of IterationTagNode") do
+      tree = AdHocTemplate::Parser.parse("<%#iteration\n  the second line\nthe third line")
+      expect(tree).to eq([[["  the second line\nthe third line"]]])
+    end
+
+    it("should not add a newline at the head of IterationTagNode when the type of the node is not specified") do
+      tree = AdHocTemplate::Parser.parse("a test string with tags\n<%#iteration_block\nthe value of sub_key1 is <%= sub_key1 %>.\n<%#\n  the value of sub_key2 is <%= sub_key2 %>.\n#%>\n#%>")
+      expect(tree).to eq([["a test string with tags\n"], [["the value of sub_key1 is "], [["sub_key1 "]], [".\n"], [["  the value of sub_key2 is "], [["sub_key2 "]], [".\n"]]]])
+    end
+
+    describe "with the xml_like1 tag type" do
+      it "returns a tree of TagNode and Leaf" do
+        expect(AdHocTemplate::Parser.parse("a test string with tags (<!--% the first tag %--> and <!--% the second tag %-->) in it", :xml_like1)).to eq([["a test string with tags ("],
+                                                                                                                                    [[" the first tag "]],
+                                                                                                                                    [" and "],
+                                                                                                                                    [[" the second tag "]],
+                                                                                                                                    [") in it"]])
+      end
+
+      it "allows to have a nested tag" do
+        expect(AdHocTemplate::Parser.parse("a test string with a nested tag; <!--% an outer tag and <!--% an inner tag %--> %-->", :xml_like1)).to eq([["a test string with a nested tag; "],
+                                                                                                                                  [[" an outer tag and "],
+                                                                                                                                    [[" an inner tag "]],
+                                                                                                                                    [" "]]])
+      end
+
+      it "may have iteration tags." do
+        tree = AdHocTemplate::Parser.parse("a test string with a nested tag: <iterate> an iteration tag and <!--% an inner tag %--> </iterate> and <!--% another tag %-->", :xml_like1)
+        expect(tree).to eq([["a test string with a nested tag: "],
+                             [[" an iteration tag and "],
+                               [[" an inner tag "]],
+                               [" "]],
+                             [" and "],
+                             [[" another tag "]]])
+        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationTagNode)
+      end
+
+      it "may contain lines that consist only of an iteration tag" do
+        tree = AdHocTemplate::Parser.parse("<iterate>iterations
+content
+</iterate>
+", :xml_like1)
+        expect(tree).to eq([[["content\n"]]])
+      end
+
+      it "must return an empty array when template is an empty string" do
+        tree = AdHocTemplate::Parser.parse("", :xml_like1)
+        expect(tree).to eq([])
+      end
+
+      it("spaces at the head of a line should be preserved when the line is just after a start tag of IterationTagNode") do
+        tree = AdHocTemplate::Parser.parse("<iterate>iteration\n  the second line\nthe third line</iterate>", :xml_like1)
+        expect(tree).to eq([[["  the second line\nthe third line"]]])
+      end
+
+      it("should not add a newline at the head of IterationTagNode when the type of the node is not specified") do
+        tree = AdHocTemplate::Parser.parse("a test string with tags\n<iterate>iteration_block\nthe value of sub_key1 is <!--%= sub_key1 %-->.\n<iterate>\n  the value of sub_key2 is <!--%= sub_key2 %-->.\n</iterate>\n</iterate>", :xml_like1)
+        expect(tree).to eq([["a test string with tags\n"], [["the value of sub_key1 is "], [["sub_key1 "]], [".\n"], [["  the value of sub_key2 is "], [["sub_key2 "]], [".\n"]]]])
+      end
+
+      it "removes indents from the lines which contain only iteration tag" do
+        template_without_indent = <<TEMPLATE_WITHOUT_INDENT
+A template with an iteration tag
+
+<iterate>
+    This part will be repeated with <!--% variable %-->
+</iterate>
+
+TEMPLATE_WITHOUT_INDENT
+
+        template_with_indent = <<TEMPLATE
+A template with an iteration tag
+
+  <iterate>
+    This part will be repeated with <!--% variable %-->
+  </iterate>
+
+TEMPLATE
+
+        without_indent = AdHocTemplate::Parser.parse(template_without_indent, :xml_like1)
+        with_indent = AdHocTemplate::Parser.parse(template_with_indent, :xml_like1)
+
+        expect(with_indent).to eq(without_indent)
+      end
+    end
+
+    describe "with the xml_like2 tag type" do
+      it "returns a tree of TagNode and Leaf" do
+        expect(AdHocTemplate::Parser.parse("a test string with tags (<fill> the first tag </fill> and <fill> the second tag </fill>) in it", :xml_like2)).to eq([["a test string with tags ("],
+                                                                                                                                    [[" the first tag "]],
+                                                                                                                                    [" and "],
+                                                                                                                                    [[" the second tag "]],
+                                                                                                                                    [") in it"]])
+      end
+
+      it "allows to have a nested tag" do
+        expect(AdHocTemplate::Parser.parse("a test string with a nested tag; <fill> an outer tag and <fill> an inner tag </fill> </fill>", :xml_like2)).to eq([["a test string with a nested tag; "],
+                                                                                                                                  [[" an outer tag and "],
+                                                                                                                                    [[" an inner tag "]],
+                                                                                                                                    [" "]]])
+      end
+
+      it "may have iteration tags." do
+        tree = AdHocTemplate::Parser.parse("a test string with a nested tag: <iterate> an iteration tag and <fill> an inner tag </fill> </iterate> and <fill> another tag </fill>", :xml_like2)
+        expect(tree).to eq([["a test string with a nested tag: "],
+                             [[" an iteration tag and "],
+                               [[" an inner tag "]],
+                               [" "]],
+                             [" and "],
+                             [[" another tag "]]])
+        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationTagNode)
+      end
+
+      it "may contain lines that consist only of an iteration tag" do
+        tree = AdHocTemplate::Parser.parse("<iterate>iterations
+content
+</iterate>
+", :xml_like2)
+        expect(tree).to eq([[["content\n"]]])
+      end
+
+      it "must return an empty array when template is an empty string" do
+        tree = AdHocTemplate::Parser.parse("", :xml_like2)
+        expect(tree).to eq([])
+      end
+
+      it("spaces at the head of a line should be preserved when the line is just after a start tag of IterationTagNode") do
+        tree = AdHocTemplate::Parser.parse("<iterate>iteration\n  the second line\nthe third line</iterate>", :xml_like2)
+        expect(tree).to eq([[["  the second line\nthe third line"]]])
+      end
+
+      it("should not add a newline at the head of IterationTagNode when the type of the node is not specified") do
+        tree = AdHocTemplate::Parser.parse("a test string with tags\n<iterate>iteration_block\nthe value of sub_key1 is <fill>= sub_key1 </fill>.\n<iterate>\n  the value of sub_key2 is <fill>= sub_key2 </fill>.\n</iterate>\n</iterate>", :xml_like2)
+        expect(tree).to eq([["a test string with tags\n"], [["the value of sub_key1 is "], [["sub_key1 "]], [".\n"], [["  the value of sub_key2 is "], [["sub_key2 "]], [".\n"]]]])
+      end
+    end
+
+    describe "with the xml_comment_like tag type" do
+      it "returns a tree of TagNode and Leaf" do
+        expect(AdHocTemplate::Parser.parse("a test string with tags (<!--% the first tag %--> and <!--% the second tag %-->) in it", :xml_comment_like)).to eq([["a test string with tags ("],
+                                                                                                                                    [[" the first tag "]],
+                                                                                                                                    [" and "],
+                                                                                                                                    [[" the second tag "]],
+                                                                                                                                    [") in it"]])
+      end
+
+      it "allows to have a nested tag" do
+        expect(AdHocTemplate::Parser.parse("a test string with a nested tag; <!--% an outer tag and <!--% an inner tag %--> %-->", :xml_comment_like)).to eq([["a test string with a nested tag; "],
+                                                                                                                                  [[" an outer tag and "],
+                                                                                                                                    [[" an inner tag "]],
+                                                                                                                                    [" "]]])
+      end
+
+      it "may have iteration tags." do
+        tree = AdHocTemplate::Parser.parse("a test string with a nested tag: <!--%iterate%--> an iteration tag and <!--% an inner tag %--> <!--%/iterate%--> and <!--% another tag %-->", :xml_comment_like)
+        expect(tree).to eq([["a test string with a nested tag: "],
+                             [[" an iteration tag and "],
+                               [[" an inner tag "]],
+                               [" "]],
+                             [" and "],
+                             [[" another tag "]]])
+        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationTagNode)
+      end
+
+      it "may contain lines that consist only of an iteration tag" do
+        tree = AdHocTemplate::Parser.parse("<!--%iterate%-->iterations
+content
+<!--%/iterate%-->
+", :xml_comment_like)
+        expect(tree).to eq([[["content\n"]]])
+      end
+
+      it "must return an empty array when template is an empty string" do
+        tree = AdHocTemplate::Parser.parse("", :xml_comment_like)
+        expect(tree).to eq([])
+      end
+
+      it("spaces at the head of a line should be preserved when the line is just after a start tag of IterationTagNode") do
+        tree = AdHocTemplate::Parser.parse("<!--%iterate%-->iteration\n  the second line\nthe third line<!--%/iterate%-->", :xml_comment_like)
+        expect(tree).to eq([[["  the second line\nthe third line"]]])
+      end
+
+      it("should not add a newline at the head of IterationTagNode when the type of the node is not specified") do
+        tree = AdHocTemplate::Parser.parse("a test string with tags\n<!--%iterate%-->iteration_block\nthe value of sub_key1 is <!--%= sub_key1 %-->.\n<!--%iterate%-->\n  the value of sub_key2 is <!--%= sub_key2 %-->.\n<!--%/iterate%-->\n<!--%/iterate%-->", :xml_comment_like)
+        expect(tree).to eq([["a test string with tags\n"], [["the value of sub_key1 is "], [["sub_key1 "]], [".\n"], [["  the value of sub_key2 is "], [["sub_key2 "]], [".\n"]]]])
+      end
+
+      it "removes indents from the lines which contain only iteration tag" do
+        template_without_indent = <<TEMPLATE_WITHOUT_INDENT
+A template with an iteration tag
+
+<!--%iterate%-->
+    This part will be repeated with <!--% variable %-->
+<!--%/iterate%-->
+
+TEMPLATE_WITHOUT_INDENT
+
+        template_with_indent = <<TEMPLATE
+A template with an iteration tag
+
+  <!--%iterate%-->
+    This part will be repeated with <!--% variable %-->
+  <!--%/iterate%-->
+
+TEMPLATE
+
+        without_indent = AdHocTemplate::Parser.parse(template_without_indent, :xml_comment_like)
+        with_indent = AdHocTemplate::Parser.parse(template_with_indent, :xml_comment_like)
+
+        expect(with_indent).to eq(without_indent)
+      end
+    end
+
+    describe ".register_user_defined_tag_type" do
+      it "allow to defined a tag type in YAML format" do
+        tag_type_config = <<CONFIG
+tag_name: xml_like3
+tag: ["<!--%", "%-->"]
+iteration_tag: ["<repeat>", "</repeat>"]
+remove_indent: true
+CONFIG
+        AdHocTemplate::Parser.register_user_defined_tag_type(tag_type_config)
+        defined_tag_type = AdHocTemplate::Parser::TagType[:xml_like3]
+        expect(defined_tag_type.iteration_start).to eq('<repeat>')
+        expect(defined_tag_type.iteration_end).to eq('</repeat>')
+        expect(defined_tag_type.remove_iteration_indent).to eq(true)
+      end
+
+      it "raises an error if a given definition does not contain sufficient information" do
+        tag_type_config = <<CONFIG
+tag_name: 
+tag: ["<!--%", "%-->"]
+iteration_tag: ["<repeat>", "</repeat>"]
+remove_indent: true
+CONFIG
+        expect {
+          AdHocTemplate::Parser.register_user_defined_tag_type(tag_type_config)
+        }.to raise_error(AdHocTemplate::Parser::UserDefinedTagTypeConfigError,
+                         '"tag_name" should be defined.')
+      end
+    end
+  end
+end