rxl 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 423f052155f315079efc3acd473a98ba955f378571aeba1eee1706f99d30c8a3
-  data.tar.gz: bf910f39824c12a512b7fafdcd94a6d478d1fc64bcfdcaa26c5a45c2d5c4b8d2
+  metadata.gz: 5d71e3c242930b4fbd6c3e05572e51bf19231ea10483b6ca271dd42138e1959a
+  data.tar.gz: 14c3dfbf017573840b2c31595043f3b587e6550487c91a7de5395ff02282c0fa
 SHA512:
-  metadata.gz: 5489f6b1c8500457e0bb093b4437614c3ac3ecda3d28d9bae9c6f519817355217fa5e7701a33b331e34d18873ac4d38e3749110ddb4ab2cc23f33255eb70ac2e
-  data.tar.gz: dbab0226eb5a2e6bb82d5f345630f50d4f6da2bbdff5c96eeed154998821c228e5dab0610e9bbefbce2f6088f2daf09b171d343d98280843c4e7ff4909084576
+  metadata.gz: a64c63e260638a97ebfcc00270e8d4ca265a693fa6754be61d3307a26e27b863d9d04ef3bdd46ca908ac289102c4f964ac5ff4561dfb43f46f9578494467412d
+  data.tar.gz: 18d20fc11bd47c9d8f631eca7023f398ab2992817696dbd568a796cf23307b14c8be6929db0bc7c17b00e3f8c8641d5648791179fea9d7a142e7189eb7fa3aad

data/README.md

@@ -42,7 +42,7 @@ The format of the excel read hash has the following skeleton:
 
 ```ruby
 {
-    "Sheet1" => {
+    'Sheet1' => {
       row_count: 1,
       column_count: 1,
       rows: {},
@@ -88,7 +88,7 @@ The format of the excel table read hash has the following skeleton:
 
 ```ruby
 {
-    "Sheet1" => [
+    'Sheet1' => [
       {
           header_a: value,
           header_b: value
@@ -120,18 +120,20 @@ Returns the files with sheet contents populated with hash of cells (or array of
 ```ruby
 {
   first_file: {
-    "Sheet1" => 'sheet_contents',
-    "Sheet2" => 'sheet_contents'
+    'Sheet1' => 'sheet_contents',
+    'Sheet2' => 'sheet_contents'
   },
   second_file: {
-    "Sheet1" => 'sheet_contents',
-    "Sheet2" => 'sheet_contents'
+    'Sheet1' => 'sheet_contents',
+    'Sheet2' => 'sheet_contents'
   },
 }
 ```
 
 ### Write to file
 
+Any exception is swallowed and returned.
+
 To write a file pass the filename and hash:
 
 ```ruby
@@ -142,7 +144,7 @@ The format of the excel hash_workbook has sheet names as keys and hashes of cell
 
 ```ruby
 {
-    "Sheet1" => {
+    'Sheet1' => {
       'A1' => {
           value: 'abc'
       }
@@ -150,6 +152,39 @@ 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

data/lib/rxl.rb

@@ -7,10 +7,16 @@ 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.write(filepath)
+  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)
   end
 
   def self.read_file(filepath)

data/lib/rxl/version.rb

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

data/lib/workbook.rb

@@ -26,6 +26,12 @@ module Workbook
     rubyxl_workbook
   end
 
+  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) }
+    hash_workbook
+  end
+
   def self.hash_workbook_to_hash_tables(hash_workbook)
     hash_workbook.keys.each_with_object({}) do |key, hash_tables|
       hash_tables[key] = Worksheet.hash_worksheet_to_hash_table(hash_workbook[key])

data/lib/worksheet.rb

@@ -34,6 +34,29 @@ module Worksheet
   end
 
 
+  ################################################
+  ###     GET RUBYXL WORKSHEET FROM HASHES     ###
+  ################################################
+
+  def self.hashes_to_hash_worksheet(hashes, order, 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)
+  end
+
+  def self.rows_to_hash_worksheet(rows)
+    rxl_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 }
+      end
+    end
+    rxl_worksheet
+  end
+
+
   ##############################
   ###     SHARED METHODS     ###
   ##############################
@@ -89,4 +112,10 @@ module Worksheet
     end
   end
 
+  def self.column_name(int)
+    name = 'A'
+    int.times { name.succ! }
+    name
+  end
+
 end

metadata

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