progress 0.0.7.1 → 0.0.8

data/lib/progress.rb

@@ -4,7 +4,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'singleton'
 
 class Progress
-  VERSION = '0.0.7.1'
+  VERSION = '0.0.8'
 
   include Singleton
 
@@ -29,8 +29,12 @@ class Progress
   #       sleep(0.001)
   #     end
   #   end
-  def self.start(name, total = 1)
-    levels << new(name, total, levels.length)
+  # ==== To output progress as lines (not trying to stay on line)
+  #   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)
     print_message
     if block_given?
       result = yield
@@ -39,24 +43,11 @@ class Progress
     end
   end
 
-  def self.step(steps = 1)
-    levels[-1].step(steps)
-    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:
+  def initialize(name, total, level, options) # :nodoc:
     @name = name + ': %s'
     @total = total
     @level = level
+    @options = options
     @current = 0
     start
   end
@@ -78,19 +69,11 @@ class Progress
     @message
   end
 
-protected
-
-  def self.print_message
-    message = levels.map{ |level| level.message } * ' > '
-    @io ||= $stderr
-    @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
+  def options # :nodoc:
+    @options
   end
 
-  def self.levels
-    @levels ||= []
-  end
+protected
 
   def percent
     '%5.1f%%' % (@current * 100.0 / @total)
@@ -100,6 +83,41 @@ protected
     formatted = s.ljust(6)[0, 6]
     @message = @name % formatted
   end
+
+  module ClassMethods
+    def step(steps = 1)
+      levels[-1].step(steps)
+      print_message
+    end
+
+    def stop
+      levels.pop.stop
+      @io.puts if levels.empty?
+    end
+
+    def io=(io) # :nodoc:
+      @io = io
+    end
+
+  protected
+
+    def print_message
+      message = levels.map{ |level| level.message } * ' > '
+      @io ||= $stderr
+      @io.sync = true
+      if @io.tty? && !levels.any?{ |level| level.options[:lines] }
+        @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
+      else
+        @io.puts message
+      end
+    end
+
+    def levels
+      @levels ||= []
+    end
+  end
+  extend ClassMethods
 end
 
 require 'progress/enumerable'

data/lib/progress/enumerable.rb

@@ -4,8 +4,8 @@ module Enumerable
   #   [1, 2, 3].each_with_progress('Numbers') do |number|
   #     sleep(number)
   #   end
-  def each_with_progress(name)
-    Progress.start(name, length) do
+  def each_with_progress(name, options = {})
+    Progress.start(name, length, options) do
       each do |item|
         yield item
         Progress.step
@@ -18,8 +18,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)
-    Progress.start(name, length) do
+  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

data/lib/progress/integer.rb

@@ -4,8 +4,8 @@ class Integer
   #   100.times_with_progress('Numbers') do |number|
   #     sleep(number)
   #   end
-  def times_with_progress(name)
-    Progress.start(name, self) do
+  def times_with_progress(name, options = {})
+    Progress.start(name, self, options) do
       times do |i|
         yield i
         Progress.step

data/progress.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{progress}
-  s.version = "0.0.7.1"
+  s.version = "0.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["toy"]
-  s.date = %q{2009-04-24}
+  s.date = %q{2009-04-27}
   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"]

data/tasks/rspec.rake

@@ -14,7 +14,7 @@ EOS
   exit(0)
 end
 
-desc "Run the specs under spec/models"
+desc "Run the specs"
 Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ['--options', "spec/spec.opts"]
   t.spec_files = FileList['spec/**/*_spec.rb']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: progress
 version: !ruby/object:Gem::Version 
-  version: 0.0.7.1
+  version: 0.0.8
 platform: ruby
 authors: 
 - toy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-24 00:00:00 +04:00
+date: 2009-04-27 00:00:00 +04:00
 default_executable: 
 dependencies: []