bychar 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+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 "rdoc", "~> 3.12"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.4"
+  gem "flexmock", "~>0.8"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Julik Tarkhanov
+
+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,26 @@
+= 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
+
+The wrapper will cache some bytes from the passed IO object which will make parsing
+faster when you advance your parser char by char.
+
+== 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/Rakefile

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+require File.dirname(__FILE__)  + "/lib/bychar"
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.version = Bychar::VERSION
+  gem.name = "bychar"
+  gem.homepage = "http://github.com/julik/bychar"
+  gem.license = "MIT"
+  gem.summary = %Q{ Helps parsing IO char by char }
+  gem.description = %Q{ Helps parsing IO char by char }
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bychar #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bychar.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "bychar"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Julik Tarkhanov"]
+  s.date = "2013-03-15"
+  s.description = " Helps parsing IO char by char "
+  s.email = "me@julik.nl"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "bychar.gemspec",
+    "lib/bychar.rb",
+    "test/helper.rb",
+    "test/test_bychar.rb"
+  ]
+  s.homepage = "http://github.com/julik/bychar"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Helps parsing IO char by char"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      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<flexmock>, ["~> 0.8"])
+    else
+      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<flexmock>, ["~> 0.8"])
+    end
+  else
+    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<flexmock>, ["~> 0.8"])
+  end
+end
+

data/lib/bychar.rb

@@ -0,0 +1,49 @@
+# -*- encoding : utf-8 -*-
+require 'stringio'
+
+module Bychar
+  VERSION = '1.0.0'
+
+  # Default buffer size is 512k
+  DEFAULT_BUFFER_SIZE = 512 * 1024
+  
+  # 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
+  # this makes parser construction much easier. So what we do is cache some chunk of the
+  # passed buffer and read from that. Once exhausted there will be some caching again,
+  # 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
+      @buf = StringIO.new
+    end
+
+    # 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_byte
+      cache if @buf.pos == @buf.size
+      
+      return nil if @buf.size.zero?
+      return @buf.read(1)
+    end
+    
+    # Tells whether all the data has been both read from the passed buffer
+    # and from the internal cache buffer (checks whether there is anything that
+    # can be retreived using read_one_byte)
+    def eof?
+      @buf.eof? && @io.eof?
+    end
+
+    private
+
+    def cache
+      data = @io.read(@bufsize)
+      @buf = StringIO.new(data.to_s) # Make nil become ""
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'flexmock'
+require 'flexmock/test_unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'bychar'
+
+# http://redmine.ruby-lang.org/issues/4882
+# https://github.com/jimweirich/flexmock/issues/4
+# https://github.com/julik/flexmock/commit/4acea00677e7b558bd564ec7c7630f0b27d368ca
+class FlexMock::PartialMockProxy
+  def singleton?(method_name)
+    @obj.singleton_methods.include?(method_name.to_s)
+  end
+end
+

data/test/test_bychar.rb

@@ -0,0 +1,48 @@
+require 'helper'
+
+class TestBychar < Test::Unit::TestCase
+  def test_reads_once
+    s = StringIO.new("This is a string")
+    
+    reader = Bychar::Reader.new(s)
+    assert_equal "T", reader.read_one_byte
+    assert_equal "h", reader.read_one_byte
+    assert !reader.eof?
+  end
+  
+  def test_reads_set_buffer_size
+    s = StringIO.new("abcd")
+    flexmock(s).should_receive(:read).with(4).once.and_return("abcd")
+    reader = Bychar::Reader.new(s, 4)
+    reader.read_one_byte
+  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::Reader.new(s)
+    reader.read_one_byte
+  end
+  
+  def test_eof_with_empty
+    s = StringIO.new
+    reader = Bychar::Reader.new(s)
+    assert s.eof?
+  end
+  
+  def test_eof_with_io_at_eof
+    s = StringIO.new("foo")
+    s.read(3)
+    reader = Bychar::Reader.new(s)
+    assert reader.eof?
+  end
+  
+  def test_eof_with_string_to_size
+    s = "Foobarboo another"
+    s = StringIO.new(s)
+    reader = Bychar::Reader.new(s, 1)
+    s.length.times { reader.read_one_byte }
+    assert reader.eof?
+  end
+  
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: bychar
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: flexmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    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
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- bychar.gemspec
+- lib/bychar.rb
+- test/helper.rb
+- test/test_bychar.rb
+homepage: http://github.com/julik/bychar
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3036736534217565560
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Helps parsing IO char by char
+test_files: []