io-like 0.3.0 → 0.3.1

data/spec/tell_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+require File.dirname(__FILE__) + '/shared/pos'
+
+describe "IO::Like#tell" do
+  it_behaves_like(:io_like__pos, :tell)
+end

data/spec/to_io_spec.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#to_io" do
+  it "returns self for open stream" do
+    IOSpecs.readable_iowrapper do |iowrapper|
+      iowrapper.to_io.should == iowrapper
+    end
+
+    IOSpecs.writable_iowrapper do |iowrapper|
+      iowrapper.to_io.should == iowrapper
+    end
+  end
+
+  it "returns self for closed stream" do
+    io = IOSpecs.closed_file
+    io.to_io.should == io
+  end
+end

data/spec/tty_spec.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/shared/tty'
+
+describe "IO::Like#tty?" do
+  it_behaves_like :io_like__tty, :tty?
+end

data/spec/ungetc_spec.rb

@@ -0,0 +1,118 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+
+describe "IO::Like#ungetc" do
+  before :each do
+    @file_name = File.dirname(__FILE__) + '/fixtures/readlines.txt'
+    @file = File.open(@file_name, 'r')
+    @iowrapper = ReadableIOWrapper.open(@file)
+  end
+
+  after :each do
+    @iowrapper.close unless @iowrapper.closed?
+    @file.close unless @file.closed?
+  end
+
+  it "pushes back one character onto stream" do
+    @iowrapper.getc.should == 86
+    @iowrapper.ungetc(86)
+    @iowrapper.getc.should == 86
+
+    @iowrapper.ungetc(10)
+    @iowrapper.getc.should == 10
+
+    @iowrapper.getc.should == 111
+    @iowrapper.getc.should == 105
+    # read the rest of line
+    @iowrapper.readline.should == "ci la ligne une.\n"
+    @iowrapper.getc.should == 81
+    @iowrapper.ungetc(99)
+    @iowrapper.getc.should == 99
+  end
+
+  it "pushes back one character when invoked at the end of the stream" do
+    # read entire content
+    @iowrapper.read
+    @iowrapper.ungetc(100)
+    @iowrapper.getc.should == 100
+  end
+
+  it "pushes back one character when invoked at the start of the stream" do
+    @iowrapper.read(0)
+    @iowrapper.ungetc(100)
+    @iowrapper.getc.should == 100
+  end
+
+  it "pushes back one character when invoked on empty stream" do
+    path = tmp('empty.txt')
+    File.open(path, "w+") do |empty|
+      IOWrapper.open(empty) do |iowrapper|
+        iowrapper.getc().should == nil
+        iowrapper.ungetc(10)
+        iowrapper.getc.should == 10
+      end
+    end
+    File.unlink(path)
+  end
+
+  it "affects EOF state" do
+    path = tmp('empty.txt')
+    File.open(path, "w+") do |empty|
+      IOWrapper.open(empty) do |iowrapper|
+        iowrapper.eof?.should == true
+        iowrapper.getc.should == nil
+        iowrapper.ungetc(100)
+        iowrapper.eof?.should == false
+      end
+    end
+    File.unlink(path)
+  end
+
+  it "adjusts the stream position" do
+    @iowrapper.pos.should == 0
+
+    # read one char
+    c = @iowrapper.getc
+    @iowrapper.pos.should == 1
+    @iowrapper.ungetc(c)
+    @iowrapper.pos.should == 0
+
+    # read all
+    @iowrapper.read
+    pos = @iowrapper.pos
+    @iowrapper.ungetc(98)
+    @iowrapper.pos.should == pos - 1
+  end
+
+  # TODO: file MRI bug
+  # Another specified behavior that MRI doesn't follow:
+  # "Has no effect with unbuffered reads (such as IO#sysread)."
+  #
+  #it "has no effect with unbuffered reads" do
+  #  length = File.size(@file_name)
+  #  content = @iowrapper.sysread(length)
+  #  @iowrapper.rewind
+  #  @iowrapper.ungetc(100)
+  #  @iowrapper.sysread(length).should == content
+  #end
+
+  it "makes subsequent unbuffered operations to raise IOError" do
+    @iowrapper.getc
+    @iowrapper.ungetc(100)
+    lambda { @iowrapper.sysread(1) }.should raise_error(IOError)
+  end
+
+  # WORKS AS DESIGNED:
+  # Since IO::Like has complete control over the read buffer, it supports
+  # pushing unlimited data into that buffer at any time on any readable stream.
+  #
+  #it "raises IOError when invoked on stream that was not yet read" do
+  #  lambda { @iowrapper.ungetc(100) }.should raise_error(IOError)
+  #end
+
+  it "raises IOError on closed stream" do
+    @iowrapper.getc
+    @iowrapper.close
+    lambda { @iowrapper.ungetc(100) }.should raise_error(IOError)
+  end
+end

data/spec/write_spec.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/fixtures/classes'
+require File.dirname(__FILE__) + '/shared/write'
+
+describe "IO::Like#write" do
+  before :each do
+    @filename = tmp("IO_Like__write_test")
+    @content = "012345678901234567890123456789"
+    File.open(@filename, "w") { |f| f.syswrite(@content) }
+    @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)
+  end
+
+  # TODO: impl detail? discuss this with matz. This spec is useless. - rdavis
+  it "writes all of the string's bytes but buffers them" do
+    written = @iowrapper.write("abcde")
+    written.should == 5
+    File.open(@filename) do |file|
+      file.read.should == "012345678901234567890123456789"
+      @iowrapper.flush
+      file.rewind
+      file.read.should == "abcde5678901234567890123456789"
+    end
+  end
+
+  it "returns the number of bytes written" do
+    @iowrapper.write('').should == 0
+    @iowrapper.write('abcde').should == 5
+  end
+
+  it "writes all of the string's bytes without buffering if mode is sync" do
+    @iowrapper.sync = true
+    written = @iowrapper.write("abcde")
+    written.should == 5
+    File.open(@filename) do |file|
+      file.read(10).should == "abcde56789"
+    end
+  end
+
+  it "does not raise IOError on read-only stream if writing zero bytes" do
+    lambda do
+      IOSpecs.readable_iowrapper do |iowrapper|
+        iowrapper.write("")
+      end
+    end.should_not raise_error
+  end
+
+  it "does not raise IOError on closed stream if writing zero bytes" do
+    lambda { IOSpecs.closed_file.write("") }.should_not raise_error
+  end
+end
+
+describe "IO::Like#write" do
+  it_behaves_like :io_like__write, :write
+end

data/spec_helper.rb

@@ -0,0 +1,49 @@
+unless ENV['MSPEC_RUNNER']
+  begin
+    require "pp"
+    require 'mspec/version'
+    require 'mspec/helpers'
+    require 'mspec/guards'
+    require 'mspec/runner/shared'
+    require 'mspec/matchers/be_ancestor_of'
+    require 'mspec/matchers/output'
+    require 'mspec/matchers/output_to_fd'
+    require 'mspec/matchers/complain'
+    require 'mspec/matchers/equal_element'
+    require 'mspec/matchers/equal_utf16'
+    require 'mspec/matchers/match_yaml'
+
+    # Code to setup HOME directory correctly on Windows
+    # This duplicates Ruby 1.9 semantics for defining HOME
+    platform_is :windows do
+      if ENV['HOME']
+        ENV['HOME'] = ENV['HOME'].tr '\\', '/'
+      elsif ENV['HOMEDIR'] && ENV['HOMEDRIVE']
+        ENV['HOME'] = File.join(ENV['HOMEDRIVE'], ENV['HOMEDIR'])
+      elsif ENV['HOMEDIR']
+        ENV['HOME'] = ENV['HOMEDIR']
+      elsif ENV['HOMEDRIVE']
+        ENV['HOME'] = ENV['HOMEDRIVE']
+      elsif ENV['USERPROFILE']
+        ENV['HOME'] = ENV['USERPROFILE']
+      else
+        puts "No suitable HOME environment found. This means that all of"
+        puts "HOME, HOMEDIR, HOMEDRIVE, and USERPROFILE are not set"
+        exit 1
+      end
+    end
+
+    TOLERANCE = 0.00003 unless Object.const_defined?(:TOLERANCE)
+  rescue LoadError
+    puts "Please install the MSpec gem to run the specs."
+    exit 1
+  end
+end
+
+minimum_version = "1.5.9"
+unless MSpec::VERSION >= minimum_version
+  puts "Please install MSpec version >= #{minimum_version} to run the specs"
+  exit 1
+end
+
+$VERBOSE = nil unless ENV['OUTPUT_WARNINGS']

metadata

@@ -1,46 +1,181 @@
 --- !ruby/object:Gem::Specification 
 name: io-like
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  hash: 17
+  prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Jeremy Bopp
+- Jarred Holman
+- Grant Gardner
+- Jordan Pickwell
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-04-29 00:00:00 -05:00
-default_executable: 
-dependencies: []
+date: 2020-02-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 37
+        segments: 
+        - 10
+        - 3
+        version: "10.3"
+  version_requirements: *id001
+  name: rake
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  version_requirements: *id002
+  name: mspec
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  version_requirements: *id003
+  name: yard
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 0
+        version: "0.0"
+  version_requirements: *id004
+  name: yard-redcarpet-ext
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  version_requirements: *id005
+  name: github-markup
+  type: :development
+  prerelease: false
+description: |
+  The IO::Like module provides all of the methods of typical IO implementations
+  such as File; most importantly the read, write, and seek series of methods.  A
+  class which includes IO::Like needs to provide only a few methods in order to
+  enable the higher level methods.  Buffering is automatically provided by default
+  for the methods which normally provide it in IO.
 
-description: "The IO::Like module provides the methods of an IO object based upon on a few simple methods provided by the including class: unbuffered_read, unbuffered_write, and unbuffered_seek.  These methods provide the underlying read, write, and seek support respectively, and only the method or methods necessary to the correct operation of the IO aspects of the including class need to be provided.  Missing functionality will cause the resulting object to appear read-only, write-only, and/or unseekable depending on which underlying methods are absent.  Additionally, read and write operations which are buffered in IO are buffered with independently configurable buffer sizes.  Duplexed objects (those with separate read and write streams) are also supported."
-email: jeremy at bopp dot net
+email: 
+- jeremy@bopp.net
+- jarred.holman@gmail.com
+- grant@lastweekend.com.au
+- jpickwell@users.noreply.github.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- CONTRIBUTORS
-- HACKING
 - LICENSE
-- LICENSE.rubyspec
-- GPL
-- LEGAL
-- NEWS
-- README
+- LICENSE-rubyspec
+- NEWS.md
+- README.md
 files: 
-- lib/io/like.rb
-- CONTRIBUTORS
-- HACKING
+- .yardopts
 - LICENSE
-- LICENSE.rubyspec
-- GPL
-- LEGAL
-- NEWS
-- README
-- MANIFEST
-has_rdoc: true
-homepage: http://io-like.rubyforge.org
+- LICENSE-rubyspec
+- NEWS.md
+- README.md
+- Rakefile
+- lib/io/like.rb
+- ruby.1.8.mspec
+- spec/binmode_spec.rb
+- spec/close_read_spec.rb
+- spec/close_spec.rb
+- spec/close_write_spec.rb
+- spec/closed_spec.rb
+- spec/each_byte_spec.rb
+- spec/each_line_spec.rb
+- spec/each_spec.rb
+- spec/eof_spec.rb
+- spec/fixtures/classes.rb
+- spec/fixtures/gets.txt
+- spec/fixtures/numbered_lines.txt
+- spec/fixtures/one_byte.txt
+- spec/fixtures/paragraphs.txt
+- spec/fixtures/readlines.txt
+- spec/flush_spec.rb
+- spec/getc_spec.rb
+- spec/gets_spec.rb
+- spec/isatty_spec.rb
+- spec/lineno_spec.rb
+- spec/output_spec.rb
+- spec/pos_spec.rb
+- spec/print_spec.rb
+- spec/printf_spec.rb
+- spec/putc_spec.rb
+- spec/puts_spec.rb
+- spec/read_spec.rb
+- spec/readchar_spec.rb
+- spec/readline_spec.rb
+- spec/readlines_spec.rb
+- spec/readpartial_spec.rb
+- spec/rewind_spec.rb
+- spec/seek_spec.rb
+- spec/shared/each.rb
+- spec/shared/eof.rb
+- spec/shared/pos.rb
+- spec/shared/tty.rb
+- spec/shared/write.rb
+- spec/sync_spec.rb
+- spec/sysread_spec.rb
+- spec/sysseek_spec.rb
+- spec/syswrite_spec.rb
+- spec/tell_spec.rb
+- spec/to_io_spec.rb
+- spec/tty_spec.rb
+- spec/ungetc_spec.rb
+- spec/write_spec.rb
+- spec_helper.rb
+homepage: http://github.com/javanthropus/io-like
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: 
 - --title
@@ -52,23 +187,79 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 53
+      segments: 
+      - 1
+      - 8
+      - 1
       version: 1.8.1
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: io-like
-rubygems_version: 1.3.1
+rubyforge_project: 
+rubygems_version: 1.8.15
 signing_key: 
-specification_version: 2
-summary: A module which provides the functionality of an IO object to any class which provides a couple of simple methods.
-test_files: []
-
+specification_version: 3
+summary: A module which provides the functionality of an IO object to any including class which provides a couple of simple methods.
+test_files: 
+- ruby.1.8.mspec
+- spec/binmode_spec.rb
+- spec/close_read_spec.rb
+- spec/close_spec.rb
+- spec/close_write_spec.rb
+- spec/closed_spec.rb
+- spec/each_byte_spec.rb
+- spec/each_line_spec.rb
+- spec/each_spec.rb
+- spec/eof_spec.rb
+- spec/fixtures/classes.rb
+- spec/fixtures/gets.txt
+- spec/fixtures/numbered_lines.txt
+- spec/fixtures/one_byte.txt
+- spec/fixtures/paragraphs.txt
+- spec/fixtures/readlines.txt
+- spec/flush_spec.rb
+- spec/getc_spec.rb
+- spec/gets_spec.rb
+- spec/isatty_spec.rb
+- spec/lineno_spec.rb
+- spec/output_spec.rb
+- spec/pos_spec.rb
+- spec/print_spec.rb
+- spec/printf_spec.rb
+- spec/putc_spec.rb
+- spec/puts_spec.rb
+- spec/read_spec.rb
+- spec/readchar_spec.rb
+- spec/readline_spec.rb
+- spec/readlines_spec.rb
+- spec/readpartial_spec.rb
+- spec/rewind_spec.rb
+- spec/seek_spec.rb
+- spec/shared/each.rb
+- spec/shared/eof.rb
+- spec/shared/pos.rb
+- spec/shared/tty.rb
+- spec/shared/write.rb
+- spec/sync_spec.rb
+- spec/sysread_spec.rb
+- spec/sysseek_spec.rb
+- spec/syswrite_spec.rb
+- spec/tell_spec.rb
+- spec/to_io_spec.rb
+- spec/tty_spec.rb
+- spec/ungetc_spec.rb
+- spec/write_spec.rb
+- spec_helper.rb