progress-meter 0.0.1

data/README

@@ -0,0 +1,50 @@
+= Progress Meter
+
+This program allows monitoring of loop. Only Array.each and Hash.each are
+supported right now, each type of loop must be supported separately.
+
+To use it, just require 'progress-meter'. This will hook all supported loop
+functions with the monitoring code. To actually activate the monitoring call
+Progress.monitor, this will activate monitoring of the next loop that is of a
+_supported_ type.
+
+See samples/ directory for an example.
+
+== CAVEATS
+
+Progress meters are printed in successive lines above the current one.
+So they might erase what was written before. The cursor does not really
+return to the original position after printing the reports, just to the
+original line.
+
+
+== BUGS
+
+Please report bugs to mikisvaz at yahoo com. 
+
+== LICENSE
+
+
+(The MIT License)
+
+Copyright (c) 2007 Miguel Vazquez Garcia
+
+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/lib/progress-meter.rb

@@ -0,0 +1,137 @@
+# Allow the possibility of monitoring the progress of some loop.
+# Currently only Array.each and Hash.each are supported, but this should
+# be easy to extend.
+#
+# Author:: Miguel Vazquez Garcia
+# License:: MIT
+# 
+
+# Tracks the progress of a loop. It holds information about how many
+# iterations it has to go through and how many have been executed
+# already. Every now and then, it prints the progress report.
+class Progress
+  
+  @@monitor = false
+  @@desc = ""
+
+  # This function will activate monitoring of the next _supported_ loop.
+  #
+  # If a description is given as a parameter it will show at the
+  # beginning of the progress report.
+  def Progress.monitor(desc = "")
+    @@monitor = true
+    @@desc = desc
+  end
+
+  # Returns true if next loop must be monitored.
+  #
+  def Progress.active?
+    @@monitor 
+  end
+
+
+  # Creates a new instance. Max is the total number of iterations of the
+  # loop. The depth represents how many other loops are above this one,
+  # this information is used to find the place to print the progress
+  # report.
+  #
+  def initialize(max,depth)
+    @max = max
+    @current = 1
+    @time = Time.now
+    @last_report = 0
+    @num_reports = 100
+    @depth = depth
+    @desc = @@desc
+    @@monitor = false
+    report
+  end
+
+  # Used to register a new completed loop iteration.
+  #
+  def tick
+    @current += 1
+    percent = @current.to_f/ @max.to_f
+    if percent - @last_report > 1.to_f/@num_reports.to_f then
+      report
+      @last_report=percent
+    end
+  end
+
+  # Prints de progress report. It backs up as many lines as the meters
+  # depth. Prints the progress as a line of dots, a percentage, time
+  # spent, and time left. And then goes moves the cursor back to its
+  # original line. Everything is printed to stderr.
+  #
+  def report
+  
+    percent = @current.to_f/ @max.to_f
+    percent = 0.000001 if percent == 0
+    if @desc != ""
+      indicator = @desc + ": "
+    else
+      indicator = "Progress "
+    end
+    indicator += "["
+    10.times{|i|
+      if i < percent * 10 then
+        indicator += "."
+      else
+        indicator += " "
+      end
+    }
+    indicator += "]   done #{(percent * 100).to_i}% "
+    
+    eta =  (Time.now - @time)/percent * (1-percent)
+    eta = eta.to_i
+    eta = [eta/3600, eta/60 % 60, eta % 60].map{|t| t.to_s.rjust(2, '0')}.join(':')
+
+    used = (Time.now - @time).to_i
+    used = [used/3600, used/60 % 60, used % 60].map{|t| t.to_s.rjust(2, '0')}.join(':')
+
+
+
+    indicator += " (Time left #{eta} seconds) (Started #{used} seconds ago)"
+
+    $stderr.print("\033[#{@depth + 1}F\033[2K" + indicator + "\033[#{@depth + 1}E"  )
+
+  end
+
+
+end
+
+
+
+class Array
+  @@progress_meters = Array.new
+  alias :orig_each :each
+
+  def each (&block)
+    if Progress.active?  then
+      @@progress_meters.push(Progress.new(self.length, @@progress_meters.size ))
+      orig_each {|w|block.call(w);@@progress_meters.last.tick;}
+      @@progress_meters.pop
+    else
+      orig_each &block
+    end
+  end
+
+end
+
+
+
+class Hash
+  @@progress_meters = Array.new
+  alias :orig_each :each
+  def each (&block)
+    if Progress.active?  then
+      $stderr.print "\n"
+      @@progress_meters.push(Progress.new(self.length, @@progress_meters.size ))
+      orig_each {|k,v|block.call(k,v);@@progress_meters.last.tick;}
+      @@progress_meters.pop
+    else
+      orig_each &block
+    end
+  end
+
+end

data/samples/two-loops.rb

@@ -0,0 +1,14 @@
+require 'progress-meter'
+
+# Each progress meter backs up one line
+puts ""
+puts ""
+
+Progress.monitor("Main Loop")
+(1..100).to_a.each{ 
+  Progress.monitor
+  (1..100).to_a.each{ 
+    sleep 0.05
+  }
+}
+

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: progress-meter
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-12-05 00:00:00 +01:00
+summary: Allows to monitor the progress of some loop. Currently only Array.each and Hash.each
+require_paths: 
+- lib
+email: mikisvaz@yahoo.com
+homepage: 
+rubyforge_project: 
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Miguel Vazquez
+files: 
+- lib/progress-meter.rb
+- samples/two-loops.rb
+- README
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+