ruby-pv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e80904a80987fd2c763dfe3ec6a1b434562307a
+  data.tar.gz: 12d06c90fd7f31236f7e2052c019a706b0df78f3
+SHA512:
+  metadata.gz: 450dd4d904a0221d4624b6491360b46935b3bc6951ab454b2b316e839b554e6cb4580c0e41e07707bd32347604ed07b0a9c3b358f62cf7a9da654b23b41f5eaf
+  data.tar.gz: c3b70140eb65d20d1034f7a27b0c92728d66ea26119499307faba04b60f296a19ceb831c0d33da7a899afed00679fea41337dc760c2234e8f2dd14e23d3a6b91

data/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+/pkg/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+# This is the configuration used to check the rubocop source code.
+
+Metrics/AbcSize:
+  Enabled: false
+
+# TODO: shorten long methods.
+Metrics/MethodLength:
+  Max: 13
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/pv.rb' # TODO: add docs.
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/SignalException:
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: consistent_comma

data/Gemfile

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

data/README.md

@@ -0,0 +1,44 @@
+# ruby-pv
+
+:construction: **WORK IN PROGRESS** :construction:
+
+A handy progress monitor for long-running tasks. Like [`pv`](http://linux.die.net/man/1/pv), but for Ruby. 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-pv'
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install ruby-pv
+
+## Usage
+
+TODO: Write usage instructions here
+
+### Printing to stdout while `pv`ing
+
+It just works. Seamlessly. {insert Steve Jobs picture}
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in the `.gemspec` file, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and pudmsh the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/epidemian/ruby-pv.
+
+
+TODO: Mention [tqdm](https://github.com/tqdm/tqdm) as an inspiration
+

data/Rakefile

@@ -0,0 +1,38 @@
+$LOAD_PATH << File.join(__dir__, 'lib')
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :example do
+  require 'pv'
+  500.times.pv do |n|
+    puts 'Some output' if n % 123 == 0
+    sleep rand / 50
+  end
+end
+
+task :slow_example do
+  require 'pv'
+  8.times.pv do |n|
+    puts 'Some output' if n == 3 || n == 7
+    sleep 0.5
+  end
+end
+
+task :unsized_example do
+  require 'pv'
+  125.times.to_enum.pv do |n|
+    sleep n < 25 ? 0.1 : 0.025
+  end
+end
+
+task :unsized_slow_example do
+  require 'pv'
+  50.times.to_enum.pv do
+    sleep 0.5
+  end
+end

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/lib/pv.rb

@@ -0,0 +1,146 @@
+require 'io/console'
+
+class Pv
+  include Enumerable
+
+  def initialize(enum)
+    @enum = enum
+  end
+
+  def each
+    return to_enum unless block_given?
+    # TODO: don't display progress unless $stdout.tty?
+
+    self.progress = 0
+
+    hijack_stdout
+
+    display_progress
+
+    @enum.each do |item|
+      val = yield item
+      self.progress += 1
+      display_progress
+      val
+    end
+  ensure
+    # Run on ensure block to raised StopIterations don't mess up the display.
+    clear_progress
+    restore_stdout
+  end
+
+  private
+
+  attr_accessor :progress
+
+  def total
+    @enum.size
+  end
+
+  def unknown_total?
+    total.nil? || total == Float::INFINITY
+  end
+
+  def display_progress
+    l_bar = "Progress: #{formatted_numeric_progress} ▕"
+    r_bar = '▏'
+    bar_size = term_width - l_bar.size - r_bar.size
+    bar = draw_progress_bar(bar_size)
+    line = "#{l_bar}#{bar}#{r_bar}\r"
+    @original_stdout.print line
+    @progress_displayed = true
+  end
+
+  def clear_progress
+    return unless @progress_displayed
+    @original_stdout.print(' ' * term_width + "\r")
+    @progress_displayed = false
+  end
+
+  def term_width
+    IO.console.winsize[1]
+  end
+
+  def formatted_numeric_progress
+    if unknown_total?
+      total_text = 'unknown'
+      progress_text = progress.to_s
+    else
+      total_text = total.to_s
+      progress_text = progress.to_s.rjust(total_text.size)
+    end
+    "#{progress_text}/#{total_text}"
+  end
+
+  def draw_progress_bar(bar_size)
+    if unknown_total?
+      draw_unknown_progress_bar(bar_size)
+    else
+      draw_known_progress_bar(bar_size)
+    end
+  end
+
+  FRAC_CHARS = ' ▏▎▍▌▋▊▉'
+
+  def draw_known_progress_bar(bar_size)
+    completed_size, remainder = (progress.to_f / total * bar_size).divmod(1)
+
+    rem_char =
+      progress == total ? '' : FRAC_CHARS[(FRAC_CHARS.size * remainder).floor]
+
+    completed = '█' * completed_size
+    uncompleted = ' ' * (bar_size - completed_size - rem_char.size)
+
+    "#{completed}#{rem_char}#{uncompleted}"
+  end
+
+  UNKNOWN_PROGRESS_FRAMES = [
+    '▐  ▌ ',
+    '▖▘▗▝ ',
+    ' ▝▖ ▚',
+    ' ▗▘ ▞',
+    '▘▖▝▗ ',
+  ].map(&:chars)
+
+  def draw_unknown_progress_bar(bar_size)
+    frame = UNKNOWN_PROGRESS_FRAMES[progress % UNKNOWN_PROGRESS_FRAMES.size]
+    frame.cycle.take(bar_size).join
+  end
+
+  # Hijacks $stdout so user can still print stuff while showing the progressbar.
+  def hijack_stdout
+    @original_stdout = $stdout
+    $stdout = PvAwareStdout.new do |data|
+      clear_progress
+      @original_stdout.write(data)
+      display_progress if data.end_with?("\n")
+    end
+  end
+
+  def restore_stdout
+    $stdout = @original_stdout
+  end
+
+  # TODO: make this respond to everything STDOUT responds to.
+  class PvAwareStdout
+    def initialize(&writer)
+      @writer = writer
+    end
+
+    def write(data)
+      @writer.call(data)
+    end
+  end
+end
+
+Enumerable.module_eval do
+  # TODO: Add non-monkey-patching alternative (refinements maybe?)
+  def pv(&blk)
+    pv = Pv.new(self)
+    if blk
+      pv.each(&blk)
+    else
+      pv
+    end
+  end
+end

data/ruby-pv.gemspec

@@ -0,0 +1,20 @@
+$LOAD_PATH << File.join(__dir__, 'lib')
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby-pv'
+  spec.version       = '0.0.1'
+  spec.license       = 'Public Domain'
+  spec.authors       = ['Demian Ferreiro']
+  spec.email         = 'epidemian@gmail.com'
+
+  spec.summary       = 'A handy progress monitor for long-running tasks'
+  spec.homepage      = 'https://github.com/epidemian/ruby-pv'
+
+  spec.files         = `git ls-files`.split("\n").reject { |f| f =~ %r{^spec/} }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: ruby-pv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Demian Ferreiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  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: 
+email: epidemian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- UNLICENSE
+- lib/pv.rb
+- ruby-pv.gemspec
+homepage: https://github.com/epidemian/ruby-pv
+licenses:
+- Public Domain
+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: A handy progress monitor for long-running tasks
+test_files: []