initial commit

Signed-off-by: Dion Purushotham <mail@dion.codes>

Author: dioncodes

README.md

@@ -0,0 +1,21 @@
+# Script Progress
+This is a super simple library for php-cli script progress output. It’s easy-to-use and can print the estimated time that is left until your script is done.
+
+`20% done. Appr. 00m 16s remaining.`
+
+That’s it.
+
+## Example Usage
+```php
+$numberOfItems = 20;
+$progress = new TinyApps\ScriptProgress\Progress($numberOfItems);
+
+for ($i=0; $i <= $numberOfItems; $i++) {
+    // do something
+    $progress->update($i);
+}
+```
+
+There also is an example in the corresponding folder.
+
+More features might be added soon.

composer.json

@@ -0,0 +1,21 @@
+{
+	"name": "tinyapps/script-progress",
+	"description": "Super simple library for live-updating php-cli script progress output with estimated time that is left.",
+	"type": "library",
+	"version": "1.0.0",
+	"require": {
+		"php": ">=7.0.0"
+	},
+	"autoload": {
+		"psr-4": {
+			"TinyApps\\ScriptProgress\\": "src/"
+		}
+	},
+	"license": "MIT",
+	"authors": [
+		{
+			"name": "Dion Purushotham",
+			"email": "hello@tinyapps.de"
+		}
+	]
+}

examples/example.php

@@ -0,0 +1,12 @@
+<?php
+
+use TinyApps\ScriptProgress\Progress;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+$progress = new Progress(20);
+
+for ($i=0; $i <= 20; $i++) {
+	$progress->update($i);
+	sleep(1);
+}

src/Progress.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace TinyApps\ScriptProgress;
+
+/**
+ * @author Dion Purushotham <hello@tinyapps.de>
+ */
+class Progress {
+
+	protected int $total;
+	protected int $startTime;
+	protected int $lastPrintedTime;
+	protected int $interval = 1;
+
+	/**
+	 * Initialize live-updating progress text
+	 *
+	 * @param integer $total Total amount of items (matching 100% progress)
+	 * @param integer $interval How many seconds should at least (!) pass between output/update
+	 */
+	public function __construct(int $total, int $interval = 1) {
+		$this->total = $total;
+		$this->startTime = time();
+		$this->lastPrintedTime = time();
+		$this->interval = $interval;
+
+		echo "\n0% done. Please wait...";
+	}
+
+	/**
+	 * Prints and updates the command line output (considering interval)
+	 *
+	 * @param integer $done number of items done (for calculating progress)
+	 *
+	 * @return void
+	 */
+	public function update(int $done) {
+		if ($done >= $this->total) {
+			$timePassed = time() - $this->startTime;
+			$minutes = floor($timePassed / 60);
+			$seconds = floor($timePassed % 60);
+
+			echo "\r";
+			echo '100% done in ' . $minutes . ' min. and ' . $seconds . ' sec.';
+			echo str_repeat(' ', 5) . "\n";
+
+			return;
+		}
+
+		if ($done > 0 && $this->lastPrintedTime < time() - $this->interval) {
+			$timePassed = time() - $this->startTime;
+			$averageTimeEach = $timePassed / $done;
+			$timeRemaining = $averageTimeEach * ($this->total - $done);
+			$minutesRemaining = floor($timeRemaining / 60);
+			$secondsRemaining = floor($timeRemaining % 60);
+
+			$percentage = floor(($done / $this->total) * 100);
+
+			echo "\r";
+			echo  ($percentage < 10 ? '0' . $percentage : $percentage) . '% done. ';
+			echo 'Appr. ' . ($minutesRemaining > 9 ? $minutesRemaining : '0' . $minutesRemaining) . 'm ' . ($secondsRemaining > 9 ? $secondsRemaining : '0' . $secondsRemaining) . 's remaining.  ';
+		}
+	}
+}