progress-monitor 1.9.0 → 2.0.0

data/README.rdoc

@@ -1,6 +1,11 @@
 = progress-monitor
 
-Description goes here.
+Un-obtrusive progress monitor for the command line. Patch each, collect and
+times methods from different classes to produce loop progress reports. You may
+monitor loops that are close by, or set up monitoring for loops down the call
+stack so you do not need to modify the target class.
+
+See the samples directory for example scripts
 
 == Note on Patches/Pull Requests
  

data/lib/progress-monitor.rb

@@ -10,238 +10,297 @@
 # 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
-
-  def self.caller_info(callers, depth = 0)
-    return [nil, nil] if callers.length <= depth
-
-    line = callers[depth]
-    if line.match(/(.*):\d+(?::in `(.*)')/)
-      return [$1, $2]
-    end
-
-    if line.match(/(.*):\d+/)
-      return [$1, nil ]
-    end
-
-    info
-  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, stack_depth = nil, skip = 0)
-    @@monitor = true
-    @@desc = desc
-    @@num_reports=num_reports
-    @@call_info = caller_info(caller)
-    @@stack_depth = stack_depth 
-    @@skip = skip
-  end
-
-  # Returns true if next loop must be monitored.
-  #
-  def self.active?
-
-    return false unless @@monitor
-
-    if @@stack_depth != nil
-      call_info = caller_info(caller, @@stack_depth + 1)
-      return false if call_info != @@call_info
-    end
-
-    if @@skip > 0
-      @@skip -= 1
-      return false
-    else
-      return true
-    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
-
 
+   module Progress::MonitorableProgress
+
+     def monitorable1(method_name)
+       module_eval{ 
+         orig_name =  ('orig_' + method_name.to_s).to_sym
+         
+         eval "alias #{ orig_name } #{ method_name }"
+
+         define_method(method_name) do |&block|
+           if Progress.active?
+             progress_meter = Progress.add_progress_meter(self.monitor_size) if Progress.monitor?
+             announcement   = Progress.get_announcement                      if Progress.announce?
+
+             monitor_step = nil unless defined? monitor_step
+
+             res = self.send(orig_name.to_sym) {|v| 
+               progress_meter.tick(monitor_step) if progress_meter 
+               puts announcement.call(v)         if announcement
+               block.call(v) 
+             }
+             
+             Progress.remove_last_meter
+             res
+           else
+             self.send(orig_name.to_sym) {|v| block.call(v)}
+           end
+         
+         end
+       }
+     end
+
+     def monitorable2(method_name)
+       module_eval{ 
+         orig_name =  ('orig_' + method_name.to_s).to_sym
+         
+         eval "alias #{ orig_name } #{ method_name }"
+         
+         define_method(method_name) do |&block|
+           if Progress.active?
+             progress_meter = Progress.add_progress_meter(self.monitor_size) if Progress.monitor?
+             announcement   = Progress.get_announcement                      if Progress.announce?
+             
+             monitor_step = nil unless defined? monitor_step
+
+             res = self.send(orig_name.to_sym) {|v1,v2| 
+               progress_meter.tick(monitor_step) if progress_meter 
+               puts announcement.call(v1,v2)     if announcement
+               block.call(v1,v2);
+             }
+             
+             Progress.remove_last_meter
+             res
+           else
+             self.send(orig_name.to_sym) {|v1,v2| block.call(v1,v2) }
+           end
+         
+         end
+       }
+     end
+   end
+
+
+   @@progress_meters = Array.new
+   def self.progress_meters
+     @@progress_meters
+   end
+   
+   def self.caller_info(callers, depth = 0)
+     return [nil, nil] if callers.length <= depth
+
+     line = callers[depth]
+     if line.match(/(.*):\d+(?::in `(.*)')/)
+       return [$1, $2]
+     end
+
+     if line.match(/(.*):\d+/)
+       return [$1, nil ]
+     end
+
+     info
+   end
+
+   @@monitor  = false
+   @@announce = false
+
+   def self.process_options(options)
+     @@stack_depth = options[:stack_depth] 
+     @@skip        = options[:skip] || 0
+
+     if options[:announcement]
+       @@announce     = true
+       @@announcement = options[:announcement]
+     end
+   end
+
+   # 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 = "", options = {})
+     @@monitor     = true
+     @@desc        = desc
+     @@num_reports = options[:num_reports] || 100
+     @@call_info   = caller_info(caller)
+     process_options(options)
+   end
+
+   def self.announce(announcement, options = {})
+     @@announce     = true
+     @@call_info   = caller_info(caller)
+     @@announcement = announcement
+     process_options(options)
+   end
+
+   def self.get_announcement
+     @@announce    = false
+     @@announcement
+   end
+
+   def self.this_loop?
+     if @@stack_depth != nil
+       call_info = caller_info(caller, @@stack_depth + 2)
+       return false if call_info != @@call_info
+     end
+
+     if @@skip > 0
+       @@skip -= 1
+       return false
+     else
+       return true
+     end
+   end
+
+   # Returns true if next loop must be monitored.
+   #
+   def self.monitor?
+     return @@monitor
+   end
+
+   def self.announce?
+     return @@announce
+   end
+
+   def self.active?
+     return (monitor? || announce?) && this_loop?
+   end
+
+   def self.add_progress_meter(max)
+     progress_meter = self.new(max, progress_meters.size)
+
+     progress_meters.push(progress_meter)
+
+     progress_meter
+   end
+
+   def self.remove_last_meter
+     progress_meters.pop
+   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 = -1
+     @num_reports = @@num_reports
+     @depth = depth
+     @desc = @@desc
+     @@monitor = false
+   end
+
+   # Used to register a new completed loop iteration.
+   #
+   def tick(step = nil)
+
+     if step.nil?
+       @current += 1
+     else
+       @current = step
+     end
+
+     percent = @current.to_f/ @max.to_f
+     if percent - @last_report > 1.to_f/@num_reports.to_f 
+       report
+       @last_report=percent
+     end
+
+     nil
+   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
+  class << self
+    include Progress::MonitorableProgress
   end
-end
 
+  def monitor_size
+    self
+  end
 
+  self.monitorable1(:times)
+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
+  class << self
+    include Progress::MonitorableProgress
   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
+  def monitor_size
+    self.length
   end
+
+  self.monitorable1(:each)
+  self.monitorable1(:collect)
 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
+  class << self
+    include Progress::MonitorableProgress
   end
 
-end
-
-
-
+  def monitor_size
+    self.length
+  end
 
+  self.monitorable2(:each)
+  self.monitorable2(:collect)
+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
+  class << self
+    include Progress::MonitorableProgress
   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
+  def monitor_size
+    self.stat.size
   end
 
+  def monitor_step
+    self.pos
+  end
 
+  self.monitorable1(:each)
+  self.monitorable1(:collect)
 end
 
 

data/samples/announce.rb

@@ -0,0 +1,16 @@
+# 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.expand_path(__FILE__))), 'lib', 'progress-monitor')
+
+h = Hash.new
+
+('a'..'z').to_a.each{|l|
+  h[l] = l.upcase
+}
+
+Progress.announce(Proc.new {|d,u| "Downcase #{d}, uppercase #{u}"} )
+h.each{|d,u|
+  sleep(0.2)
+}

data/samples/announce_monitor.rb

@@ -0,0 +1,16 @@
+# 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.expand_path(__FILE__))), 'lib', 'progress-monitor')
+
+h = Hash.new
+
+('a'..'z').to_a.each{|l|
+  h[l] = l.upcase
+}
+
+Progress.monitor("hash",:num_reports => 5, :announcement => Proc.new {|d,u| "Downcase #{d}, uppercase #{u}" } )
+h.each{|d,u|
+  sleep(0.2)
+}

data/samples/depth.rb

@@ -16,7 +16,7 @@ def self.loop2
 
 end
 
-Progress.monitor("Message", 100, 1)
+Progress.monitor("Message", :stack_depth => 1)
 puts "not monitored"
 100.times { 
   sleep 0.01 

data/samples/skip.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'lib',
 # Skip first loop
 puts ""
 
-Progress.monitor("Main Loop",100, 1)
+Progress.monitor("Main Loop", :skip => 1)
 
 puts "This loop must not be monitored"
 puts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: progress-monitor
 version: !ruby/object:Gem::Version 
-  version: 1.9.0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Miguel Vazquez
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-01 00:00:00 +01:00
+date: 2010-02-03 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -24,6 +24,8 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - lib/progress-monitor.rb
+- samples/announce.rb
+- samples/announce_monitor.rb
 - samples/collect.rb
 - samples/depth.rb
 - samples/file.rb