excel_utils 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83f4fd8fec5396120145aefdaa76246f93310b40a6a80d9d799223546e8de9d2
-  data.tar.gz: 45cce54a288cd0e462f60341d0fc4f8884eea4c640db9f92850a50f35e1f32bf
+  metadata.gz: 70807b62912a2e82da93e85e0275b6f3f6b6a8f010f70a7924546f31f0d93087
+  data.tar.gz: 6b78f90fd4174174044c9464299bf645bc13619251b1fde6f0ac9079a00b6d14
 SHA512:
-  metadata.gz: 20d1dfdf88228997f8c999348541dd269ef2bd9510bb5480663a3aa9c1cef9528ffe1287c198355b55347299d0d89ba6e6946e4950bf11b9b398d66f59ecebdc
-  data.tar.gz: 7e0d52d3569e343780230ba2efff28c69f449502de5dab3931d1caa426e3748c4131d72cabe003b28d4eac70602ed5be1c031470028069dcc8d0c6ddffe11544
+  metadata.gz: c8619bbea23bbad8b25c4014e0ead0bb8b81d901dce0c0e355e47b3b1fd2742f7c307d25980afc7d5066515ef33547d89d8c71df586ffe06bcdd3bc5dc6f9de4
+  data.tar.gz: 98a84f2fa77259e4ce3bbb691d267d4427e7e887eb0a41385ee7b82e59b7e1e6d06e1da333a257f3cdc9c54768a530c7c709608c3e8b89726c89ae61185b46fa

data/lib/excel_utils.rb

@@ -30,4 +30,4 @@ module ExcelUtils
     Writer.write filename, data
   end
 
-end
+end

data/lib/excel_utils/version.rb

@@ -1,3 +1,3 @@
 module ExcelUtils
-  VERSION = '1.2.0'
-end
+  VERSION = '1.3.0'
+end

data/lib/excel_utils/writer.rb

@@ -1,20 +1,24 @@
 module ExcelUtils
   class Writer
 
-    TIME_FORMAT = '%Y-%m-%dT%H:%M:%S'
+    DEFAULT_SHEET_NAME = 'Sheet1'.freeze
+
+    TIME_FORMAT = '%Y-%m-%dT%H:%M:%S'.freeze
 
     EXCEL_FORMATS = {
       date: 'yyyy-mm-dd',
       date_time: 'yyyy-mm-dd hh:mm:ss'
-    }
+    }.freeze
 
     class << self
-    
+
       def write(filename, data)
         workbook = WriteXLSX.new filename, strings_to_urls: false
 
         formats = add_formats workbook
 
+        data = {DEFAULT_SHEET_NAME => data} if data.is_a? Array
+
         data.each do |sheet_name, sheet_data|
           add_sheet workbook, sheet_name, sheet_data, formats
         end
@@ -41,14 +45,14 @@ module ExcelUtils
             row_index = r + 1
             header.each_with_index do |column, col_index|
               if row[column]
-                if row[column].is_a? String
+                if row[column].is_a?(String) || row[column].is_a?(Array)
                   sheet.write_string row_index, col_index, row[column]
-                
+
                 elsif row[column].respond_to? :to_time
                   time = row[column].to_time
                   type = date?(time) ? :date : :date_time
                   sheet.write_date_time row_index, col_index, time.to_time.strftime(TIME_FORMAT), formats[type]
-                
+
                 else
                   sheet.write row_index, col_index, row[column]
                 end

data/spec/minitest_helper.rb

@@ -7,10 +7,23 @@ require 'excel_utils'
 
 RESOURCES_PATH = File.expand_path '../resources', __FILE__
 
+TMP_PATH = File.expand_path '../../tmp', __FILE__
+FileUtils.mkpath TMP_PATH unless Dir.exists? TMP_PATH
+
 class Minitest::Test
 
   def resource_path(relative_path)
     File.join RESOURCES_PATH, relative_path
   end
 
+  def tmp_path(relative_path)
+    File.join TMP_PATH, relative_path
+  end
+
+end
+
+Minitest.after_run do
+  Dir.glob(File.join(TMP_PATH, '*')).each do |filename|
+    FileUtils.remove_file filename
+  end
 end

data/spec/write_spec.rb

@@ -2,42 +2,95 @@ require 'minitest_helper'
 
 describe ExcelUtils do
 
-  let(:tmp_path) { File.expand_path '../../tmp', __FILE__ }
+  def assert_wrote(data, expected=data)
+    filename = tmp_path "#{SecureRandom.uuid}.xlsx"
 
-  let(:filename) { File.join tmp_path, "#{SecureRandom.uuid}.xlsx" }
+    ExcelUtils.write filename, data
+
+    workbook = ExcelUtils.read filename
+
+    expected = {'Sheet1' => expected} if expected.is_a?(Array)
 
-  before do
-    FileUtils.rm_rf tmp_path
-    FileUtils.mkpath tmp_path
+    workbook.to_h.must_equal expected
   end
 
-  it 'Write' do
-    long_url = 'https://external.xx.fbcdn.net/safe_image.php?d=AQCY1f77h1RtuFfa&w=720&h=720&url=https%3A%2F%2Fwww.mercadolibre.com%2Fjms%2Fmla%2Flgz%2Fbackground%2Fsession%2Farmor.c27f26204365785956aaf9b30c289d0d4b0a201b4b01dfc3d83162b82608973be9a82ac85c2097c3f23b522681adca38b143f5e1a10fda251b430051a1592bf19caba204c07179120c48d47a1ceb5a45.774f4b8036d4b909101bab92870d262a%3Fbackground%3Darmor.c27f26204365785956aaf9b30c289d0d4b0a201b4b01dfc3d83162b82608973be9a82ac85c2097c3f23b522681adca38b143f5e1a10fda251b430051a1592bf19caba204c07179120c48d47a1ceb5a45.774f4b8036d4b909101bab92870d262a%26message%3DeyJqc190eXBlIjoianNfY29va2llIiwidmFsdWUiOiJ4In0&cfs=1&_nc_hash=AQB9Sf1HyWCwCVhF'
-    long_text = 'AQCY1f77h1RtuFfa&w=720&h=720&url=https%3A%2F%2Fwww.mercadolibre.com%2Fjms%2Fmla%2Flgz%2Fbackground%2Fsession%2Farmor.c27f26204365785956aaf9b30c289d0d4b0a201b4b01dfc3d83162b82608973be9a82ac85c2097c3f23b522681adca38b143f5e1a10fda251b430051a1592bf19caba204c07179120c48d47a1ceb5a45.774f4b8036d4b909101bab92870d262a%3Fbackground%3Darmor.c27f26204365785956aaf9b30c289d0d4b0a201b4b01dfc3d83162b82608973be9a82ac85c2097c3f23b522681adca38b143f5e1a10fda251b430051a1592bf19caba204c07179120c48d47a1ceb5a45.774f4b8036d4b909101bab92870d262a%26message%3DeyJqc190eXBlIjoianNfY29va2llIiwidmFsdWUiOiJ4In0&cfs=1&_nc_hash=AQB9Sf1HyWCwCVhF'
+  describe 'Single sheet' do
+
+    it 'Basic data' do
+      rows = [
+        {'column_a' => '1', 'column_b' => 'text 1'},
+        {'column_a' => '2.5', 'column_b' => nil, 'column_c' => 'text 2'},
+      ]
+
+      assert_wrote rows, rows.map { |r| {'column_c' => nil}.merge r }
+    end
+
+    it 'Symbolized column names' do
+      rows = [
+        {column_a: 'text 1'},
+        {column_a: 'text 2'},
+      ]
+
+      assert_wrote rows, rows.map { |r| {'column_a' => r[:column_a]} }
+    end
+
+    it 'Long values' do
+      long_url = 'https://external.xx.fbcdn.net/safe_image.php?d=AQCY1f77h1RtuFfa&w=720&h=720&url=https%3A%2F%2Fwww.mercadolibre.com%2Fjms%2Fmla%2Flgz%2Fbackground%2Fsession%2Farmor.c27f26204365785956aaf9b30c289d0d4b0a201b4b01dfc3d83162b82608973be9a82ac85c2097c3f23b522681adca38b143f5e1a10fda251b430051a1592bf19caba204c07179120c48d47a1ceb5a45.774f4b8036d4b909101bab92870d262a%3Fbackground%3Darmor.c27f26204365785956aaf9b30c289d0d4b0a201b4b01dfc3d83162b82608973be9a82ac85c2097c3f23b522681adca38b143f5e1a10fda251b430051a1592bf19caba204c07179120c48d47a1ceb5a45.774f4b8036d4b909101bab92870d262a%26message%3DeyJqc190eXBlIjoianNfY29va2llIiwidmFsdWUiOiJ4In0&cfs=1&_nc_hash=AQB9Sf1HyWCwCVhF'
+      long_text = 'AQCY1f77h1RtuFfa&w=720&h=720&url=https%3A%2F%2Fwww.mercadolibre.com%2Fjms%2Fmla%2Flgz%2Fbackground%2Fsession%2Farmor.c27f26204365785956aaf9b30c289d0d4b0a201b4b01dfc3d83162b82608973be9a82ac85c2097c3f23b522681adca38b143f5e1a10fda251b430051a1592bf19caba204c07179120c48d47a1ceb5a45.774f4b8036d4b909101bab92870d262a%3Fbackground%3Darmor.c27f26204365785956aaf9b30c289d0d4b0a201b4b01dfc3d83162b82608973be9a82ac85c2097c3f23b522681adca38b143f5e1a10fda251b430051a1592bf19caba204c07179120c48d47a1ceb5a45.774f4b8036d4b909101bab92870d262a%26message%3DeyJqc190eXBlIjoianNfY29va2llIiwidmFsdWUiOiJ4In0&cfs=1&_nc_hash=AQB9Sf1HyWCwCVhF'
+
+      rows = [
+        {'column_a' => long_url},
+        {'column_a' => long_text},
+      ]
+
+      assert_wrote rows
+    end
+
+    it 'Numbers' do
+      rows = [
+        {'column_a' => 1},
+        {'column_a' => 2.5},
+      ]
 
+      assert_wrote rows
+    end
+
+    it 'Date and DateTime' do
+      rows = [
+        {'column_a' => DateTime.parse('2019-05-25T16:30:00')},
+        {'column_a' => Date.parse('2019-07-09')},
+      ]
+
+      assert_wrote rows
+    end
+
+    it 'Objects' do
+      rows = [
+        {'column_a' => ['text', 1]},
+        {'column_a' => {key: 123}},
+        {'column_a' => Set.new(['text', 1])}
+      ]
+
+      assert_wrote rows, rows.map { |r| {'column_a' => r['column_a'].to_s} }
+    end
+
+  end
+
+  it 'Multiple sheets' do
     data = {
-      'Sheet 1' => [
-        {'column_a' => 1.5, 'column_b' => 'text 1', 'column_c' => DateTime.parse('2019-05-25T16:30:00')},
-        {'column_b' => 'text 2', 'column_c' => Date.parse('2019-07-09'), 'column_a' => 2, 'column_d' => '0123'},
+      'strings' => [
+        {'column_a' => 'text 1', 'column_b' => 'text 2'},
+        {'column_a' => 'text 3', 'column_b' => 'text 4'}
       ],
-      'Sheet 2' => [
-        {'Column A' => long_url, 'Column B' => long_text}
+      'numbers' => [
+        {'x' => 1, 'y' => 2},
+        {'x' => 3, 'y' => 4},
+        {'x' => 5, 'y' => 6}
       ],
-      'Sheet 3' => []
+      'empty' => [],
     }
 
-    ExcelUtils.write filename, data
-
-    workbook = ExcelUtils.read filename
-
-    workbook.sheets.each do |sheet|
-      sheet.each_with_index do |row, i|
-        columns = row.keys | data[sheet.name][i].keys
-        columns.each do |column|
-          row[column].must_equal data[sheet.name][i][column]
-        end
-      end
-    end
+    assert_wrote data
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: excel_utils
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Gabriel Naiman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflecto