htot_conv 0.3.2 → 1.0.0

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-task :default => :test
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "htot_conv"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "htot_conv"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docs/index.md

@@ -0,0 +1,88 @@
+# Types of input
+
+## `simple_text`
+
+ * A text file consisting of multiple lines where:
+   * `<line> ::= { <indent> } <key> { <delimiter> <value> }`
+   * `<key>` : a text that does not start with `<indent>` and does not contain `<delimiter>` (if `<delimiter>` specified).
+   * `<value>` : a text that does not contain `<delimiter>`.
+   * `<indent>` : specified by `--from-indent` option
+   * `<delimiter>` : specified by `--from-delimiter` option
+
+## `dir_tree`
+
+ * Directory tree with the glob pattern specified by `--from-glob-pattern` (default: `**/*`)
+
+## `html_list`
+
+ * HTML `<ul><li>` and/or `<ol><li>` [nesting list](https://www.w3.org/wiki/HTML_lists#Nesting_lists).
+ * All text outside of `<li>` elements is ignored.
+
+## `opml`
+
+ * [OPML](http://dev.opml.org/)
+ * Treat the `text` attribute as a key text, the other attributes as values.
+
+# Types of output
+
+The sample input used in this section are as follows:
+
+    1,1(1),1(2)
+      1.1,1.1(1),1.1(2)
+      1.2,1.2(1),1.2(2)
+        1.2.1,1.2.1(1),1.2.1(2)
+
+ * key header: H1, H2, H3
+ * value header: H(1), H(2)
+
+## `xlsx_type0`
+
+![](image/output_xlsx_type0.png)
+
+## `xlsx_type1`
+
+![](image/output_xlsx_type1.png)
+
+`--outline-rows=yes` : group rows
+
+![](image/output_xlsx_type1_outline_rows_yes.png)
+
+Not implemented (TODO):
+
+ * Fill with different background color for each level.
+
+## `xlsx_type2`
+
+![](image/output_xlsx_type2.png)
+
+`--integrate-cells={colspan,rowspan}` : group columns/rows.
+
+![](image/output_xlsx_type2_integrate_cells_colspan.png)
+
+`--outline-rows=yes` : group rows.
+
+![](image/output_xlsx_type2_outline_rows_yes.png)
+
+## `xlsx_type3`
+
+![](image/output_xlsx_type3.png)
+
+`--integrate-cells={colspan,rowspan,both}` : group columns/rows.
+
+![](image/output_xlsx_type3_integrate_cells_both.png)
+
+## `xlsx_type4`
+
+![](image/output_xlsx_type4.png)
+
+`--integrate-cells={colspan,rowspan,both}` : group columns/rows.
+
+![](image/output_xlsx_type4_integrate_cells_both.png)
+
+## `xlsx_type5`
+
+![](image/output_xlsx_type5.png)
+
+`--integrate-cells=colspan` : group columns/rows.
+
+![](image/output_xlsx_type5_integrate_cells_colspan.png)

data/exe/htot_conv

@@ -1,8 +1,8 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-#
-require 'rubygems'
-require 'htot_conv'
-require 'htot_conv/cli'
-
-HTOTConv::CLI.main(ARGV)
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+require 'rubygems'
+require 'htot_conv'
+require 'htot_conv/cli'
+
+HTOTConv::CLI.main(ARGV)

data/htot_conv.gemspec

@@ -1,37 +1,37 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'htot_conv/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "htot_conv"
-  spec.version       = HTOTConv::VERSION
-  spec.authors       = ["@cat_in_136"]
-  spec.email         = ["cat.in.136+github@gmail.com"]
-
-  spec.summary       = %q{Hierarchical-Tree Outline Text Converter}
-  spec.description   = %q{Convert from a simple hierarchical-tree outline text into ugly xlsx file}
-  spec.homepage      = "https://github.com/cat-in-136/htot_conv"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "axlsx", "~> 2.0.1"
-  spec.add_dependency "rinne", "~> 0.0.3"
-
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "fakefs", "~> 0.11.3"
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'htot_conv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "htot_conv"
+  spec.version       = HTOTConv::VERSION
+  spec.authors       = ["@cat_in_136"]
+  spec.email         = ["cat.in.136+github@gmail.com"]
+
+  spec.summary       = %q{Hierarchical-Tree Outline Text Converter}
+  spec.description   = %q{Convert from a simple hierarchical-tree outline text into ugly xlsx file}
+  spec.homepage      = "https://github.com/cat-in-136/htot_conv"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubyXL", "~> 3.3.26"
+  spec.add_dependency "rinne", "~> 0.0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "fakefs", "~> 0.11.3"
+end

data/lib/htot_conv.rb

@@ -1,20 +1,20 @@
-# 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
-
-  def convert(input, input_type, output, output_type, input_option={}, output_option={})
-    parser = HTOTConv::Parser.create(input_type, input_option)
-    outline = parser.parse(input)
-    generator = HTOTConv::Generator.create(output_type, outline, output_option)
-    generator.output(output)
-  end
-  module_function :convert
-
-end
+# 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
+
+  def convert(input, input_type, output, output_type, input_option={}, output_option={})
+    parser = HTOTConv::Parser.create(input_type, input_option)
+    outline = parser.parse(input)
+    generator = HTOTConv::Generator.create(output_type, outline, output_option)
+    generator.output(output)
+  end
+  module_function :convert
+
+end

data/lib/htot_conv/cli.rb

@@ -1,174 +1,174 @@
-# 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_reader :options, :from_options, :to_options
-
-      def freeze
-        @options.freeze
-        @from_options.freeze
-        @to_options.freeze
-        super
-      end
-
-      def define_options(opts, io_filter=false)
-        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:"
-        if io_filter
-          define_sub_options_of(opts, HTOTConv::Parser, @options[:from_type], "from") do |key, v|
-            @from_options[key] = v
-          end
-          define_sub_options_of(opts, HTOTConv::Generator, @options[:to_type], "to") do |key, v|
-            @to_options[key] = v
-          end
-        else
-          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
-      end
-
-      private
-      def add_sub_options_of_a_type_to!(cli_options, opts, klass, type, prefix) 
-        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 cli_options.include?(long_option)
-            cli_options[long_option][:desc] << "For #{type}, #{v[:desc]}"
-            unless cli_options[long_option][:pattern] == v[:pat]
-              if (cli_options[long_option][:pattern].kind_of?(Array) && v[:pat].kind_of?(Array))
-                cli_options[long_option][:pattern] = cli_options[long_option][:pattern].concat(v[:pat]).uniq
-              else
-                raise "pattern registration mismatch around #{long_option}"
-              end
-            end
-          else
-            cli_options[long_option] = {
-              :key => key,
-              :pattern => v[:pat],
-              :desc => ["For #{type}, #{v[:desc]}"],
-            }
-          end
-        end
-      end
-
-      private
-      def define_sub_options_of(opts, klass, type, prefix) # :yields: key, v
-        cli_options = {}
-        
-        add_sub_options_of_a_type_to!(cli_options, opts, klass, type, prefix)
-        
-        cli_options.each do |long_option, value|
-          opts.on("#{long_option}=VAL", value[:pattern], *value[:desc]) do |v|
-            yield value[:key], v
-          end
-        end
-      end
-
-      private
-      def define_sub_options(opts, klass, prefix) # :yields: key, v
-        cli_options = {}
-
-        klass.types.each do |type|
-          add_sub_options_of_a_type_to!(cli_options, opts, klass, type, prefix)
-        end
-
-        cli_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.dup)
-        rescue OptionParser::ParseError => ex
-          $stderr << ex.message << "\n"
-          exit 1
-        end
-      end
-
-      OptionParser.new do |opts|
-        script_opts.define_options(opts, true)
-
-        begin
-          opts.parse!(args)
-        rescue OptionParser::ParseError => ex
-          $stderr << ex.message << "\n"
-          exit 1
-        end
-      end
-      script_opts.freeze
-    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
+# 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_reader :options, :from_options, :to_options
+
+      def freeze
+        @options.freeze
+        @from_options.freeze
+        @to_options.freeze
+        super
+      end
+
+      def define_options(opts, io_filter=false)
+        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:"
+        if io_filter
+          define_sub_options_of(opts, HTOTConv::Parser, @options[:from_type], "from") do |key, v|
+            @from_options[key] = v
+          end
+          define_sub_options_of(opts, HTOTConv::Generator, @options[:to_type], "to") do |key, v|
+            @to_options[key] = v
+          end
+        else
+          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
+      end
+
+      private
+      def add_sub_options_of_a_type_to!(cli_options, opts, klass, type, prefix) 
+        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 cli_options.include?(long_option)
+            cli_options[long_option][:desc] << "For #{type}, #{v[:desc]}"
+            unless cli_options[long_option][:pattern] == v[:pat]
+              if (cli_options[long_option][:pattern].kind_of?(Array) && v[:pat].kind_of?(Array))
+                cli_options[long_option][:pattern] = cli_options[long_option][:pattern].concat(v[:pat]).uniq
+              else
+                raise "pattern registration mismatch around #{long_option}"
+              end
+            end
+          else
+            cli_options[long_option] = {
+              :key => key,
+              :pattern => v[:pat],
+              :desc => ["For #{type}, #{v[:desc]}"],
+            }
+          end
+        end
+      end
+
+      private
+      def define_sub_options_of(opts, klass, type, prefix) # :yields: key, v
+        cli_options = {}
+        
+        add_sub_options_of_a_type_to!(cli_options, opts, klass, type, prefix)
+        
+        cli_options.each do |long_option, value|
+          opts.on("#{long_option}=VAL", value[:pattern], *value[:desc]) do |v|
+            yield value[:key], v
+          end
+        end
+      end
+
+      private
+      def define_sub_options(opts, klass, prefix) # :yields: key, v
+        cli_options = {}
+
+        klass.types.each do |type|
+          add_sub_options_of_a_type_to!(cli_options, opts, klass, type, prefix)
+        end
+
+        cli_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.dup)
+        rescue OptionParser::ParseError => ex
+          $stderr << ex.message << "\n"
+          exit 1
+        end
+      end
+
+      OptionParser.new do |opts|
+        script_opts.define_options(opts, true)
+
+        begin
+          opts.parse!(args)
+        rescue OptionParser::ParseError => ex
+          $stderr << ex.message << "\n"
+          exit 1
+        end
+      end
+      script_opts.freeze
+    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