progress 0.0.1 → 0.0.3

data/History.txt

@@ -0,0 +1,14 @@
+== 0.0.3 2008-11-01
+
+* recreated with newgem
+* created specs
+* autospec now runs well
+* created documentation
+
+== 0.0.2 2008-10-31
+
+* added enclosed progress possibility
+
+== 0.0.1
+
+* initial release

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/progress.rb
+lib/progress/enumerable.rb
+lib/progress/integer.rb
+script/console
+script/destroy
+script/generate
+spec/progress_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,51 @@
+= progress
+
+* http://github.com/toy/progress/tree/master
+
+== DESCRIPTION:
+
+Class to show progress during console script run
+
+== FEATURES/PROBLEMS:
+
+* Progress
+* Enclosed progress
+
+== SYNOPSIS:
+
+  1000.times_with_progress('Wait') do |time|
+    sleep(time * 0.0001)
+  end
+
+== REQUIREMENTS:
+
+* ruby
+
+== INSTALL:
+
+* sudo gem install progress
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 toy full name
+
+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

@@ -1,47 +1,21 @@
-require 'rubygems'
-require 'rake/gempackagetask'
-require 'rubygems/specification'
-require 'date'
-
-GEM = "progress"
-GEM_VERSION = "0.0.1"
-AUTHOR = "toy"
-EMAIL = "ivan@workisfun.ru"
-HOMEPAGE = ""
-SUMMARY = "Class to show progress during script run"
-
-spec = Gem::Specification.new do |s|
-  s.name = GEM
-  s.version = GEM_VERSION
-  s.platform = Gem::Platform::RUBY
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
-  s.summary = SUMMARY
-  s.description = s.summary
-  s.author = AUTHOR
-  s.email = EMAIL
-  s.homepage = HOMEPAGE
-  
-  # Uncomment this to add a dependency
-  # s.add_dependency "foo"
-  
-  s.require_path = 'lib'
-  s.autorequire = GEM
-  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs}/**/*")
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end
-
-desc "install the gem locally"
-task :install => [:package] do
-  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
-end
-
-desc "create a gemspec file"
-task :make_spec do
-  File.open("#{GEM}.gemspec", "w") do |file|
-    file.puts spec.to_ruby
-  end
-end
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/progress'
+
+$hoe = Hoe.new('progress', Progress::VERSION) do |p|
+  p.developer('toy', 'email')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks'

data/lib/progress/enumerable.rb

@@ -0,0 +1,29 @@
+module Enumerable
+  # 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)
+    Progress.start(name, length) do
+      each do |item|
+        yield item
+        Progress.step
+      end
+    end
+  end
+
+  # note that Progress.step is called automatically
+  # ==== Example
+  #   [1, 2, 3].each_with_index_and_progress('Numbers') do |number, index|
+  #     sleep(number)
+  #   end
+  def each_with_index_and_progress(name)
+    Progress.start(name, length) do
+      each_with_index do |item, index|
+        yield item, index
+        Progress.step
+      end
+    end
+  end
+end

data/lib/{integer.rb → progress/integer.rb}

@@ -1,4 +1,9 @@
 class Integer
+  # note that Progress.step is called automatically
+  # ==== Example
+  #   100.times_with_progress('Numbers') do |number|
+  #     sleep(number)
+  #   end
   def times_with_progress(name)
     Progress.start(name, self) do
       times do |i|

data/lib/progress.rb

@@ -1,42 +1,99 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'singleton'
+
 class Progress
+  VERSION = '0.0.3'
+
+  include Singleton
+
+  # start progress indication
+  # ==== Procedural example
+  #   Progress.start('Test', 1000)
+  #   1000.times{ Progress.step }
+  #   Progress.stop
+  # ==== Block example
+  #   Progress.start('Test', 1000) do
+  #     1000.times{ Progress.step }
+  #   end
+  # ==== Enclosed block example
+  #   [1, 2, 3].each_with_progress('1 2 3') do |one_of_1_2_3|
+  #     10.times_with_progress('10') do |one_of_10|
+  #       sleep(0.001)
+  #     end
+  #   end
   def self.start(name, total = 100)
-    @io ||= $stdout
-    @io.sync = true
-    
-    @each = total / 1000
-    @count = 0
+    levels << new(name, total, levels.length)
+    print_message
+    if block_given?
+      yield
+      stop
+    end
+  end
 
-    @current = 0
-    @total = total
+  def self.step
+    levels[-1].step
+    print_message
+  end
+
+  def self.stop
+    levels.pop.stop
+    @io.puts if levels.empty?
+  end
+
+  def self.io=(io) # :nodoc:
+    @io = io
+  end
+
+  def initialize(name, total, level) # :nodoc:
     @name = name + ': %s'
-    message highight('...')
-    yield
-    message percent
-    @io.puts
+    @total = total
+    @level = level
+    @current = 0
+    start
   end
 
-  def self.step
+  def start # :nodoc:
+    self.message = '.' * 6
+  end
+
+  def step # :nodoc:
     @current += 1
-    if (@count += 1) >= @each
-      message highight(percent)
-      @count = 0
-    end
+    self.message = percent
   end
 
-private
+  def stop # :nodoc:
+    self.message = percent
+  end
 
-  def self.percent
-    '%5.1f%%' % (@current * 100.0 / @total)
+  def message # :nodoc:
+    @message
   end
-  
-  def self.message(s)
-    @io.print "\r\e[0K#{@name % s}"
+
+protected
+
+  def self.print_message
+    message = levels.map{ |level| level.message } * ' > '
+    @io ||= $stdout
+    @io.sync = true
+    @io.print "\r" + message.ljust(@previous_length || 0).gsub(/\d+\.\d+/){ |s| s == '100.0' ? s : "\e[1m#{s}\e[0m" }
+    @previous_length = message.length
+  end
+
+  def self.levels
+    @levels ||= []
+  end
+
+  def percent
+    '%5.1f%%' % (@current * 100.0 / @total)
   end
 
-  def self.highight(s)
-    "\e[1m#{s}\e[0m"
+  def message=(s)
+    formatted = s.ljust(6)[0, 6]
+    @message = @name % formatted
   end
 end
 
-require 'enumerable'
-require 'integer'
+require 'progress/enumerable'
+require 'progress/integer'

data/script/console

@@ -0,0 +1,10 @@
+#!/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

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,14 @@
+#!/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)

data/spec/progress_spec.rb

@@ -0,0 +1,114 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Progress do
+  before :each do
+    @io = StringIO.new
+    Progress.io = @io
+  end
+  
+  def io_pop
+    @io.seek(0)
+    s = @io.read
+    @io.truncate(0)
+    @io.seek(0)
+    s
+  end
+
+  def verify_output_before_step(i)
+    io_pop.should =~ /#{Regexp.quote(i == 0 ? '......' : (i / 10.0).to_s)}/
+  end
+  def verify_output_after_stop
+    io_pop.should =~ /100\.0.*\n$/
+  end
+
+  it "should show valid output for procedural version" do
+    Progress.start('Test', 1000)
+    1000.times do |i|
+      verify_output_before_step(i)
+      Progress.step
+    end
+    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|
+        verify_output_before_step(i)
+        Progress.step
+      end
+    end
+    verify_output_after_stop
+  end
+
+  describe Enumerable do
+    before :each do
+      @a = Array.new(1000){ |n| n }
+    end
+
+    describe 'with each_with_progress' do
+      it "should not break each" do
+        c = 0
+        @a.each_with_progress('Test') do |n|
+          n.should == @a[c]
+          c += 1
+        end
+      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
+    end
+
+    describe 'with each_with_index_and_progress' do
+      it "should not break each_with_index" do
+        c = 0
+        @a.each_with_index_and_progress('Test') do |n, i|
+          n.should == @a[c]
+          i.should == @a[c]
+          c += 1
+        end
+      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
+    end
+  end
+
+  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
+        end
+      end
+
+      it "should show valid output for each_with_progress" do
+        1000.times_with_progress('Test') do |i|
+          verify_output_before_step(i)
+        end
+        verify_output_after_stop
+      end
+    end
+  end
+
+  it "should allow enclosed progress" do
+    10.times_with_progress('A') do |a|
+      io_pop.should =~ /#{Regexp.quote(a == 0 ? '......' : (a * 10.0).to_s)}/
+      10.times_with_progress('B') do |b|
+        io_pop.should =~ /#{Regexp.quote(a == 0 ? '......' : (a * 10.0).to_s)}.*#{Regexp.quote(b == 0 ? '......' : (b * 10.0).to_s)}/
+      end
+      io_pop.should =~ /#{Regexp.quote(a == 0 ? '......' : (a * 10.0).to_s)}.*100\.0/
+    end
+    io_pop.should =~ /100\.0.*\n$/
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'progress'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -1,41 +1,69 @@
 --- !ruby/object:Gem::Specification 
 name: progress
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors: 
 - toy
-autorequire: progress
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-08-11 00:00:00 +04:00
+date: 2008-11-01 00:00:00 +03:00
 default_executable: 
-dependencies: []
-
-description: Class to show progress during script run
-email: ivan@workisfun.ru
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Class to show progress during console script run
+email: 
+- email
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
-- LICENSE
-- TODO
+- History.txt
+- Manifest.txt
+- README.rdoc
 files: 
-- LICENSE
-- README
+- History.txt
+- Manifest.txt
+- README.rdoc
 - Rakefile
-- TODO
-- lib/enumerable.rb
-- lib/integer.rb
 - lib/progress.rb
+- lib/progress/enumerable.rb
+- lib/progress/integer.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/progress_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
 has_rdoc: true
-homepage: ""
+homepage: http://github.com/toy/progress/tree/master
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -52,10 +80,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: progress
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Class to show progress during script run
+summary: Class to show progress during console script run
 test_files: []
 

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2008 YOUR NAME
-
-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

@@ -1,4 +0,0 @@
-progress
-========
-
-Class to show progress during script run

data/TODO

@@ -1 +0,0 @@
-TODO:

data/lib/enumerable.rb

@@ -1,10 +0,0 @@
-module Enumerable
-  def each_with_progress(name)
-    Progress.start(name, length) do
-      each do |item|
-        yield item
-        Progress.step
-      end
-    end
-  end
-end