bychar 2.0.0 → 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4955440b9eff7331dd966ba6a381b032b24e8f1a
+  data.tar.gz: 345f1b882ce2aef85acf391dd55d8a8aa8db2a33
+SHA512:
+  metadata.gz: 96879e770df2a03d227834db03c6c64ec7b501bff447c01e25ccd9ecfead0be28408ef5d0f92b6eacfa3380a16b72c8e8d9ef3142e277601b5ecbe2f26462f89
+  data.tar.gz: 89a78a2e211f15cc54a0fe8e21b4ef21338ece9662d16aa27ba5d228f581cdc84a576f2e35cd9151261cbc0ffe889cb81d00df723ba29f842c835e9b29b65c10

data/.travis.yml

@@ -2,5 +2,7 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - 2.1.2
   - jruby
   - ruby-head

data/Gemfile

@@ -1,13 +1,9 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem "rake"
   gem "rdoc", "~> 3.12"
-  gem "bundler"
-  gem "jeweler", "~> 1.8.4"
+  gem 'test-unit'
+  gem "jeweler", '1.8.7'
   gem "flexmock", "~>0.8"
 end

data/README.md

@@ -0,0 +1,60 @@
+# bychar
+
+A simple IO wrapper for libraries that tend to read the IO in the following way:
+
+* Only forward
+* By a single character
+* Without skipping
+
+This is how most of recursive-descent parsers and stateful parsers would work. However,
+reading a simple IO object byte by byte in Ruby is very slow. Orders slower in fact.
+Therefore, this gem creates a simple wrapper that you can get like this:
+
+    wrapper = Bychar.wrap(io)
+    while c = wrapper.read_one_char
+      # Do your thang
+    end
+
+The wrapper will cache some bytes from the passed IO object which will make parsing
+faster when you advance your parser char by char.
+
+## Performance
+
+I told you reading char by char is not the best strategy. On Ruby 1.9:
+
+    Bare IO using read(1):                                 3.400000   1.900000   5.300000 (  5.300798)
+    Bychar using StringIO:                                 1.790000   0.010000   1.800000 (  1.795277)
+    Bychar using a String buffer:                          1.760000   0.000000   1.760000 (  1.760440)
+    Platform-picked Bychar.wrap(io) Bychar::ReaderStrbuf:  1.770000   0.010000   1.780000 (  1.776339)
+
+while on Ruby 1.8 it is kinda sad:
+
+    Bare IO using read(1):                               2.380000   0.000000   2.380000 (  2.393260)
+    Bychar using StringIO:                               2.270000   0.010000   2.280000 (  2.275631)
+    Bychar using a String buffer:                        2.920000   0.000000   2.920000 (  2.924574)
+    Platform-picked Bychar.wrap(io) Bychar::ReaderBare:  2.380000   0.010000   2.390000 (  2.384414)
+
+And on JRuby it's different still:
+
+    Bare IO using read(1):                                1.610000   0.040000   1.650000 (  1.180000)
+    Bychar using StringIO:                                0.730000   0.020000   0.750000 (  0.603000)
+    Bychar using a String buffer:                         1.040000   0.040000   1.080000 (  0.790000)
+    Platform-picked Bychar.wrap(io) Bychar::ReaderIOBuf:  0.560000   0.030000   0.590000 (  0.546000)
+
+As you can see, Bychar will do some work to pick an implementation that makes sense for your Ruby platform.
+
+## Contributing to bychar
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Julik Tarkhanov. See LICENSE.txt for
+further details.
+

data/bychar.gemspec

@@ -2,26 +2,28 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: bychar 3.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "bychar"
-  s.version = "2.0.0"
+  s.version = "3.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2013-03-23"
+  s.date = "2014-12-10"
   s.description = " Helps parsing IO char by char "
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "bychar.gemspec",
     "lib/bychar.rb",
@@ -37,28 +39,30 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/julik/bychar"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "2.2.2"
   s.summary = "Helps parsing IO char by char"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<test-unit>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["= 1.8.7"])
       s.add_development_dependency(%q<flexmock>, ["~> 0.8"])
     else
+      s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<test-unit>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["= 1.8.7"])
       s.add_dependency(%q<flexmock>, ["~> 0.8"])
     end
   else
+    s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<test-unit>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["= 1.8.7"])
     s.add_dependency(%q<flexmock>, ["~> 0.8"])
   end
 end

data/lib/bychar.rb

@@ -6,22 +6,36 @@ require File.dirname(__FILE__) + "/impls/reader_strbuf"
 require File.dirname(__FILE__) + "/impls/reader_bare"
 
 module Bychar
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
   DEFAULT_BUFFER_SIZE = 512 * 1024
   
-  # Gets raised when you have exhausted the underlying IO
-  class EOF < EOFError  #:nodoc: all
+  # The basic wrapper that you get from wrap()
+  class Wrapper
+    def initialize(io_to_wrap)
+      @io = io_to_wrap
+    end
+    
+    def read_one_char
+      @io.read_one_char
+    end
+    
+    def each_char
+      while char = read_one_char do
+        yield char
+      end
+    end
   end
   
-  # Returns a reader object that responds to read_one_char!
-  # and raises an EOF if the IO is depleted
+  # Returns a reader object that responds to read_one_char 
+  # and can be passed on to the actual parsers
   def self.wrap(io)
-    if RUBY_PLATFORM == 'java'
+    reader = if RUBY_PLATFORM == 'java'
       ReaderIOBuf.new(io)
     elsif RUBY_VERSION < '1.9'
       ReaderBare.new(io)
     else
       ReaderStrbuf.new(io)
     end
+    Wrapper.new(reader)
   end
 end

data/lib/impls/reader_bare.rb

@@ -6,10 +6,8 @@ module Bychar
       @io = io
     end
   
-    def read_one_char!
-      b = @io.read(1)
-      raise Bychar::EOF if b.nil?
-      b
+    def read_one_char
+      @io.read(1)
     end
   end
 end

data/lib/impls/reader_iobuf.rb

@@ -10,9 +10,9 @@ module Bychar
     # 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_char!
+    def read_one_char
       cache if @buf.eos?
-      raise EOF if @buf.eos?
+      return nil if @buf.eos?
       
       @buf.getch
     end

data/lib/impls/reader_strbuf.rb

@@ -14,10 +14,11 @@ module Bychar
     # Will transparently read one byte off the contained IO, maintaining the internal cache.
     # If the cache has been depleted it will read a big chunk from the IO and cache it and then
     # return the byte
-    def read_one_char!
+    def read_one_char
       if @pos_in_buf > @maximum_pos
         @buf = @io.read(DEFAULT_BUFFER_SIZE)
-        raise EOF if @buf.nil?
+        
+        return nil if @buf.nil?
       
         @maximum_pos = @buf.length - 1
         @pos_in_buf = 0

data/test/test_ioreader.rb

@@ -6,55 +6,53 @@ class TestBychar < Test::Unit::TestCase
     s = StringIO.new("This is a string")
     
     reader = Bychar::ReaderIOBuf.new(s)
-    assert_equal "T", reader.read_one_char!
-    assert_equal "h", reader.read_one_char!
+    assert_equal "T", reader.read_one_char
+    assert_equal "h", reader.read_one_char
   end
   
   def test_reads_set_buffer_size
     s = StringIO.new("abcd")
     flexmock(s).should_receive(:read).with(4).once.and_return("abcd")
     reader = Bychar::ReaderIOBuf.new(s, 4)
-    reader.read_one_char!
+    reader.read_one_char
   end
   
   def test_reads_in_64kb_chunks_by_default
     s = StringIO.new("abcd")
     flexmock(s).should_receive(:read).with(Bychar::DEFAULT_BUFFER_SIZE).once.and_return("abcd")
     reader = Bychar::ReaderIOBuf.new(s)
-    reader.read_one_char!
+    reader.read_one_char
   end
   
   def test_eof_with_empty
     s = StringIO.new
     reader = Bychar::ReaderIOBuf.new(s)
-    assert_raise(Bychar::EOF) { reader.read_one_char! }
+    assert_nil reader.read_one_char
   end
   
   def test_eof_with_io_at_eof
     s = StringIO.new("foo")
     s.read(3)
     reader = Bychar::ReaderIOBuf.new(s)
-    assert_raise(Bychar::EOF) { reader.read_one_char! }
+    assert_nil reader.read_one_char
   end
   
   def test_eof_with_string_to_size
     s = "Foobarboo another"
     s = StringIO.new(s)
     reader = Bychar::ReaderIOBuf.new(s, 1)
-    s.length.times { reader.read_one_char! }
-    assert_raise(Bychar::EOF) { reader.read_one_char! }
+    s.length.times { reader.read_one_char }
+    assert_nil reader.read_one_char
   end
   
-  def test_read_one_byte_and_raise_at_eof
+  def test_read_one_byte_and_nil_at_eof
     str = "Frobobo"
     
     bytes = []
-    assert_raise(Bychar::EOF) do
-      s = Bychar::ReaderIOBuf.new(StringIO.new(str))
-      loop { bytes << s.read_one_char! }
+    s = Bychar::ReaderIOBuf.new(StringIO.new(str))
+    while c = s.read_one_char do
+      bytes << c
     end
-    
     assert_equal %w( F r o b o b o ), bytes
   end
-  
 end

data/test/test_reader.rb

@@ -6,40 +6,28 @@ class TestReader < Test::Unit::TestCase
     s = StringIO.new("This is a string")
     
     reader = Bychar.wrap(s)
-    assert_equal "T", reader.read_one_char!
-    assert_equal "h", reader.read_one_char!
+    assert_equal "T", reader.read_one_char
+    assert_equal "h", reader.read_one_char
   end
   
   def test_eof_with_empty
     s = StringIO.new
     reader = Bychar.wrap(s)
-    assert_raise(Bychar::EOF) { reader.read_one_char! }
+    assert_nil reader.read_one_char
   end
   
   def test_eof_with_io_at_eof
     s = StringIO.new("foo")
     s.read(3)
     reader = Bychar.wrap(s)
-    assert_raise(Bychar::EOF) { reader.read_one_char! }
+    assert_nil reader.read_one_char
   end
   
   def test_eof_with_string_to_size
     s = "Foobarboo another"
     s = StringIO.new(s)
     reader = Bychar.wrap(s)
-    s.length.times { reader.read_one_char! }
-    assert_raise(Bychar::EOF) { reader.read_one_char! }
+    s.length.times { reader.read_one_char }
+    assert_nil reader.read_one_char
   end
-  
-  def test_read_one_byte_and_raise_at_eof
-    str = "Frobobo"
-    bytes = []
-    assert_raise(Bychar::EOF) do
-      s = Bychar.wrap(StringIO.new(str))
-      loop { bytes << s.read_one_char! }
-    end
-    
-    assert_equal %w( F r o b o b o ), bytes
-  end
-  
 end

data/test/test_strreader.rb

@@ -6,41 +6,30 @@ class TestStrReader < Test::Unit::TestCase
     s = StringIO.new("This is a string")
     
     reader = Bychar::ReaderIOBuf.new(s)
-    assert_equal "T", reader.read_one_char!
-    assert_equal "h", reader.read_one_char!
+    assert_equal "T", reader.read_one_char
+    assert_equal "h", reader.read_one_char
   end
   
   def test_eof_with_empty
     s = StringIO.new
     reader = Bychar::ReaderStrbuf.new(s)
-    assert_raise(Bychar::EOF) { reader.read_one_char! }
+    assert_nil reader.read_one_char
   end
   
   def test_eof_with_io_at_eof
     s = StringIO.new("foo")
     s.read(3)
     reader = Bychar::ReaderStrbuf.new(s)
-    assert_raise(Bychar::EOF) { reader.read_one_char! }
+    assert_nil reader.read_one_char
   end
   
   def test_eof_with_string_to_size
     s = "Foobarboo another"
     s = StringIO.new(s)
     reader = Bychar::ReaderStrbuf.new(s)
-    s.length.times { reader.read_one_char! }
-    assert_raise(Bychar::EOF) { reader.read_one_char! }
+    s.length.times {
+      assert reader.read_one_char
+    }
+    assert_nil reader.read_one_char
   end
-  
-  def test_read_one_byte_and_raise_at_eof
-    str = "Frobobo"
-    
-    bytes = []
-    assert_raise(Bychar::EOF) do
-      s = Bychar::ReaderStrbuf.new(StringIO.new(str))
-      loop { bytes << s.read_one_char! }
-    end
-    
-    assert_equal %w( F r o b o b o ), bytes
-  end
-  
 end

data/test/test_z_bench.rb

@@ -21,9 +21,9 @@ class BenchReader
   def run
     File.open(File.dirname(__FILE__) + "/huge_nuke_tcl.tcl") do | io |
       reader = get_reader(io)
-      begin
-        loop { reader.read_one_char! * 2 }
-      rescue Bychar::EOF
+      str = []
+      while c = reader.read_one_char
+        str << (c * 2)
       end
     end
   end

metadata

@@ -1,95 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: bychar
 version: !ruby/object:Gem::Version
-  version: 2.0.0
-  prerelease:
+  version: 3.0.0
 platform: ruby
 authors:
 - Julik Tarkhanov
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-23 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
-    none: false
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
-    none: false
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: bundler
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
-  prerelease: false
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency
-  name: jeweler
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.4
-    none: false
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.4
-    none: false
-  prerelease: false
+        version: 1.8.7
   type: :development
-- !ruby/object:Gem::Dependency
-  name: flexmock
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.8'
-    none: false
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: flexmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-    none: false
-  prerelease: false
   type: :development
-description: ! ' Helps parsing IO char by char '
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: " Helps parsing IO char by char "
 email: me@julik.nl
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
-- .document
-- .travis.yml
+- ".document"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - bychar.gemspec
 - lib/bychar.rb
@@ -105,31 +108,25 @@ files:
 homepage: http://github.com/julik/bychar
 licenses:
 - MIT
-post_install_message:
+metadata: {}
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: 2
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.24
-signing_key:
-specification_version: 3
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
 summary: Helps parsing IO char by char
 test_files: []

data/README.rdoc

@@ -1,63 +0,0 @@
-= bychar
-
-A simple IO wrapper for libraries that tend to read the IO in the following way:
-
-* Only forward
-* By a single character
-* Without skipping
-
-This is how most of recursive-descent parsers and stateful parsers would work. However,
-reading a simple IO object byte by byte in Ruby is very slow. Orders slower in fact.
-Therefore, this gem creates a simple wrapper that you can get like this:
-
-  wrapper = Bychar.wrap(io)
-  loop do
-    c = wrapper.read_one_char!
-  rescye Bychar::EOF
-    # Your IO ran out
-  end
-
-The wrapper will cache some bytes from the passed IO object which will make parsing
-faster when you advance your parser char by char. You should not do any checks on the returned char
-since the reader will raise a Bychar::EOF once the IO is depleted. That exception inherits from EOFError.
-
-== Performance
-
-I told you reading char by char is not the best strategy. On Ruby 1.9:
-
-  Bare IO using read(1):                                 3.400000   1.900000   5.300000 (  5.300798)
-  Bychar using StringIO:                                 1.790000   0.010000   1.800000 (  1.795277)
-  Bychar using a String buffer:                          1.760000   0.000000   1.760000 (  1.760440)
-  Platform-picked Bychar.wrap(io) Bychar::ReaderStrbuf:  1.770000   0.010000   1.780000 (  1.776339)
-
-while on Ruby 1.8 it is kinda sad:
-
-  Bare IO using read(1):                               2.380000   0.000000   2.380000 (  2.393260)
-  Bychar using StringIO:                               2.270000   0.010000   2.280000 (  2.275631)
-  Bychar using a String buffer:                        2.920000   0.000000   2.920000 (  2.924574)
-  Platform-picked Bychar.wrap(io) Bychar::ReaderBare:  2.380000   0.010000   2.390000 (  2.384414)
-
-And on JRuby it's different still:
-
-  Bare IO using read(1):                                1.610000   0.040000   1.650000 (  1.180000)
-  Bychar using StringIO:                                0.730000   0.020000   0.750000 (  0.603000)
-  Bychar using a String buffer:                         1.040000   0.040000   1.080000 (  0.790000)
-  Platform-picked Bychar.wrap(io) Bychar::ReaderIOBuf:  0.560000   0.030000   0.590000 (  0.546000)
-
-As you can see, Bychar will do some work to pick an implementation that makes sense for your Ruby platform.
-
-== Contributing to bychar
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2013 Julik Tarkhanov. See LICENSE.txt for
-further details.
-