rxl 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b102ae677e551c55e09c215bc2d1cce924fd7f2fc04ed62494688ace5ef97d0
-  data.tar.gz: e27a358a15acd3ffe9fd7cb0fb28b80bffe1d34a5d4d39cd6daf8588e5f41bc0
+  metadata.gz: de4749440f95c5322dd8ebd53fbe5cb404ea1fb74cf8f8f3ccb5075bf8546a13
+  data.tar.gz: 45c65180dff5b3ea3caa4e419b6dbc484bc3f08ec893c498bd0eefa292dc03a3
 SHA512:
-  metadata.gz: 16bc6449d64157ba6a930d38c6b2d37e5068e95a2e8c7aa9b0dab8577d4681e852b09b40f3e7cfaab9d428c819a8ca1eb6385ec4d83e37d46828c060aa9e27f4
-  data.tar.gz: b7036aaa8fde48fd7c5f5967623c04170c11f8aca19567aa9c21525a23ab8bbe3ae516951718f5ff9eede77d059bade248b0f796e20a44ae372fdc1696c34d77
+  metadata.gz: d14ae0ec6967b65750b93b5bd83f586f709f54ec59d6b67d88c79f2eae50121532520714f104eda924615d246ed8ff5a5c466d9a5485c96bd81b07fab91eb828
+  data.tar.gz: 04fb929742e396df0798f59d92fdb78b98d93be0c303a13fb5c30a25d6b3596ffc438c59570f4354776822c90a870ad45eef2b2a7f9da1d442c2126dd6e72314

data/README.md

@@ -10,6 +10,10 @@ The mechanics of the conversion between xlsx and ruby hash have been implemented
 
 https://github.com/weshatheleopard/rubyXL
 
+## Breaking changes
+
+Version 0.6.0 introduces a breaking change in the format of inputs for writing as tables, refer to revised documentation below.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -240,35 +244,37 @@ TODO: add full description for hash_cell_to_rubyxl_cell and rubyxl_cell_to_hash_
 To write a file as pass the filename and hash:
 
 ```ruby
-Rxl.write_file_as_tables('path/to/save.xlsx', hash_tables, order)
+Rxl.write_file_as_tables('path/to/save.xlsx', hash_tables)
 ```
 
-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.
+The worksheets' top row will be populated with values specified in the `columns` 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)
+* use `nil` in the `columns` 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'
-    }
-  ]
+  'Sheet1' => {
+    columns: %i[header_a header_b],
+    rows: [
+      {
+        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.
+Add formatting to tables by adding a `:formats` key to the sheet hash.
 
 Inside the formatting hash add child hashes with keys for the relevant table.
 
@@ -279,10 +285,10 @@ 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' => {
+  'Sheet1' => {
+    columns: %i[header_a header_b],
+    formats: {
       headers: {
         bold: true,
         align: 'center'
@@ -290,18 +296,18 @@ hash_tables = {
       'B' => {
         fill: 'feb302'
       }
-    }
-  },
-  'Sheet1' => [
-    {
-      'col_1' => 'some_value',
-      'col_2' => 'other_value'
     },
-    {
-      'col_1' => 'some_value',
-      'col_2' => 'other_value'
-    }
-  ]
+    rows: [
+      {
+        'col_1' => 'some_value',
+        'col_2' => 'other_value'
+      },
+      {
+        'col_1' => 'some_value',
+        'col_2' => 'other_value'
+      }
+    ]
+  }
 }
 ```
 

data/lib/rxl.rb

@@ -10,8 +10,8 @@ module Rxl
     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)
+  def self.write_file_as_tables(filepath, hash_tables, write_headers: true)
+    hash_workbook = Workbook.hashes_to_hash_workbook(hash_tables, write_headers: write_headers)
     write_file(filepath, hash_workbook)
     nil
   end

data/lib/rxl/version.rb

@@ -1,3 +1,3 @@
 module Rxl
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/lib/workbook.rb

@@ -26,12 +26,10 @@ module Workbook
     rubyxl_workbook
   end
 
-  def self.hashes_to_hash_workbook(hash_tables, order, write_headers: true)
+  def self.hashes_to_hash_workbook(hash_tables, write_headers: true)
     hash_workbook = {}
-    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)
+      hash_workbook[k] = Worksheet.hashes_to_hash_worksheet(v[:rows], v[:columns], v[:formats] || {}, write_headers: write_headers)
     end
     hash_workbook
   end

data/lib/worksheet.rb

@@ -38,11 +38,11 @@ module Worksheet
   ###     GET RUBYXL WORKSHEET FROM HASHES     ###
   ################################################
 
-  def self.hashes_to_hash_worksheet(hashes, order, formats, write_headers: true)
+  def self.hashes_to_hash_worksheet(hashes, columns, formats, write_headers: true)
     rows = hashes.map do |hash|
-      order.map { |item| hash[item] }
+      columns.map { |item| hash[item] }
     end
-    rows.unshift(order.map { |item| "#{item}" }) if write_headers
+    rows.unshift(columns.map { |item| "#{item}" }) if write_headers
     hash_worksheet = rows_to_hash_worksheet(rows)
     format_hash_worksheet(hash_worksheet, formats, write_headers) if formats
     hash_worksheet

metadata

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