excel_utils 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83f4fd8fec5396120145aefdaa76246f93310b40a6a80d9d799223546e8de9d2
-  data.tar.gz: 45cce54a288cd0e462f60341d0fc4f8884eea4c640db9f92850a50f35e1f32bf
+  metadata.gz: e0507cda2a3420f5c69d57f6ef3ba09410385a39444d1d8944532cd564db9bc8
+  data.tar.gz: 93f97d7e6e2577a7fb5d98b474c35b50d3914c503a2adde0f012c82f812cc349
 SHA512:
-  metadata.gz: 20d1dfdf88228997f8c999348541dd269ef2bd9510bb5480663a3aa9c1cef9528ffe1287c198355b55347299d0d89ba6e6946e4950bf11b9b398d66f59ecebdc
-  data.tar.gz: 7e0d52d3569e343780230ba2efff28c69f449502de5dab3931d1caa426e3748c4131d72cabe003b28d4eac70602ed5be1c031470028069dcc8d0c6ddffe11544
+  metadata.gz: a335fa0c35aae34f171ea9fe533618e4145f3316883bb7bf27156a78456e342b0dfc99b8706d2dc8eca9de8c1d6707a9d1808ce3e9ad0788c8065bb60dd0b8d7
+  data.tar.gz: b698d64e528206b7e7319c343042f2b0dea677256412ae257f3d6e24c83032cf8dc0ce8128757e6ac96a57c305b0752a1cf53b7cceaf7468732128f57272ba1a

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [ '**' ]
+  pull_request:
+    branches: [ '**' ]
+
+jobs:
+  test:
+
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.3', '2.4', '2.5', '2.6', '2.7', 'jruby-9.2.9.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/README.md

@@ -1,7 +1,7 @@
 # ExcelUtils
 
 [![Gem Version](https://badge.fury.io/rb/excel_utils.svg)](https://rubygems.org/gems/excel_utils)
-[![Build Status](https://travis-ci.org/gabynaiman/excel_utils.svg?branch=master)](https://travis-ci.org/gabynaiman/excel_utils)
+[![CI](https://github.com/gabynaiman/excel_utils/actions/workflows/ci.yml/badge.svg)](https://github.com/gabynaiman/excel_utils/actions/workflows/ci.yml)
 [![Coverage Status](https://coveralls.io/repos/github/gabynaiman/excel_utils/badge.svg?branch=master)](https://coveralls.io/github/gabynaiman/excel_utils?branch=master)
 [![Code Climate](https://codeclimate.com/github/gabynaiman/excel_utils.svg)](https://codeclimate.com/github/gabynaiman/excel_utils)
 

data/lib/excel_utils/version.rb

@@ -1,3 +1,3 @@
 module ExcelUtils
-  VERSION = '1.2.0'
-end
+  VERSION = '1.3.1'
+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
@@ -40,15 +44,18 @@ module ExcelUtils
           sheet_data.each_with_index do |row, r|
             row_index = r + 1
             header.each_with_index do |column, col_index|
-              if row[column]
-                if row[column].is_a? String
+              unless row[column].nil?
+                if row[column].is_a?(String) || row[column].is_a?(Array)
                   sheet.write_string row_index, col_index, row[column]
-                
+
+                elsif [true, false].include?(row[column])
+                  sheet.write_string row_index, col_index, row[column].to_s
+
                 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
@@ -65,4 +72,4 @@ module ExcelUtils
     end
 
   end
-end
+end

data/lib/excel_utils.rb

@@ -30,4 +30,4 @@ module ExcelUtils
     Writer.write filename, data
   end
 
-end
+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,104 @@ 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
 
-  before do
-    FileUtils.rm_rf tmp_path
-    FileUtils.mkpath tmp_path
+    expected = {'Sheet1' => expected} if expected.is_a?(Array)
+
+    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
+
+    it 'Booleans' do
+      rows = [
+        {'column_a' => true, 'column_b' => 'text 1'},
+        {'column_a' => false, 'column_b' => 'text 2'}
+      ]
+
+      assert_wrote rows, [{'column_a' => 'true', 'column_b' => 'text 1'}, {'column_a' => 'false', 'column_b' => 'text 2'}]
+    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
+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.1
 platform: ruby
 authors:
 - Gabriel Naiman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2024-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflecto
@@ -192,10 +192,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md

data/.travis.yml

@@ -1,21 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - jruby-9.1.16.0
-  - jruby-9.2.9.0
-  - ruby-head
-  - jruby-head
-
-matrix:
-  fast_finish: true
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head