feat: mason - usecase bricks (#45)

martinloesethjensen · web-flow · commit 4ea0a124bb64 · 2022-04-13T13:31:07.000+03:00
* feat: added mason and [cubit, bloc, usecase, output_usecase]

* feat: added usecase mason bricks

* fix: exclude `bricks/**`

* doc: bricks collection README.md

* doc: updated README.md to reflect the brick usecases
diff --git a/.mason/bricks.json b/.mason/bricks.json
@@ -0,0 +1 @@
+{"cubit":"/Users/mlj/.mason-cache/hosted/registry.brickhub.dev/cubit_0.1.1","bloc":"/Users/mlj/.mason-cache/hosted/registry.brickhub.dev/bloc_0.1.1","usecase":"/Users/mlj/work/flutter-template/bricks/usecase","output_usecase":"/Users/mlj/work/flutter-template/bricks/output_usecase","stream_usecase":"/Users/mlj/work/flutter-template/bricks/stream_usecase","stream_output_usecase":"/Users/mlj/work/flutter-template/bricks/stream_output_usecase","future_output_usecase":"/Users/mlj/work/flutter-template/bricks/future_output_usecase","future_usecase":"/Users/mlj/work/flutter-template/bricks/future_usecase"}
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -80,3 +80,5 @@ analyzer:
     - "**/*.freezed.dart"
     # Ignore warnings in files generated by NStack specifically.
     - "**/*nstack.dart"
+    # Ignore bricks
+    - bricks/**
diff --git a/bricks/README.md b/bricks/README.md
@@ -0,0 +1,26 @@
+# Monstar Bricks 🧱
+
+A collection of bricks.
+
+## Installation
+
+Ensure you have the [mason_cli](https://github.com/felangel/mason/tree/master/packages/mason_cli) installed. Bricks can be installed from [brickhub.dev](https://brickhub.dev).
+
+> brickhub is currently in closed alpha testing.
+
+```sh
+mason add <BRICK> [--path <LOCAL_BRICK_PATH>]
+```
+
+## Bricks
+
+| Brick                   | Description                          |
+| ----------------------- | ------------------------------------ |
+| `bloc`                  | Generate a new Bloc                  |
+| `cubit`                 | Generate a new Cubit                 |
+| `usecase`               | Generate a new usecase               |
+| `output_usecase`        | Generate a new output usecase        |
+| `stream_usecase`        | Generate a new stream usecase        |
+| `stream_output_usecase` | Generate a new stream output usecase |
+| `future_usecase`        | Generate a new future usecase        |
+| `future_output_usecase` | Generate a new future output usecase |
diff --git a/bricks/future_output_usecase/CHANGELOG.md b/bricks/future_output_usecase/CHANGELOG.md
@@ -0,0 +1,3 @@
+# 0.1.0+1
+
+- TODO: Describe initial release.
diff --git a/bricks/future_output_usecase/LICENSE b/bricks/future_output_usecase/LICENSE
@@ -0,0 +1 @@
+TODO: Add your license here.
diff --git a/bricks/future_output_usecase/README.md b/bricks/future_output_usecase/README.md
@@ -0,0 +1,24 @@
+# usecase
+
+Generate a new FutureOutputUseCase in [Dart][1].
+
+## Usage 🚀
+
+```sh
+mason make future_output_usecase --name GetStories --output_type List<Story>
+```
+
+## Variables ✨
+
+| Variable      | Description                    | Default  | Type     |
+| ------------- | ------------------------------ | -------- | -------- |
+| `name`        | The name of the usecase class  | None     | `string` |
+| `output_type` | The output type of the usecase | `String` | `string` |
+
+## Output 📦
+
+```sh
+└── get_stories_usecase.dart
+```
+
+[1]: https://dart.dev
diff --git a/bricks/future_output_usecase/__brick__/{{name.snakeCase()}}_usecase.dart b/bricks/future_output_usecase/__brick__/{{name.snakeCase()}}_usecase.dart
@@ -0,0 +1,6 @@
+class {{name.pascalCase()}}UseCase extends FutureOutputUseCase<{{output_type.pascalCase()}}> {
+  @override
+  Future<{{output_type.pascalCase()}}> run() {
+    // TODO: implement usecase
+  }
+}
diff --git a/bricks/future_output_usecase/brick.yaml b/bricks/future_output_usecase/brick.yaml
@@ -0,0 +1,30 @@
+name: future_output_usecase
+description: A new brick created with the Mason CLI.
+
+# The following defines the version and build number for your brick.
+# A version number is three numbers separated by dots, like 1.2.34
+# followed by an optional build number (separated by a +).
+version: 0.1.0+1
+
+# The following defines the environment for the current brick.
+# It includes the version of mason that the brick requires.
+environment:
+  mason: ">=0.1.0-dev <0.1.0"
+
+# Variables specify dynamic values that your brick depends on.
+# Zero or more variables can be specified for a given brick.
+# Each variable has:
+#  * a type (string, number, or boolean)
+#  * an optional short description
+#  * an optional default value
+#  * an optional prompt phrase used when asking for the variable.
+vars:
+  name:
+    type: string
+    description: Use case name
+    prompt: What is the use case name?
+  output_type:
+    type: string
+    description: The use case output type (example String)
+    default: String
+    prompt: What is the output type for the use case?
diff --git a/bricks/future_usecase/CHANGELOG.md b/bricks/future_usecase/CHANGELOG.md
@@ -0,0 +1,3 @@
+# 0.1.0+1
+
+- TODO: Describe initial release.
diff --git a/bricks/future_usecase/LICENSE b/bricks/future_usecase/LICENSE
@@ -0,0 +1 @@
+TODO: Add your license here.
diff --git a/bricks/future_usecase/README.md b/bricks/future_usecase/README.md
@@ -0,0 +1,25 @@
+# usecase
+
+Generate a new FutureUseCase in [Dart][1].
+
+## Usage 🚀
+
+```sh
+mason make future_usecase --name GetStories --input_type Query --output_type List<Story>
+```
+
+## Variables ✨
+
+| Variable      | Description                    | Default  | Type     |
+| ------------- | ------------------------------ | -------- | -------- |
+| `name`        | The name of the usecase class  | None     | `string` |
+| `input_type`  | The input type of the usecase  | `String` | `string` |
+| `output_type` | The output type of the usecase | `String` | `string` |
+
+## Output 📦
+
+```sh
+└── get_stories_usecase.dart
+```
+
+[1]: https://dart.dev
diff --git a/bricks/future_usecase/__brick__/{{name.snakeCase()}}_usecase.dart b/bricks/future_usecase/__brick__/{{name.snakeCase()}}_usecase.dart
@@ -0,0 +1,6 @@
+class {{name.pascalCase()}}UseCase extends FutureUseCase<{{input_type.pascalCase()}}, {{output_type.pascalCase()}}> {
+  @override
+  Future<{{output_type.pascalCase()}}> run({{input_type.pascalCase()}} input) {
+    // TODO: implement usecase
+  }
+}
diff --git a/bricks/future_usecase/brick.yaml b/bricks/future_usecase/brick.yaml
@@ -0,0 +1,36 @@
+name: future_usecase
+description: A new brick created with the Mason CLI.
+
+# The following defines the version and build number for your brick.
+# A version number is three numbers separated by dots, like 1.2.34
+# followed by an optional build number (separated by a +).
+version: 0.1.0+1
+
+# The following defines the environment for the current brick.
+# It includes the version of mason that the brick requires.
+environment:
+  mason: ">=0.1.0-dev <0.1.0"
+
+# Variables specify dynamic values that your brick depends on.
+# Zero or more variables can be specified for a given brick.
+# Each variable has:
+#  * a type (string, number, or boolean)
+#  * an optional short description
+#  * an optional default value
+#  * an optional prompt phrase used when asking for the variable.
+vars:
+  name:
+    type: string
+    description: Use case name
+    prompt: What is the use case name?
+  input_type:
+    type: string
+    description: The use case input type (example String)
+    default: String
+    prompt: What is the input type for the use case?
+  output_type:
+    type: string
+    description: The use case output type (example String)
+    default: String
+    prompt: What is the output type for the use case?
+
diff --git a/bricks/output_usecase/CHANGELOG.md b/bricks/output_usecase/CHANGELOG.md
@@ -0,0 +1,3 @@
+# 0.1.0+1
+
+- TODO: Describe initial release.
diff --git a/bricks/output_usecase/LICENSE b/bricks/output_usecase/LICENSE
@@ -0,0 +1 @@
+TODO: Add your license here.
diff --git a/bricks/output_usecase/README.md b/bricks/output_usecase/README.md
@@ -0,0 +1,24 @@
+# usecase
+
+Generate a new OutputUseCase in [Dart][1].
+
+## Usage 🚀
+
+```sh
+mason make output_usecase --name GetStories --output_type List<Story>
+```
+
+## Variables ✨
+
+| Variable      | Description                    | Default  | Type     |
+| ------------- | ------------------------------ | -------- | -------- |
+| `name`        | The name of the usecase class  | None     | `string` |
+| `output_type` | The output type of the usecase | `String` | `string` |
+
+## Output 📦
+
+```sh
+└── get_stories_usecase.dart
+```
+
+[1]: https://dart.dev
diff --git a/bricks/output_usecase/__brick__/{{name.snakeCase()}}_usecase.dart b/bricks/output_usecase/__brick__/{{name.snakeCase()}}_usecase.dart
@@ -0,0 +1,6 @@
+class {{name.pascalCase()}}UseCase extends OutputUseCase<{{output_type.pascalCase()}}> {
+  @override
+  {{output_type.pascalCase()}} run() {
+    // TODO: implement usecase
+  }
+}
diff --git a/bricks/output_usecase/brick.yaml b/bricks/output_usecase/brick.yaml
@@ -0,0 +1,30 @@
+name: output_usecase
+description: A new brick created with the Mason CLI.
+
+# The following defines the version and build number for your brick.
+# A version number is three numbers separated by dots, like 1.2.34
+# followed by an optional build number (separated by a +).
+version: 0.1.0+1
+
+# The following defines the environment for the current brick.
+# It includes the version of mason that the brick requires.
+environment:
+  mason: ">=0.1.0-dev <0.1.0"
+
+# Variables specify dynamic values that your brick depends on.
+# Zero or more variables can be specified for a given brick.
+# Each variable has:
+#  * a type (string, number, or boolean)
+#  * an optional short description
+#  * an optional default value
+#  * an optional prompt phrase used when asking for the variable.
+vars:
+  name:
+    type: string
+    description: Use case name
+    prompt: What is the use case name?
+  output_type:
+    type: string
+    description: The use case output type (example String)
+    default: String
+    prompt: What is the output type for the use case?
diff --git a/bricks/stream_output_usecase/CHANGELOG.md b/bricks/stream_output_usecase/CHANGELOG.md
@@ -0,0 +1,3 @@
+# 0.1.0+1
+
+- TODO: Describe initial release.
diff --git a/bricks/stream_output_usecase/LICENSE b/bricks/stream_output_usecase/LICENSE
@@ -0,0 +1 @@
+TODO: Add your license here.
diff --git a/bricks/stream_output_usecase/README.md b/bricks/stream_output_usecase/README.md
@@ -0,0 +1,24 @@
+# usecase
+
+Generate a new StreamOutputUseCase in [Dart][1].
+
+## Usage 🚀
+
+```sh
+mason make stream_output_usecase --name GetStories --output_type List<Story>
+```
+
+## Variables ✨
+
+| Variable      | Description                    | Default  | Type     |
+| ------------- | ------------------------------ | -------- | -------- |
+| `name`        | The name of the usecase class  | None     | `string` |
+| `output_type` | The output type of the usecase | `String` | `string` |
+
+## Output 📦
+
+```sh
+└── get_stories_usecase.dart
+```
+
+[1]: https://dart.dev
diff --git a/bricks/stream_output_usecase/__brick__/{{name.snakeCase()}}_usecase.dart b/bricks/stream_output_usecase/__brick__/{{name.snakeCase()}}_usecase.dart
@@ -0,0 +1,6 @@
+class {{name.pascalCase()}}UseCase extends StreamOutputUseCase<{{output_type.pascalCase()}}> {
+  @override
+  Stream<{{output_type.pascalCase()}}> run() {
+    // TODO: implement usecase
+  }
+}
diff --git a/bricks/stream_output_usecase/brick.yaml b/bricks/stream_output_usecase/brick.yaml
@@ -0,0 +1,30 @@
+name: stream_output_usecase
+description: A new brick created with the Mason CLI.
+
+# The following defines the version and build number for your brick.
+# A version number is three numbers separated by dots, like 1.2.34
+# followed by an optional build number (separated by a +).
+version: 0.1.0+1
+
+# The following defines the environment for the current brick.
+# It includes the version of mason that the brick requires.
+environment:
+  mason: ">=0.1.0-dev <0.1.0"
+
+# Variables specify dynamic values that your brick depends on.
+# Zero or more variables can be specified for a given brick.
+# Each variable has:
+#  * a type (string, number, or boolean)
+#  * an optional short description
+#  * an optional default value
+#  * an optional prompt phrase used when asking for the variable.
+vars:
+  name:
+    type: string
+    description: Use case name
+    prompt: What is the use case name?
+  output_type:
+    type: string
+    description: The use case output type (example String)
+    default: String
+    prompt: What is the output type for the use case?
diff --git a/bricks/stream_usecase/CHANGELOG.md b/bricks/stream_usecase/CHANGELOG.md
@@ -0,0 +1,3 @@
+# 0.1.0+1
+
+- TODO: Describe initial release.
diff --git a/bricks/stream_usecase/LICENSE b/bricks/stream_usecase/LICENSE
@@ -0,0 +1 @@
+TODO: Add your license here.
diff --git a/bricks/stream_usecase/README.md b/bricks/stream_usecase/README.md
@@ -0,0 +1,25 @@
+# usecase
+
+Generate a new StreamUseCase in [Dart][1].
+
+## Usage 🚀
+
+```sh
+mason make stream_usecase --name GetStories --input_type Query --output_type List<Story>
+```
+
+## Variables ✨
+
+| Variable      | Description                    | Default  | Type     |
+| ------------- | ------------------------------ | -------- | -------- |
+| `name`        | The name of the usecase class  | None     | `string` |
+| `input_type`  | The input type of the usecase  | `String` | `string` |
+| `output_type` | The output type of the usecase | `String` | `string` |
+
+## Output 📦
+
+```sh
+└── get_stories_usecase.dart
+```
+
+[1]: https://dart.dev
diff --git a/bricks/stream_usecase/__brick__/{{name.snakeCase()}}_usecase.dart b/bricks/stream_usecase/__brick__/{{name.snakeCase()}}_usecase.dart
@@ -0,0 +1,6 @@
+class {{name.pascalCase()}}UseCase extends StreamUseCase<{{input_type.pascalCase()}}, {{output_type.pascalCase()}}> {
+  @override
+  Stream<{{output_type.pascalCase()}}> run({{input_type.pascalCase()}} input) {
+    // TODO: implement usecase
+  }
+}
diff --git a/bricks/stream_usecase/brick.yaml b/bricks/stream_usecase/brick.yaml
@@ -0,0 +1,35 @@
+name: stream_usecase
+description: A new brick created with the Mason CLI.
+
+# The following defines the version and build number for your brick.
+# A version number is three numbers separated by dots, like 1.2.34
+# followed by an optional build number (separated by a +).
+version: 0.1.0+1
+
+# The following defines the environment for the current brick.
+# It includes the version of mason that the brick requires.
+environment:
+  mason: ">=0.1.0-dev <0.1.0"
+
+# Variables specify dynamic values that your brick depends on.
+# Zero or more variables can be specified for a given brick.
+# Each variable has:
+#  * a type (string, number, or boolean)
+#  * an optional short description
+#  * an optional default value
+#  * an optional prompt phrase used when asking for the variable.
+vars:
+  name:
+    type: string
+    description: Use case name
+    prompt: What is the use case name?
+  input_type:
+    type: string
+    description: The use case input type (example String)
+    default: String
+    prompt: What is the input type for the use case?
+  output_type:
+    type: string
+    description: The use case output type (example String)
+    default: String
+    prompt: What is the output type for the use case?
diff --git a/bricks/usecase/CHANGELOG.md b/bricks/usecase/CHANGELOG.md
diff --git a/bricks/usecase/LICENSE b/bricks/usecase/LICENSE
diff --git a/bricks/usecase/README.md b/bricks/usecase/README.md
diff --git a/bricks/usecase/__brick__/{{name.snakeCase()}}_usecase.dart b/bricks/usecase/__brick__/{{name.snakeCase()}}_usecase.dart
diff --git a/bricks/usecase/brick.yaml b/bricks/usecase/brick.yaml
diff --git a/lib/domain/common/use_case.dart b/lib/domain/common/use_case.dart
diff --git a/mason-lock.json b/mason-lock.json
diff --git a/mason.yaml b/mason.yaml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+{"cubit":"/Users/mlj/.mason-cache/hosted/registry.brickhub.dev/cubit_0.1.1","bloc":"/Users/mlj/.mason-cache/hosted/registry.brickhub.dev/bloc_0.1.1","usecase":"/Users/mlj/work/flutter-template/bricks/usecase","output_usecase":"/Users/mlj/work/flutter-template/bricks/output_usecase","stream_usecase":"/Users/mlj/work/flutter-template/bricks/stream_usecase","stream_output_usecase":"/Users/mlj/work/flutter-template/bricks/stream_output_usecase","future_output_usecase":"/Users/mlj/work/flutter-template/bricks/future_output_usecase","future_usecase":"/Users/mlj/work/flutter-template/bricks/future_usecase"}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# 0.1.0+1`
	`2`	`+`
	`3`	`+- TODO: Describe initial release.`