docs(examples): add todos example (#236)

Author: felangel

.github/workflows/examples_todos.yaml

@@ -0,0 +1,35 @@
+name: examples/todos
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  pull_request:
+    paths:
+      - "examples/todos/routes/**"
+      - "examples/todos/lib/**"
+      - "examples/todos/test/**"
+      - "examples/todos/packages/**/lib/**"
+      - "examples/todos/packages/**/test/**"
+      - ".github/workflows/examples_todos.yaml"
+    branches:
+      - main
+
+jobs:
+  build:
+    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1
+    with:
+      working_directory: examples/todos
+      analyze_directories: "routes test"
+      report_on: "routes"
+
+  todos_data_source:
+    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1
+    with:
+      working_directory: examples/todos/packages/todos_data_source
+
+  in_memory_todos_data_source:
+    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1
+    with:
+      working_directory: examples/todos/packages/in_memory_todos_data_source

examples/todos/.gitignore

@@ -0,0 +1,13 @@
+# See https://www.dartlang.org/guides/libraries/private-files
+
+# Files and directories created by pub
+.dart_tool/
+.packages
+pubspec.lock
+
+# Files and directories created by dart_frog
+build/
+.dart_frog
+
+# Test related files
+coverage/

examples/todos/README.md

@@ -0,0 +1,11 @@
+# todos
+
+[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
+[![License: MIT][license_badge]][license_link]
+
+An example todos app built with `dart_frog`.
+
+[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
+[license_link]: https://opensource.org/licenses/MIT
+[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
+[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis

examples/todos/analysis_options.yaml

@@ -0,0 +1,7 @@
+include: package:very_good_analysis/analysis_options.3.0.1.yaml
+analyzer:
+  exclude:
+    - build/**
+linter:
+  rules:
+    file_names: false

examples/todos/packages/in_memory_todos_data_source/.gitignore

@@ -0,0 +1,7 @@
+# See https://www.dartlang.org/guides/libraries/private-files
+
+# Files and directories created by pub
+.dart_tool/
+.packages
+build/
+pubspec.lock

examples/todos/packages/in_memory_todos_data_source/README.md

@@ -0,0 +1,69 @@
+# In Memory Todos Data Source
+
+[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
+[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)
+[![License: MIT][license_badge]][license_link]
+
+An in-memory implementation of the TodosDataSource interface.
+
+## Installation 💻
+
+**❗ In order to start using In Memory Todos Data Source you must have the [Dart SDK][dart_install_link] installed on your machine.**
+
+Add `in_memory_todos_data_source` to your `pubspec.yaml`:
+
+```yaml
+dependencies:
+  in_memory_todos_data_source:
+```
+
+Install it:
+
+```sh
+dart pub get
+```
+
+---
+
+## Continuous Integration 🤖
+
+In Memory Todos Data Source comes with a built-in [GitHub Actions workflow][github_actions_link] powered by [Very Good Workflows][very_good_workflows_link] but you can also add your preferred CI/CD solution.
+
+Out of the box, on each pull request and push, the CI `formats`, `lints`, and `tests` the code. This ensures the code remains consistent and behaves correctly as you add functionality or make changes. The project uses [Very Good Analysis][very_good_analysis_link] for a strict set of analysis options used by our team. Code coverage is enforced using the [Very Good Workflows][very_good_coverage_link].
+
+---
+
+## Running Tests 🧪
+
+To run all unit tests:
+
+```sh
+dart pub global activate coverage 1.2.0
+dart test --coverage=coverage
+dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info
+```
+
+To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov).
+
+```sh
+# Generate Coverage Report
+genhtml coverage/lcov.info -o coverage/
+
+# Open Coverage Report
+open coverage/index.html
+```
+
+[dart_install_link]: https://dart.dev/get-dart
+[github_actions_link]: https://docs.github.com/en/actions/learn-github-actions
+[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
+[license_link]: https://opensource.org/licenses/MIT
+[logo_black]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_black.png#gh-light-mode-only
+[logo_white]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_white.png#gh-dark-mode-only
+[mason_link]: https://github.com/felangel/mason
+[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
+[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
+[very_good_coverage_link]: https://github.com/marketplace/actions/very-good-coverage
+[very_good_ventures_link]: https://verygood.ventures
+[very_good_ventures_link_light]: https://verygood.ventures#gh-light-mode-only
+[very_good_ventures_link_dark]: https://verygood.ventures#gh-dark-mode-only
+[very_good_workflows_link]: https://github.com/VeryGoodOpenSource/very_good_workflows

examples/todos/packages/in_memory_todos_data_source/analysis_options.yaml

@@ -0,0 +1 @@
+include: package:very_good_analysis/analysis_options.3.0.1.yaml

examples/todos/packages/in_memory_todos_data_source/coverage_badge.svg

@@ -0,0 +1,6 @@
+/// An in-memory implementation of the TodosDataSource interface.
+library in_memory_todos_data_source;
+
+export 'package:todos_data_source/todos_data_source.dart';
+
+export 'src/in_memory_todos_data_source.dart';

examples/todos/packages/in_memory_todos_data_source/lib/in_memory_todos_data_source.dart

@@ -0,0 +1,30 @@
+import 'package:todos_data_source/todos_data_source.dart';
+import 'package:uuid/uuid.dart';
+
+/// An in-memory implementation of the [TodosDataSource] interface.
+class InMemoryTodosDataSource implements TodosDataSource {
+  /// Map of ID -> Todo
+  final _cache = <String, Todo>{};
+
+  @override
+  Future<Todo> create(Todo todo) async {
+    final id = const Uuid().v4();
+    final createdTodo = todo.copyWith(id: id);
+    _cache[id] = createdTodo;
+    return createdTodo;
+  }
+
+  @override
+  Future<List<Todo>> readAll() async => _cache.values.toList();
+
+  @override
+  Future<Todo?> read(String id) async => _cache[id];
+
+  @override
+  Future<Todo> update(String id, Todo todo) async {
+    return _cache.update(id, (value) => todo);
+  }
+
+  @override
+  Future<void> delete(String id) async => _cache.remove(id);
+}