iostreams 0.20.3 → 1.0.0.beta

data/test/utils_test.rb

@@ -0,0 +1,20 @@
+require_relative 'test_helper'
+
+class UtilsTest < Minitest::Test
+  describe IOStreams::Utils do
+    describe '.temp_file_name' do
+      it 'returns value from block' do
+        result = IOStreams::Utils.temp_file_name('base', '.ext') { |_name| 257 }
+        assert_equal 257, result
+      end
+
+      it 'supplies new temp file_name' do
+        file_name  = nil
+        file_name2 = nil
+        IOStreams::Utils.temp_file_name('base', '.ext') { |name| file_name = name }
+        IOStreams::Utils.temp_file_name('base', '.ext') { |name| file_name2 = name }
+        refute_equal file_name, file_name2
+      end
+    end
+  end
+end

data/test/xlsx_reader_test.rb

@@ -14,10 +14,10 @@ class XlsxReaderTest
       ]
     end
 
-    describe '.open' do
+    describe '.file' do
       describe 'with a file path' do
         it 'returns the contents of the file' do
-          csv  = IOStreams::Xlsx::Reader.open(file_name, &:read)
+          csv = IOStreams::Xlsx::Reader.file(file_name, &:read)
           assert_equal xlsx_contents, CSV.parse(csv)
         end
       end
@@ -26,7 +26,7 @@ class XlsxReaderTest
         it 'returns the contents of the file' do
           csv = ''
           File.open(file_name, 'rb') do |file|
-            csv = IOStreams::Xlsx::Reader.open(file, &:read)
+            csv = IOStreams::Xlsx::Reader.stream(file, &:read)
           end
 
           assert_equal xlsx_contents, CSV.parse(csv)

data/test/zip_reader_test.rb

@@ -24,36 +24,36 @@ class ZipReaderTest < Minitest::Test
       Zip::File.open(file_name) { |zip_file| zip_file.first.get_input_stream.read }
     end
 
-    describe '.open' do
+    describe '.file' do
       it 'reads the first file' do
-        result = IOStreams::Zip::Reader.open(file_name) do |io|
+        result = IOStreams::Zip::Reader.file(file_name) do |io|
           io.read
         end
         assert_equal decompressed, result
       end
 
       it 'reads entry within zip file' do
-        result = IOStreams::Zip::Reader.open(multiple_zip_file_name, entry_file_name: 'text.txt') do |io|
+        result = IOStreams::Zip::Reader.file(multiple_zip_file_name, entry_file_name: 'text.txt') do |io|
           io.read
         end
         assert_equal contents_test_txt, result
       end
 
       it 'reads another entry within zip file' do
-        result = IOStreams::Zip::Reader.open(multiple_zip_file_name, entry_file_name: 'test.json') do |io|
+        result = IOStreams::Zip::Reader.file(multiple_zip_file_name, entry_file_name: 'test.json') do |io|
           io.read
         end
         assert_equal contents_test_json, result
       end
 
-      it 'reads from a stream' do
-        result = MinimalFileReader.open(file_name) do |file|
-          IOStreams::Zip::Reader.open(file) do |io|
-            io.read
-          end
-        end
-        assert_equal decompressed, result
-      end
+      # it 'reads from a stream' do
+      #   result = MinimalFileReader.open(file_name) do |file|
+      #     IOStreams::Zip::Reader.stream(file) do |io|
+      #       io.read
+      #     end
+      #   end
+      #   assert_equal decompressed, result
+      # end
     end
 
   end

data/test/zip_writer_test.rb

@@ -12,19 +12,19 @@ class ZipWriterTest < Minitest::Test
     end
 
     let :decompressed do
-      File.read(File.join(File.dirname(__FILE__), 'files', 'text.txt'))
+      ::File.read(File.join(File.dirname(__FILE__), 'files', 'text.txt'))
     end
 
     after do
       temp_file.delete
     end
 
-    describe '.open' do
+    describe '.file' do
       it 'file' do
-        IOStreams::Zip::Writer.open(file_name, zip_file_name: 'text.txt') do |io|
+        IOStreams::Zip::Writer.file(file_name, entry_file_name: 'text.txt') do |io|
           io.write(decompressed)
         end
-        result = Zip::File.open(file_name) do |zip_file|
+        result = ::Zip::File.open(file_name) do |zip_file|
           zip_file.first.get_input_stream.read
         end
         assert_equal decompressed, result
@@ -32,7 +32,7 @@ class ZipWriterTest < Minitest::Test
 
       it 'stream' do
         io_string = StringIO.new(''.b)
-        IOStreams::Zip::Writer.open(io_string) do |io|
+        IOStreams::Zip::Writer.stream(io_string) do |io|
           io.write(decompressed)
         end
         io     = StringIO.new(io_string.string)

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: iostreams
 version: !ruby/object:Gem::Version
-  version: 0.20.3
+  version: 1.0.0.beta
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2019-10-22 00:00:00.000000000 Z
+dependencies: []
 description: 
 email:
 - reidmo@gmail.com
@@ -34,34 +20,33 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- lib/io_streams/base_path.rb
 - lib/io_streams/bzip2/reader.rb
 - lib/io_streams/bzip2/writer.rb
+- lib/io_streams/deprecated.rb
 - lib/io_streams/encode/reader.rb
 - lib/io_streams/encode/writer.rb
 - lib/io_streams/errors.rb
-- lib/io_streams/file/path.rb
-- lib/io_streams/file/reader.rb
-- lib/io_streams/file/writer.rb
 - lib/io_streams/gzip/reader.rb
 - lib/io_streams/gzip/writer.rb
-- lib/io_streams/http/reader.rb
 - lib/io_streams/io_streams.rb
 - lib/io_streams/line/reader.rb
 - lib/io_streams/line/writer.rb
+- lib/io_streams/path.rb
+- lib/io_streams/paths/file.rb
+- lib/io_streams/paths/http.rb
+- lib/io_streams/paths/matcher.rb
+- lib/io_streams/paths/s3.rb
+- lib/io_streams/paths/sftp.rb
 - lib/io_streams/pgp.rb
 - lib/io_streams/pgp/reader.rb
 - lib/io_streams/pgp/writer.rb
+- lib/io_streams/reader.rb
 - lib/io_streams/record/reader.rb
 - lib/io_streams/record/writer.rb
 - lib/io_streams/row/reader.rb
 - lib/io_streams/row/writer.rb
-- lib/io_streams/s3.rb
-- lib/io_streams/s3/path.rb
-- lib/io_streams/s3/reader.rb
-- lib/io_streams/s3/writer.rb
-- lib/io_streams/sftp/reader.rb
-- lib/io_streams/sftp/writer.rb
+- lib/io_streams/stream.rb
+- lib/io_streams/streams.rb
 - lib/io_streams/symmetric_encryption/reader.rb
 - lib/io_streams/symmetric_encryption/writer.rb
 - lib/io_streams/tabular.rb
@@ -76,18 +61,16 @@ files:
 - lib/io_streams/tabular/utility/csv_row.rb
 - lib/io_streams/utils.rb
 - lib/io_streams/version.rb
+- lib/io_streams/writer.rb
 - lib/io_streams/xlsx/reader.rb
 - lib/io_streams/zip/reader.rb
 - lib/io_streams/zip/writer.rb
 - lib/iostreams.rb
-- test/base_path_test.rb
 - test/bzip2_reader_test.rb
 - test/bzip2_writer_test.rb
+- test/deprecated_test.rb
 - test/encode_reader_test.rb
 - test/encode_writer_test.rb
-- test/file_path_test.rb
-- test/file_reader_test.rb
-- test/file_writer_test.rb
 - test/files/embedded_lines_test.csv
 - test/files/multiple_files.zip
 - test/files/spreadsheet.xlsx
@@ -102,12 +85,15 @@ files:
 - test/files/unclosed_quote_test.csv
 - test/gzip_reader_test.rb
 - test/gzip_writer_test.rb
-- test/http_reader_test.rb
 - test/io_streams_test.rb
 - test/line_reader_test.rb
 - test/line_writer_test.rb
 - test/minimal_file_reader.rb
 - test/path_test.rb
+- test/paths/file_test.rb
+- test/paths/http_test.rb
+- test/paths/matcher_test.rb
+- test/paths/s3_test.rb
 - test/pgp_reader_test.rb
 - test/pgp_test.rb
 - test/pgp_writer_test.rb
@@ -115,10 +101,11 @@ files:
 - test/record_writer_test.rb
 - test/row_reader_test.rb
 - test/row_writer_test.rb
-- test/s3_reader_test.rb
-- test/s3_writer_test.rb
+- test/stream_test.rb
+- test/streams_test.rb
 - test/tabular_test.rb
 - test/test_helper.rb
+- test/utils_test.rb
 - test/xlsx_reader_test.rb
 - test/zip_reader_test.rb
 - test/zip_writer_test.rb
@@ -134,12 +121,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.6
 signing_key: 
@@ -147,7 +134,7 @@ specification_version: 4
 summary: Input and Output streaming for Ruby.
 test_files:
 - test/pgp_reader_test.rb
-- test/base_path_test.rb
+- test/deprecated_test.rb
 - test/line_reader_test.rb
 - test/xlsx_reader_test.rb
 - test/minimal_file_reader.rb
@@ -156,10 +143,13 @@ test_files:
 - test/bzip2_writer_test.rb
 - test/encode_writer_test.rb
 - test/gzip_writer_test.rb
-- test/file_reader_test.rb
+- test/streams_test.rb
+- test/stream_test.rb
+- test/paths/matcher_test.rb
+- test/paths/s3_test.rb
+- test/paths/file_test.rb
+- test/paths/http_test.rb
 - test/record_reader_test.rb
-- test/s3_writer_test.rb
-- test/http_reader_test.rb
 - test/pgp_writer_test.rb
 - test/line_writer_test.rb
 - test/row_reader_test.rb
@@ -180,11 +170,9 @@ test_files:
 - test/gzip_reader_test.rb
 - test/encode_reader_test.rb
 - test/test_helper.rb
-- test/file_writer_test.rb
+- test/utils_test.rb
 - test/tabular_test.rb
 - test/path_test.rb
 - test/pgp_test.rb
 - test/io_streams_test.rb
 - test/record_writer_test.rb
-- test/s3_reader_test.rb
-- test/file_path_test.rb

data/lib/io_streams/base_path.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-module IOStreams
-  class BasePath
-    attr_reader :path
-
-    def initialize(path)
-      @path = path.frozen? ? path : path.dup.freeze
-    end
-
-    # If elements already contains the current path then it is used as is without
-    # adding the current path for a second time
-    def join(*elements)
-      return self if elements.empty?
-
-      relative = ::File.join(*elements)
-      if relative.start_with?(path)
-        self.class.new(relative)
-      else
-        self.class.new(::File.join(path, relative))
-      end
-    end
-
-    def to_s
-      path
-    end
-
-    # Removes the last element of the path, the file name, before creating the entire path.
-    # Returns self
-    def mkpath
-      raise NotImplementedError
-    end
-
-    # Assumes the current path does not include a file name, and creates all elements in the path.
-    # Returns self
-    #
-    # Note: Do not call this method if the path contains a file name, see `#mkpath`
-    def mkdir
-      raise NotImplementedError
-    end
-
-    # Returns [true|false] whether the file exists
-    def exist?
-      raise NotImplementedError
-    end
-
-    # Returns [Integer] size of the file
-    def size
-      raise NotImplementedError
-    end
-
-    # Delete the file.
-    # Returns self
-    #
-    # Notes:
-    # * No error is raised if the file is not present.
-    # * Only the file is removed, not any of the parent paths.
-    def delete
-      raise NotImplementedError
-    end
-
-    # Return a reader for this path
-    def reader(**args, &block)
-      IOStreams.reader(path, **args, &block)
-    end
-
-    # Return a writer for this path
-    def writer(**args, &block)
-      IOStreams.writer(path, **args, &block)
-    end
-
-  end
-end

data/lib/io_streams/file/path.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-require 'fileutils'
-
-module IOStreams
-  module File
-    class Path < IOStreams::BasePath
-      # Yields the path to a temporary file_name.
-      #
-      # File is deleted upon completion if present.
-      def self.temp_file_name(basename, extension = '')
-        result = nil
-        ::Dir::Tmpname.create([basename, extension]) do |tmpname|
-          begin
-            result = yield(tmpname)
-          ensure
-            ::File.unlink(tmpname) if ::File.exist?(tmpname)
-          end
-        end
-        result
-      end
-
-      # Used by writers that can write directly to file to create the target path
-      def self.mkpath(path)
-        dir = ::File.dirname(path)
-        FileUtils.mkdir_p(dir) unless ::File.exist?(dir)
-      end
-
-      def mkpath
-        self.class.mkpath(path)
-        self
-      end
-
-      def mkdir
-        FileUtils.mkdir_p(path) unless ::File.exist?(path)
-        self
-      end
-
-      def exist?
-        ::File.exist?(path)
-      end
-
-      def size
-        ::File.size(path)
-      end
-
-      def delete(recursively: false)
-        return self unless ::File.exist?(path)
-
-        if ::File.directory?(path)
-          recursively ? FileUtils.remove_dir(path) : Dir.delete(path)
-        else
-          ::File.unlink(path)
-        end
-        self
-      end
-    end
-  end
-end

data/lib/io_streams/file/reader.rb

@@ -1,12 +0,0 @@
-module IOStreams
-  module File
-    class Reader
-      # Read from a named file
-      def self.open(file_name, **args, &block)
-        raise(ArgumentError, 'File name must be a string') unless file_name.is_a?(String)
-
-        ::File.open(file_name, 'rb', &block)
-      end
-    end
-  end
-end