Clean Architecture Global Structure

Generate a clean architecture structure with its respective files (Data sources, Repositories, Models, Entities, Use cases) at the root of your project.

Getting Started 🚀

1. Install mason

   dart pub global activate mason_cli
   

2. Add the brick

   mason add -g clean_architecture_global_structure
   

3. Make a new Dart package

   mason make clean_architecture_global_structure
   

Variables ✨

Outputs 📦

Data directory outputs 🧱

├── data
│   ├── datasources
│   │   └── auth.dart
│   ├── models
│   │   └── auth_model.dart
│   ├── repositories
│   │   └── auth_repository_impl.dart
│   └── ...
└── ...   

Domain directory outputs 🧱

├── domain
│   ├── repositories
│   │   └── auth_repository.dart
│   ├── entities
│   │   └── auth_entity.dart
│   ├── usecases
│   │   └── auth_use_case.dart
│   └── ...
└── ...   

Aplication layer directory outputs 🧱

├── application_layer
│   ├── auth
│   │   ├── bloc
│   │   │   ├── auth
│   │   │   │   ├── auth_bloc.dart
│   │   │   │   ├── auth_event.dart
│   │   │   │   ├── auth_state.dart
│   │   │   │   └── bloc.dart
│   │   │   └── ...  
│   │   ├── pages
│   │   │   └── auth_page.dart
│   │   ├── widgets
│   │   │   └── .gitkeep
│   │   └── ...
│   └── ...
└── ...    

General outputs 🧱

├── lib
│   ├── application_layer
│   │   ├── auth
│   │   │   ├── pages
│   │   │   │   └── auth_page.dart
│   │   │   ├── widgets
│   │   │   │   └── .gitkeep
│   │   │   └── ...
│   │   └── ...
│   ├── core
│   │   ├── errors
│   │   │   └── failures.dart
│   │   ├── usecases
│   │   │   └── usecase.dart
│   ├── data
│   │   ├── datasources
│   │   │   └── auth.dart
│   │   ├── models
│   │   │   └── auth_model.dart
│   │   ├── repositories
│   │   │   └── auth_repository_impl.dart
│   │   └── ...
│   ├── domain
│   │   ├── repositories
│   │   │   └── auth_repository.dart
│   │   ├── entities
│   │   │   └── auth_entity.dart
│   │   ├── usecases
│   │   │   └── auth_use_case.dart
│   │   └── ...
│   └── ...   
└── ...

Outputs Example

Data

Datasource class

abstract class AuthDataSource {
// TODO: implement your AuthDataSource

class AuthDataSourceImpl implements AuthDataSource {
// TODO: implement your AuthDataSourceImpl
}

Model class

import 'package:any/domain/entities/auth_entity.dart';

class AuthModel extends AuthEntity {
  // TODO: implement your AuthModel
}

Repository implementation class

import "package:any/domain/repositories/auth_repository.dart";

class AuthRepositoryImpl implements AuthRepository {
  // TODO: implement your AuthRepositoryImpl
}

Domain

Entity

import 'package:equatable/equatable.dart';

class AuthEntity extends Equatable {
  // TODO: implement your AuthEntity

  @override
  // TODO: implement props
  List<Object?> get props => throw UnimplementedError();
}

Repository

class AuthRepository {
  // TODO: implement your AuthRepository
}

Use case

import 'package:dartz/dartz.dart';

import 'package:any/core/usecases/usecase.dart';
import 'package:any/core/error/failure.dart';

class AuthUseCase implements UseCase<void, AuthParams> {
  // TODO: implement the output of your AuthUseCase


  @override
  Future<Either<Failure, void>> call(AuthParams params) {
    // TODO: implement call
    throw UnimplementedError();
  }
}

class AuthParams {
  // TODO: implement your AuthParams
  const AuthParams();
}

Core

Use case

import 'package:dartz/dartz.dart';
import 'package:any/core/errors/failures.dart';

abstract class UseCase<Output, Input> {
  Future<Either<Failure, Output>> call(Input params);
}

Failures

import 'package:equatable/equatable.dart';

abstract class Failure extends Equatable {
  final int? statusCode;
  final String? responseMessage;
  final Exception? exception;

  const Failure([this.statusCode, this.responseMessage, this.exception]);

  @override
  List<Object?> get props => [statusCode, responseMessage, exception];
}

Aplication layer

Page

import 'package:flutter/material.dart';

class AuthPage extends StatelessWidget {
  const AuthPage ({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return const SizedBox();
  }
}

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 clean_architecture_global_structure

# Install globally
mason add -g clean_architecture_global_structure

Usage 🚀

mason make clean_architecture_global_structure

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ❌   Post-Gen

Environment 🌎

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

0.1.3

• feat: update documentation.

0.1.2

• feat: include use case class and failures abstract class.

0.1.1

• feat: set up to publish in brickhub.

0.1.0

• feat: Create initial Clean Architecture Global Structure brick.

MIT License

Copyright (c) 2022 Jonatas Brito

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.