Pine DTO Mapper

A brick to create your DTO Mapper class including tests.

This brick makes use of the internal lib pine_bricks_helper to get access to the package name, so please run this brick in the root of your project where a valid pubspec.yaml file exists.

How to use 🚀

mason make pine_dto_mapper --name "UserMapper" --model_name "User" --dto_name "User" --type "jto"

Variables ✨

Outputs 📦

--name "UserMapper" --model_name "User" --dto_name "UserJTO" --type "jto"
├── lib
│   └── repositories
│       └── mappers
│           └── user_mapper.dart
├── test
│   └── repositories
│       └── mappers
│           └── user_mapper_test.dart
└── ...

DTO Mapper File

import 'package:pine/pine.dart';
import 'package:{{package_name}}/models/user/user.dart';
import 'package:{{package_name}}/services/network/jto/user/user_jto.dart';

class UserMapper extends DTOMapper<UserJTO, User> {
  const UserMapper();
  
  @override
  User fromDTO(UserJTO dto) => User();

  @override
  UserJTO toDTO(User model) => UserJTO();
}

Test File

import 'package:flutter_test/flutter_test.dart';
import 'package:{{package_name}}/models/user/user.dart';
import 'package:{{package_name}}/repositories/mappers/user_mapper.dart';
import 'package:{{package_name}}/services/network/jto/user/user_jto.dart';
import '../../fixtures/jto/user_jto_fixture_factory.dart';

void main() {
  late UserMapper mapper;
  late UserJTO dto;
  late User model;

  setUp(() {
    dto = UserJTOFixture.factory().makeSingle();

    model = User();
    mapper = const UserMapper();
  });

  test('mapping User object from UserJTO', () {
    expect(mapper.fromDTO(dto), equals(model));
  });

  test('mapping User to UserJTO', () {
    expect(mapper.toDTO(model), equals(dto));
  });
}

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add pine_dto_mapper

# Install globally
mason add -g pine_dto_mapper

Usage 🚀

mason make pine_dto_mapper

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.40 <0.1.0"

0.2.0

Added default const constructor

0.1.0

First release

Copyright (c) 2023 MyLittleSuite

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.