ad_hoc_template 0.3.0 → 0.4.0

data/samples/ja/inner_iteration/for_csv.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+ad_hoc_template -t xml_comment_like -d 'csv:authors|works|name' template.html data.csv

data/samples/ja/inner_iteration/template.html

@@ -0,0 +1,18 @@
+<h1>作家</h1>
+
+<!--%iterate%-->authors:
+<h2><!--%h name %--></h2>
+
+<table summary="<!--%h name %-->の著名な作品とその出版年のリスト">
+  <caption>著名な作品</caption>
+  <thead>
+    <tr><th scope="col">作品名</th><th scope="col">出版年</th></tr>
+  </thead>
+  <tbody>
+    <!--%iterate%-->works|name:
+    <tr><td><!--%h title %--></td><td><!--%h year %--></td></tr>
+    <!--%/iterate%-->
+  </tbody>
+</table>
+
+<!--%/iterate%-->

data/samples/ja/recipe/main.aht

@@ -0,0 +1,9 @@
+country: フランス
+
+///@#authors
+
+name: アルベール・カミユ
+birth_year: 1913
+
+name: マルセル・エイメ
+birth_year: 1902

data/samples/ja/recipe/template.html

@@ -0,0 +1,20 @@
+<h1><!--%h country %-->文学の著名な作家</h1>
+
+<!--%iterate%-->authors:
+<h2><!--%h name %--></h2>
+
+<p>生年: <!--%h birth_year %--></p>
+
+<table summary="<!--%h name %-->の著名な作品とその出版年のリスト">
+  <caption>著名な作品</caption>
+  <thead>
+    <tr><th scope="col">作品名</th><th scope="col">出版年</th></tr>
+  </thead>
+  <tbody>
+    <!--%iterate%-->works|name:
+    <tr><td><!--%h title %--></td><td><!--%h year %--></td></tr>
+    <!--%/iterate%-->
+  </tbody>
+</table>
+
+<!--%/iterate%-->

data/samples/recipe.yaml

@@ -0,0 +1,34 @@
+---
+template: en/recipe/template.html
+tag_type: :xml_comment_like
+template_encoding: UTF-8
+data: en/recipe/main.aht
+data_format: 
+data_encoding: UTF-8
+output_file: 
+blocks:
+- label: "#authors"
+  data: 
+  data_format: 
+  data_encoding: 
+- label: "#authors|works|name"
+  data: en/inner_iteration/data.csv
+  data_format: 
+  data_encoding: 
+---
+template: ja/recipe/template.html
+tag_type: :xml_comment_like
+template_encoding: UTF-8
+data: ja/recipe/main.aht
+data_format: 
+data_encoding: 
+output_file: 
+blocks:
+- label: "#authors"
+  data: 
+  data_format: 
+  data_encoding: 
+- label: "#authors|works|name"
+  data: ja/inner_iteration/data.csv
+  data_format: 
+  data_encoding: 

data/spec/ad_hoc_template_spec.rb

@@ -142,7 +142,7 @@ RESULT
       expect(AdHocTemplate::DataLoader.format(tree, config, tag_formatter)).to eq(expected_result)
     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
       template = <<TEMPLATE
 a test string with tags
 <%#iteration_block:
@@ -244,6 +244,66 @@ The value of optional key2 is value2
 RESULT
       end
 
+      describe "nested iteration block" do
+        it "may contain inner iteration blocks" do
+          template =<<TEMPLATE
+<%#authors:
+Name: <%= name %>
+Birthplace: <%= birthplace %>
+Works:
+<%#works|name:
+ * <%= title %>
+#%>
+
+#%>
+TEMPLATE
+          data =<<DATA
+///@#authors
+
+name: Albert Camus
+birthplace: Algeria
+
+name: Marcel Ayme'
+birthplace: France
+
+///@#authors|works|Albert Camus
+
+title: L'E'tranger
+
+title: La Peste
+
+///@#authors|works|Marcel Ayme'
+
+title: Le Passe-muraille
+
+title: Les Contes du chat perche'
+
+DATA
+
+          expected_result =<<RESULT
+Name: Albert Camus
+Birthplace: Algeria
+Works:
+ * L'E'tranger
+ * La Peste
+
+Name: Marcel Ayme'
+Birthplace: France
+Works:
+ * Le Passe-muraille
+ * Les Contes du chat perche'
+
+RESULT
+
+          tree = AdHocTemplate::Parser.parse(template)
+          config = AdHocTemplate::RecordReader.read_record(data)
+          tag_formatter = AdHocTemplate::DefaultTagFormatter.new
+          result = AdHocTemplate::DataLoader.format(tree, config, tag_formatter)
+
+          expect(result).to eq(expected_result)
+        end
+      end
+
       describe "with data in default format" do
         it "should not ignore the content of an iteration block when some data are provided" do
           config_data = <<CONFIG
@@ -559,4 +619,14 @@ RESULT
                                    '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
+
+  describe '.local_settings' do
+    it 'evaluates the given block in the context of ConfigManager' do
+      eval_result = AdHocTemplate.local_settings do
+        self::SETTINGS_FILE_NAME
+      end
+
+      expect(eval_result).to eq(AdHocTemplate::ConfigManager::SETTINGS_FILE_NAME)
+    end
+  end
 end

data/spec/command_line_interface_spec.rb

@@ -2,6 +2,7 @@
 
 require 'shellwords'
 require 'stringio'
+require 'fileutils'
 require 'spec_helper'
 require 'ad_hoc_template'
 require 'ad_hoc_template/command_line_interface'
@@ -60,11 +61,18 @@ RESULT
     end
 
     it "can set the internal/external encoding from the command line" do
-      command_line_interface = AdHocTemplate::CommandLineInterface.new
-      set_argv("-E UTF-8:Shift_JIS")
-      command_line_interface.parse_command_line_options
-      expect(Encoding.default_external.names).to include("UTF-8")
-      expect(Encoding.default_internal.names).to include("Shift_JIS")
+      begin
+        default_external = Encoding.default_external
+        default_internal = Encoding.default_internal
+        command_line_interface = AdHocTemplate::CommandLineInterface.new
+        set_argv("-E UTF-8:Shift_JIS")
+        command_line_interface.parse_command_line_options
+        expect(Encoding.default_external.names).to include("UTF-8")
+        expect(Encoding.default_internal.names).to include("Shift_JIS")
+      ensure
+        Encoding.default_external = default_external
+        Encoding.default_internal = default_internal
+      end
     end
 
     it "can specify the output file from command line" do
@@ -231,6 +239,11 @@ key1,key2,key3
 value1-1,value1-2,value1-3
 value2-1,value2-2,value2-3
 value3-1,value3-2,value3-3
+CSV
+        @record_in_csv_with_left_header = <<CSV
+key1,value1-1,value2-1,value3-1
+key2,value1-2,value2-2,value3-2
+key3,value1-3,value2-3,value3-3
 CSV
 
         @expected_result = <<RESULT
@@ -301,7 +314,7 @@ TEMPLATE
         record_filename = "record.csv"
 
         allow(File).to receive(:read).with(File.expand_path(template_filename)).and_return(@template_without_iteration_block)
-        allow(File).to receive(:read).with(File.expand_path(record_filename)).and_return(@record_in_csv_format)
+        allow(File).to receive(:read).with(File.expand_path(record_filename)).and_return(@record_in_csv_with_left_header)
         allow(STDOUT).to receive(:print).with(@expected_result)
 
         set_argv("--data-format=csv #{template_filename} #{record_filename}")
@@ -313,8 +326,9 @@ TEMPLATE
 
       it "can read csv data of only one record" do
         record_in_csv_format = <<CSV
-key1,key2,key3
-value1-1,value1-2,value1-3
+key1,value1-1
+key2,value1-2
+key3,value1-3
 CSV
 
         expected_result = <<RESULT
@@ -346,6 +360,12 @@ key1	key2	key3
 value1-1	value1-2	value1-3
 value2-1	value2-2	value2-3
 value3-1	value3-2	value3-3
+TSV
+
+        @record_in_tsv_with_left_header = <<TSV
+key1	value1-1	value2-1	value3-1
+key2	value1-2	value2-2	value3-2
+key3	value1-3	value2-3	value3-3
 TSV
 
         @expected_result = <<RESULT
@@ -438,7 +458,7 @@ TEMPLATE
         record_filename = "record.tsv"
 
         allow(File).to receive(:read).with(File.expand_path(template_filename)).and_return(@template_without_iteration_block)
-        allow(File).to receive(:read).with(File.expand_path(record_filename)).and_return(@record_in_tsv_format)
+        allow(File).to receive(:read).with(File.expand_path(record_filename)).and_return(@record_in_tsv_with_left_header)
         allow(STDOUT).to receive(:print).with(@expected_result)
 
         set_argv("--data-format=tsv #{template_filename} #{record_filename}")
@@ -450,8 +470,9 @@ TEMPLATE
 
       it "can read tsv data of only one record" do
         record_in_tsv_format = <<TSV
-key1	key2	key3
-value1-1	value1-2	value1-3
+key1	value1-1
+key2	value1-2
+key3	value1-3
 TSV
 
         expected_result = <<RESULT
@@ -564,5 +585,78 @@ TSV
         command_line_interface.execute
       end
     end
+
+    describe '--recipe-template' do
+      it 'reads template files and geperates a blank recipe' do
+        expected_result = <<RECIPE
+---
+template: spec/test_data/en/recipe/template.html
+tag_type: :xml_comment_like
+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: 
+---
+template: spec/test_data/ja/recipe/template.html
+tag_type: :xml_comment_like
+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: 
+RECIPE
+
+        allow(STDOUT).to receive(:print).with(expected_result)
+
+        set_argv("-R -t xml_comment_like spec/test_data/en/recipe/template.html spec/test_data/ja/recipe/template.html")
+        command_line_interface = AdHocTemplate::CommandLineInterface.new
+        command_line_interface.parse_command_line_options
+
+        command_line_interface.execute
+      end
+    end
+
+    describe '--cooking-recipe' do
+      it 'reads a recipe and updates output files' do
+        en_expected_result = File.read('spec/test_data/en/recipe/expected_result.html')
+        ja_expected_result = File.read('spec/test_data/ja/recipe/expected_result.html')
+        en_result_path = 'spec/test_data/en/recipe/result.html'
+        ja_result_path = 'spec/test_data/ja/recipe/result.html'
+
+        set_argv("-c spec/test_data/recipe.yaml")
+        command_line_interface = AdHocTemplate::CommandLineInterface.new
+        command_line_interface.parse_command_line_options
+
+        command_line_interface.execute
+
+        en_result = File.read(en_result_path)
+        ja_result = File.read(ja_result_path)
+
+        expect(en_result).to eq(en_expected_result)
+        expect(ja_result).to eq(ja_expected_result)
+
+        FileUtils.rm(en_result_path)
+        FileUtils.rm(ja_result_path)
+      end
+    end
   end
 end

data/spec/config_manager_spec.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+
+require 'shellwords'
+require 'stringio'
+require 'spec_helper'
+require 'ad_hoc_template'
+require 'ad_hoc_template/config_manager'
+
+describe AdHocTemplate do
+  describe AdHocTemplate::ConfigManager do
+    describe '.require_local_settings' do
+      let(:fake_file) { double('file') }
+
+      before do
+        @config_file = AdHocTemplate::ConfigManager::LOCAL_SETTINGS_FILE
+        @config_full_path = File.expand_path(@config_file)
+      end
+
+      it 'loads local settings when the config file exists' do
+        stub_const("File", fake_file)
+        allow(File).to receive(:expand_path).with(@config_file).and_return(@config_full_path)
+        allow(File).to receive(:exist?).with(@config_full_path).and_return(true)
+        allow(AdHocTemplate::ConfigManager).to receive(:require).with(@config_full_path)
+        AdHocTemplate::ConfigManager.require_local_settings
+      end
+
+      it 'does not do nothing if the config file is not available' do
+        stub_const("File", fake_file)
+        allow(File).to receive(:expand_path).with(@config_file).and_return(@config_full_path)
+        allow(File).to receive(:exist?).with(@config_full_path).and_return(false)
+        allow(AdHocTemplate::ConfigManager).to receive(:require).with(@config_full_path)
+        AdHocTemplate::ConfigManager.require_local_settings
+        expect(AdHocTemplate::ConfigManager).to_not have_received(:require).with(@config_full_path)
+      end
+    end
+
+    describe '.user_defined_tag' do
+      it 'reads a definition from local file and register it' do
+        tag_type_class = AdHocTemplate::Parser::TagType
+
+        yaml_file_name = 'def_tag.yaml'
+        yaml_file_path = File.expand_path(yaml_file_name)
+        yaml_source = <<YAML
+---
+tag_name: :test_tag
+tag: ['<$', '$>']
+iteration_tag: ['<$#', '#$>']
+fallback_tag: ['<$*', '*$>']
+remove_indent: false
+YAML
+
+        allow(File).to receive(:read).with(yaml_file_path).and_return(yaml_source)
+        allow(File).to receive(:expand_path).and_return(yaml_file_path)
+
+        AdHocTemplate::ConfigManager.user_defined_tag(yaml_file_name)
+
+        expect(tag_type_class[:test_tag]).to be_instance_of(tag_type_class)
+      end
+    end
+
+    describe 'DefaultTagFormatter related methods' do
+      before do
+        @function_table = AdHocTemplate::DefaultTagFormatter:: FUNCTION_TABLE
+        @var = 'french_date'
+        @record = { @var => '2016/09/28' }
+        @expected_result = '28/09/2016'
+      end
+
+      it '.assign_format_label is an alias of DefaultTagFormatter.assign_format' do
+        AdHocTemplate.local_settings do
+          assign_format_label('fd') {|var, record| record[var].split(/\//).reverse.join('/') }
+        end
+
+        result = @function_table['fd'].call(@var, @record)
+
+        expect(result).to eq(@expected_result)
+
+        @function_table.delete('fd')
+      end
+
+      it '.define_label_format evaluates a given block in the context of DefaultTagFormatter' do
+        AdHocTemplate.local_settings do
+          define_label_format do
+            def french_date(var, record)
+              record[var].split(/\//).reverse.join('/')
+            end
+
+            assign_format french_date: 'fd'
+          end
+        end
+
+        method_name = @function_table['fd']
+        result = AdHocTemplate::DefaultTagFormatter.new.send method_name, @var, @record
+
+        expect(result).to eq(@expected_result)
+
+        AdHocTemplate::DefaultTagFormatter.send :undef_method, method_name
+      end
+    end
+
+    describe '.init_local_settings' do
+      before do
+        @config_manager = AdHocTemplate::ConfigManager
+        @settings_dir = File.expand_path(@config_manager::LOCAL_SETTINGS_DIR)
+        @setting_file_name = @config_manager::SETTINGS_FILE_NAME
+        @tag_def_file_name = @config_manager::TAG_DEF_FILE_NAME
+        @settings_path = File.expand_path(File.join(@settings_dir, @setting_file_name))
+        @settings_file = StringIO.new('', "w")
+        @tag_def_path = File.expand_path(File.join(@settings_dir, @tag_def_file_name))
+        @tag_def_file = StringIO.new('', "w")
+      end
+
+      it 'creates local setting files unless they exist' do
+        allow(File).to receive(:exist?).with(@settings_dir).and_return(false)
+        allow(FileUtils).to receive(:mkdir).and_return(true)
+        allow(File).to receive(:exist?).with(@settings_path).and_return(false)
+        allow(@config_manager).to receive(:open).with(@settings_path, 'w').and_yield(@settings_file)
+        allow(File).to receive(:exist?).with(@tag_def_path).and_return(false)
+        allow(@config_manager).to receive(:open).with(@tag_def_path, 'w').and_yield(@tag_def_file)
+
+        @config_manager.init_local_settings
+
+        expect(@settings_file.string).to start_with('AdHocTemplate')
+        expect(@tag_def_file.string).to start_with('---')
+      end
+
+      it 'does nothing if local setting files already exist' do
+        allow(File).to receive(:exist?).with(@settings_dir).and_return(true)
+        allow(FileUtils).to receive(:mkdir).and_return(false)
+        allow(File).to receive(:exist?).with(@settings_path).and_return(true)
+        allow(@config_manager).to receive(:open).with(@settings_path, 'w').and_yield(@settings_file)
+        allow(File).to receive(:exist?).with(@tag_def_path).and_return(true)
+        allow(@config_manager).to receive(:open).with(@tag_def_path, 'w').and_yield(@tag_def_file)
+
+        @config_manager.init_local_settings
+
+        expect(@settings_file.string).to be_empty
+        expect(@tag_def_file.string).to be_empty
+      end
+    end
+  end
+end

data/spec/default_tag_formatter_spec.rb

@@ -42,6 +42,19 @@ describe AdHocTemplate do
       AdHocTemplate::DefaultTagFormatter::FUNCTION_TABLE.delete(proc_label)
       expect(proc_assigned).to eq('test for proc assignment: <value1>')
     end
+
+    it '.assign_format can be used to reassign predefined methods' do
+      formatter = AdHocTemplate::DefaultTagFormatter
+      default_equal_sign = formatter::FUNCTION_TABLE["="]
+      expect(default_equal_sign).to eq(:default)
+
+      formatter.assign_format(html_encode: "=")
+      reassigned_equal_sign = formatter::FUNCTION_TABLE["="]
+      expect(reassigned_equal_sign).to eq(:html_encode)
+
+      formatter.assign_format(default: "=")
+      expect(formatter::FUNCTION_TABLE["="]).to eq(default_equal_sign)
+    end
   end
 end