rubysl-stringio 1.0.0

data/spec/fsync_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe "StringIO#fsync" do
+  it "returns zero" do
+    io = StringIO.new("fsync")
+    io.fsync.should eql(0)
+  end
+end

data/spec/getbyte_spec.rb

@@ -0,0 +1,25 @@
+require 'stringio'
+require File.expand_path('../shared/getc', __FILE__)
+
+describe "StringIO#getbyte" do
+  it_behaves_like :stringio_getc, :getbyte
+
+  it "returns the 8-bit byte at the current position" do
+    io = StringIO.new("example")
+
+    io.send(@method).should == 101
+    io.send(@method).should == 120
+    io.send(@method).should ==  97
+  end
+
+  it "retrieves bytes at a time rather than characters" do
+    io = StringIO.new("\xc3\x91")
+      
+    io.getbyte.should == 0xc3
+    io.getbyte.should == 0x91
+  end
+end
+
+describe "StringIO#getbyte when self is not readable" do
+  it_behaves_like :stringio_getc_not_readable, :getbyte
+end

data/spec/getc_spec.rb

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../../../spec_helper', __FILE__)
+require 'stringio'
+require File.expand_path('../shared/getc', __FILE__)
+
+describe "StringIO#getc" do
+  it_behaves_like :stringio_getc, :getc
+
+  it "returns the charactor at the current position" do
+    io = StringIO.new("example")
+
+    io.send(@method).should == ?e
+    io.send(@method).should == ?x
+    io.send(@method).should == ?a
+  end
+
+  with_feature :encoding do
+    it "increments #pos by the byte size of the character in multibyte strings" do
+      io = StringIO.new("föóbar")
+
+      io.send(@method); io.pos.should == 1 # "f" has byte size 1
+      io.send(@method); io.pos.should == 3 # "ö" has byte size 2
+      io.send(@method); io.pos.should == 5 # "ó" has byte size 2
+      io.send(@method); io.pos.should == 6 # "b" has byte size 1
+    end
+  end
+end
+
+describe "StringIO#getc when self is not readable" do
+  it_behaves_like :stringio_getc_not_readable, :getc
+end

data/spec/gets_spec.rb

@@ -0,0 +1,245 @@
+require "stringio"
+
+describe "StringIO#gets 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.gets(">").should == "this>"
+    @io.gets(">").should == "is>"
+    @io.gets(">").should == "an>"
+    @io.gets(">").should == "example"
+  end
+
+  it "sets $_ to the read content" do
+    @io.gets(">")
+    $_.should == "this>"
+    @io.gets(">")
+    $_.should == "is>"
+    @io.gets(">")
+    $_.should == "an>"
+    @io.gets(">")
+    $_.should == "example"
+    @io.gets(">")
+    $_.should be_nil
+  end
+
+  it "accepts string as separator" do
+    @io.gets("is>")
+    $_.should == "this>"
+    @io.gets("an>")
+    $_.should == "is>an>"
+    @io.gets("example")
+    $_.should == "example"
+    @io.gets("ple")
+    $_.should be_nil
+  end
+
+  it "updates self's lineno by one" do
+    @io.gets(">")
+    @io.lineno.should eql(1)
+
+    @io.gets(">")
+    @io.lineno.should eql(2)
+
+    @io.gets(">")
+    @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.gets("").should == "this is\n\n"
+      io.gets("").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.gets(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.gets(obj).should == "this>"
+  end
+end
+
+describe "StringIO#gets when passed no argument" do
+  before(:each) do
+    @io = StringIO.new("this is\nan example\nfor StringIO#gets")
+  end
+
+  it "returns the data read till the next occurence of $/ or till eof" do
+    @io.gets.should == "this is\n"
+
+    begin
+      old_sep, $/ = $/, " "
+      @io.gets.should == "an "
+      @io.gets.should == "example\nfor "
+      @io.gets.should == "StringIO#gets"
+    ensure
+      $/ = old_sep
+    end
+  end
+
+  it "sets $_ to the read content" do
+    @io.gets
+    $_.should == "this is\n"
+    @io.gets
+    $_.should == "an example\n"
+    @io.gets
+    $_.should == "for StringIO#gets"
+    @io.gets
+    $_.should be_nil
+  end
+
+  it "updates self's position" do
+    @io.gets
+    @io.pos.should eql(8)
+
+    @io.gets
+    @io.pos.should eql(19)
+
+    @io.gets
+    @io.pos.should eql(36)
+  end
+
+  it "updates self's lineno" do
+    @io.gets
+    @io.lineno.should eql(1)
+
+    @io.gets
+    @io.lineno.should eql(2)
+
+    @io.gets
+    @io.lineno.should eql(3)
+  end
+
+  it "returns nil if self is at the end" do
+    @io.pos = 36
+    @io.gets.should be_nil
+    @io.gets.should be_nil
+  end
+end
+
+ruby_version_is "1.9" do
+  describe "StringIO#gets when passed [limit]" do
+    before(:each) do
+      @io = StringIO.new("this>is>an>example")
+    end
+
+    it "returns the data read until the limit is met" do
+      @io.gets(4).should == "this"
+      @io.gets(3).should == ">is"
+      @io.gets(5).should == ">an>e"
+      @io.gets(6).should == "xample"
+    end
+
+    it "sets $_ to the read content" do
+      @io.gets(4)
+      $_.should == "this"
+      @io.gets(3)
+      $_.should == ">is"
+      @io.gets(5)
+      $_.should == ">an>e"
+      @io.gets(6)
+      $_.should == "xample"
+      @io.gets(3)
+      $_.should be_nil
+    end
+
+    it "updates self's lineno by one" do
+      @io.gets(3)
+      @io.lineno.should eql(1)
+
+      @io.gets(3)
+      @io.lineno.should eql(2)
+
+      @io.gets(3)
+      @io.lineno.should eql(3)
+    end
+
+    it "tries to convert the passed limit to an Integer using #to_int" do
+      obj = mock('to_int')
+      obj.should_receive(:to_int).and_return(4)
+      @io.gets(obj).should == "this"
+    end
+
+    it "returns a blank string when passed a limit of 0" do
+      @io.gets(0).should == ""
+    end
+  end
+
+  describe "StringIO#gets when passed [separator] and [limit]" do
+    before(:each) do
+      @io = StringIO.new("this>is>an>example")
+    end
+
+    it "returns the data read until the limit is consumed or the separator is met" do
+      @io.gets('>', 8).should == "this>"
+      @io.gets('>', 2).should == "is"
+      @io.gets('>', 10).should == ">"
+      @io.gets('>', 6).should == "an>"
+      @io.gets('>', 5).should == "examp"
+    end
+
+    it "sets $_ to the read content" do
+      @io.gets('>', 8)
+      $_.should == "this>"
+      @io.gets('>', 2)
+      $_.should == "is"
+      @io.gets('>', 10)
+      $_.should == ">"
+      @io.gets('>', 6)
+      $_.should == "an>"
+      @io.gets('>', 5)
+      $_.should == "examp"
+    end
+
+    it "updates self's lineno by one" do
+      @io.gets('>', 3)
+      @io.lineno.should eql(1)
+
+      @io.gets('>', 3)
+      @io.lineno.should eql(2)
+
+      @io.gets('>', 3)
+      @io.lineno.should eql(3)
+    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.gets(obj, 5).should == "this>"
+    end
+
+    it "does not raise TypeError if passed separator is nil" do
+      @io.gets(nil, 5).should == "this>"
+    end
+
+    it "tries to convert the passed limit to an Integer using #to_int" do
+      obj = mock('to_int')
+      obj.should_receive(:to_int).and_return(5)
+      @io.gets('>', obj).should == "this>"
+    end
+
+    it "raises a TypeError if both separator and limit are nil" do
+      lambda { @io.gets nil, nil }.should raise_error(TypeError)
+    end
+  end
+end
+
+describe "StringIO#gets when in write-only mode" do
+  it "raises an IOError" do
+    io = StringIO.new("xyz", "w")
+    lambda { io.gets }.should raise_error(IOError)
+
+    io = StringIO.new("xyz")
+    io.close_read
+    lambda { io.gets }.should raise_error(IOError)
+  end
+end

data/spec/initialize_copy_spec.rb

@@ -0,0 +1,95 @@
+require 'stringio'
+
+describe "StringIO#initialize_copy" do
+  before(:each) do
+    @io      = StringIO.new("StringIO example")
+    @orig_io = StringIO.new("Original StringIO")
+  end
+
+  it "is private" do
+    StringIO.should have_private_instance_method(:initialize_copy)
+  end
+
+  it "returns self" do
+    @io.send(:initialize_copy, @orig_io).should equal(@io)
+  end
+
+  it "tries to convert the passed argument to a StringIO using #to_strio" do
+    obj = mock('to_strio')
+    obj.should_receive(:to_strio).and_return(StringIO.new("converted"))
+    @io.send(:initialize_copy, obj)
+    @io.string.should == "converted"
+  end
+
+  it "copies the passed StringIO's content to self" do
+    @io.send(:initialize_copy, @orig_io)
+    @io.string.should == "Original StringIO"
+  end
+
+  it "copies the passed StringIO's position to self" do
+    @orig_io.pos = 5
+    @io.send(:initialize_copy, @orig_io)
+    @io.pos.should eql(5)
+  end
+
+  it "taints self when the passed StringIO is tainted" do
+    @orig_io.taint
+    @io.send(:initialize_copy, @orig_io)
+    @io.tainted?.should be_true
+  end
+
+  it "copies the passed StringIO's mode to self" do
+    orig_io = StringIO.new("read-only", "r")
+    @io.send(:initialize_copy, orig_io)
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_true
+
+    orig_io = StringIO.new("write-only", "w")
+    @io.send(:initialize_copy, orig_io)
+    @io.closed_read?.should be_true
+    @io.closed_write?.should be_false
+
+    orig_io = StringIO.new("read-write", "r+")
+    @io.send(:initialize_copy, orig_io)
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_false
+
+    orig_io = StringIO.new("read-write", "w+")
+    @io.send(:initialize_copy, orig_io)
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_false
+  end
+
+  it "copies the passed StringIO's append mode" do
+    orig_io = StringIO.new("read-write", "a")
+    @io.send(:initialize_copy, orig_io)
+
+    @io.pos = 0
+    @io << " test"
+
+    @io.string.should == "read-write test"
+  end
+
+  it "does not truncate self's content when the copied StringIO was in truncate mode" do
+    orig_io = StringIO.new("original StringIO", "w+")
+    orig_io.write("not truncated") # make sure the content is not empty
+
+    @io.send(:initialize_copy, orig_io)
+    @io.string.should == "not truncated"
+  end
+
+  it "makes both StringIO objects to share position, eof status" do
+    @io.send(:initialize_copy, @orig_io)
+    @orig_io.pos.should == 0
+    @io.getc
+    @io.pos.should == 1
+    @orig_io.pos.should == 1
+    @orig_io.read(1).should == "r"
+    @io.read(1).should == "i"
+    @orig_io.pos.should == 3
+    @orig_io.pos.should == 3
+    @io.gets(nil)
+    @io.eof?.should == true
+    @orig_io.eof?.should == true
+  end
+end

data/spec/initialize_spec.rb

@@ -0,0 +1,193 @@
+require 'stringio'
+
+describe "StringIO#initialize when passed [Object, mode]" do
+  before(:each) do
+    @io = StringIO.allocate
+  end
+
+  it "uses the passed Object as the StringIO backend" do
+    @io.send(:initialize, str = "example", "r")
+    @io.string.should equal(str)
+  end
+
+  it "sets the mode based on the passed mode" do
+    io = StringIO.allocate
+    io.send(:initialize, "example", "r")
+    io.closed_read?.should be_false
+    io.closed_write?.should be_true
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", "rb")
+    io.closed_read?.should be_false
+    io.closed_write?.should be_true
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", "r+")
+    io.closed_read?.should be_false
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", "rb+")
+    io.closed_read?.should be_false
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", "w")
+    io.closed_read?.should be_true
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", "wb")
+    io.closed_read?.should be_true
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", "w+")
+    io.closed_read?.should be_false
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", "wb+")
+    io.closed_read?.should be_false
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", "a")
+    io.closed_read?.should be_true
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", "ab")
+    io.closed_read?.should be_true
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", "a+")
+    io.closed_read?.should be_false
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", "ab+")
+    io.closed_read?.should be_false
+    io.closed_write?.should be_false
+  end
+
+  it "allows passing the mode as an Integer" do
+    io = StringIO.allocate
+    io.send(:initialize, "example", IO::RDONLY)
+    io.closed_read?.should be_false
+    io.closed_write?.should be_true
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", IO::RDWR)
+    io.closed_read?.should be_false
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", IO::WRONLY)
+    io.closed_read?.should be_true
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", IO::WRONLY | IO::TRUNC)
+    io.closed_read?.should be_true
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", IO::RDWR | IO::TRUNC)
+    io.closed_read?.should be_false
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", IO::WRONLY | IO::APPEND)
+    io.closed_read?.should be_true
+    io.closed_write?.should be_false
+
+    io = StringIO.allocate
+    io.send(:initialize, "example", IO::RDWR | IO::APPEND)
+    io.closed_read?.should be_false
+    io.closed_write?.should be_false
+  end
+
+  ruby_version_is "" ... "1.9" do
+    it "raises a TypeError when passed a frozen String in truncate mode as StringIO backend" do
+      io = StringIO.allocate
+      lambda { io.send(:initialize, "example".freeze, IO::TRUNC) }.should raise_error(TypeError)
+    end
+  end
+
+  ruby_version_is "1.9" do
+    it "raises a RuntimeError when passed a frozen String in truncate mode as StringIO backend" do
+      io = StringIO.allocate
+      lambda { io.send(:initialize, "example".freeze, IO::TRUNC) }.should raise_error(RuntimeError)
+    end
+  end
+
+  it "tries to convert the passed mode to a String using #to_str" do
+    obj = mock('to_str')
+    obj.should_receive(:to_str).and_return("r")
+    @io.send(:initialize, "example", obj)
+
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_true
+  end
+
+  it "raises an Errno::EACCES error when passed a frozen string with a write-mode" do
+    (str = "example").freeze
+    lambda { @io.send(:initialize, str, "r+") }.should raise_error(Errno::EACCES)
+    lambda { @io.send(:initialize, str, "w") }.should raise_error(Errno::EACCES)
+    lambda { @io.send(:initialize, str, "a") }.should raise_error(Errno::EACCES)
+  end
+end
+
+describe "StringIO#initialize when passed [Object]" do
+  before(:each) do
+    @io = StringIO.allocate
+  end
+
+  it "uses the passed Object as the StringIO backend" do
+    @io.send(:initialize, str = "example")
+    @io.string.should equal(str)
+  end
+
+  it "sets the mode to read-write" do
+    @io.send(:initialize, "example")
+    @io.closed_read?.should be_false
+    @io.closed_write?.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("example")
+    @io.send(:initialize, obj)
+    @io.string.should == "example"
+  end
+
+  it "automatically sets the mode to read-only when passed a frozen string" do
+    (str = "example").freeze
+    @io.send(:initialize, str)
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_true
+  end
+end
+
+describe "StringIO#initialize when passed no arguments" do
+  before(:each) do
+    @io = StringIO.allocate
+  end
+
+  it "is private" do
+    StringIO.should have_private_instance_method(:initialize)
+  end
+
+  it "sets the mode to read-write" do
+    @io.send(:initialize, "example")
+    @io.closed_read?.should be_false
+    @io.closed_write?.should be_false
+  end
+
+  it "uses an empty String as the StringIO backend" do
+    @io.send(:initialize)
+    @io.string.should == ""
+  end
+end