rubysl-stringio 1.0.0

data/spec/readchar_spec.rb

@@ -0,0 +1,19 @@
+require 'stringio'
+require File.expand_path('../shared/readchar', __FILE__)
+
+describe "StringIO#readchar" do
+  it_behaves_like :stringio_readchar, :readchar
+
+  it "reads the next 8-bit byte from self's current position" do
+    io = StringIO.new("example")
+
+    io.send(@method).should == ?e
+
+    io.pos = 4
+    io.send(@method).should == ?p
+  end
+end
+
+describe "StringIO#readchar when self is not readable" do
+  it_behaves_like :stringio_readchar_not_readable, :readchar
+end

data/spec/readline_spec.rb

@@ -0,0 +1,127 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+
+
+describe "StringIO#readline when passed [separator]" do
+  before(:each) do
+    @io = StringIO.new("this>is>an>example")
+  end
+
+  it "returns the data read till the next occurence of the passed separator" do
+    @io.readline(">").should == "this>"
+    @io.readline(">").should == "is>"
+    @io.readline(">").should == "an>"
+    @io.readline(">").should == "example"
+  end
+
+  ruby_bug "http://redmine.ruby-lang.org/issues/show/159", "1.8.7.17" do
+    it "sets $_ to the read content" do
+      @io.readline(">")
+      $_.should == "this>"
+      @io.readline(">")
+      $_.should == "is>"
+      @io.readline(">")
+      $_.should == "an>"
+      @io.readline(">")
+      $_.should == "example"
+    end
+  end
+
+  it "updates self's lineno by one" do
+    @io.readline(">")
+    @io.lineno.should eql(1)
+
+    @io.readline(">")
+    @io.lineno.should eql(2)
+
+    @io.readline(">")
+    @io.lineno.should eql(3)
+  end
+
+  ruby_bug "", "1.8.8" do
+    it "returns the next paragraph when the passed separator is an empty String" do
+      io = StringIO.new("this is\n\nan example")
+      io.readline("").should == "this is\n\n"
+      io.readline("").should == "an example"
+    end
+  end
+
+  it "returns the remaining content starting at the current position when passed nil" do
+    io = StringIO.new("this is\n\nan example")
+    io.pos = 5
+    io.readline(nil).should == "is\n\nan example"
+  end
+
+  it "tries to convert the passed separator to a String using #to_str" do
+    obj = mock('to_str')
+    obj.should_receive(:to_str).and_return(">")
+    @io.readline(obj).should == "this>"
+  end
+end
+
+describe "StringIO#readline when passed no argument" do
+  before(:each) do
+    @io = StringIO.new("this is\nan example\nfor StringIO#readline")
+  end
+
+  it "returns the data read till the next occurence of $/ or till eof" do
+    @io.readline.should == "this is\n"
+
+    begin
+      old_sep, $/ = $/, " "
+      @io.readline.should == "an "
+      @io.readline.should == "example\nfor "
+      @io.readline.should == "StringIO#readline"
+    ensure
+      $/ = old_sep
+    end
+  end
+
+  ruby_bug "http://redmine.ruby-lang.org/issues/show/159", "1.8.7.17" do
+    it "sets $_ to the read content" do
+      @io.readline
+      $_.should == "this is\n"
+      @io.readline
+      $_.should == "an example\n"
+      @io.readline
+      $_.should == "for StringIO#readline"
+    end
+  end
+
+  it "updates self's position" do
+    @io.readline
+    @io.pos.should eql(8)
+
+    @io.readline
+    @io.pos.should eql(19)
+
+    @io.readline
+    @io.pos.should eql(40)
+  end
+
+  it "updates self's lineno" do
+    @io.readline
+    @io.lineno.should eql(1)
+
+    @io.readline
+    @io.lineno.should eql(2)
+
+    @io.readline
+    @io.lineno.should eql(3)
+  end
+
+  it "raises an IOError if self is at the end" do
+    @io.pos = 40
+    lambda { @io.readline }.should raise_error(IOError)
+  end
+end
+
+describe "StringIO#readline when in write-only mode" do
+  it "raises an IOError" do
+    io = StringIO.new("xyz", "w")
+    lambda { io.readline }.should raise_error(IOError)
+
+    io = StringIO.new("xyz")
+    io.close_read
+    lambda { io.readline }.should raise_error(IOError)
+  end
+end

data/spec/readlines_spec.rb

@@ -0,0 +1,124 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe "StringIO#readlines when passed [separator]" do
+  before(:each) do
+    @io = StringIO.new("this>is>an>example")
+  end
+
+  it "returns an Array containing lines based on the passed separator" do
+    @io.readlines(">").should == ["this>", "is>", "an>", "example"]
+  end
+
+  it "updates self's position based on the number of read bytes" do
+    @io.readlines(">")
+    @io.pos.should eql(18)
+  end
+
+  it "updates self's lineno based on the number of read lines" do
+    @io.readlines(">")
+    @io.lineno.should eql(4)
+  end
+
+  it "does not change $_" do
+    $_ = "test"
+    @io.readlines(">")
+    $_.should == "test"
+  end
+
+  ruby_bug "", "1.8.8" do
+    it "returns an Array containing all paragraphs when the passed separator is an empty String" do
+      io = StringIO.new("this is\n\nan example")
+      io.readlines("").should == ["this is\n\n", "an example"]
+    end
+  end
+
+  it "returns the remaining content as one line starting at the current position when passed nil" do
+    io = StringIO.new("this is\n\nan example")
+    io.pos = 5
+    io.readlines(nil).should == ["is\n\nan example"]
+  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(">")
+    @io.readlines(obj).should == ["this>", "is>", "an>", "example"]
+  end
+end
+
+ruby_version_is "1.9" do
+  describe "StringIO#readlines" do
+    before :each do
+      @io = StringIO.new("ab\ncd")
+      ScratchPad.record []
+    end
+
+    it "returns at most limit characters when limit is positive" do
+      @io.readlines.should == ["ab\n", "cd"]
+    end
+
+    it "calls #to_int to convert the limit" do
+      limit = mock("stringio each limit")
+      limit.should_receive(:to_int).at_least(1).times.and_return(5)
+
+      @io.readlines(limit)
+    end
+
+    it "calls #to_int to convert the limit when passed separator and limit" do
+      limit = mock("stringio each limit")
+      limit.should_receive(:to_int).at_least(1).times.and_return(6)
+
+      @io.readlines($/, limit)
+    end
+
+    it "raises an ArgumentError when limit is 0" do
+      lambda { @io.readlines(0) }.should raise_error(ArgumentError)
+    end
+  end
+end
+
+describe "StringIO#readlines when passed no argument" do
+  before(:each) do
+    @io = StringIO.new("this is\nan example\nfor StringIO#readlines")
+  end
+
+  it "returns an Array containing lines based on $/" do
+    begin
+      old_sep, $/ = $/, " "
+      @io.readlines.should == ["this ", "is\nan ", "example\nfor ", "StringIO#readlines"]
+    ensure
+      $/ = old_sep
+    end
+  end
+
+  it "updates self's position based on the number of read bytes" do
+    @io.readlines
+    @io.pos.should eql(41)
+  end
+
+  it "updates self's lineno based on the number of read lines" do
+    @io.readlines
+    @io.lineno.should eql(3)
+  end
+
+  it "does not change $_" do
+    $_ = "test"
+    @io.readlines(">")
+    $_.should == "test"
+  end
+
+  it "returns an empty Array when self is at the end" do
+    @io.pos = 41
+    @io.readlines.should == []
+  end
+end
+
+describe "StringIO#readlines when in write-only mode" do
+  it "raises an IOError" do
+    io = StringIO.new("xyz", "w")
+    lambda { io.readlines }.should raise_error(IOError)
+
+    io = StringIO.new("xyz")
+    io.close_read
+    lambda { io.readlines }.should raise_error(IOError)
+  end
+end

data/spec/readpartial_spec.rb

@@ -0,0 +1,29 @@
+require "stringio"
+require File.expand_path('../shared/read', __FILE__)
+require File.expand_path('../shared/sysread', __FILE__)
+
+ruby_version_is "1.9" do
+  describe "StringIO#readpartial when passed length, buffer" do
+    it_behaves_like :stringio_read, :readpartial
+  end
+
+  describe "StringIO#readpartial when passed length" do
+    it_behaves_like :stringio_read_length, :readpartial
+  end
+
+  describe "StringIO#readpartial when passed no arguments" do
+    it_behaves_like :stringio_read_no_arguments, :readpartial
+  end
+
+  describe "StringIO#readpartial when self is not readable" do
+    it_behaves_like :stringio_read_not_readable, :readpartial
+  end
+
+  describe "StringIO#readpartial when passed nil" do
+    it_behaves_like :stringio_read_nil, :readpartial
+  end
+
+  describe "StringIO#readpartial when passed length" do
+    it_behaves_like :stringio_sysread_length, :readpartial
+  end
+end

data/spec/reopen_spec.rb

@@ -0,0 +1,303 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe "StringIO#reopen when passed [Object, Integer]" do
+  before(:each) do
+    @io = StringIO.new("example")
+  end
+
+  it "reopens self with the passed Object in the passed mode" do
+    @io.reopen("reopened", IO::RDONLY)
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_true
+    @io.string.should == "reopened"
+
+    @io.reopen("reopened, twice", IO::WRONLY)
+    @io.closed_read?.should be_true
+    @io.closed_write?.should be_false
+    @io.string.should == "reopened, twice"
+
+    @io.reopen("reopened, another time", IO::RDWR)
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_false
+    @io.string.should == "reopened, another time"
+  end
+
+  # NOTE: WEIRD!
+  it "does not taint self when the passed Object was tainted" do
+    @io.reopen("reopened".taint, IO::RDONLY)
+    @io.tainted?.should be_false
+
+    @io.reopen("reopened".taint, IO::WRONLY)
+    @io.tainted?.should be_false
+  end
+
+  it "tries to convert the passed Object to a String using #to_str" do
+    obj = mock("to_str")
+    obj.should_receive(:to_str).and_return("to_str")
+    @io.reopen(obj, IO::RDWR)
+    @io.string.should == "to_str"
+  end
+
+  it "raises a TypeError when the passed Object can't be converted to a String" do
+    lambda { @io.reopen(Object.new, IO::RDWR) }.should raise_error(TypeError)
+  end
+
+  it "raises an Errno::EACCES when trying to reopen self with a frozen String in write-mode" do
+    lambda { @io.reopen("burn".freeze, IO::WRONLY) }.should raise_error(Errno::EACCES)
+    lambda { @io.reopen("burn".freeze, IO::WRONLY | IO::APPEND) }.should raise_error(Errno::EACCES)
+  end
+
+  ruby_version_is "" ... "1.9" do
+    it "raises a TypeError when trying to reopen self with a frozen String in truncate-mode" do
+      lambda { @io.reopen("burn".freeze, IO::RDONLY | IO::TRUNC) }.should raise_error(TypeError)
+    end
+  end
+
+  ruby_version_is "1.9" do
+    it "raises a RuntimeError when trying to reopen self with a frozen String in truncate-mode" do
+      lambda { @io.reopen("burn".freeze, IO::RDONLY | IO::TRUNC) }.should raise_error(RuntimeError)
+    end
+  end
+
+  it "does not raise IOError when passed a frozen String in read-mode" do
+    @io.reopen("burn".freeze, IO::RDONLY)
+    @io.string.should == "burn"
+  end
+end
+
+describe "StringIO#reopen when passed [Object, Object]" do
+  before(:each) do
+    @io = StringIO.new("example")
+  end
+
+  it "reopens self with the passed Object in the passed mode" do
+    @io.reopen("reopened", "r")
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_true
+    @io.string.should == "reopened"
+
+    @io.reopen("reopened, twice", "r+")
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_false
+    @io.string.should == "reopened, twice"
+
+    @io.reopen("reopened, another", "w+")
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_false
+    @io.string.should == ""
+
+    @io.reopen("reopened, another time", "r+")
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_false
+    @io.string.should == "reopened, another time"
+  end
+
+  it "truncates the passed String when opened in truncate mode" do
+    @io.reopen(str = "reopened", "w")
+    str.should == ""
+  end
+
+  # NOTE: WEIRD!
+  it "does not taint self when the passed Object was tainted" do
+    @io.reopen("reopened".taint, "r")
+    @io.tainted?.should be_false
+
+    @io.reopen("reopened".taint, "w")
+    @io.tainted?.should be_false
+  end
+
+  it "tries to convert the passed Object to a String using #to_str" do
+    obj = mock("to_str")
+    obj.should_receive(:to_str).and_return("to_str")
+    @io.reopen(obj, "r")
+    @io.string.should == "to_str"
+  end
+
+  it "raises a TypeError when the passed Object can't be converted to a String using #to_str" do
+    lambda { @io.reopen(Object.new, "r") }.should raise_error(TypeError)
+  end
+
+  ruby_bug "#", "1.8.7" do
+    it "resets self's position to 0" do
+      @io.read(5)
+      @io.reopen("reopened")
+      @io.pos.should eql(0)
+    end
+
+    it "resets self's line number to 0" do
+      @io.gets
+      @io.reopen("reopened")
+      @io.lineno.should eql(0)
+    end
+  end
+
+  it "tries to convert the passed mode Object to an Integer using #to_str" do
+    obj = mock("to_str")
+    obj.should_receive(:to_str).and_return("r")
+    @io.reopen("reopened", obj)
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_true
+    @io.string.should == "reopened"
+  end
+
+  it "raises an Errno::EACCES error when trying to reopen self with a frozen String in write-mode" do
+    lambda { @io.reopen("burn".freeze, 'w') }.should raise_error(Errno::EACCES)
+    lambda { @io.reopen("burn".freeze, 'w+') }.should raise_error(Errno::EACCES)
+    lambda { @io.reopen("burn".freeze, 'a') }.should raise_error(Errno::EACCES)
+    lambda { @io.reopen("burn".freeze, "r+") }.should raise_error(Errno::EACCES)
+  end
+
+  it "does not raise IOError if a frozen string is passed in read mode" do
+    @io.reopen("burn".freeze, "r")
+    @io.string.should == "burn"
+  end
+end
+
+describe "StringIO#reopen when passed [String]" do
+  before(:each) do
+    @io = StringIO.new("example")
+  end
+
+  it "reopens self with the passed String in read-write mode" do
+    @io.close
+
+    @io.reopen("reopened")
+
+    @io.closed_write?.should be_false
+    @io.closed_read?.should be_false
+
+    @io.string.should == "reopened"
+  end
+
+  # NOTE: WEIRD!
+  it "does not taint self when the passed Object was tainted" do
+    @io.reopen("reopened".taint)
+    @io.tainted?.should be_false
+  end
+
+  ruby_bug "#", "1.8.7" do
+    it "resets self's position to 0" do
+      @io.read(5)
+      @io.reopen("reopened")
+      @io.pos.should eql(0)
+    end
+
+    it "resets self's line number to 0" do
+      @io.gets
+      @io.reopen("reopened")
+      @io.lineno.should eql(0)
+    end
+  end
+end
+
+describe "StringIO#reopen when passed [Object]" do
+  before(:each) do
+    @io = StringIO.new("example")
+  end
+
+  it "raises a TypeError when passed an Object that can't be converted to a StringIO" do
+    lambda { @io.reopen(Object.new) }.should raise_error(TypeError)
+  end
+
+  it "does not try to convert the passed Object to a String using #to_str" do
+    obj = mock("not to_str")
+    obj.should_not_receive(:to_str)
+    lambda { @io.reopen(obj) }.should raise_error(TypeError)
+  end
+
+  it "tries to convert the passed Object to a StringIO using #to_strio" do
+    obj = mock("to_strio")
+    obj.should_receive(:to_strio).and_return(StringIO.new("to_strio"))
+    @io.reopen(obj)
+    @io.string.should == "to_strio"
+  end
+
+  # NOTE: WEIRD!
+  it "taints self when the passed Object was tainted" do
+    @io.reopen(StringIO.new("reopened").taint)
+    @io.tainted?.should be_true
+  end
+end
+
+describe "StringIO#reopen when passed no arguments" do
+  before(:each) do
+    @io = StringIO.new("example\nsecond line")
+  end
+
+  it "resets self's mode to read-write" do
+    @io.close
+    @io.reopen
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_false
+  end
+
+  ruby_bug "#", "1.8.7" do
+    it "resets self's position to 0" do
+      @io.read(5)
+      @io.reopen
+      @io.pos.should eql(0)
+    end
+
+    it "resets self's line number to 0" do
+      @io.gets
+      @io.reopen
+      @io.lineno.should eql(0)
+    end
+  end
+end
+
+# NOTE: Some reopen specs disabled due to MRI bugs. See:
+# http://rubyforge.org/tracker/index.php?func=detail&aid=13919&group_id=426&atid=1698
+# for details.
+describe "StringIO#reopen" do
+  before(:each) do
+    @io = StringIO.new('hello','a')
+  end
+
+  # TODO: find out if this is really a bug
+  ruby_bug "#", "1.8.6.114" do
+    it "reopens a stream when given a String argument" do
+      @io.reopen('goodbye').should == @io
+      @io.string.should == 'goodbye'
+      @io << 'x'
+      @io.string.should == 'xoodbye'
+    end
+
+    it "reopens a stream in append mode when flagged as such" do
+      @io.reopen('goodbye', 'a').should == @io
+      @io.string.should == 'goodbye'
+      @io << 'x'
+      @io.string.should == 'goodbyex'
+    end
+
+    it "reopens and truncate when reopened in write mode" do
+      @io.reopen('goodbye', 'wb').should == @io
+      @io.string.should == ''
+      @io << 'x'
+      @io.string.should == 'x'
+    end
+
+    it "truncates the given string, not a copy" do
+      str = 'goodbye'
+      @io.reopen(str, 'w')
+      @io.string.should == ''
+      str.should == ''
+    end
+  end
+
+  it "taints self if the provided StringIO argument is tainted" do
+    new_io = StringIO.new("tainted")
+    new_io.taint
+    @io.reopen(new_io)
+    @io.tainted?.should == true
+  end
+
+  it "does not truncate the content even when the StringIO argument is in the truncate mode" do
+    orig_io = StringIO.new("Original StringIO", IO::RDWR|IO::TRUNC)
+    orig_io.write("BLAH") # make sure the content is not empty
+
+    @io.reopen(orig_io)
+    @io.string.should == "BLAH"
+  end
+
+end