Compare commits

..

94 Commits

Author SHA1 Message Date
Sergey Penkovsky
475deac1e0 chore(release): publish packages
- cherrypick@3.0.0-dev.5
 - cherrypick_flutter@1.1.3-dev.5
2025-08-07 16:23:12 +03:00
Sergey Penkovsky
f06f4564d9 Merge pull request #15 from pese-git/improve
perf(scope): speed up dependency lookup with Map-based binding resolv…
2025-08-07 16:19:11 +03:00
Sergey Penkovsky
70731c7e94 refactor(scope): simplify _findBindingResolver<T> with one-liner and optional chaining
The function is now shorter, more readable and uses modern Dart null-safety idioms. No functional change.
2025-08-07 15:48:04 +03:00
Sergey Penkovsky
4d5f96705f Merge pull request #17 from pese-git/impr/complex_benchmark_impr
impr: BENCHMARK - complex benchmark improvements.
2025-08-07 15:01:27 +03:00
yarashevich_kv
d23d06f98e impr: BENCHMARK - fix for CherrypickDIAdapter. 2025-08-07 14:55:07 +03:00
Sergey Penkovsky
e1371f7038 docs: update architecture diagram in README to show adapter-centric universalRegistration pattern 2025-08-07 14:37:34 +03:00
Sergey Penkovsky
75db42428c docs: update README (en/ru) to reflect adapter-based universalRegistration pattern
- Show type-safe DIAdapter-centric registration for all scenarios
- Document new way to add scenarios/DI via universalRegistration<S extends Enum>
- Remove legacy function-based registration/manual switching from guide
- Provide examples for Dart and CLI usage with all DI adapters
2025-08-07 14:23:06 +03:00
Sergey Penkovsky
5336c22550 test: validate all benchmark scenarios and stress runs for all DI adapters
- Successfully executed all scenarios (register, chain, asyncChain, named, override, etc) for Cherrypick, GetIt, and Riverpod
- Verified correct integration of fully generic DIAdapter & universalRegistration architecture
- Ensured type-safety in all setup/registration flows after complete refactor
- All benchmarks run and pass under stress/load params for each DI adapter
2025-08-07 14:18:16 +03:00
Sergey Penkovsky
56bdb3946e refactor: full generic DIAdapter workflow & universalRegistration abstraction
- Made UniversalChainBenchmark and UniversalChainAsyncBenchmark fully generic with strong typing for DIAdapter<TContainer>
- Moved all universalRegistration logic inside adapters; removed global function and typedef
- Replaced dynamic/object-based registration with type-safe generic contracts end-to-end
- Updated CLI and usage: all DI and scenarios are invoked via type-safe generics
- Fixed all analysis errors, Riverpod async/future usages, and imports for full Dart 3 compatibility
- All benchmarks fully pass for Cherrypick, GetIt, and Riverpod adapters
2025-08-07 14:11:29 +03:00
Sergey Penkovsky
54446868e4 refactor: unify DIAdapter with generics, ensure type-safety & scalability in benchmark_di
- Refactor DIAdapter to generic abstract class; align interfaces for Cherrypick, GetIt, Riverpod.
- Remove all dynamic/object usage from dependency registration and bench scenarios.
- Universal getUniversalRegistration function now fully type-safe for all DIs.
- Fix teardown and lifecycle for RiverpodAdapter to prevent disposed Container errors.
- Update CLI and benchmark entry points; validated all scenarios and stress modes for each DI adapter.
2025-08-07 13:45:16 +03:00
Sergey Penkovsky
590b876cf4 feat: add Riverpod adapter, async-chain support via FutureProvider, full DI CLI/bench integration, benchmarking, ascii performance graphs in markdown 2025-08-07 13:12:56 +03:00
Sergey Penkovsky
f7a7ea4384 feat: full di benchmarks report (en/ru) + get_it scope+override support fix; fresh results for all scenarios and settings 2025-08-07 12:11:16 +03:00
Sergey Penkovsky
6b6564f8c3 refactor: rename benchmark_cherrypick to benchmark_di, update paths, pubspec, imports, and documentation 2025-08-07 10:34:50 +03:00
Sergey Penkovsky
da79f1e546 docs: update README.md and README.ru.md for universal DI benchmarks, scenarios, CLI options, and architecture diagram 2025-08-07 10:16:14 +03:00
Sergey Penkovsky
64f33b20a7 fix: universal benchmarks and DI registration; proper named binding; robust override support for cherrypick and get_it; improved CLI args 2025-08-07 09:15:26 +03:00
Sergey Penkovsky
d523a5f261 refactor: simplify DIAdapter interface with a single registration callback; update benchmarks and cherrypick adapter accordingly 2025-08-07 08:28:23 +03:00
Sergey Penkovsky
b72dec9944 Обновлен README.ru.md: новые современные сценарии, параметры CLI, форматы отчётов, инструкция по расширению 2025-08-06 23:22:05 +03:00
Sergey Penkovsky
352442e52d Update README.md with current benchmark scenarios, CLI options, and report formats (EN) 2025-08-06 23:19:37 +03:00
Sergey Penkovsky
134fc5207a Add English documentation comments to all benchmark_cherrypick source files (adapters, scenarios, CLI, reporters, runner) 2025-08-06 23:15:28 +03:00
Sergey Penkovsky
01d82e1cd3 feat(report): add legend to MarkdownReport output with explanation of columns 2025-08-06 22:53:33 +03:00
Sergey Penkovsky
1e6375f5ae refactor(report): round numeric values to 2 decimal places in MarkdownReport output 2025-08-06 22:41:08 +03:00
Sergey Penkovsky
3da71674d4 chore: fix current status, all implemented features and refactors 2025-08-06 22:35:49 +03:00
Sergey Penkovsky
ea39b9d0e1 feat(report): align MarkdownReport columns for readable ASCII/markdown output 2025-08-06 22:31:41 +03:00
Sergey Penkovsky
09ed186544 refactor(cli): modularize CLI — extract parser, runner, report and main logic into dedicated files 2025-08-06 22:19:13 +03:00
Sergey Penkovsky
3ce21f55e4 refactor(report): extract ReportGenerator abstraction for pretty/csv/json; simplify report rendering in main 2025-08-06 22:02:41 +03:00
Sergey Penkovsky
bae940f374 refactor(main): extract BenchmarkRunner and BenchmarkResult, simplify main loop, unify sync/async cases 2025-08-06 21:53:13 +03:00
Sergey Penkovsky
0fc1907173 chore(cleanup): remove unused legacy benchmarks and scenario files 2025-08-06 18:36:11 +03:00
Sergey Penkovsky
4d41266135 refactor(benchmark): clean up UniversalChainBenchmark, remove async logic, keep only sync scenario logic 2025-08-06 18:26:05 +03:00
Sergey Penkovsky
3a75bd5b28 feat(benchmark): add UniversalScenario enum and extend UniversalChainModule to support chain, register, named, override, async scenarios 2025-08-06 17:01:55 +03:00
Sergey Penkovsky
b27a7df161 refactor(structure): move benchmarks, scenarios, adapters, utils to dedicated folders; update imports/project layout 2025-08-06 16:21:31 +03:00
Sergey Penkovsky
553dbb6539 refactor(benchmarks): introduce DIAdapter abstraction, migrate all scenarios to use DIAdapter 2025-08-06 14:44:12 +03:00
Sergey Penkovsky
18905a068d docs(benchmarks): document memory_diff_kb, delta_peak_kb, peak_rss_kb in README files (EN+RU) 2025-08-06 14:07:44 +03:00
Sergey Penkovsky
6928daa50e docs(benchmarks): update README files with stability options, repeat/warmup params, stat fields, and usage examples 2025-08-06 13:48:51 +03:00
Sergey Penkovsky
7f488f873e docs(benchmarks): update README files with new CLI, matrix run, output formats, and usage instructions (EN+RU) 2025-08-06 13:35:39 +03:00
Sergey Penkovsky
926bbf15f4 refactor(benchmarks): unify benchmark structure, enable CLI parameterization, run matrix, add CSV/JSON/pretty output
- All benchmarks now use a unified base mixin for setup/teardown (BenchmarkWithScope).
- Added args package support: CLI flags for choosing benchmarks, chain counts, nesting depths, output format.
- Support for running benchmarks in matrix mode (multiple parameter sets).
- Machine-readable output: csv, json, pretty-table.
- Loop and naming lint fixes, unused imports removed.
2025-08-06 13:30:30 +03:00
yarashevich_kv
a5ef0dc437 impr: BENCHMARK - complex benchmark improvements. 2025-08-06 09:41:17 +03:00
Sergey Penkovsky
05cfca5977 docs(perf): clarify Map-based resolver optimization applies since v3.0.0 in all docs 2025-08-06 08:29:00 +03:00
Sergey Penkovsky
52a55219ab docs: update EN/RU quick start and tutorial with Fast Map-based lookup section; clarify performance benefit in README 2025-08-05 19:41:24 +03:00
Sergey Penkovsky
ffff33c744 perf(scope): speed up dependency lookup with Map-based binding resolver index
Optimize resolve()/tryResolve() to use O(1) Map-based lookup by type and name instead of iterating through all modules and bindings. Behavior of factory, singleton, instance, and named bindings is preserved.
2025-08-05 17:20:35 +03:00
Sergey Penkovsky
a4573ce8ef Add package topics to all pubspec.yaml files 2025-08-05 06:46:26 +03:00
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
105 changed files with 11256 additions and 662 deletions

2
.fvmrc
View File

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

2
.gitignore vendored
View File

@@ -18,3 +18,5 @@ pubspec_overrides.yaml
melos_cherrypick.iml melos_cherrypick.iml
melos_cherrypick_workspace.iml melos_cherrypick_workspace.iml
melos_cherrypick_flutter.iml melos_cherrypick_flutter.iml
coverage

View File

@@ -3,6 +3,306 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
## 2025-08-07
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`cherrypick` - `v3.0.0-dev.5`](#cherrypick---v300-dev5)
- [`cherrypick_flutter` - `v1.1.3-dev.5`](#cherrypick_flutter---v113-dev5)
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.5`
---
#### `cherrypick` - `v3.0.0-dev.5`
- **REFACTOR**(scope): simplify _findBindingResolver<T> with one-liner and optional chaining.
- **PERF**(scope): speed up dependency lookup with Map-based binding resolver index.
- **DOCS**(perf): clarify Map-based resolver optimization applies since v3.0.0 in all docs.
- **DOCS**: update EN/RU quick start and tutorial with Fast Map-based lookup section; clarify performance benefit in README.
## 2025-08-07
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`cherrypick` - `v3.0.0-dev.4`](#cherrypick---v300-dev4)
- [`cherrypick_flutter` - `v1.1.3-dev.4`](#cherrypick_flutter---v113-dev4)
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.4`
---
#### `cherrypick` - `v3.0.0-dev.4`
- **REFACTOR**(scope): simplify _findBindingResolver<T> with one-liner and optional chaining.
- **PERF**(scope): speed up dependency lookup with Map-based binding resolver index.
- **DOCS**(perf): clarify Map-based resolver optimization applies since v3.0.0 in all docs.
- **DOCS**: update EN/RU quick start and tutorial with Fast Map-based lookup section; clarify performance benefit in README.
## 2025-08-07
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`cherrypick` - `v3.0.0-dev.3`](#cherrypick---v300-dev3)
- [`cherrypick_flutter` - `v1.1.3-dev.3`](#cherrypick_flutter---v113-dev3)
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.3`
---
#### `cherrypick` - `v3.0.0-dev.3`
- **REFACTOR**(scope): simplify _findBindingResolver<T> with one-liner and optional chaining.
- **PERF**(scope): speed up dependency lookup with Map-based binding resolver index.
- **DOCS**(perf): clarify Map-based resolver optimization applies since v3.0.0 in all docs.
- **DOCS**: update EN/RU quick start and tutorial with Fast Map-based lookup section; clarify performance benefit in README.
## 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 ## 2025-05-22
### Changes ### Changes

View File

@@ -99,7 +99,7 @@ final scope = CherryPick.openRootScope()
..installModules([$MyModule()]); ..installModules([$MyModule()]);
final repo = scope.resolve<DataRepository>(); final repo = scope.resolve<DataRepository>();
final greeting = scope.resolveWithParams<String>('John'); // 'Hello, John!' final greeting = scope.resolve<String>(params: 'John'); // 'Hello, John!'
``` ```
_For Flutter, wrap your app with `CherryPickProvider` for DI scopes in the widget tree:_ _For Flutter, wrap your app with `CherryPickProvider` for DI scopes in the widget tree:_

275
benchmark_di/README.md Normal file
View File

@@ -0,0 +1,275 @@
# benchmark_di
_Benchmark suite for cherrypick DI container, get_it, and other DI solutions._
## Overview
benchmark_di is a flexible benchmarking suite to compare DI containers (like cherrypick and get_it) on synthetic, deep, and real-world dependency scenarios chains, factories, async, named, override, etc.
**Features:**
- Universal registration layer and modular scenario setup (works with any DI)
- Built-in support for [cherrypick](https://github.com/) and [get_it](https://pub.dev/packages/get_it)
- Clean CLI for matrix runs and output formats (Markdown, CSV, JSON, pretty)
- Reports metrics: timings, memory (RSS, peak), statistical spreads, and more
- Extendable via your own DIAdapter or benchmark scenarios
---
## Benchmark Scenarios
- **registerSingleton**: Simple singleton registration/resolution
- **chainSingleton**: Resolution of long singleton chains (A→B→C...)
- **chainFactory**: Chain resolution via factories (new instances each time)
- **asyncChain**: Async chain (with async providers)
- **named**: Named/qualified resolution (e.g. from multiple implementations)
- **override**: Resolution and override in subScopes/child adapters
---
## Supported DI
- **cherrypick** (default)
- **get_it**
- Easy to add your own DI by creating a DIAdapter
Switch DI with the CLI option: `--di`
---
## How to Run
1. **Install dependencies:**
```shell
dart pub get
```
2. **Run all benchmarks (default: all scenarios, 2 warmup, 2 repeats):**
```shell
dart run bin/main.dart --benchmark=all --format=markdown
```
3. **For get_it:**
```shell
dart run bin/main.dart --di=getit --benchmark=all --format=markdown
```
4. **Show all CLI options:**
```shell
dart run bin/main.dart --help
```
### CLI Parameters
- `--di` — DI implementation: `cherrypick` (default) or `getit`
- `--benchmark, -b` — Scenario: `registerSingleton`, `chainSingleton`, `chainFactory`, `asyncChain`, `named`, `override`, `all`
- `--chainCount, -c` — Number of parallel chains (e.g. `10,100`)
- `--nestingDepth, -d` — Chain depth (e.g. `5,10`)
- `--repeat, -r` — Measurement repeats (default: 2)
- `--warmup, -w` — Warmup runs (default: 1)
- `--format, -f` — Output: `pretty`, `csv`, `json`, `markdown`
- `--help, -h` — Usage
### Run Examples
- **All benchmarks for cherrypick:**
```shell
dart run bin/main.dart --di=cherrypick --benchmark=all --format=markdown
```
- **For get_it (all scenarios):**
```shell
dart run bin/main.dart --di=getit --benchmark=all --format=markdown
```
- **Specify chains/depth matrix:**
```shell
dart run bin/main.dart --benchmark=chainSingleton --chainCount=10,100 --nestingDepth=5,10 --repeat=3 --format=csv
```
---
## Universal DI registration: Adapter-centric approach
Starting from vX.Y.Z, all DI registration scenarios and logic are encapsulated in the adapter itself via the `universalRegistration` method.
### How to use (in Dart code):
```dart
final di = CherrypickDIAdapter(); // or GetItAdapter(), RiverpodAdapter(), etc
di.setupDependencies(
di.universalRegistration(
scenario: UniversalScenario.chain,
chainCount: 10,
nestingDepth: 5,
bindingMode: UniversalBindingMode.singletonStrategy,
),
);
```
- There is **no more need to use any global function or switch**: each adapter provides its own type-safe implementation.
### How to add a new scenario or DI:
- Implement `universalRegistration<S extends Enum>(...)` in your adapter
- Use your own Enum if you want adapter-specific scenarios!
- Benchmarks and CLI become automatically extensible for custom DI and scenarios.
### CLI usage (runs all universal scenarios for Cherrypick, GetIt, Riverpod):
```
dart run bin/main.dart --di=cherrypick --benchmark=all
dart run bin/main.dart --di=getit --benchmark=all
dart run bin/main.dart --di=riverpod --benchmark=all
```
See the `benchmark_di/lib/di_adapters/` folder for ready-to-use adapters.
---
## Advantages
- **Type-safe:** Zero dynamic/object usage in DI flows.
- **Extensible:** New scenarios are just new Enum values and a method extension.
- **No global registration logic:** All DI-related logic is where it belongs: in the adapter.
=======
## How to Add Your Own DI
1. Implement a class extending `DIAdapter` (`lib/di_adapters/your_adapter.dart`)
2. Implement the `universalRegistration<S extends Enum>(...)` method directly in your adapter for type-safe and scenario-specific registration
3. Register your adapter in CLI (see `cli/benchmark_cli.dart`)
4. No global function needed — all logic is within the adapter!
---
## Universal DI registration: Adapter-centric approach
Starting from vX.Y.Z, all DI registration scenarios and logic are encapsulated in the adapter itself via the `universalRegistration` method.
### How to use (in Dart code):
```dart
final di = CherrypickDIAdapter(); // or GetItAdapter(), RiverpodAdapter(), etc
di.setupDependencies(
di.universalRegistration(
scenario: UniversalScenario.chain,
chainCount: 10,
nestingDepth: 5,
bindingMode: UniversalBindingMode.singletonStrategy,
),
);
```
- There is **no more need to use any global function or switch**: each adapter provides its own type-safe implementation.
### How to add a new scenario or DI:
- Implement `universalRegistration<S extends Enum>(...)` in your adapter
- Use your own Enum if you want adapter-specific scenarios!
- Benchmarks and CLI become automatically extensible for custom DI and scenarios.
### CLI usage (runs all universal scenarios for Cherrypick, GetIt, Riverpod):
```
dart run bin/main.dart --di=cherrypick --benchmark=all
dart run bin/main.dart --di=getit --benchmark=all
dart run bin/main.dart --di=riverpod --benchmark=all
```
See the `benchmark_di/lib/di_adapters/` folder for ready-to-use adapters.
## Advantages
- **Type-safe:** Zero dynamic/object usage in DI flows.
- **Extensible:** New scenarios are just new Enum values and a method extension.
- **No global registration logic:** All DI-related logic is where it belongs: in the adapter.
---
## Architecture
```mermaid
classDiagram
class BenchmarkCliRunner {
+run(args)
}
class UniversalChainBenchmark~TContainer~ {
+setup()
+run()
+teardown()
}
class UniversalChainAsyncBenchmark~TContainer~ {
+setup()
+run()
+teardown()
}
class DIAdapter~TContainer~ {
<<interface>>
+setupDependencies(cb)
+resolve~T~(named)
+resolveAsync~T~(named)
+teardown()
+openSubScope(name)
+waitForAsyncReady()
+universalRegistration<S extends Enum>(...)
}
class CherrypickDIAdapter
class GetItAdapter
class RiverpodAdapter
class UniversalChainModule {
+builder(scope)
+chainCount
+nestingDepth
+bindingMode
+scenario
}
class UniversalService {
<<interface>>
+value
+dependency
}
class UniversalServiceImpl {
+UniversalServiceImpl(value, dependency)
}
class Scope
class UniversalScenario
class UniversalBindingMode
%% Relationships
BenchmarkCliRunner --> UniversalChainBenchmark
BenchmarkCliRunner --> UniversalChainAsyncBenchmark
UniversalChainBenchmark *-- DIAdapter
UniversalChainAsyncBenchmark *-- DIAdapter
DIAdapter <|.. CherrypickDIAdapter
DIAdapter <|.. GetItAdapter
DIAdapter <|.. RiverpodAdapter
CherrypickDIAdapter ..> Scope
GetItAdapter ..> GetIt: "uses GetIt"
RiverpodAdapter ..> Map~String, ProviderBase~: "uses Provider registry"
DIAdapter o--> UniversalChainModule : setupDependencies
UniversalChainModule ..> UniversalScenario
UniversalChainModule ..> UniversalBindingMode
UniversalChainModule o-- UniversalServiceImpl : creates
UniversalService <|.. UniversalServiceImpl
UniversalServiceImpl --> UniversalService : dependency
%%
%% Each concrete adapter implements universalRegistration<S extends Enum>
%% You can add new scenario enums for custom adapters
%% Extensibility is achieved via adapter logic, not global functions
```
---
## Metrics
Always collected:
- **Timings** (microseconds): mean, median, stddev, min, max
- **Memory**: RSS difference, peak RSS
## License
MIT

226
benchmark_di/README.ru.md Normal file
View File

@@ -0,0 +1,226 @@
# benchmark_di
енчмаркинговый набор для cherrypick, get_it и других DI-контейнеров._
## Общее описание
benchmark_di — это современный фреймворк для измерения производительности DI-контейнеров (как cherrypick, так и get_it) на синтетических, сложных и реальных сценариях: цепочки зависимостей, factory, async, именованные биндинги, override и пр.
**Возможности:**
- Универсальный слой регистрации сценариев (работает с любым DI)
- Готовая поддержка [cherrypick](https://github.com/) и [get_it](https://pub.dev/packages/get_it)
- Удобный CLI для запусков по матрице значений параметров и различных форматов вывода (Markdown, CSV, JSON, pretty)
- Сбор и вывод метрик: время, память (RSS, peak), статистика (среднее, медиана, stddev, min/max)
- Легко расширять — создавайте свой DIAdapter и новые сценарии
---
## Сценарии бенчмарков
- **registerSingleton**: Регистрация и резолвинг singleton
- **chainSingleton**: Разрешение длинных singleton-цепочек (A→B→C…)
- **chainFactory**: То же, но с factory (каждый раз — новый объект)
- **asyncChain**: Асинхронная цепочка (async factory/provider)
- **named**: Разрешение по имени (например, из нескольких реализаций)
- **override**: Переопределение зависимостей в subScope
---
## Поддерживаемые DI-контейнеры
- **cherrypick** (по умолчанию)
- **get_it**
- Легко добавить свой DI через DIAdapter
Меняется одной CLI-опцией: `--di`
---
## Как запустить
1. **Установить зависимости:**
```shell
dart pub get
```
2. **Запустить все бенчмарки (по умолчанию: все сценарии, 2 прогрева, 2 замера):**
```shell
dart run bin/main.dart --benchmark=all --format=markdown
```
3. **Для get_it:**
```shell
dart run bin/main.dart --di=getit --benchmark=all --format=markdown
```
4. **Показать все опции CLI:**
```shell
dart run bin/main.dart --help
```
### Параметры CLI
- `--di` — Какой DI использовать: `cherrypick` (по умолчанию) или `getit`
- `--benchmark, -b` — Сценарий: `registerSingleton`, `chainSingleton`, `chainFactory`, `asyncChain`, `named`, `override`, `all`
- `--chainCount, -c` — Сколько параллельных цепочек (например, `10,100`)
- `--nestingDepth, -d` — Глубина цепочки (например, `5,10`)
- `--repeat, -r` — Повторов замера (по умолчанию 2)
- `--warmup, -w` — Прогревочных запусков (по умолчанию 1)
- `--format, -f` — Формат отчёта: `pretty`, `csv`, `json`, `markdown`
- `--help, -h` — Справка
### Примеры запуска
- **Все бенчмарки для cherrypick:**
```shell
dart run bin/main.dart --di=cherrypick --benchmark=all --format=markdown
```
- **Для get_it (все сценарии):**
```shell
dart run bin/main.dart --di=getit --benchmark=all --format=markdown
```
- **Запуск по матрице параметров:**
```shell
dart run bin/main.dart --benchmark=chainSingleton --chainCount=10,100 --nestingDepth=5,10 --repeat=3 --format=csv
```
---
## Универсальная регистрация зависимостей: теперь через adapter
В версии X.Y.Z вся логика сценариев регистрации DI-инфраструктуры локализована в adapter через метод `universalRegistration`.
### Использование в Dart:
```dart
final di = CherrypickDIAdapter(); // или GetItAdapter(), RiverpodAdapter() и т.д.
di.setupDependencies(
di.universalRegistration(
scenario: UniversalScenario.chain,
chainCount: 10,
nestingDepth: 5,
bindingMode: UniversalBindingMode.singletonStrategy,
),
);
```
- **Теперь нет необходимости вызывать глобальные функции или switch-case по типу DI!** Каждый adapter сам предоставляет типобезопасную функцию регистрации.
### Как добавить новый сценарий или DI:
- Реализуйте метод `universalRegistration<S extends Enum>(...)` в своём adapter.
- Можно использовать как UniversalScenario, так и собственные enum-сценарии!
- Бенчмарки CLI автоматически расширяются под ваш DI и ваши сценарии, если реализован метод-расширение.
### Запуск CLI (все сценарии DI Cherrypick, GetIt, Riverpod):
```
dart run bin/main.dart --di=cherrypick --benchmark=all
dart run bin/main.dart --di=getit --benchmark=all
dart run bin/main.dart --di=riverpod --benchmark=all
```
Смотрите примеры готовых adapters в `benchmark_di/lib/di_adapters/`.
## Преимущества
- **Type-safe:** Исключено использование dynamic/object в стороне DI.
- **Масштабируемость:** Новый сценарий — просто enum + метод в adapter.
- **Вся логика регистрации теперь только в adapter:** Добавление или изменение не затрагивает глобальные функции.
---
## Архитектура
```mermaid
classDiagram
class BenchmarkCliRunner {
+run(args)
}
class UniversalChainBenchmark~TContainer~ {
+setup()
+run()
+teardown()
}
class UniversalChainAsyncBenchmark~TContainer~ {
+setup()
+run()
+teardown()
}
class DIAdapter~TContainer~ {
<<interface>>
+setupDependencies(cb)
+resolve~T~(named)
+resolveAsync~T~(named)
+teardown()
+openSubScope(name)
+waitForAsyncReady()
+universalRegistration<S extends Enum>(...)
}
class CherrypickDIAdapter
class GetItAdapter
class RiverpodAdapter
class UniversalChainModule {
+builder(scope)
+chainCount
+nestingDepth
+bindingMode
+scenario
}
class UniversalService {
<<interface>>
+value
+dependency
}
class UniversalServiceImpl {
+UniversalServiceImpl(value, dependency)
}
class Scope
class UniversalScenario
class UniversalBindingMode
%% Relationships
BenchmarkCliRunner --> UniversalChainBenchmark
BenchmarkCliRunner --> UniversalChainAsyncBenchmark
UniversalChainBenchmark *-- DIAdapter
UniversalChainAsyncBenchmark *-- DIAdapter
DIAdapter <|.. CherrypickDIAdapter
DIAdapter <|.. GetItAdapter
DIAdapter <|.. RiverpodAdapter
CherrypickDIAdapter ..> Scope
GetItAdapter ..> GetIt: "uses GetIt"
RiverpodAdapter ..> Map~String, ProviderBase~: "uses Provider registry"
DIAdapter o--> UniversalChainModule : setupDependencies
UniversalChainModule ..> UniversalScenario
UniversalChainModule ..> UniversalBindingMode
UniversalChainModule o-- UniversalServiceImpl : creates
UniversalService <|.. UniversalServiceImpl
UniversalServiceImpl --> UniversalService : dependency
%%
%% Each concrete adapter implements universalRegistration<S extends Enum>
%% You can add new scenario enums for custom adapters
%% Extensibility is achieved via adapter logic, not global functions
```
---
## Метрики
Всегда собираются:
- **Время** (мкс): среднее, медиана, stddev, min, max
- **Память**: прирост RSS, пиковое значение RSS
## Лицензия
MIT

79
benchmark_di/REPORT.md Normal file
View File

@@ -0,0 +1,79 @@
# DI Benchmark Results: cherrypick vs get_it
## Benchmark parameters
| Parameter | Value |
|------------------|-----------------------|
| --benchmark | all |
| --chainCount (-c)| 10, 100 |
| --nestingDepth (-d)| 10, 100 |
| --repeat (-r) | 2 |
| --warmup (-w) | 1 (default) |
| --format (-f) | markdown |
| --di | cherrypick, get_it |
---
## Benchmark scenarios
**(1) RegisterSingleton**
Registers and resolves a singleton. Baseline DI speed.
**(2) ChainSingleton**
A dependency chain A → B → ... → N (singleton). Measures how fast DI resolves deep singleton chains by name.
**(3) ChainFactory**
Same as ChainSingleton, but every chain element is a factory. Shows DI speed for stateless 'creation chain'.
**(4) AsyncChain**
Async chain (async factory). Measures DI performance for async graphs.
**(5) Named**
Registers two bindings with names ("impl1", "impl2"), resolves by name. Tests named lookup.
**(6) Override**
Registers a chain/alias in a child scope and resolves UniversalService without a name in that scope. Simulates override and modular/test architecture.
---
## Comparative Table (Mean, ΔRSS), chainCount=10, nestingDepth=10
| Scenario | cherrypick Mean (us) | cherrypick ΔRSS | get_it Mean (us) | get_it ΔRSS |
|--------------------|---------------------:|----------------:|-----------------:|------------:|
| RegisterSingleton | 21.0 | 320 | 24.5 | 80 |
| ChainSingleton | 112.5 | -3008 | 2.0 | 304 |
| ChainFactory | 8.0 | 0 | 4.0 | 0 |
| AsyncChain | 36.5 | 0 | 13.5 | 0 |
| Named | 1.5 | 0 | 0.5 | 0 |
| Override | 27.5 | 0 | 0.0 | 0 |
## Maximum load: chainCount=100, nestingDepth=100
| Scenario | cherrypick Mean (us) | cherrypick ΔRSS | get_it Mean (us) | get_it ΔRSS |
|--------------------|---------------------:|----------------:|-----------------:|------------:|
| RegisterSingleton | 1.0 | 32 | 1.0 | 0 |
| ChainSingleton | 3884.0 | 0 | 1.5 | 34848 |
| ChainFactory | 4088.0 | 0 | 50.0 | 12528 |
| AsyncChain | 4287.0 | 0 | 17.0 | 63120 |
| Named | 1.0 | 0 | 0.0 | 0 |
| Override | 4767.5 | 0 | 1.5 | 14976 |
---
## Scenario explanations
- **RegisterSingleton:** Registers and resolves a singleton dependency, baseline test for cold/hot startup speed.
- **ChainSingleton:** Deep chain of singleton dependencies. Cherrypick is much slower as depth increases; get_it is nearly unaffected.
- **ChainFactory:** Creation chain with new instances per resolve. get_it generally faster on large chains due to ultra-simple factory registration.
- **AsyncChain:** Async factory chain. get_it processes async resolutions much faster; cherrypick is much slower as depth increases due to async handling.
- **Named:** Both DI containers resolve named bindings nearly instantly, even on large graphs.
- **Override:** Child scope override. get_it (thanks to stack-based scopes) resolves immediately; cherrypick supports modular testing with controlled memory use.
## Summary
- **get_it** demonstrates impressive speed and low overhead across all scenarios and loads, but lacks diagnostics, advanced scopes, and cycle detection.
- **cherrypick** is ideal for complex, multi-layered, production or testable architectures where scope, overrides, and diagnostics are critical. Predictably slower on deep/wide graphs, but scales well and provides extra safety.
**Recommendation:**
- Use cherrypick for enterprise, multi-feature/testable DI needs.
- Use get_it for fast games, scripts, tiny Apps, and hot demos.

79
benchmark_di/REPORT.ru.md Normal file
View File

@@ -0,0 +1,79 @@
# Результаты бенчмарка DI: cherrypick vs get_it
## Параметры запуска бенчмарков
| Параметр | Значение |
|------------------|-------------------------|
| --benchmark | all |
| --chainCount (-c)| 10, 100 |
| --nestingDepth (-d)| 10, 100 |
| --repeat (-r) | 2 |
| --warmup (-w) | 1 (по умолчанию) |
| --format (-f) | markdown |
| --di | cherrypick, get_it |
---
## Описание бенчмарков
**(1) RegisterSingleton**
Регистрируется и дважды резолвится singleton. Базовый тест скорости DI.
**(2) ChainSingleton**
Цепочка зависимостей A → B → ... → N (singleton). Тестирует скорость заполнения и разрешения глубоких singleton-цепочек по имени.
**(3) ChainFactory**
Аналогично ChainSingleton, но каждое звено цепи — factory (новый объект при каждом resolve).
**(4) AsyncChain**
Асинхронная цепочка (async factory). Важно для сценариев с async DI.
**(5) Named**
Регистрируются две реализации по имени ('impl1', 'impl2'), разрешается named. Проверка lookup по имени.
**(6) Override**
Регистрируется цепочка/alias в дочернем scope, резолвится UniversalService без имени там же. Симуляция override и изолированной/тестовой архитектуры.
---
## Сравнительная таблица (Mean (us), ΔRSS(KB)), chainCount=10, nestingDepth=10
| Сценарий | cherrypick Mean (мкс) | cherrypick ΔRSS | get_it Mean (мкс) | get_it ΔRSS |
|-------------------|---------------------:|----------------:|-----------------:|------------:|
| RegisterSingleton | 21.0 | 320 | 24.5 | 80 |
| ChainSingleton | 112.5 | -3008 | 2.0 | 304 |
| ChainFactory | 8.0 | 0 | 4.0 | 0 |
| AsyncChain | 36.5 | 0 | 13.5 | 0 |
| Named | 1.5 | 0 | 0.5 | 0 |
| Override | 27.5 | 0 | 0.0 | 0 |
## Максимальная нагрузка: chainCount=100, nestingDepth=100
| Сценарий | cherrypick Mean (мкс) | cherrypick ΔRSS | get_it Mean (мкс) | get_it ΔRSS |
|-------------------|---------------------:|----------------:|-----------------:|------------:|
| RegisterSingleton | 1.0 | 32 | 1.0 | 0 |
| ChainSingleton | 3884.0 | 0 | 1.5 | 34848 |
| ChainFactory | 4088.0 | 0 | 50.0 | 12528 |
| AsyncChain | 4287.0 | 0 | 17.0 | 63120 |
| Named | 1.0 | 0 | 0.0 | 0 |
| Override | 4767.5 | 0 | 1.5 | 14976 |
---
## Пояснения по сценариям
- **RegisterSingleton** — базовый тест DI (регистрация и резолвинг singleton). Практически мгновенно у обоих DI.
- **ChainSingleton** — глубокая singleton-цепочка. get_it вне конкуренции по скорости, cherrypick медленнее из-за более сложной логики поиска именованных зависимостей, но предсказуем.
- **ChainFactory** — цепочка Factory-объектов. cherrypick заметно медленнее на длинных цепях, get_it почти не увеличивает время.
- **AsyncChain** — асинхронная цепочка сервисов. get_it существенно быстрее, cherrypick страдает на глубине/ширине.
- **Named** — разрешение зависимостей по имени. Оба DI почти мгновенны.
- **Override** — переопределение alias без имени в дочернем scope. get_it (со стековыми scope) почти не теряет времени; cherrypick предсказуемо замедляется на глубине/ширине.
## Итог
- **get_it** выдаёт отличную производительность по всем сценариям, особенно на больших графах; но не поддерживает продвинутую диагностику, проверки циклов, расширенные scope.
- **cherrypick** — незаменим для работы с корпоративными/тестируемыми архитектурами и наследованием, устойчиво ведёт себя на тысячи зависимостей, но требует учёта роста времени при экстремальных нагрузках.
**Рекомендация:**
- cherrypick — выбор для серьёзных production-систем и тестирования;
- get_it — лидер для MVP, быстрых демо, прототипов, CLI, games.

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
analyzer:
errors:
deprecated_member_use: ignore
depend_on_referenced_packages: 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,5 @@
import 'package:benchmark_di/cli/benchmark_cli.dart';
Future<void> main(List<String> args) async {
await BenchmarkCliRunner().run(args);
}

View File

@@ -0,0 +1,41 @@
import 'package:benchmark_di/scenarios/universal_binding_mode.dart';
import 'package:benchmark_di/scenarios/universal_scenario.dart';
import 'package:benchmark_harness/benchmark_harness.dart';
import 'package:benchmark_di/di_adapters/di_adapter.dart';
import 'package:benchmark_di/scenarios/universal_service.dart';
class UniversalChainAsyncBenchmark<TContainer> extends AsyncBenchmarkBase {
final DIAdapter<TContainer> di;
final int chainCount;
final int nestingDepth;
final UniversalBindingMode mode;
UniversalChainAsyncBenchmark(
this.di, {
this.chainCount = 1,
this.nestingDepth = 3,
this.mode = UniversalBindingMode.asyncStrategy,
}) : super('UniversalAsync: asyncChain/$mode CD=$chainCount/$nestingDepth');
@override
Future<void> setup() async {
di.setupDependencies(di.universalRegistration(
chainCount: chainCount,
nestingDepth: nestingDepth,
bindingMode: mode,
scenario: UniversalScenario.asyncChain,
));
await di.waitForAsyncReady();
}
@override
Future<void> teardown() async {
di.teardown();
}
@override
Future<void> run() async {
final serviceName = '${chainCount}_$nestingDepth';
await di.resolveAsync<UniversalService>(named: serviceName);
}
}

View File

@@ -0,0 +1,79 @@
import 'package:benchmark_di/scenarios/universal_binding_mode.dart';
import 'package:benchmark_di/scenarios/universal_scenario.dart';
import 'package:benchmark_harness/benchmark_harness.dart';
import 'package:benchmark_di/di_adapters/di_adapter.dart';
import 'package:benchmark_di/scenarios/universal_service.dart';
class UniversalChainBenchmark<TContainer> extends BenchmarkBase {
final DIAdapter<TContainer> _di;
final int chainCount;
final int nestingDepth;
final UniversalBindingMode mode;
final UniversalScenario scenario;
DIAdapter<TContainer>? _childDi;
UniversalChainBenchmark(
this._di, {
this.chainCount = 1,
this.nestingDepth = 3,
this.mode = UniversalBindingMode.singletonStrategy,
this.scenario = UniversalScenario.chain,
}) : super('Universal: $scenario/$mode CD=$chainCount/$nestingDepth');
@override
void setup() {
switch (scenario) {
case UniversalScenario.override:
_di.setupDependencies(_di.universalRegistration(
chainCount: chainCount,
nestingDepth: nestingDepth,
bindingMode: UniversalBindingMode.singletonStrategy,
scenario: UniversalScenario.chain,
));
_childDi = _di.openSubScope('child');
_childDi!.setupDependencies(_childDi!.universalRegistration(
chainCount: chainCount,
nestingDepth: nestingDepth,
bindingMode: UniversalBindingMode.singletonStrategy,
scenario: UniversalScenario.chain,
));
break;
default:
_di.setupDependencies(_di.universalRegistration(
chainCount: chainCount,
nestingDepth: nestingDepth,
bindingMode: mode,
scenario: scenario,
));
break;
}
}
@override
void teardown() => _di.teardown();
@override
void run() {
switch (scenario) {
case UniversalScenario.register:
_di.resolve<UniversalService>();
break;
case UniversalScenario.named:
if (_di.runtimeType.toString().contains('GetItAdapter')) {
_di.resolve<UniversalService>(named: 'impl2');
} else {
_di.resolve<UniversalService>(named: 'impl2');
}
break;
case UniversalScenario.chain:
final serviceName = '${chainCount}_$nestingDepth';
_di.resolve<UniversalService>(named: serviceName);
break;
case UniversalScenario.override:
_childDi!.resolve<UniversalService>();
break;
case UniversalScenario.asyncChain:
throw UnsupportedError('asyncChain supported only in UniversalChainAsyncBenchmark');
}
}
}

View File

@@ -0,0 +1,133 @@
import 'dart:math';
import 'package:benchmark_di/cli/report/markdown_report.dart';
import 'package:benchmark_di/scenarios/universal_scenario.dart';
import 'package:cherrypick/cherrypick.dart';
import 'package:get_it/get_it.dart';
import 'package:riverpod/riverpod.dart' as rp;
import 'report/pretty_report.dart';
import 'report/csv_report.dart';
import 'report/json_report.dart';
import 'parser.dart';
import 'runner.dart';
import 'package:benchmark_di/benchmarks/universal_chain_benchmark.dart';
import 'package:benchmark_di/benchmarks/universal_chain_async_benchmark.dart';
import 'package:benchmark_di/di_adapters/cherrypick_adapter.dart';
import 'package:benchmark_di/di_adapters/get_it_adapter.dart';
import 'package:benchmark_di/di_adapters/riverpod_adapter.dart';
/// Command-line interface (CLI) runner for benchmarks.
///
/// Parses CLI arguments, orchestrates benchmarks for different
/// scenarios and configurations, collects results, and generates reports
/// in the desired output format.
class BenchmarkCliRunner {
/// Runs benchmarks based on CLI [args], configuring different test scenarios.
Future<void> run(List<String> args) async {
final config = parseBenchmarkCli(args);
final results = <Map<String, dynamic>>[];
for (final bench in config.benchesToRun) {
final scenario = toScenario(bench);
final mode = toMode(bench);
for (final c in config.chainCounts) {
for (final d in config.nestDepths) {
BenchmarkResult benchResult;
if (config.di == 'getit') {
final di = GetItAdapter();
if (scenario == UniversalScenario.asyncChain) {
final benchAsync = UniversalChainAsyncBenchmark<GetIt>(di,
chainCount: c, nestingDepth: d, mode: mode,
);
benchResult = await BenchmarkRunner.runAsync(
benchmark: benchAsync,
warmups: config.warmups,
repeats: config.repeats,
);
} else {
final benchSync = UniversalChainBenchmark<GetIt>(di,
chainCount: c, nestingDepth: d, mode: mode, scenario: scenario,
);
benchResult = await BenchmarkRunner.runSync(
benchmark: benchSync,
warmups: config.warmups,
repeats: config.repeats,
);
}
} else if (config.di == 'riverpod') {
final di = RiverpodAdapter();
if (scenario == UniversalScenario.asyncChain) {
final benchAsync = UniversalChainAsyncBenchmark<Map<String, rp.ProviderBase<Object?>>>(di,
chainCount: c, nestingDepth: d, mode: mode,
);
benchResult = await BenchmarkRunner.runAsync(
benchmark: benchAsync,
warmups: config.warmups,
repeats: config.repeats,
);
} else {
final benchSync = UniversalChainBenchmark<Map<String, rp.ProviderBase<Object?>>>(di,
chainCount: c, nestingDepth: d, mode: mode, scenario: scenario,
);
benchResult = await BenchmarkRunner.runSync(
benchmark: benchSync,
warmups: config.warmups,
repeats: config.repeats,
);
}
} else {
final di = CherrypickDIAdapter();
if (scenario == UniversalScenario.asyncChain) {
final benchAsync = UniversalChainAsyncBenchmark<Scope>(di,
chainCount: c, nestingDepth: d, mode: mode,
);
benchResult = await BenchmarkRunner.runAsync(
benchmark: benchAsync,
warmups: config.warmups,
repeats: config.repeats,
);
} else {
final benchSync = UniversalChainBenchmark<Scope>(di,
chainCount: c, nestingDepth: d, mode: mode, scenario: scenario,
);
benchResult = await BenchmarkRunner.runSync(
benchmark: benchSync,
warmups: config.warmups,
repeats: config.repeats,
);
}
}
final timings = benchResult.timings;
timings.sort();
var mean = timings.reduce((a, b) => a + b) / timings.length;
var median = timings[timings.length ~/ 2];
var minVal = timings.first;
var maxVal = timings.last;
var stddev = timings.isEmpty ? 0 : sqrt(timings.map((x) => pow(x - mean, 2)).reduce((a, b) => a + b) / timings.length);
results.add({
'benchmark': 'Universal_$bench',
'chainCount': c,
'nestingDepth': d,
'mean_us': mean.toStringAsFixed(2),
'median_us': median.toStringAsFixed(2),
'stddev_us': stddev.toStringAsFixed(2),
'min_us': minVal.toStringAsFixed(2),
'max_us': maxVal.toStringAsFixed(2),
'trials': timings.length,
'timings_us': timings.map((t) => t.toStringAsFixed(2)).toList(),
'memory_diff_kb': benchResult.memoryDiffKb,
'delta_peak_kb': benchResult.deltaPeakKb,
'peak_rss_kb': benchResult.peakRssKb,
});
}
}
}
final reportGenerators = {
'pretty': PrettyReport(),
'csv': CsvReport(),
'json': JsonReport(),
'markdown': MarkdownReport(),
};
print(reportGenerators[config.format]?.render(results) ?? PrettyReport().render(results));
}
}

View File

@@ -0,0 +1,130 @@
import 'dart:io';
import 'package:args/args.dart';
import 'package:benchmark_di/scenarios/universal_binding_mode.dart';
import 'package:benchmark_di/scenarios/universal_scenario.dart';
/// Enum describing all supported Universal DI benchmark types.
enum UniversalBenchmark {
/// Simple singleton registration benchmark
registerSingleton,
/// Chain of singleton dependencies
chainSingleton,
/// Chain using factories
chainFactory,
/// Async chain resolution
chainAsync,
/// Named registration benchmark
named,
/// Override/child-scope benchmark
override,
}
/// Maps [UniversalBenchmark] to the scenario enum for DI chains.
UniversalScenario toScenario(UniversalBenchmark b) {
switch (b) {
case UniversalBenchmark.registerSingleton:
return UniversalScenario.register;
case UniversalBenchmark.chainSingleton:
return UniversalScenario.chain;
case UniversalBenchmark.chainFactory:
return UniversalScenario.chain;
case UniversalBenchmark.chainAsync:
return UniversalScenario.asyncChain;
case UniversalBenchmark.named:
return UniversalScenario.named;
case UniversalBenchmark.override:
return UniversalScenario.override;
}
}
/// Maps benchmark to registration mode (singleton/factory/async).
UniversalBindingMode toMode(UniversalBenchmark b) {
switch (b) {
case UniversalBenchmark.registerSingleton:
return UniversalBindingMode.singletonStrategy;
case UniversalBenchmark.chainSingleton:
return UniversalBindingMode.singletonStrategy;
case UniversalBenchmark.chainFactory:
return UniversalBindingMode.factoryStrategy;
case UniversalBenchmark.chainAsync:
return UniversalBindingMode.asyncStrategy;
case UniversalBenchmark.named:
return UniversalBindingMode.singletonStrategy;
case UniversalBenchmark.override:
return UniversalBindingMode.singletonStrategy;
}
}
/// Utility to parse a string into its corresponding enum value [T].
T parseEnum<T>(String value, List<T> values, T defaultValue) {
return values.firstWhere(
(v) => v.toString().split('.').last.toLowerCase() == value.toLowerCase(),
orElse: () => defaultValue,
);
}
/// Parses comma-separated integer list from [s].
List<int> parseIntList(String s) =>
s.split(',').map((e) => int.tryParse(e.trim()) ?? 0).where((x) => x > 0).toList();
/// CLI config describing what and how to benchmark.
class BenchmarkCliConfig {
/// Benchmarks enabled to run (scenarios).
final List<UniversalBenchmark> benchesToRun;
/// List of chain counts (parallel, per test).
final List<int> chainCounts;
/// List of nesting depths (max chain length, per test).
final List<int> nestDepths;
/// How many times to repeat each trial.
final int repeats;
/// How many times to warm-up before measuring.
final int warmups;
/// Output report format.
final String format;
/// Name of DI implementation ("cherrypick" or "getit")
final String di;
BenchmarkCliConfig({
required this.benchesToRun,
required this.chainCounts,
required this.nestDepths,
required this.repeats,
required this.warmups,
required this.format,
required this.di,
});
}
/// Parses CLI arguments [args] into a [BenchmarkCliConfig].
/// Supports --benchmark, --chainCount, --nestingDepth, etc.
BenchmarkCliConfig parseBenchmarkCli(List<String> args) {
final parser = ArgParser()
..addOption('benchmark', abbr: 'b', defaultsTo: 'chainSingleton')
..addOption('chainCount', abbr: 'c', defaultsTo: '10')
..addOption('nestingDepth', abbr: 'd', defaultsTo: '5')
..addOption('repeat', abbr: 'r', defaultsTo: '2')
..addOption('warmup', abbr: 'w', defaultsTo: '1')
..addOption('format', abbr: 'f', defaultsTo: 'pretty')
..addOption('di', defaultsTo: 'cherrypick', help: 'DI implementation: cherrypick, getit or riverpod')
..addFlag('help', abbr: 'h', negatable: false, help: 'Show help');
final result = parser.parse(args);
if (result['help'] == true) {
print(parser.usage);
exit(0);
}
final benchName = result['benchmark'] as String;
final isAll = benchName == 'all';
final allBenches = UniversalBenchmark.values;
final benchesToRun = isAll
? allBenches
: [parseEnum(benchName, allBenches, UniversalBenchmark.chainSingleton)];
return BenchmarkCliConfig(
benchesToRun: benchesToRun,
chainCounts: parseIntList(result['chainCount'] as String),
nestDepths: parseIntList(result['nestingDepth'] as String),
repeats: int.tryParse(result['repeat'] as String? ?? "") ?? 2,
warmups: int.tryParse(result['warmup'] as String? ?? "") ?? 1,
format: result['format'] as String,
di: result['di'] as String? ?? 'cherrypick',
);
}

View File

@@ -0,0 +1,24 @@
import 'report_generator.dart';
/// Generates a CSV-formatted report for benchmark results.
class CsvReport extends ReportGenerator {
/// List of all keys/columns to include in the CSV output.
@override
final List<String> keys = [
'benchmark','chainCount','nestingDepth','mean_us','median_us','stddev_us',
'min_us','max_us','trials','timings_us','memory_diff_kb','delta_peak_kb','peak_rss_kb'
];
/// Renders rows as a CSV table string.
@override
String render(List<Map<String, dynamic>> rows) {
final header = keys.join(',');
final lines = rows.map((r) =>
keys.map((k) {
final v = r[k];
if (v is List) return '"${v.join(';')}"';
return (v ?? '').toString();
}).join(',')
).toList();
return ([header] + lines).join('\n');
}
}

View File

@@ -0,0 +1,13 @@
import 'report_generator.dart';
/// Generates a JSON-formatted report for benchmark results.
class JsonReport extends ReportGenerator {
/// No specific keys; outputs all fields in raw map.
@override
List<String> get keys => [];
/// Renders all result rows as a pretty-printed JSON array.
@override
String render(List<Map<String, dynamic>> rows) {
return '[\n${rows.map((r) => ' $r').join(',\n')}\n]';
}
}

View File

@@ -0,0 +1,78 @@
import 'report_generator.dart';
/// Generates a Markdown-formatted report for benchmark results.
///
/// Displays result rows as a visually clear Markdown table including a legend for all metrics.
class MarkdownReport extends ReportGenerator {
/// List of columns (keys) to show in the Markdown table.
@override
final List<String> keys = [
'benchmark','chainCount','nestingDepth','mean_us','median_us','stddev_us',
'min_us','max_us','trials','memory_diff_kb','delta_peak_kb','peak_rss_kb'
];
/// Friendly display names for each benchmark type.
static const nameMap = {
'Universal_UniversalBenchmark.registerSingleton':'RegisterSingleton',
'Universal_UniversalBenchmark.chainSingleton':'ChainSingleton',
'Universal_UniversalBenchmark.chainFactory':'ChainFactory',
'Universal_UniversalBenchmark.chainAsync':'AsyncChain',
'Universal_UniversalBenchmark.named':'Named',
'Universal_UniversalBenchmark.override':'Override',
};
/// Renders all results as a formatted Markdown table with aligned columns and a legend.
@override
String render(List<Map<String, dynamic>> rows) {
final headers = [
'Benchmark', 'Chain Count', 'Depth', 'Mean (us)', 'Median', 'Stddev', 'Min', 'Max', 'N', 'ΔRSS(KB)', 'ΔPeak(KB)', 'PeakRSS(KB)'
];
final dataRows = rows.map((r) {
final readableName = nameMap[r['benchmark']] ?? r['benchmark'];
return [
readableName,
r['chainCount'],
r['nestingDepth'],
r['mean_us'],
r['median_us'],
r['stddev_us'],
r['min_us'],
r['max_us'],
r['trials'],
r['memory_diff_kb'],
r['delta_peak_kb'],
r['peak_rss_kb'],
].map((cell) => cell.toString()).toList();
}).toList();
// Calculate column width for pretty alignment
final all = [headers] + dataRows;
final widths = List.generate(headers.length, (i) {
return all.map((row) => row[i].length).reduce((a, b) => a > b ? a : b);
});
String rowToLine(List<String> row, {String sep = ' | '}) =>
'| ${List.generate(row.length, (i) => row[i].padRight(widths[i])).join(sep)} |';
final headerLine = rowToLine(headers);
final divider = '| ${widths.map((w) => '-' * w).join(' | ')} |';
final lines = dataRows.map(rowToLine).toList();
final legend = '''
> **Legend:**
> `Benchmark` Test name
> `Chain Count` Number of independent chains
> `Depth` Depth of each chain
> `Mean (us)` Average time per run (microseconds)
> `Median` Median time per run
> `Stddev` Standard deviation
> `Min`, `Max` Min/max run time
> `N` Number of measurements
> `ΔRSS(KB)` Change in process memory (KB)
> `ΔPeak(KB)` Change in peak RSS (KB)
> `PeakRSS(KB)` Max observed RSS memory (KB)
''';
return '$legend\n\n${([headerLine, divider] + lines).join('\n')}' ;
}
}

View File

@@ -0,0 +1,50 @@
import 'report_generator.dart';
/// Generates a human-readable, tab-delimited report for benchmark results.
///
/// Used for terminal and log output; shows each result as a single line with labeled headers.
class PrettyReport extends ReportGenerator {
/// List of columns to output in the pretty report.
@override
final List<String> keys = [
'benchmark','chainCount','nestingDepth','mean_us','median_us','stddev_us',
'min_us','max_us','trials','memory_diff_kb','delta_peak_kb','peak_rss_kb'
];
/// Mappings from internal benchmark IDs to display names.
static const nameMap = {
'Universal_UniversalBenchmark.registerSingleton': 'RegisterSingleton',
'Universal_UniversalBenchmark.chainSingleton': 'ChainSingleton',
'Universal_UniversalBenchmark.chainFactory': 'ChainFactory',
'Universal_UniversalBenchmark.chainAsync': 'AsyncChain',
'Universal_UniversalBenchmark.named': 'Named',
'Universal_UniversalBenchmark.override': 'Override',
};
/// Renders the results as a header + tab-separated value table.
@override
String render(List<Map<String, dynamic>> rows) {
final headers = [
'Benchmark', 'Chain Count', 'Depth', 'Mean (us)', 'Median', 'Stddev', 'Min', 'Max', 'N', 'ΔRSS(KB)', 'ΔPeak(KB)', 'PeakRSS(KB)'
];
final header = headers.join('\t');
final lines = rows.map((r) {
final readableName = nameMap[r['benchmark']] ?? r['benchmark'];
return [
readableName,
r['chainCount'],
r['nestingDepth'],
r['mean_us'],
r['median_us'],
r['stddev_us'],
r['min_us'],
r['max_us'],
r['trials'],
r['memory_diff_kb'],
r['delta_peak_kb'],
r['peak_rss_kb'],
].join('\t');
}).toList();
return ([header] + lines).join('\n');
}
}

View File

@@ -0,0 +1,9 @@
/// Abstract base for generating benchmark result reports in different formats.
///
/// Subclasses implement [render] to output results, and [keys] to define columns (if any).
abstract class ReportGenerator {
/// Renders the given [results] as a formatted string (table, markdown, csv, etc).
String render(List<Map<String, dynamic>> results);
/// List of output columns/keys included in the export (or [] for auto/all).
List<String> get keys;
}

View File

@@ -0,0 +1,96 @@
import 'dart:io';
import 'dart:math';
import 'package:benchmark_di/benchmarks/universal_chain_benchmark.dart';
import 'package:benchmark_di/benchmarks/universal_chain_async_benchmark.dart';
/// Holds the results for a single benchmark execution.
class BenchmarkResult {
/// List of timings for each run (in microseconds).
final List<num> timings;
/// Difference in memory (RSS, in KB) after running.
final int memoryDiffKb;
/// Difference between peak RSS and initial RSS (in KB).
final int deltaPeakKb;
/// Peak RSS memory observed (in KB).
final int peakRssKb;
BenchmarkResult({
required this.timings,
required this.memoryDiffKb,
required this.deltaPeakKb,
required this.peakRssKb,
});
/// Computes a BenchmarkResult instance from run timings and memory data.
factory BenchmarkResult.collect({
required List<num> timings,
required List<int> rssValues,
required int memBefore,
}) {
final memAfter = ProcessInfo.currentRss;
final memDiffKB = ((memAfter - memBefore) / 1024).round();
final peakRss = [...rssValues, memBefore].reduce(max);
final deltaPeakKb = ((peakRss - memBefore) / 1024).round();
return BenchmarkResult(
timings: timings,
memoryDiffKb: memDiffKB,
deltaPeakKb: deltaPeakKb,
peakRssKb: (peakRss / 1024).round(),
);
}
}
/// Static methods to execute and time benchmarks for DI containers.
class BenchmarkRunner {
/// Runs a synchronous benchmark ([UniversalChainBenchmark]) for a given number of [warmups] and [repeats].
/// Collects execution time and observed memory.
static Future<BenchmarkResult> runSync({
required UniversalChainBenchmark benchmark,
required int warmups,
required int repeats,
}) async {
final timings = <num>[];
final rssValues = <int>[];
for (int i = 0; i < warmups; i++) {
benchmark.setup();
benchmark.run();
benchmark.teardown();
}
final memBefore = ProcessInfo.currentRss;
for (int i = 0; i < repeats; i++) {
benchmark.setup();
final sw = Stopwatch()..start();
benchmark.run();
sw.stop();
timings.add(sw.elapsedMicroseconds);
rssValues.add(ProcessInfo.currentRss);
benchmark.teardown();
}
return BenchmarkResult.collect(timings: timings, rssValues: rssValues, memBefore: memBefore);
}
/// Runs an asynchronous benchmark ([UniversalChainAsyncBenchmark]) for a given number of [warmups] and [repeats].
/// Collects execution time and observed memory.
static Future<BenchmarkResult> runAsync({
required UniversalChainAsyncBenchmark benchmark,
required int warmups,
required int repeats,
}) async {
final timings = <num>[];
final rssValues = <int>[];
for (int i = 0; i < warmups; i++) {
await benchmark.setup();
await benchmark.run();
await benchmark.teardown();
}
final memBefore = ProcessInfo.currentRss;
for (int i = 0; i < repeats; i++) {
await benchmark.setup();
final sw = Stopwatch()..start();
await benchmark.run();
sw.stop();
timings.add(sw.elapsedMicroseconds);
rssValues.add(ProcessInfo.currentRss);
await benchmark.teardown();
}
return BenchmarkResult.collect(timings: timings, rssValues: rssValues, memBefore: memBefore);
}
}

View File

@@ -0,0 +1,188 @@
import 'package:benchmark_di/scenarios/universal_binding_mode.dart';
import 'package:benchmark_di/scenarios/universal_scenario.dart';
import 'package:benchmark_di/scenarios/universal_service.dart';
import 'package:cherrypick/cherrypick.dart';
import 'di_adapter.dart';
/// Test module that generates a chain of service bindings for benchmarking.
///
/// Configurable by chain count, nesting depth, binding mode, and scenario
/// to support various DI performance tests (singleton, factory, async, etc).
class UniversalChainModule extends Module {
/// Number of chains to create.
final int chainCount;
/// Depth of each chain.
final int nestingDepth;
/// How modules are registered (factory/singleton/async).
final UniversalBindingMode bindingMode;
/// Which di scenario to generate (chained, named, etc).
final UniversalScenario scenario;
/// Constructs a configured test DI module for the benchmarks.
UniversalChainModule({
required this.chainCount,
required this.nestingDepth,
this.bindingMode = UniversalBindingMode.singletonStrategy,
this.scenario = UniversalScenario.chain,
});
@override
void builder(Scope currentScope) {
if (scenario == UniversalScenario.asyncChain) {
// Generate async chain with singleton async bindings.
for (var chainIndex = 0; chainIndex < chainCount; chainIndex++) {
for (var levelIndex = 0; levelIndex < nestingDepth; levelIndex++) {
final chain = chainIndex + 1;
final level = levelIndex + 1;
final prevDepName = '${chain}_${level - 1}';
final depName = '${chain}_$level';
bind<UniversalService>()
.toProvideAsync(() async {
final prev = level > 1
? await currentScope.resolveAsync<UniversalService>(named: prevDepName)
: null;
return UniversalServiceImpl(
value: depName,
dependency: prev,
);
})
.withName(depName)
.singleton();
}
}
return;
}
switch (scenario) {
case UniversalScenario.register:
// Simple singleton registration.
bind<UniversalService>()
.toProvide(() => UniversalServiceImpl(value: 'reg', dependency: null))
.singleton();
break;
case UniversalScenario.named:
// Named factory registration for two distinct objects.
bind<UniversalService>().toProvide(() => UniversalServiceImpl(value: 'impl1')).withName('impl1');
bind<UniversalService>().toProvide(() => UniversalServiceImpl(value: 'impl2')).withName('impl2');
break;
case UniversalScenario.chain:
// Chain of nested services, with dependency on previous level by name.
for (var chainIndex = 0; chainIndex < chainCount; chainIndex++) {
for (var levelIndex = 0; levelIndex < nestingDepth; levelIndex++) {
final chain = chainIndex + 1;
final level = levelIndex + 1;
final prevDepName = '${chain}_${level - 1}';
final depName = '${chain}_$level';
switch (bindingMode) {
case UniversalBindingMode.singletonStrategy:
bind<UniversalService>()
.toProvide(() => UniversalServiceImpl(
value: depName,
dependency: currentScope.tryResolve<UniversalService>(named: prevDepName),
))
.withName(depName)
.singleton();
break;
case UniversalBindingMode.factoryStrategy:
bind<UniversalService>()
.toProvide(() => UniversalServiceImpl(
value: depName,
dependency: currentScope.tryResolve<UniversalService>(named: prevDepName),
))
.withName(depName);
break;
case UniversalBindingMode.asyncStrategy:
bind<UniversalService>()
.toProvideAsync(() async => UniversalServiceImpl(
value: depName,
dependency: await currentScope.resolveAsync<UniversalService>(named: prevDepName),
))
.withName(depName)
.singleton();
break;
}
}
}
// Регистрация алиаса без имени (на последний элемент цепочки)
final depName = '${chainCount}_$nestingDepth';
bind<UniversalService>()
.toProvide(() => currentScope.resolve<UniversalService>(named: depName))
.singleton();
break;
case UniversalScenario.override:
// handled at benchmark level, но алиас нужен прямо в этом scope!
final depName = '${chainCount}_$nestingDepth';
bind<UniversalService>()
.toProvide(() => currentScope.resolve<UniversalService>(named: depName))
.singleton();
break;
case UniversalScenario.asyncChain:
// already handled above
break;
}
}
}
class CherrypickDIAdapter extends DIAdapter<Scope> {
Scope? _scope;
final bool _isSubScope;
CherrypickDIAdapter([Scope? scope, this._isSubScope = false]) {
_scope = scope;
}
@override
void setupDependencies(void Function(Scope container) registration) {
_scope ??= CherryPick.openRootScope();
registration(_scope!);
}
@override
Registration<Scope> universalRegistration<S extends Enum>({
required S scenario,
required int chainCount,
required int nestingDepth,
required UniversalBindingMode bindingMode,
}) {
if (scenario is UniversalScenario) {
return (scope) {
scope.installModules([
UniversalChainModule(
chainCount: chainCount,
nestingDepth: nestingDepth,
bindingMode: bindingMode,
scenario: scenario,
),
]);
};
}
throw UnsupportedError('Scenario $scenario not supported by CherrypickDIAdapter');
}
@override
T resolve<T extends Object>({String? named}) =>
_scope!.resolve<T>(named: named);
@override
Future<T> resolveAsync<T extends Object>({String? named}) async =>
_scope!.resolveAsync<T>(named: named);
@override
void teardown() {
if (!_isSubScope) {
CherryPick.closeRootScope();
_scope = null;
}
// SubScope teardown не требуется
}
@override
CherrypickDIAdapter openSubScope(String name) {
return CherrypickDIAdapter(_scope!.openSubScope(name), true);
}
@override
Future<void> waitForAsyncReady() async {}
}

View File

@@ -0,0 +1,32 @@
import 'package:benchmark_di/scenarios/universal_binding_mode.dart';
/// Универсальная абстракция для DI-адаптера с унифицированной функцией регистрации.
/// Теперь для каждого адаптера задаём строгий generic тип контейнера.
typedef Registration<TContainer> = void Function(TContainer);
abstract class DIAdapter<TContainer> {
/// Устанавливает зависимости с помощью строго типизированного контейнера.
void setupDependencies(void Function(TContainer container) registration);
/// Возвращает типобезопасную функцию регистрации зависимостей под конкретный сценарий.
Registration<TContainer> universalRegistration<S extends Enum>({
required S scenario,
required int chainCount,
required int nestingDepth,
required UniversalBindingMode bindingMode,
});
/// Резолвит (возвращает) экземпляр типа [T] (по имени, если требуется).
T resolve<T extends Object>({String? named});
/// Асинхронно резолвит экземпляр типа [T] (если нужно).
Future<T> resolveAsync<T extends Object>({String? named});
/// Уничтожает/отчищает DI-контейнер.
void teardown();
/// Открывает дочерний scope и возвращает новый адаптер (если поддерживается).
DIAdapter<TContainer> openSubScope(String name);
/// Ожидание готовности DI контейнера (если нужно для async DI).
Future<void> waitForAsyncReady() async {}
}

View File

@@ -0,0 +1,156 @@
import 'package:benchmark_di/scenarios/universal_binding_mode.dart';
import 'package:benchmark_di/scenarios/universal_scenario.dart';
import 'package:benchmark_di/scenarios/universal_service.dart';
import 'package:get_it/get_it.dart';
import 'di_adapter.dart';
/// Универсальный DIAdapter для GetIt c поддержкой scopes и строгой типизацией.
class GetItAdapter extends DIAdapter<GetIt> {
late GetIt _getIt;
final String? _scopeName;
final bool _isSubScope;
bool _scopePushed = false;
/// Основной (root) и subScope-конструкторы.
GetItAdapter({GetIt? instance, String? scopeName, bool isSubScope = false})
: _scopeName = scopeName,
_isSubScope = isSubScope {
if (instance != null) {
_getIt = instance;
}
}
@override
void setupDependencies(void Function(GetIt container) registration) {
if (_isSubScope) {
// Создаём scope через pushNewScope с init
_getIt.pushNewScope(
scopeName: _scopeName,
init: (getIt) => registration(getIt),
);
_scopePushed = true;
} else {
_getIt = GetIt.asNewInstance();
registration(_getIt);
}
}
@override
T resolve<T extends Object>({String? named}) =>
_getIt<T>(instanceName: named);
@override
Future<T> resolveAsync<T extends Object>({String? named}) async =>
_getIt<T>(instanceName: named);
@override
void teardown() {
if (_isSubScope && _scopePushed) {
_getIt.popScope();
_scopePushed = false;
} else {
_getIt.reset();
}
}
@override
GetItAdapter openSubScope(String name) =>
GetItAdapter(instance: _getIt, scopeName: name, isSubScope: true);
@override
Future<void> waitForAsyncReady() async {
await _getIt.allReady();
}
@override
Registration<GetIt> universalRegistration<S extends Enum>({
required S scenario,
required int chainCount,
required int nestingDepth,
required UniversalBindingMode bindingMode,
}) {
if (scenario is UniversalScenario) {
return (getIt) {
switch (scenario) {
case UniversalScenario.asyncChain:
for (int chain = 1; chain <= chainCount; chain++) {
for (int level = 1; level <= nestingDepth; level++) {
final prevDepName = '${chain}_${level - 1}';
final depName = '${chain}_$level';
getIt.registerSingletonAsync<UniversalService>(
() async {
final prev = level > 1
? await getIt.getAsync<UniversalService>(instanceName: prevDepName)
: null;
return UniversalServiceImpl(value: depName, dependency: prev);
},
instanceName: depName,
);
}
}
break;
case UniversalScenario.register:
getIt.registerSingleton<UniversalService>(UniversalServiceImpl(value: 'reg', dependency: null));
break;
case UniversalScenario.named:
getIt.registerFactory<UniversalService>(() => UniversalServiceImpl(value: 'impl1'), instanceName: 'impl1');
getIt.registerFactory<UniversalService>(() => UniversalServiceImpl(value: 'impl2'), instanceName: 'impl2');
break;
case UniversalScenario.chain:
for (int chain = 1; chain <= chainCount; chain++) {
for (int level = 1; level <= nestingDepth; level++) {
final prevDepName = '${chain}_${level - 1}';
final depName = '${chain}_$level';
switch (bindingMode) {
case UniversalBindingMode.singletonStrategy:
getIt.registerSingleton<UniversalService>(
UniversalServiceImpl(
value: depName,
dependency: level > 1
? getIt<UniversalService>(instanceName: prevDepName)
: null,
),
instanceName: depName,
);
break;
case UniversalBindingMode.factoryStrategy:
getIt.registerFactory<UniversalService>(
() => UniversalServiceImpl(
value: depName,
dependency: level > 1
? getIt<UniversalService>(instanceName: prevDepName)
: null,
),
instanceName: depName,
);
break;
case UniversalBindingMode.asyncStrategy:
getIt.registerSingletonAsync<UniversalService>(
() async => UniversalServiceImpl(
value: depName,
dependency: level > 1
? await getIt.getAsync<UniversalService>(instanceName: prevDepName)
: null,
),
instanceName: depName,
);
break;
}
}
}
break;
case UniversalScenario.override:
// handled at benchmark level
break;
}
if (scenario == UniversalScenario.chain || scenario == UniversalScenario.override) {
final depName = '${chainCount}_$nestingDepth';
getIt.registerSingleton<UniversalService>(
getIt<UniversalService>(instanceName: depName),
);
}
};
}
throw UnsupportedError('Scenario $scenario not supported by GetItAdapter');
}
}

View File

@@ -0,0 +1,139 @@
import 'package:benchmark_di/scenarios/universal_binding_mode.dart';
import 'package:benchmark_di/scenarios/universal_scenario.dart';
import 'package:benchmark_di/scenarios/universal_service.dart';
import 'package:riverpod/riverpod.dart' as rp;
import 'di_adapter.dart';
/// Унифицированный DIAdapter для Riverpod с поддержкой scopes и строгой типизацией.
class RiverpodAdapter extends DIAdapter<Map<String, rp.ProviderBase<Object?>>> {
rp.ProviderContainer? _container;
final Map<String, rp.ProviderBase<Object?>> _namedProviders;
final rp.ProviderContainer? _parent;
final bool _isSubScope;
RiverpodAdapter({
rp.ProviderContainer? container,
Map<String, rp.ProviderBase<Object?>>? providers,
rp.ProviderContainer? parent,
bool isSubScope = false,
}) : _container = container,
_namedProviders = providers ?? <String, rp.ProviderBase<Object?>>{},
_parent = parent,
_isSubScope = isSubScope;
@override
void setupDependencies(void Function(Map<String, rp.ProviderBase<Object?>> container) registration) {
_container ??= _parent == null
? rp.ProviderContainer()
: rp.ProviderContainer(parent: _parent);
registration(_namedProviders);
}
@override
T resolve<T extends Object>({String? named}) {
final key = named ?? T.toString();
final provider = _namedProviders[key];
if (provider == null) {
throw Exception('Provider not found for $key');
}
return _container!.read(provider) as T;
}
@override
Future<T> resolveAsync<T extends Object>({String? named}) async {
final key = named ?? T.toString();
final provider = _namedProviders[key];
if (provider == null) {
throw Exception('Provider not found for $key');
}
// Если это FutureProvider — используем .future
if (provider.runtimeType.toString().contains('FutureProvider')) {
return await _container!.read((provider as dynamic).future) as T;
}
return resolve<T>(named: named);
}
@override
void teardown() {
_container?.dispose();
_container = null;
_namedProviders.clear();
}
@override
RiverpodAdapter openSubScope(String name) {
final newContainer = rp.ProviderContainer(parent: _container);
return RiverpodAdapter(
container: newContainer,
providers: Map.of(_namedProviders),
parent: _container,
isSubScope: true,
);
}
@override
Future<void> waitForAsyncReady() async {
// Riverpod синхронный по умолчанию.
return;
}
@override
Registration<Map<String, rp.ProviderBase<Object?>>> universalRegistration<S extends Enum>({
required S scenario,
required int chainCount,
required int nestingDepth,
required UniversalBindingMode bindingMode,
}) {
if (scenario is UniversalScenario) {
return (providers) {
switch (scenario) {
case UniversalScenario.register:
providers['UniversalService'] = rp.Provider<UniversalService>((ref) => UniversalServiceImpl(value: 'reg', dependency: null));
break;
case UniversalScenario.named:
providers['impl1'] = rp.Provider<UniversalService>((ref) => UniversalServiceImpl(value: 'impl1'));
providers['impl2'] = rp.Provider<UniversalService>((ref) => UniversalServiceImpl(value: 'impl2'));
break;
case UniversalScenario.chain:
for (int chain = 1; chain <= chainCount; chain++) {
for (int level = 1; level <= nestingDepth; level++) {
final prevDepName = '${chain}_${level - 1}';
final depName = '${chain}_$level';
providers[depName] = rp.Provider<UniversalService>((ref) => UniversalServiceImpl(
value: depName,
dependency: level > 1 ? ref.watch(providers[prevDepName] as rp.ProviderBase<UniversalService>) : null,
));
}
}
final depName = '${chainCount}_$nestingDepth';
providers['UniversalService'] = rp.Provider<UniversalService>((ref) => ref.watch(providers[depName] as rp.ProviderBase<UniversalService>));
break;
case UniversalScenario.override:
// handled at benchmark level
break;
case UniversalScenario.asyncChain:
for (int chain = 1; chain <= chainCount; chain++) {
for (int level = 1; level <= nestingDepth; level++) {
final prevDepName = '${chain}_${level - 1}';
final depName = '${chain}_$level';
providers[depName] = rp.FutureProvider<UniversalService>((ref) async {
return UniversalServiceImpl(
value: depName,
dependency: level > 1
? await ref.watch((providers[prevDepName] as rp.FutureProvider<UniversalService>).future) as UniversalService?
: null,
);
});
}
}
final depName = '${chainCount}_$nestingDepth';
providers['UniversalService'] = rp.FutureProvider<UniversalService>((ref) async {
return await ref.watch((providers[depName] as rp.FutureProvider<UniversalService>).future);
});
break;
}
};
}
throw UnsupportedError('Scenario $scenario not supported by RiverpodAdapter');
}
}

View File

@@ -0,0 +1,11 @@
/// Enum to represent the DI registration/binding mode.
enum UniversalBindingMode {
/// Singleton/provider binding.
singletonStrategy,
/// Factory-based binding.
factoryStrategy,
/// Async-based binding.
asyncStrategy,
}

View File

@@ -0,0 +1,13 @@
/// Enum to represent which scenario is constructed for the benchmark.
enum UniversalScenario {
/// Single registration.
register,
/// Chain of dependencies.
chain,
/// Named registrations.
named,
/// Child-scope override scenario.
override,
/// Asynchronous chain scenario.
asyncChain,
}

View File

@@ -0,0 +1,17 @@
/// Base interface for any universal service in the benchmarks.
///
/// Represents an object in the dependency chain with an identifiable value
/// and (optionally) a dependency on a previous service in the chain.
abstract class UniversalService {
/// String ID for this service instance (e.g. chain/level info).
final String value;
/// Optional reference to dependency service in the chain.
final UniversalService? dependency;
UniversalService({required this.value, this.dependency});
}
/// Default implementation for [UniversalService] used in service chains.
class UniversalServiceImpl extends UniversalService {
UniversalServiceImpl({required super.value, super.dependency});
}

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>

132
benchmark_di/pubspec.lock Normal file
View File

@@ -0,0 +1,132 @@
# 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"
args:
dependency: "direct main"
description:
name: args
sha256: d0481093c50b1da8910eb0bb301626d4d8eb7284aa739614d2b394ee09e3ea04
url: "https://pub.dev"
source: hosted
version: "2.7.0"
async:
dependency: transitive
description:
name: async
sha256: "758e6d74e971c3e5aceb4110bfd6698efc7f501675bcfe0c775459a8140750eb"
url: "https://pub.dev"
source: hosted
version: "2.13.0"
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.2"
collection:
dependency: transitive
description:
name: collection
sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76"
url: "https://pub.dev"
source: hosted
version: "1.19.1"
exception_templates:
dependency: transitive
description:
name: exception_templates
sha256: "517f7c770da690073663f867ee2057ae2f4ffb28edae9da9faa624aa29ac76eb"
url: "https://pub.dev"
source: hosted
version: "0.3.1"
get_it:
dependency: "direct main"
description:
name: get_it
sha256: a4292e7cf67193f8e7c1258203104eb2a51ec8b3a04baa14695f4064c144297b
url: "https://pub.dev"
source: hosted
version: "8.2.0"
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"
path:
dependency: transitive
description:
name: path
sha256: "75cca69d1490965be98c73ceaea117e8a04dd21217b37b292c9ddbec0d955bc5"
url: "https://pub.dev"
source: hosted
version: "1.9.1"
riverpod:
dependency: "direct main"
description:
name: riverpod
sha256: "59062512288d3056b2321804332a13ffdd1bf16df70dcc8e506e411280a72959"
url: "https://pub.dev"
source: hosted
version: "2.6.1"
stack_trace:
dependency: transitive
description:
name: stack_trace
sha256: "8b27215b45d22309b5cddda1aa2b19bdfec9df0e765f2de506401c071d38d1b1"
url: "https://pub.dev"
source: hosted
version: "1.12.1"
state_notifier:
dependency: transitive
description:
name: state_notifier
sha256: b8677376aa54f2d7c58280d5a007f9e8774f1968d1fb1c096adcb4792fba29bb
url: "https://pub.dev"
source: hosted
version: "1.0.0"
sdks:
dart: ">=3.6.0 <4.0.0"

19
benchmark_di/pubspec.yaml Normal file
View File

@@ -0,0 +1,19 @@
name: benchmark_di
version: 0.1.0
publish_to: none
description: Universal benchmark for any DI library (cherrypick, get_it, and others)
environment:
sdk: '>=3.0.0 <4.0.0'
dependencies:
cherrypick:
path: ../cherrypick
args: ^2.7.0
get_it: ^8.2.0
riverpod: ^2.6.1
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 Version Cache
.fvm/ .fvm/
pubspec_overrides.yaml

View File

@@ -1,3 +1,48 @@
## 3.0.0-dev.5
- **REFACTOR**(scope): simplify _findBindingResolver<T> with one-liner and optional chaining.
- **PERF**(scope): speed up dependency lookup with Map-based binding resolver index.
- **DOCS**(perf): clarify Map-based resolver optimization applies since v3.0.0 in all docs.
- **DOCS**: update EN/RU quick start and tutorial with Fast Map-based lookup section; clarify performance benefit in README.
## 3.0.0-dev.4
- **REFACTOR**(scope): simplify _findBindingResolver<T> with one-liner and optional chaining.
- **PERF**(scope): speed up dependency lookup with Map-based binding resolver index.
- **DOCS**(perf): clarify Map-based resolver optimization applies since v3.0.0 in all docs.
- **DOCS**: update EN/RU quick start and tutorial with Fast Map-based lookup section; clarify performance benefit in README.
## 3.0.0-dev.3
- **REFACTOR**(scope): simplify _findBindingResolver<T> with one-liner and optional chaining.
- **PERF**(scope): speed up dependency lookup with Map-based binding resolver index.
- **DOCS**(perf): clarify Map-based resolver optimization applies since v3.0.0 in all docs.
- **DOCS**: update EN/RU quick start and tutorial with Fast Map-based lookup section; clarify performance benefit in README.
## 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 ## 2.2.0-dev.1
- **FIX**: fix warnings. - **FIX**: fix warnings.

View File

@@ -8,7 +8,6 @@
A **Binding** acts as a configuration for how to create or provide a particular dependency. Bindings support: A **Binding** acts as a configuration for how to create or provide a particular dependency. Bindings support:
- Direct instance assignment (`toInstance()`, `toInstanceAsync()`) - Direct instance assignment (`toInstance()`, `toInstanceAsync()`)
- Lazy providers (sync/async functions) - Lazy providers (sync/async functions)
- Provider functions supporting dynamic parameters - Provider functions supporting dynamic parameters
@@ -95,6 +94,13 @@ final subScope = rootScope.openSubScope('featureScope')
final dataBloc = await subScope.resolveAsync<DataBloc>(); final dataBloc = await subScope.resolveAsync<DataBloc>();
``` ```
### Fast Dependency Lookup (Performance Improvement)
> **Performance Note:**
> **Starting from version 3.0.0**, CherryPick uses a Map-based resolver index for dependency lookup. This means calls to `resolve<T>()` and related methods are now O(1) operations, regardless of the number of modules or bindings in your scope. Previously, the library had to iterate over all modules and bindings to locate the requested dependency, which could impact performance as your project grew.
>
> This optimization is internal and does not change any library APIs or usage patterns, but it significantly improves resolution speed in larger applications.
### Dependency Lookup API ### Dependency Lookup API
- `resolve<T>()` — Locates a dependency instance or throws if missing. - `resolve<T>()` — Locates a dependency instance or throws if missing.
@@ -237,6 +243,80 @@ class ApiClientImpl implements ApiClient {
- [x] Singleton Lifecycle Management - [x] Singleton Lifecycle Management
- [x] Modular and Hierarchical Composition - [x] Modular and Hierarchical Composition
- [x] Null-safe Resolution (tryResolve/tryResolveAsync) - [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 ## Contributing

View File

@@ -17,19 +17,28 @@ class FeatureModule extends Module {
@override @override
void builder(Scope currentScope) { void builder(Scope currentScope) {
// Using toProvideAsync for async initialization // 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( final client = await Future.delayed(
Duration(milliseconds: 100), Duration(milliseconds: 1000),
() => currentScope.resolve<ApiClient>( () => currentScope.resolve<ApiClient>(
named: isMock ? "apiClientMock" : "apiClientImpl")); named: isMock ? "apiClientMock" : "apiClientImpl",
),
);
return NetworkDataRepository(client); return NetworkDataRepository(client);
}).singleton(); }).singleton();
// Asynchronous initialization of DataBloc // Asynchronous initialization of DataBloc
bind<DataBloc>().toProvideAsync( bind<DataBloc>().toProvide(
() async { () async {
final repo = await currentScope.resolveAsync<DataRepository>( final repo = await currentScope.resolveAsync<DataRepository>(
named: "networkRepo"); named: "networkRepo",
params: 'Some params',
);
return DataBloc(repo); return DataBloc(repo);
}, },
); );
@@ -38,9 +47,7 @@ class FeatureModule extends Module {
Future<void> main() async { Future<void> main() async {
try { try {
final scope = openRootScope().installModules([ final scope = openRootScope().installModules([AppModule()]);
AppModule(),
]);
final subScope = scope final subScope = scope
.openSubScope("featureScope") .openSubScope("featureScope")
@@ -48,8 +55,11 @@ Future<void> main() async {
// Asynchronous instance resolution // Asynchronous instance resolution
final dataBloc = await subScope.resolveAsync<DataBloc>(); final dataBloc = await subScope.resolveAsync<DataBloc>();
dataBloc.data.listen((d) => print('Received data: $d'), dataBloc.data.listen(
onError: (e) => print('Error: $e'), onDone: () => print('DONE')); (d) => print('Received data: $d'),
onError: (e) => print('Error: $e'),
onDone: () => print('DONE'),
);
await dataBloc.fetchData(); await dataBloc.fetchData();
} catch (e) { } catch (e) {

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. // limitations under the License.
// //
export 'package:cherrypick/src/binding_resolver.dart';
export 'package:cherrypick/src/binding.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/helper.dart';
export 'package:cherrypick/src/module.dart'; export 'package:cherrypick/src/module.dart';
export 'package:cherrypick/src/scope.dart'; export 'package:cherrypick/src/scope.dart';

View File

@@ -11,45 +11,21 @@
// limitations under the License. // limitations under the License.
// //
enum Mode { simple, instance, providerInstance, providerInstanceWithParams } import 'package:cherrypick/src/binding_resolver.dart';
typedef Provider<T> = T? Function();
typedef ProviderWithParams<T> = T Function(dynamic params);
typedef AsyncProvider<T> = Future<T> Function();
typedef AsyncProviderWithParams<T> = Future<T> Function(dynamic params);
/// RU: Класс Binding<T> настраивает параметры экземпляра. /// RU: Класс Binding<T> настраивает параметры экземпляра.
/// ENG: The Binding<T> class configures the settings for the instance. /// ENG: The Binding<T> class configures the settings for the instance.
/// ///
class Binding<T> { class Binding<T> {
late Mode _mode;
late Type _key; late Type _key;
late String _name; String? _name;
T? _instance;
Future<T>? _instanceAsync;
Provider<T>? _provider;
ProviderWithParams<T>? _providerWithParams;
AsyncProvider<T>? asyncProvider; BindingResolver<T>? _resolver;
AsyncProviderWithParams<T>? asyncProviderWithParams;
late bool _isSingleton = false;
late bool _isNamed = false;
Binding() { Binding() {
_mode = Mode.simple;
_key = T; _key = T;
} }
/// RU: Метод возвращает [Mode] экземпляра.
/// ENG: The method returns the [Mode] of the instance.
///
/// return [Mode]
Mode get mode => _mode;
/// RU: Метод возвращает тип экземпляра. /// RU: Метод возвращает тип экземпляра.
/// ENG: The method returns the type of the instance. /// ENG: The method returns the type of the instance.
/// ///
@@ -60,19 +36,21 @@ class Binding<T> {
/// ENG: The method returns the name of the instance. /// ENG: The method returns the name of the instance.
/// ///
/// return [String] /// return [String]
String get name => _name; String? get name => _name;
/// RU: Метод проверяет сингелтон экземпляр или нет.
/// ENG: The method checks the singleton instance or not.
///
/// return [bool]
bool get isSingleton => _isSingleton;
/// RU: Метод проверяет именован экземпляр или нет. /// RU: Метод проверяет именован экземпляр или нет.
/// ENG: The method checks whether the instance is named or not. /// ENG: The method checks whether the instance is named or not.
/// ///
/// return [bool] /// 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]. /// RU: Добавляет имя для экземляпя [value].
/// ENG: Added name for instance [value]. /// ENG: Added name for instance [value].
@@ -80,7 +58,6 @@ class Binding<T> {
/// return [Binding] /// return [Binding]
Binding<T> withName(String name) { Binding<T> withName(String name) {
_name = name; _name = name;
_isNamed = true;
return this; return this;
} }
@@ -88,21 +65,9 @@ class Binding<T> {
/// ENG: Initialization instance [value]. /// ENG: Initialization instance [value].
/// ///
/// return [Binding] /// return [Binding]
Binding<T> toInstance(T value) { Binding<T> toInstance(Instance<T> value) {
_mode = Mode.instance; _resolver = InstanceResolver<T>(value);
_instance = value;
_isSingleton = true;
return this;
}
/// RU: Инициализация экземляпяра [value].
/// ENG: Initialization instance [value].
///
/// return [Binding]
Binding<T> toInstanceAsync(Future<T> value) {
_mode = Mode.instance;
_instanceAsync = value;
_isSingleton = true;
return this; return this;
} }
@@ -111,18 +76,8 @@ class Binding<T> {
/// ///
/// return [Binding] /// return [Binding]
Binding<T> toProvide(Provider<T> value) { Binding<T> toProvide(Provider<T> value) {
_mode = Mode.providerInstance; _resolver = ProviderResolver<T>((_) => value.call(), withParams: false);
_provider = value;
return this;
}
/// RU: Инициализация экземляпяра  через провайдер [value].
/// ENG: Initialization instance via provider [value].
///
/// return [Binding]
Binding<T> toProvideAsync(AsyncProvider<T> provider) {
_mode = Mode.providerInstance;
asyncProvider = provider;
return this; return this;
} }
@@ -131,19 +86,24 @@ class Binding<T> {
/// ///
/// return [Binding] /// return [Binding]
Binding<T> toProvideWithParams(ProviderWithParams<T> value) { Binding<T> toProvideWithParams(ProviderWithParams<T> value) {
_mode = Mode.providerInstanceWithParams; _resolver = ProviderResolver<T>(value, withParams: true);
_providerWithParams = value;
return this; return this;
} }
/// RU: Инициализация экземляра через асинхронный провайдер [value] с динамическим параметром. @Deprecated('Use toInstance instead of toInstanceAsync')
/// ENG: Initializes the instance via async provider [value] with a dynamic param. Binding<T> toInstanceAsync(Instance<T> value) {
/// return this.toInstance(value);
/// return [Binding] }
Binding<T> toProvideAsyncWithParams(AsyncProviderWithParams<T> provider) {
_mode = Mode.providerInstanceWithParams; @Deprecated('Use toProvide instead of toProvideAsync')
asyncProviderWithParams = provider; Binding<T> toProvideAsync(Provider<T> value) {
return this; return this.toProvide(value);
}
@Deprecated('Use toProvideWithParams instead of toProvideAsyncWithParams')
Binding<T> toProvideAsyncWithParams(ProviderWithParams<T> value) {
return this.toProvideWithParams(value);
} }
/// RU: Инициализация экземляпяра  как сингелтон [value]. /// RU: Инициализация экземляпяра  как сингелтон [value].
@@ -151,40 +111,16 @@ class Binding<T> {
/// ///
/// return [Binding] /// return [Binding]
Binding<T> singleton() { Binding<T> singleton() {
_isSingleton = true; _resolver?.toSingleton();
return this; return this;
} }
/// RU: Поиск экземпляра. T? resolveSync([dynamic params]) {
/// ENG: Resolve instance. return resolver?.resolveSync(params);
///
/// return [T]
T? get instance => _instance;
/// RU: Поиск экземпляра.
/// ENG: Resolve instance.
///
/// return [T]
Future<T>? get instanceAsync => _instanceAsync;
/// RU: Поиск экземпляра.
/// ENG: Resolve instance.
///
/// return [T]
T? get provider {
if (_isSingleton) {
_instance ??= _provider?.call();
return _instance;
}
return _provider?.call();
} }
/// RU: Поиск экземпляра с параметром. Future<T>? resolveAsync([dynamic params]) {
/// return resolver?.resolveAsync(params);
/// ENG: Resolve instance with [params].
///
/// return [T]
T? providerWithParams(dynamic params) {
return _providerWithParams?.call(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. // limitations under the License.
// //
import 'package:cherrypick/src/scope.dart'; import 'package:cherrypick/src/scope.dart';
import 'package:cherrypick/src/global_cycle_detector.dart';
import 'package:meta/meta.dart'; import 'package:meta/meta.dart';
Scope? _rootScope; Scope? _rootScope;
bool _globalCycleDetectionEnabled = false;
bool _globalCrossScopeCycleDetectionEnabled = false;
class CherryPick { class CherryPick {
/// RU: Метод открывает главный [Scope]. /// RU: Метод открывает главный [Scope].
@@ -22,6 +25,17 @@ class CherryPick {
/// return /// return
static Scope openRootScope() { static Scope openRootScope() {
_rootScope ??= Scope(null); _rootScope ??= Scope(null);
// Применяем глобальную настройку обнаружения циклических зависимостей
if (_globalCycleDetectionEnabled && !_rootScope!.isCycleDetectionEnabled) {
_rootScope!.enableCycleDetection();
}
// Применяем глобальную настройку обнаружения между скоупами
if (_globalCrossScopeCycleDetectionEnabled && !_rootScope!.isGlobalCycleDetectionEnabled) {
_rootScope!.enableGlobalCycleDetection();
}
return _rootScope!; 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]. /// RU: Метод открывает дочерний [Scope].
/// ENG: The method open the child [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'); throw Exception('Can not open sub scope because scopeName can not split');
} }
return nameParts.fold( final scope = nameParts.fold(
openRootScope(), openRootScope(),
(Scope previousValue, String element) => (Scope previousValue, String element) =>
previousValue.openSubScope(element)); previousValue.openSubScope(element));
// Применяем глобальную настройку обнаружения циклических зависимостей
if (_globalCycleDetectionEnabled && !scope.isCycleDetectionEnabled) {
scope.enableCycleDetection();
}
// Применяем глобальную настройку обнаружения между скоупами
if (_globalCrossScopeCycleDetectionEnabled && !scope.isGlobalCycleDetectionEnabled) {
scope.enableGlobalCycleDetection();
}
return scope;
} }
/// RU: Метод открывает дочерний [Scope]. /// RU: Метод открывает дочерний [Scope].
@@ -102,4 +272,106 @@ class CherryPick {
openRootScope().closeSubScope(nameParts[0]); 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. // limitations under the License.
// //
import 'dart:collection'; 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'; import 'package:cherrypick/src/module.dart';
Scope openRootScope() => Scope(null); Scope openRootScope() => Scope(null);
class Scope { class Scope with CycleDetectionMixin, GlobalCycleDetectionMixin {
final Scope? _parentScope; final Scope? _parentScope;
/// RU: Метод возвращает родительский [Scope]. /// RU: Метод возвращает родительский [Scope].
@@ -29,10 +32,26 @@ class Scope {
final Map<String, Scope> _scopeMap = HashMap(); final Map<String, Scope> _scopeMap = HashMap();
Scope(this._parentScope); Scope(this._parentScope) {
// Генерируем уникальный ID для скоупа
setScopeId(_generateScopeId());
}
final Set<Module> _modulesList = HashSet(); final Set<Module> _modulesList = HashSet();
// индекс для мгновенного поиска bindingов
final Map<Object, Map<String?, BindingResolver>> _bindingResolvers = {};
/// 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]. /// RU: Метод открывает дочерний (дополнительный) [Scope].
/// ///
/// ENG: The method opens child (additional) [Scope]. /// ENG: The method opens child (additional) [Scope].
@@ -40,7 +59,17 @@ class Scope {
/// return [Scope] /// return [Scope]
Scope openSubScope(String name) { Scope openSubScope(String name) {
if (!_scopeMap.containsKey(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]!; return _scopeMap[name]!;
} }
@@ -51,6 +80,13 @@ class Scope {
/// ///
/// return [Scope] /// return [Scope]
void closeSubScope(String name) { void closeSubScope(String name) {
final childScope = _scopeMap[name];
if (childScope != null) {
// Очищаем детектор для дочернего скоупа
if (childScope.scopeId != null) {
GlobalCycleDetector.instance.removeScopeDetector(childScope.scopeId!);
}
}
_scopeMap.remove(name); _scopeMap.remove(name);
} }
@@ -64,6 +100,7 @@ class Scope {
for (var module in modules) { for (var module in modules) {
module.builder(this); module.builder(this);
} }
_rebuildResolversIndex();
return this; return this;
} }
@@ -75,7 +112,7 @@ class Scope {
Scope dropModules() { Scope dropModules() {
// [AlexeyYuPopkov](https://github.com/AlexeyYuPopkov) Thank you for the [Removed exception "ConcurrentModificationError"](https://github.com/pese-git/cherrypick/pull/2) // [AlexeyYuPopkov](https://github.com/AlexeyYuPopkov) Thank you for the [Removed exception "ConcurrentModificationError"](https://github.com/pese-git/cherrypick/pull/2)
_modulesList.clear(); _modulesList.clear();
_rebuildResolversIndex();
return this; return this;
} }
@@ -91,46 +128,65 @@ class Scope {
/// return - returns an object of type [T] or [StateError] /// return - returns an object of type [T] or [StateError]
/// ///
T resolve<T>({String? named, dynamic params}) { 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) { if (resolved != null) {
return resolved; return resolved;
} else { } else {
throw StateError( throw StateError(
'Can\'t resolve dependency `$T`. Maybe you forget register it?'); 'Can\'t resolve dependency `$T`. Maybe you forget register it?');
} }
});
} }
/// RU: Возвращает найденную зависимость типа [T] или null, если она не может быть найдена. /// RU: Возвращает найденную зависимость типа [T] или null, если она не может быть найдена.
/// ENG: Returns found dependency of type [T] or null if it cannot be found. /// ENG: Returns found dependency of type [T] or null if it cannot be found.
/// ///
T? tryResolve<T>({String? named, dynamic params}) { T? tryResolve<T>({String? named, dynamic params}) {
// 1 Поиск зависимости по всем модулям текущего скоупа // Используем глобальное отслеживание, если включено
if (_modulesList.isNotEmpty) { if (isGlobalCycleDetectionEnabled) {
for (var module in _modulesList) { return withGlobalCycleDetection<T?>(T, named, () {
for (var binding in module.bindingSet) { return _tryResolveWithLocalDetection<T>(named: named, params: params);
if (binding.key == T && });
((!binding.isNamed && named == null) || } else {
(binding.isNamed && named == binding.name))) { return _tryResolveWithLocalDetection<T>(named: named, params: params);
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;
}
}
}
} }
} }
/// 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 Поиск зависимостей в родительском скоупе // 2 Поиск зависимостей в родительском скоупе
return _parentScope?.tryResolve(named: named, params: params); _parentScope?.tryResolve(named: named, params: params);
} }
/// RU: Асинхронно возвращает найденную зависимость, определенную параметром типа [T]. /// RU: Асинхронно возвращает найденную зависимость, определенную параметром типа [T].
@@ -144,40 +200,76 @@ class Scope {
/// return - returns an object of type [T] or [StateError] /// return - returns an object of type [T] or [StateError]
/// ///
Future<T> resolveAsync<T>({String? named, dynamic params}) async { 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) { if (resolved != null) {
return resolved; return resolved;
} else { } else {
throw StateError( throw StateError(
'Can\'t resolve async dependency `$T`. Maybe you forget register it?'); 'Can\'t resolve async dependency `$T`. Maybe you forget register it?');
} }
});
} }
Future<T?> tryResolveAsync<T>({String? named, dynamic params}) async { 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) =>
_bindingResolvers[T]?[named] as BindingResolver<T>?;
// Индексируем все bindingи после каждого installModules/dropModules
void _rebuildResolversIndex() {
_bindingResolvers.clear();
for (var module in _modulesList) { for (var module in _modulesList) {
for (var binding in module.bindingSet) { for (var binding in module.bindingSet) {
if (binding.key == T && _bindingResolvers.putIfAbsent(binding.key, () => {});
((!binding.isNamed && named == null) || final nameKey = binding.isNamed ? binding.name : null;
(binding.isNamed && named == binding.name))) { _bindingResolvers[binding.key]![nameKey] = binding.resolver!;
if (binding.instanceAsync != null) {
return await binding.instanceAsync;
}
if (binding.asyncProvider != null) {
return await binding.asyncProvider?.call();
}
if (binding.asyncProviderWithParams != null) {
if (params == null) {
throw StateError('Param is null. Maybe you forget pass it');
}
return await binding.asyncProviderWithParams!(params);
} }
} }
} }
} }
}
return _parentScope?.tryResolveAsync(named: named, params: params);
}
}

View File

@@ -1,10 +1,18 @@
name: cherrypick name: cherrypick
description: Cherrypick is a small dependency injection (DI) library for dart/flutter projects. description: Cherrypick is a small dependency injection (DI) library for dart/flutter projects.
version: 2.2.0-dev.1 version: 3.0.0-dev.5
homepage: https://pese-git.github.io/cherrypick-site/ homepage: https://pese-git.github.io/cherrypick-site/
documentation: https://github.com/pese-git/cherrypick/wiki documentation: https://github.com/pese-git/cherrypick/wiki
repository: https://github.com/pese-git/cherrypick repository: https://github.com/pese-git/cherrypick
issue_tracker: https://github.com/pese-git/cherrypick/issues issue_tracker: https://github.com/pese-git/cherrypick/issues
topics:
- di
- ioc
- scope
- dependency-injection
- dependency-management
- inversion-of-control
- container
environment: environment:
sdk: ">=3.5.2 <4.0.0" sdk: ">=3.5.2 <4.0.0"

View File

@@ -1,4 +1,4 @@
import 'package:cherrypick/src/binding.dart'; import 'package:cherrypick/cherrypick.dart';
import 'package:test/test.dart'; import 'package:test/test.dart';
void main() { void main() {
@@ -7,12 +7,12 @@ void main() {
group('Without name', () { group('Without name', () {
test('Returns null by default', () { test('Returns null by default', () {
final binding = Binding<int>(); final binding = Binding<int>();
expect(binding.instance, null); expect(binding.resolver, null);
}); });
test('Sets mode to instance', () { test('Sets mode to instance', () {
final binding = Binding<int>().toInstance(5); final binding = Binding<int>().toInstance(5);
expect(binding.mode, Mode.instance); expect(binding.resolver, isA<InstanceResolver<int>>());
}); });
test('isSingleton is true', () { test('isSingleton is true', () {
@@ -22,19 +22,19 @@ void main() {
test('Stores value', () { test('Stores value', () {
final binding = Binding<int>().toInstance(5); final binding = Binding<int>().toInstance(5);
expect(binding.instance, 5); expect(binding.resolver?.resolveSync(), 5);
}); });
}); });
group('With name', () { group('With name', () {
test('Returns null by default', () { test('Returns null by default', () {
final binding = Binding<int>().withName('n'); final binding = Binding<int>().withName('n');
expect(binding.instance, null); expect(binding.resolver, null);
}); });
test('Sets mode to instance', () { test('Sets mode to instance', () {
final binding = Binding<int>().withName('n').toInstance(5); final binding = Binding<int>().withName('n').toInstance(5);
expect(binding.mode, Mode.instance); expect(binding.resolver, isA<InstanceResolver<int>>());
}); });
test('Sets key', () { test('Sets key', () {
@@ -49,7 +49,7 @@ void main() {
test('Stores value', () { test('Stores value', () {
final binding = Binding<int>().withName('n').toInstance(5); final binding = Binding<int>().withName('n').toInstance(5);
expect(binding.instance, 5); expect(binding.resolver?.resolveSync(), 5);
}); });
test('Sets name', () { test('Sets name', () {
@@ -60,45 +60,39 @@ void main() {
test('Multiple toInstance calls change value', () { test('Multiple toInstance calls change value', () {
final binding = Binding<int>().toInstance(1).toInstance(2); final binding = Binding<int>().toInstance(1).toInstance(2);
expect(binding.instance, 2); expect(binding.resolver?.resolveSync(), 2);
}); });
}); });
// --- Instance binding (asynchronous) --- // --- Instance binding (asynchronous) ---
group('Async Instance Binding (toInstanceAsync)', () { group('Async Instance Binding (toInstanceAsync)', () {
test('Resolves instanceAsync with expected value', () async { test('Resolves instanceAsync with expected value', () async {
final binding = Binding<int>().toInstanceAsync(Future.value(42)); final binding = Binding<int>().toInstance(Future.value(42));
expect(await binding.instanceAsync, 42); expect(await binding.resolveAsync(), 42);
});
test('Does not affect instance', () {
final binding = Binding<int>().toInstanceAsync(Future.value(5));
expect(binding.instance, null);
}); });
test('Sets mode to instance', () { test('Sets mode to instance', () {
final binding = Binding<int>().toInstanceAsync(Future.value(5)); final binding = Binding<int>().toInstance(Future.value(5));
expect(binding.mode, Mode.instance); expect(binding.resolver, isA<InstanceResolver<int>>());
}); });
test('isSingleton is true after toInstanceAsync', () { test('isSingleton is true after toInstanceAsync', () {
final binding = Binding<int>().toInstanceAsync(Future.value(5)); final binding = Binding<int>().toInstance(Future.value(5));
expect(binding.isSingleton, isTrue); expect(binding.isSingleton, isTrue);
}); });
test('Composes with withName', () async { test('Composes with withName', () async {
final binding = Binding<int>() final binding =
.withName('asyncValue') Binding<int>().withName('asyncValue').toInstance(Future.value(7));
.toInstanceAsync(Future.value(7));
expect(binding.isNamed, isTrue); expect(binding.isNamed, isTrue);
expect(binding.name, 'asyncValue'); expect(binding.name, 'asyncValue');
expect(await binding.instanceAsync, 7); expect(await binding.resolveAsync(), 7);
}); });
test('Keeps value after multiple awaits', () async { test('Keeps value after multiple awaits', () async {
final binding = Binding<int>().toInstanceAsync(Future.value(123)); final binding = Binding<int>().toInstance(Future.value(123));
final result1 = await binding.instanceAsync; final result1 = await binding.resolveAsync();
final result2 = await binding.instanceAsync; final result2 = await binding.resolveAsync();
expect(result1, equals(result2)); expect(result1, equals(result2));
}); });
}); });
@@ -108,12 +102,12 @@ void main() {
group('Without name', () { group('Without name', () {
test('Returns null by default', () { test('Returns null by default', () {
final binding = Binding<int>(); final binding = Binding<int>();
expect(binding.provider, null); expect(binding.resolver, null);
}); });
test('Sets mode to providerInstance', () { test('Sets mode to providerInstance', () {
final binding = Binding<int>().toProvide(() => 5); final binding = Binding<int>().toProvide(() => 5);
expect(binding.mode, Mode.providerInstance); expect(binding.resolver, isA<ProviderResolver<int>>());
}); });
test('isSingleton is false by default', () { test('isSingleton is false by default', () {
@@ -123,19 +117,19 @@ void main() {
test('Returns provided value', () { test('Returns provided value', () {
final binding = Binding<int>().toProvide(() => 5); final binding = Binding<int>().toProvide(() => 5);
expect(binding.provider, 5); expect(binding.resolveSync(), 5);
}); });
}); });
group('With name', () { group('With name', () {
test('Returns null by default', () { test('Returns null by default', () {
final binding = Binding<int>().withName('n'); final binding = Binding<int>().withName('n');
expect(binding.provider, null); expect(binding.resolver, null);
}); });
test('Sets mode to providerInstance', () { test('Sets mode to providerInstance', () {
final binding = Binding<int>().withName('n').toProvide(() => 5); final binding = Binding<int>().withName('n').toProvide(() => 5);
expect(binding.mode, Mode.providerInstance); expect(binding.resolver, isA<ProviderResolver<int>>());
}); });
test('Sets key', () { test('Sets key', () {
@@ -150,7 +144,7 @@ void main() {
test('Returns provided value', () { test('Returns provided value', () {
final binding = Binding<int>().withName('n').toProvide(() => 5); final binding = Binding<int>().withName('n').toProvide(() => 5);
expect(binding.provider, 5); expect(binding.resolveSync(), 5);
}); });
test('Sets name', () { test('Sets name', () {
@@ -163,14 +157,14 @@ void main() {
// --- Async provider binding --- // --- Async provider binding ---
group('Async Provider Binding', () { group('Async Provider Binding', () {
test('Resolves asyncProvider value', () async { test('Resolves asyncProvider value', () async {
final binding = Binding<int>().toProvideAsync(() async => 5); final binding = Binding<int>().toProvide(() async => 5);
expect(await binding.asyncProvider?.call(), 5); expect(await binding.resolveAsync(), 5);
}); });
test('Resolves asyncProviderWithParams value', () async { test('Resolves asyncProviderWithParams value', () async {
final binding = Binding<int>() final binding = Binding<int>()
.toProvideAsyncWithParams((param) async => 5 + (param as int)); .toProvideWithParams((param) async => 5 + (param as int));
expect(await binding.asyncProviderWithParams?.call(3), 8); expect(await binding.resolveAsync(3), 8);
}); });
}); });
@@ -179,12 +173,7 @@ void main() {
group('Without name', () { group('Without name', () {
test('Returns null if no provider set', () { test('Returns null if no provider set', () {
final binding = Binding<int>().singleton(); final binding = Binding<int>().singleton();
expect(binding.provider, null); expect(binding.resolver, null);
});
test('Sets mode to providerInstance', () {
final binding = Binding<int>().toProvide(() => 5).singleton();
expect(binding.mode, Mode.providerInstance);
}); });
test('isSingleton is true', () { test('isSingleton is true', () {
@@ -194,7 +183,7 @@ void main() {
test('Returns singleton value', () { test('Returns singleton value', () {
final binding = Binding<int>().toProvide(() => 5).singleton(); final binding = Binding<int>().toProvide(() => 5).singleton();
expect(binding.provider, 5); expect(binding.resolveSync(), 5);
}); });
test('Returns same value each call and provider only called once', () { test('Returns same value each call and provider only called once', () {
@@ -204,8 +193,8 @@ void main() {
return counter; return counter;
}).singleton(); }).singleton();
final first = binding.provider; final first = binding.resolveSync();
final second = binding.provider; final second = binding.resolveSync();
expect(first, equals(second)); expect(first, equals(second));
expect(counter, 1); expect(counter, 1);
}); });
@@ -214,13 +203,7 @@ void main() {
group('With name', () { group('With name', () {
test('Returns null if no provider set', () { test('Returns null if no provider set', () {
final binding = Binding<int>().withName('n').singleton(); final binding = Binding<int>().withName('n').singleton();
expect(binding.provider, null); expect(binding.resolver, null);
});
test('Sets mode to providerInstance', () {
final binding =
Binding<int>().withName('n').toProvide(() => 5).singleton();
expect(binding.mode, Mode.providerInstance);
}); });
test('Sets key', () { test('Sets key', () {
@@ -238,7 +221,7 @@ void main() {
test('Returns singleton value', () { test('Returns singleton value', () {
final binding = final binding =
Binding<int>().withName('n').toProvide(() => 5).singleton(); Binding<int>().withName('n').toProvide(() => 5).singleton();
expect(binding.provider, 5); expect(binding.resolveSync(), 5);
}); });
test('Sets name', () { test('Sets name', () {
@@ -247,12 +230,6 @@ void main() {
expect(binding.name, 'n'); expect(binding.name, 'n');
}); });
}); });
test('Chained withName and singleton preserves mode', () {
final binding =
Binding<int>().toProvide(() => 3).withName("named").singleton();
expect(binding.mode, Mode.providerInstance);
});
}); });
// --- WithName / Named binding, isNamed, edge-cases --- // --- WithName / Named binding, isNamed, edge-cases ---
@@ -265,7 +242,7 @@ void main() {
test('providerWithParams returns null if not set', () { test('providerWithParams returns null if not set', () {
final binding = Binding<int>(); final binding = Binding<int>();
expect(binding.providerWithParams(123), null); 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

@@ -127,7 +127,7 @@ void main() {
final scope = Scope(null) final scope = Scope(null)
..installModules([ ..installModules([
_InlineModule((m, s) { _InlineModule((m, s) {
m.bind<String>().toInstanceAsync(Future.value('async value')); m.bind<String>().toInstance(Future.value('async value'));
}), }),
]); ]);
expect(await scope.resolveAsync<String>(), "async value"); expect(await scope.resolveAsync<String>(), "async value");
@@ -137,7 +137,7 @@ void main() {
final scope = Scope(null) final scope = Scope(null)
..installModules([ ..installModules([
_InlineModule((m, s) { _InlineModule((m, s) {
m.bind<int>().toProvideAsync(() async => 7); m.bind<int>().toProvide(() async => 7);
}), }),
]); ]);
expect(await scope.resolveAsync<int>(), 7); expect(await scope.resolveAsync<int>(), 7);
@@ -147,7 +147,7 @@ void main() {
final scope = Scope(null) final scope = Scope(null)
..installModules([ ..installModules([
_InlineModule((m, s) { _InlineModule((m, s) {
m.bind<int>().toProvideAsyncWithParams((x) async => (x as int) * 3); m.bind<int>().toProvideWithParams((x) async => (x as int) * 3);
}), }),
]); ]);
expect(await scope.resolveAsync<int>(params: 2), 6); expect(await scope.resolveAsync<int>(params: 2), 6);

View File

@@ -24,3 +24,5 @@ doc/api/
.fvm/ .fvm/
melos_cherrypick_annotations.iml melos_cherrypick_annotations.iml
pubspec_overrides.yaml

View File

@@ -1,3 +1,11 @@
## 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 ## 1.1.0-dev.0
- **FEAT**: implement generator for dynamic params. - **FEAT**: implement generator for dynamic params.

View File

@@ -2,7 +2,7 @@
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
A lightweight set of Dart annotations designed for dependency injection (DI) frameworks and code generation, inspired by modern approaches like Dagger and Injectable. Works best in tandem with [`cherrypick_generator`](https://pub.dev/packages/cherrypick_generator). 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).
--- ---
@@ -10,10 +10,13 @@ A lightweight set of Dart annotations designed for dependency injection (DI) fra
- **@module** Marks a class as a DI module for service/provider registration. - **@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. - **@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 (not 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 dependency injection into parameters. - **@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. - **@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. - **@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). These annotations streamline DI configuration and serve as markers for code generation tools such as [`cherrypick_generator`](https://pub.dev/packages/cherrypick_generator).
@@ -32,18 +35,21 @@ Add as a `dev_dependency` for code generation:
```yaml ```yaml
dev_dependencies: dev_dependencies:
cherrypick_generator: ^latest
build_runner: ^latest build_runner: ^latest
cherrypick_generator:
``` ```
### 2. Annotate your DI modules and providers ---
### 2. Annotate your DI modules, providers, and injectable classes
#### **Module and Provider Example**
```dart ```dart
import 'package:cherrypick_annotations/cherrypick_annotations.dart'; import 'package:cherrypick_annotations/cherrypick_annotations.dart';
import 'package:cherrypick/cherrypick.dart';
@module() @module()
abstract class AppModule extends Module { abstract class AppModule {
@singleton() @singleton()
Dio dio() => Dio(); Dio dio() => Dio();
@@ -61,7 +67,7 @@ abstract class AppModule extends Module {
} }
``` ```
When used with `cherrypick_generator`, code similar to the following will be generated: With `cherrypick_generator`, code like the following will be generated:
```dart ```dart
final class $AppModule extends AppModule { final class $AppModule extends AppModule {
@@ -78,13 +84,78 @@ final class $AppModule extends AppModule {
--- ---
#### **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 ## 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` ### `@module`
```dart ```dart
@module() @module()
abstract class AppModule extends Module {} abstract class AppModule {}
``` ```
Use on classes to mark them as a DI module. This is the root for registering your dependency providers. Use on classes to mark them as a DI module. This is the root for registering your dependency providers.
@@ -127,6 +198,7 @@ Use on methods to indicate they provide a dependency to the DI module. Dependenc
String token() => 'abc'; String token() => 'abc';
``` ```
Assigns a name to a binding for keyed injection or resolution. Assigns a name to a binding for keyed injection or resolution.
Can be used on both provider methods and fields.
--- ---
@@ -136,7 +208,7 @@ Assigns a name to a binding for keyed injection or resolution.
@provide() @provide()
String greet(@params() dynamic params) => 'Hello $params'; String greet(@params() dynamic params) => 'Hello $params';
``` ```
Use on method parameters to indicate that this parameter should receive runtime-supplied arguments during dependency resolution (for example, via `.toProvide*((params) => greate(params))` in generated code). Indicates that this parameter should receive runtime-supplied arguments during dependency resolution.
--- ---

View File

@@ -19,3 +19,6 @@ export 'src/instance.dart';
export 'src/singleton.dart'; export 'src/singleton.dart';
export 'src/named.dart'; export 'src/named.dart';
export 'src/params.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

@@ -11,11 +11,12 @@
// limitations under the License. // limitations under the License.
// //
/// An annotation to specify that a method or class provides a new instance /// ENGLISH:
/// each time it is requested. /// Annotation to specify that a new instance should be provided on each request.
/// ///
/// This is typically used to indicate that the annotated binding should /// Use the `@instance()` annotation for methods or classes in your DI module
/// not be a singleton and a new object is created for every injection. /// to declare that the DI container must create a new object every time
/// the dependency is injected (i.e., no singleton behavior).
/// ///
/// Example: /// Example:
/// ```dart /// ```dart
@@ -35,6 +36,32 @@
/// } /// }
/// } /// }
/// ``` /// ```
///
/// 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 // ignore: camel_case_types
final class instance { final class instance {
const instance(); const instance();

View File

@@ -11,25 +11,57 @@
// limitations under the License. // limitations under the License.
// //
/// An annotation used to mark a Dart class or library as a module. /// ENGLISH:
/// Annotation for marking Dart classes or libraries as modules.
/// ///
/// This annotation can be used for tooling, code generation, /// Use the `@module()` annotation on abstract classes (or on a library)
/// or to provide additional metadata about the module. /// 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: /// Example:
/// ```dart /// ```dart
/// @module() /// @module()
/// abstract class AppModule extends Module { /// abstract class AppModule extends Module {
/// // Dependency definitions go here.
/// } /// }
/// ``` /// ```
/// Сгенерирует код: ///
/// Generates code like:
/// ```dart /// ```dart
/// final class $AppModule extends AppModule { /// final class $AppModule extends AppModule {
/// @override /// @override
/// void builder(Scope currentScope) { /// 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 // ignore: camel_case_types
final class module { final class module {
/// Creates a [module] annotation. /// Creates a [module] annotation.

View File

@@ -11,10 +11,13 @@
// limitations under the License. // limitations under the License.
// //
/// An annotation to assign a name or identifier to a class, method, or other element. /// ENGLISH:
/// Annotation to assign a name or identifier to a class, method, or other element.
/// ///
/// This can be useful for code generation, dependency injection, /// The `@named('value')` annotation allows you to specify a string name
/// or providing metadata within a framework. /// 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: /// Example:
/// ```dart /// ```dart
@@ -25,7 +28,33 @@
/// } /// }
/// ``` /// ```
/// ///
/// Сгенерирует код: /// 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 /// ```dart
/// final class $AppModule extends AppModule { /// final class $AppModule extends AppModule {
/// @override /// @override
@@ -36,9 +65,13 @@
/// ``` /// ```
// ignore: camel_case_types // ignore: camel_case_types
final class named { final class named {
/// The assigned name or identifier. /// EN: The assigned name or identifier for the element.
///
/// RU: Назначенное имя или идентификатор для элемента.
final String value; final String value;
/// Creates a [named] annotation with the given [value]. /// EN: Creates a [named] annotation with the given [value].
///
/// RU: Создаёт аннотацию [named] с заданным значением [value].
const named(this.value); const named(this.value);
} }

View File

@@ -11,11 +11,14 @@
// limitations under the License. // limitations under the License.
// //
/// An annotation to indicate that a parameter is to be injected with run-time provided arguments. /// ENGLISH:
/// Annotation to mark a method parameter for injection with run-time arguments.
/// ///
/// Use this annotation to mark a method parameter that should receive arguments /// Use the `@params()` annotation to specify that a particular parameter of a
/// passed during the resolution of a dependency (for example, through the /// provider method should be assigned a value supplied at resolution time,
/// `.withParams(...)` method in the generated code). /// 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: /// Example:
/// ```dart /// ```dart
@@ -27,6 +30,26 @@
/// ```dart /// ```dart
/// bind<String>().toProvideWithParams((args) => greet(args)); /// 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 // ignore: camel_case_types
final class params { final class params {
const params(); const params();

View File

@@ -11,28 +11,56 @@
// limitations under the License. // limitations under the License.
// //
/// An annotation to indicate that a method provides a dependency to the module. /// ENGLISH:
/// Annotation to declare a factory/provider method or class as a singleton.
/// ///
/// This annotation is typically used in conjunction with dependency injection, /// Use the `@singleton()` annotation on methods in your DI module to specify
/// marking methods whose return value should be registered as a provider. /// that only one instance of the resulting object should be created and shared
/// The annotated method can optionally declare dependencies as parameters, /// for all consumers. This is especially useful in dependency injection
/// which will be resolved and injected automatically. /// frameworks and service locators.
/// ///
/// Example: /// Example:
/// ```dart /// ```dart
/// @module() /// @module()
/// abstract class AppModule extends Module { /// abstract class AppModule extends Module {
/// @provide() /// @singleton()
/// Foo foo(Bar bar) => Foo(bar); /// Dio dio() => Dio();
/// } /// }
/// ``` /// ```
/// ///
/// This will generate: /// This generates the following code:
/// ```dart /// ```dart
/// final class $AppModule extends AppModule { /// final class $AppModule extends AppModule {
/// @override /// @override
/// void builder(Scope currentScope) { /// void builder(Scope currentScope) {
/// bind<Foo>().toProvide(() => foo(currentScope.resolve<Bar>())); /// 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();
/// } /// }
/// } /// }
/// ``` /// ```

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

@@ -11,11 +11,14 @@
// limitations under the License. // limitations under the License.
// //
/// An annotation to declare a class as a singleton. /// ENGLISH:
/// Annotation to declare a dependency as a singleton.
/// ///
/// This can be used to indicate that only one instance of the class /// Use the `@singleton()` annotation on provider methods inside a module
/// should be created, which is often useful in dependency injection /// to indicate that only a single instance of this dependency should be
/// frameworks or service locators. /// 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: /// Example:
/// ```dart /// ```dart
@@ -25,7 +28,36 @@
/// Dio dio() => Dio(); /// 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 /// ```dart
/// final class $AppModule extends AppModule { /// final class $AppModule extends AppModule {
/// @override /// @override

View File

@@ -1,9 +1,18 @@
name: cherrypick_annotations name: cherrypick_annotations
description: Collection annotations. description: |
version: 1.1.0-dev.0 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 documentation: https://github.com/pese-git/cherrypick/wiki
repository: https://github.com/pese-git/cherrypick repository: https://github.com/pese-git/cherrypick/cherrypick_annotations
issue_tracker: https://github.com/pese-git/cherrypick/issues issue_tracker: https://github.com/pese-git/cherrypick/issues
topics:
- di
- ioc
- scope
- dependency-injection
- dependency-management
- inversion-of-control
- container
environment: environment:
sdk: ">=3.5.2 <4.0.0" sdk: ">=3.5.2 <4.0.0"

View File

@@ -1,3 +1,31 @@
## 1.1.3-dev.5
- Update a dependency to the latest release.
## 1.1.3-dev.4
- Update a dependency to the latest release.
## 1.1.3-dev.3
- Update a dependency to the latest release.
## 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 ## 1.1.2-dev.1
- Update a dependency to the latest release. - Update a dependency to the latest release.

View File

@@ -1,10 +1,18 @@
name: cherrypick_flutter name: cherrypick_flutter
description: "Flutter library that allows access to the root scope through the context using `CherryPickProvider`." description: "Flutter library that allows access to the root scope through the context using `CherryPickProvider`."
version: 1.1.2-dev.1 version: 1.1.3-dev.5
homepage: https://pese-git.github.io/cherrypick-site/ homepage: https://pese-git.github.io/cherrypick-site/
documentation: https://github.com/pese-git/cherrypick/wiki documentation: https://github.com/pese-git/cherrypick/wiki
repository: https://github.com/pese-git/cherrypick repository: https://github.com/pese-git/cherrypick
issue_tracker: https://github.com/pese-git/cherrypick/issues issue_tracker: https://github.com/pese-git/cherrypick/issues
topics:
- di
- ioc
- scope
- dependency-injection
- dependency-management
- inversion-of-control
- container
environment: environment:
sdk: ">=3.5.2 <4.0.0" sdk: ">=3.5.2 <4.0.0"
@@ -13,7 +21,7 @@ environment:
dependencies: dependencies:
flutter: flutter:
sdk: flutter sdk: flutter
cherrypick: ^2.2.0-dev.1 cherrypick: ^3.0.0-dev.5
dev_dependencies: dev_dependencies:
flutter_test: flutter_test:

View File

@@ -26,3 +26,7 @@ doc/api/
melos_cherrypick_generator.iml melos_cherrypick_generator.iml
**/*.mocks.dart **/*.mocks.dart
coverage
pubspec_overrides.yaml

View File

@@ -1,3 +1,23 @@
## 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 ## 1.1.0-dev.1
- **FIX**: optimize code. - **FIX**: optimize code.

View File

@@ -1,54 +1,95 @@
# Cherrypick Generator # Cherrypick Generator
**Cherrypick Generator** is a Dart code generation library for automatic boilerplate creation in dependency injection (DI) modules. It processes classes annotated with `@module()` (from [cherrypick_annotations](https://pub.dev/packages/cherrypick_annotations)) and generates code for registering dependencies, handling singletons, named bindings, runtime parameters, and more. **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 ## Features
- **Automatic Binding Generation:** - **Automatic Field Injection:**
Generates `bind<Type>()` registration code for every method in a DI module marked with `@module()`. Detects classes annotated with `@injectable()`, and generates mixins to inject all fields annotated with `@inject()`, supporting scope and named qualifiers.
- **Support for DI Annotations:** - **Module and Service Registration:**
Understands and processes meta-annotations such as `@singleton`, `@named`, `@instance`, `@provide`, and `@params`. For classes annotated with `@module()`, generates service registration code for methods using annotations such as `@provide`, `@instance`, `@singleton`, `@named`, and `@params`.
- **Runtime & Compile-Time Parameters:** - **Scope & Named Qualifier Support:**
Handles both injected (compile-time) and runtime parameters for provider/binding methods. Supports advanced DI features:
&nbsp;&nbsp;• Field-level scoping with `@scope('scopename')`
&nbsp;&nbsp;• Named dependencies via `@named('value')`
- **Synchronous & Asynchronous Support:** - **Synchronous & Asynchronous Support:**
Correctly distinguishes between synchronous and asynchronous bindings (including `Future<T>` return types). Handles both synchronous and asynchronous services (including `Future<T>`) for both field injection and module registration.
- **Named Bindings:** - **Parameters and Runtime Arguments:**
Allows registration of named services via the `@named()` annotation. Recognizes and wires both injected dependencies and runtime parameters using `@params`.
- **Singletons:** - **Error Handling:**
Registers singletons via the `@singleton` annotation. Validates annotations at generation time. Provides helpful errors for incorrect usage (e.g., using `@injectable` on non-class elements).
--- ---
## How It Works ## How It Works
1. **Annotations** ### 1. Annotate your code
Annotate your module classes and methods using `@module()`, `@instance`, `@provide`, `@singleton`, and `@named` as needed.
2. **Code Scanning** Use annotations from [cherrypick_annotations](https://pub.dev/packages/cherrypick_annotations):
During the build process (with `build_runner`), the generator scans your annotated classes.
3. **Code Generation** - `@injectable()` — on classes to enable field injection
For each `@module()` class, a new class (with a `$` prefix) is generated. - `@inject()` — on fields to specify they should be injected
This class overrides the `builder(Scope)` method to register all bindings. - `@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
4. **Binding Logic** ### 2. Run the generator
Each binding method's signature and annotations are analyzed. Registration code is generated according to:
- Return type (sync/async) Use `build_runner` to process your code and generate `.module.cherrypick.g.dart` and `.inject.cherrypick.g.dart` files.
- Annotations (`@singleton`, `@named`, etc.)
- Parameter list (DI dependencies, `@named`, or `@params` for runtime values) ### 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.
--- ---
## Example ## Field Injection Example
Given the following annotated Dart code: 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 ```dart
import 'package:cherrypick_annotations/cherrypick_annotations.dart'; import 'package:cherrypick_annotations/cherrypick_annotations.dart';
@@ -57,98 +98,92 @@ import 'package:cherrypick_annotations/cherrypick_annotations.dart';
class MyModule { class MyModule {
@singleton @singleton
@instance @instance
SomeService provideService(ApiClient client); AuthService provideAuth(Api api);
@provide @provide
@named('special') @named('logging')
Future<Handler> createHandler(@params Map<String, dynamic> params); Future<Logger> provideLogger(@params Map<String, dynamic> args);
} }
``` ```
The generator will output (simplified): **The generator will output (simplified):**
```dart ```dart
final class $MyModule extends MyModule { final class $MyModule extends MyModule {
@override @override
void builder(Scope currentScope) { void builder(Scope currentScope) {
bind<SomeService>() bind<AuthService>()
.toInstance(provideService(currentScope.resolve<ApiClient>())) .toInstance(provideAuth(currentScope.resolve<Api>()))
.singleton(); .singleton();
bind<Handler>() bind<Logger>()
.toProvideAsyncWithParams((args) => createHandler(args)) .toProvideAsyncWithParams((args) => provideLogger(args))
.withName('special'); .withName('logging');
} }
} }
``` ```
--- ---
## Generated Code Overview ## Key Points
- **Constructor Registration:** - **Rich Annotation Support:**
All non-abstract methods are considered as providers and processed for DI registration. Mix and match field, parameter, and method annotations for maximum flexibility.
- **Scope and Named Resolution:**
- **Parameter Handling:** Use `@scope('...')` and `@named('...')` to precisely control where and how dependencies are wired.
Each method parameter is analyzed: - **Async/Synchronous:**
- Standard DI dependency: resolved via `currentScope.resolve<Type>()`. The generator distinguishes between sync (`resolve<T>`) and async (`resolveAsync<T>`) dependencies.
- Named dependency: resolved via `currentScope.resolve<Type>(named: 'name')`. - **Automatic Mixins:**
- Runtime parameter (`@params`): passed through as-is (e.g., `args`). For classes with `@injectable()`, a mixin is generated that injects all relevant fields (using constructor or setter).
- **Comprehensive Error Checking:**
- **Binding Types:** Misapplied annotations (e.g., `@injectable()` on non-class) produce clear build-time errors.
Supports both `.toInstance()` and `.toProvide()` (including async variants).
- **Singleton/Named:**
Appends `.singleton()` and/or `.withName('name')` as appropriate.
--- ---
## Usage ## Usage
1. **Add dependencies** 1. **Add dependencies**
In your `pubspec.yaml`:
```yaml ```yaml
dependencies: dependencies:
cherrypick_annotations: ^x.y.z cherrypick_annotations: ^latest
dev_dependencies: dev_dependencies:
cherrypick_generator: ^latest
build_runner: ^2.1.0 build_runner: ^2.1.0
cherrypick_generator: ^x.y.z
``` ```
2. **Apply annotations** 2. **Annotate your classes and modules as above**
Annotate your DI modules and provider methods as shown above.
3. **Run the generator** 3. **Run the generator**
```
```shell
dart run build_runner build dart run build_runner build
# or with Flutter: # or, if using Flutter:
flutter pub run build_runner build flutter pub run build_runner build
``` ```
4. **Import and use the generated code** 4. **Use generated code**
The generated files (suffix `.cherrypick.g.dart`) contain your `$YourModule` classes ready for use with your DI framework.
- Import the generated `.inject.cherrypick.g.dart` or `.cherrypick.g.dart` files where needed
--- ---
## Advanced ## Advanced Usage
- **Customizing Parameter Names:**
Use the `@named('value')` annotation on methods and parameters for named bindings.
- **Runtime Arguments:**
Use `@params` to designate parameters as runtime arguments that are supplied at injection time.
- **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:** - **Async Factories:**
Methods returning `Future<T>` generate the appropriate `.toProvideAsync()` or `.toInstanceAsync()` bindings. Methods returning Future<T> generate async bindings and async field resolution logic.
--- ---
## Developer Notes ## Developer Notes
- The generator relies on Dart's analyzer, source_gen, and build packages. - The generator relies on the Dart analyzer, `source_gen`, and `build` packages.
- Each class and method is parsed for annotations; missing required annotations (like `@instance` or `@provide`) will result in a generation error. - All classes and methods are parsed for annotations.
- The generated code is designed to extend your original module classes while injecting all binding logic. - Improper annotation usage will result in generator errors.
--- ---
@@ -162,6 +197,7 @@ Licensed under the Apache License, Version 2.0
## Contribution ## Contribution
Pull requests and issues are welcome! Please open git issues or submit improvements as needed. Pull requests and issues are welcome! Please open GitHub issues or submit improvements.
--- ---

View File

@@ -28,3 +28,7 @@ include: package:lints/recommended.yaml
# For additional information about configuring this file, see # For additional information about configuring this file, see
# https://dart.dev/guides/language/analysis-options # https://dart.dev/guides/language/analysis-options
analyzer:
errors:
deprecated_member_use: ignore

View File

@@ -2,7 +2,15 @@ builders:
module_generator: module_generator:
import: "package:cherrypick_generator/module_generator.dart" import: "package:cherrypick_generator/module_generator.dart"
builder_factories: ["moduleBuilder"] builder_factories: ["moduleBuilder"]
build_extensions: {".dart": [".cherrypick.g.dart"]} 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 auto_apply: dependents
required_inputs: ["lib/**"] required_inputs: ["lib/**"]
runs_before: [] runs_before: []
@@ -14,3 +22,6 @@ targets:
cherrypick_generator|module_generator: cherrypick_generator|module_generator:
generate_for: generate_for:
- lib/**.dart - 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

@@ -14,3 +14,4 @@ library;
// //
export 'module_generator.dart'; 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

@@ -90,4 +90,4 @@ class ModuleGenerator extends GeneratorForAnnotation<ann.module> {
/// файлов, где встречается @module(). /// файлов, где встречается @module().
/// --------------------------------------------------------------------------- /// ---------------------------------------------------------------------------
Builder moduleBuilder(BuilderOptions options) => Builder moduleBuilder(BuilderOptions options) =>
PartBuilder([ModuleGenerator()], '.cherrypick.g.dart'); 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

@@ -12,10 +12,12 @@
// //
import 'package:analyzer/dart/element/element.dart'; import 'package:analyzer/dart/element/element.dart';
import 'package:source_gen/source_gen.dart';
import 'bind_parameters_spec.dart'; import 'bind_parameters_spec.dart';
import 'metadata_utils.dart'; import 'metadata_utils.dart';
import 'exceptions.dart';
import 'type_parser.dart';
import 'annotation_validator.dart';
enum BindingType { enum BindingType {
instance, instance,
@@ -105,10 +107,42 @@ class BindSpec {
final indentStr = ' ' * indent; final indentStr = ' ' * indent;
final provide = _generateProvideClause(indent); final provide = _generateProvideClause(indent);
final postfix = _generatePostfix(); final postfix = _generatePostfix();
return '$indentStr'
'bind<$returnType>()' // Create the full single-line version first
'$provide' final singleLine = '${indentStr}bind<$returnType>()$provide$postfix;';
'$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. // Internal method: decides how the provide clause should be generated by param kind.
@@ -122,14 +156,16 @@ class BindSpec {
// Safe variable name for parameters. // Safe variable name for parameters.
const paramVar = 'args'; const paramVar = 'args';
final fnArgs = parameters.map((p) => p.generateArg(paramVar)).join(', '); 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'); final multiLine = fnArgs.length > 60 || fnArgs.contains('\n');
switch (bindingType) { switch (bindingType) {
case BindingType.instance: case BindingType.instance:
return isAsyncInstance throw StateError(
? '.toInstanceAsync(($fnArgs) => $methodName($fnArgs))' 'Internal error: _generateWithParamsProvideClause called for @instance binding with @params.');
: '.toInstance(($fnArgs) => $methodName($fnArgs))'; //return isAsyncInstance
// ? '.toInstanceAsync(($fnArgs) => $methodName($fnArgs))'
// : '.toInstance(($fnArgs) => $methodName($fnArgs))';
case BindingType.provide: case BindingType.provide:
default:
if (isAsyncProvide) { if (isAsyncProvide) {
return multiLine return multiLine
? '.toProvideAsyncWithParams(\n${' ' * (indent + 2)}($paramVar) => $methodName($fnArgs))' ? '.toProvideAsyncWithParams(\n${' ' * (indent + 2)}($paramVar) => $methodName($fnArgs))'
@@ -145,22 +181,38 @@ class BindSpec {
/// EN / RU: Supports only injected dependencies, not runtime (@params). /// EN / RU: Supports only injected dependencies, not runtime (@params).
String _generatePlainProvideClause(int indent) { String _generatePlainProvideClause(int indent) {
final argsStr = parameters.map((p) => p.generateArg()).join(', '); final argsStr = parameters.map((p) => p.generateArg()).join(', ');
final multiLine = argsStr.length > 60 || argsStr.contains('\n');
// 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) { switch (bindingType) {
case BindingType.instance: case BindingType.instance:
return isAsyncInstance return isAsyncInstance
? '.toInstanceAsync($methodName($argsStr))' ? '.toInstanceAsync($methodName($argsStr))'
: '.toInstance($methodName($argsStr))'; : '.toInstance($methodName($argsStr))';
case BindingType.provide: case BindingType.provide:
default:
if (isAsyncProvide) { if (isAsyncProvide) {
return multiLine if (needsMultiline) {
? '.toProvideAsync(\n${' ' * (indent + 2)}() => $methodName($argsStr))' final lambdaIndent =
: '.toProvideAsync(() => $methodName($argsStr))'; (isSingleton || named != null) ? indent + 6 : indent + 2;
final closingIndent =
(isSingleton || named != null) ? indent + 4 : indent;
return '.toProvideAsync(\n${' ' * lambdaIndent}() => $methodName($argsStr),\n${' ' * closingIndent})';
} else { } else {
return multiLine return '.toProvideAsync(() => $methodName($argsStr))';
? '.toProvide(\n${' ' * (indent + 2)}() => $methodName($argsStr))' }
: '.toProvide(() => $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))';
}
} }
} }
} }
@@ -172,6 +224,20 @@ class BindSpec {
return '$namePart$singletonPart'; 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 /// fromMethod
/// ///
@@ -186,9 +252,15 @@ class BindSpec {
/// асинхронности. Если нет @instance или @provide — кидает ошибку. /// асинхронности. Если нет @instance или @provide — кидает ошибку.
/// ------------------------------------------------------------------------- /// -------------------------------------------------------------------------
static BindSpec fromMethod(MethodElement method) { static BindSpec fromMethod(MethodElement method) {
var returnType = method.returnType.getDisplayString(); 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; final methodName = method.displayName;
// Check for @singleton annotation. // Check for @singleton annotation.
final isSingleton = MetadataUtils.anyMeta(method.metadata, 'singleton'); final isSingleton = MetadataUtils.anyMeta(method.metadata, 'singleton');
@@ -209,27 +281,45 @@ class BindSpec {
// Determine bindingType: @instance or @provide. // Determine bindingType: @instance or @provide.
final hasInstance = MetadataUtils.anyMeta(method.metadata, 'instance'); final hasInstance = MetadataUtils.anyMeta(method.metadata, 'instance');
final hasProvide = MetadataUtils.anyMeta(method.metadata, 'provide'); final hasProvide = MetadataUtils.anyMeta(method.metadata, 'provide');
if (!hasInstance && !hasProvide) { if (!hasInstance && !hasProvide) {
throw InvalidGenerationSourceError( throw AnnotationValidationException(
'Method $methodName must be marked with @instance() or @provide().', 'Method must be marked with either @instance() or @provide() annotation',
element: method, element: method,
suggestion:
'Add @instance() for direct instances or @provide() for factory methods',
context: {
'method_name': methodName,
'return_type': parsedReturnType.displayString,
},
); );
} }
final bindingType = final bindingType =
hasInstance ? BindingType.instance : BindingType.provide; hasInstance ? BindingType.instance : BindingType.provide;
// -- Extract inner type for Future<T> and set async flags. // PROHIBIT @params with @instance bindings!
bool isAsyncInstance = false; if (bindingType == BindingType.instance && hasParams) {
bool isAsyncProvide = false; throw AnnotationValidationException(
final futureInnerType = _extractFutureInnerType(returnType); '@params() (runtime arguments) cannot be used together with @instance()',
if (futureInnerType != null) { element: method,
returnType = futureInnerType; suggestion: 'Use @provide() instead if you want runtime arguments',
if (bindingType == BindingType.instance) isAsyncInstance = true; context: {
if (bindingType == BindingType.provide) isAsyncProvide = true; '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( return BindSpec(
returnType: returnType, returnType: parsedReturnType.codeGenType,
methodName: methodName, methodName: methodName,
isSingleton: isSingleton, isSingleton: isSingleton,
named: named, named: named,
@@ -239,11 +329,21 @@ class BindSpec {
isAsyncProvide: isAsyncProvide, isAsyncProvide: isAsyncProvide,
hasParams: hasParams, 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(),
},
);
} }
/// EN / RU: Extracts inner type from Future<T>, returns e.g. "T" or null.
static String? _extractFutureInnerType(String typeName) {
final match = RegExp(r'^Future<(.+)>$').firstMatch(typeName);
return match?.group(1)?.trim();
} }
} }

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

@@ -49,10 +49,15 @@ class GeneratedClass {
/// Список всех обнаруженных биндингов /// Список всех обнаруженных биндингов
final List<BindSpec> binds; final List<BindSpec> binds;
/// Source file name for the part directive
/// Имя исходного файла для part директивы
final String sourceFile;
GeneratedClass( GeneratedClass(
this.className, this.className,
this.generatedClassName, this.generatedClassName,
this.binds, this.binds,
this.sourceFile,
); );
/// ------------------------------------------------------------------------- /// -------------------------------------------------------------------------
@@ -72,13 +77,15 @@ class GeneratedClass {
final className = element.displayName; final className = element.displayName;
// Generated class name with '$' prefix (standard for generated Dart code). // Generated class name with '$' prefix (standard for generated Dart code).
final generatedClassName = r'$' + className; final generatedClassName = r'$' + className;
// Get source file name
final sourceFile = element.source.shortName;
// Collect bindings for all non-abstract methods. // Collect bindings for all non-abstract methods.
final binds = element.methods final binds = element.methods
.where((m) => !m.isAbstract) .where((m) => !m.isAbstract)
.map(BindSpec.fromMethod) .map(BindSpec.fromMethod)
.toList(); .toList();
return GeneratedClass(className, generatedClassName, binds); return GeneratedClass(className, generatedClassName, binds, sourceFile);
} }
/// ------------------------------------------------------------------------- /// -------------------------------------------------------------------------
@@ -95,11 +102,10 @@ class GeneratedClass {
/// и регистрирует все зависимости через методы bind<Type>()... /// и регистрирует все зависимости через методы bind<Type>()...
/// ------------------------------------------------------------------------- /// -------------------------------------------------------------------------
String generate() { String generate() {
final buffer = StringBuffer(); final buffer = StringBuffer()
..writeln('final class $generatedClassName extends $className {')
buffer.writeln('final class $generatedClassName extends $className {'); ..writeln(' @override')
buffer.writeln(' @override'); ..writeln(' void builder(Scope currentScope) {');
buffer.writeln(' void builder(Scope currentScope) {');
// For each binding, generate bind<Type>() code string. // For each binding, generate bind<Type>() code string.
// Для каждого биндинга — генерируем строку bind<Type>()... // Для каждого биндинга — генерируем строку bind<Type>()...
@@ -107,8 +113,9 @@ class GeneratedClass {
buffer.writeln(bind.generateBind(4)); buffer.writeln(bind.generateBind(4));
} }
buffer.writeln(' }'); buffer
buffer.writeln('}'); ..writeln(' }')
..writeln('}');
return buffer.toString(); return buffer.toString();
} }

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

@@ -1,23 +1,35 @@
name: cherrypick_generator name: cherrypick_generator
description: Code generator for cherrypick annotations description: |
version: 1.1.0-dev.1 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 documentation: https://github.com/pese-git/cherrypick/wiki
repository: https://github.com/pese-git/cherrypick repository: https://github.com/pese-git/cherrypick/cherrypick_generator
issue_tracker: https://github.com/pese-git/cherrypick/issues issue_tracker: https://github.com/pese-git/cherrypick/issues
topics:
- di
- ioc
- scope
- dependency-injection
- dependency-management
- inversion-of-control
- container
environment: environment:
sdk: ">=3.5.2 <4.0.0" sdk: ">=3.5.2 <4.0.0"
# Add regular dependencies here. # Add regular dependencies here.
dependencies: dependencies:
cherrypick_annotations: ^1.1.0-dev.0 cherrypick_annotations: ^1.1.0
analyzer: ^6.7.0 analyzer: ^7.0.0
dart_style: ^2.3.7 dart_style: ^3.0.0
build: ^2.4.1 build: ^2.4.1
build_runner: ^2.4.13 source_gen: ^2.0.0
source_gen: ^1.5.0 collection: ^1.18.0
dev_dependencies: dev_dependencies:
lints: ^5.0.0 lints: ^4.0.0
mockito: ^5.4.4 mockito: ^5.4.4
test: ^1.25.8 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

@@ -1,13 +1,32 @@
//
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import 'package:test/test.dart'; import 'package:test/test.dart';
void main() { // Import working test suites
group('A group of tests', () { import 'simple_test.dart' as simple_tests;
setUp(() { import 'bind_spec_test.dart' as bind_spec_tests;
// Additional setup goes here. import 'metadata_utils_test.dart' as metadata_utils_tests;
}); // Import integration test suites (now working!)
import 'module_generator_test.dart' as module_generator_tests;
import 'inject_generator_test.dart' as inject_generator_tests;
test('First Test', () { void main() {
expect(2, 2); 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/).

415
doc/full_tutorial_en.md Normal file
View File

@@ -0,0 +1,415 @@
# 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
```
---
### Fast Dependency Lookup (Performance Improvement)
> **Performance Note:**
> **Starting from version 3.0.0**, CherryPick uses a Map-based resolver index for dependency lookup. This means calls to `resolve<T>()`, `tryResolve<T>()` and similar methods are now O(1) operations, regardless of the number of modules or bindings within your scope. Previously it would iterate over all modules and bindings, which could reduce performance as your project grew. This optimization is internal and does not affect the public API or usage patterns, but significantly improves resolution speed for larger applications.
---
## 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)

418
doc/full_tutorial_ru.md Normal file
View File

@@ -0,0 +1,418 @@
# Полный гайд по 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, если нет
```
---
### Быстрый поиск зависимостей (Performance Improvement)
> **Примечание по производительности:**
> Начиная с версии **3.0.0**, CherryPick для поиска зависимости внутри scope использует Map-индекс. Благодаря этому методы `resolve<T>()`, `tryResolve<T>()` и аналогичные теперь работают за O(1), независимо от количества модулей и биндингов в вашем проекте. Ранее для поиска приходилось перебирать весь список вручную, что могло замедлять работу крупных приложений. Это внутреннее улучшение не меняет внешнего API или паттернов использования, но заметно ускоряет разрешение зависимостей на больших проектах.
---
## Внедрение зависимостей через аннотации и автогенерацию
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

@@ -5,23 +5,18 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: _fe_analyzer_shared name: _fe_analyzer_shared
sha256: f256b0c0ba6c7577c15e2e4e114755640a875e885099367bf6e012b19314c834 sha256: e55636ed79578b9abca5fecf9437947798f5ef7456308b5cb85720b793eac92f
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "72.0.0" version: "82.0.0"
_macros:
dependency: transitive
description: dart
source: sdk
version: "0.3.2"
analyzer: analyzer:
dependency: transitive dependency: transitive
description: description:
name: analyzer name: analyzer
sha256: b652861553cd3990d8ed361f7979dc6d7053a9ac8843fa73820ab68ce5410139 sha256: "904ae5bb474d32c38fb9482e2d925d5454cda04ddd0e55d2e6826bc72f6ba8c0"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "6.7.0" version: "7.4.5"
args: args:
dependency: transitive dependency: transitive
description: description:
@@ -34,26 +29,26 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: async name: async
sha256: "947bfcf187f74dbc5e146c9eb9c0f10c9f8b30743e341481c1e2ed3ecc18c20c" sha256: d2872f9c19731c2e5f10444b14686eb7cc85c76274bd6c16e1816bff9a3bab63
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "2.11.0" version: "2.12.0"
boolean_selector: boolean_selector:
dependency: transitive dependency: transitive
description: description:
name: boolean_selector name: boolean_selector
sha256: "6cfb5af12253eaf2b368f07bacc5a80d1301a071c73360d746b7f2e32d762c66" sha256: "8aab1771e1243a5063b8b0ff68042d67334e3feab9e95b9490f9a6ebf73b42ea"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "2.1.1" version: "2.1.2"
build: build:
dependency: transitive dependency: transitive
description: description:
name: build name: build
sha256: "80184af8b6cb3e5c1c4ec6d8544d27711700bc3e6d2efad04238c7b5290889f0" sha256: cef23f1eda9b57566c81e2133d196f8e3df48f244b317368d65c5943d91148f0
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "2.4.1" version: "2.4.2"
build_config: build_config:
dependency: transitive dependency: transitive
description: description:
@@ -74,26 +69,26 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: build_resolvers name: build_resolvers
sha256: "339086358431fa15d7eca8b6a36e5d783728cf025e559b834f4609a1fcfb7b0a" sha256: b9e4fda21d846e192628e7a4f6deda6888c36b5b69ba02ff291a01fd529140f0
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "2.4.2" version: "2.4.4"
build_runner: build_runner:
dependency: "direct dev" dependency: "direct dev"
description: description:
name: build_runner name: build_runner
sha256: "028819cfb90051c6b5440c7e574d1896f8037e3c96cf17aaeb054c9311cfbf4d" sha256: "058fe9dce1de7d69c4b84fada934df3e0153dd000758c4d65964d0166779aa99"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "2.4.13" version: "2.4.15"
build_runner_core: build_runner_core:
dependency: transitive dependency: transitive
description: description:
name: build_runner_core name: build_runner_core
sha256: f8126682b87a7282a339b871298cc12009cb67109cfa1614d6436fb0289193e0 sha256: "22e3aa1c80e0ada3722fe5b63fd43d9c8990759d0a2cf489c8c5d7b2bdebc021"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "7.3.2" version: "8.0.0"
built_collection: built_collection:
dependency: transitive dependency: transitive
description: description:
@@ -114,10 +109,10 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: characters name: characters
sha256: "04a925763edad70e8443c99234dc3328f442e811f1d8fd1a72f1c8ad0f69a605" sha256: f71061c654a3380576a52b451dd5532377954cf9dbd272a78fc8479606670803
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.3.0" version: "1.4.0"
checked_yaml: checked_yaml:
dependency: transitive dependency: transitive
description: description:
@@ -132,36 +127,36 @@ packages:
path: "../../cherrypick" path: "../../cherrypick"
relative: true relative: true
source: path source: path
version: "2.2.0-dev.0" version: "3.0.0-dev.1"
cherrypick_annotations: cherrypick_annotations:
dependency: "direct main" dependency: "direct main"
description: description:
path: "../../cherrypick_annotations" path: "../../cherrypick_annotations"
relative: true relative: true
source: path source: path
version: "1.1.0-dev.0" version: "1.1.0"
cherrypick_flutter: cherrypick_flutter:
dependency: "direct main" dependency: "direct main"
description: description:
path: "../../cherrypick_flutter" path: "../../cherrypick_flutter"
relative: true relative: true
source: path source: path
version: "1.1.2-dev.0" version: "1.1.3-dev.1"
cherrypick_generator: cherrypick_generator:
dependency: "direct dev" dependency: "direct dev"
description: description:
path: "../../cherrypick_generator" path: "../../cherrypick_generator"
relative: true relative: true
source: path source: path
version: "1.1.0-dev.0" version: "1.1.0"
clock: clock:
dependency: transitive dependency: transitive
description: description:
name: clock name: clock
sha256: cb6d7f03e1de671e34607e909a7213e31d7752be4fb66a86d29fe1eb14bfb5cf sha256: fddb70d9b5277016c77a80201021d40a2247104d9f4aa7bab7157b7e3f05b84b
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.1.1" version: "1.1.2"
code_builder: code_builder:
dependency: transitive dependency: transitive
description: description:
@@ -174,10 +169,10 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: collection name: collection
sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.18.0" version: "1.19.1"
convert: convert:
dependency: transitive dependency: transitive
description: description:
@@ -206,18 +201,18 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: dart_style name: dart_style
sha256: "7856d364b589d1f08986e140938578ed36ed948581fbc3bc9aef1805039ac5ab" sha256: "27eb0ae77836989a3bc541ce55595e8ceee0992807f14511552a898ddd0d88ac"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "2.3.7" version: "3.0.1"
fake_async: fake_async:
dependency: transitive dependency: transitive
description: description:
name: fake_async name: fake_async
sha256: "511392330127add0b769b75a987850d136345d9227c6b94c96a04cf4a391bf78" sha256: "6a95e56b2449df2273fd8c45a662d6947ce1ebb7aafe80e550a3f68297f3cacc"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.3.1" version: "1.3.2"
file: file:
dependency: transitive dependency: transitive
description: description:
@@ -276,6 +271,14 @@ packages:
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "2.3.2" 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: http_multi_server:
dependency: transitive dependency: transitive
description: description:
@@ -320,18 +323,18 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: leak_tracker name: leak_tracker
sha256: "3f87a60e8c63aecc975dda1ceedbc8f24de75f09e4856ea27daf8958f2f0ce05" sha256: c35baad643ba394b40aac41080300150a4f08fd0fd6a10378f8f7c6bc161acec
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "10.0.5" version: "10.0.8"
leak_tracker_flutter_testing: leak_tracker_flutter_testing:
dependency: transitive dependency: transitive
description: description:
name: leak_tracker_flutter_testing name: leak_tracker_flutter_testing
sha256: "932549fb305594d82d7183ecd9fa93463e9914e1b67cacc34bc40906594a1806" sha256: f8b613e7e6a13ec79cfdc0e97638fddb3ab848452eff057653abd3edba760573
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "3.0.5" version: "3.0.9"
leak_tracker_testing: leak_tracker_testing:
dependency: transitive dependency: transitive
description: description:
@@ -356,22 +359,14 @@ packages:
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.3.0" version: "1.3.0"
macros:
dependency: transitive
description:
name: macros
sha256: "0acaed5d6b7eab89f63350bccd82119e6c602df0f391260d0e32b5e23db79536"
url: "https://pub.dev"
source: hosted
version: "0.1.2-main.4"
matcher: matcher:
dependency: transitive dependency: transitive
description: description:
name: matcher name: matcher
sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb sha256: dc58c723c3c24bf8d3e2d3ad3f2f9d7bd9cf43ec6feaa64181775e60190153f2
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "0.12.16+1" version: "0.12.17"
material_color_utilities: material_color_utilities:
dependency: transitive dependency: transitive
description: description:
@@ -384,10 +379,10 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: meta name: meta
sha256: bdb68674043280c3428e9ec998512fb681678676b3c54e773629ffe74419f8c7 sha256: e3641ec5d63ebf0d9b41bd43201a66e3fc79a65db5f61fc181f04cd27aab950c
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.15.0" version: "1.16.0"
mime: mime:
dependency: transitive dependency: transitive
description: description:
@@ -408,10 +403,10 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: path name: path
sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af" sha256: "75cca69d1490965be98c73ceaea117e8a04dd21217b37b292c9ddbec0d955bc5"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.9.0" version: "1.9.1"
pool: pool:
dependency: transitive dependency: transitive
description: description:
@@ -456,39 +451,39 @@ packages:
dependency: transitive dependency: transitive
description: flutter description: flutter
source: sdk source: sdk
version: "0.0.99" version: "0.0.0"
source_gen: source_gen:
dependency: transitive dependency: transitive
description: description:
name: source_gen name: source_gen
sha256: "14658ba5f669685cd3d63701d01b31ea748310f7ab854e471962670abcf57832" sha256: "35c8150ece9e8c8d263337a265153c3329667640850b9304861faea59fc98f6b"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.5.0" version: "2.0.0"
source_span: source_span:
dependency: transitive dependency: transitive
description: description:
name: source_span name: source_span
sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c" sha256: "254ee5351d6cb365c859e20ee823c3bb479bf4a293c22d17a9f1bf144ce86f7c"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.10.0" version: "1.10.1"
stack_trace: stack_trace:
dependency: transitive dependency: transitive
description: description:
name: stack_trace name: stack_trace
sha256: "73713990125a6d93122541237550ee3352a2d84baad52d375a4cad2eb9b7ce0b" sha256: "8b27215b45d22309b5cddda1aa2b19bdfec9df0e765f2de506401c071d38d1b1"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.11.1" version: "1.12.1"
stream_channel: stream_channel:
dependency: transitive dependency: transitive
description: description:
name: stream_channel name: stream_channel
sha256: ba2aa5d8cc609d96bbb2899c28934f9e1af5cddbd60a827822ea467161eb54e7 sha256: "969e04c80b8bcdf826f8f16579c7b14d780458bd97f56d107d3950fdbeef059d"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "2.1.2" version: "2.1.4"
stream_transform: stream_transform:
dependency: transitive dependency: transitive
description: description:
@@ -501,26 +496,26 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: string_scanner name: string_scanner
sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde" sha256: "921cd31725b72fe181906c6a94d987c78e3b98c2e205b397ea399d4054872b43"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.2.0" version: "1.4.1"
term_glyph: term_glyph:
dependency: transitive dependency: transitive
description: description:
name: term_glyph name: term_glyph
sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84 sha256: "7f554798625ea768a7518313e58f83891c7f5024f88e46e7182a4558850a4b8e"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.2.1" version: "1.2.2"
test_api: test_api:
dependency: transitive dependency: transitive
description: description:
name: test_api name: test_api
sha256: "5b8a98dafc4d5c4c9c72d8b31ab2b23fc13422348d2997120294d3bac86b4ddb" sha256: fb31f383e2ee25fbbfe06b40fe21e1e458d14080e3c67e7ba0acfde4df4e0bbd
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "0.7.2" version: "0.7.4"
timing: timing:
dependency: transitive dependency: transitive
description: description:
@@ -549,10 +544,10 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: vm_service name: vm_service
sha256: "5c5f338a667b4c644744b661f309fb8080bb94b18a7e91ef1dbd343bed00ed6d" sha256: "0968250880a6c5fe7edc067ed0a13d4bae1577fe2771dcf3010d52c4a9d3ca14"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "14.2.5" version: "14.3.1"
watcher: watcher:
dependency: transitive dependency: transitive
description: description:
@@ -594,5 +589,5 @@ packages:
source: hosted source: hosted
version: "3.1.3" version: "3.1.3"
sdks: sdks:
dart: ">=3.5.2 <4.0.0" dart: ">=3.7.0-0 <4.0.0"
flutter: ">=3.18.0-18.0.pre.54" flutter: ">=3.18.0-18.0.pre.54"

View File

@@ -11,10 +11,13 @@ environment:
dependencies: dependencies:
flutter: flutter:
sdk: flutter sdk: flutter
cherrypick: ^2.2.0-dev.1 cherrypick:
cherrypick_flutter: ^1.1.2-dev.1 path: ../../cherrypick
cherrypick_flutter:
path: ../../cherrypick_flutter
cherrypick_annotations: ^1.1.0-dev.0 cherrypick_annotations:
path: ../../cherrypick_annotations
cupertino_icons: ^1.0.8 cupertino_icons: ^1.0.8
@@ -24,8 +27,9 @@ dev_dependencies:
flutter_lints: ^5.0.0 flutter_lints: ^5.0.0
cherrypick_generator: ^1.1.0-dev.1 cherrypick_generator:
build_runner: ^2.4.13 path: ../../cherrypick_generator
build_runner: ^2.4.15
# For information on the generic Dart part of this file, see the # For information on the generic Dart part of this file, see the
# following page: https://dart.dev/tools/pub/pubspec # following page: https://dart.dev/tools/pub/pubspec

View File

@@ -9,6 +9,13 @@
# packages, and plugins designed to encourage good coding practices. # packages, and plugins designed to encourage good coding practices.
include: package:flutter_lints/flutter.yaml include: package:flutter_lints/flutter.yaml
analyzer:
exclude:
- "**/*.g.dart"
- "**/*.freezed.dart"
- "**/*.gr.dart"
- "**/*.config.dart"
linter: linter:
# The lint rules applied to this project can be customized in the # The lint rules applied to this project can be customized in the
# section below to disable rules from the `package:flutter_lints/flutter.yaml` # section below to disable rules from the `package:flutter_lints/flutter.yaml`

View File

@@ -0,0 +1,35 @@
import 'package:cherrypick/cherrypick.dart';
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'domain/repository/post_repository.dart';
import 'presentation/bloc/post_bloc.dart';
import 'router/app_router.dart';
part 'app.inject.cherrypick.g.dart';
@injectable()
class MyApp extends StatelessWidget with _$MyApp {
final _appRouter = AppRouter();
@named('repo')
@inject()
late final PostRepository repository;
MyApp({super.key}) {
_inject(this);
}
@override
Widget build(BuildContext context) {
return BlocProvider(
create: (_) => PostBloc(repository),
child: MaterialApp.router(
routeInformationParser: _appRouter.defaultRouteParser(),
routerDelegate: _appRouter.delegate(),
theme: ThemeData.light(),
),
);
}
}

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