io-like 0.3.0 → 0.3.1

data/ruby.1.8.mspec

@@ -0,0 +1,7 @@
+class MSpecScript
+  # An ordered list of the directories containing specs to run
+  set :files, ['spec']
+
+  # The default implementation to run the specs.
+  set :target, 'ruby'
+end

data/spec/binmode_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#binmode" do
+  before :each do
+    @filename = tmp("IO_binmode_file")
+    @file = File.open(@filename, "w")
+    @iowrapper = WritableIOWrapper.open(@file)
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @file.close unless @file.closed?
+    File.delete(@filename) if File.exist?(@filename)
+  end
+
+  it "returns a reference to the stream" do
+    @iowrapper.binmode.should == @iowrapper
+  end
+
+  it "does not raise any errors on closed stream" do
+    lambda { IOSpecs.closed_file.binmode }.should_not raise_error()
+  end
+
+  # Even if it does nothing in Unix it should not raise any errors.
+  it "puts a stream in binary mode" do
+    lambda { @iowrapper.binmode }.should_not raise_error
+  end
+end

data/spec/close_read_spec.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+require 'fileutils'
+
+describe "IO::Like#close_read" do
+  before :each do
+    @io = IO.popen('cat', "r+")
+    @iowrapper = DuplexedIOWrapper.open(@io)
+    @filename = tmp('IO_Like__close_read_test')
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @io.close unless @io.closed?
+    File.delete(@filename) if File.exist?(@filename)
+  end
+
+  it "closes the read end of a duplex I/O stream" do
+    @iowrapper.close_read
+
+    lambda { @iowrapper.read }.should raise_error(IOError)
+  end
+
+  it "raises an IOError on subsequent invocations" do
+    @iowrapper.close_read
+
+    lambda { @iowrapper.close_read }.should raise_error(IOError)
+  end
+
+  it "allows subsequent invocation of close" do
+    @iowrapper.close_read
+
+    lambda { @iowrapper.close }.should_not raise_error
+  end
+
+  it "raises an IOError if the stream is writable and not duplexed" do
+    io = File.open(@filename, 'w')
+    iowrapper = WritableIOWrapper.open(io)
+
+    begin
+      lambda { iowrapper.close_read }.should raise_error(IOError)
+    ensure
+      iowrapper.close unless iowrapper.closed?
+      io.close unless io.closed?
+    end
+  end
+
+  it "closes the stream if it is neither writable nor duplexed" do
+    FileUtils.touch(@filename)
+    io = File.open(@filename)
+    iowrapper = ReadableIOWrapper.open(io)
+
+    iowrapper.close_read
+    iowrapper.closed?.should == true
+
+    io.close
+  end
+
+  it "raises IOError on closed stream" do
+    @io.close
+
+    lambda { @io.close_read }.should raise_error(IOError)
+  end
+end

data/spec/close_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#close" do
+  before :each do
+    @filename = tmp('IO_Like__close_test')
+    @io = File.open(@filename, 'w+')
+    @iowrapper = IOWrapper.open(@io)
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @io.close unless @io.closed?
+    File.unlink(@filename) if File.exist?(@filename)
+  end
+
+  it "closes the stream" do
+    lambda { @iowrapper.close }.should_not raise_error
+    @iowrapper.closed?.should == true
+  end
+
+  it "returns nil" do
+    @iowrapper.close.should == nil
+  end
+
+  it "makes the stream unavailable for any further data operations" do
+    @iowrapper.close
+    lambda { @iowrapper.write("attempt to write") }.should raise_error(IOError)
+    lambda { @iowrapper.read }.should raise_error(IOError)
+  end
+
+  it "raises an IOError on subsequent invocations" do
+    @iowrapper.close
+    lambda { @iowrapper.close }.should raise_error(IOError)
+  end
+end

data/spec/close_write_spec.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#close_write" do
+  before :each do
+    @io = IO.popen('cat', 'r+')
+    @iowrapper = DuplexedIOWrapper.open(@io)
+    @filename = tmp('IO_Like__close_write_test')
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @io.close unless @io.closed?
+    File.delete(@filename) if File.exist?(@filename)
+  end
+
+  it "closes the write end of a duplex I/O stream" do
+    @iowrapper.close_write
+    lambda { @iowrapper.write("attempt to write") }.should raise_error(IOError)
+  end
+
+  it "raises an IOError on subsequent invocations" do
+    @iowrapper.close_write
+    lambda { @iowrapper.close_write }.should raise_error(IOError)
+  end
+
+  it "allows subsequent invocation of close" do
+    @iowrapper.close_write
+    lambda { @iowrapper.close }.should_not raise_error
+  end
+
+  it "raises an IOError if the stream is readable and not duplexed" do
+    io = File.open(@filename, 'w+')
+    iowrapper = IOWrapper.open(io)
+
+    begin
+      lambda { iowrapper.close_write }.should raise_error(IOError)
+    ensure
+      iowrapper.close unless iowrapper.closed?
+      io.close unless io.closed?
+    end
+  end
+
+  it "closes the stream if it is neither readable nor duplexed" do
+    IOSpecs.writable_iowrapper do |iowrapper|
+      iowrapper.close_write
+      iowrapper.closed?.should == true
+    end
+  end
+
+  it "flushes and closes the write stream" do
+    @iowrapper.puts('12345')
+    @iowrapper.close_write
+    @io.close_write
+    @iowrapper.read.should == "12345\n"
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.close_write }.should raise_error(IOError)
+  end
+end

data/spec/closed_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#closed?" do
+  it "returns true on closed stream" do
+    IOSpecs.closed_file.closed?.should == true
+  end
+
+  it "returns false on open stream" do
+    File.open(File.dirname(__FILE__) + '/fixtures/gets.txt', 'r') do |io|
+      ReadableIOWrapper.open(io) do |iowrapper|
+        iowrapper.closed?.should == false
+      end
+    end
+  end
+end

data/spec/each_byte_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#each_byte" do
+  it "raises IOError on closed stream" do
+    # each_byte must have a block in order to raise the Error.
+    # MRI 1.8.7 returns enumerator if block is not provided.
+    # See [ruby-core:16557].
+    lambda { IOSpecs.closed_file.each_byte {} }.should raise_error(IOError)
+  end
+
+  it "yields each byte" do
+    File.open(IOSpecs.gets_fixtures) do |io|
+      ReadableIOWrapper.open(io) do |iowrapper|
+        bytes = []
+
+        iowrapper.each_byte do |byte|
+          bytes << byte
+          break if bytes.length >= 5
+        end
+
+        bytes.should == [86, 111, 105, 99, 105]
+      end
+    end
+  end
+
+  it "works on empty streams" do
+    @filename = tmp("IO_Like__each_byte_test")
+    File.open(@filename, "w+") do |io|
+      IOWrapper.open(io) do |iowrapper|
+        lambda do
+          iowrapper.each_byte { |b| raise IOError }
+        end.should_not raise_error
+      end
+    end
+    File.unlink(@filename) if File.exist?(@filename)
+  end
+end

data/spec/each_line_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+require File.dirname(__FILE__) + '/shared/each'
+
+describe "IO::Like#each_line" do
+  it_behaves_like :io_like__each, :each_line
+end
+
+describe "IO::Like#each_line when passed a separator" do
+  it_behaves_like :io_like__each_separator, :each_line
+end

data/spec/each_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+require File.dirname(__FILE__) + '/shared/each'
+
+describe "IO::Like#each" do
+  it_behaves_like :io_like__each, :each
+end
+
+describe "IO::Like#each when passed a separator" do
+  it_behaves_like :io_like__each_separator, :each
+end

data/spec/eof_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+require File.dirname(__FILE__) + '/shared/eof'
+
+describe "IO::Like#eof" do
+  it_behaves_like :io_like__eof, :eof
+end
+
+describe "IO::Like#eof?" do
+  it_behaves_like :io_like__eof, :eof?
+end

data/spec/fixtures/classes.rb

@@ -0,0 +1,96 @@
+require File.dirname(__FILE__) + '/../../lib/io/like'
+
+class IOWrapper
+  include IO::Like
+
+  def self.open(io)
+    iow = new(io)
+    return iow unless block_given?
+
+    begin
+      yield(iow)
+    ensure
+      iow.close unless iow.closed?
+    end
+  end
+
+  def initialize(io)
+    @io = io
+  end
+
+  private
+
+  def unbuffered_read(length)
+    @io.sysread(length)
+  end
+
+  def unbuffered_seek(offset, whence = IO::SEEK_SET)
+    @io.sysseek(offset, whence)
+  end
+
+  def unbuffered_write(string)
+    @io.syswrite(string)
+  end
+end
+
+class DuplexedIOWrapper < IOWrapper
+  def duplexed?
+    true
+  end
+end
+
+class ReadableIOWrapper < IOWrapper
+  def writable?
+    false
+  end
+end
+
+class WritableIOWrapper < IOWrapper
+  def readable?
+    false
+  end
+end
+
+module IOSpecs
+  def self.lines
+    [
+      "Voici la ligne une.\n",
+      "Qui \303\250 la linea due.\n",
+      "\n",
+      "\n",
+      "Aqu\303\255 est\303\241 la l\303\255nea tres.\n",
+      "Ist hier Linie vier.\n",
+      "\n",
+      "Est\303\241 aqui a linha cinco.\n",
+      "Here is line six.\n"
+    ]
+  end
+
+  def self.gets_fixtures
+    File.dirname(__FILE__) + '/gets.txt'
+  end
+
+  def self.gets_output
+    File.dirname(__FILE__) + '/gets_output.txt'
+  end
+
+  def self.closed_file
+    File.open(gets_fixtures, 'r') do |f|
+      ReadableIOWrapper.open(f) { |iowrapper| iowrapper }
+    end
+  end
+
+  def self.readable_iowrapper(&b)
+    File.open(gets_fixtures, 'r') do |f|
+      ReadableIOWrapper.open(f, &b)
+    end
+  end
+
+  def self.writable_iowrapper(&b)
+    File.open(gets_output, 'w') do |f|
+      WritableIOWrapper.open(f, &b)
+    end
+  ensure
+    File.delete(gets_output)
+  end
+end

data/spec/fixtures/gets.txt

@@ -0,0 +1,9 @@
+Voici la ligne une.
+Qui è la linea due.
+
+
+Aquí está la línea tres.
+Ist hier Linie vier.
+
+Está aqui a linha cinco.
+Here is line six.

data/spec/fixtures/numbered_lines.txt

@@ -0,0 +1,5 @@
+Line 1: One
+Line 2: Two
+Line 3: Three
+Line 4: Four
+Line 5: Five

data/spec/fixtures/one_byte.txt

@@ -0,0 +1 @@
+1

data/spec/fixtures/paragraphs.txt

@@ -0,0 +1,7 @@
+This is
+
+an example
+
+
+
+of paragraphs.

data/spec/fixtures/readlines.txt

@@ -0,0 +1,6 @@
+Voici la ligne une.
+Qui è la linea due.
+Aquí está la línea tres.
+Ist hier Linie vier.
+Está aqui a linha cinco.
+Here is line six.

data/spec/flush_spec.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#flush" do
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.flush }.should raise_error(IOError)
+  end
+end

data/spec/getc_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#getc" do
+  before :each do
+    @file_name = File.dirname(__FILE__) + '/fixtures/readlines.txt'
+    @file = File.open(@file_name, 'r')
+    @iowrapper = ReadableIOWrapper.open(@file)
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @file.close unless @file.closed?
+  end
+
+  it "returns the next byte from the stream" do
+    @iowrapper.getc.should == 86
+    @iowrapper.getc.should == 111
+    @iowrapper.getc.should == 105
+    # read the rest of line
+    @iowrapper.readline.should == "ci la ligne une.\n"
+    @iowrapper.getc.should == 81
+  end
+
+  it "returns nil when invoked at the end of the stream" do
+    # read entire content
+    @iowrapper.read
+    @iowrapper.getc.should == nil
+  end
+
+  it "returns nil on empty stream" do
+    path = tmp('empty.txt')
+    File.open(path, "w+") do |empty|
+      IOWrapper.open(empty) do |iowrapper|
+        iowrapper.getc.should == nil
+      end
+    end
+    File.unlink(path)
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.getc }.should raise_error(IOError)
+  end
+end