htot_conv 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db822ef12503c3c67ad25292d6843071c98ace01
-  data.tar.gz: 8bf51fe9de74f2ab6d135dd7a65f212df9d3a4dc
+  metadata.gz: 2aec83d272692c2e5e421fa83871202a6658f6f0
+  data.tar.gz: 2e36a66a3309075cb170a1e587e18d83fc3a1c97
 SHA512:
-  metadata.gz: 5d7e7917107721f317b69f02d18eacf268241e4fdee0bc601b927781fccd1e8cdf0faddb4dd99581bf75ed5e1e56ec744c58d2f7cad5ca601bb93d1cfa4db6e1
-  data.tar.gz: f3065da8d0f122319037639cc1934296a804d8080241bd5b611aa6f0372a2fbe7ff91e9c234e4f31a825c7f9c51a8ad8ce2684e20e6a31e2a27ae6386288b00e
+  metadata.gz: aea65eb03fa27f1d475448e8bf560a387e36c564d8af92b6e68e99701569d10544496841458c840eff89e815ba2e3857140d0d7e1b43e932f6c5a3c616be53b9
+  data.tar.gz: fefabfb0d96991003bb55d53590fc26bbbc1c2a1947d5ba92a7188852ad8491408ff7f5b4399d3f179bbd8fb8b4e586139cc55a8576e8cdb9d3d538b270ce31e

data/.travis.yml

@@ -2,8 +2,10 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
+  - 2.4.1
   - 2.3.4
-before_install: gem install bundler -v 1.12.5
+  - 2.2.7
+before_install: gem install bundler
 notifications:
   email: false
   slack:

data/README.md

@@ -2,6 +2,9 @@
 
 Convert from a simple hierarchical-tree outline text into ugly xlsx file
 
+[![Gem Version](https://badge.fury.io/rb/htot_conv.svg)](https://badge.fury.io/rb/htot_conv)
+[![Build Status](https://travis-ci.org/cat-in-136/htot_conv.svg?branch=master)](https://travis-ci.org/cat-in-136/htot_conv)
+
 ## Installation
 
 Install `htot_conv` via RubyGems. Simply run the following command to install:
@@ -83,10 +86,6 @@ Not implemented (TODO):
 |    | 1.2 |       | 1.2(1)   | 1.2(2)   | 
 |    |     | 1.2.1 | 1.2.1(1) | 1.2.1(2) | 
 
-Not implemented (TODO):
-
- * Cell integration over row.
-
 #### `xlsx_type3`
 
 Not supported (implemented) as of now.
@@ -98,7 +97,7 @@ Not supported (implemented) as of now.
 |    | 1.2  | 1.2(1) |          | 1.2(2)   | 
 |    |      | 1.2.1  | 1.2.1(1) | 1.2.1(2) | 
 
-TODO: Github Flavored Markdown does not support for column span.
+TODO: Github Flavored Markdown does not support for row span.
 So, this document does not correctly represent type-3 xlsx spread sheet.
 
 #### `xlsx_type4`
@@ -108,10 +107,6 @@ So, this document does not correctly represent type-3 xlsx spread sheet.
 | 1  | 1.1 |       | 1.1(1)   | 1.1(2)   | 
 |    | 1.2 | 1.2.1 | 1.2.1(1) | 1.2.1(2) | 
 
-Not implemented (TODO):
-
- * Cell integration over column.
-
 #### `xlsx_type5`
 
 | H1 | H2  | H3    | H(1)     | H(2)     | 
@@ -119,11 +114,6 @@ Not implemented (TODO):
 | 1  | 1.1 |       | 1.1(1)   | 1.1(2)   | 
 | 1  | 1.2 | 1.2.1 | 1.2.1(1) | 1.2.1(2) | 
 
-Not implemented (TODO):
-
- * Cell integration over column.
- * Apply auto filter to the first (header) row.
-
 ## Development
 
     $ bundle install --path=vendor/bundle --with development test

data/exe/htot_conv

@@ -1,111 +1,8 @@
 #!/usr/bin/env ruby
-require 'optparse'
-
+# frozen_string_literal: true
+#
 require 'rubygems'
-require 'rinne'
 require 'htot_conv'
+require 'htot_conv/cli'
 
-module HTOTConv
-  module CLI
-    class ScriptOptions
-      def initialize
-        @options = {
-          :from_type => :simple_text,
-          :to_type => :xlsx_type2,
-        }
-        @from_options = {}
-        @to_options = {}
-      end
-      attr_accessor :options, :from_options, :to_options
-
-      def define_options(opts)
-        opts.banner       = %q{Hierarchical-Tree Outline Text Converter}
-        opts.define_head    %q{Usage: htot_conv [options] [input] [output]}
-        opts.separator      %q{}
-        opts.separator      %q{Options:}
-
-        from_types = HTOTConv::Parser.types.map { |v| [v, v.to_s.tr("_", "-")] }.flatten
-        to_types = HTOTConv::Generator.types.map { |v| [v, v.to_s.tr("_", "-")] }.flatten
-
-        opts.on("-f", "--from-type=TYPE", from_types, "type of input (default: #{options[:from_type]})") do |v|
-          options[:from_type] = v.to_s.tr("-", "_")
-        end
-        opts.on("-t", "--to-type=TYPE", to_types, "type of output (default: #{options[:to_type]})") do |v|
-          options[:to_type] = v.to_s.tr("-", "_")
-        end
-        opts.on("-l", "--list-type", "list input/output type") do
-          $stdout << "type of input:\n"
-          $stdout << HTOTConv::Parser.types.join(" ") << "\n"
-          $stdout << "\n"
-          $stdout << "type of output:\n"
-          $stdout << HTOTConv::Generator.types.join(" ") << "\n"
-          $stdout << "\n"
-          exit
-        end
-
-        opts.separator ""
-        opts.on("-h", "-?", "--help", "Show this message") do
-          puts opts
-          exit
-        end
-        opts.on("--version", "Show version") do
-          $stdout << "htot_conv #{HTOTConv::VERSION}\n"
-          exit
-        end
-
-        opts.separator ""
-        opts.separator "I/O Options:"
-        define_sub_options(opts, HTOTConv::Parser, "from") do |key, v|
-          @from_options[key] = v
-        end
-        define_sub_options(opts, HTOTConv::Generator, "to") do |key, v|
-          @to_options[key] = v
-        end
-      end
-
-      private
-      def define_sub_options(opts, klass, prefix) # :yields: key, v
-        klass.types.each do |type|
-          type_klass = klass.const_get(Rinne.camelize(type.to_s))
-          type_klass.option_help.each do |key,v|
-            long_option = "--#{prefix}-#{key.to_s.tr('_','-')}=VAL"
-            cmd_switch = opts.top.list.find { |v| v.kind_of?(OptionParser::Switch) && v.long.include?(long_option) }
-            if cmd_switch
-              cmd_switch.desc << "For #{type}, #{v[:desc]}"
-            else
-              opts.on(long_option, v[:pat], "For #{type}, #{v[:desc]}") do |v|
-                yield key, v
-              end
-            end
-          end
-        end
-      end
-    end
-
-    def optparse(args)
-      script_opts = ScriptOptions.new
-      OptionParser.new do |opts|
-        script_opts.define_options(opts)
-
-        begin
-          opts.parse!(args)
-        rescue OptionParser::ParseError => ex
-          $stderr << ex.message << "\n"
-          exit 1
-        end
-      end
-      script_opts
-    end
-    module_function :optparse
-  end
-end
-
-script_opts = HTOTConv::CLI.optparse(ARGV)
-options = script_opts.options
-from_options = script_opts.from_options
-to_options = script_opts.to_options
-
-inio  = ((ARGV.length > 0) && (ARGV[0] != "-"))? File.open(ARGV[0], "rb") : $stdin
-outio = ((ARGV.length > 1) && (ARGV[1] != "-"))? File.open(ARGV[1], "wb") : $stdout
-
-HTOTConv.convert(inio, options[:from_type], outio, options[:to_type], from_options, to_options)
+HTOTConv::CLI.main(ARGV)

data/lib/htot_conv/cli.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+require 'optparse'
+
+require 'rinne'
+
+module HTOTConv
+  module CLI
+    class ScriptOptions
+      def initialize
+        @options = {
+          :from_type => :simple_text,
+          :to_type => :xlsx_type2,
+        }
+        @from_options = {}
+        @to_options = {}
+      end
+      attr_accessor :options, :from_options, :to_options
+
+      def define_options(opts)
+        opts.banner       = %q{Hierarchical-Tree Outline Text Converter}
+        opts.define_head    %q{Usage: htot_conv [options] [input] [output]}
+        opts.separator      %q{}
+        opts.separator      %q{Options:}
+
+        from_types = HTOTConv::Parser.types.map { |v| [v, v.to_s.tr("_", "-")] }.flatten
+        to_types = HTOTConv::Generator.types.map { |v| [v, v.to_s.tr("_", "-")] }.flatten
+
+        opts.on("-f", "--from-type=TYPE", from_types, "type of input (default: #{options[:from_type]})") do |v|
+          options[:from_type] = v.to_s.tr("-", "_")
+        end
+        opts.on("-t", "--to-type=TYPE", to_types, "type of output (default: #{options[:to_type]})") do |v|
+          options[:to_type] = v.to_s.tr("-", "_")
+        end
+        opts.on("-l", "--list-type", "list input/output type") do
+          $stdout << "type of input:\n"
+          $stdout << HTOTConv::Parser.types.join(" ") << "\n"
+          $stdout << "\n"
+          $stdout << "type of output:\n"
+          $stdout << HTOTConv::Generator.types.join(" ") << "\n"
+          $stdout << "\n"
+          exit
+        end
+
+        opts.separator ""
+        opts.on("-h", "-?", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+        opts.on("--version", "Show version") do
+          $stdout << "htot_conv #{HTOTConv::VERSION}\n"
+          exit
+        end
+
+        opts.separator ""
+        opts.separator "I/O Options:"
+        define_sub_options(opts, HTOTConv::Parser, "from") do |key, v|
+          @from_options[key] = v
+        end
+        define_sub_options(opts, HTOTConv::Generator, "to") do |key, v|
+          @to_options[key] = v
+        end
+      end
+
+      private
+      def define_sub_options(opts, klass, prefix) # :yields: key, v
+        options = {}
+
+        klass.types.each do |type|
+          type_klass = klass.const_get(Rinne.camelize(type.to_s))
+          type_klass.option_help.each do |key,v|
+            long_option = "--#{prefix}-#{key.to_s.tr('_','-')}"
+
+            if options.include?(long_option)
+              options[long_option][:desc] << "For #{type}, #{v[:desc]}"
+              unless options[long_option][:pattern] == v[:pat]
+                if (options[long_option][:pattern].kind_of?(Array) && v[:pat].kind_of?(Array))
+                  options[long_option][:pattern] = options[long_option][:pattern].concat(v[:pat]).uniq
+                else
+                  raise "pattern registration mismatch around #{long_option}"
+                end
+              end
+            else
+              options[long_option] = {
+                :key => key,
+                :pattern => v[:pat],
+                :desc => ["For #{type}, #{v[:desc]}"],
+              }
+            end
+          end
+        end
+
+        options.each do |long_option, value|
+          opts.on("#{long_option}=VAL", value[:pattern], *value[:desc]) do |v|
+            yield value[:key], v
+          end
+        end
+      end
+    end
+
+    def optparse(args)
+      script_opts = ScriptOptions.new
+      OptionParser.new do |opts|
+        script_opts.define_options(opts)
+
+        begin
+          opts.parse!(args)
+        rescue OptionParser::ParseError => ex
+          $stderr << ex.message << "\n"
+          exit 1
+        end
+      end
+      script_opts
+    end
+    module_function :optparse
+
+    def main(args=ARGV)
+      script_opts = HTOTConv::CLI.optparse(args)
+      options = script_opts.options
+      from_options = script_opts.from_options
+      to_options = script_opts.to_options
+      
+      inio  = ((args.length > 0) && (args[0] != "-"))? File.open(args[0], "rb") : $stdin
+      outio = ((args.length > 1) && (args[1] != "-"))? File.open(args[1], "wb") : $stdout
+      
+      HTOTConv.convert(inio, options[:from_type], outio, options[:to_type], from_options, to_options)
+    end
+    module_function :main
+  end
+end

data/lib/htot_conv/generator/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module HTOTConv
   module Generator
     class Base

data/lib/htot_conv/generator/xlsx_type0.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'axlsx'
 
 require 'htot_conv/generator/base'

data/lib/htot_conv/generator/xlsx_type1.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'axlsx'
 

data/lib/htot_conv/generator/xlsx_type2.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'axlsx'
 
 require 'htot_conv/generator/base'
@@ -5,6 +6,16 @@ require 'htot_conv/generator/base'
 module HTOTConv
   module Generator
     class XlsxType2 < XlsxBase
+      def self.option_help
+        {
+          :integrate_cells => {
+            :default => nil,
+            :pat => [:colspan, :rowspan],
+            :desc => "integrate key cells (specify 'colspan' or 'rowspan')",
+          },
+        }
+      end
+
       def output_to_worksheet(ws)
         max_level = @data.max_level
         max_value_length = @data.max_value_length
@@ -31,6 +42,25 @@ module HTOTConv
               :border => { :style => :thin, :color => "00", :edges => edges })
           end
         end
+
+        case @option[:integrate_cells]
+        when :colspan
+          @data.item.each_with_index do |item, item_index|
+            if item.level < max_level
+              ws.merge_cells(ws.rows[item_index + 1].cells[((item.level - 1)..(max_level - 1))])
+            end
+          end
+        when :rowspan
+          @data.item.each_with_index do |item, item_index|
+            cells = [ws.rows[item_index + 1].cells[item.level - 1]]
+            ((item_index + 1)..(@data.item.length - 1)).each do |i|
+              break if @data.item[i].level <= item.level
+              cells << ws.rows[i + 1].cells[item.level - 1]
+            end
+
+            ws.merge_cells(cells) if cells.length > 1
+          end
+        end
       end
     end
   end

data/lib/htot_conv/generator/xlsx_type4.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'axlsx'
 
 require 'htot_conv/generator/base'
@@ -5,6 +6,16 @@ require 'htot_conv/generator/base'
 module HTOTConv
   module Generator
     class XlsxType4 < XlsxBase
+      def self.option_help
+        {
+          :integrate_cells => {
+            :default => nil,
+            :pat => [:colspan, :rowspan, :both],
+            :desc => "integrate key cells (specify 'colspan', 'rowspan' or 'all')",
+          },
+        }
+      end
+
       def output_to_worksheet(ws)
         max_level = @data.max_level
         max_value_length = @data.max_value_length
@@ -13,13 +24,14 @@ module HTOTConv
           HTOTConv::Util.pad_array(@data.value_header, max_value_length)),
         :style => Axlsx::STYLE_THIN_BORDER)
 
+        rowspan_cells = Array.new(max_level) { [] }
         @data.to_tree.descendants.each do |node|
           if node.leaf?
             item = node.item
 
             key_cell = Array.new(max_level, nil)
             key_cell[node.item.level - 1] = item.key
-            node.ancestors do |ancestor|
+            node.ancestors.each do |ancestor|
               key_cell[ancestor.item.level - 1] = ancestor.item.key if ancestor.item
               break if ancestor.prev
             end
@@ -29,7 +41,7 @@ module HTOTConv
             ws.add_row(key_cell.concat(value_cell),
                        :style => Axlsx::STYLE_THIN_BORDER)
 
-            [node].concat(node.ancestors).each do |ancestor|
+            [node].concat(node.ancestors.to_a).each do |ancestor|
               if (ancestor.parent && ancestor.parent.item && ancestor.parent.item.level)
                 edges = [:left, :right]
                 edges << :top unless ancestor.prev
@@ -45,6 +57,25 @@ module HTOTConv
               ws.rows.last.cells[level - 1].style = ws.styles.add_style(
                 :border => { :style => :thin, :color => "00", :edges => edges })
             end
+
+            if [:colspan, :both].include?(@option[:integrate_cells])
+              if item.level < max_level
+                ws.merge_cells(ws.rows.last.cells[((item.level - 1)..(max_level - 1))])
+              end
+            end
+
+            node.ancestors.inject(node) do |c_node, a_node|
+              rowspan_cells[a_node.item.level - 1] << ws.rows.last.cells[a_node.item.level - 1]
+              unless c_node.next # if c_node is last?
+                if [:rowspan, :both].include?(@option[:integrate_cells])
+                  if rowspan_cells[a_node.item.level - 1].length > 1
+                    ws.merge_cells(rowspan_cells[a_node.item.level - 1])
+                  end
+                end
+                rowspan_cells[a_node.item.level - 1].clear 
+              end
+              a_node
+            end
           end
         end
       end

data/lib/htot_conv/generator/xlsx_type5.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'axlsx'
 
 require 'htot_conv/generator/base'
@@ -5,6 +6,16 @@ require 'htot_conv/generator/base'
 module HTOTConv
   module Generator
     class XlsxType5 < XlsxBase
+      def self.option_help
+        {
+          :integrate_cells => {
+            :default => nil,
+            :pat => [:colspan],
+            :desc => "integrate key cells (specify 'colspan')",
+          },
+        }
+      end
+
       def output_to_worksheet(ws)
         max_level = @data.max_level
         max_value_length = @data.max_value_length
@@ -19,7 +30,7 @@ module HTOTConv
 
             key_cell = Array.new(max_level, nil)
             key_cell[node.item.level - 1] = item.key
-            node.ancestors do |ancestor|
+            node.ancestors.each do |ancestor|
               key_cell[ancestor.item.level - 1] = ancestor.item.key if ancestor.item
             end
 
@@ -35,6 +46,12 @@ module HTOTConv
               ws.rows.last.cells[level - 1].style = ws.styles.add_style(
                 :border => { :style => :thin, :color => "00", :edges => edges })
             end
+
+            if [:colspan].include?(@option[:integrate_cells])
+              if item.level < max_level
+                ws.merge_cells(ws.rows.last.cells[((item.level - 1)..(max_level - 1))])
+              end
+            end
           end
         end
 

data/lib/htot_conv/generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'htot_conv/generator/xlsx_type0.rb'
 require 'htot_conv/generator/xlsx_type1.rb'
 require 'htot_conv/generator/xlsx_type2.rb'

data/lib/htot_conv/outline.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module HTOTConv
   class Outline
     def initialize
@@ -96,7 +97,7 @@ module HTOTConv
       end
       alias :<< :add
 
-      def each # :yields: child
+      def each # :yield: child
         @children.each do |v|
           yield v if block_given?
         end
@@ -129,28 +130,25 @@ module HTOTConv
         end
       end
 
-      def ancestors # :yields: ancestor
-        ancestors = []
-        node = self.parent
-        until (node.nil? || node.root?)
-          ancestors << node
-          yield node if block_given?
-          node = node.parent
+      def ancestors
+        Enumerator.new do |y|
+          node = self.parent
+          until (node.nil? || node.root?)
+            y << node
+            node = node.parent
+          end 
         end
-        ancestors
       end
 
-      def descendants # :yields: descendant
-        descendants = []
-        @children.each do |child|
-          descendants << child
-          yield child if block_given?
-          child.descendants do |descendant|
-            descendants << descendant
-            yield descendant if block_given?
+      def descendants
+        Enumerator.new do |y|
+          @children.each do |child|
+            y << child
+            child.descendants.each do |descendant|
+              y << descendant
+            end
           end
         end
-        descendants
       end
     end
   end

data/lib/htot_conv/parser/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module HTOTConv
   module Parser
     class Base

data/lib/htot_conv/parser/html_list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'htot_conv/parser/base'
 
 module HTOTConv

data/lib/htot_conv/parser/simple_text.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'htot_conv/parser/base'
 
 module HTOTConv
@@ -13,7 +14,17 @@ module HTOTConv
           :delimiter => {
             :default => nil,
             :pat => String,
-            :desc => "separator character of additional data"
+            :desc => "separator character of additional data",
+          },
+          :preserve_empty_line => {
+            :defalut => false,
+            :pat => FalseClass,
+            :desc => "preserve empty line as a level-1 item (default: no)",
+          },
+          :value_header => {
+            :default => [],
+            :pat => Array,
+            :desc => "value header",
           },
         }
       end
@@ -23,9 +34,11 @@ module HTOTConv
         delimiter_regexp = (option[:delimiter].kind_of?(String))? Regexp.new(Regexp.escape(option[:delimiter])) : option[:delimiter]
         outline = HTOTConv::Outline.new
         outline.key_header = []
-        outline.value_header = []
+        outline.value_header = option[:value_header]
 
         input.each_line do |line|
+          next if ((line.chomp == "") && (!option[:preserve_empty_line]))
+
           level = 1
           value = []
           if (option[:indent] || '').length > 0

data/lib/htot_conv/parser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'htot_conv/parser/base.rb'
 require 'htot_conv/parser/simple_text.rb'
 require 'htot_conv/parser/html_list.rb'

data/lib/htot_conv/util.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module HTOTConv
   module Util

data/lib/htot_conv/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module HTOTConv
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/htot_conv.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 require 'htot_conv/version'
 
 require 'htot_conv/util'
 require 'htot_conv/outline'
 require 'htot_conv/generator'
 require 'htot_conv/parser'
+# require 'htot_conv/cli'
 
 module HTOTConv
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: htot_conv
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - "@cat_in_136"
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2017-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: axlsx
@@ -99,6 +99,7 @@ files:
 - exe/htot_conv
 - htot_conv.gemspec
 - lib/htot_conv.rb
+- lib/htot_conv/cli.rb
 - lib/htot_conv/generator.rb
 - lib/htot_conv/generator/base.rb
 - lib/htot_conv/generator/xlsx_type0.rb