progress_bar 1.0.5 → 1.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/.github/FUNDING.yml +12 -0
- data/.github/workflows/pronto.yml +32 -0
- data/.github/workflows/rspec.yml +27 -0
- data/.gitignore +9 -0
- data/.reek.yml +51 -0
- data/.rubocop.yml +113 -0
- data/.travis.yml +4 -8
- data/Changelog.mkd +18 -0
- data/Gemfile +3 -1
- data/README.mkd +73 -9
- data/Rakefile +5 -3
- data/examples/enumerable.rb +5 -0
- data/examples/printing_messages.rb +22 -0
- data/examples/simple.rb +2 -1
- data/lib/progress_bar.rb +41 -35
- data/lib/progress_bar/core_ext/enumerable_with_progress.rb +9 -0
- data/lib/progress_bar/version.rb +3 -1
- data/lib/progress_bar/with_progress.rb +20 -0
- data/progress_bar.gemspec +12 -8
- data/spec/arguments_spec.rb +16 -19
- data/spec/bar_spec.rb +9 -9
- data/spec/counter_spec.rb +18 -23
- data/spec/elapsed_spec.rb +17 -15
- data/spec/eta_spec.rb +19 -18
- data/spec/percentage_spec.rb +17 -18
- data/spec/print_spec.rb +21 -0
- data/spec/progress_bar_spec.rb +16 -16
- data/spec/rate_spec.rb +24 -24
- data/spec/spec_helper.rb +4 -4
- data/spec/with_progress_spec.rb +42 -0
- metadata +75 -13
@@ -0,0 +1,22 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "../lib/progress_bar"
|
4
|
+
|
5
|
+
bar = ProgressBar.new
|
6
|
+
|
7
|
+
100.times do |i|
|
8
|
+
sleep 0.1
|
9
|
+
bar.puts("Some long text\nthat contains newlines") if i == 10
|
10
|
+
bar.puts("Halfway there!") if i == 50
|
11
|
+
bar.puts("Almost done!") if i == 90
|
12
|
+
bar.increment!
|
13
|
+
end
|
14
|
+
|
15
|
+
__END__
|
16
|
+
|
17
|
+
$ ruby examples/printing_messages.rb
|
18
|
+
Some long text
|
19
|
+
that contains newlines
|
20
|
+
Halfway there!
|
21
|
+
Almost done!
|
22
|
+
[##################################] [100/100] [100%] [00:10] [00:00] [ 9.98/s]
|
data/examples/simple.rb
CHANGED
data/lib/progress_bar.rb
CHANGED
@@ -1,6 +1,7 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
|
2
|
-
require
|
3
|
-
require
|
3
|
+
require "options"
|
4
|
+
require "highline"
|
4
5
|
|
5
6
|
class ProgressBar
|
6
7
|
Error = Class.new(StandardError)
|
@@ -9,34 +10,41 @@ class ProgressBar
|
|
9
10
|
attr_accessor :count, :max, :meters
|
10
11
|
|
11
12
|
def initialize(*args)
|
12
|
-
|
13
13
|
@count = 0
|
14
14
|
@max = 100
|
15
15
|
@meters = [:bar, :counter, :percentage, :elapsed, :eta, :rate]
|
16
16
|
|
17
|
-
@max
|
18
|
-
raise ArgumentError, "Max must be a positive integer" unless @max
|
17
|
+
@max = args.shift if args.first.is_a? Numeric
|
18
|
+
raise ArgumentError, "Max must be a positive integer" unless @max >= 0
|
19
19
|
|
20
|
-
@meters
|
20
|
+
@meters = args unless args.empty?
|
21
21
|
|
22
22
|
@last_write = ::Time.at(0)
|
23
23
|
@start = ::Time.now
|
24
24
|
|
25
|
-
@hl
|
25
|
+
@hl = HighLine.new
|
26
|
+
@terminal_width = 80
|
27
|
+
@last_width_adjustment = Time.at(0)
|
26
28
|
end
|
27
29
|
|
28
30
|
def increment!(count = 1)
|
29
|
-
|
31
|
+
@count += count
|
30
32
|
now = ::Time.now
|
31
|
-
if (now - @last_write) > 0.2 ||
|
33
|
+
if (now - @last_write) > 0.2 || @count >= max
|
32
34
|
write
|
33
35
|
@last_write = now
|
34
36
|
end
|
35
37
|
end
|
36
38
|
|
37
|
-
def
|
39
|
+
def puts(text)
|
38
40
|
clear!
|
39
|
-
|
41
|
+
$stderr.write(text)
|
42
|
+
$stderr.puts
|
43
|
+
write
|
44
|
+
end
|
45
|
+
|
46
|
+
def write
|
47
|
+
print "\r" + to_s
|
40
48
|
end
|
41
49
|
|
42
50
|
def remaining
|
@@ -73,8 +81,8 @@ class ProgressBar
|
|
73
81
|
|
74
82
|
def to_s
|
75
83
|
self.count = max if count > max
|
76
|
-
meters.inject(
|
77
|
-
text << render(meter)
|
84
|
+
meters.inject(String.new) do |text, meter|
|
85
|
+
text << "#{render(meter)} "
|
78
86
|
end.strip
|
79
87
|
end
|
80
88
|
|
@@ -85,7 +93,7 @@ class ProgressBar
|
|
85
93
|
end
|
86
94
|
|
87
95
|
def clear!
|
88
|
-
print "\r"
|
96
|
+
print "\r" + " " * terminal_width + "\r"
|
89
97
|
end
|
90
98
|
|
91
99
|
def render(meter)
|
@@ -97,13 +105,11 @@ class ProgressBar
|
|
97
105
|
end
|
98
106
|
|
99
107
|
def render_bar
|
100
|
-
return
|
108
|
+
return "" if bar_width < 2
|
109
|
+
|
101
110
|
progress_width = (ratio * (bar_width - 2)).floor
|
102
111
|
remainder_width = bar_width - 2 - progress_width
|
103
|
-
"["
|
104
|
-
"#" * progress_width +
|
105
|
-
" " * remainder_width +
|
106
|
-
"]"
|
112
|
+
"[#{'#' * progress_width}#{' ' * remainder_width}]"
|
107
113
|
end
|
108
114
|
|
109
115
|
def render_counter
|
@@ -124,20 +130,17 @@ class ProgressBar
|
|
124
130
|
end
|
125
131
|
|
126
132
|
def render_rate
|
127
|
-
"[%#{max_width+3}.2f/s]" % rate
|
133
|
+
"[%#{max_width + 3}.2f/s]" % rate
|
128
134
|
end
|
129
135
|
|
130
136
|
def terminal_width
|
131
137
|
# HighLine check takes a long time, so only update width every second.
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
@terminal_width = 80
|
139
|
-
end
|
140
|
-
@terminal_width
|
138
|
+
now = ::Time.now
|
139
|
+
if now - @last_width_adjustment > 1
|
140
|
+
@last_width_adjustment = now
|
141
|
+
new_width = @hl.output_cols.to_i
|
142
|
+
new_width = 80 if new_width < 1
|
143
|
+
@terminal_width = new_width
|
141
144
|
else
|
142
145
|
@terminal_width
|
143
146
|
end
|
@@ -148,12 +151,12 @@ class ProgressBar
|
|
148
151
|
end
|
149
152
|
|
150
153
|
def non_bar_width
|
151
|
-
meters.reject { |
|
154
|
+
meters.reject { |meter| meter == :bar }.inject(0) do |width, meter|
|
152
155
|
width += width_of(meter) + 1
|
153
156
|
end
|
154
157
|
end
|
155
158
|
|
156
|
-
def counter_width
|
159
|
+
def counter_width # [ 1/100]
|
157
160
|
max_width * 2 + 3
|
158
161
|
end
|
159
162
|
|
@@ -181,12 +184,15 @@ class ProgressBar
|
|
181
184
|
max.to_s.length
|
182
185
|
end
|
183
186
|
|
187
|
+
HOUR = 3600
|
188
|
+
MINUTE = 60
|
184
189
|
def format_interval(interval)
|
185
|
-
if interval >
|
186
|
-
"%02i:%02i:%02i" % [interval/
|
190
|
+
if interval > HOUR
|
191
|
+
"%02i:%02i:%02i" % [interval / HOUR, interval % HOUR / MINUTE, interval % MINUTE]
|
187
192
|
else
|
188
|
-
"%02i:%02i" % [interval/
|
193
|
+
"%02i:%02i" % [interval / MINUTE, interval % MINUTE]
|
189
194
|
end
|
190
195
|
end
|
191
|
-
|
192
196
|
end
|
197
|
+
|
198
|
+
require_relative "progress_bar/with_progress"
|
data/lib/progress_bar/version.rb
CHANGED
@@ -0,0 +1,20 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
class ProgressBar
|
4
|
+
module WithProgress
|
5
|
+
def each_with_progress(*args, &block)
|
6
|
+
bar = ProgressBar.new(count, *args)
|
7
|
+
if block
|
8
|
+
each{ |obj| yield(obj).tap{ bar.increment! } }
|
9
|
+
else
|
10
|
+
Enumerator.new{ |yielder|
|
11
|
+
each do |obj|
|
12
|
+
(yielder << obj).tap{ bar.increment! }
|
13
|
+
end
|
14
|
+
}
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
alias_method :with_progress, :each_with_progress
|
19
|
+
end
|
20
|
+
end
|
data/progress_bar.gemspec
CHANGED
@@ -1,6 +1,6 @@
|
|
1
|
-
#
|
2
|
-
|
3
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "lib/progress_bar/version"
|
4
4
|
|
5
5
|
Gem::Specification.new do |s|
|
6
6
|
s.name = "progress_bar"
|
@@ -9,16 +9,20 @@ Gem::Specification.new do |s|
|
|
9
9
|
s.authors = ["Paul Sadauskas"]
|
10
10
|
s.email = ["psadauskas@gmail.com"]
|
11
11
|
s.homepage = "http://github.com/paul/progress_bar"
|
12
|
-
s.
|
13
|
-
s.
|
12
|
+
s.license = "WTFPL"
|
13
|
+
s.summary = "Simple Progress Bar for output to a terminal"
|
14
|
+
s.description = "Give people feedback about long-running tasks without overloading them with information: Use a progress bar, like Curl or Wget!"
|
14
15
|
|
15
|
-
s.
|
16
|
+
s.required_ruby_version = ">= 2.4.0"
|
16
17
|
|
17
|
-
s.add_dependency(
|
18
|
-
s.add_dependency(
|
18
|
+
s.add_dependency("highline", [">= 1.6", "< 3"])
|
19
|
+
s.add_dependency("options", "~> 2.3.0")
|
19
20
|
|
20
21
|
s.add_development_dependency("rake")
|
22
|
+
s.add_development_dependency("reek")
|
21
23
|
s.add_development_dependency("rspec")
|
24
|
+
s.add_development_dependency("rubocop")
|
25
|
+
s.add_development_dependency("rubocop-rspec")
|
22
26
|
s.add_development_dependency("timecop")
|
23
27
|
|
24
28
|
s.files = `git ls-files`.split("\n")
|
data/spec/arguments_spec.rb
CHANGED
@@ -1,40 +1,37 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
3
|
+
require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
|
4
|
+
|
5
|
+
describe "ProgressBar arguments" do
|
6
|
+
let(:default_max) { 100 }
|
7
|
+
let(:default_meters) { [:bar, :counter, :percentage, :elapsed, :eta, :rate] }
|
8
8
|
|
9
9
|
it "should set appropriate defaults without any arguments" do
|
10
10
|
bar = ProgressBar.new
|
11
|
-
bar.max.
|
12
|
-
bar.meters.
|
11
|
+
expect(bar.max).to eq default_max
|
12
|
+
expect(bar.meters).to eq default_meters
|
13
13
|
end
|
14
14
|
|
15
15
|
it "should allow a single argument specifying the max" do
|
16
16
|
bar = ProgressBar.new(123)
|
17
|
-
bar.max.
|
18
|
-
bar.meters.
|
17
|
+
expect(bar.max).to eq 123
|
18
|
+
expect(bar.meters).to eq default_meters
|
19
19
|
end
|
20
20
|
|
21
21
|
it "should allow specifying just the meters" do
|
22
22
|
bar = ProgressBar.new(:bar, :eta)
|
23
|
-
bar.max.
|
24
|
-
bar.meters.
|
23
|
+
expect(bar.max).to eq default_max
|
24
|
+
expect(bar.meters).to eq [:bar, :eta]
|
25
25
|
end
|
26
26
|
|
27
27
|
it "should allow specyfing the max and meters" do
|
28
28
|
bar = ProgressBar.new(123, :bar, :eta)
|
29
|
-
bar.max.
|
30
|
-
bar.meters.
|
29
|
+
expect(bar.max).to eq 123
|
30
|
+
expect(bar.meters).to eq [:bar, :eta]
|
31
31
|
end
|
32
32
|
|
33
33
|
it "should raise an error when initial max is nonsense" do
|
34
|
-
|
35
|
-
|
36
|
-
}.should raise_error(ProgressBar::ArgumentError)
|
34
|
+
expect { ProgressBar.new(-1) }
|
35
|
+
.to raise_error(ProgressBar::ArgumentError)
|
37
36
|
end
|
38
|
-
|
39
37
|
end
|
40
|
-
|
data/spec/bar_spec.rb
CHANGED
@@ -1,37 +1,39 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
2
|
|
3
|
-
|
3
|
+
require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
|
4
|
+
|
5
|
+
describe "ProgressBar bar output" do
|
4
6
|
let(:max) { 100 }
|
5
7
|
let(:terminal_width) { 12 }
|
6
8
|
|
7
9
|
let(:progress_bar) { ProgressBar.new(max, :bar) }
|
8
10
|
|
9
11
|
before do
|
10
|
-
progress_bar.
|
12
|
+
allow(progress_bar).to receive(:terminal_width).and_return(terminal_width)
|
11
13
|
progress_bar.count = count
|
12
14
|
end
|
13
15
|
|
14
16
|
subject { progress_bar.to_s }
|
15
17
|
|
16
|
-
describe
|
18
|
+
describe "at count=0" do
|
17
19
|
let(:count) { 0 }
|
18
20
|
|
19
21
|
it { should == "[ ]" }
|
20
22
|
end
|
21
23
|
|
22
|
-
describe
|
24
|
+
describe "at count=50" do
|
23
25
|
let(:count) { 50 }
|
24
26
|
|
25
27
|
it { should == "[##### ]" }
|
26
28
|
end
|
27
29
|
|
28
|
-
describe
|
30
|
+
describe "at count=100" do
|
29
31
|
let(:count) { 100 }
|
30
32
|
|
31
33
|
it { should == "[##########]" }
|
32
34
|
end
|
33
35
|
|
34
|
-
describe
|
36
|
+
describe "at count=25 (non-integer divide, should round down)" do
|
35
37
|
let(:count) { 25 }
|
36
38
|
|
37
39
|
it { should == "[## ]" }
|
@@ -50,6 +52,4 @@ describe 'ProgressBar bar output' do
|
|
50
52
|
end
|
51
53
|
end
|
52
54
|
end
|
53
|
-
|
54
55
|
end
|
55
|
-
|
data/spec/counter_spec.rb
CHANGED
@@ -1,50 +1,45 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
3
|
+
require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
|
4
|
+
|
5
|
+
describe "ProgressBar counter output" do
|
6
|
+
let(:progress_bar) { ProgressBar.new(100, :counter) }
|
7
7
|
|
8
|
-
subject {
|
8
|
+
subject { progress_bar.to_s }
|
9
9
|
|
10
|
-
describe
|
10
|
+
describe "at count=0" do
|
11
11
|
before do
|
12
|
-
|
12
|
+
progress_bar.count = 0
|
13
13
|
end
|
14
14
|
|
15
15
|
it { should == "[ 0/100]" }
|
16
16
|
end
|
17
17
|
|
18
|
-
describe
|
18
|
+
describe "at count=50" do
|
19
19
|
before do
|
20
|
-
|
20
|
+
progress_bar.count = 50
|
21
21
|
end
|
22
22
|
|
23
23
|
it { should == "[ 50/100]" }
|
24
24
|
end
|
25
25
|
|
26
|
-
describe
|
26
|
+
describe "at count=100" do
|
27
27
|
before do
|
28
|
-
|
28
|
+
progress_bar.count = 100
|
29
29
|
end
|
30
30
|
|
31
31
|
it { should == "[100/100]" }
|
32
32
|
end
|
33
33
|
|
34
|
-
describe
|
35
|
-
|
36
|
-
@progress_bar = ProgressBar.new(42, :counter)
|
37
|
-
end
|
34
|
+
describe "with a shorter max" do
|
35
|
+
let(:progress_bar) { ProgressBar.new(42, :counter) }
|
38
36
|
|
39
|
-
it { should ==
|
37
|
+
it { should == "[ 0/42]" }
|
40
38
|
end
|
41
39
|
|
42
|
-
describe
|
43
|
-
|
44
|
-
@progress_bar = ProgressBar.new(4242, :counter)
|
45
|
-
end
|
40
|
+
describe "with a longer max" do
|
41
|
+
let(:progress_bar) { ProgressBar.new(4242, :counter) }
|
46
42
|
|
47
|
-
it { should ==
|
43
|
+
it { should == "[ 0/4242]" }
|
48
44
|
end
|
49
|
-
|
50
45
|
end
|