bloc_enhancer_gen 0.3.2+1

A code generator for simplifying Bloc event and state classes, enhancing code readability and reducing naming conflicts.

bloc_enhancer

bloc_enhancer_gen is a code generator package that complements bloc_enhancer by automating the generation of streamlined Bloc event and state classes. This generator simplifies and enhances the development process, allowing for more intuitive and efficient state management.

Why bloc_enhancer_gen?

The Problem

My biggest (prior) complaint for using bloc was naming. Generally, you have to prepend all public states and events with the bloc's name to avoid naming conflicts with other blocs (You can't have 2 Ready states 🙄), then the names started to get long.

You'd also have to remember what the name of your event is to invoke bloc.add(YourBlocEven()). You'd also have to remember what the name of your state is to check bloc.state is YourBlocState. This is all fine and dandy for small projects, but as your project grows, it becomes a pain to manage.

There are packages that help you with mapping out your states... but dart only allows 80 characters per line, so nesting all of your (UI) code within a bloc.state.map is not ideal.

The Solution

bloc_enhancer_gen is a code generator that generates a set of extensions that allow you to invoke events and check states intuitively.

// Simplified events (you can use intellisense! 🙌)
bloc.events.createUser(name: 'John');

// Intuitive state type check and retrieval
if (bloc.state.asIfReady case final readyState?) {
    // Handle the ready state
}

// or
if (bloc.state.isReady) {
    final readyState = bloc.state.asReady;
    // Handle the ready state
}

Getting Started

1. Add the bloc_enhancer, bloc_enhancer_gen, build_runner packages to your pubspec.yaml file:

   dependencies:
       bloc_enhancer: # latest version
   
   dev_dependencies:
       bloc_enhancer_gen: # latest version
       build_runner: # latest version
   

2. Configure the build runner to use bloc_enhancer_gen in your build.yaml file:

   targets:
       $default:
           builders:
               bloc_enhancer_gen:
                   generate_for:
                       - lib/blocs/*.dart
                   options:
                       auto_enhance: false # set to true to automatically enhance all Blocs
   

3. Feed Bloc to the generator using @enhance or the config in build.yaml.

Using @enhance

 import 'package:bloc_enhancer/bloc_enhancer.dart';

@enhance
class UserBloc extends Bloc<UserEvent, UserState> {
     ...
}

Using build.yaml

targets:
    $default:
        builders:
            bloc_enhancer_gen:
                generate_for:
                    - lib/**.dart
                options:
                    auto_enhance: true

bloc_enhancer_gen will read your events and your states.

// user_event.dart
class UserEvent {}
class _Create extends UserEvent {}
class _UpdateUser extends UserEvent {
    const _UpdateUser.name(String this.name): email = null;
    const _UpdateUser.email(String this.email): name = null;

    final String? name;
    final String? email;
}

// user_state.dart
class UserState {}
class _Ready extends UserState {
    const Ready(this.user);

    final User user;
}
class _Loading extends UserState {}
class _Error extends UserState {
    const Error(this.message);

    final String message;
}

1. Run the build command to generate the enhanced Bloc classes:

   # using flutter
   flutter pub run build_runner build --delete-conflicting-outputs
   
    # using dart
    pub run build_runner build --delete-conflicting-outputs
   

Testing

Obviously we can't test private classes, so how do we test the enhanced blocs?

Enhanced blocs can generate "Factory" classes for both event & state classes. These classes will create new instances of the event or state class with all the necessary parameters.

Generate

Via createFactory Annotation

To generate the factory classes, you can annotate the base event or state class with @createFactory.

@createFactory
class UserEvent {}

class _Fetch extends UserEvent {}

@createFactory
class UserState {}

class _Ready extends UserState {}

Via create_event_factory & create_state_factory Options

You can also enable the factory generation via the build.yaml file.

Note: This will generate factories for all events and states for every enhanced bloc.

targets:
    $default:
        builders:
            bloc_enhancer_gen:
                generate_for:
                    - lib/**.dart
                options:
                    create_event_factory: true # default is false
                    create_state_factory: true # default is false

Usage

To use the newly generated factories, create a static instance of the in the base event or state class.

@createFactory
class UserEvent {
    static const create = _$UserEventCreator();
}

@createFactory
class UserState {
    static const create = _$UserStateCreator();
}

Now you can create new instances of the event or state classes within your tests.

final readyState = UserState.create.ready();

final fetchEvent = UserEvent.create.fetch();

If you don't want to create a certain class in the factory, you can exclude them by annotating the class with @ignore. This also applies to constructs that you'd like to exclude too.

A note about build_runner

The build runner can be slow if you have a large project. It really starts to slow down with nested folders. To get the optimal performance, I recommend flattening your files that require generation as much as possible. This will allow the build runner to only scan the files that are necessary.

Slow 🚶

lib
└── blocs
    ├── user
    │   ├── user_bloc.dart
    │   ├── user_event.dart
    │   └── user_state.dart
    └── post
        ├── post_bloc.dart
        ├── post_event.dart
        └── post_state.dart

Fast 🏃

lib
├── user_bloc.dart
├── user_event.dart
├── user_state.dart
├── post_bloc.dart
├── post_event.dart
└── post_state.dart

You can also use the exclude option in build.yaml to exclude folders that don't need to be scanned.

targets:
    $default:
        builders:
            bloc_enhancer_gen:
                generate_for:
                    include:
                        - lib/blocs/*.dart
                    exclude:
                        - lib/ui/**

generate_for.include & generate_for.exclude are not bound to this package. They are part of the build.yaml format. You can read more here

License

This software is released under the Apache 2.0 license. https://www.apache.org/licenses/LICENSE-2.0