Pine Cubit

A brick to create your cubits (with methods and states) 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. Also, make sure you have previously set up your project to work with the freezed and the flutter_cubit library.

How to use 🚀

mason make pine_cubit --name "SignIn" --methods "perform" --states "performing,performed,error"

Variables ✨

Outputs 📦

--name "SignIn" --methods "perform" --states "performing,performed,error"
├── lib
│   └── cubits
│       └── sign_in
│           |── sign_in_cubit.dart
│           └── sign_in_state.dart
├── test
│   └── cubits
│       └── sign_in
│           └── sign_in_cubit_test.dart
└── ...

Cubit File

import 'package:flutter_cubit/flutter_cubit.dart';
import 'package:freezed_annotation/freezed_annotation.dart';
import 'dart:async';

part 'sign_in_state.dart';

part 'sign_in_cubit.freezed.dart';

/// The SignInCubit
class SignInCubit extends Cubit<SignInState> {

  /// Create a new instance of [SignInCubit].
  SignInCubit() : super(const SignInState.performing());

  /// Method used to perform the [perform] action
  FutureOr<void> perform() {
    //TODO: map PerformSignInEvent to SignInState states
  }
}

extension SignInCubitExtension on BuildContext {
  /// Extension method used to get the [SignInCubit] instance
  SignInCubit get signInCubit => read<SignInCubit>();
}

State File

part of 'sign_in_cubit.dart';

@freezed
class SignInState with _$SignInState {
  const factory SignInState.performing() = PerformingSignInState;

  const factory SignInState.performed() = PerformedSignInState;

  const factory SignInState.error() = ErrorSignInState;
}

Test File

import 'package:cubit_test/cubit_test.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:{{package_name}}/cubits/sign_in/sign_in_cubit.dart';

void main() {
  late SignInCubit cubit;

  setUp(() {
    cubit = SignInCubit();
  });

  /// Testing the method [perform]
  group('when the method perform is called', () {
    cubitTest<SignInCubit, SignInState>(
      'test that SignInCubit emits SignInState.performing when perform is called',
      setUp: () {
        //TODO: setup the environment
      },
      build: () => cubit,
      act: (cubit) {
        cubit.perform();
      },
      expect: () =>
      <SignInState>[
        //TODO: define the emitted SignInState states
      ],
      verify: (_) {
        //TODO: verify that methods are invoked properly
      },
    );
  });
}

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_cubit

# Install globally
mason add -g pine_cubit

Usage 🚀

mason make pine_cubit

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

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

0.3.0

Added Cubit extension on context

0.2.0

State classes are now public to support new Dart 3 Switch Expressions

0.1.0

First release

Copyright (c) 2024 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.