progress_bar 1.0.5 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 63c44738d941428ab4348be03ab2f1744343fb7b
-  data.tar.gz: a78ec7e3bd7e45e56ae9fb9d07d7269d3b05dbda
+SHA256:
+  metadata.gz: bb7f4ff94b18c74293549cabfa13a706919a372ad266ba128f51871e835640b9
+  data.tar.gz: 86ee5facbec3945a261948111955ca19e84b0bbf28d58beb5c67074b9fefb1f8
 SHA512:
-  metadata.gz: 913cb8e575f72ff88aaf39d32e54e67abbe83ab6aa19540295b512641c898a038ad91b1b845604bb4fd19abc5cc4436e64a63ada61faf0dbaf27b982b83863d1
-  data.tar.gz: 5a483c2f3cc1e5b41949644463c8da98ecdb9509c18ab2d117971cd72fc71589b44bdba59ec08f5c59910904e211ac66f1dd8069df9d3e17aeaf8d011d4a60d8
+  metadata.gz: 2cce378aa8152b13f210fa1e005ca9933146e70bf243257a057bd228833f0ab2ea2ebb9627e65a9d1c3114b43b9dafd531d6ceca13f412e1c6b94e68773f61e7
+  data.tar.gz: 23e2f70bb0d18351baf90809383607dd9d4c6f75591f8018d704cb487554e791560bde118f7c720bb0791abce42247f6a68c2ad7120f3aa05ac21686cc8aa628

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: paul
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.github/workflows/pronto.yml

@@ -0,0 +1,32 @@
+---
+name: Lint
+"on": [pull_request]
+jobs:
+  lint:
+    name: Pronto
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1.0.0
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+      - name: Install dependencies
+        run: |
+          sudo apt-get update -qq
+          sudo apt-get install -qqy --no-install-recommends yamllint jq
+          gem install bundler --no-document
+          bundle install
+          gem install --no-document \
+            pronto  \
+            pronto-brakeman  \
+            pronto-flay  \
+            pronto-reek  \
+            pronto-rubocop  \
+            pronto-yamllint
+
+      - name: Pronto
+        env:
+          PRONTO_GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          export PRONTO_PULL_REQUEST_ID=$(jq .number -r $GITHUB_EVENT_PATH)
+          pronto run -c origin/master -f github_status github_pr_review text

data/.github/workflows/rspec.yml

@@ -0,0 +1,27 @@
+---
+name: Test
+"on": [pull_request]
+jobs:
+  rspec:
+    name: RSpec
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 2.4.x
+          - 2.5.x
+          - 2.6.x
+          - 2.7.x
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: |
+          gem install bundler --no-document
+          bundle install
+
+      - name: RSpec
+        run: |
+          rspec

data/.gitignore

@@ -2,3 +2,12 @@
 .bundle
 Gemfile.lock
 pkg/*
+
+# Rubocop inherited configs
+.rubocop-http*
+
+# Editor junk
+.DS_Store
+.vscode
+.idea
+

data/.reek.yml

@@ -0,0 +1,51 @@
+---
+exclude_paths:
+  - bin
+
+detectors:
+  UtilityFunction:
+    public_methods_only: true
+
+  TooManyStatements:
+    exclude:
+      - initialize
+    max_statements: 8
+
+  RepeatedConditional:
+    max_ifs: 4
+
+  LongParameterList:
+    exclude:
+      - initialize
+
+  # This one just makes sure the Class/Module has a comment. Dumb.
+  IrresponsibleModule:
+    enabled: false
+
+  # Transaction result blocks are 3-deep
+  NestedIterators:
+    max_allowed_nesting: 3
+
+  UncommunicativeVariableName:
+    accept:
+      - i     # array index
+      - c     # config
+      - k     # key
+      - v     # value
+      - h     # hash initializer (Hash.new { |h,k| h[k] = Hash.new })
+      - "_"
+  UncommunicativeModuleName:
+    accept:
+      - Auth0
+
+  # AS::Subscriber objects tend to rely heavily on `event` and `payload`, so its
+  # hard to avoid "Feature Envy", but is perfectly readable.
+  FeatureEnvy:
+    enabled: false
+
+directories:
+  "spec/support":
+    UtilityFunction:
+      enabled: false
+
+# vi:syntax=yaml

data/.rubocop.yml

@@ -0,0 +1,113 @@
+---
+inherit_from:
+  - https://relaxed.ruby.style/rubocop.yml
+
+require:
+  - rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+  Exclude:
+    - "vendor/**/*"
+    - "spec/fixtures/**/*"
+    - "bin/**/*"
+    - "script/**/*"
+    - "tmp/**/*"
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"  # `expect { }.to change { }` is fine
+Lint/ShadowingOuterLocalVariable:
+  # Shadowing outer local variables with block parameters is often useful to
+  # not reinvent a new name for the same thing, it highlights the relation
+  # between the outer variable and the parameter. The cases where it's actually
+  # confusing are rare, and usually bad for other reasons already, for example
+  # because the method is too long.
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - Gemfile
+    - Guardfile
+    - shared_context
+    - feature
+  ExcludedMethods:
+    - configure
+    - context
+    - define
+    - describe
+    - factory
+    - it
+    - namespace
+    - specify
+    - task
+    - shared_examples_for
+    - shared_context
+    - feature
+    - define_type
+Layout/LineLength:
+  Enabled: true
+  Max: 120
+Metrics/ClassLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+Naming/RescuedExceptionsVariableName:
+  PreferredName: ex
+Naming/FileName:
+  Enabled: false
+Naming/MethodParameterName:
+  Enabled: false
+Style/EmptyLiteral:
+  Enabled: false
+Style/FormatStringToken:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: true
+Style/HashSyntax:
+  Exclude:
+    - lib/tasks/**/*.rake
+Style/NumericLiterals:
+  Enabled: false
+Style/StringConcatenation:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/SymbolArray:
+  MinSize: 4
+
+# Rspec
+Capybara/FeatureMethods:
+  Enabled: false
+RSpec/ContextWording:
+  Enabled: false
+RSpec/DescribeClass:
+  Enabled: false
+RSpec/DescribedClass:
+  Enabled: false
+RSpec/ExampleLength:
+  Max: 10
+RSpec/ExampleWording:
+  Enabled: false
+RSpec/ExpectChange:
+  EnforcedStyle: block
+RSpec/ImplicitExpect:
+  Enabled: false
+RSpec/LeadingSubject:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Max: 4
+RSpec/NestedGroups:
+  Max: 4
+RSpec/NotToNot:
+  Enabled: false
+RSpec/ExpectInHook:
+  Enabled: false
+RSpec/LetSetup:
+  Enabled: false

data/.travis.yml

@@ -1,16 +1,12 @@
 script: rake spec
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.2
+  - 2.2
+  - 2.3
+  - 2.4.0-preview3
   - ruby-head
-  - jruby-19mode
-  - jruby-head
-  - rbx-2
 
 matrix:
   allow_failures:
     - rvm:
-      - rbx-2.1.1
-      - jruby-head
+      - 2.4.0-preview3
       - ruby-head

data/Changelog.mkd

@@ -0,0 +1,25 @@
+# 1.3.3
+
+ * Fixed use of unqualified ::Time that was conflicting with another
+   ProgressBar gem [#58](https://github.com/paul/progress_bar/pull/58).
+   Thanks to [harryloewen](https://github.com/harryloewen) for the
+   [report](https://github.com/paul/progress_bar/issues/57)
+
+# 1.3.2
+
+ * Added `ProgressBar#puts`, to be able to print text to the output without
+   interfering with the rendering of the bar output.
+   [#56](https://github.com/paul/progress_bar/pull/56) Thanks to
+   [TRex22](https://github.com/TRex22) for the suggestion in
+   [#44](https://github.com/paul/progress_bar/pull/44).
+
+# 1.3.1
+
+ * Added support for passing bar options to `Enumerable#with_progress`
+   extension.
+
+# 1.3.0
+
+ * Relaxed highline gem requirement to allow highline 2.0 as well as 1.6+
+
+

data/Gemfile

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # A sample Gemfile
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec

data/README.mkd

@@ -1,6 +1,6 @@
 # ProgressBar
 
-[![Build Status](https://travis-ci.org/paul/progress_bar.png?branch=master)](https://travis-ci.org/paul/progress_bar)[![Gem Version](https://badge.fury.io/rb/progress_bar.svg)](http://badge.fury.io/rb/progress_bar)
+[![Build Status](https://github.com/paul/progress_bar/workflows/Test/badge.svg)](https://github.com/paul/progress_bar/actions)[![Gem Version](https://badge.fury.io/rb/progress_bar.svg)](http://badge.fury.io/rb/progress_bar)
 
 *ProgressBar* is a simple Ruby library for displaying progress of
 long-running tasks on the console. It is intended to be as simple to use
@@ -20,14 +20,16 @@ lots of progress bar alternatives, and we thank you for using ProgressBar!
 
 ## The Easy Way
 
+```ruby
+require 'progress_bar'
 
-    require 'progress_bar'
-    bar = ProgressBar.new
+bar = ProgressBar.new
 
-    100.times do
-      sleep 0.1
-      bar.increment!
-    end
+100.times do
+  sleep 0.1
+  bar.increment!
+end
+```
 
 Produces output like:
 
@@ -42,15 +44,43 @@ it.*
 Usually, the defaults should be fine, the only thing you'll need to
 tweak is the max.
 
-    bar = ProgressBar.new(1000)
+```ruby
+bar = ProgressBar.new(1000)
+```
 
 ## Larger Steps
 
 If you want to process several things, and update less often, you can
 pass a number to `#increment!`
 
+```ruby
     bar.increment! 42
+```
+
+## Printing additional output
+
+Sometimes you want to print some additional messages in the output, but since the ProgressBar uses terminal control characters to replace the text on the same line on every update, the output looks funny:
+
+    [#######################################                           ] [ 59.00%] [00:06]
+    Hello!
+    [#########################################                         ] [ 60.00%] [00:05]
+
+To prevent this, you can use `ProgressBar#puts` so ProgressBar knows you want to print something, and it'll clear the bar before printing, then resume printing on the next line:
+
+```ruby
+100.times do |i|
+  sleep 0.1
+  bar.puts "Halfway there!" if i == 50
+  bar.increment!
+end
+```
+
+Produces output like:
+
+    Halfway there!
+    [##################################] [100/100] [100%] [00:10] [00:00] [  9.98/s]
 
+Try it out in `examples/printing_messages.rb` to see how it looks.
 
 ## Picking the meters
 
@@ -58,7 +88,9 @@ By default, ProgressBar will use all available meters (this will
 probably change). To select which meters you want, and in which order,
 pass them to the constructor:
 
-    bar = ProgressBar.new(100, :bar, :rate, :eta)
+```ruby
+bar = ProgressBar.new(100, :bar, :rate, :eta)
+```
 
 
 ### Available Meters
@@ -81,6 +113,38 @@ gem install --development progress_bar
 rspec spec/*_spec.rb
 ```
 
+## Using ProgressBar on Enumerable-alikes.
+
+If you do a lot of progresses, you can shorten your way with this:
+
+```ruby
+class Array
+  include ProgressBar::WithProgress
+end
+
+[1,2,3].each_with_progress{do_something}
+
+# or any other Enumerable's methods:
+
+(1..1000).to_a.with_progress.select{|i| (i % 2).zero?}
+```
 
+You can include `ProgressBar::WithProgress` in any class, having methods
+`#count` and `#each`, like some DB datasets and so on.
 
+If you are using progress_bar regularly on plain arrays, you may want to
+do:
 
+```ruby
+require 'progress_bar/core_ext/enumerable_with_progress'
+
+# it adds each_with_progress/with_progress to Array/Hash/Range
+
+(1..400).with_progress.select{|i| (i % 2).zero?}
+```
+
+If you want to display only specific meters you can do it like so:
+
+```ruby
+(1..400).with_progress(:bar, :elapsed).select{|i| (i % 2).zero?}
+```

data/Rakefile

@@ -1,6 +1,8 @@
-require 'bundler'
+# frozen_string_literal: true
+
+require "bundler"
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec

data/examples/enumerable.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "../lib/progress_bar/core_ext/enumerable_with_progress"
+
+(20...34).with_progress.select{ |i| sleep 0.1; (i % 2).zero? }

data/examples/printing_messages.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../lib/progress_bar"
+
+bar = ProgressBar.new
+
+100.times do |i|
+  sleep 0.1
+  bar.puts("Some long text\nthat contains newlines") if i == 10
+  bar.puts("Halfway there!") if i == 50
+  bar.puts("Almost done!") if i == 90
+  bar.increment!
+end
+
+__END__
+
+$ ruby examples/printing_messages.rb
+Some long text
+that contains newlines
+Halfway there!
+Almost done!
+[##################################] [100/100] [100%] [00:10] [00:00] [  9.98/s]

data/examples/simple.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib/progress_bar'))
+require_relative "../lib/progress_bar"
 
 bar = ProgressBar.new
 

data/lib/progress_bar/core_ext/enumerable_with_progress.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "../../progress_bar"
+
+ObjectSpace.each_object(Module) do |mod|
+  if mod <= Enumerable
+    mod.send :include, ProgressBar::WithProgress
+  end
+end

data/lib/progress_bar/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ProgressBar
-  VERSION = "1.0.5"
+  VERSION = "1.3.3"
 end

data/lib/progress_bar/with_progress.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class ProgressBar
+  module WithProgress
+    def each_with_progress(*args, &block)
+      bar = ProgressBar.new(count, *args)
+      if block
+        each{ |obj| yield(obj).tap{ bar.increment! } }
+      else
+        Enumerator.new{ |yielder|
+          each do |obj|
+            (yielder << obj).tap{ bar.increment! }
+          end
+        }
+      end
+    end
+
+    alias_method :with_progress, :each_with_progress
+  end
+end