rubysl-stringio 1.0.0

data/spec/shared/eof.rb

@@ -0,0 +1,24 @@
+describe :stringio_eof, :shared => true do
+  before(:each) do
+    @io = StringIO.new("eof")
+  end
+
+  it "returns true when self's position is greater than or equal to self's size" do
+    @io.pos = 3
+    @io.send(@method).should be_true
+
+    @io.pos = 6
+    @io.send(@method).should be_true
+  end
+
+  it "returns false when self's position is less than self's size" do
+    @io.pos = 0
+    @io.send(@method).should be_false
+
+    @io.pos = 1
+    @io.send(@method).should be_false
+
+    @io.pos = 2
+    @io.send(@method).should be_false
+  end
+end

data/spec/shared/getc.rb

@@ -0,0 +1,43 @@
+describe :stringio_getc, :shared => true do
+  before(:each) do
+    @io = StringIO.new("example")
+  end
+
+  it "increases self's position by one" do
+    @io.send(@method)
+    @io.pos.should eql(1)
+
+    @io.send(@method)
+    @io.pos.should eql(2)
+
+    @io.send(@method)
+    @io.pos.should eql(3)
+  end
+
+  it "returns nil when called at the end of self" do
+    @io.pos = 7
+    @io.send(@method).should be_nil
+    @io.send(@method).should be_nil
+    @io.send(@method).should be_nil
+  end
+
+  it "does not increase self's position when called at the end of file" do
+    @io.pos = 7
+    @io.send(@method)
+    @io.pos.should eql(7)
+
+    @io.send(@method)
+    @io.pos.should eql(7)
+  end
+end
+
+describe :stringio_getc_not_readable, :shared => true do
+  it "raises an IOError" do
+    io = StringIO.new("xyz", "w")
+    lambda { io.send(@method) }.should raise_error(IOError)
+
+    io = StringIO.new("xyz")
+    io.close_read
+    lambda { io.send(@method) }.should raise_error(IOError)
+  end
+end

data/spec/shared/isatty.rb

@@ -0,0 +1,5 @@
+describe :stringio_isatty, :shared => true do
+  it "returns false" do
+    StringIO.new('tty').send(@method).should be_false
+  end
+end

data/spec/shared/length.rb

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+describe :stringio_length, :shared => true do
+  it "returns the length of the wrapped string" do
+    StringIO.new("example").send(@method).should == 7
+  end
+
+  with_feature :encoding do
+    it "returns the number of bytes" do
+      StringIO.new("ありがとう").send(@method).should == 15
+    end
+  end
+end

data/spec/shared/read.rb

@@ -0,0 +1,186 @@
+describe :stringio_read, :shared => true do
+  before(:each) do
+    @io = StringIO.new("example")
+  end
+
+  it "returns the passed buffer String" do
+    ret = @io.send(@method, 7, buffer = "")
+    ret.should equal(buffer)
+  end
+
+  it "returns the remaining data when limit is nil" do
+    @io.send(@method, nil, buffer = "").should == "example"
+    buffer.should == "example"
+  end
+
+  ruby_version_is "1.9" do
+    it "truncates buffer when limit is nil and no data reamins" do
+      @io.send(@method)
+      @io.send(@method, nil, buffer = "abc").should == ""
+      buffer.should == ""
+    end
+  end
+
+  it "reads length bytes and writes them to the buffer String" do
+    @io.send(@method, 7, buffer = "")
+    buffer.should == "example"
+  end
+
+  it "calls #to_str to convert the object to a String" do
+    obj = mock("to_str")
+    obj.should_receive(:to_str).and_return(buffer = "")
+
+    @io.send(@method, 7, obj)
+    buffer.should == "example"
+  end
+
+  it "raises a TypeError if the object does not respond to #to_str" do
+    lambda { @io.send(@method, 7, Object.new) }.should raise_error(TypeError)
+  end
+
+  ruby_version_is ""..."1.9" do
+    it "raises a TypeError when passed a frozen String as buffer" do
+      lambda { @io.send(@method, 7, "".freeze) }.should raise_error(TypeError)
+    end
+  end
+
+  ruby_version_is "1.9" do
+    it "raises a RuntimeError when passed a frozen String as buffer" do
+      lambda { @io.send(@method, 7, "".freeze) }.should raise_error(RuntimeError)
+    end
+  end
+
+  with_feature :encoding do
+    it "returns a String in ASCII-8BIT ignoring the encoding of the source String and buffer" do
+      io = StringIO.new("abc".force_encoding(Encoding::EUC_JP))
+      buffer = "".force_encoding(Encoding::ISO_8859_1)
+      io.send(@method, 3, buffer).encoding.should == Encoding::ASCII_8BIT
+    end
+  end
+end
+
+describe :stringio_read_length, :shared => true do
+  before(:each) do
+    @io = StringIO.new("example")
+  end
+
+  it "reads length bytes from the current position and returns them" do
+    @io.pos = 3
+    @io.send(@method, 4).should == "mple"
+  end
+
+  it "reads at most the whole content" do
+    @io.send(@method, 999).should == "example"
+  end
+  it "updates the position" do
+    @io.send(@method, 3)
+    @io.pos.should eql(3)
+
+    @io.send(@method, 999)
+    @io.pos.should eql(7)
+  end
+
+  it "calls #to_int to convert the length" do
+    obj = mock("to_int")
+    obj.should_receive(:to_int).and_return(7)
+    @io.send(@method, obj).should == "example"
+  end
+
+  it "raises a TypeError when the length does not respond to #to_int" do
+    lambda { @io.send(@method, Object.new) }.should raise_error(TypeError)
+  end
+
+  it "raises a TypeError when length is negative" do
+    lambda { @io.send(@method, -2) }.should raise_error(ArgumentError)
+  end
+
+  with_feature :encoding do
+    it "returns a String in ASCII-8BIT encoding when passed a length > 0" do
+      @io.send(@method, 4).encoding.should == Encoding::ASCII_8BIT
+    end
+
+    it "returns an empty String in ASCII-8BIT encoding when passed length == 0" do
+      @io.send(@method, 0).encoding.should == Encoding::ASCII_8BIT
+    end
+  end
+end
+
+describe :stringio_read_no_arguments, :shared => true do
+  before(:each) do
+    @io = StringIO.new("example")
+  end
+
+  it "reads the whole content starting from the current position" do
+    @io.send(@method).should == "example"
+
+    @io.pos = 3
+    @io.send(@method).should == "mple"
+  end
+
+  it "updates the current position" do
+    @io.send(@method)
+    @io.pos.should eql(7)
+  end
+
+  ruby_bug "readmine#156", "1.8.7" do
+    it "returns an empty String when no data remains" do
+      @io.send(@method).should == "example"
+      @io.send(@method).should == ""
+    end
+  end
+
+  with_feature :encoding do
+    it "returns a String in the same encoding as the source String" do
+      io = StringIO.new("abc".force_encoding(Encoding::EUC_JP))
+      io.send(@method).encoding.should == Encoding::EUC_JP
+    end
+
+    it "returns an empty String in ASCII-8BIT encoding" do
+      @io.send(@method).should == "example"
+      @io.send(@method).encoding.should == Encoding::ASCII_8BIT
+    end
+  end
+end
+
+describe :stringio_read_nil, :shared => true do
+  before :each do
+    @io = StringIO.new("example")
+  end
+
+  it "returns the remaining content from the current position" do
+    @io.send(@method, nil).should == "example"
+
+    @io.pos = 4
+    @io.send(@method, nil).should == "ple"
+  end
+
+  it "updates the current position" do
+    @io.send(@method, nil)
+    @io.pos.should eql(7)
+  end
+
+  ruby_bug "redmine#156", "1.8.7" do
+    it "returns an empty String when no data remains" do
+      @io.send(@method, nil).should == "example"
+      @io.send(@method, nil).should == ""
+    end
+  end
+
+  with_feature :encoding do
+    it "returns an empty String in ASCII-8BIT encoding" do
+      @io.send(@method).should == "example"
+      @io.send(@method).encoding.should == Encoding::ASCII_8BIT
+    end
+  end
+end
+
+describe :stringio_read_not_readable, :shared => true do
+  it "raises an IOError" do
+    io = StringIO.new("test", "w")
+    lambda { io.send(@method) }.should raise_error(IOError)
+
+    io = StringIO.new("test")
+    io.close_read
+    lambda { io.send(@method) }.should raise_error(IOError)
+  end
+end

data/spec/shared/readchar.rb

@@ -0,0 +1,29 @@
+describe :stringio_readchar, :shared => true do
+  before(:each) do
+    @io = StringIO.new("example")
+  end
+
+  it "correctly updates the current position" do
+    @io.send(@method)
+    @io.pos.should == 1
+
+    @io.send(@method)
+    @io.pos.should == 2
+  end
+
+  it "raises an EOFError when self is at the end" do
+    @io.pos = 7
+    lambda { @io.send(@method) }.should raise_error(EOFError)
+  end
+end
+
+describe :stringio_readchar_not_readable, :shared => true do
+  it "raises an IOError" do
+    io = StringIO.new("a b c d e", "w")
+    lambda { io.send(@method) }.should raise_error(IOError)
+
+    io = StringIO.new("a b c d e")
+    io.close_read
+    lambda { io.send(@method) }.should raise_error(IOError)
+  end
+end

data/spec/shared/sysread.rb

@@ -0,0 +1,27 @@
+describe :stringio_sysread_length, :shared => true do
+  before(:each) do
+    @io = StringIO.new("example")
+  end
+
+  # This was filed as a bug in redmine#156 but since MRI refused to change the
+  # 1.8 behavior, it's now considered a version difference by RubySpec since
+  # it could have a significant impact on user code.
+  ruby_version_is ""..."1.9" do
+    it "raises an EOFError when passed 0 and no data remains" do
+      @io.send(@method, 8).should == "example"
+      lambda { @io.send(@method, 0) }.should raise_error(EOFError)
+    end
+  end
+
+  ruby_version_is "1.9" do
+    it "returns an empty String when passed 0 and no data remains" do
+      @io.send(@method, 8).should == "example"
+      @io.send(@method, 0).should == ""
+    end
+  end
+
+  it "raises an EOFError when passed length > 0 and no data remains" do
+    @io.read.should == "example"
+    lambda { @io.sysread(1) }.should raise_error(EOFError)
+  end
+end

data/spec/shared/tell.rb

@@ -0,0 +1,12 @@
+describe :stringio_tell, :shared => true do
+  before(:each) do
+    @io = StringIOSpecs.build
+  end
+
+  it "returns the current byte offset" do
+    @io.getc
+    @io.send(@method).should == 1
+    @io.read(7)
+    @io.send(@method).should == 8
+  end
+end

data/spec/shared/write.rb

@@ -0,0 +1,134 @@
+# -*- encoding: utf-8 -*-
+
+describe :stringio_write, :shared => true do
+  before(:each) do
+    @io = StringIO.new('12345')
+  end
+
+  it "tries to convert the passed Object to a String using #to_s" do
+    obj = mock("to_s")
+    obj.should_receive(:to_s).and_return("to_s")
+    @io.send(@method, obj)
+    @io.string.should == "to_s5"
+  end
+
+  it "raises an IOError if the data String is frozen after creating the StringIO instance" do
+    s = "abcdef"
+    io = StringIO.new s, "w"
+    s.freeze
+    lambda { io.write "xyz" }.should raise_error(IOError)
+  end
+end
+
+describe :stringio_write_string, :shared => true do
+  before(:each) do
+    @io = StringIO.new('12345')
+  end
+
+  # TODO: RDoc says that #write appends at the current position.
+  it "writes the passed String at the current buffer position" do
+    @io.pos = 2
+    @io.send(@method, 'x').should == 1
+    @io.string.should == '12x45'
+    @io.send(@method, 7).should == 1
+    @io.string.should == '12x75'
+  end
+
+  it "pads self with \\000 when the current position is after the end" do
+    @io.pos = 8
+    @io.send(@method, 'x')
+    @io.string.should == "12345\000\000\000x"
+    @io.send(@method, 9)
+    @io.string.should == "12345\000\000\000x9"
+  end
+
+  it "returns the number of bytes written" do
+    @io.send(@method, '').should == 0
+    @io.send(@method, nil).should == 0
+    str = "1" * 100
+    @io.send(@method, str).should == 100
+  end
+
+  it "updates self's position" do
+    @io.send(@method, 'test')
+    @io.pos.should eql(4)
+  end
+
+  it "taints self's String when the passed argument is tainted" do
+    @io.send(@method, "test".taint)
+    @io.string.tainted?.should be_true
+  end
+
+  it "does not taint self when the passed argument is tainted" do
+    @io.send(@method, "test".taint)
+    @io.tainted?.should be_false
+  end
+
+
+  with_feature :encoding do
+
+    before :each do
+      @enc_io = StringIO.new("Hëllø")
+    end
+
+    it "writes binary data into the io" do
+      data = "Hëll\xFF"
+      data.force_encoding("ASCII-8BIT")
+      @enc_io.send(@method, data)
+      @enc_io.string.should == "Hëll\xFF\xB8"
+    end
+
+    it "retains the original encoding" do
+      data = "Hëll\xFF"
+      data.force_encoding("ASCII-8BIT")
+      @enc_io.send(@method, data)
+      @enc_io.string.encoding.should == Encoding::UTF_8
+    end
+
+    it "returns the number of bytes written" do
+      data = "Hëll\xFF"
+      data.force_encoding("ASCII-8BIT")
+      @enc_io.send(@method, data).should == 6
+    end
+
+    it "pads multibyte characters properly" do
+      @enc_io.pos = 8
+      @enc_io.send(@method, 'x')
+      @enc_io.string.should == "Hëllø\000x"
+      @enc_io.send(@method, 9)
+      @enc_io.string.should == "Hëllø\000x9"
+    end
+
+  end
+
+end
+
+describe :stringio_write_not_writable, :shared => true do
+  it "raises an IOError" do
+    io = StringIO.new("test", "r")
+    lambda { io.send(@method, "test") }.should raise_error(IOError)
+
+    io = StringIO.new("test")
+    io.close_write
+    lambda { io.send(@method, "test") }.should raise_error(IOError)
+  end
+end
+
+describe :stringio_write_append, :shared => true do
+  before(:each) do
+    @io = StringIO.new("example", "a")
+  end
+
+  it "appends the passed argument to the end of self" do
+    @io.send(@method, ", just testing")
+    @io.string.should == "example, just testing"
+
+    @io.send(@method, " and more testing")
+    @io.string.should == "example, just testing and more testing"
+  end
+
+  it "correctly updates self's position" do
+    @io.send(@method, ", testing")
+    @io.pos.should eql(16)
+  end
+end