buffered_io 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in buffered_io.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Scott M. Kroll
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,34 @@
+= BufferedIO
+
+Library for buffering Ruby IO objects.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'buffered_io'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install buffered_io
+
+== Usage
+
+TODO: Write usage instructions here
+
+== Contributing
+
+1. Fork it
+
+1. Create your feature branch (`git checkout -b my-new-feature`)
+
+1. Commit your changes (`git commit -am 'Add some feature'`)
+
+1. Push to the branch (`git push origin my-new-feature`)
+
+1. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.title = 'BufferedIO'
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_files.include('README.rdoc', 'lib/**/*.rb')
+end
+

data/buffered_io.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'buffered_io/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'buffered_io'
+  gem.version       = BufferedIO::VERSION
+  gem.authors       = ['Scott M. Kroll']
+  gem.email         = ['skroll@gmail.com']
+  gem.summary       = %q{Library to buffer IO objects for efficient reading.}
+  gem.description   = gem.summary
+  gem.homepage      = 'https://github.com/skroll/ruby-buffered_io'
+  gem.has_rdoc      = true
+  gem.rdoc_options = ['--line-numbers', '--inline-source', '--title', 'BufferedIO', '--main', 'README.rdoc']
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end
+

data/lib/buffered_io.rb

@@ -0,0 +1,6 @@
+require 'buffered_io/version'
+require 'buffered_io/io_buffer'
+
+module BufferedIO # :nodoc:
+end
+

data/lib/buffered_io/io_buffer.rb

@@ -0,0 +1,153 @@
+require 'buffered_io/read_buffer'
+
+module BufferedIO
+  # An +IOBuffer+ object wraps an +IO+ object and buffers read data for
+  # efficient +IO+ manipulation.
+  #
+  # === Example
+  #
+  #   io_buffer = IOBuffer.new(io)
+  #
+  #   puts io_buffer.readline # => Read until a newline
+  #   puts io_buffer.read(64) # => Read 64 bytes
+  #
+  class IOBuffer
+    # Returns a new +IOBuffer+ object wrapping +io+.
+    def initialize(io)
+      @io = io
+      @read_buffer = ReadBuffer.new(io)
+    end
+
+    # Read bytes from the underlying +IO+ object.
+    #
+    # === Parameters
+    #
+    # +length+ is the number of bytes to read.
+    #
+    # +dest+ is the buffer to append to.
+    #
+    # +ignore_eof+ indicates whether or not to ignore +EOFError+ exceptions.
+    #
+    # === Errors
+    #
+    # This method may raise:
+    #
+    # * +EOFError+
+    #
+    def read(length, dest = '', ignore_eof = false)
+      read_bytes = 0
+      begin
+        while read_bytes + @read_buffer.size < length
+          dest << (s = @read_buffer.consume(@read_buffer.size))
+          read_bytes += s.size
+          @read_buffer.fill
+        end
+        dest << (s = @read_buffer.consume(length - read_bytes))
+        read_bytes += s.size
+      rescue EOFError
+        raise unless ignore_eof
+      end
+      dest
+    end
+
+    # Read all data from the underlying +IO+ object until an +EOFError+ is
+    # raised by the +IO+ object.
+    #
+    # === Parameters
+    #
+    # +dest+ is the buffer to append to.
+    #
+    def read_all(dest = '')
+      read_bytes = 0
+      begin
+        while true
+          dest << (s = @read_buffer.consume(@read_buffer.size))
+          read_bytes += s.size
+          @read_buffer.fill
+        end
+      rescue EOFError
+        ;
+      end
+      dest
+    end
+
+    # Read from the underlying +IO+ object until a specified terminator
+    # is reached.
+    #
+    # === Parameters
+    #
+    # +terminator+ is the terminator to read until.
+    #
+    # +ignore_eof+ indicates whether or not to ignore +EOFError+ exceptions.
+    #
+    # === Errors
+    #
+    # This method may raise:
+    #
+    # * +EOFError+
+    #
+    def readuntil(terminator, ignore_eof = false)
+      begin
+        until idx = @read_buffer.index(terminator)
+          @read_buffer.fill
+        end
+        return @read_buffer.consume(idx + terminator.size)
+      rescue EOFError
+        raise unless ignore_eof
+        return @read_buffer.consume(@read_buffer.size)
+      end
+    end
+
+    # Read a line from the underlying +IO+ object.
+    #
+    # === Parameters
+    #
+    # +chop+ indicates whether or not to strip the newline character from
+    # the read data.
+    #
+    # === Errors
+    #
+    # This method may raise:
+    #
+    # * +EOFError+
+    def readline(chop = true)
+      s = readuntil("\n")
+      return chop ? s.chop : s
+    end
+
+    # Writes bytes to the underlying +IO+ object.
+    #
+    # === Parameters
+    #
+    # +str+ is the data to write.
+    def write(str)
+      writing { write0 str }
+    end
+
+    # Appends a newline to a string and writes it to the underlying +IO+
+    # object.
+    #
+    # === Parameters
+    #
+    # +str+ is the data to write.
+    def writeline(str)
+      writing { write0 str + "\r\n" }
+    end
+
+    private
+    def writing
+      @written_bytes = 0
+      yield
+      bytes = @written_bytes
+      @written_bytes = nil
+      bytes
+    end
+
+    def write0(str)
+      length = @io.write(str)
+      @written_bytes += length
+      length
+    end
+  end
+end
+

data/lib/buffered_io/read_buffer.rb

@@ -0,0 +1,43 @@
+module BufferedIO
+  # Maintains a read buffer for an IO object.
+  class ReadBuffer # :nodoc:
+    # :nodoc:
+    DEFAULT_BUFFER_SIZE = 1024 * 16
+
+    def initialize(io)
+      @io = io
+      @buffer = ''
+      @read_timeout = 60
+      @buffer_size = DEFAULT_BUFFER_SIZE
+    end
+
+    attr_reader :io
+    attr_accessor :read_timeout
+
+    # Attempt to fill the IOBuffer
+    def fill
+      begin
+        @buffer << @io.read_nonblock(@buffer_size)
+      rescue ::IO::WaitReadable
+        IO.select([@io], nil, nil, @read_timeout) ? retry : (raise ::Timeout::Error)
+      rescue ::IO::WaitWritable
+        IO.select(nil, [@io], nil, @read_timeout) ? retry : (raise ::Timeout::Error)
+      end
+    end
+
+    # Consume bytes from the IOBuffer
+    def consume(len)
+      return @buffer.slice!(0, len)
+    end
+
+    # Number of bytes in the buffer
+    def size
+      @buffer.size
+    end
+
+    def index(i)
+      @buffer.index(i)
+    end
+  end
+end
+

data/lib/buffered_io/version.rb

@@ -0,0 +1,5 @@
+module BufferedIO
+  # The version of the BufferedIO library.
+  VERSION = "0.0.1"
+end
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: buffered_io
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Scott M. Kroll
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-20 00:00:00.000000000 Z
+dependencies: []
+description: Library to buffer IO objects for efficient reading.
+email:
+- skroll@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- buffered_io.gemspec
+- lib/buffered_io.rb
+- lib/buffered_io/io_buffer.rb
+- lib/buffered_io/read_buffer.rb
+- lib/buffered_io/version.rb
+homepage: https://github.com/skroll/ruby-buffered_io
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- BufferedIO
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Library to buffer IO objects for efficient reading.
+test_files: []