simple_xlsx_reader 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1dd4b96753ca2dafcfadf59469c3a9357742ab7e
-  data.tar.gz: ffb23c6b020a55b893743206c236fea2abb07b65
+SHA256:
+  metadata.gz: e2b04473235c5ed2c2764f62a627fa6f16816c36e0fcff3497be229f8666a0f7
+  data.tar.gz: 9367b0082f31e9cb208d9f97ed6cb67d5276a459562809460694602339dfdaad
 SHA512:
-  metadata.gz: 01a2326f942c455c665d5c135aa4115edd87a307e4aa5dff5e1d177ef61dcd326bcc33ad342f3b164ac7996731f0e31e97a9471973b98682757624f44052f6a2
-  data.tar.gz: b5371713dd232d5f1134ab810ea69447a3ad59bb781f917df2bc3a49e7b1c86c765ab0a074b1ddce021390f1b1d54e1507326abf22a65f1d83de1cf568ce7896
+  metadata.gz: cd42f7a0b8830a2f01703dca10ae779b973566ad25e3b74d31dc3693977fa5b2b3442e47bc1a3b50723bae3bb9f31facd923f1eaba06b51cc8b927e7fb207cf3
+  data.tar.gz: 38ecb026b0ad5a1985d88349a839a9d2972f85596504e6f300686f9751169a3c8d62582e79119106085a9cadc066517206da117993c3a30f48a5a0c58f256b4c

data/.travis.yml

@@ -3,5 +3,6 @@ cache: bundler
 before_install:
   - gem update bundler
 rvm:
-  - 1.9.3
-  - 2.3.0
+  - 2.5.8
+  - 2.7.2
+  - 3.0.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.0.5
+
+* Support string or io input via `SimpleXlsxReader#parse` (@kalsan, @til)
+
 ### 1.0.4
 
 * Fix Windows + RubyZip 1.2.1 bug preventing files from being read

data/README.md

@@ -35,14 +35,21 @@ Here's the totality of the public api, in code:
 
     module SimpleXlsxReader
       def self.open(file_path)
-        Document.new(file_path).tap(&:sheets)
+        Document.new(file_path: file_path).tap(&:sheets)
+      end
+
+      def self.parse(string_or_io)
+        Document.new(string_or_io: string_or_io).tap(&:sheets)
       end
 
       class Document
-        attr_reader :file_path
+        attr_reader :string_or_io
+
+        def initialize(legacy_file_path = nil, file_path: nil, string_or_io: nil)
+          ((file_path || legacy_file_path).nil? ^ string_or_io.nil?) ||
+            fail(ArgumentError, 'either file_path or string_or_io must be provided')
 
-        def initialize(file_path)
-          @file_path = file_path
+          @string_or_io = string_or_io || File.new(file_path || legacy_file_path)
         end
 
         def sheets
@@ -54,7 +61,7 @@ Here's the totality of the public api, in code:
         end
 
         def xml
-          Xml.load(file_path)
+          Xml.load(string_or_io)
         end
 
         class Sheet < Struct.new(:name, :rows)

data/lib/simple_xlsx_reader/version.rb

@@ -1,3 +1,3 @@
 module SimpleXlsxReader
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/lib/simple_xlsx_reader.rb

@@ -53,14 +53,21 @@ module SimpleXlsxReader
   end
 
   def self.open(file_path)
-    Document.new(file_path).tap(&:sheets)
+    Document.new(file_path: file_path).tap(&:sheets)
+  end
+
+  def self.parse(string_or_io)
+    Document.new(string_or_io: string_or_io).tap(&:sheets)
   end
 
   class Document
-    attr_reader :file_path
+    attr_reader :string_or_io
+
+    def initialize(legacy_file_path = nil, file_path: nil, string_or_io: nil)
+      ((file_path || legacy_file_path).nil? ^ string_or_io.nil?) ||
+        fail(ArgumentError, 'either file_path or string_or_io must be provided')
 
-    def initialize(file_path)
-      @file_path = file_path
+      @string_or_io = string_or_io || File.new(file_path || legacy_file_path)
     end
 
     def sheets
@@ -72,7 +79,7 @@ module SimpleXlsxReader
     end
 
     def xml
-      Xml.load(file_path)
+      Xml.load(string_or_io)
     end
 
     class Sheet < Struct.new(:name, :rows)
@@ -98,9 +105,9 @@ module SimpleXlsxReader
     class Xml
       attr_accessor :workbook, :shared_strings, :sheets, :sheet_rels, :styles
 
-      def self.load(file_path)
+      def self.load(string_or_io)
         self.new.tap do |xml|
-          SimpleXlsxReader::Zip.open(file_path) do |zip|
+          SimpleXlsxReader::Zip.open_buffer(string_or_io) do |zip|
             xml.sheets = []
             xml.sheet_rels = []
 

data/test/simple_xlsx_reader_test.rb

@@ -4,25 +4,63 @@ require 'time'
 SXR = SimpleXlsxReader
 
 describe SimpleXlsxReader do
-  let(:sesame_street_blog_file) { File.join(File.dirname(__FILE__),
-                                            'sesame_street_blog.xlsx') }
-
-  let(:subject) { SimpleXlsxReader::Document.new(sesame_street_blog_file) }
-
-  describe '#to_hash' do
-    it 'reads an xlsx file into a hash of {[sheet name] => [data]}' do
-      subject.to_hash.must_equal({
-        "Authors"=>
-          [["Name", "Occupation"],
-           ["Big Bird", "Teacher"]],
-
-        "Posts"=>
-          [["Author Name", "Title", "Body", "Created At", "Comment Count", "URL"],
-           ["Big Bird", "The Number 1", "The Greatest", Time.parse("2002-01-01 11:00:00 UTC"), 1, SXR::Hyperlink.new("http://www.example.com/hyperlink-function", "This uses the HYPERLINK() function")],
-           ["Big Bird", "The Number 2", "Second Best", Time.parse("2002-01-02 14:00:00 UTC"), 2, SXR::Hyperlink.new("http://www.example.com/hyperlink-gui", "This uses the hyperlink GUI option")],
-           ["Big Bird", "Formula Dates", "Tricky tricky", Time.parse("2002-01-03 14:00:00 UTC"), 0, nil],
-           ["Empty Eagress", nil, "The title, date, and comment have types, but no values", nil, nil, nil]]
-      })
+  let(:sesame_street_blog_file_path) { File.join(File.dirname(__FILE__), 'sesame_street_blog.xlsx') }
+  let(:sesame_street_blog_io) { File.new(sesame_street_blog_file_path) }
+  let(:expected_result) do
+    {
+      "Authors"=>
+        [["Name", "Occupation"],
+          ["Big Bird", "Teacher"]],
+      "Posts"=>
+        [["Author Name", "Title", "Body", "Created At", "Comment Count", "URL"],
+          ["Big Bird", "The Number 1", "The Greatest", Time.parse("2002-01-01 11:00:00 UTC"), 1, SXR::Hyperlink.new("http://www.example.com/hyperlink-function", "This uses the HYPERLINK() function")],
+          ["Big Bird", "The Number 2", "Second Best", Time.parse("2002-01-02 14:00:00 UTC"), 2, SXR::Hyperlink.new("http://www.example.com/hyperlink-gui", "This uses the hyperlink GUI option")],
+          ["Big Bird", "Formula Dates", "Tricky tricky", Time.parse("2002-01-03 14:00:00 UTC"), 0, nil],
+          ["Empty Eagress", nil, "The title, date, and comment have types, but no values", nil, nil, nil]]
+    }
+  end
+
+  describe SimpleXlsxReader do
+    describe 'load from file path' do
+      let(:subject) { SimpleXlsxReader.open(sesame_street_blog_file_path) }
+
+      it 'reads an xlsx file into a hash of {[sheet name] => [data]}' do
+        subject.to_hash.must_equal(expected_result)
+      end
+    end
+
+    describe 'load from buffer' do
+      let(:subject) { SimpleXlsxReader.parse(sesame_street_blog_io) }
+
+      it 'reads an xlsx buffer into a hash of {[sheet name] => [data]}' do
+        subject.to_hash.must_equal(expected_result)
+      end
+    end
+  end
+
+  describe SimpleXlsxReader::Document do
+    describe 'load from file path' do
+      let(:subject) { SimpleXlsxReader::Document.new(file_path: sesame_street_blog_file_path) }
+
+      it 'reads an xlsx file into a hash of {[sheet name] => [data]}' do
+        subject.to_hash.must_equal(expected_result)
+      end
+    end
+
+    describe 'load from buffer' do
+      let(:subject) { SimpleXlsxReader::Document.new(string_or_io: sesame_street_blog_io) }
+
+      it 'reads an xlsx buffer into a hash of {[sheet name] => [data]}' do
+        subject.to_hash.must_equal(expected_result)
+      end
+    end
+
+    describe 'load from file path (legacy API)' do
+      let(:subject) { SimpleXlsxReader::Document.new(sesame_street_blog_file_path) }
+
+      it 'reads an xlsx file into a hash of {[sheet name] => [data]}' do
+        subject.to_hash.must_equal(expected_result)
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_xlsx_reader
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Woody Peterson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-12 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -130,8 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Read xlsx data the Ruby way