xsv 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef096c0bca09f5a58d67897e9884388a89883a058dabf43f1e223eec250a93d5
-  data.tar.gz: 7d1b47f63b21096975aa8f31f5bfb9473c79badc898a7c4735e4a7260fbf6fc3
+  metadata.gz: 85395cd1f83157097328c94eb82db6ecbf4c3e18ae1241c56762b21d5de03927
+  data.tar.gz: 3141ce4b9bd703aed15cab002f6905636d3597a92492e7d7689077628b7618b9
 SHA512:
-  metadata.gz: e851ff5345dbfa88594a5dd57749f78b8d6309bbede337d66d45ce66dc2c0eb29fcf2e123e5bc97bc456962fa1d21e5527f25214c792cdd486243cdba1e8ce5c
-  data.tar.gz: 4ae56754f6328a420a9ed6c8a635936950e2b1c1f61a4dcd584dd9517036abc8942b2936b4803a09ad1e6bf4ea78f94776fe62554ca97d54a9c61a1698211340
+  metadata.gz: 91870ea588f4fbe857c7c8a75c0282a8a22dd91c552bb166cda59d6ecffb32694383dd764136f8412dcaffa12d177df15cd73d408a84d7553ed9d83074c5af46
+  data.tar.gz: e9c81c6c5601b290d13d8eea15a57c018c7c6cee064bd478026b82d279b28d29e7f30d0fe9703e46d16c9653697f71454714592fc9f05ac105836598b7cd4176

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Xsv Changelog
 
+## 1.0.1 2021-03-18
+
+- Allow passing a block to Workbook.open
+- `parse_headers!` returns self to allow chaining (thanks @senhalil)
+
 ## 1.0.0 2021-01-26
 
 - Xsv no longer depends on native extensions, thanks to a pure-Ruby XML parser

data/README.md

@@ -2,6 +2,7 @@
 
 [![Travis CI](https://img.shields.io/travis/martijn/xsv/master)](https://travis-ci.org/martijn/xsv)
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/github/martijn/xsv)
+[![Gem Version](https://badge.fury.io/rb/xsv.svg)](https://badge.fury.io/rb/xsv)
 
 Xsv is a fast, lightweight, pure Ruby parser for Office Open XML spreadsheet files
 (commonly known as Excel or .xlsx files). It strives to be minimal in the
@@ -82,7 +83,8 @@ sheet[1] # => {"header1" => "value1", "header2" => "value2"}
 Be aware that hash mode will lead to unpredictable results if the worksheet
 has multiple columns with the same header.
 
-`Xsv::Workbook.open` accepts a filename, or an IO or String containing a workbook.
+`Xsv::Workbook.open` accepts a filename, or an IO or String containing a workbook. Optionally, you can pass a block
+which will be called with the workbook as parameter, like `File#open`.
 
 `Xsv::Sheet` implements `Enumerable` so you can call methods like `#first`,
 `#filter`/`#select`, and `#map` on it.

data/lib/xsv/sax_parser.rb

@@ -2,7 +2,7 @@
 
 module Xsv
   class SaxParser
-    ATTR_REGEX = /((\S+)="(.*?)")/m.freeze
+    ATTR_REGEX = /((\S+)="(.*?)")/m
 
     def parse(io)
       state = :look_start
@@ -34,11 +34,11 @@ module Xsv
 
             if respond_to?(:characters) && !chars.empty?
               if chars.index('&')
-                chars.gsub!('&', %q{&})
-                chars.gsub!(''', %q{'})
-                chars.gsub!('>', %q{>})
-                chars.gsub!('&lt;', %q{<})
-                chars.gsub!('&quot;', %q{"})
+                chars.gsub!('&amp;', '&')
+                chars.gsub!('&apos;', "'")
+                chars.gsub!('&gt;', '>')
+                chars.gsub!('&lt;', '<')
+                chars.gsub!('&quot;', '"')
               end
               characters(chars)
             end
@@ -66,13 +66,11 @@ module Xsv
 
             if tag_name.start_with?('/')
               end_element(tag_name[1..-1]) if respond_to?(:end_element)
+            elsif args.nil?
+              start_element(tag_name, nil)
             else
-              if 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
+              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
 
             state = :look_start

data/lib/xsv/sheet.rb

@@ -80,12 +80,12 @@ module Xsv
 
     # Load headers in the top row of the worksheet. After parsing of headers
     # all methods return hashes instead of arrays
-    # @return [true]
+    # @return [self]
     def parse_headers!
       @headers = parse_headers
       @mode = :hash
 
-      true
+      self
     end
 
     # Return the headers of the sheet as an array
@@ -100,9 +100,10 @@ module Xsv
     private
 
     def parse_headers
-      if @mode == :array
+      case @mode
+      when :array
         first
-      elsif @mode == :hash
+      when :hash
         @mode = :array
         headers.tap { @mode = :hash }
       end || []

data/lib/xsv/sheet_bounds_handler.rb

@@ -13,7 +13,7 @@ module Xsv
 
       handler = new(workbook.trim_empty_rows) do |row, col|
         rows = row
-        cols = col == 0 ? 0 : col + 1
+        cols = col.zero? ? 0 : col + 1
 
         return rows, cols
       end

data/lib/xsv/styles_handler.rb

@@ -34,9 +34,10 @@ module Xsv
     end
 
     def end_element(name)
-      if name == 'styleSheet'
+      case name
+      when 'styleSheet'
         @block.call(@xfs, @numFmts)
-      elsif name == 'cellXfs'
+      when 'cellXfs'
         @state = nil
       end
     end

data/lib/xsv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Xsv
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/xsv/workbook.rb

@@ -22,6 +22,16 @@ module Xsv
                   else # must be a filename
                     new(Zip::File.open(data), **kws)
                   end
+
+      if block_given?
+        begin
+          yield(@workbook)
+        ensure
+          @workbook.close
+        end
+      else
+        @workbook
+      end
     end
 
     # Open a workbook from an instance of {Zip::File}. Generally it's recommended
@@ -52,6 +62,7 @@ module Xsv
     # @return [true]
     def close
       @zip.close
+      @zip = nil
       @sheets = nil
       @xfs = nil
       @numFmts = nil
@@ -78,7 +89,7 @@ module Xsv
       stream = handle.get_input_stream
       SharedStringsParser.parse(stream)
     ensure
-      stream.close if stream
+      stream&.close
     end
 
     def fetch_styles

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xsv
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Martijn Storck
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip