Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inmanturbo/futomaki
Fat sushi rolls
https://github.com/inmanturbo/futomaki
Last synced: about 1 month ago
JSON representation
Fat sushi rolls
- Host: GitHub
- URL: https://github.com/inmanturbo/futomaki
- Owner: inmanturbo
- License: mit
- Created: 2024-03-15T20:08:38.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-07-08T20:57:15.000Z (4 months ago)
- Last Synced: 2024-09-13T22:54:56.458Z (about 2 months ago)
- Language: PHP
- Homepage:
- Size: 89.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Fat sushi rolls
[](https://packagist.org/packages/inmanturbo/futomaki)
[](https://github.com/inmanturbo/futomaki/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/inmanturbo/futomaki/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/inmanturbo/futomaki)
A set of features for eloquent built on top of [calebporzio/sushi](https://github.com/calebporzio/sushi).
## Installation
You can install the package via composer:
```bash
composer require inmanturbo/futomaki
```
## Usage
### Eloquent CSV Driver
```php
'id',
'title' => 'string',
'content' => 'text',
];
protected function csvFileName()
{
return 'posts.csv';
}
protected function csvDirectory()
{
return storage_path('csv');
}
}
```
HasCsv uses sushi (array driver) under the hood, and supports defining a $rows property as well. A csv file will automatically be created using the defined $rows.
```php
use Illuminate\Database\Eloquent\Model;
use Inmanturbo\Futomaki\HasCsv;
class PostWithCsv extends Model
{
use HasCsv;
protected $guarded = [];
protected $schema = [
'id' => 'id',
'title' => 'string',
'content' => 'text',
];
protected $rows = [
[
'id' => 1,
'title' => 'Post 1',
'content' => 'Content 1',
],
[
'id' => 2,
'title' => 'Post 2',
'content' => 'Content 2',
],
];
}
```
### Using ->getCsvRows()
Implementing your own `getCsvRows()` method is supported as well.
```php
use Illuminate\Database\Eloquent\Model;
use Inmanturbo\Futomaki\HasCsv;
class PostWithCsv extends Model
{
use HasCsv;
protected $guarded = [];
protected $schema = [
'id' => 'id',
'title' => 'string',
'content' => 'text',
];
public function getCsvRows()
{
return [
['id' => 1,'title' => 'Post 1', 'content' => 'Content 1'],
['id' => 2,'title' => 'Post 2','content' => 'Content 2'],
];
}
}
```
### HasFutumakiWrites
HasFutomakiWrites is a trait which leverages eloquent's `saving()` and `deleting()` hooks to support writing sushi's changes out to another database, or api, etc.
Example Below.
```php
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\DB;
use Inmanturbo\Futomaki\Futomaki;
use Inmanturbo\Futomaki\HasFutomakiWrites;
class PostWithFutomakiWrites extends Model
{
use Futomaki;
use HasFutomakiWrites;
public $timestamps = true;
public $guarded = [];
protected $schema = [
'id' => 'id',
'title' => 'string',
'content' => 'text',
];
public function getRows()
{
return DB::connection('remote_posts')->table('posts')->get()->map(fn ($remoteItem) => [
'id' => $remoteItem->id,
'title' => $remoteItem->title,
'content' => $remoteItem->body,
])->toArray();
}
public function futomakiSaving()
{
$values = [
'id' => $this->id,
'title' => $this->title,
'body' => $this->content,
];
DB::connection('remote_posts')->transaction(function () {
DB::connection('remote_posts')->table('posts')->upsert($values, $this->getKeyName());
});
}
public function futomakiDeleting()
{
DB::connection('remote_posts')
->table('posts')
->where($this->getKeyName(), $this->getKey())
->delete();
}
}
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [inmanturbo](https://github.com/inmanturbo)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.