time_remaining 0.0.8

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in time_remaining.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 John McDowall
+
+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.md

@@ -0,0 +1,52 @@
+T I M E - R E M A I N I N G
+===========================
+
+Given a process that will take some amount of time, and we know how much we have done, 
+and how much is still to do, what is the time remaining for the process to reach completion?
+
+U S A G E
+-----------
+ 
+  require 'time_remaining'_
+
+	time_remaining = McDowall::TimeRemaining.new
+	tasks_done = 0.0
+	total_tasks = 20.0
+	tasks_remaining = total_tasks
+
+	def do_task
+	  sleep (1 + rand(2))
+	end
+
+	while( tasks_done < total_tasks ) do
+	  do_task( )						# Do whatever it is, transfer a byte, check a file etc.
+	  tasks_done+=1
+	  tasks_remaining-=1
+
+	  time_remaining.add ( (tasks_done/total_tasks).to_f )
+
+	  p Time.now.to_s + " | " + time_remaining.completed_at.to_s       	# Prints "2011-06-22 22:45:38 -0400"
+	  p time_remaining                                                  # Prints "03:01:00"
+	end
+	
+	
+R U N N I N G  T H E  T E S T  S U I T E
+----------------------------------------
+
+	rspec spec
+
+C O N T R I B U T I N G  to  T I M E - R E M A I N I N G
+--------------------------------------------------------
+
+* Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet
+* Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+C O P Y R I G H T
+-----------------
+
+Copyright © 2011 John McDowall. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/time_remaining.rb

@@ -0,0 +1,77 @@
+require "time_remaining/version"
+require 'rubygems'
+require 'algorithms'
+require 'time_diff'
+
+module McDowall 
+  class TimeRemaining
+  
+    def initialize( min_data=2, max_duration=2 )
+      @minimum_data  = min_data
+      @maximum_ticks = max_duration * 10
+      @queue = Containers::Queue.new
+      @start_time = Time.now
+    
+      @current = {}
+      @oldest  = {}
+    end
+  
+    def reset
+      @queue.clear
+      @start_time = nil
+    end
+  
+    def add progress
+      clear_expired
+      current_ticks = elapsed_ticks
+      @current = {:current_ticks => current_ticks,:progress=>progress}
+
+      @queue.push(@current);
+
+      if @queue.size == 1
+        @oldest = @current
+      end
+    end
+  
+    def completed_in
+      oldest  = @oldest;
+      current = @current;
+
+      if (@queue.size < @minimum_data || oldest[:progress] == current[:progress])
+        return 99999
+      end
+    
+      #puts "(1.0 - #{current[:progress].to_f}) * ((#{current[:current_ticks]} - #{oldest[:current_ticks]}) / (#{current[:progress]} - #{oldest[:progress]}))"
+
+      finishedInTicks = (1.0 - current[:progress].to_f) * ((current[:current_ticks] - oldest[:current_ticks]) / (current[:progress] - oldest[:progress]));
+      finishedInTicks
+    end
+  
+    def completed_at
+      Time.at(Time.now.to_i + completed_in)
+    end
+  
+    def time_remaining_available?
+      return (@queue.size >= @minimum_data && @oldestcurrent[:progress] != @currentcurrent[:progress]);
+    end
+  
+    def to_s
+      Time.diff( completed_at, Time.now-1 )[:diff]
+    end
+  
+    private
+    
+      def elapsed_ticks
+        (Time.now-@start_time).to_i
+      end
+    
+      def clear_expired
+        expired = elapsed_ticks - @maximum_ticks;
+
+        while (@queue.size > @minimum_data && @queue.next[:current_ticks] < expired) do
+          @oldest = @queue.pop
+        end
+      end
+     
+  end
+end 

data/lib/time_remaining/version.rb

@@ -0,0 +1,3 @@
+module TimeRemaining
+  VERSION = "0.0.8"
+end

data/spec/time_remaining_spec.rb

@@ -0,0 +1,20 @@
+require "./lib/time_remaining"
+
+describe "The Time Remaining class" do
+  
+  let(:time_remaining) { McDowall::TimeRemaining.new }
+  
+  describe "when no data has accumulated" do
+    it "should return 99999 as estimated finish time" do
+      time_remaining.completed_in.should == 99999
+    end
+
+    it "time_remaining_available? returns false" do
+      time_remaining.time_remaining_available?.should == false
+    end   
+  end
+  
+  describe "when data hase accumulated" do
+  end
+  
+end

data/time_remaining.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "time_remaining/version"
+
+Gem::Specification.new do |s|
+  s.name        = "time_remaining"
+  s.version     = TimeRemaining::VERSION
+  s.authors     = ["johnmcdowall"]
+  s.email       = ["john@mcdowall.info"]
+  s.homepage    = "https://github.com/johnmcdowall/time-remaining"
+  s.summary     = %q{Determine the time remaining to complete a list of tasks when the total number of tasks and the number of tasks completed are known.}
+  s.description = %q{This gem uses a moving average of previous task execution durations and how much work is still remaining to calculate how long it will take to finish the remaining tasks.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "algorithms"
+  s.add_dependency "time_diff"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: time_remaining
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+  prerelease: 
+platform: ruby
+authors:
+- johnmcdowall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: algorithms
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: time_diff
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem uses a moving average of previous task execution durations and
+  how much work is still remaining to calculate how long it will take to finish the
+  remaining tasks.
+email:
+- john@mcdowall.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/time_remaining.rb
+- lib/time_remaining/version.rb
+- spec/time_remaining_spec.rb
+- time_remaining.gemspec
+homepage: https://github.com/johnmcdowall/time-remaining
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Determine the time remaining to complete a list of tasks when the total number
+  of tasks and the number of tasks completed are known.
+test_files:
+- spec/time_remaining_spec.rb