htot_conv 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2aec83d272692c2e5e421fa83871202a6658f6f0
-  data.tar.gz: 2e36a66a3309075cb170a1e587e18d83fc3a1c97
+  metadata.gz: 5d55ad5f2d58f0e79c06559e63d2a8916b34aa31
+  data.tar.gz: c08cb89b3d16f61f9a529fd78eb69d4eda2979ae
 SHA512:
-  metadata.gz: aea65eb03fa27f1d475448e8bf560a387e36c564d8af92b6e68e99701569d10544496841458c840eff89e815ba2e3857140d0d7e1b43e932f6c5a3c616be53b9
-  data.tar.gz: fefabfb0d96991003bb55d53590fc26bbbc1c2a1947d5ba92a7188852ad8491408ff7f5b4399d3f179bbd8fb8b4e586139cc55a8576e8cdb9d3d538b270ce31e
+  metadata.gz: 3437bfd4648e1b5422a84ac848fd7271bb1b2f71b6a98080864af56e1dc4800a749cce2f30e1327c456ad1f802a855e27f16083d9e0a56215b5ae26e13ca8b3c
+  data.tar.gz: 1147a7ad351c344f6b1e53cdb5e5330ae23a24ffe5e6b8b94f1e2eb718c4bf5c6481ba739920f17f2a78edefad6bd84de0bbf1a593bf0f56b2d291da2db2ed9f

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 TODO: Write your name
+Copyright (c) 2017 cat_in_136
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -38,11 +38,20 @@ Install `htot_conv` via RubyGems. Simply run the following command to install:
    * `<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:
@@ -88,8 +97,6 @@ Not implemented (TODO):
 
 #### `xlsx_type3`
 
-Not supported (implemented) as of now.
-
 | H1 | H(1) |        |          | H(2)     | 
 |----|------|--------|----------|----------| 
 | 1  | 1(1) |        |          | 1(2)     | 
@@ -97,7 +104,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 row span.
+TODO: Github Flavored Markdown does not support the column span.
 So, this document does not correctly represent type-3 xlsx spread sheet.
 
 #### `xlsx_type4`

data/htot_conv.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   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/generator/base.rb

@@ -3,9 +3,9 @@ module HTOTConv
   module Generator
     class Base
       def initialize(data, option={})
+        data.validate
         @data = data
         @option = self.class.option_help.inject({}) { |h, pair| h[pair[0]] = pair[1][:default]; h}.merge(option)
-        raise ArgumentError, "data is invalid" unless data.valid?
       end
       def self.option_help
         {}

data/lib/htot_conv/generator/xlsx_type0.rb

@@ -9,7 +9,7 @@ module HTOTConv
       def output_to_worksheet(ws)
         max_value_length = @data.max_value_length
 
-        ws.add_row([@data.key_header[0], 'Level'].concat(
+        ws.add_row([@data.key_header[0], 'Outline Level'].concat(
           HTOTConv::Util.pad_array(@data.value_header, max_value_length)),
         :style => Axlsx::STYLE_THIN_BORDER)
 

data/lib/htot_conv/generator/xlsx_type1.rb

@@ -7,6 +7,16 @@ require 'htot_conv/generator/base'
 module HTOTConv
   module Generator
     class XlsxType1 < XlsxBase
+      def self.option_help
+        {
+          :outline_rows => {
+            :default => false,
+            :pat => FalseClass,
+            :desc => "group rows (default: no)",
+          },
+        }
+      end
+
       def output_to_worksheet(ws)
         max_value_length = @data.max_value_length
 
@@ -19,6 +29,39 @@ module HTOTConv
             HTOTConv::Util.pad_array(item.value, max_value_length)),
           :style => Axlsx::STYLE_THIN_BORDER)
         end
+
+        if @option[:outline_rows]
+          max_level = @data.max_level
+          outline_begin = Array.new(max_level, nil)
+          dummy_end_item = HTOTConv::Outline::Item.new(nil, 1, nil)
+          @data.item.concat([dummy_end_item]).each_with_index do |item, item_index|
+            (item.level..max_level).each do |level|
+              if outline_begin[level - 1]
+                if outline_begin[level - 1] < item_index - 1
+                  ws.outline_level_rows((outline_begin[level - 1] + 1) + 1, (item_index - 1) + 1, level, false)
+                end
+                outline_begin[level - 1] = nil
+              end
+            end
+            outline_begin[item.level - 1] = item_index
+          end
+
+          # PR randym/axlsx#440 has been added to master branch
+          # https://github.com/randym/axlsx/commit/c80c8b9d9be5542471d66afcc2ce4ddd80cac1f7
+          # but latest release on rubygems does not contain this.
+          # So apply monkey patch to ws.sheet_pr.
+          if defined? ws.sheet_pr.outline_pr
+            ws.sheet_pr.outline_pr.summary_below = false
+          else
+            class << ws.sheet_pr # monkey patch
+              def to_xml_string(str="".dup)
+                tmp_str = "".dup
+                super(tmp_str)
+                str << tmp_str.sub('<pageSetUpPr', '<outlinePr summaryBelow="0" /><pageSetUpPr')
+              end
+            end
+          end
+        end
       end
     end
   end

data/lib/htot_conv/generator/xlsx_type2.rb

@@ -13,6 +13,11 @@ module HTOTConv
             :pat => [:colspan, :rowspan],
             :desc => "integrate key cells (specify 'colspan' or 'rowspan')",
           },
+          :outline_rows => {
+            :default => false,
+            :pat => FalseClass,
+            :desc => "group rows (default: no)",
+          },
         }
       end
 
@@ -43,6 +48,38 @@ module HTOTConv
           end
         end
 
+        if @option[:outline_rows]
+          outline_begin = Array.new(max_level, nil)
+          dummy_end_item = HTOTConv::Outline::Item.new(nil, 1, nil)
+          @data.item.concat([dummy_end_item]).each_with_index do |item, item_index|
+            (item.level..max_level).each do |level|
+              if outline_begin[level - 1]
+                if outline_begin[level - 1] < item_index - 1
+                  ws.outline_level_rows((outline_begin[level - 1] + 1) + 1, (item_index - 1) + 1, level, false)
+                end
+                outline_begin[level - 1] = nil
+              end
+            end
+            outline_begin[item.level - 1] = item_index
+          end
+
+          # PR randym/axlsx#440 has been added to master branch
+          # https://github.com/randym/axlsx/commit/c80c8b9d9be5542471d66afcc2ce4ddd80cac1f7
+          # but latest release on rubygems does not contain this.
+          # So apply monkey patch to ws.sheet_pr.
+          if defined? ws.sheet_pr.outline_pr
+            ws.sheet_pr.outline_pr.summary_below = false
+          else
+            class << ws.sheet_pr # monkey patch
+              def to_xml_string(str="".dup)
+                tmp_str = "".dup
+                super(tmp_str)
+                str << tmp_str.sub('<pageSetUpPr', '<outlinePr summaryBelow="0" /><pageSetUpPr')
+              end
+            end
+          end
+        end
+
         case @option[:integrate_cells]
         when :colspan
           @data.item.each_with_index do |item, item_index|

data/lib/htot_conv/generator/xlsx_type3.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+require 'axlsx'
+
+require 'htot_conv/generator/base'
+
+module HTOTConv
+  module Generator
+    class XlsxType3 < XlsxBase
+      def self.option_help
+        {
+          :integrate_cells => {
+            :default => nil,
+            :pat => [:colspan, :rowspan, :both],
+            :desc => "integrate key cells (specify 'colspan', 'rowspan' or 'both')",
+          },
+        }
+      end
+
+      def output_to_worksheet(ws)
+        max_level = @data.max_level
+        max_value_length = @data.max_value_length
+
+        ws.add_row([
+          @data.key_header[0],
+          *(HTOTConv::Util.pad_array([@data.value_header[0]], max_level)),
+          *((@data.value_header.length <= 1)? [] : @data.value_header.last(@data.value_header.length - 1)),
+        ], :style => Axlsx::STYLE_THIN_BORDER)
+        1.upto(max_level) do |col_idx|
+          edges = [:top, :bottom]
+          edges << :left if (col_idx <= 1)
+          edges << :right if (col_idx >= max_level)
+          ws.rows.last.cells[col_idx].style = ws.styles.add_style(
+            :border => { :style => :thin, :color => "00", :edges => edges })
+        end
+
+        @data.item.each_with_index do |item, item_index|
+          key_value_cell = Array.new(max_level + 1, nil)
+          key_value_cell[item.level - 1] = item.key
+          key_value_cell[item.level    ] = item.value[0]
+          rest_value_cell = (item.value.length <= 1)? [] :
+            HTOTConv::Util.pad_array(item.value.last(item.value.length - 1), max_value_length - 1)
+
+          ws.add_row(key_value_cell.concat(rest_value_cell),
+                     :style => Axlsx::STYLE_THIN_BORDER)
+
+          0.upto(max_level) do |col_idx|
+            edges = []
+
+            edges << :left if (col_idx <= item.level)
+            edges << :right if ((col_idx < item.level) || (col_idx >= max_level))
+            edges << :top if ((col_idx > (item.level - 2)) || (item_index == 0))
+            edges << :bottom if ((col_idx > (item.level - 1)) || (item_index == @data.item.length - 1))
+            ws.rows.last.cells[col_idx].style = ws.styles.add_style(
+              :border => { :style => :thin, :color => "00", :edges => edges })
+          end
+        end
+
+        if [:colspan, :both].include?(@option[:integrate_cells])
+          if max_level > 1
+            ws.merge_cells(ws.rows[0].cells[1..(max_level)])
+          end
+          @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..max_level)])
+            end
+          end
+        end
+        if [:rowspan, :both].include?(@option[:integrate_cells])
+          @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
+end

data/lib/htot_conv/generator/xlsx_type4.rb

@@ -11,7 +11,7 @@ module HTOTConv
           :integrate_cells => {
             :default => nil,
             :pat => [:colspan, :rowspan, :both],
-            :desc => "integrate key cells (specify 'colspan', 'rowspan' or 'all')",
+            :desc => "integrate key cells (specify 'colspan', 'rowspan' or 'both')",
           },
         }
       end

data/lib/htot_conv/generator.rb

@@ -2,6 +2,7 @@
 require 'htot_conv/generator/xlsx_type0.rb'
 require 'htot_conv/generator/xlsx_type1.rb'
 require 'htot_conv/generator/xlsx_type2.rb'
+require 'htot_conv/generator/xlsx_type3.rb'
 require 'htot_conv/generator/xlsx_type4.rb'
 require 'htot_conv/generator/xlsx_type5.rb'
 

data/lib/htot_conv/outline.rb

@@ -13,13 +13,22 @@ module HTOTConv
       @item << Item.new(*args)
     end
 
+    def validate
+      raise ValidationError, "key_header must be an array" unless @key_header.kind_of?(Array)
+      raise ValidationError, "key_header elements must be strings." unless @key_header.all? { |v| v.nil? || v.kind_of?(String) }
+      raise ValidationError, "value_header must be an array" unless @value_header.kind_of?(Array)
+      raise ValidationError, "value_header elements must be strings." unless @value_header.all? { |v| v.nil? || v.kind_of?(String) }
+      raise ValidationError, "item must be an array" unless @item.kind_of?(Array)
+      @item.each { |item| item.validate }
+    end
+
     def valid?
-      @key_header.kind_of?(Array) &&
-        @key_header.all? { |v| v.nil? || v.kind_of?(String) } &&
-        @value_header.kind_of?(Array) &&
-        @value_header.all? { |v| v.nil? || v.kind_of?(String) } &&
-        @item.kind_of?(Array) &&
-        @item.all? { |item| item.valid? }
+      begin
+        validate
+        true
+      rescue ValidationError
+        false
+      end
     end
 
     def max_level
@@ -62,12 +71,24 @@ module HTOTConv
       root
     end
 
+    class ValidationError < RuntimeError
+    end
+
     Item = Struct.new(:key, :level, :value) do
+      def validate
+        raise ValidationError, "item level for item \"#{key}\" must be an integer" unless self.level.kind_of?(Numeric)
+        raise ValidationError, "item level for item \"#{key}\" must be positive" unless self.level > 0
+        raise ValidationError, "item level for item \"#{key}\" must be an integer" unless (self.level.to_i == self.level)
+        raise ValidationError, "value for item \"#{key}\" must be an array" unless self.value.kind_of?(Array)
+      end
+
       def valid?
-        self.level.kind_of?(Numeric) &&
-          (self.level > 0) &&
-          (self.level.to_i == self.level) &&
-          self.value.kind_of?(Array)
+        begin
+          validate
+          true
+        rescue ValidationError
+          false
+        end
       end
     end
 

data/lib/htot_conv/parser/dir_tree.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require 'htot_conv/parser/base'
+
+module HTOTConv
+  module Parser
+    class DirTree < Base
+      def self.option_help
+        {
+          :glob_pattern => {
+            :default => "**/*",
+            :pat => String,
+            :desc => "globbing pattern (default: \"**/*\")",
+          },
+        }
+      end
+
+      def parse(input=Dir.pwd)
+        outline = HTOTConv::Outline.new
+        outline.key_header = []
+        outline.value_header = []
+
+        outline_item = Set.new
+        Dir.chdir(input) do
+          Dir.glob(@option[:glob_pattern]).each do |f|
+            f.split(File::SEPARATOR).inject(nil) do |parent_path, v|
+              file_path = (parent_path)? File.join(parent_path, v) : v
+              outline_item << file_path
+              file_path
+            end
+          end
+        end
+
+        outline_item.sort.each do |file_path|
+          key = File.basename(file_path)
+          level = file_path.split(File::SEPARATOR).length
+          outline.add_item(key, level, [])
+        end
+
+        outline
+      end
+    end
+  end
+end

data/lib/htot_conv/parser/opml.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require 'htot_conv/parser/base'
+
+module HTOTConv
+  module Parser
+    class Opml < Base
+      def parse(input)
+        outline = HTOTConv::Outline.new
+        outline.key_header = []
+        outline.value_header = []
+
+        parser = Nokogiri::XML::SAX::Parser.new(ListDoc.new(outline))
+        parser.parse(input)
+
+        outline
+      end
+
+      class ListDoc < Nokogiri::XML::SAX::Document
+        def initialize(outline)
+          @outline = outline
+          @breadcrumb = []
+        end
+
+        def start_element(name, attrs=[])
+          if (name == "outline")
+            @breadcrumb << name
+            generate_outline_item(attrs)
+          end
+        end
+
+        def end_element(name)
+          @breadcrumb.pop if (name == "outline")
+        end
+
+        private
+        def generate_outline_item(attrs)
+          text = ""
+          level = @breadcrumb.length
+          values = []
+          attrs.each do |pair|
+            attr_name, attr_val = pair
+            if attr_name == "text"
+              text = attr_val
+            else
+              unless @outline.value_header.include?(attr_name)
+                @outline.value_header << attr_name 
+                values[@outline.value_header.length - 1] = attr_val
+              else
+                values[@outline.value_header.index(attr_name)] = attr_val
+              end
+            end
+          end
+
+          @outline.add_item(text, level, values)
+        end
+      end
+
+    end
+  end
+end

data/lib/htot_conv/parser/simple_text.rb

@@ -30,20 +30,20 @@ module HTOTConv
       end
 
       def parse(input)
-        indent_regexp = Regexp.new("^(?<indents>(#{Regexp.escape(option[:indent])})*)")
-        delimiter_regexp = (option[:delimiter].kind_of?(String))? Regexp.new(Regexp.escape(option[:delimiter])) : option[:delimiter]
+        indent_regexp = Regexp.new("^(?<indents>(#{Regexp.escape(@option[:indent])})*)")
+        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 = option[:value_header]
+        outline.value_header = @option[:value_header]
 
         input.each_line do |line|
-          next if ((line.chomp == "") && (!option[:preserve_empty_line]))
+          next if ((line.chomp == "") && (!@option[:preserve_empty_line]))
 
           level = 1
           value = []
-          if (option[:indent] || '').length > 0
+          if (@option[:indent] || '').length > 0
             indents = indent_regexp.match(line)[:indents]
-            level = 1 + indents.length / option[:indent].length
+            level = 1 + indents.length / @option[:indent].length
             line = line.sub(indent_regexp, "")
           end
 

data/lib/htot_conv/parser.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 require 'htot_conv/parser/base.rb'
 require 'htot_conv/parser/simple_text.rb'
+require 'htot_conv/parser/dir_tree.rb'
 require 'htot_conv/parser/html_list.rb'
+require 'htot_conv/parser/opml.rb'
 
 module HTOTConv
   module Parser

data/lib/htot_conv/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: htot_conv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - "@cat_in_136"
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-01 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: axlsx
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
 description: Convert from a simple hierarchical-tree outline text into ugly xlsx file
 email:
 - cat.in.136+github@gmail.com
@@ -105,12 +119,15 @@ files:
 - lib/htot_conv/generator/xlsx_type0.rb
 - lib/htot_conv/generator/xlsx_type1.rb
 - lib/htot_conv/generator/xlsx_type2.rb
+- lib/htot_conv/generator/xlsx_type3.rb
 - lib/htot_conv/generator/xlsx_type4.rb
 - lib/htot_conv/generator/xlsx_type5.rb
 - lib/htot_conv/outline.rb
 - lib/htot_conv/parser.rb
 - lib/htot_conv/parser/base.rb
+- lib/htot_conv/parser/dir_tree.rb
 - lib/htot_conv/parser/html_list.rb
+- lib/htot_conv/parser/opml.rb
 - lib/htot_conv/parser/simple_text.rb
 - lib/htot_conv/util.rb
 - lib/htot_conv/version.rb