io-like 0.3.0 → 0.3.1

data/spec/shared/eof.rb

@@ -0,0 +1,116 @@
+require File.dirname(__FILE__) + '/../fixtures/classes'
+
+describe :io_like__eof, :shared => true do
+  before :each do
+    @filename = File.dirname(__FILE__) + '/../fixtures/readlines.txt'
+    @file = File.open(@filename, 'r')
+    @iowrapper = ReadableIOWrapper.open(@file)
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @file.close unless @file.closed?
+  end
+
+  it "returns false when not at end of file" do
+    @iowrapper.send(@method).should == false
+    @iowrapper.read(1)
+    @iowrapper.send(@method).should == false
+  end
+
+  it "returns true after reading with read with no parameters" do
+    @iowrapper.read
+    @iowrapper.send(@method).should == true
+  end
+
+  it "returns true after reading with read" do
+    @iowrapper.read(File.size(@filename))
+    @iowrapper.send(@method).should == true
+  end
+
+  it "returns true after reading with sysread" do
+    @iowrapper.sysread(File.size(@filename))
+    @iowrapper.send(@method).should == true
+  end
+
+  it "returns true after reading with readlines" do
+    @iowrapper.readlines
+    @iowrapper.send(@method).should == true
+  end
+
+  it "returns true on just opened empty stream" do
+    path = tmp('empty.txt')
+    File.open(path, "w") { |empty| } # ensure it exists
+    File.open(path) do |empty|
+      ReadableIOWrapper.open(empty) do |iowrapper|
+        iowrapper.send(@method).should == true
+      end
+    end
+    File.delete(path)
+  end
+
+  it "returns false on just opened non-empty stream" do
+    @iowrapper.send(@method).should == false
+  end
+
+  it "should not consume the data from the stream" do
+    @iowrapper.send(@method).should == false
+    @iowrapper.getc.should == 86
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.send(@method) }.should raise_error(IOError)
+  end
+
+  it "raises IOError on stream not opened for reading" do
+    IOSpecs.writable_iowrapper do |iowrapper|
+      lambda { iowrapper.send(@method) }.should raise_error(IOError)
+    end
+  end
+
+  it "raises IOError on stream closed for reading by close_read" do
+    @iowrapper.close_read
+    lambda { @iowrapper.send(@method) }.should raise_error(IOError)
+  end
+
+  it "returns true on one-byte stream after single-byte read" do
+    File.open(File.dirname(__FILE__) + '/../fixtures/one_byte.txt') do |one_byte|
+      WritableIOWrapper.open(one_byte) do |iowrapper|
+        one_byte.read(1)
+        one_byte.send(@method).should == true
+      end
+    end
+  end
+
+  it "returns true on receiving side of Pipe when writing side is closed" do
+    r, w = IO.pipe
+    iowrapper_r = ReadableIOWrapper.open(r)
+    iowrapper_w = WritableIOWrapper.open(w)
+    iowrapper_w.close
+    w.close
+
+    iowrapper_r.send(@method).should == true
+
+    iowrapper_r.close
+    r.close
+  end
+
+  it "returns false on receiving side of Pipe when writing side wrote some data" do
+    r, w = IO.pipe
+    iowrapper_r = ReadableIOWrapper.open(r)
+    iowrapper_w = WritableIOWrapper.open(w)
+    iowrapper_w.sync = true
+
+    iowrapper_w.puts "hello"
+    iowrapper_r.send(@method).should == false
+    iowrapper_w.close
+    w.close
+
+    iowrapper_r.send(@method).should == false
+    iowrapper_r.read
+    iowrapper_r.send(@method).should == true
+
+    iowrapper_r.close
+    r.close
+  end
+end

data/spec/shared/pos.rb

@@ -0,0 +1,39 @@
+describe :io_like__pos, :shared => true do
+  before :each do
+    @fname = tmp('IO_Like__pos_test')
+    File.open(@fname, 'w') { |f| f.write("123") }
+  end
+
+  after :each do
+    File.unlink(@fname)
+  end
+
+  it "gets the offset" do
+    IOSpecs.readable_iowrapper do |iowrapper|
+      iowrapper.send(@method).should == 0
+      iowrapper.read(1)
+      iowrapper.send(@method).should == 1
+      iowrapper.read(2)
+      iowrapper.send(@method).should == 3
+    end
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.send(@method) }.should raise_error(IOError)
+  end
+
+  # BOGUS EXPECTATION
+  # This fails for File and IO.  It used to pass because the end of file was not
+  # actually reached with just 2 bytes read from the file.
+  #it "resets #eof?" do
+  #  File.open(@fname) do |f|
+  #    ReadableIOWrapper.open(f) do |iowrapper|
+  #      iowrapper.read(1)
+  #      iowrapper.read(1)
+  #      iowrapper.eof?.should == true
+  #      iowrapper.send(@method)
+  #      iowrapper.eof?.should == false
+  #    end
+  #  end
+  #end
+end

data/spec/shared/tty.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../fixtures/classes'
+
+describe :io_like__tty, :shared => true do
+  it "returns false if this stream is open" do
+    IOSpecs.readable_iowrapper { |io| io.send(@method) }.should == false
+    IOSpecs.writable_iowrapper { |io| io.send(@method) }.should == false
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.send(@method) }.should raise_error(IOError)
+  end
+end

data/spec/shared/write.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/../fixtures/classes'
+
+describe :io_like__write, :shared => true do
+  before :each do
+    @filename = tmp("IO_Like__shared_write_test")
+    @content = "012345678901234567890123456789"
+    File.open(@filename, "w") { |f| f.write(@content) }
+    @file = File.open(@filename, "r+")
+    @iowrapper = IOWrapper.open(@file)
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @file.close unless @file.closed?
+    File.delete(@filename)
+  end
+
+  it "coerces the argument to a string using to_s" do
+    (obj = mock('test')).should_receive(:to_s).and_return('a string')
+    @iowrapper.send(@method, obj)
+  end
+
+  it "does not warn if called after IO#read" do
+    @iowrapper.read(5)
+    lambda { @iowrapper.send(@method, "fghij") }.should_not complain
+  end
+
+  it "writes to the current position after IO#read" do
+    @iowrapper.read(5)
+    @iowrapper.send(@method, "abcd")
+    @iowrapper.rewind
+    @iowrapper.read.should == "01234abcd901234567890123456789"
+  end
+
+  it "advances the file position by the count of given bytes" do
+    @iowrapper.send(@method, "abcde")
+    @iowrapper.read(10).should == "5678901234"
+  end
+
+  it "raises IOError on read-only stream if writing more than zero bytes" do
+    lambda do
+      IOSpecs.readable_iowrapper do |iowrapper|
+        iowrapper.send(@method, "abcde")
+      end
+    end.should raise_error(IOError)
+  end
+
+  it "raises IOError on closed stream if writing more than zero bytes" do
+    lambda do
+      IOSpecs.closed_file.send(@method, "abcde")
+    end.should raise_error(IOError)
+  end
+end

data/spec/sync_spec.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#sync=" do
+  before :each do
+    @file = File.dirname(__FILE__) + '/fixtures/readlines.txt'
+    @f = File.open(@file)
+    @iowrapper = ReadableIOWrapper.open(@f)
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @f.close unless @f.closed?
+  end
+
+  it "sets the sync mode to true or false" do
+    @iowrapper.sync = true
+    @iowrapper.sync.should == true
+    @iowrapper.sync = false
+    @iowrapper.sync.should == false
+  end
+
+  it "accepts non-boolean arguments" do
+    @iowrapper.sync = 10
+    @iowrapper.sync.should == true
+    @iowrapper.sync = nil
+    @iowrapper.sync.should == false
+    @iowrapper.sync = Object.new
+    @iowrapper.sync.should == true
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.sync = true }.should raise_error(IOError)
+  end
+end
+
+describe "IO::Like#sync" do
+  before :each do
+    @file = File.dirname(__FILE__) + '/fixtures/readlines.txt'
+    @f = File.open(@file)
+    @iowrapper = ReadableIOWrapper.open(@f)
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @f.close unless @f.closed?
+  end
+
+  it "returns the current sync mode" do
+    @iowrapper.sync.should == false
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.sync }.should raise_error(IOError)
+  end
+end

data/spec/sysread_spec.rb

@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#sysread on a file" do
+  before :each do
+    @filename = tmp("IO_Like___sysread_file") + $$.to_s
+    @contents = "012345678901234567890123456789"
+    File.open(@filename, "w") { |f| f.write(@contents) }
+
+    @file = File.open(@filename, "r+")
+    @iowrapper = IOWrapper.open(@file)
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @file.close unless @file.closed?
+    File.delete(@filename) if File.exists?(@filename)
+  end
+
+  it "reads the specified number of bytes from the file" do
+    @iowrapper.sysread(15).should == @contents.slice(0, 15)
+  end
+
+  it "reads the specified number of bytes from the file to the buffer" do
+    buf = "" # empty buffer
+    @iowrapper.sysread(15, buf).should == buf
+    buf.should == @contents.slice(0, 15)
+
+    @iowrapper.rewind
+
+    buf = "ABCDE" # small buffer
+    @iowrapper.sysread(15, buf).should == buf
+    buf.should == @contents.slice(0, 15)
+
+    @iowrapper.rewind
+
+    buf = "ABCDE" * 5 # large buffer
+    @iowrapper.sysread(15, buf).should == buf
+    buf.should == @contents.slice(0, 15)
+  end
+
+  it "coerces the second argument to string and uses it as a buffer" do
+    buf = "ABCDE"
+    (obj = mock("buff")).should_receive(:to_str).and_return(buf)
+    @iowrapper.sysread(15, obj).should == buf
+    buf.should == @contents.slice(0, 15)
+  end
+
+  it "advances the position of the file by the specified number of bytes" do
+    @iowrapper.sysread(15)
+    @iowrapper.sysread(5).should == @contents.slice(15, 5)
+  end
+
+  it "raises IOError when called immediately after a buffered IO#read" do
+    @iowrapper.read(15)
+    lambda { @iowrapper.sysread(5) }.should raise_error(IOError)
+  end
+
+  it "does not raise IOError if called after IO#read followed by IO#write" do
+    @iowrapper.read(5)
+    @iowrapper.write("abcde")
+    lambda { @iowrapper.sysread(5) }.should_not raise_error(IOError)
+  end
+
+  it "does not raise IOError if called after IO#read followed by IO#syswrite" do
+    @iowrapper.read(5)
+    @iowrapper.syswrite("abcde")
+    lambda { @iowrapper.sysread(5) }.should_not raise_error(IOError)
+  end
+
+  it "reads updated content after the flushed buffered IO#write" do
+    @iowrapper.write("abcde")
+    @iowrapper.flush
+    @iowrapper.sysread(5).should == @contents.slice(5, 5)
+    File.open(@filename) do |f|
+      f.sysread(10).should == "abcde56789"
+    end
+  end
+
+  it "raises IOError on write-only stream" do
+    lambda { IOSpecs.writable_iowrapper.sysread(5) }.should raise_error(IOError)
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.sysread(5) }.should raise_error(IOError)
+  end
+end

data/spec/sysseek_spec.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#sysseek on a file" do
+  # TODO: This should be made more generic with seek spec
+  before :each do
+    @file = File.open(File.dirname(__FILE__) + '/fixtures/readlines.txt', 'r')
+    @iowrapper = IOWrapper.open(@file)
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @file.close unless @file.closed?
+  end
+
+  it "moves the read position relative to the current position with SEEK_CUR" do
+    @iowrapper.sysseek(10, IO::SEEK_CUR)
+    @iowrapper.readline.should == "igne une.\n"
+  end
+
+  it "raises an error when called after buffered reads" do
+    @iowrapper.readline
+    lambda { @iowrapper.sysseek(-5, IO::SEEK_CUR) }.should raise_error(IOError)
+  end
+
+  it "warns if called immediately after a buffered IO#write" do
+    begin
+      # copy contents to a separate file
+      tmpfile = File.open(tmp("tmp_IO_sysseek"), "w")
+      wrapper = IOWrapper.open(tmpfile)
+      wrapper.write(@iowrapper.read)
+      wrapper.seek(0, File::SEEK_SET)
+
+      wrapper.write("abcde")
+      lambda { wrapper.sysseek(10) }.should complain(/sysseek/)
+    ensure
+      wrapper.close
+      File.unlink(tmpfile.path)
+    end
+  end
+
+  it "moves the read position relative to the start with SEEK_SET" do
+    @iowrapper.sysseek(42, IO::SEEK_SET)
+    @iowrapper.readline.should == "quí está la línea tres.\n"
+  end
+
+  it "moves the read position relative to the end with SEEK_END" do
+    @iowrapper.sysseek(1, IO::SEEK_END)
+
+    # this is the safest way of checking the EOF when
+    # sys-* methods are invoked
+    lambda { @iowrapper.sysread(1) }.should raise_error(EOFError)
+
+    @iowrapper.sysseek(-25, IO::SEEK_END)
+    @iowrapper.sysread(7).should == "cinco.\n"
+  end
+
+  it "can handle any numerical argument without breaking and can seek past EOF" do
+    @iowrapper.sysseek(1.2).should == 1
+    @iowrapper.sysseek(2**10).should == 1024
+    @iowrapper.sysseek(2**32).should == 4294967296
+    lambda { @iowrapper.sysseek(2**128) }.should raise_error(RangeError)
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.sysseek(0) }.should raise_error(IOError)
+  end
+end

data/spec/syswrite_spec.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+require File.dirname(__FILE__) + '/shared/write'
+
+describe "IO::Like#syswrite" do
+  before :each do
+    @filename = tmp("IO_Like__syswrite_test")
+    @content = "012345678901234567890123456789"
+    File.open(@filename, "w") { |f| f.syswrite(@content) }
+    @file = File.open(@filename, "r+")
+    @iowrapper = IOWrapper.open(@file)
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @file.close unless @file.closed?
+    File.delete(@filename)
+  end
+
+  it "returns the number of bytes written" do
+    @iowrapper.syswrite('').should == 0
+    @iowrapper.syswrite('abcde').should == 5
+  end
+
+  it "writes all of the string's bytes but does not buffer them" do
+    written = @iowrapper.syswrite("abcde")
+    written.should == 5
+    File.open(@filename) do |file|
+      file.sysread(10).should == "abcde56789"
+      file.seek(0)
+      @iowrapper.flush
+      file.sysread(10).should == "abcde56789"
+    end
+  end
+
+  not_compliant_on :rubinius do
+    it "warns if called immediately after a buffered IO#write" do
+      @iowrapper.write("abcde")
+      lambda { @iowrapper.syswrite("fghij") }.should complain(/syswrite/)
+    end
+  end
+
+  it "does not warn if called after IO#write with intervening IO#sysread" do
+    @iowrapper.write("abcde")
+    @iowrapper.sysread(5)
+    lambda { @iowrapper.syswrite("fghij") }.should_not complain
+  end
+
+  it "writes to the actual file position when called after buffered IO#read" do
+    @iowrapper.read(5)
+    @iowrapper.syswrite("abcde")
+    File.open(@filename) do |file|
+      file.sysread(10).should == "01234abcde"
+    end
+  end
+end
+
+describe "IO::Like#syswrite" do
+  it_behaves_like :io_like__write, :syswrite
+end