Merge pull request #1 from Button99/develop

Add Memory Usage class

Author: Button99

.gitignore

@@ -1,6 +1,6 @@
 composer.phar
 /vendor/
-
+.idea
 # Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
 # composer.lock

README.md

@@ -32,6 +32,8 @@ Console::warning("Warning");
 Console::blue("This is a blue message");
 Console::magenta("This is a magenta message");
 Console::cyan("Cyan message for notification");
+Console::debug("Debug testing");
+Console::Notice("Notice testing");
 ```
 
 #### Progress Bar
@@ -65,6 +67,17 @@ Or withSteps method
 ```php
 Spinner::withSteps(0, 10, 1);
 ```
+#### MemoryUsage
+The `MemoryUsage` class tracks Memory consumption for executed functions.
+
+Usage:
+```php
+    $start = \Ckoumpis\PhpPrompt\MemoryUsage::getMemoryUsage();
+    $arr = array_fill(0, 100000, 'test');
+    $end = \Ckoumpis\PhpPrompt\MemoryUsage::getMemoryUsage();
+    $memoryUsage = \Ckoumpis\PhpPrompt\MemoryUsage::showMemory($end - $start);
+```
+
 
 ### Contributing
-We welcome contributions! If you find a bug or have a feature request, please open an issue or submit a pull request on Github.
+We welcome contributions! If you find a bug or have a feature request, please open an issue or submit a pull request on Github.

src/Console.php

@@ -9,11 +9,12 @@ class Console {
         'blue' => '0;34',
         'magenta' => '0;35',
         'cyan' => '0;36',
-        'white' => '1;37'
+        'white' => '1;37',
+        'grey' => '38;5;235'
     ];
 
     public static function log(string $message, string $color = 'white'): void {
-        $colorCode = self::COLORS[$color]?? self::COLORS['white'];
+        $colorCode = self::COLORS[$color] ?? self::COLORS['white'];
         echo "\033[" . $colorCode . "m" . $message . "\033[0m" . PHP_EOL;
     }
 
@@ -29,6 +30,16 @@ public static function warning(string $message): void {
         self::log("Warning: " . $message, 'yellow');
     }
 
+    public static function debug(string $message): void {
+        self::log("Debug: " . $message, 'grey');
+    }
+
+    public static function notice(string $message): void
+    {
+        self::log('Notice: '. $message, 'cyan');
+    }
+
+
     public static function blue(string $message): void {
         self::log("Blue: " . $message, 'blue');
     }
@@ -41,4 +52,4 @@ public static function cyan(string $message): void {
         self::log("Cyan: " . $message, 'cyan');
     }
 }
-?>
+?>

src/MemoryUsage.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Ckoumpis\PhpPrompt;
+
+class MemoryUsage
+{
+
+    const BYTES_MB = 1024;
+    const BYTES_KB = 1048576;
+
+    public static function getMemoryUsage(): float
+    {
+        return memory_get_usage();
+    }
+
+    public static function getPeakMemoryUsage(): float
+    {
+        return memory_get_peak_usage();
+    }
+
+    public static function showMemory(int $bytes): string
+    {
+        if ($bytes >= self::BYTES_MB) {
+            return self::formatMemory($bytes, self::BYTES_MB, ' MB');
+        } elseif ($bytes >= self::BYTES_KB) {
+            return self::formatMemory($bytes, self::BYTES_KB, ' KB');
+        } else {
+            return $bytes . " Bytes";
+        }
+    }
+
+    protected static function formatMemory(int $bytes, int $unitSize, string $unit): string
+    {
+        return round($bytes / $unitSize, 2) . ' ' . $unit;
+    }
+}

tests/ConsoleTest.php

@@ -0,0 +1,93 @@
+<?php
+
+
+use Ckoumpis\PhpPrompt\Console;
+use PHPUnit\Framework\TestCase;
+
+class ConsoleTest extends TestCase
+{
+
+    public function testWarning()
+    {
+        ob_start();
+        Console::warning('Testing warning!');
+        $output = ob_get_clean();
+        echo $output;
+        $this->assertStringContainsString("\033[1;33", $output);
+    }
+
+    public function testCyan()
+    {
+        ob_start();
+        Console::cyan('Testing Cyan!');
+        $output = ob_get_clean();
+        echo $output;
+        $this->assertStringContainsString("\033[0;36", $output);
+
+    }
+
+    public function testLog()
+    {
+        ob_start();
+        Console::log('Testing log!');
+        $output = ob_get_clean();
+        echo $output;
+        $this->assertStringContainsString("\033[1;37", $output);
+    }
+
+    public function testError()
+    {
+        ob_start();
+        Console::error('Testing error!');
+        $output = ob_get_clean();
+        echo $output;
+        $this->assertStringContainsString("\033[0;31", $output);
+    }
+
+    public function testSuccess()
+    {
+        ob_start();
+        Console::success('Testing success!');
+        $output = ob_get_clean();
+        echo $output;
+        $this->assertStringContainsString("\033[0;32", $output);
+    }
+
+    public function testMagenta()
+    {
+        ob_start();
+        Console::magenta('Testing magenta!');
+        $output = ob_get_clean();
+        echo $output;
+        $this->assertStringContainsString("\033[0;35", $output);
+
+    }
+
+    public function testBlue()
+    {
+        ob_start();
+        Console::blue('Testing blue!');
+        $output = ob_get_clean();
+        echo $output;
+        $this->assertStringContainsString("\033[0;34", $output);
+    }
+
+    public function testDebug()
+    {
+        ob_start();
+        Console::debug('Testing debug!');
+        $output = ob_get_clean();
+        echo $output;
+        $this->assertStringContainsString("\033[38;5;235", $output);
+    }
+
+    public function testNotice()
+    {
+        ob_start();
+        Console::notice('Testing notice!');
+        $output = ob_get_clean();
+        echo $output;
+        $this->assertStringContainsString("\033[0;36", $output);
+
+    }
+}

tests/MemUsageTest.php

@@ -0,0 +1,30 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+
+class MemUsageTest extends TestCase
+{
+    public function testMemoryUsage(): void {
+        ob_start();
+        $start = \Ckoumpis\PhpPrompt\MemoryUsage::getMemoryUsage();
+        $arr = array_fill(0, 100000, 'test');
+        $end = \Ckoumpis\PhpPrompt\MemoryUsage::getMemoryUsage();
+        $memoryUsage = \Ckoumpis\PhpPrompt\MemoryUsage::showMemory($end - $start);
+        ob_end_clean();
+        $this->assertGreaterThan(0, $end - $start, 'Memory usage is =<0');
+        $this->assertIsString($memoryUsage, 'Memory usage is string!');
+    }
+
+    public function testPeakMemoryUsage(): void {
+        ob_start();
+        $start = \Ckoumpis\PhpPrompt\MemoryUsage::getPeakMemoryUsage();
+        $arr = array_fill(0, 100000, 'test');
+        $end = \Ckoumpis\PhpPrompt\MemoryUsage::getPeakMemoryUsage();
+        $memoryUsage = \Ckoumpis\PhpPrompt\MemoryUsage::showMemory($end - $start);
+        echo $memoryUsage;
+        $content = ob_get_contents();
+        echo $content;
+        ob_end_clean();
+        $this->assertIsString($memoryUsage, 'Memory Peak usage is float!');
+    }
+}