ad_hoc_template 0.2.0 → 0.3.0

data/spec/parser_spec.rb

@@ -33,7 +33,7 @@ describe AdHocTemplate do
       end
 
       it "may contain lines that consist only of an iteration tag" do
-        tree = AdHocTemplate::Parser.parse("<%#iterations
+        tree = AdHocTemplate::Parser.parse("<%#iterations:
 content
 #%>
 ")
@@ -70,6 +70,32 @@ TEMPLATE
 
         expect(with_indent).not_to eq(without_indent)
       end
+
+      it "may contains nested tags and the first inner tag may not have preceding strings" do
+        template = "main start <%#<%= var1 %> inner part <%= var2 %> inner end #%> main end"
+        tree = AdHocTemplate::Parser.parse(template)
+        expect(tree).to eq([
+                             ["main start "],
+                             [
+                               [["var1 "]],
+                               [" inner part "],
+                               [["var2 "]],
+                               [" inner end "]],
+                             [" main end"]])
+      end
+
+      it "tags may be put side by side without any string in between" do
+        template = "main start <%# inner start<%= var1 %><%= var2 %>inner end #%> main end"
+        tree = AdHocTemplate::Parser.parse(template)
+        expect(tree).to eq([
+                             ["main start "],
+                             [
+                               [" inner start"],
+                               [["var1 "]],
+                               [["var2 "]],
+                               ["inner end "]],
+                             [" main end"]])
+      end
     end
 
     describe "with the square brackets tag type" do
@@ -100,7 +126,7 @@ TEMPLATE
       end
 
       it "may contain lines that consist only of an iteration tag" do
-        tree = AdHocTemplate::Parser.parse("[[#iterations
+        tree = AdHocTemplate::Parser.parse("[[#iterations:
 content
 #]]
 ", :square_brackets)
@@ -141,7 +167,7 @@ content
       end
 
       it "may contain lines that consist only of an iteration tag" do
-        tree = AdHocTemplate::Parser.parse("{{#iterations
+        tree = AdHocTemplate::Parser.parse("{{#iterations:
 content
 #}}
 ", :curly_brackets)
@@ -155,12 +181,12 @@ content
     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")
+      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#%>")
+      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
 
@@ -192,7 +218,7 @@ content
       end
 
       it "may contain lines that consist only of an iteration tag" do
-        tree = AdHocTemplate::Parser.parse("<iterate>iterations
+        tree = AdHocTemplate::Parser.parse("<iterate>iterations:
 content
 </iterate>
 ", :xml_like1)
@@ -205,12 +231,12 @@ content
       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)
+        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)
+        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
 
@@ -268,7 +294,7 @@ TEMPLATE
       end
 
       it "may contain lines that consist only of an iteration tag" do
-        tree = AdHocTemplate::Parser.parse("<iterate>iterations
+        tree = AdHocTemplate::Parser.parse("<iterate>iterations:
 content
 </iterate>
 ", :xml_like2)
@@ -281,12 +307,12 @@ content
       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)
+        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)
+        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
@@ -319,7 +345,7 @@ content
       end
 
       it "may contain lines that consist only of an iteration tag" do
-        tree = AdHocTemplate::Parser.parse("<!--%iterate%-->iterations
+        tree = AdHocTemplate::Parser.parse("<!--%iterate%-->iterations:
 content
 <!--%/iterate%-->
 ", :xml_comment_like)
@@ -332,12 +358,12 @@ content
       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)
+        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)
+        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
 
@@ -370,7 +396,7 @@ TEMPLATE
         template_without_indent = <<TEMPLATE_WITHOUT_INDENT
 A template with an iteration tag
 
-<!--%iterate%-->label
+<!--%iterate%-->label:
     This part will be repeated with <!--% variable %-->
 <!--%/iterate%-->
 
@@ -379,7 +405,7 @@ TEMPLATE_WITHOUT_INDENT
         template_with_indent = <<TEMPLATE
 A template with an iteration tag
 
-  <!--%iterate%-->label
+  <!--%iterate%-->label:
     This part will be repeated with <!--% variable %-->
   <!--%/iterate%-->
 
@@ -398,12 +424,14 @@ TEMPLATE
 tag_name: xml_like3
 tag: ["<!--%", "%-->"]
 iteration_tag: ["<repeat>", "</repeat>"]
+fallback_tag: ["<fallback>", "</fallback>"]
 remove_indent: true
 CONFIG
+        iteration_tag_node = AdHocTemplate::Parser::IterationTagNode
         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.head_of[iteration_tag_node]).to eq('<repeat>')
+        expect(defined_tag_type.tail_of[iteration_tag_node]).to eq('</repeat>')
         expect(defined_tag_type.remove_iteration_indent).to eq(true)
       end
 
@@ -412,6 +440,7 @@ CONFIG
 tag_name: 
 tag: ["<!--%", "%-->"]
 iteration_tag: ["<repeat>", "</repeat>"]
+fallback_tag: ["<fallback>", "</fallback>"]
 remove_indent: true
 CONFIG
         expect {
@@ -420,5 +449,72 @@ CONFIG
                          '"tag_name" should be defined.')
       end
     end
+
+    describe "#contains_any_value_tag?" do
+      it 'return true if any value tag is contained' do
+      template_with_value_tag =<<TEMPLATE
+main start
+
+<%#
+<%*
+line with <%= value tag %>
+*%>
+#%>
+
+
+main end
+TEMPLATE
+        parsed = AdHocTemplate::Parser.parse(template_with_value_tag)
+        expect(parsed[1].contains_any_value_tag?).to be_truthy
+      end
+
+      it 'return false if no value tag is contained' do
+      template_without_value_tag =<<TEMPLATE
+main start
+
+<%#
+<%*
+line without value tag
+*%>
+#%>
+
+
+main end
+TEMPLATE
+
+        parsed = AdHocTemplate::Parser.parse(template_without_value_tag)
+
+        expect(parsed[1].contains_any_value_tag?).to be_falsy
+      end
+    end
+
+    describe AdHocTemplate::Parser::FallbackTagNode do
+      it 'is expected to be parsed like IterationTagNode -- used inline' do
+        source = 'main start <%# <%* content in fallback_tag <%= tag node in fallback tag %> fallback end *%> optional content with <%#iterations: in iteration tag <%= item %> #%> iteration part end  #%> main end'
+        expected_tree = [
+          ["main start "],
+          [
+            [" "],
+            [
+              [" content in fallback_tag "],
+              [["tag node in fallback tag "]],
+              [" fallback end "]
+            ],
+            [" optional content with "],
+            [
+              ["in iteration tag "],
+              [["item "]],
+              [" "]],
+            [" iteration part end  "]],
+          [" main end"]
+        ]
+
+        tree = AdHocTemplate::Parser.parse(source)
+        fallback = tree[1][1]
+
+        expect(tree).to eq(expected_tree)
+        expect(fallback).to be_kind_of(AdHocTemplate::Parser::FallbackTagNode)
+      end
+    end
   end
 end

data/spec/pseudohiki_formatter_spec.rb

@@ -23,7 +23,7 @@ CONFIG
 
       template = <<TEMPLATE
 <ul>
-<%#iteration
+<%#iteration:
   <li>
     <ul>
       <li><%ph key1 %></li>
@@ -62,7 +62,7 @@ the second paragraph in block
 
 RESULT
 
-      result = AdHocTemplate.convert(config_data, template)
+      result = AdHocTemplate.render(config_data, template)
       expect(result).to eq(expected_result)
     end
   end

data/spec/record_reader_spec.rb

@@ -223,8 +223,15 @@ YAML
       expect(yaml_reader).to eq(record_reader)
     end
 
-    it '.to_yaml converts the format of data from default to yaml' do
-      yaml = AdHocTemplate::RecordReader::YAMLReader.to_yaml(@config_source)
+    it '.dump converts the format of data from default to yaml' do
+      yaml = AdHocTemplate::RecordReader::YAMLReader.dump(@config_source)
+
+      expect(yaml).to eq(@yaml_dump)
+    end
+
+    it '.dump accepts parsed data too' do
+      parsed_data = AdHocTemplate::RecordReader.read_record(@config_source)
+      yaml = AdHocTemplate::RecordReader::YAMLReader.dump(parsed_data)
 
       expect(yaml).to eq(@yaml_dump)
     end
@@ -275,7 +282,22 @@ CONFIG
 JSON
 
       @json_dump = <<JSON
-{"key1":"value1","key2":"value2","key3":"value3","#subconfigs":[{"key1-1":"value1-1","key1-2":"value1-2"},{"key2-1":"value2-1","key2-2":"value2-2"}],"block":"the first line of block\\nthe second line of block\\n\\nthe second paragraph in block\\n"}
+{
+  "key1": "value1",
+  "key2": "value2",
+  "key3": "value3",
+  "#subconfigs": [
+    {
+      "key1-1": "value1-1",
+      "key1-2": "value1-2"
+    },
+    {
+      "key2-1": "value2-1",
+      "key2-2": "value2-2"
+    }
+  ],
+  "block": "the first line of block\\nthe second line of block\\n\\nthe second paragraph in block\\n"
+}
 JSON
     end
 
@@ -293,8 +315,15 @@ JSON
       expect(json_reader).to eq(record_reader)
     end
 
-    it '.to_yaml converts the format of data from default to yaml' do
-      json = AdHocTemplate::RecordReader::JSONReader.to_json(@config_source)
+    it '.dump converts the format of data from default to json' do
+      json = AdHocTemplate::RecordReader::JSONReader.dump(@config_source)
+
+      expect(json).to eq(@json_dump.chomp)
+    end
+
+    it '.dump accepts parsed data too' do
+      parsed_data = AdHocTemplate::RecordReader.read_record(@config_source)
+      json = AdHocTemplate::RecordReader::JSONReader.dump(parsed_data)
 
       expect(json).to eq(@json_dump.chomp)
     end
@@ -319,6 +348,32 @@ key3: value3-3
 
 CONFIG
 
+        @csv_incompatible_config_source = <<CONFIG
+key: value
+
+///@#subconfigs
+
+key1: value1-1
+key2: value1-2
+key3: value1-3
+
+key1: value2-1
+key2: value2-2
+key3: value2-3
+
+key1: value3-1
+key2: value3-2
+key3: value3-3
+
+CONFIG
+
+      @config_source_without_iteration = <<CONFIG
+key1: value1
+key2: value2
+key3: value3
+CONFIG
+
+
         @csv_source = <<CSV
 key1,key2,key3
 value1-1,value1-2,value1-3
@@ -334,6 +389,78 @@ value3-1	value3-2	value3-3
 TSV
     end
 
+    it '.dump can convert data in default format to CSV when the data have just one record' do
+      expected_csv = <<CSV
+key1,key2,key3
+value1,value2,value3
+CSV
+      parsed_data = AdHocTemplate::RecordReader.read_record(@config_source_without_iteration)
+      csv = AdHocTemplate::RecordReader::CSVReader.dump(parsed_data)
+
+      expect(csv).to eq(expected_csv)
+    end
+
+    it '.dump can convert data in default format to CSV when the data consist of just one iteration block' do
+      parsed_data = AdHocTemplate::RecordReader.read_record(@config_source)
+      csv = AdHocTemplate::RecordReader::CSVReader.dump(parsed_data)
+
+      expect(csv).to eq(@csv_source)
+    end
+
+    it '.dump may return CSV data that contain empty fields' do
+        config_source = <<CONFIG
+///@#subconfigs
+
+key1: value1-1
+key3: value1-3
+
+key1: value2-1
+key2: value2-2
+key3: value2-3
+
+key3: value3-3
+
+CONFIG
+
+      expected_csv = <<CSV
+key1,key2,key3
+value1-1,,value1-3
+value2-1,value2-2,value2-3
+,,value3-3
+CSV
+
+      parsed_data = AdHocTemplate::RecordReader.read_record(config_source)
+      csv = AdHocTemplate::RecordReader::CSVReader.dump(parsed_data)
+
+      expect(csv).to eq(expected_csv)
+    end
+
+    it '.dump raises an exception when the structure of given data is too complex' do
+      parsed_data = AdHocTemplate::RecordReader.read_record(@csv_incompatible_config_source)
+      error_type = AdHocTemplate::RecordReader::CSVReader::NotSupportedError
+
+      expect do
+        AdHocTemplate::RecordReader::CSVReader.dump(parsed_data)
+      end.to raise_error(error_type)
+    end
+
+    it '.dump can generate TSV data too' do
+      col_sep = AdHocTemplate::RecordReader::CSVReader::COL_SEP[:tsv]
+      parsed_data = AdHocTemplate::RecordReader.read_record(@config_source)
+      tsv = AdHocTemplate::RecordReader::CSVReader.dump(parsed_data, col_sep)
+
+      expect(tsv).to eq(@tsv_source)
+    end
+
+    it 'TSV.dump is an alias of CSV.dump except for its default col_sep value' do
+      col_sep = AdHocTemplate::RecordReader::CSVReader::COL_SEP[:tsv]
+      parsed_data = AdHocTemplate::RecordReader.read_record(@config_source)
+      tsv_by_csv_reader = AdHocTemplate::RecordReader::CSVReader.dump(parsed_data, col_sep)
+      tsv = AdHocTemplate::RecordReader::TSVReader.dump(parsed_data)
+
+      expect(tsv).to eq(tsv_by_csv_reader)
+    end
+
     it 'reads CSV data and turns it into a Ruby object' do
       config = AdHocTemplate::RecordReader.read_record(@config_source)
       csv = AdHocTemplate::RecordReader::CSVReader.read_record(@csv_source, "subconfigs")
@@ -362,16 +489,133 @@ TSV
       end
 
       it '.read_record is called from RecordReader.read_record if the format of source data is specified' do
-        csv_reader = AdHocTemplate::RecordReader::CSVReader.read_record(@csv_source, tsv: "subconfigs")
-        record_reader = AdHocTemplate::RecordReader.read_record(@csv_source, tsv: "subconfigs")
+        csv_reader = AdHocTemplate::RecordReader::CSVReader.read_record(@tsv_source, tsv: "subconfigs")
+        record_reader = AdHocTemplate::RecordReader.read_record(@tsv_source, tsv: "subconfigs")
 
-        csv_reader_without_label = AdHocTemplate::RecordReader::CSVReader.read_record(@csv_source, :tsv)
-        record_reader_without_label = AdHocTemplate::RecordReader.read_record(@csv_source, :tsv)
+        csv_reader_without_label = AdHocTemplate::RecordReader::CSVReader.read_record(@tsv_source, :tsv)
+        record_reader_without_label = AdHocTemplate::RecordReader.read_record(@tsv_source, :tsv)
 
 
         expect(csv_reader).to eq(record_reader)
         expect(csv_reader_without_label).to eq(record_reader_without_label)
       end
+
+      it 'TSV.read_record is an alias of CSV.dump except for its default col_sep value' do
+        csv_reader = AdHocTemplate::RecordReader::CSVReader.read_record(@tsv_source, tsv: "subconfigs")
+        tsv_reader = AdHocTemplate::RecordReader::TSVReader.read_record(@tsv_source, "subconfigs")
+
+        expect(tsv_reader).to eq(csv_reader)
+      end
+    end
+  end
+
+  describe AdHocTemplate::RecordReader::DefaultFormReader do
+    before do
+      @config_source = <<CONFIG
+key1: value1
+key2: value2
+key3: value3
+
+///@#subconfigs
+
+key1-1: value1-1
+key1-2: value1-2
+
+key2-1: value2-1
+key2-2: value2-2
+
+///@block
+
+the first line of block
+the second line of block
+
+the second paragraph in block
+
+CONFIG
+
+      @yaml_source = <<YAML
+key1: value1
+key2: value2
+key3: value3
+'#subconfigs':
+  - key1-1: value1-1
+    key1-2: value1-2
+  - key2-1: value2-1
+    key2-2: value2-2
+block: |
+  the first line of block
+  the second line of block
+  
+  the second paragraph in block
+YAML
+    end
+
+    it ',dump accepts non-empty data' do
+      parsed_data = AdHocTemplate::RecordReader::YAMLReader.read_record(@yaml_source)
+      dump_data = AdHocTemplate::RecordReader::DefaultFormReader.dump(parsed_data)
+      expected_data = @config_source.sub(/(#{$/}+)\Z/, $/)
+
+      expect(dump_data).to eq(expected_data)
+    end
+
+    describe 'private methods' do
+      it '.categorize_keys devide keys into 3 groups' do
+        parsed_data = AdHocTemplate::RecordReader::YAMLReader.read_record(@yaml_source)
+        iteration_keys, key_value_keys, block_keys = AdHocTemplate::RecordReader::DefaultFormReader.send :categorize_keys, parsed_data
+
+        expect(iteration_keys).to eq(%w(#subconfigs))
+        expect(key_value_keys).to eq(%w(key1 key2 key3))
+        expect(block_keys).to eq (%w(block))
+      end
+
+      it '.format_key_value_pairs returns a YAML like key-value pairs' do
+        expected_result = <<RESULT
+key1: value1
+key2: value2
+key3: value3
+RESULT
+
+        parsed_data = AdHocTemplate::RecordReader::YAMLReader.read_record(@yaml_source)
+        iteration_keys, key_value_keys, block_keys = AdHocTemplate::RecordReader::DefaultFormReader.send :categorize_keys, parsed_data
+        format_result = AdHocTemplate::RecordReader::DefaultFormReader.send :format_key_value_pairs, key_value_keys, parsed_data
+
+        expect(format_result).to eq(expected_result)
+      end
+
+      it '.format_key_value_block returns a header with label and multi-line value' do
+        expected_result = <<RESULT
+///@block
+
+the first line of block
+the second line of block
+
+the second paragraph in block
+RESULT
+
+        parsed_data = AdHocTemplate::RecordReader::YAMLReader.read_record(@yaml_source)
+        iteration_keys, key_value_keys, block_keys = AdHocTemplate::RecordReader::DefaultFormReader.send :categorize_keys, parsed_data
+        format_result = AdHocTemplate::RecordReader::DefaultFormReader.send :format_key_value_block, block_keys, parsed_data
+
+        expect(format_result).to eq(expected_result)
+      end
+
+      it '.format_iteration_block returns a header and sub-records YAML like key-value pairs' do
+        expected_result = <<RESULT
+///@#subconfigs
+
+key1-1: value1-1
+key1-2: value1-2
+
+key2-1: value2-1
+key2-2: value2-2
+RESULT
+
+        parsed_data = AdHocTemplate::RecordReader::YAMLReader.read_record(@yaml_source)
+        iteration_keys, key_value_keys, block_keys = AdHocTemplate::RecordReader::DefaultFormReader.send :categorize_keys, parsed_data
+        format_result = AdHocTemplate::RecordReader::DefaultFormReader.send :format_iteration_block, iteration_keys, parsed_data
+
+        expect(format_result).to eq(expected_result)
+      end
     end
   end
 end