bychar 1.0.1 → 1.1.0

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head

data/bychar.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "bychar"
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik Tarkhanov"]
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
     "README.rdoc",

data/lib/bychar.rb

@@ -2,11 +2,15 @@
 require 'stringio'
 
 module Bychar
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 
   # Default buffer size is 512k
   DEFAULT_BUFFER_SIZE = 512 * 1024
   
+  # Gets raised when you have exhausted the underlying IO
+  class EOFError < RuntimeError  #:nodoc: all
+  end
+  
   # This object helps you build parsers that parse an IO byte by byte without having to
   # read byte by byte.
   # Reading byte by byte is very inefficient, but we want to parse byte by byte since
@@ -15,7 +19,6 @@ module Bychar
   # and ad infinitum until the passed buffer is exhausted
   class Reader
     
-
     def initialize(with_io, buffer_size = DEFAULT_BUFFER_SIZE)
       @io = with_io
       @bufsize = buffer_size
@@ -38,9 +41,19 @@ module Bychar
     def eof?
       (@buf && @buf.eos?) && @io.eof?
     end
-
+    
+    # Since you parse char by char, you will be tempted to do it in a tight loop
+    # and to call eof? on each iteration. Don't. Instead. allow it to raise and do not check.
+    # This takes the profile time down from 36 seconds to 30 seconds for a large file.
+    def read_one_byte!
+      cache if @buf.eos?
+      raise EOFError if @buf.eos?
+      
+      @buf.getch
+    end
+    
     private
-
+    
     def cache
       data = @io.read(@bufsize)
       @buf = StringScanner.new(data.to_s) # Make nil become ""

data/test/test_bychar.rb

@@ -45,4 +45,16 @@ class TestBychar < Test::Unit::TestCase
     assert reader.eof?
   end
   
+  def test_read_one_byte_and_raise_at_eof
+    str = "Frobobo"
+    
+    bytes = []
+    assert_raise(Bychar::EOFError) do
+      s = Bychar::Reader.new(StringIO.new(str))
+      loop { bytes << s.read_one_byte! }
+    end
+    
+    assert_equal %w( F r o b o b o ), bytes
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bychar
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -84,6 +84,7 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - .document
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.rdoc
@@ -107,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1325391043988314358
+      hash: -1419412971002679734
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: