Progress   A
last analyzed

Coupling/Cohesion

Components 1
Dependencies 5

Complexity

Total Complexity 23

Size/Duplication

Total Lines 260
Duplicated Lines 0 %

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
wmc 23
lcom 1
cbo 5
dl 0
loc 260
ccs 66
cts 66
cp 1
rs 10
c 0
b 0
f 0

13 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 6 2
A total() 0 6 1
A advance() 0 4 1
A getProgressBar() 0 19 3
A getBar() 0 7 1
A getBarStrLen() 0 9 2
A percentageFormatted() 0 4 1
A labelFormatted() 0 4 1
A current() 0 16 3
A forceRedraw() 0 6 1
A drawProgressBar() 0 11 2
A getProgressBarStr() 0 14 2
A shouldRedraw() 0 4 3
1
<?php
2
3
namespace League\CLImate\TerminalObject\Dynamic;
4
5
class Progress extends DynamicTerminalObject
6
{
7
    /**
8
     * The total number of items involved
9
     *
10
     * @var integer $total
11
     */
12
    protected $total = 0;
13
14
    /**
15
     * The current item that the progress bar represents
16
     *
17
     * @var integer $current
18
     */
19
    protected $current = 0;
20
21
    /**
22
     * The current percentage displayed
23
     *
24
     * @var string $current_percentage
25
     */
26
    protected $current_percentage = '';
27
28
    /**
29
     * The string length of the bar when at 100%
30
     *
31
     * @var integer $bar_str_len
32
     */
33
    protected $bar_str_len;
34
35
    /**
36
     * Flag indicating whether we are writing the bar for the first time
37
     *
38
     * @var boolean $first_line
39
     */
40
    protected $first_line = true;
41
42
    /**
43
     * Current status bar label
44
     *
45
     * @var string $label
46
     */
47
    protected $label;
48
49
    /**
50
     * Force a redraw every time
51
     *
52
     * @var boolean $force_redraw
53
     */
54
    protected $force_redraw = false;
55
56
    /**
57
     * If they pass in a total, set the total
58
     *
59
     * @param integer $total
60
     */
61 44
    public function __construct($total = null)
62
    {
63 44
        if ($total !== null) {
64 20
            $this->total($total);
65 20
        }
66 44
    }
67
68
    /**
69
     * Set the total property
70
     *
71
     * @param  integer $total
72
     *
73
     * @return Progress
74
     */
75 40
    public function total($total)
76
    {
77 40
        $this->total = $total;
78
79 40
        return $this;
80
    }
81
82
    /**
83
     * Determines the current percentage we are at and re-writes the progress bar
84
     *
85
     * @param integer $current
86
     * @param mixed   $label
87
     * @throws \Exception
88
     */
89 44
    public function current($current, $label = null)
90
    {
91 44
        if ($this->total == 0) {
92
            // Avoid dividing by 0
93 4
            throw new \Exception('The progress total must be greater than zero.');
94
        }
95
96 40
        if ($current > $this->total) {
97 4
            throw new \Exception('The current is greater than the total.');
98
        }
99
100 36
        $this->drawProgressBar($current, $label);
101
102 36
        $this->current = $current;
103 36
        $this->label   = $label;
104 36
    }
105
106
    /**
107
     * Increments the current position we are at and re-writes the progress bar
108
     *
109
     * @param integer $increment The number of items to increment by
110
     * @param string $label
111
     */
112 8
    public function advance($increment = 1, $label = null)
113
    {
114 8
        $this->current($this->current + $increment, $label);
115 8
    }
116
117
    /**
118
     * Force the progress bar to redraw every time regardless of whether it has changed or not
119
     *
120
     * @param boolean $force
121
     * @return Progress
122
     */
123 8
    public function forceRedraw($force = true)
124
    {
125 8
        $this->force_redraw = !!$force;
126
127 8
        return $this;
128
    }
129
130
    /**
131
     * Draw the progress bar, if necessary
132
     *
133
     * @param string $current
134
     * @param string $label
135
     */
136 36
    protected function drawProgressBar($current, $label)
137
    {
138 36
        $percentage = $this->percentageFormatted($current / $this->total);
139
140 36
        if ($this->shouldRedraw($percentage, $label)) {
141 36
            $progress_bar = $this->getProgressBar($current, $label);
142 36
            $this->output->write($this->parser->apply($progress_bar));
143 36
        }
144
145 36
        $this->current_percentage = $percentage;
146 36
    }
147
148
    /**
149
     * Build the progress bar str and return it
150
     *
151
     * @param integer $current
152
     * @param string $label
153
     *
154
     * @return string
155
     */
156 36
    protected function getProgressBar($current, $label)
157
    {
158 36
        if ($this->first_line) {
159
            // Drop down a line, we are about to
160
            // re-write this line for the progress bar
161 36
            $this->output->write('');
162 36
            $this->first_line = false;
163 36
        }
164
165
        // Move the cursor up one line and clear it to the end
166 36
        $line_count    = (strlen($label) > 0) ? 2 : 1;
167
168 36
        $progress_bar  = $this->util->cursor->up($line_count);
169 36
        $progress_bar .= $this->util->cursor->startOfCurrentLine();
170 36
        $progress_bar .= $this->util->cursor->deleteCurrentLine();
171 36
        $progress_bar .= $this->getProgressBarStr($current, $label);
172
173 36
        return $progress_bar;
174
    }
175
176
    /**
177
     * Get the progress bar string, basically:
178
     * =============>             50% label
179
     *
180
     * @param integer $current
181
     * @param string $label
182
     *
183
     * @return string
184
     */
185 36
    protected function getProgressBarStr($current, $label)
186
    {
187 36
        $percentage = $current / $this->total;
188 36
        $bar_length = round($this->getBarStrLen() * $percentage);
189
190 36
        $bar        = $this->getBar($bar_length);
191 36
        $number     = $this->percentageFormatted($percentage);
192
193 36
        if ($label) {
194 8
            $label = $this->labelFormatted($label);
195 8
        }
196
197 36
        return trim("{$bar} {$number}{$label}");
198
    }
199
200
    /**
201
     * Get the string for the actual bar based on the current length
202
     *
203
     * @param integer $length
204
     *
205
     * @return string
206
     */
207 36
    protected function getBar($length)
208
    {
209 36
        $bar     = str_repeat('=', $length);
210 36
        $padding = str_repeat(' ', $this->getBarStrLen() - $length);
211
212 36
        return "{$bar}>{$padding}";
213
    }
214
215
    /**
216
     * Get the length of the bar string based on the width of the terminal window
217
     *
218
     * @return integer
219
     */
220 36
    protected function getBarStrLen()
221
    {
222 36
        if (!$this->bar_str_len) {
223
            // Subtract 10 because of the '> 100%' plus some padding, max 100
224 36
            $this->bar_str_len = min($this->util->width() - 10, 100);
225 36
        }
226
227 36
        return $this->bar_str_len;
228
    }
229
230
    /**
231
     * Format the percentage so it looks pretty
232
     *
233
     * @param integer $percentage
234
     * @return float
235
     */
236 36
    protected function percentageFormatted($percentage)
237
    {
238 36
        return round($percentage * 100) . '%';
239
    }
240
241
    /**
242
     * Format the label so it is positioned correctly
243
     *
244
     * @param string $label
245
     * @return string
246
     */
247 8
    protected function labelFormatted($label)
248
    {
249 8
        return "\n" . $this->util->cursor->startOfCurrentLine() . $this->util->cursor->deleteCurrentLine() . $label;
250
    }
251
252
    /**
253
     * Determine whether the progress bar has changed and we need to redrew
254
     *
255
     * @param string $percentage
256
     * @param string $label
257
     *
258
     * @return boolean
259
     */
260 36
    protected function shouldRedraw($percentage, $label)
261
    {
262 36
        return ($this->force_redraw || $percentage != $this->current_percentage || $label != $this->label);
263
    }
264
}
265