Scaffolding

A brick to scaffold a flutter application for CRUD (Create, Read, Update and Delete)!

This is based on rails and grails scaffolding.

Lots of ideas, structure and approach lifted directly from their documentation, source code and my own prior experience using the scaffolding approach in grails/rails to bootstrap CRUD web application.

In creating this brick I thought why not try take these learning/reduce boilerplate benefits to flutter / dart even if only to help quickly educate the patterns in building, testing and scaling a CRUD application using state management in BLoC (Business logic controller) and unit tests.

Please note this has nothing to do with the flutter Scaffold (https://api.flutter.dev/flutter/material/Scaffold-class.html) material class widget.

Samples screens

Table of Contents

• How to use
  • Scaffolding from Command Line
  • Scaffolding from Config
• Outputs

How to use 🚀

Simple flutter project

Start with a simple flutter project and add the following dependencies

equatable
uuid
flutter_bloc

For the generated unit test you will also need

mockito
bloc_test

The steps to add from the command line would be:

flutter create scaffolding_sample
cd scaffolding_sample
flutter pub add equatable uuid flutter_bloc
flutter pub add mocktail bloc_test --dev

Next setup mason to scaffold your code.

Command Line

mason init
mason add scaffolding
mason make scaffolding --package scaffolding_sample --feature feature1 --properties "String firstName=Your first name, String lastName=Your surname, bool registered=false, int age=21" --generate-tests true --generate-home true

To confirm the tests are all passing with full coverage run the following from the based of the project (noting the removal of the widget_test from flutter create):

rm test/widget_test.dart 
flutter test --coverage && genhtml -p ${PWD}/lib -o coverage coverage/lcov.info && open coverage/index.html

You should see a result similar to the image below in your browser.

Variables for the Command Line and Config Json ✨

Config

mason make scaffolding -c scaffolding_config.json

Example Config:

{
  "package": "scaffolding_sample",
  "feature": "feature1",
  "generate-tests": true, // true or false
  "generate-home": true, // true or false
  "properties": "String firstName=Your first name, String lastName=Your surname, bool registered=false, int age=21"
}

Outputs 📦

--package scaffolding_sample --feature feature1 --properties "String firstName=Your first name, String lastName=Your surname, bool registered=false, int age=21" --generate-tests true --generate-home true
lib/
├─ features/
│  └─ feature1/
│     ├─ data/
│     │  ├─ feature1_model.dart
│     │  └─ feature1_repository_impl.dart
│     ├─ domain/
│     │  ├─ feature1_repository.dart
│     │  └─ feature1.dart
│     └─ presentation/
│        ├─ bloc/
│        │  ├─ feature1_edit_bloc.dart
│        │  ├─ feature1_edit_event.dart
│        │  ├─ feature1_edit_state.dart
│        │  ├─ feature1_read_bloc.dart
│        │  ├─ feature1_read_event.dart
│        │  └─ feature1_read_state.dart
│        └─ views/
│           ├─ feature1_edit_view.dart
│           └─ feature1_read_view.dart
└─ shared/
   └─ presentation/
         └─ list_table.dart

Files from the scaffolding_test and scaffolding_main that are included for the options --generate-tests true --generate-home true

When --generate-test true

test/
└─ features/
   └─ feature1/
      ├─ data/
      │  ├─ feature1_model_test.dart
      │  └─ feature1_repository_impl_test.dart
      ├─ domain/
      │  └─ feature1_test.dart
      └─ presentation/
         ├─ bloc/
         │  ├─ feature1_edit_bloc_test.dart
         │  └─ feature1_read_bloc_test.dart
         └─ views/
            ├─ feature1_edit_view_test.dart
            └─ feature1_read_view_test.dart

When --generate-home true

lib/
├─ main.dart
└─ scaffold_app.dart

When both --generate-home true and --generate-test true

test/
└─ scaffold_app_test.dart

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 scaffolding

# Install globally
mason add -g scaffolding

Usage 🚀

mason make scaffolding

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

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

0.1.0 Bumping minor release after milestone https://github.com/sjhorn/mason_bricks/milestone/1

0.0.5

• enhancement: add type based form components to edit view https://github.com/sjhorn/mason_bricks/issues/5

0.0.4

• enhancement: adjust the read view to show appropriate visual by type https://github.com/sjhorn/mason_bricks/issues/4

0.0.2

• Now part of brickhub.dev - so can simplify install

0.0.1

• Build basic hooks and templates for the CRUD application, confirm running on macos

MIT License

Copyright (c) 2023 Scott Horn

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.