xsv 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ade681d66101849ddf0ecd1cb0211d309153f604cbe0fc8ed3254c7930265e0a
-  data.tar.gz: e9c0d24538cfe42affb2690f2f00a5535277013898c781aa668eecbd3329df6b
+  metadata.gz: '0755959285e8f4e588fc8f72f45c48904bc0b840c1abc7b250faf6bad978e7f0'
+  data.tar.gz: 482143461be2e72994e8d9758d1a971e87355acdd16cb027a5631956b7898927
 SHA512:
-  metadata.gz: fb21f559a6a3d8fd20192fab8c0543fbf430f49fc563e5c98e584258bb72cd0faa8b0cf8ce9792035d5db46f40a8db082eb2407c6a132e085d74cc69200c3e2a
-  data.tar.gz: 87c1ffca0e26ffdaf9a91bae58d188bffedae87508c3a91d33fb06c1fbb6c121f40dfce12af3dd5080254613ae47a5481cab996f9a6284517967fd71893ede94
+  metadata.gz: a9a48303c59d254233e12994562a341854caffde500f78e5357edebfd16dca12cf7b9b39af6c3c9e1536491f1467456c0b8295bfebf4fddda0f315ab4fbe0875
+  data.tar.gz: db9fe14a1c829ca66d2d1daa59da9bab181c5b4ba17c89ebc0703369165310ad4390e8713effc329d0ad6ce9f932a822e368b7eec6ae1e3876b4ed27d4bc0969

data/.github/workflows/ruby.yml

@@ -9,9 +9,9 @@ name: Ruby
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   test:
@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0', 'jruby', 'truffleruby']
+        ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1', 'jruby', 'truffleruby']
 
     steps:
     - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Xsv Changelog
 
+## 1.0.6 2022-01-07
+
+- Code cleanup, small performance improvements
+
 ## 1.0.5 2022-01-05
 
 - Raise exception if given an empty buffer when opening workbook (thanks @kevin-j-m)

data/benchmark.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require 'bundler/inline'
+
+gemfile do
+  source "https://rubygems.org"
+
+  gemspec
+  gem "benchmark-memory"
+  gem "benchmark-perf"
+end
+
+def bench_perf(sheet)
+  result = Benchmark::Perf.cpu(repeat: 5) do
+    sheet.each do |row|
+      row.each do |cell|
+        cell
+      end
+    end
+  end
+
+  puts "Performance benchmark: #{result.avg}s avg #{result.stdev}s stdev"
+end
+
+def bench_mem(sheet)
+  Benchmark.memory do |bm|
+    bm.report do
+      sheet.each do |row|
+        row.each do |cell|
+          cell
+        end
+      end
+    end
+  end
+end
+
+file = File.read("test/files/10k-sheet.xlsx")
+
+workbook = Xsv::Workbook.open(file)
+
+puts "--- ARRAY MODE ---"
+
+bench_perf(workbook.sheets[0])
+bench_mem(workbook.sheets[0])
+
+puts "\n--- HASH MODE ---"
+
+workbook.sheets[0].parse_headers!
+
+bench_perf(workbook.sheets[0])
+bench_mem(workbook.sheets[0])

data/lib/xsv/sax_parser.rb

@@ -5,6 +5,9 @@ module Xsv
     ATTR_REGEX = /((\S+)="(.*?)")/m
 
     def parse(io)
+      responds_to_end_element = respond_to?(:end_element)
+      responds_to_characters = respond_to?(:characters)
+
       state = :look_start
       if io.is_a?(String)
         pbuf = io.dup
@@ -32,7 +35,7 @@ module Xsv
           if (o = pbuf.index("<"))
             chars = pbuf.slice!(0, o + 1).chop!.force_encoding("utf-8")
 
-            if respond_to?(:characters) && !chars.empty?
+            if responds_to_characters && !chars.empty?
               if chars.index("&")
                 chars.gsub!("&amp;", "&")
                 chars.gsub!("&apos;", "'")
@@ -65,12 +68,12 @@ module Xsv
             end
 
             if tag_name.start_with?("/")
-              end_element(tag_name[1..-1]) if respond_to?(:end_element)
+              end_element(tag_name[1..-1]) if responds_to_end_element
             elsif args.nil?
               start_element(tag_name, nil)
             else
               start_element(tag_name, args.scan(ATTR_REGEX).each_with_object({}) { |m, h| h[m[1].to_sym] = m[2] })
-              end_element(tag_name) if args.end_with?("/") && respond_to?(:end_element)
+              end_element(tag_name) if responds_to_end_element && args.end_with?("/")
             end
 
             state = :look_start

data/lib/xsv/sheet_bounds_handler.rb

@@ -30,8 +30,8 @@ module Xsv
       @state = nil
       @cell = nil
       @row = nil
-      @maxRow = 0
-      @maxColumn = 0
+      @max_row = 0
+      @max_column = 0
       @trim_empty_rows = trim_empty_rows
     end
 
@@ -42,28 +42,28 @@ module Xsv
         @cell = attrs[:r]
       when "v"
         col = column_index(@cell)
-        @maxColumn = col if col > @maxColumn
-        @maxRow = @row if @row > @maxRow
+        @max_column = col if col > @max_column
+        @max_row = @row if @row > @max_row
       when "row"
         @state = name
         @row = attrs[:r].to_i
       when "dimension"
         @state = name
 
-        _firstCell, lastCell = attrs[:ref].split(":")
+        _first_cell, last_cell = attrs[:ref].split(":")
 
-        if lastCell
-          @maxColumn = column_index(lastCell)
+        if last_cell
+          @max_column = column_index(last_cell)
           unless @trim_empty_rows
-            @maxRow = lastCell[/\d+$/].to_i
-            @block.call(@maxRow, @maxColumn)
+            @max_row = last_cell[/\d+$/].to_i
+            @block.call(@max_row, @max_column)
           end
         end
       end
     end
 
     def end_element(name)
-      @block.call(@maxRow, @maxColumn) if name == "sheetData"
+      @block.call(@max_row, @max_column) if name == "sheetData"
     end
   end
 end

data/lib/xsv/sheet_rows_handler.rb

@@ -14,11 +14,11 @@ module Xsv
       @last_row = last_row - @row_skip
       @block = block
 
-      @state = nil
+      @store_characters = false
 
       @row_index = 0
       @current_row = {}
-      @current_row_attrs = {}
+      @current_row_number = 0
       @current_cell = {}
       @current_value = +""
 
@@ -28,44 +28,36 @@ module Xsv
     def start_element(name, attrs)
       case name
       when "c"
-        @state = name
         @current_cell = attrs
         @current_value.clear
-      when "v", "is"
-        @state = name
+      when "v", "is", "t"
+        @store_characters = true
       when "row"
-        @state = name
         @current_row = @empty_row.dup
-        @current_row_attrs = attrs
-      when "t"
-        @state = nil unless @state == "is"
-      else
-        @state = nil
+        @current_row_number = attrs[:r].to_i
       end
     end
 
     def characters(value)
-      @current_value << value if @state == "v" || @state == "is"
+      @current_value << value if @store_characters
     end
 
     def end_element(name)
       case name
-      when "v"
-        @state = nil
+      when "v", "is", "t"
+        @store_characters = false
       when "c"
         col_index = column_index(@current_cell[:r])
 
-        case @mode
-        when :array
+        if @mode == :array
           @current_row[col_index] = format_cell
-        when :hash
+        else
           @current_row[@headers[col_index]] = format_cell
         end
       when "row"
-        real_row_number = @current_row_attrs[:r].to_i
-        adjusted_row_number = real_row_number - @row_skip
+        return if @current_row_number <= @row_skip
 
-        return if real_row_number <= @row_skip
+        adjusted_row_number = @current_row_number - @row_skip
 
         @row_index += 1
 
@@ -98,10 +90,7 @@ module Xsv
         nil
       when nil, "n"
         if @current_cell[:s]
-          style = @workbook.xfs[@current_cell[:s].to_i]
-          numFmt = @workbook.numFmts[style[:numFmtId].to_i]
-
-          parse_number_format(@current_value, numFmt)
+          parse_number_format(@current_value, @workbook.get_num_fmt(@current_cell[:s].to_i))
         else
           parse_number(@current_value)
         end

data/lib/xsv/styles_handler.rb

@@ -5,21 +5,21 @@ module Xsv
   # This is used internally when opening a sheet.
   class StylesHandler < SaxParser
     def self.get_styles(io)
-      handler = new(Xsv::Helpers::BUILT_IN_NUMBER_FORMATS.dup) do |xfs, numFmts|
+      handler = new(Xsv::Helpers::BUILT_IN_NUMBER_FORMATS.dup) do |xfs, num_fmts|
         @xfs = xfs
-        @numFmts = numFmts
+        @num_fmts = num_fmts
       end
 
       handler.parse(io)
 
-      [@xfs, @numFmts]
+      [@xfs, @num_fmts]
     end
 
-    def initialize(numFmts, &block)
+    def initialize(num_fmts, &block)
       @block = block
       @state = nil
       @xfs = []
-      @numFmts = numFmts
+      @num_fmts = num_fmts
     end
 
     def start_element(name, attrs)
@@ -27,16 +27,16 @@ module Xsv
       when "cellXfs"
         @state = "cellXfs"
       when "xf"
-        @xfs << attrs if @state == "cellXfs"
+        @xfs << attrs.transform_values(&:to_i) if @state == "cellXfs"
       when "numFmt"
-        @numFmts[attrs[:numFmtId].to_i] = attrs[:formatCode]
+        @num_fmts[attrs[:numFmtId].to_i] = attrs[:formatCode]
       end
     end
 
     def end_element(name)
       case name
       when "styleSheet"
-        @block.call(@xfs, @numFmts)
+        @block.call(@xfs, @num_fmts)
       when "cellXfs"
         @state = nil
       end

data/lib/xsv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Xsv
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

data/lib/xsv/workbook.rb

@@ -10,7 +10,7 @@ module Xsv
     # @return [Array<Sheet>]
     attr_reader :sheets
 
-    attr_reader :shared_strings, :xfs, :numFmts, :trim_empty_rows
+    attr_reader :shared_strings, :xfs, :num_fmts, :trim_empty_rows
 
     # Open the workbook of the given filename, string or buffer. For additional
     # options see {.initialize}
@@ -49,7 +49,7 @@ module Xsv
       @trim_empty_rows = trim_empty_rows
 
       @sheets = []
-      @xfs, @numFmts = fetch_styles
+      @xfs, @num_fmts = fetch_styles
       @sheet_ids = fetch_sheet_ids
       @relationships = fetch_relationships
       @shared_strings = fetch_shared_strings
@@ -68,7 +68,7 @@ module Xsv
       @zip = nil
       @sheets = nil
       @xfs = nil
-      @numFmts = nil
+      @num_fmts = nil
       @relationships = nil
       @shared_strings = nil
       @sheet_ids = nil
@@ -83,6 +83,11 @@ module Xsv
       @sheets.select { |s| s.name == name }
     end
 
+    # Get number format for given style index
+    def get_num_fmt(style)
+      @num_fmts[@xfs[style][:numFmtId]]
+    end
+
     private
 
     def fetch_shared_strings

data/xsv.gemspec

@@ -43,5 +43,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "< 3"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.14.2"
-  spec.add_development_dependency "standardrb", "~> 1.0"
+  spec.add_development_dependency "standard", "~> 1.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xsv
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Martijn Storck
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -73,19 +73,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.14.2
 - !ruby/object:Gem::Dependency
-  name: standardrb
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.6.0
 description: |2
                               Xsv is a fast, lightweight parser for Office Open XML spreadsheet files
                               (commonly known as Excel or .xlsx files). It strives to be minimal in the
@@ -105,6 +105,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmark.rb
 - bin/console
 - bin/setup
 - lib/xsv.rb