excel_utils 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea8c9b8aeb5945a6d01f5ea29578bf34c48d28f8a572cb6d5f3857757fb48ae9
-  data.tar.gz: f1fc9f86e3a3fe784184cd942739e3ea961f018ea313006222568785988b6f34
+  metadata.gz: 83f4fd8fec5396120145aefdaa76246f93310b40a6a80d9d799223546e8de9d2
+  data.tar.gz: 45cce54a288cd0e462f60341d0fc4f8884eea4c640db9f92850a50f35e1f32bf
 SHA512:
-  metadata.gz: 0d7ef606b270f1af8ae88e91e12b44c657e693c7653c3df2d5b951d71758339749be6d78ee95a2c04f1e6895544cb653d8f84bae8ba619757bfc2b1bbb945dbe
-  data.tar.gz: 6eea2444670d88df36d2d4fdcca88ba4ced1ac9bfbc8890b8e2ab6b4c6b90d42a0413725599ea99e5bfc93f480bbd931cdc8516e725b04ed2c0a3c355ca00815
+  metadata.gz: 20d1dfdf88228997f8c999348541dd269ef2bd9510bb5480663a3aa9c1cef9528ffe1287c198355b55347299d0d89ba6e6946e4950bf11b9b398d66f59ecebdc
+  data.tar.gz: 7e0d52d3569e343780230ba2efff28c69f449502de5dab3931d1caa426e3748c4131d72cabe003b28d4eac70602ed5be1c031470028069dcc8d0c6ddffe11544

data/excel_utils.gemspec

@@ -19,9 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'inflecto', '~> 0.0'
-  spec.add_runtime_dependency 'roo', '~> 2.7'
-  spec.add_runtime_dependency 'roo-xls', '~> 1.1'
+  spec.add_runtime_dependency 'roo', '~> 2.8'
+  spec.add_runtime_dependency 'roo-xls', '~> 1.2'
   spec.add_runtime_dependency 'write_xlsx', '~> 0.85'
+  spec.add_runtime_dependency 'nesquikcsv', '~> 0.1'
 
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'minitest', '~> 5.0', '< 5.11'

data/lib/excel_utils.rb

@@ -4,16 +4,26 @@ require 'roo'
 require 'roo-xls'
 require 'write_xlsx'
 require 'inflecto'
+require 'nesquikcsv'
 
 require_relative 'excel_utils/version'
-require_relative 'excel_utils/workbook'
-require_relative 'excel_utils/sheet'
+require_relative 'excel_utils/workbooks/csv'
+require_relative 'excel_utils/workbooks/excel'
+require_relative 'excel_utils/sheets/base'
+require_relative 'excel_utils/sheets/csv'
+require_relative 'excel_utils/sheets/excel'
+require_relative 'excel_utils/sheets/excel_stream'
 require_relative 'excel_utils/writer'
 
 module ExcelUtils
-  
+
   def self.read(filename, **options)
-    Workbook.new filename, **options
+    extension = options.fetch(:extension, File.extname(filename)[1..-1])
+    if extension == 'csv'
+      Workbooks::CSV.new(filename, **options)
+    else
+      Workbooks::Excel.new(filename, **options)
+    end
   end
 
   def self.write(filename, data)

data/lib/excel_utils/sheets/base.rb

@@ -0,0 +1,41 @@
+module ExcelUtils
+  module Sheets
+    class Base
+
+      include Enumerable
+
+      attr_reader :name, :normalize_column_names
+
+      def initialize(name:, normalize_column_names: false)
+        @name = name
+        @normalize_column_names = normalize_column_names
+      end
+
+      def column_names
+        @column_names ||= normalize_column_names ? normalize_columns(first_row) : first_row
+      end
+
+      def each
+        if column_names.any?
+          each_row do |row|
+            break if empty_row? row
+            yield Hash[column_names.zip(row)]
+          end
+        end
+      end
+
+      private
+
+      def normalize_columns(names)
+        names.map do |name|
+          Inflecto.underscore(name.strip.gsub(' ', '_')).to_sym
+        end
+      end
+
+      def empty_row?(row)
+        row.all? { |cell| cell.to_s.strip.empty? }
+      end
+
+    end
+  end
+end

data/lib/excel_utils/sheets/csv.rb

@@ -0,0 +1,28 @@
+module ExcelUtils
+  module Sheets
+    class CSV < Base
+
+      def initialize(filename:, **options)
+        super(**options)
+        @filename = filename
+      end
+
+      private
+
+      attr_reader :filename
+
+      def first_row
+        NesquikCSV.open(filename) { |csv| csv.readline } || []
+      end
+
+      def each_row
+        first = true
+        NesquikCSV.foreach(filename) do |row|
+          yield row unless first
+          first = false
+        end
+      end
+
+    end
+  end
+end

data/lib/excel_utils/sheets/excel.rb

@@ -0,0 +1,35 @@
+module ExcelUtils
+  module Sheets
+    class Excel < Base
+
+      def initialize(spreadsheet:, **options)
+        super(**options)
+        @spreadsheet = spreadsheet
+      end
+
+      private
+
+      attr_reader :spreadsheet
+
+      def first_row
+        with_sheet do |sheet|
+          sheet.first_row ? sheet.row(sheet.first_row) : []
+        end
+      end
+
+      def each_row
+        with_sheet do |sheet|
+          (sheet.first_row + 1).upto(sheet.last_row) do |i|
+            yield sheet.row(i)
+          end
+        end
+      end
+
+      def with_sheet
+        yield spreadsheet.sheet(name)
+      end
+
+    end
+
+  end
+end

data/lib/excel_utils/sheets/excel_stream.rb

@@ -0,0 +1,35 @@
+module ExcelUtils
+  module Sheets
+    class ExcelStream < Base
+
+      def initialize(spreadsheet:, **options)
+        super(**options)
+        @spreadsheet = spreadsheet
+      end
+
+      private
+
+      attr_reader :spreadsheet
+
+      def first_row
+        row = sheet.each_row_streaming(pad_cells: true, max_rows: 0).first || []
+        normalize_row row
+      end
+
+      def each_row
+        sheet.each_row_streaming(pad_cells: true, offset: 1) do |row|
+          yield normalize_row(row)
+        end
+      end
+
+      def normalize_row(row)
+        row.map { |cell| cell ? cell.value : cell }
+      end
+
+      def sheet
+        spreadsheet.sheet name
+      end
+
+    end
+  end
+end

data/lib/excel_utils/version.rb

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

data/lib/excel_utils/workbooks/csv.rb

@@ -0,0 +1,36 @@
+module ExcelUtils
+  module Workbooks
+    class CSV
+
+      SHEET_NAME = 'default'.freeze
+
+      attr_reader :filename, :normalize_column_names
+
+      def initialize(filename, normalize_column_names: false)
+        @filename = filename
+        @normalize_column_names = normalize_column_names
+
+        @sheet = Sheets::CSV.new name: SHEET_NAME,
+                                 normalize_column_names: normalize_column_names,
+                                 filename: filename
+      end
+
+      def sheets
+        [sheet]
+      end
+
+      def [](sheet_name)
+        sheet_name == SHEET_NAME ? sheet : nil
+      end
+
+      def to_h
+        {SHEET_NAME => sheet.to_a}
+      end
+
+      private
+
+      attr_reader :sheet
+
+    end
+  end
+end

data/lib/excel_utils/workbooks/excel.rb

@@ -0,0 +1,41 @@
+module ExcelUtils
+  module Workbooks
+    class Excel
+
+      attr_reader :filename, :normalize_column_names
+
+      def initialize(filename, normalize_column_names: false, extension: nil)
+        @filename = filename
+        @normalize_column_names = normalize_column_names
+        @spreadsheet = Roo::Spreadsheet.open filename, extension: extension
+      end
+
+      def sheets
+        @sheets ||= spreadsheet.sheets.map do |name|
+          sheet_class.new name: name,
+                          normalize_column_names: normalize_column_names,
+                          spreadsheet: spreadsheet
+        end
+      end
+
+      def [](sheet_name)
+        sheets.detect { |sheet| sheet.name == sheet_name }
+      end
+
+      def to_h
+        sheets.each_with_object({}) do |sheet, hash|
+          hash[sheet.name] = sheet.to_a
+        end
+      end
+
+      private
+
+      attr_reader :spreadsheet
+
+      def sheet_class
+        @sheet_class ||= spreadsheet.respond_to?(:each_row_streaming) ? Sheets::ExcelStream : Sheets::Excel
+      end
+
+    end
+  end
+end

data/spec/minitest_helper.rb

@@ -3,4 +3,14 @@ require 'minitest/autorun'
 require 'minitest/colorin'
 require 'pry-nav'
 
-require 'excel_utils'
+require 'excel_utils'
+
+RESOURCES_PATH = File.expand_path '../resources', __FILE__
+
+class Minitest::Test
+
+  def resource_path(relative_path)
+    File.join RESOURCES_PATH, relative_path
+  end
+
+end

data/spec/read_spec.rb

@@ -2,110 +2,151 @@ require 'minitest_helper'
 
 describe ExcelUtils, 'Read' do
 
-  def expected_rows(sheet)
-    rows_by_sheet[sheet.name].map { |r| Hash[columns_by_sheet[sheet.name].zip(r)] }
-  end
+  Dir.glob(File.join(RESOURCES_PATH, 'basic.*')).each do |filename|
 
-  let :rows_by_sheet do
-    {
-      'Sheet1' => [
-        [1.0, 'some text'],
-        [2.0, 1.35],
-        [3.0, Date.parse('2019-08-17')],
-        [4.0, nil]
-      ],
-      'Sheet2' => [
-        [123.0, 'Text 1'],
-        [456.0, 'Text 2']
-      ],
-      'Sheet3' => []
-    }
-  end
+    [true, false].each do |normalize_column_names|
+
+      describe File.basename(filename), "Workbook (normalize_column_names: #{normalize_column_names})" do
+
+        let(:workbook) { ExcelUtils.read filename, normalize_column_names: normalize_column_names }
+
+        let(:sheet) { workbook.sheets.first }
+
+        let(:csv?) { File.extname(filename) == '.csv' }
+
+        let(:expected_sheet_name) { csv? ? 'default' : 'Sheet1' }
+
+        let(:column_a) { normalize_column_names ? :column_a : 'Column A' }
+
+        let(:column_b) { normalize_column_names ? :column_b : 'Column B' }
 
-  ['xls', 'xlsx'].each do |extension|
+        let(:expected_columns) { [column_a, column_b] }
 
-    describe extension do
-  
-      let(:filename) { File.expand_path "../sample.#{extension}", __FILE__ }
+        let :expected_rows do
+          if csv?
+            [
+              {column_a => '1', column_b => 'some text'},
+              {column_a => '2', column_b => '1,35'},
+              {column_a => '3', column_b => '17/08/2019'},
+              {column_a => '4', column_b => nil}
+            ]
+          else
+            [
+              {column_a => 1, column_b => 'some text'},
+              {column_a => 2, column_b => 1.35},
+              {column_a => 3, column_b => Date.parse('2019-08-17')},
+              {column_a => 4, column_b => nil}
+            ]
+          end
+        end
 
-      describe 'Original column names' do
+        it 'filename' do
+          workbook.filename.must_equal filename
+        end
+
+        it 'normalize_column_names' do
+          workbook.normalize_column_names.must_equal normalize_column_names
+        end
 
-        let(:workbook) { ExcelUtils.read filename }
-        
-        let :columns_by_sheet do
-          {
-            'Sheet1' => ['Column A', 'Column B'],
-            'Sheet2' => ['ID', 'Value'],
-            'Sheet3' => []
-          }
+        it 'sheets' do
+          workbook.sheets.count.must_equal 1
+          workbook[workbook.sheets.first.name].must_equal sheet
         end
 
         it 'to_h' do
-          workbook.to_h.must_equal 'Sheet1' => expected_rows(workbook['Sheet1']),
-                                   'Sheet2' => expected_rows(workbook['Sheet2']),
-                                   'Sheet3' => []
+          workbook.to_h.must_equal workbook.sheets.first.name => sheet.to_a
         end
 
-        ['Sheet1', 'Sheet2', 'Sheet3'].each do |sheet_name|
+        describe 'Sheet' do
 
-          describe sheet_name do
+          it 'name' do
+            sheet.name.must_equal expected_sheet_name
+          end
 
-            let(:sheet) { workbook[sheet_name] }
+          it 'normalize_column_names' do
+            sheet.normalize_column_names.must_equal workbook.normalize_column_names
+          end
 
-            it 'Column names' do
-              sheet.column_names.must_equal columns_by_sheet[sheet_name]
-            end
+          it 'column_names' do
+            sheet.column_names.must_equal expected_columns
+          end
 
-            it 'Rows' do
-              sheet.to_a.must_equal expected_rows(sheet)
-            end
+          it 'count' do
+            sheet.count.must_equal 4
+          end
 
+          it 'to_a' do
+            sheet.to_a.must_equal expected_rows
           end
 
         end
 
       end
 
-      describe 'Normalized column names' do
+    end
 
-        let(:workbook) { ExcelUtils.read filename, normalize_column_names: true }
-        
-        let :columns_by_sheet do
-          {
-            'Sheet1' => [:column_a, :column_b],
-            'Sheet2' => [:id, :value],
-            'Sheet3' => []
-          }
-        end
+  end
 
-        ['Sheet1', 'Sheet2', 'Sheet3'].each do |sheet_name|
+  it 'empty.csv' do
+    workbook = ExcelUtils.read resource_path('empty.csv')
 
-          describe sheet_name do
+    workbook.sheets.map(&:name).must_equal ['default']
 
-            let(:sheet) { workbook[sheet_name] }
+    workbook['default'].column_names.must_equal []
+    workbook['default'].to_a.must_equal []
 
-            it 'Column names' do
-              sheet.column_names.must_equal columns_by_sheet[sheet_name]
-            end
+    workbook.to_h.must_equal 'default' => []
+  end
 
-            it 'Rows' do
-              sheet.to_a.must_equal expected_rows(sheet)
-            end
+  it 'only_headers.csv' do
+    workbook = ExcelUtils.read resource_path('only_headers.csv')
 
-          end
+    workbook.sheets.map(&:name).must_equal ['default']
 
-        end
+    workbook['default'].column_names.must_equal ['ID', 'Value']
+    workbook['default'].to_a.must_equal []
 
-      end
+    workbook.to_h.must_equal 'default' => []
+  end
 
-    end
+  it 'custom_extension.tmp' do
+    workbook = ExcelUtils.read resource_path('custom_extension.tmp'), extension: 'xlsx'
 
+    expected_rows = [
+      {'ID' => 1, 'Value' => 'Text 1'},
+      {'ID' => 2, 'Value' => 'Text 2'}
+    ]
+
+    workbook.sheets.map(&:name).must_equal ['Sheet1']
+
+    workbook['Sheet1'].column_names.must_equal ['ID', 'Value']
+    workbook['Sheet1'].to_a.must_equal expected_rows
+
+    workbook.to_h.must_equal 'Sheet1' => expected_rows
   end
 
-  it 'Force extension' do
-    filename = File.expand_path "../sample.tmp", __FILE__
-    workbook = ExcelUtils.read filename, extension: 'xlsx'
-    workbook.sheets.count.must_equal 3
+  it 'multiple.xlsx' do
+    workbook = ExcelUtils.read resource_path('multiple.xlsx'), normalize_column_names: true
+
+    workbook.sheets.map(&:name).must_equal ['Sheet1', 'Sheet2', 'Sheet3']
+
+    expected_rows_sheet_1 = [
+      {id: 1, value: 'Text 1'},
+      {id: 2, value: 'Text 2'}
+    ]
+
+    workbook['Sheet1'].column_names.must_equal [:id, :value]
+    workbook['Sheet1'].to_a.must_equal expected_rows_sheet_1
+
+    workbook['Sheet2'].column_names.must_equal [:id, :value]
+    workbook['Sheet2'].to_a.must_equal []
+
+    workbook['Sheet3'].column_names.must_equal []
+    workbook['Sheet3'].to_a.must_equal []
+
+    workbook.to_h.must_equal 'Sheet1' => expected_rows_sheet_1,
+                             'Sheet2' => [],
+                             'Sheet3' => []
   end
 
 end

data/spec/resources/basic.csv

@@ -0,0 +1,5 @@
+Column A,Column B
+1,some text
+2,"1,35"
+3,17/08/2019
+4,

data/spec/resources/only_headers.csv

@@ -0,0 +1 @@
+ID,Value

data/spec/write_spec.rb

@@ -34,7 +34,7 @@ describe ExcelUtils do
       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] 
+          row[column].must_equal data[sheet.name][i][column]
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: excel_utils
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Gabriel Naiman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflecto
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: roo-xls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: write_xlsx
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.85'
+- !ruby/object:Gem::Dependency
+  name: nesquikcsv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -188,16 +202,26 @@ files:
 - Rakefile
 - excel_utils.gemspec
 - lib/excel_utils.rb
-- lib/excel_utils/sheet.rb
+- lib/excel_utils/sheets/base.rb
+- lib/excel_utils/sheets/csv.rb
+- lib/excel_utils/sheets/excel.rb
+- lib/excel_utils/sheets/excel_stream.rb
 - lib/excel_utils/version.rb
-- lib/excel_utils/workbook.rb
+- lib/excel_utils/workbooks/csv.rb
+- lib/excel_utils/workbooks/excel.rb
 - lib/excel_utils/writer.rb
 - spec/coverage_helper.rb
 - spec/minitest_helper.rb
 - spec/read_spec.rb
-- spec/sample.tmp
-- spec/sample.xls
-- spec/sample.xlsx
+- spec/resources/basic.csv
+- spec/resources/basic.ods
+- spec/resources/basic.xls
+- spec/resources/basic.xlsm
+- spec/resources/basic.xlsx
+- spec/resources/custom_extension.tmp
+- spec/resources/empty.csv
+- spec/resources/multiple.xlsx
+- spec/resources/only_headers.csv
 - spec/write_spec.rb
 homepage: https://github.com/gabynaiman/excel_utils
 licenses:
@@ -226,7 +250,13 @@ test_files:
 - spec/coverage_helper.rb
 - spec/minitest_helper.rb
 - spec/read_spec.rb
-- spec/sample.tmp
-- spec/sample.xls
-- spec/sample.xlsx
+- spec/resources/basic.csv
+- spec/resources/basic.ods
+- spec/resources/basic.xls
+- spec/resources/basic.xlsm
+- spec/resources/basic.xlsx
+- spec/resources/custom_extension.tmp
+- spec/resources/empty.csv
+- spec/resources/multiple.xlsx
+- spec/resources/only_headers.csv
 - spec/write_spec.rb

data/lib/excel_utils/sheet.rb

@@ -1,54 +0,0 @@
-module ExcelUtils
-  class Sheet
-
-    include Enumerable
-    
-    attr_reader :name, :normalize_column_names
-    
-    def initialize(name, spreadsheet, normalize_column_names: false)
-      @name = name
-      @spreadsheet = spreadsheet
-      @normalize_column_names = normalize_column_names
-    end
-
-    def column_names
-      @column_names ||= begin
-        if sheet.first_row
-          first_row = sheet.row sheet.first_row
-          normalize_column_names ? first_row.map { |name| normalize_column name } : first_row
-        else
-          []
-        end
-      end
-    end
-
-    def each(&block)
-      rows.each(&block)
-    end
-
-    private
-
-    attr_reader :spreadsheet
-
-    def sheet
-      spreadsheet.sheet name
-    end
-
-    def rows
-      @rows ||= begin
-        if sheet.first_row
-          sheet.to_a[1..-1].map do |row| 
-            Hash[column_names.zip(row)] 
-          end
-        else
-          []
-        end
-      end
-    end
-
-    def normalize_column(name)
-      Inflecto.underscore(name.strip.gsub(' ', '_')).to_sym
-    end
-
-  end
-end

data/lib/excel_utils/workbook.rb

@@ -1,33 +0,0 @@
-module ExcelUtils
-  class Workbook
-
-    attr_reader :filename, :normalize_column_names
-    
-    def initialize(filename, normalize_column_names: false, extension: nil)
-      @filename = filename
-      @normalize_column_names = normalize_column_names
-      @spreadsheet = Roo::Spreadsheet.open filename, extension: extension
-    end
-
-    def sheets
-      @sheets ||= spreadsheet.sheets.map do |name| 
-        Sheet.new name, spreadsheet, normalize_column_names: normalize_column_names
-      end
-    end
-
-    def [](sheet_name)
-      sheets.detect { |sheet| sheet.name == sheet_name }
-    end
-
-    def to_h
-      sheets.each_with_object({}) do |sheet, hash|
-        hash[sheet.name] = sheet.to_a
-      end
-    end
-
-    private
-
-    attr_reader :spreadsheet
-
-  end
-end