progressive_io 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2011-08-04
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+.autotest
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/progressive_io.rb
+test/test_progressive_io.rb

data/README.rdoc

@@ -0,0 +1,50 @@
+= progressive_io
+
+* http://github.com/julik/progressive_io
+
+== DESCRIPTION:
+
+A wrapper for IO objects that allows a callback to be set which is called when an object is read from
+
+== FEATURES/PROBLEMS:
+
+* Wraps any IO
+
+== SYNOPSIS:
+
+  io = ProgressiveIO.new(File.open("/bigfile.dat")) do | pos, total_size |
+    puts "Read %d bytes of %d" % [ pos, total_size ]
+  end
+
+== REQUIREMENTS:
+
+* Ruby 1.8.6+
+
+== INSTALL:
+
+* gem install progressive_io
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Julik Tarkhanov <me@julik.nl>
+
+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/Rakefile

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'progressive_io' do | p |
+  p.developer('Julik Tarkhanov', 'me@ujulik.nl')
+  p.readme_file   = 'README.rdoc'
+  p.extra_rdoc_files  = FileList['*.rdoc'] + FileList['*.txt']
+  p.extra_dev_deps = {"flexmock" => "~> 0.8"}
+  p.clean_globs = File.read(File.dirname(__FILE__) + "/.gitignore").split(/\s/).to_a
+end
+
+# vim: syntax=ruby

data/lib/progressive_io.rb

@@ -0,0 +1,86 @@
+require "delegate"
+
+class ProgressiveIO < DelegateClass(IO)
+  VERSION = '1.0.0'
+  
+  # Get or set the total size of the contained IO. If the passed IO is a File object 
+  # the size will be preset automatically
+  attr_accessor :total_size
+  attr_accessor :progress_block
+  
+  # The constructor accepts an IO object and the block that will be called when the IO is read.
+  # If the passed IO is a File-like object that responds to #stat then the size will be computed
+  # automatically
+  def initialize(with_io, &blk)
+    __setobj__(with_io)
+    @total_size = with_io.stat.size if with_io.respond_to?(:stat)
+    @progress_block = blk.to_proc if blk
+  end
+  
+  # Report offset at each line
+  def each(sep_string = $/, &blk)
+    # Report offset at each call of the iterator
+    result = super(sep_string) do | line |
+      yield(line)
+      notify_read
+    end
+  end
+  alias_method :each_line, :each
+  
+  def each_byte(&blk)
+    # Report offset at each call of the iterator
+    super { |b| yield(b); notify_read }
+  end
+  
+  def getc
+    returning(super) { notify_read }
+  end
+  
+  def gets
+    returning(super) { notify_read }
+  end
+  
+  def read(*a)
+    returning(super) { notify_read }
+  end
+  
+  def readbytes(*a)
+    returning(super) { notify_read }
+  end
+  
+  def readchar
+    returning(super) { notify_read }
+  end
+  
+  def readline(*a)
+    returning(super) { notify_read }
+  end
+  
+  def readlines(*a)
+    returning(super) { notify_read }
+  end
+  
+  def seek(*a)
+    returning(super) { notify_read }
+  end
+  
+  def ungetc(*a)
+    returning(super) { notify_read }
+  end 
+  
+  def pos=(p)
+    returning(super) { notify_read }
+  end
+  
+  private
+    # The "returning" idiom copied from ActiveSupport. We know that modern Rubies have
+    # Object#tap but why mandate newer Rubies for something as small as this?
+    def returning(r)
+      yield(r); r
+    end
+    
+    # This method will be called when something is read
+    def notify_read
+      @progress_block.call(pos, @total_size) if @progress_block
+    end
+end

data/test/test_progressive_io.rb

@@ -0,0 +1,141 @@
+require "test/unit"
+require "progressive_io"
+require "flexmock"
+require "flexmock/test_unit"
+require "stringio"
+
+# 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
+
+class TestProgressiveIO < Test::Unit::TestCase
+  
+  def e(s)
+    
+    # Make a mock File object from a string
+    io = StringIO.new(s)
+    mock_stat = flexmock(:size => s.length)
+    flexmock(io).should_receive(:stat).and_return(mock_stat)
+    
+    ProgressiveIO.new(io)
+  end
+  
+  def test_each
+    io, messages = e("Mary\nHad\nA little\nLamb"), []
+    
+    io.progress_block = lambda do | offset, total |
+      messages.push([offset, total])
+    end
+    
+    lines = []
+    io.each {|line|  lines.push(line) }
+    assert_equal ["Mary\n", "Had\n", "A little\n", "Lamb"], lines
+    assert_equal [[5, 22], [9, 22], [18, 22], [22, 22]], messages
+  end
+  
+  def test_each_byte
+    io, messages = e("123"), []
+    
+    io.progress_block = lambda do | offset, total |
+      messages.push([offset, total])
+    end
+    
+    bytes = []
+    io.each_byte{|s| bytes << s }
+    assert_equal [49, 50, 51], bytes
+    assert_equal [[1, 3], [2, 3], [3, 3]], messages
+  end
+  
+  def test_getc
+    io = e("123")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [1, 3], [offset, total]
+    end
+    if RUBY_VERSION < "1.9"
+      assert_equal 49, io.getc
+    else
+      assert_equal "1", io.getc
+    end
+  end
+  
+  def test_gets
+    io = e("Mary\nHad\nA little\nLamb")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [5, 22], [offset, total]
+    end
+    assert_equal "Mary\n", io.gets
+  end
+  
+  def test_read
+    io = e("Mary\nHad\nA little\nLamb")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [15, 22], [offset, total]
+    end
+    assert_equal "Mary\nHad\nA litt", io.read(15)
+  end
+  
+  def test_readchar
+    io = e("123")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [1, 3], [offset, total]
+    end
+    
+    if RUBY_VERSION < "1.9"
+      assert_equal 49, io.getc
+    else
+      assert_equal "1", io.getc
+    end
+  end
+  
+  def test_readline
+    io = e("Mary\nHad\nA little\nLamb")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [5, 22], [offset, total]
+    end
+    assert_equal "Mary\n", io.readline
+  end
+  
+  def test_readlines
+    io = e("Mary\nHad\nA little\nLamb")
+    m = []
+    io.progress_block = lambda do | offset, total |
+      m.push([offset, total])
+    end
+    
+    assert_equal ["Mary\n", "Had\n", "A little\n", "Lamb"], io.readlines
+    assert_equal [[22, 22]], m
+  end
+  
+  def test_seek
+    io = e("Mary\nHad\nA little\nLamb")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [6, 22], [offset, total]
+    end
+    io.seek(6)
+  end
+  
+  def test_ungetc
+    io = e("Mary\nHad\nA little\nLamb")
+    m = []
+    io.progress_block = lambda do | offset, total |
+      m.push([offset, total])
+    end
+    
+    io.getc
+    io.ungetc(2)
+    assert_equal [[1, 22], [0, 22]], m
+  end
+  
+  def test_poseq
+    io = e("Mary\nHad\nA little\nLamb")
+    io.progress_block = lambda do | offset, total |
+      assert_equal [2, 22], [offset, total]
+    end
+    io.pos = 2
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: progressive_io
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.8"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.10"
+  type: :development
+  version_requirements: *id002
+description: A wrapper for IO objects that allows a callback to be set which is called when an object is read from
+email: 
+- me@ujulik.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/progressive_io.rb
+- test/test_progressive_io.rb
+- .gemtest
+homepage: http://github.com/julik/progressive_io
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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: progressive_io
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: A wrapper for IO objects that allows a callback to be set which is called when an object is read from
+test_files: 
+- test/test_progressive_io.rb