progress 1.2.1 → 2.0.0

data/.gitignore

@@ -0,0 +1,11 @@
+/pkg/
+
+/doc/
+/rdoc/
+/.yardoc/
+/coverage/
+
+Makefile
+*.o
+*.bundle
+/tmp/

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Ivan Kuchin
+Copyright (c) 2010-2011 Ivan Kuchin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -98,6 +98,14 @@ Or if you know that B runs 10 times faster than C:
       end
     end
 
+You can also show note:
+
+    [1, 2, 3].with_progress('Wait').each do |i|
+      sleep 1
+      Progress.note = i
+    end
+
+
 ## REQUIREMENTS:
 
 ruby )))
@@ -108,4 +116,4 @@ ruby )))
 
 ## Copyright
 
-Copyright (c) 2010 Ivan Kuchin. See LICENSE.txt for details.
+Copyright (c) 2010-2011 Ivan Kuchin. See LICENSE.txt for details.

data/lib/progress.rb

@@ -3,11 +3,19 @@ require 'thread'
 
 # ==== Procedural example
 #   Progress.start('Test', 1000)
-#   1000.times{ Progress.step }
+#   1000.times do
+#     Progress.step do
+#       # do something
+#     end
+#   end
 #   Progress.stop
 # ==== Block example
 #   Progress.start('Test', 1000) do
-#     1000.times{ Progress.step }
+#     1000.times do
+#       Progress.step do
+#         # do something
+#       end
+#     end
 #   end
 # ==== Step must not always be one
 #   symbols = []
@@ -70,7 +78,7 @@ class Progress
         @semaphore = Mutex.new
         @beeper = Thread.new do
           loop do
-            sleep 3
+            sleep 1
             print_message
           end
         end
@@ -121,12 +129,13 @@ class Progress
         end
         levels.pop
         if levels.empty?
+          @beeper.kill
           io.puts
         end
       end
     end
 
-    # set note (will be shown after progress message)
+    # set note
     def note=(s)
       if levels.last
         levels.last.note = s
@@ -250,5 +259,11 @@ end
 
 require 'progress/enumerable'
 require 'progress/integer'
-require 'progress/kernel'
 require 'progress/active_record'
+
+module Kernel
+  def Progress(title = nil, total = nil, &block)
+    Progress.start(title, total, &block)
+  end
+  private :Progress
+end

data/lib/progress/active_record.rb

@@ -1,3 +1,5 @@
+require 'progress'
+
 if defined?(ActiveRecord::Base)
   module ActiveRecord
     module BatchesWithProgress

data/lib/progress/enumerable.rb

@@ -8,28 +8,19 @@ module Enumerable
   #   [1, 2, 3].with_progress('Numbers').each do |number|
   #     # code
   #   end
+  #
   #   [1, 2, 3].with_progress('Numbers').each_cons(2) do |numbers|
   #     # code
   #   end
-  def with_progress(title = nil)
-    Progress::WithProgress.new(self, title)
-  end
-
-  # run `each` with progress
-  # ==== Example
-  #   [1, 2, 3].each_with_progress('Numbers') do |number|
+  #
+  #   (0...100).with_progress('Numbers').select do |numbers|
   #     # code
   #   end
-  def each_with_progress(title = nil, &block)
-    with_progress(title).each(&block)
-  end
-
-  # run `each_with_index` with progress
-  # ==== Example
-  #   [1, 2, 3].each_with_index_and_progress('Numbers') do |number, index|
+  #
+  #   (0...100).with_progress('Numbers').all? do |numbers|
   #     # code
   #   end
-  def each_with_index_and_progress(title = nil, &block)
-    with_progress(title).each_with_index(&block)
+  def with_progress(title = nil, &block)
+    Progress::WithProgress.new(self, title, &block)
   end
 end

data/lib/progress/integer.rb

@@ -1,3 +1,5 @@
+require 'progress'
+
 class Integer
   # run `times` with progress
   #   100.times_with_progress('Numbers') do |number|

data/lib/progress/with_progress.rb

@@ -1,42 +1,38 @@
-require 'delegate'
+require 'progress'
 
 class Progress
   class WithProgress
-    attr_reader :object, :title
-    def initialize(object, title)
-      @object = Progress::Enhancer.new(object)
-      @title = title
-    end
+    include Enumerable
 
-    def with_progress(title)
-      self
+    def initialize(enumerable, title, &block)
+      @enumerable, @title = enumerable, title
+      each(&block) if block
     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|
-        Progress.step do
-          block.call(*yielded)
+    def each
+      Progress.start(@title, length) do
+        @enumerable.each do |object|
+          Progress.step do
+            yield object
+          end
         end
       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
+      @length ||= if @enumerable.respond_to?(:length) && !@enumerable.is_a?(String)
+        @enumerable.length
+      elsif @enumerable.respond_to?(:count)
+        @enumerable.count
+      elsif @enumerable.respond_to?(:to_a)
+        @enumerable.to_a.length
       else
-        __getobj__.inject(0){ |length, obj| length + 1 }
+        @enumerable.inject(0){ |length, obj| length + 1 }
       end
     end
+
+    def with_progress(title = nil)
+      self
+    end
   end
 end

data/progress.gemspec

@@ -1,57 +1,19 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# encoding: UTF-8
 
 Gem::Specification.new do |s|
-  s.name = "progress"
-  s.version = "1.2.1"
+  s.name        = 'progress'
+  s.version     = '2.0.0'
+  s.summary     = %q{Show progress of long running tasks}
+  s.homepage    = "http://github.com/toy/#{s.name}"
+  s.authors     = ['Ivan Kuchin']
+  s.license     = 'MIT'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Ivan Kuchin"]
-  s.date = "2011-10-18"
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.markdown"
-  ]
-  s.files = [
-    ".tmignore",
-    "LICENSE.txt",
-    "README.markdown",
-    "Rakefile",
-    "VERSION",
-    "lib/progress.rb",
-    "lib/progress/active_record.rb",
-    "lib/progress/enumerable.rb",
-    "lib/progress/integer.rb",
-    "lib/progress/kernel.rb",
-    "lib/progress/with_progress.rb",
-    "progress.gemspec",
-    "spec/progress_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/toy/progress"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.11"
-  s.summary = "Show progress of long running tasks"
+  s.rubyforge_project = s.name
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = %w[lib]
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_development_dependency(%q<rake-gem-ghost>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-    else
-      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_dependency(%q<rake-gem-ghost>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-    s.add_dependency(%q<rake-gem-ghost>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-  end
+  s.add_development_dependency 'rspec'
 end
-

data/spec/progress_spec.rb

@@ -1,10 +1,12 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 
 describe Progress do
+  let(:count){ 165 }
+
   before :each do
     @io = StringIO.new
-    Progress.stub!(:io).and_return(@io)
-    Progress.stub!(:time_to_print?).and_return(true)
+    Progress.instance_variable_set(:@io, @io)
+    def Progress.time_to_print?; true; end
   end
 
   def io_pop
@@ -19,8 +21,8 @@ describe Progress do
     io_pop.sub(/ \(ETA: \d+.\)$/, '')
   end
 
-  def verify_output_before_step(i)
-    io_pop.should =~ /#{Regexp.quote(i == 0 ? '......' : (i / 10.0).to_s)}/
+  def verify_output_before_step(i, count)
+    io_pop.should =~ /#{Regexp.quote(i == 0 ? '......' : '%5.1f' % (i / count.to_f * 100.0))}/
   end
   def verify_output_after_stop
     io_pop.should =~ /100\.0.*\n$/
@@ -29,9 +31,9 @@ describe Progress do
   describe 'direct usage' do
     describe 'procedural' do
       it "should show valid output when called as Progress.start" do
-        Progress.start('Test', 1000)
-        1000.times do |i|
-          verify_output_before_step(i)
+        Progress.start('Test', count)
+        count.times do |i|
+          verify_output_before_step(i, count)
           Progress.step
         end
         Progress.stop
@@ -39,9 +41,9 @@ describe Progress do
       end
 
       it "should show valid output when called as Progress" do
-        Progress('Test', 1000)
-        1000.times do |i|
-          verify_output_before_step(i)
+        Progress('Test', count)
+        count.times do |i|
+          verify_output_before_step(i, count)
           Progress.step
         end
         Progress.stop
@@ -49,9 +51,9 @@ describe Progress do
       end
 
       it "should show valid output when called without title" do
-        Progress(1000)
-        1000.times do |i|
-          verify_output_before_step(i)
+        Progress(count)
+        count.times do |i|
+          verify_output_before_step(i, count)
           Progress.step
         end
         Progress.stop
@@ -61,9 +63,9 @@ describe Progress do
 
     describe 'block' do
       it "should show valid output when called as Progress.start" do
-        Progress.start('Test', 1000) do
-          1000.times do |i|
-            verify_output_before_step(i)
+        Progress.start('Test', count) do
+          count.times do |i|
+            verify_output_before_step(i, count)
             Progress.step
           end
         end
@@ -71,9 +73,9 @@ describe Progress do
       end
 
       it "should show valid output when called as Progress" do
-        Progress('Test', 1000) do
-          1000.times do |i|
-            verify_output_before_step(i)
+        Progress('Test', count) do
+          count.times do |i|
+            verify_output_before_step(i, count)
             Progress.step
           end
         end
@@ -81,9 +83,9 @@ describe Progress do
       end
 
       it "should show valid output when called without title" do
-        Progress(1000) do
-          1000.times do |i|
-            verify_output_before_step(i)
+        Progress(count) do
+          count.times do |i|
+            verify_output_before_step(i, count)
             Progress.step
           end
         end
@@ -196,68 +198,18 @@ describe Progress do
 
   describe Enumerable do
     before :each do
-      @a = (0...1000).to_a
+      @a = 0...1000
     end
 
-    describe 'with each_with_progress' do
+    describe 'with_progress' do
       it "should not break each" do
-        a = []
-        @a.each_with_progress('Test') do |n|
-          a << n
-        end
-        a.should == @a
-      end
-
-      it "should show valid output for each_with_progress" do
-        @a.each_with_progress('Test') do |n|
-          verify_output_before_step(n)
-        end
-        verify_output_after_stop
-      end
-
-      it "should show valid output for each_with_progress without title" do
-        @a.each_with_progress do |n|
-          verify_output_before_step(n)
-        end
-        verify_output_after_stop
-      end
-    end
-
-    describe 'with each_with_index_and_progress' do
-      it "should not break each_with_index" do
-        a = []
-        @a.each_with_index_and_progress('Test') do |n, i|
-          n.should == i
-          a << n
-        end
-        a.should == @a
-      end
-
-      it "should show valid output for each_with_progress" do
-        @a.each_with_index_and_progress('Test') do |n, i|
-          verify_output_before_step(n)
-        end
-        verify_output_after_stop
-      end
-
-      it "should show valid output for each_with_progress without title" do
-        @a.each_with_index_and_progress do |n, i|
-          verify_output_before_step(n)
-        end
-        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
+        with, without = [], []
+        @a.with_progress.each{ |n| with << n }
+        @a.each{ |n| without << n }
+        with.should == without
       end
 
-      it "should not break any?" do
+      it "should not break find" 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' }
@@ -285,23 +237,23 @@ describe Progress do
   describe Integer do
     describe 'with times_with_progress' do
       it "should not break times" do
-        c = 0
-        1000.times_with_progress('Test') do |i|
-          i.should == c
-          c += 1
+        ii = 0
+        count.times_with_progress('Test') do |i|
+          i.should == ii
+          ii += 1
         end
       end
 
       it "should show valid output for each_with_progress" do
-        1000.times_with_progress('Test') do |i|
-          verify_output_before_step(i)
+        count.times_with_progress('Test') do |i|
+          verify_output_before_step(i, count)
         end
         verify_output_after_stop
       end
 
       it "should show valid output for each_with_progress without title" do
-        1000.times_with_progress do |i|
-          verify_output_before_step(i)
+        count.times_with_progress do |i|
+          verify_output_before_step(i, count)
         end
         verify_output_after_stop
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: progress
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 15
   prerelease: 
   segments: 
-  - 1
   - 2
-  - 1
-  version: 1.2.1
+  - 0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Ivan Kuchin
@@ -15,42 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-18 00:00:00 Z
+date: 2011-11-28 00:00:00 Z
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: jeweler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake-gem-ghost
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -60,27 +30,23 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id001
 description: 
 email: 
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE.txt
-- README.markdown
+extra_rdoc_files: []
+
 files: 
-- .tmignore
+- .gitignore
 - LICENSE.txt
 - README.markdown
-- Rakefile
-- VERSION
 - lib/progress.rb
 - lib/progress/active_record.rb
 - lib/progress/enumerable.rb
 - lib/progress/integer.rb
-- lib/progress/kernel.rb
 - lib/progress/with_progress.rb
 - progress.gemspec
 - spec/progress_spec.rb
@@ -113,10 +79,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: progress
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Show progress of long running tasks
-test_files: []
-
+test_files: 
+- spec/progress_spec.rb
+- spec/spec_helper.rb
+has_rdoc: 

data/.tmignore

@@ -1 +0,0 @@
-/*.gemspec

data/Rakefile

@@ -1,25 +0,0 @@
-require 'rake'
-require 'jeweler'
-require 'rake/gem_ghost_task'
-require 'rspec/core/rake_task'
-
-name = 'progress'
-
-Jeweler::Tasks.new do |gem|
-  gem.name = name
-  gem.summary = %Q{Show progress of long running tasks}
-  gem.homepage = "http://github.com/toy/#{name}"
-  gem.license = 'MIT'
-  gem.authors = ['Ivan Kuchin']
-  gem.add_development_dependency 'jeweler', '~> 1.5.1'
-  gem.add_development_dependency 'rake-gem-ghost'
-  gem.add_development_dependency 'rspec'
-end
-Jeweler::RubygemsDotOrgTasks.new
-Rake::GemGhostTask.new
-
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.rspec_opts = ['--colour --format progress']
-  spec.pattern = 'spec/**/*_spec.rb'
-end
-task :default => :spec

data/VERSION

@@ -1 +0,0 @@
-1.2.1

data/lib/progress/kernel.rb

@@ -1,6 +0,0 @@
-module Kernel
-  def Progress(title = nil, total = nil, &block)
-    Progress.start(title, total, &block)
-  end
-  private :Progress
-end