progress 0.0.8.1 → 0.0.9.0

data/Manifest

@@ -1,13 +1,11 @@
 CHANGELOG
 lib/progress/enumerable.rb
 lib/progress/integer.rb
+lib/progress/with_progress.rb
 lib/progress.rb
 Manifest
 Rakefile
 README.rdoc
-script/console
-script/destroy
-script/generate
 spec/progress_spec.rb
 spec/spec.opts
 spec/spec_helper.rb

data/README.rdoc

@@ -6,7 +6,7 @@
 
 Class to show progress during console script run
 
-== FEATURES/PROBLEMS:
+== FEATURES:
 
 * Progress
 * Enclosed progress
@@ -14,7 +14,32 @@ Class to show progress during console script run
 == SYNOPSIS:
 
   1000.times_with_progress('Wait') do |time|
-    sleep(time * 0.0001)
+    puts time
+  end
+
+  [1, 2, 3].with_progress('Wait').each do |i|
+    puts i
+  end
+
+  (1..100).with_progress('Wait').each do |i|
+    puts i
+  end
+
+  {
+    :a => 'a',
+    :b => 'b',
+    :c => 'c',
+    :d => 'd',
+  }.with_progress('Wait').each do |k, v|
+    puts "#{k} => #{v}"
+  end
+
+  (1..10).with_progress('Outer').map do |a|
+    (1..10).with_progress('Middle').map do |b|
+      (1..10).with_progress('Inner').map do |c|
+        [a, b, c]
+      end
+    end
   end
 
 == REQUIREMENTS:
@@ -29,7 +54,7 @@ Class to show progress during console script run
 
 (The MIT License)
 
-Copyright (c) 2008 toy full name
+Copyright (c) 2008 toy
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -21,4 +21,4 @@ task 'ghost' do
   path = Gem.searcher.find(echoe.name).full_gem_path
   system 'sudo', 'rm', '-r', path
   symlink File.expand_path('.'), path
-end
+end

data/VERSION.yml

@@ -1 +1 @@
-[0, 0, 8, 1]
+[0, 0, 9, 0]

data/lib/progress/enumerable.rb

@@ -1,16 +1,25 @@
+require 'enumerator'
 module Enumerable
+  # executes any Enumerable method with progress
+  # note that methods which don't necessarily go through all items (like find or any?) will not show 100%
+  # ==== Example
+  #   [1, 2, 3].with_progress('Numbers').each do |number|
+  #     sleep(number)
+  #   end
+  #   [1, 2, 3].with_progress('Numbers').each_cons(2) do |numbers|
+  #     p numbers
+  #   end
+  def with_progress(title)
+    Progress::WithProgress.new(self, title)
+  end
+
   # note that Progress.step is called automatically
   # ==== Example
   #   [1, 2, 3].each_with_progress('Numbers') do |number|
   #     sleep(number)
   #   end
-  def each_with_progress(name, options = {})
-    Progress.start(name, length, options) do
-      each do |item|
-        yield item
-        Progress.step
-      end
-    end
+  def each_with_progress(title, *args, &block)
+    with_progress(title).each(*args, &block)
   end
 
   # note that Progress.step is called automatically
@@ -18,12 +27,8 @@ module Enumerable
   #   [1, 2, 3].each_with_index_and_progress('Numbers') do |number, index|
   #     sleep(number)
   #   end
-  def each_with_index_and_progress(name, options = {})
-    Progress.start(name, length, options) do
-      each_with_index do |item, index|
-        yield item, index
-        Progress.step
-      end
-    end
+  def each_with_index_and_progress(title, *args, &block)
+    with_progress(title).each_with_index(*args, &block)
   end
+
 end

data/lib/progress/with_progress.rb

@@ -0,0 +1,41 @@
+require 'delegate'
+
+class Progress
+  class WithProgress
+    attr_reader :object, :title
+    def initialize(object, title)
+      @object = Progress::Enhancer.new(object)
+      @title = title
+    end
+
+    def with_progress(title)
+      self
+    end
+
+    def method_missing(method, *args, &block)
+      Progress.start(title, object.length) do
+        object.send(method, *args, &block)
+      end
+    end
+  end
+
+  class Enhancer < SimpleDelegator
+    include Enumerable
+    def each(*args, &block)
+      __getobj__.each(*args) do |*yielded|
+        block.call(*yielded)
+        Progress.step
+      end
+    end
+
+    def length
+      if __getobj__.respond_to?(:length) && !__getobj__.is_a?(String)
+        __getobj__.length
+      elsif __getobj__.respond_to?(:to_a)
+        __getobj__.to_a.length
+      else
+        __getobj__.inject(0){ |length, obj| length + 1 }
+      end
+    end
+  end
+end

data/lib/progress.rb

@@ -31,8 +31,8 @@ class Progress
   #   Progress.start('Test', 1000, :lines => true) do
   #     1000.times{ Progress.step }
   #   end
-  def self.start(name, total = 1, options = {})
-    levels << new(name, total, levels.length, options)
+  def self.start(title, total = 1, options = {})
+    levels << new(title, total, levels.length, options)
     print_message
     if block_given?
       result = yield
@@ -41,8 +41,9 @@ class Progress
     end
   end
 
-  def initialize(name, total, level, options) # :nodoc:
-    @name = name + ': %s'
+  attr_reader :message, :options
+  def initialize(title, total, level, options) # :nodoc:
+    @title = title + ': %s'
     @total = total
     @level = level
     @options = options
@@ -63,14 +64,6 @@ class Progress
     self.message = percent
   end
 
-  def message # :nodoc:
-    @message
-  end
-
-  def options # :nodoc:
-    @options
-  end
-
 protected
 
   def percent
@@ -79,7 +72,7 @@ protected
 
   def message=(s)
     formatted = s.ljust(6)[0, 6]
-    @message = @name % formatted
+    @message = @title % formatted
   end
 
   module ClassMethods
@@ -93,7 +86,7 @@ protected
       @io.puts if levels.empty?
     end
 
-    def io=(io) # :nodoc:
+    def io=(io)
       @io = io
     end
 
@@ -118,5 +111,7 @@ protected
   extend ClassMethods
 end
 
+require 'progress/with_progress'
+
 require 'progress/enumerable'
 require 'progress/integer'

data/progress.gemspec

@@ -2,21 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{progress}
-  s.version = "0.0.8.1"
+  s.version = "0.0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["toy"]
-  s.date = %q{2009-05-02}
+  s.date = %q{2009-07-20}
   s.description = %q{A library to show progress of long running tasks.}
   s.email = %q{}
-  s.extra_rdoc_files = ["CHANGELOG", "lib/progress/enumerable.rb", "lib/progress/integer.rb", "lib/progress.rb", "README.rdoc", "tasks/rspec.rake"]
-  s.files = ["CHANGELOG", "lib/progress/enumerable.rb", "lib/progress/integer.rb", "lib/progress.rb", "Manifest", "Rakefile", "README.rdoc", "script/console", "script/destroy", "script/generate", "spec/progress_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake", "VERSION.yml", "progress.gemspec"]
-  s.has_rdoc = true
+  s.extra_rdoc_files = ["CHANGELOG", "lib/progress/enumerable.rb", "lib/progress/integer.rb", "lib/progress/with_progress.rb", "lib/progress.rb", "README.rdoc", "tasks/rspec.rake"]
+  s.files = ["CHANGELOG", "lib/progress/enumerable.rb", "lib/progress/integer.rb", "lib/progress/with_progress.rb", "lib/progress.rb", "Manifest", "Rakefile", "README.rdoc", "spec/progress_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake", "VERSION.yml", "progress.gemspec"]
   s.homepage = %q{}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Progress", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{progress}
-  s.rubygems_version = %q{1.3.2}
+  s.rubygems_version = %q{1.3.4}
   s.summary = %q{A library to show progress of long running tasks.}
 
   if s.respond_to? :specification_version then

data/spec/progress_spec.rb

@@ -5,7 +5,7 @@ describe Progress do
     @io = StringIO.new
     Progress.io = @io
   end
-  
+
   def io_pop
     @io.seek(0)
     s = @io.read
@@ -30,7 +30,7 @@ describe Progress do
     Progress.stop
     verify_output_after_stop
   end
-  
+
   it "should show valid output for block version" do
     Progress.start('Test', 1000) do
       1000.times do |i|
@@ -43,16 +43,16 @@ describe Progress do
 
   describe Enumerable do
     before :each do
-      @a = Array.new(1000){ |n| n }
+      @a = (0...1000).to_a
     end
 
     describe 'with each_with_progress' do
       it "should not break each" do
-        c = 0
+        a = []
         @a.each_with_progress('Test') do |n|
-          n.should == @a[c]
-          c += 1
+          a << n
         end
+        a.should == @a
       end
 
       it "should show valid output for each_with_progress" do
@@ -65,12 +65,12 @@ describe Progress do
 
     describe 'with each_with_index_and_progress' do
       it "should not break each_with_index" do
-        c = 0
+        a = []
         @a.each_with_index_and_progress('Test') do |n, i|
-          n.should == @a[c]
-          i.should == @a[c]
-          c += 1
+          n.should == i
+          a << n
         end
+        a.should == @a
       end
 
       it "should show valid output for each_with_progress" do
@@ -80,6 +80,39 @@ describe Progress do
         verify_output_after_stop
       end
     end
+
+    describe 'with with_progress' do
+      it "should not break each" do
+        a = []
+        @a.with_progress('Test').each do |n|
+          a << n
+        end
+        a.should == @a
+      end
+
+      it "should not break any?" do
+        @a.with_progress('Hello').find{ |n| n == 100 }.should == @a.find{ |n| n == 100 }
+        @a.with_progress('Hello').find{ |n| n == 10000 }.should == @a.find{ |n| n == 10000 }
+        default = proc{ 'default' }
+        @a.with_progress('Hello').find(default){ |n| n == 10000 }.should == @a.find(default){ |n| n == 10000 }
+      end
+
+      it "should not break map" do
+        @a.with_progress('Hello').map{ |n| n * n }.should == @a.map{ |n| n * n }
+      end
+
+      it "should not break grep" do
+        @a.with_progress('Hello').grep(100).should == @a.grep(100)
+      end
+
+      it "should not break each_cons" do
+        without_progress = []
+        @a.each_cons(3){ |values| without_progress << values }
+        with_progress = []
+        @a.with_progress('Hello').each_cons(3){ |values| with_progress << values }
+        without_progress.should == with_progress
+      end
+    end
   end
 
   describe Integer do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: progress
 version: !ruby/object:Gem::Version 
-  version: 0.0.8.1
+  version: 0.0.9.0
 platform: ruby
 authors: 
 - toy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-02 00:00:00 +04:00
+date: 2009-07-20 00:00:00 +04:00
 default_executable: 
 dependencies: []
 
@@ -23,6 +23,7 @@ extra_rdoc_files:
 - CHANGELOG
 - lib/progress/enumerable.rb
 - lib/progress/integer.rb
+- lib/progress/with_progress.rb
 - lib/progress.rb
 - README.rdoc
 - tasks/rspec.rake
@@ -30,13 +31,11 @@ files:
 - CHANGELOG
 - lib/progress/enumerable.rb
 - lib/progress/integer.rb
+- lib/progress/with_progress.rb
 - lib/progress.rb
 - Manifest
 - Rakefile
 - README.rdoc
-- script/console
-- script/destroy
-- script/generate
 - spec/progress_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -72,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: progress
-rubygems_version: 1.3.2
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
 summary: A library to show progress of long running tasks.

data/script/console

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-# File: script/console
-irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
-
-libs =  " -r irb/completion"
-# Perhaps use a console_lib to store any extra methods I may want available in the cosole
-# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
-libs <<  " -r #{File.dirname(__FILE__) + '/../lib/progress.rb'}"
-puts "Loading progress gem"
-exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/destroy'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/generate'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Generate.new.run(ARGV)