excel-esv 0.0.7 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f4b522fea0806b72698bc419499675d9848f5e54
-  data.tar.gz: 8c855b2015a8a1795144885e2e7c72a60d37487e
+SHA256:
+  metadata.gz: 61b9d8716af48b7a32382ba6e9558a5f9f2afc71cb6ec0e6a380686dd91ea308
+  data.tar.gz: 8d737947eb7b20510cd234a5c23a033c5eaec2a8f90d22152c8c6892de99e271
 SHA512:
-  metadata.gz: 4f1aa109f2887da7a834572e40ad4f1a7adcb8933076b58d3311ee768fa2c53144ecdb918fb70b837e98efffeefb43bbe5294788844015a2a2fb7ec2b5b99f72
-  data.tar.gz: a5cdfc529d344daef68ff7eb6fd23ae80cd6697f84b6ae3151f8e6de0ce502db53fb0289391f910a7e7a3e13ceb59fa4baca267f14dffcd76b4095398d4dea48
+  metadata.gz: e72fa2c2685e9833c15d4ea0c6278b41ca0b8f45fe296ff81f6691652cd0b477f68e69365b9bc42b3d70024738361cd8805ab0d21885de875b028febab293d0d
+  data.tar.gz: 2dacf749dcc74944f9ad3cf2ef671e123a16f8665ecfab299541cd22c702663b9e168218675cfd75cc56ef1bac455b3d90f6f554f0d3549f71928931074808ea

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["3.0", "2.7", "2.6", "2.5"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - "tmp/**/*"
+inherit_gem:
+  barsoom_utils: shared_rubocop.yml

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# 3.0.0
+
+* Returns the last value of any formula cells instead of returning a `Spreadsheet::Formula`.
+* Returns the URL of any link cells instead of returning a `Spreadsheet::Link`.
+
+# 2.0.0
+
+* `parse` now returns an actual nested `Array`, not array-like `Spreadsheet::Row` records.
+
+# 1.0.0
+
+* `send_excel` now supports a `filename:` argument, e.g. `send_excel(data, filename: "salaries.xls")`.

data/Gemfile

@@ -1,4 +1,12 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in esv.gemspec
+# Specify your gem's dependencies in excel-esv.gemspec
 gemspec
+
+group :development do
+  gem "barsoom_utils", github: "barsoom/barsoom_utils"
+  gem "bundler"
+  gem "rake"
+  gem "rspec"
+  gem "rubocop"
+end

data/README.md

@@ -2,9 +2,11 @@
 
 Ruby library/gem for Excel parsing and generation with the ease of CSV.
 
-Exporting CSVs because Excel generation is too complex? No more!
+Exporting CSVs because Excel generation is too complex? No more! CSVs can also be difficult to open correctly, e.g. in Excel on Mac.
 
-CSVs can be difficult to open correctly, e.g. in Excel on Mac.
+ESV will read and generate XLS files. There is currently no XLSX support, but Pull Requests are welcome.
+
+By design, ESV only reads and writes simple values like integers, floats, strings and dates/datetimes. When parsing a spreadsheet with formulas, you will get their last value, if known.
 
 
 ## Usage
@@ -83,6 +85,7 @@ class MyController < ApplicationController
   def show
     data = MyExcelDocument.generate("Rails")
     send_excel(data)
+    # or: send_excel(data, filename: "myfilename.xls")
   end
 
   def another_example

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/excel-esv.gemspec

@@ -1,24 +1,20 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'esv/version'
+require "esv/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "excel-esv"
   spec.version       = ESV::VERSION
-  spec.authors       = ["Henrik Nyh"]
-  spec.email         = ["henrik@nyh.se"]
+  spec.authors       = [ "Henrik Nyh" ]
+  spec.email         = [ "henrik@nyh.se" ]
   spec.summary       = %q{Excel parsing and generation with the ease of CSV.}
   spec.homepage      = "https://github.com/barsoom/excel-esv"
   spec.license       = "MIT"
+  spec.metadata      = { "rubygems_mfa_required" => "true" }
 
   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.require_paths = [ "lib" ]
 
   spec.add_dependency "spreadsheet"
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
 end

data/lib/esv/rails_controller.rb

@@ -5,11 +5,12 @@ module ESV
   module RailsController
     private
 
-    def send_excel(data)
+    def send_excel(data, filename: nil)
       send_data(
         data,
         type: ESV::CONTENT_TYPE,
         disposition: "attachment",
+        filename: filename,
       )
     end
   end

data/lib/esv/version.rb

@@ -1,3 +1,3 @@
 module ESV
-  VERSION = "0.0.7"
+  VERSION = "3.0.1"
 end

data/lib/esv.rb

@@ -25,7 +25,15 @@ module ESV
     worksheet_count = book.worksheets.length
     raise "Expected 1 worksheet, found #{worksheet_count}." if worksheet_count > 1
 
-    book.worksheet(0).to_a
+    book.worksheet(0).to_a.map(&:to_a).map { |row|
+      row.map { |cell|
+        case cell
+        when Spreadsheet::Formula then cell.value
+        when Spreadsheet::Link then cell.href
+        else cell
+        end
+      }
+    }
   end
 
   def self.parse_file(path)

data/spec/esv_spec.rb

@@ -1,6 +1,6 @@
 require "esv"
 
-describe ESV, ".generate and .parse" do
+RSpec.describe ESV, ".generate and .parse" do
   it "works" do
     data = ESV.generate do |esv|
       esv << [ "Dogs", "Cats" ]
@@ -16,19 +16,68 @@ describe ESV, ".generate and .parse" do
   end
 end
 
-describe ESV, ".parse" do
+RSpec.describe ESV, ".parse" do
   it "raises if there's more than one worksheet" do
+    excel_file_with_two_worksheets = generate_excel_file do |sheet, book|
+      book.create_worksheet
+    end
+
     expect {
       ESV.parse(excel_file_with_two_worksheets)
     }.to raise_error(/Expected 1 worksheet, found 2/)
   end
 
+  it "ignores formatting, always returning a plain array of data" do
+    excel_file_with_formatting = generate_excel_file do |sheet|
+      sheet.row(0).replace([ 1, 2 ])
+      sheet.row(0).default_format = Spreadsheet::Format.new(color: :blue)
+    end
+
+    output = ESV.parse(excel_file_with_formatting)
+
+    expect(output).to eq [
+      [ 1, 2 ],
+    ]
+
+    expect(output[0].class).to eq Array
+  end
+
+  it "returns the last value of a formula cell" do
+    excel_file_with_formula = generate_excel_file do |sheet|
+      formula = Spreadsheet::Formula.new
+      formula.value = "two"
+      sheet.row(0).replace([ "one", formula ])
+    end
+
+    output = ESV.parse(excel_file_with_formula)
+
+    expect(output).to eq [
+      [ "one", "two" ],
+    ]
+    expect(output[0].class).to eq Array
+  end
+
+
+  it "returns the URL of a link cell" do
+    excel_file_with_link = generate_excel_file do |sheet|
+      link = Spreadsheet::Link.new("https://example.com", "desc", "foo")
+      sheet.row(0).replace([ "one", link ])
+    end
+    output = ESV.parse(excel_file_with_link)
+    expect(output).to eq [
+      [ "one", "https://example.com#foo" ],
+    ]
+
+    expect(output[0][1].class).to eq String
+  end
+
   private
 
-  def excel_file_with_two_worksheets
+  def generate_excel_file(&block)
     book = Spreadsheet::Workbook.new
-    book.create_worksheet
-    book.create_worksheet
+    sheet = book.create_worksheet
+
+    block.call(sheet, book)
 
     data = ""
     fake_file = StringIO.new(data)
@@ -37,7 +86,7 @@ describe ESV, ".parse" do
   end
 end
 
-describe ESV, ".generate_file and .parse_file" do
+RSpec.describe ESV, ".generate_file and .parse_file" do
   before do
     @file = Tempfile.new("esv")
   end

data/spec/spec_helper.rb

@@ -1,23 +1,4 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause this
-# file to always be loaded, without a need to explicitly require it in any files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, make a
-# separate helper file that requires this one and then use it only in the specs
-# that actually need it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
   # These two settings work together to allow you to limit a spec run
   # to individual examples or groups you care about by tagging them with
   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
@@ -32,7 +13,7 @@ RSpec.configure do |config|
     # Use the documentation formatter for detailed output,
     # unless a formatter has already been configured
     # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
+    config.default_formatter = "doc"
   end
 
   # Print the 10 slowest examples and example groups at the
@@ -45,6 +26,7 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = :random
+  config.disable_monkey_patching!
 
   # Seed global randomization in this process using the `--seed` CLI option.
   # Setting this allows you to use `--seed` to deterministically reproduce
@@ -62,17 +44,11 @@ RSpec.configure do |config|
     expectations.syntax = :expect
   end
 
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
   config.mock_with :rspec do |mocks|
-    # Enable only the newer, non-monkey-patching expect syntax.
-    # For more details, see:
-    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
     mocks.syntax = :expect
 
     # Prevents you from mocking or stubbing a method that does not exist on
     # a real object. This is generally recommended.
     mocks.verify_partial_doubles = true
   end
-=end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: excel-esv
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 3.0.1
 platform: ruby
 authors:
 - Henrik Nyh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spreadsheet
@@ -24,48 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - henrik@nyh.se
@@ -73,8 +31,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -90,7 +51,8 @@ files:
 homepage: https://github.com/barsoom/excel-esv
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -106,11 +68,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.2.28
 signing_key: 
 specification_version: 4
 summary: Excel parsing and generation with the ease of CSV.
-test_files:
-- spec/esv_spec.rb
-- spec/spec_helper.rb
+test_files: []