rxl 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6991fc216795b685c75f3bf7b4222520e428a9b021bac623bc7501e817fd6453
-  data.tar.gz: a99745263d114493fff4802e534f2c97757c7fe75bc6a23726d2a4ad6df7a466
+  metadata.gz: 7820fff21fd0ba92fb5904c2a1a72a303c369830df9018ef12594ee5da572f8c
+  data.tar.gz: 101f2adf3cd52dc9b25357e772b95cb74121c4f8c66a6effeb7de7ac5de28816
 SHA512:
-  metadata.gz: 192009987d16a7b84bd611f62ded016dd230eeb9938eb0e963ba2608ce6414de2821d9669537f340299d1788a67b29cb1c39c3b668b48edb1d09be7af8490086
-  data.tar.gz: 71d91a553075e6af3cc4e8e8729cf45e10afe647dc1049abcefd11898064d04a810f1e2d8aaa1f183b4dcee1c1c2494fca8b77829cc9e496b5e938c95f28678f
+  metadata.gz: 37d51c7a106c7daab8f244726efada37d1e31f178aae7618a1821450898f48e211ce9bf3fa1c7ffdfb25d740a3031b671228922863362f883566c5980ce8d1cd
+  data.tar.gz: 71ed2283fe0f700ff366e97912cb35863005527c32966722debae51195f4f5ba59a633acc91cf23dbd15917c3e730b63256507c312a380079f695d1816e27d39

data/README.md

@@ -60,7 +60,8 @@ The format of the excel read hash has the following skeleton:
 Bear in mind the limitations of reading cell formats. Everything is read as a string other than:
 * cells formatted as dates are converted to a DateTime object with the time portion set to midnight
 * cells formatted as times are converted to a DateTime object with the date portion set to 31/12/1899 - unless the cell has a date prefix in which case this is carried in (this will be read as a date format as per below parsing rules)
-* numbers (including floats and percentages) where the cell format is number or percentage are read in as integers - trailing zeroes are cropped from floats in this case and percentages are converted to numeric format (eg 100% = 1)
+* percentages are converted to numeric format (eg 100% = 1)
+* to account for floats, which lose any trailing zeroes, decimal point information is retained in the `:decimals` value
 * formulas are not read from cells with date and time formats
 
 Within these limitations the cell hash's :format holds the best analysis of the original cell format but as there's no way to extract all of the format information directly from the sheet some information may need to be refurbished as required after import via Rxl.
@@ -152,21 +153,58 @@ The format of the excel hash_workbook has sheet names as keys and hashes of cell
 
 #### Cell specification
 
-All cells are written with the format set to general except those with a number format specified
+##### Output formatting
+
+All cells are written with the format set to general by default
+
+If the value is a DateTime object then use `:date_format` with a date format as per the below examples, the default is 'dd/mm/yyyy'
+
+If `:format` is given as `:percentage` where the value is a number or float then the format defaults to a matching format (eg '0' for 1, '0.0' for 0.1), override using `:number_format` if trailing zeroes are required or rounding is needed
 
 Specify the number format according to https://support.office.com/en-us/article/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68?ui=en-US&rs=en-US&ad=US
 
 Examples:
 
-| value        | number format | resulting cell format | resulting cell value |
+| value        | number_format | resulting cell format | resulting cell value |
+|--------------|---------------|-----------------------|----------------------|
+| 0            | '0'           | number                | 0                    |
+| 0.49         | '0'           | number                | 0                    |
+| 0.5          | '0'           | number                | 1                    |
+| 0            | '0.00'        | number                | 0.00                 |
+| 0.5          | '0.00'        | number                | 0.50                 |
+| 0            |' 0%'          | percentage            | 0%                   |
+| 1            | '0%'          | percentage            | 100%                 |
+| 0.101        | '0.00%'       | percentage            | 10.10%               |
+| 1            | '0.00%'       | percentage            | 100.00%              |
+
+| value        | date_format   | resulting cell format | resulting cell value |
 |--------------|---------------|-----------------------|----------------------|
-| 0            | 0             | number                | 0                    |
-| 0.49         | 0             | number                | 0                    |
-| 0.5          | 0             | number                | 1                    |
-| 0            | 0.00          | number                | 0.00                 |
-| 0            | 0%            | percentage            | 0%                   |
-| 1            | 0%            | percentage            | 100%                 |
 | '01/01/2000' | 'dd/mm/yyyy'  | date                  | 01/01/2000           |
+| '01/01/2000' | 'dd-mmm-yyyy' | date                  | 01-Jan-2000          |
+| '01:00:00'   | 'hh:mm:ss'    | time                  | 01:00:00             |
+
+##### Cell formatting
+
+TODO: add more cell formatting
+
+```ruby
+{
+  'A1' => {
+    value: 'some_text',
+    font_name: 'Arial',
+    font_size: 8,
+    bold: true,
+    h_align: :center,
+    v_align: :center,
+    fill: 'a1b2c3',
+    border: { top: 'thin', bottom: 'thin', left: 'thin', right: 'thin' }
+  }
+}
+```
+
+##### Formulas
+
+Formulas are read and written from/to the `:formula` value and on write supercede and value specified, however due to some unknown issue, formulas which were written via this gem can then be re-read but the cell value will be empty
 
 #### Write Validation
 
@@ -180,7 +218,6 @@ The following rules are validated for write_file:
 * 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
 
 

data/lib/cell.rb

@@ -8,20 +8,37 @@ 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
+    rubyxl_cell_value = resolve_date_ms(rubyxl_cell_value) if rubyxl_cell_value.is_a?(Date)
+    format = hash_cell_format(rubyxl_cell_value)
     {
-        value: rubyxl_cell_value,
-        format: hash_cell_format(rubyxl_cell_value),
-        formula: rubyxl_cell_formula(rubyxl_cell),
-        h_align: rubyxl_cell_h_align(rubyxl_cell),
-        v_align: rubyxl_cell_v_align(rubyxl_cell),
-        bold: rubyxl_cell.nil? ? false : rubyxl_cell.is_bolded,
-        fill: rubyxl_cell.nil? ? 'ffffff' : rubyxl_cell.fill_color,
-        font_name: rubyxl_cell.nil? ? 'Calibri' : rubyxl_cell.font_name,
-        font_size: rubyxl_cell.nil? ? 12 : rubyxl_cell.font_size.to_i,
-        border: rubyxl_cell_to_border_hash(rubyxl_cell)
+      value: rubyxl_cell_value,
+      format: format,
+      formula: rubyxl_cell_formula(rubyxl_cell),
+      decimals: format == :number ? decimals(rubyxl_cell) : nil,
+      h_align: rubyxl_cell_h_align(rubyxl_cell),
+      v_align: rubyxl_cell_v_align(rubyxl_cell),
+      bold: rubyxl_cell.nil? ? false : rubyxl_cell.is_bolded,
+      fill: rubyxl_cell.nil? ? 'ffffff' : rubyxl_cell.fill_color,
+      font_name: rubyxl_cell.nil? ? 'Calibri' : rubyxl_cell.font_name,
+      font_size: rubyxl_cell.nil? ? 12 : rubyxl_cell.font_size.to_i,
+      border: rubyxl_cell_to_border_hash(rubyxl_cell)
     }
   end
 
+  def self.resolve_date_ms(value)
+    value_ut = value.strftime('%s')
+    ut = value.strftime('%L').to_i > 499 ? "#{value_ut.to_i + 1}" : value_ut
+    DateTime.strptime(ut, '%s')
+  end
+
+  def self.decimals(rubyxl_cell)
+    number_format = rubyxl_cell.number_format
+    return nil unless number_format
+    format_code = number_format.format_code
+    i = format_code.reverse.index('.')
+    format_code[0 - i..-1].length if i
+  end
+
   def self.rubyxl_cell_to_border_hash(rubyxl_cell)
     {
       top: rubyxl_cell.nil? ? nil : rubyxl_cell.get_border(:top),
@@ -68,28 +85,71 @@ module Cell
     rubyxl_worksheet.merge_cells(row_index, column_index, merge_column_index, merge_row_index) if combined_hash_cell[:merge]
     rubyxl_worksheet.change_column_width(column_index, combined_hash_cell[:width])  if combined_hash_cell[:width]
 
-    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_name(combined_hash_cell[:font_name]) if combined_hash_cell[:font_name]
     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[: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]
-      rubyxl_worksheet[row_index][column_index].change_border('top' , combined_hash_cell[:border_all])
-      rubyxl_worksheet[row_index][column_index].change_border('bottom' , combined_hash_cell[:border_all])
-      rubyxl_worksheet[row_index][column_index].change_border('left' , combined_hash_cell[:border_all])
-      rubyxl_worksheet[row_index][column_index].change_border('right' , combined_hash_cell[:border_all])
+    if combined_hash_cell[:border]
+      rubyxl_worksheet[row_index][column_index].change_border('top' , combined_hash_cell[:border][:top])
+      rubyxl_worksheet[row_index][column_index].change_border('bottom' , combined_hash_cell[:border][:bottom])
+      rubyxl_worksheet[row_index][column_index].change_border('left' , combined_hash_cell[:border][:left])
+      rubyxl_worksheet[row_index][column_index].change_border('right' , combined_hash_cell[:border][:right])
+    end
+  end
+
+  def self.add_rubyxl_cells(hash_cell, rubyxl_worksheet, row_index, column_index)
+    number_format = write_format(hash_cell)
+    if hash_cell[:formula]
+      if number_format
+        rubyxl_worksheet.add_cell(row_index, column_index, '', hash_cell[:formula])
+          .set_number_format(number_format)
+      else
+        rubyxl_worksheet.add_cell(row_index, column_index, '', hash_cell[:formula])
+      end
+    else
+      if number_format
+        cell_value = hash_cell[:value].is_a?(Date) ? date_to_num(hash_cell[:value]) : hash_cell[:value]
+        rubyxl_worksheet.add_cell(row_index, column_index, cell_value)
+          .set_number_format(number_format)
+      else
+        rubyxl_worksheet.add_cell(row_index, column_index, hash_cell[:value])
+      end
     end
   end
 
-  def self.add_rubyxl_cells(combined_hash_cell, rubyxl_worksheet, row_index, column_index)
-    if combined_hash_cell[:formula]
-      rubyxl_worksheet.add_cell(row_index, column_index, '', combined_hash_cell[:formula]).set_number_format combined_hash_cell[:dp_2]
+  def self.write_format(hash_cell)
+    case hash_cell[:format]
+    when :number
+      hash_cell[:decimals] ? "0.#{ '0' * hash_cell[:decimals] }" : '0'
+    when :date
+      hash_cell[:date_format] ? hash_cell[:date_format] : 'dd/mm/yyyy'
+    when :time
+      hash_cell[:date_format] ? hash_cell[:date_format] : 'hh:mm:ss'
+    when :percentage
+      hash_cell[:decimals] ? "0.#{ '0' * hash_cell[:decimals] }%" : '0%'
     else
-      rubyxl_worksheet.add_cell(row_index, column_index, combined_hash_cell[:value])
+      case hash_cell[:value].class.to_s
+      when 'Fixnum'
+        '0'
+      when 'Float'
+        value = hash_cell[:value].to_s
+        decimals = value[value.index('.') + 1..-1].length
+        "0.#{ '0' * decimals }"
+      when 'DateTime'
+        return 'dd/mm/yyyy hh:mm:ss'
+      else
+        nil
+      end
     end
   end
 
+  def self.date_to_num(date)
+    workbook = RubyXL::Workbook.new
+    workbook.date_to_num(date)
+  end
+
 
   ##################################
   ###     VALIDATE HASH CELL     ###
@@ -124,8 +184,10 @@ module Cell
   def self.valid_cell_keys
     %i[
       value
-      number
+      format
+      date_format
       formula
+      decimals
       bold
       h_align
       v_align

data/lib/rxl/version.rb

@@ -1,3 +1,3 @@
 module Rxl
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

metadata

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