Initial commit

Author: codebarista

.gitattributes

@@ -0,0 +1,4 @@
+/tests export-ignore
+/phpunit.xml export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore

.gitignore

@@ -0,0 +1,4 @@
+/vendor
+composer.lock
+.idea
+

README.md

@@ -1,2 +1,15 @@
-# laravel-essentials
-Tiny extensions and helpers for Laravel projects
+# Laravel Essentials
+
+Growing library for simple macros, facades and other helpers in the Laravel cosmos .
+
+## Installation
+
+### Install package
+
+```shell
+composer require codebarista/laravel-essentials
+```
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE) for more information.

bootstrap/helpers.php

@@ -0,0 +1,15 @@
+<?php
+
+if (! function_exists('encode_json')) {
+    function encode_json(array $value): bool|string
+    {
+        return \Illuminate\Support\Arr::toJson($value);
+    }
+}
+
+if (! function_exists('decode_json')) {
+    function decode_json(string $value): array
+    {
+        return \Illuminate\Support\Str::toJson($value);
+    }
+}

composer.json

@@ -0,0 +1,59 @@
+{
+    "name": "codebarista/laravel-essentials",
+    "description": "Tiny extensions and helpers for Laravel projects.",
+    "type": "library",
+    "keywords": [
+        "laravel",
+        "extensions",
+        "helpers"
+    ],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Ralf Langebrake",
+            "email": "ralf@langebrake.com"
+        }
+    ],
+    "require": {
+        "php": "^8.3",
+        "laravel/framework": "^10.0",
+        "spatie/laravel-health": "^1.20"
+    },
+    "require-dev": {
+        "orchestra/testbench": "^v8.21",
+        "pestphp/pest-plugin-laravel": "^2.0"
+    },
+    "suggest": {
+        "barryvdh/laravel-ide-helper": "Enables your IDE to provide accurate autocompletion"
+    },
+    "autoload": {
+        "psr-4": {
+            "Codebarista\\LaravelEssentials\\": "src/"
+        },
+        "files": [
+            "bootstrap/helpers.php"
+        ]
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Codebarista\\LaravelEssentials\\Tests\\": "tests/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Codebarista\\LaravelEssentials\\EssentialsServiceProvider"
+            ]
+        }
+    },
+    "config": {
+        "optimize-autoloader": true,
+        "preferred-install": "dist",
+        "sort-packages": true,
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}

phpunit.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         stopOnFailure="true"
+         cacheResult="false"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="Laravel Essentials Test Suite">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <source>
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </source>
+</phpunit>

src/Checks/OpcodeCacheCheck.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Codebarista\LaravelEssentials\Checks;
+
+use Spatie\Health\Checks\Check;
+use Spatie\Health\Checks\Result;
+
+class OpcodeCacheCheck extends Check
+{
+    public function run(): Result
+    {
+        if ($status = opcache_get_status(false)) {
+            if ((bool) $status['opcache_enabled'] === true) {
+                return Result::make()->ok();
+            }
+
+            return Result::make()->warning('Disabled');
+        }
+
+        return Result::make()->failed('Absent');
+    }
+}

src/EssentialsServiceProvider.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Codebarista\LaravelEssentials;
+
+use Illuminate\Support\Arr;
+use Illuminate\Support\ServiceProvider;
+use Illuminate\Support\Str;
+
+class EssentialsServiceProvider extends ServiceProvider
+{
+    public function register(): void
+    {
+        $this->registerStringMacros();
+        $this->registerArrayMacros();
+    }
+
+    public function boot(): void
+    {
+    }
+
+    private function registerStringMacros(): void
+    {
+        $macros = [
+            'toJson' => \Codebarista\LaravelEssentials\Macros\String\Json::class,
+        ];
+
+        foreach ($macros as $name => $class) {
+            if (! Str::hasMacro($name)) {
+                Str::macro($name, app($class));
+            }
+        }
+    }
+
+    private function registerArrayMacros(): void
+    {
+        $macros = [
+            'toJson' => \Codebarista\LaravelEssentials\Macros\Array\Json::class,
+        ];
+
+        foreach ($macros as $name => $class) {
+            if (! Arr::hasMacro($name)) {
+                Arr::macro($name, app($class));
+            }
+        }
+    }
+}

src/Facades/DB.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Codebarista\LaravelEssentials\Facades;
+
+use Illuminate\Support\Collection;
+
+class DB extends \Illuminate\Support\Facades\DB
+{
+    public static function collect(string $query, array $bindings): Collection
+    {
+        return collect(self::select($query, $bindings));
+    }
+}

src/Macros/Array/Json.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Codebarista\LaravelEssentials\Macros\Array;
+
+class Json
+{
+    public function __invoke(array $value, bool $pretty = false): bool|string
+    {
+        $flags = JSON_NUMERIC_CHECK
+            | JSON_THROW_ON_ERROR
+            | JSON_UNESCAPED_SLASHES;
+
+        if ($pretty === true) {
+            $flags |= JSON_PRETTY_PRINT;
+        }
+
+        return json_encode($value, $flags);
+    }
+}

src/Macros/String/Json.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Codebarista\LaravelEssentials\Macros\String;
+
+class Json
+{
+    public function __invoke(
+        string $value,
+        bool $associative = true,
+        int $depth = 512,
+        int $flags = JSON_THROW_ON_ERROR
+    ): array|object {
+        return json_decode($value, $associative, $depth, $flags);
+    }
+}

tests/Feature/HelpersTest.php

@@ -0,0 +1,26 @@
+<?php
+
+it('decodes json string to array', function () {
+    $value = <<<'JSON'
+        {
+            "greeting": "Gude Moin"
+        }
+    JSON;
+
+    expect(decode_json($value))
+        ->toBeArray()
+        ->toHaveKey('greeting')
+        ->toContain('Gude Moin');
+
+})->covers('decode_json');
+
+it('encodes array to json string', function () {
+    $value = [
+        'greeting' => 'Gude Moin',
+    ];
+
+    expect(encode_json($value))
+        ->toBeString()
+        ->toContain('greeting');
+
+})->covers('encode_json');

tests/PackageTestCase.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codebarista\LaravelEssentials\Tests;
+
+use Codebarista\LaravelEssentials\EssentialsServiceProvider;
+use Orchestra\Testbench\TestCase;
+
+abstract class PackageTestCase extends TestCase
+{
+    protected function getPackageProviders($app): array
+    {
+        return [
+            EssentialsServiceProvider::class,
+        ];
+    }
+}

tests/Pest.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+use Codebarista\LaravelEssentials\Tests\PackageTestCase;
+
+/*
+|--------------------------------------------------------------------------
+| Test Case
+|--------------------------------------------------------------------------
+|
+| The closure you provide to your test functions is always bound to a specific PHPUnit test
+| case class. By default, that class is "PHPUnit\Framework\TestCase". Of course, you may
+| need to change it using the "uses()" function to bind a different classes or traits.
+|
+*/
+
+uses(PackageTestCase::class)->in(__DIR__);