table_transform 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fb6bac3917263800ce0bf3ad130303f284d0370
-  data.tar.gz: a2944c579b7c1df767b8c91133268c8ecac2de25
+  metadata.gz: 2d6d8a8e87390799ac51635a6889032993ab424f
+  data.tar.gz: 118f7f5592a983ee5ff77cad1e7960d73e032de8
 SHA512:
-  metadata.gz: d409bbd7f233d8a24bfe2bb5f822579f9afa72fd94627b9d251918bbe7d329e91f7565690fdc3f1e78f42a88ef33db11a8711211db474006af1fffa1382a1626
-  data.tar.gz: 915eda6a4a62242e77d89b888fa8209fb027a5190755af78d811f1e2a0db3321ba24c595a6864d00d214c04745c0188630b6830a59a44572c0d07720f5621eb9
+  metadata.gz: 320bd9c7eccdcf26649d717c3f254e7fcaa39f6cd88f256e6b91355c0d5f631a85ad5fe4a107af90f40bc3a6c755e670ee3dceb53d83c98e0fb8ae4f0d4fb899
+  data.tar.gz: 574420f128ca4cfc4b54db2a6a7058f562c5201294db8954c0965fde1850d05021198761376c7d7e07eb5c36633a39ca885b01e09a8c6bafd50936351dc3648b

data/CHANGELOG.md

@@ -6,9 +6,18 @@ TableTransform is still in pre-release state. This means that its APIs and behav
 
 ## [Unreleased]
 
+## [0.2.0][] (2016-02-16)
+
+* Added ability to publish Tables in *Microsoft Excel* format
+
+Fixes:
+
+* Require at least non empty header row to be present in Table
+
 ## 0.1.0 (2016-02-10)
 
 * Initial release including Table
 
 [Semver]: http://semver.org
-[Unreleased]: https://github.com/jonas-lantto/table_transform/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/jonas-lantto/table_transform/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/jonas-lantto/table_transform/compare/v0.1.0...0.2.0

data/README.md

@@ -34,7 +34,7 @@ Or install it yourself as:
     data = [ %w(Name Age), %w(Jane 22)]
     t = TableTransform::Table.new(data)
 
-### Work with the table
+### Transform
     # Add a new column to the far right
     t.add_column('NameLength'){|row| row['Name'].size}
 
@@ -55,9 +55,22 @@ Or install it yourself as:
     t2 = TableTransform::Table::create_empty(%w(Col1 Col2))
     t3 = t1 + t2
     
+ 
+### Publish
     # Export as array
     t.to_a
-    
+
+    # Excel sheet
+    excel = TableTransform::ExcelCreator.new('output.xlsx')
+    excel.add_tab('Result', t)
+    excel.create!
+
+#### Excel Creator
+Will create an Excel Table on each tab. Name of the table will be the same as the sheet (except space replaced
+with _)
+
+Each column will be auto scaled to an approximate size based on column content.
+     
 ## Contributing
 
 Bug reports and pull requests are welcome on [GitHub](https://github.com/jonas-lantto/table_transform).

data/lib/table_transform/excel_creator.rb

@@ -0,0 +1,62 @@
+require 'write_xlsx'
+
+
+module TableTransform
+
+  # Creates excel file
+  class ExcelCreator
+    def initialize(filename)
+      @workbook = WriteXLSX.new(filename)
+    end
+
+    def create!
+      @workbook.close
+    end
+
+    def add_tab(name, table)
+      create_table(name, table.to_a)
+    end
+
+    #################################
+    private
+
+    # @return array with column width per column
+    def self.column_width(data, auto_filter_correct = true, max_width = 100)
+      return [] if data.empty?
+
+      auto_filter_size_correction = auto_filter_correct ? 3 : 0
+
+      res = Array.new(data.first.map { |x| x.to_s.size + auto_filter_size_correction })
+      data.each { |row|
+        row.each_with_index { |cell, column_no|
+          res[column_no] = [cell.to_s.size, res[column_no]].max
+        }
+      }
+      res.map! { |x| [x, max_width].min }
+    end
+
+    def create_table(name, data)
+      worksheet = @workbook.add_worksheet(name)
+      return if data.nil? or data.empty? # Create empty worksheet if no data
+
+      auto_filter = true
+      col_width = ExcelCreator::column_width(data, auto_filter)
+
+      header = data.shift
+      data << [nil] * header.count if data.empty? # Add extra row if empty
+
+      worksheet.add_table(
+          0, 0, data.count, header.count - 1,
+          {
+              :name => name.tr(' ', '_'),
+              :data => data,
+              :autofilter => auto_filter ? 1 : 0,
+              :columns => header.map { |v| {:header => v} }
+          }
+      )
+
+      # Set column width
+      col_width.each_with_index { |size, column| worksheet.set_column(column, column, size) }
+    end
+  end
+end

data/lib/table_transform/table.rb

@@ -24,16 +24,13 @@ module TableTransform
     # @throws if column names not unique
     # @throws if column size for each row match
     def initialize(rows)
+      raise 'Table required to have at least a header row' if (rows.nil? or rows.empty?)
       @data_rows = rows.clone
       @header = @data_rows.shift
       @column_indexes = create_column_name_binding(@header)
 
-      #validate header uniqueness
-      dup = @header.select{ |e| @header.count(e) > 1 }.uniq
-      raise "Column #{dup.map{|x| "'#{x}'"}.join(' and ')} not unique" if dup.size > 0
-
-      #validate column size
-      @data_rows.each_with_index {|x, index| raise "Column size mismatch. On row #{index+1}. Size #{x.size} expected to be #{@header.size}" if @header.size != x.size}
+      validate_header_uniqueness
+      validate_column_size
     end
 
     def << (hash_values)
@@ -105,6 +102,17 @@ module TableTransform
       self
     end
 
+    # @throws unless all header names are unique
+    private def validate_header_uniqueness
+      dup = @header.select{ |e| @header.count(e) > 1 }.uniq
+      raise "Column #{dup.map{|x| "'#{x}'"}.join(' and ')} not unique" if dup.size > 0
+    end
+
+    # @throws unless all rows have same number of elements
+    private def validate_column_size
+      @data_rows.each_with_index {|x, index| raise "Column size mismatch. On row #{index+1}. Size #{x.size} expected to be #{@header.size}" if @header.size != x.size}
+    end
+
     class Row
 
       def initialize(cols, row)

data/lib/table_transform/version.rb

@@ -1,3 +1,3 @@
 module TableTransform
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/table_transform.rb

@@ -1,3 +1,3 @@
 require 'table_transform/version'
 require 'table_transform/table'
-
+require 'table_transform/excel_creator'

data/table_transform.gemspec

@@ -19,7 +19,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'bundler',    '~> 1.10'
+  spec.add_development_dependency 'rake',       '~> 10.0'
+  spec.add_development_dependency 'minitest',   '~> 5.0'
+  spec.add_development_dependency 'write_xlsx', '~> 0.83'
+  spec.add_development_dependency 'roo',        '~> 2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_transform
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jonas Lantto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-10 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: write_xlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.83'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.83'
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: ''
 email:
 - j@lantto.net
@@ -71,6 +99,7 @@ files:
 - README.md
 - Rakefile
 - lib/table_transform.rb
+- lib/table_transform/excel_creator.rb
 - lib/table_transform/table.rb
 - lib/table_transform/version.rb
 - table_transform.gemspec