table_transform 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91c96009ab39b8d65825644044ebd64e75b85994
-  data.tar.gz: 7f6c16447953380214f627ce735bbe90bedcd1dd
+  metadata.gz: 9eeed52b5a7aa9db9eea7f0e0f27a40ff2b932be
+  data.tar.gz: bad8620c79b09929f105d54894b4df931a8b778b
 SHA512:
-  metadata.gz: 3cf48bcd2ed716bc0c0c2c00d43f8d6d2bd6165f790c75bfb20e496a2aa7afe223012f1a91495d0d77c36973c42c9f6ccfcb5620efc5e7f79a72ae57a1427bf3
-  data.tar.gz: f3e61219d7987ef67a8070cd6e11228c0ab138a7475d2890e20a12e2c03737bf0fca5522b44804ab21f22505d0ad805b40f951d672cf2853217ced602481764c
+  metadata.gz: 7837639dace38af311b85547f997b138812c3bba8d969a356936896f0b1a0be9e12ec22e7b86fbaa705f93a6efd55122d6a739339ad732a619965dfb6d058eaf
+  data.tar.gz: aa40106dd2c8e0c18129a60e50965a1e4e09eaf3d8305bb367aeab79166d6dc540636e9d0b771e9a4fb6f4e4c1c812593338a4309a2f10251a03f7f9d5b794a2

data/CHANGELOG.md

@@ -6,6 +6,11 @@ TableTransform is still in pre-release state. This means that its APIs and behav
 
 ## [Unreleased]
 
+## [0.4.0][] (2016-03-05)
+* Supports formulas in columns
+* Helper functions to create formulas
+* Column width estimates format size in calculation 
+
 ## [0.3.0][] (2016-02-29)
 * Added format capability for columns when published as Excel
 * CodeClimate and test coverage added
@@ -21,5 +26,6 @@ TableTransform is still in pre-release state. This means that its APIs and behav
 
 [Semver]: http://semver.org
 [Unreleased]: https://github.com/jonas-lantto/table_transform/compare/v0.3.0...HEAD
+[0.4.0]: https://github.com/jonas-lantto/table_transform/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/jonas-lantto/table_transform/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/jonas-lantto/table_transform/compare/v0.1.0...v0.2.0

data/README.md

@@ -86,6 +86,41 @@ A row can access its values by column name e.g. `row['Name']`
     # Add meta data during add_column
     t.add_column('Tax', {format: '0.0%'}){|row| 0.25}
     
+### Formula
+Formulas can be added to columns. They have to be in US locale. 
+Column values will be nil if inspected
+
+    # Add formula to column
+    t.add_column_formula('OnePlusOne', '1+1')
+
+    # Add formula to column with meta data
+    t.add_column_formula('OnePlusOne', '1+1' {format: '0.0'})
+
+#### Formula helper
+To aid when creating formulas there are a few helpers available
+    
+    f = TableTransform::FormulaHelper # Namespace alias
+    
+    # Column
+    f::column('price') # <=> [price]
+    t.add_column_formula('Total value', "#{f::column('price')}*f::column('volume')}")
+
+    # Table
+    f::table('Table1') # <=> Table1[]
+    
+    # Text (will avoid the clutter of protecting " character)
+    f::text('No') # <=> "No"
+    
+    # VLOOKUP, convenience function to extract values from another table
+    # Finds the street name in table Address for name specified in column Name
+    f::vlookup(f::column('Name'), 'Address', 'Street'))
+    f::vlookup('[Name]', 'Address', 'Street'))
+
+    # Finds the number of pets in Table Pets for name specified in column Name. If name does not exist it defaults to 0
+    f::vlookup(f::column('Name'), 'Pets', 'nPets', 0))
+    f::vlookup('[Name]', 'Pets', 'nPets', 0))
+
+
 ### Publish
     # Export as array
     t.to_a

data/lib/table_transform/excel_creator.rb

@@ -23,13 +23,22 @@ module TableTransform
     #################################
     private
 
+    # estimated column width of format
+    def self.format_column_size(format)
+      return 0 if format.nil?
+      f = format.gsub(/\[.*?\]/, '').split(';')
+      f.map{|x| x.size}.max
+    end
+
     # @return array with column width per column
-    def self.column_width(data, auto_filter_correct = true, max_width = 100)
-      return [] if data.empty?
+    def self.column_width(table, auto_filter_correct = true, max_width = 100)
+      return [] unless table.is_a? TableTransform::Table
+      data = table.to_a
 
       auto_filter_size_correction = auto_filter_correct ? 3 : 0
-
-      res = Array.new(data.first.map { |x| x.to_s.size + auto_filter_size_correction })
+      res = Array.new(data.first.map { |name|
+        [name.to_s.size + auto_filter_size_correction, format_column_size(table.metadata[name][:format])].max
+      })
       data.each { |row|
         row.each_with_index { |cell, column_no|
           res[column_no] = [cell.to_s.size, res[column_no]].max
@@ -45,11 +54,13 @@ module TableTransform
       }
     end
 
-    def create_column_metadata(metadata, formats)
+    def create_column_metadata(metadata, formats, formulas)
       res = []
       metadata.each{ |header_name, data|
         data_dup = data.dup
         data_dup[:format] = formats[data_dup[:format]] unless data_dup[:format].nil? #replace str format with excel representation
+        formula = formulas[header_name]
+        data_dup.merge!({formula: formula}) unless formula.nil?
         res << {header: header_name}.merge(data_dup)
       }
       res
@@ -61,7 +72,7 @@ module TableTransform
       return if data.nil? or data.empty? # Create empty worksheet if no data
 
       auto_filter = true
-      col_width = ExcelCreator::column_width(data, auto_filter)
+      col_width = ExcelCreator::column_width(table, auto_filter)
 
       header = data.shift
       data << [nil] * header.count if data.empty? # Add extra row if empty
@@ -72,7 +83,7 @@ module TableTransform
               :name => name.tr(' ', '_'),
               :data => data,
               :autofilter => auto_filter ? 1 : 0,
-              :columns => create_column_metadata(table.metadata, @formats)
+              :columns => create_column_metadata(table.metadata, @formats, table.formulas)
           }
       )
 

data/lib/table_transform/formula_helper.rb

@@ -0,0 +1,36 @@
+module TableTransform
+
+  # Help functions to create formulas
+  module FormulaHelper
+    # Reference a table
+    def self.table(name)
+      "#{name}[]"
+    end
+
+    # Reference a column in same table
+    def self.column(name)
+      "[#{name}]"
+    end
+
+    # Quotes text to be used inside formulas
+    def self.text(txt)
+      "\"#{txt}\""
+    end
+
+    # vlookup helper, search for a value in another table with return column specified by name
+    # Use other help functions to create an excel expression
+    #
+    # @param [excel expression] search_value, value to lookup
+    # @param [string]           table_name, name of the table to search in
+    # @param [string]           return_col_name, name of the return column in given table
+    # @param [excel expression] default, value if nothing was found, otherwise Excel will show N/A
+    def self.vlookup(search_value, table_name, return_col_name, default = nil)
+      vlookup = "VLOOKUP(#{search_value},#{table(table_name)},COLUMN(#{table_name}[[#Headers],#{column(return_col_name)}]),FALSE)"
+
+      # Workaround
+      # Should be possible to write "IFNA(#{vlookup},#{default})"
+      # but Excel will error with #Name? until formula is updated by hand
+      default.nil? ? vlookup : "IF(ISNA(#{vlookup}),#{default},#{vlookup})"
+    end
+  end
+end

data/lib/table_transform/table.rb

@@ -8,6 +8,8 @@ module TableTransform
   end
 
   class Table
+    attr_reader :formulas
+
     def self.create_from_file(file_name, sep = ',')
       rows = CSV.read(file_name, { :col_sep => sep })
       raise "'#{file_name}' contains no data" if rows.empty?
@@ -30,6 +32,7 @@ module TableTransform
       header = @data_rows.shift
       @column_indexes = create_column_name_binding(header)
       @metadata = header.zip( Array.new(header.size){{}} ).to_h
+      @formulas = {}
 
       validate_header_uniqueness(header)
       validate_column_size
@@ -50,6 +53,12 @@ module TableTransform
       @metadata.clone
     end
 
+    def add_column_formula(column, formula, metadata = {})
+      add_column(column, metadata){nil}
+      @formulas[column] = formula
+      self # self chaining
+    end
+
     def << (hash_values)
       @data_rows << create_row(hash_values)
       self
@@ -83,6 +92,7 @@ module TableTransform
       selected_cols = @column_indexes.values_at(*header)
       t = Table.new( @data_rows.inject([header]) {|res, row| (res << row.values_at(*selected_cols))} )
       t.metadata = t.metadata.keys.zip(@metadata.values_at(*header)).to_h
+      t.formulas = header.zip(@formulas.values_at(*header)).to_h
       t
     end
 
@@ -105,6 +115,7 @@ module TableTransform
     end
 
     def change_column(name)
+      raise "Column with formula('#{name}') cannot be changed" if @formulas[name]
       index = Util::get_col_index(name, @column_indexes)
       @data_rows.each{|r|
         r[index] = yield Row.new(@column_indexes, r)
@@ -115,7 +126,10 @@ module TableTransform
 
     def delete_column(*names)
       validate_column_names(*names)
-      names.each{|n| @metadata.delete(n)}
+      names.each{|n|
+        @metadata.delete(n)
+        @formulas.delete(n)
+      }
 
       selected_cols = @column_indexes.values_at(*@metadata.keys)
       @data_rows.map!{|row| row.values_at(*selected_cols)}
@@ -124,6 +138,8 @@ module TableTransform
       self
     end
 
+    # Table row
+    # Columns within row can be referenced by name, e.g. row['name']
     class Row
 
       def initialize(cols, row)
@@ -140,6 +156,7 @@ module TableTransform
 
     end
 
+    # Cell within Table::Row
     class Cell < String
       # @returns true if this cell includes any of the given values in list
       def include_any?(list)
@@ -149,6 +166,7 @@ module TableTransform
 
     protected
       attr_writer :metadata
+      attr_writer :formulas
 
     private
       def create_column_name_binding(header_row)

data/lib/table_transform/version.rb

@@ -1,3 +1,3 @@
 module TableTransform
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/table_transform.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_transform
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jonas Lantto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2016-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -101,6 +101,7 @@ files:
 - Rakefile
 - lib/table_transform.rb
 - lib/table_transform/excel_creator.rb
+- lib/table_transform/formula_helper.rb
 - lib/table_transform/table.rb
 - lib/table_transform/version.rb
 - table_transform.gemspec