duration_estimate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa1e5e72f8be0aeda87a2fca48d6bd5a7017bf53
+  data.tar.gz: 8030719f419e5d5287bac608cd5e21eb3a089c98
+SHA512:
+  metadata.gz: f6a65ccdc2835b58eabf6708e5319e20565b1f673fec740383594d61aad4fed6c5e3252d30a5155ecd5169bdc381a44ea1c2368d08c5f7f47cb31505fd69b51a
+  data.tar.gz: 889189139a5e5d690b508e4af4df06dcfb965861aad1c75f484febf46331b76e3a949184cc5a084d82e8ee677da62eaabf883aca69ddd06c05f512eddff6190a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper.rb

data/.rubocop-my.yml

@@ -0,0 +1,2 @@
+Metrics/MethodLength:
+  Max: 12

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop-my.yml

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+rvm:
+  - 2.2.2
+  - 1.9.3
+  - jruby-19mode
+
+branches:
+  only:
+    - master
+
+notifications:
+  email:
+    on_success: change
+    on_failure: always
+
+install: "bundle --jobs 4"
+script: "bundle exec rspec"

data/.yardopts

@@ -0,0 +1,7 @@
+--protected
+--private
+--embed-mixins
+lib/**/*.rb
+-
+README.md
+LICENSE.txt

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Oldrich Vetesnik
+
+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,87 @@
+# DurationEstimate
+
+Do something to a collection of items and see how long it is going to take.
+Useful for long-running Rake tasks.
+
+## Usage
+
+```ruby
+items = 0..10000 # Some data set.
+
+DurationEstimate.each(items) do |item, e|
+  print "\r#{ DurationEstimate::TerminalFormatter.format(e) }"
+
+  # Do something time consuming with item.
+  sleep 0.001
+end
+
+puts
+```
+
+You can specify the collection size if you are using some kind of ORM that
+does not respond to `:size` method.
+
+```ruby
+media = Media
+  .where { created_at > Time.parse('some time') }
+  .order(:created_at)
+
+File.open('missing-media.log', 'w') do |log|
+  DurationEstimate.each(media, size: media.count) do |medium, e|
+    print "\r#{ DurationEstimate::TerminalFormatter.format(e) }"
+
+    unless medium.on_s3?
+      log.puts medium.id
+      log.fsync # Write changes now, be able tail the file.
+    end
+
+    sleep 2 # Don't overload AWS S3
+  end
+end
+
+puts
+```
+
+This is going to re-print a line with something like this:
+
+     1/11 (  9.09 %) -, -
+     2/11 ( 18.18 %) 11:47:29, 00:00:34
+     3/11 ( 27.27 %) 11:47:30, 00:00:31
+     4/11 ( 36.36 %) 11:47:31, 00:00:27
+     5/11 ( 45.45 %) 11:47:31, 00:00:23
+     6/11 ( 54.55 %) 11:47:30, 00:00:19
+     7/11 ( 63.64 %) 11:47:30, 00:00:15
+     8/11 ( 72.73 %) 11:47:30, 00:00:11
+     9/11 ( 81.82 %) 11:47:30, 00:00:07
+    10/11 ( 90.91 %) 11:47:30, 00:00:03
+    11/11 (100.00 %) 11:47:30, 00:00:00
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'duration_estimate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install duration_estimate
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it (https://github.com/ollie/duration_estimate/fork)
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+task default: :combo
+
+desc 'Run tests, rubocop and generate documentation'
+task :combo do
+  sh 'bundle exec rspec'
+  sh('bundle exec rubocop') {} # ignore status > 0
+  sh 'bundle exec yardoc'
+end
+
+desc 'Same as :combo but build a gem, too'
+task mega_combo: :combo do
+  sh 'gem build duration_estimate.gemspec'
+end

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'duration_estimate'
+
+# 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.
+
+require 'pry'
+Pry.start

data/bin/setup

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

data/duration_estimate.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'duration_estimate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'duration_estimate'
+  spec.version       = DurationEstimate::VERSION
+  spec.authors       = ['Oldrich Vetesnik']
+  spec.email         = ['oldrich.vetesnik@gmail.com']
+
+  spec.summary       = 'Do something to a collection of items and see how ' \
+                       'long it is going to take. Useful for long-running ' \
+                       'Rake tasks.'
+  spec.homepage      = 'https://github.com/ollie/duration_estimate'
+  spec.license       = 'MIT'
+
+  # rubocop:disable Metrics/LineLength
+  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']
+
+  # System
+  spec.add_development_dependency 'bundler', '~> 1.9'
+
+  # Test
+  spec.add_development_dependency 'rspec',     '~> 3.2'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+
+  # Code style, debugging, docs
+  spec.add_development_dependency 'rubocop', '~> 0.31'
+  spec.add_development_dependency 'pry',     '~> 0.10'
+  spec.add_development_dependency 'yard',    '~> 0.8'
+  spec.add_development_dependency 'rake',    '~> 10.4'
+end

data/lib/duration_estimate/null_time.rb

@@ -0,0 +1,11 @@
+class DurationEstimate
+  # Null Object Pattern for nil time.
+  class NullTime
+    # Be able to call strftime on nil time.
+    #
+    # @return [String]
+    def strftime(*_args)
+      '-'
+    end
+  end
+end

data/lib/duration_estimate/sized_queue.rb

@@ -0,0 +1,43 @@
+class DurationEstimate
+  # Queue (array) that can hold +max_size+ items at most.
+  class SizedQueue
+    # Collection of items.
+    #
+    # @return [Array]
+    attr_accessor :items
+
+    # Maximum number the collection will hold.
+    #
+    # @return [Fixnum]
+    attr_accessor :max_size
+
+    # Setup.
+    #
+    # @param max_size [Fixnum] What is the maximum size?
+    def initialize(max_size)
+      self.max_size = max_size
+      self.items    = []
+    end
+
+    # Add an item into the collection.
+    #
+    # @param item [Object] Item to add.
+    #
+    # @return [SizedQueue] Self.
+    def <<(item)
+      items << item
+      items.shift if items.size > max_size
+      self
+    end
+
+    # Calculate mean (average). It is assumed that the objects in collection
+    # respond to +:++ method.
+    #
+    # @return [Numeric, nil]
+    def average
+      size = items.size
+      return if size.zero?
+      items.reduce(:+) / size
+    end
+  end
+end

data/lib/duration_estimate/terminal_formatter.rb

@@ -0,0 +1,59 @@
+class DurationEstimate
+  # Format a status line for terminal.
+  class TerminalFormatter
+    # Reference to the estimate instance.
+    #
+    # @return [DurationEstimate]
+    attr_accessor :estimate
+
+    # Format a status line for terminal.
+    #
+    # @return [String]
+    def self.format(estimate)
+      new(estimate).format
+    end
+
+    # Format a status line for terminal.
+    #
+    # @param estimate [DurationEstimate] Reference to the estimate instance.
+    def initialize(estimate)
+      self.estimate = estimate
+    end
+
+    # Format estimate as a string.
+    # Prevent trailing junk characters by setting fixed widths for things.
+    #
+    # @return [String]
+    def format
+      [
+        "#{ items_done }/#{ estimate.items_size }",
+        "(#{ percentage } %)",
+        "#{ estimate.ends_at.strftime('%H:%M:%S') },",
+        "#{ estimate.time_remaining }"
+      ].join(' ')
+    end
+
+    private
+
+    # Align the items_done number to the right.
+    #
+    # @return [String]
+    def items_done
+      estimate.items_done.to_s.rjust(items_size_digits)
+    end
+
+    # Number of digits for the items_size number.
+    #
+    # @return [Fixnum]
+    def items_size_digits
+      estimate.items_size.to_s.size
+    end
+
+    # Format percentage number.
+    #
+    # @return [String]
+    def percentage
+      Kernel.format('%6.02f', estimate.percentage)
+    end
+  end
+end

data/lib/duration_estimate/version.rb

@@ -0,0 +1,53 @@
+# Do something to a collection of items and see how long it is going to take.
+# Useful for long-running Rake tasks.
+#
+#   items = 0..10000 # Some data set.
+#
+#   DurationEstimate.each(items) do |item, e|
+#     print "\r#{ DurationEstimate::TerminalFormatter.format(e) }"
+#
+#     # Do something time consuming with item.
+#     sleep 0.001
+#   end
+#
+#   puts
+#
+# You can specify the collection size if you are using some kind of ORM that
+# does not respond to `:size` method.
+#
+#   media = Media
+#     .where { created_at > Time.parse('some time') }
+#     .order(:created_at)
+#
+#   File.open('missing-media.log', 'w') do |log|
+#     DurationEstimate.each(media, size: media.count) do |medium, e|
+#       print "\r#{ DurationEstimate::TerminalFormatter.format(e) }"
+#
+#       unless medium.on_s3?
+#         log.puts medium.id
+#         log.fsync # Write changes now, be able tail the file.
+#       end
+#
+#       sleep 2 # Don't overload AWS S3
+#     end
+#   end
+#
+#   puts
+#
+# This is going to re-print a line with something like this:
+#
+#    1/11 (  9.09 %) -, -
+#    2/11 ( 18.18 %) 11:47:29, 00:00:34
+#    3/11 ( 27.27 %) 11:47:30, 00:00:31
+#    4/11 ( 36.36 %) 11:47:31, 00:00:27
+#    5/11 ( 45.45 %) 11:47:31, 00:00:23
+#    6/11 ( 54.55 %) 11:47:30, 00:00:19
+#    7/11 ( 63.64 %) 11:47:30, 00:00:15
+#    8/11 ( 72.73 %) 11:47:30, 00:00:11
+#    9/11 ( 81.82 %) 11:47:30, 00:00:07
+#   10/11 ( 90.91 %) 11:47:30, 00:00:03
+#   11/11 (100.00 %) 11:47:30, 00:00:00
+class DurationEstimate
+  # Version, man!
+  VERSION = '0.0.1'
+end

data/lib/duration_estimate.rb

@@ -0,0 +1,169 @@
+require 'benchmark'
+
+require 'duration_estimate/version'
+require 'duration_estimate/sized_queue'
+require 'duration_estimate/null_time'
+require 'duration_estimate/terminal_formatter'
+
+# Do something to a collection of items and see how long it is going to take.
+# Useful for long-running Rake tasks.
+#
+#   items = 0..10000 # Some data set.
+#
+#   DurationEstimate.each(items) do |item, e|
+#     print "\r#{ DurationEstimate::TerminalFormatter.format(e) }"
+#
+#     # Do something time consuming with item.
+#     sleep 0.001
+#   end
+#
+#   puts
+#
+# You can specify the collection size if you are using some kind of ORM that
+# does not respond to `:size` method.
+#
+#   media = Media
+#     .where { created_at > Time.parse('some time') }
+#     .order(:created_at)
+#
+#   File.open('missing-media.log', 'w') do |log|
+#     DurationEstimate.each(media, size: media.count) do |medium, e|
+#       print "\r#{ DurationEstimate::TerminalFormatter.format(e) }"
+#
+#       unless medium.on_s3?
+#         log.puts medium.id
+#         log.fsync # Write changes now, be able tail the file.
+#       end
+#
+#       sleep 2 # Don't overload AWS S3
+#     end
+#   end
+#
+#   puts
+#
+# This is going to re-print a line with something like this:
+#
+#    1/11 (  9.09 %) -, -
+#    2/11 ( 18.18 %) 11:47:29, 00:00:34
+#    3/11 ( 27.27 %) 11:47:30, 00:00:31
+#    4/11 ( 36.36 %) 11:47:31, 00:00:27
+#    5/11 ( 45.45 %) 11:47:31, 00:00:23
+#    6/11 ( 54.55 %) 11:47:30, 00:00:19
+#    7/11 ( 63.64 %) 11:47:30, 00:00:15
+#    8/11 ( 72.73 %) 11:47:30, 00:00:11
+#    9/11 ( 81.82 %) 11:47:30, 00:00:07
+#   10/11 ( 90.91 %) 11:47:30, 00:00:03
+#   11/11 (100.00 %) 11:47:30, 00:00:00
+class DurationEstimate
+  # Some collection to run through.
+  #
+  # @return [Enumerable]
+  attr_accessor :items
+
+  # Number of items.
+  #
+  # @return [Fixnum]
+  attr_accessor :items_size
+
+  # Number of items done.
+  #
+  # @return [Fixnum]
+  attr_accessor :items_done
+
+  # Number of items remaining.
+  #
+  # @return [Fixnum]
+  attr_accessor :items_remaining
+
+  # Hold operation times.
+  #
+  # @return [SizedQueue]
+  attr_accessor :times
+
+  # Iterate through collection, measure how long it took, yield the item
+  # as well as self to use helper methods.
+  #
+  # @yieldparam item [Object]           Current item in collection.
+  # @yieldparam e    [DurationEstimate] This instance.
+  def self.each(*args, &block)
+    new(*args).each(&block)
+  end
+
+  # Setup.
+  #
+  # @param  items          [Enumerable] Some collection to run through.
+  # @param  options        [Hash]
+  # @option options :size  [Fixnum] Total number of items.
+  def initialize(items, options = {})
+    self.items           = items
+    self.items_size      = options[:size] || items.size
+    self.items_done      = 0
+    self.items_remaining = items_size
+    self.times           = SizedQueue.new(5)
+  end
+
+  # Iterate through collection, measure how long it took, yield the item
+  # as well as self to use helper methods.
+  #
+  # @yieldparam item [Object]           Current item in collection.
+  # @yieldparam e    [DurationEstimate] This instance.
+  def each
+    items.each do |item|
+      measure do
+        self.items_done      += 1 # rubocop:disable Style/SpaceAroundOperators
+        self.items_remaining -= 1
+
+        yield item, self
+      end
+    end
+  end
+
+  # Calculate end time when all will be done.
+  #
+  # @return [Time, NullTime]
+  def ends_at
+    seconds = seconds_left
+    return NullTime.new unless seconds
+    Time.now + seconds
+  end
+
+  # Calculate future time when all will be well and done.
+  #
+  # @return [String]
+  def time_remaining
+    seconds = seconds_left
+    return '-' unless seconds
+
+    minutes, seconds = seconds.divmod(60)
+    hours, minutes   = minutes.divmod(60)
+
+    [
+      "#{ format('%02d', hours) }",
+      "#{ format('%02d', minutes) }",
+      "#{ format('%02d', seconds) }"
+    ].compact.join(':')
+  end
+
+  # Calculates percentage of done items.
+  #
+  # @return [Float]
+  def percentage
+    items_done.to_f / items_size * 100
+  end
+
+  private
+
+  # Calculate how many seconds are left until the end.
+  #
+  # @return [Numeric, nil]
+  def seconds_left
+    average = times.average
+    return unless average
+    items_remaining * average
+  end
+
+  # Do some operation and record how long it took.
+  def measure
+    times << Benchmark.realtime { yield }
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: duration_estimate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oldrich Vetesnik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-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.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.31'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: 
+email:
+- oldrich.vetesnik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop-my.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- duration_estimate.gemspec
+- lib/duration_estimate.rb
+- lib/duration_estimate/null_time.rb
+- lib/duration_estimate/sized_queue.rb
+- lib/duration_estimate/terminal_formatter.rb
+- lib/duration_estimate/version.rb
+homepage: https://github.com/ollie/duration_estimate
+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.6
+signing_key: 
+specification_version: 4
+summary: Do something to a collection of items and see how long it is going to take.
+  Useful for long-running Rake tasks.
+test_files: []
+has_rdoc: