excel_utils 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13a477a8679749794ff54f4bb0a76c653b354be459d50ed1d7c89a6de8a32509
+  data.tar.gz: 920a86b0b1fb587105d7fc78609cf5bdd98a231aa6bee22726ebdfc090b3daca
+SHA512:
+  metadata.gz: cfb43adfda51aa543e1dd13e00f952b9eb0d2c9cec9dd7b41119eea1b2e0b2db433e47040c224dda7069f0ff0ec0b6d17f43f215f50e60a66db4545ecc740f5a
+  data.tar.gz: c1f424a05025b504b92cd5bf5b67f53c60129ad1973045daf263acf837301e61cc2681a9ce87a3ad90ba20e82a8ac1ef51891e9b2f6d387f4c3756fa6145a74f

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: OZLK28dktucmypLk1pqoEK2yTrWfEfIlw

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+excel_utils

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.0

data/.travis.yml

@@ -0,0 +1,21 @@
+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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in excel_utils.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Gabriel Naiman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# 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)
+[![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)
+
+Excel utils for easy read and write
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'excel_utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install excel_utils
+
+## Usage
+
+### Write
+```ruby
+data = {
+  'Sheet1' => [
+    {column_a: 1.0, column_b: 'some text'},
+    {column_a: 2.0, column_b: 1.35},
+    {column_a: 3.0, column_b: Date.parse('2019-08-17')},
+    {column_a: 4.0, column_b: nil}
+  ],
+  'Sheet2' => [
+    {'Column 1' => 123.0, 'Column 2' => 'Text 1'},
+    {'Column 1' => 456.0, 'Column 2' => 'Text 2'}
+  ],
+  'Sheet3' => []
+}
+
+ExcelUtils.write '/path/to/file.xlsx', data
+```
+
+### Read
+```ruby
+workbook = ExcelUtils.read '/path/to/file.xlsx'
+workbook.to_h => # {'Sheet1' => [{'Column A' => 1, ...}, ...], ...}
+sheet = workbook['Sheet1']
+sheet.name => # 'Sheet1'
+sheet.column_names => # ['Column A', ...]
+sheet.each # Implements enumerable module (map, to_a, ...)
+
+workbook = ExcelUtils.read '/path/to/file.xlsx', normalize_column_names: true
+workbook.to_h => # {'Sheet1' => [{column_a: 1, ...}, ...], ...}
+sheet = workbook.sheets.first
+sheet.column_names => # [:column_a, ...]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gabynaiman/excel_utils.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,25 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.libs << 'lib'
+  t.pattern = ENV['DIR'] ? File.join(ENV['DIR'], '**', '*_spec.rb') : 'spec/**/*_spec.rb'
+  t.verbose = false
+  t.warning = false
+  t.loader = nil if ENV['TEST']
+  ENV['TEST'], ENV['LINE'] = ENV['TEST'].split(':') if ENV['TEST'] && !ENV['LINE']
+  t.options = ''
+  t.options << "--name=/#{ENV['NAME']}/ " if ENV['NAME']
+  t.options << "-l #{ENV['LINE']} " if ENV['LINE'] && ENV['TEST']
+end
+
+task default: :spec
+
+desc 'Pry console'
+task :console do
+  require 'excel_utils'
+  require 'pry'
+  ARGV.clear
+  Pry.start
+end

data/excel_utils.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/excel_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'excel_utils'
+  spec.version       = ExcelUtils::VERSION
+  spec.authors       = ['Gabriel Naiman']
+  spec.email         = ['gabynaiman@gmail.com']
+  spec.summary       = 'Excel utils for easy read and write'
+  spec.description   = 'Excel utils for easy read and write'
+  spec.homepage      = 'https://github.com/gabynaiman/excel_utils'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  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 'write_xlsx', '~> 0.85'
+
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'minitest', '~> 5.0', '< 5.11'
+  spec.add_development_dependency 'minitest-colorin', '~> 0.1'
+  spec.add_development_dependency 'minitest-line', '~> 0.6'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'pry-nav', '~> 0.2'
+end

data/lib/excel_utils.rb

@@ -0,0 +1,23 @@
+require 'date'
+require 'time'
+require 'roo'
+require 'roo-xls'
+require 'write_xlsx'
+require 'inflecto'
+
+require_relative 'excel_utils/version'
+require_relative 'excel_utils/workbook'
+require_relative 'excel_utils/sheet'
+require_relative 'excel_utils/writer'
+
+module ExcelUtils
+  
+  def self.read(filename, **options)
+    Workbook.new filename, **options
+  end
+
+  def self.write(filename, data)
+    Writer.write filename, data
+  end
+
+end

data/lib/excel_utils/sheet.rb

@@ -0,0 +1,50 @@
+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 { |n| Inflecto.underscore(n.strip.gsub(' ', '_')).to_sym } : 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
+
+  end
+end

data/lib/excel_utils/version.rb

@@ -0,0 +1,3 @@
+module ExcelUtils
+  VERSION = '1.0.0'
+end

data/lib/excel_utils/workbook.rb

@@ -0,0 +1,33 @@
+module ExcelUtils
+  class Workbook
+
+    attr_reader :filename, :normalize_column_names
+    
+    def initialize(filename, normalize_column_names: false)
+      @filename = filename
+      @normalize_column_names = normalize_column_names
+      @spreadsheet = Roo::Spreadsheet.open filename
+    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

data/lib/excel_utils/writer.rb

@@ -0,0 +1,63 @@
+module ExcelUtils
+  class Writer
+
+    TIME_FORMAT = '%Y-%m-%dT%H:%M:%S'
+
+    EXCEL_FORMATS = {
+      date: 'yyyy-mm-dd',
+      date_time: 'yyyy-mm-dd hh:mm:ss'
+    }
+
+    class << self
+    
+      def write(filename, data)
+        workbook = WriteXLSX.new filename, strings_to_urls: false
+
+        formats = add_formats workbook
+
+        data.each do |sheet_name, sheet_data|
+          add_sheet workbook, sheet_name, sheet_data, formats
+        end
+
+        workbook.close
+      end
+
+      private
+
+      def add_formats(workbook)
+        EXCEL_FORMATS.each_with_object({}) do |(type, value), formats|
+          formats[type] = workbook.add_format num_format: value
+        end
+      end
+
+      def add_sheet(workbook, sheet_name, sheet_data, formats)
+        sheet = workbook.add_worksheet sheet_name
+
+        if sheet_data.any?
+          header = sheet_data.first.keys
+          sheet.write_row 0, 0, header.map(&:to_s)
+
+          sheet_data.each_with_index do |row, r|
+            header.each_with_index do |column, c|
+              if row[column]
+                if row[column].respond_to? :to_time
+                  time = row[column].to_time
+                  type = date?(time) ? :date : :date_time
+                  sheet.write_date_time r + 1, c, time.to_time.strftime(TIME_FORMAT), formats[type]
+                else
+                  sheet.write r + 1, c, row[column]
+                end
+              end
+            end
+          end
+        end
+      end
+
+      def date?(time)
+        time.hour + time.min + time.sec == 0
+      end
+
+    end
+
+  end
+end

data/spec/coverage_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new [SimpleCov::Formatter::HTMLFormatter, Coveralls::SimpleCov::Formatter]
+SimpleCov.start

data/spec/minitest_helper.rb

@@ -0,0 +1,6 @@
+require 'coverage_helper'
+require 'minitest/autorun'
+require 'minitest/colorin'
+require 'pry-nav'
+
+require 'excel_utils'

data/spec/read_spec.rb

@@ -0,0 +1,105 @@
+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
+
+  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
+
+  ['xls', 'xlsx'].each do |extension|
+
+    describe extension do
+  
+      let(:filename) { File.expand_path "../sample.#{extension}", __FILE__ }
+
+      describe 'Original column names' do
+
+        let(:workbook) { ExcelUtils.read filename }
+        
+        let :columns_by_sheet do
+          {
+            'Sheet1' => ['Column A', 'Column B'],
+            'Sheet2' => ['ID', 'Value'],
+            'Sheet3' => []
+          }
+        end
+
+        it 'to_h' do
+          workbook.to_h.must_equal 'Sheet1' => expected_rows(workbook['Sheet1']),
+                                   'Sheet2' => expected_rows(workbook['Sheet2']),
+                                   'Sheet3' => []
+        end
+
+        ['Sheet1', 'Sheet2', 'Sheet3'].each do |sheet_name|
+
+          describe sheet_name do
+
+            let(:sheet) { workbook[sheet_name] }
+
+            it 'Column names' do
+              sheet.column_names.must_equal columns_by_sheet[sheet_name]
+            end
+
+            it 'Rows' do
+              sheet.to_a.must_equal expected_rows(sheet)
+            end
+
+          end
+
+        end
+
+      end
+
+      describe 'Normalized column names' do
+
+        let(:workbook) { ExcelUtils.read filename, normalize_column_names: true }
+        
+        let :columns_by_sheet do
+          {
+            'Sheet1' => [:column_a, :column_b],
+            'Sheet2' => [:id, :value],
+            'Sheet3' => []
+          }
+        end
+
+        ['Sheet1', 'Sheet2', 'Sheet3'].each do |sheet_name|
+
+          describe sheet_name do
+
+            let(:sheet) { workbook[sheet_name] }
+
+            it 'Column names' do
+              sheet.column_names.must_equal columns_by_sheet[sheet_name]
+            end
+
+            it 'Rows' do
+              sheet.to_a.must_equal expected_rows(sheet)
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/write_spec.rb

@@ -0,0 +1,33 @@
+require 'minitest_helper'
+
+describe ExcelUtils do
+
+  let(:tmp_path) { File.expand_path '../../tmp', __FILE__ }
+
+  let(:filename) { File.join tmp_path, "#{SecureRandom.uuid}.xlsx" }
+
+  before do
+    FileUtils.rm_rf tmp_path
+    FileUtils.mkpath tmp_path
+  end
+
+  it 'Write' 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},
+      ],
+      'Sheet 2' => [
+        {'Column A' => 'Text A', 'Column B' => 'Text B'}
+      ],
+      'Sheet 3' => []
+    }
+
+    ExcelUtils.write filename, data
+
+    workbook = ExcelUtils.read filename
+
+    workbook.to_h.must_equal data
+  end
+
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: excel_utils
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gabriel Naiman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inflecto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: roo-xls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: write_xlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.85'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.85'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: minitest-colorin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-line
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Excel utils for easy read and write
+email:
+- gabynaiman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- excel_utils.gemspec
+- lib/excel_utils.rb
+- lib/excel_utils/sheet.rb
+- lib/excel_utils/version.rb
+- lib/excel_utils/workbook.rb
+- lib/excel_utils/writer.rb
+- spec/coverage_helper.rb
+- spec/minitest_helper.rb
+- spec/read_spec.rb
+- spec/sample.xls
+- spec/sample.xlsx
+- spec/write_spec.rb
+homepage: https://github.com/gabynaiman/excel_utils
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Excel utils for easy read and write
+test_files:
+- spec/coverage_helper.rb
+- spec/minitest_helper.rb
+- spec/read_spec.rb
+- spec/sample.xls
+- spec/sample.xlsx
+- spec/write_spec.rb