eta 0.0.1 → 0.0.2

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in eta.gemspec
 gemspec
+gem 'rake'
+gem 'minitest', '3.5.0'
+gem 'timecop'

data/README.md

@@ -18,7 +18,29 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+There are 2 ways to use Eta: around an `Eta::Process`, or with an
+`Eta::Estimator`.
+
+### Eta::Process
+
+TODO: Write usage instructions for `Eta::Process` here
+
+### Eta::Estimator
+
+If you have a task, and can calculate what percentage of the task you're
+finished with, you can use an `Eta::Estimator` to estimate how much time is
+left, and when the task will be done.
+
+Use it like this:
+
+	files_to_delete = Dir.glob('junk/*')
+	estimator = Eta::Estimator.new
+	estimator.start!
+	files_to_delete.each_with_index do |file, i|
+	  File.delete(file)
+	  estimator.percent_done = i.to_f / files_to_delete.size
+	  puts "Should be done in #{estimator.time_left} seconds, by #{estimator.eta}"
+	end
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end

data/lib/eta/estimator.rb

@@ -0,0 +1,29 @@
+module Eta
+  class Estimator
+    attr_accessor :percent_done
+
+    def start!
+      @start_time = current_time
+    end
+
+    def eta
+      Time.at(current_time.to_i + time_left)
+    end
+
+    def time_left
+      expected_duration - elapsed_time
+    end
+
+    def expected_duration
+      elapsed_time / percent_done
+    end
+
+    def elapsed_time
+      current_time - @start_time
+    end
+
+    def current_time
+      Time.now.to_i
+    end
+  end
+end

data/lib/eta/version.rb

@@ -1,3 +1,3 @@
 module Eta
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/eta/estimator_test.rb

@@ -0,0 +1,72 @@
+require 'minitest/autorun'
+require 'minitest/mock'
+require 'timecop'
+require 'eta/estimator'
+
+describe Eta::Estimator do
+  it 'should be able to stub #current_time' do
+    estimator = Eta::Estimator.new { 0 }
+    Timecop.freeze(Time.at(0))
+    estimator.current_time.must_equal 0
+  end
+
+  it 'can calculate #elapsed_time' do
+    Timecop.freeze(Time.at(0))
+    estimator = Eta::Estimator.new
+    estimator.start!
+    Timecop.freeze(Time.at(100))
+    estimator.elapsed_time.must_equal 100
+  end
+
+  it 'can calculate #expected_duration' do
+    Timecop.freeze(Time.at(0))
+    estimator = Eta::Estimator.new
+    estimator.start!
+
+    Timecop.freeze(Time.at(1000))
+
+    estimator.percent_done = 0.25
+    estimator.expected_duration.must_equal 4000
+    estimator.percent_done = 0.5
+    estimator.expected_duration.must_equal 2000
+    estimator.percent_done = 0.8
+    estimator.expected_duration.must_equal 1250
+
+    Timecop.freeze(Time.at(500))
+    estimator.expected_duration.must_equal 625
+  end
+
+  it 'can calculate #time_left' do
+    Timecop.freeze(Time.at(0))
+    estimator = Eta::Estimator.new
+    estimator.start!
+
+    Timecop.freeze(Time.at(1000))
+
+    estimator.percent_done = 0.25
+    estimator.time_left.must_equal 3000
+    estimator.percent_done = 0.5
+    estimator.time_left.must_equal 1000
+
+    Timecop.freeze(Time.at(3000))
+    estimator.percent_done = 0.75
+    estimator.time_left.must_equal 1000
+  end
+
+  it 'can calculate #eta' do
+    Timecop.freeze(Time.at(0))
+    estimator = Eta::Estimator.new
+    estimator.start!
+
+    Timecop.freeze(Time.at(500))
+
+    estimator.percent_done = 0.25
+    estimator.eta.must_equal Time.at(2000)
+    estimator.percent_done = 0.5
+    estimator.eta.must_equal Time.at(1000)
+
+    Timecop.freeze(Time.at(3000))
+    estimator.percent_done = 0.75
+    estimator.eta.must_equal Time.at(4000)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eta
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-16 00:00:00.000000000 Z
+date: 2013-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -41,7 +41,9 @@ files:
 - Rakefile
 - eta.gemspec
 - lib/eta.rb
+- lib/eta/estimator.rb
 - lib/eta/version.rb
+- test/eta/estimator_test.rb
 - test/functional.rb
 homepage: ''
 licenses: []
@@ -63,9 +65,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: ''
 test_files:
+- test/eta/estimator_test.rb
 - test/functional.rb
+has_rdoc: