table_transform 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9eeed52b5a7aa9db9eea7f0e0f27a40ff2b932be
-  data.tar.gz: bad8620c79b09929f105d54894b4df931a8b778b
+  metadata.gz: 18bd452f05254c417d3deb30c03d61c9595d3494
+  data.tar.gz: d998ab542023204734aca739c5caf91538307e91
 SHA512:
-  metadata.gz: 7837639dace38af311b85547f997b138812c3bba8d969a356936896f0b1a0be9e12ec22e7b86fbaa705f93a6efd55122d6a739339ad732a619965dfb6d058eaf
-  data.tar.gz: aa40106dd2c8e0c18129a60e50965a1e4e09eaf3d8305bb367aeab79166d6dc540636e9d0b771e9a4fb6f4e4c1c812593338a4309a2f10251a03f7f9d5b794a2
+  metadata.gz: fb3c761f20419bccf2a954c05ee50b0baf01886bc87df0808071cf44147e6c8050bee7b8d0613b058a7f152dbe8ce6e02b4cd74ac08164e0dff3590028060bad
+  data.tar.gz: 55bf3224205284a9b32904fa7f5d507be845878bd4eaf0f983a17e26456d6cccb24f1420a7df697866223b2df2964150404285e1db6497efe7904464172bcc1c

data/CHANGELOG.md

@@ -6,6 +6,9 @@ TableTransform is still in pre-release state. This means that its APIs and behav
 
 ## [Unreleased]
 
+## [0.5.0][] (2016-03-13)
+* Table properties added
+
 ## [0.4.0][] (2016-03-05)
 * Supports formulas in columns
 * Helper functions to create formulas
@@ -25,7 +28,8 @@ 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.3.0...HEAD
+[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
 [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

@@ -73,6 +73,13 @@ 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
+    # 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    
     # Set format for one column
     t.set_metadata('Tax', {format: '0.0%'})

data/lib/table_transform/excel_creator.rb

@@ -23,6 +23,15 @@ module TableTransform
     #################################
     private
 
+    def self.default_properties(table_name)
+      TableTransform::Table::TableProperties.new(
+          {
+              name: table_name.tr(' ', '_'),
+              auto_filter: true
+          }
+      )
+    end
+
     # estimated column width of format
     def self.format_column_size(format)
       return 0 if format.nil?
@@ -71,8 +80,8 @@ module TableTransform
       data = table.to_a
       return if data.nil? or data.empty? # Create empty worksheet if no data
 
-      auto_filter = true
-      col_width = ExcelCreator::column_width(table, auto_filter)
+      properties = ExcelCreator::default_properties(name).update(table.table_properties.to_h)
+      col_width = ExcelCreator::column_width(table, properties[:auto_filter])
 
       header = data.shift
       data << [nil] * header.count if data.empty? # Add extra row if empty
@@ -80,9 +89,9 @@ module TableTransform
       worksheet.add_table(
           0, 0, data.count, header.count - 1,
           {
-              :name => name.tr(' ', '_'),
+              :name => properties[:name],
               :data => data,
-              :autofilter => auto_filter ? 1 : 0,
+              :autofilter => properties[:auto_filter] ? 1 : 0,
               :columns => create_column_metadata(table.metadata, @formats, table.formulas)
           }
       )

data/lib/table_transform/properties.rb

@@ -0,0 +1,37 @@
+
+module TableTransform
+
+  class Properties
+    def initialize(init_properties = {})
+      validate(init_properties)
+      @props = init_properties
+    end
+
+    def validate(properties)
+      raise 'Default properties must be a hash' unless properties.is_a? Hash
+    end
+
+    def to_h
+      @props.clone
+    end
+
+    def update(properties)
+      validate(properties)
+      @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

@@ -1,4 +1,5 @@
 require 'csv'
+require_relative 'properties'
 
 module TableTransform
   module Util
@@ -9,6 +10,7 @@ module TableTransform
 
   class Table
     attr_reader :formulas
+    attr_reader :table_properties
 
     def self.create_from_file(file_name, sep = ',')
       rows = CSV.read(file_name, { :col_sep => sep })
@@ -17,15 +19,15 @@ module TableTransform
       Table.new(rows)
     end
 
-    def self.create_empty(header)
+    def self.create_empty(header, table_properties = {})
       raise 'Table header need to be array' unless header.is_a? Array
       raise 'Table, No header defined' if header.empty?
-      Table.new([header])
+      Table.new([header], table_properties)
     end
 
     # @throws if column names not unique
     # @throws if column size for each row match
-    def initialize(rows)
+    def initialize(rows, table_properties = {})
       raise 'Table required to have at least a header row' if (rows.nil? or rows.empty?)
 
       @data_rows = rows.clone
@@ -33,6 +35,7 @@ module TableTransform
       @column_indexes = create_column_name_binding(header)
       @metadata = header.zip( Array.new(header.size){{}} ).to_h
       @formulas = {}
+      @table_properties = TableProperties.new(table_properties)
 
       validate_header_uniqueness(header)
       validate_column_size
@@ -69,8 +72,9 @@ module TableTransform
     def +(table)
       t2 = table.to_a
       t2_header = t2.shift
-      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
+      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 table properties mismatch' unless @table_properties.to_h == table.table_properties.to_h
       TableTransform::Table.new(self.to_a + t2)
     end
 
@@ -90,7 +94,7 @@ module TableTransform
     def extract(header)
       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 = 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
       t.formulas = header.zip(@formulas.values_at(*header)).to_h
       t
@@ -98,7 +102,7 @@ module TableTransform
 
     # @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.new( (@data_rows.select {|row| yield Row.new(@column_indexes, row)}.unshift @metadata.keys.clone), @table_properties.to_h )
     end
 
     #adds a column with given name to the far right of the table
@@ -164,6 +168,24 @@ module TableTransform
       end
     end
 
+    # Table properties
+    class TableProperties < TableTransform::Properties
+      def validate(properties)
+        super
+        properties.each { |k, v|
+          case k
+            when :name
+              raise "Table property '#{k}' expected to be a non-empty string" unless v.is_a?(String) && !v.empty?
+            when :auto_filter
+              raise "Table property '#{k}' expected to be a boolean" unless !!v == v
+            else
+              raise "Table property unknown '#{k}'"
+          end
+        }
+      end
+    end
+
+
     protected
       attr_writer :metadata
       attr_writer :formulas

data/lib/table_transform/version.rb

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

metadata

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