io-like 0.3.0 → 0.3.1

data/spec/readlines_spec.rb

@@ -0,0 +1,140 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#readlines when passed no arguments" do
+  before(:each) do
+    @io = File.open(File.dirname(__FILE__) + '/fixtures/readlines.txt')
+    @iowrapper = IOWrapper.open(@io)
+  end
+
+  after(:each) do
+    @iowrapper.close
+    @io.close
+  end
+
+  it "returns an Array containing lines based on $/" do
+    begin
+      old_sep, $/ = $/, " "
+      @iowrapper.readlines.should == [
+        "Voici ", "la ", "ligne ", "une.\nQui ", "\303\250 ", "la ", "linea ",
+        "due.\nAqu\303\255 ", "est\303\241 ", "la ", "l\303\255nea ",
+        "tres.\nIst ", "hier ", "Linie ", "vier.\nEst\303\241 ", "aqui ", "a ",
+        "linha ", "cinco.\nHere ", "is ", "line ", "six.\n"
+      ]
+    ensure
+      $/ = old_sep
+    end
+  end
+
+  it "updates self's position" do
+    @iowrapper.readlines
+    @iowrapper.pos.should eql(134)
+  end
+
+  it "updates self's lineno based on the number of lines read" do
+    @iowrapper.readlines
+    @iowrapper.lineno.should eql(6)
+  end
+
+  it "does not change $_" do
+    $_ = "test"
+    @iowrapper.readlines(">")
+    $_.should == "test"
+  end
+
+  it "returns an empty Array when self is at the end" do
+    @iowrapper.pos = 134
+    @iowrapper.readlines.should == []
+  end
+end
+
+describe "IO::Like#readlines when passed [separator]" do
+  before(:each) do
+    @io = File.open(File.dirname(__FILE__) + '/fixtures/readlines.txt')
+    @iowrapper = IOWrapper.open(@io)
+  end
+
+  after(:each) do
+    @iowrapper.close
+    @io.close
+  end
+
+  it "returns an Array containing lines based on the passed separator" do
+    @iowrapper.readlines('r').should == [
+      "Voici la ligne une.\nQui \303\250 la linea due.\nAqu\303\255 est\303\241 la l\303\255nea tr",
+      "es.\nIst hier",
+      " Linie vier",
+      ".\nEst\303\241 aqui a linha cinco.\nHer",
+      "e is line six.\n"
+    ]
+  end
+
+  it "returns an empty Array when self is at the end" do
+    @iowrapper.pos = 134
+    @iowrapper.readlines('r').should == []
+  end
+
+  it "updates self's lineno based on the number of lines read" do
+    @iowrapper.readlines('r')
+    @iowrapper.lineno.should eql(5)
+  end
+
+  it "updates self's position based on the number of characters read" do
+    @iowrapper.readlines("r")
+    @iowrapper.pos.should eql(134)
+  end
+
+  it "does not change $_" do
+    $_ = "test"
+    @iowrapper.readlines("r")
+    $_.should == "test"
+  end
+
+  it "returns an Array containing all paragraphs when the passed separator is an empty String" do
+    IOWrapper.open(File.open(File.dirname(__FILE__) + '/fixtures/paragraphs.txt')) do |io|
+      io.readlines("").should == [
+        "This is\n\n",
+        "an example\n\n",
+        "of paragraphs."
+      ]
+    end
+  end
+
+  it "returns the remaining content as one line starting at the current position when passed nil" do
+    @iowrapper.pos = 5
+    @iowrapper.readlines(nil).should == [
+      " la ligne une.\nQui \303\250 la linea due.\n" +
+      "Aqu\303\255 est\303\241 la l\303\255nea tres.\n" +
+      "Ist hier Linie vier.\nEst\303\241 aqui a linha cinco.\n" +
+      "Here is line six.\n"
+    ]
+  end
+
+  it "tries to convert the passed separator to a String using #to_str" do
+    obj = mock('to_str')
+    obj.stub!(:to_str).and_return("r")
+    @iowrapper.readlines(obj).should == [
+      "Voici la ligne une.\nQui \303\250 la linea due.\nAqu\303\255 est\303\241 la l\303\255nea tr",
+      "es.\nIst hier",
+      " Linie vier",
+      ".\nEst\303\241 aqui a linha cinco.\nHer",
+      "e is line six.\n"]
+  end
+end
+
+describe "IO::Like#readlines when in write-only mode" do
+  it "raises an IOError" do
+    path = tmp("write_only_specs")
+    IOWrapper.open(File.open(path, 'a')) do |io|
+      lambda { io.readlines }.should raise_error(IOError)
+    end
+
+    File.open(path) do |io|
+      IOWrapper.open(io) do |iowrapper|
+        io.close_read
+        lambda { iowrapper.readlines }.should raise_error(IOError)
+      end
+    end
+    File.unlink(path) if File.exists?(path)
+  end
+end

data/spec/readpartial_spec.rb

@@ -0,0 +1,92 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#readpartial" do
+  before :each do
+    @rd, @wr = IO.pipe
+    @iowrapper_rd, @iowrapper_wr = IOWrapper.open(@rd), IOWrapper.open(@wr)
+    @iowrapper_wr.sync = true
+  end
+
+  after :each do
+    @iowrapper_rd.close unless @iowrapper_rd.closed?
+    @iowrapper_wr.close unless @iowrapper_wr.closed?
+    @rd.close unless @rd.closed?
+    @wr.close unless @wr.closed?
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.readpartial(10) }.should raise_error(IOError)
+
+    @iowrapper_rd.close
+    lambda { @iowrapper_rd.readpartial(10) }.should raise_error(IOError)
+  end
+
+  it "reads at most the specified number of bytes" do
+    @iowrapper_wr.write("foobar")
+
+    # buffered read
+    @iowrapper_rd.read(1).should == 'f'
+    # return only specified number, not the whole buffer
+    @iowrapper_rd.readpartial(1).should == "o"
+  end
+
+  it "reads after ungetc with data in the buffer" do
+    @iowrapper_wr.write("foobar")
+    c = @iowrapper_rd.getc
+    @iowrapper_rd.ungetc(c)
+    @iowrapper_rd.readpartial(3).should == "foo"
+    @iowrapper_rd.readpartial(3).should == "bar"
+  end
+
+  it "reads after ungetc without data in the buffer" do
+    @iowrapper_wr.write("f")
+    c = @iowrapper_rd.getc
+    @iowrapper_rd.ungetc(c)
+    @iowrapper_rd.readpartial(2).should == "f"
+
+    # now, also check that the ungot char is cleared and
+    # not returned again
+    @iowrapper_wr.write("b")
+    @iowrapper_rd.readpartial(2).should == "b"
+  end
+
+  it "discards the existing buffer content upon successful read" do
+    buffer = "existing"
+    @iowrapper_wr.write("hello world")
+    @iowrapper_wr.close
+    @wr.close
+    @iowrapper_rd.readpartial(11, buffer)
+    buffer.should == "hello world"
+  end
+
+  it "raises EOFError on EOF" do
+    @iowrapper_wr.write("abc")
+    @iowrapper_wr.close
+    @wr.close
+    @iowrapper_rd.readpartial(10).should == 'abc'
+    lambda { @iowrapper_rd.readpartial(10) }.should raise_error(EOFError)
+  end
+
+  it "discards the existing buffer content upon error" do
+    buffer = 'hello'
+    @iowrapper_wr.close
+    @wr.close
+    lambda { @iowrapper_rd.readpartial(1, buffer) }.should raise_error(EOFError)
+    buffer.should be_empty
+  end
+
+  it "raises IOError if the stream is closed" do
+    @iowrapper_wr.close
+    @wr.close
+    lambda { @iowrapper_rd.readpartial(1) }.should raise_error(IOError)
+  end
+
+  it "raises ArgumentError if the negative argument is provided" do
+    lambda { @iowrapper_rd.readpartial(-1) }.should raise_error(ArgumentError)
+  end
+
+  it "immediately returns an empty string if the length argument is 0" do
+    @iowrapper_rd.readpartial(0).should == ""
+  end
+end

data/spec/rewind_spec.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#rewind" do
+  before :each do
+    @file = File.open(File.dirname(__FILE__) + '/fixtures/readlines.txt', 'r')
+    @iowrapper = ReadableIOWrapper.open(@file)
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @file.close unless @file.closed?
+  end
+
+  it "should return 0" do
+    @iowrapper.rewind.should == 0
+  end
+
+  it "positions the instance to the beginning of input" do
+    @iowrapper.readline.should == "Voici la ligne une.\n"
+    @iowrapper.readline.should == "Qui è la linea due.\n"
+    @iowrapper.rewind
+    @iowrapper.readline.should == "Voici la ligne une.\n"
+  end
+
+  it "positions the instance to the beginning of input and clears EOF" do
+    value = @iowrapper.read
+    @iowrapper.rewind
+    @iowrapper.eof?.should == false
+    value.should == @iowrapper.read
+  end
+
+  it "sets lineno to 0" do
+    @iowrapper.readline.should == "Voici la ligne une.\n"
+    @iowrapper.lineno.should == 1
+    @iowrapper.rewind
+    @iowrapper.lineno.should == 0
+  end
+
+  it "works on write-only streams" do
+    file = tmp('IO_Like__rewind.test')
+    File.open(file, 'w') do |f|
+      WritableIOWrapper.open(f) do |io|
+        io.write('test1')
+        io.rewind.should == 0
+        io.write('test2')
+      end
+    end
+    File.read(file).should == 'test2'
+    File.delete(file)
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.rewind }.should raise_error(IOError)
+  end
+end

data/spec/seek_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#seek" do
+  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
+    lambda { @iowrapper.seek(-1) }.should raise_error(Errno::EINVAL)
+    @iowrapper.seek(10, IO::SEEK_CUR)
+    @iowrapper.readline.should == "igne une.\n"
+    @iowrapper.seek(-5, IO::SEEK_CUR)
+    @iowrapper.readline.should == "une.\n"
+  end
+
+  it "moves the read position relative to the start with SEEK_SET" do
+    @iowrapper.seek(1)
+    @iowrapper.pos.should == 1
+    @iowrapper.rewind
+    @iowrapper.seek(42, IO::SEEK_SET)
+    @iowrapper.readline.should == "quí está la línea tres.\n"
+    @iowrapper.seek(5, IO::SEEK_SET)
+    @iowrapper.readline.should == " la ligne une.\n"
+  end
+
+  it "moves the read position relative to the end with SEEK_END" do
+    @iowrapper.seek(0, IO::SEEK_END)
+    @iowrapper.tell.should == 134
+    @iowrapper.seek(-25, IO::SEEK_END)
+    @iowrapper.readline.should == "cinco.\n"
+  end
+
+  it "can handle any numerical argument without breaking" do
+    @iowrapper.seek(1.2).should == 0
+    @iowrapper.seek(2**32).should == 0
+    @iowrapper.seek(1.23423423432e12).should == 0
+    @iowrapper.seek(0.00000000000000000000001).should == 0
+    lambda { @iowrapper.seek(2**128) }.should raise_error(RangeError)
+  end
+
+  it "raises IOError on closed stream" do
+    lambda { IOSpecs.closed_file.seek(0) }.should raise_error(IOError)
+  end
+
+  it "moves the read position and clears EOF with SEEK_SET" do
+    value = @iowrapper.read
+    @iowrapper.seek(0, IO::SEEK_SET)
+    @iowrapper.eof?.should == false
+    value.should == @iowrapper.read
+  end
+
+  it "moves the read position and clears EOF with SEEK_CUR" do
+    value = @iowrapper.read
+    @iowrapper.seek(-1, IO::SEEK_CUR)
+    @iowrapper.eof?.should == false
+    value[-1].should == @iowrapper.read[0]
+  end
+
+  it "moves the read position and clears EOF with SEEK_END" do
+    value = @iowrapper.read
+    @iowrapper.seek(-1, IO::SEEK_END)
+    @iowrapper.eof?.should == false
+    value[-1].should == @iowrapper.read[0]
+  end
+end

data/spec/shared/each.rb

@@ -0,0 +1,204 @@
+require File.dirname(__FILE__) + '/../fixtures/classes'
+
+describe :io_like__each, :shared => true do
+  before(:each) do
+    @old_rs = $/
+    @io = File.open(IOSpecs.gets_fixtures)
+    @iowrapper = ReadableIOWrapper.open(@io)
+  end
+
+  after(:each) do
+    @iowrapper.close
+    @io.close
+    $/ = @old_rs
+  end
+
+  it "returns self" do
+    @iowrapper.send(@method) { |l| l }.should == @iowrapper
+  end
+
+  it "yields each line to the passed block" do
+    seen = []
+    @iowrapper.send(@method) { |s| seen << s }
+    seen.should == [
+      "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
+
+  it "yields each line starting from the current position" do
+    seen = []
+    @iowrapper.pos = 40
+    @iowrapper.send(@method) { |s| seen << s }
+    seen.should == [
+      "\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
+
+  it "does not change $_" do
+    $_ = "test"
+    @iowrapper.send(@method) { |s| s }
+    $_.should == "test"
+  end
+
+  it "uses $/ as the default line separator" do
+    seen = []
+    $/ = " "
+    @iowrapper.send(@method) { |s| seen << s }
+    seen.should == [
+      "Voici ", "la ", "ligne ", "une.\nQui ", "\303\250 ", "la ", "linea ",
+      "due.\n\n\nAqu\303\255 ", "est\303\241 ", "la ", "l\303\255nea ",
+      "tres.\nIst ", "hier ", "Linie ", "vier.\n\nEst\303\241 ", "aqui ",
+      "a ", "linha ", "cinco.\nHere ", "is ", "line ", "six.\n"
+    ]
+  end
+
+  it "raises IOError on write-only stream" do
+    # method must have a block in order to raise the IOError.
+    # MRI 1.8.7 returns enumerator if block is not provided.
+    # See [ruby-core:16557].
+    lambda do
+      IOSpecs.writable_iowrapper do |iowrapper|
+        iowrapper.send(@method) {}
+      end
+    end.should raise_error(IOError)
+  end
+
+  it "raises IOError on closed stream" do
+    # method must have a block in order to raise the IOError.
+    # MRI 1.8.7 returns enumerator if block is not provided.
+    # See [ruby-core:16557].
+    lambda { IOSpecs.closed_file.send(@method) {} }.should raise_error(IOError)
+  end
+
+  ruby_version_is "" ... "1.8.7" do
+    it "yields a LocalJumpError when passed no block" do
+      lambda { @iowrapper.send(@method) }.should raise_error(LocalJumpError)
+    end
+  end
+
+  ruby_version_is "1.8.7" do
+    it "returns an Enumerator when passed no block" do
+      enum = @iowrapper.send(@method, " ")
+      enum.instance_of?(Enumerable::Enumerator).should be_true
+
+      enum.to_a.should == [
+        "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
+  end
+end
+
+describe :io_like__each_separator, :shared => true do
+  before(:each) do
+    @io = File.open(IOSpecs.gets_fixtures)
+    @iowrapper = ReadableIOWrapper.open(@io)
+  end
+
+  after(:each) do
+    @iowrapper.close
+    @io.close
+  end
+
+  it "returns self" do
+    @iowrapper.send(@method, " ") { |l| l }.should equal(@iowrapper)
+  end
+
+  it "uses the passed argument as the line separator" do
+    seen = []
+    @iowrapper.send(@method, " ") { |s| seen << s }
+    seen.should == [
+      "Voici ", "la ", "ligne ", "une.\nQui ", "\303\250 ", "la ", "linea ",
+      "due.\n\n\nAqu\303\255 ", "est\303\241 ", "la ", "l\303\255nea ",
+      "tres.\nIst ", "hier ", "Linie ", "vier.\n\nEst\303\241 ", "aqui ", "a ",
+      "linha ", "cinco.\nHere ", "is ", "line ", "six.\n"
+    ]
+  end
+
+  it "does not change $_" do
+    $_ = "test"
+    @iowrapper.send(@method, " ") { |s| s }
+    $_.should == "test"
+  end
+
+  it "tries to convert the passed separator to a String using #to_str" do
+    obj = mock("to_str")
+    obj.stub!(:to_str).and_return(" ")
+
+    seen = []
+    @iowrapper.send(@method, obj) { |l| seen << l }
+    seen.should == [
+      "Voici ", "la ", "ligne ", "une.\nQui ", "\303\250 ", "la ", "linea ",
+      "due.\n\n\nAqu\303\255 ", "est\303\241 ", "la ", "l\303\255nea ",
+      "tres.\nIst ", "hier ", "Linie ", "vier.\n\nEst\303\241 ", "aqui ", "a ",
+      "linha ", "cinco.\nHere ", "is ", "line ", "six.\n"
+    ]
+  end
+
+  it "yields self's content starting from the current position when the passed separator is nil" do
+    seen = []
+    @iowrapper.pos = 100
+    @iowrapper.send(@method, nil) { |s| seen << s }
+    seen.should == ["qui a linha cinco.\nHere is line six.\n"]
+  end
+
+  it "yields each paragraph when passed an empty String as separator" do
+    seen = []
+    para_file = File.dirname(__FILE__) + '/../fixtures/paragraphs.txt'
+    File.open(para_file) do |io|
+      ReadableIOWrapper.open(io) do |iowrapper|
+        iowrapper.send(@method, "") { |s| seen << s }
+      end
+    end
+    seen.should == ["This is\n\n", "an example\n\n", "of paragraphs."]
+  end
+
+  it "raises IOError on write-only stream" do
+    # method must have a block in order to raise the IOError.
+    # MRI 1.8.7 returns enumerator if block is not provided.
+    # See [ruby-core:16557].
+    lambda do
+      IOSpecs.writable_iowrapper do |iowrapper|
+        iowrapper.send(@method, " ") {}
+      end
+    end.should raise_error(IOError)
+  end
+
+  it "raises IOError on closed stream" do
+    # method must have a block in order to raise the IOError.
+    # MRI 1.8.7 returns enumerator if block is not provided.
+    # See [ruby-core:16557].
+    lambda do
+      IOSpecs.closed_file.send(@method, " ") {}
+    end.should raise_error(IOError)
+  end
+
+  ruby_version_is "" ... "1.8.7" do
+    it "yields a LocalJumpError when passed no block" do
+      lambda do
+        @iowrapper.send(@method, " ")
+      end.should raise_error(LocalJumpError)
+    end
+  end
+
+  ruby_version_is "1.8.7" do
+    it "returns an Enumerator when passed no block" do
+      enum = @iowrapper.send(@method, " ")
+      enum.instance_of?(Enumerable::Enumerator).should be_true
+
+      enum.to_a.should == [
+        "Voici ", "la ", "ligne ", "une.\nQui ", "\303\250 ", "la ", "linea ",
+        "due.\n\n\nAqu\303\255 ", "est\303\241 ", "la ", "l\303\255nea ",
+        "tres.\nIst ", "hier ", "Linie ", "vier.\n\nEst\303\241 ", "aqui ",
+        "a ", "linha ", "cinco.\nHere ", "is ", "line ", "six.\n"
+      ]
+    end
+  end
+end