averager 0.0.2 → 0.0.3

data/Manifest.txt

@@ -10,4 +10,5 @@ script/generate
 spec/averager_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
-tasks/rspec.rake
+spec/time_travel.rb
+tasks/rspec.rake

data/Rakefile

@@ -5,7 +5,7 @@ require 'fileutils'
 require './lib/averager'
 
 Hoe.plugin :newgem
-Hoe.plugin :website
+# Hoe.plugin :website
 # Hoe.plugin :cucumberfeatures
 
 # Generate all the Rake tasks

data/lib/averager.rb

@@ -2,37 +2,94 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 class Averager
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
   
   def initialize(options = {})
     @started = Time.now
     @every = options[:every] || 1000
-    if @expected_lines = options[:expected_lines]
-      @digits = @expected_lines.to_i.to_s.length
+    if @expected = options[:expected]
+      @digits = @expected.to_i.to_s.length
     end
     if options[:digits]
       @digits = options[:digits]
     else
       @digits ||= 7
     end
+    @log_path = options[:log_path]
     @stream = options[:stream] || STDOUT
+    flush_stream_for_progress
+    @progress_bar = options[:progress_bar] == true
+    @i = 0
+    if block_given?
+      yield(self)
+      self.finish
+    end
   end
-
-  def avg(i, status = nil)
-    if i > 0 && i % @every == 0
-      per_second = i / (Time.now - @started)
-      out = nil
-      if block_given?
-        out = yield(:digits => @digits, :i => i, :per_second => per_second, :status => status)
-      else
-        out = "%0#{@digits}d: %.1f" % [i, per_second]
-        out << ": #{status}" if status
+  
+  def flush_stream_for_progress
+    if @log_path
+      FileUtils.mkdir_p(File.dirname(@log_path))
+      @stream = File.open(@log_path, "w")
+    else
+      @stream.print "\r"
+    end
+  end
+  
+  def print_current?
+    @i % @every == 0
+  end
+  
+  def print_current(status = nil)
+    per_second = @i / (Time.now - @started)
+    out = nil
+    if block_given?
+      out = yield(:digits => @digits, :iteration => @i, :per_second => per_second, :status => status)
+    else
+      out = "%#{@digits}d" % @i
+      if @expected
+        out << "/#{@expected}" 
+        out << " %3.1f%" % (100 * (@i / @expected.to_f)) if @i <= @expected
       end
+      out << " (%.1f)" % per_second
+      out << ": #{status}" if status
+    end
+    if @progress_bar
+      flush_stream_for_progress
+      @stream.print out
+    else
       @stream.puts out
-      @stream.flush
+    end
+    @stream.flush
+  end
+
+  def avg(*args)
+    status = nil
+    i_or_status = args.shift
+    if args.any?
+      status = args.shift
+    end
+    if i_or_status.is_a?(Numeric)
+      @i = i_or_status
+    else
+      if i_or_status.is_a?(String)
+        status = i_or_status
+      end
+      @i += 1
+    end
+    if print_current?
+      print_current(status)
       true
     else
       false
     end
   end
+  
+  def finish
+    if !print_current?
+      print_current
+    end
+    @stream.puts "\n" if @progress_bar
+    @stream.puts "finished in #{Time.now - @started}"
+    @stream.close
+  end
 end

data/spec/averager_spec.rb

@@ -3,9 +3,80 @@ require File.dirname(__FILE__) + '/spec_helper.rb'
 # Time to add your specs!
 # http://rspec.info/
 describe "Place your specs here" do
+  before(:each) do
+    @log_path = File.expand_path(File.dirname("#{__FILE__}") + "/../tmp/status.log")
+    FileUtils.rm_f(@log_path)
+    TimeTravel.freeze_to Time.local(2009, 9, 9, 11, 20, 0)
+  end
+  
+  it "should log to a specific logfile" do
+    avg = Averager.new(:log_path => @log_path, :every => 1, :digits => 3)
+    TimeTravel.jump(1)
+    avg.avg(100, "test")
+    TimeTravel.jump(1)
+    avg.avg(300, "test")
+    File.read(@log_path).should == %(100 (100.0): test\n300 (150.0): test\n)
+  end
+  
+  it "should only log every x time" do
+    avg = Averager.new(:log_path => @log_path, :every => 600)
+    TimeTravel.jump(1)
+    avg.avg(100, "100")
+    TimeTravel.jump(1)
+    avg.avg(300, "300")
+    TimeTravel.jump(1)
+    avg.avg(600, "600")
+    avg.avg(601, "601")
+    File.read(@log_path).should == %(    600 (200.0): 600\n)
+  end
+  
+  it "should include a percentage and estimated end time" do
+    avg = Averager.new(:log_path => @log_path, :expected => 1000, :every => 250)
+    TimeTravel.jump(1)
+    avg.avg(500, "500")
+    TimeTravel.jump(1)
+    avg.avg(750, "750")
+    File.read(@log_path).should == %( 500/1000 50.0% (500.0): 500\n 750/1000 75.0% (375.0): 750\n)
+  end
+  
+  it "should print a progress when asked for" do
+    avg = Averager.new(:log_path => @log_path, :expected => 1000, :every => 250, :progress_bar => true)
+    TimeTravel.jump(1)
+    avg.avg(500, "500")
+    File.read(@log_path).should == %( 500/1000 50.0% (500.0): 500)
+    TimeTravel.jump(1)
+    avg.avg(750, "750")
+    File.read(@log_path).should == %( 750/1000 75.0% (375.0): 750)
+  end
   
-  it "find this spec in spec directory" do
-    # violated "Be sure to write your specs"
+  it "should not be mandatory to call with integer" do
+    avg = Averager.new(:log_path => @log_path, :expected => 2, :every => 1)
+    TimeTravel.jump(1)
+    avg.avg
+    TimeTravel.jump(1)
+    avg.avg
+    File.read(@log_path).should == %(1/2 50.0% (1.0)\n2/2 100.0% (1.0)\n)
   end
   
+  it "should be able to be called with a block" do
+    Averager.new(:log_path => @log_path, :expected => 2, :every => 1) do |avg|
+      TimeTravel.jump(1)
+      avg.avg
+      TimeTravel.jump(1)
+      avg.avg
+    end
+    File.read(@log_path).should == %(1/2 50.0% (1.0)\n2/2 100.0% (1.0)\nfinished in 2.0\n)
+  end
+  
+  it "should print the last status when finished before" do
+    Averager.new(:log_path => @log_path, :expected => 3, :every => 4) do |avg|
+      TimeTravel.jump(1)
+      avg.avg
+      TimeTravel.jump(1)
+      avg.avg
+      TimeTravel.jump(1)
+      avg.avg
+    end
+    File.read(@log_path).should == %(3/3 100.0% (1.0)\nfinished in 3.0\n)
+  end
 end

data/spec/spec_helper.rb

@@ -8,3 +8,4 @@ end
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'averager'
+require 'spec/time_travel'

data/spec/time_travel.rb

@@ -0,0 +1,29 @@
+module TimeTravel
+  @@offset = 0
+  
+  def self.now
+    if @@frozen_time
+      @@frozen_time + offset
+    else
+      Time.now_without_time_travel + offset
+    end
+  end
+  
+  def self.freeze_to(time)
+    @@frozen_time = time
+  end
+  
+  def self.jump(seconds)
+    @@offset = offset + seconds
+  end
+  
+  def self.offset
+    @@offset
+  end
+end
+
+
+class << Time
+  alias_method :now_without_time_travel, :now
+  def now; TimeTravel.now; end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: averager
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Tobias Schwab
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-02 00:00:00 +02:00
+date: 2010-08-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,6 +74,7 @@ files:
 - spec/averager_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/time_travel.rb
 - tasks/rspec.rake
 has_rdoc: true
 homepage: http://github.com/tobstarr/averager