Initial commit

.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,11 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.travis.yml        export-ignore
+/phpunit.xml.dist   export-ignore
+/.scrutinizer.yml   export-ignore
+/tests              export-ignore
+/.editorconfig      export-ignore

.gitignore

@@ -0,0 +1,5 @@
+build
+composer.lock
+docs
+vendor
+coverage

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to `laravel-balance` will be documented in this file
+
+## 1.0.0 - 2021-03-19
+
+- initial release

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Eduar Bastidas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,114 @@
+# Laravel Balance
+
+Maintains a history of balance movements in the eloquent models. This simple package will keep track of the balance of your models. You can increase, decrease, reset and set the balance. It is also possible to check if a model has a positive balance or no balance.
+
+
+## Installation
+
+You can install the package via composer:
+
+``` bash
+composer require mreduar/laravel-balance
+```
+You can publish and run the migrations with:
+
+```bash
+php artisan vendor:publish --provider="MrEduar\Balance\BalanceServiceProvider" --tag="migrations"
+php artisan migrate
+```
+You can publish the config file with:
+
+```bash
+php artisan vendor:publish --provider="MrEduar\Balance\BalanceServiceProvider" --tag="config"
+```
+This is the contents of the published config file:
+
+```
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Table name
+    |--------------------------------------------------------------------------
+    |
+    | Table name to use to store balance history transactions.
+    |
+    */
+
+    'table' => 'balance_history',
+
+];
+```
+## Usage
+
+Adding the `HasBalance` trait will enable balance functionality on the Model.
+
+``` php
+use Illuminate\Foundation\Auth\User as Authenticatable;
+use MrEduar\Balance\HasBalance;
+
+class User extends Authenticatable
+{
+    use HasBalance;
+}
+```
+
+##### Basic operations
+
+```php
+$user->increaseBalance(2575);
+$user->balance; // 25.75
+
+$user->decreaseBalance(2575);
+$user->balance; // 0
+
+$user->modifyBalance(-2537);
+$user->balance; // -25.37
+
+$user->modifyBalance(3037);
+$user->balance; // 5
+```
+
+##### Reset balance
+
+It's also possible to reset the balance and directly setting a new value.
+
+```php
+$user->resetBalance(); // 0
+
+$user->resetBalance(10); // 10
+```
+
+##### Check if model has balance
+
+Check if there is a positive balance or a balance greater than that provided.
+```php
+$user->hasBalance();
+$user->hasBalance(2575);
+```
+
+##### Check if model has balance
+
+Check if there is a positive balance or a balance greater than that provided.
+```php
+$user->hasBalance();
+$user->hasBalance(2575);
+```
+
+##### Check if model has no balance
+
+Check if there is no more balance.
+```php
+$user->hasNoBalance();
+```
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,55 @@
+{
+    "name": "mreduar/laravel-balance",
+    "description": "Maintains a history of balance movements in the eloquent models. This simple package will keep track of the balance of your models. You can increase, decrease, reset and set the balance. It is also possible to check if a model has a positive balance or no balance.",
+    "keywords": [
+        "mreduar",
+        "laravel",
+        "laravel-balance",
+        "balance",
+        "balance-history",
+        "money"
+    ],
+    "homepage": "https://github.com/mreduar/laravel-balance",
+    "license": "MIT",
+    "type": "library",
+    "authors": [
+        {
+            "name": "Eduar Bastidas",
+            "email": "[email protected]",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": "^7.1",
+        "illuminate/support": "^6.0|^7.0|^8.0"
+    },
+    "require-dev": {
+        "orchestra/testbench": "^4.0",
+        "phpunit/phpunit": "^8.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "MrEduar\\Balance\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "MrEduar\\Balance\\Tests\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit",
+        "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
+
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "MrEduar\\Balance\\BalanceServiceProvider"
+            ]
+        }
+    }
+}

config/balance.php

@@ -0,0 +1,16 @@
+<?php
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Table name
+    |--------------------------------------------------------------------------
+    |
+    | Table name to use to store balance history transactions.
+    |
+    */
+
+    'table' => 'balance_history',
+
+];

database/migrations/2021_03_19_100000_create_balance_history_table.php

@@ -0,0 +1,42 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateBalanceHistoryTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('balance_history', function (Blueprint $table) {
+            $table->id();
+            $table->morphs('balanceable');
+            $table->integer('amount');
+
+            //morphs referenceable nullable
+            $table->string('referenceable_type')->nullable();
+            $table->unsignedBigInteger('referenceable_id')->nullable();
+
+            $table->text('description')->nullable();
+            $table->timestamps();
+
+            //compound index
+            $table->index(['referenceable_type', 'referenceable_id']);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('balance_history');
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="tap" target="build/report.tap"/>
+        <log type="junit" target="build/report.junit.xml"/>
+        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
+        <log type="coverage-text" target="build/coverage.txt"/>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    </logging>
+</phpunit>