iostreams 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4099b7285a53bdc5f6ab88dcef531c6d7575d06
-  data.tar.gz: 68f52bb99df8b7edc3f24ac0b8fed8d4a6a1dbab
+  metadata.gz: f17b7f95e61b93d4e1e69390deaa85511c3765fc
+  data.tar.gz: 29b174a1959de6a887040c89af1f63a072807f7b
 SHA512:
-  metadata.gz: b6579da43c8d3341dc91c50b929852e7caf6916cd197ca338cdb75920005a2413285c4a006c86b9221ce7070e56836626ddc4dca4f68edfe0a7e04976528bb2a
-  data.tar.gz: 7293d70e70612990e8038bd6deb188f3e85b663b3748c0385b91254ea78f62ac46c0e3e76130791cb662d1c99d135f73b72384407ce96c2a3109c1e440593484
+  metadata.gz: b2edf62d725b21fcb292ffbb025113462083a1f6156097e496c2d67e7a2cf77f10cb482b8094b431a5521577a29bb37bb19466e068acc6f1286f55a5e846acd9
+  data.tar.gz: 7bb62d42bb61a520132188d9f8304b1eb1923bf7b7d9b119b675a0c8cb980884b24818011e805d57a82532e6c13ab32f3a4593a03fa7ff82103b59cb5381569c

data/lib/io_streams/version.rb

@@ -1,3 +1,3 @@
 module IOStreams #:nodoc
-  VERSION = '0.8.1'
+  VERSION = '0.8.2'
 end

data/lib/io_streams/xlsx/reader.rb

@@ -0,0 +1,55 @@
+begin
+  require 'creek'
+rescue LoadError => e
+  puts "Install the 'creek' gem for xlsx streaming support"
+  raise(e)
+end
+require 'csv'
+
+module IOStreams
+  module Xlsx
+    class Reader
+      attr_reader :worksheet
+
+      def initialize(workbook)
+        @worksheet = workbook.sheets[0]
+      end
+
+      def each_line(&block)
+        worksheet.rows.each do |row|
+          block.call(row.values.to_csv(row_sep: nil))
+        end
+      end
+
+      # Read from a xlsx file or stream.
+      #
+      # Example:
+      #   IOStreams::Xlsx::Reader.open('spreadsheet.xlsx') do |spreadsheet_stream|
+      #     spreadsheet_stream.each_line do |line|
+      #       puts line
+      #     end
+      #   end
+      def self.open(file_name_or_io, options={}, &block)
+        options     = options.dup
+        buffer_size = options.delete(:buffer_size) || 65536
+        raise(ArgumentError, "Unknown IOStreams::Xlsx::Reader option: #{options.inspect}") if options.size > 0
+
+        if file_name_or_io.respond_to?(:read)
+          temp_file = Tempfile.new('rocket_job_xlsx')
+          file_name = temp_file.to_path
+
+          ::File.open(file_name, 'wb') do |file|
+            IOStreams.copy(file_name_or_io, file, buffer_size)
+          end
+        else
+          file_name = file_name_or_io
+        end
+
+        block.call(self.new(Creek::Book.new(file_name, check_file_extension: false)))
+      ensure
+        temp_file.delete if temp_file
+      end
+
+    end
+  end
+end

data/lib/io_streams/zip/reader.rb

@@ -6,7 +6,7 @@ module IOStreams
       # to the supplied block
       #
       # Example:
-      #   IOStreams::ZipReader.open('abc.zip') do |io_stream|
+      #   IOStreams::Zip::Reader.open('abc.zip') do |io_stream|
       #     # Read 256 bytes at a time
       #     while data = io_stream.read(256)
       #       puts data
@@ -79,4 +79,4 @@ module IOStreams
       end
     end
   end
-end
+end

data/lib/iostreams.rb

@@ -16,5 +16,8 @@ module IOStreams
     autoload :Reader, 'io_streams/delimited/reader'
     autoload :Writer, 'io_streams/delimited/writer'
   end
+  module Xlsx
+    autoload :Reader, 'io_streams/xlsx/reader'
+  end
 end
 require 'io_streams/io_streams'

data/test/delimited_reader_test.rb

@@ -3,8 +3,8 @@ require_relative 'test_helper'
 # Unit Test for IOStreams::File
 module Streams
   class DelimitedReaderTest < Minitest::Test
-    context IOStreams::File::Reader do
-      setup do
+    describe IOStreams::File::Reader do
+      before do
         @file_name = File.join(File.dirname(__FILE__), 'files', 'text.txt')
         @data      = []
         File.open(@file_name, 'rt') do |file|
@@ -14,8 +14,8 @@ module Streams
         end
       end
 
-      context '.open' do
-        should 'each_line file' do
+      describe '.open' do
+        it 'each_line file' do
           lines = []
           IOStreams::Delimited::Reader.open(@file_name) do |io|
             io.each_line { |line| lines << line }
@@ -23,7 +23,7 @@ module Streams
           assert_equal @data, lines
         end
 
-        should 'each_line stream' do
+        it 'each_line stream' do
           lines = []
           File.open(@file_name) do |file|
             IOStreams::Delimited::Reader.open(file) do |io|
@@ -34,7 +34,7 @@ module Streams
         end
 
         ["\r\n", "\n\r", "\n", "\r"].each do |delimiter|
-          should "autodetect delimiter: #{delimiter.inspect}" do
+          it "autodetect delimiter: #{delimiter.inspect}" do
             lines  = []
             stream = StringIO.new(@data.join(delimiter))
             IOStreams::Delimited::Reader.open(stream, buffer_size: 15) do |io|
@@ -45,7 +45,7 @@ module Streams
         end
 
         ['@', 'BLAH'].each do |delimiter|
-          should "read delimited #{delimiter.inspect}" do
+          it "read delimited #{delimiter.inspect}" do
             lines  = []
             stream = StringIO.new(@data.join(delimiter))
             IOStreams::Delimited::Reader.open(stream, buffer_size: 15, delimiter: delimiter) do |io|
@@ -55,7 +55,7 @@ module Streams
           end
         end
 
-        should "read binary delimited" do
+        it "read binary delimited" do
           delimiter = "\x01"
           lines     = []
           stream    = StringIO.new(@data.join(delimiter))

data/test/file_reader_test.rb

@@ -3,20 +3,20 @@ require_relative 'test_helper'
 # Unit Test for IOStreams::File
 module Streams
   class FileReaderTest < Minitest::Test
-    context IOStreams::File::Reader do
-      setup do
+    describe IOStreams::File::Reader do
+      before do
         @file_name = File.join(File.dirname(__FILE__), 'files', 'text.txt')
         @data      = File.read(@file_name)
       end
 
-      context '.open' do
-        should 'file' do
+      describe '.open' do
+        it 'file' do
           result = IOStreams::File::Reader.open(@file_name) do |io|
             io.read
           end
           assert_equal @data, result
         end
-        should 'stream' do
+        it 'stream' do
           result = File.open(@file_name) do |file|
             IOStreams::File::Reader.open(file) do |io|
               io.read
@@ -28,4 +28,4 @@ module Streams
 
     end
   end
-end
+end

data/test/file_writer_test.rb

@@ -3,14 +3,14 @@ require_relative 'test_helper'
 # Unit Test for IOStreams::File
 module Streams
   class FileWriterTest < Minitest::Test
-    context IOStreams::File::Writer do
-      setup do
+    describe IOStreams::File::Writer do
+      before do
         @file_name = File.join(File.dirname(__FILE__), 'files', 'text.txt')
         @data      = File.read(@file_name)
       end
 
-      context '.open' do
-        should 'file' do
+      describe '.open' do
+        it 'file' do
           temp_file = Tempfile.new('rocket_job')
           file_name = temp_file.to_path
           IOStreams::File::Writer.open(file_name) do |io|
@@ -19,7 +19,7 @@ module Streams
           result = File.read(file_name)
           assert_equal @data, result
         end
-        should 'stream' do
+        it 'stream' do
           io_string = StringIO.new
           IOStreams::File::Writer.open(io_string) do |io|
             io.write(@data)
@@ -30,4 +30,4 @@ module Streams
 
     end
   end
-end
+end

data/test/gzip_reader_test.rb

@@ -3,21 +3,21 @@ require_relative 'test_helper'
 # Unit Test for IOStreams::Gzip
 module Streams
   class GzipReaderTest < Minitest::Test
-    context IOStreams::Gzip::Reader do
-      setup do
+    describe IOStreams::Gzip::Reader do
+      before do
         @file_name = File.join(File.dirname(__FILE__), 'files', 'text.txt.gz')
         @gzip_data = File.open(@file_name, 'rb') { |f| f.read }
         @data      = Zlib::GzipReader.open(@file_name) { |gz| gz.read }
       end
 
-      context '.open' do
-        should 'file' do
+      describe '.open' do
+        it 'file' do
           result = IOStreams::Gzip::Reader.open(@file_name) do |io|
             io.read
           end
           assert_equal @data, result
         end
-        should 'stream' do
+        it 'stream' do
           result = File.open(@file_name) do |file|
             IOStreams::Gzip::Reader.open(file) do |io|
               io.read

data/test/gzip_writer_test.rb

@@ -3,14 +3,14 @@ require_relative 'test_helper'
 # Unit Test for IOStreams::Gzip
 module Streams
   class GzipWriterTest < Minitest::Test
-    context IOStreams::Gzip::Writer do
-      setup do
+    describe IOStreams::Gzip::Writer do
+      before do
         @file_name = File.join(File.dirname(__FILE__), 'files', 'text.txt.gz')
         @data      = Zlib::GzipReader.open(@file_name) { |gz| gz.read }
       end
 
-      context '.open' do
-        should 'file' do
+      describe '.open' do
+        it 'file' do
           temp_file = Tempfile.new('rocket_job')
           file_name = temp_file.to_path
           IOStreams::Gzip::Writer.open(file_name) do |io|
@@ -20,7 +20,7 @@ module Streams
           temp_file.delete
           assert_equal @data, result
         end
-        should 'stream' do
+        it 'stream' do
           io_string = StringIO.new(''.force_encoding('ASCII-8BIT'))
           IOStreams::Gzip::Writer.open(io_string) do |io|
             io.write(@data)

data/test/test_helper.rb

@@ -3,7 +3,6 @@ $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'yaml'
 require 'minitest/autorun'
 require 'minitest/reporters'
-require 'shoulda/context'
 require 'iostreams'
 require 'awesome_print'
 require 'symmetric-encryption'

data/test/xlsx_reader_test.rb

@@ -0,0 +1,43 @@
+require_relative 'test_helper'
+
+module Streams
+  describe IOStreams::Xlsx::Reader do
+    XLSX_CONTENTS = [
+      "first column,second column,third column",
+      "data 1,data 2,more data",
+    ]
+
+    describe '.open' do
+      let(:file_name) { File.join(File.dirname(__FILE__), 'files', 'spreadsheet.xlsx') }
+
+      describe 'with a file path' do
+        before do
+          @file = File.open(file_name)
+        end
+
+        it 'returns the contents of the file' do
+          rows = []
+          IOStreams::Xlsx::Reader.open(@file) do |spreadsheet|
+            spreadsheet.each_line { |row| rows << row }
+          end
+          assert_equal(XLSX_CONTENTS, rows)
+        end
+      end
+
+      describe 'with a file stream' do
+
+        it 'returns the contents of the file' do
+          rows = []
+          File.open(file_name) do |file|
+            IOStreams::Xlsx::Reader.open(file) do |spreadsheet|
+              spreadsheet.each_line { |row| rows << row }
+            end
+          end
+
+          assert_equal(XLSX_CONTENTS, rows)
+        end
+      end
+    end
+
+  end
+end

data/test/zip_reader_test.rb

@@ -4,21 +4,21 @@ require 'zip'
 # Unit Test for IOStreams::Zip
 module Streams
   class ZipReaderTest < Minitest::Test
-    context IOStreams::Zip::Reader do
-      setup do
+    describe IOStreams::Zip::Reader do
+      before do
         @file_name = File.join(File.dirname(__FILE__), 'files', 'text.zip')
         @zip_data  = File.open(@file_name, 'rb') { |f| f.read }
         @data      = Zip::File.open(@file_name) { |zip_file| zip_file.first.get_input_stream.read }
       end
 
-      context '.open' do
-        should 'file' do
+      describe '.open' do
+        it 'file' do
           result = IOStreams::Zip::Reader.open(@file_name) do |io|
             io.read
           end
           assert_equal @data, result
         end
-        should 'stream' do
+        it 'stream' do
           result = File.open(@file_name) do |file|
             IOStreams::Zip::Reader.open(file) do |io|
               io.read
@@ -30,4 +30,4 @@ module Streams
 
     end
   end
-end
+end

data/test/zip_writer_test.rb

@@ -4,14 +4,14 @@ require 'zip'
 # Unit Test for IOStreams::Zip
 module Streams
   class ZipWriterTest < Minitest::Test
-    context IOStreams::Zip::Writer do
-      setup do
+    describe IOStreams::Zip::Writer do
+      before do
         file_name = File.join(File.dirname(__FILE__), 'files', 'text.txt')
         @data     = File.read(file_name)
       end
 
-      context '.open' do
-        should 'file' do
+      describe '.open' do
+        it 'file' do
           temp_file = Tempfile.new('rocket_job')
           file_name = temp_file.to_path
           IOStreams::Zip::Writer.open(file_name, zip_file_name: 'text.txt') do |io|
@@ -24,7 +24,7 @@ module Streams
           assert_equal @data, result
         end
 
-        should 'stream' do
+        it 'stream' do
           io_string = StringIO.new(''.force_encoding('ASCII-8BIT'))
           IOStreams::Zip::Writer.open(io_string) do |io|
             io.write(@data)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iostreams
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-27 00:00:00.000000000 Z
+date: 2015-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: symmetric-encryption
@@ -54,12 +54,14 @@ files:
 - lib/io_streams/gzip/writer.rb
 - lib/io_streams/io_streams.rb
 - lib/io_streams/version.rb
+- lib/io_streams/xlsx/reader.rb
 - lib/io_streams/zip/reader.rb
 - lib/io_streams/zip/writer.rb
 - lib/iostreams.rb
 - test/delimited_reader_test.rb
 - test/file_reader_test.rb
 - test/file_writer_test.rb
+- test/files/spreadsheet.xlsx
 - test/files/text.txt
 - test/files/text.txt.gz
 - test/files/text.txt.gz.zip
@@ -67,6 +69,7 @@ files:
 - test/gzip_reader_test.rb
 - test/gzip_writer_test.rb
 - test/test_helper.rb
+- test/xlsx_reader_test.rb
 - test/zip_reader_test.rb
 - test/zip_writer_test.rb
 homepage: https://github.com/rocketjob/streams
@@ -97,6 +100,7 @@ test_files:
 - test/delimited_reader_test.rb
 - test/file_reader_test.rb
 - test/file_writer_test.rb
+- test/files/spreadsheet.xlsx
 - test/files/text.txt
 - test/files/text.txt.gz
 - test/files/text.txt.gz.zip
@@ -104,5 +108,7 @@ test_files:
 - test/gzip_reader_test.rb
 - test/gzip_writer_test.rb
 - test/test_helper.rb
+- test/xlsx_reader_test.rb
 - test/zip_reader_test.rb
 - test/zip_writer_test.rb
+has_rdoc: true