mirror of
https://github.com/nullthoughts/laravel-data-sync.git
synced 2026-01-26 11:44:11 +00:00
Compare commits
71 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8c6bcd068b | ||
|
|
ae5828cc3f | ||
|
|
38c451fa1c | ||
|
|
3d1a5da432 | ||
|
|
0be2ed7c16 | ||
|
|
da3eab90c5 | ||
| d39a0020b1 | |||
|
|
70ae10137c | ||
|
|
e9e95871a1 | ||
|
|
aec5ec026a | ||
|
|
e12085be2c | ||
|
|
261e47bf7f | ||
|
|
311cf155c5 | ||
|
|
f14dc0a5c2 | ||
|
|
9980bc7e9a | ||
|
|
9935cb78cb | ||
|
|
9ade30325c | ||
|
|
effd3be10f | ||
| 412a03516b | |||
|
|
730fe0e2ac | ||
|
|
f830c5b264 | ||
| 95635719d6 | |||
|
|
e57f989c68 | ||
| 3a54f48c65 | |||
| c0f21612fc | |||
|
|
8007b2ae88 | ||
|
|
000f1e3851 | ||
|
|
7bcec7872f | ||
|
|
449dafcb89 | ||
|
|
af513debec | ||
|
|
5759629d34 | ||
|
|
0ab4a4f053 | ||
|
|
163be72b86 | ||
|
|
20b07aeea8 | ||
|
|
168923d3da | ||
|
|
b177e8de2c | ||
|
|
cd3adf1a96 | ||
|
|
8a987b89c5 | ||
|
|
552bc8fba8 | ||
|
|
7b89add86e | ||
|
|
8c69fe4d27 | ||
|
|
a6b0d7aa66 | ||
|
|
6dbf71adbc | ||
|
|
0a462f9193 | ||
|
|
ec73547e7a | ||
| f478df70c4 | |||
| 382c4a152d | |||
| 27e8683874 | |||
|
|
6f826afe71 | ||
|
|
de80308447 | ||
|
|
5f7fa84914 | ||
|
|
ee3f13ec2b | ||
|
|
5acf52b9f4 | ||
|
|
6b3ff0ebdf | ||
|
|
862a15b95c | ||
|
|
325667f1f7 | ||
|
|
cdd675a862 | ||
|
|
dafbb6cb6a | ||
|
|
aa9d2905fb | ||
|
|
916f203c5b | ||
|
|
9dd3e29601 | ||
|
|
e6200c346a | ||
|
|
12ba3008cc | ||
|
|
a64f17891f | ||
|
|
c601bee490 | ||
|
|
d081af525c | ||
|
|
82e5865831 | ||
|
|
b5eacfb0f7 | ||
|
|
ec80e79b01 | ||
|
|
2b27089c60 | ||
|
|
bd682f0d78 |
18
.editorconfig
Normal file
18
.editorconfig
Normal file
@@ -0,0 +1,18 @@
|
||||
# EditorConfig is awesome: https://editorconfig.org
|
||||
|
||||
# top-most EditorConfig file
|
||||
root = true
|
||||
|
||||
# Unix-style newlines with a newline ending every file
|
||||
[*]
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
charset = utf-8
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
|
||||
[*.md]
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
[*.{yml,yaml}]
|
||||
indent_size = 2
|
||||
43
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
43
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
|
||||
**Laravel (please complete the following information):**
|
||||
- Host OS: [e.g. Linux]
|
||||
- Version [e.g. 6.1.0]
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- Browser [e.g. chrome, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Smartphone (please complete the following information):**
|
||||
- Device: [e.g. iPhone6]
|
||||
- OS: [e.g. iOS8.1]
|
||||
- Browser [e.g. stock browser, safari]
|
||||
- Version [e.g. 22]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
69
.github/workflows/phpunit.yml
vendored
Normal file
69
.github/workflows/phpunit.yml
vendored
Normal file
@@ -0,0 +1,69 @@
|
||||
---
|
||||
# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
|
||||
name: PHPUnit
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [master, main]
|
||||
pull_request:
|
||||
branches: [master, main]
|
||||
|
||||
jobs:
|
||||
build-test:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
statuses: write
|
||||
|
||||
strategy:
|
||||
fail-fast: true
|
||||
matrix:
|
||||
php: [ '8.0', '8.1', '8.2', '8.3' ]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Setup PHP
|
||||
uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
php-version: ${{ matrix.php }}
|
||||
tools: composer
|
||||
extensions: json, dom, curl, libxml, mbstring
|
||||
coverage: xdebug
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Get composer cache directory
|
||||
id: composer-cache-dir
|
||||
run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Get composer.lock or composer.json hash for caching
|
||||
id: hash
|
||||
shell: bash
|
||||
run: |
|
||||
if [ -f composer.lock ]; then
|
||||
echo "lock=${{ hashFiles('**/composer.lock') }}" >> $GITHUB_OUTPUT
|
||||
else
|
||||
echo "lock=${{ hashFiles('**/composer.json') }}" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
|
||||
- name: Cache Composer packages
|
||||
id: composer-cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ${{ steps.composer-cache-dir.outputs.dir }}
|
||||
key: ${{ runner.os }}-php-${{ matrix.php }}-${{ steps.hash.outputs.lock }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-php-${{ matrix.php }}-${{ steps.hash.outputs.lock }}
|
||||
${{ runner.os }}-php-${{ matrix.php }}-
|
||||
${{ runner.os }}-php-
|
||||
|
||||
- name: Install Dependencies (prefer-${{ matrix.stability }})
|
||||
run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress
|
||||
|
||||
- name: Configure matchers
|
||||
uses: mheap/phpunit-matcher-action@v1
|
||||
|
||||
- name: Execute composer test (Unit and Feature tests)
|
||||
run: composer test:ci
|
||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -12,4 +12,5 @@ Homestead.yaml
|
||||
npm-debug.log
|
||||
yarn-error.log
|
||||
.env
|
||||
.phpunit.result.cache
|
||||
*.cache
|
||||
composer.lock
|
||||
|
||||
30
.travis.yml
Normal file
30
.travis.yml
Normal file
@@ -0,0 +1,30 @@
|
||||
language: php
|
||||
|
||||
env:
|
||||
global:
|
||||
- setup=stable
|
||||
|
||||
matrix:
|
||||
fast_finish: true
|
||||
include:
|
||||
- php: 8.0
|
||||
- php: 8.0
|
||||
env: setup=lowest
|
||||
- php: 8.1
|
||||
- php: 8.1
|
||||
env: setup=lowest
|
||||
- php: 8.2
|
||||
- php: 8.2
|
||||
env: setup=lowest
|
||||
|
||||
sudo: false
|
||||
|
||||
cache:
|
||||
directories:
|
||||
- $HOME/.composer/cache
|
||||
|
||||
install:
|
||||
- if [[ $setup = 'stable' ]]; then travis_retry composer update --prefer-dist --no-interaction --prefer-stable --no-suggest; fi
|
||||
- if [[ $setup = 'lowest' ]]; then travis_retry composer update --prefer-dist --no-interaction --prefer-lowest --prefer-stable --no-suggest; fi
|
||||
|
||||
script: vendor/bin/phpunit
|
||||
76
CODE_OF_CONDUCT.md
Normal file
76
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
||||
level of experience, education, socio-economic status, nationality, personal
|
||||
appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at jani@nullincorporated.com. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see
|
||||
https://www.contributor-covenant.org/faq
|
||||
19
CONTRIBUTING.md
Normal file
19
CONTRIBUTING.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Contribution Guide
|
||||
|
||||
<a name="bug-reports"></a>
|
||||
## Bug Reports
|
||||
|
||||
To encourage active collaboration, we strongly encourages pull requests, not just bug reports. "Bug reports" may also be sent in the form of a pull request containing a failing test.
|
||||
|
||||
However, if you file a bug report, your issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix.
|
||||
|
||||
Remember, bug reports are created in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the bug report will automatically see any activity or that others will jump to fix it. Creating a bug report serves to help yourself and others start on the path of fixing the problem.
|
||||
|
||||
<a name="coding-style"></a>
|
||||
## Coding Style
|
||||
|
||||
Laravel follows the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) coding standard and the [PSR-4](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md) autoloading standard, so do we.
|
||||
|
||||
## Security Vulnerabilities
|
||||
|
||||
If you discover a security vulnerability within the package, please send an e-mail to [@nullthoughts](https://github.com/nullthoughts) via [jani@nullincorporated.com](mailto:jani@nullincorporated.com). All security vulnerabilities will be promptly addressed.
|
||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2019 Jani Gyllenberg
|
||||
|
||||
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.
|
||||
@@ -1,34 +1,54 @@
|
||||
{
|
||||
"name": "distinctm/laravel-data-sync",
|
||||
"description": "Laravel utility to keep records synced between enviroments through source control",
|
||||
"name": "nullthoughts/laravel-data-sync",
|
||||
"description": "Laravel utility to keep records synced between environments through source control",
|
||||
"license": "MIT",
|
||||
"authors": [
|
||||
{
|
||||
"name": "distinctm",
|
||||
"email": "jani@marketdistinctly.com"
|
||||
"name": "nullthoughts",
|
||||
"email": "jani@nullincorporated.com"
|
||||
}
|
||||
],
|
||||
"scripts": {
|
||||
"lint": "pint --test",
|
||||
"lint:fix": "pint --repair",
|
||||
"psalm": "psalm",
|
||||
"psalm:fix": "psalm --alter --issues=MissingReturnType,MissingParamType",
|
||||
"test": "phpunit --coverage-text",
|
||||
"test:ci": "phpunit --teamcity"
|
||||
},
|
||||
"require": {
|
||||
"ext-json": "*"
|
||||
"ext-json": "*",
|
||||
"php": "^8.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"orchestra/testbench": "^3.7"
|
||||
"orchestra/testbench": "^7|^8",
|
||||
"rector/rector": "^1",
|
||||
"ergebnis/composer-normalize": "^2",
|
||||
"vimeo/psalm": "^5",
|
||||
"psalm/plugin-laravel": "^2",
|
||||
"laravel/pint": "^1"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4" : {
|
||||
"distinctm\\LaravelDataSync\\": "src/"
|
||||
"psr-4": {
|
||||
"nullthoughts\\LaravelDataSync\\": "src/"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4" : {
|
||||
"distinctm\\LaravelDataSync\\Tests\\": "tests/"
|
||||
"psr-4": {
|
||||
"nullthoughts\\LaravelDataSync\\Tests\\": "tests/",
|
||||
"nullthoughts\\LaravelDataSync\\Tests\\Fakes\\": "tests/fakes/"
|
||||
}
|
||||
},
|
||||
"extra": {
|
||||
"laravel": {
|
||||
"providers": [
|
||||
"distinctm\\LaravelDataSync\\DataSyncBaseServiceProvider"
|
||||
"nullthoughts\\LaravelDataSync\\DataSyncBaseServiceProvider"
|
||||
]
|
||||
}
|
||||
},
|
||||
"config": {
|
||||
"allow-plugins": {
|
||||
"ergebnis/composer-normalize": true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
4503
composer.lock
generated
4503
composer.lock
generated
File diff suppressed because it is too large
Load Diff
@@ -4,5 +4,5 @@ return [
|
||||
'path' => base_path('sync'),
|
||||
'order' => [
|
||||
//
|
||||
]
|
||||
],
|
||||
];
|
||||
|
||||
27
phpunit.xml
27
phpunit.xml
@@ -1,25 +1,16 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit backupGlobals="false"
|
||||
backupStaticAttributes="false"
|
||||
bootstrap="vendor/autoload.php"
|
||||
colors="true"
|
||||
convertErrorsToExceptions="true"
|
||||
convertNoticesToExceptions="true"
|
||||
convertWarningsToExceptions="true"
|
||||
processIsolation="false"
|
||||
stopOnFailure="false">
|
||||
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" backupStaticAttributes="false"
|
||||
bootstrap="vendor/autoload.php" colors="true" convertErrorsToExceptions="true"
|
||||
convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false"
|
||||
stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
|
||||
<coverage processUncoveredFiles="true">
|
||||
<include>
|
||||
<directory suffix=".php">./src</directory>
|
||||
</include>
|
||||
</coverage>
|
||||
<testsuites>
|
||||
<testsuite name="Unit">
|
||||
<directory suffix="Test.php">./tests/Unit</directory>
|
||||
</testsuite>
|
||||
|
||||
<testsuite name="Feature">
|
||||
<directory suffix="Test.php">./tests/Feature</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
<filter>
|
||||
<whitelist processUncoveredFilesFromWhitelist="true">
|
||||
<directory suffix=".php">./src</directory>
|
||||
</whitelist>
|
||||
</filter>
|
||||
</phpunit>
|
||||
|
||||
17
psalm.xml
Normal file
17
psalm.xml
Normal file
@@ -0,0 +1,17 @@
|
||||
<?xml version="1.0"?>
|
||||
<psalm
|
||||
errorLevel="7"
|
||||
resolveFromConfigFile="true"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns="https://getpsalm.org/schema/config"
|
||||
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
|
||||
findUnusedBaselineEntry="true"
|
||||
findUnusedCode="true"
|
||||
>
|
||||
<projectFiles>
|
||||
<directory name="src" />
|
||||
<ignoreFiles>
|
||||
<directory name="vendor" />
|
||||
</ignoreFiles>
|
||||
</projectFiles>
|
||||
</psalm>
|
||||
62
readme.md
62
readme.md
@@ -1,10 +1,60 @@
|
||||
<p align="center">
|
||||
<a href="https://packagist.org/packages/nullthoughts/laravel-data-sync" target="_blank"><img src="https://poser.pugx.org/nullthoughts/laravel-data-sync/d/total.svg" alt="Total Downloads"></a>
|
||||
<a href="https://packagist.org/packages/nullthoughts/laravel-data-sync" target="_blank"><img src="https://poser.pugx.org/nullthoughts/laravel-data-sync/v/stable.svg" alt="Latest Stable Version"></a>
|
||||
<a href="https://travis-ci.com/nullthoughts/laravel-data-sync"><img src="https://api.travis-ci.com/nullthoughts/laravel-data-sync.svg?branch=master" alt="Travis CI Build Status: Master"></a>
|
||||
</p>
|
||||
|
||||
# Laravel Data Sync
|
||||
|
||||
Laravel utility to keep records synced between enviroments through source control
|
||||
Laravel utility to keep records synchronized between environments through source control
|
||||
|
||||
## Installation & Usage
|
||||
- Via composer: `composer require distinctm/laravel-data-sync`
|
||||
- Run `php artisan vendor:publish --provider="distinctm\LaravelDataSync\DataSyncBaseServiceProvider" --tag="data-sync-config"` to publish config file. Specify directory for sync data files (default is a new sync directory in the project root)
|
||||
## [V3.1 branch](https://github.com/nullthoughts/laravel-data-sync/tree/v3.1) Notes (Work in progress)
|
||||
- Adds support for Laravel 8+ models directory in `config/data-sync.php`:
|
||||
```
|
||||
'namespace' => '\\App\\Models\\',
|
||||
```
|
||||
|
||||
- Adds ability to export existing Models to data sync files:
|
||||
```
|
||||
php artisan data:export User --criteria=name --criteria=email --except=id
|
||||
```
|
||||
|
||||
which generates
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"_name": "Cameron Frye",
|
||||
"properties->title": "Best Friend",
|
||||
"phone_numbers->mobile": "555-555-5556",
|
||||
"_email": "noreply@buellerandco.com",
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
- Further work is required to support remote disks. For testing & development of new V3.1 features, use `composer require nullthoughts/laravel-data-sync:v3.1.x-dev`
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
You can install this package via composer:
|
||||
```bash
|
||||
composer require nullthoughts/laravel-data-sync
|
||||
```
|
||||
|
||||
Or add this line in your `composer.json`, inside of the `require` section:
|
||||
|
||||
``` json
|
||||
{
|
||||
"require": {
|
||||
"nullthoughts/laravel-data-sync": "^1.0",
|
||||
}
|
||||
}
|
||||
```
|
||||
then run ` composer install `
|
||||
|
||||
## Usage
|
||||
- Run `php artisan vendor:publish --provider="nullthoughts\LaravelDataSync\DataSyncBaseServiceProvider" --tag="data-sync-config"` to publish config file. Specify directory for sync data files (default is a new sync directory in the project root)
|
||||
- Create a JSON file for each model, using the model name as the filename. Example: Product.json would update the Product model
|
||||
- Use nested arrays in place of hardcoded IDs for relationships
|
||||
- Run `php artisan data:sync` (or `php artisan data:sync --model={model}` with the model flag to specify a model)
|
||||
@@ -14,8 +64,8 @@ If using Laravel Forge, you can have the data sync run automatically on deploy.
|
||||
```
|
||||
if [ -f artisan ]
|
||||
then
|
||||
php artisan data:sync
|
||||
php artisan migrate --force
|
||||
php artisan data:sync
|
||||
fi
|
||||
```
|
||||
|
||||
@@ -144,4 +194,4 @@ translates to...
|
||||
'role_id' => Role::where('slug', 'destroy-ferrari')->first()->id,
|
||||
]);
|
||||
|
||||
```
|
||||
```
|
||||
|
||||
16
rector.php
Normal file
16
rector.php
Normal file
@@ -0,0 +1,16 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Rector\Config\RectorConfig;
|
||||
|
||||
return RectorConfig::configure()
|
||||
->withPaths([
|
||||
__DIR__.'/config',
|
||||
__DIR__.'/src',
|
||||
__DIR__.'/tests',
|
||||
])
|
||||
->withPhpSets()
|
||||
->withPreparedSets(deadCode: true, codeQuality: true)
|
||||
->withImportNames(removeUnusedImports: true)
|
||||
->withTypeCoverageLevel(0);
|
||||
14
scratch.md
14
scratch.md
@@ -1,12 +1,14 @@
|
||||
# Dev
|
||||
- Check if null return from json decode (invalid JSON)
|
||||
- Check if updateOrCreate returns anything
|
||||
|
||||
- Check if null return from json decode (invalid JSON)
|
||||
- Check if updateOrCreate returns anything
|
||||
|
||||
# Usage
|
||||
- Must have the columsn you are updating as fillable
|
||||
- In config, specify disk to use (string)
|
||||
- Document Forge example
|
||||
|
||||
- Must have the columsn you are updating as fillable
|
||||
- In config, specify disk to use (string)
|
||||
- Document Forge example
|
||||
|
||||
# Troubleshooting
|
||||
- Make sure columns are fillable in model
|
||||
|
||||
- Make sure columns are fillable in model
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
<?php
|
||||
|
||||
namespace distinctm\LaravelDataSync\Console\Commands;
|
||||
namespace nullthoughts\LaravelDataSync\Console\Commands;
|
||||
|
||||
use distinctm\LaravelDataSync\Updater;
|
||||
use Illuminate\Console\Command;
|
||||
use nullthoughts\LaravelDataSync\Updater;
|
||||
|
||||
class Sync extends Command
|
||||
{
|
||||
@@ -11,15 +11,16 @@ class Sync extends Command
|
||||
|
||||
protected $description = 'Update Models with respective sync data files';
|
||||
|
||||
public function handle()
|
||||
/** @psalm-api */
|
||||
public function handle(): void
|
||||
{
|
||||
$path = $this->option('path');
|
||||
$model = $this->option('model');
|
||||
|
||||
$this->info('Updating Models with sync data files');
|
||||
|
||||
|
||||
(new Updater($path, $model))->run();
|
||||
|
||||
|
||||
$this->comment('Data sync completed');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,12 +1,14 @@
|
||||
<?php
|
||||
|
||||
namespace distinctm\LaravelDataSync;
|
||||
namespace nullthoughts\LaravelDataSync;
|
||||
|
||||
use Illuminate\Support\ServiceProvider;
|
||||
use nullthoughts\LaravelDataSync\Console\Commands\Sync;
|
||||
|
||||
/** @psalm-api */
|
||||
class DataSyncBaseServiceProvider extends ServiceProvider
|
||||
{
|
||||
public function boot()
|
||||
public function boot(): void
|
||||
{
|
||||
if ($this->app->runningInConsole()) {
|
||||
$this->registerPublishing();
|
||||
@@ -16,14 +18,14 @@ class DataSyncBaseServiceProvider extends ServiceProvider
|
||||
public function register()
|
||||
{
|
||||
$this->commands([
|
||||
Console\Commands\Sync::class,
|
||||
Sync::class,
|
||||
]);
|
||||
}
|
||||
|
||||
protected function registerPublishing()
|
||||
protected function registerPublishing(): void
|
||||
{
|
||||
$this->publishes([
|
||||
__DIR__ . '/../config/data-sync.php' => config_path('data-sync.php'),
|
||||
__DIR__.'/../config/data-sync.php' => config_path('data-sync.php'),
|
||||
], 'data-sync-config');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
<?php
|
||||
|
||||
namespace distinctm\LaravelDataSync\Exceptions;
|
||||
namespace nullthoughts\LaravelDataSync\Exceptions;
|
||||
|
||||
use Exception;
|
||||
use Throwable;
|
||||
|
||||
class ErrorUpdatingModelException extends Exception
|
||||
{
|
||||
public function __construct(string $message = "", int $code = 0, Throwable $previous = null)
|
||||
public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
|
||||
{
|
||||
parent::__construct($message, $code, $previous);
|
||||
|
||||
$this->message = "Error updating the {$message} model.";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
<?php
|
||||
|
||||
namespace distinctm\LaravelDataSync\Exceptions;
|
||||
namespace nullthoughts\LaravelDataSync\Exceptions;
|
||||
|
||||
use Exception;
|
||||
|
||||
class FileDirectoryNotFoundException extends Exception
|
||||
{
|
||||
protected $message = 'Specified sync file directory does not exist';
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
<?php
|
||||
|
||||
namespace distinctm\LaravelDataSync\Exceptions;
|
||||
namespace nullthoughts\LaravelDataSync\Exceptions;
|
||||
|
||||
use Exception;
|
||||
|
||||
class NoCriteriaException extends Exception
|
||||
{
|
||||
protected $message = 'No criteria/attributes detected';
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
<?php
|
||||
|
||||
namespace distinctm\LaravelDataSync\Exceptions;
|
||||
namespace nullthoughts\LaravelDataSync\Exceptions;
|
||||
|
||||
use Exception;
|
||||
use Throwable;
|
||||
|
||||
class NoRecordsInvalidJSONException extends Exception
|
||||
{
|
||||
public function __construct(string $message = "", int $code = 0, Throwable $previous = null)
|
||||
public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
|
||||
{
|
||||
parent::__construct($message, $code, $previous);
|
||||
|
||||
$this->message = "No records or invalid JSON for {$message} model.";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
187
src/Updater.php
187
src/Updater.php
@@ -1,34 +1,70 @@
|
||||
<?php
|
||||
|
||||
namespace distinctm\LaravelDataSync;
|
||||
namespace nullthoughts\LaravelDataSync;
|
||||
|
||||
use distinctm\LaravelDataSync\Exceptions\FileDirectoryNotFoundException;
|
||||
use distinctm\LaravelDataSync\Exceptions\NoCriteriaException;
|
||||
use distinctm\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException;
|
||||
use Illuminate\Support\Collection;
|
||||
use Illuminate\Support\Facades\File;
|
||||
use distinctm\LaravelDataSync\Exceptions\ErrorUpdatingModelException;
|
||||
use Illuminate\Support\Facades\Storage;
|
||||
use Illuminate\Support\Str;
|
||||
use nullthoughts\LaravelDataSync\Exceptions\ErrorUpdatingModelException;
|
||||
use nullthoughts\LaravelDataSync\Exceptions\FileDirectoryNotFoundException;
|
||||
use nullthoughts\LaravelDataSync\Exceptions\NoCriteriaException;
|
||||
use nullthoughts\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException;
|
||||
use stdClass;
|
||||
|
||||
class Updater
|
||||
{
|
||||
private string $directory;
|
||||
|
||||
private Collection $files;
|
||||
|
||||
private bool $remote;
|
||||
|
||||
private string $disk;
|
||||
|
||||
private string $baseNamespace = '\\App\\';
|
||||
|
||||
/**
|
||||
* Get files in sync directory
|
||||
* Get files in sync directory.
|
||||
*
|
||||
* @param string|null $path
|
||||
* @param string|null $model
|
||||
* @param string|null $path
|
||||
* @param string|null $model
|
||||
* @param bool $remote
|
||||
* @param string $disk
|
||||
*
|
||||
* @throws \distinctm\LaravelDataSync\Exceptions\FileDirectoryNotFoundException
|
||||
* @throws \nullthoughts\LaravelDataSync\Exceptions\FileDirectoryNotFoundException
|
||||
*/
|
||||
public function __construct($path = null, $model = null)
|
||||
public function __construct($path = null, $model = null, $remote = false, $disk = 's3')
|
||||
{
|
||||
$directory = $this->getDirectory($path);
|
||||
$this->files = $this->getFiles($directory, $model);
|
||||
$this->remote = $remote;
|
||||
$this->disk = $disk;
|
||||
|
||||
$this->directory = $this->getDirectory($path);
|
||||
$this->files = $this->getFiles($this->directory, $model);
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute syncModel for each file
|
||||
* Override the default namespace for the class.
|
||||
*
|
||||
* @return mixed
|
||||
* @psalm-api
|
||||
*/
|
||||
public function setNamespace(string $namespace): void
|
||||
{
|
||||
$this->baseNamespace = $namespace;
|
||||
}
|
||||
|
||||
/**
|
||||
* Override the default directory for the class.
|
||||
*
|
||||
* @psalm-api
|
||||
*/
|
||||
public function setDirectory(string $directory): void
|
||||
{
|
||||
$this->directory = $directory;
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute syncModel for each file.
|
||||
*/
|
||||
public function run()
|
||||
{
|
||||
@@ -37,7 +73,7 @@ class Updater
|
||||
return $files->map(function ($file) {
|
||||
try {
|
||||
return $this->syncModel($file);
|
||||
} catch (\ErrorException $e) {
|
||||
} catch (\ErrorException) {
|
||||
$model = pathinfo($file, PATHINFO_FILENAME);
|
||||
|
||||
throw new ErrorUpdatingModelException(ucwords($model));
|
||||
@@ -46,12 +82,13 @@ class Updater
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse each record for criteria/values and update/create model
|
||||
* Parse each record for criteria/values and update/create model.
|
||||
*
|
||||
* @param string $file
|
||||
*
|
||||
* @return \Illuminate\Support\Collection
|
||||
* @throws \distinctm\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException
|
||||
*
|
||||
* @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
|
||||
* @throws \nullthoughts\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException
|
||||
*/
|
||||
protected function syncModel(string $file)
|
||||
{
|
||||
@@ -74,79 +111,86 @@ class Updater
|
||||
}
|
||||
|
||||
/**
|
||||
* Get directory path for sync files
|
||||
* Get directory path for sync files.
|
||||
*
|
||||
* @param $path
|
||||
*
|
||||
* @return string
|
||||
* @throws \distinctm\LaravelDataSync\Exceptions\FileDirectoryNotFoundException
|
||||
*
|
||||
* @throws \nullthoughts\LaravelDataSync\Exceptions\FileDirectoryNotFoundException
|
||||
*/
|
||||
protected function getDirectory($path)
|
||||
protected function getDirectory(?string $path)
|
||||
{
|
||||
$directory = $path ?? config('data-sync.path', base_path('sync'));
|
||||
|
||||
if (!file_exists($directory)) {
|
||||
if ($this->directoryMissingLocally($directory) || $this->directoryMissingRemotely($directory)) {
|
||||
throw new FileDirectoryNotFoundException;
|
||||
}
|
||||
|
||||
return $directory;
|
||||
$this->directory = $directory;
|
||||
|
||||
return $this->directory;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get list of files in directory
|
||||
*
|
||||
* @param string $directory
|
||||
* @param string|null $model
|
||||
* Get list of files in directory.
|
||||
*
|
||||
* @param string|null $model
|
||||
* @return \Illuminate\Support\Collection
|
||||
*/
|
||||
protected function getFiles(string $directory, $model = null)
|
||||
{
|
||||
if ($model) {
|
||||
return Collection::wrap($directory . '/' . $model . '.json');
|
||||
return Collection::wrap($directory.'/'.$model.'.json');
|
||||
}
|
||||
|
||||
return collect(File::files($directory))
|
||||
->filter(function($file) {
|
||||
$files = ($this->remote) ? Storage::disk($this->disk)->files($directory) : File::files($directory);
|
||||
|
||||
return collect($files)
|
||||
->filter(function ($file) {
|
||||
return pathinfo($file, PATHINFO_EXTENSION) == 'json';
|
||||
})->map(function ($path) {
|
||||
|
||||
if (is_string($path)) {
|
||||
return $path;
|
||||
}
|
||||
|
||||
return $path->getPathname();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Sort Models by pre-configured order
|
||||
* Sort Models by pre-configured order.
|
||||
*
|
||||
*
|
||||
* @param \Illuminate\Support\Collection $files
|
||||
* @return \Illuminate\Support\Collection
|
||||
*/
|
||||
protected function sortModels(\Illuminate\Support\Collection $files)
|
||||
{
|
||||
if(empty(config('data-sync.order'))) {
|
||||
if (empty(config('data-sync.order'))) {
|
||||
return $files;
|
||||
}
|
||||
|
||||
return $files->sortBy(function($file) use ($files) {
|
||||
|
||||
return $files->sortBy(function ($file) use ($files) {
|
||||
$filename = pathinfo($file, PATHINFO_FILENAME);
|
||||
|
||||
|
||||
$order = array_search(
|
||||
studly_case($filename),
|
||||
Str::studly($filename),
|
||||
config('data-sync.order')
|
||||
);
|
||||
|
||||
|
||||
return $order !== false ? $order : (count($files) + 1);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter record criteria
|
||||
* Filter record criteria.
|
||||
*
|
||||
* @param object $record
|
||||
*
|
||||
* @return \Illuminate\Support\Collection
|
||||
* @throws \distinctm\LaravelDataSync\Exceptions\NoCriteriaException
|
||||
*
|
||||
* @throws \nullthoughts\LaravelDataSync\Exceptions\NoCriteriaException
|
||||
*/
|
||||
protected function getCriteria(object $record)
|
||||
protected function getCriteria(stdClass $record)
|
||||
{
|
||||
$criteria = collect($record)->filter(function ($value, $key) {
|
||||
return $this->isCriteria($key);
|
||||
@@ -162,13 +206,12 @@ class Updater
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter record values
|
||||
* Filter record values.
|
||||
*
|
||||
* @param object $record
|
||||
*
|
||||
* @return \Illuminate\Support\Collection
|
||||
*/
|
||||
protected function getValues(object $record)
|
||||
protected function getValues(stdClass $record)
|
||||
{
|
||||
return collect($record)->reject(function ($value, $key) {
|
||||
if ($this->isCriteria($key)) {
|
||||
@@ -184,28 +227,30 @@ class Updater
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns model name for file
|
||||
* Returns model name for file.
|
||||
*
|
||||
* @param string $name
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function getModel(string $name)
|
||||
{
|
||||
return '\\App\\' . studly_case(pathinfo($name, PATHINFO_FILENAME));
|
||||
return $this->baseNamespace.Str::studly(pathinfo($name, PATHINFO_FILENAME));
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses JSON from file and returns collection
|
||||
* Parses JSON from file and returns collection.
|
||||
*
|
||||
* @param string $file
|
||||
*
|
||||
* @return \Illuminate\Support\Collection
|
||||
* @throws \distinctm\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException
|
||||
*
|
||||
* @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
|
||||
* @throws \nullthoughts\LaravelDataSync\Exceptions\NoRecordsInvalidJSONException
|
||||
*/
|
||||
protected function getRecords(string $file)
|
||||
{
|
||||
$records = collect(json_decode(File::get($file)));
|
||||
$fetchedFile = ($this->remote) ? Storage::disk($this->disk)->get($file) : File::get($file);
|
||||
|
||||
$records = collect(json_decode($fetchedFile));
|
||||
|
||||
if ($records->isEmpty()) {
|
||||
throw new NoRecordsInvalidJSONException($file);
|
||||
@@ -215,11 +260,10 @@ class Updater
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if column is criteria for a condition match
|
||||
* Check if column is criteria for a condition match.
|
||||
*
|
||||
* @param string $key
|
||||
*
|
||||
* @return boolean
|
||||
* @param string $key
|
||||
* @return bool
|
||||
*/
|
||||
protected function isCriteria($key)
|
||||
{
|
||||
@@ -227,19 +271,16 @@ class Updater
|
||||
}
|
||||
|
||||
/**
|
||||
* Return ID for nested key-value pairs
|
||||
* Return ID for nested key-value pairs.
|
||||
*
|
||||
* @param string $key
|
||||
* @param object $values
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function resolveId(string $key, object $values)
|
||||
protected function resolveId(string $key, stdClass $values)
|
||||
{
|
||||
$model = $this->getModel($key);
|
||||
|
||||
$values = collect($values)->mapWithKeys(function ($value, $column) {
|
||||
|
||||
if (is_object($value)) {
|
||||
return $this->resolveId($column, $value);
|
||||
}
|
||||
@@ -247,13 +288,12 @@ class Updater
|
||||
return [$column => $value];
|
||||
})->toArray();
|
||||
|
||||
return [$key . '_id' => $model::where($values)->first()->id];
|
||||
return [$key.'_id' => $model::where($values)->first()->id];
|
||||
}
|
||||
|
||||
/**
|
||||
* Detect nested objects and resolve them
|
||||
* Detect nested objects and resolve them.
|
||||
*
|
||||
* @param \Illuminate\Support\Collection $record
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
@@ -268,4 +308,21 @@ class Updater
|
||||
})->toArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param \Illuminate\Config\Repository $directory
|
||||
* @return bool
|
||||
*/
|
||||
protected function directoryMissingLocally($directory)
|
||||
{
|
||||
return ! $this->remote && ! file_exists($directory);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param \Illuminate\Config\Repository $directory
|
||||
* @return bool
|
||||
*/
|
||||
protected function directoryMissingRemotely($directory)
|
||||
{
|
||||
return $this->remote && ! Storage::disk($this->disk)->exists($directory);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
<?php
|
||||
|
||||
namespace distinctm\LaravelDataSync\Tests;
|
||||
namespace nullthoughts\LaravelDataSync\Tests;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||
|
||||
class Roles extends Model
|
||||
{
|
||||
@@ -10,8 +11,8 @@ class Roles extends Model
|
||||
|
||||
protected $guarded = [];
|
||||
|
||||
public function supervisor()
|
||||
public function supervisor(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(Supervisor::class);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
<?php
|
||||
|
||||
namespace distinctm\LaravelDataSync\Tests;
|
||||
namespace nullthoughts\LaravelDataSync\Tests;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
|
||||
class Supervisor extends Model
|
||||
{
|
||||
@@ -10,8 +11,8 @@ class Supervisor extends Model
|
||||
|
||||
protected $guarded = [];
|
||||
|
||||
public function roles()
|
||||
public function roles(): HasMany
|
||||
{
|
||||
return $this->hasMany(Roles::class);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,35 +1,40 @@
|
||||
<?php
|
||||
|
||||
namespace distinctm\LaravelDataSync\Tests;
|
||||
namespace nullthoughts\LaravelDataSync\Tests;
|
||||
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
class TestCase extends \Orchestra\Testbench\TestCase
|
||||
{
|
||||
protected function getEnvironmentSetUp($app)
|
||||
/** @psalm-suppress PropertyNotSetInConstructor */
|
||||
public string $testDataPath;
|
||||
|
||||
protected function getEnvironmentSetUp($app): void
|
||||
{
|
||||
$app['config']->set('database.default', 'testdb');
|
||||
$app['config']->set('database.connections.testdb', [
|
||||
'driver' => 'sqlite',
|
||||
'database' => ':memory:'
|
||||
'database' => ':memory:',
|
||||
]);
|
||||
|
||||
$this->testDataPath = __DIR__.'/test-data';
|
||||
}
|
||||
|
||||
protected function setUp()
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
Schema::create('supervisors', function (Blueprint $table) {
|
||||
Schema::create('supervisors', static function (Blueprint $table): void {
|
||||
$table->increments('id');
|
||||
$table->string('name');
|
||||
});
|
||||
|
||||
Schema::create('roles', function (Blueprint $table) {
|
||||
Schema::create('roles', static function (Blueprint $table): void {
|
||||
$table->increments('id');
|
||||
$table->string('slug');
|
||||
$table->unsignedInteger('supervisor_id')->nullable();
|
||||
$table->string('category')->nullable();
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
164
tests/Unit/UpdaterRemoteTest.php
Normal file
164
tests/Unit/UpdaterRemoteTest.php
Normal file
@@ -0,0 +1,164 @@
|
||||
<?php
|
||||
|
||||
namespace nullthoughts\LaravelDataSync\Tests\Unit;
|
||||
|
||||
use Exception;
|
||||
use Illuminate\Support\Facades\File;
|
||||
use Illuminate\Support\Facades\Storage;
|
||||
use nullthoughts\LaravelDataSync\Exceptions\ErrorUpdatingModelException;
|
||||
use nullthoughts\LaravelDataSync\Tests\Fakes\UpdaterFake;
|
||||
use nullthoughts\LaravelDataSync\Tests\Roles;
|
||||
use nullthoughts\LaravelDataSync\Tests\Supervisor;
|
||||
use nullthoughts\LaravelDataSync\Tests\TestCase;
|
||||
|
||||
class UpdaterRemoteTest extends TestCase
|
||||
{
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
Storage::fake('s3');
|
||||
Storage::disk('s3')->put('test-data/roles.json', File::get(__DIR__.'/../test-data/roles.json'));
|
||||
foreach (File::directories(__DIR__.'/../test-data/') as $directory) {
|
||||
$files = File::files($directory);
|
||||
|
||||
foreach ($files as $file) {
|
||||
Storage::disk('s3')->put('test-data/'.basename($directory).'/'.$file->getRelativePathname(), File::get($file->getPathname()));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function it_adds_roles_to_the_database_in_remote()
|
||||
{
|
||||
$updater = new UpdaterFake('test-data', 'roles', true, 's3');
|
||||
|
||||
$updater->run();
|
||||
|
||||
$this->assertDatabaseHas('roles', ['slug' => 'update-student-records']);
|
||||
$this->assertDatabaseHas('roles', ['slug' => 'borrow-ferrari']);
|
||||
$this->assertDatabaseHas('roles', ['slug' => 'destroy-ferrari']);
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function it_can_default_to_configuration_in_remote()
|
||||
{
|
||||
config()->set('data-sync.path', 'test-data');
|
||||
|
||||
$updater = new UpdaterFake(null, null, true, 's3');
|
||||
|
||||
$updater->run();
|
||||
|
||||
$this->assertDatabaseHas('roles', ['slug' => 'update-student-records']);
|
||||
$this->assertDatabaseHas('roles', ['slug' => 'borrow-ferrari']);
|
||||
$this->assertDatabaseHas('roles', ['slug' => 'destroy-ferrari']);
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function it_can_update_an_existing_record_in_remote()
|
||||
{
|
||||
config()->set('data-sync.path', 'test-data');
|
||||
(new UpdaterFake(null, null, true, 's3'))->run();
|
||||
|
||||
config()->set('data-sync.path', 'test-data/valid');
|
||||
(new UpdaterFake(null, null, true, 's3'))->run();
|
||||
|
||||
$this->assertDatabaseHas('roles', ['category' => 'changed']);
|
||||
$this->assertDatabaseHas('roles', ['category' => 'changed']);
|
||||
$this->assertDatabaseHas('roles', ['category' => 'changed']);
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function it_can_update_the_relationship_in_remote()
|
||||
{
|
||||
$supervisor = Supervisor::create([
|
||||
'name' => 'CEO',
|
||||
]);
|
||||
|
||||
config()->set('data-sync.path', 'test-data/relationship');
|
||||
(new UpdaterFake(null, null, true, 's3'))->run();
|
||||
|
||||
$this->assertEquals($supervisor->id, Roles::first()->supervisor_id);
|
||||
$this->assertTrue($supervisor->is(Roles::first()->supervisor));
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*
|
||||
* @group current
|
||||
*/
|
||||
public function exception_is_thrown_if_the_directory_does_not_exists(): void
|
||||
{
|
||||
try {
|
||||
new UpdaterFake(null, null, true, 's3');
|
||||
|
||||
$this->fail('exception was thrown');
|
||||
} catch (Exception $e) {
|
||||
$this->assertEquals('Specified sync file directory does not exist', $e->getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function invalid_json_throws_an_exception_in_remote(): void
|
||||
{
|
||||
try {
|
||||
$updater = new UpdaterFake('test-data/invalid-json', null, true, 's3');
|
||||
$updater->run();
|
||||
|
||||
$this->fail('exception was thrown');
|
||||
} catch (Exception $e) {
|
||||
$this->assertStringContainsString('No records or invalid JSON for', $e->getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function the_json_must_contain_a_key_with_an_underscore_in_remote(): void
|
||||
{
|
||||
try {
|
||||
$updater = new UpdaterFake('test-data/no-criteria', null, true, 's3');
|
||||
$updater->run();
|
||||
|
||||
$this->fail('exception was thrown');
|
||||
} catch (Exception $e) {
|
||||
$this->assertEquals('No criteria/attributes detected', $e->getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function order_of_imports_can_be_defined_in_config_in_remote(): void
|
||||
{
|
||||
config()->set('data-sync.order', [
|
||||
'Supervisor',
|
||||
'Roles',
|
||||
]);
|
||||
|
||||
$updater = new UpdaterFake('test-data/ordered', null, true, 's3');
|
||||
$updater->run();
|
||||
|
||||
$this->assertDatabaseHas('roles', ['slug' => 'update-student-records']);
|
||||
$this->assertDatabaseHas('supervisors', ['name' => 'CEO']);
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function exception_is_thrown_if_imports_are_in_incorrect_order_in_remote(): void
|
||||
{
|
||||
config()->set('data-sync.order', [
|
||||
'Roles',
|
||||
'Supervisor',
|
||||
]);
|
||||
|
||||
$this->expectException(ErrorUpdatingModelException::class);
|
||||
|
||||
$updater = new UpdaterFake('test-data/ordered', null, true, 's3');
|
||||
$updater->run();
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function it_ignores_non_json_files_in_remote(): void
|
||||
{
|
||||
$updater = new UpdaterFake('test-data/not-json', null, true, 's3');
|
||||
$updater->run();
|
||||
|
||||
$this->assertDatabaseMissing('roles', ['slug' => 'update-student-records']);
|
||||
}
|
||||
}
|
||||
@@ -1,17 +1,20 @@
|
||||
<?php
|
||||
|
||||
namespace distinctm\LaravelDataSync\Tests;
|
||||
namespace nullthoughts\LaravelDataSync\Tests\Unit;
|
||||
|
||||
use distinctm\LaravelDataSync\Tests\Fakes\UpdaterFake;
|
||||
use Exception;
|
||||
use distinctm\LaravelDataSync\Exceptions\ErrorUpdatingModelException;
|
||||
use nullthoughts\LaravelDataSync\Exceptions\ErrorUpdatingModelException;
|
||||
use nullthoughts\LaravelDataSync\Tests\fakes\UpdaterFake;
|
||||
use nullthoughts\LaravelDataSync\Tests\Roles;
|
||||
use nullthoughts\LaravelDataSync\Tests\Supervisor;
|
||||
use nullthoughts\LaravelDataSync\Tests\TestCase;
|
||||
|
||||
class UpdaterTest extends TestCase
|
||||
{
|
||||
/** @test */
|
||||
public function it_adds_roles_to_the_database()
|
||||
public function it_adds_roles_to_the_database(): void
|
||||
{
|
||||
$updater = new UpdaterFake(__DIR__ . '/../test-data', 'roles');
|
||||
$updater = new UpdaterFake($this->testDataPath, 'roles');
|
||||
|
||||
$updater->run();
|
||||
|
||||
@@ -23,9 +26,9 @@ class UpdaterTest extends TestCase
|
||||
/** @test */
|
||||
public function it_can_default_to_configuration()
|
||||
{
|
||||
config()->set('data-sync.path', __DIR__ . '/../test-data');
|
||||
config()->set('data-sync.path', $this->testDataPath);
|
||||
|
||||
$updater = new UpdaterFake();
|
||||
$updater = new UpdaterFake;
|
||||
|
||||
$updater->run();
|
||||
|
||||
@@ -37,11 +40,11 @@ class UpdaterTest extends TestCase
|
||||
/** @test */
|
||||
public function it_can_update_an_existing_record()
|
||||
{
|
||||
config()->set('data-sync.path', __DIR__ . '/../test-data');
|
||||
(new UpdaterFake())->run();
|
||||
config()->set('data-sync.path', $this->testDataPath);
|
||||
(new UpdaterFake)->run();
|
||||
|
||||
config()->set('data-sync.path', __DIR__ . '/../test-data/valid');
|
||||
(new UpdaterFake())->run();
|
||||
config()->set('data-sync.path', $this->testDataPath.'/valid');
|
||||
(new UpdaterFake)->run();
|
||||
|
||||
$this->assertDatabaseHas('roles', ['category' => 'changed']);
|
||||
$this->assertDatabaseHas('roles', ['category' => 'changed']);
|
||||
@@ -49,95 +52,91 @@ class UpdaterTest extends TestCase
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function it_can_update_the_relationship()
|
||||
public function it_can_update_the_relationship(): void
|
||||
{
|
||||
$supervisor = Supervisor::create([
|
||||
'name' => 'CEO',
|
||||
]);
|
||||
|
||||
config()->set('data-sync.path', __DIR__ . '/../test-data/relationship', 'roles');
|
||||
(new UpdaterFake())->run();
|
||||
config()->set('data-sync.path', $this->testDataPath.'/relationship', 'roles');
|
||||
(new UpdaterFake)->run();
|
||||
|
||||
$this->assertEquals($supervisor->id, Roles::first()->supervisor_id);
|
||||
$this->assertTrue($supervisor->is(Roles::first()->supervisor));
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function exception_is_thrown_if_the_directory_does_not_exists()
|
||||
public function exception_is_thrown_if_the_directory_does_not_exists(): void
|
||||
{
|
||||
try {
|
||||
new UpdaterFake();
|
||||
new UpdaterFake;
|
||||
|
||||
$this->fail('exception was thrown');
|
||||
|
||||
} catch (Exception $e) {
|
||||
$this->assertEquals('Specified sync file directory does not exist', $e->getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/** @test */
|
||||
public function invalid_json_throws_an_exception()
|
||||
public function invalid_json_throws_an_exception(): void
|
||||
{
|
||||
try {
|
||||
$updater = new UpdaterFake(__DIR__ . '/../test-data/invalid-json');
|
||||
$updater = new UpdaterFake($this->testDataPath.'/invalid-json');
|
||||
$updater->run();
|
||||
|
||||
$this->fail('exception was thrown');
|
||||
|
||||
} catch (Exception $e) {
|
||||
$this->assertContains('No records or invalid JSON for', $e->getMessage());
|
||||
$this->assertStringContainsString('No records or invalid JSON for', $e->getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function the_json_must_contain_a_key_with_an_underscore()
|
||||
public function the_json_must_contain_a_key_with_an_underscore(): void
|
||||
{
|
||||
try {
|
||||
$updater = new UpdaterFake(__DIR__ . '/../test-data/no-criteria');
|
||||
$updater = new UpdaterFake($this->testDataPath.'/no-criteria');
|
||||
$updater->run();
|
||||
|
||||
$this->fail('exception was thrown');
|
||||
|
||||
} catch (Exception $e) {
|
||||
$this->assertEquals('No criteria/attributes detected', $e->getMessage());
|
||||
$this->assertEquals('No criteria/attributes detected', $e->getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function order_of_imports_can_be_defined_in_config()
|
||||
public function order_of_imports_can_be_defined_in_config(): void
|
||||
{
|
||||
config()->set('data-sync.order', [
|
||||
'Supervisor',
|
||||
'Roles'
|
||||
'Roles',
|
||||
]);
|
||||
|
||||
$updater = new UpdaterFake(__DIR__ . '/../test-data/ordered');
|
||||
$updater = new UpdaterFake($this->testDataPath.'/ordered');
|
||||
$updater->run();
|
||||
|
||||
$this->assertDatabaseHas('roles', ['slug' => 'update-student-records']);
|
||||
$this->assertDatabaseHas('supervisors', ['name' => 'CEO']);
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function exception_is_thrown_if_imports_are_in_incorrect_order()
|
||||
public function exception_is_thrown_if_imports_are_in_incorrect_order(): void
|
||||
{
|
||||
config()->set('data-sync.order', [
|
||||
'Roles',
|
||||
'Supervisor'
|
||||
'Supervisor',
|
||||
]);
|
||||
|
||||
$this->expectException(ErrorUpdatingModelException::class);
|
||||
|
||||
$updater = new UpdaterFake(__DIR__ . '/../test-data/ordered');
|
||||
|
||||
$updater = new UpdaterFake($this->testDataPath.'/ordered');
|
||||
$updater->run();
|
||||
}
|
||||
|
||||
/** @test */
|
||||
public function it_ignores_non_json_files()
|
||||
public function it_ignores_non_json_files(): void
|
||||
{
|
||||
$updater = new UpdaterFake(__DIR__ . '/../test-data/not-json');
|
||||
$updater = new UpdaterFake($this->testDataPath.'/not-json');
|
||||
$updater->run();
|
||||
|
||||
$this->assertDatabaseMissing('roles', ['slug' => 'update-student-records']);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,15 +1,16 @@
|
||||
<?php
|
||||
|
||||
namespace distinctm\LaravelDataSync\Tests\Fakes;
|
||||
namespace nullthoughts\LaravelDataSync\Tests\Fakes;
|
||||
|
||||
use distinctm\LaravelDataSync\Updater;
|
||||
use Illuminate\Support\Str;
|
||||
use nullthoughts\LaravelDataSync\Updater;
|
||||
|
||||
class UpdaterFake extends Updater
|
||||
{
|
||||
protected function getModel(string $name)
|
||||
{
|
||||
return '\\distinctm\\LaravelDataSync\\Tests\\' . studly_case(
|
||||
return '\\nullthoughts\\LaravelDataSync\\Tests\\'.Str::studly(
|
||||
pathinfo($name, PATHINFO_FILENAME)
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +1 @@
|
||||
[
|
||||
|
||||
]
|
||||
[]
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
{
|
||||
"string": "update-student-records"
|
||||
}
|
||||
]
|
||||
]
|
||||
|
||||
@@ -6,4 +6,4 @@
|
||||
"name": "CEO"
|
||||
}
|
||||
}
|
||||
]
|
||||
]
|
||||
|
||||
@@ -6,4 +6,4 @@
|
||||
"name": "CEO"
|
||||
}
|
||||
}
|
||||
]
|
||||
]
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
{
|
||||
"_name": "CEO"
|
||||
}
|
||||
]
|
||||
]
|
||||
|
||||
@@ -6,4 +6,4 @@
|
||||
"name": "CEO"
|
||||
}
|
||||
}
|
||||
]
|
||||
]
|
||||
|
||||
@@ -11,4 +11,4 @@
|
||||
"_slug": "destroy-ferrari",
|
||||
"category": "cars"
|
||||
}
|
||||
]
|
||||
]
|
||||
|
||||
@@ -11,4 +11,4 @@
|
||||
"_slug": "destroy-ferrari",
|
||||
"category": "changed"
|
||||
}
|
||||
]
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user