console_progress 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c71df20be61e4883f8b00664151b2aff535caa89
+  data.tar.gz: d6e06f27d1fccf73dc9f3977845fae49bf822801
+SHA512:
+  metadata.gz: 778670e005b3152761f97459942c9e9ad8c55ace597d52794a98433eb2ac115f6fbe36089cb3196cd1cab499477e69919146f087411fabdd7938a890b752e322
+  data.tar.gz: b4a3b1342d78688afa0a9d9f3a0596bd0a375a42e201b4c79f5c329d94d96bb1fe0d1d555ea377aa8febf9ee7e32c460ec231c5c7e71ecf3eb852aaea7ace6be

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/.ruby-version
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ben Wiseley
+
+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 @@
+# ConsoleProgress
+
+A simple gem to log progress on a job.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'console_progress'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install console_progress
+
+## Usage
+
+```ruby
+prog = ConsoleProgress::ETA.new(5)
+prog.start
+5.times do
+  puts prog.progress
+  sleep 2
+end
+```
+
+Would output something like:
+```
+ETA: 1/5 Time Left 0.00h or 0.00m Took: 0.00s Avg: 0.00s
+ETA: 2/5 Time Left 0.00h or 0.07m Took: 2.00s Avg: 1.00s
+ETA: 3/5 Time Left 0.00h or 0.07m Took: 2.00s Avg: 1.34s
+ETA: 4/5 Time Left 0.00h or 0.05m Took: 2.00s Avg: 1.50s
+ETA: 5/5 Time Left 0.00h or 0.03m Took: 2.00s Avg: 1.60s
+```
+
+Initialize with `number of steps`. Start it. Call `.progress` to move up a step.
+
+You can override the default message prefix with `prog.message_prefix = 'Bob'`
+
+You can override format by putting anything in `ConsoleProgress::ATTR` in a string with `{{}}` around it. Example:
+
+```ruby
+prog = ConsoleProgress.new(100, format: '{{step}}/{{steps}}'
+or
+set it later prog.format = '{{step}}/{{steps}}'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wiseleyb/console_progress.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "console_progress"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/console_progress.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'console_progress/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "console_progress"
+  spec.version       = ConsoleProgress::VERSION
+  spec.authors       = ["Ben Wiseley"]
+  spec.email         = ["wiseleyb@gmail.com"]
+
+  spec.summary       = 'Simple progress gem for use in logs/console'
+  spec.description   = 'Simple progress gem for use in logs/console'
+  spec.homepage      = 'https://github.com/wiseleyb/console_progress'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/console_progress.rb

@@ -0,0 +1,53 @@
+require "console_progress/version"
+
+module ConsoleProgress
+  class ETA
+    ATTR = [:steps, :step, :step_time, :times,
+            :avg_time, :format, :start_time,
+            :hours, :minutes, :seconds,
+            :message_prefix]
+
+    attr_accessor *ATTR
+
+    def initialize(steps, format: nil)
+      @steps = steps
+      @format = format
+      @message_prefix = 'ETA'
+      @format ||= "{{message_prefix}}: {{step}}/{{steps}} "\
+                  "Time Left {{hours}}h or {{minutes}}m "\
+                  "Took: {{step_time}}s Avg: {{avg_time}}s"
+      @step = 0
+      @times = []
+    end
+
+    def start
+      @start_time = Time.now
+      @step_time_start = @start_time
+    end
+
+    def progress(msg = nil, current_step: @step)
+      @message_prefix = msg if msg
+      t = Time.now
+      @step_time = t - @step_time_start
+      @times << @step_time
+      @avg_time = @times.reduce(0, :+) / @times.size
+      steps_left = @steps - @step
+      @step = current_step + 1
+      @seconds = steps_left * @avg_time
+      @minutes = '%.2f' % (@seconds / 60)
+      @hours = '%.2f' % (@seconds / 60 / 60)
+      @step_time = '%.2f' % @step_time
+      @avg_time = '%.2f' % @avg_time
+      @step_time_start = t
+      log
+    end
+
+    def log(msg = @message_prefix)
+      out = @format.dup
+      ATTR.each do |m|
+        out.gsub!("{{#{m}}}", send(m).to_s)
+      end
+      out
+    end
+  end
+end

data/lib/console_progress/version.rb

@@ -0,0 +1,3 @@
+module ConsoleProgress
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: console_progress
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Wiseley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Simple progress gem for use in logs/console
+email:
+- wiseleyb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- console_progress.gemspec
+- lib/console_progress.rb
+- lib/console_progress/version.rb
+homepage: https://github.com/wiseleyb/console_progress
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Simple progress gem for use in logs/console
+test_files: []