progress-monitor 1.8.9

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Miguel Vazquez
+
+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.rdoc

@@ -0,0 +1,18 @@
+= progress-monitor
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Miguel Vazquez. See LICENSE for details.

data/lib/progress-monitor.rb

@@ -0,0 +1,227 @@
+# 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
+  
+  @@progress_meters = Array.new
+  def self.progress_meters
+    @@progress_meters
+  end
+
+  @@monitor = false
+  @@desc = ""
+  @@skip = 0
+
+  # 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 self.monitor(desc = "", num_reports = 100, skip = 0)
+    @@monitor = true
+    @@desc = desc
+    @@num_reports=num_reports
+    @@skip = skip
+  end
+
+  # Returns true if next loop must be monitored.
+  #
+  def self.active?
+    if @@monitor
+      if @@skip > 0
+        @@skip -= 1
+        return false
+      else
+        return true
+      end
+    else
+      return false
+    end
+  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
+    @max = 1 if @max < 1
+    @current = 0
+    @time = Time.now
+    @last_report = 0
+    @num_reports = @@num_reports
+    @depth = depth
+    @desc = @@desc
+    @@monitor = false
+    report
+  end
+
+  # Used to register a new completed loop iteration.
+  #
+  def tick(steps = 1)
+    @current += steps
+    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
+
+  def set(step)
+    @current = step
+    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.001 if percent < 0.001
+    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 Integer
+  alias :orig_times :times
+
+  def times (&block)
+    if Progress.active?  then
+      progress_meters = Progress::progress_meters
+      progress_meters.push(Progress.new(self, progress_meters.size ))
+      orig_times {|w|block.call(w);progress_meters.last.tick;}
+      progress_meters.pop
+    else
+      orig_times &block
+    end
+  end
+end
+
+
+
+class Array
+  alias :orig_each :each
+
+  def each (&block)
+    if Progress.active?  then
+      progress_meters = Progress::progress_meters
+      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
+
+  alias :orig_collect :collect
+  def collect (&block)
+    if Progress.active?  then
+      progress_meters = Progress::progress_meters
+      progress_meters.push(Progress.new(self.length, progress_meters.size ))
+      res = orig_collect {|w| r = block.call(w);progress_meters.last.tick; r}
+      progress_meters.pop
+      res
+    else
+      orig_collect &block
+    end
+  end
+end
+
+
+
+class Hash
+  alias :orig_each :each
+  def each (&block)
+    if Progress.active?  then
+      progress_meters = Progress::progress_meters
+      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
+
+
+
+
+
+class File
+  alias :orig_each :each
+  alias :orig_collect :collect
+  def each (&block)
+    if Progress.active?  then
+      progress_meters = Progress::progress_meters
+      progress_meters.push(Progress.new(self.stat.size, progress_meters.size ))
+      orig_each {|l| block.call(l);progress_meters.last.set(self.pos);}
+      progress_meters.pop
+    else
+      orig_each &block
+    end
+  end
+
+  def collect (&block)
+    if Progress.active?  then
+      progress_meters = Progress::progress_meters
+      progress_meters.push(Progress.new(self.stat.size, progress_meters.size ))
+      res = orig_collect {|l| r = block.call(l);progress_meters.last.set(self.pos); r}
+      progress_meters.pop
+      res
+    else
+      orig_collect &block
+    end
+  end
+
+
+end
+
+
+

data/samples/collect.rb

@@ -0,0 +1,10 @@
+require File.join(File.dirname(File.dirname(__FILE__)), 'lib', 'progress-monitor')
+
+dc = ('a'..'z').to_a
+Progress.monitor
+uc = dc.collect{|l|
+  sleep(0.2)
+  l.upcase
+}
+p uc
+

data/samples/file.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(File.dirname(__FILE__)), 'lib', 'progress-monitor')
+
+f = File.open('README.rdoc')
+Progress.monitor("File.each")
+f.each{|l|
+  sleep(1)
+}

data/samples/hash-loop.rb

@@ -0,0 +1,17 @@
+# This is an example using a hash. It also shows what happens when you
+# print stuff. In this case, we print new lines, and the progress meter
+# is always moved to the line above the last one.
+
+require File.join(File.dirname(File.dirname(__FILE__)), 'lib', 'progress-monitor')
+
+h = Hash.new
+
+('a'..'z').to_a.each{|l|
+  h[l] = l.upcase
+}
+
+Progress.monitor("hash",50)
+h.each{|d,u|
+  puts "#{d} => #{u}, "
+  sleep(0.2)
+}

data/samples/skip.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(File.dirname(__FILE__)), 'lib', 'progress-monitor')
+
+# Skip first loop
+puts ""
+
+Progress.monitor("Main Loop",100, 1)
+
+puts "This loop must not be monitored"
+puts
+(1..100).to_a.each{ 
+  sleep 0.05
+}
+
+puts "This loop must be monitored"
+puts
+(1..100).to_a.each{ 
+    sleep 0.05
+}
+

data/samples/times.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(File.dirname(__FILE__)), 'lib', 'progress-monitor')
+
+Progress.monitor
+10.times{|i|
+  sleep 1
+}
+

data/samples/two-loops.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(File.dirname(__FILE__)), 'lib', 'progress-monitor')
+
+# 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,64 @@
+--- !ruby/object:Gem::Specification 
+name: progress-monitor
+version: !ruby/object:Gem::Version 
+  version: 1.8.9
+platform: ruby
+authors: 
+- Miguel Vazquez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-27 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Patches some each and collect functions of certain classes (Array, Hash, Integer) to report progress
+email: miguel.vazquez@fdi.ucm.es
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/progress-monitor.rb
+- samples/collect.rb
+- samples/file.rb
+- samples/hash-loop.rb
+- samples/skip.rb
+- samples/times.rb
+- samples/two-loops.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/mikisvaz/progress-monitor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Monitor Progress in the Command Line
+test_files: []
+