rxl 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d71e3c242930b4fbd6c3e05572e51bf19231ea10483b6ca271dd42138e1959a
-  data.tar.gz: 14c3dfbf017573840b2c31595043f3b587e6550487c91a7de5395ff02282c0fa
+  metadata.gz: 62aee75c921b3b6e206dadf145c6421d3bf193c24eadb6f42c9905b4c1f27c4b
+  data.tar.gz: a95171c0ebbc1242621af4f2aff4b1157e66c6d0fe601eb44bc8ae83f4e6e34c
 SHA512:
-  metadata.gz: a64c63e260638a97ebfcc00270e8d4ca265a693fa6754be61d3307a26e27b863d9d04ef3bdd46ca908ac289102c4f964ac5ff4561dfb43f46f9578494467412d
-  data.tar.gz: 18d20fc11bd47c9d8f631eca7023f398ab2992817696dbd568a796cf23307b14c8be6929db0bc7c17b00e3f8c8641d5648791179fea9d7a142e7189eb7fa3aad
+  metadata.gz: d3ef588d022f83c7f2cb9042521bd2e20699012fcb9155115a07900a7b9367be30fee4a7cf7815da41f18eff3486b4a6492b7ec6cc15f68dbc25c5ba0a87f647
+  data.tar.gz: f50bc7833adc83c12bd227c404841a45d9aa0eb553c673da144124dde780610cc713f2baf33aca4cf415d771a750e5a07db2f15136a8f21523a4a14d8457c076

data/.gitignore

@@ -10,3 +10,4 @@
 /.idea
 **/sandbox.*
 /.analysis
+rxl-*.gem

data/Gemfile

@@ -6,4 +6,4 @@ gemspec
 gem 'awesome_print'
 gem 'mitrush', '>= 0.2.0'
 gem 'rubocop'
-gem 'rubyXL'
+gem 'rubyXL', '3.3.30'

data/README.md

@@ -132,8 +132,6 @@ Returns the files with sheet contents populated with hash of cells (or array of
 
 ### Write to file
 
-Any exception is swallowed and returned.
-
 To write a file pass the filename and hash:
 
 ```ruby
@@ -152,39 +150,6 @@ The format of the excel hash_workbook has sheet names as keys and hashes of cell
 }
 ```
 
-### Write to file as tables
-
-Any exception is swallowed and returned.
-
-To write a file as pass the filename and hash:
-
-```ruby
-Rxl.write_file_as_tables('path/to/save.xlsx', hash_tables, order)
-```
-
-The worsheets' top row will be populated with values specified in the `order` array. Those array items will also be used to extract the current row from the current hash.
-
-* use `nil` in the `order` array to leave blank columns (including blank header)
-* string or symbol keys can be used, so long as the key in order is the same as in the hashes
-
-The format of the excel hash_workbook has sheet names as keys and hashes of rows as values:
-
-```ruby
-order = %i[header_a header_b]
-hash_tables = {
-    'Sheet1' => [
-      {
-        header_a: 'some_value',
-        header_b: 'other_value'
-      },
-      {
-        header_a: 'some_value',
-        header_b: 'other_value'
-      }
-    ]
-}
-```
-
 #### Cell specification
 
 All cells are written with the format set to general except those with a number format specified
@@ -233,6 +198,76 @@ Other keys can be specified:
 
 TODO: add full description for hash_cell_to_rubyxl_cell and rubyxl_cell_to_hash_cell (and check they're as consistent as possible)
 
+### Write to file as tables
+
+To write a file as pass the filename and hash:
+
+```ruby
+Rxl.write_file_as_tables('path/to/save.xlsx', hash_tables, order)
+```
+
+The worksheets' top row will be populated with values specified in the `order` array. Those array items will also be used to extract the current row from the current hash.
+
+* use `nil` in the `order` array to leave blank columns (including blank header)
+* string or symbol keys can be used, so long as the key in order is the same as in the hashes
+
+The format of the excel hash_workbook has sheet names as keys and hashes of rows as values:
+
+```ruby
+order = %i[header_a header_b]
+hash_tables = {
+  'Sheet1' => [
+    {
+      header_a: 'some_value',
+      header_b: 'other_value'
+    },
+    {
+      header_a: 'some_value',
+      header_b: 'other_value'
+    }
+  ]
+}
+```
+
+#### Formatting for tables
+
+Add formatting to tables by adding a `:formats` key to the top level hash.
+
+Inside the formatting hash add child hashes with keys for the relevant table.
+
+Within the table add hashes for each column with the key as the column letter and the value as a cell hash (excluding `:value`).
+
+Formatting for rows is not currently implemented.
+
+Additionally inside the table hash add a key `:headers` with a cell hash (excluding `:value`) to set formatting for the header row.
+
+```ruby
+order = %i[header_a header_b]
+hash_tables = {
+  formats: {
+    'Sheet1' => {
+      headers: {
+        bold: true,
+        align: 'center'
+      },
+      'B' => {
+        fill: 'feb302'
+      }
+    }
+  },
+  'Sheet1' => [
+    {
+      'col_1' => 'some_value',
+      'col_2' => 'other_value'
+    },
+    {
+      'col_1' => 'some_value',
+      'col_2' => 'other_value'
+    }
+  ]
+}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/cell.rb

@@ -8,12 +8,27 @@ module Cell
 
   def self.rubyxl_cell_to_hash_cell(rubyxl_cell = nil)
     rubyxl_cell_value = rubyxl_cell.nil? ? RubyXL::Cell.new.value : rubyxl_cell.value
-    {
+    values = {
         value: rubyxl_cell_value,
         format: hash_cell_format(rubyxl_cell_value),
         formula: rubyxl_cell_formula(rubyxl_cell),
         h_align: rubyxl_cell_horizontal_alignment(rubyxl_cell),
-        v_align: rubyxl_cell_vertical_alignment(rubyxl_cell)
+        v_align: rubyxl_cell_vertical_alignment(rubyxl_cell),
+        bold: rubyxl_cell.is_bolded,
+        fill: rubyxl_cell.fill_color,
+        font_name: rubyxl_cell.font_name,
+        font_size: rubyxl_cell.font_size.to_i,
+        border: rubyxl_cell_to_border_hash(rubyxl_cell)
+    }
+    return values
+  end
+
+  def self.rubyxl_cell_to_border_hash(rubyxl_cell)
+    {
+      top: rubyxl_cell.get_border(:top),
+      bottom: rubyxl_cell.get_border(:bottom),
+      left: rubyxl_cell.get_border(:left),
+      right: rubyxl_cell.get_border(:right)
     }
   end
 
@@ -57,7 +72,7 @@ module Cell
     rubyxl_worksheet[row_index][column_index].change_font_name(combined_hash_cell[:font_style]) if combined_hash_cell[:font_style]
     rubyxl_worksheet[row_index][column_index].change_font_size(combined_hash_cell[:font_size]) if combined_hash_cell[:font_size]
     rubyxl_worksheet[row_index][column_index].change_fill(combined_hash_cell[:fill]) if combined_hash_cell[:fill]
-    rubyxl_worksheet[row_index][column_index].change_horizontal_alignment(combined_hash_cell[:align]) if combined_hash_cell[:align]
+    rubyxl_worksheet[row_index][column_index].change_horizontal_alignment(combined_hash_cell[:h_align]) if combined_hash_cell[:h_align]
     rubyxl_worksheet[row_index][column_index].change_font_bold(combined_hash_cell[:bold]) if combined_hash_cell[:bold]
 
     if combined_hash_cell[:border_all]
@@ -91,9 +106,10 @@ module Cell
     unless hash_cell.keys.reject { |key| key.is_a?(Symbol) }.empty?
       raise("cell key at path #{trace + [hash_cell_key]} must be a Symbol")
     end
-    unless hash_cell.keys.delete_if { |key| valid_cell_keys.include?(key) }.empty?
+    invalid_keys = hash_cell.keys.delete_if { |key| valid_cell_keys.include?(key) }
+    unless invalid_keys.empty?
       valid_cell_keys_string = ":#{valid_cell_keys.join(', :')}"
-      raise(%(invalid cell hash key at path #{trace + [hash_cell_key]}, valid keys are: [#{valid_cell_keys_string}]))
+      raise(%(invalid cell hash key(s) #{invalid_keys} at path #{trace + [hash_cell_key]}, valid keys are: [#{valid_cell_keys_string}]))
     end
     # TODO: add validation for hash_cell specification
   end
@@ -112,6 +128,13 @@ module Cell
       value
       number
       formula
+      bold
+      h_align
+      v_align
+      border
+      fill
+      font_name
+      font_size
     ]
   end
 

data/lib/rxl.rb

@@ -5,18 +5,15 @@ require_relative 'workbook'
 module Rxl
 
   def self.write_file(filepath, hash_workbook)
-    begin
-      rubyxl_workbook = Workbook.hash_workbook_to_rubyxl_workbook(hash_workbook)
-      rubyxl_workbook.write(filepath)
-      nil
-    rescue => e
-      return e
-    end
+    rubyxl_workbook = Workbook.hash_workbook_to_rubyxl_workbook(hash_workbook)
+    rubyxl_workbook.write(filepath)
+    nil
   end
 
   def self.write_file_as_tables(filepath, hash_tables, order, write_headers: true)
     hash_workbook = Workbook.hashes_to_hash_workbook(hash_tables, order, write_headers: write_headers)
     write_file(filepath, hash_workbook)
+    nil
   end
 
   def self.read_file(filepath)

data/lib/rxl/version.rb

@@ -1,3 +1,3 @@
 module Rxl
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/workbook.rb

@@ -28,7 +28,11 @@ module Workbook
 
   def self.hashes_to_hash_workbook(hash_tables, order, write_headers: true)
     hash_workbook = {}
-    hash_tables.each { |k, v| hash_workbook[k] = Worksheet.hashes_to_hash_worksheet(v, order, write_headers: write_headers) }
+    all_formats = hash_tables.delete(:formats) || {}
+    hash_tables.each do |k, v|
+      formats = all_formats[k]
+      hash_workbook[k] = Worksheet.hashes_to_hash_worksheet(v, order, formats, write_headers: write_headers)
+    end
     hash_workbook
   end
 

data/lib/worksheet.rb

@@ -38,22 +38,37 @@ module Worksheet
   ###     GET RUBYXL WORKSHEET FROM HASHES     ###
   ################################################
 
-  def self.hashes_to_hash_worksheet(hashes, order, write_headers: true)
+  def self.hashes_to_hash_worksheet(hashes, order, formats, write_headers: true)
     rows = hashes.map do |hash|
       order.map { |item| hash[item] }
     end
     rows.unshift(order.map { |item| "#{item}" }) if write_headers
-    rows_to_hash_worksheet(rows)
+    hash_worksheet = rows_to_hash_worksheet(rows)
+    format_hash_worksheet(hash_worksheet, formats, write_headers) if formats
+    hash_worksheet
   end
 
   def self.rows_to_hash_worksheet(rows)
-    rxl_worksheet = {}
+    hash_worksheet = {}
     rows.count.times do |i|
       rows[i].each_with_index do |cell_value, index|
-        rxl_worksheet["#{column_name(index)}#{i + 1}"] = { value: cell_value }
+        hash_worksheet["#{column_name(index)}#{i + 1}"] = { value: cell_value }
+      end
+    end
+    hash_worksheet
+  end
+
+  def self.format_hash_worksheet(hash_worksheet, formats, write_headers)
+    if write_headers && formats[:headers]
+      hash_worksheet.keys.grep(/^\D+1$/).each { |key| hash_worksheet[key].update(formats[:headers]) }
+    end
+    formats.keys.each do |col|
+      next if col == :header
+      hash_worksheet.keys.grep(/^#{col}/).each do |key|
+        next if write_headers && key[/^\D+1$/]
+        hash_worksheet[key].update(formats[col])
       end
     end
-    rxl_worksheet
   end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rxl
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ian McWilliams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-10 00:00:00.000000000 Z
+date: 2019-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler