ke 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fbfaca5a83423f479bc2a76e0b7903397b5fdd0
+  data.tar.gz: eff7b260a09a7ae6c2c5e4d7c8d58ac37843c1be
+SHA512:
+  metadata.gz: 9bb0ebe5335d9f3b31c2a21aa71bfb7c4e67c65f102a76d5be0818e84fd25b904902f6a32b4e035adefb7f9060dc02b04214daad3356713ad857c1b383da3d9b
+  data.tar.gz: c5718d042ff068d8dd43520ab670d6b5478ed91aab5934c47cd44dc7696cd882c4573d1374c6c804d0450a1e6cefd50bff77707d1142ee713b5a1edda5cd768d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mark Dodwell
+
+MIT License
+
+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,67 @@
+# Ke [![Build Status](https://travis-ci.org/mkdynamic/ke.png)](https://travis-ci.org/mkdynamic/ke)
+
+Measure progress of Ruby code with the ability to provide estimates for time until completion.
+
+Supports tasks with a known (determinate) and unknown (indeterminate) number of iterations. For indeterminate tasks it's only possible to provide a rate. For determinate tasks it's possible to provide both a rate and an estimated remaining time.
+
+## Usage
+
+Install them gem with `gem install ke`. If you're using Bundler then add it to your Gemfile with `gem ke` and run `bundle install`. Usage examples below:
+
+### Example 1: An indeterminate task with a multi line reporting output
+
+```ruby
+require 'ke'
+
+task = Ke::IndeterminateTask.new
+reporter = Ke::MultiLineReporter.new(task, "indeterminate task")
+task.start
+reporter.print_start
+loop do
+  break if rand(200) == 50
+  sleep 0.1
+  task.tick
+  reporter.print_tick if task.tick_count % 10 == 0
+end
+task.complete
+reporter.print_complete
+```
+
+### Example 2: A determinate task with a single line reporting output
+
+```ruby
+require 'ke'
+
+task = Ke::DeterminateTask.new(total_ticks: 50)
+reporter = Ke::SingleLineReporter.new(task, "determinate task")
+task.start
+reporter.print_start
+50.times do
+  sleep 0.1
+  task.tick
+  reporter.print_tick if task.tick_count % 10 == 0
+end
+task.complete
+reporter.print_complete
+```
+
+## Custom reporters
+
+You can add your own reporters as needed. Scope the existing reporters to learn the interface.
+
+## TODO
+
+- Provide some syntactic sugar for the API, it's a bit rough at present
+- Provide some pleasant looking default reporters (the current 2 work, but are ugly)
+- Add some real tests
+- Add more Ruby versions to Travis CI (anything 1.9+ compat should work)
+- Measure the performanc impact
+- Use other averages than SMA. WMA, EMA etc.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.libs << 'test'
+  task.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/ke.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ke/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ke"
+  spec.version       = Ke::VERSION
+  spec.authors       = ["Mark Dodwell"]
+  spec.email         = ["mark@madeofcode.com"]
+  spec.description   = "Measure progress of Ruby code."
+  spec.summary       = "Measure progress of Ruby code."
+  spec.homepage      = "https://github.com/mkdynamic/ke"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/ke.rb

@@ -0,0 +1,6 @@
+require 'ke/version'
+require 'ke/capped_sample'
+require 'ke/indeterminate_task'
+require 'ke/determinate_task'
+require 'ke/reporters/single_line_reporter'
+require 'ke/reporters/multi_line_reporter'

data/lib/ke/capped_sample.rb

@@ -0,0 +1,36 @@
+module Ke
+  class CappedSample
+    def initialize(limit)
+      @array = []
+      @limit = limit
+    end
+
+    def push(element)
+      @array << element
+      @array.shift if @array.size > @limit
+      self
+    end
+    alias :<< :push
+
+    def size
+      @array.size
+    end
+
+    def to_a
+      @array.dup
+    end
+    alias :to_ary :to_a
+
+    def mean
+      if @array.size > 0
+        @array.inject(:+) / @array.size.to_f
+      else
+        0
+      end
+    end
+
+    def to_s
+      "#<CappedSample: #{@array.inspect}>"
+    end
+  end
+end

data/lib/ke/determinate_task.rb

@@ -0,0 +1,13 @@
+module Ke
+  class DeterminateTask < IndeterminateTask
+    def initialize(opts = {})
+      super
+      @total_ticks = opts[:total_ticks]
+    end
+
+    def estimated_duration_until_complete
+      ticks_remaining = [@total_ticks - @tick_count, 0].max
+      ticks_remaining * duration_per_tick
+    end
+  end
+end

data/lib/ke/indeterminate_task.rb

@@ -0,0 +1,46 @@
+module Ke
+  class IndeterminateTask
+    attr_reader :tick_count, :complete_time
+
+    def initialize(opts = {})
+      @tick_count = 0
+      @duration_per_tick = 0
+      @duration_per_tick_history = CappedSample.new(100)
+      @mutex = Mutex.new
+    end
+
+    def start_time
+      @start_time
+    end
+
+    def elapsed_duration
+      Time.now - @start_time
+    end
+
+    def total_duration
+      @complete_time - @start_time
+    end
+
+    def start
+      @start_time = Time.now
+    end
+
+    def duration_per_tick
+      @duration_per_tick_history.mean
+    end
+
+    def tick
+      @mutex.synchronize do
+        this_tick_time = Time.now
+        duration_this_tick = this_tick_time - (@last_tick_time || start_time)
+        @duration_per_tick_history << duration_this_tick
+        @last_tick_time = this_tick_time
+        @tick_count += 1
+      end
+    end
+
+    def complete
+      @complete_time = Time.now
+    end
+  end
+end

data/lib/ke/reporters/multi_line_reporter.rb

@@ -0,0 +1,29 @@
+module Ke
+  class MultiLineReporter
+    def initialize(task, label, io = STDOUT)
+      @task = task
+      @label = label
+      @io = io
+    end
+
+    def print_start
+      @io.puts "Starting #{@label}"
+    end
+
+    def print_tick
+      ticks_per_second = (1 / @task.duration_per_tick).round(2)
+      elapsed_time = (@task.elapsed_duration / 60.0).round(2)
+
+      if @task.respond_to?(:estimated_duration_until_complete)
+        estimated_duration_until_complete = (@task.estimated_duration_until_complete / 60.0).round(2)
+        @io.puts "Running #{@label}, #{elapsed_time} minutes elapsed, #{estimated_duration_until_complete} minutes remaining"
+      else
+        @io.puts "Running #{@label}, #{elapsed_time} minutes elapsed, #{ticks_per_second} ticks/second"
+      end
+    end
+
+    def print_complete
+      @io.puts "Completed #{@label}, #{@task.total_duration} total duration"
+    end
+  end
+end

data/lib/ke/reporters/single_line_reporter.rb

@@ -0,0 +1,29 @@
+module Ke
+  class SingleLineReporter
+    def initialize(task, label, io = STDOUT)
+      @task = task
+      @label = label
+      @io = io
+    end
+
+    def print_start
+      @io.print "Starting #{@label}"
+    end
+
+    def print_tick
+      ticks_per_second = (1 / @task.duration_per_tick).round(2)
+      elapsed_time = (@task.elapsed_duration / 60.0).round(2)
+
+      if @task.respond_to?(:estimated_duration_until_complete)
+        estimated_duration_until_complete = (@task.estimated_duration_until_complete / 60.0).round(2)
+        @io.print "{#{elapsed_time}/#{estimated_duration_until_complete} mins}"
+      else
+        @io.print "{#{elapsed_time} mins, #{ticks_per_second} ticks/sec}"
+      end
+    end
+
+    def print_complete
+      @io.puts "complete."
+    end
+  end
+end

data/lib/ke/version.rb

@@ -0,0 +1,3 @@
+module Ke
+  VERSION = "0.0.1"
+end

data/test/ke_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+task = Ke::IndeterminateTask.new
+reporter = Ke::MultiLineReporter.new(task, "indeterminate task")
+task.start
+reporter.print_start
+loop do
+  break if rand(200) == 50
+  sleep 0.1
+  task.tick
+  reporter.print_tick if task.tick_count % 10 == 0
+end
+task.complete
+reporter.print_complete
+
+task = Ke::DeterminateTask.new(total_ticks: 50)
+reporter = Ke::SingleLineReporter.new(task, "determinate task")
+task.start
+reporter.print_start
+50.times do
+  sleep 0.1
+  task.tick
+  reporter.print_tick if task.tick_count % 10 == 0
+end
+task.complete
+reporter.print_complete

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'ke'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: ke
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Dodwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Measure progress of Ruby code.
+email:
+- mark@madeofcode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ke.gemspec
+- lib/ke.rb
+- lib/ke/capped_sample.rb
+- lib/ke/determinate_task.rb
+- lib/ke/indeterminate_task.rb
+- lib/ke/reporters/multi_line_reporter.rb
+- lib/ke/reporters/single_line_reporter.rb
+- lib/ke/version.rb
+- test/ke_test.rb
+- test/test_helper.rb
+homepage: https://github.com/mkdynamic/ke
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Measure progress of Ruby code.
+test_files:
+- test/ke_test.rb
+- test/test_helper.rb