ad_hoc_template 0.3.0 → 0.4.0

data/spec/entry_format_generator_spec.rb

@@ -2,9 +2,10 @@
 
 require 'spec_helper'
 require 'ad_hoc_template'
+require 'stringio'
 
 describe AdHocTemplate do
-  describe AdHocTemplate::EntryFormatGenerator::LabelChecker do
+  describe AdHocTemplate::EntryFormatGenerator do
     before do
       @template = <<TEMPLATE
 The first line in the main part
@@ -39,15 +40,17 @@ TEMPLATE
         "block" => nil}
     end
 
-    it 'collects tag labels from a parsed template' do
-      tree = AdHocTemplate::Parser.parse(@template)
-      label_checker = AdHocTemplate::EntryFormatGenerator::LabelChecker.new
-      tree.accept(label_checker)
-      labels = label_checker.labels
-      expect(labels).to eq(@expected_labels_as_ruby_objects)
+    describe AdHocTemplate::EntryFormatGenerator::LabelChecker do
+      it 'collects tag labels from a parsed template' do
+        tree = AdHocTemplate::Parser.parse(@template)
+        label_checker = AdHocTemplate::EntryFormatGenerator::LabelChecker.new
+        tree.accept(label_checker)
+        labels = label_checker.labels
+        expect(labels).to eq(@expected_labels_as_ruby_objects)
+      end
     end
 
-    it '.extract_labels collects tag labels from a parsed template' do
+    it '.extract_form collects tag labels from a parsed template' do
       expected_labels_in_default_format = <<YAML
 key: 
 optional1: 
@@ -61,12 +64,12 @@ key2:
 YAML
 
       tree = AdHocTemplate::Parser.parse(@template)
-      labels = AdHocTemplate::EntryFormatGenerator.extract_labels(tree)
+      labels = AdHocTemplate::EntryFormatGenerator.extract_form(tree)
 
       expect(labels).to eq(expected_labels_in_default_format)
     end
 
-    it '.extract_labels should ignore fallback tags if they do not any contain value tag' do
+    it '.extract_form should ignore fallback tags if they do not any contain value tag' do
       template = <<TEMPLATE
 main start
 <%#
@@ -88,12 +91,12 @@ var2:
 EXPECTED
 
       tree = AdHocTemplate::Parser.parse(template)
-      labels = AdHocTemplate::EntryFormatGenerator.extract_labels(tree)
+      labels = AdHocTemplate::EntryFormatGenerator.extract_form(tree)
 
       expect(labels).to eq(expected)
     end
 
-    it '.extract_labels should labels in fallback tags' do
+    it '.extract_form should collect labels in fallback tags' do
       template = <<TEMPLATE
 main start
 <%#
@@ -117,12 +120,12 @@ var2:
 EXPECTED
 
       tree = AdHocTemplate::Parser.parse(template)
-      labels = AdHocTemplate::EntryFormatGenerator.extract_labels(tree)
+      labels = AdHocTemplate::EntryFormatGenerator.extract_form(tree)
 
       expect(labels).to eq(expected)
     end
 
-    it '.extract_labels accepts :yaml as its second argument' do
+    it '.extract_form accepts :yaml as its second argument' do
       expected_labels_in_yaml = <<YAML
 ---
 key: 
@@ -135,12 +138,12 @@ block:
 YAML
 
       tree = AdHocTemplate::Parser.parse(@template)
-      labels = AdHocTemplate::EntryFormatGenerator.extract_labels(tree, :yaml)
+      labels = AdHocTemplate::EntryFormatGenerator.extract_form(tree, :yaml)
 
       expect(labels).to eq(expected_labels_in_yaml)
     end
 
-    it '.extract_labels accepts :json as its second argument' do
+    it '.extract_form accepts :json as its second argument' do
       expected_labels_in_json = <<JSON
 {
   "key":null,
@@ -155,9 +158,149 @@ YAML
 JSON
 
       tree = AdHocTemplate::Parser.parse(@template)
-      labels = AdHocTemplate::EntryFormatGenerator.extract_labels(tree, :json)
+      labels = AdHocTemplate::EntryFormatGenerator.extract_form(tree, :json)
 
       expect(JSON.parse(labels)).to eq(JSON.parse(expected_labels_in_json))
     end
+
+    it '.extract_form should extract labels from nested iteration tags' do
+        template =<<TEMPLATE
+<%#authors:
+Name: <%= name %>
+Birthplace: <%= birthplace %>
+Works:
+<%#works|name:
+ * <%= title %>
+#%>
+
+<%#
+<%#bio|name:
+Born: <%= birth_date %>
+#%>
+#%>
+
+#%>
+TEMPLATE
+
+      expected_result =<<RESULT
+
+///@#authors
+
+name: 
+birthplace: 
+
+///@#authors|works|name
+
+title: 
+
+///@#authors|bio|name
+
+birth_date: 
+RESULT
+
+      tree = AdHocTemplate::Parser.parse(template)
+      labels = AdHocTemplate::EntryFormatGenerator.extract_form(tree)
+
+      expect(labels).to eq(expected_result)
+    end
+
+    it '.extract_iteration_labels collects iteration labels in a template' do
+              template =<<TEMPLATE
+<%#authors:
+Name: <%= name %>
+Birthplace: <%= birthplace %>
+Works:
+<%#works|name:
+ * <%= title %>
+#%>
+
+<%#
+<%#bio|name:
+Born: <%= birth_date %>
+#%>
+#%>
+
+#%>
+TEMPLATE
+
+      tree = AdHocTemplate::Parser.parse(template)
+      labels = AdHocTemplate::EntryFormatGenerator.extract_iteration_labels(tree)
+
+      expect(labels).to eq(["#authors", "#authors|works|name", "#authors|bio|name"])
+    end
+
+    it '.extract_recipe generates a recipe entry for a given template' do
+      template =<<TEMPLATE
+<%#authors:
+Name: <%= name %>
+Birthplace: <%= birthplace %>
+Works:
+<%#works|name:
+ * <%= title %>
+#%>
+
+<%#
+<%#bio|name:
+Born: <%= birth_date %>
+#%>
+#%>
+
+#%>
+TEMPLATE
+
+      expected_recipe = <<RECIPE
+---
+template: template.html
+tag_type: :default
+template_encoding: UTF-8
+data: 
+data_format: 
+data_encoding: 
+output_file: 
+blocks:
+- label: "#authors"
+  data: 
+  data_format: 
+  data_encoding: 
+- label: "#authors|works|name"
+  data: 
+  data_format: 
+  data_encoding: 
+- label: "#authors|bio|name"
+  data: 
+  data_format: 
+  data_encoding: 
+RECIPE
+
+      recipe = AdHocTemplate::EntryFormatGenerator.extract_recipe(template, 'template.html')
+      expect(recipe).to eq(expected_recipe)
+    end
+
+    it '.extract_recipes_from_template_files' do
+      recipe_entry = <<RECIPE
+---
+template: template1.html
+tag_type: :default
+template_encoding: UTF-8
+data: 
+data_format: 
+data_encoding: 
+output_file: 
+blocks:
+- label: "#iteration_block"
+  data: 
+  data_format: 
+  data_encoding: 
+RECIPE
+      recipe_entry2 = recipe_entry.sub(/template1\.html/, 'template2.html')
+
+      template_names = %w(template1.html template2.html)
+      template_names.each do |template_name|
+        allow(AdHocTemplate::EntryFormatGenerator).to receive(:open).with(File.expand_path(template_name)).and_yield(StringIO.new(@template))
+      end
+
+      result = AdHocTemplate::EntryFormatGenerator.extract_recipes_from_template_files(template_names)
+      expect(result).to eq(recipe_entry + recipe_entry2)
+    end
   end
 end

data/spec/parser_spec.rb

@@ -29,7 +29,7 @@ describe AdHocTemplate do
                                [" "]],
                              [" and "],
                              [[" another tag "]]])
-        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationTagNode)
+        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationNode)
       end
 
       it "may contain lines that consist only of an iteration tag" do
@@ -122,7 +122,7 @@ TEMPLATE
                                [" "]],
                              [" and "],
                              [[" another tag "]]])
-        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationTagNode)
+        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationNode)
       end
 
       it "may contain lines that consist only of an iteration tag" do
@@ -163,7 +163,7 @@ content
                                [" "]],
                              [" and "],
                              [[" another tag "]]])
-        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationTagNode)
+        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationNode)
       end
 
       it "may contain lines that consist only of an iteration tag" do
@@ -180,12 +180,12 @@ content
       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
+    it("spaces at the head of a line should be preserved when the line is just after a start tag of IterationNode") 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
+    it("should not add a newline at the head of IterationNode 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
@@ -214,7 +214,7 @@ content
                                [" "]],
                              [" and "],
                              [[" another tag "]]])
-        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationTagNode)
+        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationNode)
       end
 
       it "may contain lines that consist only of an iteration tag" do
@@ -230,12 +230,12 @@ content
         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
+      it("spaces at the head of a line should be preserved when the line is just after a start tag of IterationNode") 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
+      it("should not add a newline at the head of IterationNode 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
@@ -290,7 +290,7 @@ TEMPLATE
                                [" "]],
                              [" and "],
                              [[" another tag "]]])
-        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationTagNode)
+        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationNode)
       end
 
       it "may contain lines that consist only of an iteration tag" do
@@ -306,12 +306,12 @@ content
         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
+      it("spaces at the head of a line should be preserved when the line is just after a start tag of IterationNode") 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
+      it("should not add a newline at the head of IterationNode 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
@@ -341,7 +341,7 @@ content
                                [" "]],
                              [" and "],
                              [[" another tag "]]])
-        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationTagNode)
+        expect(tree[1]).to be_a_kind_of(AdHocTemplate::Parser::IterationNode)
       end
 
       it "may contain lines that consist only of an iteration tag" do
@@ -357,12 +357,12 @@ content
         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
+      it("spaces at the head of a line should be preserved when the line is just after a start tag of IterationNode") 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
+      it("should not add a newline at the head of IterationNode 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
@@ -427,7 +427,7 @@ iteration_tag: ["<repeat>", "</repeat>"]
 fallback_tag: ["<fallback>", "</fallback>"]
 remove_indent: true
 CONFIG
-        iteration_tag_node = AdHocTemplate::Parser::IterationTagNode
+        iteration_tag_node = AdHocTemplate::Parser::IterationNode
         AdHocTemplate::Parser.register_user_defined_tag_type(tag_type_config)
         defined_tag_type = AdHocTemplate::Parser::TagType[:xml_like3]
         expect(defined_tag_type.head_of[iteration_tag_node]).to eq('<repeat>')
@@ -452,11 +452,14 @@ CONFIG
 
     describe "#contains_any_value_tag?" do
       it 'return true if any value tag is contained' do
-      template_with_value_tag =<<TEMPLATE
+        template_with_value_tag =<<TEMPLATE
 main start
 
 <%#
 <%*
+line without value tag
+*%>
+<%*
 line with <%= value tag %>
 *%>
 #%>
@@ -469,7 +472,7 @@ TEMPLATE
       end
 
       it 'return false if no value tag is contained' do
-      template_without_value_tag =<<TEMPLATE
+        template_without_value_tag =<<TEMPLATE
 main start
 
 <%#
@@ -488,8 +491,49 @@ TEMPLATE
       end
     end
 
-    describe AdHocTemplate::Parser::FallbackTagNode do
-      it 'is expected to be parsed like IterationTagNode -- used inline' do
+    describe "#inner_iteration_tag_labels" do
+      it "returns labels of inner iteration tags" do
+        template =<<TEMPLATE
+<%#authors:
+Name: <%= name %>
+Birthplace: <%= birthplace %>
+Works:
+<%#works|name:
+ * <%= title %>
+<%#
+<%#bio|name:
+Born: <%= birth_date %>
+#%>
+#%>
+#%>
+
+#%>
+TEMPLATE
+
+        tree = AdHocTemplate::Parser.parse(template)
+        expect(tree[0].inner_iteration_tag_labels).to eq (%w(#works|name #bio|name))
+      end
+
+          it "returns nil when there is no inner iteration tags" do
+        template =<<TEMPLATE
+<%#
+Name: <%= name %>
+Birthplace: <%= birthplace %>
+Works:
+ * <%= title %>
+<%#
+Born: <%= birth_date %>
+#%>
+#%>
+TEMPLATE
+
+        tree = AdHocTemplate::Parser.parse(template)
+        expect(tree[0].inner_iteration_tag_labels).to be_nil
+      end
+    end
+
+    describe AdHocTemplate::Parser::FallbackNode do
+      it 'is expected to be parsed like IterationNode -- 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 "],
@@ -513,7 +557,7 @@ TEMPLATE
         fallback = tree[1][1]
 
         expect(tree).to eq(expected_tree)
-        expect(fallback).to be_kind_of(AdHocTemplate::Parser::FallbackTagNode)
+        expect(fallback).to be_kind_of(AdHocTemplate::Parser::FallbackNode)
       end
     end
   end