mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-24 05:25:19 +00:00
Compare commits
11 Commits
cherrypick
...
cherrypick
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0eec549b57 | ||
|
|
a3648209b9 | ||
|
|
c722ad0c07 | ||
|
|
8468eff5f7 | ||
|
|
24bb47f741 | ||
|
|
b5f6fff8d1 | ||
|
|
e7f20d8f63 | ||
|
|
e057bb487b | ||
|
|
2e7c9129bb | ||
|
|
292af4a4f3 | ||
|
|
5220ebc4b9 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -7,7 +7,7 @@
|
||||
.idea/
|
||||
.vscode/
|
||||
|
||||
|
||||
**/generated
|
||||
**/*.g.dart
|
||||
**/*.gr.dart
|
||||
**/*.freezed.dart
|
||||
|
||||
34
CHANGELOG.md
34
CHANGELOG.md
@@ -3,6 +3,40 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## 2025-07-15
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- [`cherrypick_generator` - `v1.1.0-dev.6`](#cherrypick_generator---v110-dev6)
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`cherrypick` - `v2.2.0-dev.2`](#cherrypick---v220-dev2)
|
||||
- [`cherrypick_flutter` - `v1.1.2-dev.2`](#cherrypick_flutter---v112-dev2)
|
||||
|
||||
Packages with dependency updates only:
|
||||
|
||||
> Packages listed below depend on other packages in this workspace that have had changes. Their versions have been incremented to bump the minimum dependency versions of the packages they depend upon in this project.
|
||||
|
||||
- `cherrypick_flutter` - `v1.1.2-dev.2`
|
||||
|
||||
---
|
||||
|
||||
#### `cherrypick_generator` - `v1.1.0-dev.6`
|
||||
|
||||
- **FIX**: format test code.
|
||||
- **FEAT**(generator): support output_dir and build_extensions config for generated files.
|
||||
- **BREAKING** **FEAT**(generator): complete code generation testing framework with 100% test coverage.
|
||||
|
||||
#### `cherrypick` - `v2.2.0-dev.2`
|
||||
|
||||
- **DOCS**: move and update quick start guides to ./doc directory.
|
||||
|
||||
|
||||
## 2025-06-04
|
||||
|
||||
### Changes
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
## 2.2.0-dev.2
|
||||
|
||||
- **DOCS**: move and update quick start guides to ./doc directory.
|
||||
|
||||
## 2.2.0-dev.1
|
||||
|
||||
- **FIX**: fix warnings.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
name: cherrypick
|
||||
description: Cherrypick is a small dependency injection (DI) library for dart/flutter projects.
|
||||
version: 2.2.0-dev.1
|
||||
version: 2.2.0-dev.2
|
||||
homepage: https://pese-git.github.io/cherrypick-site/
|
||||
documentation: https://github.com/pese-git/cherrypick/wiki
|
||||
repository: https://github.com/pese-git/cherrypick
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
## 1.1.2-dev.2
|
||||
|
||||
- Update a dependency to the latest release.
|
||||
|
||||
## 1.1.2-dev.1
|
||||
|
||||
- Update a dependency to the latest release.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
name: cherrypick_flutter
|
||||
description: "Flutter library that allows access to the root scope through the context using `CherryPickProvider`."
|
||||
version: 1.1.2-dev.1
|
||||
version: 1.1.2-dev.2
|
||||
homepage: https://pese-git.github.io/cherrypick-site/
|
||||
documentation: https://github.com/pese-git/cherrypick/wiki
|
||||
repository: https://github.com/pese-git/cherrypick
|
||||
@@ -13,7 +13,7 @@ environment:
|
||||
dependencies:
|
||||
flutter:
|
||||
sdk: flutter
|
||||
cherrypick: ^2.2.0-dev.1
|
||||
cherrypick: ^2.2.0-dev.2
|
||||
|
||||
dev_dependencies:
|
||||
flutter_test:
|
||||
|
||||
4
cherrypick_generator/.gitignore
vendored
4
cherrypick_generator/.gitignore
vendored
@@ -25,4 +25,6 @@ doc/api/
|
||||
|
||||
melos_cherrypick_generator.iml
|
||||
|
||||
**/*.mocks.dart
|
||||
**/*.mocks.dart
|
||||
|
||||
coverage
|
||||
@@ -1,3 +1,11 @@
|
||||
## 1.1.0-dev.6
|
||||
|
||||
> Note: This release has breaking changes.
|
||||
|
||||
- **FIX**: format test code.
|
||||
- **FEAT**(generator): support output_dir and build_extensions config for generated files.
|
||||
- **BREAKING** **FEAT**(generator): complete code generation testing framework with 100% test coverage.
|
||||
|
||||
## 1.1.0-dev.5
|
||||
|
||||
- **FEAT**: implement tryResolve via generate code.
|
||||
|
||||
@@ -4,6 +4,50 @@
|
||||
|
||||
---
|
||||
|
||||
### Advanced: Customizing Generated File Paths (`build_extensions`)
|
||||
|
||||
You can further control the filenames and subdirectory structure of generated files using the `build_extensions` option in `build.yaml`. This is especially useful in large apps for keeping DI artifacts organized under `lib/generated/` or any custom location.
|
||||
|
||||
**Example advanced build.yaml:**
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|inject_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/app.dart': ['lib/generated/app.inject.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
cherrypick_generator|module_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/di/{{}}.dart': ['lib/generated/di/{{}}.module.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
```
|
||||
|
||||
- **output_dir**: Path where all generated files are placed (e.g., `lib/generated`)
|
||||
- **build_extensions**: Allows templating of generated filenames and locations. You can use wildcards like `{{}}` to keep directory structure or group related files.
|
||||
|
||||
**If you use these options, be sure to update your imports accordingly, for example:**
|
||||
|
||||
```dart
|
||||
import 'package:your_package/generated/app.inject.cherrypick.g.dart';
|
||||
import 'package:your_package/generated/di/app_module.module.cherrypick.g.dart';
|
||||
```
|
||||
|
||||
### FAQ / Troubleshooting
|
||||
|
||||
- If files are missing or located in unexpected directories, double-check your `output_dir` and `build_extensions` configuration.
|
||||
- If you change generation paths, always update your imports in the codebase.
|
||||
- These options are backward compatible: omitting them preserves pre-existing (side-by-source) output behavior.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
- **Automatic Field Injection:**
|
||||
@@ -170,6 +214,26 @@ final class $MyModule extends MyModule {
|
||||
|
||||
## Advanced Usage
|
||||
|
||||
### Custom output directory for generated code (output_dir)
|
||||
|
||||
You can control the directory where the generated files (`*.inject.cherrypick.g.dart`, `*.module.cherrypick.g.dart`) are placed using the `output_dir` option in your `build.yaml`:
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|injectBuilder:
|
||||
options:
|
||||
output_dir: lib/generated
|
||||
cherrypick_generator|moduleBuilder:
|
||||
options:
|
||||
output_dir: lib/generated
|
||||
```
|
||||
|
||||
**If `output_dir` is omitted, generated files are placed next to the original sources (default behavior).**
|
||||
|
||||
After running code generation, you will find files like `lib/generated/app.inject.cherrypick.g.dart` and `lib/generated/your_module.module.cherrypick.g.dart`. You can import them as needed from that directory.
|
||||
|
||||
- **Combining Modules and Field Injection:**
|
||||
It's possible to mix both style of DI — modules for binding, and field injection for consuming services.
|
||||
- **Parameter and Named Injection:**
|
||||
|
||||
@@ -1,20 +1,18 @@
|
||||
builders:
|
||||
module_generator:
|
||||
import: "package:cherrypick_generator/module_generator.dart"
|
||||
builder_factories: ["moduleBuilder"]
|
||||
build_extensions: {".dart": [".cherrypick.g.dart"]}
|
||||
auto_apply: dependents
|
||||
required_inputs: ["lib/**"]
|
||||
runs_before: []
|
||||
build_to: source
|
||||
inject_generator:
|
||||
import: "package:cherrypick_generator/inject_generator.dart"
|
||||
builder_factories: ["injectBuilder"]
|
||||
build_extensions: {".dart": [".cherrypick.g.dart"]}
|
||||
build_extensions: {".dart": [".inject.cherrypick.g.dart"]}
|
||||
auto_apply: dependents
|
||||
required_inputs: ["lib/**"]
|
||||
runs_before: []
|
||||
build_to: source
|
||||
applies_builders: ["source_gen|combining_builder"]
|
||||
module_generator:
|
||||
import: "package:cherrypick_generator/module_generator.dart"
|
||||
builder_factories: ["moduleBuilder"]
|
||||
build_extensions: {".dart": [".module.cherrypick.g.dart"]}
|
||||
auto_apply: dependents
|
||||
build_to: source
|
||||
applies_builders: ["source_gen|combining_builder"]
|
||||
|
||||
targets:
|
||||
$default:
|
||||
@@ -24,4 +22,4 @@ targets:
|
||||
- lib/**.dart
|
||||
cherrypick_generator|inject_generator:
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
- lib/**.dart
|
||||
|
||||
137
cherrypick_generator/coverage_analysis.py
Normal file
137
cherrypick_generator/coverage_analysis.py
Normal file
@@ -0,0 +1,137 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Анализ покрытия тестами для CherryPick Generator
|
||||
"""
|
||||
|
||||
import re
|
||||
import os
|
||||
|
||||
def analyze_lcov_file(lcov_path):
|
||||
"""Анализирует LCOV файл и возвращает статистику покрытия"""
|
||||
|
||||
if not os.path.exists(lcov_path):
|
||||
print(f"❌ LCOV файл не найден: {lcov_path}")
|
||||
return
|
||||
|
||||
with open(lcov_path, 'r') as f:
|
||||
content = f.read()
|
||||
|
||||
# Разбиваем на секции по файлам
|
||||
file_sections = content.split('SF:')[1:] # Убираем первую пустую секцию
|
||||
|
||||
total_lines = 0
|
||||
total_hit = 0
|
||||
files_coverage = {}
|
||||
|
||||
for section in file_sections:
|
||||
lines = section.strip().split('\n')
|
||||
if not lines:
|
||||
continue
|
||||
|
||||
file_path = lines[0]
|
||||
file_name = os.path.basename(file_path)
|
||||
|
||||
# Подсчитываем строки
|
||||
da_lines = [line for line in lines if line.startswith('DA:')]
|
||||
|
||||
file_total = len(da_lines)
|
||||
file_hit = 0
|
||||
|
||||
for da_line in da_lines:
|
||||
# DA:line_number,hit_count
|
||||
parts = da_line.split(',')
|
||||
if len(parts) >= 2:
|
||||
hit_count = int(parts[1])
|
||||
if hit_count > 0:
|
||||
file_hit += 1
|
||||
|
||||
if file_total > 0:
|
||||
coverage_percent = (file_hit / file_total) * 100
|
||||
files_coverage[file_name] = {
|
||||
'total': file_total,
|
||||
'hit': file_hit,
|
||||
'percent': coverage_percent
|
||||
}
|
||||
|
||||
total_lines += file_total
|
||||
total_hit += file_hit
|
||||
|
||||
# Общая статистика
|
||||
overall_percent = (total_hit / total_lines) * 100 if total_lines > 0 else 0
|
||||
|
||||
print("📊 АНАЛИЗ ПОКРЫТИЯ ТЕСТАМИ CHERRYPICK GENERATOR")
|
||||
print("=" * 60)
|
||||
|
||||
print(f"\n🎯 ОБЩАЯ СТАТИСТИКА:")
|
||||
print(f" Всего строк кода: {total_lines}")
|
||||
print(f" Покрыто тестами: {total_hit}")
|
||||
print(f" Общее покрытие: {overall_percent:.1f}%")
|
||||
|
||||
print(f"\n📁 ПОКРЫТИЕ ПО ФАЙЛАМ:")
|
||||
|
||||
# Сортируем по проценту покрытия
|
||||
sorted_files = sorted(files_coverage.items(), key=lambda x: x[1]['percent'], reverse=True)
|
||||
|
||||
for file_name, stats in sorted_files:
|
||||
percent = stats['percent']
|
||||
hit = stats['hit']
|
||||
total = stats['total']
|
||||
|
||||
# Эмодзи в зависимости от покрытия
|
||||
if percent >= 80:
|
||||
emoji = "✅"
|
||||
elif percent >= 50:
|
||||
emoji = "🟡"
|
||||
else:
|
||||
emoji = "❌"
|
||||
|
||||
print(f" {emoji} {file_name:<25} {hit:>3}/{total:<3} ({percent:>5.1f}%)")
|
||||
|
||||
print(f"\n🏆 РЕЙТИНГ КОМПОНЕНТОВ:")
|
||||
|
||||
# Группируем по типам компонентов
|
||||
core_files = ['bind_spec.dart', 'bind_parameters_spec.dart', 'generated_class.dart']
|
||||
utils_files = ['metadata_utils.dart']
|
||||
generator_files = ['module_generator.dart', 'inject_generator.dart']
|
||||
|
||||
def calculate_group_coverage(file_list):
|
||||
group_total = sum(files_coverage.get(f, {}).get('total', 0) for f in file_list)
|
||||
group_hit = sum(files_coverage.get(f, {}).get('hit', 0) for f in file_list)
|
||||
return (group_hit / group_total * 100) if group_total > 0 else 0
|
||||
|
||||
core_coverage = calculate_group_coverage(core_files)
|
||||
utils_coverage = calculate_group_coverage(utils_files)
|
||||
generators_coverage = calculate_group_coverage(generator_files)
|
||||
|
||||
print(f" 🔧 Core Components: {core_coverage:>5.1f}%")
|
||||
print(f" 🛠️ Utils: {utils_coverage:>5.1f}%")
|
||||
print(f" ⚙️ Generators: {generators_coverage:>5.1f}%")
|
||||
|
||||
print(f"\n📈 РЕКОМЕНДАЦИИ:")
|
||||
|
||||
# Файлы с низким покрытием
|
||||
low_coverage = [(f, s) for f, s in files_coverage.items() if s['percent'] < 50]
|
||||
if low_coverage:
|
||||
print(" 🎯 Приоритет для улучшения:")
|
||||
for file_name, stats in sorted(low_coverage, key=lambda x: x[1]['percent']):
|
||||
print(f" • {file_name} ({stats['percent']:.1f}%)")
|
||||
|
||||
# Файлы без покрытия
|
||||
zero_coverage = [(f, s) for f, s in files_coverage.items() if s['percent'] == 0]
|
||||
if zero_coverage:
|
||||
print(" ❗ Требуют срочного внимания:")
|
||||
for file_name, stats in zero_coverage:
|
||||
print(f" • {file_name} (0% покрытия)")
|
||||
|
||||
print(f"\n✨ ДОСТИЖЕНИЯ:")
|
||||
high_coverage = [(f, s) for f, s in files_coverage.items() if s['percent'] >= 80]
|
||||
if high_coverage:
|
||||
print(" 🏅 Отлично протестированы:")
|
||||
for file_name, stats in sorted(high_coverage, key=lambda x: x[1]['percent'], reverse=True):
|
||||
print(f" • {file_name} ({stats['percent']:.1f}%)")
|
||||
|
||||
return files_coverage, overall_percent
|
||||
|
||||
if __name__ == "__main__":
|
||||
lcov_path = "coverage/lcov.info"
|
||||
analyze_lcov_file(lcov_path)
|
||||
76
cherrypick_generator/lib/cherrypick_custom_builders.dart
Normal file
76
cherrypick_generator/lib/cherrypick_custom_builders.dart
Normal file
@@ -0,0 +1,76 @@
|
||||
import 'dart:async';
|
||||
import 'package:build/build.dart';
|
||||
import 'package:path/path.dart' as p;
|
||||
import 'package:source_gen/source_gen.dart';
|
||||
import 'inject_generator.dart';
|
||||
import 'module_generator.dart';
|
||||
|
||||
/// Универсальный Builder для генераторов Cherrypick с поддержкой кастомного output_dir
|
||||
/// (указывает директорию для складывания сгенерированных файлов через build.yaml)
|
||||
class CustomOutputBuilder extends Builder {
|
||||
final Generator generator;
|
||||
final String extension;
|
||||
final String outputDir;
|
||||
final Map<String, List<String>> customBuildExtensions;
|
||||
|
||||
CustomOutputBuilder(this.generator, this.extension, this.outputDir, this.customBuildExtensions);
|
||||
|
||||
@override
|
||||
Map<String, List<String>> get buildExtensions {
|
||||
if (customBuildExtensions.isNotEmpty) {
|
||||
return customBuildExtensions;
|
||||
}
|
||||
// Дефолт: рядом с исходником, как PartBuilder
|
||||
return {
|
||||
'.dart': [extension],
|
||||
};
|
||||
}
|
||||
|
||||
@override
|
||||
Future<void> build(BuildStep buildStep) async {
|
||||
final inputId = buildStep.inputId;
|
||||
print('[CustomOutputBuilder] build() called for input: \\${inputId.path}');
|
||||
final library = await buildStep.resolver.libraryFor(inputId);
|
||||
print('[CustomOutputBuilder] resolved library for: \\${inputId.path}');
|
||||
final generated = await generator.generate(LibraryReader(library), buildStep);
|
||||
print('[CustomOutputBuilder] gen result for input: \\${inputId.path}, isNull: \\${generated == null}, isEmpty: \\${generated?.isEmpty}');
|
||||
if (generated == null || generated.isEmpty) return;
|
||||
String outputPath;
|
||||
if (customBuildExtensions.isNotEmpty) {
|
||||
// Кастомная директория/шаблон
|
||||
final inputPath = inputId.path;
|
||||
final relativeInput = p.relative(inputPath, from: 'lib/');
|
||||
final parts = p.split(relativeInput);
|
||||
String subdir = '';
|
||||
String baseName = parts.last.replaceAll('.dart', '');
|
||||
if (parts.length > 1) {
|
||||
subdir = parts.first; // Например, 'di'
|
||||
}
|
||||
outputPath = subdir.isEmpty
|
||||
? p.join('lib', 'generated', '$baseName$extension')
|
||||
: p.join('lib', 'generated', subdir, '$baseName$extension');
|
||||
} else {
|
||||
// Дефолт: рядом с исходником
|
||||
outputPath = p.setExtension(inputId.path, extension);
|
||||
}
|
||||
final outputId = AssetId(inputId.package, outputPath);
|
||||
// part of - всегда авто!
|
||||
final partOfPath = p.relative(inputId.path, from: p.dirname(outputPath));
|
||||
final codeWithPartOf = "part of '$partOfPath';\n\n$generated";
|
||||
print('[CustomOutputBuilder] writing to output: \\${outputId.path}');
|
||||
await buildStep.writeAsString(outputId, codeWithPartOf);
|
||||
print('[CustomOutputBuilder] successfully written for input: \\${inputId.path}');
|
||||
}
|
||||
}
|
||||
|
||||
Builder injectCustomBuilder(BuilderOptions options) {
|
||||
final outputDir = options.config['output_dir'] as String? ?? '';
|
||||
final buildExtensions = (options.config['build_extensions'] as Map?)?.map((k,v)=>MapEntry(k.toString(), (v as List).map((item)=>item.toString()).toList())) ?? {};
|
||||
return CustomOutputBuilder(InjectGenerator(), '.inject.cherrypick.g.dart', outputDir, buildExtensions);
|
||||
}
|
||||
|
||||
Builder moduleCustomBuilder(BuilderOptions options) {
|
||||
final outputDir = options.config['output_dir'] as String? ?? '';
|
||||
final buildExtensions = (options.config['build_extensions'] as Map?)?.map((k,v)=>MapEntry(k.toString(), (v as List).map((item)=>item.toString()).toList())) ?? {};
|
||||
return CustomOutputBuilder(ModuleGenerator(), '.module.cherrypick.g.dart', outputDir, buildExtensions);
|
||||
}
|
||||
@@ -19,6 +19,7 @@ import 'package:build/build.dart';
|
||||
import 'package:source_gen/source_gen.dart';
|
||||
import 'package:analyzer/dart/element/element.dart';
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart' as ann;
|
||||
import 'cherrypick_custom_builders.dart' as custom;
|
||||
|
||||
/// InjectGenerator generates a mixin for a class marked with @injectable()
|
||||
/// and injects all fields annotated with @inject(), using CherryPick DI.
|
||||
@@ -204,4 +205,4 @@ class _ParsedInjectField {
|
||||
///
|
||||
/// Фабрика билдера. Используется build_runner.
|
||||
Builder injectBuilder(BuilderOptions options) =>
|
||||
PartBuilder([InjectGenerator()], '.inject.cherrypick.g.dart');
|
||||
custom.injectCustomBuilder(options);
|
||||
|
||||
@@ -15,9 +15,8 @@ import 'package:analyzer/dart/element/element.dart';
|
||||
import 'package:build/build.dart';
|
||||
import 'package:source_gen/source_gen.dart';
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart' as ann;
|
||||
|
||||
import 'src/generated_class.dart';
|
||||
|
||||
import 'cherrypick_custom_builders.dart' as custom;
|
||||
/// ---------------------------------------------------------------------------
|
||||
/// ModuleGenerator for code generation of dependency-injected modules.
|
||||
///
|
||||
@@ -89,5 +88,8 @@ class ModuleGenerator extends GeneratorForAnnotation<ann.module> {
|
||||
/// Возвращает Builder, используемый build_runner для генерации кода для всех
|
||||
/// файлов, где встречается @module().
|
||||
/// ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
|
||||
Builder moduleBuilder(BuilderOptions options) =>
|
||||
PartBuilder([ModuleGenerator()], '.module.cherrypick.g.dart');
|
||||
custom.moduleCustomBuilder(options);
|
||||
@@ -2,7 +2,7 @@ name: cherrypick_generator
|
||||
description: |
|
||||
Source code generator for the cherrypick dependency injection system. Processes annotations to generate binding and module code for Dart & Flutter projects.
|
||||
|
||||
version: 1.1.0-dev.5
|
||||
version: 1.1.0-dev.6
|
||||
documentation: https://github.com/pese-git/cherrypick/wiki
|
||||
repository: https://github.com/pese-git/cherrypick/cherrypick_generator
|
||||
issue_tracker: https://github.com/pese-git/cherrypick/issues
|
||||
@@ -14,13 +14,15 @@ environment:
|
||||
dependencies:
|
||||
cherrypick_annotations: ^1.1.0-dev.1
|
||||
analyzer: ^7.0.0
|
||||
dart_style: ^3.0.1
|
||||
dart_style: ^3.0.0
|
||||
build: ^2.4.1
|
||||
build_runner: ^2.4.15
|
||||
source_gen: ^2.0.0
|
||||
collection: ^1.18.0
|
||||
path: ^1.9.1
|
||||
|
||||
dev_dependencies:
|
||||
lints: ^5.0.0
|
||||
lints: ^4.0.0
|
||||
mockito: ^5.4.4
|
||||
test: ^1.25.8
|
||||
build_test: ^2.1.7
|
||||
build_runner: ^2.4.13
|
||||
|
||||
304
cherrypick_generator/test/bind_spec_test.dart
Normal file
304
cherrypick_generator/test/bind_spec_test.dart
Normal file
@@ -0,0 +1,304 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:cherrypick_generator/src/bind_spec.dart';
|
||||
import 'package:test/test.dart';
|
||||
|
||||
void main() {
|
||||
group('BindSpec Tests', () {
|
||||
group('BindSpec Creation', () {
|
||||
test('should create BindSpec with all properties', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'ApiClient',
|
||||
methodName: 'createApiClient',
|
||||
isSingleton: true,
|
||||
named: 'mainApi',
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: true,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
expect(bindSpec.returnType, equals('ApiClient'));
|
||||
expect(bindSpec.methodName, equals('createApiClient'));
|
||||
expect(bindSpec.isSingleton, isTrue);
|
||||
expect(bindSpec.named, equals('mainApi'));
|
||||
expect(bindSpec.parameters, isEmpty);
|
||||
expect(bindSpec.bindingType, equals(BindingType.provide));
|
||||
expect(bindSpec.isAsyncInstance, isFalse);
|
||||
expect(bindSpec.isAsyncProvide, isTrue);
|
||||
expect(bindSpec.hasParams, isFalse);
|
||||
});
|
||||
|
||||
test('should create BindSpec with minimal properties', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
expect(bindSpec.returnType, equals('String'));
|
||||
expect(bindSpec.methodName, equals('getString'));
|
||||
expect(bindSpec.isSingleton, isFalse);
|
||||
expect(bindSpec.named, isNull);
|
||||
expect(bindSpec.bindingType, equals(BindingType.instance));
|
||||
});
|
||||
});
|
||||
|
||||
group('Bind Generation - Instance', () {
|
||||
test('should generate simple instance bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, equals(' bind<String>().toInstance(getString());'));
|
||||
});
|
||||
|
||||
test('should generate singleton instance bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: true,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result,
|
||||
equals(' bind<String>().toInstance(getString()).singleton();'));
|
||||
});
|
||||
|
||||
test('should generate named instance bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
named: 'testString',
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result,
|
||||
equals(
|
||||
" bind<String>().toInstance(getString()).withName('testString');"));
|
||||
});
|
||||
|
||||
test('should generate named singleton instance bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: true,
|
||||
named: 'testString',
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result,
|
||||
equals(
|
||||
" bind<String>().toInstance(getString()).withName('testString').singleton();"));
|
||||
});
|
||||
|
||||
test('should generate async instance bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: true,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result, equals(' bind<String>().toInstanceAsync(getString());'));
|
||||
});
|
||||
});
|
||||
|
||||
group('Bind Generation - Provide', () {
|
||||
test('should generate simple provide bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result, equals(' bind<String>().toProvide(() => getString());'));
|
||||
});
|
||||
|
||||
test('should generate async provide bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: true,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result,
|
||||
equals(' bind<String>().toProvideAsync(() => getString());'));
|
||||
});
|
||||
|
||||
test('should generate provide bind with params', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: true,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result,
|
||||
equals(
|
||||
' bind<String>().toProvideWithParams((args) => getString());'));
|
||||
});
|
||||
|
||||
test('should generate async provide bind with params', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: true,
|
||||
hasParams: true,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result,
|
||||
equals(
|
||||
' bind<String>().toProvideAsyncWithParams((args) => getString());'));
|
||||
});
|
||||
});
|
||||
|
||||
group('Complex Scenarios', () {
|
||||
test('should generate bind with all options', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'ApiClient',
|
||||
methodName: 'createApiClient',
|
||||
isSingleton: true,
|
||||
named: 'mainApi',
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: true,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result,
|
||||
equals(
|
||||
" bind<ApiClient>().toProvideAsync(() => createApiClient()).withName('mainApi').singleton();"));
|
||||
});
|
||||
|
||||
test('should handle different indentation', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result2 = bindSpec.generateBind(2);
|
||||
expect(result2, startsWith(' '));
|
||||
|
||||
final result8 = bindSpec.generateBind(8);
|
||||
expect(result8, startsWith(' '));
|
||||
});
|
||||
|
||||
test('should handle complex type names', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'Map<String, List<User>>',
|
||||
methodName: 'getComplexData',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('bind<Map<String, List<User>>>()'));
|
||||
expect(result, contains('toProvide'));
|
||||
expect(result, contains('getComplexData'));
|
||||
});
|
||||
});
|
||||
|
||||
group('BindingType Enum', () {
|
||||
test('should have correct enum values', () {
|
||||
expect(BindingType.instance, isNotNull);
|
||||
expect(BindingType.provide, isNotNull);
|
||||
expect(BindingType.values, hasLength(2));
|
||||
expect(BindingType.values, contains(BindingType.instance));
|
||||
expect(BindingType.values, contains(BindingType.provide));
|
||||
});
|
||||
|
||||
test('should have correct string representation', () {
|
||||
expect(BindingType.instance.toString(), contains('instance'));
|
||||
expect(BindingType.provide.toString(), contains('provide'));
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
@@ -1,13 +1,32 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:test/test.dart';
|
||||
|
||||
void main() {
|
||||
group('A group of tests', () {
|
||||
setUp(() {
|
||||
// Additional setup goes here.
|
||||
});
|
||||
// Import working test suites
|
||||
import 'simple_test.dart' as simple_tests;
|
||||
import 'bind_spec_test.dart' as bind_spec_tests;
|
||||
import 'metadata_utils_test.dart' as metadata_utils_tests;
|
||||
// Import integration test suites (now working!)
|
||||
import 'module_generator_test.dart' as module_generator_tests;
|
||||
import 'inject_generator_test.dart' as inject_generator_tests;
|
||||
|
||||
test('First Test', () {
|
||||
expect(2, 2);
|
||||
});
|
||||
void main() {
|
||||
group('CherryPick Generator Tests', () {
|
||||
group('Simple Tests', simple_tests.main);
|
||||
group('BindSpec Tests', bind_spec_tests.main);
|
||||
group('MetadataUtils Tests', metadata_utils_tests.main);
|
||||
group('ModuleGenerator Tests', module_generator_tests.main);
|
||||
group('InjectGenerator Tests', inject_generator_tests.main);
|
||||
});
|
||||
}
|
||||
|
||||
604
cherrypick_generator/test/inject_generator_test.dart
Normal file
604
cherrypick_generator/test/inject_generator_test.dart
Normal file
@@ -0,0 +1,604 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:build/build.dart';
|
||||
import 'package:build_test/build_test.dart';
|
||||
import 'package:cherrypick_generator/inject_generator.dart';
|
||||
import 'package:source_gen/source_gen.dart';
|
||||
import 'package:test/test.dart';
|
||||
|
||||
void main() {
|
||||
group('InjectGenerator Tests', () {
|
||||
setUp(() {
|
||||
// InjectGenerator setup if needed
|
||||
});
|
||||
|
||||
group('Basic Injection', () {
|
||||
test('should generate mixin for simple injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
late final MyService service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().resolve<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate mixin for nullable injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
late final MyService? service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().tryResolve<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Named Injection', () {
|
||||
test('should generate mixin for named injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@named('myService')
|
||||
late final MyService service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().resolve<MyService>(
|
||||
named: 'myService',
|
||||
);
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate mixin for named nullable injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@named('myService')
|
||||
late final MyService? service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().tryResolve<MyService>(
|
||||
named: 'myService',
|
||||
);
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Scoped Injection', () {
|
||||
test('should generate mixin for scoped injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@scope('userScope')
|
||||
late final MyService service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openScope(
|
||||
scopeName: 'userScope',
|
||||
).resolve<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate mixin for scoped named injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@scope('userScope')
|
||||
@named('myService')
|
||||
late final MyService service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openScope(
|
||||
scopeName: 'userScope',
|
||||
).resolve<MyService>(named: 'myService');
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Async Injection', () {
|
||||
test('should generate mixin for Future injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
late final Future<MyService> service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().resolveAsync<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate mixin for nullable Future injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
late final Future<MyService?> service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().tryResolveAsync<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate mixin for named Future injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@named('myService')
|
||||
late final Future<MyService> service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().resolveAsync<MyService>(
|
||||
named: 'myService',
|
||||
);
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Multiple Fields', () {
|
||||
test('should generate mixin for multiple injected fields', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class ApiService {}
|
||||
class DatabaseService {}
|
||||
class CacheService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
late final ApiService apiService;
|
||||
|
||||
@inject()
|
||||
@named('cache')
|
||||
late final CacheService? cacheService;
|
||||
|
||||
@inject()
|
||||
@scope('dbScope')
|
||||
late final Future<DatabaseService> dbService;
|
||||
|
||||
// Non-injected field should be ignored
|
||||
String nonInjectedField = "test";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.apiService = CherryPick.openRootScope().resolve<ApiService>();
|
||||
instance.cacheService = CherryPick.openRootScope().tryResolve<CacheService>(
|
||||
named: 'cache',
|
||||
);
|
||||
instance.dbService = CherryPick.openScope(
|
||||
scopeName: 'dbScope',
|
||||
).resolveAsync<DatabaseService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Complex Types', () {
|
||||
test('should handle generic types', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
late final List<String> stringList;
|
||||
|
||||
@inject()
|
||||
late final Map<String, int> stringIntMap;
|
||||
|
||||
@inject()
|
||||
late final Future<List<String>> futureStringList;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.stringList = CherryPick.openRootScope().resolve<List<String>>();
|
||||
instance.stringIntMap = CherryPick.openRootScope()
|
||||
.resolve<Map<String, int>>();
|
||||
instance.futureStringList = CherryPick.openRootScope()
|
||||
.resolveAsync<List<String>>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Error Cases', () {
|
||||
test('should throw error for non-class element', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
@injectable()
|
||||
void notAClass() {}
|
||||
''';
|
||||
|
||||
await expectLater(
|
||||
() => _testGeneration(input, ''),
|
||||
throwsA(isA<InvalidGenerationSourceError>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should generate empty mixin for class without @inject fields',
|
||||
() async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
String normalField = "test";
|
||||
int anotherField = 42;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Edge Cases', () {
|
||||
test('should handle empty scope name', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@scope('')
|
||||
late final MyService service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().resolve<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should handle empty named value', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@named('')
|
||||
late final MyService service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().resolve<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/// Helper function to test code generation
|
||||
Future<void> _testGeneration(String input, String expectedOutput) async {
|
||||
await testBuilder(
|
||||
injectBuilder(BuilderOptions.empty),
|
||||
{
|
||||
'a|lib/test_widget.dart': input,
|
||||
},
|
||||
outputs: {
|
||||
'a|lib/test_widget.inject.cherrypick.g.dart': expectedOutput,
|
||||
},
|
||||
reader: await PackageAssetReader.currentIsolate(),
|
||||
);
|
||||
}
|
||||
72
cherrypick_generator/test/metadata_utils_test.dart
Normal file
72
cherrypick_generator/test/metadata_utils_test.dart
Normal file
@@ -0,0 +1,72 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:cherrypick_generator/src/metadata_utils.dart';
|
||||
import 'package:test/test.dart';
|
||||
|
||||
void main() {
|
||||
group('MetadataUtils Tests', () {
|
||||
group('Basic Functionality', () {
|
||||
test('should handle empty metadata lists', () {
|
||||
expect(MetadataUtils.anyMeta([], 'singleton'), isFalse);
|
||||
expect(MetadataUtils.getNamedValue([]), isNull);
|
||||
});
|
||||
|
||||
test('should be available for testing', () {
|
||||
// This test ensures the MetadataUtils class is accessible
|
||||
// More comprehensive tests would require mock setup or integration tests
|
||||
expect(MetadataUtils, isNotNull);
|
||||
});
|
||||
|
||||
test('should handle null inputs gracefully', () {
|
||||
expect(MetadataUtils.anyMeta([], ''), isFalse);
|
||||
expect(MetadataUtils.getNamedValue([]), isNull);
|
||||
});
|
||||
|
||||
test('should have static methods available', () {
|
||||
// Verify that the static methods exist and can be called
|
||||
// This is a basic smoke test
|
||||
expect(() => MetadataUtils.anyMeta([], 'test'), returnsNormally);
|
||||
expect(() => MetadataUtils.getNamedValue([]), returnsNormally);
|
||||
});
|
||||
});
|
||||
|
||||
group('Method Signatures', () {
|
||||
test('anyMeta should return bool', () {
|
||||
final result = MetadataUtils.anyMeta([], 'singleton');
|
||||
expect(result, isA<bool>());
|
||||
});
|
||||
|
||||
test('getNamedValue should return String or null', () {
|
||||
final result = MetadataUtils.getNamedValue([]);
|
||||
expect(result, anyOf(isA<String>(), isNull));
|
||||
});
|
||||
});
|
||||
|
||||
group('Edge Cases', () {
|
||||
test('should handle various annotation names', () {
|
||||
// Test with different annotation names
|
||||
expect(MetadataUtils.anyMeta([], 'singleton'), isFalse);
|
||||
expect(MetadataUtils.anyMeta([], 'provide'), isFalse);
|
||||
expect(MetadataUtils.anyMeta([], 'instance'), isFalse);
|
||||
expect(MetadataUtils.anyMeta([], 'named'), isFalse);
|
||||
expect(MetadataUtils.anyMeta([], 'params'), isFalse);
|
||||
});
|
||||
|
||||
test('should handle empty strings', () {
|
||||
expect(MetadataUtils.anyMeta([], ''), isFalse);
|
||||
expect(MetadataUtils.getNamedValue([]), isNull);
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
648
cherrypick_generator/test/module_generator_test.dart
Normal file
648
cherrypick_generator/test/module_generator_test.dart
Normal file
@@ -0,0 +1,648 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:test/test.dart';
|
||||
import 'package:build_test/build_test.dart';
|
||||
import 'package:build/build.dart';
|
||||
|
||||
import 'package:cherrypick_generator/module_generator.dart';
|
||||
import 'package:source_gen/source_gen.dart';
|
||||
|
||||
void main() {
|
||||
group('ModuleGenerator Tests', () {
|
||||
setUp(() {
|
||||
// ModuleGenerator setup if needed
|
||||
});
|
||||
|
||||
group('Simple Module Generation', () {
|
||||
test('should generate basic module with instance binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@instance()
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toInstance(testString());
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate basic module with provide binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toProvide(() => testString());
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Singleton Bindings', () {
|
||||
test('should generate singleton instance binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@instance()
|
||||
@singleton()
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toInstance(testString()).singleton();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate singleton provide binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
@singleton()
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toProvide(() => testString()).singleton();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Named Bindings', () {
|
||||
test('should generate named instance binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@instance()
|
||||
@named('testName')
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toInstance(testString()).withName('testName');
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate named singleton binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
@singleton()
|
||||
@named('testName')
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>()
|
||||
.toProvide(() => testString())
|
||||
.withName('testName')
|
||||
.singleton();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Async Bindings', () {
|
||||
test('should generate async instance binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@instance()
|
||||
Future<String> testString() async => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toInstanceAsync(testString());
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate async provide binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
Future<String> testString() async => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toProvideAsync(() => testString());
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate async binding with params', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
Future<String> testString(@params() dynamic params) async => "Hello \$params";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toProvideAsyncWithParams((args) => testString(args));
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Dependencies Injection', () {
|
||||
test('should generate binding with injected dependencies', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
class ApiClient {}
|
||||
class Repository {}
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
Repository repository(ApiClient client) => Repository();
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<Repository>().toProvide(
|
||||
() => repository(currentScope.resolve<ApiClient>()),
|
||||
);
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate binding with named dependencies', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
class ApiClient {}
|
||||
class Repository {}
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
Repository repository(@named('api') ApiClient client) => Repository();
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<Repository>().toProvide(
|
||||
() => repository(currentScope.resolve<ApiClient>(named: 'api')),
|
||||
);
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Runtime Parameters', () {
|
||||
test('should generate binding with params', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
String testString(@params() dynamic params) => "Hello \$params";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toProvideWithParams((args) => testString(args));
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate async binding with params', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
Future<String> testString(@params() dynamic params) async => "Hello \$params";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toProvideAsyncWithParams((args) => testString(args));
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Complex Scenarios', () {
|
||||
test('should generate module with multiple bindings', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
class ApiClient {}
|
||||
class Repository {}
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@instance()
|
||||
@singleton()
|
||||
@named('baseUrl')
|
||||
String baseUrl() => "https://api.example.com";
|
||||
|
||||
@provide()
|
||||
@singleton()
|
||||
ApiClient apiClient(@named('baseUrl') String url) => ApiClient();
|
||||
|
||||
@provide()
|
||||
Repository repository(ApiClient client) => Repository();
|
||||
|
||||
@provide()
|
||||
@named('greeting')
|
||||
String greeting(@params() dynamic name) => "Hello \$name";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toInstance(baseUrl()).withName('baseUrl').singleton();
|
||||
bind<ApiClient>()
|
||||
.toProvide(
|
||||
() => apiClient(currentScope.resolve<String>(named: 'baseUrl')),
|
||||
)
|
||||
.singleton();
|
||||
bind<Repository>().toProvide(
|
||||
() => repository(currentScope.resolve<ApiClient>()),
|
||||
);
|
||||
bind<String>()
|
||||
.toProvideWithParams((args) => greeting(args))
|
||||
.withName('greeting');
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Error Cases', () {
|
||||
test('should throw error for non-class element', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
void notAClass() {}
|
||||
''';
|
||||
|
||||
await expectLater(
|
||||
() => _testGeneration(input, ''),
|
||||
throwsA(isA<InvalidGenerationSourceError>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should throw error for method without @instance or @provide',
|
||||
() async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
await expectLater(
|
||||
() => _testGeneration(input, ''),
|
||||
throwsA(isA<InvalidGenerationSourceError>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should throw error for @params with @instance', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@instance()
|
||||
String testString(@params() dynamic params) => "Hello \$params";
|
||||
}
|
||||
''';
|
||||
|
||||
await expectLater(
|
||||
() => _testGeneration(input, ''),
|
||||
throwsA(isA<InvalidGenerationSourceError>()),
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/// Helper function to test code generation
|
||||
Future<void> _testGeneration(String input, String expectedOutput) async {
|
||||
await testBuilder(
|
||||
moduleBuilder(BuilderOptions.empty),
|
||||
{
|
||||
'a|lib/test_module.dart': input,
|
||||
},
|
||||
outputs: {
|
||||
'a|lib/test_module.module.cherrypick.g.dart': expectedOutput,
|
||||
},
|
||||
reader: await PackageAssetReader.currentIsolate(),
|
||||
);
|
||||
}
|
||||
176
cherrypick_generator/test/simple_test.dart
Normal file
176
cherrypick_generator/test/simple_test.dart
Normal file
@@ -0,0 +1,176 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:cherrypick_generator/src/bind_spec.dart';
|
||||
import 'package:test/test.dart';
|
||||
|
||||
void main() {
|
||||
group('Simple Generator Tests', () {
|
||||
group('BindSpec', () {
|
||||
test('should create BindSpec with correct properties', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
expect(bindSpec.returnType, equals('String'));
|
||||
expect(bindSpec.methodName, equals('getString'));
|
||||
expect(bindSpec.isSingleton, isFalse);
|
||||
expect(bindSpec.bindingType, equals(BindingType.instance));
|
||||
});
|
||||
|
||||
test('should generate basic bind code', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('bind<String>()'));
|
||||
expect(result, contains('toInstance'));
|
||||
expect(result, contains('getString'));
|
||||
});
|
||||
|
||||
test('should generate singleton bind code', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: true,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('singleton()'));
|
||||
});
|
||||
|
||||
test('should generate named bind code', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
named: 'testName',
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains("withName('testName')"));
|
||||
});
|
||||
|
||||
test('should generate provide bind code', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('toProvide'));
|
||||
expect(result, contains('() => getString'));
|
||||
});
|
||||
|
||||
test('should generate async provide bind code', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: true,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('toProvideAsync'));
|
||||
});
|
||||
|
||||
test('should generate params bind code', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: true,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('toProvideWithParams'));
|
||||
expect(result, contains('(args) => getString()'));
|
||||
});
|
||||
|
||||
test('should generate complex bind with all options', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'ApiClient',
|
||||
methodName: 'createApiClient',
|
||||
isSingleton: true,
|
||||
named: 'mainApi',
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: true,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('bind<ApiClient>()'));
|
||||
expect(result, contains('toProvideAsync'));
|
||||
expect(result, contains("withName('mainApi')"));
|
||||
expect(result, contains('singleton()'));
|
||||
});
|
||||
});
|
||||
|
||||
group('BindingType Enum', () {
|
||||
test('should have correct values', () {
|
||||
expect(BindingType.instance, isNotNull);
|
||||
expect(BindingType.provide, isNotNull);
|
||||
expect(BindingType.values.length, equals(2));
|
||||
});
|
||||
});
|
||||
|
||||
group('Generator Classes', () {
|
||||
test('should be able to import generators', () {
|
||||
// Test that we can import the generator classes
|
||||
expect(BindSpec, isNotNull);
|
||||
expect(BindingType, isNotNull);
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
140
doc/annotations_en.md
Normal file
140
doc/annotations_en.md
Normal file
@@ -0,0 +1,140 @@
|
||||
# DI Code Generation with Annotations (CherryPick)
|
||||
|
||||
CherryPick enables smart, fully-automated dependency injection (DI) for Dart/Flutter via annotations and code generation.
|
||||
This eliminates boilerplate and guarantees correctness—just annotate, run the generator, and use!
|
||||
|
||||
---
|
||||
|
||||
## 1. How does it work?
|
||||
|
||||
You annotate classes, fields, and modules using [cherrypick_annotations].
|
||||
The [cherrypick_generator] processes these, generating code that registers your dependencies and wires up fields or modules.
|
||||
|
||||
You then run:
|
||||
```sh
|
||||
dart run build_runner build --delete-conflicting-outputs
|
||||
```
|
||||
— and use the generated files in your app.
|
||||
|
||||
---
|
||||
|
||||
## 2. Supported Annotations
|
||||
|
||||
| Annotation | Where | Purpose |
|
||||
|-------------------|-----------------|----------------------------------------------------------|
|
||||
| `@injectable()` | class | Enables auto field injection; mixin will be generated |
|
||||
| `@inject()` | field | Field will be injected automatically |
|
||||
| `@scope()` | field/param | Use a named scope when resolving this dep |
|
||||
| `@named()` | field/param | Bind/resolve a named interface implementation |
|
||||
| `@module()` | class | Marks as a DI module (methods = providers) |
|
||||
| `@provide` | method | Registers a type via this provider method |
|
||||
| `@instance` | method | Registers a direct instance (like singleton/factory) |
|
||||
| `@singleton` | method/class | The target is a singleton |
|
||||
| `@params` | param | Accepts runtime/constructor params for providers |
|
||||
|
||||
**You can combine annotations as needed for advanced use-cases.**
|
||||
|
||||
---
|
||||
|
||||
## 3. Practical Examples
|
||||
|
||||
### A. Field Injection (recommended for widgets/classes)
|
||||
|
||||
```dart
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
@injectable()
|
||||
class MyWidget with _$MyWidget { // the generated mixin
|
||||
@inject()
|
||||
late final AuthService auth;
|
||||
|
||||
@inject()
|
||||
@scope('profile')
|
||||
late final ProfileManager profile;
|
||||
|
||||
@inject()
|
||||
@named('special')
|
||||
late final ApiClient specialApi;
|
||||
}
|
||||
```
|
||||
|
||||
- After running build_runner, the mixin _$MyWidget is created.
|
||||
- Call `MyWidget().injectFields();` (method name may be `_inject` or similar) to populate the fields!
|
||||
|
||||
### B. Module Binding (recommended for global app services)
|
||||
|
||||
```dart
|
||||
@module()
|
||||
abstract class AppModule extends Module {
|
||||
@singleton
|
||||
AuthService provideAuth(Api api) => AuthService(api);
|
||||
|
||||
@provide
|
||||
@named('logging')
|
||||
Future<Logger> provideLogger(@params Map<String, dynamic> args) async => ...
|
||||
}
|
||||
```
|
||||
|
||||
- Providers can return async(`Future<T>`) or sync.
|
||||
- `@singleton` = one instance per scope.
|
||||
|
||||
---
|
||||
|
||||
## 4. Using the Generated Code
|
||||
|
||||
1. Add to your `pubspec.yaml`:
|
||||
|
||||
```yaml
|
||||
dependencies:
|
||||
cherrypick: any
|
||||
cherrypick_annotations: any
|
||||
|
||||
dev_dependencies:
|
||||
cherrypick_generator: any
|
||||
build_runner: any
|
||||
```
|
||||
|
||||
2. Import generated files (e.g. `app_module.module.cherrypick.g.dart`, `your_class.inject.cherrypick.g.dart`).
|
||||
|
||||
3. Register modules:
|
||||
|
||||
```dart
|
||||
final scope = openRootScope()
|
||||
..installModules([$AppModule()]);
|
||||
```
|
||||
|
||||
4. For classes with auto-injected fields, mix in the generated mixin and call the injector:
|
||||
|
||||
```dart
|
||||
final widget = MyWidget();
|
||||
widget.injectFields(); // or use the mixin's helper
|
||||
```
|
||||
|
||||
5. All dependencies are now available and ready to use!
|
||||
|
||||
---
|
||||
|
||||
## 5. Advanced Features
|
||||
|
||||
- **Named and Scoped dependencies:** use `@named`, `@scope` on fields/methods and in resolve().
|
||||
- **Async support:** Providers or injected fields can be Future<T> (resolveAsync).
|
||||
- **Runtime parameters:** Decorate a parameter with `@params`, and use `resolve<T>(params: ...)`.
|
||||
- **Combining strategies:** Mix field injection (`@injectable`) and module/provider (`@module` + methods) in one app.
|
||||
|
||||
---
|
||||
|
||||
## 6. Troubleshooting
|
||||
|
||||
- Make sure all dependencies are annotated, imports are correct, and run `build_runner` on every code/DI change.
|
||||
- Errors in annotation usage (e.g. `@singleton` on non-class/method) will be shown at build time.
|
||||
- Use the `.g.dart` files directly—do not edit them by hand.
|
||||
|
||||
---
|
||||
|
||||
## 7. References
|
||||
|
||||
- [Cherrypick Generator README (extended)](../cherrypick_generator/README.md)
|
||||
- Example: `examples/postly`
|
||||
- [API Reference](../cherrypick/doc/api/)
|
||||
|
||||
---
|
||||
137
doc/annotations_ru.md
Normal file
137
doc/annotations_ru.md
Normal file
@@ -0,0 +1,137 @@
|
||||
# Генерация DI-кода через аннотации (CherryPick)
|
||||
|
||||
CherryPick позволяет получить умный и полностью автоматизированный DI для Dart/Flutter на основе аннотаций и генерации кода.
|
||||
Это убирает boilerplate — просто ставьте аннотации, запускайте генератор и используйте результат!
|
||||
|
||||
---
|
||||
|
||||
## 1. Как это работает?
|
||||
|
||||
Вы размечаете классы, поля и модули с помощью [cherrypick_annotations].
|
||||
[cherrypick_generator] анализирует их и создаёт код для регистрации зависимостей и подстановки полей или модулей.
|
||||
|
||||
Далее — запускайте:
|
||||
```sh
|
||||
dart run build_runner build --delete-conflicting-outputs
|
||||
```
|
||||
— и используйте сгенерированные файлы в проекте.
|
||||
|
||||
---
|
||||
|
||||
## 2. Поддерживаемые аннотации
|
||||
|
||||
| Аннотация | Где применить | Значение |
|
||||
|--------------------|------------------|------------------------------------------------------------|
|
||||
| `@injectable()` | класс | Включает автоподстановку полей, генерируется mixin |
|
||||
| `@inject()` | поле | Поле будет автоматически подставлено DI |
|
||||
| `@scope()` | поле/параметр | Использовать определённый scope при разрешении |
|
||||
| `@named()` | поле/параметр | Именованный биндинг для интерфейсов/реализаций |
|
||||
| `@module()` | класс | Класс как DI-модуль (методы — провайдеры) |
|
||||
| `@provide` | метод | Регистрирует тип через этот метод-провайдер |
|
||||
| `@instance` | метод | Регистрирует как прямой инстанс (singleton/factory, как есть)|
|
||||
| `@singleton` | метод/класс | Синглтон (один экземпляр на scope) |
|
||||
| `@params` | параметр | Пробрасывает параметры рантайм/конструктора в DI |
|
||||
|
||||
Миксуйте аннотации для сложных сценариев!
|
||||
|
||||
---
|
||||
|
||||
## 3. Примеры использования
|
||||
|
||||
### A. Field Injection (рекомендуется для виджетов/классов)
|
||||
|
||||
```dart
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
@injectable()
|
||||
class MyWidget with _$MyWidget {
|
||||
@inject()
|
||||
late final AuthService auth;
|
||||
|
||||
@inject()
|
||||
@scope('profile')
|
||||
late final ProfileManager profile;
|
||||
|
||||
@inject()
|
||||
@named('special')
|
||||
late final ApiClient specialApi;
|
||||
}
|
||||
```
|
||||
- После build_runner появится mixin _$MyWidget.
|
||||
- Вызовите `MyWidget().injectFields();` (или соответствующий метод из mixin), чтобы заполнить поля.
|
||||
|
||||
### B. Binding через модуль (вариант для глобальных сервисов)
|
||||
|
||||
```dart
|
||||
@module()
|
||||
abstract class AppModule extends Module {
|
||||
@singleton
|
||||
AuthService provideAuth(Api api) => AuthService(api);
|
||||
|
||||
@provide
|
||||
@named('logging')
|
||||
Future<Logger> provideLogger(@params Map<String, dynamic> args) async => ...
|
||||
}
|
||||
```
|
||||
- Методы-провайдеры поддерживают async (Future<T>) и singleton.
|
||||
|
||||
---
|
||||
|
||||
## 4. Использование сгенерированного кода
|
||||
|
||||
1. В `pubspec.yaml`:
|
||||
|
||||
```yaml
|
||||
dependencies:
|
||||
cherrypick: any
|
||||
cherrypick_annotations: any
|
||||
|
||||
dev_dependencies:
|
||||
cherrypick_generator: any
|
||||
build_runner: any
|
||||
```
|
||||
|
||||
2. Импортируйте сгенерированные файлы (`app_module.module.cherrypick.g.dart`, `your_class.inject.cherrypick.g.dart`).
|
||||
|
||||
3. Регистрируйте модули так:
|
||||
|
||||
```dart
|
||||
final scope = openRootScope()
|
||||
..installModules([$AppModule()]);
|
||||
```
|
||||
|
||||
4. Для классов с автоподстановкой полей (field injection): используйте mixin и вызовите injector:
|
||||
|
||||
```dart
|
||||
final widget = MyWidget();
|
||||
widget.injectFields(); // или эквивалентный метод из mixin
|
||||
```
|
||||
|
||||
5. Все зависимости готовы к использованию!
|
||||
|
||||
---
|
||||
|
||||
## 5. Расширенные возможности
|
||||
|
||||
- **Именованные и scope-зависимости:** используйте `@named`, `@scope` в полях/методах/resolve.
|
||||
- **Async:** Провайдеры и поля могут быть Future<T> (resolveAsync).
|
||||
- **Параметры рантайм:** через `@params` прямо к провайдеру: `resolve<T>(params: ...)`.
|
||||
- **Комбинированная стратегия:** можно смешивать field injection и модульные провайдеры в одном проекте.
|
||||
|
||||
---
|
||||
|
||||
## 6. Советы и FAQ
|
||||
|
||||
- Проверьте аннотации, пути import и запускайте build_runner после каждого изменения DI/кода.
|
||||
- Ошибки применения аннотаций появляются на этапе генерации.
|
||||
- Никогда не редактируйте .g.dart файлы вручную.
|
||||
|
||||
---
|
||||
|
||||
## 7. Полезные ссылки
|
||||
|
||||
- [README по генератору](../cherrypick_generator/README.md)
|
||||
- Пример интеграции: `examples/postly`
|
||||
- [API Reference](../cherrypick/doc/api/)
|
||||
|
||||
---
|
||||
446
doc/full_tutorial_en.md
Normal file
446
doc/full_tutorial_en.md
Normal file
@@ -0,0 +1,446 @@
|
||||
# Full Guide to CherryPick DI for Dart and Flutter: Dependency Injection with Annotations and Automatic Code Generation
|
||||
|
||||
**CherryPick** is a powerful tool for dependency injection in Dart and Flutter projects. It offers a modern approach with code generation, async providers, named and parameterized bindings, and field injection using annotations.
|
||||
|
||||
> Tools:
|
||||
> - [`cherrypick`](https://pub.dev/packages/cherrypick) — runtime DI core
|
||||
> - [`cherrypick_annotations`](https://pub.dev/packages/cherrypick_annotations) — DI annotations
|
||||
> - [`cherrypick_generator`](https://pub.dev/packages/cherrypick_generator) — DI code generation
|
||||
>
|
||||
|
||||
---
|
||||
|
||||
## CherryPick advantages vs other DI frameworks
|
||||
|
||||
- 📦 Simple declarative API for registering and resolving dependencies
|
||||
- ⚡️ Full support for both sync and async registrations
|
||||
- 🧩 DI via annotations with codegen, including advanced field injection
|
||||
- 🏷️ Named bindings for multiple interface implementations
|
||||
- 🏭 Parameterized bindings for runtime factories (e.g., by ID)
|
||||
- 🌲 Flexible scope system for dependency isolation and hierarchy
|
||||
- 🕹️ Optional resolution (`tryResolve`)
|
||||
- 🐞 Clear compile-time errors for invalid annotation or DI configuration
|
||||
|
||||
---
|
||||
|
||||
## How CherryPick works: core concepts
|
||||
|
||||
### Dependency registration (bindings)
|
||||
|
||||
```dart
|
||||
bind<MyService>().toProvide(() => MyServiceImpl());
|
||||
bind<MyRepository>().toProvideAsync(() async => await initRepo());
|
||||
bind<UserService>().toProvideWithParams((id) => UserService(id));
|
||||
|
||||
// Singleton
|
||||
bind<MyApi>().toProvide(() => MyApi()).singleton();
|
||||
|
||||
// Register an already created object
|
||||
final config = AppConfig.dev();
|
||||
bind<AppConfig>().toInstance(config);
|
||||
|
||||
// Register an already running Future/async value
|
||||
final setupFuture = loadEnvironment();
|
||||
bind<Environment>().toInstanceAsync(setupFuture);
|
||||
```
|
||||
|
||||
- **toProvide** — regular sync factory
|
||||
- **toProvideAsync** — async factory (if you need to await a Future)
|
||||
- **toProvideWithParams / toProvideAsyncWithParams** — factories with runtime parameters
|
||||
- **toInstance** — registers an already created object as a dependency
|
||||
- **toInstanceAsync** — registers an already started Future as an async dependency
|
||||
|
||||
### Named bindings
|
||||
|
||||
You can register several implementations of an interface under different names:
|
||||
|
||||
```dart
|
||||
bind<ApiClient>().toProvide(() => ApiClientProd()).withName('prod');
|
||||
bind<ApiClient>().toProvide(() => ApiClientMock()).withName('mock');
|
||||
|
||||
// Resolving by name:
|
||||
final api = scope.resolve<ApiClient>(named: 'mock');
|
||||
```
|
||||
|
||||
### Lifecycle: singleton
|
||||
|
||||
- `.singleton()` — single instance per Scope lifetime
|
||||
- By default, every resolve creates a new object
|
||||
|
||||
### Parameterized bindings
|
||||
|
||||
Allows you to create dependencies with runtime parameters, e.g., a service for a user with a given ID:
|
||||
|
||||
```dart
|
||||
bind<UserService>().toProvideWithParams((userId) => UserService(userId));
|
||||
|
||||
// Resolve:
|
||||
final userService = scope.resolveWithParams<UserService>(params: '123');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Scope management: dependency hierarchy
|
||||
|
||||
For most business cases, a single root scope is enough, but CherryPick supports nested scopes:
|
||||
|
||||
```dart
|
||||
final rootScope = CherryPick.openRootScope();
|
||||
final profileScope = rootScope.openSubScope('profile')
|
||||
..installModules([ProfileModule()]);
|
||||
```
|
||||
|
||||
- **Subscope** can override parent dependencies.
|
||||
- When resolving, first checks its own scope, then up the hierarchy.
|
||||
|
||||
|
||||
## Managing names and scope hierarchy (subscopes) in CherryPick
|
||||
|
||||
CherryPick supports nested scopes, each can be "root" or a child. For accessing/managing the hierarchy, CherryPick uses scope names (strings) as well as convenient open/close methods.
|
||||
|
||||
### Open subScope by name
|
||||
|
||||
CherryPick uses separator-delimited strings to search and build scope trees, for example:
|
||||
|
||||
```dart
|
||||
final subScope = CherryPick.openScope(scopeName: 'profile.settings');
|
||||
```
|
||||
|
||||
- Here, `'profile.settings'` will open 'profile' subscope in root, then 'settings' subscope in 'profile'.
|
||||
- Default separator is a dot (`.`), can be changed via `separator` argument.
|
||||
|
||||
**Example with another separator:**
|
||||
|
||||
```dart
|
||||
final subScope = CherryPick.openScope(
|
||||
scopeName: 'project>>dev>>api',
|
||||
separator: '>>',
|
||||
);
|
||||
```
|
||||
|
||||
### Hierarchy & access
|
||||
|
||||
Each hierarchy level is a separate scope.
|
||||
This is convenient for restricting/localizing dependencies, for example:
|
||||
- `main.profile` — dependencies only for user profile
|
||||
- `main.profile.details` — even narrower context
|
||||
|
||||
### Closing subscopes
|
||||
|
||||
To close a specific subScope, use the same path:
|
||||
|
||||
```dart
|
||||
CherryPick.closeScope(scopeName: 'profile.settings');
|
||||
```
|
||||
|
||||
- Closing a top-level scope (`profile`) wipes all children too.
|
||||
|
||||
### Methods summary
|
||||
|
||||
| Method | Description |
|
||||
|---------------------------|--------------------------------------------------------|
|
||||
| `openRootScope()` | Open/get root scope |
|
||||
| `closeRootScope()` | Close root scope, remove all dependencies |
|
||||
| `openScope(scopeName)` | Open scope(s) by name & hierarchy (`'a.b.c'`) |
|
||||
| `closeScope(scopeName)` | Close specified scope or subScope |
|
||||
|
||||
---
|
||||
|
||||
**Recommendations:**
|
||||
Use meaningful names and dot notation for scope structuring in large apps—this improves readability and dependency management on any level.
|
||||
|
||||
---
|
||||
|
||||
**Example:**
|
||||
|
||||
```dart
|
||||
// Opens scopes by hierarchy: app -> module -> page
|
||||
final scope = CherryPick.openScope(scopeName: 'app.module.page');
|
||||
|
||||
// Closes 'module' and all nested subscopes
|
||||
CherryPick.closeScope(scopeName: 'app.module');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
This lets you scale CherryPick DI for any app complexity!
|
||||
|
||||
---
|
||||
|
||||
## Safe dependency resolution
|
||||
|
||||
If not sure a dependency exists, use tryResolve/tryResolveAsync:
|
||||
|
||||
```dart
|
||||
final service = scope.tryResolve<OptionalService>(); // returns null if not exists
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Dependency injection with annotations & code generation
|
||||
|
||||
CherryPick supports DI with annotations, letting you eliminate manual DI setup.
|
||||
|
||||
### Annotation structure
|
||||
|
||||
| Annotation | Purpose | Where to use |
|
||||
|---------------|---------------------------|------------------------------------|
|
||||
| `@module` | DI module | Classes |
|
||||
| `@singleton` | Singleton | Module methods |
|
||||
| `@instance` | New object | Module methods |
|
||||
| `@provide` | Provider | Methods (with DI params) |
|
||||
| `@named` | Named binding | Method argument/Class fields |
|
||||
| `@params` | Parameter passing | Provider argument |
|
||||
| `@injectable` | Field injection support | Classes |
|
||||
| `@inject` | Auto-injection | Class fields |
|
||||
| `@scope` | Scope/realm | Class fields |
|
||||
|
||||
### Example DI module
|
||||
|
||||
```dart
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
@module()
|
||||
abstract class AppModule extends Module {
|
||||
@singleton()
|
||||
@provide()
|
||||
ApiClient apiClient() => ApiClient();
|
||||
|
||||
@provide()
|
||||
UserService userService(ApiClient api) => UserService(api);
|
||||
|
||||
@singleton()
|
||||
@provide()
|
||||
@named('mock')
|
||||
ApiClient mockApiClient() => ApiClientMock();
|
||||
}
|
||||
```
|
||||
- Methods annotated with `@provide` become DI factories.
|
||||
- Add other annotations to specify binding type or name.
|
||||
|
||||
Generated code will look like:
|
||||
|
||||
```dart
|
||||
class $AppModule extends AppModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<ApiClient>().toProvide(() => apiClient()).singleton();
|
||||
bind<UserService>().toProvide(() => userService(currentScope.resolve<ApiClient>()));
|
||||
bind<ApiClient>().toProvide(() => mockApiClient()).withName('mock').singleton();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Example: field injection
|
||||
|
||||
```dart
|
||||
@injectable()
|
||||
class ProfileBloc with _$ProfileBloc {
|
||||
@inject()
|
||||
late final AuthService auth;
|
||||
|
||||
@inject()
|
||||
@named('admin')
|
||||
late final UserService adminUser;
|
||||
|
||||
ProfileBloc() {
|
||||
_inject(this); // injectFields — generated method
|
||||
}
|
||||
}
|
||||
```
|
||||
- Generator creates a mixin (`_$ProfileBloc`) which automatically resolves and injects dependencies into fields.
|
||||
- The `@named` annotation links a field to a named implementation.
|
||||
|
||||
Example generated code:
|
||||
|
||||
```dart
|
||||
mixin $ProfileBloc {
|
||||
@override
|
||||
void _inject(ProfileBloc instance) {
|
||||
instance.auth = CherryPick.openRootScope().resolve<AuthService>();
|
||||
instance.adminUser = CherryPick.openRootScope().resolve<UserService>(named: 'admin');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### How to connect it
|
||||
|
||||
```dart
|
||||
void main() async {
|
||||
final scope = CherryPick.openRootScope();
|
||||
scope.installModules([
|
||||
$AppModule(),
|
||||
]);
|
||||
// DI via field injection
|
||||
final bloc = ProfileBloc();
|
||||
runApp(MyApp(bloc: bloc));
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Async dependencies
|
||||
|
||||
For async providers, use `toProvideAsync`, and resolve them with `resolveAsync`:
|
||||
|
||||
```dart
|
||||
bind<RemoteConfig>().toProvideAsync(() async => await RemoteConfig.load());
|
||||
|
||||
// Usage:
|
||||
final config = await scope.resolveAsync<RemoteConfig>();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Validation and diagnostics
|
||||
|
||||
- If you use incorrect annotations or DI config, you'll get clear compile-time errors.
|
||||
- Binding errors are found during code generation, minimizing runtime issues and speeding up development.
|
||||
|
||||
---
|
||||
|
||||
## Flutter integration: cherrypick_flutter
|
||||
|
||||
### What it is
|
||||
|
||||
[`cherrypick_flutter`](https://pub.dev/packages/cherrypick_flutter) is the integration package for CherryPick DI in Flutter. It provides a convenient `CherryPickProvider` widget which sits in your widget tree and gives access to the root DI scope (and subscopes) from context.
|
||||
|
||||
### Features
|
||||
|
||||
- **Global DI Scope Access:**
|
||||
Use `CherryPickProvider` to access rootScope and subscopes anywhere in the widget tree.
|
||||
- **Context integration:**
|
||||
Use `CherryPickProvider.of(context)` for DI access inside your widgets.
|
||||
|
||||
### Usage Example
|
||||
|
||||
```dart
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:cherrypick_flutter/cherrypick_flutter.dart';
|
||||
|
||||
void main() {
|
||||
runApp(
|
||||
CherryPickProvider(
|
||||
child: MyApp(),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
class MyApp extends StatelessWidget {
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
final rootScope = CherryPickProvider.of(context).openRootScope();
|
||||
|
||||
return MaterialApp(
|
||||
home: Scaffold(
|
||||
body: Center(
|
||||
child: Text(
|
||||
rootScope.resolve<AppService>().getStatus(),
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- Here, `CherryPickProvider` wraps the app and gives DI scope access via context.
|
||||
- You can create subscopes, e.g. for screens or modules:
|
||||
`final subScope = CherryPickProvider.of(context).openSubScope(scopeName: "profileFeature");`
|
||||
|
||||
---
|
||||
## CherryPick is not just for Flutter!
|
||||
|
||||
You can use CherryPick in Dart CLI, server apps, and microservices. All major features work without Flutter.
|
||||
|
||||
---
|
||||
|
||||
## CherryPick Example Project: Step by Step
|
||||
|
||||
1. Add dependencies:
|
||||
```yaml
|
||||
dependencies:
|
||||
cherrypick: ^1.0.0
|
||||
cherrypick_annotations: ^1.0.0
|
||||
|
||||
dev_dependencies:
|
||||
build_runner: ^2.0.0
|
||||
cherrypick_generator: ^1.0.0
|
||||
```
|
||||
|
||||
2. Describe your modules using annotations.
|
||||
|
||||
3. To generate DI code:
|
||||
```shell
|
||||
dart run build_runner build --delete-conflicting-outputs
|
||||
```
|
||||
|
||||
4. Enjoy modern DI with no boilerplate!
|
||||
|
||||
---
|
||||
|
||||
### Advanced: Customizing Generated Code Location
|
||||
|
||||
CherryPick's code generator now supports flexible output configuration via `build.yaml`.
|
||||
|
||||
You can control both the output directory (using `output_dir`) and filename templates (using `build_extensions`):
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|inject_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/app.dart': ['lib/generated/app.inject.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
cherrypick_generator|module_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/di/{{}}.dart': ['lib/generated/di/{{}}.module.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
```
|
||||
|
||||
- **output_dir**: Folder where all generated files will be placed.
|
||||
- **build_extensions**: Allows full customization of generated file names and subfolders.
|
||||
|
||||
If you use these, be sure to update your imports accordingly, e.g.:
|
||||
```dart
|
||||
import 'package:your_project/generated/app.inject.cherrypick.g.dart';
|
||||
```
|
||||
If not specified, generated files will appear next to your source files, as before.
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## Conclusion
|
||||
|
||||
**CherryPick** is a modern DI solution for Dart and Flutter, combining a concise API and advanced annotation/codegen features. Scopes, parameterized providers, named bindings, and field-injection make it great for both small and large-scale projects.
|
||||
|
||||
**Full annotation list and their purposes:**
|
||||
|
||||
| Annotation | Purpose | Where to use |
|
||||
|---------------|---------------------------|------------------------------------|
|
||||
| `@module` | DI module | Classes |
|
||||
| `@singleton` | Singleton | Module methods |
|
||||
| `@instance` | New object | Module methods |
|
||||
| `@provide` | Provider | Methods (with DI params) |
|
||||
| `@named` | Named binding | Method argument/Class fields |
|
||||
| `@params` | Parameter passing | Provider argument |
|
||||
| `@injectable` | Field injection support | Classes |
|
||||
| `@inject` | Auto-injection | Class fields |
|
||||
| `@scope` | Scope/realm | Class fields |
|
||||
|
||||
---
|
||||
|
||||
## Useful Links
|
||||
|
||||
- [cherrypick](https://pub.dev/packages/cherrypick)
|
||||
- [cherrypick_annotations](https://pub.dev/packages/cherrypick_annotations)
|
||||
- [cherrypick_generator](https://pub.dev/packages/cherrypick_generator)
|
||||
- [Sources on GitHub](https://github.com/pese-git/cherrypick)
|
||||
450
doc/full_tutorial_ru.md
Normal file
450
doc/full_tutorial_ru.md
Normal file
@@ -0,0 +1,450 @@
|
||||
# Полный гайд по CherryPick DI для Dart и Flutter: внедрение зависимостей с аннотациями и автоматической генерацией кода
|
||||
|
||||
**CherryPick** — это мощный инструмент для инъекции зависимостей в проектах на Dart и Flutter. Он предлагает современный подход с поддержкой генерации кода, асинхронных провайдеров, именованных и параметризируемых биндингов, а также field injection с использованием аннотаций.
|
||||
|
||||
> Инструменты:
|
||||
> - [`cherrypick`](https://pub.dev/packages/cherrypick) — runtime DI core
|
||||
> - [`cherrypick_annotations`](https://pub.dev/packages/cherrypick_annotations) — аннотации для DI
|
||||
> - [`cherrypick_generator`](https://pub.dev/packages/cherrypick_generator) — генерация DI-кода
|
||||
>
|
||||
|
||||
---
|
||||
|
||||
## Преимущества CherryPick по сравнению с другими DI-фреймворками
|
||||
|
||||
- 📦 Простой декларативный API для регистрации и разрешения зависимостей.
|
||||
- ⚡️ Полная поддержка синхронных _и_ асинхронных регистраций.
|
||||
- 🧩 DI через аннотации с автогенерацией кода, включая field injection.
|
||||
- 🏷️ Именованные зависимости (named bindings).
|
||||
- 🏭 Параметризация биндингов для runtime-использования фабрик.
|
||||
- 🌲 Гибкая система Scope'ов для изоляции и иерархии зависимостей.
|
||||
- 🕹️ Опциональное разрешение (tryResolve).
|
||||
- 🐞 Ясные compile-time ошибки при неправильной аннотации или неверном DI-описании.
|
||||
|
||||
---
|
||||
|
||||
## Как работает CherryPick: основные концепции
|
||||
|
||||
### Регистрация зависимостей: биндинги
|
||||
|
||||
```dart
|
||||
bind<MyService>().toProvide(() => MyServiceImpl());
|
||||
bind<MyRepository>().toProvideAsync(() async => await initRepo());
|
||||
bind<UserService>().toProvideWithParams((id) => UserService(id));
|
||||
|
||||
// Singleton
|
||||
bind<MyApi>().toProvide(() => MyApi()).singleton();
|
||||
|
||||
// Зарегистрировать уже существующий объект
|
||||
final config = AppConfig.dev();
|
||||
bind<AppConfig>().toInstance(config);
|
||||
|
||||
// Зарегистрировать уже существующий Future/асинхронное значение
|
||||
final setupFuture = loadEnvironment();
|
||||
bind<Environment>().toInstanceAsync(setupFuture);
|
||||
```
|
||||
|
||||
|
||||
- **toProvide** — обычная синхронная фабрика.
|
||||
- **toProvideAsync** — асинхронная фабрика (например, если нужно дожидаться Future).
|
||||
- **toProvideWithParams / toProvideAsyncWithParams** — фабрики с параметрами.
|
||||
- **toInstance** — регистрирует уже созданный экземпляр класса как зависимость.
|
||||
- **toInstanceAsync** — регистрирует уже запущенный Future, как асинхронную зависимость.
|
||||
|
||||
### Именованные биндинги (Named)
|
||||
|
||||
Можно регистрировать несколько реализаций одного интерфейса под разными именами:
|
||||
|
||||
```dart
|
||||
bind<ApiClient>().toProvide(() => ApiClientProd()).withName('prod');
|
||||
bind<ApiClient>().toProvide(() => ApiClientMock()).withName('mock');
|
||||
|
||||
// Получение по имени:
|
||||
final api = scope.resolve<ApiClient>(named: 'mock');
|
||||
```
|
||||
|
||||
### Жизненный цикл: singleton
|
||||
|
||||
- `.singleton()` — один инстанс на всё время жизни Scope.
|
||||
- По умолчанию каждый resolve создаёт новый объект.
|
||||
|
||||
### Параметрические биндинги
|
||||
|
||||
Позволяют создавать зависимости с runtime-параметрами — например, сервис для пользователя с ID:
|
||||
|
||||
```dart
|
||||
bind<UserService>().toProvideWithParams((userId) => UserService(userId));
|
||||
|
||||
// Получение
|
||||
final userService = scope.resolveWithParams<UserService>(params: '123');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Управление Scope'ами: иерархия зависимостей
|
||||
|
||||
Для большинства бизнес-кейсов достаточно одного Scope (root), но CherryPick поддерживает создание вложенных Scope:
|
||||
|
||||
```dart
|
||||
final rootScope = CherryPick.openRootScope();
|
||||
final profileScope = rootScope.openSubScope('profile')
|
||||
..installModules([ProfileModule()]);
|
||||
```
|
||||
|
||||
- **Под-скоуп** может переопределять зависимости родителя.
|
||||
- При разрешении сначала проверяется свой Scope, потом иерархия вверх.
|
||||
|
||||
|
||||
## Работа с именованием и иерархией подскоупов (subscopes) в CherryPick
|
||||
|
||||
CherryPick поддерживает вложенные области видимости (scopes), где каждый scope может быть как "корневым", так и дочерним. Для доступа и управления иерархией используется понятие **scope name** (имя области видимости), а также удобные методы для открытия и закрытия скопов по строковым идентификаторам.
|
||||
|
||||
### Открытие subScope по имени
|
||||
|
||||
CherryPick использует строки с разделителями для поиска и построения дерева областей видимости. Например:
|
||||
|
||||
```dart
|
||||
final subScope = CherryPick.openScope(scopeName: 'profile.settings');
|
||||
```
|
||||
|
||||
- Здесь `'profile.settings'` означает, что сначала откроется подскоуп `profile` у rootScope, затем — подскоуп `settings` у `profile`.
|
||||
- Разделитель по умолчанию — точка (`.`). Его можно изменить, указав `separator` аргументом.
|
||||
|
||||
**Пример с другим разделителем:**
|
||||
|
||||
```dart
|
||||
final subScope = CherryPick.openScope(
|
||||
scopeName: 'project>>dev>>api',
|
||||
separator: '>>',
|
||||
);
|
||||
```
|
||||
|
||||
### Иерархия и доступ
|
||||
|
||||
Каждый уровень иерархии соответствует отдельному scope.
|
||||
Это удобно для ограничения и локализации зависимостей, например:
|
||||
- `main.profile` — зависимости только для профиля пользователя
|
||||
- `main.profile.details` — ещё более "узкая" область видимости
|
||||
|
||||
### Закрытие подскоупов
|
||||
|
||||
Чтобы закрыть конкретный subScope, используйте тот же путь:
|
||||
|
||||
```dart
|
||||
CherryPick.closeScope(scopeName: 'profile.settings');
|
||||
```
|
||||
|
||||
- Если закрываете верхний скоуп (`profile`), все дочерние тоже будут очищены.
|
||||
|
||||
### Кратко о методах
|
||||
|
||||
| Метод | Описание |
|
||||
|--------------------------|--------------------------------------------------------|
|
||||
| `openRootScope()` | Открыть/получить корневой scope |
|
||||
| `closeRootScope()` | Закрыть root scope, удалить все зависимости |
|
||||
| `openScope(scopeName)` | Открыть scope(ы) по имени с иерархией (`'a.b.c'`) |
|
||||
| `closeScope(scopeName)` | Закрыть указанный scope или subscope |
|
||||
|
||||
---
|
||||
|
||||
**Рекомендации:**
|
||||
Используйте осмысленные имена и "точечную" нотацию для структурирования зон видимости в крупных приложениях — это повысит читаемость и позволит удобно управлять зависимостями на любых уровнях.
|
||||
|
||||
---
|
||||
|
||||
**Пример:**
|
||||
|
||||
```dart
|
||||
// Откроет scopes по иерархии: app -> module -> page
|
||||
final scope = CherryPick.openScope(scopeName: 'app.module.page');
|
||||
|
||||
// Закроет 'module' и все вложенные subscopes
|
||||
CherryPick.closeScope(scopeName: 'app.module');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Это позволит масштабировать DI-подход CherryPick в приложениях любой сложности!
|
||||
|
||||
---
|
||||
|
||||
## Безопасное разрешение зависимостей
|
||||
|
||||
Если не уверены, что нужная зависимость есть, используйте tryResolve/tryResolveAsync:
|
||||
|
||||
```dart
|
||||
final service = scope.tryResolve<OptionalService>(); // вернет null, если нет
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Внедрение зависимостей через аннотации и автогенерацию
|
||||
|
||||
CherryPick поддерживает DI через аннотации, что позволяет полностью избавиться от ручного внедрения зависимостей.
|
||||
|
||||
### Структура аннотаций
|
||||
|
||||
| Аннотация | Для чего | Где применяют |
|
||||
| ------------- | ------------------------- | -------------------------------- |
|
||||
| `@module` | DI-модуль | Классы |
|
||||
| `@singleton` | Singleton | Методы класса |
|
||||
| `@instance` | Новый объект | Методы класса |
|
||||
| `@provide` | Провайдер | Методы (с DI params) |
|
||||
| `@named` | Именованный биндинг | Аргумент метода/Аттрибуты класса |
|
||||
| `@params` | Передача параметров | Аргумент провайдера |
|
||||
| `@injectable` | Поддержка field injection | Классы |
|
||||
| `@inject` | Автовнедрение | Аттрибуты класса |
|
||||
| `@scope` | Scope/realm | Аттрибуты класса |
|
||||
|
||||
### Пример DI-модуля
|
||||
|
||||
```dart
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
@module()
|
||||
abstract class AppModule extends Module {
|
||||
@singleton()
|
||||
@provide()
|
||||
ApiClient apiClient() => ApiClient();
|
||||
|
||||
@provide()
|
||||
UserService userService(ApiClient api) => UserService(api);
|
||||
|
||||
@singleton()
|
||||
@provide()
|
||||
@named('mock')
|
||||
ApiClient mockApiClient() => ApiClientMock();
|
||||
}
|
||||
```
|
||||
- Методы, отмеченные `@provide`, становятся фабриками DI.
|
||||
- Можно добавлять другие аннотации для уточнения типа биндинга, имени.
|
||||
|
||||
Сгенерированный код будет выглядеть вот таким образом:
|
||||
|
||||
```dart
|
||||
class $AppModule extends AppModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<ApiClient>().toProvide(() => apiClient()).singelton();
|
||||
bind<UserService>().toProvide(() => userService(currentScope.resolve<ApiClient>()));
|
||||
bind<ApiClient>().toProvide(() => mockApiClient()).withName('mock').singelton();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
### Пример инъекций зависимостей через field injection
|
||||
|
||||
```dart
|
||||
@injectable()
|
||||
class ProfileBloc with _$ProfileBloc {
|
||||
@inject()
|
||||
late final AuthService auth;
|
||||
|
||||
@inject()
|
||||
@named('admin')
|
||||
late final UserService adminUser;
|
||||
|
||||
ProfileBloc() {
|
||||
_inject(this); // injectFields — сгенерированный метод
|
||||
}
|
||||
}
|
||||
```
|
||||
- Генератор создаёт mixin (`_$ProfileBloc`), который автоматически резолвит и подставляет зависимости в поля класса.
|
||||
- Аннотация `@named` привязывает конкретную реализацию по имени.
|
||||
|
||||
Сгенерированный код будет выглядеть вот таким образом:
|
||||
|
||||
```dart
|
||||
mixin $ProfileBloc {
|
||||
@override
|
||||
void _inject(ProfileBloc instance) {
|
||||
instance.auth = CherryPick.openRootScope().resolve<AuthService>();
|
||||
instance.adminUser = CherryPick.openRootScope().resolve<UserService>(named: 'admin');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
### Как это подключается
|
||||
|
||||
```dart
|
||||
void main() async {
|
||||
final scope = CherryPick.openRootScope();
|
||||
scope.installModules([
|
||||
$AppModule(),
|
||||
]);
|
||||
// DI через field injection
|
||||
final bloc = ProfileBloc();
|
||||
runApp(MyApp(bloc: bloc));
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Асинхронные зависимости
|
||||
|
||||
Для асинхронных провайдеров используйте `toProvideAsync`, а получать их — через `resolveAsync`:
|
||||
|
||||
```dart
|
||||
bind<RemoteConfig>().toProvideAsync(() async => await RemoteConfig.load());
|
||||
|
||||
// Использование:
|
||||
final config = await scope.resolveAsync<RemoteConfig>();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Проверка и диагностика
|
||||
|
||||
- При неправильных аннотациях или ошибках DI появляется понятное compile-time сообщение.
|
||||
- Ошибки биндингов выявляются при генерации кода. Это минимизирует runtime-ошибки и ускоряет разработку.
|
||||
|
||||
---
|
||||
|
||||
## Использование CherryPick с Flutter: пакет cherrypick_flutter
|
||||
|
||||
### Что это такое
|
||||
|
||||
[`cherrypick_flutter`](https://pub.dev/packages/cherrypick_flutter) — это пакет интеграции CherryPick DI с Flutter. Он предоставляет удобный виджет-провайдер `CherryPickProvider`, который размещается в вашем дереве виджетов и даёт доступ к root scope DI (и подскоупам) прямо из контекста.
|
||||
|
||||
### Ключевые возможности
|
||||
|
||||
- **Глобальный доступ к DI Scope:**
|
||||
Через `CherryPickProvider` вы легко получаете доступ к rootScope и подскоупам из любого места дерева Flutter.
|
||||
- **Интеграция с контекстом:**
|
||||
Используйте `CherryPickProvider.of(context)` для доступа к DI внутри ваших виджетов.
|
||||
|
||||
### Пример использования
|
||||
|
||||
```dart
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:cherrypick_flutter/cherrypick_flutter.dart';
|
||||
|
||||
void main() {
|
||||
runApp(
|
||||
CherryPickProvider(
|
||||
child: MyApp(),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
class MyApp extends StatelessWidget {
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
final rootScope = CherryPickProvider.of(context).openRootScope();
|
||||
|
||||
return MaterialApp(
|
||||
home: Scaffold(
|
||||
body: Center(
|
||||
child: Text(
|
||||
rootScope.resolve<AppService>().getStatus(),
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- В этом примере `CherryPickProvider` оборачивает приложение и предоставляет доступ к DI scope через контекст.
|
||||
- Вы можете создавать подскоупы, если нужно, например, для экранов или модулей:
|
||||
`final subScope = CherryPickProvider.of(context).openSubScope(scopeName: "profileFeature");`
|
||||
|
||||
---
|
||||
## CherryPick подходит не только для Flutter!
|
||||
|
||||
Вы можете использовать CherryPick и в Dart CLI, серверных проектах и микросервисах. Все основные возможности доступны и без Flutter.
|
||||
|
||||
---
|
||||
|
||||
## Пример проекта на CherryPick: полный путь
|
||||
|
||||
1. Установите зависимости:
|
||||
```yaml
|
||||
dependencies:
|
||||
cherrypick: ^1.0.0
|
||||
cherrypick_annotations: ^1.0.0
|
||||
|
||||
dev_dependencies:
|
||||
build_runner: ^2.0.0
|
||||
cherrypick_generator: ^1.0.0
|
||||
```
|
||||
|
||||
2. Описываете свои модули с помощью аннотаций.
|
||||
|
||||
3. Для автоматической генерации DI кода используйте:
|
||||
```shell
|
||||
dart run build_runner build --delete-conflicting-outputs
|
||||
```
|
||||
|
||||
4. Наслаждайтесь современным DI без боли!
|
||||
|
||||
---
|
||||
|
||||
### Продвинутая настройка путей генерации кода
|
||||
|
||||
В последних версиях генератора CherryPick добавлена поддержка гибкой настройки директорий и шаблонов имён файлов через `build.yaml`.
|
||||
|
||||
Вы можете управлять и папкой назначения (через `output_dir`), и шаблоном имён (через `build_extensions`):
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|inject_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/app.dart': ['lib/generated/app.inject.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
cherrypick_generator|module_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/di/{{}}.dart': ['lib/generated/di/{{}}.module.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
```
|
||||
|
||||
- **output_dir**: Папка, куда будут складываться все сгенерированные файлы.
|
||||
- **build_extensions**: Полный контроль над именами итоговых файлов и подпапками.
|
||||
|
||||
Если вы это используете, обязательно обновляйте импорты, например:
|
||||
```dart
|
||||
import 'package:your_project/generated/app.inject.cherrypick.g.dart';
|
||||
```
|
||||
Если не задать параметры, файлы будут сгенерированы рядом с исходными — как и раньше.
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## Заключение
|
||||
|
||||
**CherryPick** — это современное DI-решение для Dart и Flutter, сочетающее лаконичный API и расширенные возможности аннотирования и генерации кода. Гибкость Scopes, параметрические провайдеры, именованные биндинги и field-injection делают его особенно мощным как для небольших, так и для масштабных проектов.
|
||||
|
||||
|
||||
**Полный список аннотаций и их предназначение:**
|
||||
|
||||
| Аннотация | Для чего | Где применяют |
|
||||
| ------------- | ------------------------- | -------------------------------- |
|
||||
| `@module` | DI-модуль | Классы |
|
||||
| `@singleton` | Singleton | Методы класса |
|
||||
| `@instance` | Новый объект | Методы класса |
|
||||
| `@provide` | Провайдер | Методы (с DI params) |
|
||||
| `@named` | Именованный биндинг | Аргумент метода/Аттрибуты класса |
|
||||
| `@params` | Передача параметров | Аргумент провайдера |
|
||||
| `@injectable` | Поддержка field injection | Классы |
|
||||
| `@inject` | Автовнедрение | Аттрибуты класса |
|
||||
| `@scope` | Scope/realm | Аттрибуты класса |
|
||||
|
||||
---
|
||||
|
||||
## Полезные ссылки
|
||||
|
||||
- [cherrypick](https://pub.dev/packages/cherrypick)
|
||||
- [cherrypick_annotations](https://pub.dev/packages/cherrypick_annotations)
|
||||
- [cherrypick_generator](https://pub.dev/packages/cherrypick_generator)
|
||||
- [Исходники на GitHub](https://github.com/pese-git/cherrypick)
|
||||
@@ -19,7 +19,29 @@ There are two main methods for initializing a custom instance `toInstance ()` an
|
||||
|
||||
Example:
|
||||
|
||||
```dart
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Advanced: Customizing Code Generation Output
|
||||
|
||||
You can configure where generated files will be placed by updating your `build.yaml` (supports `output_dir` and `build_extensions`):
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|inject_generator:
|
||||
options:
|
||||
output_dir: lib/generated
|
||||
cherrypick_generator|module_generator:
|
||||
options:
|
||||
output_dir: lib/generated
|
||||
```
|
||||
|
||||
For full control and more examples, see the "Full Tutorial" or documentation on `build_extensions`.
|
||||
|
||||
---
|
||||
// initializing a text string instance through a method toInstance()
|
||||
Binding<String>().toInstance("hello world");
|
||||
|
||||
@@ -19,7 +19,29 @@ Binding - по сути это конфигуратор для пользов
|
||||
|
||||
Пример:
|
||||
|
||||
```dart
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Продвинутая настройка генерации кода
|
||||
|
||||
В файле `build.yaml` можно задать папку для сгенерированных файлов через параметр `output_dir` (а также использовать шаблон `build_extensions`):
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|inject_generator:
|
||||
options:
|
||||
output_dir: lib/generated
|
||||
cherrypick_generator|module_generator:
|
||||
options:
|
||||
output_dir: lib/generated
|
||||
```
|
||||
|
||||
Для полной настройки и шаблонов см. раздел “Полный гайд” или документацию по `build_extensions`.
|
||||
|
||||
---
|
||||
// инициализация экземпляра текстовой строки через метод toInstance()
|
||||
Binding<String>().toInstance("hello world");
|
||||
|
||||
@@ -148,7 +148,7 @@ packages:
|
||||
path: "../../cherrypick_generator"
|
||||
relative: true
|
||||
source: path
|
||||
version: "1.1.0-dev.3"
|
||||
version: "1.1.0-dev.5"
|
||||
clock:
|
||||
dependency: transitive
|
||||
description:
|
||||
|
||||
@@ -11,10 +11,13 @@ environment:
|
||||
dependencies:
|
||||
flutter:
|
||||
sdk: flutter
|
||||
cherrypick: ^2.2.0-dev.1
|
||||
cherrypick_flutter: ^1.1.2-dev.1
|
||||
cherrypick:
|
||||
path: ../../cherrypick
|
||||
cherrypick_flutter:
|
||||
path: ../../cherrypick_flutter
|
||||
|
||||
cherrypick_annotations: ^1.1.0-dev.1
|
||||
cherrypick_annotations:
|
||||
path: ../../cherrypick_annotations
|
||||
|
||||
cupertino_icons: ^1.0.8
|
||||
|
||||
@@ -24,7 +27,8 @@ dev_dependencies:
|
||||
|
||||
flutter_lints: ^5.0.0
|
||||
|
||||
cherrypick_generator: ^1.1.0-dev.5
|
||||
cherrypick_generator:
|
||||
path: ../../cherrypick_generator
|
||||
build_runner: ^2.4.15
|
||||
|
||||
# For information on the generic Dart part of this file, see the
|
||||
|
||||
@@ -9,6 +9,13 @@
|
||||
# packages, and plugins designed to encourage good coding practices.
|
||||
include: package:flutter_lints/flutter.yaml
|
||||
|
||||
analyzer:
|
||||
exclude:
|
||||
- "**/*.g.dart"
|
||||
- "**/*.freezed.dart"
|
||||
- "**/*.gr.dart"
|
||||
- "**/*.config.dart"
|
||||
|
||||
linter:
|
||||
# The lint rules applied to this project can be customized in the
|
||||
# section below to disable rules from the `package:flutter_lints/flutter.yaml`
|
||||
|
||||
27
examples/postly/build.yaml
Normal file
27
examples/postly/build.yaml
Normal file
@@ -0,0 +1,27 @@
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|inject_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/app.dart': ['lib/generated/app.inject.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
cherrypick_generator|module_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/di/{{}}.dart': ['lib/generated/di/{{}}.module.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
|
||||
#targets:
|
||||
# $default:
|
||||
# builders:
|
||||
# cherrypick_generator|module_generator:
|
||||
# generate_for:
|
||||
# - lib/**.dart
|
||||
# cherrypick_generator|inject_generator:
|
||||
# generate_for:
|
||||
# - lib/**.dart
|
||||
@@ -7,7 +7,7 @@ import 'domain/repository/post_repository.dart';
|
||||
import 'presentation/bloc/post_bloc.dart';
|
||||
import 'router/app_router.dart';
|
||||
|
||||
part 'app.inject.cherrypick.g.dart';
|
||||
part 'generated/app.inject.cherrypick.g.dart';
|
||||
|
||||
@injectable()
|
||||
class MyApp extends StatelessWidget with _$MyApp {
|
||||
|
||||
@@ -5,7 +5,7 @@ import '../data/network/json_placeholder_api.dart';
|
||||
import '../data/post_repository_impl.dart';
|
||||
import '../domain/repository/post_repository.dart';
|
||||
|
||||
part 'app_module.module.cherrypick.g.dart';
|
||||
part '../generated/di/app_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class AppModule extends Module {
|
||||
|
||||
@@ -165,7 +165,7 @@ packages:
|
||||
path: "../../cherrypick_generator"
|
||||
relative: true
|
||||
source: path
|
||||
version: "1.1.0-dev.4"
|
||||
version: "1.1.0-dev.5"
|
||||
clock:
|
||||
dependency: transitive
|
||||
description:
|
||||
|
||||
@@ -12,8 +12,10 @@ dependencies:
|
||||
flutter:
|
||||
sdk: flutter
|
||||
|
||||
cherrypick: ^2.2.0-dev.1
|
||||
cherrypick_annotations: ^1.1.0-dev.1
|
||||
cherrypick:
|
||||
path: ../../cherrypick
|
||||
cherrypick_annotations:
|
||||
path: ../../cherrypick_annotations
|
||||
|
||||
dio: ^5.4.0
|
||||
retrofit: ^4.0.3
|
||||
@@ -30,7 +32,8 @@ dev_dependencies:
|
||||
|
||||
flutter_lints: ^5.0.0
|
||||
|
||||
cherrypick_generator: ^1.1.0-dev.5
|
||||
cherrypick_generator:
|
||||
path: ../../cherrypick_generator
|
||||
build_runner: 2.4.15
|
||||
|
||||
retrofit_generator: ^9.1.5
|
||||
|
||||
20
melos.yaml
20
melos.yaml
@@ -18,7 +18,23 @@ scripts:
|
||||
exec: dart format lib
|
||||
|
||||
test:
|
||||
exec: flutter test
|
||||
run: |
|
||||
echo "Running Dart tests..."
|
||||
melos exec --scope="cherrypick,cherrypick_annotations,cherrypick_generator" -- dart test --reporter=compact
|
||||
echo "Running Flutter tests..."
|
||||
melos exec --scope="cherrypick_flutter" -- flutter test --reporter=compact
|
||||
|
||||
test:dart:
|
||||
description: "Run tests for Dart packages only"
|
||||
exec: dart test --reporter=compact
|
||||
packageFilters:
|
||||
scope: ["cherrypick", "cherrypick_annotations", "cherrypick_generator"]
|
||||
|
||||
test:flutter:
|
||||
description: "Run tests for Flutter packages only"
|
||||
exec: flutter test --reporter=compact
|
||||
packageFilters:
|
||||
scope: ["cherrypick_flutter"]
|
||||
|
||||
codegen:
|
||||
run: |
|
||||
@@ -31,4 +47,4 @@ scripts:
|
||||
exec: dart pub upgrade --major-versions
|
||||
|
||||
drop:
|
||||
exec: flutter clean
|
||||
exec: flutter clean
|
||||
|
||||
Reference in New Issue
Block a user