ad_hoc_template 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 476f29030bdd0bf5050ef7e961affd45a4a64667
-  data.tar.gz: 04901a83516ee55be4a9f887d4c050f12cabbd4b
+  metadata.gz: 77dedc981af5ec62410d30504f9d41bb01fb78b3
+  data.tar.gz: 090b330043f0d60d385e613dc50a617d85fe6dba
 SHA512:
-  metadata.gz: 04719a11683310dc6ff684782ea384f1c2a55056ec99d1ab845660f763c7a90ca000e7fa75670dc9537bfbfd047563e41ad24a9ba709de0b438d8562da83288d
-  data.tar.gz: bd458ab6de4d391f4a4ea7fafce0412841f46f449c4b88e8a37b08c53c08ed38b48ea9fb099bdb14a1f12323d7595843c04c222a977480246d83973361681bf5
+  metadata.gz: e96dd5a5f56ded725d6fd1d5c8a02ec5855dbed793200da55e4594ac9f832a441383963eee8f2f46b61dcd21002295264f5f3ddbae891ee6f3ebba2ee41c0c0b
+  data.tar.gz: 46682a5ae8479d813c14b5019ba7150d4db4a1e5199f2a1252ed1a971faec73ed9ba832327761998ccc631925a95047ea4efdc22b30b26d53c06fc85792a23e9

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in ad_hoc_template.gemspec
 
 gem 'pseudohikiparser', '0.0.5.develop'
+gem 'optparse_plus'
 
 group :development do
   gem "bundler", "~> 1.3"

data/README.md

@@ -6,7 +6,7 @@ I conceived this template as a workaroud for some tasks in a working environment
 
 And I hope this tool saves you from meaningless tasks when you have to face such a situation.
 
-## Installation (not published to RubyGems.org yet)
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -42,7 +42,7 @@ key1: value1
 key2: value2
 key3: value3
 
-//@#iteration_block
+///@#iteration_block
 
 sub_key1: value1-1
 sub_key2: value1-2
@@ -50,7 +50,7 @@ sub_key2: value1-2
 sub_key1: value2-1
 sub_key2: value2-2
 
-//@block
+///@block
 
 the first line of block
 the second line of block

data/ad_hoc_template.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
   spec.add_runtime_dependency "pseudohikiparser", "0.0.5.develop"
+  spec.add_runtime_dependency "optparse_plus"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.1"

data/lib/ad_hoc_template/command_line_interface.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'ad_hoc_template'
-require 'optparse'
+require 'optparse_plus'
 
 module AdHocTemplate
   class CommandLineInterface
@@ -37,38 +37,16 @@ module AdHocTemplate
       @data_format = nil
     end
 
-    def set_encoding(given_opt)
-      external, internal = given_opt.split(/:/o, 2)
-      Encoding.default_external = external if external and not external.empty?
-      Encoding.default_internal = internal if internal and not internal.empty?
-    end
-
     def parse_command_line_options
-      OptionParser.new("USAGE: #{File.basename($0)} [OPTION]... TEMPLATE_FILE DATA_FILE") do |opt|
-        opt.on("-E [ex[:in]]", "--encoding [=ex[:in]]",
-               "Specify the default external and internal character encodings (same as the option of MRI") do |given_opt|
-          self.set_encoding(given_opt)
-        end
+      OptionParser.new_with_yaml do |opt|
+        opt.banner = "USAGE: #{File.basename($0)} [OPTION]... TEMPLATE_FILE DATA_FILE"
+        opt.version = AdHocTemplate::VERSION
 
-        opt.on("-o [output_file]", "--output [=output_file]",
-               "Save the result into the specified file.") do |output_file|
-          @output_filename = File.expand_path(output_file)
-        end
-
-        opt.on("-t [tag_type]", "--tag-type [=tag_type]",
-               "Choose a template tag type: default, curly_brackets or square_brackets") do |given_type|
-          choose_tag_type(given_type)
-        end
-
-        opt.on("-d [data_format]", "--data-format [=data_format]",
-               "Specify the format of input data: default, yaml, json, csv or tsv") do |data_format|
-          choose_data_format(data_format)
-        end
-
-        opt.on("-u [tag_config.yaml]","--user-defined-tag [=tag_config.yaml]",
-               "Configure a user-defined tag. The configuration file is in YAML format.") do |tag_config_yaml|
-          register_user_defined_tag_type(tag_config_yaml)
-        end
+        opt.inherit_ruby_options('E') # -E, --encoding
+        opt.on(:output_file) {|output_file| @output_filename = File.expand_path(output_file) }
+        opt.on(:tag_type) {|given_type| choose_tag_type(given_type) }
+        opt.on(:data_format) {|data_format| choose_data_format(data_format) }
+        opt.on(:tag_config) {|tag_config_yaml| register_user_defined_tag_type(tag_config_yaml) }
 
         opt.parse!
       end
@@ -155,3 +133,21 @@ module AdHocTemplate
     end
   end
 end
+
+__END__
+output_file:
+  short: "-o [output_file]"
+  long: "--output [=output_file]"
+  description: "Save the result into the specified file."
+tag_type:
+  short: "-t [tag_type]"
+  long: "--tag-type [=tag_type]"
+  description: "Choose a template tag type: default, curly_brackets or square_brackets"
+data_format:
+  short: "-d [data_format]"
+  long: "--data-format [=data_format]"
+  description: "Specify the format of input data: default, yaml, json, csv or tsv"
+tag_config:
+  short: "-u [tag_config.yaml]"
+  long: "--user-defined-tag [=tag_config.yaml]"
+  description: "Configure a user-defined tag. The configuration file is in YAML format."

data/lib/ad_hoc_template/default_tag_formatter.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+module AdHocTemplate
+  class DefaultTagFormatter
+    FUNCTION_TABLE = {
+      "=" => :default,
+      "h" => :html_encode
+    }
+
+    def self.assign_format(format_label, &func)
+      FUNCTION_TABLE[format_label] = func
+    end
+
+    def find_function(format_label)
+      FUNCTION_TABLE[format_label]||:default
+    end
+
+    def format(format_label, var, record)
+      func = find_function(format_label)
+      case func
+      when Symbol, String
+        self.send(func, var, record)
+      else
+        func.call(var, record)
+      end
+    end
+
+    def default(var, record)
+      record[var]||"[#{var}]"
+    end
+
+    def html_encode(var, record)
+      HtmlElement.escape(record[var]||var)
+    end
+  end
+end

data/lib/ad_hoc_template/parser.rb

@@ -113,12 +113,12 @@ module AdHocTemplate
     end
 
     def self.remove_indent_before_iteration_tags(template_source, tag_type)
-      [
+      start_tag, end_tag = [
         tag_type.iteration_start,
         tag_type.iteration_end
-      ].inject(template_source) do |s, tag|
-        s.gsub(/^([ \t]+#{Regexp.escape(tag)}(?:\r?\n|\r))/) { $1.lstrip }
-      end
+      ].map {|tag| Regexp.escape(tag) }
+      template_source.gsub(/^([ \t]+#{start_tag}\S*(?:\r?\n|\r))/) {|s| s.lstrip }
+        .gsub(/^([ \t]+#{end_tag}(?:\r?\n|\r))/) {|s| s.lstrip }
     end
 
     def self.register_user_defined_tag_type(config_source)

data/lib/ad_hoc_template/pseudohiki_formatter.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'pseudohikiparser'
+
+module AdHocTemplate
+  class DefaultTagFormatter
+    module PseudoHikiFormatter
+      include PseudoHiki
+
+      def self.to_xhtml(var, record)
+        hiki_source = record[var] || var
+        parser = choose_parser(hiki_source)
+        PseudoHiki::XhtmlFormat.format(parser.parse(hiki_source)).to_s
+      end
+
+      def self.choose_parser(hiki_source)
+        hiki_source[/(?:\r?\n|\r)/] ? BlockParser : InlineParser
+      end
+
+      private_class_method :choose_parser
+    end
+
+    assign_format("ph") {|var, record| PseudoHikiFormatter.to_xhtml(var, record) }
+  end
+end

data/lib/ad_hoc_template/record_reader.rb

@@ -64,12 +64,12 @@ module AdHocTemplate
         return label, field_sep
       end
 
-      private_class_method :convert_to_hash
+      private_class_method :convert_to_hash, :parse_config
     end
 
     SEPARATOR = /:\s*/o
-    BLOCK_HEAD = /\A\/\/@/o
-    ITERATION_HEAD = /\A\/\/@#/o
+    BLOCK_HEAD = /\A\/\/\/@/o
+    ITERATION_HEAD = /\A\/\/\/@#/o
     EMPTY_LINE = /\A(?:\r?\n|\r)\Z/o
     ITERATION_MARK = /\A#/o
     READERS_RE = {

data/lib/ad_hoc_template/version.rb

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

data/lib/ad_hoc_template.rb

@@ -1,31 +1,10 @@
 require "ad_hoc_template/version"
 require "ad_hoc_template/parser"
 require "ad_hoc_template/record_reader"
+require "ad_hoc_template/default_tag_formatter"
+require "ad_hoc_template/pseudohiki_formatter"
 
 module AdHocTemplate
-  class DefaultTagFormatter
-    def find_function(tag_type)
-      FUNCTION_TABLE[tag_type]||:default
-    end
-
-    def format(tag_type, var, record)
-      self.send(find_function(tag_type), var, record)
-    end
-
-    def default(var, record)
-      record[var]||"[#{var}]"
-    end
-
-    def html_encode(var, record)
-      HtmlElement.escape(record[var]||var)
-    end
-
-    FUNCTION_TABLE = {
-      "=" => :default,
-      "h" => :html_encode
-    }
-  end
-
   class DataLoader
     def self.format(template, record, tag_formatter=DefaultTagFormatter.new)
       if record.kind_of? Array

data/spec/ad_hoc_template_spec.rb

@@ -25,7 +25,7 @@ key1: value1
 key2: value2
 key3: value3
 
-//@#iteration_block
+///@#iteration_block
 
 sub_key1: value1-1
 sub_key2: value1-2
@@ -33,7 +33,7 @@ sub_key2: value1-2
 sub_key1: value2-1
 sub_key2: value2-2
 
-//@block
+///@block
 
 the first line of block
 the second line of block
@@ -104,7 +104,7 @@ key2: value2
 key3: value3
 key-without-value: 
 
-//@block
+///@block
 
 the first line of block
 the second line of block
@@ -156,14 +156,14 @@ the value of sub_key1 is <%= sub_key1 %>
 TEMPLATE
 
       config_data = <<CONFIG
-//@#iteration_block
+///@#iteration_block
 
 sub_key1: value1-1
 sub_key2: value1-2
 
 sub_key1: value2-1
 
-//@block
+///@block
 
 the first line of block
 CONFIG
@@ -247,7 +247,7 @@ RESULT
       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
-//@#iteration_block
+///@#iteration_block
 
 key1: value1
 
@@ -265,7 +265,7 @@ CONFIG
 
         it "should ignore the content of an iteration block if no thing is provided" do
           config_data = <<CONFIG
-//@#iteration_block
+///@#iteration_block
 
 CONFIG
 
@@ -286,7 +286,7 @@ RESULT
 key: value
 optional1: optinal value1
 
-//@#iteration_block
+///@#iteration_block
 
 key1: value1
 
@@ -308,7 +308,7 @@ CONFIG
 key: 
 optional1: 
 
-//@#iteration_block
+///@#iteration_block
 
 key1: 
 

data/spec/command_line_interface_spec.rb

@@ -25,7 +25,7 @@ key1: value1
 key2: value2
 key3: value3
 
-//@#iteration_block
+///@#iteration_block
 
 sub_key1: value1-1
 sub_key2: value1-2
@@ -33,7 +33,7 @@ sub_key2: value1-2
 sub_key1: value2-1
 sub_key2: value2-2
 
-//@block
+///@block
 
 the first line of block
 the second line of block
@@ -59,27 +59,6 @@ the second paragraph in block
 RESULT
     end
 
-    it "can set the input/output encoding" do
-      command_line_interface = AdHocTemplate::CommandLineInterface.new
-      command_line_interface.set_encoding("UTF-8:Shift_JIS")
-      expect(Encoding.default_external.names).to include("UTF-8")
-      expect(Encoding.default_internal.names).to include("Shift_JIS")
-    end
-
-    it "accepts an internal only argument" do
-      command_line_interface = AdHocTemplate::CommandLineInterface.new
-      command_line_interface.set_encoding(":UTF-8")
-      expect(Encoding.default_internal.names).to include("UTF-8")
-    end
-
-    it "accepts also an external only argument" do
-      command_line_interface = AdHocTemplate::CommandLineInterface.new
-      command_line_interface.set_encoding("Shift_JIS")
-      expect(Encoding.default_external.names).to include("Shift_JIS")
-      command_line_interface.set_encoding("UTF-8:")
-      expect(Encoding.default_external.names).to include("UTF-8")
-    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")

data/spec/default_tag_formatter_spec.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require 'spec_helper'
+require 'ad_hoc_template'
+
+describe AdHocTemplate do
+  describe AdHocTemplate::DefaultTagFormatter do
+    before do
+      @record = {
+        'var1' => '<value1>',
+        'var2' => 'value2'
+      }
+    end
+
+    it 'has "=" format label for the default format' do
+      formatter = AdHocTemplate::DefaultTagFormatter.new
+      default = formatter.format('=', 'var1', @record)
+      expect(default).to eq('<value1>')
+    end
+
+    it 'has "h" format label for HTML encoding' do
+      formatter = AdHocTemplate::DefaultTagFormatter.new
+      default = formatter.format('h', 'var1', @record)
+      expect(default).to eq('&lt;value1&gt;')
+    end
+
+    it 'proc objects may be assigned in DefaultTagFormatter::FUNCTION_TABLE' do
+      proc_label = 'proc_label'
+      function_table = AdHocTemplate::DefaultTagFormatter::FUNCTION_TABLE
+      function_table[proc_label] = proc {|var, record| "test for proc assignment: #{record[var]}" }
+      formatter = AdHocTemplate::DefaultTagFormatter.new
+      proc_assigned = formatter.format(proc_label, 'var1', @record)
+      function_table.delete(proc_label)
+      expect(proc_assigned).to eq('test for proc assignment: <value1>')
+    end
+
+    it '.assign_format may be used to register a new format' do
+      proc_label = 'proc_label'
+      AdHocTemplate::DefaultTagFormatter.assign_format(proc_label) {|var, record| "test for proc assignment: #{record[var]}" }
+      formatter = AdHocTemplate::DefaultTagFormatter.new
+      proc_assigned = formatter.format(proc_label, 'var1', @record)
+      AdHocTemplate::DefaultTagFormatter::FUNCTION_TABLE.delete(proc_label)
+      expect(proc_assigned).to eq('test for proc assignment: <value1>')
+    end
+  end
+end
+

data/spec/parser_spec.rb

@@ -358,6 +358,31 @@ A template with an iteration tag
     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
+
+      it "removes indents from the lines which contain only a labeled iteration tag" do
+        template_without_indent = <<TEMPLATE_WITHOUT_INDENT
+A template with an iteration tag
+
+<!--%iterate%-->label
+    This part will be repeated with <!--% variable %-->
+<!--%/iterate%-->
+
+TEMPLATE_WITHOUT_INDENT
+
+        template_with_indent = <<TEMPLATE
+A template with an iteration tag
+
+  <!--%iterate%-->label
+    This part will be repeated with <!--% variable %-->
+  <!--%/iterate%-->
+
 TEMPLATE
 
         without_indent = AdHocTemplate::Parser.parse(template_without_indent, :xml_comment_like)

data/spec/pseudohiki_formatter_spec.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+describe AdHocTemplate do
+  describe AdHocTemplate::DefaultTagFormatter::PseudoHikiFormatter do
+    it 'with "ph" format label, you can use Hiki notation' do
+      config_data = <<CONFIG
+///@#iteration
+
+key1: value1-1
+key2: value2-1 with [[a link|http://www.example.org/]]
+
+key1: value1-2
+key2: value2-2
+
+///@block
+
+the ''first'' line of block
+the second line of block
+
+the second paragraph in block
+
+CONFIG
+
+      template = <<TEMPLATE
+<ul>
+<%#iteration
+  <li>
+    <ul>
+      <li><%ph key1 %></li>
+      <li><%ph key2 %></li>
+    </ul>
+  </li>
+#%>
+</ul>
+
+<%ph block %>
+TEMPLATE
+
+      expected_result = <<RESULT
+<ul>
+  <li>
+    <ul>
+      <li>value1-1</li>
+      <li>value2-1 with <a href="http://www.example.org/">a link</a></li>
+    </ul>
+  </li>
+  <li>
+    <ul>
+      <li>value1-2</li>
+      <li>value2-2</li>
+    </ul>
+  </li>
+</ul>
+
+<p>
+the <em>first</em> line of block
+the second line of block
+</p>
+<p>
+the second paragraph in block
+</p>
+
+RESULT
+
+      result = AdHocTemplate.convert(config_data, template)
+      expect(result).to eq(expected_result)
+    end
+  end
+end

data/spec/record_reader_spec.rb

@@ -24,7 +24,7 @@ CONFIG
 
     it "can read several header type configurations at once." do
       data = <<CONFIGS
-//@#configs
+///@#configs
 
 key1-1: value1-1
 key1-2: value1-2
@@ -48,7 +48,7 @@ CONFIGS
 
     it "can read sets of several header type configurations at once." do
       data = <<CONFIGS
-//@#configs
+///@#configs
 
 key1-1: value1-1
 key1-2: value1-2
@@ -59,7 +59,7 @@ key2-2: value2-2
 key3-1: value3-1
 key3-2: value3-2
 
-//@#configs2
+///@#configs2
 
 key1-1: value1-1
 key1-2: value1-2
@@ -93,14 +93,14 @@ key1: value1
 key2: value2
 key3: value3
 
-//@block1
+///@block1
 
 the first line of block1
 the second line of block1
 
 the second paragraph in block1
 
-//@block2
+///@block2
 the first line of block2
 the second line of block2
 
@@ -123,7 +123,7 @@ key1: value1
 key2: value2
 key3: value3
 
-//@#subconfigs
+///@#subconfigs
 
 key1-1: value1-1
 key1-2: value1-2
@@ -131,7 +131,7 @@ key1-2: value1-2
 key2-1: value2-1
 key2-2: value2-2
 
-//@block
+///@block
 
 the first line of block
 the second line of block
@@ -158,7 +158,7 @@ key1: value1
 key2: value2
 key3: value3
 
-//@#subconfigs
+///@#subconfigs
 
 key1-1: value1-1
 key1-2: value1-2
@@ -166,7 +166,7 @@ key1-2: value1-2
 key2-1: value2-1
 key2-2: value2-2
 
-//@block
+///@block
 
 the first line of block
 the second line of block
@@ -237,7 +237,7 @@ key1: value1
 key2: value2
 key3: value3
 
-//@#subconfigs
+///@#subconfigs
 
 key1-1: value1-1
 key1-2: value1-2
@@ -245,7 +245,7 @@ key1-2: value1-2
 key2-1: value2-1
 key2-2: value2-2
 
-//@block
+///@block
 
 the first line of block
 the second line of block
@@ -303,7 +303,7 @@ JSON
   describe AdHocTemplate::RecordReader::CSVReader do
       before do
         @config_source = <<CONFIG
-//@#subconfigs
+///@#subconfigs
 
 key1: value1-1
 key2: value1-2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ad_hoc_template
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - HASHIMOTO, Naoki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-03 00:00:00.000000000 Z
+date: 2016-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pseudohikiparser
@@ -24,6 +24,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.0.5.develop
+- !ruby/object:Gem::Dependency
+  name: optparse_plus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,12 +100,16 @@ files:
 - bin/ad_hoc_template
 - lib/ad_hoc_template.rb
 - lib/ad_hoc_template/command_line_interface.rb
+- lib/ad_hoc_template/default_tag_formatter.rb
 - lib/ad_hoc_template/parser.rb
+- lib/ad_hoc_template/pseudohiki_formatter.rb
 - lib/ad_hoc_template/record_reader.rb
 - lib/ad_hoc_template/version.rb
 - spec/ad_hoc_template_spec.rb
 - spec/command_line_interface_spec.rb
+- spec/default_tag_formatter_spec.rb
 - spec/parser_spec.rb
+- spec/pseudohiki_formatter_spec.rb
 - spec/record_reader_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/nico-hn/AdHocTemplate
@@ -114,13 +132,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: A tiny template processor
 test_files:
 - spec/ad_hoc_template_spec.rb
 - spec/command_line_interface_spec.rb
+- spec/default_tag_formatter_spec.rb
 - spec/parser_spec.rb
+- spec/pseudohiki_formatter_spec.rb
 - spec/record_reader_spec.rb
 - spec/spec_helper.rb