table_transform 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18bd452f05254c417d3deb30c03d61c9595d3494
-  data.tar.gz: d998ab542023204734aca739c5caf91538307e91
+  metadata.gz: 49ec7d69f22f2697f744cbfde782c2d5bdf176ec
+  data.tar.gz: 9528fc0373c003fb1be323e00cea5718328e4a9e
 SHA512:
-  metadata.gz: fb3c761f20419bccf2a954c05ee50b0baf01886bc87df0808071cf44147e6c8050bee7b8d0613b058a7f152dbe8ce6e02b4cd74ac08164e0dff3590028060bad
-  data.tar.gz: 55bf3224205284a9b32904fa7f5d507be845878bd4eaf0f983a17e26456d6cccb24f1420a7df697866223b2df2964150404285e1db6497efe7904464172bcc1c
+  metadata.gz: d4001db9c5ccb63aedf406320d0e5accec5b8f788a247dc75f6981a1dbbdf205d29d56667bee5d0575302635177cba0b47beb863f6c44f57977fb9dd9762a2fc
+  data.tar.gz: 0e1697d357bcb66f417102b049d02bdd0d6ceb68d8fe1d4f60112d0a5c01746f9bba1a8c9edcd8dd1d71ef690fbd34cf206850020fabb5d0cd242dcae1834e55

data/CHANGELOG.md

@@ -6,6 +6,11 @@ TableTransform is still in pre-release state. This means that its APIs and behav
 
 ## [Unreleased]
 
+## [0.6.0][] (2016-03-20)
+* Added rename table column
+* Harmonization of how to work with properties, Table and Column
+* Deprecated old metadata functions (to be removed)
+    
 ## [0.5.0][] (2016-03-13)
 * Table properties added
 
@@ -28,8 +33,9 @@ TableTransform is still in pre-release state. This means that its APIs and behav
 * Initial release including Table
 
 [Semver]: http://semver.org
-[Unreleased]: https://github.com/jonas-lantto/table_transform/compare/v0.5.0...HEAD
-[0.4.0]: https://github.com/jonas-lantto/table_transform/compare/v0.4.0...v0.5.0
+[Unreleased]: https://github.com/jonas-lantto/table_transform/compare/v0.6.0...HEAD
+[0.6.0]: https://github.com/jonas-lantto/table_transform/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/jonas-lantto/table_transform/compare/v0.4.0...v0.5.0
 [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

@@ -46,6 +46,9 @@ Or install it yourself as:
     # Will remove given columns. One or several can be specified.
     t.delete_column('Name', 'Address')
     
+    # Rename column
+    r.rename_column('Age', 'Years')
+    
     # Create a new Table with given column in specified order
     t.extract(%w(Length Name))
     
@@ -73,22 +76,38 @@ A row can access its values by column name e.g. `row['Name']`
     c = row['Col1']                # c = 'CHECK'
     c.include_any?(%w(AA EC DD)))  # true
 
-### Table properties
+### Properties
+There are two categories of properties, Table and Column<br/>
+Same interface for interacting with properties
+    
+    # Update - add or update :name property in existing p
+    p.update({name: 'xxx'})
+    
+    # Reset - resets p with given property, clearing previous properties 
+    p.reset({name: 'xxx'})
+    
+    # Delete
+    p.delete(:name)
+    
+    # Each
+    p.each{|x| ...}
+    
+    # Access
+    p[:name]
+    
+#### Table properties
     # Set table name - override default name
     t.table_properties.update({name: 'Table1'})
     
     # Set turn on/off auto filter button
     t.table_properties.update({auto_filter: false})
 
-### Meta data    
+#### Column properties   
     # Set format for one column
-    t.set_metadata('Tax', {format: '0.0%'})
+    t.column_properties['Tax'].update({format: '0.0%'})
  
-    # Extract metadata
-    t.metadata['Tax'] # {format: '0.0%'}
-
-    # Set format for multiple columns
-    t.set_metadata(*%w(Income Tax Dept), {format: '#,##0'})
+    # Extract properties
+    t.column_properties['Tax'] # {format: '0.0%'}
     
     # Add meta data during add_column
     t.add_column('Tax', {format: '0.0%'}){|row| 0.25}

data/lib/table_transform/excel_creator.rb

@@ -16,7 +16,7 @@ module TableTransform
     end
 
     def add_tab(name, table)
-      set_formats(table.metadata) if table.is_a?(TableTransform::Table)
+      set_formats(table.column_properties) if table.is_a?(TableTransform::Table)
       create_table(name, table)
     end
 
@@ -46,7 +46,7 @@ module TableTransform
 
       auto_filter_size_correction = auto_filter_correct ? 3 : 0
       res = Array.new(data.first.map { |name|
-        [name.to_s.size + auto_filter_size_correction, format_column_size(table.metadata[name][:format])].max
+        [name.to_s.size + auto_filter_size_correction, format_column_size(table.column_properties[name][:format])].max
       })
       data.each { |row|
         row.each_with_index { |cell, column_no|
@@ -56,21 +56,29 @@ module TableTransform
       res.map! { |x| [x, max_width].min }
     end
 
-    def set_formats(metadata)
-      metadata.each{|_,v|
+    def set_formats(column_properties)
+      # find all :formats across all columns
+      column_properties.each{|_,v|
         f = v[:format]
         @formats[f] ||= @workbook.add_format(:num_format => f) unless f.nil?
       }
     end
 
-    def create_column_metadata(metadata, formats, formulas)
+    def create_column_metadata(column_properties, 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
+      column_properties.each{ |header_name, data|
+        col_props = TableTransform::Properties.new data.to_h
+
+        #format (replace str format with excel representation)
+        col_props.update({format: formats[col_props[:format]]}) unless col_props[:format].nil?
+
+        #formula
         formula = formulas[header_name]
-        data_dup.merge!({formula: formula}) unless formula.nil?
-        res << {header: header_name}.merge(data_dup)
+        col_props.update({formula: formula}) unless formula.nil?
+
+        #header
+        col_props.update({header: header_name})
+        res << col_props.to_h
       }
       res
     end
@@ -80,8 +88,8 @@ module TableTransform
       data = table.to_a
       return if data.nil? or data.empty? # Create empty worksheet if no data
 
-      properties = ExcelCreator::default_properties(name).update(table.table_properties.to_h)
-      col_width = ExcelCreator::column_width(table, properties[:auto_filter])
+      table_properties = ExcelCreator::default_properties(name).update(table.table_properties.to_h)
+      col_width = ExcelCreator::column_width(table, table_properties[:auto_filter])
 
       header = data.shift
       data << [nil] * header.count if data.empty? # Add extra row if empty
@@ -89,10 +97,10 @@ module TableTransform
       worksheet.add_table(
           0, 0, data.count, header.count - 1,
           {
-              :name => properties[:name],
+              :name => table_properties[:name],
               :data => data,
-              :autofilter => properties[:auto_filter] ? 1 : 0,
-              :columns => create_column_metadata(table.metadata, @formats, table.formulas)
+              :autofilter => table_properties[:auto_filter] ? 1 : 0,
+              :columns => create_column_metadata(table.column_properties, @formats, table.formulas)
           }
       )
 

data/lib/table_transform/properties.rb

@@ -1,10 +1,14 @@
+require 'forwardable'
 
 module TableTransform
 
   class Properties
+    extend Forwardable
+    def_delegators :@props, :delete, :each, :[]
+
     def initialize(init_properties = {})
       validate(init_properties)
-      @props = init_properties
+      @props = init_properties.clone
     end
 
     def validate(properties)
@@ -20,18 +24,11 @@ module TableTransform
       @props.merge! properties
     end
 
-    def delete(prop_key)
-      @props.delete(prop_key)
-    end
-
     def reset(properties)
       validate(properties)
       @props = properties
     end
 
-    def [](prop_key)
-      raise "Property '#{prop_key}' does not exist" unless @props.include? prop_key
-      @props[prop_key]
-    end
   end
+
 end

data/lib/table_transform/table.rb

@@ -11,6 +11,7 @@ module TableTransform
   class Table
     attr_reader :formulas
     attr_reader :table_properties
+    attr_reader :column_properties
 
     def self.create_from_file(file_name, sep = ',')
       rows = CSV.read(file_name, { :col_sep => sep })
@@ -33,9 +34,10 @@ module TableTransform
       @data_rows = rows.clone
       header = @data_rows.shift
       @column_indexes = create_column_name_binding(header)
-      @metadata = header.zip( Array.new(header.size){{}} ).to_h
       @formulas = {}
       @table_properties = TableProperties.new(table_properties)
+      @column_properties = Hash.new{|hash, key| raise "No column with name '#{key}' exists"}
+      create_column_properties(*header,{})
 
       validate_header_uniqueness(header)
       validate_column_size
@@ -45,19 +47,22 @@ module TableTransform
     # Example:
     #  set_metadata('Col1', {format: '#,##0'})
     def set_metadata(*columns, metadata)
-      validate_column_names(*columns)
-      validate_metadata_tags(metadata)
-
-      columns.each{|col| @metadata[col] = metadata.clone}
+      warn 'set_metadata is deprecated. Use column_properties[] instead'
+      columns.each{|c| @column_properties[c].reset(metadata)}
     end
 
     # Returns meta data as Hash with header name as key
     def metadata
-      @metadata.clone
+      warn 'metadata is deprecated. Use column_properties[] instead'
+      res = Hash.new
+      @column_properties.each{|k, v|
+        res.merge! ({k => v.to_h})
+      }
+      res
     end
 
-    def add_column_formula(column, formula, metadata = {})
-      add_column(column, metadata){nil}
+    def add_column_formula(column, formula, column_properties = {})
+      add_column(column, column_properties){nil}
       @formulas[column] = formula
       self # self chaining
     end
@@ -68,12 +73,12 @@ module TableTransform
     end
 
     # Add two tables
-    # @throws if header or meta data do not match
+    # @throws if header or properties do not match
     def +(table)
       t2 = table.to_a
       t2_header = t2.shift
-      raise 'Tables cannot be added due to header mismatch' unless @metadata.keys == t2_header
-      raise 'Tables cannot be added due to meta data mismatch' unless @metadata == table.metadata
+      raise 'Tables cannot be added due to header mismatch' unless @column_properties.keys == t2_header
+      raise 'Tables cannot be added due to column properties mismatch' unless column_properties_eql? table.column_properties
       raise 'Tables cannot be added due to table properties mismatch' unless @table_properties.to_h == table.table_properties.to_h
       TableTransform::Table.new(self.to_a + t2)
     end
@@ -87,34 +92,33 @@ module TableTransform
     # @returns array of data arrays including header row
     def to_a
       res = @data_rows.clone
-      res.unshift @metadata.keys.clone
+      res.unshift @column_properties.keys.clone
     end
 
     # @returns new table with specified columns specified in given header
     def extract(header)
-      validate_column_names(*header)
+      validate_column_exist(*header)
       selected_cols = @column_indexes.values_at(*header)
       t = Table.new( @data_rows.inject([header]) {|res, row| (res << row.values_at(*selected_cols))}, @table_properties.to_h )
-      t.metadata = t.metadata.keys.zip(@metadata.values_at(*header)).to_h
+      header.each{|h| t.column_properties[h].reset(@column_properties[h].to_h)}
       t.formulas = header.zip(@formulas.values_at(*header)).to_h
       t
     end
 
     # @returns new table with rows that match given block
     def filter
-      Table.new( (@data_rows.select {|row| yield Row.new(@column_indexes, row)}.unshift @metadata.keys.clone), @table_properties.to_h )
+      Table.new( (@data_rows.select {|row| yield Row.new(@column_indexes, row)}.unshift @column_properties.keys.clone), @table_properties.to_h )
     end
 
     #adds a column with given name to the far right of the table
     #@throws if given column name already exists
-    def add_column(name, metadata = {})
-      raise "Column '#{name}' already exists" if @metadata.keys.include?(name)
-      @metadata[name] = {}
+    def add_column(name, column_properties = {})
+      validate_column_absence(name)
+      create_column_properties(name, column_properties)
       @data_rows.each{|x|
         x << (yield Row.new(@column_indexes, x))
       }
       @column_indexes[name] = @column_indexes.size
-      set_metadata(name, metadata)
       self # enable chaining
     end
 
@@ -129,19 +133,28 @@ module TableTransform
     end
 
     def delete_column(*names)
-      validate_column_names(*names)
+      validate_column_exist(*names)
       names.each{|n|
-        @metadata.delete(n)
+        @column_properties.delete(n)
         @formulas.delete(n)
       }
 
-      selected_cols = @column_indexes.values_at(*@metadata.keys)
+      selected_cols = @column_indexes.values_at(*@column_properties.keys)
       @data_rows.map!{|row| row.values_at(*selected_cols)}
 
-      @column_indexes = create_column_name_binding(@metadata.keys)
+      @column_indexes = create_column_name_binding(@column_properties.keys)
       self
     end
 
+    def rename_column(from, to)
+      validate_column_exist(from)
+      validate_column_absence(to)
+
+      @column_properties = @column_properties.map{|k,v| [k == from ? to : k, v] }.to_h
+      @formulas = @formulas.map{|k,v| [k == from ? to : k, v] }.to_h
+      @column_indexes = create_column_name_binding(@column_properties.keys)
+    end
+
     # Table row
     # Columns within row can be referenced by name, e.g. row['name']
     class Row
@@ -185,9 +198,23 @@ module TableTransform
       end
     end
 
+    # Column properties
+    class ColumnProperties < TableTransform::Properties
+      def validate(properties)
+        super
+        properties.each { |k, v|
+          case k
+            when :format
+              raise "Column property 'format' expected to be a non-empty string" unless v.is_a?(String) && !v.empty?
+            else
+              raise "Unknown column property '#{k}'"
+          end
+        }
+      end
+    end
+
 
     protected
-      attr_writer :metadata
       attr_writer :formulas
 
     private
@@ -196,7 +223,16 @@ module TableTransform
       end
 
       def create_row(hash_values)
-        @metadata.keys.inject([]) { |row, col| row << hash_values.fetch(col){raise "Value for column '#{col}' could not be found"} }
+        @column_properties.keys.inject([]) { |row, col| row << hash_values.fetch(col){raise "Value for column '#{col}' could not be found"} }
+      end
+
+      def create_column_properties(*header, properties)
+        header.each{|key| @column_properties.store(key, TableTransform::Table::ColumnProperties.new(properties))}
+      end
+
+      def column_properties_eql?(column_properties)
+          return false unless @column_properties.size == column_properties.size
+          @column_properties.each{|key, prop| return false unless prop.to_h == column_properties[key].to_h}
       end
 
       # @throws unless all header names are unique
@@ -207,24 +243,17 @@ module TableTransform
 
       # @throws unless all rows have same number of elements
       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 #{@metadata.size}" if @metadata.size != x.size}
+        @data_rows.each_with_index {|x, index| raise "Column size mismatch. On row #{index+1}. Size #{x.size} expected to be #{@column_properties.size}" if @column_properties.size != x.size}
       end
 
-      def validate_column_names(*names)
-        diff = names - @metadata.keys
+      def validate_column_exist(*names)
+        diff = names - @column_properties.keys
         raise raise "No column with name '#{diff.first}' exists" if diff.size > 0
       end
 
-      def validate_metadata_tags(metadata)
-        raise 'Metadata must be a hash' unless metadata.is_a?(Hash)
-        metadata.each { |k, v|
-          case k
-            when :format
-              raise "Meta tag 'format' expected to be a non-empty string" unless v.is_a?(String) && !v.empty?
-            else
-              raise "Unknown meta data tag '#{k}'"
-          end
-        }
+      def validate_column_absence(name)
+        raise "Column '#{name}' already exists" if @column_properties.keys.include?(name)
       end
+
   end
 end

data/lib/table_transform/version.rb

@@ -1,3 +1,3 @@
 module TableTransform
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_transform
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jonas Lantto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-13 00:00:00.000000000 Z
+date: 2016-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake