io-like 0.3.0 → 0.3.1

data/spec/printf_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#printf" do
+  before :each do
+    @io = IO.new(STDOUT.fileno, 'w')
+    @iowrapper = WritableIOWrapper.open(@io)
+    @iowrapper.sync = true
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+  end
+
+  it "writes the #sprintf formatted string to the file descriptor" do
+    lambda do
+      @io.printf("%s\n", "look ma, no hands")
+    end.should output_to_fd("look ma, no hands\n", @io)
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.printf("stuff") }.should raise_error(IOError)
+  end
+end

data/spec/putc_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#putc" do
+  before :each do
+    @filename = tmp('IO_Like__putc_test')
+    @file = File.open(@filename, 'w')
+    @file.sync = true
+    @iowrapper = WritableIOWrapper.open(@file)
+    @iowrapper.sync = true
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @file.close unless @file.closed?
+    File.unlink @filename
+  end
+
+  it "returns a reference to the object" do
+    @iowrapper.putc('a').should == 'a'
+    @iowrapper.putc(128).should == 128
+  end
+
+  it "writes the first byte of a String" do
+    @iowrapper.putc("foo")
+    File.read(@filename).should == 'f'
+  end
+
+  it "writes the first byte of an object's string representation" do
+    (obj = mock('test')).should_receive(:to_int).and_return(261)
+    @iowrapper.putc(obj)
+    File.read(@filename).should == "\005"
+  end
+
+  it "writes Numerics that fit in a C char" do
+    @iowrapper.putc(-128)
+    @iowrapper.putc(0)
+    @iowrapper.putc(255)
+
+    File.read(@filename).should == "\200\000\377"
+  end
+
+  it "write the first byte of Numerics that don't fit in a C char" do
+    @iowrapper.putc(-129)
+    @iowrapper.putc(256)
+
+    File.read(@filename).should == "\177\000"
+  end
+
+  it "checks if the stream is writable" do
+    lambda { IOSpecs.readable_iowrapper.putc('a') }.should raise_error(IOError)
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.putc('a') }.should raise_error(IOError)
+  end
+end

data/spec/puts_spec.rb

@@ -0,0 +1,99 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+# TODO: need to find a better way to test this. Too fragile to set expectations
+# to each write call. Only care that all the characters are sent not the number
+# or write calls. Also, these tests do not make sure the ordering of the write calls
+# are correct.
+describe "IO::Like#puts" do
+  before :each do
+    @old_record_separator = $\
+    @old_field_separator = $,
+    @filename = tmp('IO_Like__print_test')
+    @file = File.open(@filename, 'w')
+    @file.sync = true
+    @iowrapper = WritableIOWrapper.open(@file)
+    @iowrapper.sync = true
+  end
+
+  after :each do
+    $\ = @old_record_separator
+    $, = @old_field_separator
+    @iowrapper.close unless @iowrapper.closed?
+    @file.close unless @file.closed?
+  end
+
+  it "returns nil" do
+    @iowrapper.puts('hello').should == nil
+  end
+
+  it "writes just a newline when given no args" do
+    @iowrapper.puts()
+    File.read(@filename).should == "\n"
+  end
+
+  it "writes just a newline when given just a newline" do
+    @iowrapper.puts("\n")
+    File.read(@filename).should == "\n"
+  end
+
+  it "writes nil with a newline when given nil as an arg" do
+    @iowrapper.puts(nil)
+    File.read(@filename).should == "nil\n"
+  end
+
+  it "coerces arguments to strings using to_s" do
+    data = 'abcdefgh9876'
+    (obj = mock('test')).should_receive(:to_s).and_return(data)
+    @iowrapper.puts(obj)
+    File.read(@filename).should == "#{data}\n"
+  end
+
+  it "writes each arg if given several" do
+    data1 = 'abcdefgh9876'
+    data2 = '12345678zyxw'
+    @iowrapper.puts(data1, data2)
+    File.read(@filename).should == "#{data1}\n#{data2}\n"
+  end
+
+  it "flattens a nested array before writing it" do
+    data = ['abcdefgh9876', '12345678zyxw']
+    @iowrapper.puts(data)
+    File.read(@filename).should == "#{data[0]}\n#{data[1]}\n"
+  end
+
+  it "writes [...] for a recursive array arg" do
+    data = []
+    data << 1 << data << 2
+    @iowrapper.puts(data)
+    File.read(@filename).should == "#{data[0]}\n[...]\n#{data[2]}\n"
+  end
+
+  it "writes a newline after objects that do not end in newlines" do
+    data = 'abcdefgh9876'
+    @iowrapper.puts(data)
+    File.read(@filename).should == "#{data}\n"
+  end
+
+  it "does not write a newline after objects that end in newlines" do
+    data = "abcdefgh9876\n"
+    @iowrapper.puts(data)
+    File.read(@filename).should == data
+  end
+
+  it "ignores the $\ separator global" do
+    $\ = ":"
+    data1 = 'abcdefgh9876'
+    data2 = '12345678zyxw'
+    @iowrapper.puts(data1, data2)
+    File.read(@filename).should == "#{data1}\n#{data2}\n"
+  end
+
+  it "raises IOError on read-only stream" do
+    lambda { IOSpecs.readable_iowrapper.puts }.should raise_error(IOError)
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.puts }.should raise_error(IOError)
+  end
+end

data/spec/read_spec.rb

@@ -0,0 +1,162 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#read" do
+  before :each do
+    @filename = tmp('IO_Like__read_test')
+    @contents = "1234567890"
+    File.open(@filename, "w") { |io| io.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 "can be read from consecutively" do
+    @iowrapper.read(1).should == '1'
+    @iowrapper.read(2).should == '23'
+    @iowrapper.read(3).should == '456'
+    @iowrapper.read(4).should == '7890'
+  end
+
+  it "can read lots of data" do
+    data = "\xaa" * (8096 * 2 + 1024) # HACK IO::BufferSize
+    File.open(@filename, 'w') { |io| io.write(data) }
+    actual = nil
+    File.open(@filename, 'r') { |io| actual = io.read }
+
+    actual.length.should == data.length
+    actual.split('').all? { |c| c == "\xaa" }.should == true
+  end
+
+  it "can read lots of data with length" do
+    read_length = 8096 * 2 + 1024 # HACK IO::BufferSize
+    data = "\xaa" * (read_length + 8096) # HACK same
+    File.open(@filename, 'w') { |io| io.write(data) }
+    actual = nil
+    File.open(@filename, 'r') { |io| actual = io.read(read_length) }
+
+    actual.length.should == read_length
+    actual.split('').all? { |c| c == "\xaa" }.should == true
+  end
+
+  it "consumes zero bytes when reading zero bytes" do
+    pre_pos = @iowrapper.pos
+
+    @iowrapper.read(0).should == ''
+    @iowrapper.getc.chr.should == '1'
+  end
+
+  it "is at end-of-file when everything has been read" do
+    @iowrapper.read
+    @iowrapper.eof?.should == true
+  end
+
+  it "reads the contents of a file" do
+    @iowrapper.read.should == @contents
+  end
+
+  it "places the specified number of bytes in the buffer" do
+    buf = ""
+    @iowrapper.read(5, buf)
+
+    buf.should == "12345"
+  end
+
+  it "expands the buffer when too small" do
+    buf = "ABCDE"
+    @iowrapper.read(nil, buf)
+
+    buf.should == @contents
+  end
+
+  it "overwrites the buffer" do
+    buf = "ABCDEFGHIJ"
+    @iowrapper.read(nil, buf)
+
+    buf.should == @contents
+  end
+
+  it "truncates the buffer when too big" do
+    buf = "ABCDEFGHIJKLMNO"
+    @iowrapper.read(nil, buf)
+    buf.should == @contents
+
+    @iowrapper.rewind
+    buf = "ABCDEFGHIJKLMNO"
+    @iowrapper.read(5, buf)
+    buf.should == @contents[0..4]
+  end
+
+  it "returns the given buffer" do
+    buf = ""
+
+    @iowrapper.read(nil, buf).object_id.should == buf.object_id
+  end
+
+  it "coerces the second argument to string and uses it as a buffer" do
+    buf = "ABCDE"
+    obj = mock("buff")
+    obj.should_receive(:to_str).any_number_of_times.and_return(buf)
+
+    @iowrapper.read(15, obj).object_id.should_not == obj.object_id
+    buf.should == @contents
+  end
+
+  it "returns an empty string at end-of-file" do
+    @iowrapper.read
+    @iowrapper.read.should == ''
+  end
+
+  it "reads the contents of a file when more bytes are specified" do
+    @iowrapper.read(@contents.length + 1).should == @contents
+  end
+
+  it "reads all data available before a SystemCallError is raised" do
+    # Overrride @file.sysread to raise SystemCallError every other time it's
+    # called.
+    class << @file
+      alias :sysread_orig :sysread
+      def sysread(length)
+        if @error_raised then
+          @error_raised = false
+          sysread_orig(length)
+        else
+          @error_raised = true
+          raise SystemCallError, 'Test Error'
+        end
+      end
+    end
+
+    lambda { @iowrapper.read }.should raise_error(SystemCallError)
+    @iowrapper.read.should == @contents
+  end
+
+  it "returns an empty string when the current pos is bigger than the content size" do
+    @iowrapper.pos = 1000
+    @iowrapper.read.should == ''
+  end
+
+  it "returns nil at end-of-file with a length" do
+    @iowrapper.read
+    @iowrapper.read(1).should == nil
+  end
+
+  it "with length argument returns nil when the current pos is bigger than the content size" do
+    @iowrapper.pos = 1000
+    @iowrapper.read(1).should == nil
+  end
+
+  it "raises IOError on write-only stream" do
+    lambda { IOSpecs.writable_iowrapper.read }.should raise_error(IOError)
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.read }.should raise_error(IOError)
+  end
+end

data/spec/readchar_spec.rb

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

data/spec/readline_spec.rb

@@ -0,0 +1,60 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#readline" do
+  before :each do
+    testfile = File.dirname(__FILE__) + '/fixtures/gets.txt'
+    @contents = File.read(testfile)
+    @io = File.open(testfile, 'r')
+    @iowrapper = IOWrapper.open(@io)
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @io.close unless @io.closed?
+  end
+
+  it "returns the next line on the stream" do
+    @iowrapper.readline.should == "Voici la ligne une.\n"
+    @iowrapper.readline.should == "Qui è la linea due.\n"
+  end
+
+  it "goes back to first position after a rewind" do
+    @iowrapper.readline.should == "Voici la ligne une.\n"
+    @iowrapper.rewind
+    @iowrapper.readline.should == "Voici la ligne une.\n"
+  end
+
+  it "is modified by the cursor position" do
+    @iowrapper.seek(1)
+    @iowrapper.readline.should == "oici la ligne une.\n"
+  end
+
+  it "reads and returns all data available before a SystemCallError is raised when the separator is nil" do
+    # Overrride @io.sysread to raise SystemCallError every other time it's
+    # called.
+    class << @io
+      alias :sysread_orig :sysread
+      def sysread(length)
+        if @error_raised then
+          @error_raised = false
+          sysread_orig(length)
+        else
+          @error_raised = true
+          raise SystemCallError, 'Test Error'
+        end
+      end
+    end
+
+    lambda { @iowrapper.readline(nil) }.should raise_error(SystemCallError)
+    @iowrapper.readline(nil).should == @contents
+  end
+
+  it "raises EOFError on end of stream" do
+    lambda { loop { @iowrapper.readline } }.should raise_error(EOFError)
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.readline }.should raise_error(IOError)
+  end
+end