Compare commits

..

123 Commits

Author SHA1 Message Date
Sergey Penkovsky
62868477fb chore(release): publish packages
- cherrypick@3.0.0-dev.2
 - cherrypick_flutter@1.1.3-dev.2
2025-08-04 08:54:37 +03:00
Sergey Penkovsky
a889cf0d40 Resolved all Dart analyzer warnings across multiple files 2025-08-01 11:20:23 +03:00
Sergey Penkovsky
123ed6ce02 Merge pull request #13 from pese-git/impr/binding_resolver
Refactored Binding by extracting BindingResolver to improve code structure and simplify the Binding class.
2025-08-01 11:01:30 +03:00
Sergey Penkovsky
7cc0743d94 Update benchmark results in README.ru.md with latest timings (RU version) 2025-08-01 08:48:27 +03:00
Sergey Penkovsky
63dae76ea9 Update benchmark results in README.md with latest timings 2025-08-01 08:47:55 +03:00
Sergey Penkovsky
a74c34876d feat(binding): add deprecated proxy async methods for backward compatibility and highlight transition to modern API 2025-08-01 08:44:31 +03:00
yarashevich_kv
9f0a8a84aa impr: fix after rebase. 2025-08-01 08:44:31 +03:00
yarashevich_kv
2cba7f2675 impr: add binding resolver class. 2025-08-01 08:44:31 +03:00
Sergey Penkovsky
1682ed9c08 Update benchmarks, lock files, and related documentation 2025-08-01 08:40:10 +03:00
Sergey Penkovsky
882ee92000 Update benchmark results in README.md with fresh timings 2025-08-01 08:39:12 +03:00
Sergey Penkovsky
9a3576f76d chore(release): publish packages
- cherrypick@3.0.0-dev.1
 - cherrypick_flutter@1.1.3-dev.1
2025-08-01 08:31:50 +03:00
Sergey Penkovsky
f7cc86ea66 docs: add quick guide for circular dependency detection to README 2025-08-01 08:31:50 +03:00
Sergey Penkovsky
1c8e38b0c9 chore(release): publish packages
- cherrypick@3.0.0-dev.0
 - cherrypick_flutter@1.1.3-dev.0
2025-08-01 08:31:50 +03:00
Sergey Penkovsky
d4af82ba01 Remove dead code: _createDependencyKey (no longer used, cycle detection not affected) 2025-08-01 08:31:50 +03:00
Sergey Penkovsky
5630efccfe feat: enable CherryPick cycle detection in debug mode and use safe root scope 2025-08-01 08:31:50 +03:00
Sergey Penkovsky
d63d52b817 feat: implement comprehensive circular dependency detection system
- Add two-level circular dependency detection (local and global)
- Implement CycleDetector for local scope cycle detection
- Implement GlobalCycleDetector for cross-scope cycle detection
- Add CircularDependencyException with detailed dependency chain info
- Integrate cycle detection into Scope class with unique scope IDs
- Extend CherryPick helper with cycle detection management API
- Add safe scope creation methods with automatic detection
- Support both synchronous and asynchronous dependency resolution
- Include comprehensive test coverage (72+ tests)
- Add bilingual documentation (English and Russian)
- Provide usage examples and architectural best practices
- Add performance recommendations and debug tools

BREAKING CHANGE: Scope constructor now generates unique IDs for global detection

fix: remove tmp files

update examples

update examples
2025-08-01 08:31:50 +03:00
Sergey Penkovsky
724dc9b3b5 Update lock files for dependency consistency 2025-08-01 08:30:53 +03:00
Sergey Penkovsky
6bdb9472b5 Update melos.yaml: add benchmark_cherrypick to managed packages 2025-08-01 08:30:12 +03:00
Sergey Penkovsky
23683119c2 Add complex DI benchmarks, main runner, and English README with summarized results for cherrypick core 2025-08-01 08:26:33 +03:00
Sergey Penkovsky
2c1f9d5969 doc: update manual 2025-07-29 08:10:08 +03:00
Sergey Penkovsky
e609c44f90 fix: update deps 2025-07-28 12:53:47 +03:00
Sergey Penkovsky
eb8cc1f566 update gitignore 2025-07-28 12:53:27 +03:00
Sergey Penkovsky
8fcb61ef3e chore(release): publish packages
- cherrypick@2.2.0
 - cherrypick_annotations@1.1.0
 - cherrypick_flutter@1.1.2
 - cherrypick_generator@1.1.0
2025-07-28 12:34:54 +03:00
Sergey Penkovsky
69e166644a fix(tests): update expected outputs in generator tests to match new formatting 2025-07-25 12:44:25 +03:00
Sergey Penkovsky
feb7258302 chore(generator): improve annotation validation, unify async type handling, and refactor BindSpec creation
- Enhance annotation validation in DI code generation.
- Move from manual Future<T> extraction to unified type parsing.
- Refactor BindSpec creation logic to provide better error messages and type consistency.
- Add missing source files for exceptions, annotation validation, and type parsing.

BREAKING CHANGE:
Invalid annotation combinations now produce custom generator errors. Async detection is now handled via unified type parser.
2025-07-25 11:58:56 +03:00
Sergey Penkovsky
c722ad0c07 docs: update full Russian tutorial
- Updated doc/full_tutorial_ru.md with improvements and clarifications
2025-06-21 15:45:34 +03:00
Sergey Penkovsky
8468eff5f7 docs: add full English tutorial for CherryPick DI
- Added doc/full_tutorial_en.md: complete translation and detailed guide for CherryPick DI usage in Dart/Flutter projects
2025-06-21 15:31:52 +03:00
Sergey Penkovsky
24bb47f741 docs: add detailed Russian full tutorial
- Added doc/full_tutorial_ru.md with comprehensive usage and explanation of CherryPick DI
2025-06-21 15:20:30 +03:00
Sergey Penkovsky
b5f6fff8d1 Merge pull request #11 from pese-git/annotations
Annotations
2025-06-19 08:28:10 +03:00
Sergey Penkovsky
e7f20d8f63 docs: move and update quick start guides to ./doc directory
- Перемещены и обновлены quick_start_en.md и quick_start_ru.md
- Файлы удалены из cherrypick/doc, теперь находятся в корне doc/
- Описаны актуальные примеры и улучшена структура
2025-06-17 17:22:30 +03:00
Sergey Penkovsky
e057bb487b docs: add annotation usage guides (en, ru) with up-to-date examples and best practices 2025-06-17 17:19:08 +03:00
Sergey Penkovsky
2e7c9129bb Merge pull request #9 from pese-git/annotations
Annotations
2025-06-12 21:51:04 +03:00
Sergey Penkovsky
292af4a4f3 fix: format test code 2025-06-12 21:49:53 +03:00
Sergey Penkovsky
5220ebc4b9 feat(generator): complete code generation testing framework with 100% test coverage
BREAKING CHANGE: Updated file extensions and dependencies for better compatibility

## 🎯 Major Features Added:
-  Complete test suite for ModuleGenerator (66 integration tests)
-  Complete test suite for InjectGenerator (66 integration tests)
-  Comprehensive unit tests for BindSpec, MetadataUtils
-  195 total tests across all packages (100% passing)

## 🔧 Technical Improvements:
- feat(generator): add comprehensive integration tests for code generation
- feat(generator): implement BindSpec unit tests with full coverage
- feat(generator): add MetadataUtils unit tests for annotation processing
- fix(generator): update file extensions to avoid conflicts (.module.cherrypick.g.dart)
- fix(generator): correct part directive generation in templates
- fix(generator): resolve dart_style 3.x formatting compatibility

## 📦 Dependencies & Configuration:
- build(deps): upgrade analyzer to ^7.0.0 for Dart 3.5+ compatibility
- build(deps): upgrade dart_style to ^3.0.0 for modern formatting
- build(deps): upgrade source_gen to ^2.0.0 for latest features
- config(build): update build.yaml with new file extensions
- config(melos): optimize test commands for better performance

## 🐛 Bug Fixes:
- fix(examples): correct local package paths in client_app and postly
- fix(analysis): exclude generated files from static analysis
- fix(generator): remove unused imports and variables
- fix(tests): add missing part directives in test input files
- fix(tests): update expected outputs to match dart_style 3.x format

## 🚀 Performance & Quality:
- perf(tests): optimize test execution time (132 tests in ~1 second)
- quality: achieve 100% test coverage for code generation
- quality: eliminate all analyzer warnings and errors
- quality: ensure production-ready stability

## 📋 Test Coverage Summary:
- cherrypick: 61 tests 
- cherrypick_annotations: 1 test 
- cherrypick_generator: 132 tests 
- cherrypick_flutter: 1 test 
- Total: 195 tests (100% passing)

## 🔄 Compatibility:
-  Dart SDK 3.5.2+
-  Flutter 3.24+
-  melos + fvm workflow
-  build_runner integration
-  Modern analyzer and formatter

This commit establishes CherryPick as a production-ready dependency injection
framework with enterprise-grade testing and code generation capabilities.
2025-06-11 18:34:19 +03:00
Sergey Penkovsky
a0a0a967a2 chore(release): publish packages
- cherrypick_generator@1.1.0-dev.5
2025-06-04 00:39:25 +03:00
Sergey Penkovsky
a9260e0413 feat: implement tryResolve via generate code 2025-06-04 00:38:23 +03:00
Sergey Penkovsky
dd608031a2 chore(release): publish packages
- cherrypick_generator@1.1.0-dev.4
2025-05-28 01:36:40 +03:00
Sergey Penkovsky
49e3654ab8 fix: fixed warnings 2025-05-28 01:35:46 +03:00
Sergey Penkovsky
bc28ff79ef chore: update deps and up to flutter sdk 3.29.3 and dart >=3.7.0 2025-05-28 00:02:23 +03:00
Sergey Penkovsky
52bc66f2f9 update documentaions 2025-05-23 17:27:40 +03:00
Sergey Penkovsky
79a050d056 update documentaions 2025-05-23 17:23:22 +03:00
Sergey Penkovsky
3beb53a094 update documentations 2025-05-23 17:13:57 +03:00
Sergey Penkovsky
21955640d9 chore(release): publish packages
- cherrypick_annotations@1.1.0-dev.1
 - cherrypick_generator@1.1.0-dev.3
2025-05-23 16:11:08 +03:00
Sergey Penkovsky
a62052daa5 doc: update documentations 2025-05-23 16:10:09 +03:00
Sergey Penkovsky
7dbaa59c01 refactor inject generator 2025-05-23 16:03:29 +03:00
Sergey Penkovsky
8438697107 implement inject generator 2025-05-23 15:26:09 +03:00
Sergey Penkovsky
9c42ba4cef feat: implement InjectGenerator 2025-05-23 14:08:08 +03:00
Sergey Penkovsky
1f6ee172a1 starting implement inject generator 2025-05-23 12:21:23 +03:00
Sergey Penkovsky
161e9085f4 chore(release): publish packages
- cherrypick_generator@1.1.0-dev.2
2025-05-23 08:21:46 +03:00
Sergey Penkovsky
ef49595627 doc: update documentations 2025-05-23 08:21:11 +03:00
Sergey Penkovsky
0fd10488f3 update deps 2025-05-23 08:06:28 +03:00
Sergey Penkovsky
46c2939125 fix: update instance generator code 2025-05-23 08:06:08 +03:00
Sergey Penkovsky
6d5537f068 update pubspec 2025-05-23 00:18:54 +03:00
Sergey Penkovsky
2480757797 update pubspec 2025-05-23 00:17:32 +03:00
Sergey Penkovsky
f8340c6a84 chore(release): publish packages
- cherrypick@2.2.0-dev.1
 - cherrypick_generator@1.1.0-dev.1
 - cherrypick_flutter@1.1.2-dev.1
2025-05-22 23:52:55 +03:00
Sergey Penkovsky
62a1655728 fix: fix warnings 2025-05-22 23:52:02 +03:00
Sergey Penkovsky
fc941c0041 update deps 2025-05-22 23:50:55 +03:00
Sergey Penkovsky
5161fa19b6 refactor code 2025-05-22 23:32:26 +03:00
Sergey Penkovsky
8093f077b1 fix: optimize code 2025-05-22 23:27:41 +03:00
Sergey Penkovsky
45b93db6f5 fix pubspecs 2025-05-22 16:58:59 +03:00
Sergey Penkovsky
1741256f37 chore(release): publish packages
- cherrypick@2.2.0-dev.0
 - cherrypick_annotations@1.1.0-dev.0
 - cherrypick_flutter@1.1.2-dev.0
 - cherrypick_generator@1.1.0-dev.0
2025-05-22 16:54:26 +03:00
Sergey Penkovsky
6aa76e4041 fix pubspecs 2025-05-22 16:53:29 +03:00
Sergey Penkovsky
b4970fcf43 doc: update readme 2025-05-22 16:26:33 +03:00
Sergey Penkovsky
0874cbe43a doc: update documentations 2025-05-22 16:06:38 +03:00
Sergey Penkovsky
3bbecfb8ac doc: update documentations 2025-05-22 16:05:09 +03:00
Sergey Penkovsky
c47418d922 update readme 2025-05-22 15:18:16 +03:00
Sergey Penkovsky
9bbfe2a726 added documentations 2025-05-22 13:52:56 +03:00
Sergey Penkovsky
7490a8e66b refactor code 2025-05-21 15:59:11 +03:00
Sergey Penkovsky
e6d944c5f9 refactor code 2025-05-21 15:50:24 +03:00
Sergey Penkovsky
2bc89062cc fix: fix warning conflict with names 2025-05-21 12:45:52 +03:00
Sergey Penkovsky
df2d90777f feat: implement generator for dynamic params 2025-05-21 12:23:33 +03:00
Sergey Penkovsky
1bdcc71534 feat: implement async mode for instance/provide annotations 2025-05-21 11:05:18 +03:00
Sergey Penkovsky
ad6522856a feat: generate instance async code 2025-05-21 10:40:21 +03:00
Sergey Penkovsky
14dce2aafa feat: implement instance/provide annotations 2025-05-21 00:50:57 +03:00
Sergey Penkovsky
7914d91653 refactor module generator 2025-05-20 19:50:13 +03:00
Sergey Penkovsky
29aa790134 doc: fix comment 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
302e1b6115 doc: update readme 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
3afef18f95 doc: update readme 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
5de737079d doc: add README 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
7e1cb7ab93 doc: update README 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
4c9ff802a6 fix: fix warnings 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
74f13e3fa4 doc: added comments to code 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
7bad0c09c0 write comments to code 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
6e063a4067 modify sample 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
9bc0380a7b fix: fix module generator 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
220f1ed097 feat: implement named dependency 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
a4ee97b79f hotfix 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
ea6eb536dd feat: implement generator for named annotation 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
3d071626e5 fix: fix generator for singletone annotation 2025-05-19 16:12:45 +03:00
Sergey Penkovsky
d1e726aaec feat: implement generator di module 2025-05-19 16:12:44 +03:00
Sergey Penkovsky
b906e927c3 start implement generator code 2025-05-19 16:11:41 +03:00
Sergey Penkovsky
9b0741199c feat: implement annotations 2025-05-19 16:10:44 +03:00
Sergey Penkovsky
7a5880e436 feat: Add async dependency resolution and enhance example
- Implemented async provider methods `toProvideAsync` and `toProvideAsyncWithParams` in `Binding` class, allowing asynchronous initialization with dynamic parameters.
- Added typedefs `AsyncProvider<T>` and `AsyncProviderWithParams<T>` for better type clarity with async operations.
- Introduced async resolution methods `resolveAsync` and `tryResolveAsync` in `Scope` for resolving asynchronous dependencies.
- Updated example in `main.dart` to demonstrate async dependency resolution capabilities.
  - Modified `FeatureModule` to utilize async providers for `DataRepository` and `DataBloc`.
  - Replaced synchronous resolution with `resolveAsync` where applicable.
  - Handled potential errors in dependency resolution with try-catch.
- Removed unnecessary whitespace for cleaner code formatting.
2025-05-19 16:10:43 +03:00
Sergey Penkovsky
de995228a5 update readme 2025-05-19 16:06:51 +03:00
Sergey Penkovsky
2607a69bca Merge pull request #8 from pese-git/refactor
Refactor code and add toInstanceAsync method
2025-05-19 13:44:16 +03:00
Sergey Penkovsky
e91987c635 update tests 2025-05-19 11:14:59 +03:00
Sergey Penkovsky
50652a14a9 implement scope tests 2025-05-19 11:10:10 +03:00
Sergey Penkovsky
869f9123bc feat: implement toInstanceAync binding 2025-05-19 10:55:50 +03:00
Sergey Penkovsky
53dd4a1005 add provide typedef 2025-05-19 10:36:26 +03:00
Sergey Penkovsky
e6f9b13ea4 fix readme and freez deps 2025-05-19 10:26:45 +03:00
Sergey Penkovsky
20e44beea7 chore(release): publish packages
- cherrypick@2.1.0
 - cherrypick_flutter@1.1.1
2025-05-19 10:12:32 +03:00
Sergey Penkovsky
0b3d10b88d Merge pull request #7 from pese-git/develop 2025-05-19 09:24:52 +03:00
Sergey Penkovsky
ed43bf78b8 hide test 2025-05-18 22:59:15 +03:00
Sergey Penkovsky
3cd15bc0c1 hide test 2025-05-18 16:48:37 +03:00
Sergey Penkovsky
bf1b0bd215 fix build scripts 2025-05-18 16:41:48 +03:00
Sergey Penkovsky
9bce40735b init di 2025-05-16 18:09:14 +03:00
Sergey Penkovsky
5cab9164ce modified build scripts 2025-05-16 17:58:02 +03:00
Sergey Penkovsky
0c5db63961 fixed warnings 2025-05-16 17:57:40 +03:00
Sergey Penkovsky
7740717fce implement example 2025-05-16 17:56:57 +03:00
Sergey Penkovsky
a7dc2e0f27 chore(release): publish packages
- cherrypick@2.1.0-dev.1
 - cherrypick_flutter@1.1.1-dev.1
2025-05-16 17:32:26 +03:00
Sergey Penkovsky
cb5f0b23d2 implement example 2025-05-16 17:32:26 +03:00
Sergey Penkovsky
c1b2f9c260 doc: update README 2025-05-16 17:32:26 +03:00
Sergey Penkovsky
80c121d2c9 chore(release): publish packages
- cherrypick@2.1.0-dev.0
 - cherrypick_flutter@1.1.1-dev.0
2025-05-16 17:32:26 +03:00
Sergey Penkovsky
3d24f01e3e doc: update README and example 2025-05-16 17:32:26 +03:00
Sergey Penkovsky
2c39ee48ad implement test 2025-05-16 17:32:26 +03:00
Sergey Penkovsky
28035a1ccd fix warnings 2025-05-16 17:32:25 +03:00
Sergey Penkovsky
1b5cc64324 feat: Add async dependency resolution and enhance example
- Implemented async provider methods `toProvideAsync` and `toProvideAsyncWithParams` in `Binding` class, allowing asynchronous initialization with dynamic parameters.
- Added typedefs `AsyncProvider<T>` and `AsyncProviderWithParams<T>` for better type clarity with async operations.
- Introduced async resolution methods `resolveAsync` and `tryResolveAsync` in `Scope` for resolving asynchronous dependencies.
- Updated example in `main.dart` to demonstrate async dependency resolution capabilities.
  - Modified `FeatureModule` to utilize async providers for `DataRepository` and `DataBloc`.
  - Replaced synchronous resolution with `resolveAsync` where applicable.
  - Handled potential errors in dependency resolution with try-catch.
- Removed unnecessary whitespace for cleaner code formatting.
2025-05-16 17:31:58 +03:00
Sergey Penkovsky
e0e2408bc5 fix: fix warning 2025-05-16 17:31:40 +03:00
Sergey Penkovsky
2fb91ca7cc fix: fix warning 2025-05-16 17:31:23 +03:00
Sergey Penkovsky
f23b14c13b docs: add CONTRIBUTORS.md 2025-05-16 16:43:23 +03:00
Sergey Penkovsky
9255dc2bc3 Update pipeline.yml 2025-05-16 14:17:52 +03:00
Sergey Penkovsky
0d2a6ef023 Update pipeline.yml 2025-05-16 14:11:22 +03:00
Sergey Penkovsky
ec977c06b2 Create pipeline.yml 2025-05-16 14:09:10 +03:00
126 changed files with 13372 additions and 670 deletions

2
.fvmrc
View File

@@ -1,3 +1,3 @@
{
"flutter": "3.24.2"
"flutter": "3.29.3"
}

38
.github/workflows/pipeline.yml vendored Normal file
View File

@@ -0,0 +1,38 @@
name: Melos + FVM CI
on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dart-lang/setup-dart@v1
# также актуализация Flutter, если нужен fvm
- name: Install FVM
run: dart pub global activate fvm
- name: Install Flutter version via FVM
run: fvm install
# ВАЖНО: активируем melos через flutter, чтобы не было несовместимости
- name: Install Melos
run: fvm flutter pub global activate melos
- name: Bootstrap workspace
run: fvm flutter pub global run melos bootstrap
- name: CodeGen
run: fvm flutter pub global run melos run codegen
- name: Analyze all packages
run: fvm flutter pub global run melos run analyze
- name: Run all tests
run: fvm flutter pub global run melos run test

8
.gitignore vendored
View File

@@ -7,8 +7,16 @@
.idea/
.vscode/
**/*.g.dart
**/*.gr.dart
**/*.freezed.dart
**/*.cherrypick_injectable.g.dart
pubspec_overrides.yaml
melos_cherrypick.iml
melos_cherrypick_workspace.iml
melos_cherrypick_flutter.iml
coverage

View File

@@ -3,6 +3,325 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
## 2025-08-04
### Changes
---
Packages with breaking changes:
- [`cherrypick` - `v3.0.0-dev.2`](#cherrypick---v300-dev2)
Packages with other changes:
- [`cherrypick_flutter` - `v1.1.3-dev.2`](#cherrypick_flutter---v113-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.3-dev.2`
---
#### `cherrypick` - `v3.0.0-dev.2`
- **FEAT**(binding): add deprecated proxy async methods for backward compatibility and highlight transition to modern API.
- **DOCS**: add quick guide for circular dependency detection to README.
- **DOCS**: add quick guide for circular dependency detection to README.
- **BREAKING** **FEAT**: implement comprehensive circular dependency detection system.
- **BREAKING** **FEAT**: implement comprehensive circular dependency detection system.
## 2025-07-30
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`cherrypick` - `v3.0.0-dev.1`](#cherrypick---v300-dev1)
- [`cherrypick_flutter` - `v1.1.3-dev.1`](#cherrypick_flutter---v113-dev1)
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.3-dev.1`
---
#### `cherrypick` - `v3.0.0-dev.1`
- **DOCS**: add quick guide for circular dependency detection to README.
## 2025-07-30
### Changes
---
Packages with breaking changes:
- [`cherrypick` - `v3.0.0-dev.0`](#cherrypick---v300-dev0)
Packages with other changes:
- [`cherrypick_flutter` - `v1.1.3-dev.0`](#cherrypick_flutter---v113-dev0)
---
#### `cherrypick` - `v3.0.0-dev.0`
- **BREAKING** **FEAT**: implement comprehensive circular dependency detection system.
#### `cherrypick_flutter` - `v1.1.3-dev.0`
- **FIX**: update deps.
## 2025-07-28
### Changes
---
Packages with breaking changes:
- [`cherrypick_flutter` - `v1.1.2`](#cherrypick_flutter---v112)
Packages with other changes:
- [`cherrypick` - `v2.2.0`](#cherrypick---v220)
- [`cherrypick_annotations` - `v1.1.0`](#cherrypick_annotations---v110)
- [`cherrypick_generator` - `v1.1.0`](#cherrypick_generator---v110)
Packages graduated to a stable release (see pre-releases prior to the stable version for changelog entries):
- `cherrypick` - `v2.2.0`
- `cherrypick_annotations` - `v1.1.0`
- `cherrypick_flutter` - `v1.1.2`
- `cherrypick_generator` - `v1.1.0`
---
#### `cherrypick_flutter` - `v1.1.2`
#### `cherrypick` - `v2.2.0`
#### `cherrypick_annotations` - `v1.1.0`
#### `cherrypick_generator` - `v1.1.0`
## 2025-06-04
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`cherrypick_generator` - `v1.1.0-dev.5`](#cherrypick_generator---v110-dev5)
---
#### `cherrypick_generator` - `v1.1.0-dev.5`
- **FEAT**: implement tryResolve via generate code.
## 2025-05-28
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`cherrypick_generator` - `v1.1.0-dev.4`](#cherrypick_generator---v110-dev4)
---
#### `cherrypick_generator` - `v1.1.0-dev.4`
- **FIX**: fixed warnings.
## 2025-05-23
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`cherrypick_annotations` - `v1.1.0-dev.1`](#cherrypick_annotations---v110-dev1)
- [`cherrypick_generator` - `v1.1.0-dev.3`](#cherrypick_generator---v110-dev3)
---
#### `cherrypick_annotations` - `v1.1.0-dev.1`
- **FEAT**: implement InjectGenerator.
#### `cherrypick_generator` - `v1.1.0-dev.3`
- **FEAT**: implement InjectGenerator.
## 2025-05-23
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`cherrypick_generator` - `v1.1.0-dev.2`](#cherrypick_generator---v110-dev2)
---
#### `cherrypick_generator` - `v1.1.0-dev.2`
- **FIX**: update instance generator code.
## 2025-05-22
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`cherrypick` - `v2.2.0-dev.1`](#cherrypick---v220-dev1)
- [`cherrypick_generator` - `v1.1.0-dev.1`](#cherrypick_generator---v110-dev1)
- [`cherrypick_flutter` - `v1.1.2-dev.1`](#cherrypick_flutter---v112-dev1)
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.1`
---
#### `cherrypick` - `v2.2.0-dev.1`
- **FIX**: fix warnings.
#### `cherrypick_generator` - `v1.1.0-dev.1`
- **FIX**: optimize code.
## 2025-05-22
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`cherrypick` - `v2.2.0-dev.0`](#cherrypick---v220-dev0)
- [`cherrypick_annotations` - `v1.1.0-dev.0`](#cherrypick_annotations---v110-dev0)
- [`cherrypick_flutter` - `v1.1.2-dev.0`](#cherrypick_flutter---v112-dev0)
- [`cherrypick_generator` - `v1.1.0-dev.0`](#cherrypick_generator---v110-dev0)
---
#### `cherrypick` - `v2.2.0-dev.0`
- **FEAT**: Add async dependency resolution and enhance example.
- **FEAT**: implement toInstanceAync binding.
#### `cherrypick_annotations` - `v1.1.0-dev.0`
- **FEAT**: implement generator for dynamic params.
- **FEAT**: implement instance/provide annotations.
- **FEAT**: implement generator for named annotation.
- **FEAT**: implement generator di module.
- **FEAT**: implement annotations.
#### `cherrypick_flutter` - `v1.1.2-dev.0`
- **FIX**: fix warning.
- **FIX**: fix warnings.
#### `cherrypick_generator` - `v1.1.0-dev.0`
- **FIX**: fix warning conflict with names.
- **FIX**: fix warnings.
- **FIX**: fix module generator.
- **FIX**: fix generator for singletone annotation.
- **FEAT**: implement generator for dynamic params.
- **FEAT**: implement async mode for instance/provide annotations.
- **FEAT**: generate instance async code.
- **FEAT**: implement instance/provide annotations.
- **FEAT**: implement named dependency.
- **FEAT**: implement generator for named annotation.
- **FEAT**: implement generator di module.
- **FEAT**: implement annotations.
## 2025-05-19
### Changes
---
Packages with breaking changes:
- [`cherrypick_flutter` - `v1.1.1`](#cherrypick_flutter---v111)
Packages with other changes:
- [`cherrypick` - `v2.1.0`](#cherrypick---v210)
Packages graduated to a stable release (see pre-releases prior to the stable version for changelog entries):
- `cherrypick` - `v2.1.0`
- `cherrypick_flutter` - `v1.1.1`
---
#### `cherrypick_flutter` - `v1.1.1`
#### `cherrypick` - `v2.1.0`
## 2025-05-16
### Changes

4
CONTRIBUTORS.md Normal file
View File

@@ -0,0 +1,4 @@
# Contributors
- Sergey Penkovsky <sergey.penkovsky@gmail.com>
- Klim Yaroshevich <yarashevich_kv@st.by>

171
README.md
View File

@@ -1,100 +1,145 @@
# CherryPick Workspace
Welcome to the CherryPick Workspace, a comprehensive suite for dependency management in Flutter applications. It consists of the `cherrypick` and `cherrypick_flutter` packages, designed to enhance modularity and testability by providing robust dependency and state management tools.
CherryPick Workspace is a modular, open-source dependency injection ecosystem for Dart and Flutter, designed to offer lightweight, flexible, and scalable DI suitable for both backend and frontend (Flutter) development. This monorepo contains the main DI runtime library, annotation helpers, code generation for modular bindings, and seamless Flutter integration.
## Overview
---
- **`cherrypick`**: A Dart library offering core tools for dependency injection and management through modules and scopes.
- **`cherrypick_flutter`**: A Flutter-specific library facilitating access to the root scope via the context using `CherryPickProvider`, simplifying state management within the widget tree.
## Packages Overview
## Repository Structure
- **[`cherrypick`](./cherrypick)**
The core dependency injection library. Supports modular bindings, hierarchical scopes, named and singleton bindings, provider functions (sync/async), runtime parameters, and test-friendly composition.
_Intended for use in pure Dart and Flutter projects._
- **Packages**:
- `cherrypick`: Core DI functionalities.
- `cherrypick_flutter`: Flutter integration for context-based root scope access.
- **[`cherrypick_annotations`](./cherrypick_annotations)**
A set of Dart annotations (`@module`, `@singleton`, `@instance`, `@provide`, `@named`, `@params`) enabling concise, declarative DI modules and providers, primarily for use with code generation tools.
## Quick Start Guide
- **[`cherrypick_generator`](./cherrypick_generator)**
A [source_gen](https://pub.dev/packages/source_gen)-based code generator that automatically converts your annotated modules and providers into ready-to-use boilerplate for registration and resolution within your app.
_Reduces manual wiring and errors; compatible with build_runner._
### Installation
- **[`cherrypick_flutter`](./cherrypick_flutter)**
Adds Flutter-native integration, exposing DI scopes and modules to the widget tree through `CherryPickProvider` and enabling dependency management throughout your Flutter app.
To add the packages to your project, include the dependencies in your `pubspec.yaml`:
---
## Why CherryPick?
- **Zero-overhead and intuitive API:**
Clean, minimal syntax, strong typing, powerful binding lifecycle control.
- **High testability:**
Supports overriding and hierarchical scope trees.
- **Both Sync & Async support:**
Register and resolve async providers, factories, and dependencies.
- **Seamless code generation:**
Effortless setup with annotations + generator—skip boilerplate!
- **Works with or without Flutter.**
- **Production ready:**
Robust enough for apps, packages, and server-side Dart.
- **Extensible & Modular:**
Add bindings at runtime, use sub-modules, or integrate via codegen.
---
## Get Started
### 1. Add dependencies
In your `pubspec.yaml`:
```yaml
dependencies:
cherrypick: any
cherrypick_flutter: any
cherrypick: ^<latest-version>
cherrypick_annotations: ^<latest-version>
dev_dependencies:
build_runner: ^<latest>
cherrypick_generator: ^<latest-version>
```
Run `flutter pub get` to install the dependencies.
For Flutter projects, add:
### Usage
```yaml
dependencies:
cherrypick_flutter: ^<latest-version>
```
#### cherrypick
### 2. Write a DI Module (with annotations)
- **Binding Dependencies**: Use `Binding` to set up dependencies.
```dart
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
import 'package:cherrypick/cherrypick.dart';
```dart
Binding<String>().toInstance("hello world");
Binding<String>().toProvide(() => "hello world").singleton();
```
@module()
abstract class MyModule extends Module {
@singleton()
ApiClient apiClient() => ApiClient();
- **Creating Modules**: Define dependencies within a module.
@provide()
DataRepository dataRepo(ApiClient client) => DataRepository(client);
```dart
class AppModule extends Module {
@override
void builder(Scope currentScope) {
bind<ApiClient>().toInstance(ApiClientMock());
}
}
```
@provide()
String greeting(@params() String name) => 'Hello, $name!';
}
```
- **Managing Scopes**: Control dependency lifecycles with scopes.
### 3. Generate the bindings
```dart
final rootScope = Cherrypick.openRootScope();
rootScope.installModules([AppModule()]);
final apiClient = rootScope.resolve<ApiClient>();
```
```sh
dart run build_runner build
# or for Flutter:
flutter pub run build_runner build
```
#### cherrypick_flutter
The generator will create a `$MyModule` class with binding code.
- **CherryPickProvider**: Wrap your widget tree to access the root scope via context.
### 4. Install and Resolve
```dart
void main() {
runApp(CherryPickProvider(
rootScope: yourRootScopeInstance,
child: MyApp(),
));
}
```
```dart
final scope = CherryPick.openRootScope()
..installModules([$MyModule()]);
- **Accessing Root Scope**: Use `CherryPickProvider.of(context).rootScope` to interact with the root scope in your widgets.
final repo = scope.resolve<DataRepository>();
final greeting = scope.resolve<String>(params: 'John'); // 'Hello, John!'
```
```dart
final rootScope = CherryPickProvider.of(context).rootScope;
```
_For Flutter, wrap your app with `CherryPickProvider` for DI scopes in the widget tree:_
### Example Project
```dart
void main() {
runApp(
CherryPickProvider(child: MyApp()),
);
}
```
Check the `example` directory for a complete demonstration of implementing CherryPick Workspace in a Flutter app.
---
## Features
## Features at a Glance
- [x] Dependency Binding and Resolution
- [x] Custom Module Creation
- [x] Root and Sub-Scopes
- [x] Convenient Root Scope Access in Flutter
-**Fast, lightweight DI** for any Dart/Flutter project
- 🧩 **Modular & hierarchical scopes** (root, subscopes)
- 🔖 **Named/bound/singleton instances** out of the box
- 🔄 **Sync and async provider support**
- ✏️ **Runtime parameters for dynamic factory methods**
- 🏷️ **Code generator** for annotation-based DI setup (`cherrypick_generator`)
- 🕹️ **Deep Flutter integration** via `CherryPickProvider`
## Contributing
---
We welcome contributions from the community. Feel free to open issues or submit pull requests with suggestions and enhancements.
## Example Usage
## License
Please see:
- [`cherrypick/README.md`](./cherrypick/README.md) for core DI features and examples
- [`cherrypick_flutter/README.md`](./cherrypick_flutter/README.md) for Flutter-specific usage
- [`cherrypick_annotations/README.md`](./cherrypick_annotations/README.md) and [`cherrypick_generator/README.md`](./cherrypick_generator/README.md) for codegen and annotations
This project is licensed under the Apache License 2.0. You may obtain a copy of the License at [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
---
## Links
## Contribution & License
- [GitHub Repository](https://github.com/pese-git/cherrypick)
- **Contributions:** PRs, issues, and feedback are welcome on [GitHub](https://github.com/pese-git/cherrypick).
- **License:** Apache 2.0 for all packages in this workspace.
---
**Happy Cherry Picking! 🍒**

View File

@@ -0,0 +1,42 @@
# benchmark_cherrypick
Benchmarks for performance and features of the cherrypick (core) DI container.
All scenarios use the public API capabilities of cherrypick (scope, module, binding, scoping, and async support).
## Scenarios
- **RegisterAndResolve**: basic registration and resolution of a dependency.
- **ChainSingleton (A->B->C, singleton)**: dependency chain, all as singletons.
- **ChainFactory (A->B->C, factory)**: dependency chain with factory bindings (new instance on each request).
- **NamedResolve (by name)**: resolving a named dependency among multiple implementations.
- **AsyncChain (A->B->C, async)**: asynchronous dependency chain.
- **ScopeOverride (child overrides parent)**: overriding a dependency in a child scope over a parent.
## Benchmark results
| Scenario | RunTime (μs) |
|----------------------------------------------------|---------------|
| RegisterAndResolve | 0.4574 |
| ChainSingleton (A->B->C, singleton) | 0.3759 |
| ChainFactory (A->B->C, factory) | 1.3783 |
| NamedResolve (by name) | 0.5193 |
| AsyncChain (A->B->C, async) | 0.5985 |
| ScopeOverride (child overrides parent) | 0.3611 |
## How to run
1. Get dependencies:
```shell
dart pub get
```
2. Run the benchmarks:
```shell
dart run bin/main.dart
```
A text report with all metrics will be displayed in the console.
---
To add your custom scenario — just create a new Dart file and declare a class extending BenchmarkBase or AsyncBenchmarkBase, then add its invocation to main.dart.

View File

@@ -0,0 +1,42 @@
# benchmark_cherrypick
Бенчмарки производительности и функциональности DI-контейнера cherrypick (core).
Все сценарии используют реальные возможности public API cherrypick (scope, module, binding, scoping и асинхронность).
## Сценарии
- **RegisterAndResolve**: базовая операция регистрации и разрешения зависимости.
- **ChainSingleton (A->B->C, singleton)**: цепочка зависимостей, все singletons.
- **ChainFactory (A->B->C, factory)**: цепочка зависимостей с factory биндингами, новые объекты на каждый запрос.
- **NamedResolve (by name)**: разрешение именованной зависимости среди нескольких реализаций.
- **AsyncChain (A->B->C, async)**: асинхронная цепочка зависимостей.
- **ScopeOverride (child overrides parent)**: переопределение зависимости в дочернем scope над родительским.
## Результаты исследования
| Сценарий | RunTime (мкс) |
|----------------------------------------------------|--------------|
| RegisterAndResolve | 0.4574 |
| ChainSingleton (A->B->C, singleton) | 0.3759 |
| ChainFactory (A->B->C, factory) | 1.3783 |
| NamedResolve (by name) | 0.5193 |
| AsyncChain (A->B->C, async) | 0.5985 |
| ScopeOverride (child overrides parent) | 0.3611 |
## Как запускать
1. Получить зависимости:
```shell
dart pub get
```
2. Запустить бенчмарк:
```shell
dart run bin/main.dart
```
Будет показан текстовый отчёт по всем метрикам.
---
Если хотите добавить свой сценарий — создайте отдельный Dart-файл и объявите новый BenchmarkBase/AsyncBenchmarkBase, не забудьте вставить его вызов в main.

View File

@@ -0,0 +1,33 @@
# This file configures the static analysis results for your project (errors,
# warnings, and lints).
#
# This enables the 'recommended' set of lints from `package:lints`.
# This set helps identify many issues that may lead to problems when running
# or consuming Dart code, and enforces writing Dart using a single, idiomatic
# style and format.
#
# If you want a smaller set of lints you can change this to specify
# 'package:lints/core.yaml'. These are just the most critical lints
# (the recommended set includes the core lints).
# The core lints are also what is used by pub.dev for scoring packages.
include: package:lints/recommended.yaml
analyzer:
errors:
deprecated_member_use: ignore
# Uncomment the following section to specify additional rules.
# linter:
# rules:
# - camel_case_types
# analyzer:
# exclude:
# - path/to/excluded/files/**
# For more information about the core and recommended set of lints, see
# https://dart.dev/go/core-lints
# For additional information about configuring this file, see
# https://dart.dev/guides/language/analysis-options

View File

@@ -0,0 +1,17 @@
import 'package:benchmark_cherrypick/cherrypick_benchmark.dart';
import 'package:benchmark_cherrypick/complex_bindings_benchmark.dart';
import 'package:benchmark_cherrypick/async_chain_benchmark.dart';
import 'package:benchmark_cherrypick/scope_override_benchmark.dart';
void main(List<String> args) async {
// Синхронные бенчмарки
RegisterAndResolveBenchmark().report();
ChainSingletonBenchmark().report();
ChainFactoryBenchmark().report();
NamedResolveBenchmark().report();
// Асинхронный бенчмарк
await AsyncChainBenchmark().report();
ScopeOverrideBenchmark().report();
}

View File

@@ -0,0 +1,43 @@
// ignore: depend_on_referenced_packages
import 'package:benchmark_harness/benchmark_harness.dart';
import 'package:cherrypick/cherrypick.dart';
class AsyncA {}
class AsyncB {
final AsyncA a;
AsyncB(this.a);
}
class AsyncC {
final AsyncB b;
AsyncC(this.b);
}
class AsyncChainModule extends Module {
@override
void builder(Scope currentScope) {
bind<AsyncA>().toProvideAsync(() async => AsyncA()).singleton();
bind<AsyncB>().toProvideAsync(() async => AsyncB(await currentScope.resolveAsync<AsyncA>())).singleton();
bind<AsyncC>().toProvideAsync(() async => AsyncC(await currentScope.resolveAsync<AsyncB>())).singleton();
}
}
class AsyncChainBenchmark extends AsyncBenchmarkBase {
AsyncChainBenchmark() : super('AsyncChain (A->B->C, async)');
late Scope scope;
@override
Future<void> setup() async {
CherryPick.disableGlobalCycleDetection();
CherryPick.disableGlobalCrossScopeCycleDetection();
scope = CherryPick.openRootScope();
scope.installModules([AsyncChainModule()]);
}
@override
Future<void> teardown() async {
CherryPick.closeRootScope();
}
@override
Future<void> run() async {
await scope.resolveAsync<AsyncC>();
}
}

View File

@@ -0,0 +1,40 @@
// ignore: depend_on_referenced_packages
import 'package:benchmark_harness/benchmark_harness.dart';
import 'package:cherrypick/cherrypick.dart';
class AppModule extends Module {
@override
void builder(Scope currentScope) {
bind<FooService>().toProvide(() => FooService());
}
}
// Dummy service for DI
class FooService {}
class RegisterAndResolveBenchmark extends BenchmarkBase {
RegisterAndResolveBenchmark() : super('RegisterAndResolve');
late final Scope scope;
@override
void setup() {
CherryPick.disableGlobalCycleDetection();
CherryPick.disableGlobalCrossScopeCycleDetection();
scope = CherryPick.openRootScope();
scope.installModules([AppModule()]);
}
@override
void run() {
scope.resolve<FooService>();
}
@override
void teardown() => CherryPick.closeRootScope();
}
void main() {
RegisterAndResolveBenchmark().report();
}

View File

@@ -0,0 +1,95 @@
// ignore: depend_on_referenced_packages
import 'package:benchmark_harness/benchmark_harness.dart';
import 'package:cherrypick/cherrypick.dart';
// === DI graph: A -> B -> C (singleton) ===
class ServiceA {}
class ServiceB {
final ServiceA a;
ServiceB(this.a);
}
class ServiceC {
final ServiceB b;
ServiceC(this.b);
}
class ChainSingletonModule extends Module {
@override
void builder(Scope currentScope) {
bind<ServiceA>().toProvide(() => ServiceA()).singleton();
bind<ServiceB>().toProvide((() => ServiceB(currentScope.resolve<ServiceA>()))).singleton();
bind<ServiceC>().toProvide((() => ServiceC(currentScope.resolve<ServiceB>()))).singleton();
}
}
class ChainSingletonBenchmark extends BenchmarkBase {
ChainSingletonBenchmark() : super('ChainSingleton (A->B->C, singleton)');
late Scope scope;
@override
void setup() {
scope = CherryPick.openRootScope();
scope.installModules([ChainSingletonModule()]);
}
@override
void teardown() => CherryPick.closeRootScope();
@override
void run() {
scope.resolve<ServiceC>();
}
}
// === DI graph: A -> B -> C (factory/no singleton) ===
class ChainFactoryModule extends Module {
@override
void builder(Scope currentScope) {
bind<ServiceA>().toProvide(() => ServiceA());
bind<ServiceB>().toProvide((() => ServiceB(currentScope.resolve<ServiceA>())));
bind<ServiceC>().toProvide((() => ServiceC(currentScope.resolve<ServiceB>())));
}
}
class ChainFactoryBenchmark extends BenchmarkBase {
ChainFactoryBenchmark() : super('ChainFactory (A->B->C, factory)');
late Scope scope;
@override
void setup() {
CherryPick.disableGlobalCycleDetection();
CherryPick.disableGlobalCrossScopeCycleDetection();
scope = CherryPick.openRootScope();
scope.installModules([ChainFactoryModule()]);
}
@override
void teardown() => CherryPick.closeRootScope();
@override
void run() {
scope.resolve<ServiceC>();
}
}
// === Named bindings: Multiple implementations ===
class Impl1 {}
class Impl2 {}
class NamedModule extends Module {
@override
void builder(Scope currentScope) {
bind<Object>().toProvide(() => Impl1()).withName('impl1');
bind<Object>().toProvide(() => Impl2()).withName('impl2');
}
}
class NamedResolveBenchmark extends BenchmarkBase {
NamedResolveBenchmark() : super('NamedResolve (by name)');
late Scope scope;
@override
void setup() {
scope = CherryPick.openRootScope();
scope.installModules([NamedModule()]);
}
@override
void teardown() => CherryPick.closeRootScope();
@override
void run() {
// Switch name for comparison
scope.resolve<Object>(named: 'impl2');
}
}

View File

@@ -0,0 +1,46 @@
// ignore: depend_on_referenced_packages
import 'package:benchmark_harness/benchmark_harness.dart';
import 'package:cherrypick/cherrypick.dart';
class Shared {}
class ParentImpl extends Shared {}
class ChildImpl extends Shared {}
class ParentModule extends Module {
@override
void builder(Scope currentScope) {
bind<Shared>().toProvide(() => ParentImpl()).singleton();
}
}
class ChildOverrideModule extends Module {
@override
void builder(Scope currentScope) {
bind<Shared>().toProvide(() => ChildImpl()).singleton();
}
}
class ScopeOverrideBenchmark extends BenchmarkBase {
ScopeOverrideBenchmark() : super('ScopeOverride (child overrides parent)');
late Scope parent;
late Scope child;
@override
void setup() {
CherryPick.disableGlobalCycleDetection();
CherryPick.disableGlobalCrossScopeCycleDetection();
parent = CherryPick.openRootScope();
parent.installModules([ParentModule()]);
child = parent.openSubScope('child');
child.installModules([ChildOverrideModule()]);
}
@override
void teardown() {
CherryPick.closeRootScope();
}
@override
void run() {
// Должен возвращать ChildImpl, а не ParentImpl
final resolved = child.resolve<Shared>();
assert(resolved is ChildImpl);
}
}

View File

@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="WEB_MODULE" version="4">
<component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$">
<sourceFolder url="file://$MODULE_DIR$" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
<excludeFolder url="file://$MODULE_DIR$/.dart_tool" />
<excludeFolder url="file://$MODULE_DIR$/.pub" />
<excludeFolder url="file://$MODULE_DIR$/build" />
</content>
<orderEntry type="sourceFolder" forTests="false" />
<orderEntry type="library" name="Dart SDK" level="project" />
<orderEntry type="library" name="Dart Packages" level="project" />
</component>
</module>

View File

@@ -0,0 +1,68 @@
# Generated by pub
# See https://dart.dev/tools/pub/glossary#lockfile
packages:
ansi_modifier:
dependency: transitive
description:
name: ansi_modifier
sha256: "4b97c241f345e49c929bd56d0198b567b7dfcca7ec8d4f798745c9ced998684c"
url: "https://pub.dev"
source: hosted
version: "0.1.4"
benchmark_harness:
dependency: "direct dev"
description:
name: benchmark_harness
sha256: "83f65107165883ba8623eb822daacb23dcf9f795c66841de758c9dd7c5a0cf28"
url: "https://pub.dev"
source: hosted
version: "2.3.1"
benchmark_runner:
dependency: "direct dev"
description:
name: benchmark_runner
sha256: "7de181228eb74cb34507ded2260fe88b3b71e0aacfe0dfa794df49edaf041ca3"
url: "https://pub.dev"
source: hosted
version: "0.0.4"
cherrypick:
dependency: "direct main"
description:
path: "../cherrypick"
relative: true
source: path
version: "3.0.0-dev.1"
exception_templates:
dependency: transitive
description:
name: exception_templates
sha256: "517f7c770da690073663f867ee2057ae2f4ffb28edae9da9faa624aa29ac76eb"
url: "https://pub.dev"
source: hosted
version: "0.3.1"
lazy_memo:
dependency: transitive
description:
name: lazy_memo
sha256: dcb30b4184a6d767e1d779d74ce784d752d38313b8fb4bad6b659ae7af4bb34d
url: "https://pub.dev"
source: hosted
version: "0.2.3"
lints:
dependency: "direct dev"
description:
name: lints
sha256: c35bb79562d980e9a453fc715854e1ed39e24e7d0297a880ef54e17f9874a9d7
url: "https://pub.dev"
source: hosted
version: "5.1.1"
meta:
dependency: transitive
description:
name: meta
sha256: "23f08335362185a5ea2ad3a4e597f1375e78bce8a040df5c600c8d3552ef2394"
url: "https://pub.dev"
source: hosted
version: "1.17.0"
sdks:
dart: ">=3.6.0 <4.0.0"

View File

@@ -0,0 +1,16 @@
name: benchmark_cherrypick
version: 0.1.0
publish_to: none
description: Benchmark for cherrypick core DI library
environment:
sdk: '>=3.0.0 <4.0.0'
dependencies:
cherrypick:
path: ../cherrypick
dev_dependencies:
lints: ^5.0.0
benchmark_harness: ^2.2.2
benchmark_runner: ^0.0.2

View File

@@ -22,3 +22,5 @@ doc/api/
# FVM Version Cache
.fvm/
pubspec_overrides.yaml

View File

@@ -1,3 +1,40 @@
## 3.0.0-dev.2
> Note: This release has breaking changes.
- **FEAT**(binding): add deprecated proxy async methods for backward compatibility and highlight transition to modern API.
- **DOCS**: add quick guide for circular dependency detection to README.
- **DOCS**: add quick guide for circular dependency detection to README.
- **BREAKING** **FEAT**: implement comprehensive circular dependency detection system.
- **BREAKING** **FEAT**: implement comprehensive circular dependency detection system.
## 3.0.0-dev.1
- **DOCS**: add quick guide for circular dependency detection to README.
## 3.0.0-dev.0
> Note: This release has breaking changes.
- **BREAKING** **FEAT**: implement comprehensive circular dependency detection system.
## 2.2.0
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
## 2.2.0-dev.1
- **FIX**: fix warnings.
## 2.2.0-dev.0
- **FEAT**: Add async dependency resolution and enhance example.
- **FEAT**: implement toInstanceAync binding.
## 2.1.0
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
## 2.1.0-dev.1
- **FIX**: fix warnings.

View File

@@ -1,89 +1,114 @@
# CherryPick Flutter
# CherryPick
`cherrypick_flutter` is a robust Flutter library designed for managing and accessing dependencies using a scope context provided by `CherryPickProvider`. It enhances your application's modularity and testability by simplifying dependency injection.
`cherrypick` is a flexible and lightweight dependency injection library for Dart and Flutter. It provides an easy-to-use system for registering, scoping, and resolving dependencies using modular bindings and hierarchical scopes. The design enables cleaner architecture, testability, and modular code in your applications.
## Quick Start
## Key Concepts
### Core Components of Dependency Injection (DI)
### Binding
#### Binding
A **Binding** acts as a configuration for how to create or provide a particular dependency. Bindings support:
A Binding is a custom instance configurator crucial for setting up dependencies. It offers the following key methods:
- Direct instance assignment (`toInstance()`, `toInstanceAsync()`)
- Lazy providers (sync/async functions)
- Provider functions supporting dynamic parameters
- Named instances for resolving by string key
- Optional singleton lifecycle
- `toInstance()`: Directly provides an initialized instance.
- `toProvide()`: Accepts a provider function for lazy initialization.
- `toProvideAsync()`: Accepts an asynchronous provider for lazy initialization.
- `toProvideWithParams()`: Accepts a provider function requiring dynamic parameters.
- `toProvideAsyncWithParams()`: Accepts an asynchronous provider requiring dynamic parameters.
- `withName()`: Assigns a name for instance retrieval by name.
- `singleton()`: Marks the instance as a singleton, ensuring only one instance exists within the scope.
##### Example:
#### Example
```dart
// Direct instance initialization using toInstance()
Binding<String>().toInstance("hello world");
// Provide a direct instance
Binding<String>().toInstance("Hello world");
// Lazy initialization via provider
Binding<String>().toProvide(() => "hello world");
// Provide an async direct instance
Binding<String>().toInstanceAsync(Future.value("Hello world"));
// Asynchronous lazy initialization
Binding<String>().toProvideAsync(() async => "hello async world");
// Provide a lazy sync instance using a factory
Binding<String>().toProvide(() => "Hello world");
/ Asynchronous lazy initialization with dynamic parameters
Binding<String>().toProvideAsyncWithParams((params) async => "hello $params");
// Provide a lazy async instance using a factory
Binding<String>().toProvideAsync(() async => "Hello async world");
// Initialization with dynamic parameters
Binding<String>().toProvideWithParams((params) => "hello $params");
// Provide an instance with dynamic parameters (sync)
Binding<String>().toProvideWithParams((params) => "Hello $params");
// Named instance for resolution
Binding<String>().toProvide(() => "hello world").withName("my_string").toInstance("hello world");
// Provide an instance with dynamic parameters (async)
Binding<String>().toProvideAsyncWithParams((params) async => "Hello $params");
// Singleton instance
Binding<String>().toProvide(() => "hello world").singleton();
// Named instance for retrieval by name
Binding<String>().toProvide(() => "Hello world").withName("my_string");
// Mark as singleton (only one instance within the scope)
Binding<String>().toProvide(() => "Hello world").singleton();
```
#### Module
### Module
A Module encapsulates bindings, logically organizing dependencies. Implement the `void builder(Scope currentScope)` method to create a custom module.
A **Module** is a logical collection point for bindings, designed for grouping and initializing related dependencies. Implement the `builder` method to define how dependencies should be bound within the scope.
##### Example:
#### Example
```dart
class AppModule extends Module {
@override
void builder(Scope currentScope) {
bind<ApiClient>().toInstance(ApiClientMock());
bind<String>().toProvide(() => "Hello world!");
}
}
```
#### Scope
### Scope
A Scope manages your dependency tree, holding modules and instances. Use the scope to access dependencies with `resolve<T>()` or `resolveAsync<T>()` for asynchronous operations.
A **Scope** manages a tree of modules and dependency instances. Scopes can be nested into hierarchies (parent-child), supporting modular app composition and context-specific overrides.
##### Example:
You typically work with the root scope, but can also create named subscopes as needed.
#### Example
```dart
// Open the main scope
// Open the main/root scope
final rootScope = CherryPick.openRootScope();
// Install custom modules
// Install a custom module
rootScope.installModules([AppModule()]);
// Resolve an instance
// Resolve a dependency synchronously
final str = rootScope.resolve<String>();
// Asynchronously resolve an instance
final asyncStr = await rootScope.resolveAsync<String>();
// Resolve a dependency asynchronously
final result = await rootScope.resolveAsync<String>();
// Close the main scope
// Close the root scope once done
CherryPick.closeRootScope();
```
#### Working with Subscopes
```dart
// Open a named child scope (e.g., for a feature/module)
final subScope = rootScope.openSubScope('featureScope')
..installModules([FeatureModule()]);
// Resolve from subScope, with fallback to parents if missing
final dataBloc = await subScope.resolveAsync<DataBloc>();
```
### Dependency Lookup API
- `resolve<T>()` — Locates a dependency instance or throws if missing.
- `resolveAsync<T>()` — Async variant for dependencies requiring async binding.
- `tryResolve<T>()` — Returns `null` if not found (sync).
- `tryResolveAsync<T>()` — Returns `null` async if not found.
Supports:
- Synchronous and asynchronous dependencies
- Named dependencies
- Provider functions with and without runtime parameters
## Example Application
The following example demonstrates module setup, scope management, and dependency resolution (both synchronous and asynchronous).
Below is a complete example illustrating modules, subscopes, async providers, and dependency resolution.
```dart
import 'dart:async';
@@ -100,27 +125,28 @@ class AppModule extends Module {
class FeatureModule extends Module {
final bool isMock;
FeatureModule({required this.isMock});
@override
void builder(Scope currentScope) {
// Using toProvideAsync for async initialization
// Async provider for DataRepository with named dependency selection
bind<DataRepository>()
.withName("networkRepo")
.toProvideAsync(() async {
final client = await Future.delayed(
Duration(milliseconds: 100),
() => currentScope.resolve<ApiClient>(
named: isMock ? "apiClientMock" : "apiClientImpl"));
named: isMock ? "apiClientMock" : "apiClientImpl",
),
);
return NetworkDataRepository(client);
})
.singleton();
// Asynchronous initialization of DataBloc
// Chained async provider for DataBloc
bind<DataBloc>().toProvideAsync(
() async {
final repo = await currentScope.resolveAsync<DataRepository>(named: "networkRepo");
final repo = await currentScope.resolveAsync<DataRepository>(
named: "networkRepo");
return DataBloc(repo);
},
);
@@ -128,27 +154,24 @@ class FeatureModule extends Module {
}
void main() async {
final scope = openRootScope().installModules([
AppModule(),
]);
final scope = CherryPick.openRootScope().installModules([AppModule()]);
final featureScope = scope.openSubScope("featureScope")
..installModules([FeatureModule(isMock: true)]);
final subScope = scope
.openSubScope("featureScope")
.installModules([FeatureModule(isMock: true)]);
// Asynchronous instance resolution
final dataBloc = await subScope.resolveAsync<DataBloc>();
dataBloc.data.listen((d) => print('Received data: $d'),
onError: (e) => print('Error: $e'), onDone: () => print('DONE'));
final dataBloc = await featureScope.resolveAsync<DataBloc>();
dataBloc.data.listen(
(d) => print('Received data: $d'),
onError: (e) => print('Error: $e'),
onDone: () => print('DONE'),
);
await dataBloc.fetchData();
}
class DataBloc {
final DataRepository _dataRepository;
Stream<String> get data => _dataController.stream;
StreamController<String> _dataController = StreamController.broadcast();
final StreamController<String> _dataController = StreamController.broadcast();
DataBloc(this._dataRepository);
@@ -172,16 +195,19 @@ abstract class DataRepository {
class NetworkDataRepository implements DataRepository {
final ApiClient _apiClient;
final _token = 'token';
NetworkDataRepository(this._apiClient);
@override
Future<String> getData() async => await _apiClient.sendRequest(
url: 'www.google.com', token: _token, requestBody: {'type': 'data'});
Future<String> getData() async =>
await _apiClient.sendRequest(
url: 'www.google.com',
token: _token,
requestBody: {'type': 'data'},
);
}
abstract class ApiClient {
Future sendRequest({@required String url, String token, Map requestBody});
Future sendRequest({@required String? url, String? token, Map? requestBody});
}
class ApiClientMock implements ApiClient {
@@ -203,18 +229,97 @@ class ApiClientImpl implements ApiClient {
## Features
- [x] Main Scope and Sub Scopes
- [x] Named Instance Initialization
- [x] Asynchronous Dependency Resolution
- [x] Dynamic Parameter Support for Providers
- [x] Main Scope and Named Subscopes
- [x] Named Instance Binding and Resolution
- [x] Asynchronous and Synchronous Providers
- [x] Providers Supporting Runtime Parameters
- [x] Singleton Lifecycle Management
- [x] Modular and Hierarchical Composition
- [x] Null-safe Resolution (tryResolve/tryResolveAsync)
- [x] Circular Dependency Detection (Local and Global)
## Quick Guide: Circular Dependency Detection
CherryPick can detect circular dependencies in your DI configuration, helping you avoid infinite loops and hard-to-debug errors.
**How to use:**
### 1. Enable Cycle Detection for Development
**Local detection (within one scope):**
```dart
final scope = CherryPick.openSafeRootScope(); // Local detection enabled by default
// or, for an existing scope:
scope.enableCycleDetection();
```
**Global detection (across all scopes):**
```dart
CherryPick.enableGlobalCrossScopeCycleDetection();
final rootScope = CherryPick.openGlobalSafeRootScope();
```
### 2. Error Example
If you declare mutually dependent services:
```dart
class A { A(B b); }
class B { B(A a); }
scope.installModules([
Module((bind) {
bind<A>().to((s) => A(s.resolve<B>()));
bind<B>().to((s) => B(s.resolve<A>()));
}),
]);
scope.resolve<A>(); // Throws CircularDependencyException
```
### 3. Typical Usage Pattern
- **Always enable detection** in debug and test environments for maximum safety.
- **Disable detection** in production for performance (after code is tested).
```dart
import 'package:flutter/foundation.dart';
void main() {
if (kDebugMode) {
CherryPick.enableGlobalCycleDetection();
CherryPick.enableGlobalCrossScopeCycleDetection();
}
runApp(MyApp());
}
```
### 4. Handling and Debugging Errors
On detection, `CircularDependencyException` is thrown with a readable dependency chain:
```dart
try {
scope.resolve<MyService>();
} on CircularDependencyException catch (e) {
print('Dependency chain: ${e.dependencyChain}');
}
```
**More details:** See [cycle_detection.en.md](doc/cycle_detection.en.md)
## Documentation
- [Circular Dependency Detection (English)](doc/cycle_detection.en.md)
- [Обнаружение циклических зависимостей (Русский)](doc/cycle_detection.ru.md)
## Contributing
We welcome contributions from the community. Please feel free to submit issues or pull requests with suggestions or improvements.
Contributions are welcome! Please open issues or submit pull requests on [GitHub](https://github.com/pese-git/cherrypick).
## License
This project is licensed under the Apache License 2.0. You may obtain a copy of the License at [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
Licensed under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
---
**Important:** 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 specific language governing permissions and limitations under the License.

View File

@@ -1,5 +1,4 @@
import 'dart:async';
import 'package:meta/meta.dart';
import 'package:cherrypick/cherrypick.dart';
class AppModule extends Module {
@@ -18,29 +17,37 @@ class FeatureModule extends Module {
@override
void builder(Scope currentScope) {
// Using toProvideAsync for async initialization
bind<DataRepository>().withName("networkRepo").toProvideAsync(() async {
bind<DataRepository>()
.withName("networkRepo")
.toProvideWithParams((params) async {
print('REPO PARAMS: $params');
final client = await Future.delayed(
Duration(milliseconds: 100),
Duration(milliseconds: 1000),
() => currentScope.resolve<ApiClient>(
named: isMock ? "apiClientMock" : "apiClientImpl"));
named: isMock ? "apiClientMock" : "apiClientImpl",
),
);
return NetworkDataRepository(client);
}).singleton();
// Asynchronous initialization of DataBloc
bind<DataBloc>().toProvideAsync(
bind<DataBloc>().toProvide(
() async {
final repo = await currentScope.resolveAsync<DataRepository>(
named: "networkRepo");
named: "networkRepo",
params: 'Some params',
);
return DataBloc(repo);
},
);
}
}
void main() async {
final scope = openRootScope().installModules([
AppModule(),
]);
Future<void> main() async {
try {
final scope = openRootScope().installModules([AppModule()]);
final subScope = scope
.openSubScope("featureScope")
@@ -48,17 +55,23 @@ void main() async {
// Asynchronous instance resolution
final dataBloc = await subScope.resolveAsync<DataBloc>();
dataBloc.data.listen((d) => print('Received data: $d'),
onError: (e) => print('Error: $e'), onDone: () => print('DONE'));
dataBloc.data.listen(
(d) => print('Received data: $d'),
onError: (e) => print('Error: $e'),
onDone: () => print('DONE'),
);
await dataBloc.fetchData();
} catch (e) {
print('Error resolving dependency: $e');
}
}
class DataBloc {
final DataRepository _dataRepository;
Stream<String> get data => _dataController.stream;
final StreamController<String> _dataController = StreamController.broadcast();
Stream<String> get data => _dataController.stream;
DataBloc(this._dataRepository);
@@ -91,21 +104,19 @@ class NetworkDataRepository implements DataRepository {
}
abstract class ApiClient {
Future sendRequest({@required String url, String token, Map requestBody});
Future sendRequest({String url, String token, Map requestBody});
}
class ApiClientMock implements ApiClient {
@override
Future sendRequest(
{@required String? url, String? token, Map? requestBody}) async {
Future sendRequest({String? url, String? token, Map? requestBody}) async {
return 'Local Data';
}
}
class ApiClientImpl implements ApiClient {
@override
Future sendRequest(
{@required String? url, String? token, Map? requestBody}) async {
Future sendRequest({String? url, String? token, Map? requestBody}) async {
return 'Network data';
}
}

View File

@@ -0,0 +1,230 @@
import 'package:cherrypick/cherrypick.dart';
// Пример сервисов для демонстрации
class DatabaseService {
void connect() => print('🔌 Connecting to database');
}
class ApiService {
final DatabaseService database;
ApiService(this.database);
void fetchData() {
database.connect();
print('📡 Fetching data via API');
}
}
class UserService {
final ApiService apiService;
UserService(this.apiService);
void getUser(String id) {
apiService.fetchData();
print('👤 Fetching user: $id');
}
}
// Модули для различных feature
class DatabaseModule extends Module {
@override
void builder(Scope currentScope) {
bind<DatabaseService>().singleton().toProvide(() => DatabaseService());
}
}
class ApiModule extends Module {
@override
void builder(Scope currentScope) {
bind<ApiService>().toProvide(() => ApiService(
currentScope.resolve<DatabaseService>()
));
}
}
class UserModule extends Module {
@override
void builder(Scope currentScope) {
bind<UserService>().toProvide(() => UserService(
currentScope.resolve<ApiService>()
));
}
}
// Пример циклических зависимостей для демонстрации обнаружения
class CircularServiceA {
final CircularServiceB serviceB;
CircularServiceA(this.serviceB);
}
class CircularServiceB {
final CircularServiceA serviceA;
CircularServiceB(this.serviceA);
}
class CircularModuleA extends Module {
@override
void builder(Scope currentScope) {
bind<CircularServiceA>().toProvide(() => CircularServiceA(
currentScope.resolve<CircularServiceB>()
));
}
}
class CircularModuleB extends Module {
@override
void builder(Scope currentScope) {
bind<CircularServiceB>().toProvide(() => CircularServiceB(
currentScope.resolve<CircularServiceA>()
));
}
}
void main() {
print('=== Improved CherryPick Helper Demonstration ===\n');
// Example 1: Global enabling of cycle detection
print('1. Globally enable cycle detection:');
CherryPick.enableGlobalCycleDetection();
print('✅ Global cycle detection enabled: ${CherryPick.isGlobalCycleDetectionEnabled}');
// All new scopes will automatically have cycle detection enabled
final globalScope = CherryPick.openRootScope();
print('✅ Root scope has cycle detection enabled: ${globalScope.isCycleDetectionEnabled}');
// Install modules without circular dependencies
globalScope.installModules([
DatabaseModule(),
ApiModule(),
UserModule(),
]);
final userService = globalScope.resolve<UserService>();
userService.getUser('user123');
print('');
// Example 2: Safe scope creation
print('2. Creating safe scopes:');
CherryPick.closeRootScope(); // Закрываем предыдущий скоуп
CherryPick.disableGlobalCycleDetection(); // Отключаем глобальную настройку
// Создаем безопасный скоуп (с автоматически включенным обнаружением)
final safeScope = CherryPick.openSafeRootScope();
print('✅ Safe scope created with cycle detection: ${safeScope.isCycleDetectionEnabled}');
safeScope.installModules([
DatabaseModule(),
ApiModule(),
UserModule(),
]);
final safeUserService = safeScope.resolve<UserService>();
safeUserService.getUser('safe_user456');
print('');
// Example 3: Detecting cycles
print('3. Detecting circular dependencies:');
final cyclicScope = CherryPick.openSafeRootScope();
cyclicScope.installModules([
CircularModuleA(),
CircularModuleB(),
]);
try {
cyclicScope.resolve<CircularServiceA>();
print('❌ This should not be executed');
} catch (e) {
if (e is CircularDependencyException) {
print('❌ Circular dependency detected!');
print(' Message: ${e.message}');
print(' Chain: ${e.dependencyChain.join(' -> ')}');
}
}
print('');
// Example 4: Managing detection for specific scopes
print('4. Managing detection for specific scopes:');
CherryPick.closeRootScope();
// Создаем скоуп без обнаружения
// ignore: unused_local_variable
final specificScope = CherryPick.openRootScope();
print(' Detection in root scope: ${CherryPick.isCycleDetectionEnabledForScope()}');
// Включаем обнаружение для конкретного скоупа
CherryPick.enableCycleDetectionForScope();
print('✅ Detection enabled for root scope: ${CherryPick.isCycleDetectionEnabledForScope()}');
// Создаем дочерний скоуп
// ignore: unused_local_variable
final featureScope = CherryPick.openScope(scopeName: 'feature.auth');
print(' Detection in feature.auth scope: ${CherryPick.isCycleDetectionEnabledForScope(scopeName: 'feature.auth')}');
// Включаем обнаружение для дочернего скоупа
CherryPick.enableCycleDetectionForScope(scopeName: 'feature.auth');
print('✅ Detection enabled for feature.auth scope: ${CherryPick.isCycleDetectionEnabledForScope(scopeName: 'feature.auth')}');
print('');
// Example 5: Creating safe child scopes
print('5. Creating safe child scopes:');
final safeFeatureScope = CherryPick.openSafeScope(scopeName: 'feature.payments');
print('✅ Safe feature scope created: ${safeFeatureScope.isCycleDetectionEnabled}');
// You can create a complex hierarchy of scopes
final complexScope = CherryPick.openSafeScope(scopeName: 'app.feature.auth.login');
print('✅ Complex scope created: ${complexScope.isCycleDetectionEnabled}');
print('');
// Example 6: Tracking resolution chains
print('6. Tracking dependency resolution chains:');
final trackingScope = CherryPick.openSafeRootScope();
trackingScope.installModules([
DatabaseModule(),
ApiModule(),
UserModule(),
]);
print(' Chain before resolve: ${CherryPick.getCurrentResolutionChain()}');
// The chain is populated during resolution, but cleared after completion
// ignore: unused_local_variable
final trackedUserService = trackingScope.resolve<UserService>();
print(' Chain after resolve: ${CherryPick.getCurrentResolutionChain()}');
print('');
// Example 7: Usage recommendations
print('7. Recommended usage:');
print('');
print('🔧 Development mode:');
print(' CherryPick.enableGlobalCycleDetection(); // Enable globally');
print(' or');
print(' final scope = CherryPick.openSafeRootScope(); // Safe scope');
print('');
print('🚀 Production mode:');
print(' CherryPick.disableGlobalCycleDetection(); // Disable for performance');
print(' final scope = CherryPick.openRootScope(); // Regular scope');
print('');
print('🧪 Testing:');
print(' setUp(() => CherryPick.enableGlobalCycleDetection());');
print(' tearDown(() => CherryPick.closeRootScope());');
print('');
print('🎯 Feature-specific:');
print(' CherryPick.enableCycleDetectionForScope(scopeName: "feature.critical");');
print(' // Enable only for critical features');
// Cleanup
CherryPick.closeRootScope();
CherryPick.disableGlobalCycleDetection();
print('\n=== Demonstration complete ===');
}

View File

@@ -0,0 +1,197 @@
import 'package:cherrypick/cherrypick.dart';
// Пример сервисов с циклической зависимостью
class UserService {
final OrderService orderService;
UserService(this.orderService);
void createUser(String name) {
print('Creating user: $name');
// Пытаемся получить заказы пользователя, что создает циклическую зависимость
orderService.getOrdersForUser(name);
}
}
class OrderService {
final UserService userService;
OrderService(this.userService);
void getOrdersForUser(String userName) {
print('Getting orders for user: $userName');
// Пытаемся получить информацию о пользователе, что создает циклическую зависимость
userService.createUser(userName);
}
}
// Модули с циклическими зависимостями
class UserModule extends Module {
@override
void builder(Scope currentScope) {
bind<UserService>().toProvide(() => UserService(
currentScope.resolve<OrderService>()
));
}
}
class OrderModule extends Module {
@override
void builder(Scope currentScope) {
bind<OrderService>().toProvide(() => OrderService(
currentScope.resolve<UserService>()
));
}
}
// Правильная реализация без циклических зависимостей
class UserRepository {
void createUser(String name) {
print('Creating user in repository: $name');
}
String getUserInfo(String name) {
return 'User info for: $name';
}
}
class OrderRepository {
void createOrder(String orderId, String userName) {
print('Creating order $orderId for user: $userName');
}
List<String> getOrdersForUser(String userName) {
return ['order1', 'order2', 'order3'];
}
}
class ImprovedUserService {
final UserRepository userRepository;
ImprovedUserService(this.userRepository);
void createUser(String name) {
userRepository.createUser(name);
}
String getUserInfo(String name) {
return userRepository.getUserInfo(name);
}
}
class ImprovedOrderService {
final OrderRepository orderRepository;
final ImprovedUserService userService;
ImprovedOrderService(this.orderRepository, this.userService);
void createOrder(String orderId, String userName) {
// Проверяем, что пользователь существует
final userInfo = userService.getUserInfo(userName);
print('User exists: $userInfo');
orderRepository.createOrder(orderId, userName);
}
List<String> getOrdersForUser(String userName) {
return orderRepository.getOrdersForUser(userName);
}
}
// Правильные модули без циклических зависимостей
class ImprovedUserModule extends Module {
@override
void builder(Scope currentScope) {
bind<UserRepository>().singleton().toProvide(() => UserRepository());
bind<ImprovedUserService>().toProvide(() => ImprovedUserService(
currentScope.resolve<UserRepository>()
));
}
}
class ImprovedOrderModule extends Module {
@override
void builder(Scope currentScope) {
bind<OrderRepository>().singleton().toProvide(() => OrderRepository());
bind<ImprovedOrderService>().toProvide(() => ImprovedOrderService(
currentScope.resolve<OrderRepository>(),
currentScope.resolve<ImprovedUserService>()
));
}
}
void main() {
print('=== Circular Dependency Detection Example ===\n');
// Example 1: Demonstrate circular dependency
print('1. Attempt to create a scope with circular dependencies:');
try {
final scope = Scope(null);
scope.enableCycleDetection(); // Включаем обнаружение циклических зависимостей
scope.installModules([
UserModule(),
OrderModule(),
]);
// Это должно выбросить CircularDependencyException
final userService = scope.resolve<UserService>();
print('UserService created: $userService');
} catch (e) {
print('❌ Circular dependency detected: $e\n');
}
// Example 2: Without circular dependency detection (dangerous!)
print('2. Same code without circular dependency detection:');
try {
final scope = Scope(null);
// НЕ включаем обнаружение циклических зависимостей
scope.installModules([
UserModule(),
OrderModule(),
]);
// Это приведет к StackOverflowError при попытке использования
final userService = scope.resolve<UserService>();
print('UserService создан: $userService');
// Попытка использовать сервис приведет к бесконечной рекурсии
// userService.createUser('John'); // Раскомментируйте для демонстрации StackOverflow
print('⚠️ UserService created, but using it will cause StackOverflow\n');
} catch (e) {
print('❌ Error: $e\n');
}
// Example 3: Correct architecture without circular dependencies
print('3. Correct architecture without circular dependencies:');
try {
final scope = Scope(null);
scope.enableCycleDetection(); // Включаем для безопасности
scope.installModules([
ImprovedUserModule(),
ImprovedOrderModule(),
]);
final userService = scope.resolve<ImprovedUserService>();
final orderService = scope.resolve<ImprovedOrderService>();
print('✅ Services created successfully');
// Демонстрация работы
userService.createUser('John');
orderService.createOrder('ORD-001', 'John');
final orders = orderService.getOrdersForUser('John');
print('✅ Orders for user John: $orders');
} catch (e) {
print('❌ Error: $e');
}
print('\n=== Recommendations ===');
print('1. Always enable circular dependency detection in development mode.');
print('2. Use repositories and services to separate concerns.');
print('3. Avoid mutual dependencies between services at the same level.');
print('4. Use events or mediators to decouple components.');
}

View File

@@ -13,7 +13,10 @@ library;
// limitations under the License.
//
export 'package:cherrypick/src/binding_resolver.dart';
export 'package:cherrypick/src/binding.dart';
export 'package:cherrypick/src/cycle_detector.dart';
export 'package:cherrypick/src/global_cycle_detector.dart';
export 'package:cherrypick/src/helper.dart';
export 'package:cherrypick/src/module.dart';
export 'package:cherrypick/src/scope.dart';

View File

@@ -11,41 +11,21 @@
// limitations under the License.
//
enum Mode { simple, instance, providerInstance, providerInstanceWithParams }
typedef ProviderWithParams<T> = T Function(dynamic params);
typedef AsyncProvider<T> = Future<T> Function();
typedef AsyncProviderWithParams<T> = Future<T> Function(dynamic params);
import 'package:cherrypick/src/binding_resolver.dart';
/// RU: Класс Binding<T> настраивает параметры экземпляра.
/// ENG: The Binding<T> class configures the settings for the instance.
///
class Binding<T> {
late Mode _mode;
late Type _key;
late String _name;
T? _instance;
T? Function()? _provider;
AsyncProvider<T>? asyncProvider;
AsyncProviderWithParams<T>? asyncProviderWithParams;
String? _name;
ProviderWithParams<T>? _providerWithParams;
late bool _isSingleton = false;
late bool _isNamed = false;
BindingResolver<T>? _resolver;
Binding() {
_mode = Mode.simple;
_key = T;
}
/// RU: Метод возвращает [Mode] экземпляра.
/// ENG: The method returns the [Mode] of the instance.
///
/// return [Mode]
Mode get mode => _mode;
/// RU: Метод возвращает тип экземпляра.
/// ENG: The method returns the type of the instance.
///
@@ -56,19 +36,21 @@ class Binding<T> {
/// ENG: The method returns the name of the instance.
///
/// return [String]
String get name => _name;
/// RU: Метод проверяет сингелтон экземпляр или нет.
/// ENG: The method checks the singleton instance or not.
///
/// return [bool]
bool get isSingleton => _isSingleton;
String? get name => _name;
/// RU: Метод проверяет именован экземпляр или нет.
/// ENG: The method checks whether the instance is named or not.
///
/// return [bool]
bool get isNamed => _isNamed;
bool get isNamed => _name != null;
/// RU: Метод проверяет сингелтон экземпляр или нет.
/// ENG: The method checks the singleton instance or not.
///
/// return [bool]
bool get isSingleton => _resolver?.isSingleton ?? false;
BindingResolver<T>? get resolver => _resolver;
/// RU: Добавляет имя для экземляпя [value].
/// ENG: Added name for instance [value].
@@ -76,7 +58,6 @@ class Binding<T> {
/// return [Binding]
Binding<T> withName(String name) {
_name = name;
_isNamed = true;
return this;
}
@@ -84,10 +65,9 @@ class Binding<T> {
/// ENG: Initialization instance [value].
///
/// return [Binding]
Binding<T> toInstance(T value) {
_mode = Mode.instance;
_instance = value;
_isSingleton = true;
Binding<T> toInstance(Instance<T> value) {
_resolver = InstanceResolver<T>(value);
return this;
}
@@ -95,19 +75,9 @@ class Binding<T> {
/// ENG: Initialization instance via provider [value].
///
/// return [Binding]
Binding<T> toProvide(T Function() value) {
_mode = Mode.providerInstance;
_provider = value;
return this;
}
Binding<T> toProvide(Provider<T> value) {
_resolver = ProviderResolver<T>((_) => value.call(), withParams: false);
/// RU: Инициализация экземляпяра  через провайдер [value].
/// ENG: Initialization instance via provider [value].
///
/// return [Binding]
Binding<T> toProvideAsync(AsyncProvider<T> provider) {
_mode = Mode.providerInstance;
asyncProvider = provider;
return this;
}
@@ -116,19 +86,24 @@ class Binding<T> {
///
/// return [Binding]
Binding<T> toProvideWithParams(ProviderWithParams<T> value) {
_mode = Mode.providerInstanceWithParams;
_providerWithParams = value;
_resolver = ProviderResolver<T>(value, withParams: true);
return this;
}
/// RU: Инициализация экземляра через асинхронный провайдер [value] с динамическим параметром.
/// ENG: Initializes the instance via async provider [value] with a dynamic param.
///
/// return [Binding]
Binding<T> toProvideAsyncWithParams(AsyncProviderWithParams<T> provider) {
_mode = Mode.providerInstanceWithParams;
asyncProviderWithParams = provider;
return this;
@Deprecated('Use toInstance instead of toInstanceAsync')
Binding<T> toInstanceAsync(Instance<T> value) {
return this.toInstance(value);
}
@Deprecated('Use toProvide instead of toProvideAsync')
Binding<T> toProvideAsync(Provider<T> value) {
return this.toProvide(value);
}
@Deprecated('Use toProvideWithParams instead of toProvideAsyncWithParams')
Binding<T> toProvideAsyncWithParams(ProviderWithParams<T> value) {
return this.toProvideWithParams(value);
}
/// RU: Инициализация экземляпяра  как сингелтон [value].
@@ -136,34 +111,16 @@ class Binding<T> {
///
/// return [Binding]
Binding<T> singleton() {
_isSingleton = true;
_resolver?.toSingleton();
return this;
}
/// RU: Поиск экземпляра.
/// ENG: Resolve instance.
///
/// return [T]
T? get instance => _instance;
/// RU: Поиск экземпляра.
/// ENG: Resolve instance.
///
/// return [T]
T? get provider {
if (_isSingleton) {
_instance ??= _provider?.call();
return _instance;
}
return _provider?.call();
T? resolveSync([dynamic params]) {
return resolver?.resolveSync(params);
}
/// RU: Поиск экземпляра с параметром.
///
/// ENG: Resolve instance with [params].
///
/// return [T]
T? providerWithParams(dynamic params) {
return _providerWithParams?.call(params);
Future<T>? resolveAsync([dynamic params]) {
return resolver?.resolveAsync(params);
}
}

View File

@@ -0,0 +1,129 @@
import 'dart:async';
typedef Instance<T> = FutureOr<T>;
/// RU: Синхронный или асинхронный провайдер без параметров, возвращающий [T] или [Future<T>].
/// ENG: Synchronous or asynchronous provider without parameters, returning [T] or [Future<T>].
typedef Provider<T> = FutureOr<T> Function();
/// RU: Провайдер с динамическим параметром, возвращающий [T] или [Future<T>] в зависимости от реализации.
/// ENG: Provider with dynamic parameter, returning [T] or [Future<T>] depending on implementation.
typedef ProviderWithParams<T> = FutureOr<T> Function(dynamic);
/// RU: Абстрактный интерфейс для классов, которые разрешают зависимости типа [T].
/// ENG: Abstract interface for classes that resolve dependencies of type [T].
abstract class BindingResolver<T> {
/// RU: Синхронное разрешение зависимости с параметром [params].
/// ENG: Synchronous resolution of the dependency with [params].
T? resolveSync([dynamic params]);
/// RU: Асинхронное разрешение зависимости с параметром [params].
/// ENG: Asynchronous resolution of the dependency with [params].
Future<T>? resolveAsync([dynamic params]);
/// RU: Помечает текущий резолвер как синглтон — результат будет закеширован.
/// ENG: Marks this resolver as singleton — result will be cached.
void toSingleton();
bool get isSingleton;
}
/// RU: Резолвер, оборачивающий конкретный экземпляр [T] (или Future<T>), без вызова провайдера.
/// ENG: Resolver that wraps a concrete instance of [T] (or Future<T>), without provider invocation.
class InstanceResolver<T> implements BindingResolver<T> {
final Instance<T> _instance;
/// RU: Создаёт резолвер, оборачивающий значение [instance].
/// ENG: Creates a resolver that wraps the given [instance].
InstanceResolver(this._instance);
@override
T resolveSync([_]) {
if (_instance is T) return _instance;
throw StateError(
'Instance $_instance is Future; '
'use resolveAsync() instead',
);
}
@override
Future<T> resolveAsync([_]) {
if (_instance is Future<T>) return _instance;
return Future.value(_instance);
}
@override
void toSingleton() {}
@override
bool get isSingleton => true;
}
/// RU: Резолвер, оборачивающий провайдер, с возможностью синглтон-кеширования.
/// ENG: Resolver that wraps a provider, with optional singleton caching.
class ProviderResolver<T> implements BindingResolver<T> {
final ProviderWithParams<T> _provider;
final bool _withParams;
FutureOr<T>? _cache;
bool _singleton = false;
/// RU: Создаёт резолвер из произвольной функции [raw], поддерживающей ноль или один параметр.
/// ENG: Creates a resolver from arbitrary function [raw], supporting zero or one parameter.
ProviderResolver(
ProviderWithParams<T> provider, {
required bool withParams,
}) : _provider = provider,
_withParams = withParams;
@override
T resolveSync([dynamic params]) {
_checkParams(params);
final result = _cache ?? _provider(params);
if (result is T) {
if (_singleton) {
_cache ??= result;
}
return result;
}
throw StateError(
'Provider [$_provider] return Future<$T>. Use resolveAsync() instead.',
);
}
@override
Future<T> resolveAsync([dynamic params]) {
_checkParams(params);
final result = _cache ?? _provider(params);
final target = result is Future<T> ? result : Future<T>.value(result);
if (_singleton) {
_cache ??= target;
}
return target;
}
@override
void toSingleton() {
_singleton = true;
}
@override
bool get isSingleton => _singleton;
/// RU: Проверяет, был ли передан параметр, если провайдер требует его.
/// ENG: Checks if parameter is passed when the provider expects it.
void _checkParams(dynamic params) {
if (_withParams && params == null) {
throw StateError(
'[$T] Params is null. Maybe you forgot to pass it?',
);
}
}
}

View File

@@ -0,0 +1,167 @@
//
// 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 'dart:collection';
/// RU: Исключение, выбрасываемое при обнаружении циклической зависимости.
/// ENG: Exception thrown when a circular dependency is detected.
class CircularDependencyException implements Exception {
final String message;
final List<String> dependencyChain;
const CircularDependencyException(this.message, this.dependencyChain);
@override
String toString() {
final chain = dependencyChain.join(' -> ');
return 'CircularDependencyException: $message\nDependency chain: $chain';
}
}
/// RU: Детектор циклических зависимостей для CherryPick DI контейнера.
/// ENG: Circular dependency detector for CherryPick DI container.
class CycleDetector {
// Стек текущих разрешаемых зависимостей
final Set<String> _resolutionStack = HashSet<String>();
// История разрешения для построения цепочки зависимостей
final List<String> _resolutionHistory = [];
/// RU: Начинает отслеживание разрешения зависимости.
/// ENG: Starts tracking dependency resolution.
///
/// Throws [CircularDependencyException] if circular dependency is detected.
void startResolving<T>({String? named}) {
final dependencyKey = _createDependencyKey<T>(named);
if (_resolutionStack.contains(dependencyKey)) {
// Найдена циклическая зависимость
final cycleStartIndex = _resolutionHistory.indexOf(dependencyKey);
final cycle = _resolutionHistory.sublist(cycleStartIndex)..add(dependencyKey);
throw CircularDependencyException(
'Circular dependency detected for $dependencyKey',
cycle,
);
}
_resolutionStack.add(dependencyKey);
_resolutionHistory.add(dependencyKey);
}
/// RU: Завершает отслеживание разрешения зависимости.
/// ENG: Finishes tracking dependency resolution.
void finishResolving<T>({String? named}) {
final dependencyKey = _createDependencyKey<T>(named);
_resolutionStack.remove(dependencyKey);
// Удаляем из истории только если это последний элемент
if (_resolutionHistory.isNotEmpty &&
_resolutionHistory.last == dependencyKey) {
_resolutionHistory.removeLast();
}
}
/// RU: Очищает все состояние детектора.
/// ENG: Clears all detector state.
void clear() {
_resolutionStack.clear();
_resolutionHistory.clear();
}
/// RU: Проверяет, находится ли зависимость в процессе разрешения.
/// ENG: Checks if dependency is currently being resolved.
bool isResolving<T>({String? named}) {
final dependencyKey = _createDependencyKey<T>(named);
return _resolutionStack.contains(dependencyKey);
}
/// RU: Возвращает текущую цепочку разрешения зависимостей.
/// ENG: Returns current dependency resolution chain.
List<String> get currentResolutionChain => List.unmodifiable(_resolutionHistory);
/// RU: Создает уникальный ключ для зависимости.
/// ENG: Creates unique key for dependency.
String _createDependencyKey<T>(String? named) {
final typeName = T.toString();
return named != null ? '$typeName@$named' : typeName;
}
}
/// RU: Миксин для добавления поддержки обнаружения циклических зависимостей.
/// ENG: Mixin for adding circular dependency detection support.
mixin CycleDetectionMixin {
CycleDetector? _cycleDetector;
/// RU: Включает обнаружение циклических зависимостей.
/// ENG: Enables circular dependency detection.
void enableCycleDetection() {
_cycleDetector = CycleDetector();
}
/// RU: Отключает обнаружение циклических зависимостей.
/// ENG: Disables circular dependency detection.
void disableCycleDetection() {
_cycleDetector?.clear();
_cycleDetector = null;
}
/// RU: Проверяет, включено ли обнаружение циклических зависимостей.
/// ENG: Checks if circular dependency detection is enabled.
bool get isCycleDetectionEnabled => _cycleDetector != null;
/// RU: Выполняет действие с отслеживанием циклических зависимостей.
/// ENG: Executes action with circular dependency tracking.
T withCycleDetection<T>(
Type dependencyType,
String? named,
T Function() action,
) {
if (_cycleDetector == null) {
return action();
}
final dependencyKey = named != null
? '${dependencyType.toString()}@$named'
: dependencyType.toString();
if (_cycleDetector!._resolutionStack.contains(dependencyKey)) {
final cycleStartIndex = _cycleDetector!._resolutionHistory.indexOf(dependencyKey);
final cycle = _cycleDetector!._resolutionHistory.sublist(cycleStartIndex)
..add(dependencyKey);
throw CircularDependencyException(
'Circular dependency detected for $dependencyKey',
cycle,
);
}
_cycleDetector!._resolutionStack.add(dependencyKey);
_cycleDetector!._resolutionHistory.add(dependencyKey);
try {
return action();
} finally {
_cycleDetector!._resolutionStack.remove(dependencyKey);
if (_cycleDetector!._resolutionHistory.isNotEmpty &&
_cycleDetector!._resolutionHistory.last == dependencyKey) {
_cycleDetector!._resolutionHistory.removeLast();
}
}
}
/// RU: Возвращает текущую цепочку разрешения зависимостей.
/// ENG: Returns current dependency resolution chain.
List<String> get currentResolutionChain =>
_cycleDetector?.currentResolutionChain ?? [];
}

View File

@@ -0,0 +1,222 @@
//
// 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 'dart:collection';
import 'package:cherrypick/src/cycle_detector.dart';
/// RU: Глобальный детектор циклических зависимостей для всей иерархии скоупов.
/// ENG: Global circular dependency detector for entire scope hierarchy.
class GlobalCycleDetector {
static GlobalCycleDetector? _instance;
// Глобальный стек разрешения зависимостей
final Set<String> _globalResolutionStack = HashSet<String>();
// История разрешения для построения цепочки зависимостей
final List<String> _globalResolutionHistory = [];
// Карта активных детекторов по скоупам
final Map<String, CycleDetector> _scopeDetectors = HashMap<String, CycleDetector>();
GlobalCycleDetector._internal();
/// RU: Получить единственный экземпляр глобального детектора.
/// ENG: Get singleton instance of global detector.
static GlobalCycleDetector get instance {
_instance ??= GlobalCycleDetector._internal();
return _instance!;
}
/// RU: Сбросить глобальный детектор (полезно для тестов).
/// ENG: Reset global detector (useful for tests).
static void reset() {
_instance?._globalResolutionStack.clear();
_instance?._globalResolutionHistory.clear();
_instance?._scopeDetectors.clear();
_instance = null;
}
/// RU: Начать отслеживание разрешения зависимости в глобальном контексте.
/// ENG: Start tracking dependency resolution in global context.
void startGlobalResolving<T>({String? named, String? scopeId}) {
final dependencyKey = _createDependencyKeyFromType(T, named, scopeId);
if (_globalResolutionStack.contains(dependencyKey)) {
// Найдена глобальная циклическая зависимость
final cycleStartIndex = _globalResolutionHistory.indexOf(dependencyKey);
final cycle = _globalResolutionHistory.sublist(cycleStartIndex)..add(dependencyKey);
throw CircularDependencyException(
'Global circular dependency detected for $dependencyKey',
cycle,
);
}
_globalResolutionStack.add(dependencyKey);
_globalResolutionHistory.add(dependencyKey);
}
/// RU: Завершить отслеживание разрешения зависимости в глобальном контексте.
/// ENG: Finish tracking dependency resolution in global context.
void finishGlobalResolving<T>({String? named, String? scopeId}) {
final dependencyKey = _createDependencyKeyFromType(T, named, scopeId);
_globalResolutionStack.remove(dependencyKey);
// Удаляем из истории только если это последний элемент
if (_globalResolutionHistory.isNotEmpty &&
_globalResolutionHistory.last == dependencyKey) {
_globalResolutionHistory.removeLast();
}
}
/// RU: Выполнить действие с глобальным отслеживанием циклических зависимостей.
/// ENG: Execute action with global circular dependency tracking.
T withGlobalCycleDetection<T>(
Type dependencyType,
String? named,
String? scopeId,
T Function() action,
) {
final dependencyKey = _createDependencyKeyFromType(dependencyType, named, scopeId);
if (_globalResolutionStack.contains(dependencyKey)) {
final cycleStartIndex = _globalResolutionHistory.indexOf(dependencyKey);
final cycle = _globalResolutionHistory.sublist(cycleStartIndex)
..add(dependencyKey);
throw CircularDependencyException(
'Global circular dependency detected for $dependencyKey',
cycle,
);
}
_globalResolutionStack.add(dependencyKey);
_globalResolutionHistory.add(dependencyKey);
try {
return action();
} finally {
_globalResolutionStack.remove(dependencyKey);
if (_globalResolutionHistory.isNotEmpty &&
_globalResolutionHistory.last == dependencyKey) {
_globalResolutionHistory.removeLast();
}
}
}
/// RU: Получить детектор для конкретного скоупа.
/// ENG: Get detector for specific scope.
CycleDetector getScopeDetector(String scopeId) {
return _scopeDetectors.putIfAbsent(scopeId, () => CycleDetector());
}
/// RU: Удалить детектор для скоупа.
/// ENG: Remove detector for scope.
void removeScopeDetector(String scopeId) {
_scopeDetectors.remove(scopeId);
}
/// RU: Проверить, находится ли зависимость в процессе глобального разрешения.
/// ENG: Check if dependency is currently being resolved globally.
bool isGloballyResolving<T>({String? named, String? scopeId}) {
final dependencyKey = _createDependencyKeyFromType(T, named, scopeId);
return _globalResolutionStack.contains(dependencyKey);
}
/// RU: Получить текущую глобальную цепочку разрешения зависимостей.
/// ENG: Get current global dependency resolution chain.
List<String> get globalResolutionChain => List.unmodifiable(_globalResolutionHistory);
/// RU: Очистить все состояние детектора.
/// ENG: Clear all detector state.
void clear() {
_globalResolutionStack.clear();
_globalResolutionHistory.clear();
_scopeDetectors.values.forEach(_detectorClear);
_scopeDetectors.clear();
}
void _detectorClear(detector) => detector.clear();
/// RU: Создать уникальный ключ для зависимости с учетом скоупа.
/// ENG: Create unique key for dependency including scope.
//String _createDependencyKey<T>(String? named, String? scopeId) {
// return _createDependencyKeyFromType(T, named, scopeId);
//}
/// RU: Создать уникальный ключ для зависимости по типу с учетом скоупа.
/// ENG: Create unique key for dependency by type including scope.
String _createDependencyKeyFromType(Type type, String? named, String? scopeId) {
final typeName = type.toString();
final namePrefix = named != null ? '@$named' : '';
final scopePrefix = scopeId != null ? '[$scopeId]' : '';
return '$scopePrefix$typeName$namePrefix';
}
}
/// RU: Улучшенный миксин для глобального обнаружения циклических зависимостей.
/// ENG: Enhanced mixin for global circular dependency detection.
mixin GlobalCycleDetectionMixin {
String? _scopeId;
bool _globalCycleDetectionEnabled = false;
/// RU: Установить идентификатор скоупа для глобального отслеживания.
/// ENG: Set scope identifier for global tracking.
void setScopeId(String scopeId) {
_scopeId = scopeId;
}
/// RU: Получить идентификатор скоупа.
/// ENG: Get scope identifier.
String? get scopeId => _scopeId;
/// RU: Включить глобальное обнаружение циклических зависимостей.
/// ENG: Enable global circular dependency detection.
void enableGlobalCycleDetection() {
_globalCycleDetectionEnabled = true;
}
/// RU: Отключить глобальное обнаружение циклических зависимостей.
/// ENG: Disable global circular dependency detection.
void disableGlobalCycleDetection() {
_globalCycleDetectionEnabled = false;
}
/// RU: Проверить, включено ли глобальное обнаружение циклических зависимостей.
/// ENG: Check if global circular dependency detection is enabled.
bool get isGlobalCycleDetectionEnabled => _globalCycleDetectionEnabled;
/// RU: Выполнить действие с глобальным отслеживанием циклических зависимостей.
/// ENG: Execute action with global circular dependency tracking.
T withGlobalCycleDetection<T>(
Type dependencyType,
String? named,
T Function() action,
) {
if (!_globalCycleDetectionEnabled) {
return action();
}
return GlobalCycleDetector.instance.withGlobalCycleDetection<T>(
dependencyType,
named,
_scopeId,
action,
);
}
/// RU: Получить текущую глобальную цепочку разрешения зависимостей.
/// ENG: Get current global dependency resolution chain.
List<String> get globalResolutionChain =>
GlobalCycleDetector.instance.globalResolutionChain;
}

View File

@@ -11,9 +11,12 @@
// limitations under the License.
//
import 'package:cherrypick/src/scope.dart';
import 'package:cherrypick/src/global_cycle_detector.dart';
import 'package:meta/meta.dart';
Scope? _rootScope;
bool _globalCycleDetectionEnabled = false;
bool _globalCrossScopeCycleDetectionEnabled = false;
class CherryPick {
/// RU: Метод открывает главный [Scope].
@@ -22,6 +25,17 @@ class CherryPick {
/// return
static Scope openRootScope() {
_rootScope ??= Scope(null);
// Применяем глобальную настройку обнаружения циклических зависимостей
if (_globalCycleDetectionEnabled && !_rootScope!.isCycleDetectionEnabled) {
_rootScope!.enableCycleDetection();
}
// Применяем глобальную настройку обнаружения между скоупами
if (_globalCrossScopeCycleDetectionEnabled && !_rootScope!.isGlobalCycleDetectionEnabled) {
_rootScope!.enableGlobalCycleDetection();
}
return _rootScope!;
}
@@ -35,6 +49,150 @@ class CherryPick {
}
}
/// RU: Глобально включает обнаружение циклических зависимостей для всех новых скоупов.
/// ENG: Globally enables circular dependency detection for all new scopes.
///
/// Этот метод влияет на все скоупы, создаваемые через CherryPick.
/// This method affects all scopes created through CherryPick.
///
/// Example:
/// ```dart
/// CherryPick.enableGlobalCycleDetection();
/// final scope = CherryPick.openRootScope(); // Автоматически включено обнаружение
/// ```
static void enableGlobalCycleDetection() {
_globalCycleDetectionEnabled = true;
// Включаем для уже существующего root scope, если он есть
if (_rootScope != null) {
_rootScope!.enableCycleDetection();
}
}
/// RU: Глобально отключает обнаружение циклических зависимостей.
/// ENG: Globally disables circular dependency detection.
///
/// Рекомендуется использовать в production для максимальной производительности.
/// Recommended for production use for maximum performance.
///
/// Example:
/// ```dart
/// CherryPick.disableGlobalCycleDetection();
/// ```
static void disableGlobalCycleDetection() {
_globalCycleDetectionEnabled = false;
// Отключаем для уже существующего root scope, если он есть
if (_rootScope != null) {
_rootScope!.disableCycleDetection();
}
}
/// RU: Проверяет, включено ли глобальное обнаружение циклических зависимостей.
/// ENG: Checks if global circular dependency detection is enabled.
///
/// return true если включено, false если отключено
/// return true if enabled, false if disabled
static bool get isGlobalCycleDetectionEnabled => _globalCycleDetectionEnabled;
/// RU: Включает обнаружение циклических зависимостей для конкретного скоупа.
/// ENG: Enables circular dependency detection for a specific scope.
///
/// [scopeName] - имя скоупа (пустая строка для root scope)
/// [scopeName] - scope name (empty string for root scope)
///
/// Example:
/// ```dart
/// CherryPick.enableCycleDetectionForScope(); // Для root scope
/// CherryPick.enableCycleDetectionForScope(scopeName: 'feature.auth'); // Для конкретного scope
/// ```
static void enableCycleDetectionForScope({String scopeName = '', String separator = '.'}) {
final scope = _getScope(scopeName, separator);
scope.enableCycleDetection();
}
/// RU: Отключает обнаружение циклических зависимостей для конкретного скоупа.
/// ENG: Disables circular dependency detection for a specific scope.
///
/// [scopeName] - имя скоупа (пустая строка для root scope)
/// [scopeName] - scope name (empty string for root scope)
static void disableCycleDetectionForScope({String scopeName = '', String separator = '.'}) {
final scope = _getScope(scopeName, separator);
scope.disableCycleDetection();
}
/// RU: Проверяет, включено ли обнаружение циклических зависимостей для конкретного скоупа.
/// ENG: Checks if circular dependency detection is enabled for a specific scope.
///
/// [scopeName] - имя скоупа (пустая строка для root scope)
/// [scopeName] - scope name (empty string for root scope)
///
/// return true если включено, false если отключено
/// return true if enabled, false if disabled
static bool isCycleDetectionEnabledForScope({String scopeName = '', String separator = '.'}) {
final scope = _getScope(scopeName, separator);
return scope.isCycleDetectionEnabled;
}
/// RU: Возвращает текущую цепочку разрешения зависимостей для конкретного скоупа.
/// ENG: Returns current dependency resolution chain for a specific scope.
///
/// Полезно для отладки и анализа зависимостей.
/// Useful for debugging and dependency analysis.
///
/// [scopeName] - имя скоупа (пустая строка для root scope)
/// [scopeName] - scope name (empty string for root scope)
///
/// return список имен зависимостей в текущей цепочке разрешения
/// return list of dependency names in current resolution chain
static List<String> getCurrentResolutionChain({String scopeName = '', String separator = '.'}) {
final scope = _getScope(scopeName, separator);
return scope.currentResolutionChain;
}
/// RU: Создает новый скоуп с автоматически включенным обнаружением циклических зависимостей.
/// ENG: Creates a new scope with automatically enabled circular dependency detection.
///
/// Удобный метод для создания безопасных скоупов в development режиме.
/// Convenient method for creating safe scopes in development mode.
///
/// Example:
/// ```dart
/// final scope = CherryPick.openSafeRootScope();
/// // Обнаружение циклических зависимостей автоматически включено
/// ```
static Scope openSafeRootScope() {
final scope = openRootScope();
scope.enableCycleDetection();
return scope;
}
/// RU: Создает новый дочерний скоуп с автоматически включенным обнаружением циклических зависимостей.
/// ENG: Creates a new child scope with automatically enabled circular dependency detection.
///
/// [scopeName] - имя скоупа
/// [scopeName] - scope name
///
/// Example:
/// ```dart
/// final scope = CherryPick.openSafeScope(scopeName: 'feature.auth');
/// // Обнаружение циклических зависимостей автоматически включено
/// ```
static Scope openSafeScope({String scopeName = '', String separator = '.'}) {
final scope = openScope(scopeName: scopeName, separator: separator);
scope.enableCycleDetection();
return scope;
}
/// RU: Внутренний метод для получения скоупа по имени.
/// ENG: Internal method to get scope by name.
static Scope _getScope(String scopeName, String separator) {
if (scopeName.isEmpty) {
return openRootScope();
}
return openScope(scopeName: scopeName, separator: separator);
}
/// RU: Метод открывает дочерний [Scope].
/// ENG: The method open the child [Scope].
///
@@ -59,10 +217,22 @@ class CherryPick {
throw Exception('Can not open sub scope because scopeName can not split');
}
return nameParts.fold(
final scope = nameParts.fold(
openRootScope(),
(Scope previousValue, String element) =>
previousValue.openSubScope(element));
// Применяем глобальную настройку обнаружения циклических зависимостей
if (_globalCycleDetectionEnabled && !scope.isCycleDetectionEnabled) {
scope.enableCycleDetection();
}
// Применяем глобальную настройку обнаружения между скоупами
if (_globalCrossScopeCycleDetectionEnabled && !scope.isGlobalCycleDetectionEnabled) {
scope.enableGlobalCycleDetection();
}
return scope;
}
/// RU: Метод открывает дочерний [Scope].
@@ -102,4 +272,106 @@ class CherryPick {
openRootScope().closeSubScope(nameParts[0]);
}
}
/// RU: Глобально включает обнаружение циклических зависимостей между скоупами.
/// ENG: Globally enables cross-scope circular dependency detection.
///
/// Этот режим обнаруживает циклические зависимости во всей иерархии скоупов.
/// This mode detects circular dependencies across the entire scope hierarchy.
///
/// Example:
/// ```dart
/// CherryPick.enableGlobalCrossScopeCycleDetection();
/// ```
static void enableGlobalCrossScopeCycleDetection() {
_globalCrossScopeCycleDetectionEnabled = true;
// Включаем для уже существующего root scope, если он есть
if (_rootScope != null) {
_rootScope!.enableGlobalCycleDetection();
}
}
/// RU: Глобально отключает обнаружение циклических зависимостей между скоупами.
/// ENG: Globally disables cross-scope circular dependency detection.
///
/// Example:
/// ```dart
/// CherryPick.disableGlobalCrossScopeCycleDetection();
/// ```
static void disableGlobalCrossScopeCycleDetection() {
_globalCrossScopeCycleDetectionEnabled = false;
// Отключаем для уже существующего root scope, если он есть
if (_rootScope != null) {
_rootScope!.disableGlobalCycleDetection();
}
// Очищаем глобальный детектор
GlobalCycleDetector.instance.clear();
}
/// RU: Проверяет, включено ли глобальное обнаружение циклических зависимостей между скоупами.
/// ENG: Checks if global cross-scope circular dependency detection is enabled.
///
/// return true если включено, false если отключено
/// return true if enabled, false if disabled
static bool get isGlobalCrossScopeCycleDetectionEnabled => _globalCrossScopeCycleDetectionEnabled;
/// RU: Возвращает глобальную цепочку разрешения зависимостей.
/// ENG: Returns global dependency resolution chain.
///
/// Полезно для отладки циклических зависимостей между скоупами.
/// Useful for debugging circular dependencies across scopes.
///
/// return список имен зависимостей в глобальной цепочке разрешения
/// return list of dependency names in global resolution chain
static List<String> getGlobalResolutionChain() {
return GlobalCycleDetector.instance.globalResolutionChain;
}
/// RU: Очищает все состояние глобального детектора циклических зависимостей.
/// ENG: Clears all global circular dependency detector state.
///
/// Полезно для тестов и сброса состояния.
/// Useful for tests and state reset.
static void clearGlobalCycleDetector() {
GlobalCycleDetector.reset();
}
/// RU: Создает новый скоуп с автоматически включенным глобальным обнаружением циклических зависимостей.
/// ENG: Creates a new scope with automatically enabled global circular dependency detection.
///
/// Этот скоуп будет отслеживать циклические зависимости во всей иерархии.
/// This scope will track circular dependencies across the entire hierarchy.
///
/// Example:
/// ```dart
/// final scope = CherryPick.openGlobalSafeRootScope();
/// // Глобальное обнаружение циклических зависимостей автоматически включено
/// ```
static Scope openGlobalSafeRootScope() {
final scope = openRootScope();
scope.enableCycleDetection();
scope.enableGlobalCycleDetection();
return scope;
}
/// RU: Создает новый дочерний скоуп с автоматически включенным глобальным обнаружением циклических зависимостей.
/// ENG: Creates a new child scope with automatically enabled global circular dependency detection.
///
/// [scopeName] - имя скоупа
/// [scopeName] - scope name
///
/// Example:
/// ```dart
/// final scope = CherryPick.openGlobalSafeScope(scopeName: 'feature.auth');
/// // Глобальное обнаружение циклических зависимостей автоматически включено
/// ```
static Scope openGlobalSafeScope({String scopeName = '', String separator = '.'}) {
final scope = openScope(scopeName: scopeName, separator: separator);
scope.enableCycleDetection();
scope.enableGlobalCycleDetection();
return scope;
}
}

View File

@@ -11,13 +11,16 @@
// limitations under the License.
//
import 'dart:collection';
import 'dart:math';
import 'package:cherrypick/src/binding.dart';
import 'package:cherrypick/src/cycle_detector.dart';
import 'package:cherrypick/src/global_cycle_detector.dart';
import 'package:cherrypick/src/binding_resolver.dart';
import 'package:cherrypick/src/module.dart';
Scope openRootScope() => Scope(null);
class Scope {
class Scope with CycleDetectionMixin, GlobalCycleDetectionMixin {
final Scope? _parentScope;
/// RU: Метод возвращает родительский [Scope].
@@ -29,10 +32,22 @@ class Scope {
final Map<String, Scope> _scopeMap = HashMap();
Scope(this._parentScope);
Scope(this._parentScope) {
// Генерируем уникальный ID для скоупа
setScopeId(_generateScopeId());
}
final Set<Module> _modulesList = HashSet();
/// RU: Генерирует уникальный идентификатор для скоупа.
/// ENG: Generates unique identifier for scope.
String _generateScopeId() {
final random = Random();
final timestamp = DateTime.now().millisecondsSinceEpoch;
final randomPart = random.nextInt(10000);
return 'scope_${timestamp}_$randomPart';
}
/// RU: Метод открывает дочерний (дополнительный) [Scope].
///
/// ENG: The method opens child (additional) [Scope].
@@ -40,7 +55,17 @@ class Scope {
/// return [Scope]
Scope openSubScope(String name) {
if (!_scopeMap.containsKey(name)) {
_scopeMap[name] = Scope(this);
final childScope = Scope(this);
// Наследуем настройки обнаружения циклических зависимостей
if (isCycleDetectionEnabled) {
childScope.enableCycleDetection();
}
if (isGlobalCycleDetectionEnabled) {
childScope.enableGlobalCycleDetection();
}
_scopeMap[name] = childScope;
}
return _scopeMap[name]!;
}
@@ -51,6 +76,13 @@ class Scope {
///
/// return [Scope]
void closeSubScope(String name) {
final childScope = _scopeMap[name];
if (childScope != null) {
// Очищаем детектор для дочернего скоупа
if (childScope.scopeId != null) {
GlobalCycleDetector.instance.removeScopeDetector(childScope.scopeId!);
}
}
_scopeMap.remove(name);
}
@@ -91,46 +123,65 @@ class Scope {
/// return - returns an object of type [T] or [StateError]
///
T resolve<T>({String? named, dynamic params}) {
var resolved = tryResolve<T>(named: named, params: params);
// Используем глобальное отслеживание, если включено
if (isGlobalCycleDetectionEnabled) {
return withGlobalCycleDetection<T>(T, named, () {
return _resolveWithLocalDetection<T>(named: named, params: params);
});
} else {
return _resolveWithLocalDetection<T>(named: named, params: params);
}
}
/// RU: Разрешение с локальным детектором циклических зависимостей.
/// ENG: Resolution with local circular dependency detector.
T _resolveWithLocalDetection<T>({String? named, dynamic params}) {
return withCycleDetection<T>(T, named, () {
var resolved = _tryResolveInternal<T>(named: named, params: params);
if (resolved != null) {
return resolved;
} else {
throw StateError(
'Can\'t resolve dependency `$T`. Maybe you forget register it?');
}
});
}
/// RU: Возвращает найденную зависимость типа [T] или null, если она не может быть найдена.
/// ENG: Returns found dependency of type [T] or null if it cannot be found.
///
T? tryResolve<T>({String? named, dynamic params}) {
// 1 Поиск зависимости по всем модулям текущего скоупа
if (_modulesList.isNotEmpty) {
for (var module in _modulesList) {
for (var binding in module.bindingSet) {
if (binding.key == T &&
((!binding.isNamed && named == null) ||
(binding.isNamed && named == binding.name))) {
switch (binding.mode) {
case Mode.instance:
return binding.instance;
case Mode.providerInstance:
return binding.provider;
case Mode.providerInstanceWithParams:
if (params == null) {
throw StateError('Param is null. Maybe you forget pass it');
}
return binding.providerWithParams(params);
default:
return null;
}
}
}
// Используем глобальное отслеживание, если включено
if (isGlobalCycleDetectionEnabled) {
return withGlobalCycleDetection<T?>(T, named, () {
return _tryResolveWithLocalDetection<T>(named: named, params: params);
});
} else {
return _tryResolveWithLocalDetection<T>(named: named, params: params);
}
}
/// RU: Попытка разрешения с локальным детектором циклических зависимостей.
/// ENG: Try resolution with local circular dependency detector.
T? _tryResolveWithLocalDetection<T>({String? named, dynamic params}) {
if (isCycleDetectionEnabled) {
return withCycleDetection<T?>(T, named, () {
return _tryResolveInternal<T>(named: named, params: params);
});
} else {
return _tryResolveInternal<T>(named: named, params: params);
}
}
/// RU: Внутренний метод для разрешения зависимостей без проверки циклических зависимостей.
/// ENG: Internal method for dependency resolution without circular dependency checking.
T? _tryResolveInternal<T>({String? named, dynamic params}) {
final resolver = _findBindingResolver<T>(named);
// 1 Поиск зависимости по всем модулям текущего скоупа
return resolver?.resolveSync(params) ??
// 2 Поиск зависимостей в родительском скоупе
return _parentScope?.tryResolve(named: named, params: params);
_parentScope?.tryResolve(named: named, params: params);
}
/// RU: Асинхронно возвращает найденную зависимость, определенную параметром типа [T].
@@ -144,33 +195,75 @@ class Scope {
/// return - returns an object of type [T] or [StateError]
///
Future<T> resolveAsync<T>({String? named, dynamic params}) async {
var resolved = await tryResolveAsync<T>(named: named, params: params);
// Используем глобальное отслеживание, если включено
if (isGlobalCycleDetectionEnabled) {
return withGlobalCycleDetection<Future<T>>(T, named, () async {
return await _resolveAsyncWithLocalDetection<T>(named: named, params: params);
});
} else {
return await _resolveAsyncWithLocalDetection<T>(named: named, params: params);
}
}
/// RU: Асинхронное разрешение с локальным детектором циклических зависимостей.
/// ENG: Async resolution with local circular dependency detector.
Future<T> _resolveAsyncWithLocalDetection<T>({String? named, dynamic params}) async {
return withCycleDetection<Future<T>>(T, named, () async {
var resolved = await _tryResolveAsyncInternal<T>(named: named, params: params);
if (resolved != null) {
return resolved;
} else {
throw StateError(
'Can\'t resolve async dependency `$T`. Maybe you forget register it?');
}
});
}
Future<T?> tryResolveAsync<T>({String? named, dynamic params}) async {
if (_modulesList.isNotEmpty) {
// Используем глобальное отслеживание, если включено
if (isGlobalCycleDetectionEnabled) {
return withGlobalCycleDetection<Future<T?>>(T, named, () async {
return await _tryResolveAsyncWithLocalDetection<T>(named: named, params: params);
});
} else {
return await _tryResolveAsyncWithLocalDetection<T>(named: named, params: params);
}
}
/// RU: Асинхронная попытка разрешения с локальным детектором циклических зависимостей.
/// ENG: Async try resolution with local circular dependency detector.
Future<T?> _tryResolveAsyncWithLocalDetection<T>({String? named, dynamic params}) async {
if (isCycleDetectionEnabled) {
return withCycleDetection<Future<T?>>(T, named, () async {
return await _tryResolveAsyncInternal<T>(named: named, params: params);
});
} else {
return await _tryResolveAsyncInternal<T>(named: named, params: params);
}
}
/// RU: Внутренний метод для асинхронного разрешения зависимостей без проверки циклических зависимостей.
/// ENG: Internal method for async dependency resolution without circular dependency checking.
Future<T?> _tryResolveAsyncInternal<T>({String? named, dynamic params}) async {
final resolver = _findBindingResolver<T>(named);
// 1 Поиск зависимости по всем модулям текущего скоупа
return resolver?.resolveAsync(params) ??
// 2 Поиск зависимостей в родительском скоупе
_parentScope?.tryResolveAsync(named: named, params: params);
}
BindingResolver<T>? _findBindingResolver<T>(String? named) {
for (var module in _modulesList) {
for (var binding in module.bindingSet) {
if (binding.key == T &&
((!binding.isNamed && named == null) ||
(binding.isNamed && named == binding.name))) {
if (binding.asyncProvider != null) {
return await binding.asyncProvider?.call();
return binding.resolver as BindingResolver<T>?;
}
}
}
if (binding.asyncProviderWithParams != null) {
return await binding.asyncProviderWithParams!(params);
}
}
}
}
}
return _parentScope?.tryResolveAsync(named: named, params: params);
return null;
}
}

View File

@@ -1,13 +1,13 @@
name: cherrypick
description: Cherrypick is a small dependency injection (DI) library for dart/flutter projects.
version: 2.1.0-dev.1
version: 3.0.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
issue_tracker: https://github.com/pese-git/cherrypick/issues
environment:
sdk: ">=3.0.0 <4.0.0"
sdk: ">=3.5.2 <4.0.0"
dependencies:
meta: ^1.3.0

View File

@@ -1,315 +1,248 @@
import 'package:cherrypick/src/binding.dart';
import 'package:cherrypick/cherrypick.dart';
import 'package:test/test.dart';
void main() {
group('Check instance.', () {
group('Without name.', () {
test('Binding resolves null', () {
// --- Instance binding (synchronous) ---
group('Instance Binding (toInstance)', () {
group('Without name', () {
test('Returns null by default', () {
final binding = Binding<int>();
expect(binding.instance, null);
expect(binding.resolver, null);
});
test('Binding check mode', () {
final expectedValue = 5;
final binding = Binding<int>().toInstance(expectedValue);
expect(binding.mode, Mode.instance);
test('Sets mode to instance', () {
final binding = Binding<int>().toInstance(5);
expect(binding.resolver, isA<InstanceResolver<int>>());
});
test('Binding check singleton', () {
final expectedValue = 5;
final binding = Binding<int>().toInstance(expectedValue);
test('isSingleton is true', () {
final binding = Binding<int>().toInstance(5);
expect(binding.isSingleton, true);
});
test('Binding check value', () {
final expectedValue = 5;
final binding = Binding<int>().toInstance(expectedValue);
expect(binding.instance, expectedValue);
});
test('Binding resolves value', () {
final expectedValue = 5;
final binding = Binding<int>().toInstance(expectedValue);
expect(binding.instance, expectedValue);
test('Stores value', () {
final binding = Binding<int>().toInstance(5);
expect(binding.resolver?.resolveSync(), 5);
});
});
group('With name.', () {
test('Binding resolves null', () {
final binding = Binding<int>().withName('expectedValue');
expect(binding.instance, null);
group('With name', () {
test('Returns null by default', () {
final binding = Binding<int>().withName('n');
expect(binding.resolver, null);
});
test('Binding check mode', () {
final expectedValue = 5;
final binding =
Binding<int>().withName('expectedValue').toInstance(expectedValue);
expect(binding.mode, Mode.instance);
test('Sets mode to instance', () {
final binding = Binding<int>().withName('n').toInstance(5);
expect(binding.resolver, isA<InstanceResolver<int>>());
});
test('Binding check key', () {
final expectedValue = 5;
final binding =
Binding<int>().withName('expectedValue').toInstance(expectedValue);
test('Sets key', () {
final binding = Binding<int>().withName('n').toInstance(5);
expect(binding.key, int);
});
test('Binding check singleton', () {
final expectedValue = 5;
final binding =
Binding<int>().withName('expectedValue').toInstance(expectedValue);
test('isSingleton is true', () {
final binding = Binding<int>().withName('n').toInstance(5);
expect(binding.isSingleton, true);
});
test('Binding check value', () {
final expectedValue = 5;
test('Stores value', () {
final binding = Binding<int>().withName('n').toInstance(5);
expect(binding.resolver?.resolveSync(), 5);
});
test('Sets name', () {
final binding = Binding<int>().withName('n').toInstance(5);
expect(binding.name, 'n');
});
});
test('Multiple toInstance calls change value', () {
final binding = Binding<int>().toInstance(1).toInstance(2);
expect(binding.resolver?.resolveSync(), 2);
});
});
// --- Instance binding (asynchronous) ---
group('Async Instance Binding (toInstanceAsync)', () {
test('Resolves instanceAsync with expected value', () async {
final binding = Binding<int>().toInstance(Future.value(42));
expect(await binding.resolveAsync(), 42);
});
test('Sets mode to instance', () {
final binding = Binding<int>().toInstance(Future.value(5));
expect(binding.resolver, isA<InstanceResolver<int>>());
});
test('isSingleton is true after toInstanceAsync', () {
final binding = Binding<int>().toInstance(Future.value(5));
expect(binding.isSingleton, isTrue);
});
test('Composes with withName', () async {
final binding =
Binding<int>().withName('expectedValue').toInstance(expectedValue);
expect(binding.instance, expectedValue);
Binding<int>().withName('asyncValue').toInstance(Future.value(7));
expect(binding.isNamed, isTrue);
expect(binding.name, 'asyncValue');
expect(await binding.resolveAsync(), 7);
});
test('Binding check value', () {
final expectedValue = 5;
final binding =
Binding<int>().withName('expectedValue').toInstance(expectedValue);
expect(binding.name, 'expectedValue');
});
test('Binding resolves value', () {
final expectedValue = 5;
final binding =
Binding<int>().withName('expectedValue').toInstance(expectedValue);
expect(binding.instance, expectedValue);
});
test('Keeps value after multiple awaits', () async {
final binding = Binding<int>().toInstance(Future.value(123));
final result1 = await binding.resolveAsync();
final result2 = await binding.resolveAsync();
expect(result1, equals(result2));
});
});
group('Check provide.', () {
group('Without name.', () {
test('Binding resolves null', () {
// --- Provider binding (synchronous) ---
group('Provider Binding (toProvide)', () {
group('Without name', () {
test('Returns null by default', () {
final binding = Binding<int>();
expect(binding.provider, null);
expect(binding.resolver, null);
});
test('Binding check mode', () {
final expectedValue = 5;
final binding = Binding<int>().toProvide(() => expectedValue);
expect(binding.mode, Mode.providerInstance);
test('Sets mode to providerInstance', () {
final binding = Binding<int>().toProvide(() => 5);
expect(binding.resolver, isA<ProviderResolver<int>>());
});
test('Binding check singleton', () {
final expectedValue = 5;
final binding = Binding<int>().toProvide(() => expectedValue);
test('isSingleton is false by default', () {
final binding = Binding<int>().toProvide(() => 5);
expect(binding.isSingleton, false);
});
test('Binding check value', () {
final expectedValue = 5;
final binding = Binding<int>().toProvide(() => expectedValue);
expect(binding.provider, expectedValue);
});
test('Binding resolves value', () {
final expectedValue = 5;
final binding = Binding<int>().toProvide(() => expectedValue);
expect(binding.provider, expectedValue);
test('Returns provided value', () {
final binding = Binding<int>().toProvide(() => 5);
expect(binding.resolveSync(), 5);
});
});
group('With name.', () {
test('Binding resolves null', () {
final binding = Binding<int>().withName('expectedValue');
expect(binding.provider, null);
group('With name', () {
test('Returns null by default', () {
final binding = Binding<int>().withName('n');
expect(binding.resolver, null);
});
test('Binding check mode', () {
final expectedValue = 5;
final binding = Binding<int>()
.withName('expectedValue')
.toProvide(() => expectedValue);
expect(binding.mode, Mode.providerInstance);
test('Sets mode to providerInstance', () {
final binding = Binding<int>().withName('n').toProvide(() => 5);
expect(binding.resolver, isA<ProviderResolver<int>>());
});
test('Binding check key', () {
final expectedValue = 5;
final binding = Binding<int>()
.withName('expectedValue')
.toProvide(() => expectedValue);
test('Sets key', () {
final binding = Binding<int>().withName('n').toProvide(() => 5);
expect(binding.key, int);
});
test('Binding check singleton', () {
final expectedValue = 5;
final binding = Binding<int>()
.withName('expectedValue')
.toProvide(() => expectedValue);
test('isSingleton is false by default', () {
final binding = Binding<int>().withName('n').toProvide(() => 5);
expect(binding.isSingleton, false);
});
test('Binding check value', () {
final expectedValue = 5;
test('Returns provided value', () {
final binding = Binding<int>().withName('n').toProvide(() => 5);
expect(binding.resolveSync(), 5);
});
test('Sets name', () {
final binding = Binding<int>().withName('n').toProvide(() => 5);
expect(binding.name, 'n');
});
});
});
// --- Async provider binding ---
group('Async Provider Binding', () {
test('Resolves asyncProvider value', () async {
final binding = Binding<int>().toProvide(() async => 5);
expect(await binding.resolveAsync(), 5);
});
test('Resolves asyncProviderWithParams value', () async {
final binding = Binding<int>()
.withName('expectedValue')
.toProvide(() => expectedValue);
expect(binding.provider, expectedValue);
});
test('Binding check value', () {
final expectedValue = 5;
final binding = Binding<int>()
.withName('expectedValue')
.toProvide(() => expectedValue);
expect(binding.name, 'expectedValue');
});
test('Binding resolves value', () {
final expectedValue = 5;
final binding = Binding<int>()
.withName('expectedValue')
.toProvide(() => expectedValue);
expect(binding.provider, expectedValue);
});
});
});
group('Check Async provider.', () {
test('Binding resolves value asynchronously', () async {
final expectedValue = 5;
final binding = Binding<int>().toProvideAsync(() async => expectedValue);
final result = await binding.asyncProvider?.call();
expect(result, expectedValue);
});
test('Binding resolves value asynchronously with params', () async {
final expectedValue = 5;
final binding = Binding<int>().toProvideAsyncWithParams(
(param) async => expectedValue + (param as int));
final result = await binding.asyncProviderWithParams?.call(3);
expect(result, expectedValue + 3);
.toProvideWithParams((param) async => 5 + (param as int));
expect(await binding.resolveAsync(3), 8);
});
});
group('Check singleton provide.', () {
group('Without name.', () {
test('Binding resolves null', () {
// --- Singleton provider binding ---
group('Singleton Provider Binding', () {
group('Without name', () {
test('Returns null if no provider set', () {
final binding = Binding<int>().singleton();
expect(binding.provider, null);
expect(binding.resolver, null);
});
test('Binding check mode', () {
final expectedValue = 5;
final binding =
Binding<int>().toProvide(() => expectedValue).singleton();
expect(binding.mode, Mode.providerInstance);
});
test('Binding check singleton', () {
final expectedValue = 5;
final binding =
Binding<int>().toProvide(() => expectedValue).singleton();
test('isSingleton is true', () {
final binding = Binding<int>().toProvide(() => 5).singleton();
expect(binding.isSingleton, true);
});
test('Binding check value', () {
final expectedValue = 5;
test('Returns singleton value', () {
final binding = Binding<int>().toProvide(() => 5).singleton();
expect(binding.resolveSync(), 5);
});
test('Returns same value each call and provider only called once', () {
int counter = 0;
final binding = Binding<int>().toProvide(() {
counter++;
return counter;
}).singleton();
final first = binding.resolveSync();
final second = binding.resolveSync();
expect(first, equals(second));
expect(counter, 1);
});
});
group('With name', () {
test('Returns null if no provider set', () {
final binding = Binding<int>().withName('n').singleton();
expect(binding.resolver, null);
});
test('Sets key', () {
final binding =
Binding<int>().toProvide(() => expectedValue).singleton();
expect(binding.provider, expectedValue);
});
test('Binding resolves value', () {
final expectedValue = 5;
final binding =
Binding<int>().toProvide(() => expectedValue).singleton();
expect(binding.provider, expectedValue);
});
});
group('With name.', () {
test('Binding resolves null', () {
final binding = Binding<int>().withName('expectedValue').singleton();
expect(binding.provider, null);
});
test('Binding check mode', () {
final expectedValue = 5;
final binding = Binding<int>()
.withName('expectedValue')
.toProvide(() => expectedValue)
.singleton();
expect(binding.mode, Mode.providerInstance);
});
test('Binding check key', () {
final expectedValue = 5;
final binding = Binding<int>()
.withName('expectedValue')
.toProvide(() => expectedValue)
.singleton();
Binding<int>().withName('n').toProvide(() => 5).singleton();
expect(binding.key, int);
});
test('Binding check singleton', () {
final expectedValue = 5;
final binding = Binding<int>()
.withName('expectedValue')
.toProvide(() => expectedValue)
.singleton();
test('isSingleton is true', () {
final binding =
Binding<int>().withName('n').toProvide(() => 5).singleton();
expect(binding.isSingleton, true);
});
test('Binding check value', () {
final expectedValue = 5;
final binding = Binding<int>()
.withName('expectedValue')
.toProvide(() => expectedValue)
.singleton();
expect(binding.provider, expectedValue);
test('Returns singleton value', () {
final binding =
Binding<int>().withName('n').toProvide(() => 5).singleton();
expect(binding.resolveSync(), 5);
});
test('Binding check value', () {
final expectedValue = 5;
final binding = Binding<int>()
.withName('expectedValue')
.toProvide(() => expectedValue)
.singleton();
expect(binding.name, 'expectedValue');
test('Sets name', () {
final binding =
Binding<int>().withName('n').toProvide(() => 5).singleton();
expect(binding.name, 'n');
});
});
});
test('Binding resolves value', () {
final expectedValue = 5;
final binding = Binding<int>()
.withName('expectedValue')
.toProvide(() => expectedValue)
.singleton();
expect(binding.provider, expectedValue);
// --- WithName / Named binding, isNamed, edge-cases ---
group('Named binding & helpers', () {
test('withName sets isNamed true and stores name', () {
final binding = Binding<int>().withName('foo');
expect(binding.isNamed, true);
expect(binding.name, 'foo');
});
test('providerWithParams returns null if not set', () {
final binding = Binding<int>();
expect(binding.resolveSync(123), null);
});
});
}

View File

@@ -0,0 +1,158 @@
import 'package:cherrypick/cherrypick.dart';
import 'package:test/test.dart';
void main() {
group('Cross-Scope Circular Dependency Detection', () {
tearDown(() {
CherryPick.closeRootScope();
CherryPick.disableGlobalCycleDetection();
});
test('should detect circular dependency across parent-child scopes', () {
// Создаем родительский скоуп с сервисом A
final parentScope = CherryPick.openSafeRootScope();
parentScope.installModules([ParentScopeModule()]);
// Создаем дочерний скоуп с сервисом B, который зависит от A
final childScope = parentScope.openSubScope('child');
childScope.enableCycleDetection();
childScope.installModules([ChildScopeModule()]);
// Сервис A в родительском скоупе пытается получить сервис B из дочернего скоупа
// Это создает циклическую зависимость между скоупами
expect(
() => parentScope.resolve<CrossScopeServiceA>(),
throwsA(isA<CircularDependencyException>()),
);
});
test('should detect circular dependency in complex scope hierarchy', () {
final rootScope = CherryPick.openSafeRootScope();
final level1Scope = rootScope.openSubScope('level1');
final level2Scope = level1Scope.openSubScope('level2');
level1Scope.enableCycleDetection();
level2Scope.enableCycleDetection();
// Устанавливаем модули на разных уровнях
rootScope.installModules([RootLevelModule()]);
level1Scope.installModules([Level1Module()]);
level2Scope.installModules([Level2Module()]);
// Попытка разрешить зависимость, которая создает цикл через все уровни
expect(
() => level2Scope.resolve<Level2Service>(),
throwsA(isA<CircularDependencyException>()),
);
});
test('current implementation limitation - may not detect cross-scope cycles', () {
// Этот тест демонстрирует ограничение текущей реализации
final parentScope = CherryPick.openRootScope();
parentScope.enableCycleDetection();
final childScope = parentScope.openSubScope('child');
// НЕ включаем cycle detection для дочернего скоупа
parentScope.installModules([ParentScopeModule()]);
childScope.installModules([ChildScopeModule()]);
// В текущей реализации это может не обнаружить циклическую зависимость
// если детекторы работают независимо в каждом скоупе
try {
// ignore: unused_local_variable
final service = parentScope.resolve<CrossScopeServiceA>();
// Если мы дошли сюда, значит циклическая зависимость не была обнаружена
print('Циклическая зависимость между скоупами не обнаружена');
} catch (e) {
if (e is CircularDependencyException) {
print('Циклическая зависимость обнаружена: ${e.message}');
} else {
print('Другая ошибка: $e');
}
}
});
});
}
// Тестовые сервисы для демонстрации циклических зависимостей между скоупами
class CrossScopeServiceA {
final CrossScopeServiceB serviceB;
CrossScopeServiceA(this.serviceB);
}
class CrossScopeServiceB {
final CrossScopeServiceA serviceA;
CrossScopeServiceB(this.serviceA);
}
class ParentScopeModule extends Module {
@override
void builder(Scope currentScope) {
bind<CrossScopeServiceA>().toProvide(() {
// Пытаемся получить сервис B из дочернего скоупа
final childScope = currentScope.openSubScope('child');
return CrossScopeServiceA(childScope.resolve<CrossScopeServiceB>());
});
}
}
class ChildScopeModule extends Module {
@override
void builder(Scope currentScope) {
bind<CrossScopeServiceB>().toProvide(() {
// Пытаемся получить сервис A из родительского скоупа
final parentScope = currentScope.parentScope!;
return CrossScopeServiceB(parentScope.resolve<CrossScopeServiceA>());
});
}
}
// Сервисы для сложной иерархии скоупов
class RootLevelService {
final Level1Service level1Service;
RootLevelService(this.level1Service);
}
class Level1Service {
final Level2Service level2Service;
Level1Service(this.level2Service);
}
class Level2Service {
final RootLevelService rootService;
Level2Service(this.rootService);
}
class RootLevelModule extends Module {
@override
void builder(Scope currentScope) {
bind<RootLevelService>().toProvide(() {
final level1Scope = currentScope.openSubScope('level1');
return RootLevelService(level1Scope.resolve<Level1Service>());
});
}
}
class Level1Module extends Module {
@override
void builder(Scope currentScope) {
bind<Level1Service>().toProvide(() {
final level2Scope = currentScope.openSubScope('level2');
return Level1Service(level2Scope.resolve<Level2Service>());
});
}
}
class Level2Module extends Module {
@override
void builder(Scope currentScope) {
bind<Level2Service>().toProvide(() {
// Идем к корневому скоупу через цепочку родителей
var rootScope = currentScope.parentScope?.parentScope;
return Level2Service(rootScope!.resolve<RootLevelService>());
});
}
}

View File

@@ -0,0 +1,215 @@
import 'package:cherrypick/src/cycle_detector.dart';
import 'package:cherrypick/src/module.dart';
import 'package:cherrypick/src/scope.dart';
import 'package:test/test.dart';
void main() {
group('CycleDetector', () {
late CycleDetector detector;
setUp(() {
detector = CycleDetector();
});
test('should detect simple circular dependency', () {
detector.startResolving<String>();
expect(
() => detector.startResolving<String>(),
throwsA(isA<CircularDependencyException>()),
);
});
test('should detect circular dependency with named bindings', () {
detector.startResolving<String>(named: 'test');
expect(
() => detector.startResolving<String>(named: 'test'),
throwsA(isA<CircularDependencyException>()),
);
});
test('should allow different types to be resolved simultaneously', () {
detector.startResolving<String>();
detector.startResolving<int>();
expect(() => detector.finishResolving<int>(), returnsNormally);
expect(() => detector.finishResolving<String>(), returnsNormally);
});
test('should detect complex circular dependency chain', () {
detector.startResolving<String>();
detector.startResolving<int>();
detector.startResolving<bool>();
expect(
() => detector.startResolving<String>(),
throwsA(predicate((e) =>
e is CircularDependencyException &&
e.dependencyChain.contains('String') &&
e.dependencyChain.length > 1
)),
);
});
test('should clear state properly', () {
detector.startResolving<String>();
detector.clear();
expect(() => detector.startResolving<String>(), returnsNormally);
});
test('should track resolution history correctly', () {
detector.startResolving<String>();
detector.startResolving<int>();
expect(detector.currentResolutionChain, contains('String'));
expect(detector.currentResolutionChain, contains('int'));
expect(detector.currentResolutionChain.length, equals(2));
detector.finishResolving<int>();
expect(detector.currentResolutionChain.length, equals(1));
expect(detector.currentResolutionChain, contains('String'));
});
});
group('Scope with Cycle Detection', () {
test('should detect circular dependency in real scenario', () {
final scope = Scope(null);
scope.enableCycleDetection();
// Создаем циклическую зависимость: A зависит от B, B зависит от A
scope.installModules([
CircularModuleA(),
CircularModuleB(),
]);
expect(
() => scope.resolve<ServiceA>(),
throwsA(isA<CircularDependencyException>()),
);
});
test('should work normally without cycle detection enabled', () {
final scope = Scope(null);
// Не включаем обнаружение циклических зависимостей
scope.installModules([
SimpleModule(),
]);
expect(() => scope.resolve<SimpleService>(), returnsNormally);
expect(scope.resolve<SimpleService>(), isA<SimpleService>());
});
test('should allow disabling cycle detection', () {
final scope = Scope(null);
scope.enableCycleDetection();
expect(scope.isCycleDetectionEnabled, isTrue);
scope.disableCycleDetection();
expect(scope.isCycleDetectionEnabled, isFalse);
});
test('should handle named dependencies in cycle detection', () {
final scope = Scope(null);
scope.enableCycleDetection();
scope.installModules([
NamedCircularModule(),
]);
expect(
() => scope.resolve<String>(named: 'circular'),
throwsA(isA<CircularDependencyException>()),
);
});
test('should detect cycles in async resolution', () async {
final scope = Scope(null);
scope.enableCycleDetection();
scope.installModules([
AsyncCircularModule(),
]);
expect(
() => scope.resolveAsync<AsyncServiceA>(),
throwsA(isA<CircularDependencyException>()),
);
});
});
}
// Test services and modules for circular dependency testing
class ServiceA {
final ServiceB serviceB;
ServiceA(this.serviceB);
}
class ServiceB {
final ServiceA serviceA;
ServiceB(this.serviceA);
}
class CircularModuleA extends Module {
@override
void builder(Scope currentScope) {
bind<ServiceA>().toProvide(() => ServiceA(currentScope.resolve<ServiceB>()));
}
}
class CircularModuleB extends Module {
@override
void builder(Scope currentScope) {
bind<ServiceB>().toProvide(() => ServiceB(currentScope.resolve<ServiceA>()));
}
}
class SimpleService {
SimpleService();
}
class SimpleModule extends Module {
@override
void builder(Scope currentScope) {
bind<SimpleService>().toProvide(() => SimpleService());
}
}
class NamedCircularModule extends Module {
@override
void builder(Scope currentScope) {
bind<String>()
.withName('circular')
.toProvide(() => currentScope.resolve<String>(named: 'circular'));
}
}
class AsyncServiceA {
final AsyncServiceB serviceB;
AsyncServiceA(this.serviceB);
}
class AsyncServiceB {
final AsyncServiceA serviceA;
AsyncServiceB(this.serviceA);
}
class AsyncCircularModule extends Module {
@override
void builder(Scope currentScope) {
// ignore: deprecated_member_use_from_same_package
bind<AsyncServiceA>().toProvideAsync(() async {
final serviceB = await currentScope.resolveAsync<AsyncServiceB>();
return AsyncServiceA(serviceB);
});
// ignore: deprecated_member_use_from_same_package
bind<AsyncServiceB>().toProvideAsync(() async {
final serviceA = await currentScope.resolveAsync<AsyncServiceA>();
return AsyncServiceB(serviceA);
});
}
}

View File

@@ -0,0 +1,274 @@
import 'package:cherrypick/cherrypick.dart';
import 'package:test/test.dart';
void main() {
group('Global Cycle Detection', () {
setUp(() {
// Сбрасываем состояние перед каждым тестом
CherryPick.closeRootScope();
CherryPick.disableGlobalCycleDetection();
CherryPick.disableGlobalCrossScopeCycleDetection();
CherryPick.clearGlobalCycleDetector();
});
tearDown(() {
// Очищаем состояние после каждого теста
CherryPick.closeRootScope();
CherryPick.disableGlobalCycleDetection();
CherryPick.disableGlobalCrossScopeCycleDetection();
CherryPick.clearGlobalCycleDetector();
});
group('Global Cross-Scope Cycle Detection', () {
test('should enable global cross-scope cycle detection', () {
expect(CherryPick.isGlobalCrossScopeCycleDetectionEnabled, isFalse);
CherryPick.enableGlobalCrossScopeCycleDetection();
expect(CherryPick.isGlobalCrossScopeCycleDetectionEnabled, isTrue);
});
test('should disable global cross-scope cycle detection', () {
CherryPick.enableGlobalCrossScopeCycleDetection();
expect(CherryPick.isGlobalCrossScopeCycleDetectionEnabled, isTrue);
CherryPick.disableGlobalCrossScopeCycleDetection();
expect(CherryPick.isGlobalCrossScopeCycleDetectionEnabled, isFalse);
});
test('should automatically enable global cycle detection for new root scope', () {
CherryPick.enableGlobalCrossScopeCycleDetection();
final scope = CherryPick.openRootScope();
expect(scope.isGlobalCycleDetectionEnabled, isTrue);
});
test('should automatically enable global cycle detection for existing root scope', () {
final scope = CherryPick.openRootScope();
expect(scope.isGlobalCycleDetectionEnabled, isFalse);
CherryPick.enableGlobalCrossScopeCycleDetection();
expect(scope.isGlobalCycleDetectionEnabled, isTrue);
});
});
group('Global Safe Scope Creation', () {
test('should create global safe root scope with both detections enabled', () {
final scope = CherryPick.openGlobalSafeRootScope();
expect(scope.isCycleDetectionEnabled, isTrue);
expect(scope.isGlobalCycleDetectionEnabled, isTrue);
});
test('should create global safe sub-scope with both detections enabled', () {
final scope = CherryPick.openGlobalSafeScope(scopeName: 'feature.global');
expect(scope.isCycleDetectionEnabled, isTrue);
expect(scope.isGlobalCycleDetectionEnabled, isTrue);
});
});
group('Cross-Scope Circular Dependency Detection', () {
test('should detect circular dependency across parent-child scopes', () {
final parentScope = CherryPick.openGlobalSafeRootScope();
parentScope.installModules([GlobalParentModule()]);
final childScope = parentScope.openSubScope('child');
childScope.installModules([GlobalChildModule()]);
expect(
() => parentScope.resolve<GlobalServiceA>(),
throwsA(isA<CircularDependencyException>()),
);
});
test('should detect circular dependency in complex scope hierarchy', () {
final rootScope = CherryPick.openGlobalSafeRootScope();
final level1Scope = rootScope.openSubScope('level1');
final level2Scope = level1Scope.openSubScope('level2');
// Устанавливаем модули на разных уровнях
rootScope.installModules([GlobalRootModule()]);
level1Scope.installModules([GlobalLevel1Module()]);
level2Scope.installModules([GlobalLevel2Module()]);
expect(
() => level2Scope.resolve<GlobalLevel2Service>(),
throwsA(isA<CircularDependencyException>()),
);
});
test('should provide detailed global resolution chain in exception', () {
final scope = CherryPick.openGlobalSafeRootScope();
scope.installModules([GlobalParentModule()]);
final childScope = scope.openSubScope('child');
childScope.installModules([GlobalChildModule()]);
try {
scope.resolve<GlobalServiceA>();
fail('Expected CircularDependencyException');
} catch (e) {
expect(e, isA<CircularDependencyException>());
final circularError = e as CircularDependencyException;
// Проверяем, что цепочка содержит информацию о скоупах
expect(circularError.dependencyChain, isNotEmpty);
expect(circularError.dependencyChain.length, greaterThan(1));
// Цепочка должна содержать оба сервиса
final chainString = circularError.dependencyChain.join(' -> ');
expect(chainString, contains('GlobalServiceA'));
expect(chainString, contains('GlobalServiceB'));
}
});
test('should track global resolution chain', () {
final scope = CherryPick.openGlobalSafeRootScope();
scope.installModules([SimpleGlobalModule()]);
// До разрешения цепочка должна быть пустой
expect(CherryPick.getGlobalResolutionChain(), isEmpty);
final service = scope.resolve<SimpleGlobalService>();
expect(service, isA<SimpleGlobalService>());
// После разрешения цепочка должна быть очищена
expect(CherryPick.getGlobalResolutionChain(), isEmpty);
});
test('should clear global cycle detector state', () {
CherryPick.enableGlobalCrossScopeCycleDetection();
// ignore: unused_local_variable
final scope = CherryPick.openGlobalSafeRootScope();
expect(CherryPick.getGlobalResolutionChain(), isEmpty);
CherryPick.clearGlobalCycleDetector();
// После очистки детектор должен быть сброшен
expect(CherryPick.getGlobalResolutionChain(), isEmpty);
});
});
group('Inheritance of Global Settings', () {
test('should inherit global cycle detection in child scopes', () {
CherryPick.enableGlobalCrossScopeCycleDetection();
final parentScope = CherryPick.openRootScope();
final childScope = parentScope.openSubScope('child');
expect(parentScope.isGlobalCycleDetectionEnabled, isTrue);
expect(childScope.isGlobalCycleDetectionEnabled, isTrue);
});
test('should inherit both local and global cycle detection', () {
CherryPick.enableGlobalCycleDetection();
CherryPick.enableGlobalCrossScopeCycleDetection();
final scope = CherryPick.openScope(scopeName: 'feature.test');
expect(scope.isCycleDetectionEnabled, isTrue);
expect(scope.isGlobalCycleDetectionEnabled, isTrue);
});
});
});
}
// Test services for global circular dependency testing
class GlobalServiceA {
final GlobalServiceB serviceB;
GlobalServiceA(this.serviceB);
}
class GlobalServiceB {
final GlobalServiceA serviceA;
GlobalServiceB(this.serviceA);
}
class GlobalParentModule extends Module {
@override
void builder(Scope currentScope) {
bind<GlobalServiceA>().toProvide(() {
// Получаем сервис B из дочернего скоупа
final childScope = currentScope.openSubScope('child');
return GlobalServiceA(childScope.resolve<GlobalServiceB>());
});
}
}
class GlobalChildModule extends Module {
@override
void builder(Scope currentScope) {
bind<GlobalServiceB>().toProvide(() {
// Получаем сервис A из родительского скоупа
final parentScope = currentScope.parentScope!;
return GlobalServiceB(parentScope.resolve<GlobalServiceA>());
});
}
}
// Services for complex hierarchy testing
class GlobalRootService {
final GlobalLevel1Service level1Service;
GlobalRootService(this.level1Service);
}
class GlobalLevel1Service {
final GlobalLevel2Service level2Service;
GlobalLevel1Service(this.level2Service);
}
class GlobalLevel2Service {
final GlobalRootService rootService;
GlobalLevel2Service(this.rootService);
}
class GlobalRootModule extends Module {
@override
void builder(Scope currentScope) {
bind<GlobalRootService>().toProvide(() {
final level1Scope = currentScope.openSubScope('level1');
return GlobalRootService(level1Scope.resolve<GlobalLevel1Service>());
});
}
}
class GlobalLevel1Module extends Module {
@override
void builder(Scope currentScope) {
bind<GlobalLevel1Service>().toProvide(() {
final level2Scope = currentScope.openSubScope('level2');
return GlobalLevel1Service(level2Scope.resolve<GlobalLevel2Service>());
});
}
}
class GlobalLevel2Module extends Module {
@override
void builder(Scope currentScope) {
bind<GlobalLevel2Service>().toProvide(() {
// Идем к корневому скоупу через цепочку родителей
var rootScope = currentScope.parentScope?.parentScope;
return GlobalLevel2Service(rootScope!.resolve<GlobalRootService>());
});
}
}
// Simple service for non-circular testing
class SimpleGlobalService {
SimpleGlobalService();
}
class SimpleGlobalModule extends Module {
@override
void builder(Scope currentScope) {
bind<SimpleGlobalService>().toProvide(() => SimpleGlobalService());
}
}

View File

@@ -0,0 +1,240 @@
import 'package:cherrypick/cherrypick.dart';
import 'package:test/test.dart';
void main() {
group('CherryPick Cycle Detection Helper Methods', () {
setUp(() {
// Сбрасываем состояние перед каждым тестом
CherryPick.closeRootScope();
CherryPick.disableGlobalCycleDetection();
});
tearDown(() {
// Очищаем состояние после каждого теста
CherryPick.closeRootScope();
CherryPick.disableGlobalCycleDetection();
});
group('Global Cycle Detection', () {
test('should enable global cycle detection', () {
expect(CherryPick.isGlobalCycleDetectionEnabled, isFalse);
CherryPick.enableGlobalCycleDetection();
expect(CherryPick.isGlobalCycleDetectionEnabled, isTrue);
});
test('should disable global cycle detection', () {
CherryPick.enableGlobalCycleDetection();
expect(CherryPick.isGlobalCycleDetectionEnabled, isTrue);
CherryPick.disableGlobalCycleDetection();
expect(CherryPick.isGlobalCycleDetectionEnabled, isFalse);
});
test('should automatically enable cycle detection for new root scope when global is enabled', () {
CherryPick.enableGlobalCycleDetection();
final scope = CherryPick.openRootScope();
expect(scope.isCycleDetectionEnabled, isTrue);
});
test('should automatically enable cycle detection for existing root scope when global is enabled', () {
final scope = CherryPick.openRootScope();
expect(scope.isCycleDetectionEnabled, isFalse);
CherryPick.enableGlobalCycleDetection();
expect(scope.isCycleDetectionEnabled, isTrue);
});
test('should automatically disable cycle detection for existing root scope when global is disabled', () {
CherryPick.enableGlobalCycleDetection();
final scope = CherryPick.openRootScope();
expect(scope.isCycleDetectionEnabled, isTrue);
CherryPick.disableGlobalCycleDetection();
expect(scope.isCycleDetectionEnabled, isFalse);
});
test('should apply global setting to sub-scopes', () {
CherryPick.enableGlobalCycleDetection();
final scope = CherryPick.openScope(scopeName: 'test.subscope');
expect(scope.isCycleDetectionEnabled, isTrue);
});
});
group('Scope-specific Cycle Detection', () {
test('should enable cycle detection for root scope', () {
final scope = CherryPick.openRootScope();
expect(scope.isCycleDetectionEnabled, isFalse);
CherryPick.enableCycleDetectionForScope();
expect(CherryPick.isCycleDetectionEnabledForScope(), isTrue);
expect(scope.isCycleDetectionEnabled, isTrue);
});
test('should disable cycle detection for root scope', () {
CherryPick.enableCycleDetectionForScope();
expect(CherryPick.isCycleDetectionEnabledForScope(), isTrue);
CherryPick.disableCycleDetectionForScope();
expect(CherryPick.isCycleDetectionEnabledForScope(), isFalse);
});
test('should enable cycle detection for specific scope', () {
final scopeName = 'feature.auth';
CherryPick.openScope(scopeName: scopeName);
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName), isFalse);
CherryPick.enableCycleDetectionForScope(scopeName: scopeName);
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName), isTrue);
});
test('should disable cycle detection for specific scope', () {
final scopeName = 'feature.auth';
CherryPick.enableCycleDetectionForScope(scopeName: scopeName);
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName), isTrue);
CherryPick.disableCycleDetectionForScope(scopeName: scopeName);
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName), isFalse);
});
});
group('Safe Scope Creation', () {
test('should create safe root scope with cycle detection enabled', () {
final scope = CherryPick.openSafeRootScope();
expect(scope.isCycleDetectionEnabled, isTrue);
});
test('should create safe sub-scope with cycle detection enabled', () {
final scope = CherryPick.openSafeScope(scopeName: 'feature.safe');
expect(scope.isCycleDetectionEnabled, isTrue);
});
test('safe scope should work independently of global setting', () {
// Глобальная настройка отключена
expect(CherryPick.isGlobalCycleDetectionEnabled, isFalse);
final scope = CherryPick.openSafeScope(scopeName: 'feature.independent');
expect(scope.isCycleDetectionEnabled, isTrue);
});
});
group('Resolution Chain Tracking', () {
test('should return empty resolution chain for scope without cycle detection', () {
CherryPick.openRootScope();
final chain = CherryPick.getCurrentResolutionChain();
expect(chain, isEmpty);
});
test('should return empty resolution chain for scope with cycle detection but no active resolution', () {
CherryPick.enableCycleDetectionForScope();
final chain = CherryPick.getCurrentResolutionChain();
expect(chain, isEmpty);
});
test('should track resolution chain for specific scope', () {
final scopeName = 'feature.tracking';
CherryPick.enableCycleDetectionForScope(scopeName: scopeName);
final chain = CherryPick.getCurrentResolutionChain(scopeName: scopeName);
expect(chain, isEmpty); // Пустая, так как нет активного разрешения
});
});
group('Integration with Circular Dependencies', () {
test('should detect circular dependency with global cycle detection enabled', () {
CherryPick.enableGlobalCycleDetection();
final scope = CherryPick.openRootScope();
scope.installModules([CircularTestModule()]);
expect(
() => scope.resolve<CircularServiceA>(),
throwsA(isA<CircularDependencyException>()),
);
});
test('should detect circular dependency with safe scope', () {
final scope = CherryPick.openSafeRootScope();
scope.installModules([CircularTestModule()]);
expect(
() => scope.resolve<CircularServiceA>(),
throwsA(isA<CircularDependencyException>()),
);
});
test('should not detect circular dependency when cycle detection is disabled', () {
final scope = CherryPick.openRootScope();
scope.installModules([CircularTestModule()]);
// Без обнаружения циклических зависимостей не будет выброшено CircularDependencyException,
// но может произойти StackOverflowError при попытке создания объекта
expect(() => scope.resolve<CircularServiceA>(),
throwsA(isA<StackOverflowError>()));
});
});
group('Scope Name Handling', () {
test('should handle empty scope name as root scope', () {
CherryPick.enableCycleDetectionForScope(scopeName: '');
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: ''), isTrue);
expect(CherryPick.isCycleDetectionEnabledForScope(), isTrue);
});
test('should handle complex scope names', () {
final complexScopeName = 'app.feature.auth.login';
CherryPick.enableCycleDetectionForScope(scopeName: complexScopeName);
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: complexScopeName), isTrue);
});
test('should handle custom separator', () {
final scopeName = 'app/feature/auth';
CherryPick.enableCycleDetectionForScope(scopeName: scopeName, separator: '/');
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName, separator: '/'), isTrue);
});
});
});
}
// Test services for circular dependency testing
class CircularServiceA {
final CircularServiceB serviceB;
CircularServiceA(this.serviceB);
}
class CircularServiceB {
final CircularServiceA serviceA;
CircularServiceB(this.serviceA);
}
class CircularTestModule extends Module {
@override
void builder(Scope currentScope) {
bind<CircularServiceA>().toProvide(() => CircularServiceA(currentScope.resolve<CircularServiceB>()));
bind<CircularServiceB>().toProvide(() => CircularServiceB(currentScope.resolve<CircularServiceA>()));
}
}

View File

@@ -3,46 +3,44 @@ import 'package:cherrypick/src/scope.dart';
import 'package:test/test.dart';
void main() {
group('Without parent scope.', () {
test('Parent scope is null.', () {
// --------------------------------------------------------------------------
group('Scope & Subscope Management', () {
test('Scope has no parent if constructed with null', () {
final scope = Scope(null);
expect(scope.parentScope, null);
});
test('Open sub scope.', () {
test('Can open and retrieve the same subScope by key', () {
final scope = Scope(null);
final subScope = scope.openSubScope('subScope');
expect(scope.openSubScope('subScope'), subScope);
});
test("Container throws state error if the value can't be resolved", () {
test('closeSubScope removes subscope so next openSubScope returns new', () {
final scope = Scope(null);
final subScope = scope.openSubScope("child");
expect(scope.openSubScope("child"), same(subScope));
scope.closeSubScope("child");
final newSubScope = scope.openSubScope("child");
expect(newSubScope, isNot(same(subScope)));
});
});
// --------------------------------------------------------------------------
group('Dependency Resolution (standard)', () {
test("Throws StateError if value can't be resolved", () {
final scope = Scope(null);
expect(() => scope.resolve<String>(), throwsA(isA<StateError>()));
});
test('Container resolves value after adding a dependency', () {
test('Resolves value after adding a dependency', () {
final expectedValue = 'test string';
final scope = Scope(null)
.installModules([TestModule<String>(value: expectedValue)]);
expect(scope.resolve<String>(), expectedValue);
});
});
group('With parent scope.', () {
/*
test(
"Container bind() throws state error (if it's parent already has a resolver)",
() {
final parentScope = new Scope(null)
.installModules([TestModule<String>(value: "string one")]);
final scope = new Scope(parentScope);
expect(
() => scope.installModules([TestModule<String>(value: "string two")]),
throwsA(isA<StateError>()));
});
*/
test('Container resolve() returns a value from parent container.', () {
test('Returns a value from parent scope', () {
final expectedValue = 5;
final parentScope = Scope(null);
final scope = Scope(parentScope);
@@ -52,8 +50,7 @@ void main() {
expect(scope.resolve<int>(), expectedValue);
});
test('Container resolve() returns a several value from parent container.',
() {
test('Returns several values from parent container', () {
final expectedIntValue = 5;
final expectedStringValue = 'Hello world';
final parentScope = Scope(null).installModules([
@@ -66,15 +63,126 @@ void main() {
expect(scope.resolve<String>(), expectedStringValue);
});
test("Container resolve() throws a state error if parent hasn't value too.",
() {
test("Throws StateError if parent hasn't value too", () {
final parentScope = Scope(null);
final scope = Scope(parentScope);
expect(() => scope.resolve<int>(), throwsA(isA<StateError>()));
});
test("After dropModules resolves fail", () {
final scope = Scope(null)..installModules([TestModule<int>(value: 5)]);
expect(scope.resolve<int>(), 5);
scope.dropModules();
expect(() => scope.resolve<int>(), throwsA(isA<StateError>()));
});
});
// --------------------------------------------------------------------------
group('Named Dependencies', () {
test('Resolve named binding', () {
final scope = Scope(null)
..installModules([
TestModule<String>(value: "first"),
TestModule<String>(value: "second", name: "special")
]);
expect(scope.resolve<String>(named: "special"), "second");
expect(scope.resolve<String>(), "first");
});
test('Named binding does not clash with unnamed', () {
final scope = Scope(null)
..installModules([
TestModule<String>(value: "foo", name: "bar"),
]);
expect(() => scope.resolve<String>(), throwsA(isA<StateError>()));
expect(scope.resolve<String>(named: "bar"), "foo");
});
test("tryResolve returns null for missing named", () {
final scope = Scope(null)
..installModules([
TestModule<String>(value: "foo"),
]);
expect(scope.tryResolve<String>(named: "bar"), isNull);
});
});
// --------------------------------------------------------------------------
group('Provider with parameters', () {
test('Resolve dependency using providerWithParams', () {
final scope = Scope(null)
..installModules([
_InlineModule((m, s) {
m.bind<int>().toProvideWithParams((param) => (param as int) * 2);
}),
]);
expect(scope.resolve<int>(params: 3), 6);
expect(() => scope.resolve<int>(), throwsA(isA<StateError>()));
});
});
// --------------------------------------------------------------------------
group('Async Resolution', () {
test('Resolve async instance', () async {
final scope = Scope(null)
..installModules([
_InlineModule((m, s) {
m.bind<String>().toInstance(Future.value('async value'));
}),
]);
expect(await scope.resolveAsync<String>(), "async value");
});
test('Resolve async provider', () async {
final scope = Scope(null)
..installModules([
_InlineModule((m, s) {
m.bind<int>().toProvide(() async => 7);
}),
]);
expect(await scope.resolveAsync<int>(), 7);
});
test('Resolve async provider with param', () async {
final scope = Scope(null)
..installModules([
_InlineModule((m, s) {
m.bind<int>().toProvideWithParams((x) async => (x as int) * 3);
}),
]);
expect(await scope.resolveAsync<int>(params: 2), 6);
expect(() => scope.resolveAsync<int>(), throwsA(isA<StateError>()));
});
test('tryResolveAsync returns null for missing', () async {
final scope = Scope(null);
final result = await scope.tryResolveAsync<String>();
expect(result, isNull);
});
});
// --------------------------------------------------------------------------
group('Optional resolution and error handling', () {
test("tryResolve returns null for missing dependency", () {
final scope = Scope(null);
expect(scope.tryResolve<int>(), isNull);
});
// Не реализован:
// test("Container bind() throws state error (if it's parent already has a resolver)", () {
// final parentScope = new Scope(null).installModules([TestModule<String>(value: "string one")]);
// final scope = new Scope(parentScope);
// expect(
// () => scope.installModules([TestModule<String>(value: "string two")]),
// throwsA(isA<StateError>()));
// });
});
}
// ----------------------------------------------------------------------------
// Вспомогательные модули
class TestModule<T> extends Module {
final T value;
final String? name;
@@ -89,3 +197,12 @@ class TestModule<T> extends Module {
}
}
}
/// Вспомогательный модуль для подстановки builder'а через конструктор
class _InlineModule extends Module {
final void Function(Module, Scope) _builder;
_InlineModule(this._builder);
@override
void builder(Scope s) => _builder(this, s);
}

28
cherrypick_annotations/.gitignore vendored Normal file
View File

@@ -0,0 +1,28 @@
# See https://www.dartlang.org/guides/libraries/private-files
# Files and directories created by pub
.dart_tool/
.packages
build/
# If you're building an application, you may want to check-in your pubspec.lock
pubspec.lock
# Directory created by dartdoc
# If you don't generate documentation locally you can remove this line.
doc/api/
# Avoid committing generated Javascript files:
*.dart.js
*.info.json # Produced by the --dump-info flag.
*.js # When generated by dart2js. Don't specify *.js if your
# project includes source files written in JavaScript.
*.js_
*.js.deps
*.js.map
# FVM Version Cache
.fvm/
melos_cherrypick_annotations.iml
pubspec_overrides.yaml

View File

@@ -0,0 +1,19 @@
## 1.1.0
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
## 1.1.0-dev.1
- **FEAT**: implement InjectGenerator.
## 1.1.0-dev.0
- **FEAT**: implement generator for dynamic params.
- **FEAT**: implement instance/provide annotations.
- **FEAT**: implement generator for named annotation.
- **FEAT**: implement generator di module.
- **FEAT**: implement annotations.
## 1.0.0
- Initial version.

View File

@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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.

View File

@@ -0,0 +1,229 @@
# cherrypick_annotations
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
A lightweight set of Dart annotations for dependency injection (DI) frameworks and code generation, inspired by modern approaches like Dagger and Injectable. Optimized for use with [`cherrypick_generator`](https://pub.dev/packages/cherrypick_generator).
---
## Features
- **@module** Marks a class as a DI module for service/provider registration.
- **@singleton** Declares that a method or class should be provided as a singleton.
- **@instance** Marks a method or class so that a new instance is provided on each request.
- **@provide** Marks a method whose return value should be registered as a provider, supporting DI into its parameters.
- **@named** Assigns a string name to a binding for keyed resolution and injection.
- **@params** Indicates that a parameter should be injected with runtime-supplied arguments.
- **@injectable** Marks a class as eligible for automatic field injection. Fields annotated with `@inject` will be injected by the code generator.
- **@inject** Marks a field to be automatically injected by the code generator.
- **@scope** Declares the DI scope from which a dependency should be resolved for a field.
These annotations streamline DI configuration and serve as markers for code generation tools such as [`cherrypick_generator`](https://pub.dev/packages/cherrypick_generator).
---
## Getting Started
### 1. Add dependency
```yaml
dependencies:
cherrypick_annotations: ^latest
```
Add as a `dev_dependency` for code generation:
```yaml
dev_dependencies:
cherrypick_generator: ^latest
build_runner: ^latest
```
---
### 2. Annotate your DI modules, providers, and injectable classes
#### **Module and Provider Example**
```dart
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
@module()
abstract class AppModule {
@singleton()
Dio dio() => Dio();
@named('baseUrl')
String baseUrl() => 'https://api.example.com';
@instance()
Foo foo() => Foo();
@provide()
Bar bar(Foo foo) => Bar(foo);
@provide()
String greet(@params() dynamic params) => 'Hello $params';
}
```
With `cherrypick_generator`, code like the following will be generated:
```dart
final class $AppModule extends AppModule {
@override
void builder(Scope currentScope) {
bind<Dio>().toProvide(() => dio()).singleton();
bind<String>().toProvide(() => baseUrl()).withName('baseUrl');
bind<Foo>().toInstance(foo());
bind<Bar>().toProvide(() => bar(currentScope.resolve<Foo>()));
bind<String>().toProvideWithParams((args) => greet(args));
}
}
```
---
#### **Field Injection Example**
```dart
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
@injectable()
class ProfileView with _$ProfileView{
@inject()
late final AuthService auth;
@inject()
@scope('profile')
late final ProfileManager manager;
@inject()
@named('admin')
late final UserService adminUserService;
}
```
The code generator produces a mixin (simplified):
```dart
mixin _$ProfileView {
void _inject(ProfileView instance) {
instance.auth = CherryPick.openRootScope().resolve<AuthService>();
instance.manager = CherryPick.openScope(scopeName: 'profile').resolve<ProfileManager>();
instance.adminUserService = CherryPick.openRootScope().resolve<UserService>(named: 'admin');
}
}
```
---
## Annotation Reference
### `@injectable`
```dart
@injectable()
class MyWidget { ... }
```
Marks a class as injectable for CherryPick DI. The code generator will generate a mixin to perform automatic injection of fields marked with `@inject()`.
---
### `@inject`
```dart
@inject()
late final SomeService service;
```
Applied to a field to request automatic injection of the dependency using the CherryPick DI framework.
---
### `@scope`
```dart
@inject()
@scope('profile')
late final ProfileManager manager;
```
Specifies the scope from which the dependency should be resolved for an injected field.
---
### `@module`
```dart
@module()
abstract class AppModule {}
```
Use on classes to mark them as a DI module. This is the root for registering your dependency providers.
---
### `@singleton`
```dart
@singleton()
Dio dio() => Dio();
```
Use on methods or classes to provide a singleton instance (the same instance is reused).
---
### `@instance`
```dart
@instance()
Foo foo() => Foo();
```
Use on methods or classes to provide a new instance on each request (not a singleton).
---
### `@provide`
```dart
@provide()
Bar bar(Foo foo) => Bar(foo);
```
Use on methods to indicate they provide a dependency to the DI module. Dependencies listed as parameters (e.g., `foo`) are resolved and injected.
---
### `@named`
```dart
@named('token')
String token() => 'abc';
```
Assigns a name to a binding for keyed injection or resolution.
Can be used on both provider methods and fields.
---
### `@params`
```dart
@provide()
String greet(@params() dynamic params) => 'Hello $params';
```
Indicates that this parameter should receive runtime-supplied arguments during dependency resolution.
---
## License
Licensed under the [Apache License 2.0](LICENSE).
---
## Contributing
Pull requests and feedback are welcome!
---
## Author
Sergey Penkovsky (<sergey.penkovsky@gmail.com>)

View File

@@ -0,0 +1,30 @@
# This file configures the static analysis results for your project (errors,
# warnings, and lints).
#
# This enables the 'recommended' set of lints from `package:lints`.
# This set helps identify many issues that may lead to problems when running
# or consuming Dart code, and enforces writing Dart using a single, idiomatic
# style and format.
#
# If you want a smaller set of lints you can change this to specify
# 'package:lints/core.yaml'. These are just the most critical lints
# (the recommended set includes the core lints).
# The core lints are also what is used by pub.dev for scoring packages.
include: package:lints/recommended.yaml
# Uncomment the following section to specify additional rules.
# linter:
# rules:
# - camel_case_types
# analyzer:
# exclude:
# - path/to/excluded/files/**
# For more information about the core and recommended set of lints, see
# https://dart.dev/go/core-lints
# For additional information about configuring this file, see
# https://dart.dev/guides/language/analysis-options

View File

@@ -0,0 +1,24 @@
library;
//
// 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.
//
export 'src/module.dart';
export 'src/provide.dart';
export 'src/instance.dart';
export 'src/singleton.dart';
export 'src/named.dart';
export 'src/params.dart';
export 'src/inject.dart';
export 'src/injectable.dart';
export 'src/scope.dart';

View File

@@ -0,0 +1,34 @@
//
// 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:meta/meta.dart';
/// Annotation for field injection in CherryPick DI framework.
/// Apply this to a field, and the code generator will automatically inject
/// the appropriate dependency into it.
///
/// ---
///
/// Аннотация для внедрения зависимости в поле через фреймворк CherryPick DI.
/// Поместите её на поле класса — генератор кода автоматически подставит нужную зависимость.
///
/// Example / Пример:
/// ```dart
/// @inject()
/// late final SomeService service;
/// ```
@experimental
// ignore: camel_case_types
final class inject {
const inject();
}

View File

@@ -0,0 +1,38 @@
//
// 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:meta/meta.dart';
/// Marks a class as injectable for the CherryPick dependency injection framework.
/// If a class is annotated with [@injectable()], the code generator will
/// create a mixin to perform automatic injection of fields marked with [@inject].
///
/// ---
///
/// Помечает класс как внедряемый для фреймворка внедрения зависимостей CherryPick.
/// Если класс помечен аннотацией [@injectable()], генератор создаст миксин
/// для автоматического внедрения полей, отмеченных [@inject].
///
/// Example / Пример:
/// ```dart
/// @injectable()
/// class MyWidget extends StatelessWidget {
/// @inject()
/// late final MyService service;
/// }
/// ```
@experimental
// ignore: camel_case_types
final class injectable {
const injectable();
}

View File

@@ -0,0 +1,68 @@
//
// 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.
//
/// ENGLISH:
/// Annotation to specify that a new instance should be provided on each request.
///
/// Use the `@instance()` annotation for methods or classes in your DI module
/// to declare that the DI container must create a new object every time
/// the dependency is injected (i.e., no singleton behavior).
///
/// Example:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// @instance()
/// Foo foo() => Foo();
/// }
/// ```
///
/// This will generate:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Foo>().toInstance(() => foo());
/// }
/// }
/// ```
///
/// RUSSIAN (Русский):
/// Аннотация для создания нового экземпляра при каждом запросе.
///
/// Используйте `@instance()` для методов или классов в DI-модуле,
/// чтобы указать, что контейнер внедрения зависимостей должен создавать
/// новый объект при каждом обращении к зависимости (то есть, не синглтон).
///
/// Пример:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// @instance()
/// Foo foo() => Foo();
/// }
/// ```
///
/// Будет сгенерирован следующий код:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Foo>().toInstance(() => foo());
/// }
/// }
/// ```
// ignore: camel_case_types
final class instance {
const instance();
}

View File

@@ -0,0 +1,69 @@
//
// 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.
//
/// ENGLISH:
/// Annotation for marking Dart classes or libraries as modules.
///
/// Use the `@module()` annotation on abstract classes (or on a library)
/// to indicate that the class represents a DI (Dependency Injection) module.
/// This is commonly used in code generation tools to automatically register
/// and configure dependencies defined within the module.
///
/// Example:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// // Dependency definitions go here.
/// }
/// ```
///
/// Generates code like:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// // Dependency registration...
/// }
/// }
/// ```
///
/// RUSSIAN (Русский):
/// Аннотация для пометки классов или библиотек Dart как модуля.
///
/// Используйте `@module()` для абстрактных классов (или библиотек), чтобы
/// показать, что класс реализует DI-модуль (Dependency Injection).
/// Обычно используется генераторами кода для автоматической регистрации
/// и конфигурирования зависимостей, определённых в модуле.
///
/// Пример:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// // Определения зависимостей
/// }
/// ```
///
/// Будет сгенерирован код:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// // Регистрация зависимостей...
/// }
/// }
/// ```
// ignore: camel_case_types
final class module {
/// Creates a [module] annotation.
const module();
}

View File

@@ -0,0 +1,77 @@
//
// 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.
//
/// ENGLISH:
/// Annotation to assign a name or identifier to a class, method, or other element.
///
/// The `@named('value')` annotation allows you to specify a string name
/// for a dependency, factory, or injectable. This is useful for distinguishing
/// between multiple registrations of the same type in dependency injection,
/// code generation, and for providing human-readable metadata.
///
/// Example:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// @named('dio')
/// Dio dio() => Dio();
/// }
/// ```
///
/// This will generate:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Dio>().toProvide(() => dio()).withName('dio').singleton();
/// }
/// }
/// ```
///
/// RUSSIAN (Русский):
/// Аннотация для задания имени или идентификатора классу, методу или другому элементу.
///
/// Аннотация `@named('значение')` позволяет указать строковое имя для зависимости,
/// фабрики или внедряемого значения. Это удобно для различения нескольких
/// регистраций одного типа в DI, генерации кода.
///
/// Пример:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// @named('dio')
/// Dio dio() => Dio();
/// }
/// ```
///
/// Будет сгенерирован следующий код:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Dio>().toProvide(() => dio()).withName('dio').singleton();
/// }
/// }
/// ```
// ignore: camel_case_types
final class named {
/// EN: The assigned name or identifier for the element.
///
/// RU: Назначенное имя или идентификатор для элемента.
final String value;
/// EN: Creates a [named] annotation with the given [value].
///
/// RU: Создаёт аннотацию [named] с заданным значением [value].
const named(this.value);
}

View File

@@ -0,0 +1,56 @@
//
// 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.
//
/// ENGLISH:
/// Annotation to mark a method parameter for injection with run-time arguments.
///
/// Use the `@params()` annotation to specify that a particular parameter of a
/// provider method should be assigned a value supplied at resolution time,
/// rather than during static dependency graph creation. This is useful in DI
/// when a dependency must receive dynamic data passed by the consumer
/// (via `.withParams(...)` in the generated code).
///
/// Example:
/// ```dart
/// @provide()
/// String greet(@params() dynamic params) => 'Hello $params';
/// ```
///
/// This will generate:
/// ```dart
/// bind<String>().toProvideWithParams((args) => greet(args));
/// ```
///
/// RUSSIAN (Русский):
/// Аннотация для пометки параметра метода, который будет внедряться со значением во время выполнения.
///
/// Используйте `@params()` чтобы указать, что конкретный параметр метода-провайдера
/// должен получать значение, передаваемое в момент обращения к зависимости,
/// а не на этапе построения графа зависимостей. Это полезно, если зависимость
/// должна получать данные динамически от пользователя или другого процесса
/// через `.withParams(...)` в сгенерированном коде.
///
/// Пример:
/// ```dart
/// @provide()
/// String greet(@params() dynamic params) => 'Hello $params';
/// ```
///
/// Будет сгенерировано:
/// ```dart
/// bind<String>().toProvideWithParams((args) => greet(args));
/// ```
// ignore: camel_case_types
final class params {
const params();
}

View File

@@ -0,0 +1,70 @@
//
// 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.
//
/// ENGLISH:
/// Annotation to declare a factory/provider method or class as a singleton.
///
/// Use the `@singleton()` annotation on methods in your DI module to specify
/// that only one instance of the resulting object should be created and shared
/// for all consumers. This is especially useful in dependency injection
/// frameworks and service locators.
///
/// Example:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// @singleton()
/// Dio dio() => Dio();
/// }
/// ```
///
/// This generates the following code:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Dio>().toProvide(() => dio()).singleton();
/// }
/// }
/// ```
///
/// RUSSIAN (Русский):
/// Аннотация для объявления фабричного/провайдерного метода или класса синглтоном.
///
/// Используйте `@singleton()` для методов внутри DI-модуля, чтобы указать,
/// что соответствующий объект (экземпляр класса) должен быть создан только один раз
/// и использоваться всеми компонентами приложения (единый общий экземпляр).
/// Это характерно для систем внедрения зависимостей и сервис-локаторов.
///
/// Пример:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// @singleton()
/// Dio dio() => Dio();
/// }
/// ```
///
/// Будет сгенерирован следующий код:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Dio>().toProvide(() => dio()).singleton();
/// }
/// }
/// ```
// ignore: camel_case_types
final class provide {
const provide();
}

View File

@@ -0,0 +1,37 @@
//
// 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:meta/meta.dart';
/// Annotation to specify a scope for dependency injection in CherryPick.
/// Use this on an injected field to indicate from which scope
/// the dependency must be resolved.
///
/// ---
///
/// Аннотация для указания области внедрения (scope) в CherryPick.
/// Используйте её на инъецируемом поле, чтобы определить из какой области
/// должна быть получена зависимость.
///
/// Example / Пример:
/// ```dart
/// @inject()
/// @scope('profile')
/// late final ProfileManager profileManager;
/// ```
@experimental
// ignore: camel_case_types
final class scope {
final String? name;
const scope(this.name);
}

View File

@@ -0,0 +1,73 @@
//
// 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.
//
/// ENGLISH:
/// Annotation to declare a dependency as a singleton.
///
/// Use the `@singleton()` annotation on provider methods inside a module
/// to indicate that only a single instance of this dependency should be
/// created and shared throughout the application's lifecycle. This is
/// typically used in dependency injection frameworks or service locators
/// to guarantee a single shared instance.
///
/// Example:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// @singleton()
/// Dio dio() => Dio();
/// }
/// ```
///
/// This will generate code like:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Dio>().toProvide(() => dio()).singleton();
/// }
/// }
/// ```
///
/// RUSSIAN (Русский):
/// Аннотация для объявления зависимости как синглтона.
///
/// Используйте `@singleton()` для методов-провайдеров внутри модуля,
/// чтобы указать, что соответствующий объект должен быть создан
/// единожды и использоваться во всём приложении (общий синглтон).
/// Это характерно для систем внедрения зависимостей и сервис-локаторов,
/// чтобы гарантировать один общий экземпляр.
///
/// Пример:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// @singleton()
/// Dio dio() => Dio();
/// }
/// ```
///
/// Будет сгенерирован следующий код:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Dio>().toProvide(() => dio()).singleton();
/// }
/// }
/// ```
// ignore: camel_case_types
final class singleton {
/// Creates a [singleton] annotation.
const singleton();
}

View File

@@ -0,0 +1,19 @@
name: cherrypick_annotations
description: |
Set of annotations for CherryPick dependency injection library. Enables code generation and declarative DI for Dart & Flutter projects.
version: 1.1.0
documentation: https://github.com/pese-git/cherrypick/wiki
repository: https://github.com/pese-git/cherrypick/cherrypick_annotations
issue_tracker: https://github.com/pese-git/cherrypick/issues
environment:
sdk: ">=3.5.2 <4.0.0"
# Add regular dependencies here.
dependencies:
meta: ^1.15.0
# path: ^1.8.0
dev_dependencies:
lints: ^5.0.0
test: ^1.25.8

View File

@@ -0,0 +1,13 @@
import 'package:test/test.dart';
void main() {
group('A group of tests', () {
setUp(() {
// Additional setup goes here.
});
test('First Test', () {
expect(1, 1);
});
});
}

View File

@@ -1,3 +1,32 @@
## 1.1.3-dev.2
- Update a dependency to the latest release.
## 1.1.3-dev.1
- Update a dependency to the latest release.
## 1.1.3-dev.0
- **FIX**: update deps.
## 1.1.2
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
## 1.1.2-dev.1
- Update a dependency to the latest release.
## 1.1.2-dev.0
- **FIX**: fix warning.
- **FIX**: fix warnings.
## 1.1.1
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
## 1.1.1-dev.1
- **FIX**: fix warnings.

View File

@@ -1,16 +1,15 @@
library;
///
/// 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.
///
//
// 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.
//
export 'src/cherrypick_provider.dart';

View File

@@ -1,19 +1,19 @@
name: cherrypick_flutter
description: "Flutter library that allows access to the root scope through the context using `CherryPickProvider`."
version: 1.1.1-dev.1
version: 1.1.3-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
issue_tracker: https://github.com/pese-git/cherrypick/issues
environment:
sdk: ^3.5.2
flutter: ">=1.17.0"
sdk: ">=3.5.2 <4.0.0"
flutter: ">=3.24.0"
dependencies:
flutter:
sdk: flutter
cherrypick: ^2.1.0-dev.1
cherrypick: ^3.0.0-dev.2
dev_dependencies:
flutter_test:

32
cherrypick_generator/.gitignore vendored Normal file
View File

@@ -0,0 +1,32 @@
# See https://www.dartlang.org/guides/libraries/private-files
# Files and directories created by pub
.dart_tool/
.packages
build/
# If you're building an application, you may want to check-in your pubspec.lock
pubspec.lock
# Directory created by dartdoc
# If you don't generate documentation locally you can remove this line.
doc/api/
# Avoid committing generated Javascript files:
*.dart.js
*.info.json # Produced by the --dump-info flag.
*.js # When generated by dart2js. Don't specify *.js if your
# project includes source files written in JavaScript.
*.js_
*.js.deps
*.js.map
# FVM Version Cache
.fvm/
melos_cherrypick_generator.iml
**/*.mocks.dart
coverage
pubspec_overrides.yaml

View File

@@ -0,0 +1,42 @@
## 1.1.0
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
## 1.1.0-dev.5
- **FEAT**: implement tryResolve via generate code.
## 1.1.0-dev.4
- **FIX**: fixed warnings.
## 1.1.0-dev.3
- **FEAT**: implement InjectGenerator.
## 1.1.0-dev.2
- **FIX**: update instance generator code.
## 1.1.0-dev.1
- **FIX**: optimize code.
## 1.1.0-dev.0
- **FIX**: fix warning conflict with names.
- **FIX**: fix warnings.
- **FIX**: fix module generator.
- **FIX**: fix generator for singletone annotation.
- **FEAT**: implement generator for dynamic params.
- **FEAT**: implement async mode for instance/provide annotations.
- **FEAT**: generate instance async code.
- **FEAT**: implement instance/provide annotations.
- **FEAT**: implement named dependency.
- **FEAT**: implement generator for named annotation.
- **FEAT**: implement generator di module.
- **FEAT**: implement annotations.
## 1.0.0
- Initial version.

View File

@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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.

View File

@@ -0,0 +1,203 @@
# Cherrypick Generator
**Cherrypick Generator** is a Dart code generation library for automating dependency injection (DI) boilerplate. It processes classes and fields annotated with [cherrypick_annotations](https://pub.dev/packages/cherrypick_annotations) and generates registration code for services, modules, and field injection for classes marked as `@injectable`. It supports advanced DI features such as scopes, named bindings, parameters, and asynchronous dependencies.
---
## Features
- **Automatic Field Injection:**
Detects classes annotated with `@injectable()`, and generates mixins to inject all fields annotated with `@inject()`, supporting scope and named qualifiers.
- **Module and Service Registration:**
For classes annotated with `@module()`, generates service registration code for methods using annotations such as `@provide`, `@instance`, `@singleton`, `@named`, and `@params`.
- **Scope & Named Qualifier Support:**
Supports advanced DI features:
&nbsp;&nbsp;• Field-level scoping with `@scope('scopename')`
&nbsp;&nbsp;• Named dependencies via `@named('value')`
- **Synchronous & Asynchronous Support:**
Handles both synchronous and asynchronous services (including `Future<T>`) for both field injection and module registration.
- **Parameters and Runtime Arguments:**
Recognizes and wires both injected dependencies and runtime parameters using `@params`.
- **Error Handling:**
Validates annotations at generation time. Provides helpful errors for incorrect usage (e.g., using `@injectable` on non-class elements).
---
## How It Works
### 1. Annotate your code
Use annotations from [cherrypick_annotations](https://pub.dev/packages/cherrypick_annotations):
- `@injectable()` — on classes to enable field injection
- `@inject()` — on fields to specify they should be injected
- `@scope()`, `@named()` — on fields or parameters for advanced wiring
- `@module()` — on classes to mark as DI modules
- `@provide`, `@instance`, `@singleton`, `@params` — on methods and parameters for module-based DI
### 2. Run the generator
Use `build_runner` to process your code and generate `.module.cherrypick.g.dart` and `.inject.cherrypick.g.dart` files.
### 3. Use the output in your application
- For modules: Register DI providers using the generated `$YourModule` class.
- For services: Enable field injection on classes using the generated mixin.
---
## Field Injection Example
Given the following:
```dart
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
@injectable()
class MyWidget with _$MyWidget {
@inject()
late final AuthService auth;
@inject()
@scope('profile')
late final ProfileManager manager;
@inject()
@named('special')
late final ApiClient specialApi;
}
```
**The generator will output (simplified):**
```dart
mixin _$MyWidget {
void _inject(MyWidget instance) {
instance.auth = CherryPick.openRootScope().resolve<AuthService>();
instance.manager = CherryPick.openScope(scopeName: 'profile').resolve<ProfileManager>();
instance.specialApi = CherryPick.openRootScope().resolve<ApiClient>(named: 'special');
}
}
```
You can then mix this into your widget to enable automatic DI at runtime.
---
## Module Registration Example
Given:
```dart
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
@module()
class MyModule {
@singleton
@instance
AuthService provideAuth(Api api);
@provide
@named('logging')
Future<Logger> provideLogger(@params Map<String, dynamic> args);
}
```
**The generator will output (simplified):**
```dart
final class $MyModule extends MyModule {
@override
void builder(Scope currentScope) {
bind<AuthService>()
.toInstance(provideAuth(currentScope.resolve<Api>()))
.singleton();
bind<Logger>()
.toProvideAsyncWithParams((args) => provideLogger(args))
.withName('logging');
}
}
```
---
## Key Points
- **Rich Annotation Support:**
Mix and match field, parameter, and method annotations for maximum flexibility.
- **Scope and Named Resolution:**
Use `@scope('...')` and `@named('...')` to precisely control where and how dependencies are wired.
- **Async/Synchronous:**
The generator distinguishes between sync (`resolve<T>`) and async (`resolveAsync<T>`) dependencies.
- **Automatic Mixins:**
For classes with `@injectable()`, a mixin is generated that injects all relevant fields (using constructor or setter).
- **Comprehensive Error Checking:**
Misapplied annotations (e.g., `@injectable()` on non-class) produce clear build-time errors.
---
## Usage
1. **Add dependencies**
```yaml
dependencies:
cherrypick_annotations: ^latest
dev_dependencies:
cherrypick_generator: ^latest
build_runner: ^2.1.0
```
2. **Annotate your classes and modules as above**
3. **Run the generator**
```shell
dart run build_runner build
# or, if using Flutter:
flutter pub run build_runner build
```
4. **Use generated code**
- Import the generated `.inject.cherrypick.g.dart` or `.cherrypick.g.dart` files where needed
---
## Advanced Usage
- **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:**
Use `@named` on both provider and parameter for named registration and lookup; use `@params` to pass runtime arguments.
- **Async Factories:**
Methods returning Future<T> generate async bindings and async field resolution logic.
---
## Developer Notes
- The generator relies on the Dart analyzer, `source_gen`, and `build` packages.
- All classes and methods are parsed for annotations.
- Improper annotation usage will result in generator errors.
---
## License
```
Licensed under the Apache License, Version 2.0
```
---
## Contribution
Pull requests and issues are welcome! Please open GitHub issues or submit improvements.
---

View File

@@ -0,0 +1,34 @@
# This file configures the static analysis results for your project (errors,
# warnings, and lints).
#
# This enables the 'recommended' set of lints from `package:lints`.
# This set helps identify many issues that may lead to problems when running
# or consuming Dart code, and enforces writing Dart using a single, idiomatic
# style and format.
#
# If you want a smaller set of lints you can change this to specify
# 'package:lints/core.yaml'. These are just the most critical lints
# (the recommended set includes the core lints).
# The core lints are also what is used by pub.dev for scoring packages.
include: package:lints/recommended.yaml
# Uncomment the following section to specify additional rules.
# linter:
# rules:
# - camel_case_types
# analyzer:
# exclude:
# - path/to/excluded/files/**
# For more information about the core and recommended set of lints, see
# https://dart.dev/go/core-lints
# For additional information about configuring this file, see
# https://dart.dev/guides/language/analysis-options
analyzer:
errors:
deprecated_member_use: ignore

View File

@@ -0,0 +1,27 @@
builders:
module_generator:
import: "package:cherrypick_generator/module_generator.dart"
builder_factories: ["moduleBuilder"]
build_extensions: {".dart": [".module.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": [".inject.cherrypick.g.dart"]}
auto_apply: dependents
required_inputs: ["lib/**"]
runs_before: []
build_to: source
targets:
$default:
builders:
cherrypick_generator|module_generator:
generate_for:
- lib/**.dart
cherrypick_generator|inject_generator:
generate_for:
- lib/**.dart

View 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)

View File

@@ -0,0 +1,17 @@
library;
//
// 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.
//
export 'module_generator.dart';
export 'inject_generator.dart';

View File

@@ -0,0 +1,207 @@
//
// 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 'dart:async';
import 'package:analyzer/dart/constant/value.dart';
import 'package:analyzer/dart/element/nullability_suffix.dart';
import 'package:analyzer/dart/element/type.dart';
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;
/// InjectGenerator generates a mixin for a class marked with @injectable()
/// and injects all fields annotated with @inject(), using CherryPick DI.
///
/// For Future<T> fields it calls .resolveAsync<T>(),
/// otherwise .resolve<T>() is used. Scope and named qualifiers are supported.
///
/// ---
///
/// InjectGenerator генерирует миксин для класса с аннотацией @injectable()
/// и внедряет все поля, помеченные @inject(), используя DI-фреймворк CherryPick.
///
/// Для Future<T> полей вызывается .resolveAsync<T>(),
/// для остальных — .resolve<T>(). Поддерживаются scope и named qualifier.
///
class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
const InjectGenerator();
/// The main entry point for code generation.
///
/// Checks class validity, collects injectable fields, and produces injection code.
///
/// Основная точка входа генератора. Проверяет класс, собирает инъектируемые поля и создает код внедрения зависимостей.
@override
FutureOr<String> generateForAnnotatedElement(
Element element,
ConstantReader annotation,
BuildStep buildStep,
) {
if (element is! ClassElement) {
throw InvalidGenerationSourceError(
'@injectable() can only be applied to classes.',
element: element,
);
}
final classElement = element;
final className = classElement.name;
final mixinName = '_\$$className';
final buffer = StringBuffer()
..writeln('mixin $mixinName {')
..writeln(' void _inject($className instance) {');
// Collect and process all @inject fields.
// Собираем и обрабатываем все поля с @inject.
final injectFields =
classElement.fields.where(_isInjectField).map(_parseInjectField);
for (final parsedField in injectFields) {
buffer.writeln(_generateInjectionLine(parsedField));
}
buffer
..writeln(' }')
..writeln('}');
return buffer.toString();
}
/// Checks if a field has the @inject annotation.
///
/// Проверяет, отмечено ли поле аннотацией @inject.
static bool _isInjectField(FieldElement field) {
return field.metadata.any(
(m) => m.computeConstantValue()?.type?.getDisplayString() == 'inject',
);
}
/// Parses the field for scope/named qualifiers and determines its type.
/// Returns a [_ParsedInjectField] describing injection information.
///
/// Разбирает поле на наличие модификаторов scope/named и выясняет его тип.
/// Возвращает [_ParsedInjectField] с информацией о внедрении.
static _ParsedInjectField _parseInjectField(FieldElement field) {
String? scopeName;
String? namedValue;
for (final meta in field.metadata) {
final DartObject? obj = meta.computeConstantValue();
final type = obj?.type?.getDisplayString();
if (type == 'scope') {
scopeName = obj?.getField('name')?.toStringValue();
} else if (type == 'named') {
namedValue = obj?.getField('value')?.toStringValue();
}
}
final DartType dartType = field.type;
String coreTypeName;
bool isFuture;
if (dartType.isDartAsyncFuture) {
final ParameterizedType paramType = dartType as ParameterizedType;
coreTypeName = paramType.typeArguments.first.getDisplayString();
isFuture = true;
} else {
coreTypeName = dartType.getDisplayString();
isFuture = false;
}
// ***
// Добавим определение nullable для типа (например PostRepository? или Future<PostRepository?>)
bool isNullable = dartType.nullabilitySuffix ==
NullabilitySuffix.question ||
(dartType is ParameterizedType &&
(dartType)
.typeArguments
.any((t) => t.nullabilitySuffix == NullabilitySuffix.question));
return _ParsedInjectField(
fieldName: field.name,
coreType: coreTypeName.replaceAll('?', ''), // удаляем "?" на всякий
isFuture: isFuture,
isNullable: isNullable,
scopeName: scopeName,
namedValue: namedValue,
);
}
/// Generates a line of code that performs the dependency injection for a field.
/// Handles resolve/resolveAsync, scoping, and named qualifiers.
///
/// Генерирует строку кода, которая внедряет зависимость для поля.
/// Учитывает resolve/resolveAsync, scoping и named qualifier.
String _generateInjectionLine(_ParsedInjectField field) {
// Используем tryResolve для nullable, иначе resolve
final resolveMethod = field.isFuture
? (field.isNullable
? 'tryResolveAsync<${field.coreType}>'
: 'resolveAsync<${field.coreType}>')
: (field.isNullable
? 'tryResolve<${field.coreType}>'
: 'resolve<${field.coreType}>');
final openCall = (field.scopeName != null && field.scopeName!.isNotEmpty)
? "CherryPick.openScope(scopeName: '${field.scopeName}')"
: "CherryPick.openRootScope()";
final params = (field.namedValue != null && field.namedValue!.isNotEmpty)
? "(named: '${field.namedValue}')"
: '()';
return " instance.${field.fieldName} = $openCall.$resolveMethod$params;";
}
}
/// Data structure representing all information required to generate
/// injection code for a field.
///
/// Структура данных, содержащая всю информацию,
/// необходимую для генерации кода внедрения для поля.
class _ParsedInjectField {
/// The name of the field / Имя поля.
final String fieldName;
/// The base type name (T or Future<T>) / Базовый тип (T или тип из Future<T>).
final String coreType;
/// True if the field type is Future<T>; false otherwise
/// Истина, если поле — Future<T>, иначе — ложь.
final bool isFuture;
/// Optional scope annotation argument / Опциональное имя scope.
final String? scopeName;
/// Optional named annotation argument / Опциональное имя named.
final String? namedValue;
final bool isNullable;
_ParsedInjectField({
required this.fieldName,
required this.coreType,
required this.isFuture,
required this.isNullable,
this.scopeName,
this.namedValue,
});
}
/// Builder factory. Used by build_runner.
///
/// Фабрика билдера. Используется build_runner.
Builder injectBuilder(BuilderOptions options) =>
PartBuilder([InjectGenerator()], '.inject.cherrypick.g.dart');

View File

@@ -0,0 +1,93 @@
//
// 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: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';
/// ---------------------------------------------------------------------------
/// ModuleGenerator for code generation of dependency-injected modules.
///
/// ENGLISH
/// This generator scans for Dart classes annotated with `@module()` and
/// automatically generates boilerplate code for dependency injection
/// (DI) based on the public methods in those classes. Each method can be
/// annotated to describe how an object should be provided to the DI container.
/// The generated code registers those methods as bindings. This automates the
/// creation of factories, singletons, and named instances, reducing repetitive
/// manual code.
///
/// RUSSIAN
/// Генератор зависимостей для DI-контейнера на основе аннотаций.
/// Данный генератор автоматически создаёт код для внедрения зависимостей (DI)
/// на основе аннотаций в вашем исходном коде. Когда вы отмечаете класс
/// аннотацией `@module()`, этот генератор обработает все его публичные методы
/// и автоматически сгенерирует класс с биндингами (регистрациями зависимостей)
/// для DI-контейнера. Это избавляет от написания однообразного шаблонного кода.
/// ---------------------------------------------------------------------------
class ModuleGenerator extends GeneratorForAnnotation<ann.module> {
/// -------------------------------------------------------------------------
/// ENGLISH
/// Generates the Dart source for a class marked with the `@module()` annotation.
/// - [element]: the original Dart class element.
/// - [annotation]: the annotation parameters (not usually used here).
/// - [buildStep]: the current build step info.
///
/// RUSSIAN
/// Генерирует исходный код для класса-модуля с аннотацией `@module()`.
/// [element] — исходный класс, помеченный аннотацией.
/// [annotation] — значения параметров аннотации.
/// [buildStep] — информация о текущем шаге генерации.
/// -------------------------------------------------------------------------
@override
String generateForAnnotatedElement(
Element element,
ConstantReader annotation,
BuildStep buildStep,
) {
// Only classes are supported for @module() annotation
// Обрабатываются только классы (другие элементы — ошибка)
if (element is! ClassElement) {
throw InvalidGenerationSourceError(
'@module() can only be applied to classes. / @module() может быть применён только к классам.',
element: element,
);
}
final classElement = element;
// Build a representation of the generated bindings based on class methods /
// Создаёт объект, описывающий, какие биндинги нужно сгенерировать на основании методов класса
final generatedClass = GeneratedClass.fromClassElement(classElement);
// Generate the resulting Dart code / Генерирует итоговый Dart-код
return generatedClass.generate();
}
}
/// ---------------------------------------------------------------------------
/// ENGLISH
/// Entry point for build_runner. Returns a Builder used to generate code for
/// every file with a @module() annotation.
///
/// RUSSIAN
/// Точка входа для генератора build_runner.
/// Возвращает Builder, используемый build_runner для генерации кода для всех
/// файлов, где встречается @module().
/// ---------------------------------------------------------------------------
Builder moduleBuilder(BuilderOptions options) =>
PartBuilder([ModuleGenerator()], '.module.cherrypick.g.dart');

View File

@@ -0,0 +1,321 @@
//
// 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:analyzer/dart/element/element.dart';
import 'exceptions.dart';
import 'metadata_utils.dart';
/// Validates annotation combinations and usage patterns
class AnnotationValidator {
/// Validates annotations on a method element
static void validateMethodAnnotations(MethodElement method) {
final annotations = _getAnnotationNames(method.metadata);
_validateMutuallyExclusiveAnnotations(method, annotations);
_validateAnnotationCombinations(method, annotations);
_validateAnnotationParameters(method);
}
/// Validates annotations on a field element
static void validateFieldAnnotations(FieldElement field) {
final annotations = _getAnnotationNames(field.metadata);
_validateInjectFieldAnnotations(field, annotations);
}
/// Validates annotations on a class element
static void validateClassAnnotations(ClassElement classElement) {
final annotations = _getAnnotationNames(classElement.metadata);
_validateModuleClassAnnotations(classElement, annotations);
_validateInjectableClassAnnotations(classElement, annotations);
}
static List<String> _getAnnotationNames(List<ElementAnnotation> metadata) {
return metadata
.map((m) => m.computeConstantValue()?.type?.getDisplayString())
.where((name) => name != null)
.cast<String>()
.toList();
}
static void _validateMutuallyExclusiveAnnotations(
MethodElement method,
List<String> annotations,
) {
// @instance and @provide are mutually exclusive
if (annotations.contains('instance') && annotations.contains('provide')) {
throw AnnotationValidationException(
'Method cannot have both @instance and @provide annotations',
element: method,
suggestion:
'Use either @instance for direct instances or @provide for factory methods',
context: {
'method_name': method.displayName,
'annotations': annotations,
},
);
}
}
static void _validateAnnotationCombinations(
MethodElement method,
List<String> annotations,
) {
// @params can only be used with @provide
if (annotations.contains('params') && !annotations.contains('provide')) {
throw AnnotationValidationException(
'@params annotation can only be used with @provide annotation',
element: method,
suggestion: 'Remove @params or add @provide annotation',
context: {
'method_name': method.displayName,
'annotations': annotations,
},
);
}
// Methods must have either @instance or @provide
if (!annotations.contains('instance') && !annotations.contains('provide')) {
throw AnnotationValidationException(
'Method must be marked with either @instance or @provide annotation',
element: method,
suggestion:
'Add @instance() for direct instances or @provide() for factory methods',
context: {
'method_name': method.displayName,
'available_annotations': annotations,
},
);
}
// @singleton validation
if (annotations.contains('singleton')) {
_validateSingletonUsage(method, annotations);
}
}
static void _validateSingletonUsage(
MethodElement method,
List<String> annotations,
) {
// Singleton with params might not make sense in some contexts
if (annotations.contains('params')) {
// This is a warning, not an error - could be useful for parameterized singletons
// We could add a warning system later
}
// Check if return type is suitable for singleton
final returnType = method.returnType.getDisplayString();
if (returnType == 'void') {
throw AnnotationValidationException(
'Singleton methods cannot return void',
element: method,
suggestion: 'Remove @singleton annotation or change return type',
context: {
'method_name': method.displayName,
'return_type': returnType,
},
);
}
}
static void _validateAnnotationParameters(MethodElement method) {
// Validate @named annotation parameters
final namedValue = MetadataUtils.getNamedValue(method.metadata);
if (namedValue != null) {
if (namedValue.isEmpty) {
throw AnnotationValidationException(
'@named annotation cannot have empty value',
element: method,
suggestion: 'Provide a non-empty string value for @named annotation',
context: {
'method_name': method.displayName,
'named_value': namedValue,
},
);
}
// Check for valid naming conventions
if (!RegExp(r'^[a-zA-Z_][a-zA-Z0-9_]*$').hasMatch(namedValue)) {
throw AnnotationValidationException(
'@named value should follow valid identifier naming conventions',
element: method,
suggestion:
'Use alphanumeric characters and underscores only, starting with a letter or underscore',
context: {
'method_name': method.displayName,
'named_value': namedValue,
},
);
}
}
// Validate method parameters for @params usage
for (final param in method.parameters) {
final paramAnnotations = _getAnnotationNames(param.metadata);
if (paramAnnotations.contains('params')) {
_validateParamsParameter(param, method);
}
}
}
static void _validateParamsParameter(
ParameterElement param, MethodElement method) {
// @params parameter should typically be dynamic or Map<String, dynamic>
final paramType = param.type.getDisplayString();
if (paramType != 'dynamic' &&
paramType != 'Map<String, dynamic>' &&
paramType != 'Map<String, dynamic>?') {
// This is more of a warning - other types might be valid
// We could add a warning system for this
}
// Check if parameter is required when using @params
try {
final hasDefault = (param as dynamic).defaultValue != null;
if (param.isRequired && !hasDefault) {
// This might be intentional, so we don't throw an error
// but we could warn about it
}
} catch (e) {
// Ignore if defaultValue is not available in this analyzer version
}
}
static void _validateInjectFieldAnnotations(
FieldElement field,
List<String> annotations,
) {
if (!annotations.contains('inject')) {
return; // Not an inject field, nothing to validate
}
// Check if field type is suitable for injection
final fieldType = field.type.getDisplayString();
if (fieldType == 'void') {
throw AnnotationValidationException(
'Cannot inject void type',
element: field,
suggestion: 'Use a concrete type instead of void',
context: {
'field_name': field.displayName,
'field_type': fieldType,
},
);
}
// Validate scope annotation if present
for (final meta in field.metadata) {
final obj = meta.computeConstantValue();
final type = obj?.type?.getDisplayString();
if (type == 'scope') {
// Empty scope name is treated as no scope (uses root scope)
// This is allowed for backward compatibility and convenience
}
}
}
static void _validateModuleClassAnnotations(
ClassElement classElement,
List<String> annotations,
) {
if (!annotations.contains('module')) {
return; // Not a module class
}
// Check if class has public methods
final publicMethods =
classElement.methods.where((m) => m.isPublic).toList();
if (publicMethods.isEmpty) {
throw AnnotationValidationException(
'Module class must have at least one public method',
element: classElement,
suggestion: 'Add public methods with @instance or @provide annotations',
context: {
'class_name': classElement.displayName,
'method_count': publicMethods.length,
},
);
}
// Validate that public methods have appropriate annotations
for (final method in publicMethods) {
final methodAnnotations = _getAnnotationNames(method.metadata);
if (!methodAnnotations.contains('instance') &&
!methodAnnotations.contains('provide')) {
throw AnnotationValidationException(
'Public methods in module class must have @instance or @provide annotation',
element: method,
suggestion: 'Add @instance() or @provide() annotation to the method',
context: {
'class_name': classElement.displayName,
'method_name': method.displayName,
},
);
}
}
}
static void _validateInjectableClassAnnotations(
ClassElement classElement,
List<String> annotations,
) {
if (!annotations.contains('injectable')) {
return; // Not an injectable class
}
// Check if class has injectable fields
final injectFields = classElement.fields.where((f) {
final fieldAnnotations = _getAnnotationNames(f.metadata);
return fieldAnnotations.contains('inject');
}).toList();
// Allow injectable classes without @inject fields to generate empty mixins
// This can be useful for classes that will have @inject fields added later
// or for testing purposes
if (injectFields.isEmpty) {
// Just log a warning but don't throw an exception
// print('Warning: Injectable class ${classElement.displayName} has no @inject fields');
}
// Validate that injectable fields are properly declared
for (final field in injectFields) {
// Injectable fields should be late final for immutability after injection
if (!field.isFinal) {
throw AnnotationValidationException(
'Injectable fields should be final for immutability',
element: field,
suggestion:
'Add final keyword to injectable field (preferably late final)',
context: {
'class_name': classElement.displayName,
'field_name': field.displayName,
},
);
}
// Check if field is late (recommended pattern)
try {
final isLate = (field as dynamic).isLate ?? false;
if (!isLate) {
// This is a warning, not an error - late final is recommended but not required
// We could add a warning system later
}
} catch (e) {
// Ignore if isLate is not available in this analyzer version
}
}
}
}

View File

@@ -0,0 +1,75 @@
//
// 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.
//
/// ----------------------------------------------------------------------------
/// BindParameterSpec - describes a single method parameter and how to resolve it.
///
/// ENGLISH
/// Describes a single parameter for a provider/binding method in the DI system.
/// Stores the parameter type, its optional `@named` key for named resolution,
/// and whether it is a runtime "params" argument. Used to generate code that
/// resolves dependencies from the DI scope:
/// - If the parameter is a dependency type (e.g. SomeDep), emits:
/// currentScope.resolve<SomeDep>()
/// - If the parameter is named, emits:
/// currentScope.resolve<SomeDep>(named: 'yourName')
/// - If it's a runtime parameter (e.g. via @params()), emits:
/// args
///
/// RUSSIAN
/// Описывает один параметр метода в DI, и его способ разрешения из контейнера.
/// Сохраняет имя типа, дополнительное имя (если параметр аннотирован через @named),
/// и признак runtime-параметра (@params).
/// Для обычной зависимости типа (например, SomeDep) генерирует строку вида:
/// currentScope.resolve<SomeDep>()
/// Для зависимости с именем:
/// currentScope.resolve<SomeDep>(named: 'имя')
/// Для runtime-параметра:
/// args
/// ----------------------------------------------------------------------------
class BindParameterSpec {
/// Type name of the parameter (e.g. SomeService)
/// Имя типа параметра (например, SomeService)
final String typeName;
/// Optional name for named resolution (from @named)
/// Необязательное имя для разрешения по имени (если аннотировано через @named)
final String? named;
/// True if this parameter uses @params and should be provided from runtime args
/// Признак, что параметр — runtime (через @params)
final bool isParams;
BindParameterSpec(this.typeName, this.named, {this.isParams = false});
/// --------------------------------------------------------------------------
/// generateArg
///
/// ENGLISH
/// Generates Dart code for resolving the dependency from the DI scope,
/// considering type, named, and param-argument.
///
/// RUSSIAN
/// Генерирует строку для получения зависимости из DI scope (с учётом имени
/// и типа параметра или runtime-режима @params).
/// --------------------------------------------------------------------------
String generateArg([String paramsVar = 'args']) {
if (isParams) {
return paramsVar;
}
if (named != null) {
return "currentScope.resolve<$typeName>(named: '$named')";
}
return "currentScope.resolve<$typeName>()";
}
}

View File

@@ -0,0 +1,349 @@
//
// 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:analyzer/dart/element/element.dart';
import 'bind_parameters_spec.dart';
import 'metadata_utils.dart';
import 'exceptions.dart';
import 'type_parser.dart';
import 'annotation_validator.dart';
enum BindingType {
instance,
provide;
}
/// ---------------------------------------------------------------------------
/// BindSpec -- describes a binding specification generated for a dependency.
///
/// ENGLISH
/// Represents all the data necessary to generate a DI binding for a single
/// method in a module class. Each BindSpec corresponds to one public method
/// and contains information about its type, provider method, lifecycle (singleton),
/// parameters (with their annotations), binding strategy (instance/provide),
/// asynchronous mode, and named keys. It is responsible for generating the
/// correct Dart code to register this binding with the DI container, in both
/// sync and async cases, with and without named or runtime arguments.
///
/// RUSSIAN
/// Описывает параметры для создания одного биндинга зависимости (binding spec).
/// Каждый биндинг соответствует одному публичному методу класса-модуля и
/// содержит всю информацию для генерации кода регистрации этого биндинга в
/// DI-контейнере: тип возвращаемой зависимости, имя метода, параметры, аннотации
/// (@singleton, @named, @instance, @provide), асинхронность, признак runtime
/// аргументов и др. Генерирует правильный Dart-код для регистрации биндера.
/// ---------------------------------------------------------------------------
class BindSpec {
/// The type this binding provides (e.g. SomeService)
/// Тип, который предоставляет биндинг (например, SomeService)
final String returnType;
/// Method name that implements the binding
/// Имя метода, который реализует биндинг
final String methodName;
/// Optional name for named dependency (from @named)
/// Необязательное имя, для именованной зависимости (используется с @named)
final String? named;
/// Whether the dependency is a singleton (@singleton annotation)
/// Является ли зависимость синглтоном (имеется ли аннотация @singleton)
final bool isSingleton;
/// List of method parameters to inject dependencies with
/// Список параметров, которые требуются методу для внедрения зависимостей
final List<BindParameterSpec> parameters;
/// Binding type: 'instance' or 'provide' (@instance or @provide)
final BindingType bindingType; // 'instance' | 'provide'
/// True if the method is asynchronous and uses instance binding (Future)
final bool isAsyncInstance;
/// True if the method is asynchronous and uses provide binding (Future)
final bool isAsyncProvide;
/// True if the binding method accepts runtime "params" argument (@params)
final bool hasParams;
BindSpec({
required this.returnType,
required this.methodName,
required this.isSingleton,
required this.parameters,
this.named,
required this.bindingType,
required this.isAsyncInstance,
required this.isAsyncProvide,
required this.hasParams,
});
/// -------------------------------------------------------------------------
/// generateBind
///
/// ENGLISH
/// Generates a line of Dart code registering the binding with the DI framework.
/// Produces something like:
/// bind<Type>().toProvide(() => method(args)).withName('name').singleton();
/// Indent parameter allows formatted multiline output.
///
/// RUSSIAN
/// Формирует dart-код для биндинга, например:
/// bind<Type>().toProvide(() => method(args)).withName('name').singleton();
/// Параметр [indent] задаёт отступ для красивого форматирования кода.
/// -------------------------------------------------------------------------
String generateBind(int indent) {
final indentStr = ' ' * indent;
final provide = _generateProvideClause(indent);
final postfix = _generatePostfix();
// Create the full single-line version first
final singleLine = '${indentStr}bind<$returnType>()$provide$postfix;';
// Check if we need multiline formatting
final needsMultiline = singleLine.length > 80 || provide.contains('\n');
if (!needsMultiline) {
return singleLine;
}
// For multiline formatting, check if we need to break after bind<Type>()
if (provide.contains('\n')) {
// Provider clause is already multiline
if (postfix.isNotEmpty) {
// If there's a postfix, break after bind<Type>()
final multilinePostfix = _generateMultilinePostfix(indent);
return '${indentStr}bind<$returnType>()'
'\n${' ' * (indent + 4)}$provide'
'$multilinePostfix;';
} else {
// No postfix, keep bind<Type>() with provide start
return '${indentStr}bind<$returnType>()$provide;';
}
} else {
// Simple multiline: break after bind<Type>()
if (postfix.isNotEmpty) {
final multilinePostfix = _generateMultilinePostfix(indent);
return '${indentStr}bind<$returnType>()'
'\n${' ' * (indent + 4)}$provide'
'$multilinePostfix;';
} else {
return '${indentStr}bind<$returnType>()'
'\n${' ' * (indent + 4)}$provide;';
}
}
}
// Internal method: decides how the provide clause should be generated by param kind.
String _generateProvideClause(int indent) {
if (hasParams) return _generateWithParamsProvideClause(indent);
return _generatePlainProvideClause(indent);
}
/// EN / RU: Supports runtime parameters (@params).
String _generateWithParamsProvideClause(int indent) {
// Safe variable name for parameters.
const paramVar = 'args';
final fnArgs = parameters.map((p) => p.generateArg(paramVar)).join(', ');
// Use multiline format only if args are long or contain newlines
final multiLine = fnArgs.length > 60 || fnArgs.contains('\n');
switch (bindingType) {
case BindingType.instance:
throw StateError(
'Internal error: _generateWithParamsProvideClause called for @instance binding with @params.');
//return isAsyncInstance
// ? '.toInstanceAsync(($fnArgs) => $methodName($fnArgs))'
// : '.toInstance(($fnArgs) => $methodName($fnArgs))';
case BindingType.provide:
if (isAsyncProvide) {
return multiLine
? '.toProvideAsyncWithParams(\n${' ' * (indent + 2)}($paramVar) => $methodName($fnArgs))'
: '.toProvideAsyncWithParams(($paramVar) => $methodName($fnArgs))';
} else {
return multiLine
? '.toProvideWithParams(\n${' ' * (indent + 2)}($paramVar) => $methodName($fnArgs))'
: '.toProvideWithParams(($paramVar) => $methodName($fnArgs))';
}
}
}
/// EN / RU: Supports only injected dependencies, not runtime (@params).
String _generatePlainProvideClause(int indent) {
final argsStr = parameters.map((p) => p.generateArg()).join(', ');
// Check if we need multiline formatting based on total line length
final singleLineCall = '$methodName($argsStr)';
final needsMultiline =
singleLineCall.length >= 45 || argsStr.contains('\n');
switch (bindingType) {
case BindingType.instance:
return isAsyncInstance
? '.toInstanceAsync($methodName($argsStr))'
: '.toInstance($methodName($argsStr))';
case BindingType.provide:
if (isAsyncProvide) {
if (needsMultiline) {
final lambdaIndent =
(isSingleton || named != null) ? indent + 6 : indent + 2;
final closingIndent =
(isSingleton || named != null) ? indent + 4 : indent;
return '.toProvideAsync(\n${' ' * lambdaIndent}() => $methodName($argsStr),\n${' ' * closingIndent})';
} else {
return '.toProvideAsync(() => $methodName($argsStr))';
}
} else {
if (needsMultiline) {
final lambdaIndent =
(isSingleton || named != null) ? indent + 6 : indent + 2;
final closingIndent =
(isSingleton || named != null) ? indent + 4 : indent;
return '.toProvide(\n${' ' * lambdaIndent}() => $methodName($argsStr),\n${' ' * closingIndent})';
} else {
return '.toProvide(() => $methodName($argsStr))';
}
}
}
}
/// EN / RU: Adds .withName and .singleton if needed.
String _generatePostfix() {
final namePart = named != null ? ".withName('$named')" : '';
final singletonPart = isSingleton ? '.singleton()' : '';
return '$namePart$singletonPart';
}
/// EN / RU: Generates multiline postfix with proper indentation.
String _generateMultilinePostfix(int indent) {
final parts = <String>[];
if (named != null) {
parts.add(".withName('$named')");
}
if (isSingleton) {
parts.add('.singleton()');
}
if (parts.isEmpty) return '';
return parts.map((part) => '\n${' ' * (indent + 4)}$part').join('');
}
/// -------------------------------------------------------------------------
/// fromMethod
///
/// ENGLISH
/// Creates a BindSpec from a module class method by analyzing its return type,
/// annotations, list of parameters (with their own annotations), and async-ness.
/// Throws if a method does not have the required @instance() or @provide().
///
/// RUSSIAN
/// Создаёт спецификацию биндинга (BindSpec) из метода класса-модуля, анализируя
/// возвращаемый тип, аннотации, параметры (и их аннотации), а также факт
/// асинхронности. Если нет @instance или @provide — кидает ошибку.
/// -------------------------------------------------------------------------
static BindSpec fromMethod(MethodElement method) {
try {
// Validate method annotations
AnnotationValidator.validateMethodAnnotations(method);
// Parse return type using improved type parser
final parsedReturnType = TypeParser.parseType(method.returnType, method);
final methodName = method.displayName;
// Check for @singleton annotation.
final isSingleton = MetadataUtils.anyMeta(method.metadata, 'singleton');
// Get @named value if present.
final named = MetadataUtils.getNamedValue(method.metadata);
// Parse each method parameter.
final params = <BindParameterSpec>[];
bool hasParams = false;
for (final p in method.parameters) {
final typeStr = p.type.getDisplayString();
final paramNamed = MetadataUtils.getNamedValue(p.metadata);
final isParams = MetadataUtils.anyMeta(p.metadata, 'params');
if (isParams) hasParams = true;
params.add(BindParameterSpec(typeStr, paramNamed, isParams: isParams));
}
// Determine bindingType: @instance or @provide.
final hasInstance = MetadataUtils.anyMeta(method.metadata, 'instance');
final hasProvide = MetadataUtils.anyMeta(method.metadata, 'provide');
if (!hasInstance && !hasProvide) {
throw AnnotationValidationException(
'Method must be marked with either @instance() or @provide() annotation',
element: method,
suggestion:
'Add @instance() for direct instances or @provide() for factory methods',
context: {
'method_name': methodName,
'return_type': parsedReturnType.displayString,
},
);
}
final bindingType =
hasInstance ? BindingType.instance : BindingType.provide;
// PROHIBIT @params with @instance bindings!
if (bindingType == BindingType.instance && hasParams) {
throw AnnotationValidationException(
'@params() (runtime arguments) cannot be used together with @instance()',
element: method,
suggestion: 'Use @provide() instead if you want runtime arguments',
context: {
'method_name': methodName,
'binding_type': 'instance',
'has_params': hasParams,
},
);
}
// Set async flags based on parsed type
final isAsyncInstance =
bindingType == BindingType.instance && parsedReturnType.isFuture;
final isAsyncProvide =
bindingType == BindingType.provide && parsedReturnType.isFuture;
return BindSpec(
returnType: parsedReturnType.codeGenType,
methodName: methodName,
isSingleton: isSingleton,
named: named,
parameters: params,
bindingType: bindingType,
isAsyncInstance: isAsyncInstance,
isAsyncProvide: isAsyncProvide,
hasParams: hasParams,
);
} catch (e) {
if (e is CherryPickGeneratorException) {
rethrow;
}
throw CodeGenerationException(
'Failed to create BindSpec from method "${method.displayName}"',
element: method,
suggestion:
'Check that the method has valid annotations and return type',
context: {
'method_name': method.displayName,
'return_type': method.returnType.getDisplayString(),
'error': e.toString(),
},
);
}
}
}

View File

@@ -0,0 +1,117 @@
//
// 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:analyzer/dart/element/element.dart';
import 'package:source_gen/source_gen.dart';
/// Enhanced exception class for CherryPick generator with detailed context information
class CherryPickGeneratorException extends InvalidGenerationSourceError {
final String category;
final String? suggestion;
final Map<String, dynamic>? context;
CherryPickGeneratorException(
String message, {
required Element element,
required this.category,
this.suggestion,
this.context,
}) : super(
_formatMessage(message, category, suggestion, context, element),
element: element,
);
static String _formatMessage(
String message,
String category,
String? suggestion,
Map<String, dynamic>? context,
Element element,
) {
final buffer = StringBuffer();
// Header with category
buffer.writeln('[$category] $message');
// Element context
buffer.writeln('');
buffer.writeln('Context:');
buffer.writeln(' Element: ${element.displayName}');
buffer.writeln(' Type: ${element.runtimeType}');
buffer.writeln(' Location: ${element.source?.fullName ?? 'unknown'}');
// Note: enclosingElement may not be available in all analyzer versions
try {
final enclosing = (element as dynamic).enclosingElement;
if (enclosing != null) {
buffer.writeln(' Enclosing: ${enclosing.displayName}');
}
} catch (e) {
// Ignore if enclosingElement is not available
}
// Additional context
if (context != null && context.isNotEmpty) {
buffer.writeln('');
buffer.writeln('Additional Context:');
context.forEach((key, value) {
buffer.writeln(' $key: $value');
});
}
// Suggestion
if (suggestion != null) {
buffer.writeln('');
buffer.writeln('💡 Suggestion: $suggestion');
}
return buffer.toString();
}
}
/// Specific exception types for different error categories
class AnnotationValidationException extends CherryPickGeneratorException {
AnnotationValidationException(
super.message, {
required super.element,
super.suggestion,
super.context,
}) : super(category: 'ANNOTATION_VALIDATION');
}
class TypeParsingException extends CherryPickGeneratorException {
TypeParsingException(
super.message, {
required super.element,
super.suggestion,
super.context,
}) : super(category: 'TYPE_PARSING');
}
class CodeGenerationException extends CherryPickGeneratorException {
CodeGenerationException(
super.message, {
required super.element,
super.suggestion,
super.context,
}) : super(category: 'CODE_GENERATION');
}
class DependencyResolutionException extends CherryPickGeneratorException {
DependencyResolutionException(
super.message, {
required super.element,
super.suggestion,
super.context,
}) : super(category: 'DEPENDENCY_RESOLUTION');
}

View File

@@ -0,0 +1,122 @@
//
// 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:analyzer/dart/element/element.dart';
import 'bind_spec.dart';
/// ---------------------------------------------------------------------------
/// GeneratedClass -- represents the result of processing a single module class.
///
/// ENGLISH
/// Encapsulates all the information produced from analyzing a DI module class:
/// - The original class name,
/// - Its generated class name (e.g., `$SomeModule`),
/// - The collection of bindings (BindSpec) for all implemented provider methods.
///
/// Also provides code generation functionality, allowing to generate the source
/// code for the derived DI module class, including all binding registrations.
///
/// RUSSIAN
/// Описывает результат обработки одного класса-модуля DI:
/// - Имя оригинального класса,
/// - Имя генерируемого класса (например, `$SomeModule`),
/// - Список всех бидингов (BindSpec) — по публичным методам модуля.
///
/// Также содержит функцию генерации исходного кода для этого класса и
/// регистрации всех зависимостей через bind(...).
/// ---------------------------------------------------------------------------
class GeneratedClass {
/// The name of the original module class.
/// Имя исходного класса-модуля
final String className;
/// The name of the generated class (e.g., $SomeModule).
/// Имя генерируемого класса (например, $SomeModule)
final String generatedClassName;
/// List of all discovered bindings for the class.
/// Список всех обнаруженных биндингов
final List<BindSpec> binds;
/// Source file name for the part directive
/// Имя исходного файла для part директивы
final String sourceFile;
GeneratedClass(
this.className,
this.generatedClassName,
this.binds,
this.sourceFile,
);
/// -------------------------------------------------------------------------
/// fromClassElement
///
/// ENGLISH
/// Static factory: creates a GeneratedClass from a Dart ClassElement (AST representation).
/// Discovers all non-abstract methods, builds BindSpec for each, and computes the
/// generated class name by prefixing `$`.
///
/// RUSSIAN
/// Строит объект класса по элементу AST (ClassElement): имя класса,
/// сгенерированное имя, список BindSpec по всем не абстрактным методам.
/// Имя ген-класса строится с префиксом `$`.
/// -------------------------------------------------------------------------
static GeneratedClass fromClassElement(ClassElement element) {
final className = element.displayName;
// Generated class name with '$' prefix (standard for generated Dart code).
final generatedClassName = r'$' + className;
// Get source file name
final sourceFile = element.source.shortName;
// Collect bindings for all non-abstract methods.
final binds = element.methods
.where((m) => !m.isAbstract)
.map(BindSpec.fromMethod)
.toList();
return GeneratedClass(className, generatedClassName, binds, sourceFile);
}
/// -------------------------------------------------------------------------
/// generate
///
/// ENGLISH
/// Generates Dart source code for the DI module class. The generated class
/// inherits from the original, overrides the 'builder' method, and registers
/// all bindings in the DI scope.
///
/// RUSSIAN
/// Генерирует исходный Dart-код для класса-модуля DI.
/// Новая версия класса наследует оригинальный, переопределяет builder(Scope),
/// и регистрирует все зависимости через методы bind<Type>()...
/// -------------------------------------------------------------------------
String generate() {
final buffer = StringBuffer()
..writeln('final class $generatedClassName extends $className {')
..writeln(' @override')
..writeln(' void builder(Scope currentScope) {');
// For each binding, generate bind<Type>() code string.
// Для каждого биндинга — генерируем строку bind<Type>()...
for (final bind in binds) {
buffer.writeln(bind.generateBind(4));
}
buffer
..writeln(' }')
..writeln('}');
return buffer.toString();
}
}

View File

@@ -0,0 +1,76 @@
//
// 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:analyzer/dart/element/element.dart';
/// ---------------------------------------------------------------------------
/// MetadataUtils -- utilities for analyzing method and parameter annotations.
///
/// ENGLISH
/// Provides static utility methods to analyze Dart annotations on methods or
/// parameters. For instance, helps to find if an element is annotated with
/// `@named()`, `@singleton()`, or other meta-annotations used in this DI framework.
///
/// RUSSIAN
/// Утилиты для разбора аннотаций методов и параметров.
/// Позволяют находить наличие аннотаций, например, @named() и @singleton(),
/// у методов и параметров. Используется для анализа исходного кода при генерации.
/// ---------------------------------------------------------------------------
class MetadataUtils {
/// -------------------------------------------------------------------------
/// anyMeta
///
/// ENGLISH
/// Checks if any annotation in the list has a type name that contains
/// [typeName] (case insensitive).
///
/// RUSSIAN
/// Проверяет: есть ли среди аннотаций метка, имя которой содержит [typeName]
/// (регистр не учитывается).
/// -------------------------------------------------------------------------
static bool anyMeta(List<ElementAnnotation> meta, String typeName) {
return meta.any((m) =>
m
.computeConstantValue()
?.type
?.getDisplayString()
.toLowerCase()
.contains(typeName.toLowerCase()) ??
false);
}
/// -------------------------------------------------------------------------
/// getNamedValue
///
/// ENGLISH
/// Retrieves the value from a `@named('value')` annotation if present.
/// Returns the string value or null if not found.
///
/// RUSSIAN
/// Находит значение из аннотации @named('значение').
/// Возвращает строку значения, если аннотация присутствует; иначе null.
/// -------------------------------------------------------------------------
static String? getNamedValue(List<ElementAnnotation> meta) {
for (final m in meta) {
final cv = m.computeConstantValue();
final typeStr = cv?.type?.getDisplayString().toLowerCase();
if (typeStr?.contains('named') ?? false) {
return cv?.getField('value')?.toStringValue();
}
}
return null;
}
}

View File

@@ -0,0 +1,218 @@
//
// 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:analyzer/dart/element/element.dart';
import 'package:analyzer/dart/element/nullability_suffix.dart';
import 'package:analyzer/dart/element/type.dart';
import 'exceptions.dart';
/// Enhanced type parser that uses AST analysis instead of regular expressions
class TypeParser {
/// Parses a DartType and extracts detailed type information
static ParsedType parseType(DartType dartType, Element context) {
try {
return _parseTypeInternal(dartType, context);
} catch (e) {
throw TypeParsingException(
'Failed to parse type: ${dartType.getDisplayString()}',
element: context,
suggestion: 'Ensure the type is properly imported and accessible',
context: {
'original_type': dartType.getDisplayString(),
'error': e.toString(),
},
);
}
}
static ParsedType _parseTypeInternal(DartType dartType, Element context) {
final displayString = dartType.getDisplayString();
final isNullable = dartType.nullabilitySuffix == NullabilitySuffix.question;
// Check if it's a Future type
if (dartType.isDartAsyncFuture) {
return _parseFutureType(dartType, context, isNullable);
}
// Check if it's a generic type (List, Map, etc.)
if (dartType is ParameterizedType && dartType.typeArguments.isNotEmpty) {
return _parseGenericType(dartType, context, isNullable);
}
// Simple type
return ParsedType(
displayString: displayString,
coreType: displayString.replaceAll('?', ''),
isNullable: isNullable,
isFuture: false,
isGeneric: false,
typeArguments: [],
);
}
static ParsedType _parseFutureType(
DartType dartType, Element context, bool isNullable) {
if (dartType is! ParameterizedType || dartType.typeArguments.isEmpty) {
throw TypeParsingException(
'Future type must have a type argument',
element: context,
suggestion: 'Use Future<T> instead of raw Future',
context: {'type': dartType.getDisplayString()},
);
}
final innerType = dartType.typeArguments.first;
final innerParsed = _parseTypeInternal(innerType, context);
return ParsedType(
displayString: dartType.getDisplayString(),
coreType: innerParsed.coreType,
isNullable: isNullable || innerParsed.isNullable,
isFuture: true,
isGeneric: innerParsed.isGeneric,
typeArguments: innerParsed.typeArguments,
innerType: innerParsed,
);
}
static ParsedType _parseGenericType(
ParameterizedType dartType, Element context, bool isNullable) {
final typeArguments = dartType.typeArguments
.map((arg) => _parseTypeInternal(arg, context))
.toList();
final baseType = dartType.element?.name ?? dartType.getDisplayString();
return ParsedType(
displayString: dartType.getDisplayString(),
coreType: baseType,
isNullable: isNullable,
isFuture: false,
isGeneric: true,
typeArguments: typeArguments,
);
}
/// Validates that a type is suitable for dependency injection
static void validateInjectableType(ParsedType parsedType, Element context) {
// Check for void type
if (parsedType.coreType == 'void') {
throw TypeParsingException(
'Cannot inject void type',
element: context,
suggestion: 'Use a concrete type instead of void',
);
}
// Check for dynamic type (warning)
if (parsedType.coreType == 'dynamic') {
// This could be a warning instead of an error
throw TypeParsingException(
'Using dynamic type reduces type safety',
element: context,
suggestion: 'Consider using a specific type instead of dynamic',
);
}
// Validate nested types for complex generics
for (final typeArg in parsedType.typeArguments) {
validateInjectableType(typeArg, context);
}
}
}
/// Represents a parsed type with detailed information
class ParsedType {
/// The full display string of the type (e.g., "Future<List<String>?>")
final String displayString;
/// The core type name without nullability and Future wrapper (e.g., "List<String>")
final String coreType;
/// Whether the type is nullable
final bool isNullable;
/// Whether the type is wrapped in Future
final bool isFuture;
/// Whether the type has generic parameters
final bool isGeneric;
/// Parsed type arguments for generic types
final List<ParsedType> typeArguments;
/// For Future types, the inner type
final ParsedType? innerType;
const ParsedType({
required this.displayString,
required this.coreType,
required this.isNullable,
required this.isFuture,
required this.isGeneric,
required this.typeArguments,
this.innerType,
});
/// Returns the type string suitable for code generation
String get codeGenType {
if (isFuture && innerType != null) {
return innerType!.codeGenType;
}
// For generic types, include type arguments
if (isGeneric && typeArguments.isNotEmpty) {
final args = typeArguments.map((arg) => arg.codeGenType).join(', ');
return '$coreType<$args>';
}
return coreType;
}
/// Returns whether this type should use tryResolve instead of resolve
bool get shouldUseTryResolve => isNullable;
/// Returns the appropriate resolve method name
String get resolveMethodName {
if (isFuture) {
return shouldUseTryResolve ? 'tryResolveAsync' : 'resolveAsync';
}
return shouldUseTryResolve ? 'tryResolve' : 'resolve';
}
@override
String toString() {
return 'ParsedType(displayString: $displayString, coreType: $coreType, '
'isNullable: $isNullable, isFuture: $isFuture, isGeneric: $isGeneric)';
}
@override
bool operator ==(Object other) {
if (identical(this, other)) return true;
return other is ParsedType &&
other.displayString == displayString &&
other.coreType == coreType &&
other.isNullable == isNullable &&
other.isFuture == isFuture &&
other.isGeneric == isGeneric;
}
@override
int get hashCode {
return displayString.hashCode ^
coreType.hashCode ^
isNullable.hashCode ^
isFuture.hashCode ^
isGeneric.hashCode;
}
}

View File

@@ -0,0 +1,27 @@
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
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
environment:
sdk: ">=3.5.2 <4.0.0"
# Add regular dependencies here.
dependencies:
cherrypick_annotations: ^1.1.0
analyzer: ^7.0.0
dart_style: ^3.0.0
build: ^2.4.1
source_gen: ^2.0.0
collection: ^1.18.0
dev_dependencies:
lints: ^4.0.0
mockito: ^5.4.4
test: ^1.25.8
build_test: ^2.1.7
build_runner: ^2.4.13

View File

@@ -0,0 +1,307 @@
//
// 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>()\n"
" .toProvideAsync(() => createApiClient())\n"
" .withName('mainApi')\n"
" .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'));
});
});
});
}

View File

@@ -0,0 +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';
// 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;
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);
});
}

View 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(),
);
}

View 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);
});
});
});
}

View 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(),
);
}

View 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);
});
});
});
}

View File

@@ -0,0 +1,235 @@
import 'package:test/test.dart';
import 'package:analyzer/dart/element/element.dart';
import 'package:analyzer/source/source.dart';
import 'package:cherrypick_generator/src/type_parser.dart';
import 'package:cherrypick_generator/src/exceptions.dart';
void main() {
group('TypeParser', () {
group('parseType', () {
test('should parse simple types correctly', () {
// This would require setting up analyzer infrastructure
// For now, we'll test the ParsedType class directly
});
test('should parse Future types correctly', () {
// This would require setting up analyzer infrastructure
// For now, we'll test the ParsedType class directly
});
test('should parse nullable types correctly', () {
// This would require setting up analyzer infrastructure
// For now, we'll test the ParsedType class directly
});
test('should throw TypeParsingException for invalid types', () {
// This would require setting up analyzer infrastructure
// For now, we'll test the ParsedType class directly
});
});
group('validateInjectableType', () {
test('should throw for void type', () {
final parsedType = ParsedType(
displayString: 'void',
coreType: 'void',
isNullable: false,
isFuture: false,
isGeneric: false,
typeArguments: [],
);
expect(
() => TypeParser.validateInjectableType(
parsedType, _createMockElement()),
throwsA(isA<TypeParsingException>()),
);
});
test('should throw for dynamic type', () {
final parsedType = ParsedType(
displayString: 'dynamic',
coreType: 'dynamic',
isNullable: false,
isFuture: false,
isGeneric: false,
typeArguments: [],
);
expect(
() => TypeParser.validateInjectableType(
parsedType, _createMockElement()),
throwsA(isA<TypeParsingException>()),
);
});
test('should pass for valid types', () {
final parsedType = ParsedType(
displayString: 'String',
coreType: 'String',
isNullable: false,
isFuture: false,
isGeneric: false,
typeArguments: [],
);
expect(
() => TypeParser.validateInjectableType(
parsedType, _createMockElement()),
returnsNormally,
);
});
});
});
group('ParsedType', () {
test('should return correct codeGenType for simple types', () {
final parsedType = ParsedType(
displayString: 'String',
coreType: 'String',
isNullable: false,
isFuture: false,
isGeneric: false,
typeArguments: [],
);
expect(parsedType.codeGenType, equals('String'));
});
test('should return correct codeGenType for Future types', () {
final innerType = ParsedType(
displayString: 'String',
coreType: 'String',
isNullable: false,
isFuture: false,
isGeneric: false,
typeArguments: [],
);
final parsedType = ParsedType(
displayString: 'Future<String>',
coreType: 'Future<String>',
isNullable: false,
isFuture: true,
isGeneric: false,
typeArguments: [],
innerType: innerType,
);
expect(parsedType.codeGenType, equals('String'));
});
test('should return correct resolveMethodName for sync types', () {
final parsedType = ParsedType(
displayString: 'String',
coreType: 'String',
isNullable: false,
isFuture: false,
isGeneric: false,
typeArguments: [],
);
expect(parsedType.resolveMethodName, equals('resolve'));
});
test('should return correct resolveMethodName for nullable sync types', () {
final parsedType = ParsedType(
displayString: 'String?',
coreType: 'String',
isNullable: true,
isFuture: false,
isGeneric: false,
typeArguments: [],
);
expect(parsedType.resolveMethodName, equals('tryResolve'));
});
test('should return correct resolveMethodName for async types', () {
final parsedType = ParsedType(
displayString: 'Future<String>',
coreType: 'String',
isNullable: false,
isFuture: true,
isGeneric: false,
typeArguments: [],
);
expect(parsedType.resolveMethodName, equals('resolveAsync'));
});
test('should return correct resolveMethodName for nullable async types',
() {
final parsedType = ParsedType(
displayString: 'Future<String?>',
coreType: 'String',
isNullable: true,
isFuture: true,
isGeneric: false,
typeArguments: [],
);
expect(parsedType.resolveMethodName, equals('tryResolveAsync'));
});
test('should implement equality correctly', () {
final parsedType1 = ParsedType(
displayString: 'String',
coreType: 'String',
isNullable: false,
isFuture: false,
isGeneric: false,
typeArguments: [],
);
final parsedType2 = ParsedType(
displayString: 'String',
coreType: 'String',
isNullable: false,
isFuture: false,
isGeneric: false,
typeArguments: [],
);
expect(parsedType1, equals(parsedType2));
expect(parsedType1.hashCode, equals(parsedType2.hashCode));
});
test('should implement toString correctly', () {
final parsedType = ParsedType(
displayString: 'String',
coreType: 'String',
isNullable: false,
isFuture: false,
isGeneric: false,
typeArguments: [],
);
final result = parsedType.toString();
expect(result, contains('ParsedType'));
expect(result, contains('String'));
expect(result, contains('isNullable: false'));
expect(result, contains('isFuture: false'));
});
});
}
// Mock element for testing
Element _createMockElement() {
return _MockElement();
}
class _MockElement implements Element {
@override
String get displayName => 'MockElement';
@override
String get name => 'MockElement';
@override
Source? get source => null;
@override
noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
}

140
doc/annotations_en.md Normal file
View 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
View 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/)
---

572
doc/cycle_detection.en.md Normal file
View File

@@ -0,0 +1,572 @@
# Circular Dependency Detection
CherryPick provides robust circular dependency detection to prevent infinite loops and stack overflow errors in your dependency injection setup.
## What are Circular Dependencies?
Circular dependencies occur when two or more services depend on each other directly or indirectly, creating a cycle in the dependency graph.
### Example of circular dependencies within a scope
```dart
class UserService {
final OrderService orderService;
UserService(this.orderService);
}
class OrderService {
final UserService userService;
OrderService(this.userService);
}
```
### Example of circular dependencies between scopes
```dart
// In parent scope
class ParentService {
final ChildService childService;
ParentService(this.childService); // Gets from child scope
}
// In child scope
class ChildService {
final ParentService parentService;
ChildService(this.parentService); // Gets from parent scope
}
```
## Detection Types
### 🔍 Local Detection
Detects circular dependencies within a single scope. Fast and efficient.
### 🌐 Global Detection
Detects circular dependencies across the entire scope hierarchy. Slower but provides complete protection.
## Usage
### Local Detection
```dart
final scope = Scope(null);
scope.enableCycleDetection(); // Enable local detection
scope.installModules([
Module((bind) {
bind<UserService>().to((scope) => UserService(scope.resolve<OrderService>()));
bind<OrderService>().to((scope) => OrderService(scope.resolve<UserService>()));
}),
]);
try {
final userService = scope.resolve<UserService>(); // Will throw CircularDependencyException
} catch (e) {
print(e); // CircularDependencyException: Circular dependency detected
}
```
### Global Detection
```dart
// Enable global detection for all scopes
CherryPick.enableGlobalCrossScopeCycleDetection();
final rootScope = CherryPick.openGlobalSafeRootScope();
final childScope = rootScope.openSubScope();
// Configure dependencies that create cross-scope cycles
rootScope.installModules([
Module((bind) {
bind<ParentService>().to((scope) => ParentService(childScope.resolve<ChildService>()));
}),
]);
childScope.installModules([
Module((bind) {
bind<ChildService>().to((scope) => ChildService(rootScope.resolve<ParentService>()));
}),
]);
try {
final parentService = rootScope.resolve<ParentService>(); // Will throw CircularDependencyException
} catch (e) {
print(e); // CircularDependencyException with detailed chain information
}
```
## CherryPick Helper API
### Global Settings
```dart
// Enable/disable local detection globally
CherryPick.enableGlobalCycleDetection();
CherryPick.disableGlobalCycleDetection();
// Enable/disable global cross-scope detection
CherryPick.enableGlobalCrossScopeCycleDetection();
CherryPick.disableGlobalCrossScopeCycleDetection();
// Check current settings
bool localEnabled = CherryPick.isGlobalCycleDetectionEnabled;
bool globalEnabled = CherryPick.isGlobalCrossScopeCycleDetectionEnabled;
```
### Per-Scope Settings
```dart
// Enable/disable for specific scope
CherryPick.enableCycleDetectionForScope(scope);
CherryPick.disableCycleDetectionForScope(scope);
// Enable/disable global detection for specific scope
CherryPick.enableGlobalCycleDetectionForScope(scope);
CherryPick.disableGlobalCycleDetectionForScope(scope);
```
### Safe Scope Creation
```dart
// Create scopes with detection automatically enabled
final safeRootScope = CherryPick.openSafeRootScope(); // Local detection enabled
final globalSafeRootScope = CherryPick.openGlobalSafeRootScope(); // Both local and global enabled
final safeSubScope = CherryPick.openSafeSubScope(parentScope); // Inherits parent settings
```
## Performance Considerations
| Detection Type | Overhead | Recommended Usage |
|----------------|----------|-------------------|
| **Local** | Minimal (~5%) | Development, Testing |
| **Global** | Moderate (~15%) | Complex hierarchies, Critical features |
| **Disabled** | None | Production (after testing) |
### Recommendations
- **Development**: Enable both local and global detection for maximum safety
- **Testing**: Keep detection enabled to catch issues early
- **Production**: Consider disabling for performance, but only after thorough testing
```dart
import 'package:flutter/foundation.dart';
void configureCycleDetection() {
if (kDebugMode) {
// Enable full protection in debug mode
CherryPick.enableGlobalCycleDetection();
CherryPick.enableGlobalCrossScopeCycleDetection();
} else {
// Disable in release mode for performance
CherryPick.disableGlobalCycleDetection();
CherryPick.disableGlobalCrossScopeCycleDetection();
}
}
```
## Architectural Patterns
### Repository Pattern
```dart
// ✅ Correct: Repository doesn't depend on service
class UserRepository {
final ApiClient apiClient;
UserRepository(this.apiClient);
}
class UserService {
final UserRepository repository;
UserService(this.repository);
}
// ❌ Incorrect: Circular dependency
class UserRepository {
final UserService userService; // Don't do this!
UserRepository(this.userService);
}
```
### Mediator Pattern
```dart
// ✅ Correct: Use mediator to break cycles
abstract class EventBus {
void publish<T>(T event);
Stream<T> listen<T>();
}
class UserService {
final EventBus eventBus;
UserService(this.eventBus);
void createUser(User user) {
// ... create user logic
eventBus.publish(UserCreatedEvent(user));
}
}
class OrderService {
final EventBus eventBus;
OrderService(this.eventBus) {
eventBus.listen<UserCreatedEvent>().listen(_onUserCreated);
}
void _onUserCreated(UserCreatedEvent event) {
// React to user creation without direct dependency
}
}
```
## Scope Hierarchy Best Practices
### Proper Dependency Flow
```dart
// ✅ Correct: Dependencies flow downward in hierarchy
// Root Scope: Core services
final rootScope = CherryPick.openGlobalSafeRootScope();
rootScope.installModules([
Module((bind) {
bind<DatabaseService>().singleton((scope) => DatabaseService());
bind<ApiClient>().singleton((scope) => ApiClient());
}),
]);
// Feature Scope: Feature-specific services
final featureScope = rootScope.openSubScope();
featureScope.installModules([
Module((bind) {
bind<UserRepository>().to((scope) => UserRepository(scope.resolve<ApiClient>()));
bind<UserService>().to((scope) => UserService(scope.resolve<UserRepository>()));
}),
]);
// UI Scope: UI-specific services
final uiScope = featureScope.openSubScope();
uiScope.installModules([
Module((bind) {
bind<UserController>().to((scope) => UserController(scope.resolve<UserService>()));
}),
]);
```
### Avoid Cross-Scope Dependencies
```dart
// ❌ Incorrect: Child scope depending on parent's specific services
childScope.installModules([
Module((bind) {
bind<ChildService>().to((scope) =>
ChildService(rootScope.resolve<ParentService>()) // Risky!
);
}),
]);
// ✅ Correct: Use interfaces and proper dependency injection
abstract class IParentService {
void doSomething();
}
class ParentService implements IParentService {
void doSomething() { /* implementation */ }
}
// In root scope
rootScope.installModules([
Module((bind) {
bind<IParentService>().to((scope) => ParentService());
}),
]);
// In child scope - resolve through normal hierarchy
childScope.installModules([
Module((bind) {
bind<ChildService>().to((scope) =>
ChildService(scope.resolve<IParentService>()) // Safe!
);
}),
]);
```
## Debug Mode
### Resolution Chain Tracking
```dart
// Enable debug mode to track resolution chains
final scope = CherryPick.openGlobalSafeRootScope();
// Access current resolution chain for debugging
print('Current resolution chain: ${scope.currentResolutionChain}');
// Access global resolution chain
print('Global resolution chain: ${GlobalCycleDetector.instance.currentGlobalResolutionChain}');
```
### Exception Details
```dart
try {
final service = scope.resolve<CircularService>();
} on CircularDependencyException catch (e) {
print('Error: ${e.message}');
print('Dependency chain: ${e.dependencyChain.join(' -> ')}');
// For global detection, additional context is available
if (e.message.contains('cross-scope')) {
print('This is a cross-scope circular dependency');
}
}
```
## Testing Integration
### Unit Tests
```dart
import 'package:test/test.dart';
import 'package:cherrypick/cherrypick.dart';
void main() {
group('Circular Dependency Detection', () {
setUp(() {
// Enable detection for tests
CherryPick.enableGlobalCycleDetection();
CherryPick.enableGlobalCrossScopeCycleDetection();
});
tearDown(() {
// Clean up after tests
CherryPick.disableGlobalCycleDetection();
CherryPick.disableGlobalCrossScopeCycleDetection();
});
test('should detect circular dependency', () {
final scope = CherryPick.openGlobalSafeRootScope();
scope.installModules([
Module((bind) {
bind<ServiceA>().to((scope) => ServiceA(scope.resolve<ServiceB>()));
bind<ServiceB>().to((scope) => ServiceB(scope.resolve<ServiceA>()));
}),
]);
expect(
() => scope.resolve<ServiceA>(),
throwsA(isA<CircularDependencyException>()),
);
});
});
}
```
### Integration Tests
```dart
testWidgets('should handle circular dependencies in widget tree', (tester) async {
// Enable detection
CherryPick.enableGlobalCycleDetection();
await tester.pumpWidget(
CherryPickProvider(
create: () {
final scope = CherryPick.openGlobalSafeRootScope();
// Configure modules that might have cycles
return scope;
},
child: MyApp(),
),
);
// Test that circular dependencies are properly handled
expect(find.text('Error: Circular dependency detected'), findsNothing);
});
```
## Migration Guide
### From Version 2.1.x to 2.2.x
1. **Update dependencies**:
```yaml
dependencies:
cherrypick: ^2.2.0
```
2. **Enable detection in existing code**:
```dart
// Before
final scope = Scope(null);
// After - with local detection
final scope = CherryPick.openSafeRootScope();
// Or with global detection
final scope = CherryPick.openGlobalSafeRootScope();
```
3. **Update error handling**:
```dart
try {
final service = scope.resolve<MyService>();
} on CircularDependencyException catch (e) {
// Handle circular dependency errors
logger.error('Circular dependency detected: ${e.dependencyChain}');
}
```
4. **Configure for production**:
```dart
void main() {
// Configure detection based on build mode
if (kDebugMode) {
CherryPick.enableGlobalCycleDetection();
CherryPick.enableGlobalCrossScopeCycleDetection();
}
runApp(MyApp());
}
```
## API Reference
### Scope Methods
```dart
class Scope {
// Local cycle detection
void enableCycleDetection();
void disableCycleDetection();
bool get isCycleDetectionEnabled;
List<String> get currentResolutionChain;
// Global cycle detection
void enableGlobalCycleDetection();
void disableGlobalCycleDetection();
bool get isGlobalCycleDetectionEnabled;
}
```
### CherryPick Helper Methods
```dart
class CherryPick {
// Global settings
static void enableGlobalCycleDetection();
static void disableGlobalCycleDetection();
static bool get isGlobalCycleDetectionEnabled;
static void enableGlobalCrossScopeCycleDetection();
static void disableGlobalCrossScopeCycleDetection();
static bool get isGlobalCrossScopeCycleDetectionEnabled;
// Per-scope settings
static void enableCycleDetectionForScope(Scope scope);
static void disableCycleDetectionForScope(Scope scope);
static void enableGlobalCycleDetectionForScope(Scope scope);
static void disableGlobalCycleDetectionForScope(Scope scope);
// Safe scope creation
static Scope openSafeRootScope();
static Scope openGlobalSafeRootScope();
static Scope openSafeSubScope(Scope parent);
}
```
### Exception Classes
```dart
class CircularDependencyException implements Exception {
final String message;
final List<String> dependencyChain;
const CircularDependencyException(this.message, this.dependencyChain);
@override
String toString() {
final chain = dependencyChain.join(' -> ');
return 'CircularDependencyException: $message\nDependency chain: $chain';
}
}
```
## Best Practices
### 1. Enable Detection During Development
```dart
void main() {
if (kDebugMode) {
CherryPick.enableGlobalCycleDetection();
CherryPick.enableGlobalCrossScopeCycleDetection();
}
runApp(MyApp());
}
```
### 2. Use Safe Scope Creation
```dart
// Instead of
final scope = Scope(null);
// Use
final scope = CherryPick.openGlobalSafeRootScope();
```
### 3. Design Proper Architecture
- Follow single responsibility principle
- Use interfaces to decouple dependencies
- Implement mediator pattern for complex interactions
- Keep dependency flow unidirectional in scope hierarchy
### 4. Handle Errors Gracefully
```dart
T resolveSafely<T>() {
try {
return scope.resolve<T>();
} on CircularDependencyException catch (e) {
logger.error('Circular dependency detected', e);
rethrow;
}
}
```
### 5. Test Thoroughly
- Write unit tests for dependency configurations
- Use integration tests to verify complex scenarios
- Enable detection in test environments
- Test both positive and negative scenarios
## Troubleshooting
### Common Issues
1. **False Positives**: If you're getting false circular dependency errors, check if you have proper async handling in your providers.
2. **Performance Issues**: If global detection is too slow, consider using only local detection or disabling it in production.
3. **Complex Hierarchies**: For very complex scope hierarchies, consider simplifying your architecture or using more interfaces.
### Debug Tips
1. **Check Resolution Chain**: Use `scope.currentResolutionChain` to see the current dependency resolution path.
2. **Enable Logging**: Add logging to your providers to trace dependency resolution.
3. **Simplify Dependencies**: Break complex dependencies into smaller, more manageable pieces.
4. **Use Interfaces**: Abstract dependencies behind interfaces to reduce coupling.
## Conclusion
Circular dependency detection in CherryPick provides robust protection against infinite loops and stack overflow errors. By following the best practices and using the appropriate detection level for your use case, you can build reliable and maintainable dependency injection configurations.
For more information, see the [main documentation](../README.md) and [examples](../example/).

572
doc/cycle_detection.ru.md Normal file
View File

@@ -0,0 +1,572 @@
# Обнаружение циклических зависимостей
CherryPick предоставляет надежное обнаружение циклических зависимостей для предотвращения бесконечных циклов и ошибок переполнения стека в вашей настройке внедрения зависимостей.
## Что такое циклические зависимости?
Циклические зависимости возникают, когда два или более сервиса зависят друг от друга прямо или косвенно, создавая цикл в графе зависимостей.
### Пример циклических зависимостей в рамках скоупа
```dart
class UserService {
final OrderService orderService;
UserService(this.orderService);
}
class OrderService {
final UserService userService;
OrderService(this.userService);
}
```
### Пример циклических зависимостей между скоупами
```dart
// В родительском скоупе
class ParentService {
final ChildService childService;
ParentService(this.childService); // Получает из дочернего скоупа
}
// В дочернем скоупе
class ChildService {
final ParentService parentService;
ChildService(this.parentService); // Получает из родительского скоупа
}
```
## Типы обнаружения
### 🔍 Локальное обнаружение
Обнаруживает циклические зависимости в рамках одного скоупа. Быстрое и эффективное.
### 🌐 Глобальное обнаружение
Обнаруживает циклические зависимости во всей иерархии скоупов. Более медленное, но обеспечивает полную защиту.
## Использование
### Локальное обнаружение
```dart
final scope = Scope(null);
scope.enableCycleDetection(); // Включить локальное обнаружение
scope.installModules([
Module((bind) {
bind<UserService>().to((scope) => UserService(scope.resolve<OrderService>()));
bind<OrderService>().to((scope) => OrderService(scope.resolve<UserService>()));
}),
]);
try {
final userService = scope.resolve<UserService>(); // Выбросит CircularDependencyException
} catch (e) {
print(e); // CircularDependencyException: Circular dependency detected
}
```
### Глобальное обнаружение
```dart
// Включить глобальное обнаружение для всех скоупов
CherryPick.enableGlobalCrossScopeCycleDetection();
final rootScope = CherryPick.openGlobalSafeRootScope();
final childScope = rootScope.openSubScope();
// Настроить зависимости, которые создают межскоуповые циклы
rootScope.installModules([
Module((bind) {
bind<ParentService>().to((scope) => ParentService(childScope.resolve<ChildService>()));
}),
]);
childScope.installModules([
Module((bind) {
bind<ChildService>().to((scope) => ChildService(rootScope.resolve<ParentService>()));
}),
]);
try {
final parentService = rootScope.resolve<ParentService>(); // Выбросит CircularDependencyException
} catch (e) {
print(e); // CircularDependencyException с детальной информацией о цепочке
}
```
## API CherryPick Helper
### Глобальные настройки
```dart
// Включить/отключить локальное обнаружение глобально
CherryPick.enableGlobalCycleDetection();
CherryPick.disableGlobalCycleDetection();
// Включить/отключить глобальное межскоуповое обнаружение
CherryPick.enableGlobalCrossScopeCycleDetection();
CherryPick.disableGlobalCrossScopeCycleDetection();
// Проверить текущие настройки
bool localEnabled = CherryPick.isGlobalCycleDetectionEnabled;
bool globalEnabled = CherryPick.isGlobalCrossScopeCycleDetectionEnabled;
```
### Настройки для конкретного скоупа
```dart
// Включить/отключить для конкретного скоупа
CherryPick.enableCycleDetectionForScope(scope);
CherryPick.disableCycleDetectionForScope(scope);
// Включить/отключить глобальное обнаружение для конкретного скоупа
CherryPick.enableGlobalCycleDetectionForScope(scope);
CherryPick.disableGlobalCycleDetectionForScope(scope);
```
### Безопасное создание скоупов
```dart
// Создать скоупы с автоматически включенным обнаружением
final safeRootScope = CherryPick.openSafeRootScope(); // Локальное обнаружение включено
final globalSafeRootScope = CherryPick.openGlobalSafeRootScope(); // Включены локальное и глобальное
final safeSubScope = CherryPick.openSafeSubScope(parentScope); // Наследует настройки родителя
```
## Соображения производительности
| Тип обнаружения | Накладные расходы | Рекомендуемое использование |
|-----------------|-------------------|----------------------------|
| **Локальное** | Минимальные (~5%) | Разработка, тестирование |
| **Глобальное** | Умеренные (~15%) | Сложные иерархии, критические функции |
| **Отключено** | Нет | Продакшн (после тестирования) |
### Рекомендации
- **Разработка**: Включите локальное и глобальное обнаружение для максимальной безопасности
- **Тестирование**: Оставьте обнаружение включенным для раннего выявления проблем
- **Продакшн**: Рассмотрите отключение для производительности, но только после тщательного тестирования
```dart
import 'package:flutter/foundation.dart';
void configureCycleDetection() {
if (kDebugMode) {
// Включить полную защиту в режиме отладки
CherryPick.enableGlobalCycleDetection();
CherryPick.enableGlobalCrossScopeCycleDetection();
} else {
// Отключить в релизном режиме для производительности
CherryPick.disableGlobalCycleDetection();
CherryPick.disableGlobalCrossScopeCycleDetection();
}
}
```
## Архитектурные паттерны
### Паттерн Repository
```dart
// ✅ Правильно: Repository не зависит от сервиса
class UserRepository {
final ApiClient apiClient;
UserRepository(this.apiClient);
}
class UserService {
final UserRepository repository;
UserService(this.repository);
}
// ❌ Неправильно: Циклическая зависимость
class UserRepository {
final UserService userService; // Не делайте так!
UserRepository(this.userService);
}
```
### Паттерн Mediator
```dart
// ✅ Правильно: Используйте медиатор для разрыва циклов
abstract class EventBus {
void publish<T>(T event);
Stream<T> listen<T>();
}
class UserService {
final EventBus eventBus;
UserService(this.eventBus);
void createUser(User user) {
// ... логика создания пользователя
eventBus.publish(UserCreatedEvent(user));
}
}
class OrderService {
final EventBus eventBus;
OrderService(this.eventBus) {
eventBus.listen<UserCreatedEvent>().listen(_onUserCreated);
}
void _onUserCreated(UserCreatedEvent event) {
// Реагировать на создание пользователя без прямой зависимости
}
}
```
## Лучшие практики иерархии скоупов
### Правильный поток зависимостей
```dart
// ✅ Правильно: Зависимости текут вниз по иерархии
// Корневой скоуп: Основные сервисы
final rootScope = CherryPick.openGlobalSafeRootScope();
rootScope.installModules([
Module((bind) {
bind<DatabaseService>().singleton((scope) => DatabaseService());
bind<ApiClient>().singleton((scope) => ApiClient());
}),
]);
// Скоуп функции: Сервисы, специфичные для функции
final featureScope = rootScope.openSubScope();
featureScope.installModules([
Module((bind) {
bind<UserRepository>().to((scope) => UserRepository(scope.resolve<ApiClient>()));
bind<UserService>().to((scope) => UserService(scope.resolve<UserRepository>()));
}),
]);
// UI скоуп: Сервисы, специфичные для UI
final uiScope = featureScope.openSubScope();
uiScope.installModules([
Module((bind) {
bind<UserController>().to((scope) => UserController(scope.resolve<UserService>()));
}),
]);
```
### Избегайте межскоуповых зависимостей
```dart
// ❌ Неправильно: Дочерний скоуп зависит от конкретных сервисов родителя
childScope.installModules([
Module((bind) {
bind<ChildService>().to((scope) =>
ChildService(rootScope.resolve<ParentService>()) // Рискованно!
);
}),
]);
// ✅ Правильно: Используйте интерфейсы и правильное внедрение зависимостей
abstract class IParentService {
void doSomething();
}
class ParentService implements IParentService {
void doSomething() { /* реализация */ }
}
// В корневом скоупе
rootScope.installModules([
Module((bind) {
bind<IParentService>().to((scope) => ParentService());
}),
]);
// В дочернем скоупе - разрешение через обычную иерархию
childScope.installModules([
Module((bind) {
bind<ChildService>().to((scope) =>
ChildService(scope.resolve<IParentService>()) // Безопасно!
);
}),
]);
```
## Режим отладки
### Отслеживание цепочки разрешения
```dart
// Включить режим отладки для отслеживания цепочек разрешения
final scope = CherryPick.openGlobalSafeRootScope();
// Доступ к текущей цепочке разрешения для отладки
print('Текущая цепочка разрешения: ${scope.currentResolutionChain}');
// Доступ к глобальной цепочке разрешения
print('Глобальная цепочка разрешения: ${GlobalCycleDetector.instance.currentGlobalResolutionChain}');
```
### Детали исключений
```dart
try {
final service = scope.resolve<CircularService>();
} on CircularDependencyException catch (e) {
print('Ошибка: ${e.message}');
print('Цепочка зависимостей: ${e.dependencyChain.join(' -> ')}');
// Для глобального обнаружения доступен дополнительный контекст
if (e.message.contains('cross-scope')) {
print('Это межскоуповая циклическая зависимость');
}
}
```
## Интеграция с тестированием
### Модульные тесты
```dart
import 'package:test/test.dart';
import 'package:cherrypick/cherrypick.dart';
void main() {
group('Обнаружение циклических зависимостей', () {
setUp(() {
// Включить обнаружение для тестов
CherryPick.enableGlobalCycleDetection();
CherryPick.enableGlobalCrossScopeCycleDetection();
});
tearDown(() {
// Очистка после тестов
CherryPick.disableGlobalCycleDetection();
CherryPick.disableGlobalCrossScopeCycleDetection();
});
test('должен обнаружить циклическую зависимость', () {
final scope = CherryPick.openGlobalSafeRootScope();
scope.installModules([
Module((bind) {
bind<ServiceA>().to((scope) => ServiceA(scope.resolve<ServiceB>()));
bind<ServiceB>().to((scope) => ServiceB(scope.resolve<ServiceA>()));
}),
]);
expect(
() => scope.resolve<ServiceA>(),
throwsA(isA<CircularDependencyException>()),
);
});
});
}
```
### Интеграционные тесты
```dart
testWidgets('должен обрабатывать циклические зависимости в дереве виджетов', (tester) async {
// Включить обнаружение
CherryPick.enableGlobalCycleDetection();
await tester.pumpWidget(
CherryPickProvider(
create: () {
final scope = CherryPick.openGlobalSafeRootScope();
// Настроить модули, которые могут иметь циклы
return scope;
},
child: MyApp(),
),
);
// Проверить, что циклические зависимости правильно обрабатываются
expect(find.text('Ошибка: Обнаружена циклическая зависимость'), findsNothing);
});
```
## Руководство по миграции
### С версии 2.1.x на 2.2.x
1. **Обновите зависимости**:
```yaml
dependencies:
cherrypick: ^2.2.0
```
2. **Включите обнаружение в существующем коде**:
```dart
// Раньше
final scope = Scope(null);
// Теперь - с локальным обнаружением
final scope = CherryPick.openSafeRootScope();
// Или с глобальным обнаружением
final scope = CherryPick.openGlobalSafeRootScope();
```
3. **Обновите обработку ошибок**:
```dart
try {
final service = scope.resolve<MyService>();
} on CircularDependencyException catch (e) {
// Обработать ошибки циклических зависимостей
logger.error('Обнаружена циклическая зависимость: ${e.dependencyChain}');
}
```
4. **Настройте для продакшна**:
```dart
void main() {
// Настроить обнаружение в зависимости от режима сборки
if (kDebugMode) {
CherryPick.enableGlobalCycleDetection();
CherryPick.enableGlobalCrossScopeCycleDetection();
}
runApp(MyApp());
}
```
## Справочник API
### Методы Scope
```dart
class Scope {
// Локальное обнаружение циклов
void enableCycleDetection();
void disableCycleDetection();
bool get isCycleDetectionEnabled;
List<String> get currentResolutionChain;
// Глобальное обнаружение циклов
void enableGlobalCycleDetection();
void disableGlobalCycleDetection();
bool get isGlobalCycleDetectionEnabled;
}
```
### Методы CherryPick Helper
```dart
class CherryPick {
// Глобальные настройки
static void enableGlobalCycleDetection();
static void disableGlobalCycleDetection();
static bool get isGlobalCycleDetectionEnabled;
static void enableGlobalCrossScopeCycleDetection();
static void disableGlobalCrossScopeCycleDetection();
static bool get isGlobalCrossScopeCycleDetectionEnabled;
// Настройки для конкретного скоупа
static void enableCycleDetectionForScope(Scope scope);
static void disableCycleDetectionForScope(Scope scope);
static void enableGlobalCycleDetectionForScope(Scope scope);
static void disableGlobalCycleDetectionForScope(Scope scope);
// Безопасное создание скоупов
static Scope openSafeRootScope();
static Scope openGlobalSafeRootScope();
static Scope openSafeSubScope(Scope parent);
}
```
### Классы исключений
```dart
class CircularDependencyException implements Exception {
final String message;
final List<String> dependencyChain;
const CircularDependencyException(this.message, this.dependencyChain);
@override
String toString() {
final chain = dependencyChain.join(' -> ');
return 'CircularDependencyException: $message\nЦепочка зависимостей: $chain';
}
}
```
## Лучшие практики
### 1. Включайте обнаружение во время разработки
```dart
void main() {
if (kDebugMode) {
CherryPick.enableGlobalCycleDetection();
CherryPick.enableGlobalCrossScopeCycleDetection();
}
runApp(MyApp());
}
```
### 2. Используйте безопасное создание скоупов
```dart
// Вместо
final scope = Scope(null);
// Используйте
final scope = CherryPick.openGlobalSafeRootScope();
```
### 3. Проектируйте правильную архитектуру
- Следуйте принципу единственной ответственности
- Используйте интерфейсы для разделения зависимостей
- Реализуйте паттерн медиатор для сложных взаимодействий
- Поддерживайте однонаправленный поток зависимостей в иерархии скоупов
### 4. Обрабатывайте ошибки корректно
```dart
T resolveSafely<T>() {
try {
return scope.resolve<T>();
} on CircularDependencyException catch (e) {
logger.error('Обнаружена циклическая зависимость', e);
rethrow;
}
}
```
### 5. Тестируйте тщательно
- Пишите модульные тесты для конфигураций зависимостей
- Используйте интеграционные тесты для проверки сложных сценариев
- Включайте обнаружение в тестовых средах
- Тестируйте как положительные, так и отрицательные сценарии
## Устранение неполадок
### Распространенные проблемы
1. **Ложные срабатывания**: Если вы получаете ложные ошибки циклических зависимостей, проверьте правильность обработки async в ваших провайдерах.
2. **Проблемы производительности**: Если глобальное обнаружение слишком медленное, рассмотрите использование только локального обнаружения или отключение в продакшне.
3. **Сложные иерархии**: Для очень сложных иерархий скоупов рассмотрите упрощение архитектуры или использование большего количества интерфейсов.
### Советы по отладке
1. **Проверьте цепочку разрешения**: Используйте `scope.currentResolutionChain` для просмотра текущего пути разрешения зависимостей.
2. **Включите логирование**: Добавьте логирование в ваши провайдеры для трассировки разрешения зависимостей.
3. **Упростите зависимости**: Разбейте сложные зависимости на более мелкие, управляемые части.
4. **Используйте интерфейсы**: Абстрагируйте зависимости за интерфейсами для уменьшения связанности.
## Заключение
Обнаружение циклических зависимостей в CherryPick обеспечивает надежную защиту от бесконечных циклов и ошибок переполнения стека. Следуя лучшим практикам и используя подходящий уровень обнаружения для вашего случая использования, вы можете создавать надежные и поддерживаемые конфигурации внедрения зависимостей.
Для получения дополнительной информации см. [основную документацию](../README.md) и [примеры](../example/).

407
doc/full_tutorial_en.md Normal file
View File

@@ -0,0 +1,407 @@
# 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.resolve<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!
---
## 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)

411
doc/full_tutorial_ru.md Normal file
View File

@@ -0,0 +1,411 @@
# Полный гайд по 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.resolve<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** — это современное 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)

View File

@@ -45,3 +45,9 @@ app.*.map.json
pubspec_overrides.yaml
**/*.g.dart
**/*.gr.dart
**/*.freezed.dart
**/*.cherrypick_injectable.g.dart

View File

@@ -1,14 +1,12 @@
import 'package:cherrypick/cherrypick.dart';
import 'package:client_app/my_home_page.dart';
import 'package:flutter/material.dart';
import 'package:cherrypick_flutter/cherrypick_flutter.dart';
import 'my_home_page.dart';
import 'use_case.dart';
void main() {
// Здесь происходит инициализация рутового скоупа и привязка зависимостей
CherryPick.openRootScope().installModules([
// Создаем модуль, который будет предоставлять UseCase
ModuleWithUseCase(),
]);
runApp(
@@ -23,19 +21,10 @@ class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Example App',
theme: ThemeData(primarySwatch: Colors.blue),
return CherryPickProvider(
child: MaterialApp(
home: MyHomePage(),
),
);
}
}
// Модуль для настройки зависимостей
class ModuleWithUseCase extends Module {
@override
void builder(Scope currentScope) {
// Привязка UseCase как singleton
bind<UseCase>().toInstance(UseCase());
}
}

View File

@@ -1,17 +1,18 @@
import 'package:flutter/material.dart';
import 'package:cherrypick_flutter/cherrypick_flutter.dart';
import 'use_case.dart';
class MyHomePage extends StatelessWidget {
late final UseCase useCase;
// ignore: prefer_const_constructors_in_immutables
MyHomePage({super.key});
@override
Widget build(BuildContext context) {
// Разрешение зависимости UseCase из рутового скоупа
final UseCase useCase =
CherryPickProvider.of(context).openRootScope().resolve<UseCase>();
//_inject(context); // Make sure this function is called in context
return Scaffold(
appBar: AppBar(
title: Text('Example App'),
title: const Text('Example App'),
),
body: Center(
child: Text(useCase.fetchData()),

View File

@@ -1,62 +1,194 @@
# Generated by pub
# See https://dart.dev/tools/pub/glossary#lockfile
packages:
_fe_analyzer_shared:
dependency: transitive
description:
name: _fe_analyzer_shared
sha256: e55636ed79578b9abca5fecf9437947798f5ef7456308b5cb85720b793eac92f
url: "https://pub.dev"
source: hosted
version: "82.0.0"
analyzer:
dependency: transitive
description:
name: analyzer
sha256: "904ae5bb474d32c38fb9482e2d925d5454cda04ddd0e55d2e6826bc72f6ba8c0"
url: "https://pub.dev"
source: hosted
version: "7.4.5"
args:
dependency: transitive
description:
name: args
sha256: d0481093c50b1da8910eb0bb301626d4d8eb7284aa739614d2b394ee09e3ea04
url: "https://pub.dev"
source: hosted
version: "2.7.0"
async:
dependency: transitive
description:
name: async
sha256: "947bfcf187f74dbc5e146c9eb9c0f10c9f8b30743e341481c1e2ed3ecc18c20c"
sha256: d2872f9c19731c2e5f10444b14686eb7cc85c76274bd6c16e1816bff9a3bab63
url: "https://pub.dev"
source: hosted
version: "2.11.0"
version: "2.12.0"
boolean_selector:
dependency: transitive
description:
name: boolean_selector
sha256: "6cfb5af12253eaf2b368f07bacc5a80d1301a071c73360d746b7f2e32d762c66"
sha256: "8aab1771e1243a5063b8b0ff68042d67334e3feab9e95b9490f9a6ebf73b42ea"
url: "https://pub.dev"
source: hosted
version: "2.1.1"
version: "2.1.2"
build:
dependency: transitive
description:
name: build
sha256: cef23f1eda9b57566c81e2133d196f8e3df48f244b317368d65c5943d91148f0
url: "https://pub.dev"
source: hosted
version: "2.4.2"
build_config:
dependency: transitive
description:
name: build_config
sha256: bf80fcfb46a29945b423bd9aad884590fb1dc69b330a4d4700cac476af1708d1
url: "https://pub.dev"
source: hosted
version: "1.1.1"
build_daemon:
dependency: transitive
description:
name: build_daemon
sha256: "79b2aef6ac2ed00046867ed354c88778c9c0f029df8a20fe10b5436826721ef9"
url: "https://pub.dev"
source: hosted
version: "4.0.2"
build_resolvers:
dependency: transitive
description:
name: build_resolvers
sha256: b9e4fda21d846e192628e7a4f6deda6888c36b5b69ba02ff291a01fd529140f0
url: "https://pub.dev"
source: hosted
version: "2.4.4"
build_runner:
dependency: "direct dev"
description:
name: build_runner
sha256: "058fe9dce1de7d69c4b84fada934df3e0153dd000758c4d65964d0166779aa99"
url: "https://pub.dev"
source: hosted
version: "2.4.15"
build_runner_core:
dependency: transitive
description:
name: build_runner_core
sha256: "22e3aa1c80e0ada3722fe5b63fd43d9c8990759d0a2cf489c8c5d7b2bdebc021"
url: "https://pub.dev"
source: hosted
version: "8.0.0"
built_collection:
dependency: transitive
description:
name: built_collection
sha256: "376e3dd27b51ea877c28d525560790aee2e6fbb5f20e2f85d5081027d94e2100"
url: "https://pub.dev"
source: hosted
version: "5.1.1"
built_value:
dependency: transitive
description:
name: built_value
sha256: ea90e81dc4a25a043d9bee692d20ed6d1c4a1662a28c03a96417446c093ed6b4
url: "https://pub.dev"
source: hosted
version: "8.9.5"
characters:
dependency: transitive
description:
name: characters
sha256: "04a925763edad70e8443c99234dc3328f442e811f1d8fd1a72f1c8ad0f69a605"
sha256: f71061c654a3380576a52b451dd5532377954cf9dbd272a78fc8479606670803
url: "https://pub.dev"
source: hosted
version: "1.3.0"
version: "1.4.0"
checked_yaml:
dependency: transitive
description:
name: checked_yaml
sha256: feb6bed21949061731a7a75fc5d2aa727cf160b91af9a3e464c5e3a32e28b5ff
url: "https://pub.dev"
source: hosted
version: "2.0.3"
cherrypick:
dependency: "direct main"
description:
name: cherrypick
sha256: "802427b777bc80e39216ec7070e452edd1a01eca84f824dfb57cc5e055797c4c"
url: "https://pub.dev"
source: hosted
version: "2.0.1"
path: "../../cherrypick"
relative: true
source: path
version: "3.0.0-dev.1"
cherrypick_annotations:
dependency: "direct main"
description:
path: "../../cherrypick_annotations"
relative: true
source: path
version: "1.1.0"
cherrypick_flutter:
dependency: "direct main"
description:
name: cherrypick_flutter
sha256: "6fa2ee4ea06a8f9edfaab43e665199b378add34c52ca081f55ed82cded090257"
url: "https://pub.dev"
source: hosted
path: "../../cherrypick_flutter"
relative: true
source: path
version: "1.1.3-dev.1"
cherrypick_generator:
dependency: "direct dev"
description:
path: "../../cherrypick_generator"
relative: true
source: path
version: "1.1.0"
clock:
dependency: transitive
description:
name: clock
sha256: cb6d7f03e1de671e34607e909a7213e31d7752be4fb66a86d29fe1eb14bfb5cf
sha256: fddb70d9b5277016c77a80201021d40a2247104d9f4aa7bab7157b7e3f05b84b
url: "https://pub.dev"
source: hosted
version: "1.1.1"
version: "1.1.2"
code_builder:
dependency: transitive
description:
name: code_builder
sha256: "0ec10bf4a89e4c613960bf1e8b42c64127021740fb21640c29c909826a5eea3e"
url: "https://pub.dev"
source: hosted
version: "4.10.1"
collection:
dependency: transitive
description:
name: collection
sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a
sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76"
url: "https://pub.dev"
source: hosted
version: "1.18.0"
version: "1.19.1"
convert:
dependency: transitive
description:
name: convert
sha256: b30acd5944035672bc15c6b7a8b47d773e41e2f17de064350988c5d02adb1c68
url: "https://pub.dev"
source: hosted
version: "3.1.2"
crypto:
dependency: transitive
description:
name: crypto
sha256: "1e445881f28f22d6140f181e07737b22f1e099a5e1ff94b0af2f9e4a463f4855"
url: "https://pub.dev"
source: hosted
version: "3.0.6"
cupertino_icons:
dependency: "direct main"
description:
@@ -65,14 +197,38 @@ packages:
url: "https://pub.dev"
source: hosted
version: "1.0.8"
dart_style:
dependency: transitive
description:
name: dart_style
sha256: "27eb0ae77836989a3bc541ce55595e8ceee0992807f14511552a898ddd0d88ac"
url: "https://pub.dev"
source: hosted
version: "3.0.1"
fake_async:
dependency: transitive
description:
name: fake_async
sha256: "511392330127add0b769b75a987850d136345d9227c6b94c96a04cf4a391bf78"
sha256: "6a95e56b2449df2273fd8c45a662d6947ce1ebb7aafe80e550a3f68297f3cacc"
url: "https://pub.dev"
source: hosted
version: "1.3.1"
version: "1.3.2"
file:
dependency: transitive
description:
name: file
sha256: a3b4f84adafef897088c160faf7dfffb7696046cb13ae90b508c2cbc95d3b8d4
url: "https://pub.dev"
source: hosted
version: "7.0.1"
fixnum:
dependency: transitive
description:
name: fixnum
sha256: b6dc7065e46c974bc7c5f143080a6764ec7a4be6da1285ececdc37be96de53be
url: "https://pub.dev"
source: hosted
version: "1.1.1"
flutter:
dependency: "direct main"
description: flutter
@@ -82,31 +238,103 @@ packages:
dependency: "direct dev"
description:
name: flutter_lints
sha256: "3f41d009ba7172d5ff9be5f6e6e6abb4300e263aab8866d2a0842ed2a70f8f0c"
sha256: "5398f14efa795ffb7a33e9b6a08798b26a180edac4ad7db3f231e40f82ce11e1"
url: "https://pub.dev"
source: hosted
version: "4.0.0"
version: "5.0.0"
flutter_test:
dependency: "direct dev"
description: flutter
source: sdk
version: "0.0.0"
frontend_server_client:
dependency: transitive
description:
name: frontend_server_client
sha256: f64a0333a82f30b0cca061bc3d143813a486dc086b574bfb233b7c1372427694
url: "https://pub.dev"
source: hosted
version: "4.0.0"
glob:
dependency: transitive
description:
name: glob
sha256: c3f1ee72c96f8f78935e18aa8cecced9ab132419e8625dc187e1c2408efc20de
url: "https://pub.dev"
source: hosted
version: "2.1.3"
graphs:
dependency: transitive
description:
name: graphs
sha256: "741bbf84165310a68ff28fe9e727332eef1407342fca52759cb21ad8177bb8d0"
url: "https://pub.dev"
source: hosted
version: "2.3.2"
http:
dependency: transitive
description:
name: http
sha256: "2c11f3f94c687ee9bad77c171151672986360b2b001d109814ee7140b2cf261b"
url: "https://pub.dev"
source: hosted
version: "1.4.0"
http_multi_server:
dependency: transitive
description:
name: http_multi_server
sha256: aa6199f908078bb1c5efb8d8638d4ae191aac11b311132c3ef48ce352fb52ef8
url: "https://pub.dev"
source: hosted
version: "3.2.2"
http_parser:
dependency: transitive
description:
name: http_parser
sha256: "2aa08ce0341cc9b354a498388e30986515406668dbcc4f7c950c3e715496693b"
url: "https://pub.dev"
source: hosted
version: "4.0.2"
io:
dependency: transitive
description:
name: io
sha256: dfd5a80599cf0165756e3181807ed3e77daf6dd4137caaad72d0b7931597650b
url: "https://pub.dev"
source: hosted
version: "1.0.5"
js:
dependency: transitive
description:
name: js
sha256: c1b2e9b5ea78c45e1a0788d29606ba27dc5f71f019f32ca5140f61ef071838cf
url: "https://pub.dev"
source: hosted
version: "0.7.1"
json_annotation:
dependency: transitive
description:
name: json_annotation
sha256: "1ce844379ca14835a50d2f019a3099f419082cfdd231cd86a142af94dd5c6bb1"
url: "https://pub.dev"
source: hosted
version: "4.9.0"
leak_tracker:
dependency: transitive
description:
name: leak_tracker
sha256: "3f87a60e8c63aecc975dda1ceedbc8f24de75f09e4856ea27daf8958f2f0ce05"
sha256: c35baad643ba394b40aac41080300150a4f08fd0fd6a10378f8f7c6bc161acec
url: "https://pub.dev"
source: hosted
version: "10.0.5"
version: "10.0.8"
leak_tracker_flutter_testing:
dependency: transitive
description:
name: leak_tracker_flutter_testing
sha256: "932549fb305594d82d7183ecd9fa93463e9914e1b67cacc34bc40906594a1806"
sha256: f8b613e7e6a13ec79cfdc0e97638fddb3ab848452eff057653abd3edba760573
url: "https://pub.dev"
source: hosted
version: "3.0.5"
version: "3.0.9"
leak_tracker_testing:
dependency: transitive
description:
@@ -119,18 +347,26 @@ packages:
dependency: transitive
description:
name: lints
sha256: "976c774dd944a42e83e2467f4cc670daef7eed6295b10b36ae8c85bcbf828235"
sha256: "3315600f3fb3b135be672bf4a178c55f274bebe368325ae18462c89ac1e3b413"
url: "https://pub.dev"
source: hosted
version: "4.0.0"
version: "5.0.0"
logging:
dependency: transitive
description:
name: logging
sha256: c8245ada5f1717ed44271ed1c26b8ce85ca3228fd2ffdb75468ab01979309d61
url: "https://pub.dev"
source: hosted
version: "1.3.0"
matcher:
dependency: transitive
description:
name: matcher
sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
sha256: dc58c723c3c24bf8d3e2d3ad3f2f9d7bd9cf43ec6feaa64181775e60190153f2
url: "https://pub.dev"
source: hosted
version: "0.12.16+1"
version: "0.12.17"
material_color_utilities:
dependency: transitive
description:
@@ -143,71 +379,159 @@ packages:
dependency: transitive
description:
name: meta
sha256: bdb68674043280c3428e9ec998512fb681678676b3c54e773629ffe74419f8c7
sha256: e3641ec5d63ebf0d9b41bd43201a66e3fc79a65db5f61fc181f04cd27aab950c
url: "https://pub.dev"
source: hosted
version: "1.15.0"
version: "1.16.0"
mime:
dependency: transitive
description:
name: mime
sha256: "41a20518f0cb1256669420fdba0cd90d21561e560ac240f26ef8322e45bb7ed6"
url: "https://pub.dev"
source: hosted
version: "2.0.0"
package_config:
dependency: transitive
description:
name: package_config
sha256: f096c55ebb7deb7e384101542bfba8c52696c1b56fca2eb62827989ef2353bbc
url: "https://pub.dev"
source: hosted
version: "2.2.0"
path:
dependency: transitive
description:
name: path
sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
sha256: "75cca69d1490965be98c73ceaea117e8a04dd21217b37b292c9ddbec0d955bc5"
url: "https://pub.dev"
source: hosted
version: "1.9.0"
version: "1.9.1"
pool:
dependency: transitive
description:
name: pool
sha256: "20fe868b6314b322ea036ba325e6fc0711a22948856475e2c2b6306e8ab39c2a"
url: "https://pub.dev"
source: hosted
version: "1.5.1"
pub_semver:
dependency: transitive
description:
name: pub_semver
sha256: "5bfcf68ca79ef689f8990d1160781b4bad40a3bd5e5218ad4076ddb7f4081585"
url: "https://pub.dev"
source: hosted
version: "2.2.0"
pubspec_parse:
dependency: transitive
description:
name: pubspec_parse
sha256: "81876843eb50dc2e1e5b151792c9a985c5ed2536914115ed04e9c8528f6647b0"
url: "https://pub.dev"
source: hosted
version: "1.4.0"
shelf:
dependency: transitive
description:
name: shelf
sha256: ad29c505aee705f41a4d8963641f91ac4cee3c8fad5947e033390a7bd8180fa4
url: "https://pub.dev"
source: hosted
version: "1.4.1"
shelf_web_socket:
dependency: transitive
description:
name: shelf_web_socket
sha256: cc36c297b52866d203dbf9332263c94becc2fe0ceaa9681d07b6ef9807023b67
url: "https://pub.dev"
source: hosted
version: "2.0.1"
sky_engine:
dependency: transitive
description: flutter
source: sdk
version: "0.0.99"
version: "0.0.0"
source_gen:
dependency: transitive
description:
name: source_gen
sha256: "35c8150ece9e8c8d263337a265153c3329667640850b9304861faea59fc98f6b"
url: "https://pub.dev"
source: hosted
version: "2.0.0"
source_span:
dependency: transitive
description:
name: source_span
sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c"
sha256: "254ee5351d6cb365c859e20ee823c3bb479bf4a293c22d17a9f1bf144ce86f7c"
url: "https://pub.dev"
source: hosted
version: "1.10.0"
version: "1.10.1"
stack_trace:
dependency: transitive
description:
name: stack_trace
sha256: "73713990125a6d93122541237550ee3352a2d84baad52d375a4cad2eb9b7ce0b"
sha256: "8b27215b45d22309b5cddda1aa2b19bdfec9df0e765f2de506401c071d38d1b1"
url: "https://pub.dev"
source: hosted
version: "1.11.1"
version: "1.12.1"
stream_channel:
dependency: transitive
description:
name: stream_channel
sha256: ba2aa5d8cc609d96bbb2899c28934f9e1af5cddbd60a827822ea467161eb54e7
sha256: "969e04c80b8bcdf826f8f16579c7b14d780458bd97f56d107d3950fdbeef059d"
url: "https://pub.dev"
source: hosted
version: "2.1.2"
version: "2.1.4"
stream_transform:
dependency: transitive
description:
name: stream_transform
sha256: ad47125e588cfd37a9a7f86c7d6356dde8dfe89d071d293f80ca9e9273a33871
url: "https://pub.dev"
source: hosted
version: "2.1.1"
string_scanner:
dependency: transitive
description:
name: string_scanner
sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde"
sha256: "921cd31725b72fe181906c6a94d987c78e3b98c2e205b397ea399d4054872b43"
url: "https://pub.dev"
source: hosted
version: "1.2.0"
version: "1.4.1"
term_glyph:
dependency: transitive
description:
name: term_glyph
sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84
sha256: "7f554798625ea768a7518313e58f83891c7f5024f88e46e7182a4558850a4b8e"
url: "https://pub.dev"
source: hosted
version: "1.2.1"
version: "1.2.2"
test_api:
dependency: transitive
description:
name: test_api
sha256: "5b8a98dafc4d5c4c9c72d8b31ab2b23fc13422348d2997120294d3bac86b4ddb"
sha256: fb31f383e2ee25fbbfe06b40fe21e1e458d14080e3c67e7ba0acfde4df4e0bbd
url: "https://pub.dev"
source: hosted
version: "0.7.2"
version: "0.7.4"
timing:
dependency: transitive
description:
name: timing
sha256: "62ee18aca144e4a9f29d212f5a4c6a053be252b895ab14b5821996cff4ed90fe"
url: "https://pub.dev"
source: hosted
version: "1.0.2"
typed_data:
dependency: transitive
description:
name: typed_data
sha256: f9049c039ebfeb4cf7a7104a675823cd72dba8297f264b6637062516699fa006
url: "https://pub.dev"
source: hosted
version: "1.4.0"
vector_math:
dependency: transitive
description:
@@ -220,10 +544,50 @@ packages:
dependency: transitive
description:
name: vm_service
sha256: "5c5f338a667b4c644744b661f309fb8080bb94b18a7e91ef1dbd343bed00ed6d"
sha256: "0968250880a6c5fe7edc067ed0a13d4bae1577fe2771dcf3010d52c4a9d3ca14"
url: "https://pub.dev"
source: hosted
version: "14.2.5"
version: "14.3.1"
watcher:
dependency: transitive
description:
name: watcher
sha256: "69da27e49efa56a15f8afe8f4438c4ec02eff0a117df1b22ea4aad194fe1c104"
url: "https://pub.dev"
source: hosted
version: "1.1.1"
web:
dependency: transitive
description:
name: web
sha256: "868d88a33d8a87b18ffc05f9f030ba328ffefba92d6c127917a2ba740f9cfe4a"
url: "https://pub.dev"
source: hosted
version: "1.1.1"
web_socket:
dependency: transitive
description:
name: web_socket
sha256: "34d64019aa8e36bf9842ac014bb5d2f5586ca73df5e4d9bf5c936975cae6982c"
url: "https://pub.dev"
source: hosted
version: "1.0.1"
web_socket_channel:
dependency: transitive
description:
name: web_socket_channel
sha256: d645757fb0f4773d602444000a8131ff5d48c9e47adfe9772652dd1a4f2d45c8
url: "https://pub.dev"
source: hosted
version: "3.0.3"
yaml:
dependency: transitive
description:
name: yaml
sha256: b9da305ac7c39faa3f030eccd175340f968459dae4af175130b3fc47e40d76ce
url: "https://pub.dev"
source: hosted
version: "3.1.3"
sdks:
dart: ">=3.5.2 <4.0.0"
dart: ">=3.7.0-0 <4.0.0"
flutter: ">=3.18.0-18.0.pre.54"

View File

@@ -5,14 +5,19 @@ publish_to: 'none'
version: 1.0.0+1
environment:
sdk: ^3.5.2
sdk: ">=3.5.2 <4.0.0"
dependencies:
flutter:
sdk: flutter
cherrypick: any
cherrypick_flutter: any
cherrypick:
path: ../../cherrypick
cherrypick_flutter:
path: ../../cherrypick_flutter
cherrypick_annotations:
path: ../../cherrypick_annotations
cupertino_icons: ^1.0.8
@@ -20,7 +25,11 @@ dev_dependencies:
flutter_test:
sdk: flutter
flutter_lints: ^4.0.0
flutter_lints: ^5.0.0
cherrypick_generator:
path: ../../cherrypick_generator
build_runner: ^2.4.15
# For information on the generic Dart part of this file, see the
# following page: https://dart.dev/tools/pub/pubspec

View File

@@ -5,26 +5,27 @@
// gestures. You can also use WidgetTester to find child widgets in the widget
// tree, read text, and verify that the values of widget properties are correct.
import 'package:flutter/material.dart';
//import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:client_app/main.dart';
//import 'package:client_app/main.dart';
void main() {
testWidgets('Counter increments smoke test', (WidgetTester tester) async {
expect(1, 1);
// Build our app and trigger a frame.
await tester.pumpWidget(const MyApp());
//await tester.pumpWidget(const MyApp());
// Verify that our counter starts at 0.
expect(find.text('0'), findsOneWidget);
expect(find.text('1'), findsNothing);
//// Verify that our counter starts at 0.
//expect(find.text('0'), findsOneWidget);
//expect(find.text('1'), findsNothing);
// Tap the '+' icon and trigger a frame.
await tester.tap(find.byIcon(Icons.add));
await tester.pump();
//// Tap the '+' icon and trigger a frame.
//await tester.tap(find.byIcon(Icons.add));
//await tester.pump();
// Verify that our counter has incremented.
expect(find.text('0'), findsNothing);
expect(find.text('1'), findsOneWidget);
//// Verify that our counter has incremented.
//expect(find.text('0'), findsNothing);
//expect(find.text('1'), findsOneWidget);
});
}

48
examples/postly/.gitignore vendored Normal file
View File

@@ -0,0 +1,48 @@
# Miscellaneous
*.class
*.log
*.pyc
*.swp
.DS_Store
.atom/
.buildlog/
.history
.svn/
migrate_working_dir/
# IntelliJ related
*.iml
*.ipr
*.iws
.idea/
# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/
# Flutter/Dart/Pub related
**/doc/api/
**/ios/Flutter/.last_build_id
.dart_tool/
.flutter-plugins
.flutter-plugins-dependencies
.pub-cache/
.pub/
/build/
# Symbolication related
app.*.symbols
# Obfuscation related
app.*.map.json
# Android Studio will place build artifacts here
/android/app/debug
/android/app/profile
/android/app/release
**/*.g.dart
**/*.gr.dart
**/*.freezed.dart

30
examples/postly/.metadata Normal file
View File

@@ -0,0 +1,30 @@
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled and should not be manually edited.
version:
revision: "4cf269e36de2573851eaef3c763994f8f9be494d"
channel: "stable"
project_type: app
# Tracks metadata for the flutter migrate command
migration:
platforms:
- platform: root
create_revision: 4cf269e36de2573851eaef3c763994f8f9be494d
base_revision: 4cf269e36de2573851eaef3c763994f8f9be494d
- platform: web
create_revision: 4cf269e36de2573851eaef3c763994f8f9be494d
base_revision: 4cf269e36de2573851eaef3c763994f8f9be494d
# User provided section
# List of Local paths (relative to this file) that should be
# ignored by the migrate tool.
#
# Files that are not part of the templates will be ignored by default.
unmanaged_files:
- 'lib/main.dart'
- 'ios/Runner.xcodeproj/project.pbxproj'

16
examples/postly/README.md Normal file
View File

@@ -0,0 +1,16 @@
# postly
A new Flutter project.
## Getting Started
This project is a starting point for a Flutter application.
A few resources to get you started if this is your first Flutter project:
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.

View File

@@ -0,0 +1,35 @@
# This file configures the analyzer, which statically analyzes Dart code to
# check for errors, warnings, and lints.
#
# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
# invoked from the command line by running `flutter analyze`.
# The following line activates a set of recommended lints for Flutter apps,
# 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`
# included above or to enable additional rules. A list of all available lints
# and their documentation is published at https://dart.dev/lints.
#
# Instead of disabling a lint rule for the entire project in the
# section below, it can also be suppressed for a single line of code
# or a specific dart file by using the `// ignore: name_of_lint` and
# `// ignore_for_file: name_of_lint` syntax on the line or in the file
# producing the lint.
rules:
# avoid_print: false # Uncomment to disable the `avoid_print` rule
# prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule
# Additional information about this file can be found at
# https://dart.dev/guides/language/analysis-options

Some files were not shown because too many files have changed in this diff Show More