develop/v0.1.0: Added more documentation and created a few Unit tests

Author: wazzac

CHANGELOG.md

@@ -0,0 +1,13 @@
+## v0.1.0-alpha `2025-06-14`
+
+Initial Alpha release. The package is functional, with documentation and unit tests included.
+
+### Added
+
+- Complete package scaffolding and setup.
+- Database migration for encrypted data storage.
+- Encryption table Eloquent model.
+- Reusable trait for model property/attribute encryption.
+- Core encryption controller.
+- Comprehensive documentation, including installation and usage guides.
+- Configuration file for package customization.

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing
+
+Thank you for considering to contribute to `laravel-db-encryption` 💖
+
+We are always open for code improvements and features.
+
+Please note that this project is released with a [Code of Conduct](https://github.com/wazzac/laravel-db-encryption/blob/main/CODE_OF_CONDUCT.md). By participating you agree to abide by its terms.
+
+Since this package provides encryption features, please be mindful what data is written to the log file.
+
+Lastly, for any new coding updates; please also include a unit test. Thank you 😉
+
+## Setup
+
+#### Fork this repo
+
+[https://github.com/wazzac/laravel-db-encryption](https://github.com/wazzac/laravel-db-encryption)
+
+#### Check the issues section if there are already issues and see if you can fix them
+
+
+[https://github.com/wazzac/laravel-db-encryption/issues](https://github.com/wazzac/laravel-db-encryption/issues)
+
+#### If the issue is new, add the code to the fork of the repository and then create a pull request.
+
+#### Add Feat or Fix to the pull request title so maintainer understand what this issue is about.

composer.lock

@@ -0,0 +1,23 @@
+<?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" colors="true">
+    <testsuites>
+        <testsuite name="Unit">
+            <directory>./tests/Unit</directory>
+        </testsuite>
+        <testsuite name="Feature">
+            <directory>./tests/Feature</directory>
+        </testsuite>
+    </testsuites>
+    <source>
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </source>
+    <php>
+        <env name="APP_ENV" value="testing"/>
+        <env name="DB_ENCRYPT_DB_PRIMARY_KEY_FORMAT" value="int"/>
+        <env name="DB_ENCRYPT_KEY" value="Ky4cw2sqPi0Hm7w0UqYa"/>
+        <env name="DB_ENCRYPT_LOG_INDICATOR" value="sync-modeltocrm"/>
+        <env name="DB_ENCRYPT_LOG_LEVEL" value="3"/>
+    </php>
+</phpunit>

phpunit.xml

@@ -0,0 +1,5 @@
+<?php
+
+it('contains a successful example feature test', function () {
+    expect(true)->toBeTrue();
+});

tests/Feature/ExampleTest.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| 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 "pest()" function to bind a different classes or traits.
+|
+*/
+
+uses(\Wazza\DbEncrypt\Tests\TestCase::class)->in('Unit', 'Feature');
+
+/*
+|--------------------------------------------------------------------------
+| Expectations
+|--------------------------------------------------------------------------
+|
+| When you're writing tests, you often need to check that values meet certain conditions. The
+| "expect()" function gives you access to a set of "expectations" methods that you can use
+| to assert different things. Of course, you may extend the Expectation API at any time.
+|
+*/
+
+expect()->extend('toBeOne', function () {
+    return $this->toBe(1);
+});
+
+/*
+|--------------------------------------------------------------------------
+| Functions
+|--------------------------------------------------------------------------
+|
+| While Pest is very powerful out-of-the-box, you may have some testing code specific to your
+| project that you don't want to repeat in every file. Here you can also expose helpers as
+| global functions to help you to reduce the number of lines of code in your test files.
+|
+*/
+
+function something()
+{
+    // ..
+}

tests/Pest.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Wazza\DbEncrypt\Tests;
+
+use Orchestra\Testbench\TestCase as OrchestraTestCase;
+use Illuminate\Foundation\Testing\DatabaseMigrations;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Wazza\DbEncrypt\Providers\DbEncryptServiceProvider;
+use Wazza\DbEncrypt\Models\EncryptedAttributes;
+
+abstract class TestCase extends OrchestraTestCase
+{
+    use DatabaseMigrations, DatabaseTransactions;
+
+    /**
+     * Setup the test environment.
+     *
+     * @return void
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->loadMigrationsFrom(__DIR__ . '/../database/migrations');
+        // $this->withFactories(__DIR__ . '/../database/factories');
+    }
+
+    /**
+     * Add the package provider
+     *
+     * @param $app
+     * @return array
+     */
+    protected function getPackageProviders($app)
+    {
+        return [
+            DbEncryptServiceProvider::class,
+        ];
+    }
+
+    /**
+     * Define environment setup.
+     *
+     * @param  \Illuminate\Foundation\Application $app
+     * @return void
+     */
+    protected function getEnvironmentSetUp($app)
+    {
+        $app['config']->set('database.default', 'testdb');
+        $app['config']->set('database.connections.testdb', [
+            'driver' => 'sqlite',
+            'database' => __DIR__ . '/testdb.sqlite',
+            'prefix' => '',
+        ]);
+        $app['config']->set('db-encrypt.db.primary_key_format', env('DB_ENCRYPT_DB_PRIMARY_KEY_FORMAT', 'int'));
+        $app['config']->set('db-encrypt.logging.level', env('DB_ENCRYPT_LOG_LEVEL'));
+        $app['config']->set('db-encrypt.logging.indicator', env('DB_ENCRYPT_LOG_INDICATOR'));
+        $app['config']->set('db-encrypt.key', env('DB_ENCRYPT_KEY'));
+    }
+
+    /**
+     * Define aliases for the package
+     */
+    protected function getPackageAliases($app)
+    {
+        return [
+            'config' => 'Illuminate\Config\Repository'
+        ];
+    }
+}