roo 2.9.0 → 2.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae372e5e7ed6c045de6911c323a805fa4f60c68c2e8cd96358db03a01ff3beef
-  data.tar.gz: 6a2f09854519bd5d1b233aafcd1cf58d29343dc48e3cc735498ea2696785fd24
+  metadata.gz: cd6f8267a04fcec20134f5170360fdd0259369b0c8b319100d0304c95964a6f5
+  data.tar.gz: 6e33716242265c9c02a7cc42b22690f03114cf12bcbbe846055040fede3cd790
 SHA512:
-  metadata.gz: 5dae710a3f90d9d7038b0c4813ac0b400e6c587c2cf00be9239e27294f60046b2748b090207fce2ebaa3139a3adc681d0063bec9c1e6ee7c91cde51de1ae5861
-  data.tar.gz: 34691a95ee37cf9af6640c2090d2542db2a84558829a42b4ecab13870e2d9e73ee1d0c243cb01d536d5709158cb746bf69b1e0d0a0888226f5906bf41566e542
+  metadata.gz: 65dd59afe1dfda800c7e88547f305dbd1eb295c5715fd23dc5123618307205ae1a0c0740511739d2880b4d91cabca10fad152d522cca96a2694f8e3c1cccbd39
+  data.tar.gz: 9d239b22ee226fc3466d2445127dc2c4fc50c488249171b0b86dc17a4a41779e543e83ed3def1fe9fae26ddc67608a81733483e3757b32156d822abdbf2bc974

data/.github/workflows/pull-request.yml

@@ -0,0 +1,15 @@
+name: Changelog
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
+
+jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: amoniacou/changelog-enforcer@v1.4.0
+        with:
+          changeLogPath: 'CHANGELOG.md'
+          skipLabel: 'Skip-Changelog'

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-##  Unreleased
+##  [2.10.1] 2024-01-17
+
+### Changed/Added
+- Prevent warnings on Ruby 3.1 if finalizer is called twice [586](https://github.com/roo-rb/roo/pull/586)
+- Fix Roo::Base#each_with_pagename degraded at [576](https://github.com/roo-rb/roo/pull/576) [583](https://github.com/roo-rb/roo/pull/583)
+
+##  [2.10.0] 2023-02-07
+
+### Changed/Added
+- Fix gsub! usage for open office documents on a frozen string [581](https://github.com/roo-rb/roo/pull/581)
+- Add support for boolean values in open office files that were generated via Google Sheets [580](https://github.com/roo-rb/roo/pull/580)
+- Roo::Base#each_with_pagename returns Enumerator Object [576](https://github.com/roo-rb/roo/pull/576)
 
 ##  [2.9.0] 2022-03-19
 

data/README.md

@@ -18,26 +18,41 @@ Install as a gem
 Or add it to your Gemfile
 
 ```ruby
-gem "roo", "~> 2.8.0"
+gem "roo", "~> 2.10.0"
 ```
 ## Usage
 
-Opening a spreadsheet
+### Opening a spreadsheet
 
+You can use the `Roo::Spreadsheet` class so `roo` automatically detects which [parser class](https://github.com/roo-rb/roo/blob/master/lib/roo.rb#L17) to use for you.
 ```ruby
 require 'roo'
 
-xlsx = Roo::Spreadsheet.open('./new_prices.xlsx')
-xlsx = Roo::Excelx.new("./new_prices.xlsx")
+file_name = './new_prices.xlsx'
+xlsx = Roo::Spreadsheet.open(file_name)
+xlsx.info
+# => Returns basic info about the spreadsheet file
+```
 
-# Use the extension option if the extension is ambiguous.
-xlsx = Roo::Spreadsheet.open('./rails_temp_upload', extension: :xlsx)
+``Roo::Spreadsheet.open`` can accept both string paths and ``File`` instances. Also, you can provide the extension of the file as an option: 
+
+```ruby
+require 'roo'
 
+file_name = './rails_temp_upload'
+xlsx = Roo::Spreadsheet.open(file_name, extension: :xlsx)
 xlsx.info
 # => Returns basic info about the spreadsheet file
 ```
 
-``Roo::Spreadsheet.open`` can accept both paths and ``File`` instances.
+On the other hand, if you know what the file extension is, you can use the specific parser class instead:
+```ruby
+require 'roo'
+
+xlsx = Roo::Excelx.new("./new_prices.xlsx")
+xlsx.info
+# => Returns basic info about the spreadsheet file
+```
 
 ### Working with sheets
 

data/lib/roo/base.rb

@@ -250,6 +250,8 @@ class Roo::Base
 
   # iterate through all worksheets of a document
   def each_with_pagename
+    return to_enum(:each_with_pagename) { sheets.size } unless block_given?
+
     sheets.each do |s|
       yield sheet(s, true)
     end

data/lib/roo/excelx/cell/number.rb

@@ -51,7 +51,7 @@ module Roo
           when /^#,##0.(0+)$/ then number_format("%.#{$1.size}f")
           when '0%'
             proc do |number|
-              Kernel.format('%d%%', number.to_f * 100)
+              Kernel.format('%.0f%%', number.to_f * 100)
             end
           when '0.00%'
             proc do |number|
@@ -66,6 +66,16 @@ module Roo
           when '##0.0E+0' then '%.1E'
           when "_-* #,##0.00\\ _€_-;\\-* #,##0.00\\ _€_-;_-* \"-\"??\\ _€_-;_-@_-" then number_format('%.2f', '-%.2f')
           when '@' then proc { |number| number }
+          when /^(?:_\()?"([^"]*)"(?:\* )?([^_]+)/
+            proc do |number|
+              formatted_number = generate_formatter($2).call(number)
+              "#{$1}#{formatted_number}"
+            end
+          when /^_[- \(]\[\$([^-]*)[^#@]+([^_]+)/
+            proc do |number|
+              formatted_number = generate_formatter($2).call(number)
+              "#{$1}#{formatted_number}"
+            end
           else
             raise "Unknown format: #{format.inspect}"
           end

data/lib/roo/excelx/sheet_doc.rb

@@ -211,10 +211,19 @@ module Roo
         extracted_cells = {}
         empty_cell = @options[:empty_cell]
 
-        doc.xpath('/worksheet/sheetData/row/c').each do |cell_xml|
-          coordinate = ::Roo::Utils.extract_coordinate(cell_xml["r"])
-          cell = cell_from_xml(cell_xml, hyperlinks(relationships)[coordinate], coordinate, empty_cell)
-          extracted_cells[coordinate] = cell if cell
+        doc.xpath('/worksheet/sheetData/row').each.with_index(1) do |row_xml, ycoord|
+          row_xml.xpath('c').each.with_index(1) do |cell_xml, xcoord|
+            r = cell_xml['r']
+            coordinate =
+              if r.nil?
+                ::Roo::Excelx::Coordinate.new(ycoord, xcoord)
+              else
+                ::Roo::Utils.extract_coordinate(r)
+              end
+
+            cell = cell_from_xml(cell_xml, hyperlinks(relationships)[coordinate], coordinate, empty_cell)
+            extracted_cells[coordinate] = cell if cell
+          end
         end
 
         expand_merged_ranges(extracted_cells) if @options[:expand_merged_ranges]

data/lib/roo/excelx/workbook.rb

@@ -32,6 +32,7 @@ module Roo
         doc.xpath('//definedName').each_with_object({}) do |defined_name, hash|
           # "Sheet1!$C$5"
           sheet, coordinates = defined_name.text.split('!$', 2)
+          next unless coordinates
           col, row = coordinates.split('$')
           name = defined_name['name']
           hash[name] = Label.new(name, sheet, row, col)

data/lib/roo/open_office.rb

@@ -423,7 +423,10 @@ module Roo
       @style[sheet][key] = style_name
       case @cell_type[sheet][key]
       when :float
-        @cell[sheet][key] = (table_cell.attributes['value'].to_s.include?(".") || table_cell.children.first.text.include?(".")) ? v.to_f : v.to_i
+        value = (table_cell.attributes['value'].to_s.include?(".") || table_cell.children.first.text.include?(".")) ? v.to_f : v.to_i
+        value = 'true' if formula == '=TRUE()'
+        value = 'false' if formula == '=FALSE()'
+        @cell[sheet][key] = value
       when :percentage
         @cell[sheet][key] = v.to_f
       when :string
@@ -517,7 +520,7 @@ module Roo
                         str_v += child.content #.text
                       end
                     end
-                    str_v.gsub!(/'/, "'") # special case not supported by unescapeHTML
+                    str_v = str_v.gsub(/'/, "'") # special case not supported by unescapeHTML
                     str_v = CGI.unescapeHTML(str_v)
                   end # == 'p'
                 end

data/lib/roo/tempdir.rb

@@ -4,7 +4,10 @@ module Roo
       if @tempdirs && (dirs_to_remove = @tempdirs[object_id])
         @tempdirs.delete(object_id)
         dirs_to_remove.each do |dir|
-          ::FileUtils.remove_entry(dir)
+          # Pass force=true to avoid an exception (and thus warnings in Ruby 3.1) if dir has
+          # already been removed. This can occur when the finalizer is called both in a forked
+          # child process and in the parent.
+          ::FileUtils.remove_entry(dir, true)
         end
       end
     end

data/lib/roo/version.rb

@@ -1,3 +1,3 @@
 module Roo
-  VERSION = "2.9.0"
+  VERSION = "2.10.1"
 end

data/spec/lib/roo/base_spec.rb

@@ -182,6 +182,26 @@ describe Roo::Base do
     end
   end
 
+  describe '#each_with_pagename' do
+    context 'when block given' do
+      it 'iterate with sheet and sheet_name' do
+        sheet_names = []
+        spreadsheet.each_with_pagename do |sheet_name, sheet|
+          sheet_names << sheet_name
+        end
+        expect(sheet_names).to eq ['my_sheet', 'blank sheet']
+      end
+    end
+
+    context 'when called without block' do
+      it 'should return an enumerator with all the rows' do
+        each_with_pagename = spreadsheet.each_with_pagename
+        expect(each_with_pagename).to be_a(Enumerator)
+        expect(each_with_pagename.to_a.last).to eq([spreadsheet.default_sheet, spreadsheet])
+      end
+    end
+  end
+
   describe '#each' do
     it 'should return an enumerator with all the rows' do
       each = spreadsheet.each

data/spec/lib/roo/excelx_spec.rb

@@ -326,6 +326,30 @@ describe Roo::Excelx do
         expect(subject.formatted_value(4, 1)).to eq '05010'
       end
     end
+
+    context 'contains US currency' do
+      let(:path) { 'test/files/currency-us.xlsx' }
+
+      it 'returns a zero-padded number' do
+        expect(subject.formatted_value(4, 1)).to eq '$20.51'
+      end
+    end
+
+    context 'contains euro currency' do
+      let(:path) { 'test/files/currency-euro.xlsx' }
+
+      it 'returns a zero-padded number' do
+        expect(subject.formatted_value(4, 1)).to eq '€20.51'
+      end
+    end
+
+    context 'contains uk currency' do
+      let(:path) { 'test/files/currency-uk.xlsx' }
+
+      it 'returns a zero-padded number' do
+        expect(subject.formatted_value(4, 1)).to eq '£20.51'
+      end
+    end
   end
 
   describe '#row' do
@@ -609,6 +633,17 @@ describe Roo::Excelx do
     end
   end
 
+  describe 'opening a file with filters' do
+    let(:path) { 'test/files/wrong_coordinates.xlsx' }
+    subject(:xlsx) do
+      Roo::Spreadsheet.open(path)
+    end
+
+    it 'should properly extract defined_names' do
+      expect(subject.sheet(0).workbook.defined_names.length).to eq(1)
+    end
+  end
+
   describe 'images' do
     let(:path) { 'test/files/images.xlsx' }
 

data/test/excelx/cell/test_number.rb

@@ -35,6 +35,11 @@ class TestRooExcelxCellNumber < Minitest::Test
     assert_kind_of(Float, cell.value)
   end
 
+  def test_rounded_percent_formatted_value
+    cell = Roo::Excelx::Cell::Number.new '0.569999999995', nil, ['0%'], nil, nil, nil
+    assert_equal('57%', cell.formatted_value)
+  end
+
   def test_formats_with_negative_numbers
     [
       ['#,##0 ;(#,##0)', '(1,042)'],

data/test/helpers/test_accessing_files.rb

@@ -36,6 +36,27 @@ module TestAccesingFiles
     end
   end
 
+  def test_finalize_twice
+    skip if defined? JRUBY_VERSION
+
+    instance = Class.new { include Roo::Tempdir }.new
+
+    tempdir = instance.make_tempdir(instance, "my_temp_prefix", nil)
+    assert File.exist?(tempdir), "Expected #{tempdir} to initially exist"
+
+    pid = Process.fork do
+      # Inside the forked process finalize does not affect the parent process's state, but does
+      # delete the tempfile on disk
+      instance.finalize_tempdirs(instance.object_id)
+    end
+
+    Process.wait(pid)
+    refute File.exist?(tempdir), "Expected #{tempdir} to have been cleaned up by child process"
+
+    instance.finalize_tempdirs(instance.object_id)
+    refute File.exist?(tempdir), "Expected #{tempdir} to still have been cleaned up"
+  end
+
   def test_cleanup_on_error
     # NOTE: This test was occasionally failing because when it started running
     #       other tests would have already added folders to the temp directory,

data/test/roo/test_excelx.rb

@@ -341,6 +341,15 @@ class TestRworkbookExcelx < Minitest::Test
     assert_equal "Example richtext", xlsx.cell("b", 1)
   end
 
+  def test_implicit_coordinates
+    xlsx = roo_class.new(File.join(TESTDIR, 'implicit_coordinates.xlsx'))
+
+    assert_equal 'Test', xlsx.cell('a', 1)
+    assert_equal 'A2', xlsx.cell('a', 2)
+    assert_equal 'B2', xlsx.cell(2, 2)
+    assert_equal 'C2', xlsx.cell('c', 2)
+  end
+
   def roo_class
     Roo::Excelx
   end

data/test/test_roo.rb

@@ -274,6 +274,24 @@ class TestRoo < Minitest::Test
     end
   end
 
+  def test_cell_boolean_from_google_sheets
+    with_each_spreadsheet(:name=>'boolean-from-google-sheets', :format=>[:openoffice, :excelx]) do |oo|
+      if oo.class == Roo::Excelx
+        assert_equal true, oo.cell(1, 1), "failure in #{oo.class}"
+        assert_equal false, oo.cell(2, 1), "failure in #{oo.class}"
+
+        cell = oo.sheet_for(oo.default_sheet).cells[[1, 1,]]
+        assert_equal 'TRUE', cell.formatted_value
+
+        cell = oo.sheet_for(oo.default_sheet).cells[[2, 1,]]
+        assert_equal 'FALSE', cell.formatted_value
+      else
+        assert_equal "true", oo.cell(1,1), "failure in #{oo.class}"
+        assert_equal "false", oo.cell(2,1), "failure in #{oo.class}"
+      end
+    end
+  end
+
   def test_cell_multiline
     with_each_spreadsheet(:name=>'paragraph', :format=>[:openoffice, :excelx]) do |oo|
       assert_equal "This is a test\nof a multiline\nCell", oo.cell(1,1)
@@ -282,6 +300,18 @@ class TestRoo < Minitest::Test
     end
   end
 
+  def test_apostrophe_replacement
+    with_each_spreadsheet(:name=>'apostrophe', :format=>[:openoffice]) do |oo|
+      assert_equal "'", oo.cell(1,1)
+    end
+  end
+
+  def test_frozen_string_usage
+    with_each_spreadsheet(:name=>'frozen_string', :format=>[:openoffice]) do |oo|
+      assert_equal "", oo.cell(1,1)
+    end
+  end
+
   def test_row_whitespace
     # auf dieses Dokument habe ich keinen Zugriff TODO:
     # TODO: No access to document whitespace?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roo
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.1
 platform: ruby
 authors:
 - Thomas Preymesser
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-19 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -133,6 +133,7 @@ files:
 - ".codeclimate.yml"
 - ".github/issue_template.md"
 - ".github/pull_request_template.md"
+- ".github/workflows/pull-request.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -255,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Roo can access the contents of various spreadsheet files.