ad_hoc_template 0.2.0 → 0.3.0

data/lib/ad_hoc_template/version.rb

@@ -1,3 +1,3 @@
 module AdHocTemplate
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/ad_hoc_template_spec.rb

@@ -12,7 +12,7 @@ describe AdHocTemplate do
       @template_with_an_iteration_block = <<TEMPLATE
 a test string with tags (<%= key1 %> and <%= key2 %>) in it
 
-<%#iteration_block
+<%#iteration_block:
 the value of sub_key1 is <%= sub_key1 %>
 the value of sub_key2 is <%= sub_key2 %>
 
@@ -145,7 +145,7 @@ RESULT
     it("should not add a newline at the head of IterationTagNode when the type of the node is not specified") do
       template = <<TEMPLATE
 a test string with tags
-<%#iteration_block
+<%#iteration_block:
 the value of sub_key1 is <%= sub_key1 %>
 <%#
   the value of sub_key2 is <%= sub_key2 %>
@@ -192,7 +192,7 @@ The first line in the main part
 <%#
 The first line in the iteration part
 
-<%#iteration_block
+<%#iteration_block:
 The value of key1 is <%= key1 %>
 #%>
 
@@ -209,7 +209,7 @@ Key value: <%= key %>
 Optinal values: <%# <%= optional1 %> and <%= optional2 %> are in the record.
 #%>
 
-<%#iteration_block
+<%#iteration_block:
 The value of key1 is <%= key1 %>
 <%#
 The value of optional key2 is <%= key2 %>
@@ -406,10 +406,156 @@ RESULT
         end
       end
     end
+
+    describe 'fallback block' do
+      before do
+        @template = <<TEMPLATE
+main start
+
+<%#
+<%* content in fallback tag <%= item_in_fallback %> fallback end *%>
+optional content
+<%#iterations:
+in iteration tag <%= item %> #%> iteration part end
+#%>
+
+main end
+TEMPLATE
+
+        @xml_comment_like_template = <<TEMPLATE
+main start
+
+<!--%iterate%-->
+  <!--%fallback%-->
+content in fallback tag <!--%= item_in_fallback %--> fallback end
+  <!--%/fallback%-->
+optional content
+  <!--%iterate%-->iterations:
+in iteration tag <!--%= item %-->
+  <!--%/iterate%-->
+iteration part end
+<!--%/iterate%-->
+
+main end
+TEMPLATE
+
+        @data = <<DATA
+item_in_fallback: ITEM_IN_FALLBACK
+
+///@#iterations
+
+item: ITEM_1
+
+item: ITEM_2
+DATA
+      end
+
+      it 'should be ignored when tags can be filled with data' do
+        expected_result = <<RESULT
+main start
+
+optional content
+in iteration tag ITEM_1 in iteration tag ITEM_2  iteration part end
+
+main end
+RESULT
+        tree = AdHocTemplate::Parser.parse(@template)
+        data = AdHocTemplate::RecordReader.read_record(@data)
+        tag_formatter = AdHocTemplate::DefaultTagFormatter.new
+
+        result = AdHocTemplate::DataLoader.format(tree, data, tag_formatter)
+
+        expect(result).to eq(expected_result)
+      end
+
+      it 'should be shown when tags out side of the node cannot be filled with data' do
+        expected_result = <<RESULT
+main start
+
+ content in fallback tag ITEM_IN_FALLBACK fallback end 
+main end
+RESULT
+
+        empty_data = <<DATA
+item_in_fallback: ITEM_IN_FALLBACK
+
+///@#iterations
+
+item: 
+
+item: 
+DATA
+
+        tree = AdHocTemplate::Parser.parse(@template)
+        data = AdHocTemplate::RecordReader.read_record(empty_data)
+        tag_formatter = AdHocTemplate::DefaultTagFormatter.new
+
+        result = AdHocTemplate::DataLoader.format(tree, data, tag_formatter)
+
+        expect(result).to eq(expected_result)
+      end
+
+      it 'may not contain any tag' do
+        template = <<TEMPLATE
+main start
+
+<%#
+<%* content in fallback tag without inner tags  fallback end 
+*%>
+optional content
+<%#iterations:
+in iteration tag <%= item %> #%> iteration part end
+#%>
+main end
+TEMPLATE
+        expected_result = <<RESULT
+main start
+
+ content in fallback tag without inner tags  fallback end 
+main end
+RESULT
+
+        empty_data = <<DATA
+///@#iterations
+
+item: 
+
+item: 
+DATA
+
+        tree = AdHocTemplate::Parser.parse(template)
+        data = AdHocTemplate::RecordReader.read_record(empty_data)
+        tag_formatter = AdHocTemplate::DefaultTagFormatter.new
+
+        result = AdHocTemplate::DataLoader.format(tree, data, tag_formatter)
+
+        expect(result).to eq(expected_result)
+      end
+
+      it 'should ignore indents preceding fallback tags when TagType[tag_name].remove_iteration_indent is set to true' do
+        expected_result = <<RESULT
+main start
+
+optional content
+in iteration tag ITEM_1
+in iteration tag ITEM_2
+iteration part end
+
+main end
+RESULT
+        tree = AdHocTemplate::Parser.parse(@xml_comment_like_template, :xml_comment_like)
+        data = AdHocTemplate::RecordReader.read_record(@data)
+        tag_formatter = AdHocTemplate::DefaultTagFormatter.new
+
+        result = AdHocTemplate::DataLoader.format(tree, data, tag_formatter)
+
+        expect(result).to eq(expected_result)
+      end
+    end
   end
 
   it 'can convert &"<> into character entities' do
-    result = AdHocTemplate.convert('characters: &, ", < and >',
+    result = AdHocTemplate.render('characters: &, ", < and >',
                                    'a string with characters (<%h characters %>) that should be represented as character entities.')
     expect(result).to eq('a string with characters (&amp;, &quot;, &lt; and &gt;) that should be represented as character entities.')
   end

data/spec/command_line_interface_spec.rb

@@ -12,7 +12,7 @@ describe AdHocTemplate do
       @template_in_default_format = <<TEMPLATE
 a test string with tags (<%= key1 %> and <%= key2 %>) in it
 
-<%#iteration_block
+<%#iteration_block:
 the value of sub_key1 is <%= sub_key1 %>
 the value of sub_key2 is <%= sub_key2 %>
 
@@ -141,7 +141,7 @@ RESULT
       template = <<TEMPLATE
 a test string with tags ({{= key1 }} and {{= key2 }}) in it
 
-{{#iteration_block
+{{#iteration_block:
 the value of sub_key1 is {{= sub_key1 }}
 the value of sub_key2 is {{= sub_key2 }}
 
@@ -197,7 +197,7 @@ YAML
       template = <<TEMPLATE
 a test string with tags (<!--%= key1 %--> and <!--%= key2 %-->) in it
 
-<repeat>iteration_block
+<repeat>iteration_block:
 the value of sub_key1 is <!--%= sub_key1 %-->
 the value of sub_key2 is <!--%= sub_key2 %-->
 
@@ -209,6 +209,7 @@ TEMPLATE
 tag_name: xml_like3
 tag: ["<!--%", "%-->"]
 iteration_tag: ["<repeat>", "</repeat>"]
+fallback_tag: ["<fallback>", "</fallback>"]
 remove_indent: true
 CONFIG
 
@@ -248,7 +249,7 @@ the value of sub_key2 is value3-3
 RESULT
 
         @template_without_iteration_block = <<TEMPLATE
-<%#iteration_block
+<%#iteration_block:
 the value of sub_key1 is <%= key1 %>
 the value of sub_key2 is <%= key2 %>
 the value of sub_key2 is <%= key3 %>
@@ -273,7 +274,7 @@ TEMPLATE
 
       it "can read csv data with an iteration label" do
         template = <<TEMPLATE
-<%#iteration_block
+<%#iteration_block:
 the value of sub_key1 is <%= key1 %>
 the value of sub_key2 is <%= key2 %>
 the value of sub_key2 is <%= key3 %>
@@ -363,7 +364,7 @@ the value of sub_key2 is value3-3
 RESULT
 
         @template_without_iteration_block = <<TEMPLATE
-<%#iteration_block
+<%#iteration_block:
 the value of sub_key1 is <%= key1 %>
 the value of sub_key2 is <%= key2 %>
 the value of sub_key2 is <%= key3 %>
@@ -386,9 +387,31 @@ TEMPLATE
         expect(command_line_interface.data_format).to eq(:tsv)
       end
 
+      it "should propery parse given option values" do
+        command_line_interface = AdHocTemplate::CommandLineInterface.new
+        set_argv("--data-format=t")
+        command_line_interface.parse_command_line_options
+        expect(command_line_interface.data_format).to eq(:tsv)
+
+        command_line_interface = AdHocTemplate::CommandLineInterface.new
+        set_argv("--data-format=t:")
+        command_line_interface.parse_command_line_options
+        expect(command_line_interface.data_format).to eq(:tsv)
+
+        command_line_interface = AdHocTemplate::CommandLineInterface.new
+        set_argv("--data-format=t:label")
+        command_line_interface.parse_command_line_options
+        expect(command_line_interface.data_format).to eq({ tsv: "label" })
+
+        command_line_interface = AdHocTemplate::CommandLineInterface.new
+        set_argv("--data-format=:label")
+        command_line_interface.parse_command_line_options
+        expect(command_line_interface.data_format).to eq(:default)
+      end
+
       it "can read tsv data with an iteration label" do
         template = <<TEMPLATE
-<%#iteration_block
+<%#iteration_block:
 the value of sub_key1 is <%= key1 %>
 the value of sub_key2 is <%= key2 %>
 the value of sub_key2 is <%= key3 %>
@@ -464,5 +487,82 @@ RESULT
         expect(command_line_interface.data_format).to eq(:yaml)
       end
     end
+
+    describe "--entry-format" do
+      before do
+      @template = <<TEMPLATE
+The first line in the main part
+
+<%#
+The first line in the iteration part
+
+Key value: <%= key %>
+Optinal values: <%# <%= optional1 %> and <%= optional2 %> are in the record.
+#%>
+
+<%#iteration_block:
+The value of key1 is <%= key1 %>
+<%#
+The value of optional key2 is <%= key2 %>
+#%>
+#%>
+
+#%>
+
+<%= block %>
+TEMPLATE
+
+        @csv_compatible_template = <<TEMPLATE
+<%= key1 %> <% key2 %>
+<%= key3 %>
+TEMPLATE
+      end
+
+      it 'can output an empty entry format in YAML' do
+        expected_format_in_yaml = <<YAML
+---
+key: 
+optional1: 
+optional2: 
+"#iteration_block":
+- key1: 
+  key2: 
+block: 
+YAML
+
+        template_filename = "template.txt"
+
+        allow(File).to receive(:read).with(File.expand_path(template_filename)).and_return(@template)
+        allow(STDOUT).to receive(:print).with(expected_format_in_yaml)
+        allow(ARGF).to receive(:read).with(no_args)
+
+        set_argv("-d y --entry-format #{template_filename}")
+        command_line_interface = AdHocTemplate::CommandLineInterface.new
+        command_line_interface.parse_command_line_options
+        expect(command_line_interface.data_format).to eq(:yaml)
+
+        command_line_interface.execute
+      end
+
+      it 'can output an empty entry format in TSV' do
+        expected_format_in_tsv = <<TSV
+key1\tkey2\tkey3
+\t\t
+TSV
+
+        template_filename = "template.txt"
+
+        allow(File).to receive(:read).with(File.expand_path(template_filename)).and_return(@csv_compatible_template)
+        allow(STDOUT).to receive(:print).with(expected_format_in_tsv)
+        allow(ARGF).to receive(:read).with(no_args)
+
+        set_argv("-d tsv --entry-format #{template_filename}")
+        command_line_interface = AdHocTemplate::CommandLineInterface.new
+        command_line_interface.parse_command_line_options
+        expect(command_line_interface.data_format).to eq(:tsv)
+
+        command_line_interface.execute
+      end
+    end
   end
 end

data/spec/entry_format_generator_spec.rb

@@ -0,0 +1,163 @@
+#!/usr/bin/env ruby
+
+require 'spec_helper'
+require 'ad_hoc_template'
+
+describe AdHocTemplate do
+  describe AdHocTemplate::EntryFormatGenerator::LabelChecker do
+    before do
+      @template = <<TEMPLATE
+The first line in the main part
+
+<%#
+The first line in the iteration part
+
+Key value: <%= key %>
+Optinal values: <%# <%= optional1 %> and <%= optional2 %> are in the record.
+#%>
+
+<%#iteration_block:
+The value of key1 is <%= key1 %>
+<%#
+The value of optional key2 is <%= key2 %>
+#%>
+#%>
+
+#%>
+
+<%= block %>
+TEMPLATE
+
+      @expected_labels_as_ruby_objects = {
+        "key" => nil,
+        "optional1" => nil,
+        "optional2" => nil,
+        "#iteration_block" => [{
+            "key1" => nil,
+            "key2" => nil
+          }],
+        "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)
+    end
+
+    it '.extract_labels collects tag labels from a parsed template' do
+      expected_labels_in_default_format = <<YAML
+key: 
+optional1: 
+optional2: 
+block: 
+
+///@#iteration_block
+
+key1: 
+key2: 
+YAML
+
+      tree = AdHocTemplate::Parser.parse(@template)
+      labels = AdHocTemplate::EntryFormatGenerator.extract_labels(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
+      template = <<TEMPLATE
+main start
+<%#
+optional start <%* fallback part *%> <%= var1 %>
+<%#iteration: <%= var2 %> #%>
+#%>
+<%= var3 %>
+
+main end
+TEMPLATE
+
+      expected = <<EXPECTED
+var1: 
+var3: 
+
+///@#iteration
+
+var2: 
+EXPECTED
+
+      tree = AdHocTemplate::Parser.parse(template)
+      labels = AdHocTemplate::EntryFormatGenerator.extract_labels(tree)
+
+      expect(labels).to eq(expected)
+    end
+
+    it '.extract_labels should labels in fallback tags' do
+      template = <<TEMPLATE
+main start
+<%#
+optional start <%* fallback <%= fallback_var1 %> and <%= fallback_var2 %> *%> <%= var1 %>
+<%#iteration: <%= var2 %> #%>
+#%>
+<%= var3 %>
+
+main end
+TEMPLATE
+
+      expected = <<EXPECTED
+fallback_var1: 
+fallback_var2: 
+var1: 
+var3: 
+
+///@#iteration
+
+var2: 
+EXPECTED
+
+      tree = AdHocTemplate::Parser.parse(template)
+      labels = AdHocTemplate::EntryFormatGenerator.extract_labels(tree)
+
+      expect(labels).to eq(expected)
+    end
+
+    it '.extract_labels accepts :yaml as its second argument' do
+      expected_labels_in_yaml = <<YAML
+---
+key: 
+optional1: 
+optional2: 
+"#iteration_block":
+- key1: 
+  key2: 
+block: 
+YAML
+
+      tree = AdHocTemplate::Parser.parse(@template)
+      labels = AdHocTemplate::EntryFormatGenerator.extract_labels(tree, :yaml)
+
+      expect(labels).to eq(expected_labels_in_yaml)
+    end
+
+    it '.extract_labels accepts :json as its second argument' do
+      expected_labels_in_json = <<JSON
+{
+  "key":null,
+  "optional1":null,
+  "optional2":null,
+  "#iteration_block":[{
+    "key1":null,
+    "key2":null
+  }],
+  "block":null
+}
+JSON
+
+      tree = AdHocTemplate::Parser.parse(@template)
+      labels = AdHocTemplate::EntryFormatGenerator.extract_labels(tree, :json)
+
+      expect(JSON.parse(labels)).to eq(JSON.parse(expected_labels_in_json))
+    end
+  end
+end