rxl 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd17d97488a9891b7bce15f8352bd0fb4a1b5ccb030be154d20f4eeee9369c78
-  data.tar.gz: 7c0dc41d7cac1f81724a951d3d228af7fa76d2c4c0d76878c06d15b4e73613bd
+  metadata.gz: 423f052155f315079efc3acd473a98ba955f378571aeba1eee1706f99d30c8a3
+  data.tar.gz: bf910f39824c12a512b7fafdcd94a6d478d1fc64bcfdcaa26c5a45c2d5c4b8d2
 SHA512:
-  metadata.gz: 74d0cc8be8633bb2ff9bb6258a48dd5496819d6902133802af7416fcb19c691af13bd60e7b052346efc7bc9ae5566d9e39fb1593db76b89e965e897e30c42db7
-  data.tar.gz: 0c6f3fdbb3d88bb2f3ab73f20b9d593d9cddb693505ffd049ff40d354763a568d38bc8f97a5adf6266147aa8a79809553f0503659d792874e9ce14983116657a
+  metadata.gz: 5489f6b1c8500457e0bb093b4437614c3ac3ecda3d28d9bae9c6f519817355217fa5e7701a33b331e34d18873ac4d38e3749110ddb4ab2cc23f33255eb70ac2e
+  data.tar.gz: dbab0226eb5a2e6bb82d5f345630f50d4f6da2bbdff5c96eeed154998821c228e5dab0610e9bbefbce2f6088f2daf09b171d343d98280843c4e7ff4909084576

data/README.md

@@ -101,6 +101,35 @@ The format of the excel table read hash has the following skeleton:
 }
 ```
 
+### Read multiple files at once
+
+Pass a hash of filepaths to read, get a hash of file contents back.
+
+```ruby
+filepaths_hash = {
+  first_file: 'path/to/file.xlsx',
+  second_file: 'path/to/file.xlsx'
+}
+
+Rxl.read_files(filepaths_hash)
+Rxl.read_files(filepaths_hash, :as_tables)
+```
+
+Returns the files with sheet contents populated with hash of cells (or array of rows if :as_tables read type is specified):
+
+```ruby
+{
+  first_file: {
+    "Sheet1" => 'sheet_contents',
+    "Sheet2" => 'sheet_contents'
+  },
+  second_file: {
+    "Sheet1" => 'sheet_contents',
+    "Sheet2" => 'sheet_contents'
+  },
+}
+```
+
 ### Write to file
 
 To write a file pass the filename and hash:
@@ -109,16 +138,13 @@ To write a file pass the filename and hash:
 Rxl.write_file('path/to/save.xlsx', hash_workbook)
 ```
 
-The format of the excel hash_workbook must contain at least the following skeleton:
+The format of the excel hash_workbook has sheet names as keys and hashes of cells as values:
 
 ```ruby
 {
     "Sheet1" => {
-      cells: {
-          'A1' => {
-              value: 'abc',
-              format: 'text'
-          }
+      'A1' => {
+          value: 'abc'
       }
     }
 }
@@ -150,21 +176,27 @@ The following rules are validated for write_file:
 * The hash_workbook keys must be strings
 * The hash_workbook values (hash_worksheet) must be hashes
 
-
-* The hash_worksheet keys must be symbols
-* The following keys are allowed for hash_worksheet: :cells, :rows, :columns
-* The hash_worksheet values must be arrays - those arrays must contain only hashes
-
-
-* The arrays' child hash keys must be strings of valid Excel cell id format (or stringified number for a row, capitalised alpha for a column)
-* The arrays' child hash values must be hashes (hash_cell)
+* The hash_worksheet keys must be strings of valid Excel cell id format
+* The hash_worksheet values must be hashes (specifying cells)
 * The hash_cell keys must conform the the cell specification as below
 
 * If a formula is provided the value must be nil or an empty string
 * If a number format is provided the value must be consistent with it
 
 
-TODO: Add further detail
+Cells are specified as hashes following this example:
+
+```ruby
+{
+  value: 'abc'
+}
+```
+
+Other keys can be specified:
+* v_align: :top, :centre or :bottom (default)
+* h_align: :left (default), :centre or :right
+
+TODO: add full description for hash_cell_to_rubyxl_cell and rubyxl_cell_to_hash_cell (and check they're as consistent as possible)
 
 ## Development
 

data/lib/cell.rb

@@ -76,18 +76,6 @@ module Cell
     end
   end
 
-  def self.get_combined_hash_cell(hash_worksheet, hash_cell_key, hash_cell)
-    # first get data from the matching column if it's specified
-    column_keys = hash_worksheet[:columns].keys.select { |key| hash_cell_key =~ /^#{key}\d+$/ }
-    column_keys.empty? ? hash_column = {} : hash_column = hash_worksheet[:columns][column_keys[0]]
-    combined_hash_cell = hash_column.merge(hash_cell)
-    # then get data from the matching row if it's specified
-    row_keys = hash_worksheet[:rows].keys.select { |key| hash_cell_key =~ /^\D+#{key}$/ }
-    row_keys.empty? ? hash_row = {} : hash_row = hash_worksheet[:rows][row_keys[0]]
-    combined_hash_cell = hash_row.merge(combined_hash_cell)
-    hash_worksheet[:worksheet].merge(combined_hash_cell)
-  end
-
 
   ##################################
   ###     VALIDATE HASH CELL     ###

data/lib/rxl/version.rb

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

data/lib/workbook.rb

@@ -21,7 +21,6 @@ module Workbook
       else
         rubyxl_workbook.add_worksheet(hash_key)
       end
-      Worksheet.set_hash_worksheet_defaults(hash_value)
       Worksheet.hash_worksheet_to_rubyxl_worksheet(hash_value, rubyxl_workbook[hash_key])
     end
     rubyxl_workbook

data/lib/worksheet.rb

@@ -26,11 +26,10 @@ module Worksheet
 
   def self.hash_worksheet_to_rubyxl_worksheet(hash_worksheet, rubyxl_worksheet)
     process_sheet_to_populated_block(hash_worksheet)
-    (hash_worksheet[:cells] || {}).sort.each do |hash_cell_key, hash_cell|
-      combined_hash_cell = Cell.get_combined_hash_cell(hash_worksheet, hash_cell_key, hash_cell)
+    (hash_worksheet || {}).sort.each do |hash_cell_key, hash_cell|
       row_index, column_index = RubyXL::Reference.ref2ind(hash_cell_key)
-      Cell.add_rubyxl_cells(combined_hash_cell, rubyxl_worksheet, row_index, column_index)
-      Cell.hash_cell_to_rubyxl_cell(combined_hash_cell, rubyxl_worksheet, row_index, column_index)
+      Cell.add_rubyxl_cells(hash_cell, rubyxl_worksheet, row_index, column_index)
+      Cell.hash_cell_to_rubyxl_cell(hash_cell, rubyxl_worksheet, row_index, column_index)
     end
   end
 
@@ -64,12 +63,6 @@ module Worksheet
   ###     OTHER PUBLIC METHODS     ###
   ####################################
 
-  def self.set_hash_worksheet_defaults(hash_worksheet)
-    %i[worksheet columns rows].each do |key|
-      hash_worksheet[key] = {} unless hash_worksheet.has_key?(key)
-    end
-  end
-
   def self.hash_worksheet_to_hash_table(raw_hash)
     cells = Mitrush.deep_copy(raw_hash)
     columns = cells.keys.map { |key| key[/\D+/] }.uniq

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rxl
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ian McWilliams
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-03 00:00:00.000000000 Z
+date: 2019-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,8 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A ruby spreadsheet interface