table_transform 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d6d8a8e87390799ac51635a6889032993ab424f
-  data.tar.gz: 118f7f5592a983ee5ff77cad1e7960d73e032de8
+  metadata.gz: 91c96009ab39b8d65825644044ebd64e75b85994
+  data.tar.gz: 7f6c16447953380214f627ce735bbe90bedcd1dd
 SHA512:
-  metadata.gz: 320bd9c7eccdcf26649d717c3f254e7fcaa39f6cd88f256e6b91355c0d5f631a85ad5fe4a107af90f40bc3a6c755e670ee3dceb53d83c98e0fb8ae4f0d4fb899
-  data.tar.gz: 574420f128ca4cfc4b54db2a6a7058f562c5201294db8954c0965fde1850d05021198761376c7d7e07eb5c36633a39ca885b01e09a8c6bafd50936351dc3648b
+  metadata.gz: 3cf48bcd2ed716bc0c0c2c00d43f8d6d2bd6165f790c75bfb20e496a2aa7afe223012f1a91495d0d77c36973c42c9f6ccfcb5620efc5e7f79a72ae57a1427bf3
+  data.tar.gz: f3e61219d7987ef67a8070cd6e11228c0ab138a7475d2890e20a12e2c03737bf0fca5522b44804ab21f22505d0ad805b40f951d672cf2853217ced602481764c

data/.travis.yml

@@ -1,3 +1,8 @@
 language: ruby
 rvm:
-  - 2.2.2
+- 2.1.2
+- 2.2.2
+addons:
+  code_climate:
+    repo_token:
+      secure: G4bpiNUwVTTksk5nncmXcjMWh84uB3YbZwZsCqBROpjHOwaWcHDDID7OPWbl8Yp3x23Q9tj5oEI1i8+zei+jsk1AM5nB30XgAbIVQtv0qcahnDLrMNpWs4ubvBEw3yjwKRslqCD7WDC/lk8eYYmjJ6GyaIDeW8rJbITIkHTk4tKCjXFQRinUClWFfgg+rJSTyUqNqo3+aPaxDUvSeermOKK3jTQp9y1IsRFEbwtLUqliZ3rCgvhj43H4pQ0gDqsmtDqnuHgKBikm9D7+Gf6SbFyAMfy+XpHWlEXLjwwUVlTcSASB6cQ/v0ilJlLSzgaGoTgb6nBbLA3q/cvWTS3O5QEYfWnhzIlmoDBZXVRHWTcR1WpIXF10J5KT/UH+nHCOFGIefriMPWr6LZou1LMZrjY5hJLCeXxgM5xBF3MTAgiQd9cLlzzirCGzN9GGBOZsdDENG74IZPGpmKUPBm7OXjsrLc7rRIoPg92bMuDlBejU0RUWMDTjmrLvgLJM6R6ZdWQ6Ahf9YkLM7apDtVj3DFjOBX2oQuynq9ZuZ9dfhu49MME/7qeIQZD6HQqZixq9Zn8n2tFFvAMrIbeZKc5lZz5TumHiukouh6Jmq9e4issca9J4hV/hFlQ30Ds2plabbgzliISQlQEGh0oUBog3sW1prNnxkcfN+gO7uCHTBaI=

data/CHANGELOG.md

@@ -6,18 +6,20 @@ TableTransform is still in pre-release state. This means that its APIs and behav
 
 ## [Unreleased]
 
-## [0.2.0][] (2016-02-16)
+## [0.3.0][] (2016-02-29)
+* Added format capability for columns when published as Excel
+* CodeClimate and test coverage added
+* Ruby >= 2.1 verified with TravisCI
+* Improved documentation
 
+## [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
+* [FIX] 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.2.0...HEAD
-[0.2.0]: https://github.com/jonas-lantto/table_transform/compare/v0.1.0...0.2.0
+[Unreleased]: https://github.com/jonas-lantto/table_transform/compare/v0.3.0...HEAD
+[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

@@ -2,6 +2,8 @@
 [![Gem Version](https://badge.fury.io/rb/table_transform.svg)](http://badge.fury.io/rb/table_transform)
 [![Build Status](https://travis-ci.org/jonas-lantto/table_transform.svg)](https://travis-ci.org/jonas-lantto/table_transform)
 [![Code Climate](https://codeclimate.com/github/jonas-lantto/table_transform/badges/gpa.svg)](https://codeclimate.com/github/jonas-lantto/table_transform)
+[![Test Coverage](https://codeclimate.com/github/jonas-lantto/table_transform/badges/coverage.svg)](https://codeclimate.com/github/jonas-lantto/table_transform/coverage)
+[![Issue Count](https://codeclimate.com/github/jonas-lantto/table_transform/badges/issue_count.svg)](https://codeclimate.com/github/jonas-lantto/table_transform)
 
 Utility to work with csv type data in a name safe environment with utilities to transform data
 
@@ -54,8 +56,36 @@ Or install it yourself as:
     t1 = TableTransform::Table::create_empty(%w(Col1 Col2))
     t2 = TableTransform::Table::create_empty(%w(Col1 Col2))
     t3 = t1 + t2
-    
+
+### Inspect and traverse
+    # Loop through all rows
+    t.each_row{|row| puts row['Rebate'].to_f * row['Price'].to_f}
+
+#### Table::Row
+`Table::each_row` return a `Table::Row`<br/>
+A row can access its values by column name e.g. `row['Name']`
+
+#### Table:Cell
+    # Table::Cell < String
+    row['operating_system'].downcase == 'centos'
+
+    # include_any?
+    c = row['Col1']                # c = 'CHECK'
+    c.include_any?(%w(AA EC DD)))  # true
+
+### Meta data    
+    # Set format for one column
+    t.set_metadata('Tax', {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'})
+    
+    # Add meta data during add_column
+    t.add_column('Tax', {format: '0.0%'}){|row| 0.25}
+    
 ### Publish
     # Export as array
     t.to_a

data/lib/table_transform/excel_creator.rb

@@ -1,4 +1,5 @@
 require 'write_xlsx'
+require_relative 'table'
 
 
 module TableTransform
@@ -7,6 +8,7 @@ module TableTransform
   class ExcelCreator
     def initialize(filename)
       @workbook = WriteXLSX.new(filename)
+      @formats = {}
     end
 
     def create!
@@ -14,7 +16,8 @@ module TableTransform
     end
 
     def add_tab(name, table)
-      create_table(name, table.to_a)
+      set_formats(table.metadata) if table.is_a?(TableTransform::Table)
+      create_table(name, table)
     end
 
     #################################
@@ -35,8 +38,26 @@ module TableTransform
       res.map! { |x| [x, max_width].min }
     end
 
-    def create_table(name, data)
+    def set_formats(metadata)
+      metadata.each{|_,v|
+        f = v[:format]
+        @formats[f] ||= @workbook.add_format(:num_format => f) unless f.nil?
+      }
+    end
+
+    def create_column_metadata(metadata, formats)
+      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
+        res << {header: header_name}.merge(data_dup)
+      }
+      res
+    end
+
+    def create_table(name, table)
       worksheet = @workbook.add_worksheet(name)
+      data = table.to_a
       return if data.nil? or data.empty? # Create empty worksheet if no data
 
       auto_filter = true
@@ -51,7 +72,7 @@ module TableTransform
               :name => name.tr(' ', '_'),
               :data => data,
               :autofilter => auto_filter ? 1 : 0,
-              :columns => header.map { |v| {:header => v} }
+              :columns => create_column_metadata(table.metadata, @formats)
           }
       )
 

data/lib/table_transform/table.rb

@@ -25,25 +25,43 @@ module TableTransform
     # @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)
+      header = @data_rows.shift
+      @column_indexes = create_column_name_binding(header)
+      @metadata = header.zip( Array.new(header.size){{}} ).to_h
 
-      validate_header_uniqueness
+      validate_header_uniqueness(header)
       validate_column_size
     end
 
+    # Sets metadata for given columns
+    # 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}
+    end
+
+    # Returns meta data as Hash with header name as key
+    def metadata
+      @metadata.clone
+    end
+
     def << (hash_values)
       @data_rows << create_row(hash_values)
       self
     end
 
     # Add two tables
-    # @throws if header do not match
+    # @throws if header or meta data do not match
     def +(table)
       t2 = table.to_a
       t2_header = t2.shift
-      raise 'Tables cannot be added due to header mismatch' if @header != t2_header
+      raise 'Tables cannot be added due to header mismatch' if @metadata.keys != t2_header
+      raise 'Tables cannot be added due to meta data mismatch' if @metadata != table.metadata
       TableTransform::Table.new(self.to_a + t2)
     end
 
@@ -56,29 +74,33 @@ module TableTransform
     # @returns array of data arrays including header row
     def to_a
       res = @data_rows.clone
-      res.unshift @header
+      res.unshift @metadata.keys.clone
     end
 
     # @returns new table with specified columns specified in given header
     def extract(header)
-      selected_cols = header.inject([]) { |res, c| res << Util::get_col_index(c, @column_indexes) }
-      Table.new( @data_rows.inject([header]) {|res, row| (res << row.values_at(*selected_cols))} )
+      validate_column_names(*header)
+      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
     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 @header.clone )
+      Table.new( @data_rows.select {|row| yield Row.new(@column_indexes, row)}.unshift @metadata.keys.clone )
     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)
-      raise "Column '#{name}' already exists" if @header.include?(name)
-      @header << name
+    def add_column(name, metadata = {})
+      raise "Column '#{name}' already exists" if @metadata.keys.include?(name)
+      @metadata[name] = {}
       @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
 
@@ -87,32 +109,21 @@ module TableTransform
       @data_rows.each{|r|
         r[index] = yield Row.new(@column_indexes, r)
       }
+
       self # enable chaining
     end
 
     def delete_column(*names)
-      delete_indexes = names.inject([]){|res, n| res << Util::get_col_index(n, @column_indexes)}
-      delete_indexes.sort!.reverse!
-      delete_indexes.each{|i| @header.delete_at(i)}
+      validate_column_names(*names)
+      names.each{|n| @metadata.delete(n)}
 
-      selected_cols = @header.inject([]) { |res, c| res << Util::get_col_index(c, @column_indexes) }
+      selected_cols = @column_indexes.values_at(*@metadata.keys)
       @data_rows.map!{|row| row.values_at(*selected_cols)}
 
-      @column_indexes = create_column_name_binding(@header)
+      @column_indexes = create_column_name_binding(@metadata.keys)
       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)
@@ -136,13 +147,44 @@ module TableTransform
       end
     end
 
+    protected
+      attr_writer :metadata
+
     private
       def create_column_name_binding(header_row)
         header_row.map.with_index{ |x, i| [x, i] }.to_h
       end
 
       def create_row(hash_values)
-        @header.inject([]) { |row, col| row << hash_values.fetch(col){raise "Value for column '#{col}' could not be found"} }
+        @metadata.keys.inject([]) { |row, col| row << hash_values.fetch(col){raise "Value for column '#{col}' could not be found"} }
+      end
+
+      # @throws unless all header names are unique
+      def validate_header_uniqueness(header)
+        dup = header.select{ |e| header.count(e) > 1 }.uniq
+        raise "Column(s) not unique: #{dup.map{|x| "'#{x}'"}.join(', ')}" if dup.size > 0
+      end
+
+      # @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}
+      end
+
+      def validate_column_names(*names)
+        diff = names - @metadata.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
+        }
       end
   end
 end

data/lib/table_transform/version.rb

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

data/table_transform.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Jonas Lantto']
   spec.email         = ['j@lantto.net']
 
-  spec.summary       = %q{Utility to work with csv type data in a name safe environment with utilities to transform data}
-  spec.description   = %q{}
+  spec.summary       = %q{Transforms csv like data to Excel}
+  spec.description   = %q{Utility to work with csv type data in a name safe environment with utilities to transform data}
   spec.homepage      = 'https://github.com/jonas-lantto/table_transform'
   spec.license       = 'MIT'
 
@@ -19,9 +19,11 @@ 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 'write_xlsx', '~> 0.83'
-  spec.add_development_dependency 'roo',        '~> 2.3'
+  spec.required_ruby_version = '>= 2.1'
+
+  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'
+  spec.add_development_dependency 'codeclimate-test-reporter','~> 0.5.0'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: table_transform
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jonas Lantto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-15 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +66,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description: ''
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Utility to work with csv type data in a name safe environment with utilities
+  to transform data
 email:
 - j@lantto.net
 executables: []
@@ -115,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -126,6 +127,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Utility to work with csv type data in a name safe environment with utilities
-  to transform data
+summary: Transforms csv like data to Excel
 test_files: []