Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patrykbaszak/ultra-mapper
In progress... It's almost a dedicated-mapper, but much better
https://github.com/patrykbaszak/ultra-mapper
Last synced: 8 days ago
JSON representation
In progress... It's almost a dedicated-mapper, but much better
- Host: GitHub
- URL: https://github.com/patrykbaszak/ultra-mapper
- Owner: patrykbaszak
- Created: 2024-05-31T18:55:42.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-08-20T07:54:08.000Z (4 months ago)
- Last Synced: 2024-08-21T07:42:07.036Z (4 months ago)
- Language: PHP
- Homepage:
- Size: 383 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Ultra Mapper #
// description
## Usage
// in progress
## Attributes
### Groups & Ignore
`#[Ignore()]` is like `#[Groups()]` with empty array of groups. If You do not define the groups for property, then `Default` will be assignment as a property group. Only `Origin` can decide about group assignment in the process.
| Declaration place | Normalization | Denormalization | Transformation |
|:-:|:-:|:-:|:-:|
| **Origin** | Source: ✔️
Target: ✔️ | Source: ✔️
Target: ✔️ | Source: ✔️
Target: ✔️ |
| **Source** | Source: ✖️
Target: ✖️ | Source: ✖️
Target: ✖️ | Source: ✖️
Target: ✖️ |
| **Target** | Source: ✖️
Target: ✖️ | Source: ✖️
Target: ✖️ | Source: ✖️
Target: ✖️ |
| Declaration place | Mapping |
|:-:|:-:|
| **Origin** | Source: ✔️
Target: ✔️ |
| **Source** | Source: ✖️
Target: ✖️ |
| **Target** | Source: ✖️
Target: ✖️ |
###### legend: ✖️ - *has no effect*, ✔️ - *affects*, ➖ - *not implemented*
> **INFO**
> The table is implemented by `PBaszak\UltraMapper\Mapper\Domain\Matcher\Matcher::matchClassBlueprints()`.
### TargetProperty
The behavior of the `#[TargetProperty()]` attribute depends on the class in which you declare it (*origin*, *source*, *target*). The table below presents the relationship between the declaration place and the active process, and how the attribute changes the name (or path) of the property. Placing an attribute in an origin class has no effect on any process unless the origin class is also a source class, a target class, or both.
Target Property attribute works like `Symfony\SerializedName` for Normalization, Denormalization and Transformation. It changes property name when data are normalized.
| Declaration place | Normalization | Denormalization | Transformation |
|:-:|:-:|:-:|:-:|
| **Origin** | Source: ✖️
Target: ✖️ | Source: ✖️
Target: ✖️ | Source: ✖️
Target: ✖️ |
| **Source** | Source: ✖️
Target: ✖️ | Source: ✔️
Target: ✖️ | Source: ✔️
Target: ✖️ |
| **Target** | Source: ✖️
Target: ✔️ | Source: ✖️
Target: ✖️ | Source: ✖️
Target: ✔️ |
Target Property attribute links properties from different blueprints for Mapping. It works with other processes or alone.
| Declaration place | Mapping |
|:-:|:-:|
| **Origin** | Source: ✖️
Target: ✖️ |
| **Source** | Source: ✖️
Target: ✔️ |
| **Target** | Source: ✔️
Target: ✖️ |
###### legend: ✖️ - *has no effect*, ✔️ - *affects*, ➖ - *not implemented*
#### Usage
```php
use PBaszak\UltraMapper\Mapper\Application\Attribute\TargetProperty;
class SourceClass {
#[TargetProperty(name: "mappedProperty")]
public string $originalProperty;
}
class TargetClass {
public string $mappedProperty;
}
```
## How it works
The Ultra Mapper library operates based on blueprints and attributes to map, normalize, denormalize, and transform data between various formats. Here's a step-by-step overview of each process:
1. **Normalization**: Converts a class object into an anonymous object, associative array, or flat array.
2. **Denormalization**: Converts an anonymous object, associative array, or flat array back into a class object.
3. **Mapping**: Maps data from one class object to another, e.g., DTO to entity.
4. **Transformation**: Converts an anonymous object, associative array, or flat array to another structure of the same type.
The `TargetProperty` attribute is used to specify how properties are mapped or transformed, ensuring that the correct properties are connected even if their names differ.
## Performance Report
// in progress
## Development
### How to start
Start local environment using this command:
```sh
bash start.sh
```
### How to use **Standard Version**
If You don't have node_modules directory run:
```sh
npm install
```
First release:
```sh
npm run version:first-release
```
`Major`, `Minor`, `Patch` version update:
```sh
npm run version:major
# or
npm run version:minor
# or
npm run version:patch
```
Push tags:
```sh
npm run version:release
# or
npm run release
```
Check `package.json` for understand what commands do.
### How to use **PHPStan**
Main command:
```bash
docker exec php composer code:analyse
```
but, if You need to add errors to ignored:
```bash
docker exec php composer code:analyse:b
```
### How to use **PHP CS Fixer**
```bash
docker exec php composer code:fix
```
### How to use **XDebug** in **Visual Studio Code**
Create new file in Your project: `.vscode/launch.json`
```json
{
"version": "0.2.0",
"configurations": [
{
"name": "Listen for xDebug",
"type": "php",
"request": "launch",
"port": 5902,
"hostname": "0.0.0.0",
"pathMappings": {
"/app/": "${workspaceRoot}"
}
}
]
}
```
Uncomment environments in `.env.local`:
```env
XDEBUG_MODE=develop,debug
XDEBUG_CONFIG=" client_port=5902 idekey=VSCODE client_host=host.docker.internal discover_client_host=0 start_with_request=yes"
```
Type `Ctrl + Shift + D` and run `Listen for xDebug`.