Skip to content

Commit 4df98f1

Browse files
mreduarmreduar
committed
Initial commit
0 parents  commit 4df98f1

15 files changed

+593
-0
lines changed

‎.editorconfig

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
; This file is for unifying the coding style for different editors and IDEs.
2+
; More information at http://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
indent_size = 4
9+
indent_style = space
10+
end_of_line = lf
11+
insert_final_newline = true
12+
trim_trailing_whitespace = true
13+
14+
[*.md]
15+
trim_trailing_whitespace = false

‎.gitattributes

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Path-based git attributes
2+
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
3+
4+
# Ignore all test and documentation with "export-ignore".
5+
/.gitattributes export-ignore
6+
/.gitignore export-ignore
7+
/.travis.yml export-ignore
8+
/phpunit.xml.dist export-ignore
9+
/.scrutinizer.yml export-ignore
10+
/tests export-ignore
11+
/.editorconfig export-ignore

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
build
2+
composer.lock
3+
docs
4+
vendor
5+
coverage

‎CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
All notable changes to `laravel-balance` will be documented in this file
4+
5+
## 1.0.0 - 2021-03-19
6+
7+
- initial release

‎CONTRIBUTING.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
Please read and understand the contribution guide before creating an issue or pull request.
6+
7+
## Etiquette
8+
9+
This project is open source, and as such, the maintainers give their free time to build and maintain the source code
10+
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
11+
extremely unfair for them to suffer abuse or anger for their hard work.
12+
13+
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
14+
world that developers are civilized and selfless people.
15+
16+
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
17+
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.
18+
19+
## Viability
20+
21+
When requesting or submitting new features, first consider whether it might be useful to others. Open
22+
source projects are used by many developers, who may have entirely different needs to your own. Think about
23+
whether or not your feature is likely to be used by other users of the project.
24+
25+
## Procedure
26+
27+
Before filing an issue:
28+
29+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
30+
- Check to make sure your feature suggestion isn't already present within the project.
31+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
32+
- Check the pull requests tab to ensure that the feature isn't already in progress.
33+
34+
Before submitting a pull request:
35+
36+
- Check the codebase to ensure that your feature doesn't already exist.
37+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
38+
39+
## Requirements
40+
41+
If the project maintainer has any additional requirements, you will find them listed here.
42+
43+
- **[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).
44+
45+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
46+
47+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
48+
49+
- **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.
50+
51+
**Happy coding**!

‎LICENSE.md

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

‎README.md

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Laravel Balance
2+
3+
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.
4+
5+
6+
## Installation
7+
8+
You can install the package via composer:
9+
10+
``` bash
11+
composer require mreduar/laravel-balance
12+
```
13+
You can publish and run the migrations with:
14+
15+
```bash
16+
php artisan vendor:publish --provider="MrEduar\Balance\BalanceServiceProvider" --tag="migrations"
17+
php artisan migrate
18+
```
19+
You can publish the config file with:
20+
21+
```bash
22+
php artisan vendor:publish --provider="MrEduar\Balance\BalanceServiceProvider" --tag="config"
23+
```
24+
This is the contents of the published config file:
25+
26+
```
27+
<?php
28+
29+
return [
30+
31+
/*
32+
|--------------------------------------------------------------------------
33+
| Table name
34+
|--------------------------------------------------------------------------
35+
|
36+
| Table name to use to store balance history transactions.
37+
|
38+
*/
39+
40+
'table' => 'balance_history',
41+
42+
];
43+
```
44+
## Usage
45+
46+
Adding the `HasBalance` trait will enable balance functionality on the Model.
47+
48+
``` php
49+
use Illuminate\Foundation\Auth\User as Authenticatable;
50+
use MrEduar\Balance\HasBalance;
51+
52+
class User extends Authenticatable
53+
{
54+
use HasBalance;
55+
}
56+
```
57+
58+
##### Basic operations
59+
60+
```php
61+
$user->increaseBalance(2575);
62+
$user->balance; // 25.75
63+
64+
$user->decreaseBalance(2575);
65+
$user->balance; // 0
66+
67+
$user->modifyBalance(-2537);
68+
$user->balance; // -25.37
69+
70+
$user->modifyBalance(3037);
71+
$user->balance; // 5
72+
```
73+
74+
##### Reset balance
75+
76+
It's also possible to reset the balance and directly setting a new value.
77+
78+
```php
79+
$user->resetBalance(); // 0
80+
81+
$user->resetBalance(10); // 10
82+
```
83+
84+
##### Check if model has balance
85+
86+
Check if there is a positive balance or a balance greater than that provided.
87+
```php
88+
$user->hasBalance();
89+
$user->hasBalance(2575);
90+
```
91+
92+
##### Check if model has balance
93+
94+
Check if there is a positive balance or a balance greater than that provided.
95+
```php
96+
$user->hasBalance();
97+
$user->hasBalance(2575);
98+
```
99+
100+
##### Check if model has no balance
101+
102+
Check if there is no more balance.
103+
```php
104+
$user->hasNoBalance();
105+
```
106+
107+
## Contributing
108+
109+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
110+
111+
112+
## License
113+
114+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

‎composer.json

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
{
2+
"name": "mreduar/laravel-balance",
3+
"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.",
4+
"keywords": [
5+
"mreduar",
6+
"laravel",
7+
"laravel-balance",
8+
"balance",
9+
"balance-history",
10+
"money"
11+
],
12+
"homepage": "https://github.com/mreduar/laravel-balance",
13+
"license": "MIT",
14+
"type": "library",
15+
"authors": [
16+
{
17+
"name": "Eduar Bastidas",
18+
"email": "[email protected]",
19+
"role": "Developer"
20+
}
21+
],
22+
"require": {
23+
"php": "^7.1",
24+
"illuminate/support": "^6.0|^7.0|^8.0"
25+
},
26+
"require-dev": {
27+
"orchestra/testbench": "^4.0",
28+
"phpunit/phpunit": "^8.0"
29+
},
30+
"autoload": {
31+
"psr-4": {
32+
"MrEduar\\Balance\\": "src"
33+
}
34+
},
35+
"autoload-dev": {
36+
"psr-4": {
37+
"MrEduar\\Balance\\Tests\\": "tests"
38+
}
39+
},
40+
"scripts": {
41+
"test": "vendor/bin/phpunit",
42+
"test-coverage": "vendor/bin/phpunit --coverage-html coverage"
43+
44+
},
45+
"config": {
46+
"sort-packages": true
47+
},
48+
"extra": {
49+
"laravel": {
50+
"providers": [
51+
"MrEduar\\Balance\\BalanceServiceProvider"
52+
]
53+
}
54+
}
55+
}

‎config/balance.php

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?php
2+
3+
return [
4+
5+
/*
6+
|--------------------------------------------------------------------------
7+
| Table name
8+
|--------------------------------------------------------------------------
9+
|
10+
| Table name to use to store balance history transactions.
11+
|
12+
*/
13+
14+
'table' => 'balance_history',
15+
16+
];

‎database/migrations/2021_03_19_100000_create_balance_history_table.php

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?php
2+
3+
use Illuminate\Database\Migrations\Migration;
4+
use Illuminate\Database\Schema\Blueprint;
5+
use Illuminate\Support\Facades\Schema;
6+
7+
class CreateBalanceHistoryTable extends Migration
8+
{
9+
/**
10+
* Run the migrations.
11+
*
12+
* @return void
13+
*/
14+
public function up()
15+
{
16+
Schema::create('balance_history', function (Blueprint $table) {
17+
$table->id();
18+
$table->morphs('balanceable');
19+
$table->integer('amount');
20+
21+
//morphs referenceable nullable
22+
$table->string('referenceable_type')->nullable();
23+
$table->unsignedBigInteger('referenceable_id')->nullable();
24+
25+
$table->text('description')->nullable();
26+
$table->timestamps();
27+
28+
//compound index
29+
$table->index(['referenceable_type', 'referenceable_id']);
30+
});
31+
}
32+
33+
/**
34+
* Reverse the migrations.
35+
*
36+
* @return void
37+
*/
38+
public function down()
39+
{
40+
Schema::dropIfExists('balance_history');
41+
}
42+
}

‎phpunit.xml.dist

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<phpunit bootstrap="vendor/autoload.php"
3+
backupGlobals="false"
4+
backupStaticAttributes="false"
5+
colors="true"
6+
verbose="true"
7+
convertErrorsToExceptions="true"
8+
convertNoticesToExceptions="true"
9+
convertWarningsToExceptions="true"
10+
processIsolation="false"
11+
stopOnFailure="false">
12+
<testsuites>
13+
<testsuite name="Test Suite">
14+
<directory>tests</directory>
15+
</testsuite>
16+
</testsuites>
17+
<filter>
18+
<whitelist>
19+
<directory suffix=".php">src/</directory>
20+
</whitelist>
21+
</filter>
22+
<logging>
23+
<log type="tap" target="build/report.tap"/>
24+
<log type="junit" target="build/report.junit.xml"/>
25+
<log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
26+
<log type="coverage-text" target="build/coverage.txt"/>
27+
<log type="coverage-clover" target="build/logs/clover.xml"/>
28+
</logging>
29+
</phpunit>

0 commit comments

Comments
 (0)