mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-24 13:47:24 +00:00
Compare commits
7 Commits
talker_che
...
cherrypick
| Author | SHA1 | Date | |
|---|---|---|---|
|
9baf6f8d33 | ||
|
|
4e97a39501 | ||
|
|
58daf668c5 | ||
|
|
b57ca797e1 | ||
|
|
38fd356ec3 | ||
|
|
8fd18df811 | ||
|
|
06c0dd60c0 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -18,7 +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
|
||||||
melos_benchmark_di.iml
|
|
||||||
melos_talker_cherrypick_logger.iml
|
|
||||||
|
|
||||||
coverage
|
coverage
|
||||||
627
CHANGELOG.md
627
CHANGELOG.md
@@ -3,633 +3,6 @@
|
|||||||
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-09-08
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- [`cherrypick` - `v3.0.0`](#cherrypick---v300)
|
|
||||||
- [`cherrypick_annotations` - `v3.0.0`](#cherrypick_annotations---v300)
|
|
||||||
- [`cherrypick_flutter` - `v3.0.0`](#cherrypick_flutter---v300)
|
|
||||||
- [`cherrypick_generator` - `v3.0.0`](#cherrypick_generator---v300)
|
|
||||||
- [`talker_cherrypick_logger` - `v3.0.0`](#talker_cherrypick_logger---v300)
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- There are no other changes in this release.
|
|
||||||
|
|
||||||
Packages graduated to a stable release (see pre-releases prior to the stable version for changelog entries):
|
|
||||||
|
|
||||||
- `cherrypick` - `v3.0.0`
|
|
||||||
- `cherrypick_annotations` - `v3.0.0`
|
|
||||||
- `cherrypick_flutter` - `v3.0.0`
|
|
||||||
- `cherrypick_generator` - `v3.0.0`
|
|
||||||
- `talker_cherrypick_logger` - `v3.0.0`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `cherrypick` - `v3.0.0`
|
|
||||||
|
|
||||||
#### `cherrypick_annotations` - `v3.0.0`
|
|
||||||
|
|
||||||
#### `cherrypick_flutter` - `v3.0.0`
|
|
||||||
|
|
||||||
#### `cherrypick_generator` - `v3.0.0`
|
|
||||||
|
|
||||||
#### `talker_cherrypick_logger` - `v3.0.0`
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-09-08
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- There are no breaking changes in this release.
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`cherrypick` - `v3.0.0-dev.13`](#cherrypick---v300-dev13)
|
|
||||||
- [`cherrypick_flutter` - `v3.0.0-dev.1`](#cherrypick_flutter---v300-dev1)
|
|
||||||
- [`talker_cherrypick_logger` - `v3.0.0-dev.1`](#talker_cherrypick_logger---v300-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` - `v3.0.0-dev.1`
|
|
||||||
- `talker_cherrypick_logger` - `v3.0.0-dev.1`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `cherrypick` - `v3.0.0-dev.13`
|
|
||||||
|
|
||||||
- **FIX**: fix examples.
|
|
||||||
- **DOCS**: update contributors list with GitHub links and add new contributor.
|
|
||||||
- **DOCS**(binding,docs): clarify `.singleton()` with `.toInstance()` behavior in docs and API.
|
|
||||||
- **DOCS**(binding,docs): explain .singleton() + parametric provider behavior.
|
|
||||||
- **DOCS**(binding): clarify registration limitation in API doc.
|
|
||||||
- **DOCS**(di): clarify 'toInstance' binding limitations in builder.
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-09-08
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- There are no breaking changes in this release.
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`talker_cherrypick_logger` - `v3.0.0-dev.0`](#talker_cherrypick_logger---v300-dev0)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `talker_cherrypick_logger` - `v3.0.0-dev.0`
|
|
||||||
|
|
||||||
- chore(talker_cherrypick_logger): sync version with cherrypick 3.0.0-dev.12
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-09-08
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- There are no breaking changes in this release.
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`cherrypick_flutter` - `v3.0.0-dev.0`](#cherrypick_flutter---v300-dev0)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `cherrypick_flutter` - `v3.0.0-dev.0`
|
|
||||||
|
|
||||||
- chore(cherrypick_flutter): sync version with cherrypick 3.0.0-dev.12
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-09-08
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- There are no breaking changes in this release.
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`cherrypick_generator` - `v3.0.0-dev.0`](#cherrypick_generator---v300-dev0)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `cherrypick_generator` - `v3.0.0-dev.0`
|
|
||||||
|
|
||||||
- chore(cherrypick_generator): sync version with cherrypick 3.0.0-dev.12
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-09-08
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- There are no breaking changes in this release.
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`cherrypick_annotations` - `v3.0.0-dev.0`](#cherrypick_annotations---v300-dev0)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `cherrypick_annotations` - `v3.0.0-dev.0`
|
|
||||||
|
|
||||||
- chore(cherrypick_annotations): sync version with cherrypick 3.0.0-dev.0
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-08-22
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- There are no breaking changes in this release.
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`cherrypick_annotations` - `v1.1.2-dev.2`](#cherrypick_annotations---v112-dev2)
|
|
||||||
- [`cherrypick_generator` - `v2.0.0-dev.2`](#cherrypick_generator---v200-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_generator` - `v2.0.0-dev.2`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `cherrypick_annotations` - `v1.1.2-dev.2`
|
|
||||||
|
|
||||||
- **DOCS**(annotations): improve API documentation and usage example.
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-08-19
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- There are no breaking changes in this release.
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`cherrypick` - `v3.0.0-dev.12`](#cherrypick---v300-dev12)
|
|
||||||
- [`cherrypick_flutter` - `v1.1.3-dev.12`](#cherrypick_flutter---v113-dev12)
|
|
||||||
- [`talker_cherrypick_logger` - `v1.1.0-dev.7`](#talker_cherrypick_logger---v110-dev7)
|
|
||||||
|
|
||||||
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.12`
|
|
||||||
- `talker_cherrypick_logger` - `v1.1.0-dev.7`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `cherrypick` - `v3.0.0-dev.12`
|
|
||||||
|
|
||||||
- **FIX**(scope): prevent concurrent modification in dispose().
|
|
||||||
- **FIX**(binding): fix unterminated string literal and syntax issues in binding.dart.
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-08-19
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- There are no breaking changes in this release.
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`cherrypick` - `v3.0.0-dev.11`](#cherrypick---v300-dev11)
|
|
||||||
- [`cherrypick_flutter` - `v1.1.3-dev.11`](#cherrypick_flutter---v113-dev11)
|
|
||||||
- [`talker_cherrypick_logger` - `v1.1.0-dev.6`](#talker_cherrypick_logger---v110-dev6)
|
|
||||||
|
|
||||||
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.11`
|
|
||||||
- `talker_cherrypick_logger` - `v1.1.0-dev.6`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `cherrypick` - `v3.0.0-dev.11`
|
|
||||||
|
|
||||||
- **FIX**(scope): prevent concurrent modification in dispose().
|
|
||||||
- **FIX**(binding): fix unterminated string literal and syntax issues in binding.dart.
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-08-15
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- There are no breaking changes in this release.
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`cherrypick` - `v3.0.0-dev.10`](#cherrypick---v300-dev10)
|
|
||||||
- [`cherrypick_annotations` - `v1.1.2-dev.1`](#cherrypick_annotations---v112-dev1)
|
|
||||||
- [`cherrypick_flutter` - `v1.1.3-dev.10`](#cherrypick_flutter---v113-dev10)
|
|
||||||
- [`cherrypick_generator` - `v2.0.0-dev.1`](#cherrypick_generator---v200-dev1)
|
|
||||||
- [`talker_cherrypick_logger` - `v1.1.0-dev.5`](#talker_cherrypick_logger---v110-dev5)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `cherrypick` - `v3.0.0-dev.10`
|
|
||||||
|
|
||||||
- **DOCS**(pub): update homepage and documentation URLs in pubspec.yaml to new official site.
|
|
||||||
|
|
||||||
#### `cherrypick_annotations` - `v1.1.2-dev.1`
|
|
||||||
|
|
||||||
- **DOCS**(pub): update homepage and documentation URLs in pubspec.yaml to new official site.
|
|
||||||
|
|
||||||
#### `cherrypick_flutter` - `v1.1.3-dev.10`
|
|
||||||
|
|
||||||
- **DOCS**(pub): update homepage and documentation URLs in pubspec.yaml to new official site.
|
|
||||||
|
|
||||||
#### `cherrypick_generator` - `v2.0.0-dev.1`
|
|
||||||
|
|
||||||
- **DOCS**(pub): update homepage and documentation URLs in pubspec.yaml to new official site.
|
|
||||||
|
|
||||||
#### `talker_cherrypick_logger` - `v1.1.0-dev.5`
|
|
||||||
|
|
||||||
- **DOCS**(pub): update homepage and documentation URLs in pubspec.yaml to new official site.
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-08-13
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- There are no breaking changes in this release.
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`talker_cherrypick_logger` - `v1.1.0-dev.4`](#talker_cherrypick_logger---v110-dev4)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `talker_cherrypick_logger` - `v1.1.0-dev.4`
|
|
||||||
|
|
||||||
- **DOCS**(readme): update install instructions to use pub.dev as default method and remove obsolete git example.
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-08-13
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- There are no breaking changes in this release.
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`talker_cherrypick_logger` - `v1.1.0-dev.3`](#talker_cherrypick_logger---v110-dev3)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `talker_cherrypick_logger` - `v1.1.0-dev.3`
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-08-13
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- There are no breaking changes in this release.
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`talker_cherrypick_logger` - `v1.1.0-dev.2`](#talker_cherrypick_logger---v110-dev2)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `talker_cherrypick_logger` - `v1.1.0-dev.2`
|
|
||||||
|
|
||||||
- Bump "talker_cherrypick_logger" to `1.1.0-dev.2`.
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-08-13
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- [`cherrypick_generator` - `v2.0.0-dev.0`](#cherrypick_generator---v200-dev0)
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`cherrypick` - `v3.0.0-dev.9`](#cherrypick---v300-dev9)
|
|
||||||
- [`cherrypick_annotations` - `v1.1.2-dev.0`](#cherrypick_annotations---v112-dev0)
|
|
||||||
- [`cherrypick_flutter` - `v1.1.3-dev.9`](#cherrypick_flutter---v113-dev9)
|
|
||||||
- [`talker_cherrypick_logger` - `v1.1.0-dev.0`](#talker_cherrypick_logger---v110-dev0)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `cherrypick_generator` - `v2.0.0-dev.0`
|
|
||||||
|
|
||||||
- **BREAKING** **DOCS**(generator): improve and unify English documentation and examples for all DI source files.
|
|
||||||
|
|
||||||
#### `cherrypick` - `v3.0.0-dev.9`
|
|
||||||
|
|
||||||
- **DOCS**(readme): add talker_cherrypick_logger to Additional Modules section.
|
|
||||||
- **DOCS**(api): improve all DI core code documentation with English dartdoc and examples.
|
|
||||||
|
|
||||||
#### `cherrypick_annotations` - `v1.1.2-dev.0`
|
|
||||||
|
|
||||||
- **DOCS**(annotations): unify and improve English DartDoc for all DI annotations.
|
|
||||||
|
|
||||||
#### `cherrypick_flutter` - `v1.1.3-dev.9`
|
|
||||||
|
|
||||||
- **DOCS**(provider): add detailed English API documentation for CherryPickProvider Flutter integration.
|
|
||||||
|
|
||||||
#### `talker_cherrypick_logger` - `v1.1.0-dev.0`
|
|
||||||
|
|
||||||
- **FEAT**(logging): add talker_dio_logger and talker_bloc_logger integration, improve cherrypick logger structure, add UI log screen for DI and network/bloc debug.
|
|
||||||
- **DOCS**: add full English documentation and usage guide to README.md.
|
|
||||||
- **DOCS**: add detailed English documentation and usage examples for TalkerCherryPickObserver.
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-08-12
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- There are no breaking changes in this release.
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`cherrypick` - `v3.0.0-dev.8`](#cherrypick---v300-dev8)
|
|
||||||
- [`cherrypick_flutter` - `v1.1.3-dev.8`](#cherrypick_flutter---v113-dev8)
|
|
||||||
|
|
||||||
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.8`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `cherrypick` - `v3.0.0-dev.8`
|
|
||||||
|
|
||||||
- **REFACTOR**(tests): replace MockLogger with MockObserver in scope tests to align with updated observer API.
|
|
||||||
- **FIX**(doc): remove hide symbol.
|
|
||||||
- **FEAT**(core): add full DI lifecycle observability via onInstanceDisposed.
|
|
||||||
- **DOCS**(logging): update Logging section in README with modern Observer usage and Talker integration examples.
|
|
||||||
- **DOCS**(observer): improve documentation, translate all comments to English, add usage examples.
|
|
||||||
- **DOCS**(README): add section with overview table for additional modules.
|
|
||||||
- **DOCS**(README): refactor structure and improve clarity of advanced features.
|
|
||||||
- **DOCS**(README): add 'Hierarchical Subscopes' section and update structure for advanced features clarity.
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-08-11
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- [`cherrypick` - `v3.0.0-dev.7`](#cherrypick---v300-dev7)
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`cherrypick_annotations` - `v1.1.1`](#cherrypick_annotations---v111)
|
|
||||||
- [`cherrypick_flutter` - `v1.1.3-dev.7`](#cherrypick_flutter---v113-dev7)
|
|
||||||
- [`cherrypick_generator` - `v1.1.1`](#cherrypick_generator---v111)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `cherrypick` - `v3.0.0-dev.7`
|
|
||||||
|
|
||||||
- **FIX**(comment): fix warnings.
|
|
||||||
- **FIX**(license): correct urls.
|
|
||||||
- **FEAT**: add Disposable interface source and usage example.
|
|
||||||
- **DOCS**(readme): add comprehensive section on annotations and DI code generation.
|
|
||||||
- **DOCS**(readme): add detailed section and examples for automatic Disposable resource cleanup\n\n- Added a dedicated section with English description and code samples on using Disposable for automatic resource management.\n- Updated Features to include automatic resource cleanup for Disposable dependencies.\n\nHelps developers understand and implement robust DI resource management practices.
|
|
||||||
- **DOCS**(faq): add best practice FAQ about using await with scope disposal.
|
|
||||||
- **DOCS**(faq): add best practice FAQ about using await with scope disposal.
|
|
||||||
- **BREAKING** **REFACTOR**(core): make closeRootScope async and await dispose.
|
|
||||||
- **BREAKING** **DOCS**(disposable): add detailed English documentation and usage examples for Disposable interface; chore: update binding_resolver and add explanatory comment in scope_test for deprecated usage.\n\n- Expanded Disposable interface docs, added sync & async example classes, and CherryPick integration sample.\n- Clarified how to implement and use Disposable in DI context.\n- Updated binding_resolver for internal improvements.\n- Added ignore for deprecated member use in scope_test for clarity and future upgrades.\n\nBREAKING CHANGE: Documentation style enhancement and clearer API usage for Disposable implementations.
|
|
||||||
|
|
||||||
#### `cherrypick_annotations` - `v1.1.1`
|
|
||||||
|
|
||||||
- **FIX**(license): correct urls.
|
|
||||||
|
|
||||||
#### `cherrypick_flutter` - `v1.1.3-dev.7`
|
|
||||||
|
|
||||||
- **FIX**(license): correct urls.
|
|
||||||
|
|
||||||
#### `cherrypick_generator` - `v1.1.1`
|
|
||||||
|
|
||||||
- **FIX**(license): correct urls.
|
|
||||||
|
|
||||||
|
|
||||||
## 2025-08-08
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Packages with breaking changes:
|
|
||||||
|
|
||||||
- [`cherrypick` - `v3.0.0-dev.6`](#cherrypick---v300-dev6)
|
|
||||||
|
|
||||||
Packages with other changes:
|
|
||||||
|
|
||||||
- [`cherrypick_flutter` - `v1.1.3-dev.6`](#cherrypick_flutter---v113-dev6)
|
|
||||||
|
|
||||||
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.6`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### `cherrypick` - `v3.0.0-dev.6`
|
|
||||||
|
|
||||||
- **FIX**: improve global cycle detector logic.
|
|
||||||
- **DOCS**(readme): add comprehensive DI state and action logging to features.
|
|
||||||
- **DOCS**(helper): add complete DartDoc with real usage examples for CherryPick class.
|
|
||||||
- **DOCS**(log_format): add detailed English documentation for formatLogMessage function.
|
|
||||||
- **BREAKING** **FEAT**(core): refactor root scope API, improve logger injection, helpers, and tests.
|
|
||||||
- **BREAKING** **FEAT**(logger): add extensible logging API, usage examples, and bilingual documentation.
|
|
||||||
|
|
||||||
|
|
||||||
## 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
|
## 2025-07-30
|
||||||
|
|
||||||
### Changes
|
### Changes
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
# Contributors
|
# Contributors
|
||||||
|
|
||||||
- [Sergey Penkovsky](https://github.com/pese-git)
|
- Sergey Penkovsky <sergey.penkovsky@gmail.com>
|
||||||
- [Klim Yaroshevich](https://github.com/KlimYarosh)
|
- Klim Yaroshevich <yarashevich_kv@st.by>
|
||||||
- [Alexey Popkov](https://github.com/AlexeyYuPopkov)
|
|
||||||
2
LICENSE
2
LICENSE
@@ -192,7 +192,7 @@
|
|||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
You may obtain a copy of the License at
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
https://www.apache.org/licenses/LICENSE-2.0
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
Unless required by applicable law or agreed to in writing, software
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
|||||||
@@ -1,7 +1,3 @@
|
|||||||
[](https://github.com/pese-git/cherrypick/actions/workflows/pipeline.yml)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# CherryPick Workspace
|
# CherryPick Workspace
|
||||||
|
|
||||||
CherryPick Workspace is a modular, open-source dependency injection ecosystem for Dart and Flutter, designed to offer lightweight, flexible, and scalable DI suitable for both backend and frontend (Flutter) development. This monorepo contains the main DI runtime library, annotation helpers, code generation for modular bindings, and seamless Flutter integration.
|
CherryPick Workspace is a modular, open-source dependency injection ecosystem for Dart and Flutter, designed to offer lightweight, flexible, and scalable DI suitable for both backend and frontend (Flutter) development. This monorepo contains the main DI runtime library, annotation helpers, code generation for modular bindings, and seamless Flutter integration.
|
||||||
|
|||||||
@@ -1,275 +0,0 @@
|
|||||||
# 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
|
|
||||||
@@ -1,226 +0,0 @@
|
|||||||
# 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
|
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
# Comparative DI Benchmark Report: cherrypick vs get_it vs riverpod vs kiwi
|
|
||||||
|
|
||||||
## Benchmark Parameters
|
|
||||||
|
|
||||||
- chainCount = 100
|
|
||||||
- nestingDepth = 100
|
|
||||||
- repeat = 5
|
|
||||||
- warmup = 2
|
|
||||||
|
|
||||||
## Benchmark Scenarios
|
|
||||||
|
|
||||||
1. **RegisterSingleton** — Registers and resolves a singleton. Baseline DI speed.
|
|
||||||
2. **ChainSingleton** — A dependency chain A → B → ... → N (singleton). Deep singleton chain resolution.
|
|
||||||
3. **ChainFactory** — All chain elements are factories. Stateless creation chain.
|
|
||||||
4. **AsyncChain** — Async chain (async factory). Performance on async graphs.
|
|
||||||
5. **Named** — Registers two bindings with names, resolves by name. Named lookup test.
|
|
||||||
6. **Override** — Registers a chain/alias in a child scope. Tests scope overrides.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Comparative Table: chainCount=100, nestingDepth=100, repeat=5, warmup=2 (Mean time, µs)
|
|
||||||
|
|
||||||
| Scenario | cherrypick | get_it | riverpod | kiwi | yx_scope |
|
|
||||||
|------------------|------------|--------|----------|-------|----------|
|
|
||||||
| chainSingleton | 20.6 | 14.8 | 275.2 | 47.0 | 82.8 |
|
|
||||||
| chainFactory | 90.6 | 71.6 | 357.0 | 46.2 | 79.6 |
|
|
||||||
| register | 82.6 | 10.2 | 252.6 | 43.6 | 224.0 |
|
|
||||||
| named | 18.4 | 9.4 | 12.2 | 10.2 | 10.8 |
|
|
||||||
| override | 170.6 | 11.2 | 301.4 | 51.4 | 146.4 |
|
|
||||||
| chainAsync | 493.8 | 34.0 | 5,039.0 | – | 87.2 |
|
|
||||||
|
|
||||||
|
|
||||||
## Peak Memory Usage (Peak RSS, Kb)
|
|
||||||
|
|
||||||
| Scenario | cherrypick | get_it | riverpod | kiwi | yx_scope |
|
|
||||||
|------------------|------------|--------|----------|--------|----------|
|
|
||||||
| chainSingleton | 338,224 | 326,752| 301,856 | 195,520| 320,928 |
|
|
||||||
| chainFactory | 339,040 | 335,712| 304,832 | 319,952| 318,688 |
|
|
||||||
| register | 333,760 | 334,208| 300,368 | 327,968| 326,736 |
|
|
||||||
| named | 241,040 | 229,632| 280,144 | 271,872| 266,352 |
|
|
||||||
| override | 356,912 | 331,456| 329,808 | 369,104| 304,416 |
|
|
||||||
| chainAsync | 311,616 | 434,592| 301,168 | – | 328,912 |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Analysis
|
|
||||||
|
|
||||||
- **get_it** remains the clear leader for both speed and memory usage (lowest latency across most scenarios; excellent memory efficiency even on deep chains).
|
|
||||||
- **kiwi** shows the lowest memory footprint in chainSingleton, but is unavailable for async chains.
|
|
||||||
- **yx_scope** demonstrates highly stable performance for both sync and async chains, often at the cost of higher memory usage, especially in the register/override scenarios.
|
|
||||||
- **cherrypick** comfortably beats riverpod, but is outperformed by get_it/kiwi/yx_scope, especially on async and heavy nested chains. It uses a bit less memory than yx_scope and kiwi, but can spike in memory/latency for override.
|
|
||||||
- **riverpod** is unsuitable for deep or async chains—latency and memory usage grow rapidly.
|
|
||||||
- **Peak memory (RSS):** usually around 320–340 MB for all DI; riverpod/kiwi occasionally drops below 300MB. named/factory scenarios use much less.
|
|
||||||
- **Stability:** yx_scope and get_it have the lowest latency spikes; cherrypick can show peaks on override/async; riverpod is least stable on async (stddev/mean much worse).
|
|
||||||
|
|
||||||
### Recommendations
|
|
||||||
|
|
||||||
- **get_it** (and often **kiwi**, if you don't need async): best for ultra-fast deep graphs and minimum peak memory.
|
|
||||||
- **yx_scope**: best blend of performance and async stability; perfect for production mixed DI.
|
|
||||||
- **cherrypick**: great for modular/testable architectures, unless absolute peak is needed; lower memory than yx_scope in some scenarios.
|
|
||||||
- **riverpod**: only for shallow DI or UI wiring in Flutter.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
_Last updated: August 20, 2025._
|
|
||||||
_Please see scenario source for details._
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
# Сравнительный отчет DI-бенчмарка: cherrypick vs get_it vs riverpod vs kiwi
|
|
||||||
|
|
||||||
## Параметры запуска:
|
|
||||||
- chainCount = 100
|
|
||||||
- nestingDepth = 100
|
|
||||||
- repeat = 5
|
|
||||||
- warmup = 2
|
|
||||||
|
|
||||||
## Описание сценариев
|
|
||||||
|
|
||||||
1. **RegisterSingleton** — регистрация и получение singleton (базовая скорость DI).
|
|
||||||
2. **ChainSingleton** — цепочка зависимостей A → B → ... → N (singleton). Глубокий singleton-резолвинг.
|
|
||||||
3. **ChainFactory** — все элементы цепочки — factory. Stateless построение графа.
|
|
||||||
4. **AsyncChain** — асинхронная цепочка (async factory). Тест async/await графа.
|
|
||||||
5. **Named** — регистрация двух биндингов с именами, разрешение по имени.
|
|
||||||
6. **Override** — регистрация биндинга/цепочки в дочернем scope.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Сравнительная таблица: chainCount=100, nestingDepth=100, repeat=5, warmup=2 (среднее время, мкс)
|
|
||||||
|
|
||||||
| Сценарий | cherrypick | get_it | riverpod | kiwi | yx_scope |
|
|
||||||
|------------------|------------|--------|----------|-------|----------|
|
|
||||||
| chainSingleton | 20.6 | 14.8 | 275.2 | 47.0 | 82.8 |
|
|
||||||
| chainFactory | 90.6 | 71.6 | 357.0 | 46.2 | 79.6 |
|
|
||||||
| register | 82.6 | 10.2 | 252.6 | 43.6 | 224.0 |
|
|
||||||
| named | 18.4 | 9.4 | 12.2 | 10.2 | 10.8 |
|
|
||||||
| override | 170.6 | 11.2 | 301.4 | 51.4 | 146.4 |
|
|
||||||
| chainAsync | 493.8 | 34.0 | 5,039.0 | – | 87.2 |
|
|
||||||
|
|
||||||
|
|
||||||
## Пиковое потребление памяти (Peak RSS, Кб)
|
|
||||||
|
|
||||||
| Сценарий | cherrypick | get_it | riverpod | kiwi | yx_scope |
|
|
||||||
|------------------|------------|--------|----------|--------|----------|
|
|
||||||
| chainSingleton | 338,224 | 326,752| 301,856 | 195,520| 320,928 |
|
|
||||||
| chainFactory | 339,040 | 335,712| 304,832 | 319,952| 318,688 |
|
|
||||||
| register | 333,760 | 334,208| 300,368 | 327,968| 326,736 |
|
|
||||||
| named | 241,040 | 229,632| 280,144 | 271,872| 266,352 |
|
|
||||||
| override | 356,912 | 331,456| 329,808 | 369,104| 304,416 |
|
|
||||||
| chainAsync | 311,616 | 434,592| 301,168 | – | 328,912 |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Краткий анализ и рекомендации
|
|
||||||
|
|
||||||
- **get_it** — абсолютный лидер по скорости и памяти на всех графах (минимальная задержка, небольшой peak RSS в любых цепочках).
|
|
||||||
- **kiwi** — минимальное потребление памяти в chainSingleton/Factory, но не для асинхронности.
|
|
||||||
- **yx_scope** — очень ровная производительность даже на сложных async/sync-цепях, иногда с пиком в памяти на override/register, но задержки всегда минимальны.
|
|
||||||
- **cherrypick** — стабильнее riverpod, но ощутимо уступает top-3 по латентности на длинных/async-графах; по памяти лучше yx_scope для override/named.
|
|
||||||
- **riverpod** — непригоден для глубоких/async-графов: память и время растут очень сильно.
|
|
||||||
- **Пиковое потребление памяти**: большинство DI держится в районе 320–340 Мб (большие цепи), на мелких named/factory — крайне мало.
|
|
||||||
- **Стабильность**: yx_scope и get_it показывают наименьшие скачки времени; у cherrypick иногда всплески на override/async, у riverpod — на async графе stddev почти равен mean!
|
|
||||||
|
|
||||||
### Рекомендации
|
|
||||||
- Используйте **get_it** (или **kiwi**, если не нужен async) для максимальной производительности и минимального пикового использования памяти.
|
|
||||||
- **yx_scope** — идеально для production-графов с миксом sync/async.
|
|
||||||
- **cherrypick** — хорошо для модульных и тестируемых приложений, если не требуется абсолютная “микросекундная” производительность.
|
|
||||||
- **riverpod** — только если граф плоский или нужно DI только для UI во Flutter.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
_Обновлено: 20 августа 2025._
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
# 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
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
import 'package:benchmark_di/cli/benchmark_cli.dart';
|
|
||||||
|
|
||||||
Future<void> main(List<String> args) async {
|
|
||||||
await BenchmarkCliRunner().run(args);
|
|
||||||
}
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
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);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,80 +0,0 @@
|
|||||||
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');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,222 +0,0 @@
|
|||||||
import 'dart:math';
|
|
||||||
|
|
||||||
import 'package:benchmark_di/cli/report/markdown_report.dart';
|
|
||||||
import 'package:benchmark_di/di_adapters/yx_scope_adapter.dart';
|
|
||||||
import 'package:benchmark_di/di_adapters/yx_scope_universal_container.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';
|
|
||||||
import 'package:benchmark_di/di_adapters/kiwi_adapter.dart';
|
|
||||||
import 'package:kiwi/kiwi.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 == 'kiwi') {
|
|
||||||
final di = KiwiAdapter();
|
|
||||||
if (scenario == UniversalScenario.asyncChain) {
|
|
||||||
// UnsupportedError будет выброшен адаптером, но если дойдёт — вызывать async benchmark
|
|
||||||
final benchAsync = UniversalChainAsyncBenchmark<KiwiContainer>(
|
|
||||||
di,
|
|
||||||
chainCount: c,
|
|
||||||
nestingDepth: d,
|
|
||||||
mode: mode,
|
|
||||||
);
|
|
||||||
benchResult = await BenchmarkRunner.runAsync(
|
|
||||||
benchmark: benchAsync,
|
|
||||||
warmups: config.warmups,
|
|
||||||
repeats: config.repeats,
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
final benchSync = UniversalChainBenchmark<KiwiContainer>(
|
|
||||||
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 if (config.di == 'yx_scope') {
|
|
||||||
final di = YxScopeAdapter();
|
|
||||||
if (scenario == UniversalScenario.asyncChain) {
|
|
||||||
final benchAsync = UniversalChainAsyncBenchmark<UniversalYxScopeContainer>(
|
|
||||||
di,
|
|
||||||
chainCount: c,
|
|
||||||
nestingDepth: d,
|
|
||||||
mode: mode,
|
|
||||||
);
|
|
||||||
benchResult = await BenchmarkRunner.runAsync(
|
|
||||||
benchmark: benchAsync,
|
|
||||||
warmups: config.warmups,
|
|
||||||
repeats: config.repeats,
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
final benchSync = UniversalChainBenchmark<UniversalYxScopeContainer>(
|
|
||||||
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));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,146 +0,0 @@
|
|||||||
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',
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
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');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
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]';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,99 +0,0 @@
|
|||||||
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')}';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,71 +0,0 @@
|
|||||||
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');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
/// 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;
|
|
||||||
}
|
|
||||||
@@ -1,102 +0,0 @@
|
|||||||
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);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,202 +0,0 @@
|
|||||||
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
|
|
||||||
Future<void> teardown() async {
|
|
||||||
if (!_isSubScope) {
|
|
||||||
await CherryPick.closeRootScope();
|
|
||||||
_scope = null;
|
|
||||||
}
|
|
||||||
// SubScope teardown не требуется
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
CherrypickDIAdapter openSubScope(String name) {
|
|
||||||
return CherrypickDIAdapter(_scope!.openSubScope(name), true);
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
Future<void> waitForAsyncReady() async {}
|
|
||||||
}
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
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 {}
|
|
||||||
}
|
|
||||||
@@ -1,165 +0,0 @@
|
|||||||
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');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,129 +0,0 @@
|
|||||||
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:kiwi/kiwi.dart';
|
|
||||||
import 'di_adapter.dart';
|
|
||||||
|
|
||||||
/// DIAdapter-для KiwiContainer с поддержкой universal benchmark сценариев.
|
|
||||||
class KiwiAdapter extends DIAdapter<KiwiContainer> {
|
|
||||||
late KiwiContainer _container;
|
|
||||||
// ignore: unused_field
|
|
||||||
final bool _isSubScope;
|
|
||||||
|
|
||||||
KiwiAdapter({KiwiContainer? container, bool isSubScope = false})
|
|
||||||
: _isSubScope = isSubScope {
|
|
||||||
_container = container ?? KiwiContainer();
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
void setupDependencies(void Function(KiwiContainer container) registration) {
|
|
||||||
registration(_container);
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
Registration<KiwiContainer> universalRegistration<S extends Enum>({
|
|
||||||
required S scenario,
|
|
||||||
required int chainCount,
|
|
||||||
required int nestingDepth,
|
|
||||||
required UniversalBindingMode bindingMode,
|
|
||||||
}) {
|
|
||||||
if (scenario is UniversalScenario) {
|
|
||||||
if (scenario == UniversalScenario.asyncChain ||
|
|
||||||
bindingMode == UniversalBindingMode.asyncStrategy) {
|
|
||||||
throw UnsupportedError('Kiwi does not support async dependencies or async binding scenarios.');
|
|
||||||
}
|
|
||||||
return (container) {
|
|
||||||
switch (scenario) {
|
|
||||||
case UniversalScenario.asyncChain:
|
|
||||||
break;
|
|
||||||
case UniversalScenario.register:
|
|
||||||
container.registerSingleton<UniversalService>(
|
|
||||||
(c) => UniversalServiceImpl(value: 'reg', dependency: null),
|
|
||||||
);
|
|
||||||
break;
|
|
||||||
case UniversalScenario.named:
|
|
||||||
container.registerFactory<UniversalService>(
|
|
||||||
(c) => UniversalServiceImpl(value: 'impl1'), name: 'impl1');
|
|
||||||
container.registerFactory<UniversalService>(
|
|
||||||
(c) => UniversalServiceImpl(value: 'impl2'), name: '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:
|
|
||||||
container.registerSingleton<UniversalService>(
|
|
||||||
(c) => UniversalServiceImpl(
|
|
||||||
value: depName,
|
|
||||||
dependency: level > 1
|
|
||||||
? c.resolve<UniversalService>(prevDepName)
|
|
||||||
: null),
|
|
||||||
name: depName);
|
|
||||||
break;
|
|
||||||
case UniversalBindingMode.factoryStrategy:
|
|
||||||
container.registerFactory<UniversalService>(
|
|
||||||
(c) => UniversalServiceImpl(
|
|
||||||
value: depName,
|
|
||||||
dependency: level > 1
|
|
||||||
? c.resolve<UniversalService>(prevDepName)
|
|
||||||
: null),
|
|
||||||
name: depName);
|
|
||||||
break;
|
|
||||||
case UniversalBindingMode.asyncStrategy:
|
|
||||||
// Не поддерживается
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
final depName = '${chainCount}_$nestingDepth';
|
|
||||||
container.registerSingleton<UniversalService>(
|
|
||||||
(c) => c.resolve<UniversalService>(depName));
|
|
||||||
break;
|
|
||||||
case UniversalScenario.override:
|
|
||||||
final depName = '${chainCount}_$nestingDepth';
|
|
||||||
container.registerSingleton<UniversalService>(
|
|
||||||
(c) => c.resolve<UniversalService>(depName));
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
throw UnsupportedError('Scenario $scenario not supported by KiwiAdapter');
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
T resolve<T extends Object>({String? named}) {
|
|
||||||
// Для asyncChain нужен resolve<Future<T>>
|
|
||||||
if (T.toString().startsWith('Future<')) {
|
|
||||||
return _container.resolve<T>(named);
|
|
||||||
} else {
|
|
||||||
return _container.resolve<T>(named);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
Future<T> resolveAsync<T extends Object>({String? named}) async {
|
|
||||||
if (T.toString().startsWith('Future<')) {
|
|
||||||
// resolve<Future<T>>, unwrap result
|
|
||||||
return Future.value(_container.resolve<T>(named));
|
|
||||||
} else {
|
|
||||||
// Для совместимости с chain/override
|
|
||||||
return Future.value(_container.resolve<T>(named));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
void teardown() {
|
|
||||||
_container.clear();
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
KiwiAdapter openSubScope(String name) {
|
|
||||||
// Возвращаем новый scoped контейнер (отдельный). Наследование не реализовано.
|
|
||||||
return KiwiAdapter(container: KiwiContainer.scoped(), isSubScope: true);
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
Future<void> waitForAsyncReady() async {}
|
|
||||||
}
|
|
||||||
@@ -1,156 +0,0 @@
|
|||||||
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;
|
|
||||||
|
|
||||||
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;
|
|
||||||
|
|
||||||
@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');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,126 +0,0 @@
|
|||||||
// ignore_for_file: invalid_use_of_protected_member
|
|
||||||
|
|
||||||
import 'package:benchmark_di/di_adapters/di_adapter.dart';
|
|
||||||
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:benchmark_di/di_adapters/yx_scope_universal_container.dart';
|
|
||||||
|
|
||||||
/// DIAdapter для yx_scope UniversalYxScopeContainer
|
|
||||||
class YxScopeAdapter extends DIAdapter<UniversalYxScopeContainer> {
|
|
||||||
late UniversalYxScopeContainer _scope;
|
|
||||||
|
|
||||||
@override
|
|
||||||
void setupDependencies(void Function(UniversalYxScopeContainer container) registration) {
|
|
||||||
_scope = UniversalYxScopeContainer();
|
|
||||||
registration(_scope);
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
T resolve<T extends Object>({String? named}) {
|
|
||||||
return _scope.depFor<T>(name: named).get;
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
Future<T> resolveAsync<T extends Object>({String? named}) async {
|
|
||||||
return resolve<T>(named: named);
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
void teardown() {
|
|
||||||
// У yx_scope нет явного dispose на ScopeContainer, но можно добавить очистку Map/Deps если потребуется
|
|
||||||
// Ничего не делаем
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
YxScopeAdapter openSubScope(String name) {
|
|
||||||
// Для простоты всегда возвращаем новый контейнер, сабскоупы не реализованы явно
|
|
||||||
return YxScopeAdapter();
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
Future<void> waitForAsyncReady() async {
|
|
||||||
// Все зависимости синхронны
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
@override
|
|
||||||
Registration<UniversalYxScopeContainer> universalRegistration<S extends Enum>({
|
|
||||||
required S scenario,
|
|
||||||
required int chainCount,
|
|
||||||
required int nestingDepth,
|
|
||||||
required UniversalBindingMode bindingMode,
|
|
||||||
}) {
|
|
||||||
if (scenario is UniversalScenario) {
|
|
||||||
return (scope) {
|
|
||||||
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';
|
|
||||||
final dep = scope.dep<UniversalService>(
|
|
||||||
() => UniversalServiceImpl(
|
|
||||||
value: depName,
|
|
||||||
dependency: level > 1
|
|
||||||
? scope.depFor<UniversalService>(name: prevDepName).get
|
|
||||||
: null,
|
|
||||||
),
|
|
||||||
name: depName,
|
|
||||||
);
|
|
||||||
scope.register<UniversalService>(dep, name: depName);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
case UniversalScenario.register:
|
|
||||||
final dep = scope.dep<UniversalService>(
|
|
||||||
() => UniversalServiceImpl(value: 'reg', dependency: null),
|
|
||||||
);
|
|
||||||
scope.register<UniversalService>(dep);
|
|
||||||
break;
|
|
||||||
case UniversalScenario.named:
|
|
||||||
final dep1 = scope.dep<UniversalService>(
|
|
||||||
() => UniversalServiceImpl(value: 'impl1'),
|
|
||||||
name: 'impl1',
|
|
||||||
);
|
|
||||||
final dep2 = scope.dep<UniversalService>(
|
|
||||||
() => UniversalServiceImpl(value: 'impl2'),
|
|
||||||
name: 'impl2',
|
|
||||||
);
|
|
||||||
scope.register<UniversalService>(dep1, name: 'impl1');
|
|
||||||
scope.register<UniversalService>(dep2, name: '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';
|
|
||||||
final dep = scope.dep<UniversalService>(
|
|
||||||
() => UniversalServiceImpl(
|
|
||||||
value: depName,
|
|
||||||
dependency: level > 1
|
|
||||||
? scope.depFor<UniversalService>(name: prevDepName).get
|
|
||||||
: null,
|
|
||||||
),
|
|
||||||
name: depName,
|
|
||||||
);
|
|
||||||
scope.register<UniversalService>(dep, name: depName);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
case UniversalScenario.override:
|
|
||||||
// handled at benchmark level
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
if (scenario == UniversalScenario.chain || scenario == UniversalScenario.override) {
|
|
||||||
final depName = '${chainCount}_$nestingDepth';
|
|
||||||
final lastDep = scope.dep<UniversalService>(
|
|
||||||
() => scope.depFor<UniversalService>(name: depName).get,
|
|
||||||
);
|
|
||||||
scope.register<UniversalService>(lastDep);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
throw UnsupportedError('Scenario $scenario not supported by YxScopeAdapter');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
import 'package:yx_scope/yx_scope.dart';
|
|
||||||
|
|
||||||
/// Universal container for dynamic DI registration in yx_scope (for benchmarks).
|
|
||||||
/// Allows to register and resolve deps by name/type at runtime.
|
|
||||||
class UniversalYxScopeContainer extends ScopeContainer {
|
|
||||||
final Map<String, Dep<dynamic>> _namedDeps = {};
|
|
||||||
final Map<Type, Dep<dynamic>> _typedDeps = {};
|
|
||||||
|
|
||||||
void register<T>(Dep<T> dep, {String? name}) {
|
|
||||||
if (name != null) {
|
|
||||||
_namedDeps[_depKey<T>(name)] = dep;
|
|
||||||
} else {
|
|
||||||
_typedDeps[T] = dep;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Dep<T> depFor<T>({String? name}) {
|
|
||||||
if (name != null) {
|
|
||||||
final dep = _namedDeps[_depKey<T>(name)];
|
|
||||||
if (dep is Dep<T>) return dep;
|
|
||||||
throw Exception('No dep for type $T/$name');
|
|
||||||
} else {
|
|
||||||
final dep = _typedDeps[T];
|
|
||||||
if (dep is Dep<T>) return dep;
|
|
||||||
throw Exception('No dep for type $T');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
static String _depKey<T>(String name) => '$T@$name';
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
/// Enum to represent the DI registration/binding mode.
|
|
||||||
enum UniversalBindingMode {
|
|
||||||
/// Singleton/provider binding.
|
|
||||||
singletonStrategy,
|
|
||||||
|
|
||||||
/// Factory-based binding.
|
|
||||||
factoryStrategy,
|
|
||||||
|
|
||||||
/// Async-based binding.
|
|
||||||
asyncStrategy,
|
|
||||||
}
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
/// 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,
|
|
||||||
}
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
/// 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});
|
|
||||||
}
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
<?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>
|
|
||||||
@@ -1,148 +0,0 @@
|
|||||||
# 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.12"
|
|
||||||
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"
|
|
||||||
kiwi:
|
|
||||||
dependency: "direct main"
|
|
||||||
description:
|
|
||||||
name: kiwi
|
|
||||||
sha256: d078364a90fb1b93852bb74468efdf4aaae35c036c538c1cf4f9c74a19df9a61
|
|
||||||
url: "https://pub.dev"
|
|
||||||
source: hosted
|
|
||||||
version: "5.0.1"
|
|
||||||
lazy_memo:
|
|
||||||
dependency: transitive
|
|
||||||
description:
|
|
||||||
name: lazy_memo
|
|
||||||
sha256: dcb30b4184a6d767e1d779d74ce784d752d38313b8fb4bad6b659ae7af4bb34d
|
|
||||||
url: "https://pub.dev"
|
|
||||||
source: hosted
|
|
||||||
version: "0.2.3"
|
|
||||||
lints:
|
|
||||||
dependency: "direct dev"
|
|
||||||
description:
|
|
||||||
name: lints
|
|
||||||
sha256: c35bb79562d980e9a453fc715854e1ed39e24e7d0297a880ef54e17f9874a9d7
|
|
||||||
url: "https://pub.dev"
|
|
||||||
source: hosted
|
|
||||||
version: "5.1.1"
|
|
||||||
meta:
|
|
||||||
dependency: transitive
|
|
||||||
description:
|
|
||||||
name: meta
|
|
||||||
sha256: "23f08335362185a5ea2ad3a4e597f1375e78bce8a040df5c600c8d3552ef2394"
|
|
||||||
url: "https://pub.dev"
|
|
||||||
source: hosted
|
|
||||||
version: "1.17.0"
|
|
||||||
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"
|
|
||||||
yx_scope:
|
|
||||||
dependency: "direct main"
|
|
||||||
description:
|
|
||||||
name: yx_scope
|
|
||||||
sha256: "9ba98b442261596311363bf7361622e5ccc67189705b8d042ca23c9de366f8bf"
|
|
||||||
url: "https://pub.dev"
|
|
||||||
source: hosted
|
|
||||||
version: "1.1.2"
|
|
||||||
sdks:
|
|
||||||
dart: ">=3.6.0 <4.0.0"
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
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
|
|
||||||
kiwi: ^5.0.1
|
|
||||||
yx_scope: ^1.1.2
|
|
||||||
|
|
||||||
dev_dependencies:
|
|
||||||
lints: ^5.0.0
|
|
||||||
benchmark_harness: ^2.2.2
|
|
||||||
benchmark_runner: ^0.0.2
|
|
||||||
@@ -1,102 +1,3 @@
|
|||||||
## 3.0.0
|
|
||||||
|
|
||||||
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
|
|
||||||
|
|
||||||
## 3.0.0-dev.13
|
|
||||||
|
|
||||||
- **FIX**: fix examples.
|
|
||||||
- **DOCS**: update contributors list with GitHub links and add new contributor.
|
|
||||||
- **DOCS**(binding,docs): clarify `.singleton()` with `.toInstance()` behavior in docs and API.
|
|
||||||
- **DOCS**(binding,docs): explain .singleton() + parametric provider behavior.
|
|
||||||
- **DOCS**(binding): clarify registration limitation in API doc.
|
|
||||||
- **DOCS**(di): clarify 'toInstance' binding limitations in builder.
|
|
||||||
|
|
||||||
## 3.0.0-dev.12
|
|
||||||
|
|
||||||
- **FIX**(scope): prevent concurrent modification in dispose().
|
|
||||||
- **FIX**(binding): fix unterminated string literal and syntax issues in binding.dart.
|
|
||||||
|
|
||||||
## 3.0.0-dev.11
|
|
||||||
|
|
||||||
- **FIX**(scope): prevent concurrent modification in dispose().
|
|
||||||
- **FIX**(binding): fix unterminated string literal and syntax issues in binding.dart.
|
|
||||||
|
|
||||||
## 3.0.0-dev.10
|
|
||||||
|
|
||||||
- **DOCS**(pub): update homepage and documentation URLs in pubspec.yaml to new official site.
|
|
||||||
|
|
||||||
## 3.0.0-dev.9
|
|
||||||
|
|
||||||
- **DOCS**(readme): add talker_cherrypick_logger to Additional Modules section.
|
|
||||||
- **DOCS**(api): improve all DI core code documentation with English dartdoc and examples.
|
|
||||||
|
|
||||||
## 3.0.0-dev.8
|
|
||||||
|
|
||||||
- **REFACTOR**(tests): replace MockLogger with MockObserver in scope tests to align with updated observer API.
|
|
||||||
- **FIX**(doc): remove hide symbol.
|
|
||||||
- **FEAT**(core): add full DI lifecycle observability via onInstanceDisposed.
|
|
||||||
- **DOCS**(logging): update Logging section in README with modern Observer usage and Talker integration examples.
|
|
||||||
- **DOCS**(observer): improve documentation, translate all comments to English, add usage examples.
|
|
||||||
- **DOCS**(README): add section with overview table for additional modules.
|
|
||||||
- **DOCS**(README): refactor structure and improve clarity of advanced features.
|
|
||||||
- **DOCS**(README): add 'Hierarchical Subscopes' section and update structure for advanced features clarity.
|
|
||||||
|
|
||||||
## 3.0.0-dev.7
|
|
||||||
|
|
||||||
> Note: This release has breaking changes.
|
|
||||||
|
|
||||||
- **FIX**(comment): fix warnings.
|
|
||||||
- **FIX**(license): correct urls.
|
|
||||||
- **FEAT**: add Disposable interface source and usage example.
|
|
||||||
- **DOCS**(readme): add comprehensive section on annotations and DI code generation.
|
|
||||||
- **DOCS**(readme): add detailed section and examples for automatic Disposable resource cleanup\n\n- Added a dedicated section with English description and code samples on using Disposable for automatic resource management.\n- Updated Features to include automatic resource cleanup for Disposable dependencies.\n\nHelps developers understand and implement robust DI resource management practices.
|
|
||||||
- **DOCS**(faq): add best practice FAQ about using await with scope disposal.
|
|
||||||
- **DOCS**(faq): add best practice FAQ about using await with scope disposal.
|
|
||||||
- **BREAKING** **REFACTOR**(core): make closeRootScope async and await dispose.
|
|
||||||
- **BREAKING** **DOCS**(disposable): add detailed English documentation and usage examples for Disposable interface; chore: update binding_resolver and add explanatory comment in scope_test for deprecated usage.\n\n- Expanded Disposable interface docs, added sync & async example classes, and CherryPick integration sample.\n- Clarified how to implement and use Disposable in DI context.\n- Updated binding_resolver for internal improvements.\n- Added ignore for deprecated member use in scope_test for clarity and future upgrades.\n\nBREAKING CHANGE: Documentation style enhancement and clearer API usage for Disposable implementations.
|
|
||||||
|
|
||||||
## 3.0.0-dev.6
|
|
||||||
|
|
||||||
> Note: This release has breaking changes.
|
|
||||||
|
|
||||||
- **FIX**: improve global cycle detector logic.
|
|
||||||
- **DOCS**(readme): add comprehensive DI state and action logging to features.
|
|
||||||
- **DOCS**(helper): add complete DartDoc with real usage examples for CherryPick class.
|
|
||||||
- **DOCS**(log_format): add detailed English documentation for formatLogMessage function.
|
|
||||||
- **BREAKING** **FEAT**(core): refactor root scope API, improve logger injection, helpers, and tests.
|
|
||||||
- **BREAKING** **FEAT**(logger): add extensible logging API, usage examples, and bilingual documentation.
|
|
||||||
|
|
||||||
## 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
|
## 3.0.0-dev.1
|
||||||
|
|
||||||
- **DOCS**: add quick guide for circular dependency detection to README.
|
- **DOCS**: add quick guide for circular dependency detection to README.
|
||||||
|
|||||||
@@ -192,7 +192,7 @@
|
|||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
You may obtain a copy of the License at
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
https://www.apache.org/licenses/LICENSE-2.0
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
Unless required by applicable law or agreed to in writing, software
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
|||||||
@@ -1,203 +1,47 @@
|
|||||||
[](https://github.com/pese-git/cherrypick/actions/workflows/pipeline.yml)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# CherryPick
|
# CherryPick
|
||||||
|
|
||||||
`cherrypick` is a flexible and lightweight dependency injection library for Dart and Flutter.
|
`cherrypick` is a flexible and lightweight dependency injection library for Dart and Flutter. It provides an easy-to-use system for registering, scoping, and resolving dependencies using modular bindings and hierarchical scopes. The design enables cleaner architecture, testability, and modular code in your applications.
|
||||||
It provides an easy-to-use system for registering, scoping, and resolving dependencies using modular bindings and hierarchical scopes. The design enables cleaner architecture, testability, and modular code in your applications.
|
|
||||||
|
|
||||||
---
|
## Key Concepts
|
||||||
|
|
||||||
## Table of Contents
|
|
||||||
- [Key Features](#key-features)
|
|
||||||
- [Installation](#installation)
|
|
||||||
- [Getting Started](#getting-started)
|
|
||||||
- [Core Concepts](#core-concepts)
|
|
||||||
- [Binding](#binding)
|
|
||||||
- [Module](#module)
|
|
||||||
- [Scope](#scope)
|
|
||||||
- [Disposable](#disposable)
|
|
||||||
- [Dependency Resolution API](#dependency-resolution-api)
|
|
||||||
- [Using Annotations & Code Generation](#using-annotations--code-generation)
|
|
||||||
- [Advanced Features](#advanced-features)
|
|
||||||
- [Hierarchical Subscopes](#hierarchical-subscopes)
|
|
||||||
- [Logging](#logging)
|
|
||||||
- [Circular Dependency Detection](#circular-dependency-detection)
|
|
||||||
- [Performance Improvements](#performance-improvements)
|
|
||||||
- [Example Application](#example-application)
|
|
||||||
- [FAQ](#faq)
|
|
||||||
- [Documentation Links](#documentation-links)
|
|
||||||
- [Additional Modules](#additional-modules)
|
|
||||||
- [Contributing](#contributing)
|
|
||||||
- [License](#license)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Features
|
|
||||||
- Main Scope and Named Subscopes
|
|
||||||
- Named Instance Binding and Resolution
|
|
||||||
- Asynchronous and Synchronous Providers
|
|
||||||
- Providers Supporting Runtime Parameters
|
|
||||||
- Singleton Lifecycle Management
|
|
||||||
- Modular and Hierarchical Composition
|
|
||||||
- Null-safe Resolution (tryResolve/tryResolveAsync)
|
|
||||||
- Circular Dependency Detection (Local and Global)
|
|
||||||
- Comprehensive logging of dependency injection state and actions
|
|
||||||
- Automatic resource cleanup for all registered Disposable dependencies
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
Add to your `pubspec.yaml`:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
dependencies:
|
|
||||||
cherrypick: ^<latest_version>
|
|
||||||
````
|
|
||||||
|
|
||||||
Then run:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
dart pub get
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
Here is a minimal example that registers and resolves a dependency:
|
|
||||||
|
|
||||||
```dart
|
|
||||||
import 'package:cherrypick/cherrypick.dart';
|
|
||||||
|
|
||||||
class AppModule extends Module {
|
|
||||||
@override
|
|
||||||
void builder(Scope currentScope) {
|
|
||||||
bind<ApiClient>().toInstance(ApiClientMock());
|
|
||||||
bind<String>().toProvide(() => "Hello, CherryPick!");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
final rootScope = CherryPick.openRootScope();
|
|
||||||
rootScope.installModules([AppModule()]);
|
|
||||||
|
|
||||||
final greeting = rootScope.resolve<String>();
|
|
||||||
print(greeting); // prints: Hello, CherryPick!
|
|
||||||
|
|
||||||
await CherryPick.closeRootScope();
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Core Concepts
|
|
||||||
|
|
||||||
### Binding
|
### Binding
|
||||||
|
|
||||||
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
|
||||||
* Named instances for resolving by string key
|
- Named instances for resolving by string key
|
||||||
* Optional singleton lifecycle
|
- Optional singleton lifecycle
|
||||||
|
|
||||||
#### Example
|
#### Example
|
||||||
|
|
||||||
```dart
|
```dart
|
||||||
void builder(Scope scope) {
|
// Provide a direct instance
|
||||||
// Provide a direct instance
|
Binding<String>().toInstance("Hello world");
|
||||||
bind<String>().toInstance("Hello world");
|
|
||||||
|
|
||||||
// Provide an async direct instance
|
// Provide an async direct instance
|
||||||
bind<String>().toInstanceAsync(Future.value("Hello world"));
|
Binding<String>().toInstanceAsync(Future.value("Hello world"));
|
||||||
|
|
||||||
// Provide a lazy sync instance using a factory
|
// Provide a lazy sync instance using a factory
|
||||||
bind<String>().toProvide(() => "Hello world");
|
Binding<String>().toProvide(() => "Hello world");
|
||||||
|
|
||||||
// Provide a lazy async instance using a factory
|
// Provide a lazy async instance using a factory
|
||||||
bind<String>().toProvideAsync(() async => "Hello async world");
|
Binding<String>().toProvideAsync(() async => "Hello async world");
|
||||||
|
|
||||||
// Provide an instance with dynamic parameters (sync)
|
// Provide an instance with dynamic parameters (sync)
|
||||||
bind<String>().toProvideWithParams((params) => "Hello $params");
|
Binding<String>().toProvideWithParams((params) => "Hello $params");
|
||||||
|
|
||||||
// Provide an instance with dynamic parameters (async)
|
// Provide an instance with dynamic parameters (async)
|
||||||
bind<String>().toProvideAsyncWithParams((params) async => "Hello $params");
|
Binding<String>().toProvideAsyncWithParams((params) async => "Hello $params");
|
||||||
|
|
||||||
// Named instance for retrieval by name
|
// Named instance for retrieval by name
|
||||||
bind<String>().toProvide(() => "Hello world").withName("my_string");
|
Binding<String>().toProvide(() => "Hello world").withName("my_string");
|
||||||
|
|
||||||
// Mark as singleton (only one instance within the scope)
|
// Mark as singleton (only one instance within the scope)
|
||||||
bind<String>().toProvide(() => "Hello world").singleton();
|
Binding<String>().toProvide(() => "Hello world").singleton();
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
> ⚠️ **Important note about using `toInstance` in Module `builder`:**
|
|
||||||
>
|
|
||||||
> If you register a chain of dependencies via `toInstance` inside a Module's `builder`, **do not** call `scope.resolve<T>()` for types that are also being registered in the same builder — at the moment they are registered.
|
|
||||||
>
|
|
||||||
> CherryPick initializes all bindings in the builder sequentially. Dependencies registered earlier are not yet available to `resolve` within the same builder execution. Trying to resolve just-registered types will result in an error (`Can't resolve dependency ...`).
|
|
||||||
>
|
|
||||||
> **How to do it right:**
|
|
||||||
> Manually construct the full dependency chain before calling `toInstance`:
|
|
||||||
>
|
|
||||||
> ```dart
|
|
||||||
> void builder(Scope scope) {
|
|
||||||
> final a = A();
|
|
||||||
> final b = B(a);
|
|
||||||
> final c = C(b);
|
|
||||||
> bind<A>().toInstance(a);
|
|
||||||
> bind<B>().toInstance(b);
|
|
||||||
> bind<C>().toInstance(c);
|
|
||||||
> }
|
|
||||||
> ```
|
|
||||||
>
|
|
||||||
> **Wrong:**
|
|
||||||
> ```dart
|
|
||||||
> void builder(Scope scope) {
|
|
||||||
> bind<A>().toInstance(A());
|
|
||||||
> // Error! At this point, A is not registered yet.
|
|
||||||
> bind<B>().toInstance(B(scope.resolve<A>()));
|
|
||||||
> }
|
|
||||||
> ```
|
|
||||||
>
|
|
||||||
> **Wrong:**
|
|
||||||
> ```dart
|
|
||||||
> void builder(Scope scope) {
|
|
||||||
> bind<A>().toProvide(() => A());
|
|
||||||
> // Error! At this point, A is not registered yet.
|
|
||||||
> bind<B>().toInstance(B(scope.resolve<A>()));
|
|
||||||
> }
|
|
||||||
> ```
|
|
||||||
>
|
|
||||||
> **Note:** This limitation applies **only** to `toInstance`. With `toProvide`/`toProvideAsync` and similar providers, you can safely use `scope.resolve<T>()` inside the builder.
|
|
||||||
|
|
||||||
|
|
||||||
> ⚠️ **Special note regarding `.singleton()` with `toProvideWithParams()` / `toProvideAsyncWithParams()`:**
|
|
||||||
>
|
|
||||||
> If you declare a binding using `.toProvideWithParams(...)` (or its async variant) and then chain `.singleton()`, only the **very first** `resolve<T>(params: ...)` will use its parameters; every subsequent call (regardless of params) will return the same (cached) instance.
|
|
||||||
>
|
|
||||||
> **Example:**
|
|
||||||
> ```dart
|
|
||||||
> bind<Service>().toProvideWithParams((params) => Service(params)).singleton();
|
|
||||||
> final a = scope.resolve<Service>(params: 1); // creates Service(1)
|
|
||||||
> final b = scope.resolve<Service>(params: 2); // returns Service(1)
|
|
||||||
> print(identical(a, b)); // true
|
|
||||||
> ```
|
|
||||||
>
|
|
||||||
> Use this pattern only when you want a “master” singleton. If you expect a new instance per params, **do not** use `.singleton()` on parameterized providers.
|
|
||||||
|
|
||||||
|
|
||||||
> ℹ️ **Note about `.singleton()` and `.toInstance()`:**
|
|
||||||
>
|
|
||||||
> Calling `.singleton()` after `.toInstance()` does **not** change the binding’s behavior: the object passed with `toInstance()` is already a single, constant instance that will be always returned for every resolve.
|
|
||||||
>
|
|
||||||
> It is not necessary to use `.singleton()` with an existing object—this call has no effect.
|
|
||||||
>
|
|
||||||
> `.singleton()` is only meaningful with providers (such as `toProvide`/`toProvideAsync`), to ensure only one instance is created by the factory.
|
|
||||||
|
|
||||||
|
|
||||||
### Module
|
### Module
|
||||||
|
|
||||||
A **Module** is a logical collection point for bindings, designed for grouping and initializing related dependencies. Implement the `builder` method to define how dependencies should be bound within the scope.
|
A **Module** is a logical collection point for bindings, designed for grouping and initializing related dependencies. Implement the `builder` method to define how dependencies should be bound within the scope.
|
||||||
@@ -235,67 +79,22 @@ final str = rootScope.resolve<String>();
|
|||||||
// Resolve a dependency asynchronously
|
// Resolve a dependency asynchronously
|
||||||
final result = await rootScope.resolveAsync<String>();
|
final result = await rootScope.resolveAsync<String>();
|
||||||
|
|
||||||
// Recommended: Close the root scope and release all resources
|
// Close the root scope once done
|
||||||
await CherryPick.closeRootScope();
|
CherryPick.closeRootScope();
|
||||||
|
|
||||||
// Alternatively, you may manually call dispose on any scope you manage individually
|
|
||||||
// await rootScope.dispose();
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
#### Working with Subscopes
|
||||||
|
|
||||||
### Disposable
|
|
||||||
|
|
||||||
CherryPick can automatically clean up any dependency that implements the `Disposable` interface. This makes resource management (for controllers, streams, sockets, files, etc.) easy and reliable—especially when scopes or the app are shut down.
|
|
||||||
|
|
||||||
If you bind an object implementing `Disposable` as a singleton or provide it via the DI container, CherryPick will call its `dispose()` method when the scope is closed or cleaned up.
|
|
||||||
|
|
||||||
#### Key Points
|
|
||||||
- Supports both synchronous and asynchronous cleanup (dispose may return `void` or `Future`).
|
|
||||||
- All `Disposable` instances from the current scope and subscopes will be disposed in the correct order.
|
|
||||||
- Prevents resource leaks and enforces robust cleanup.
|
|
||||||
- No manual wiring needed once your class implements `Disposable`.
|
|
||||||
|
|
||||||
#### Minimal Sync Example
|
|
||||||
```dart
|
```dart
|
||||||
class CacheManager implements Disposable {
|
// Open a named child scope (e.g., for a feature/module)
|
||||||
void dispose() {
|
final subScope = rootScope.openSubScope('featureScope')
|
||||||
cache.clear();
|
..installModules([FeatureModule()]);
|
||||||
print('CacheManager disposed!');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
final scope = CherryPick.openRootScope();
|
// Resolve from subScope, with fallback to parents if missing
|
||||||
scope.installModules([
|
final dataBloc = await subScope.resolveAsync<DataBloc>();
|
||||||
Module((bind) => bind<CacheManager>().toProvide(() => CacheManager()).singleton()),
|
|
||||||
]);
|
|
||||||
|
|
||||||
// ...later
|
|
||||||
await CherryPick.closeRootScope(); // prints: CacheManager disposed!
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Async Example
|
### Dependency Lookup API
|
||||||
```dart
|
|
||||||
class MyServiceWithSocket implements Disposable {
|
|
||||||
@override
|
|
||||||
Future<void> dispose() async {
|
|
||||||
await socket.close();
|
|
||||||
print('Socket closed!');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
scope.installModules([
|
|
||||||
Module((bind) => bind<MyServiceWithSocket>().toProvide(() => MyServiceWithSocket()).singleton()),
|
|
||||||
]);
|
|
||||||
|
|
||||||
await CherryPick.closeRootScope(); // awaits async disposal
|
|
||||||
```
|
|
||||||
|
|
||||||
**Tip:** Always call `await CherryPick.closeRootScope()` or `await scope.closeSubScope(key)` in your shutdown/teardown logic to ensure all resources are released automatically.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Dependency Resolution API
|
|
||||||
|
|
||||||
- `resolve<T>()` — Locates a dependency instance or throws if missing.
|
- `resolve<T>()` — Locates a dependency instance or throws if missing.
|
||||||
- `resolveAsync<T>()` — Async variant for dependencies requiring async binding.
|
- `resolveAsync<T>()` — Async variant for dependencies requiring async binding.
|
||||||
@@ -307,335 +106,6 @@ Supports:
|
|||||||
- Named dependencies
|
- Named dependencies
|
||||||
- Provider functions with and without runtime parameters
|
- Provider functions with and without runtime parameters
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Using Annotations & Code Generation
|
|
||||||
|
|
||||||
CherryPick provides best-in-class developer ergonomics and type safety through **Dart annotations** and code generation. This lets you dramatically reduce boilerplate: simply annotate your classes, fields, and modules, run the code generator, and enjoy auto-wired dependency injection!
|
|
||||||
|
|
||||||
### How It Works
|
|
||||||
|
|
||||||
1. **Annotate** your services, providers, and fields using `cherrypick_annotations`.
|
|
||||||
2. **Generate** code using `cherrypick_generator` with `build_runner`.
|
|
||||||
3. **Use** generated modules and mixins for fully automated DI (dependency injection).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Supported Annotations
|
|
||||||
|
|
||||||
| Annotation | Target | Description |
|
|
||||||
|-------------------|---------------|--------------------------------------------------------------------------------|
|
|
||||||
| `@injectable()` | class | Enables automatic field injection for this class (mixin will be generated) |
|
|
||||||
| `@inject()` | field | Field will be injected using DI (works with @injectable classes) |
|
|
||||||
| `@module()` | class | Declares a DI module; its methods can provide services/providers |
|
|
||||||
| `@provide` | method | Registers as a DI provider method (may have dependencies as parameters) |
|
|
||||||
| `@instance` | method/class | Registers an instance (new object on each resolution, i.e. factory) |
|
|
||||||
| `@singleton` | method/class | Registers as a singleton (one instance per scope) |
|
|
||||||
| `@named` | field/param | Use named instance (bind/resolve by name or apply to field/param) |
|
|
||||||
| `@scope` | field/param | Inject or resolve from a specific named scope |
|
|
||||||
| `@params` | param | Marks method parameter as filled by user-supplied runtime params at resolution |
|
|
||||||
|
|
||||||
You can easily **combine** these annotations for advanced scenarios!
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Field Injection Example
|
|
||||||
|
|
||||||
```dart
|
|
||||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
||||||
|
|
||||||
@injectable()
|
|
||||||
class ProfilePage with _\$ProfilePage {
|
|
||||||
@inject()
|
|
||||||
late final AuthService auth;
|
|
||||||
|
|
||||||
@inject()
|
|
||||||
@scope('profile')
|
|
||||||
late final ProfileManager manager;
|
|
||||||
|
|
||||||
@inject()
|
|
||||||
@named('admin')
|
|
||||||
late final UserService adminUserService;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- After running build_runner, the mixin `_ProfilePage` will be generated for field injection.
|
|
||||||
- Call `myProfilePage.injectFields();` or use the mixin's auto-inject feature, and all dependencies will be set up for you.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Module and Provider Example
|
|
||||||
|
|
||||||
```dart
|
|
||||||
@module()
|
|
||||||
abstract class AppModule {
|
|
||||||
@singleton
|
|
||||||
AuthService provideAuth(Api api) => AuthService(api);
|
|
||||||
|
|
||||||
@named('logging')
|
|
||||||
@provide
|
|
||||||
Future<Logger> provideLogger(@params Map<String, dynamic> args) async => ...;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- Mark class as `@module`, write provider methods.
|
|
||||||
- Use `@singleton`, `@named`, `@provide`, `@params` to control lifecycle, key names, and parameters.
|
|
||||||
- The generator will produce a class like `$AppModule` with the proper DI bindings.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Usage Steps
|
|
||||||
|
|
||||||
1. **Add to your pubspec.yaml**:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
dependencies:
|
|
||||||
cherrypick: any
|
|
||||||
cherrypick_annotations: any
|
|
||||||
|
|
||||||
dev_dependencies:
|
|
||||||
cherrypick_generator: any
|
|
||||||
build_runner: any
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Annotate** your classes and modules as above.
|
|
||||||
|
|
||||||
3. **Run code generation:**
|
|
||||||
|
|
||||||
```shell
|
|
||||||
dart run build_runner build --delete-conflicting-outputs
|
|
||||||
# or in Flutter:
|
|
||||||
flutter pub run build_runner build --delete-conflicting-outputs
|
|
||||||
```
|
|
||||||
|
|
||||||
4. **Register modules and use auto-injection:**
|
|
||||||
|
|
||||||
```dart
|
|
||||||
final scope = CherryPick.openRootScope()
|
|
||||||
..installModules([$AppModule()]);
|
|
||||||
|
|
||||||
final profile = ProfilePage();
|
|
||||||
profile.injectFields(); // injects all @inject fields
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Advanced: Parameters, Named Instances, and Scopes
|
|
||||||
|
|
||||||
- Use `@named` for key-based multi-implementation injection.
|
|
||||||
- Use `@scope` when dependencies live in a non-root scope.
|
|
||||||
- Use `@params` for runtime arguments passed during resolution.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Troubleshooting & Tips
|
|
||||||
|
|
||||||
- After modifying DI-related code, always re-run `build_runner`.
|
|
||||||
- Do not manually edit `.g.dart` files—let the generator manage them.
|
|
||||||
- Errors in annotation usage (e.g., using `@singleton` on wrong target) are shown at build time.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### References
|
|
||||||
|
|
||||||
- [Full annotation reference (en)](doc/annotations_en.md)
|
|
||||||
- [cherrypick_annotations/README.md](../cherrypick_annotations/README.md)
|
|
||||||
- [cherrypick_generator/README.md](../cherrypick_generator/README.md)
|
|
||||||
- See the [`examples/postly`](../examples/postly) for a full working DI+annotations app.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Advanced Features
|
|
||||||
|
|
||||||
### Hierarchical Subscopes
|
|
||||||
|
|
||||||
CherryPick supports a hierarchical structure of scopes, allowing you to create complex and modular dependency graphs for advanced application architectures. Each subscope inherits from its parent, enabling context-specific overrides while still allowing access to global or shared services.
|
|
||||||
|
|
||||||
#### Key Points
|
|
||||||
|
|
||||||
- **Subscopes** are child scopes that can be opened from any existing scope (including the root).
|
|
||||||
- Dependencies registered in a subscope override those from parent scopes when resolved.
|
|
||||||
- If a dependency is not found in the current subscope, the resolution process automatically searches parent scopes up the hierarchy.
|
|
||||||
- Subscopes can have their own modules, lifetime, and disposable objects.
|
|
||||||
- You can nest subscopes to any depth, modeling features, flows, or components independently.
|
|
||||||
|
|
||||||
#### Example
|
|
||||||
|
|
||||||
```dart
|
|
||||||
final rootScope = CherryPick.openRootScope();
|
|
||||||
rootScope.installModules([AppModule()]);
|
|
||||||
|
|
||||||
// Open a hierarchical subscope for a feature or page
|
|
||||||
final userFeatureScope = rootScope.openSubScope('userFeature');
|
|
||||||
userFeatureScope.installModules([UserFeatureModule()]);
|
|
||||||
|
|
||||||
// Dependencies defined in UserFeatureModule will take precedence
|
|
||||||
final userService = userFeatureScope.resolve<UserService>();
|
|
||||||
|
|
||||||
// If not found in the subscope, lookup continues in the parent (rootScope)
|
|
||||||
final sharedService = userFeatureScope.resolve<SharedService>();
|
|
||||||
|
|
||||||
// You can nest subscopes
|
|
||||||
final dialogScope = userFeatureScope.openSubScope('dialog');
|
|
||||||
dialogScope.installModules([DialogModule()]);
|
|
||||||
final dialogManager = dialogScope.resolve<DialogManager>();
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Use Cases
|
|
||||||
|
|
||||||
- Isolate feature modules, flows, or screens with their own dependencies.
|
|
||||||
- Provide and override services for specific navigation stacks or platform-specific branches.
|
|
||||||
- Manage the lifetime and disposal of groups of dependencies independently (e.g., per-user, per-session, per-component).
|
|
||||||
|
|
||||||
**Tip:** Always close subscopes when they are no longer needed to release resources and trigger cleanup of Disposable dependencies.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Logging
|
|
||||||
|
|
||||||
CherryPick lets you log all dependency injection (DI) events and errors using a flexible observer mechanism.
|
|
||||||
|
|
||||||
#### Custom Observers
|
|
||||||
|
|
||||||
You can pass any implementation of `CherryPickObserver` to your root scope or any sub-scope.
|
|
||||||
This allows centralized and extensible logging, which you can direct to print, files, visualization frameworks, external loggers, or systems like [Talker](https://pub.dev/packages/talker).
|
|
||||||
|
|
||||||
##### Example: Printing All Events
|
|
||||||
|
|
||||||
```dart
|
|
||||||
import 'package:cherrypick/cherrypick.dart';
|
|
||||||
|
|
||||||
void main() {
|
|
||||||
// Use the built-in PrintCherryPickObserver for console logs
|
|
||||||
final observer = PrintCherryPickObserver();
|
|
||||||
final scope = CherryPick.openRootScope(observer: observer);
|
|
||||||
// All DI actions and errors will now be printed!
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### Example: Advanced Logging with Talker
|
|
||||||
|
|
||||||
For richer logging, analytics, or UI overlays, use an advanced observer such as [talker_cherrypick_logger](../talker_cherrypick_logger):
|
|
||||||
|
|
||||||
```dart
|
|
||||||
import 'package:cherrypick/cherrypick.dart';
|
|
||||||
import 'package:talker/talker.dart';
|
|
||||||
import 'package:talker_cherrypick_logger/talker_cherrypick_logger.dart';
|
|
||||||
|
|
||||||
void main() {
|
|
||||||
final talker = Talker();
|
|
||||||
final observer = TalkerCherryPickObserver(talker);
|
|
||||||
CherryPick.openRootScope(observer: observer);
|
|
||||||
// All container events go to the Talker log system!
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Default Behavior
|
|
||||||
|
|
||||||
- By default, logging is silent (`SilentCherryPickObserver`) for production, with no output unless you supply an observer.
|
|
||||||
- You can configure observers **per scope** for isolated, test-specific, or feature-specific logging.
|
|
||||||
|
|
||||||
#### Observer Capabilities
|
|
||||||
|
|
||||||
Events you can observe and log:
|
|
||||||
- Dependency registration
|
|
||||||
- Instance requests, creations, disposals
|
|
||||||
- Module installs/removals
|
|
||||||
- Scope opening/closing
|
|
||||||
- Cache hits/misses
|
|
||||||
- Cycle detection
|
|
||||||
- Diagnostics, warnings, errors
|
|
||||||
|
|
||||||
Just implement or extend `CherryPickObserver` and direct messages anywhere you want!
|
|
||||||
|
|
||||||
#### When to Use
|
|
||||||
|
|
||||||
- Enable verbose logging and debugging in development or test builds.
|
|
||||||
- Route logs to your main log system or analytics.
|
|
||||||
- Hook into DI lifecycle for profiling or monitoring.
|
|
||||||
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### 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)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Performance Improvements
|
|
||||||
|
|
||||||
> **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.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Example Application
|
## Example Application
|
||||||
|
|
||||||
Below is a complete example illustrating modules, subscopes, async providers, and dependency resolution.
|
Below is a complete example illustrating modules, subscopes, async providers, and dependency resolution.
|
||||||
@@ -757,60 +227,102 @@ class ApiClientImpl implements ApiClient {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
## Features
|
||||||
|
|
||||||
## FAQ
|
- [x] Main Scope and Named Subscopes
|
||||||
|
- [x] Named Instance Binding and Resolution
|
||||||
|
- [x] Asynchronous and Synchronous Providers
|
||||||
|
- [x] Providers Supporting Runtime Parameters
|
||||||
|
- [x] Singleton Lifecycle Management
|
||||||
|
- [x] Modular and Hierarchical Composition
|
||||||
|
- [x] Null-safe Resolution (tryResolve/tryResolveAsync)
|
||||||
|
- [x] Circular Dependency Detection (Local and Global)
|
||||||
|
|
||||||
### Q: Do I need to use `await` with CherryPick.closeRootScope(), CherryPick.closeScope(), or scope.dispose() if I have no Disposable services?
|
## Quick Guide: Circular Dependency Detection
|
||||||
|
|
||||||
**A:**
|
CherryPick can detect circular dependencies in your DI configuration, helping you avoid infinite loops and hard-to-debug errors.
|
||||||
Yes! Even if none of your services currently implement `Disposable`, always use `await` when closing scopes. If you later add resource cleanup (by implementing `dispose()`), CherryPick will handle it automatically without you needing to change your scope cleanup code. This ensures resource management is future-proof, robust, and covers all application scenarios.
|
|
||||||
|
|
||||||
---
|
**How to use:**
|
||||||
|
|
||||||
## Documentation Links
|
### 1. Enable Cycle Detection for Development
|
||||||
|
|
||||||
* Circular Dependency Detection [(En)](doc/cycle_detection.en.md)[(Ru)](doc/cycle_detection.ru.md)
|
**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();
|
||||||
|
```
|
||||||
|
|
||||||
## Additional Modules
|
### 2. Error Example
|
||||||
|
|
||||||
CherryPick provides a set of official add-on modules for advanced use cases and specific platforms:
|
If you declare mutually dependent services:
|
||||||
|
```dart
|
||||||
|
class A { A(B b); }
|
||||||
|
class B { B(A a); }
|
||||||
|
|
||||||
| Module name | Description |
|
scope.installModules([
|
||||||
|-------------|-------------|
|
Module((bind) {
|
||||||
| [**cherrypick_annotations**](https://pub.dev/packages/cherrypick_annotations) | Dart annotations for concise DI definitions and code generation. |
|
bind<A>().to((s) => A(s.resolve<B>()));
|
||||||
| [**cherrypick_generator**](https://pub.dev/packages/cherrypick_generator) | Code generator to produce DI bindings based on annotations. |
|
bind<B>().to((s) => B(s.resolve<A>()));
|
||||||
| [**cherrypick_flutter**](https://pub.dev/packages/cherrypick_flutter) | Flutter integration: DI provider widgets and helpers for Flutter. |
|
}),
|
||||||
| [**talker_cherrypick_logger**](https://pub.dev/packages/talker_cherrypick_logger) | Advanced logger for CherryPick DI events and state. Provides seamless integration with [Talker](https://pub.dev/packages/talker) logger, enabling central and visual tracking of DI events, errors, and diagnostics in both UI and console. |
|
]);
|
||||||
|
|
||||||
---
|
scope.resolve<A>(); // Throws CircularDependencyException
|
||||||
|
```
|
||||||
|
|
||||||
## Contributors
|
### 3. Typical Usage Pattern
|
||||||
|
|
||||||
- [Sergey Penkovsky](https://github.com/pese-git)
|
- **Always enable detection** in debug and test environments for maximum safety.
|
||||||
- [Klim Yaroshevich](https://github.com/KlimYarosh)
|
- **Disable detection** in production for performance (after code is tested).
|
||||||
- [Alexey Popkov](https://github.com/AlexeyYuPopkov)
|
|
||||||
|
|
||||||
---
|
```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
|
||||||
|
|
||||||
Contributions are welcome! Please open issues or submit pull requests on [GitHub](https://github.com/pese-git/cherrypick).
|
Contributions are welcome! Please open issues or submit pull requests on [GitHub](https://github.com/pese-git/cherrypick).
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
|
Licensed under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Important:** Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for specific language governing permissions and limitations under the License.
|
**Important:** Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for specific language governing permissions and limitations under the License.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [GitHub Repository](https://github.com/pese-git/cherrypick)
|
- [GitHub Repository](https://github.com/pese-git/cherrypick)
|
||||||
|
|||||||
@@ -17,28 +17,19 @@ 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>()
|
bind<DataRepository>().withName("networkRepo").toProvideAsync(() async {
|
||||||
.withName("networkRepo")
|
|
||||||
.toProvideWithParams((params) async {
|
|
||||||
print('REPO PARAMS: $params');
|
|
||||||
|
|
||||||
final client = await Future.delayed(
|
final client = await Future.delayed(
|
||||||
Duration(milliseconds: 1000),
|
Duration(milliseconds: 100),
|
||||||
() => 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>().toProvide(
|
bind<DataBloc>().toProvideAsync(
|
||||||
() 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);
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
@@ -47,7 +38,9 @@ class FeatureModule extends Module {
|
|||||||
|
|
||||||
Future<void> main() async {
|
Future<void> main() async {
|
||||||
try {
|
try {
|
||||||
final scope = CherryPick.openRootScope().installModules([AppModule()]);
|
final scope = openRootScope().installModules([
|
||||||
|
AppModule(),
|
||||||
|
]);
|
||||||
|
|
||||||
final subScope = scope
|
final subScope = scope
|
||||||
.openSubScope("featureScope")
|
.openSubScope("featureScope")
|
||||||
@@ -55,11 +48,8 @@ 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(
|
dataBloc.data.listen((d) => print('Received data: $d'),
|
||||||
(d) => print('Received data: $d'),
|
onError: (e) => print('Error: $e'), onDone: () => print('DONE'));
|
||||||
onError: (e) => print('Error: $e'),
|
|
||||||
onDone: () => print('DONE'),
|
|
||||||
);
|
|
||||||
|
|
||||||
await dataBloc.fetchData();
|
await dataBloc.fetchData();
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
|
|||||||
@@ -36,16 +36,18 @@ class DatabaseModule extends Module {
|
|||||||
class ApiModule extends Module {
|
class ApiModule extends Module {
|
||||||
@override
|
@override
|
||||||
void builder(Scope currentScope) {
|
void builder(Scope currentScope) {
|
||||||
bind<ApiService>()
|
bind<ApiService>().toProvide(() => ApiService(
|
||||||
.toProvide(() => ApiService(currentScope.resolve<DatabaseService>()));
|
currentScope.resolve<DatabaseService>()
|
||||||
|
));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class UserModule extends Module {
|
class UserModule extends Module {
|
||||||
@override
|
@override
|
||||||
void builder(Scope currentScope) {
|
void builder(Scope currentScope) {
|
||||||
bind<UserService>()
|
bind<UserService>().toProvide(() => UserService(
|
||||||
.toProvide(() => UserService(currentScope.resolve<ApiService>()));
|
currentScope.resolve<ApiService>()
|
||||||
|
));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -63,16 +65,18 @@ class CircularServiceB {
|
|||||||
class CircularModuleA extends Module {
|
class CircularModuleA extends Module {
|
||||||
@override
|
@override
|
||||||
void builder(Scope currentScope) {
|
void builder(Scope currentScope) {
|
||||||
bind<CircularServiceA>().toProvide(
|
bind<CircularServiceA>().toProvide(() => CircularServiceA(
|
||||||
() => CircularServiceA(currentScope.resolve<CircularServiceB>()));
|
currentScope.resolve<CircularServiceB>()
|
||||||
|
));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class CircularModuleB extends Module {
|
class CircularModuleB extends Module {
|
||||||
@override
|
@override
|
||||||
void builder(Scope currentScope) {
|
void builder(Scope currentScope) {
|
||||||
bind<CircularServiceB>().toProvide(
|
bind<CircularServiceB>().toProvide(() => CircularServiceB(
|
||||||
() => CircularServiceB(currentScope.resolve<CircularServiceA>()));
|
currentScope.resolve<CircularServiceA>()
|
||||||
|
));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -83,13 +87,11 @@ void main() {
|
|||||||
print('1. Globally enable cycle detection:');
|
print('1. Globally enable cycle detection:');
|
||||||
|
|
||||||
CherryPick.enableGlobalCycleDetection();
|
CherryPick.enableGlobalCycleDetection();
|
||||||
print(
|
print('✅ Global cycle detection enabled: ${CherryPick.isGlobalCycleDetectionEnabled}');
|
||||||
'✅ Global cycle detection enabled: ${CherryPick.isGlobalCycleDetectionEnabled}');
|
|
||||||
|
|
||||||
// All new scopes will automatically have cycle detection enabled
|
// All new scopes will automatically have cycle detection enabled
|
||||||
final globalScope = CherryPick.openRootScope();
|
final globalScope = CherryPick.openRootScope();
|
||||||
print(
|
print('✅ Root scope has cycle detection enabled: ${globalScope.isCycleDetectionEnabled}');
|
||||||
'✅ Root scope has cycle detection enabled: ${globalScope.isCycleDetectionEnabled}');
|
|
||||||
|
|
||||||
// Install modules without circular dependencies
|
// Install modules without circular dependencies
|
||||||
globalScope.installModules([
|
globalScope.installModules([
|
||||||
@@ -110,8 +112,7 @@ void main() {
|
|||||||
|
|
||||||
// Создаем безопасный скоуп (с автоматически включенным обнаружением)
|
// Создаем безопасный скоуп (с автоматически включенным обнаружением)
|
||||||
final safeScope = CherryPick.openSafeRootScope();
|
final safeScope = CherryPick.openSafeRootScope();
|
||||||
print(
|
print('✅ Safe scope created with cycle detection: ${safeScope.isCycleDetectionEnabled}');
|
||||||
'✅ Safe scope created with cycle detection: ${safeScope.isCycleDetectionEnabled}');
|
|
||||||
|
|
||||||
safeScope.installModules([
|
safeScope.installModules([
|
||||||
DatabaseModule(),
|
DatabaseModule(),
|
||||||
@@ -152,37 +153,30 @@ void main() {
|
|||||||
// Создаем скоуп без обнаружения
|
// Создаем скоуп без обнаружения
|
||||||
// ignore: unused_local_variable
|
// ignore: unused_local_variable
|
||||||
final specificScope = CherryPick.openRootScope();
|
final specificScope = CherryPick.openRootScope();
|
||||||
print(
|
print(' Detection in root scope: ${CherryPick.isCycleDetectionEnabledForScope()}');
|
||||||
' Detection in root scope: ${CherryPick.isCycleDetectionEnabledForScope()}');
|
|
||||||
|
|
||||||
// Включаем обнаружение для конкретного скоупа
|
// Включаем обнаружение для конкретного скоупа
|
||||||
CherryPick.enableCycleDetectionForScope();
|
CherryPick.enableCycleDetectionForScope();
|
||||||
print(
|
print('✅ Detection enabled for root scope: ${CherryPick.isCycleDetectionEnabledForScope()}');
|
||||||
'✅ Detection enabled for root scope: ${CherryPick.isCycleDetectionEnabledForScope()}');
|
|
||||||
|
|
||||||
// Создаем дочерний скоуп
|
// Создаем дочерний скоуп
|
||||||
// ignore: unused_local_variable
|
// ignore: unused_local_variable
|
||||||
final featureScope = CherryPick.openScope(scopeName: 'feature.auth');
|
final featureScope = CherryPick.openScope(scopeName: 'feature.auth');
|
||||||
print(
|
print(' Detection in feature.auth scope: ${CherryPick.isCycleDetectionEnabledForScope(scopeName: 'feature.auth')}');
|
||||||
' Detection in feature.auth scope: ${CherryPick.isCycleDetectionEnabledForScope(scopeName: 'feature.auth')}');
|
|
||||||
|
|
||||||
// Включаем обнаружение для дочернего скоупа
|
// Включаем обнаружение для дочернего скоупа
|
||||||
CherryPick.enableCycleDetectionForScope(scopeName: 'feature.auth');
|
CherryPick.enableCycleDetectionForScope(scopeName: 'feature.auth');
|
||||||
print(
|
print('✅ Detection enabled for feature.auth scope: ${CherryPick.isCycleDetectionEnabledForScope(scopeName: 'feature.auth')}');
|
||||||
'✅ Detection enabled for feature.auth scope: ${CherryPick.isCycleDetectionEnabledForScope(scopeName: 'feature.auth')}');
|
|
||||||
print('');
|
print('');
|
||||||
|
|
||||||
// Example 5: Creating safe child scopes
|
// Example 5: Creating safe child scopes
|
||||||
print('5. Creating safe child scopes:');
|
print('5. Creating safe child scopes:');
|
||||||
|
|
||||||
final safeFeatureScope =
|
final safeFeatureScope = CherryPick.openSafeScope(scopeName: 'feature.payments');
|
||||||
CherryPick.openSafeScope(scopeName: 'feature.payments');
|
print('✅ Safe feature scope created: ${safeFeatureScope.isCycleDetectionEnabled}');
|
||||||
print(
|
|
||||||
'✅ Safe feature scope created: ${safeFeatureScope.isCycleDetectionEnabled}');
|
|
||||||
|
|
||||||
// You can create a complex hierarchy of scopes
|
// You can create a complex hierarchy of scopes
|
||||||
final complexScope =
|
final complexScope = CherryPick.openSafeScope(scopeName: 'app.feature.auth.login');
|
||||||
CherryPick.openSafeScope(scopeName: 'app.feature.auth.login');
|
|
||||||
print('✅ Complex scope created: ${complexScope.isCycleDetectionEnabled}');
|
print('✅ Complex scope created: ${complexScope.isCycleDetectionEnabled}');
|
||||||
print('');
|
print('');
|
||||||
|
|
||||||
@@ -215,8 +209,7 @@ void main() {
|
|||||||
print('');
|
print('');
|
||||||
|
|
||||||
print('🚀 Production mode:');
|
print('🚀 Production mode:');
|
||||||
print(
|
print(' CherryPick.disableGlobalCycleDetection(); // Disable for performance');
|
||||||
' CherryPick.disableGlobalCycleDetection(); // Disable for performance');
|
|
||||||
print(' final scope = CherryPick.openRootScope(); // Regular scope');
|
print(' final scope = CherryPick.openRootScope(); // Regular scope');
|
||||||
print('');
|
print('');
|
||||||
|
|
||||||
@@ -226,8 +219,7 @@ void main() {
|
|||||||
print('');
|
print('');
|
||||||
|
|
||||||
print('🎯 Feature-specific:');
|
print('🎯 Feature-specific:');
|
||||||
print(
|
print(' CherryPick.enableCycleDetectionForScope(scopeName: "feature.critical");');
|
||||||
' CherryPick.enableCycleDetectionForScope(scopeName: "feature.critical");');
|
|
||||||
print(' // Enable only for critical features');
|
print(' // Enable only for critical features');
|
||||||
|
|
||||||
// Cleanup
|
// Cleanup
|
||||||
|
|||||||
@@ -1,37 +0,0 @@
|
|||||||
import 'package:cherrypick/cherrypick.dart';
|
|
||||||
|
|
||||||
/// Example of a simple service class.
|
|
||||||
class UserRepository {
|
|
||||||
String getUserName() => 'Sergey DI';
|
|
||||||
}
|
|
||||||
|
|
||||||
/// DI module for registering dependencies.
|
|
||||||
class AppModule extends Module {
|
|
||||||
@override
|
|
||||||
void builder(Scope currentScope) {
|
|
||||||
bind<UserRepository>().toInstance(UserRepository());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void main() {
|
|
||||||
// Set a global logger for the DI system
|
|
||||||
CherryPick.setGlobalObserver(PrintCherryPickObserver());
|
|
||||||
|
|
||||||
// Open the root scope
|
|
||||||
final rootScope = CherryPick.openRootScope();
|
|
||||||
|
|
||||||
// Register the DI module
|
|
||||||
rootScope.installModules([AppModule()]);
|
|
||||||
|
|
||||||
// Resolve a dependency (service)
|
|
||||||
final repo = rootScope.resolve<UserRepository>();
|
|
||||||
print('User: ${repo.getUserName()}');
|
|
||||||
|
|
||||||
// Work with a sub-scope (create/close)
|
|
||||||
final subScope = rootScope.openSubScope('feature.profile');
|
|
||||||
subScope.closeSubScope('feature.profile');
|
|
||||||
|
|
||||||
// Demonstrate disabling and re-enabling logging
|
|
||||||
CherryPick.setGlobalObserver(SilentCherryPickObserver());
|
|
||||||
rootScope.resolve<UserRepository>(); // now without logs
|
|
||||||
}
|
|
||||||
@@ -29,16 +29,18 @@ class OrderService {
|
|||||||
class UserModule extends Module {
|
class UserModule extends Module {
|
||||||
@override
|
@override
|
||||||
void builder(Scope currentScope) {
|
void builder(Scope currentScope) {
|
||||||
bind<UserService>()
|
bind<UserService>().toProvide(() => UserService(
|
||||||
.toProvide(() => UserService(currentScope.resolve<OrderService>()));
|
currentScope.resolve<OrderService>()
|
||||||
|
));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class OrderModule extends Module {
|
class OrderModule extends Module {
|
||||||
@override
|
@override
|
||||||
void builder(Scope currentScope) {
|
void builder(Scope currentScope) {
|
||||||
bind<OrderService>()
|
bind<OrderService>().toProvide(() => OrderService(
|
||||||
.toProvide(() => OrderService(currentScope.resolve<UserService>()));
|
currentScope.resolve<UserService>()
|
||||||
|
));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -101,8 +103,9 @@ class ImprovedUserModule extends Module {
|
|||||||
@override
|
@override
|
||||||
void builder(Scope currentScope) {
|
void builder(Scope currentScope) {
|
||||||
bind<UserRepository>().singleton().toProvide(() => UserRepository());
|
bind<UserRepository>().singleton().toProvide(() => UserRepository());
|
||||||
bind<ImprovedUserService>().toProvide(
|
bind<ImprovedUserService>().toProvide(() => ImprovedUserService(
|
||||||
() => ImprovedUserService(currentScope.resolve<UserRepository>()));
|
currentScope.resolve<UserRepository>()
|
||||||
|
));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -112,7 +115,8 @@ class ImprovedOrderModule extends Module {
|
|||||||
bind<OrderRepository>().singleton().toProvide(() => OrderRepository());
|
bind<OrderRepository>().singleton().toProvide(() => OrderRepository());
|
||||||
bind<ImprovedOrderService>().toProvide(() => ImprovedOrderService(
|
bind<ImprovedOrderService>().toProvide(() => ImprovedOrderService(
|
||||||
currentScope.resolve<OrderRepository>(),
|
currentScope.resolve<OrderRepository>(),
|
||||||
currentScope.resolve<ImprovedUserService>()));
|
currentScope.resolve<ImprovedUserService>()
|
||||||
|
));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -122,9 +126,8 @@ void main() {
|
|||||||
// Example 1: Demonstrate circular dependency
|
// Example 1: Demonstrate circular dependency
|
||||||
print('1. Attempt to create a scope with circular dependencies:');
|
print('1. Attempt to create a scope with circular dependencies:');
|
||||||
try {
|
try {
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = Scope(null);
|
||||||
scope
|
scope.enableCycleDetection(); // Включаем обнаружение циклических зависимостей
|
||||||
.enableCycleDetection(); // Включаем обнаружение циклических зависимостей
|
|
||||||
|
|
||||||
scope.installModules([
|
scope.installModules([
|
||||||
UserModule(),
|
UserModule(),
|
||||||
@@ -141,9 +144,7 @@ void main() {
|
|||||||
// Example 2: Without circular dependency detection (dangerous!)
|
// Example 2: Without circular dependency detection (dangerous!)
|
||||||
print('2. Same code without circular dependency detection:');
|
print('2. Same code without circular dependency detection:');
|
||||||
try {
|
try {
|
||||||
CherryPick.disableGlobalCrossScopeCycleDetection();
|
final scope = Scope(null);
|
||||||
CherryPick.disableGlobalCycleDetection();
|
|
||||||
final scope = CherryPick.openRootScope();
|
|
||||||
// НЕ включаем обнаружение циклических зависимостей
|
// НЕ включаем обнаружение циклических зависимостей
|
||||||
|
|
||||||
scope.installModules([
|
scope.installModules([
|
||||||
@@ -165,7 +166,7 @@ void main() {
|
|||||||
// Example 3: Correct architecture without circular dependencies
|
// Example 3: Correct architecture without circular dependencies
|
||||||
print('3. Correct architecture without circular dependencies:');
|
print('3. Correct architecture without circular dependencies:');
|
||||||
try {
|
try {
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = Scope(null);
|
||||||
scope.enableCycleDetection(); // Включаем для безопасности
|
scope.enableCycleDetection(); // Включаем для безопасности
|
||||||
|
|
||||||
scope.installModules([
|
scope.installModules([
|
||||||
@@ -183,6 +184,7 @@ void main() {
|
|||||||
orderService.createOrder('ORD-001', 'John');
|
orderService.createOrder('ORD-001', 'John');
|
||||||
final orders = orderService.getOrdersForUser('John');
|
final orders = orderService.getOrdersForUser('John');
|
||||||
print('✅ Orders for user John: $orders');
|
print('✅ Orders for user John: $orders');
|
||||||
|
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
print('❌ Error: $e');
|
print('❌ Error: $e');
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,40 +0,0 @@
|
|||||||
import 'package:cherrypick/cherrypick.dart';
|
|
||||||
|
|
||||||
/// Ваш сервис с освобождением ресурсов
|
|
||||||
class MyService implements Disposable {
|
|
||||||
bool wasDisposed = false;
|
|
||||||
|
|
||||||
@override
|
|
||||||
void dispose() {
|
|
||||||
// Например: закрыть соединение, остановить таймер, освободить память
|
|
||||||
wasDisposed = true;
|
|
||||||
print('MyService disposed!');
|
|
||||||
}
|
|
||||||
|
|
||||||
void doSomething() => print('Doing something...');
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Пример модуля CherryPick
|
|
||||||
class ModuleImpl extends Module {
|
|
||||||
@override
|
|
||||||
void builder(Scope scope) {
|
|
||||||
bind<MyService>().toProvide(() => MyService()).singleton();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void main() {
|
|
||||||
final scope = CherryPick.openRootScope();
|
|
||||||
|
|
||||||
// Регистрируем биндинг (singleton для примера)
|
|
||||||
scope.installModules([
|
|
||||||
ModuleImpl(),
|
|
||||||
]);
|
|
||||||
|
|
||||||
// Получаем зависимость
|
|
||||||
final service = scope.resolve<MyService>();
|
|
||||||
service.doSomething(); // «Doing something...»
|
|
||||||
|
|
||||||
// Освобождаем все ресурсы
|
|
||||||
scope.dispose();
|
|
||||||
print('Service wasDisposed = ${service.wasDisposed}'); // true
|
|
||||||
}
|
|
||||||
@@ -5,7 +5,7 @@ library;
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -13,12 +13,9 @@ 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/cycle_detector.dart';
|
||||||
export 'package:cherrypick/src/global_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';
|
||||||
export 'package:cherrypick/src/disposable.dart';
|
|
||||||
export 'package:cherrypick/src/observer.dart';
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -11,333 +11,180 @@
|
|||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
//
|
//
|
||||||
|
|
||||||
import 'package:cherrypick/src/binding_resolver.dart';
|
enum Mode { simple, instance, providerInstance, providerInstanceWithParams }
|
||||||
|
|
||||||
/// {@template binding_docs}
|
typedef Provider<T> = T? Function();
|
||||||
/// [Binding] configures how a dependency of type [T] is created, provided, or managed in CherryPick DI.
|
|
||||||
///
|
|
||||||
/// A [Binding] can:
|
|
||||||
/// - Register a direct instance
|
|
||||||
/// - Register a provider (sync/async)
|
|
||||||
/// - Register a provider supporting dynamic params
|
|
||||||
/// - Be named (for multi-implementation/keyed injection)
|
|
||||||
/// - Be marked as [singleton] (single instance within scope)
|
|
||||||
///
|
|
||||||
/// ### Examples
|
|
||||||
///
|
|
||||||
/// Register a direct instance:
|
|
||||||
/// ```dart
|
|
||||||
/// bind<String>().toInstance("Hello, world!");
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Register via sync provider:
|
|
||||||
/// ```dart
|
|
||||||
/// bind<MyService>().toProvide(() => MyService());
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Register via async provider (returns Future):
|
|
||||||
/// ```dart
|
|
||||||
/// bind<MyApi>().toProvide(() async => await MyApi.connect());
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Register provider with dynamic params:
|
|
||||||
/// ```dart
|
|
||||||
/// bind<User>().toProvideWithParams((params) => User(name: params["name"]));
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Register with name/key:
|
|
||||||
/// ```dart
|
|
||||||
/// bind<Client>().withName("mock").toInstance(MockClient());
|
|
||||||
/// bind<Client>().withName("prod").toInstance(RealClient());
|
|
||||||
/// final c = scope.resolve<Client>(named: "mock");
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Singleton (same instance reused):
|
|
||||||
/// ```dart
|
|
||||||
/// bind<Database>().toProvide(() => Database()).singleton();
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// {@endtemplate}
|
|
||||||
|
|
||||||
import 'package:cherrypick/src/observer.dart';
|
typedef ProviderWithParams<T> = T Function(dynamic params);
|
||||||
|
|
||||||
|
typedef AsyncProvider<T> = Future<T> Function();
|
||||||
|
|
||||||
|
typedef AsyncProviderWithParams<T> = Future<T> Function(dynamic params);
|
||||||
|
|
||||||
|
/// RU: Класс Binding<T> настраивает параметры экземпляра.
|
||||||
|
/// 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;
|
||||||
String? _name;
|
late String _name;
|
||||||
|
T? _instance;
|
||||||
|
Future<T>? _instanceAsync;
|
||||||
|
Provider<T>? _provider;
|
||||||
|
ProviderWithParams<T>? _providerWithParams;
|
||||||
|
|
||||||
BindingResolver<T>? _resolver;
|
AsyncProvider<T>? asyncProvider;
|
||||||
|
AsyncProviderWithParams<T>? asyncProviderWithParams;
|
||||||
|
|
||||||
CherryPickObserver? observer;
|
late bool _isSingleton = false;
|
||||||
|
late bool _isNamed = false;
|
||||||
|
|
||||||
// Deferred logging flags
|
Binding() {
|
||||||
bool _createdLogged = false;
|
_mode = Mode.simple;
|
||||||
bool _namedLogged = false;
|
|
||||||
bool _singletonLogged = false;
|
|
||||||
|
|
||||||
Binding({this.observer}) {
|
|
||||||
_key = T;
|
_key = T;
|
||||||
// Deferred уведомения observer, не логировать здесь напрямую
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void markCreated() {
|
/// RU: Метод возвращает [Mode] экземпляра.
|
||||||
if (!_createdLogged) {
|
/// ENG: The method returns the [Mode] of the instance.
|
||||||
observer?.onBindingRegistered(
|
|
||||||
runtimeType.toString(),
|
|
||||||
T,
|
|
||||||
);
|
|
||||||
_createdLogged = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void markNamed() {
|
|
||||||
if (isNamed && !_namedLogged) {
|
|
||||||
observer?.onDiagnostic(
|
|
||||||
'Binding named: ${T.toString()} name: $_name',
|
|
||||||
details: {
|
|
||||||
'type': 'Binding',
|
|
||||||
'name': T.toString(),
|
|
||||||
'nameParam': _name,
|
|
||||||
'description': 'named',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
_namedLogged = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void markSingleton() {
|
|
||||||
if (isSingleton && !_singletonLogged) {
|
|
||||||
observer?.onDiagnostic(
|
|
||||||
'Binding singleton: ${T.toString()}${_name != null ? ' name: $_name' : ''}',
|
|
||||||
details: {
|
|
||||||
'type': 'Binding',
|
|
||||||
'name': T.toString(),
|
|
||||||
if (_name != null) 'name': _name,
|
|
||||||
'description': 'singleton mode enabled',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
_singletonLogged = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void logAllDeferred() {
|
|
||||||
markCreated();
|
|
||||||
markNamed();
|
|
||||||
markSingleton();
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Returns the type key used by this binding.
|
|
||||||
///
|
///
|
||||||
/// Usually you don't need to access it directly.
|
/// return [Mode]
|
||||||
|
Mode get mode => _mode;
|
||||||
|
|
||||||
|
/// RU: Метод возвращает тип экземпляра.
|
||||||
|
/// ENG: The method returns the type of the instance.
|
||||||
|
///
|
||||||
|
/// return [Type]
|
||||||
Type get key => _key;
|
Type get key => _key;
|
||||||
|
|
||||||
/// Returns the name (if any) for this binding.
|
/// RU: Метод возвращает имя экземпляра.
|
||||||
/// Useful for named/multi-implementation resolution.
|
/// ENG: The method returns the name of the instance.
|
||||||
String? get name => _name;
|
|
||||||
|
|
||||||
/// Returns true if this binding is named (named/keyed binding).
|
|
||||||
bool get isNamed => _name != null;
|
|
||||||
|
|
||||||
/// Returns true if this binding is marked as a singleton.
|
|
||||||
/// Singleton bindings will only create one instance within the scope.
|
|
||||||
bool get isSingleton => _resolver?.isSingleton ?? false;
|
|
||||||
|
|
||||||
BindingResolver<T>? get resolver => _resolver;
|
|
||||||
|
|
||||||
/// Adds a name/key to this binding (for multi-implementation or keyed injection).
|
|
||||||
///
|
///
|
||||||
/// Example:
|
/// return [String]
|
||||||
/// ```dart
|
String get name => _name;
|
||||||
/// bind<Client>().withName("mock").toInstance(MockClient());
|
|
||||||
/// ```
|
/// RU: Метод проверяет сингелтон экземпляр или нет.
|
||||||
|
/// ENG: The method checks the singleton instance or not.
|
||||||
|
///
|
||||||
|
/// return [bool]
|
||||||
|
bool get isSingleton => _isSingleton;
|
||||||
|
|
||||||
|
/// RU: Метод проверяет именован экземпляр или нет.
|
||||||
|
/// ENG: The method checks whether the instance is named or not.
|
||||||
|
///
|
||||||
|
/// return [bool]
|
||||||
|
bool get isNamed => _isNamed;
|
||||||
|
|
||||||
|
/// RU: Добавляет имя для экземляпя [value].
|
||||||
|
/// ENG: Added name for instance [value].
|
||||||
|
///
|
||||||
|
/// return [Binding]
|
||||||
Binding<T> withName(String name) {
|
Binding<T> withName(String name) {
|
||||||
_name = name;
|
_name = name;
|
||||||
|
_isNamed = true;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Binds a direct instance (static object) for this type.
|
/// RU: Инициализация экземляпяра [value].
|
||||||
|
/// ENG: Initialization instance [value].
|
||||||
///
|
///
|
||||||
/// Example:
|
/// return [Binding]
|
||||||
/// ```dart
|
Binding<T> toInstance(T value) {
|
||||||
/// bind<Api>().toInstance(ApiMock());
|
_mode = Mode.instance;
|
||||||
/// ```
|
_instance = value;
|
||||||
///
|
_isSingleton = true;
|
||||||
/// **Important limitation:**
|
|
||||||
/// If you register several dependencies via [toInstance] inside a [`Module.builder`],
|
|
||||||
/// do _not_ use `scope.resolve<T>()` to get objects that are also being registered during the _same_ builder execution.
|
|
||||||
/// All [toInstance] bindings are applied sequentially, and at the point of registration,
|
|
||||||
/// earlier objects are not yet available for resolve.
|
|
||||||
///
|
|
||||||
/// **Correct:**
|
|
||||||
/// ```dart
|
|
||||||
/// void builder(Scope scope) {
|
|
||||||
/// final a = A();
|
|
||||||
/// final b = B(a);
|
|
||||||
/// bind<A>().toInstance(a);
|
|
||||||
/// bind<B>().toInstance(b);
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
/// **Wrong:**
|
|
||||||
/// ```dart
|
|
||||||
/// void builder(Scope scope) {
|
|
||||||
/// bind<A>().toInstance(A());
|
|
||||||
/// bind<B>().toInstance(B(scope.resolve<A>())); // Error! A is not available yet.
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
/// **Wrong:**
|
|
||||||
/// ```dart
|
|
||||||
/// void builder(Scope scope) {
|
|
||||||
/// bind<A>().toProvide(() => A());
|
|
||||||
/// bind<B>().toInstance(B(scope.resolve<A>())); // Error! A is not available yet.
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
/// This restriction only applies to [toInstance] bindings.
|
|
||||||
// ignore: deprecated_member_use_from_same_package
|
|
||||||
/// With [toProvide]/[toProvideAsync] you may freely use `scope.resolve<T>()` in the builder or provider function.
|
|
||||||
Binding<T> toInstance(Instance<T> value) {
|
|
||||||
_resolver = InstanceResolver<T>(value);
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Binds a provider function (sync or async) that creates the instance when resolved.
|
/// RU: Инициализация экземляпяра [value].
|
||||||
|
/// ENG: Initialization instance [value].
|
||||||
///
|
///
|
||||||
/// Example:
|
/// return [Binding]
|
||||||
/// ```dart
|
Binding<T> toInstanceAsync(Future<T> value) {
|
||||||
/// bind<Api>().toProvide(() => ApiService());
|
_mode = Mode.instance;
|
||||||
/// bind<Db>().toProvide(() async => await openDb());
|
_instanceAsync = value;
|
||||||
/// ```
|
_isSingleton = true;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// RU: Инициализация экземляпяра через провайдер [value].
|
||||||
|
/// ENG: Initialization instance via provider [value].
|
||||||
|
///
|
||||||
|
/// return [Binding]
|
||||||
Binding<T> toProvide(Provider<T> value) {
|
Binding<T> toProvide(Provider<T> value) {
|
||||||
_resolver = ProviderResolver<T>((_) => value.call(), withParams: false);
|
_mode = Mode.providerInstance;
|
||||||
|
_provider = value;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Binds a provider function that takes dynamic params at resolve-time (e.g. for factories).
|
/// RU: Инициализация экземляпяра через провайдер [value].
|
||||||
|
/// ENG: Initialization instance via provider [value].
|
||||||
///
|
///
|
||||||
/// Example:
|
/// return [Binding]
|
||||||
/// ```dart
|
Binding<T> toProvideAsync(AsyncProvider<T> provider) {
|
||||||
/// bind<User>().toProvideWithParams((params) => User(name: params["name"]));
|
_mode = Mode.providerInstance;
|
||||||
/// ```
|
asyncProvider = provider;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// RU: Инициализация экземляпяра через провайдер [value] c динамическим параметром.
|
||||||
|
/// ENG: Initialization instance via provider [value] with a dynamic param.
|
||||||
|
///
|
||||||
|
/// return [Binding]
|
||||||
Binding<T> toProvideWithParams(ProviderWithParams<T> value) {
|
Binding<T> toProvideWithParams(ProviderWithParams<T> value) {
|
||||||
_resolver = ProviderResolver<T>(value, withParams: true);
|
_mode = Mode.providerInstanceWithParams;
|
||||||
|
_providerWithParams = value;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Deprecated('Use toInstance instead of toInstanceAsync')
|
/// RU: Инициализация экземляра через асинхронный провайдер [value] с динамическим параметром.
|
||||||
Binding<T> toInstanceAsync(Instance<T> value) {
|
/// ENG: Initializes the instance via async provider [value] with a dynamic param.
|
||||||
return this.toInstance(value);
|
///
|
||||||
|
/// return [Binding]
|
||||||
|
Binding<T> toProvideAsyncWithParams(AsyncProviderWithParams<T> provider) {
|
||||||
|
_mode = Mode.providerInstanceWithParams;
|
||||||
|
asyncProviderWithParams = provider;
|
||||||
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Deprecated('Use toProvide instead of toProvideAsync')
|
/// RU: Инициализация экземляпяра как сингелтон [value].
|
||||||
Binding<T> toProvideAsync(Provider<T> value) {
|
/// ENG: Initialization instance as a singelton [value].
|
||||||
return this.toProvide(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Deprecated('Use toProvideWithParams instead of toProvideAsyncWithParams')
|
|
||||||
Binding<T> toProvideAsyncWithParams(ProviderWithParams<T> value) {
|
|
||||||
return this.toProvideWithParams(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Marks this binding as singleton (will only create and cache one instance per scope).
|
|
||||||
///
|
///
|
||||||
/// Call this after toProvide/toInstance etc:
|
/// return [Binding]
|
||||||
/// ```dart
|
|
||||||
/// bind<Api>().toProvide(() => MyApi()).singleton();
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// ---
|
|
||||||
///
|
|
||||||
/// ⚠️ **Special note: Behavior with parametric providers (`toProvideWithParams`/`toProvideAsyncWithParams`):**
|
|
||||||
///
|
|
||||||
/// If you declare a binding using `.toProvideWithParams(...)` (or its async variant) and then chain `.singleton()`, only the **very first** `resolve<T>(params: ...)` will use its parameters;
|
|
||||||
/// every subsequent call (regardless of params) will return the same (cached) instance.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// bind<Service>().toProvideWithParams((params) => Service(params)).singleton();
|
|
||||||
/// final a = scope.resolve<Service>(params: 1); // creates Service(1)
|
|
||||||
/// final b = scope.resolve<Service>(params: 2); // returns Service(1)
|
|
||||||
/// print(identical(a, b)); // true
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Use this pattern only if you want a master singleton. If you expect a new instance per params, **do not** use `.singleton()` on parameterized providers.
|
|
||||||
///
|
|
||||||
/// ℹ️ **Note about `.singleton()` and `.toInstance()`:**
|
|
||||||
///
|
|
||||||
/// Calling `.singleton()` after `.toInstance()` does **not** change the binding’s behavior:
|
|
||||||
/// the object passed with `toInstance()` is already a single, constant instance that will always be returned for every resolve.
|
|
||||||
/// There is no need to use `.singleton()` with `toInstance()`. This call has no effect.
|
|
||||||
/// `.singleton()` is only meaningful with providers (`toProvide`, `toProvideAsync`, etc), to ensure only one instance is created by the factory.
|
|
||||||
Binding<T> singleton() {
|
Binding<T> singleton() {
|
||||||
_resolver?.toSingleton();
|
_isSingleton = true;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Resolves the instance synchronously (if binding supports sync access).
|
/// RU: Поиск экземпляра.
|
||||||
|
/// ENG: Resolve instance.
|
||||||
///
|
///
|
||||||
/// Returns the created/found instance or null.
|
/// return [T]
|
||||||
|
T? get instance => _instance;
|
||||||
|
|
||||||
|
/// RU: Поиск экземпляра.
|
||||||
|
/// ENG: Resolve instance.
|
||||||
///
|
///
|
||||||
/// Example:
|
/// return [T]
|
||||||
/// ```dart
|
Future<T>? get instanceAsync => _instanceAsync;
|
||||||
/// final s = scope.resolveSync<String>();
|
|
||||||
/// ```
|
/// RU: Поиск экземпляра.
|
||||||
T? resolveSync([dynamic params]) {
|
/// ENG: Resolve instance.
|
||||||
final res = resolver?.resolveSync(params);
|
///
|
||||||
if (res != null) {
|
/// return [T]
|
||||||
observer?.onDiagnostic(
|
T? get provider {
|
||||||
'Binding resolved instance: ${T.toString()}',
|
if (_isSingleton) {
|
||||||
details: {
|
_instance ??= _provider?.call();
|
||||||
if (_name != null) 'name': _name,
|
return _instance;
|
||||||
'method': 'resolveSync',
|
|
||||||
'description': 'object created/resolved',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
observer?.onWarning(
|
|
||||||
'resolveSync returned null: ${T.toString()}',
|
|
||||||
details: {
|
|
||||||
if (_name != null) 'name': _name,
|
|
||||||
'method': 'resolveSync',
|
|
||||||
'description': 'resolveSync returned null',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
return res;
|
return _provider?.call();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Resolves the instance asynchronously (if binding supports async/future access).
|
/// RU: Поиск экземпляра с параметром.
|
||||||
///
|
///
|
||||||
/// Returns a [Future] with the instance, or null if unavailable.
|
/// ENG: Resolve instance with [params].
|
||||||
///
|
///
|
||||||
/// Example:
|
/// return [T]
|
||||||
/// ```dart
|
T? providerWithParams(dynamic params) {
|
||||||
/// final user = await scope.resolveAsync<User>();
|
return _providerWithParams?.call(params);
|
||||||
/// ```
|
|
||||||
Future<T>? resolveAsync([dynamic params]) {
|
|
||||||
final future = resolver?.resolveAsync(params);
|
|
||||||
if (future != null) {
|
|
||||||
future
|
|
||||||
.then((res) => observer?.onDiagnostic(
|
|
||||||
'Future resolved for: ${T.toString()}',
|
|
||||||
details: {
|
|
||||||
if (_name != null) 'name': _name,
|
|
||||||
'method': 'resolveAsync',
|
|
||||||
'description': 'Future resolved',
|
|
||||||
},
|
|
||||||
))
|
|
||||||
.catchError((e, s) => observer?.onError(
|
|
||||||
'resolveAsync error: ${T.toString()}',
|
|
||||||
e,
|
|
||||||
s,
|
|
||||||
));
|
|
||||||
} else {
|
|
||||||
observer?.onWarning(
|
|
||||||
'resolveAsync returned null: ${T.toString()}',
|
|
||||||
details: {
|
|
||||||
if (_name != null) 'name': _name,
|
|
||||||
'method': 'resolveAsync',
|
|
||||||
'description': 'resolveAsync returned null',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return future;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,177 +0,0 @@
|
|||||||
//
|
|
||||||
// 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
|
|
||||||
// https://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';
|
|
||||||
|
|
||||||
/// Represents a direct instance or an async instance ([T] or [Future<T>]).
|
|
||||||
/// Used for both direct and async bindings.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// Instance<String> sync = "hello";
|
|
||||||
/// Instance<MyApi> async = Future.value(MyApi());
|
|
||||||
/// ```
|
|
||||||
typedef Instance<T> = FutureOr<T>;
|
|
||||||
|
|
||||||
/// Provider function type for synchronous or asynchronous, parameterless creation of [T].
|
|
||||||
/// Can return [T] or [Future<T>].
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// Provider<MyService> provider = () => MyService();
|
|
||||||
/// Provider<Api> asyncProvider = () async => await Api.connect();
|
|
||||||
/// ```
|
|
||||||
typedef Provider<T> = FutureOr<T> Function();
|
|
||||||
|
|
||||||
/// Provider function type that accepts a dynamic parameter, for factory/parametrized injection.
|
|
||||||
/// Returns [T] or [Future<T>].
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// ProviderWithParams<User> provider = (params) => User(params["name"]);
|
|
||||||
/// ```
|
|
||||||
typedef ProviderWithParams<T> = FutureOr<T> Function(dynamic);
|
|
||||||
|
|
||||||
/// Abstract interface for dependency resolvers used by [Binding].
|
|
||||||
/// Defines how to resolve instances of type [T].
|
|
||||||
///
|
|
||||||
/// You usually don't use this directly; it's used internally for advanced/low-level DI.
|
|
||||||
abstract class BindingResolver<T> {
|
|
||||||
/// Synchronously resolves the dependency, optionally taking parameters (for factory cases).
|
|
||||||
/// Throws if implementation does not support sync resolution.
|
|
||||||
T? resolveSync([dynamic params]);
|
|
||||||
|
|
||||||
/// Asynchronously resolves the dependency, optionally taking parameters (for factory cases).
|
|
||||||
/// If instance is already a [Future], returns it directly.
|
|
||||||
Future<T>? resolveAsync([dynamic params]);
|
|
||||||
|
|
||||||
/// Marks this resolver as singleton: instance(s) will be cached and reused inside the scope.
|
|
||||||
void toSingleton();
|
|
||||||
|
|
||||||
/// Returns true if this resolver is marked as singleton.
|
|
||||||
bool get isSingleton;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Concrete resolver for direct instance ([T] or [Future<T>]). No provider is called.
|
|
||||||
///
|
|
||||||
/// Used for [Binding.toInstance].
|
|
||||||
/// Supports both sync and async resolution; sync will throw if underlying instance is [Future].
|
|
||||||
/// Examples:
|
|
||||||
/// ```dart
|
|
||||||
/// var resolver = InstanceResolver("hello");
|
|
||||||
/// resolver.resolveSync(); // == "hello"
|
|
||||||
/// var asyncResolver = InstanceResolver(Future.value(7));
|
|
||||||
/// asyncResolver.resolveAsync(); // Future<int>
|
|
||||||
/// ```
|
|
||||||
class InstanceResolver<T> implements BindingResolver<T> {
|
|
||||||
final Instance<T> _instance;
|
|
||||||
|
|
||||||
/// Wraps the given instance (sync or async) in a resolver.
|
|
||||||
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;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Resolver for provider functions (sync/async/factory), with optional singleton caching.
|
|
||||||
/// Used for [Binding.toProvide], [Binding.toProvideWithParams], [Binding.singleton].
|
|
||||||
///
|
|
||||||
/// Examples:
|
|
||||||
/// ```dart
|
|
||||||
/// // No param, sync:
|
|
||||||
/// var r = ProviderResolver((_) => 5, withParams: false);
|
|
||||||
/// r.resolveSync(); // == 5
|
|
||||||
/// // With param:
|
|
||||||
/// var rp = ProviderResolver((p) => p * 2, withParams: true);
|
|
||||||
/// rp.resolveSync(2); // == 4
|
|
||||||
/// // Singleton:
|
|
||||||
/// r.toSingleton();
|
|
||||||
/// // Async:
|
|
||||||
/// var ra = ProviderResolver((_) async => await Future.value(10), withParams: false);
|
|
||||||
/// await ra.resolveAsync(); // == 10
|
|
||||||
/// ```
|
|
||||||
class ProviderResolver<T> implements BindingResolver<T> {
|
|
||||||
final ProviderWithParams<T> _provider;
|
|
||||||
final bool _withParams;
|
|
||||||
|
|
||||||
FutureOr<T>? _cache;
|
|
||||||
bool _singleton = false;
|
|
||||||
|
|
||||||
/// Creates a resolver from [provider], optionally accepting dynamic params.
|
|
||||||
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;
|
|
||||||
|
|
||||||
/// Throws if params required but not supplied.
|
|
||||||
void _checkParams(dynamic params) {
|
|
||||||
if (_withParams && params == null) {
|
|
||||||
throw StateError(
|
|
||||||
'[$T] Params is null. Maybe you forgot to pass it?',
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -12,22 +12,14 @@
|
|||||||
//
|
//
|
||||||
|
|
||||||
import 'dart:collection';
|
import 'dart:collection';
|
||||||
import 'package:cherrypick/src/observer.dart';
|
|
||||||
|
|
||||||
/// Exception thrown when a circular dependency is detected during dependency resolution.
|
/// RU: Исключение, выбрасываемое при обнаружении циклической зависимости.
|
||||||
///
|
/// ENG: Exception thrown when a circular dependency is detected.
|
||||||
/// Contains a [message] and the [dependencyChain] showing the resolution cycle.
|
|
||||||
///
|
|
||||||
/// Example diagnostic:
|
|
||||||
/// ```
|
|
||||||
/// CircularDependencyException: Circular dependency detected for A
|
|
||||||
/// Dependency chain: A -> B -> C -> A
|
|
||||||
/// ```
|
|
||||||
class CircularDependencyException implements Exception {
|
class CircularDependencyException implements Exception {
|
||||||
final String message;
|
final String message;
|
||||||
final List<String> dependencyChain;
|
final List<String> dependencyChain;
|
||||||
|
|
||||||
CircularDependencyException(this.message, this.dependencyChain);
|
const CircularDependencyException(this.message, this.dependencyChain);
|
||||||
|
|
||||||
@override
|
@override
|
||||||
String toString() {
|
String toString() {
|
||||||
@@ -36,164 +28,100 @@ class CircularDependencyException implements Exception {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Circular dependency detector for CherryPick DI containers.
|
/// RU: Детектор циклических зависимостей для CherryPick DI контейнера.
|
||||||
///
|
/// ENG: Circular dependency detector for CherryPick DI container.
|
||||||
/// Tracks dependency resolution chains to detect and prevent infinite recursion caused by cycles.
|
|
||||||
/// Whenever a resolve chain re-enters a started dependency, a [CircularDependencyException] is thrown with the full chain.
|
|
||||||
///
|
|
||||||
/// This class is used internally, but you can interact with it through [CycleDetectionMixin].
|
|
||||||
///
|
|
||||||
/// Example usage (pseudocode):
|
|
||||||
/// ```dart
|
|
||||||
/// final detector = CycleDetector(observer: myObserver);
|
|
||||||
/// try {
|
|
||||||
/// detector.startResolving<A>();
|
|
||||||
/// // ... resolving A which depends on B, etc
|
|
||||||
/// detector.startResolving<B>();
|
|
||||||
/// detector.startResolving<A>(); // BOOM: throws exception
|
|
||||||
/// } finally {
|
|
||||||
/// detector.finishResolving<B>();
|
|
||||||
/// detector.finishResolving<A>();
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
class CycleDetector {
|
class CycleDetector {
|
||||||
final CherryPickObserver _observer;
|
// Стек текущих разрешаемых зависимостей
|
||||||
final Set<String> _resolutionStack = HashSet<String>();
|
final Set<String> _resolutionStack = HashSet<String>();
|
||||||
|
|
||||||
|
// История разрешения для построения цепочки зависимостей
|
||||||
final List<String> _resolutionHistory = [];
|
final List<String> _resolutionHistory = [];
|
||||||
|
|
||||||
CycleDetector({required CherryPickObserver observer}) : _observer = observer;
|
/// RU: Начинает отслеживание разрешения зависимости.
|
||||||
|
/// ENG: Starts tracking dependency resolution.
|
||||||
/// Starts tracking dependency resolution for type [T] and optional [named] qualifier.
|
|
||||||
///
|
///
|
||||||
/// Throws [CircularDependencyException] if a cycle is found.
|
/// Throws [CircularDependencyException] if circular dependency is detected.
|
||||||
void startResolving<T>({String? named}) {
|
void startResolving<T>({String? named}) {
|
||||||
final dependencyKey = _createDependencyKey<T>(named);
|
final dependencyKey = _createDependencyKey<T>(named);
|
||||||
_observer.onDiagnostic(
|
|
||||||
'CycleDetector startResolving: $dependencyKey',
|
|
||||||
details: {
|
|
||||||
'event': 'startResolving',
|
|
||||||
'stackSize': _resolutionStack.length,
|
|
||||||
},
|
|
||||||
);
|
|
||||||
if (_resolutionStack.contains(dependencyKey)) {
|
if (_resolutionStack.contains(dependencyKey)) {
|
||||||
|
// Найдена циклическая зависимость
|
||||||
final cycleStartIndex = _resolutionHistory.indexOf(dependencyKey);
|
final cycleStartIndex = _resolutionHistory.indexOf(dependencyKey);
|
||||||
final cycle = _resolutionHistory.sublist(cycleStartIndex)
|
final cycle = _resolutionHistory.sublist(cycleStartIndex)..add(dependencyKey);
|
||||||
..add(dependencyKey);
|
|
||||||
_observer.onCycleDetected(cycle);
|
|
||||||
_observer.onError('Cycle detected for $dependencyKey', null, null);
|
|
||||||
throw CircularDependencyException(
|
throw CircularDependencyException(
|
||||||
'Circular dependency detected for $dependencyKey',
|
'Circular dependency detected for $dependencyKey',
|
||||||
cycle,
|
cycle,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
_resolutionStack.add(dependencyKey);
|
_resolutionStack.add(dependencyKey);
|
||||||
_resolutionHistory.add(dependencyKey);
|
_resolutionHistory.add(dependencyKey);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Stops tracking dependency resolution for type [T] and optional [named] qualifier.
|
/// RU: Завершает отслеживание разрешения зависимости.
|
||||||
/// Should always be called after [startResolving], including for errors.
|
/// ENG: Finishes tracking dependency resolution.
|
||||||
void finishResolving<T>({String? named}) {
|
void finishResolving<T>({String? named}) {
|
||||||
final dependencyKey = _createDependencyKey<T>(named);
|
final dependencyKey = _createDependencyKey<T>(named);
|
||||||
_observer.onDiagnostic(
|
|
||||||
'CycleDetector finishResolving: $dependencyKey',
|
|
||||||
details: {'event': 'finishResolving'},
|
|
||||||
);
|
|
||||||
_resolutionStack.remove(dependencyKey);
|
_resolutionStack.remove(dependencyKey);
|
||||||
// Only remove from history if it's the last one
|
|
||||||
|
// Удаляем из истории только если это последний элемент
|
||||||
if (_resolutionHistory.isNotEmpty &&
|
if (_resolutionHistory.isNotEmpty &&
|
||||||
_resolutionHistory.last == dependencyKey) {
|
_resolutionHistory.last == dependencyKey) {
|
||||||
_resolutionHistory.removeLast();
|
_resolutionHistory.removeLast();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Clears all resolution state and resets the cycle detector.
|
/// RU: Очищает все состояние детектора.
|
||||||
|
/// ENG: Clears all detector state.
|
||||||
void clear() {
|
void clear() {
|
||||||
_observer.onDiagnostic(
|
|
||||||
'CycleDetector clear',
|
|
||||||
details: {
|
|
||||||
'event': 'clear',
|
|
||||||
'description': 'resolution stack cleared',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
_resolutionStack.clear();
|
_resolutionStack.clear();
|
||||||
_resolutionHistory.clear();
|
_resolutionHistory.clear();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns true if dependency [T] (and [named], if specified) is being resolved right now.
|
/// RU: Проверяет, находится ли зависимость в процессе разрешения.
|
||||||
|
/// ENG: Checks if dependency is currently being resolved.
|
||||||
bool isResolving<T>({String? named}) {
|
bool isResolving<T>({String? named}) {
|
||||||
final dependencyKey = _createDependencyKey<T>(named);
|
final dependencyKey = _createDependencyKey<T>(named);
|
||||||
return _resolutionStack.contains(dependencyKey);
|
return _resolutionStack.contains(dependencyKey);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Gets the current dependency resolution chain (for diagnostics or debugging).
|
/// RU: Возвращает текущую цепочку разрешения зависимостей.
|
||||||
List<String> get currentResolutionChain =>
|
/// ENG: Returns current dependency resolution chain.
|
||||||
List.unmodifiable(_resolutionHistory);
|
List<String> get currentResolutionChain => List.unmodifiable(_resolutionHistory);
|
||||||
|
|
||||||
/// Returns a unique string key for type [T] (+name).
|
/// RU: Создает уникальный ключ для зависимости.
|
||||||
|
/// ENG: Creates unique key for dependency.
|
||||||
String _createDependencyKey<T>(String? named) {
|
String _createDependencyKey<T>(String? named) {
|
||||||
final typeName = T.toString();
|
final typeName = T.toString();
|
||||||
return named != null ? '$typeName@$named' : typeName;
|
return named != null ? '$typeName@$named' : typeName;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Mixin for adding circular dependency detection support to custom DI containers/classes.
|
/// RU: Миксин для добавления поддержки обнаружения циклических зависимостей.
|
||||||
///
|
/// ENG: Mixin for adding circular dependency detection support.
|
||||||
/// Fields:
|
|
||||||
/// - `observer`: must be implemented by your class (used for diagnostics and error reporting)
|
|
||||||
///
|
|
||||||
/// Example usage:
|
|
||||||
/// ```dart
|
|
||||||
/// class MyContainer with CycleDetectionMixin {
|
|
||||||
/// @override
|
|
||||||
/// CherryPickObserver get observer => myObserver;
|
|
||||||
/// }
|
|
||||||
///
|
|
||||||
/// final c = MyContainer();
|
|
||||||
/// c.enableCycleDetection();
|
|
||||||
/// c.withCycleDetection(String, null, () {
|
|
||||||
/// // ... dependency resolution code
|
|
||||||
/// });
|
|
||||||
/// ```
|
|
||||||
mixin CycleDetectionMixin {
|
mixin CycleDetectionMixin {
|
||||||
CycleDetector? _cycleDetector;
|
CycleDetector? _cycleDetector;
|
||||||
CherryPickObserver get observer;
|
|
||||||
|
|
||||||
/// Turns on circular dependency detection for this class/container.
|
/// RU: Включает обнаружение циклических зависимостей.
|
||||||
|
/// ENG: Enables circular dependency detection.
|
||||||
void enableCycleDetection() {
|
void enableCycleDetection() {
|
||||||
_cycleDetector = CycleDetector(observer: observer);
|
_cycleDetector = CycleDetector();
|
||||||
observer.onDiagnostic(
|
|
||||||
'CycleDetection enabled',
|
|
||||||
details: {
|
|
||||||
'event': 'enable',
|
|
||||||
'description': 'cycle detection enabled',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Shuts off detection and clears any cycle history for this container.
|
/// RU: Отключает обнаружение циклических зависимостей.
|
||||||
|
/// ENG: Disables circular dependency detection.
|
||||||
void disableCycleDetection() {
|
void disableCycleDetection() {
|
||||||
_cycleDetector?.clear();
|
_cycleDetector?.clear();
|
||||||
observer.onDiagnostic(
|
|
||||||
'CycleDetection disabled',
|
|
||||||
details: {
|
|
||||||
'event': 'disable',
|
|
||||||
'description': 'cycle detection disabled',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
_cycleDetector = null;
|
_cycleDetector = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns true if detection is currently enabled.
|
/// RU: Проверяет, включено ли обнаружение циклических зависимостей.
|
||||||
|
/// ENG: Checks if circular dependency detection is enabled.
|
||||||
bool get isCycleDetectionEnabled => _cycleDetector != null;
|
bool get isCycleDetectionEnabled => _cycleDetector != null;
|
||||||
|
|
||||||
/// Executes [action] while tracking for circular DI cycles for [dependencyType] and [named].
|
/// RU: Выполняет действие с отслеживанием циклических зависимостей.
|
||||||
///
|
/// ENG: Executes action with circular dependency tracking.
|
||||||
/// Throws [CircularDependencyException] if a dependency cycle is detected.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// withCycleDetection(String, 'api', () => resolveApi());
|
|
||||||
/// ```
|
|
||||||
T withCycleDetection<T>(
|
T withCycleDetection<T>(
|
||||||
Type dependencyType,
|
Type dependencyType,
|
||||||
String? named,
|
String? named,
|
||||||
@@ -208,12 +136,10 @@ mixin CycleDetectionMixin {
|
|||||||
: dependencyType.toString();
|
: dependencyType.toString();
|
||||||
|
|
||||||
if (_cycleDetector!._resolutionStack.contains(dependencyKey)) {
|
if (_cycleDetector!._resolutionStack.contains(dependencyKey)) {
|
||||||
final cycleStartIndex =
|
final cycleStartIndex = _cycleDetector!._resolutionHistory.indexOf(dependencyKey);
|
||||||
_cycleDetector!._resolutionHistory.indexOf(dependencyKey);
|
|
||||||
final cycle = _cycleDetector!._resolutionHistory.sublist(cycleStartIndex)
|
final cycle = _cycleDetector!._resolutionHistory.sublist(cycleStartIndex)
|
||||||
..add(dependencyKey);
|
..add(dependencyKey);
|
||||||
observer.onCycleDetected(cycle);
|
|
||||||
observer.onError('Cycle detected for $dependencyKey', null, null);
|
|
||||||
throw CircularDependencyException(
|
throw CircularDependencyException(
|
||||||
'Circular dependency detected for $dependencyKey',
|
'Circular dependency detected for $dependencyKey',
|
||||||
cycle,
|
cycle,
|
||||||
@@ -234,7 +160,8 @@ mixin CycleDetectionMixin {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Gets the current active dependency resolution chain.
|
/// RU: Возвращает текущую цепочку разрешения зависимостей.
|
||||||
|
/// ENG: Returns current dependency resolution chain.
|
||||||
List<String> get currentResolutionChain =>
|
List<String> get currentResolutionChain =>
|
||||||
_cycleDetector?.currentResolutionChain ?? [];
|
_cycleDetector?.currentResolutionChain ?? [];
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,63 +0,0 @@
|
|||||||
//
|
|
||||||
// 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
|
|
||||||
// https://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';
|
|
||||||
|
|
||||||
/// An interface for resources that require explicit cleanup, used by the CherryPick dependency injection container.
|
|
||||||
///
|
|
||||||
/// If an object implements [Disposable], the CherryPick DI container will automatically call [dispose]
|
|
||||||
/// when the corresponding scope is cleaned up. Use [Disposable] for closing streams, files, controllers, services, etc.
|
|
||||||
/// Both synchronous and asynchronous cleanup is supported:
|
|
||||||
/// - For sync disposables, implement [dispose] as a `void` or simply return nothing.
|
|
||||||
/// - For async disposables, implement [dispose] returning a [Future].
|
|
||||||
///
|
|
||||||
/// Example: Synchronous Disposable
|
|
||||||
/// ```dart
|
|
||||||
/// class MyLogger implements Disposable {
|
|
||||||
/// void dispose() {
|
|
||||||
/// print('Logger closed!');
|
|
||||||
/// }
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Example: Asynchronous Disposable
|
|
||||||
/// ```dart
|
|
||||||
/// class MyConnection implements Disposable {
|
|
||||||
/// @override
|
|
||||||
/// Future<void> dispose() async {
|
|
||||||
/// await connection.close();
|
|
||||||
/// }
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Usage with CherryPick DI Module
|
|
||||||
/// ```dart
|
|
||||||
/// final scope = openRootScope();
|
|
||||||
/// scope.installModules([
|
|
||||||
/// Module((b) {
|
|
||||||
/// b.bind<MyLogger>((_) => MyLogger());
|
|
||||||
/// b.bindAsync<MyConnection>((_) async => MyConnection());
|
|
||||||
/// }),
|
|
||||||
/// ]);
|
|
||||||
/// // ...
|
|
||||||
/// await scope.close(); // will automatically call dispose on all Disposables
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// This pattern ensures that all resources are released safely and automatically when the scope is destroyed.
|
|
||||||
abstract class Disposable {
|
|
||||||
/// Releases all resources held by this object.
|
|
||||||
///
|
|
||||||
/// Implement cleanup logic (closing streams, sockets, files, etc.) within this method.
|
|
||||||
/// Return a [Future] for async cleanup, or nothing (`void`) for synchronous cleanup.
|
|
||||||
FutureOr<void> dispose();
|
|
||||||
}
|
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -12,28 +12,6 @@
|
|||||||
//
|
//
|
||||||
import 'package:cherrypick/src/scope.dart';
|
import 'package:cherrypick/src/scope.dart';
|
||||||
|
|
||||||
/// Abstract factory interface for creating objects of type [T] using a [Scope].
|
|
||||||
///
|
|
||||||
/// Can be implemented for advanced dependency injection scenarios where
|
|
||||||
/// the resolution requires contextual information from the DI [Scope].
|
|
||||||
///
|
|
||||||
/// Often used to supply complex objects, runtime-bound services,
|
|
||||||
/// or objects depending on dynamic configuration.
|
|
||||||
///
|
|
||||||
/// Example usage:
|
|
||||||
/// ```dart
|
|
||||||
/// class MyServiceFactory implements Factory<MyService> {
|
|
||||||
/// @override
|
|
||||||
/// MyService createInstance(Scope scope) {
|
|
||||||
/// final db = scope.resolve<Database>(named: "main");
|
|
||||||
/// return MyService(db);
|
|
||||||
/// }
|
|
||||||
/// }
|
|
||||||
///
|
|
||||||
/// // Usage in a module:
|
|
||||||
/// bind<MyService>().toProvide(() => MyServiceFactory().createInstance(scope));
|
|
||||||
/// ```
|
|
||||||
abstract class Factory<T> {
|
abstract class Factory<T> {
|
||||||
/// Implement this to provide an instance of [T], with access to the resolving [scope].
|
|
||||||
T createInstance(Scope scope);
|
T createInstance(Scope scope);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -12,52 +12,33 @@
|
|||||||
//
|
//
|
||||||
|
|
||||||
import 'dart:collection';
|
import 'dart:collection';
|
||||||
import 'package:cherrypick/cherrypick.dart';
|
import 'package:cherrypick/src/cycle_detector.dart';
|
||||||
|
|
||||||
/// GlobalCycleDetector detects and prevents circular dependencies across an entire DI scope hierarchy.
|
/// RU: Глобальный детектор циклических зависимостей для всей иерархии скоупов.
|
||||||
///
|
/// ENG: Global circular dependency detector for entire scope hierarchy.
|
||||||
/// This is particularly important for modular/feature-based applications
|
|
||||||
/// where subscopes can introduce indirect cycles that span different scopes.
|
|
||||||
///
|
|
||||||
/// The detector tracks resolution chains and throws [CircularDependencyException]
|
|
||||||
/// when a cycle is found, showing the full chain (including scope context).
|
|
||||||
///
|
|
||||||
/// Example usage via [GlobalCycleDetectionMixin]:
|
|
||||||
/// ```dart
|
|
||||||
/// class MyScope with GlobalCycleDetectionMixin { /* ... */ }
|
|
||||||
///
|
|
||||||
/// final scope = MyScope();
|
|
||||||
/// scope.setScopeId('feature');
|
|
||||||
/// scope.enableGlobalCycleDetection();
|
|
||||||
///
|
|
||||||
/// scope.withGlobalCycleDetection(String, null, () {
|
|
||||||
/// // ... resolve dependencies here, will detect cross-scope cycles
|
|
||||||
/// });
|
|
||||||
/// ```
|
|
||||||
class GlobalCycleDetector {
|
class GlobalCycleDetector {
|
||||||
static GlobalCycleDetector? _instance;
|
static GlobalCycleDetector? _instance;
|
||||||
|
|
||||||
final CherryPickObserver _observer;
|
// Глобальный стек разрешения зависимостей
|
||||||
|
|
||||||
// Global set and chain history for all resolutions
|
|
||||||
final Set<String> _globalResolutionStack = HashSet<String>();
|
final Set<String> _globalResolutionStack = HashSet<String>();
|
||||||
|
|
||||||
|
// История разрешения для построения цепочки зависимостей
|
||||||
final List<String> _globalResolutionHistory = [];
|
final List<String> _globalResolutionHistory = [];
|
||||||
|
|
||||||
// Map of active detectors for subscopes (rarely used directly)
|
// Карта активных детекторов по скоупам
|
||||||
final Map<String, CycleDetector> _scopeDetectors =
|
final Map<String, CycleDetector> _scopeDetectors = HashMap<String, CycleDetector>();
|
||||||
HashMap<String, CycleDetector>();
|
|
||||||
|
|
||||||
GlobalCycleDetector._internal({required CherryPickObserver observer})
|
GlobalCycleDetector._internal();
|
||||||
: _observer = observer;
|
|
||||||
|
|
||||||
/// Returns the singleton global detector instance, initializing it if needed.
|
/// RU: Получить единственный экземпляр глобального детектора.
|
||||||
|
/// ENG: Get singleton instance of global detector.
|
||||||
static GlobalCycleDetector get instance {
|
static GlobalCycleDetector get instance {
|
||||||
_instance ??=
|
_instance ??= GlobalCycleDetector._internal();
|
||||||
GlobalCycleDetector._internal(observer: CherryPick.globalObserver);
|
|
||||||
return _instance!;
|
return _instance!;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Reset internal state (useful for testing).
|
/// RU: Сбросить глобальный детектор (полезно для тестов).
|
||||||
|
/// ENG: Reset global detector (useful for tests).
|
||||||
static void reset() {
|
static void reset() {
|
||||||
_instance?._globalResolutionStack.clear();
|
_instance?._globalResolutionStack.clear();
|
||||||
_instance?._globalResolutionHistory.clear();
|
_instance?._globalResolutionHistory.clear();
|
||||||
@@ -65,18 +46,16 @@ class GlobalCycleDetector {
|
|||||||
_instance = null;
|
_instance = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Start tracking resolution of dependency [T] with optional [named] and [scopeId].
|
/// RU: Начать отслеживание разрешения зависимости в глобальном контексте.
|
||||||
/// Throws [CircularDependencyException] on cycle.
|
/// ENG: Start tracking dependency resolution in global context.
|
||||||
void startGlobalResolving<T>({String? named, String? scopeId}) {
|
void startGlobalResolving<T>({String? named, String? scopeId}) {
|
||||||
final dependencyKey = _createDependencyKeyFromType(T, named, scopeId);
|
final dependencyKey = _createDependencyKeyFromType(T, named, scopeId);
|
||||||
|
|
||||||
if (_globalResolutionStack.contains(dependencyKey)) {
|
if (_globalResolutionStack.contains(dependencyKey)) {
|
||||||
|
// Найдена глобальная циклическая зависимость
|
||||||
final cycleStartIndex = _globalResolutionHistory.indexOf(dependencyKey);
|
final cycleStartIndex = _globalResolutionHistory.indexOf(dependencyKey);
|
||||||
final cycle = _globalResolutionHistory.sublist(cycleStartIndex)
|
final cycle = _globalResolutionHistory.sublist(cycleStartIndex)..add(dependencyKey);
|
||||||
..add(dependencyKey);
|
|
||||||
_observer.onCycleDetected(cycle, scopeName: scopeId);
|
|
||||||
_observer.onError(
|
|
||||||
'Global circular dependency detected for $dependencyKey', null, null);
|
|
||||||
throw CircularDependencyException(
|
throw CircularDependencyException(
|
||||||
'Global circular dependency detected for $dependencyKey',
|
'Global circular dependency detected for $dependencyKey',
|
||||||
cycle,
|
cycle,
|
||||||
@@ -87,35 +66,34 @@ class GlobalCycleDetector {
|
|||||||
_globalResolutionHistory.add(dependencyKey);
|
_globalResolutionHistory.add(dependencyKey);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Finish tracking a dependency. Should always be called after [startGlobalResolving].
|
/// RU: Завершить отслеживание разрешения зависимости в глобальном контексте.
|
||||||
|
/// ENG: Finish tracking dependency resolution in global context.
|
||||||
void finishGlobalResolving<T>({String? named, String? scopeId}) {
|
void finishGlobalResolving<T>({String? named, String? scopeId}) {
|
||||||
final dependencyKey = _createDependencyKeyFromType(T, named, scopeId);
|
final dependencyKey = _createDependencyKeyFromType(T, named, scopeId);
|
||||||
_globalResolutionStack.remove(dependencyKey);
|
_globalResolutionStack.remove(dependencyKey);
|
||||||
|
|
||||||
|
// Удаляем из истории только если это последний элемент
|
||||||
if (_globalResolutionHistory.isNotEmpty &&
|
if (_globalResolutionHistory.isNotEmpty &&
|
||||||
_globalResolutionHistory.last == dependencyKey) {
|
_globalResolutionHistory.last == dependencyKey) {
|
||||||
_globalResolutionHistory.removeLast();
|
_globalResolutionHistory.removeLast();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Internally execute [action] with global cycle detection for [dependencyType], [named], [scopeId].
|
/// RU: Выполнить действие с глобальным отслеживанием циклических зависимостей.
|
||||||
/// Throws [CircularDependencyException] on cycle.
|
/// ENG: Execute action with global circular dependency tracking.
|
||||||
T withGlobalCycleDetection<T>(
|
T withGlobalCycleDetection<T>(
|
||||||
Type dependencyType,
|
Type dependencyType,
|
||||||
String? named,
|
String? named,
|
||||||
String? scopeId,
|
String? scopeId,
|
||||||
T Function() action,
|
T Function() action,
|
||||||
) {
|
) {
|
||||||
final dependencyKey =
|
final dependencyKey = _createDependencyKeyFromType(dependencyType, named, scopeId);
|
||||||
_createDependencyKeyFromType(dependencyType, named, scopeId);
|
|
||||||
|
|
||||||
if (_globalResolutionStack.contains(dependencyKey)) {
|
if (_globalResolutionStack.contains(dependencyKey)) {
|
||||||
final cycleStartIndex = _globalResolutionHistory.indexOf(dependencyKey);
|
final cycleStartIndex = _globalResolutionHistory.indexOf(dependencyKey);
|
||||||
final cycle = _globalResolutionHistory.sublist(cycleStartIndex)
|
final cycle = _globalResolutionHistory.sublist(cycleStartIndex)
|
||||||
..add(dependencyKey);
|
..add(dependencyKey);
|
||||||
_observer.onCycleDetected(cycle, scopeName: scopeId);
|
|
||||||
_observer.onError(
|
|
||||||
'Global circular dependency detected for $dependencyKey', null, null);
|
|
||||||
throw CircularDependencyException(
|
throw CircularDependencyException(
|
||||||
'Global circular dependency detected for $dependencyKey',
|
'Global circular dependency detected for $dependencyKey',
|
||||||
cycle,
|
cycle,
|
||||||
@@ -136,28 +114,31 @@ class GlobalCycleDetector {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Get per-scope detector (not usually needed by consumers).
|
/// RU: Получить детектор для конкретного скоупа.
|
||||||
|
/// ENG: Get detector for specific scope.
|
||||||
CycleDetector getScopeDetector(String scopeId) {
|
CycleDetector getScopeDetector(String scopeId) {
|
||||||
return _scopeDetectors.putIfAbsent(
|
return _scopeDetectors.putIfAbsent(scopeId, () => CycleDetector());
|
||||||
scopeId, () => CycleDetector(observer: CherryPick.globalObserver));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Remove detector for a given scope.
|
/// RU: Удалить детектор для скоупа.
|
||||||
|
/// ENG: Remove detector for scope.
|
||||||
void removeScopeDetector(String scopeId) {
|
void removeScopeDetector(String scopeId) {
|
||||||
_scopeDetectors.remove(scopeId);
|
_scopeDetectors.remove(scopeId);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns true if dependency [T] is currently being resolved in the global scope.
|
/// RU: Проверить, находится ли зависимость в процессе глобального разрешения.
|
||||||
|
/// ENG: Check if dependency is currently being resolved globally.
|
||||||
bool isGloballyResolving<T>({String? named, String? scopeId}) {
|
bool isGloballyResolving<T>({String? named, String? scopeId}) {
|
||||||
final dependencyKey = _createDependencyKeyFromType(T, named, scopeId);
|
final dependencyKey = _createDependencyKeyFromType(T, named, scopeId);
|
||||||
return _globalResolutionStack.contains(dependencyKey);
|
return _globalResolutionStack.contains(dependencyKey);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Get current global dependency resolution chain (for debugging or diagnostics).
|
/// RU: Получить текущую глобальную цепочку разрешения зависимостей.
|
||||||
List<String> get globalResolutionChain =>
|
/// ENG: Get current global dependency resolution chain.
|
||||||
List.unmodifiable(_globalResolutionHistory);
|
List<String> get globalResolutionChain => List.unmodifiable(_globalResolutionHistory);
|
||||||
|
|
||||||
/// Clears all global and per-scope state in this detector.
|
/// RU: Очистить все состояние детектора.
|
||||||
|
/// ENG: Clear all detector state.
|
||||||
void clear() {
|
void clear() {
|
||||||
_globalResolutionStack.clear();
|
_globalResolutionStack.clear();
|
||||||
_globalResolutionHistory.clear();
|
_globalResolutionHistory.clear();
|
||||||
@@ -167,9 +148,15 @@ class GlobalCycleDetector {
|
|||||||
|
|
||||||
void _detectorClear(detector) => detector.clear();
|
void _detectorClear(detector) => detector.clear();
|
||||||
|
|
||||||
/// Creates a unique dependency key string including scope and name (for diagnostics/cycle checks).
|
/// RU: Создать уникальный ключ для зависимости с учетом скоупа.
|
||||||
String _createDependencyKeyFromType(
|
/// ENG: Create unique key for dependency including scope.
|
||||||
Type type, String? named, String? scopeId) {
|
//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 typeName = type.toString();
|
||||||
final namePrefix = named != null ? '@$named' : '';
|
final namePrefix = named != null ? '@$named' : '';
|
||||||
final scopePrefix = scopeId != null ? '[$scopeId]' : '';
|
final scopePrefix = scopeId != null ? '[$scopeId]' : '';
|
||||||
@@ -177,53 +164,40 @@ class GlobalCycleDetector {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Enhanced mixin for global circular dependency detection, to be mixed into
|
/// RU: Улучшенный миксин для глобального обнаружения циклических зависимостей.
|
||||||
/// DI scopes or containers that want cross-scope protection.
|
/// ENG: Enhanced mixin for global circular dependency detection.
|
||||||
///
|
|
||||||
/// Typical usage pattern:
|
|
||||||
/// ```dart
|
|
||||||
/// class MySubscope with GlobalCycleDetectionMixin { ... }
|
|
||||||
///
|
|
||||||
/// final scope = MySubscope();
|
|
||||||
/// scope.setScopeId('user_profile');
|
|
||||||
/// scope.enableGlobalCycleDetection();
|
|
||||||
///
|
|
||||||
/// scope.withGlobalCycleDetection(UserService, null, () {
|
|
||||||
/// // ... resolve user service and friends, auto-detects global cycles
|
|
||||||
/// });
|
|
||||||
/// ```
|
|
||||||
mixin GlobalCycleDetectionMixin {
|
mixin GlobalCycleDetectionMixin {
|
||||||
String? _scopeId;
|
String? _scopeId;
|
||||||
bool _globalCycleDetectionEnabled = false;
|
bool _globalCycleDetectionEnabled = false;
|
||||||
|
|
||||||
/// Set the scope's unique identifier for global tracking (should be called at scope initialization).
|
/// RU: Установить идентификатор скоупа для глобального отслеживания.
|
||||||
|
/// ENG: Set scope identifier for global tracking.
|
||||||
void setScopeId(String scopeId) {
|
void setScopeId(String scopeId) {
|
||||||
_scopeId = scopeId;
|
_scopeId = scopeId;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Get the scope's id, if configured.
|
/// RU: Получить идентификатор скоупа.
|
||||||
|
/// ENG: Get scope identifier.
|
||||||
String? get scopeId => _scopeId;
|
String? get scopeId => _scopeId;
|
||||||
|
|
||||||
/// Enable global cross-scope circular dependency detection.
|
/// RU: Включить глобальное обнаружение циклических зависимостей.
|
||||||
|
/// ENG: Enable global circular dependency detection.
|
||||||
void enableGlobalCycleDetection() {
|
void enableGlobalCycleDetection() {
|
||||||
_globalCycleDetectionEnabled = true;
|
_globalCycleDetectionEnabled = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Disable global cycle detection (no cycle checks will be performed globally).
|
/// RU: Отключить глобальное обнаружение циклических зависимостей.
|
||||||
|
/// ENG: Disable global circular dependency detection.
|
||||||
void disableGlobalCycleDetection() {
|
void disableGlobalCycleDetection() {
|
||||||
_globalCycleDetectionEnabled = false;
|
_globalCycleDetectionEnabled = false;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns true if global cycle detection is currently enabled for this scope/container.
|
/// RU: Проверить, включено ли глобальное обнаружение циклических зависимостей.
|
||||||
|
/// ENG: Check if global circular dependency detection is enabled.
|
||||||
bool get isGlobalCycleDetectionEnabled => _globalCycleDetectionEnabled;
|
bool get isGlobalCycleDetectionEnabled => _globalCycleDetectionEnabled;
|
||||||
|
|
||||||
/// Executes [action] with global cycle detection for [dependencyType] and [named].
|
/// RU: Выполнить действие с глобальным отслеживанием циклических зависимостей.
|
||||||
/// Throws [CircularDependencyException] if a cycle is detected.
|
/// ENG: Execute action with global circular dependency tracking.
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// withGlobalCycleDetection(UserService, null, () => resolveUser());
|
|
||||||
/// ```
|
|
||||||
T withGlobalCycleDetection<T>(
|
T withGlobalCycleDetection<T>(
|
||||||
Type dependencyType,
|
Type dependencyType,
|
||||||
String? named,
|
String? named,
|
||||||
@@ -241,7 +215,8 @@ mixin GlobalCycleDetectionMixin {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Access the current global dependency resolution chain for diagnostics.
|
/// RU: Получить текущую глобальную цепочку разрешения зависимостей.
|
||||||
|
/// ENG: Get current global dependency resolution chain.
|
||||||
List<String> get globalResolutionChain =>
|
List<String> get globalResolutionChain =>
|
||||||
GlobalCycleDetector.instance.globalResolutionChain;
|
GlobalCycleDetector.instance.globalResolutionChain;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,121 +3,77 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
// See the License for the specific language governing permissions and
|
// See the License for the specific language governing permissions and
|
||||||
// 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:cherrypick/src/global_cycle_detector.dart';
|
||||||
import 'package:cherrypick/src/observer.dart';
|
|
||||||
import 'package:meta/meta.dart';
|
import 'package:meta/meta.dart';
|
||||||
|
|
||||||
Scope? _rootScope;
|
Scope? _rootScope;
|
||||||
|
|
||||||
/// Global logger for all [Scope]s managed by [CherryPick].
|
|
||||||
///
|
|
||||||
/// Defaults to [SilentLogger] unless set via [setGlobalLogger].
|
|
||||||
CherryPickObserver _globalObserver = SilentCherryPickObserver();
|
|
||||||
|
|
||||||
/// Whether global local-cycle detection is enabled for all Scopes ([Scope.enableCycleDetection]).
|
|
||||||
bool _globalCycleDetectionEnabled = false;
|
bool _globalCycleDetectionEnabled = false;
|
||||||
|
|
||||||
/// Whether global cross-scope cycle detection is enabled ([Scope.enableGlobalCycleDetection]).
|
|
||||||
bool _globalCrossScopeCycleDetectionEnabled = false;
|
bool _globalCrossScopeCycleDetectionEnabled = false;
|
||||||
|
|
||||||
/// Static facade for managing dependency graph, root scope, subscopes, logger, and global settings in the CherryPick DI container.
|
|
||||||
///
|
|
||||||
/// - Provides a singleton root scope for simple integration.
|
|
||||||
/// - Supports hierarchical/named subscopes by string path.
|
|
||||||
/// - Manages global/protected logging and DI diagnostics.
|
|
||||||
/// - Suitable for most application & CLI scenarios. For test isolation, manually create [Scope]s instead.
|
|
||||||
///
|
|
||||||
/// ### Example: Opening a root scope and installing modules
|
|
||||||
/// ```dart
|
|
||||||
/// class AppModule extends Module {
|
|
||||||
/// @override
|
|
||||||
/// void builder(Scope scope) {
|
|
||||||
/// scope.bind<Service>().toProvide(() => ServiceImpl());
|
|
||||||
/// }
|
|
||||||
/// }
|
|
||||||
///
|
|
||||||
/// final root = CherryPick.openRootScope();
|
|
||||||
/// root.installModules([AppModule()]);
|
|
||||||
/// final service = root.resolve<Service>();
|
|
||||||
/// ```
|
|
||||||
class CherryPick {
|
class CherryPick {
|
||||||
/// Sets the global logger for all [Scope]s created by CherryPick.
|
/// RU: Метод открывает главный [Scope].
|
||||||
|
/// ENG: The method opens the main [Scope].
|
||||||
///
|
///
|
||||||
/// Allows customizing log output and DI diagnostics globally.
|
/// return
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// CherryPick.setGlobalLogger(DefaultLogger());
|
|
||||||
/// ```
|
|
||||||
static void setGlobalObserver(CherryPickObserver observer) {
|
|
||||||
_globalObserver = observer;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Returns the current global logger used by CherryPick.
|
|
||||||
static CherryPickObserver get globalObserver => _globalObserver;
|
|
||||||
|
|
||||||
/// Returns the singleton root [Scope], creating it if needed.
|
|
||||||
///
|
|
||||||
/// Applies configured [globalLogger] and cycle detection settings.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// final root = CherryPick.openRootScope();
|
|
||||||
/// ```
|
|
||||||
static Scope openRootScope() {
|
static Scope openRootScope() {
|
||||||
_rootScope ??= Scope(null, observer: _globalObserver);
|
_rootScope ??= Scope(null);
|
||||||
// Apply cycle detection settings
|
|
||||||
|
// Применяем глобальную настройку обнаружения циклических зависимостей
|
||||||
if (_globalCycleDetectionEnabled && !_rootScope!.isCycleDetectionEnabled) {
|
if (_globalCycleDetectionEnabled && !_rootScope!.isCycleDetectionEnabled) {
|
||||||
_rootScope!.enableCycleDetection();
|
_rootScope!.enableCycleDetection();
|
||||||
}
|
}
|
||||||
if (_globalCrossScopeCycleDetectionEnabled &&
|
|
||||||
!_rootScope!.isGlobalCycleDetectionEnabled) {
|
// Применяем глобальную настройку обнаружения между скоупами
|
||||||
|
if (_globalCrossScopeCycleDetectionEnabled && !_rootScope!.isGlobalCycleDetectionEnabled) {
|
||||||
_rootScope!.enableGlobalCycleDetection();
|
_rootScope!.enableGlobalCycleDetection();
|
||||||
}
|
}
|
||||||
|
|
||||||
return _rootScope!;
|
return _rootScope!;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Disposes and resets the root [Scope] singleton.
|
/// RU: Метод закрывает главный [Scope].
|
||||||
|
/// ENG: The method close the main [Scope].
|
||||||
///
|
///
|
||||||
/// Call before tests or when needing full re-initialization.
|
|
||||||
///
|
///
|
||||||
/// Example:
|
static void closeRootScope() {
|
||||||
/// ```dart
|
|
||||||
/// CherryPick.closeRootScope();
|
|
||||||
/// ```
|
|
||||||
static Future<void> closeRootScope() async {
|
|
||||||
if (_rootScope != null) {
|
if (_rootScope != null) {
|
||||||
await _rootScope!
|
|
||||||
.dispose(); // Автоматический вызов dispose для rootScope!
|
|
||||||
_rootScope = null;
|
_rootScope = null;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Globally enables cycle detection for all new [Scope]s created by CherryPick.
|
/// RU: Глобально включает обнаружение циклических зависимостей для всех новых скоупов.
|
||||||
|
/// ENG: Globally enables circular dependency detection for all new scopes.
|
||||||
///
|
///
|
||||||
/// Strongly recommended for safety in all projects.
|
/// Этот метод влияет на все скоупы, создаваемые через CherryPick.
|
||||||
|
/// This method affects all scopes created through CherryPick.
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// CherryPick.enableGlobalCycleDetection();
|
/// CherryPick.enableGlobalCycleDetection();
|
||||||
|
/// final scope = CherryPick.openRootScope(); // Автоматически включено обнаружение
|
||||||
/// ```
|
/// ```
|
||||||
static void enableGlobalCycleDetection() {
|
static void enableGlobalCycleDetection() {
|
||||||
_globalCycleDetectionEnabled = true;
|
_globalCycleDetectionEnabled = true;
|
||||||
|
|
||||||
|
// Включаем для уже существующего root scope, если он есть
|
||||||
if (_rootScope != null) {
|
if (_rootScope != null) {
|
||||||
_rootScope!.enableCycleDetection();
|
_rootScope!.enableCycleDetection();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Disables global local cycle detection. Existing and new scopes won't check for local cycles.
|
/// RU: Глобально отключает обнаружение циклических зависимостей.
|
||||||
|
/// ENG: Globally disables circular dependency detection.
|
||||||
|
///
|
||||||
|
/// Рекомендуется использовать в production для максимальной производительности.
|
||||||
|
/// Recommended for production use for maximum performance.
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
@@ -125,67 +81,85 @@ class CherryPick {
|
|||||||
/// ```
|
/// ```
|
||||||
static void disableGlobalCycleDetection() {
|
static void disableGlobalCycleDetection() {
|
||||||
_globalCycleDetectionEnabled = false;
|
_globalCycleDetectionEnabled = false;
|
||||||
|
|
||||||
|
// Отключаем для уже существующего root scope, если он есть
|
||||||
if (_rootScope != null) {
|
if (_rootScope != null) {
|
||||||
_rootScope!.disableCycleDetection();
|
_rootScope!.disableCycleDetection();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns `true` if global local cycle detection is enabled.
|
/// 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;
|
static bool get isGlobalCycleDetectionEnabled => _globalCycleDetectionEnabled;
|
||||||
|
|
||||||
/// Enables cycle detection for a particular scope tree.
|
/// RU: Включает обнаружение циклических зависимостей для конкретного скоупа.
|
||||||
|
/// ENG: Enables circular dependency detection for a specific scope.
|
||||||
///
|
///
|
||||||
/// [scopeName] - hierarchical string path (e.g. 'feature.api'), or empty for root.
|
/// [scopeName] - имя скоупа (пустая строка для root scope)
|
||||||
/// [separator] - path separator (default: '.'), e.g. '/' for "feature/api/module"
|
/// [scopeName] - scope name (empty string for root scope)
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// CherryPick.enableCycleDetectionForScope(scopeName: 'api.feature');
|
/// CherryPick.enableCycleDetectionForScope(); // Для root scope
|
||||||
|
/// CherryPick.enableCycleDetectionForScope(scopeName: 'feature.auth'); // Для конкретного scope
|
||||||
/// ```
|
/// ```
|
||||||
static void enableCycleDetectionForScope(
|
static void enableCycleDetectionForScope({String scopeName = '', String separator = '.'}) {
|
||||||
{String scopeName = '', String separator = '.'}) {
|
|
||||||
final scope = _getScope(scopeName, separator);
|
final scope = _getScope(scopeName, separator);
|
||||||
scope.enableCycleDetection();
|
scope.enableCycleDetection();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Disables cycle detection for a given scope. See [enableCycleDetectionForScope].
|
/// RU: Отключает обнаружение циклических зависимостей для конкретного скоупа.
|
||||||
static void disableCycleDetectionForScope(
|
/// ENG: Disables circular dependency detection for a specific scope.
|
||||||
{String scopeName = '', String separator = '.'}) {
|
///
|
||||||
|
/// [scopeName] - имя скоупа (пустая строка для root scope)
|
||||||
|
/// [scopeName] - scope name (empty string for root scope)
|
||||||
|
static void disableCycleDetectionForScope({String scopeName = '', String separator = '.'}) {
|
||||||
final scope = _getScope(scopeName, separator);
|
final scope = _getScope(scopeName, separator);
|
||||||
scope.disableCycleDetection();
|
scope.disableCycleDetection();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns `true` if cycle detection is enabled for the requested scope.
|
/// RU: Проверяет, включено ли обнаружение циклических зависимостей для конкретного скоупа.
|
||||||
|
/// ENG: Checks if circular dependency detection is enabled for a specific scope.
|
||||||
///
|
///
|
||||||
/// Example:
|
/// [scopeName] - имя скоупа (пустая строка для root scope)
|
||||||
/// ```dart
|
/// [scopeName] - scope name (empty string for root scope)
|
||||||
/// CherryPick.isCycleDetectionEnabledForScope(scopeName: 'feature.api');
|
///
|
||||||
/// ```
|
/// return true если включено, false если отключено
|
||||||
static bool isCycleDetectionEnabledForScope(
|
/// return true if enabled, false if disabled
|
||||||
{String scopeName = '', String separator = '.'}) {
|
static bool isCycleDetectionEnabledForScope({String scopeName = '', String separator = '.'}) {
|
||||||
final scope = _getScope(scopeName, separator);
|
final scope = _getScope(scopeName, separator);
|
||||||
return scope.isCycleDetectionEnabled;
|
return scope.isCycleDetectionEnabled;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the current dependency resolution chain inside the given scope.
|
/// RU: Возвращает текущую цепочку разрешения зависимостей для конкретного скоупа.
|
||||||
|
/// ENG: Returns current dependency resolution chain for a specific scope.
|
||||||
///
|
///
|
||||||
/// Useful for diagnostics (to print what types are currently resolving).
|
/// Полезно для отладки и анализа зависимостей.
|
||||||
|
/// Useful for debugging and dependency analysis.
|
||||||
///
|
///
|
||||||
/// Example:
|
/// [scopeName] - имя скоупа (пустая строка для root scope)
|
||||||
/// ```dart
|
/// [scopeName] - scope name (empty string for root scope)
|
||||||
/// print(CherryPick.getCurrentResolutionChain(scopeName: 'feature.api'));
|
///
|
||||||
/// ```
|
/// return список имен зависимостей в текущей цепочке разрешения
|
||||||
static List<String> getCurrentResolutionChain(
|
/// return list of dependency names in current resolution chain
|
||||||
{String scopeName = '', String separator = '.'}) {
|
static List<String> getCurrentResolutionChain({String scopeName = '', String separator = '.'}) {
|
||||||
final scope = _getScope(scopeName, separator);
|
final scope = _getScope(scopeName, separator);
|
||||||
return scope.currentResolutionChain;
|
return scope.currentResolutionChain;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Opens the root scope and enables local cycle detection.
|
/// RU: Создает новый скоуп с автоматически включенным обнаружением циклических зависимостей.
|
||||||
|
/// ENG: Creates a new scope with automatically enabled circular dependency detection.
|
||||||
|
///
|
||||||
|
/// Удобный метод для создания безопасных скоупов в development режиме.
|
||||||
|
/// Convenient method for creating safe scopes in development mode.
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// final safeRoot = CherryPick.openSafeRootScope();
|
/// final scope = CherryPick.openSafeRootScope();
|
||||||
|
/// // Обнаружение циклических зависимостей автоматически включено
|
||||||
/// ```
|
/// ```
|
||||||
static Scope openSafeRootScope() {
|
static Scope openSafeRootScope() {
|
||||||
final scope = openRootScope();
|
final scope = openRootScope();
|
||||||
@@ -193,11 +167,16 @@ class CherryPick {
|
|||||||
return scope;
|
return scope;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Opens a named/nested scope and enables local cycle detection for it.
|
/// RU: Создает новый дочерний скоуп с автоматически включенным обнаружением циклических зависимостей.
|
||||||
|
/// ENG: Creates a new child scope with automatically enabled circular dependency detection.
|
||||||
|
///
|
||||||
|
/// [scopeName] - имя скоупа
|
||||||
|
/// [scopeName] - scope name
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// final api = CherryPick.openSafeScope(scopeName: 'feature.api');
|
/// final scope = CherryPick.openSafeScope(scopeName: 'feature.auth');
|
||||||
|
/// // Обнаружение циклических зависимостей автоматически включено
|
||||||
/// ```
|
/// ```
|
||||||
static Scope openSafeScope({String scopeName = '', String separator = '.'}) {
|
static Scope openSafeScope({String scopeName = '', String separator = '.'}) {
|
||||||
final scope = openScope(scopeName: scopeName, separator: separator);
|
final scope = openScope(scopeName: scopeName, separator: separator);
|
||||||
@@ -205,8 +184,8 @@ class CherryPick {
|
|||||||
return scope;
|
return scope;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns a [Scope] by path (or the root if none specified).
|
/// RU: Внутренний метод для получения скоупа по имени.
|
||||||
/// Used for internal diagnostics & helpers.
|
/// ENG: Internal method to get scope by name.
|
||||||
static Scope _getScope(String scopeName, String separator) {
|
static Scope _getScope(String scopeName, String separator) {
|
||||||
if (scopeName.isEmpty) {
|
if (scopeName.isEmpty) {
|
||||||
return openRootScope();
|
return openRootScope();
|
||||||
@@ -214,75 +193,91 @@ class CherryPick {
|
|||||||
return openScope(scopeName: scopeName, separator: separator);
|
return openScope(scopeName: scopeName, separator: separator);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Opens (and creates nested subscopes if needed) a scope by hierarchical path.
|
/// RU: Метод открывает дочерний [Scope].
|
||||||
|
/// ENG: The method open the child [Scope].
|
||||||
///
|
///
|
||||||
/// [scopeName] - dot-separated path ("api.feature"). Empty = root.
|
/// Дочерний [Scope] открывается с [scopeName]
|
||||||
/// [separator] - path delimiter (default: '.')
|
/// Child [Scope] open with [scopeName]
|
||||||
///
|
|
||||||
/// Applies global cycle detection settings to the returned scope.
|
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
|
||||||
/// final apiScope = CherryPick.openScope(scopeName: 'network.super.api');
|
|
||||||
/// ```
|
/// ```
|
||||||
|
/// final String scopeName = 'firstScope.secondScope';
|
||||||
|
/// final subScope = CherryPick.openScope(scopeName);
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
///
|
||||||
@experimental
|
@experimental
|
||||||
static Scope openScope({String scopeName = '', String separator = '.'}) {
|
static Scope openScope({String scopeName = '', String separator = '.'}) {
|
||||||
if (scopeName.isEmpty) {
|
if (scopeName.isEmpty) {
|
||||||
return openRootScope();
|
return openRootScope();
|
||||||
}
|
}
|
||||||
|
|
||||||
final nameParts = scopeName.split(separator);
|
final nameParts = scopeName.split(separator);
|
||||||
if (nameParts.isEmpty) {
|
if (nameParts.isEmpty) {
|
||||||
throw Exception('Can not open sub scope because scopeName can not split');
|
throw Exception('Can not open sub scope because scopeName can not split');
|
||||||
}
|
}
|
||||||
final scope = nameParts.fold(openRootScope(),
|
|
||||||
(Scope previous, String element) => previous.openSubScope(element));
|
final scope = nameParts.fold(
|
||||||
|
openRootScope(),
|
||||||
|
(Scope previousValue, String element) =>
|
||||||
|
previousValue.openSubScope(element));
|
||||||
|
|
||||||
|
// Применяем глобальную настройку обнаружения циклических зависимостей
|
||||||
if (_globalCycleDetectionEnabled && !scope.isCycleDetectionEnabled) {
|
if (_globalCycleDetectionEnabled && !scope.isCycleDetectionEnabled) {
|
||||||
scope.enableCycleDetection();
|
scope.enableCycleDetection();
|
||||||
}
|
}
|
||||||
if (_globalCrossScopeCycleDetectionEnabled &&
|
|
||||||
!scope.isGlobalCycleDetectionEnabled) {
|
// Применяем глобальную настройку обнаружения между скоупами
|
||||||
|
if (_globalCrossScopeCycleDetectionEnabled && !scope.isGlobalCycleDetectionEnabled) {
|
||||||
scope.enableGlobalCycleDetection();
|
scope.enableGlobalCycleDetection();
|
||||||
}
|
}
|
||||||
|
|
||||||
return scope;
|
return scope;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Closes a named or root scope (if [scopeName] is omitted).
|
/// RU: Метод открывает дочерний [Scope].
|
||||||
|
/// ENG: The method open the child [Scope].
|
||||||
///
|
///
|
||||||
/// [scopeName] - dot-separated hierarchical path (e.g. 'api.feature'). Empty = root.
|
/// Дочерний [Scope] открывается с [scopeName]
|
||||||
/// [separator] - path delimiter.
|
/// Child [Scope] open with [scopeName]
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
|
||||||
/// CherryPick.closeScope(scopeName: 'network.super.api');
|
|
||||||
/// ```
|
/// ```
|
||||||
|
/// final String scopeName = 'firstScope.secondScope';
|
||||||
|
/// final subScope = CherryPick.closeScope(scopeName);
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
///
|
||||||
@experimental
|
@experimental
|
||||||
static Future<void> closeScope(
|
static void closeScope({String scopeName = '', String separator = '.'}) {
|
||||||
{String scopeName = '', String separator = '.'}) async {
|
|
||||||
if (scopeName.isEmpty) {
|
if (scopeName.isEmpty) {
|
||||||
await closeRootScope();
|
closeRootScope();
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
final nameParts = scopeName.split(separator);
|
final nameParts = scopeName.split(separator);
|
||||||
if (nameParts.isEmpty) {
|
if (nameParts.isEmpty) {
|
||||||
throw Exception(
|
throw Exception(
|
||||||
'Can not close sub scope because scopeName can not split');
|
'Can not close sub scope because scopeName can not split');
|
||||||
}
|
}
|
||||||
|
|
||||||
if (nameParts.length > 1) {
|
if (nameParts.length > 1) {
|
||||||
final lastPart = nameParts.removeLast();
|
final lastPart = nameParts.removeLast();
|
||||||
final scope = nameParts.fold(openRootScope(),
|
|
||||||
(Scope previous, String element) => previous.openSubScope(element));
|
final scope = nameParts.fold(
|
||||||
await scope.closeSubScope(lastPart);
|
openRootScope(),
|
||||||
|
(Scope previousValue, String element) =>
|
||||||
|
previousValue.openSubScope(element));
|
||||||
|
scope.closeSubScope(lastPart);
|
||||||
} else {
|
} else {
|
||||||
await openRootScope().closeSubScope(nameParts.first);
|
openRootScope().closeSubScope(nameParts[0]);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Enables cross-scope cycle detection globally.
|
/// RU: Глобально включает обнаружение циклических зависимостей между скоупами.
|
||||||
|
/// ENG: Globally enables cross-scope circular dependency detection.
|
||||||
///
|
///
|
||||||
/// This will activate detection of cycles that may span across multiple scopes
|
/// Этот режим обнаруживает циклические зависимости во всей иерархии скоупов.
|
||||||
/// in the entire dependency graph. All new and existing [Scope]s will participate.
|
/// This mode detects circular dependencies across the entire scope hierarchy.
|
||||||
///
|
|
||||||
/// Strongly recommended for complex solutions with modular architecture.
|
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
@@ -290,15 +285,15 @@ class CherryPick {
|
|||||||
/// ```
|
/// ```
|
||||||
static void enableGlobalCrossScopeCycleDetection() {
|
static void enableGlobalCrossScopeCycleDetection() {
|
||||||
_globalCrossScopeCycleDetectionEnabled = true;
|
_globalCrossScopeCycleDetectionEnabled = true;
|
||||||
|
|
||||||
|
// Включаем для уже существующего root scope, если он есть
|
||||||
if (_rootScope != null) {
|
if (_rootScope != null) {
|
||||||
_rootScope!.enableGlobalCycleDetection();
|
_rootScope!.enableGlobalCycleDetection();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Disables global cross-scope cycle detection.
|
/// RU: Глобально отключает обнаружение циклических зависимостей между скоупами.
|
||||||
///
|
/// ENG: Globally disables cross-scope circular dependency detection.
|
||||||
/// Existing and new scopes stop checking for global (cross-scope) cycles.
|
|
||||||
/// The internal global cycle detector will be cleared as well.
|
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
@@ -306,56 +301,54 @@ class CherryPick {
|
|||||||
/// ```
|
/// ```
|
||||||
static void disableGlobalCrossScopeCycleDetection() {
|
static void disableGlobalCrossScopeCycleDetection() {
|
||||||
_globalCrossScopeCycleDetectionEnabled = false;
|
_globalCrossScopeCycleDetectionEnabled = false;
|
||||||
|
|
||||||
|
// Отключаем для уже существующего root scope, если он есть
|
||||||
if (_rootScope != null) {
|
if (_rootScope != null) {
|
||||||
_rootScope!.disableGlobalCycleDetection();
|
_rootScope!.disableGlobalCycleDetection();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Очищаем глобальный детектор
|
||||||
GlobalCycleDetector.instance.clear();
|
GlobalCycleDetector.instance.clear();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns `true` if global cross-scope cycle detection is enabled.
|
/// RU: Проверяет, включено ли глобальное обнаружение циклических зависимостей между скоупами.
|
||||||
|
/// ENG: Checks if global cross-scope circular dependency detection is enabled.
|
||||||
///
|
///
|
||||||
/// Example:
|
/// return true если включено, false если отключено
|
||||||
/// ```dart
|
/// return true if enabled, false if disabled
|
||||||
/// if (CherryPick.isGlobalCrossScopeCycleDetectionEnabled) {
|
static bool get isGlobalCrossScopeCycleDetectionEnabled => _globalCrossScopeCycleDetectionEnabled;
|
||||||
/// print('Global cross-scope detection is ON');
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
static bool get isGlobalCrossScopeCycleDetectionEnabled =>
|
|
||||||
_globalCrossScopeCycleDetectionEnabled;
|
|
||||||
|
|
||||||
/// Returns the current global dependency resolution chain (across all scopes).
|
/// RU: Возвращает глобальную цепочку разрешения зависимостей.
|
||||||
|
/// ENG: Returns global dependency resolution chain.
|
||||||
///
|
///
|
||||||
/// Shows the cross-scope resolution stack, which is useful for advanced diagnostics
|
/// Полезно для отладки циклических зависимостей между скоупами.
|
||||||
/// and debugging cycle issues that occur between scopes.
|
/// Useful for debugging circular dependencies across scopes.
|
||||||
///
|
///
|
||||||
/// Example:
|
/// return список имен зависимостей в глобальной цепочке разрешения
|
||||||
/// ```dart
|
/// return list of dependency names in global resolution chain
|
||||||
/// print(CherryPick.getGlobalResolutionChain());
|
|
||||||
/// ```
|
|
||||||
static List<String> getGlobalResolutionChain() {
|
static List<String> getGlobalResolutionChain() {
|
||||||
return GlobalCycleDetector.instance.globalResolutionChain;
|
return GlobalCycleDetector.instance.globalResolutionChain;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Clears the global cross-scope cycle detector.
|
/// RU: Очищает все состояние глобального детектора циклических зависимостей.
|
||||||
|
/// ENG: Clears all global circular dependency detector state.
|
||||||
///
|
///
|
||||||
/// Useful in tests or when resetting application state.
|
/// Полезно для тестов и сброса состояния.
|
||||||
///
|
/// Useful for tests and state reset.
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// CherryPick.clearGlobalCycleDetector();
|
|
||||||
/// ```
|
|
||||||
static void clearGlobalCycleDetector() {
|
static void clearGlobalCycleDetector() {
|
||||||
GlobalCycleDetector.reset();
|
GlobalCycleDetector.reset();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Opens the root scope with both local and global cross-scope cycle detection enabled.
|
/// RU: Создает новый скоуп с автоматически включенным глобальным обнаружением циклических зависимостей.
|
||||||
|
/// ENG: Creates a new scope with automatically enabled global circular dependency detection.
|
||||||
///
|
///
|
||||||
/// This is the safest way to start IoC for most apps — cycles will be detected
|
/// Этот скоуп будет отслеживать циклические зависимости во всей иерархии.
|
||||||
/// both inside a single scope and between scopes.
|
/// This scope will track circular dependencies across the entire hierarchy.
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// final root = CherryPick.openGlobalSafeRootScope();
|
/// final scope = CherryPick.openGlobalSafeRootScope();
|
||||||
|
/// // Глобальное обнаружение циклических зависимостей автоматически включено
|
||||||
/// ```
|
/// ```
|
||||||
static Scope openGlobalSafeRootScope() {
|
static Scope openGlobalSafeRootScope() {
|
||||||
final scope = openRootScope();
|
final scope = openRootScope();
|
||||||
@@ -364,16 +357,18 @@ class CherryPick {
|
|||||||
return scope;
|
return scope;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Opens the given named/nested scope and enables both local and cross-scope cycle detection on it.
|
/// RU: Создает новый дочерний скоуп с автоматически включенным глобальным обнаружением циклических зависимостей.
|
||||||
|
/// ENG: Creates a new child scope with automatically enabled global circular dependency detection.
|
||||||
///
|
///
|
||||||
/// Recommended when creating feature/module scopes in large apps.
|
/// [scopeName] - имя скоупа
|
||||||
|
/// [scopeName] - scope name
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// final featureScope = CherryPick.openGlobalSafeScope(scopeName: 'featureA.api');
|
/// final scope = CherryPick.openGlobalSafeScope(scopeName: 'feature.auth');
|
||||||
|
/// // Глобальное обнаружение циклических зависимостей автоматически включено
|
||||||
/// ```
|
/// ```
|
||||||
static Scope openGlobalSafeScope(
|
static Scope openGlobalSafeScope({String scopeName = '', String separator = '.'}) {
|
||||||
{String scopeName = '', String separator = '.'}) {
|
|
||||||
final scope = openScope(scopeName: scopeName, separator: separator);
|
final scope = openScope(scopeName: scopeName, separator: separator);
|
||||||
scope.enableCycleDetection();
|
scope.enableCycleDetection();
|
||||||
scope.enableGlobalCycleDetection();
|
scope.enableGlobalCycleDetection();
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -15,71 +15,39 @@ import 'dart:collection';
|
|||||||
import 'package:cherrypick/src/binding.dart';
|
import 'package:cherrypick/src/binding.dart';
|
||||||
import 'package:cherrypick/src/scope.dart';
|
import 'package:cherrypick/src/scope.dart';
|
||||||
|
|
||||||
/// Represents a DI module—a reusable group of dependency bindings.
|
/// RU: Класс Module является основой для пользовательских модулей.
|
||||||
|
/// Этот класс нужен для инициализации [Scope].
|
||||||
///
|
///
|
||||||
/// Extend [Module] to declaratively group related [Binding] definitions,
|
/// RU: The Module class is the basis for custom modules.
|
||||||
/// then install your module(s) into a [Scope] for dependency resolution.
|
/// This class is needed to initialize [Scope].
|
||||||
///
|
|
||||||
/// Modules make it easier to organize your DI configuration for features, layers,
|
|
||||||
/// infrastructure, or integration, and support modular app architecture.
|
|
||||||
///
|
|
||||||
/// Usage example:
|
|
||||||
/// ```dart
|
|
||||||
/// class AppModule extends Module {
|
|
||||||
/// @override
|
|
||||||
/// void builder(Scope currentScope) {
|
|
||||||
/// bind<NetworkService>().toProvide(() => NetworkService());
|
|
||||||
/// bind<AuthService>().toProvide(() => AuthService(currentScope.resolve<NetworkService>()));
|
|
||||||
/// bind<Config>().toInstance(Config.dev());
|
|
||||||
/// }
|
|
||||||
/// }
|
|
||||||
///
|
|
||||||
/// // Installing the module into the root DI scope:
|
|
||||||
/// final rootScope = CherryPick.openRootScope();
|
|
||||||
/// rootScope.installModules([AppModule()]);
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Combine several modules and submodules to implement scalable architectures.
|
|
||||||
///
|
///
|
||||||
abstract class Module {
|
abstract class Module {
|
||||||
final Set<Binding> _bindingSet = HashSet();
|
final Set<Binding> _bindingSet = HashSet();
|
||||||
|
|
||||||
/// Begins the declaration of a new binding within this module.
|
/// RU: Метод добавляет в коллекцию модуля [Binding] экземпляр.
|
||||||
///
|
///
|
||||||
/// Typically used within [builder] to register all needed dependency bindings.
|
/// ENG: The method adds an instance to the collection of the [Binding] module.
|
||||||
///
|
///
|
||||||
/// Example:
|
/// return [Binding<T>]
|
||||||
/// ```dart
|
|
||||||
/// bind<Api>().toProvide(() => MockApi());
|
|
||||||
/// bind<Config>().toInstance(Config.dev());
|
|
||||||
/// ```
|
|
||||||
Binding<T> bind<T>() {
|
Binding<T> bind<T>() {
|
||||||
final binding = Binding<T>();
|
final binding = Binding<T>();
|
||||||
_bindingSet.add(binding);
|
_bindingSet.add(binding);
|
||||||
return binding;
|
return binding;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the set of all [Binding] instances registered in this module.
|
/// RU: Метод возвращает коллекцию [Binding] экземпляров.
|
||||||
///
|
///
|
||||||
/// This is typically used internally by [Scope] during module installation,
|
/// ENG: The method returns a collection of [Binding] instances.
|
||||||
/// but can also be used for diagnostics or introspection.
|
///
|
||||||
|
/// return [Set<Binding>]
|
||||||
Set<Binding> get bindingSet => _bindingSet;
|
Set<Binding> get bindingSet => _bindingSet;
|
||||||
|
|
||||||
/// Abstract method where all dependency bindings are registered.
|
/// RU: Абстрактный метод для инициализации пользовательских экземпляров.
|
||||||
|
/// В этом методе осуществляется конфигурация зависимостей.
|
||||||
///
|
///
|
||||||
/// Override this method in your custom module subclass to declare
|
/// ENG: Abstract method for initializing custom instances.
|
||||||
/// all dependency bindings to be provided by this module.
|
/// This method configures dependencies.
|
||||||
///
|
///
|
||||||
/// The provided [currentScope] can be used for resolving other dependencies,
|
/// return [void]
|
||||||
/// accessing configuration, or controlling binding behavior dynamically.
|
|
||||||
///
|
|
||||||
/// Example (with dependency chaining):
|
|
||||||
/// ```dart
|
|
||||||
/// @override
|
|
||||||
/// void builder(Scope currentScope) {
|
|
||||||
/// bind<ApiClient>().toProvide(() => RestApi());
|
|
||||||
/// bind<UserRepo>().toProvide(() => UserRepo(currentScope.resolve<ApiClient>()));
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
void builder(Scope currentScope);
|
void builder(Scope currentScope);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,244 +0,0 @@
|
|||||||
//
|
|
||||||
// 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
|
|
||||||
// https://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.
|
|
||||||
//
|
|
||||||
|
|
||||||
/// An abstract Observer for CherryPick DI container events.
|
|
||||||
///
|
|
||||||
/// Extend this class to react to and log various events inside the CherryPick Dependency Injection container.
|
|
||||||
/// Allows monitoring of registration, creation, disposal, module changes, cache hits/misses, cycles, and
|
|
||||||
/// errors/warnings for improved diagnostics and debugging.
|
|
||||||
///
|
|
||||||
/// All methods have detailed event information, including name, type, scope, and other arguments.
|
|
||||||
///
|
|
||||||
/// Example: Logging and debugging container events
|
|
||||||
/// ```dart
|
|
||||||
/// final CherryPickObserver observer = PrintCherryPickObserver();
|
|
||||||
/// // Pass observer to CherryPick during setup
|
|
||||||
/// CherryPick.openRootScope(observer: observer);
|
|
||||||
/// ```
|
|
||||||
abstract class CherryPickObserver {
|
|
||||||
// === Registration and instance lifecycle ===
|
|
||||||
/// Called when a binding is registered within the container (new dependency mapping).
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onBindingRegistered('MyService', MyService, scopeName: 'root');
|
|
||||||
/// ```
|
|
||||||
void onBindingRegistered(String name, Type type, {String? scopeName});
|
|
||||||
|
|
||||||
/// Called when an instance is requested (before it is created or retrieved from cache).
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onInstanceRequested('MyService', MyService, scopeName: 'root');
|
|
||||||
/// ```
|
|
||||||
void onInstanceRequested(String name, Type type, {String? scopeName});
|
|
||||||
|
|
||||||
/// Called when a new instance is successfully created.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onInstanceCreated('MyService', MyService, instance, scopeName: 'root');
|
|
||||||
/// ```
|
|
||||||
void onInstanceCreated(String name, Type type, Object instance,
|
|
||||||
{String? scopeName});
|
|
||||||
|
|
||||||
/// Called when an instance is disposed (removed from cache and/or finalized).
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onInstanceDisposed('MyService', MyService, instance, scopeName: 'root');
|
|
||||||
/// ```
|
|
||||||
void onInstanceDisposed(String name, Type type, Object instance,
|
|
||||||
{String? scopeName});
|
|
||||||
|
|
||||||
// === Module events ===
|
|
||||||
/// Called when modules are installed into the container.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onModulesInstalled(['NetworkModule', 'RepositoryModule'], scopeName: 'root');
|
|
||||||
/// ```
|
|
||||||
void onModulesInstalled(List<String> moduleNames, {String? scopeName});
|
|
||||||
|
|
||||||
/// Called when modules are removed from the container.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onModulesRemoved(['RepositoryModule'], scopeName: 'root');
|
|
||||||
/// ```
|
|
||||||
void onModulesRemoved(List<String> moduleNames, {String? scopeName});
|
|
||||||
|
|
||||||
// === Scope lifecycle ===
|
|
||||||
/// Called when a new DI scope is opened (for example, starting a new feature or screen).
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onScopeOpened('user-session');
|
|
||||||
/// ```
|
|
||||||
void onScopeOpened(String name);
|
|
||||||
|
|
||||||
/// Called when an existing DI scope is closed.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onScopeClosed('user-session');
|
|
||||||
/// ```
|
|
||||||
void onScopeClosed(String name);
|
|
||||||
|
|
||||||
// === Cycle detection ===
|
|
||||||
/// Called if a dependency cycle is detected during resolution.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onCycleDetected(['A', 'B', 'C', 'A'], scopeName: 'root');
|
|
||||||
/// ```
|
|
||||||
void onCycleDetected(List<String> chain, {String? scopeName});
|
|
||||||
|
|
||||||
// === Cache events ===
|
|
||||||
/// Called when an instance is found in the cache.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onCacheHit('MyService', MyService, scopeName: 'root');
|
|
||||||
/// ```
|
|
||||||
void onCacheHit(String name, Type type, {String? scopeName});
|
|
||||||
|
|
||||||
/// Called when an instance is not found in the cache and should be created.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onCacheMiss('MyService', MyService, scopeName: 'root');
|
|
||||||
/// ```
|
|
||||||
void onCacheMiss(String name, Type type, {String? scopeName});
|
|
||||||
|
|
||||||
// === Diagnostic ===
|
|
||||||
/// Used for custom diagnostic and debug messages.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onDiagnostic('Cache cleared', details: detailsObj);
|
|
||||||
/// ```
|
|
||||||
void onDiagnostic(String message, {Object? details});
|
|
||||||
|
|
||||||
// === Warnings & errors ===
|
|
||||||
/// Called on non-fatal, recoverable DI container warnings.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onWarning('Binding override', details: {...});
|
|
||||||
/// ```
|
|
||||||
void onWarning(String message, {Object? details});
|
|
||||||
|
|
||||||
/// Called on error (typically exceptions thrown during resolution, instantiation, or disposal).
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// observer.onError('Failed to resolve dependency', errorObj, stackTraceObj);
|
|
||||||
/// ```
|
|
||||||
void onError(String message, Object? error, StackTrace? stackTrace);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Diagnostic/Debug observer that prints all events
|
|
||||||
class PrintCherryPickObserver implements CherryPickObserver {
|
|
||||||
@override
|
|
||||||
void onBindingRegistered(String name, Type type, {String? scopeName}) =>
|
|
||||||
print('[binding][CherryPick] $name — $type (scope: $scopeName)');
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onInstanceRequested(String name, Type type, {String? scopeName}) =>
|
|
||||||
print('[request][CherryPick] $name — $type (scope: $scopeName)');
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onInstanceCreated(String name, Type type, Object instance,
|
|
||||||
{String? scopeName}) =>
|
|
||||||
print(
|
|
||||||
'[create][CherryPick] $name — $type => $instance (scope: $scopeName)');
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onInstanceDisposed(String name, Type type, Object instance,
|
|
||||||
{String? scopeName}) =>
|
|
||||||
print(
|
|
||||||
'[dispose][CherryPick] $name — $type => $instance (scope: $scopeName)');
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onModulesInstalled(List<String> modules, {String? scopeName}) => print(
|
|
||||||
'[modules installed][CherryPick] ${modules.join(', ')} (scope: $scopeName)');
|
|
||||||
@override
|
|
||||||
void onModulesRemoved(List<String> modules, {String? scopeName}) => print(
|
|
||||||
'[modules removed][CherryPick] ${modules.join(', ')} (scope: $scopeName)');
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onScopeOpened(String name) => print('[scope opened][CherryPick] $name');
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onScopeClosed(String name) => print('[scope closed][CherryPick] $name');
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onCycleDetected(List<String> chain, {String? scopeName}) => print(
|
|
||||||
'[cycle][CherryPick] Detected: ${chain.join(' -> ')}${scopeName != null ? ' (scope: $scopeName)' : ''}');
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onCacheHit(String name, Type type, {String? scopeName}) =>
|
|
||||||
print('[cache hit][CherryPick] $name — $type (scope: $scopeName)');
|
|
||||||
@override
|
|
||||||
void onCacheMiss(String name, Type type, {String? scopeName}) =>
|
|
||||||
print('[cache miss][CherryPick] $name — $type (scope: $scopeName)');
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onDiagnostic(String message, {Object? details}) =>
|
|
||||||
print('[diagnostic][CherryPick] $message ${details ?? ''}');
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onWarning(String message, {Object? details}) =>
|
|
||||||
print('[warn][CherryPick] $message ${details ?? ''}');
|
|
||||||
@override
|
|
||||||
void onError(String message, Object? error, StackTrace? stackTrace) {
|
|
||||||
print('[error][CherryPick] $message');
|
|
||||||
if (error != null) print(' error: $error');
|
|
||||||
if (stackTrace != null) print(' stack: $stackTrace');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Silent observer: ignores all events
|
|
||||||
class SilentCherryPickObserver implements CherryPickObserver {
|
|
||||||
@override
|
|
||||||
void onBindingRegistered(String name, Type type, {String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onInstanceRequested(String name, Type type, {String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onInstanceCreated(String name, Type type, Object instance,
|
|
||||||
{String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onInstanceDisposed(String name, Type type, Object instance,
|
|
||||||
{String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onModulesInstalled(List<String> modules, {String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onModulesRemoved(List<String> modules, {String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onScopeOpened(String name) {}
|
|
||||||
@override
|
|
||||||
void onScopeClosed(String name) {}
|
|
||||||
@override
|
|
||||||
void onCycleDetected(List<String> chain, {String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onCacheHit(String name, Type type, {String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onCacheMiss(String name, Type type, {String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onDiagnostic(String message, {Object? details}) {}
|
|
||||||
@override
|
|
||||||
void onWarning(String message, {Object? details}) {}
|
|
||||||
@override
|
|
||||||
void onError(String message, Object? error, StackTrace? stackTrace) {}
|
|
||||||
}
|
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -13,84 +13,34 @@
|
|||||||
import 'dart:collection';
|
import 'dart:collection';
|
||||||
import 'dart:math';
|
import 'dart:math';
|
||||||
|
|
||||||
|
import 'package:cherrypick/src/binding.dart';
|
||||||
import 'package:cherrypick/src/cycle_detector.dart';
|
import 'package:cherrypick/src/cycle_detector.dart';
|
||||||
import 'package:cherrypick/src/disposable.dart';
|
|
||||||
import 'package:cherrypick/src/global_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';
|
||||||
import 'package:cherrypick/src/observer.dart';
|
|
||||||
// import 'package:cherrypick/src/log_format.dart';
|
|
||||||
|
|
||||||
/// Represents a DI scope (container) for modules, subscopes,
|
Scope openRootScope() => Scope(null);
|
||||||
/// and dependency resolution (sync/async) in CherryPick.
|
|
||||||
///
|
|
||||||
/// Scopes provide hierarchical DI: you can resolve dependencies from parents,
|
|
||||||
/// override or isolate modules, and manage scope-specific singletons.
|
|
||||||
///
|
|
||||||
/// Each scope:
|
|
||||||
/// - Can install modules ([installModules]) that define [Binding]s
|
|
||||||
/// - Supports parent-child scope tree (see [openSubScope])
|
|
||||||
/// - Can resolve dependencies synchronously ([resolve]) or asynchronously ([resolveAsync])
|
|
||||||
/// - Cleans up resources for [Disposable] objects (see [dispose])
|
|
||||||
/// - Detects dependency cycles (local and global, if enabled)
|
|
||||||
///
|
|
||||||
/// Example usage:
|
|
||||||
/// ```dart
|
|
||||||
/// final rootScope = CherryPick.openRootScope();
|
|
||||||
/// rootScope.installModules([AppModule()]);
|
|
||||||
///
|
|
||||||
/// // Synchronous resolution:
|
|
||||||
/// final auth = rootScope.resolve<AuthService>();
|
|
||||||
///
|
|
||||||
/// // Asynchronous resolution:
|
|
||||||
/// final db = await rootScope.resolveAsync<Database>();
|
|
||||||
///
|
|
||||||
/// // Open a child scope (for a feature, page, or test):
|
|
||||||
/// final userScope = rootScope.openSubScope('user');
|
|
||||||
/// userScope.installModules([UserModule()]);
|
|
||||||
///
|
|
||||||
/// // Proper resource cleanup (calls dispose() on tracked objects)
|
|
||||||
/// await CherryPick.closeRootScope();
|
|
||||||
/// ```
|
|
||||||
class Scope with CycleDetectionMixin, GlobalCycleDetectionMixin {
|
class Scope with CycleDetectionMixin, GlobalCycleDetectionMixin {
|
||||||
final Scope? _parentScope;
|
final Scope? _parentScope;
|
||||||
|
|
||||||
late final CherryPickObserver _observer;
|
/// RU: Метод возвращает родительский [Scope].
|
||||||
|
///
|
||||||
@override
|
/// ENG: The method returns the parent [Scope].
|
||||||
CherryPickObserver get observer => _observer;
|
///
|
||||||
|
/// return [Scope]
|
||||||
/// COLLECTS all resolved instances that implement [Disposable].
|
|
||||||
final Set<Disposable> _disposables = HashSet();
|
|
||||||
|
|
||||||
/// Returns the parent [Scope] if present, or null if this is the root scope.
|
|
||||||
Scope? get parentScope => _parentScope;
|
Scope? get parentScope => _parentScope;
|
||||||
|
|
||||||
final Map<String, Scope> _scopeMap = HashMap();
|
final Map<String, Scope> _scopeMap = HashMap();
|
||||||
|
|
||||||
Scope(this._parentScope, {required CherryPickObserver observer})
|
Scope(this._parentScope) {
|
||||||
: _observer = observer {
|
// Генерируем уникальный ID для скоупа
|
||||||
setScopeId(_generateScopeId());
|
setScopeId(_generateScopeId());
|
||||||
observer.onScopeOpened(scopeId ?? 'NO_ID');
|
|
||||||
observer.onDiagnostic(
|
|
||||||
'Scope created: ${scopeId ?? 'NO_ID'}',
|
|
||||||
details: {
|
|
||||||
'type': 'Scope',
|
|
||||||
'name': scopeId ?? 'NO_ID',
|
|
||||||
if (_parentScope?.scopeId != null) 'parent': _parentScope!.scopeId,
|
|
||||||
'description': 'scope created',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
final Set<Module> _modulesList = HashSet();
|
final Set<Module> _modulesList = HashSet();
|
||||||
|
|
||||||
// индекс для мгновенного поиска binding’ов
|
/// RU: Генерирует уникальный идентификатор для скоупа.
|
||||||
final Map<Object, Map<String?, BindingResolver>> _bindingResolvers = {};
|
/// ENG: Generates unique identifier for scope.
|
||||||
|
|
||||||
/// Generates a unique identifier string for this scope instance.
|
|
||||||
///
|
|
||||||
/// Used internally for diagnostics, logging and global scope tracking.
|
|
||||||
String _generateScopeId() {
|
String _generateScopeId() {
|
||||||
final random = Random();
|
final random = Random();
|
||||||
final timestamp = DateTime.now().millisecondsSinceEpoch;
|
final timestamp = DateTime.now().millisecondsSinceEpoch;
|
||||||
@@ -98,237 +48,121 @@ class Scope with CycleDetectionMixin, GlobalCycleDetectionMixin {
|
|||||||
return 'scope_${timestamp}_$randomPart';
|
return 'scope_${timestamp}_$randomPart';
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Opens a named child [Scope] (subscope) as a descendant of the current scope.
|
/// RU: Метод открывает дочерний (дополнительный) [Scope].
|
||||||
///
|
///
|
||||||
/// Subscopes inherit modules and DI context from their parent, but can override or extend bindings.
|
/// ENG: The method opens child (additional) [Scope].
|
||||||
/// Useful for feature-isolation, screens, request/transaction lifetimes, and test separation.
|
|
||||||
///
|
///
|
||||||
/// Example:
|
/// return [Scope]
|
||||||
/// ```dart
|
|
||||||
/// final featureScope = rootScope.openSubScope('feature');
|
|
||||||
/// featureScope.installModules([FeatureModule()]);
|
|
||||||
/// final dep = featureScope.resolve<MyDep>();
|
|
||||||
/// ```
|
|
||||||
Scope openSubScope(String name) {
|
Scope openSubScope(String name) {
|
||||||
if (!_scopeMap.containsKey(name)) {
|
if (!_scopeMap.containsKey(name)) {
|
||||||
final childScope = Scope(this, observer: observer);
|
final childScope = Scope(this);
|
||||||
|
|
||||||
|
// Наследуем настройки обнаружения циклических зависимостей
|
||||||
if (isCycleDetectionEnabled) {
|
if (isCycleDetectionEnabled) {
|
||||||
childScope.enableCycleDetection();
|
childScope.enableCycleDetection();
|
||||||
}
|
}
|
||||||
if (isGlobalCycleDetectionEnabled) {
|
if (isGlobalCycleDetectionEnabled) {
|
||||||
childScope.enableGlobalCycleDetection();
|
childScope.enableGlobalCycleDetection();
|
||||||
}
|
}
|
||||||
|
|
||||||
_scopeMap[name] = childScope;
|
_scopeMap[name] = childScope;
|
||||||
observer.onDiagnostic(
|
|
||||||
'SubScope created: $name',
|
|
||||||
details: {
|
|
||||||
'type': 'SubScope',
|
|
||||||
'name': name,
|
|
||||||
'id': childScope.scopeId,
|
|
||||||
if (scopeId != null) 'parent': scopeId,
|
|
||||||
'description': 'subscope created',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
return _scopeMap[name]!;
|
return _scopeMap[name]!;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Asynchronously closes and disposes a named child [Scope] (subscope).
|
/// RU: Метод закрывает дочерний (дополнительный) [Scope].
|
||||||
///
|
///
|
||||||
/// Ensures all [Disposable] objects and internal modules
|
/// ENG: The method closes child (additional) [Scope].
|
||||||
/// in the subscope are properly cleaned up. Also removes any global cycle detectors associated with the subscope.
|
|
||||||
///
|
///
|
||||||
/// Example:
|
/// return [Scope]
|
||||||
/// ```dart
|
void closeSubScope(String name) {
|
||||||
/// await rootScope.closeSubScope('feature');
|
|
||||||
/// ```
|
|
||||||
Future<void> closeSubScope(String name) async {
|
|
||||||
final childScope = _scopeMap[name];
|
final childScope = _scopeMap[name];
|
||||||
if (childScope != null) {
|
if (childScope != null) {
|
||||||
await childScope.dispose();
|
// Очищаем детектор для дочернего скоупа
|
||||||
if (childScope.scopeId != null) {
|
if (childScope.scopeId != null) {
|
||||||
GlobalCycleDetector.instance.removeScopeDetector(childScope.scopeId!);
|
GlobalCycleDetector.instance.removeScopeDetector(childScope.scopeId!);
|
||||||
}
|
}
|
||||||
observer.onScopeClosed(childScope.scopeId ?? name);
|
|
||||||
observer.onDiagnostic(
|
|
||||||
'SubScope closed: $name',
|
|
||||||
details: {
|
|
||||||
'type': 'SubScope',
|
|
||||||
'name': name,
|
|
||||||
'id': childScope.scopeId,
|
|
||||||
if (scopeId != null) 'parent': scopeId,
|
|
||||||
'description': 'subscope closed',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
_scopeMap.remove(name);
|
_scopeMap.remove(name);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Installs a list of custom [Module]s into the [Scope].
|
/// RU: Метод инициализирует пользовательские модули в [Scope].
|
||||||
///
|
///
|
||||||
/// Each module registers bindings and configuration for dependencies.
|
/// ENG: The method initializes custom modules in [Scope].
|
||||||
/// After calling this, bindings are immediately available for resolve/tryResolve.
|
|
||||||
///
|
///
|
||||||
/// Example:
|
/// return [Scope]
|
||||||
/// ```dart
|
|
||||||
/// rootScope.installModules([AppModule(), NetworkModule()]);
|
|
||||||
/// ```
|
|
||||||
Scope installModules(List<Module> modules) {
|
Scope installModules(List<Module> modules) {
|
||||||
_modulesList.addAll(modules);
|
_modulesList.addAll(modules);
|
||||||
if (modules.isNotEmpty) {
|
|
||||||
observer.onModulesInstalled(
|
|
||||||
modules.map((m) => m.runtimeType.toString()).toList(),
|
|
||||||
scopeName: scopeId,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
for (var module in modules) {
|
for (var module in modules) {
|
||||||
observer.onDiagnostic(
|
|
||||||
'Module installed: ${module.runtimeType}',
|
|
||||||
details: {
|
|
||||||
'type': 'Module',
|
|
||||||
'name': module.runtimeType.toString(),
|
|
||||||
'scope': scopeId,
|
|
||||||
'description': 'module installed',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
module.builder(this);
|
module.builder(this);
|
||||||
// Associate bindings with this scope's observer
|
|
||||||
for (final binding in module.bindingSet) {
|
|
||||||
binding.observer = observer;
|
|
||||||
binding.logAllDeferred();
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
_rebuildResolversIndex();
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Removes all installed [Module]s and their bindings from this [Scope].
|
/// RU: Метод удаляет пользовательские модули из [Scope].
|
||||||
///
|
///
|
||||||
/// Typically used in tests or when resetting app configuration/runtime environment.
|
/// ENG: This method removes custom modules from [Scope].
|
||||||
/// Note: this does not dispose resolved [Disposable]s (call [dispose] for that).
|
|
||||||
///
|
///
|
||||||
/// Example:
|
/// return [Scope]
|
||||||
/// ```dart
|
|
||||||
/// testScope.dropModules();
|
|
||||||
/// ```
|
|
||||||
Scope dropModules() {
|
Scope dropModules() {
|
||||||
if (_modulesList.isNotEmpty) {
|
// [AlexeyYuPopkov](https://github.com/AlexeyYuPopkov) Thank you for the [Removed exception "ConcurrentModificationError"](https://github.com/pese-git/cherrypick/pull/2)
|
||||||
observer.onModulesRemoved(
|
|
||||||
_modulesList.map((m) => m.runtimeType.toString()).toList(),
|
|
||||||
scopeName: scopeId,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
observer.onDiagnostic(
|
|
||||||
'Modules dropped for scope: $scopeId',
|
|
||||||
details: {
|
|
||||||
'type': 'Scope',
|
|
||||||
'name': scopeId,
|
|
||||||
'description': 'modules dropped',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
_modulesList.clear();
|
_modulesList.clear();
|
||||||
_rebuildResolversIndex();
|
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Resolves a dependency of type [T], optionally by name and with params.
|
/// RU: Возвращает найденную зависимость, определенную параметром типа [T].
|
||||||
|
/// Выдает [StateError], если зависимость не может быть разрешена.
|
||||||
|
/// Если вы хотите получить [null], если зависимость не может быть найдена,
|
||||||
|
/// то используйте вместо этого [tryResolve]
|
||||||
|
/// return - возвращает объект типа [T] или [StateError]
|
||||||
///
|
///
|
||||||
/// Throws [StateError] if the dependency cannot be resolved. (Use [tryResolve] for fallible lookup).
|
/// ENG: Returns the found dependency specified by the type parameter [T].
|
||||||
/// Resolves from installed modules or recurses up the parent scope chain.
|
/// Throws [StateError] if the dependency cannot be resolved.
|
||||||
|
/// If you want to get [null] if the dependency cannot be found then use [tryResolve] instead
|
||||||
|
/// return - returns an object of type [T] or [StateError]
|
||||||
///
|
///
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// final logger = scope.resolve<Logger>();
|
|
||||||
/// final special = scope.resolve<Service>(named: 'special');
|
|
||||||
/// ```
|
|
||||||
T resolve<T>({String? named, dynamic params}) {
|
T resolve<T>({String? named, dynamic params}) {
|
||||||
observer.onInstanceRequested(T.toString(), T, scopeName: scopeId);
|
// Используем глобальное отслеживание, если включено
|
||||||
T result;
|
|
||||||
if (isGlobalCycleDetectionEnabled) {
|
if (isGlobalCycleDetectionEnabled) {
|
||||||
try {
|
return withGlobalCycleDetection<T>(T, named, () {
|
||||||
result = withGlobalCycleDetection<T>(T, named, () {
|
|
||||||
return _resolveWithLocalDetection<T>(named: named, params: params);
|
return _resolveWithLocalDetection<T>(named: named, params: params);
|
||||||
});
|
});
|
||||||
} catch (e, s) {
|
|
||||||
observer.onError(
|
|
||||||
'Global cycle detection failed during resolve: $T',
|
|
||||||
e,
|
|
||||||
s,
|
|
||||||
);
|
|
||||||
rethrow;
|
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
try {
|
return _resolveWithLocalDetection<T>(named: named, params: params);
|
||||||
result = _resolveWithLocalDetection<T>(named: named, params: params);
|
|
||||||
} catch (e, s) {
|
|
||||||
observer.onError(
|
|
||||||
'Failed to resolve: $T',
|
|
||||||
e,
|
|
||||||
s,
|
|
||||||
);
|
|
||||||
rethrow;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
_trackDisposable(result);
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Resolves [T] using the local cycle detector for this scope.
|
/// RU: Разрешение с локальным детектором циклических зависимостей.
|
||||||
/// Throws [StateError] if not found or cycle is detected.
|
/// ENG: Resolution with local circular dependency detector.
|
||||||
/// Used internally by [resolve].
|
|
||||||
T _resolveWithLocalDetection<T>({String? named, dynamic params}) {
|
T _resolveWithLocalDetection<T>({String? named, dynamic params}) {
|
||||||
return withCycleDetection<T>(T, named, () {
|
return withCycleDetection<T>(T, named, () {
|
||||||
var resolved = _tryResolveInternal<T>(named: named, params: params);
|
var resolved = _tryResolveInternal<T>(named: named, params: params);
|
||||||
if (resolved != null) {
|
if (resolved != null) {
|
||||||
observer.onInstanceCreated(T.toString(), T, resolved,
|
|
||||||
scopeName: scopeId);
|
|
||||||
observer.onDiagnostic(
|
|
||||||
'Successfully resolved: $T',
|
|
||||||
details: {
|
|
||||||
'type': 'Scope',
|
|
||||||
'name': scopeId,
|
|
||||||
'resolve': T.toString(),
|
|
||||||
if (named != null) 'named': named,
|
|
||||||
'description': 'successfully resolved',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
return resolved;
|
return resolved;
|
||||||
} else {
|
} else {
|
||||||
observer.onError(
|
|
||||||
'Failed to resolve: $T',
|
|
||||||
null,
|
|
||||||
null,
|
|
||||||
);
|
|
||||||
throw StateError(
|
throw StateError(
|
||||||
'Can\'t resolve dependency `$T`. Maybe you forget register it?');
|
'Can\'t resolve dependency `$T`. Maybe you forget register it?');
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Attempts to resolve a dependency of type [T], optionally by name and with params.
|
/// RU: Возвращает найденную зависимость типа [T] или null, если она не может быть найдена.
|
||||||
|
/// ENG: Returns found dependency of type [T] or null if it cannot be found.
|
||||||
///
|
///
|
||||||
/// Returns the resolved dependency, or `null` if not found.
|
|
||||||
/// Does not throw if missing (unlike [resolve]).
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// final maybeDb = scope.tryResolve<Database>();
|
|
||||||
/// ```
|
|
||||||
T? tryResolve<T>({String? named, dynamic params}) {
|
T? tryResolve<T>({String? named, dynamic params}) {
|
||||||
T? result;
|
// Используем глобальное отслеживание, если включено
|
||||||
if (isGlobalCycleDetectionEnabled) {
|
if (isGlobalCycleDetectionEnabled) {
|
||||||
result = withGlobalCycleDetection<T?>(T, named, () {
|
return withGlobalCycleDetection<T?>(T, named, () {
|
||||||
return _tryResolveWithLocalDetection<T>(named: named, params: params);
|
return _tryResolveWithLocalDetection<T>(named: named, params: params);
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
result = _tryResolveWithLocalDetection<T>(named: named, params: params);
|
return _tryResolveWithLocalDetection<T>(named: named, params: params);
|
||||||
}
|
}
|
||||||
if (result != null) _trackDisposable(result);
|
|
||||||
return result;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Attempts to resolve [T] using the local cycle detector. Returns null if not found or cycle.
|
/// RU: Попытка разрешения с локальным детектором циклических зависимостей.
|
||||||
/// Used internally by [tryResolve].
|
/// ENG: Try resolution with local circular dependency detector.
|
||||||
T? _tryResolveWithLocalDetection<T>({String? named, dynamic params}) {
|
T? _tryResolveWithLocalDetection<T>({String? named, dynamic params}) {
|
||||||
if (isCycleDetectionEnabled) {
|
if (isCycleDetectionEnabled) {
|
||||||
return withCycleDetection<T?>(T, named, () {
|
return withCycleDetection<T?>(T, named, () {
|
||||||
@@ -339,98 +173,87 @@ class Scope with CycleDetectionMixin, GlobalCycleDetectionMixin {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Locates and resolves [T] without cycle detection (direct lookup).
|
/// RU: Внутренний метод для разрешения зависимостей без проверки циклических зависимостей.
|
||||||
/// Returns null if not found. Used internally.
|
/// ENG: Internal method for dependency resolution without circular dependency checking.
|
||||||
T? _tryResolveInternal<T>({String? named, dynamic params}) {
|
T? _tryResolveInternal<T>({String? named, dynamic params}) {
|
||||||
final resolver = _findBindingResolver<T>(named);
|
// 1 Поиск зависимости по всем модулям текущего скоупа
|
||||||
// 1 - Try from own modules; 2 - Fallback to parent
|
if (_modulesList.isNotEmpty) {
|
||||||
return resolver?.resolveSync(params) ??
|
for (var module in _modulesList) {
|
||||||
_parentScope?.tryResolve(named: named, params: params);
|
for (var binding in module.bindingSet) {
|
||||||
|
if (binding.key == T &&
|
||||||
|
((!binding.isNamed && named == null) ||
|
||||||
|
(binding.isNamed && named == binding.name))) {
|
||||||
|
switch (binding.mode) {
|
||||||
|
case Mode.instance:
|
||||||
|
return binding.instance;
|
||||||
|
case Mode.providerInstance:
|
||||||
|
return binding.provider;
|
||||||
|
case Mode.providerInstanceWithParams:
|
||||||
|
if (params == null) {
|
||||||
|
throw StateError('Param is null. Maybe you forget pass it');
|
||||||
|
}
|
||||||
|
return binding.providerWithParams(params);
|
||||||
|
default:
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Asynchronously resolves a dependency of type [T].
|
// 2 Поиск зависимостей в родительском скоупе
|
||||||
|
return _parentScope?._tryResolveInternal(named: named, params: params);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// RU: Асинхронно возвращает найденную зависимость, определенную параметром типа [T].
|
||||||
|
/// Выдает [StateError], если зависимость не может быть разрешена.
|
||||||
|
/// Если хотите получить [null], если зависимость не может быть найдена, используйте [tryResolveAsync].
|
||||||
|
/// return - возвращает объект типа [T] or [StateError]
|
||||||
///
|
///
|
||||||
/// Throws [StateError] if not found. (Use [tryResolveAsync] for a fallible async resolve.)
|
/// ENG: Asynchronously returns the found dependency specified by the type parameter [T].
|
||||||
|
/// Throws [StateError] if the dependency cannot be resolved.
|
||||||
|
/// If you want to get [null] if the dependency cannot be found, use [tryResolveAsync] instead.
|
||||||
|
/// return - returns an object of type [T] or [StateError]
|
||||||
///
|
///
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// final db = await scope.resolveAsync<Database>();
|
|
||||||
/// final special = await scope.resolveAsync<Service>(named: "special");
|
|
||||||
/// ```
|
|
||||||
Future<T> resolveAsync<T>({String? named, dynamic params}) async {
|
Future<T> resolveAsync<T>({String? named, dynamic params}) async {
|
||||||
T result;
|
// Используем глобальное отслеживание, если включено
|
||||||
if (isGlobalCycleDetectionEnabled) {
|
if (isGlobalCycleDetectionEnabled) {
|
||||||
result = await withGlobalCycleDetection<Future<T>>(T, named, () async {
|
return withGlobalCycleDetection<Future<T>>(T, named, () async {
|
||||||
return await _resolveAsyncWithLocalDetection<T>(
|
return await _resolveAsyncWithLocalDetection<T>(named: named, params: params);
|
||||||
named: named, params: params);
|
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
result = await _resolveAsyncWithLocalDetection<T>(
|
return await _resolveAsyncWithLocalDetection<T>(named: named, params: params);
|
||||||
named: named, params: params);
|
|
||||||
}
|
}
|
||||||
_trackDisposable(result);
|
|
||||||
return result;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Resolves [T] asynchronously using local cycle detector. Throws if not found.
|
/// RU: Асинхронное разрешение с локальным детектором циклических зависимостей.
|
||||||
/// Internal implementation for async [resolveAsync].
|
/// ENG: Async resolution with local circular dependency detector.
|
||||||
Future<T> _resolveAsyncWithLocalDetection<T>(
|
Future<T> _resolveAsyncWithLocalDetection<T>({String? named, dynamic params}) async {
|
||||||
{String? named, dynamic params}) async {
|
|
||||||
return withCycleDetection<Future<T>>(T, named, () async {
|
return withCycleDetection<Future<T>>(T, named, () async {
|
||||||
var resolved =
|
var resolved = await _tryResolveAsyncInternal<T>(named: named, params: params);
|
||||||
await _tryResolveAsyncInternal<T>(named: named, params: params);
|
|
||||||
if (resolved != null) {
|
if (resolved != null) {
|
||||||
observer.onInstanceCreated(T.toString(), T, resolved,
|
|
||||||
scopeName: scopeId);
|
|
||||||
observer.onDiagnostic(
|
|
||||||
'Successfully async resolved: $T',
|
|
||||||
details: {
|
|
||||||
'type': 'Scope',
|
|
||||||
'name': scopeId,
|
|
||||||
'resolve': T.toString(),
|
|
||||||
if (named != null) 'named': named,
|
|
||||||
'description': 'successfully resolved (async)',
|
|
||||||
},
|
|
||||||
);
|
|
||||||
return resolved;
|
return resolved;
|
||||||
} else {
|
} else {
|
||||||
observer.onError(
|
|
||||||
'Failed to async resolve: $T',
|
|
||||||
null,
|
|
||||||
null,
|
|
||||||
);
|
|
||||||
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?');
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Attempts to asynchronously resolve a dependency of type [T].
|
|
||||||
/// Returns the dependency or null if not present (never throws).
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// final user = await scope.tryResolveAsync<User>();
|
|
||||||
/// ```
|
|
||||||
Future<T?> tryResolveAsync<T>({String? named, dynamic params}) async {
|
Future<T?> tryResolveAsync<T>({String? named, dynamic params}) async {
|
||||||
T? result;
|
// Используем глобальное отслеживание, если включено
|
||||||
if (isGlobalCycleDetectionEnabled) {
|
if (isGlobalCycleDetectionEnabled) {
|
||||||
result = await withGlobalCycleDetection<Future<T?>>(T, named, () async {
|
return withGlobalCycleDetection<Future<T?>>(T, named, () async {
|
||||||
return await _tryResolveAsyncWithLocalDetection<T>(
|
return await _tryResolveAsyncWithLocalDetection<T>(named: named, params: params);
|
||||||
named: named, params: params);
|
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
result = await _tryResolveAsyncWithLocalDetection<T>(
|
return await _tryResolveAsyncWithLocalDetection<T>(named: named, params: params);
|
||||||
named: named, params: params);
|
|
||||||
}
|
}
|
||||||
if (result != null) _trackDisposable(result);
|
|
||||||
return result;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Attempts to resolve [T] asynchronously using local cycle detector. Returns null if missing.
|
/// RU: Асинхронная попытка разрешения с локальным детектором циклических зависимостей.
|
||||||
/// Internal implementation for async [tryResolveAsync].
|
/// ENG: Async try resolution with local circular dependency detector.
|
||||||
Future<T?> _tryResolveAsyncWithLocalDetection<T>(
|
Future<T?> _tryResolveAsyncWithLocalDetection<T>({String? named, dynamic params}) async {
|
||||||
{String? named, dynamic params}) async {
|
|
||||||
if (isCycleDetectionEnabled) {
|
if (isCycleDetectionEnabled) {
|
||||||
return withCycleDetection<Future<T?>>(T, named, () async {
|
return withCycleDetection<Future<T?>>(T, named, () async {
|
||||||
return await _tryResolveAsyncInternal<T>(named: named, params: params);
|
return await _tryResolveAsyncInternal<T>(named: named, params: params);
|
||||||
@@ -440,63 +263,33 @@ class Scope with CycleDetectionMixin, GlobalCycleDetectionMixin {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Direct async resolution for [T] without cycle check. Returns null if missing. Internal use only.
|
/// RU: Внутренний метод для асинхронного разрешения зависимостей без проверки циклических зависимостей.
|
||||||
Future<T?> _tryResolveAsyncInternal<T>(
|
/// ENG: Internal method for async dependency resolution without circular dependency checking.
|
||||||
{String? named, dynamic params}) async {
|
Future<T?> _tryResolveAsyncInternal<T>({String? named, dynamic params}) async {
|
||||||
final resolver = _findBindingResolver<T>(named);
|
if (_modulesList.isNotEmpty) {
|
||||||
// 1 - Try from own modules; 2 - Fallback to parent
|
|
||||||
return resolver?.resolveAsync(params) ??
|
|
||||||
_parentScope?.tryResolveAsync(named: named, params: params);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Looks up the [BindingResolver] for [T] and [named] within this scope.
|
|
||||||
/// Returns null if none found. Internal use only.
|
|
||||||
BindingResolver<T>? _findBindingResolver<T>(String? named) =>
|
|
||||||
_bindingResolvers[T]?[named] as BindingResolver<T>?;
|
|
||||||
|
|
||||||
/// Rebuilds the internal index of all [BindingResolver]s from installed modules.
|
|
||||||
/// Called after [installModules] and [dropModules]. Internal use only.
|
|
||||||
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) {
|
||||||
_bindingResolvers.putIfAbsent(binding.key, () => {});
|
if (binding.key == T &&
|
||||||
final nameKey = binding.isNamed ? binding.name : null;
|
((!binding.isNamed && named == null) ||
|
||||||
_bindingResolvers[binding.key]![nameKey] = binding.resolver!;
|
(binding.isNamed && named == binding.name))) {
|
||||||
}
|
if (binding.instanceAsync != null) {
|
||||||
}
|
return await binding.instanceAsync;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Tracks resolved [Disposable] instances, to ensure dispose is called automatically.
|
if (binding.asyncProvider != null) {
|
||||||
/// Internal use only.
|
return await binding.asyncProvider?.call();
|
||||||
void _trackDisposable(Object? obj) {
|
|
||||||
if (obj is Disposable && !_disposables.contains(obj)) {
|
|
||||||
_disposables.add(obj);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Asynchronously disposes this [Scope], all tracked [Disposable] objects, and recursively
|
if (binding.asyncProviderWithParams != null) {
|
||||||
/// all its child subscopes.
|
if (params == null) {
|
||||||
///
|
throw StateError('Param is null. Maybe you forget pass it');
|
||||||
/// This method should always be called when a scope is no longer needed
|
|
||||||
/// to guarantee timely resource cleanup (files, sockets, streams, handles, etc).
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// await myScope.dispose();
|
|
||||||
/// ```
|
|
||||||
Future<void> dispose() async {
|
|
||||||
// Create copies to avoid concurrent modification
|
|
||||||
final scopesCopy = Map<String, Scope>.from(_scopeMap);
|
|
||||||
for (final subScope in scopesCopy.values) {
|
|
||||||
await subScope.dispose();
|
|
||||||
}
|
}
|
||||||
_scopeMap.clear();
|
return await binding.asyncProviderWithParams!(params);
|
||||||
|
|
||||||
final disposablesCopy = Set<Disposable>.from(_disposables);
|
|
||||||
for (final d in disposablesCopy) {
|
|
||||||
await d.dispose();
|
|
||||||
}
|
}
|
||||||
_disposables.clear();
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return _parentScope?._tryResolveAsyncInternal(named: named, params: params);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,16 +1,10 @@
|
|||||||
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: 3.0.0
|
version: 3.0.0-dev.1
|
||||||
homepage: https://cherrypick-di.netlify.app
|
homepage: https://pese-git.github.io/cherrypick-site/
|
||||||
documentation: https://cherrypick-di.netlify.app/docs/intro
|
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
|
|
||||||
- dependency-injection
|
|
||||||
- dependency-management
|
|
||||||
- inversion-of-control
|
|
||||||
|
|
||||||
environment:
|
environment:
|
||||||
sdk: ">=3.5.2 <4.0.0"
|
sdk: ">=3.5.2 <4.0.0"
|
||||||
|
|||||||
@@ -1,65 +0,0 @@
|
|||||||
import 'package:cherrypick/cherrypick.dart';
|
|
||||||
import 'package:test/test.dart';
|
|
||||||
import 'mock_logger.dart';
|
|
||||||
|
|
||||||
class DummyService {}
|
|
||||||
|
|
||||||
class DummyModule extends Module {
|
|
||||||
@override
|
|
||||||
void builder(Scope currentScope) {
|
|
||||||
bind<DummyService>().toInstance(DummyService()).withName('test');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class A {}
|
|
||||||
|
|
||||||
class B {}
|
|
||||||
|
|
||||||
class CyclicModule extends Module {
|
|
||||||
@override
|
|
||||||
void builder(Scope cs) {
|
|
||||||
bind<A>().toProvide(() => cs.resolve<B>() as A);
|
|
||||||
bind<B>().toProvide(() => cs.resolve<A>() as B);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void main() {
|
|
||||||
late MockObserver observer;
|
|
||||||
|
|
||||||
setUp(() {
|
|
||||||
observer = MockObserver();
|
|
||||||
});
|
|
||||||
|
|
||||||
test('Global logger receives Binding events', () {
|
|
||||||
final scope = Scope(null, observer: observer);
|
|
||||||
scope.installModules([DummyModule()]);
|
|
||||||
final _ = scope.resolve<DummyService>(named: 'test');
|
|
||||||
|
|
||||||
// Проверяем, что биндинг DummyService зарегистрирован
|
|
||||||
expect(
|
|
||||||
observer.bindings.any((m) => m.contains('DummyService')),
|
|
||||||
isTrue,
|
|
||||||
);
|
|
||||||
// Можно добавить проверки diagnostics, если Scope что-то пишет туда
|
|
||||||
});
|
|
||||||
|
|
||||||
test('CycleDetector logs cycle detection error', () {
|
|
||||||
final scope = Scope(null, observer: observer);
|
|
||||||
// print('[DEBUG] TEST SCOPE logger type=${scope.logger.runtimeType} hash=${scope.logger.hashCode}');
|
|
||||||
scope.enableCycleDetection();
|
|
||||||
scope.installModules([CyclicModule()]);
|
|
||||||
expect(
|
|
||||||
() => scope.resolve<A>(),
|
|
||||||
throwsA(isA<CircularDependencyException>()),
|
|
||||||
);
|
|
||||||
// Проверяем, что цикл зафиксирован либо в errors, либо в diagnostics либо cycles
|
|
||||||
final foundInErrors =
|
|
||||||
observer.errors.any((m) => m.contains('cycle detected'));
|
|
||||||
final foundInDiagnostics =
|
|
||||||
observer.diagnostics.any((m) => m.contains('cycle detected'));
|
|
||||||
final foundCycleNotified = observer.cycles.isNotEmpty;
|
|
||||||
expect(foundInErrors || foundInDiagnostics || foundCycleNotified, isTrue,
|
|
||||||
reason:
|
|
||||||
'Ожидаем хотя бы один лог о цикле! errors: ${observer.errors}\ndiag: ${observer.diagnostics}\ncycles: ${observer.cycles}');
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
import 'package:cherrypick/cherrypick.dart';
|
|
||||||
|
|
||||||
class MockObserver implements CherryPickObserver {
|
|
||||||
final List<String> diagnostics = [];
|
|
||||||
final List<String> warnings = [];
|
|
||||||
final List<String> errors = [];
|
|
||||||
final List<List<String>> cycles = [];
|
|
||||||
final List<String> bindings = [];
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onDiagnostic(String message, {Object? details}) =>
|
|
||||||
diagnostics.add(message);
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onWarning(String message, {Object? details}) => warnings.add(message);
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onError(String message, Object? error, StackTrace? stackTrace) => errors.add(
|
|
||||||
'$message${error != null ? ' $error' : ''}${stackTrace != null ? '\n$stackTrace' : ''}');
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onCycleDetected(List<String> chain, {String? scopeName}) =>
|
|
||||||
cycles.add(chain);
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onBindingRegistered(String name, Type type, {String? scopeName}) =>
|
|
||||||
bindings.add('$name $type');
|
|
||||||
|
|
||||||
@override
|
|
||||||
void onInstanceRequested(String name, Type type, {String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onInstanceCreated(String name, Type type, Object instance,
|
|
||||||
{String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onInstanceDisposed(String name, Type type, Object instance,
|
|
||||||
{String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onModulesInstalled(List<String> moduleNames, {String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onModulesRemoved(List<String> moduleNames, {String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onScopeOpened(String name) {}
|
|
||||||
@override
|
|
||||||
void onScopeClosed(String name) {}
|
|
||||||
@override
|
|
||||||
void onCacheHit(String name, Type type, {String? scopeName}) {}
|
|
||||||
@override
|
|
||||||
void onCacheMiss(String name, Type type, {String? scopeName}) {}
|
|
||||||
}
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import 'package:cherrypick/cherrypick.dart';
|
import 'package:cherrypick/src/binding.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.resolver, null);
|
expect(binding.instance, 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.resolver, isA<InstanceResolver<int>>());
|
expect(binding.mode, Mode.instance);
|
||||||
});
|
});
|
||||||
|
|
||||||
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.resolver?.resolveSync(), 5);
|
expect(binding.instance, 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.resolver, null);
|
expect(binding.instance, 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.resolver, isA<InstanceResolver<int>>());
|
expect(binding.mode, Mode.instance);
|
||||||
});
|
});
|
||||||
|
|
||||||
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.resolver?.resolveSync(), 5);
|
expect(binding.instance, 5);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Sets name', () {
|
test('Sets name', () {
|
||||||
@@ -60,39 +60,45 @@ 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.resolver?.resolveSync(), 2);
|
expect(binding.instance, 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>().toInstance(Future.value(42));
|
final binding = Binding<int>().toInstanceAsync(Future.value(42));
|
||||||
expect(await binding.resolveAsync(), 42);
|
expect(await binding.instanceAsync, 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>().toInstance(Future.value(5));
|
final binding = Binding<int>().toInstanceAsync(Future.value(5));
|
||||||
expect(binding.resolver, isA<InstanceResolver<int>>());
|
expect(binding.mode, Mode.instance);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('isSingleton is true after toInstanceAsync', () {
|
test('isSingleton is true after toInstanceAsync', () {
|
||||||
final binding = Binding<int>().toInstance(Future.value(5));
|
final binding = Binding<int>().toInstanceAsync(Future.value(5));
|
||||||
expect(binding.isSingleton, isTrue);
|
expect(binding.isSingleton, isTrue);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Composes with withName', () async {
|
test('Composes with withName', () async {
|
||||||
final binding =
|
final binding = Binding<int>()
|
||||||
Binding<int>().withName('asyncValue').toInstance(Future.value(7));
|
.withName('asyncValue')
|
||||||
|
.toInstanceAsync(Future.value(7));
|
||||||
expect(binding.isNamed, isTrue);
|
expect(binding.isNamed, isTrue);
|
||||||
expect(binding.name, 'asyncValue');
|
expect(binding.name, 'asyncValue');
|
||||||
expect(await binding.resolveAsync(), 7);
|
expect(await binding.instanceAsync, 7);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Keeps value after multiple awaits', () async {
|
test('Keeps value after multiple awaits', () async {
|
||||||
final binding = Binding<int>().toInstance(Future.value(123));
|
final binding = Binding<int>().toInstanceAsync(Future.value(123));
|
||||||
final result1 = await binding.resolveAsync();
|
final result1 = await binding.instanceAsync;
|
||||||
final result2 = await binding.resolveAsync();
|
final result2 = await binding.instanceAsync;
|
||||||
expect(result1, equals(result2));
|
expect(result1, equals(result2));
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -102,12 +108,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.resolver, null);
|
expect(binding.provider, 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.resolver, isA<ProviderResolver<int>>());
|
expect(binding.mode, Mode.providerInstance);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('isSingleton is false by default', () {
|
test('isSingleton is false by default', () {
|
||||||
@@ -117,19 +123,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.resolveSync(), 5);
|
expect(binding.provider, 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.resolver, null);
|
expect(binding.provider, 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.resolver, isA<ProviderResolver<int>>());
|
expect(binding.mode, Mode.providerInstance);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Sets key', () {
|
test('Sets key', () {
|
||||||
@@ -144,7 +150,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.resolveSync(), 5);
|
expect(binding.provider, 5);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Sets name', () {
|
test('Sets name', () {
|
||||||
@@ -157,14 +163,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>().toProvide(() async => 5);
|
final binding = Binding<int>().toProvideAsync(() async => 5);
|
||||||
expect(await binding.resolveAsync(), 5);
|
expect(await binding.asyncProvider?.call(), 5);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Resolves asyncProviderWithParams value', () async {
|
test('Resolves asyncProviderWithParams value', () async {
|
||||||
final binding = Binding<int>()
|
final binding = Binding<int>()
|
||||||
.toProvideWithParams((param) async => 5 + (param as int));
|
.toProvideAsyncWithParams((param) async => 5 + (param as int));
|
||||||
expect(await binding.resolveAsync(3), 8);
|
expect(await binding.asyncProviderWithParams?.call(3), 8);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -173,7 +179,12 @@ 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.resolver, null);
|
expect(binding.provider, 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', () {
|
||||||
@@ -183,7 +194,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.resolveSync(), 5);
|
expect(binding.provider, 5);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Returns same value each call and provider only called once', () {
|
test('Returns same value each call and provider only called once', () {
|
||||||
@@ -193,8 +204,8 @@ void main() {
|
|||||||
return counter;
|
return counter;
|
||||||
}).singleton();
|
}).singleton();
|
||||||
|
|
||||||
final first = binding.resolveSync();
|
final first = binding.provider;
|
||||||
final second = binding.resolveSync();
|
final second = binding.provider;
|
||||||
expect(first, equals(second));
|
expect(first, equals(second));
|
||||||
expect(counter, 1);
|
expect(counter, 1);
|
||||||
});
|
});
|
||||||
@@ -203,7 +214,13 @@ 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.resolver, null);
|
expect(binding.provider, 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', () {
|
||||||
@@ -221,7 +238,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.resolveSync(), 5);
|
expect(binding.provider, 5);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Sets name', () {
|
test('Sets name', () {
|
||||||
@@ -230,6 +247,12 @@ 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 ---
|
||||||
@@ -242,7 +265,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.resolveSync(123), null);
|
expect(binding.providerWithParams(123), null);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -46,9 +46,7 @@ void main() {
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
test(
|
test('current implementation limitation - may not detect cross-scope cycles', () {
|
||||||
'current implementation limitation - may not detect cross-scope cycles',
|
|
||||||
() {
|
|
||||||
// Этот тест демонстрирует ограничение текущей реализации
|
// Этот тест демонстрирует ограничение текущей реализации
|
||||||
final parentScope = CherryPick.openRootScope();
|
final parentScope = CherryPick.openRootScope();
|
||||||
parentScope.enableCycleDetection();
|
parentScope.enableCycleDetection();
|
||||||
|
|||||||
@@ -1,19 +1,14 @@
|
|||||||
|
import 'package:cherrypick/src/cycle_detector.dart';
|
||||||
|
import 'package:cherrypick/src/module.dart';
|
||||||
|
import 'package:cherrypick/src/scope.dart';
|
||||||
import 'package:test/test.dart';
|
import 'package:test/test.dart';
|
||||||
import 'package:cherrypick/cherrypick.dart';
|
|
||||||
|
|
||||||
import '../mock_logger.dart';
|
|
||||||
|
|
||||||
void main() {
|
void main() {
|
||||||
late MockObserver observer;
|
|
||||||
setUp(() {
|
|
||||||
observer = MockObserver();
|
|
||||||
CherryPick.setGlobalObserver(observer);
|
|
||||||
});
|
|
||||||
group('CycleDetector', () {
|
group('CycleDetector', () {
|
||||||
late CycleDetector detector;
|
late CycleDetector detector;
|
||||||
|
|
||||||
setUp(() {
|
setUp(() {
|
||||||
detector = CycleDetector(observer: observer);
|
detector = CycleDetector();
|
||||||
});
|
});
|
||||||
|
|
||||||
test('should detect simple circular dependency', () {
|
test('should detect simple circular dependency', () {
|
||||||
@@ -52,7 +47,8 @@ void main() {
|
|||||||
throwsA(predicate((e) =>
|
throwsA(predicate((e) =>
|
||||||
e is CircularDependencyException &&
|
e is CircularDependencyException &&
|
||||||
e.dependencyChain.contains('String') &&
|
e.dependencyChain.contains('String') &&
|
||||||
e.dependencyChain.length > 1)),
|
e.dependencyChain.length > 1
|
||||||
|
)),
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -79,7 +75,7 @@ void main() {
|
|||||||
|
|
||||||
group('Scope with Cycle Detection', () {
|
group('Scope with Cycle Detection', () {
|
||||||
test('should detect circular dependency in real scenario', () {
|
test('should detect circular dependency in real scenario', () {
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = Scope(null);
|
||||||
scope.enableCycleDetection();
|
scope.enableCycleDetection();
|
||||||
|
|
||||||
// Создаем циклическую зависимость: A зависит от B, B зависит от A
|
// Создаем циклическую зависимость: A зависит от B, B зависит от A
|
||||||
@@ -95,7 +91,7 @@ void main() {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test('should work normally without cycle detection enabled', () {
|
test('should work normally without cycle detection enabled', () {
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = Scope(null);
|
||||||
// Не включаем обнаружение циклических зависимостей
|
// Не включаем обнаружение циклических зависимостей
|
||||||
|
|
||||||
scope.installModules([
|
scope.installModules([
|
||||||
@@ -107,7 +103,7 @@ void main() {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test('should allow disabling cycle detection', () {
|
test('should allow disabling cycle detection', () {
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = Scope(null);
|
||||||
scope.enableCycleDetection();
|
scope.enableCycleDetection();
|
||||||
expect(scope.isCycleDetectionEnabled, isTrue);
|
expect(scope.isCycleDetectionEnabled, isTrue);
|
||||||
|
|
||||||
@@ -116,7 +112,7 @@ void main() {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test('should handle named dependencies in cycle detection', () {
|
test('should handle named dependencies in cycle detection', () {
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = Scope(null);
|
||||||
scope.enableCycleDetection();
|
scope.enableCycleDetection();
|
||||||
|
|
||||||
scope.installModules([
|
scope.installModules([
|
||||||
@@ -130,7 +126,7 @@ void main() {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test('should detect cycles in async resolution', () async {
|
test('should detect cycles in async resolution', () async {
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = Scope(null);
|
||||||
scope.enableCycleDetection();
|
scope.enableCycleDetection();
|
||||||
|
|
||||||
scope.installModules([
|
scope.installModules([
|
||||||
@@ -160,16 +156,14 @@ class ServiceB {
|
|||||||
class CircularModuleA extends Module {
|
class CircularModuleA extends Module {
|
||||||
@override
|
@override
|
||||||
void builder(Scope currentScope) {
|
void builder(Scope currentScope) {
|
||||||
bind<ServiceA>()
|
bind<ServiceA>().toProvide(() => ServiceA(currentScope.resolve<ServiceB>()));
|
||||||
.toProvide(() => ServiceA(currentScope.resolve<ServiceB>()));
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class CircularModuleB extends Module {
|
class CircularModuleB extends Module {
|
||||||
@override
|
@override
|
||||||
void builder(Scope currentScope) {
|
void builder(Scope currentScope) {
|
||||||
bind<ServiceB>()
|
bind<ServiceB>().toProvide(() => ServiceB(currentScope.resolve<ServiceA>()));
|
||||||
.toProvide(() => ServiceB(currentScope.resolve<ServiceA>()));
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -206,13 +200,11 @@ class AsyncServiceB {
|
|||||||
class AsyncCircularModule extends Module {
|
class AsyncCircularModule extends Module {
|
||||||
@override
|
@override
|
||||||
void builder(Scope currentScope) {
|
void builder(Scope currentScope) {
|
||||||
// ignore: deprecated_member_use_from_same_package
|
|
||||||
bind<AsyncServiceA>().toProvideAsync(() async {
|
bind<AsyncServiceA>().toProvideAsync(() async {
|
||||||
final serviceB = await currentScope.resolveAsync<AsyncServiceB>();
|
final serviceB = await currentScope.resolveAsync<AsyncServiceB>();
|
||||||
return AsyncServiceA(serviceB);
|
return AsyncServiceA(serviceB);
|
||||||
});
|
});
|
||||||
|
|
||||||
// ignore: deprecated_member_use_from_same_package
|
|
||||||
bind<AsyncServiceB>().toProvideAsync(() async {
|
bind<AsyncServiceB>().toProvideAsync(() async {
|
||||||
final serviceA = await currentScope.resolveAsync<AsyncServiceA>();
|
final serviceA = await currentScope.resolveAsync<AsyncServiceA>();
|
||||||
return AsyncServiceB(serviceA);
|
return AsyncServiceB(serviceA);
|
||||||
|
|||||||
@@ -37,9 +37,7 @@ void main() {
|
|||||||
expect(CherryPick.isGlobalCrossScopeCycleDetectionEnabled, isFalse);
|
expect(CherryPick.isGlobalCrossScopeCycleDetectionEnabled, isFalse);
|
||||||
});
|
});
|
||||||
|
|
||||||
test(
|
test('should automatically enable global cycle detection for new root scope', () {
|
||||||
'should automatically enable global cycle detection for new root scope',
|
|
||||||
() {
|
|
||||||
CherryPick.enableGlobalCrossScopeCycleDetection();
|
CherryPick.enableGlobalCrossScopeCycleDetection();
|
||||||
|
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = CherryPick.openRootScope();
|
||||||
@@ -47,9 +45,7 @@ void main() {
|
|||||||
expect(scope.isGlobalCycleDetectionEnabled, isTrue);
|
expect(scope.isGlobalCycleDetectionEnabled, isTrue);
|
||||||
});
|
});
|
||||||
|
|
||||||
test(
|
test('should automatically enable global cycle detection for existing root scope', () {
|
||||||
'should automatically enable global cycle detection for existing root scope',
|
|
||||||
() {
|
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = CherryPick.openRootScope();
|
||||||
expect(scope.isGlobalCycleDetectionEnabled, isFalse);
|
expect(scope.isGlobalCycleDetectionEnabled, isFalse);
|
||||||
|
|
||||||
@@ -60,18 +56,15 @@ void main() {
|
|||||||
});
|
});
|
||||||
|
|
||||||
group('Global Safe Scope Creation', () {
|
group('Global Safe Scope Creation', () {
|
||||||
test('should create global safe root scope with both detections enabled',
|
test('should create global safe root scope with both detections enabled', () {
|
||||||
() {
|
|
||||||
final scope = CherryPick.openGlobalSafeRootScope();
|
final scope = CherryPick.openGlobalSafeRootScope();
|
||||||
|
|
||||||
expect(scope.isCycleDetectionEnabled, isTrue);
|
expect(scope.isCycleDetectionEnabled, isTrue);
|
||||||
expect(scope.isGlobalCycleDetectionEnabled, isTrue);
|
expect(scope.isGlobalCycleDetectionEnabled, isTrue);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('should create global safe sub-scope with both detections enabled',
|
test('should create global safe sub-scope with both detections enabled', () {
|
||||||
() {
|
final scope = CherryPick.openGlobalSafeScope(scopeName: 'feature.global');
|
||||||
final scope =
|
|
||||||
CherryPick.openGlobalSafeScope(scopeName: 'feature.global');
|
|
||||||
|
|
||||||
expect(scope.isCycleDetectionEnabled, isTrue);
|
expect(scope.isCycleDetectionEnabled, isTrue);
|
||||||
expect(scope.isGlobalCycleDetectionEnabled, isTrue);
|
expect(scope.isGlobalCycleDetectionEnabled, isTrue);
|
||||||
|
|||||||
@@ -1,13 +1,7 @@
|
|||||||
import 'package:cherrypick/cherrypick.dart';
|
import 'package:cherrypick/cherrypick.dart';
|
||||||
import 'package:test/test.dart';
|
import 'package:test/test.dart';
|
||||||
import '../mock_logger.dart';
|
|
||||||
|
|
||||||
void main() {
|
void main() {
|
||||||
late MockObserver observer;
|
|
||||||
setUp(() {
|
|
||||||
observer = MockObserver();
|
|
||||||
CherryPick.setGlobalObserver(observer);
|
|
||||||
});
|
|
||||||
group('CherryPick Cycle Detection Helper Methods', () {
|
group('CherryPick Cycle Detection Helper Methods', () {
|
||||||
setUp(() {
|
setUp(() {
|
||||||
// Сбрасываем состояние перед каждым тестом
|
// Сбрасываем состояние перед каждым тестом
|
||||||
@@ -39,9 +33,7 @@ void main() {
|
|||||||
expect(CherryPick.isGlobalCycleDetectionEnabled, isFalse);
|
expect(CherryPick.isGlobalCycleDetectionEnabled, isFalse);
|
||||||
});
|
});
|
||||||
|
|
||||||
test(
|
test('should automatically enable cycle detection for new root scope when global is enabled', () {
|
||||||
'should automatically enable cycle detection for new root scope when global is enabled',
|
|
||||||
() {
|
|
||||||
CherryPick.enableGlobalCycleDetection();
|
CherryPick.enableGlobalCycleDetection();
|
||||||
|
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = CherryPick.openRootScope();
|
||||||
@@ -49,9 +41,7 @@ void main() {
|
|||||||
expect(scope.isCycleDetectionEnabled, isTrue);
|
expect(scope.isCycleDetectionEnabled, isTrue);
|
||||||
});
|
});
|
||||||
|
|
||||||
test(
|
test('should automatically enable cycle detection for existing root scope when global is enabled', () {
|
||||||
'should automatically enable cycle detection for existing root scope when global is enabled',
|
|
||||||
() {
|
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = CherryPick.openRootScope();
|
||||||
expect(scope.isCycleDetectionEnabled, isFalse);
|
expect(scope.isCycleDetectionEnabled, isFalse);
|
||||||
|
|
||||||
@@ -60,9 +50,7 @@ void main() {
|
|||||||
expect(scope.isCycleDetectionEnabled, isTrue);
|
expect(scope.isCycleDetectionEnabled, isTrue);
|
||||||
});
|
});
|
||||||
|
|
||||||
test(
|
test('should automatically disable cycle detection for existing root scope when global is disabled', () {
|
||||||
'should automatically disable cycle detection for existing root scope when global is disabled',
|
|
||||||
() {
|
|
||||||
CherryPick.enableGlobalCycleDetection();
|
CherryPick.enableGlobalCycleDetection();
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = CherryPick.openRootScope();
|
||||||
expect(scope.isCycleDetectionEnabled, isTrue);
|
expect(scope.isCycleDetectionEnabled, isTrue);
|
||||||
@@ -105,25 +93,21 @@ void main() {
|
|||||||
final scopeName = 'feature.auth';
|
final scopeName = 'feature.auth';
|
||||||
CherryPick.openScope(scopeName: scopeName);
|
CherryPick.openScope(scopeName: scopeName);
|
||||||
|
|
||||||
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName),
|
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName), isFalse);
|
||||||
isFalse);
|
|
||||||
|
|
||||||
CherryPick.enableCycleDetectionForScope(scopeName: scopeName);
|
CherryPick.enableCycleDetectionForScope(scopeName: scopeName);
|
||||||
|
|
||||||
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName),
|
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName), isTrue);
|
||||||
isTrue);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test('should disable cycle detection for specific scope', () {
|
test('should disable cycle detection for specific scope', () {
|
||||||
final scopeName = 'feature.auth';
|
final scopeName = 'feature.auth';
|
||||||
CherryPick.enableCycleDetectionForScope(scopeName: scopeName);
|
CherryPick.enableCycleDetectionForScope(scopeName: scopeName);
|
||||||
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName),
|
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName), isTrue);
|
||||||
isTrue);
|
|
||||||
|
|
||||||
CherryPick.disableCycleDetectionForScope(scopeName: scopeName);
|
CherryPick.disableCycleDetectionForScope(scopeName: scopeName);
|
||||||
|
|
||||||
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName),
|
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName), isFalse);
|
||||||
isFalse);
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -144,17 +128,14 @@ void main() {
|
|||||||
// Глобальная настройка отключена
|
// Глобальная настройка отключена
|
||||||
expect(CherryPick.isGlobalCycleDetectionEnabled, isFalse);
|
expect(CherryPick.isGlobalCycleDetectionEnabled, isFalse);
|
||||||
|
|
||||||
final scope =
|
final scope = CherryPick.openSafeScope(scopeName: 'feature.independent');
|
||||||
CherryPick.openSafeScope(scopeName: 'feature.independent');
|
|
||||||
|
|
||||||
expect(scope.isCycleDetectionEnabled, isTrue);
|
expect(scope.isCycleDetectionEnabled, isTrue);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
group('Resolution Chain Tracking', () {
|
group('Resolution Chain Tracking', () {
|
||||||
test(
|
test('should return empty resolution chain for scope without cycle detection', () {
|
||||||
'should return empty resolution chain for scope without cycle detection',
|
|
||||||
() {
|
|
||||||
CherryPick.openRootScope();
|
CherryPick.openRootScope();
|
||||||
|
|
||||||
final chain = CherryPick.getCurrentResolutionChain();
|
final chain = CherryPick.getCurrentResolutionChain();
|
||||||
@@ -162,9 +143,7 @@ void main() {
|
|||||||
expect(chain, isEmpty);
|
expect(chain, isEmpty);
|
||||||
});
|
});
|
||||||
|
|
||||||
test(
|
test('should return empty resolution chain for scope with cycle detection but no active resolution', () {
|
||||||
'should return empty resolution chain for scope with cycle detection but no active resolution',
|
|
||||||
() {
|
|
||||||
CherryPick.enableCycleDetectionForScope();
|
CherryPick.enableCycleDetectionForScope();
|
||||||
|
|
||||||
final chain = CherryPick.getCurrentResolutionChain();
|
final chain = CherryPick.getCurrentResolutionChain();
|
||||||
@@ -176,17 +155,14 @@ void main() {
|
|||||||
final scopeName = 'feature.tracking';
|
final scopeName = 'feature.tracking';
|
||||||
CherryPick.enableCycleDetectionForScope(scopeName: scopeName);
|
CherryPick.enableCycleDetectionForScope(scopeName: scopeName);
|
||||||
|
|
||||||
final chain =
|
final chain = CherryPick.getCurrentResolutionChain(scopeName: scopeName);
|
||||||
CherryPick.getCurrentResolutionChain(scopeName: scopeName);
|
|
||||||
|
|
||||||
expect(chain, isEmpty); // Пустая, так как нет активного разрешения
|
expect(chain, isEmpty); // Пустая, так как нет активного разрешения
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
group('Integration with Circular Dependencies', () {
|
group('Integration with Circular Dependencies', () {
|
||||||
test(
|
test('should detect circular dependency with global cycle detection enabled', () {
|
||||||
'should detect circular dependency with global cycle detection enabled',
|
|
||||||
() {
|
|
||||||
CherryPick.enableGlobalCycleDetection();
|
CherryPick.enableGlobalCycleDetection();
|
||||||
|
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = CherryPick.openRootScope();
|
||||||
@@ -208,9 +184,7 @@ void main() {
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
test(
|
test('should not detect circular dependency when cycle detection is disabled', () {
|
||||||
'should not detect circular dependency when cycle detection is disabled',
|
|
||||||
() {
|
|
||||||
final scope = CherryPick.openRootScope();
|
final scope = CherryPick.openRootScope();
|
||||||
scope.installModules([CircularTestModule()]);
|
scope.installModules([CircularTestModule()]);
|
||||||
|
|
||||||
@@ -225,8 +199,7 @@ void main() {
|
|||||||
test('should handle empty scope name as root scope', () {
|
test('should handle empty scope name as root scope', () {
|
||||||
CherryPick.enableCycleDetectionForScope(scopeName: '');
|
CherryPick.enableCycleDetectionForScope(scopeName: '');
|
||||||
|
|
||||||
expect(
|
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: ''), isTrue);
|
||||||
CherryPick.isCycleDetectionEnabledForScope(scopeName: ''), isTrue);
|
|
||||||
expect(CherryPick.isCycleDetectionEnabledForScope(), isTrue);
|
expect(CherryPick.isCycleDetectionEnabledForScope(), isTrue);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -234,21 +207,14 @@ void main() {
|
|||||||
final complexScopeName = 'app.feature.auth.login';
|
final complexScopeName = 'app.feature.auth.login';
|
||||||
CherryPick.enableCycleDetectionForScope(scopeName: complexScopeName);
|
CherryPick.enableCycleDetectionForScope(scopeName: complexScopeName);
|
||||||
|
|
||||||
expect(
|
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: complexScopeName), isTrue);
|
||||||
CherryPick.isCycleDetectionEnabledForScope(
|
|
||||||
scopeName: complexScopeName),
|
|
||||||
isTrue);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test('should handle custom separator', () {
|
test('should handle custom separator', () {
|
||||||
final scopeName = 'app/feature/auth';
|
final scopeName = 'app/feature/auth';
|
||||||
CherryPick.enableCycleDetectionForScope(
|
CherryPick.enableCycleDetectionForScope(scopeName: scopeName, separator: '/');
|
||||||
scopeName: scopeName, separator: '/');
|
|
||||||
|
|
||||||
expect(
|
expect(CherryPick.isCycleDetectionEnabledForScope(scopeName: scopeName, separator: '/'), isTrue);
|
||||||
CherryPick.isCycleDetectionEnabledForScope(
|
|
||||||
scopeName: scopeName, separator: '/'),
|
|
||||||
isTrue);
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -268,9 +234,7 @@ class CircularServiceB {
|
|||||||
class CircularTestModule extends Module {
|
class CircularTestModule extends Module {
|
||||||
@override
|
@override
|
||||||
void builder(Scope currentScope) {
|
void builder(Scope currentScope) {
|
||||||
bind<CircularServiceA>().toProvide(
|
bind<CircularServiceA>().toProvide(() => CircularServiceA(currentScope.resolve<CircularServiceB>()));
|
||||||
() => CircularServiceA(currentScope.resolve<CircularServiceB>()));
|
bind<CircularServiceB>().toProvide(() => CircularServiceB(currentScope.resolve<CircularServiceA>()));
|
||||||
bind<CircularServiceB>().toProvide(
|
|
||||||
() => CircularServiceB(currentScope.resolve<CircularServiceA>()));
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,193 +1,76 @@
|
|||||||
import 'package:cherrypick/cherrypick.dart'
|
import 'package:cherrypick/src/module.dart';
|
||||||
show Disposable, Module, Scope, CherryPick;
|
import 'package:cherrypick/src/scope.dart';
|
||||||
import 'dart:async';
|
|
||||||
import 'package:test/test.dart';
|
import 'package:test/test.dart';
|
||||||
import '../mock_logger.dart';
|
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
|
||||||
// Вспомогательные классы для тестов
|
|
||||||
|
|
||||||
class AsyncExampleDisposable implements Disposable {
|
|
||||||
bool disposed = false;
|
|
||||||
@override
|
|
||||||
Future<void> dispose() async {
|
|
||||||
await Future.delayed(Duration(milliseconds: 10));
|
|
||||||
disposed = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class AsyncExampleModule extends Module {
|
|
||||||
@override
|
|
||||||
void builder(Scope scope) {
|
|
||||||
bind<AsyncExampleDisposable>()
|
|
||||||
.toProvide(() => AsyncExampleDisposable())
|
|
||||||
.singleton();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class TestDisposable implements Disposable {
|
|
||||||
bool disposed = false;
|
|
||||||
@override
|
|
||||||
FutureOr<void> dispose() {
|
|
||||||
disposed = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class AnotherDisposable implements Disposable {
|
|
||||||
bool disposed = false;
|
|
||||||
@override
|
|
||||||
FutureOr<void> dispose() {
|
|
||||||
disposed = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class CountingDisposable implements Disposable {
|
|
||||||
int disposeCount = 0;
|
|
||||||
@override
|
|
||||||
FutureOr<void> dispose() {
|
|
||||||
disposeCount++;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class ModuleCountingDisposable extends Module {
|
|
||||||
@override
|
|
||||||
void builder(Scope scope) {
|
|
||||||
bind<CountingDisposable>()
|
|
||||||
.toProvide(() => CountingDisposable())
|
|
||||||
.singleton();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class ModuleWithDisposable extends Module {
|
|
||||||
@override
|
|
||||||
void builder(Scope scope) {
|
|
||||||
bind<TestDisposable>().toProvide(() => TestDisposable()).singleton();
|
|
||||||
bind<AnotherDisposable>().toProvide(() => AnotherDisposable()).singleton();
|
|
||||||
bind<String>().toProvide(() => 'super string').singleton();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class TestModule<T> extends Module {
|
|
||||||
final T value;
|
|
||||||
final String? name;
|
|
||||||
TestModule({required this.value, this.name});
|
|
||||||
@override
|
|
||||||
void builder(Scope currentScope) {
|
|
||||||
if (name == null) {
|
|
||||||
bind<T>().toInstance(value);
|
|
||||||
} else {
|
|
||||||
bind<T>().withName(name!).toInstance(value);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class _InlineModule extends Module {
|
|
||||||
final void Function(Module, Scope) _builder;
|
|
||||||
_InlineModule(this._builder);
|
|
||||||
@override
|
|
||||||
void builder(Scope s) => _builder(this, s);
|
|
||||||
}
|
|
||||||
|
|
||||||
class AsyncCreatedDisposable implements Disposable {
|
|
||||||
bool disposed = false;
|
|
||||||
@override
|
|
||||||
void dispose() {
|
|
||||||
disposed = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class AsyncModule extends Module {
|
|
||||||
@override
|
|
||||||
void builder(Scope scope) {
|
|
||||||
bind<AsyncCreatedDisposable>()
|
|
||||||
// ignore: deprecated_member_use_from_same_package
|
|
||||||
.toProvideAsync(() async {
|
|
||||||
await Future.delayed(Duration(milliseconds: 10));
|
|
||||||
return AsyncCreatedDisposable();
|
|
||||||
}).singleton();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
void main() {
|
void main() {
|
||||||
// --------------------------------------------------------------------------
|
// --------------------------------------------------------------------------
|
||||||
group('Scope & Subscope Management', () {
|
group('Scope & Subscope Management', () {
|
||||||
test('Scope has no parent if constructed with null', () {
|
test('Scope has no parent if constructed with null', () {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null);
|
||||||
final scope = Scope(null, observer: observer);
|
|
||||||
expect(scope.parentScope, null);
|
expect(scope.parentScope, null);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Can open and retrieve the same subScope by key', () {
|
test('Can open and retrieve the same subScope by key', () {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null);
|
||||||
final scope = Scope(null, observer: observer);
|
final subScope = scope.openSubScope('subScope');
|
||||||
expect(Scope(scope, observer: observer), isNotNull); // эквивалент
|
expect(scope.openSubScope('subScope'), subScope);
|
||||||
});
|
|
||||||
test('closeSubScope removes subscope so next openSubScope returns new',
|
|
||||||
() async {
|
|
||||||
final observer = MockObserver();
|
|
||||||
final scope = Scope(null, observer: observer);
|
|
||||||
final subScope = scope.openSubScope("child");
|
|
||||||
expect(scope.openSubScope("child"), same(subScope));
|
|
||||||
await scope.closeSubScope("child");
|
|
||||||
final newSubScope = scope.openSubScope("child");
|
|
||||||
expect(newSubScope, isNot(same(subScope)));
|
|
||||||
});
|
});
|
||||||
|
|
||||||
test('closeSubScope removes subscope so next openSubScope returns new', () {
|
test('closeSubScope removes subscope so next openSubScope returns new', () {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null);
|
||||||
final scope = Scope(null, observer: observer);
|
final subScope = scope.openSubScope("child");
|
||||||
expect(Scope(scope, observer: observer), isNotNull); // эквивалент
|
expect(scope.openSubScope("child"), same(subScope));
|
||||||
// Нет необходимости тестировать open/closeSubScope в этом юните
|
scope.closeSubScope("child");
|
||||||
|
final newSubScope = scope.openSubScope("child");
|
||||||
|
expect(newSubScope, isNot(same(subScope)));
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
// --------------------------------------------------------------------------
|
// --------------------------------------------------------------------------
|
||||||
group('Dependency Resolution (standard)', () {
|
group('Dependency Resolution (standard)', () {
|
||||||
test("Throws StateError if value can't be resolved", () {
|
test("Throws StateError if value can't be resolved", () {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null);
|
||||||
final scope = Scope(null, observer: observer);
|
|
||||||
expect(() => scope.resolve<String>(), throwsA(isA<StateError>()));
|
expect(() => scope.resolve<String>(), throwsA(isA<StateError>()));
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Resolves value after adding a dependency', () {
|
test('Resolves value after adding a dependency', () {
|
||||||
final observer = MockObserver();
|
|
||||||
final expectedValue = 'test string';
|
final expectedValue = 'test string';
|
||||||
final scope = Scope(null, observer: observer)
|
final scope = Scope(null)
|
||||||
.installModules([TestModule<String>(value: expectedValue)]);
|
.installModules([TestModule<String>(value: expectedValue)]);
|
||||||
expect(scope.resolve<String>(), expectedValue);
|
expect(scope.resolve<String>(), expectedValue);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Returns a value from parent scope', () {
|
test('Returns a value from parent scope', () {
|
||||||
final observer = MockObserver();
|
|
||||||
final expectedValue = 5;
|
final expectedValue = 5;
|
||||||
final parentScope = Scope(null, observer: observer);
|
final parentScope = Scope(null);
|
||||||
final scope = Scope(parentScope, observer: observer);
|
final scope = Scope(parentScope);
|
||||||
|
|
||||||
parentScope.installModules([TestModule<int>(value: expectedValue)]);
|
parentScope.installModules([TestModule<int>(value: expectedValue)]);
|
||||||
|
|
||||||
expect(scope.resolve<int>(), expectedValue);
|
expect(scope.resolve<int>(), expectedValue);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Returns several values from parent container', () {
|
test('Returns several values from parent container', () {
|
||||||
final observer = MockObserver();
|
|
||||||
final expectedIntValue = 5;
|
final expectedIntValue = 5;
|
||||||
final expectedStringValue = 'Hello world';
|
final expectedStringValue = 'Hello world';
|
||||||
final parentScope = Scope(null, observer: observer).installModules([
|
final parentScope = Scope(null).installModules([
|
||||||
TestModule<int>(value: expectedIntValue),
|
TestModule<int>(value: expectedIntValue),
|
||||||
TestModule<String>(value: expectedStringValue)
|
TestModule<String>(value: expectedStringValue)
|
||||||
]);
|
]);
|
||||||
final scope = Scope(parentScope, observer: observer);
|
final scope = Scope(parentScope);
|
||||||
|
|
||||||
expect(scope.resolve<int>(), expectedIntValue);
|
expect(scope.resolve<int>(), expectedIntValue);
|
||||||
expect(scope.resolve<String>(), expectedStringValue);
|
expect(scope.resolve<String>(), expectedStringValue);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("Throws StateError if parent hasn't value too", () {
|
test("Throws StateError if parent hasn't value too", () {
|
||||||
final observer = MockObserver();
|
final parentScope = Scope(null);
|
||||||
final parentScope = Scope(null, observer: observer);
|
final scope = Scope(parentScope);
|
||||||
final scope = Scope(parentScope, observer: observer);
|
|
||||||
expect(() => scope.resolve<int>(), throwsA(isA<StateError>()));
|
expect(() => scope.resolve<int>(), throwsA(isA<StateError>()));
|
||||||
});
|
});
|
||||||
|
|
||||||
test("After dropModules resolves fail", () {
|
test("After dropModules resolves fail", () {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null)..installModules([TestModule<int>(value: 5)]);
|
||||||
final scope = Scope(null, observer: observer)
|
|
||||||
..installModules([TestModule<int>(value: 5)]);
|
|
||||||
expect(scope.resolve<int>(), 5);
|
expect(scope.resolve<int>(), 5);
|
||||||
scope.dropModules();
|
scope.dropModules();
|
||||||
expect(() => scope.resolve<int>(), throwsA(isA<StateError>()));
|
expect(() => scope.resolve<int>(), throwsA(isA<StateError>()));
|
||||||
@@ -197,8 +80,7 @@ void main() {
|
|||||||
// --------------------------------------------------------------------------
|
// --------------------------------------------------------------------------
|
||||||
group('Named Dependencies', () {
|
group('Named Dependencies', () {
|
||||||
test('Resolve named binding', () {
|
test('Resolve named binding', () {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null)
|
||||||
final scope = Scope(null, observer: observer)
|
|
||||||
..installModules([
|
..installModules([
|
||||||
TestModule<String>(value: "first"),
|
TestModule<String>(value: "first"),
|
||||||
TestModule<String>(value: "second", name: "special")
|
TestModule<String>(value: "second", name: "special")
|
||||||
@@ -206,18 +88,18 @@ void main() {
|
|||||||
expect(scope.resolve<String>(named: "special"), "second");
|
expect(scope.resolve<String>(named: "special"), "second");
|
||||||
expect(scope.resolve<String>(), "first");
|
expect(scope.resolve<String>(), "first");
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Named binding does not clash with unnamed', () {
|
test('Named binding does not clash with unnamed', () {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null)
|
||||||
final scope = Scope(null, observer: observer)
|
|
||||||
..installModules([
|
..installModules([
|
||||||
TestModule<String>(value: "foo", name: "bar"),
|
TestModule<String>(value: "foo", name: "bar"),
|
||||||
]);
|
]);
|
||||||
expect(() => scope.resolve<String>(), throwsA(isA<StateError>()));
|
expect(() => scope.resolve<String>(), throwsA(isA<StateError>()));
|
||||||
expect(scope.resolve<String>(named: "bar"), "foo");
|
expect(scope.resolve<String>(named: "bar"), "foo");
|
||||||
});
|
});
|
||||||
|
|
||||||
test("tryResolve returns null for missing named", () {
|
test("tryResolve returns null for missing named", () {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null)
|
||||||
final scope = Scope(null, observer: observer)
|
|
||||||
..installModules([
|
..installModules([
|
||||||
TestModule<String>(value: "foo"),
|
TestModule<String>(value: "foo"),
|
||||||
]);
|
]);
|
||||||
@@ -228,8 +110,7 @@ void main() {
|
|||||||
// --------------------------------------------------------------------------
|
// --------------------------------------------------------------------------
|
||||||
group('Provider with parameters', () {
|
group('Provider with parameters', () {
|
||||||
test('Resolve dependency using providerWithParams', () {
|
test('Resolve dependency using providerWithParams', () {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null)
|
||||||
final scope = Scope(null, observer: observer)
|
|
||||||
..installModules([
|
..installModules([
|
||||||
_InlineModule((m, s) {
|
_InlineModule((m, s) {
|
||||||
m.bind<int>().toProvideWithParams((param) => (param as int) * 2);
|
m.bind<int>().toProvideWithParams((param) => (param as int) * 2);
|
||||||
@@ -243,39 +124,38 @@ void main() {
|
|||||||
// --------------------------------------------------------------------------
|
// --------------------------------------------------------------------------
|
||||||
group('Async Resolution', () {
|
group('Async Resolution', () {
|
||||||
test('Resolve async instance', () async {
|
test('Resolve async instance', () async {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null)
|
||||||
final scope = Scope(null, observer: observer)
|
|
||||||
..installModules([
|
..installModules([
|
||||||
_InlineModule((m, s) {
|
_InlineModule((m, s) {
|
||||||
m.bind<String>().toInstance(Future.value('async value'));
|
m.bind<String>().toInstanceAsync(Future.value('async value'));
|
||||||
}),
|
}),
|
||||||
]);
|
]);
|
||||||
expect(await scope.resolveAsync<String>(), "async value");
|
expect(await scope.resolveAsync<String>(), "async value");
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Resolve async provider', () async {
|
test('Resolve async provider', () async {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null)
|
||||||
final scope = Scope(null, observer: observer)
|
|
||||||
..installModules([
|
..installModules([
|
||||||
_InlineModule((m, s) {
|
_InlineModule((m, s) {
|
||||||
m.bind<int>().toProvide(() async => 7);
|
m.bind<int>().toProvideAsync(() async => 7);
|
||||||
}),
|
}),
|
||||||
]);
|
]);
|
||||||
expect(await scope.resolveAsync<int>(), 7);
|
expect(await scope.resolveAsync<int>(), 7);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('Resolve async provider with param', () async {
|
test('Resolve async provider with param', () async {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null)
|
||||||
final scope = Scope(null, observer: observer)
|
|
||||||
..installModules([
|
..installModules([
|
||||||
_InlineModule((m, s) {
|
_InlineModule((m, s) {
|
||||||
m.bind<int>().toProvideWithParams((x) async => (x as int) * 3);
|
m.bind<int>().toProvideAsyncWithParams((x) async => (x as int) * 3);
|
||||||
}),
|
}),
|
||||||
]);
|
]);
|
||||||
expect(await scope.resolveAsync<int>(params: 2), 6);
|
expect(await scope.resolveAsync<int>(params: 2), 6);
|
||||||
expect(() => scope.resolveAsync<int>(), throwsA(isA<StateError>()));
|
expect(() => scope.resolveAsync<int>(), throwsA(isA<StateError>()));
|
||||||
});
|
});
|
||||||
|
|
||||||
test('tryResolveAsync returns null for missing', () async {
|
test('tryResolveAsync returns null for missing', () async {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null);
|
||||||
final scope = Scope(null, observer: observer);
|
|
||||||
final result = await scope.tryResolveAsync<String>();
|
final result = await scope.tryResolveAsync<String>();
|
||||||
expect(result, isNull);
|
expect(result, isNull);
|
||||||
});
|
});
|
||||||
@@ -284,102 +164,45 @@ void main() {
|
|||||||
// --------------------------------------------------------------------------
|
// --------------------------------------------------------------------------
|
||||||
group('Optional resolution and error handling', () {
|
group('Optional resolution and error handling', () {
|
||||||
test("tryResolve returns null for missing dependency", () {
|
test("tryResolve returns null for missing dependency", () {
|
||||||
final observer = MockObserver();
|
final scope = Scope(null);
|
||||||
final scope = Scope(null, observer: observer);
|
|
||||||
expect(scope.tryResolve<int>(), isNull);
|
expect(scope.tryResolve<int>(), isNull);
|
||||||
});
|
});
|
||||||
});
|
|
||||||
|
|
||||||
// --------------------------------------------------------------------------
|
// Не реализован:
|
||||||
group('Disposable resource management', () {
|
// test("Container bind() throws state error (if it's parent already has a resolver)", () {
|
||||||
test('scope.disposeAsync calls dispose on singleton disposable', () async {
|
// final parentScope = new Scope(null).installModules([TestModule<String>(value: "string one")]);
|
||||||
final scope = CherryPick.openRootScope();
|
// final scope = new Scope(parentScope);
|
||||||
scope.installModules([ModuleWithDisposable()]);
|
|
||||||
final t = scope.resolve<TestDisposable>();
|
|
||||||
expect(t.disposed, isFalse);
|
|
||||||
await scope.dispose();
|
|
||||||
expect(t.disposed, isTrue);
|
|
||||||
});
|
|
||||||
test('scope.disposeAsync calls dispose on all unique disposables',
|
|
||||||
() async {
|
|
||||||
final scope = Scope(null, observer: MockObserver());
|
|
||||||
scope.installModules([ModuleWithDisposable()]);
|
|
||||||
final t1 = scope.resolve<TestDisposable>();
|
|
||||||
final t2 = scope.resolve<AnotherDisposable>();
|
|
||||||
expect(t1.disposed, isFalse);
|
|
||||||
expect(t2.disposed, isFalse);
|
|
||||||
await scope.dispose();
|
|
||||||
expect(t1.disposed, isTrue);
|
|
||||||
expect(t2.disposed, isTrue);
|
|
||||||
});
|
|
||||||
test('calling disposeAsync twice does not throw and not call twice',
|
|
||||||
() async {
|
|
||||||
final scope = CherryPick.openRootScope();
|
|
||||||
scope.installModules([ModuleWithDisposable()]);
|
|
||||||
final t = scope.resolve<TestDisposable>();
|
|
||||||
await scope.dispose();
|
|
||||||
await scope.dispose();
|
|
||||||
expect(t.disposed, isTrue);
|
|
||||||
});
|
|
||||||
test('Non-disposable dependency is ignored by scope.disposeAsync',
|
|
||||||
() async {
|
|
||||||
final scope = CherryPick.openRootScope();
|
|
||||||
scope.installModules([ModuleWithDisposable()]);
|
|
||||||
final s = scope.resolve<String>();
|
|
||||||
expect(s, 'super string');
|
|
||||||
await scope.dispose();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// --------------------------------------------------------------------------
|
// expect(
|
||||||
// Расширенные edge-тесты для dispose и subScope
|
// () => scope.installModules([TestModule<String>(value: "string two")]),
|
||||||
group('Scope/subScope dispose edge cases', () {
|
// throwsA(isA<StateError>()));
|
||||||
test('Dispose called in closed subScope only', () async {
|
// });
|
||||||
final root = CherryPick.openRootScope();
|
|
||||||
final sub = root.openSubScope('feature')
|
|
||||||
..installModules([ModuleCountingDisposable()]);
|
|
||||||
final d = sub.resolve<CountingDisposable>();
|
|
||||||
expect(d.disposeCount, 0);
|
|
||||||
|
|
||||||
await root.closeSubScope('feature');
|
|
||||||
expect(d.disposeCount, 1); // dispose должен быть вызван
|
|
||||||
|
|
||||||
// Повторное закрытие не вызывает double-dispose
|
|
||||||
await root.closeSubScope('feature');
|
|
||||||
expect(d.disposeCount, 1);
|
|
||||||
|
|
||||||
// Повторное открытие subScope создает NEW instance (dispose на старый не вызовется снова)
|
|
||||||
final sub2 = root.openSubScope('feature')
|
|
||||||
..installModules([ModuleCountingDisposable()]);
|
|
||||||
final d2 = sub2.resolve<CountingDisposable>();
|
|
||||||
expect(identical(d, d2), isFalse);
|
|
||||||
await root.closeSubScope('feature');
|
|
||||||
expect(d2.disposeCount, 1);
|
|
||||||
});
|
|
||||||
test('Dispose for all nested subScopes on root disposeAsync', () async {
|
|
||||||
final root = CherryPick.openRootScope();
|
|
||||||
root
|
|
||||||
.openSubScope('a')
|
|
||||||
.openSubScope('b')
|
|
||||||
.installModules([ModuleCountingDisposable()]);
|
|
||||||
final d = root
|
|
||||||
.openSubScope('a')
|
|
||||||
.openSubScope('b')
|
|
||||||
.resolve<CountingDisposable>();
|
|
||||||
await root.dispose();
|
|
||||||
expect(d.disposeCount, 1);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
// --------------------------------------------------------------------------
|
|
||||||
group('Async disposable (Future test)', () {
|
|
||||||
test('Async Disposable is awaited on disposeAsync', () async {
|
|
||||||
final scope = CherryPick.openRootScope()
|
|
||||||
..installModules([AsyncExampleModule()]);
|
|
||||||
final d = scope.resolve<AsyncExampleDisposable>();
|
|
||||||
expect(d.disposed, false);
|
|
||||||
await scope.dispose();
|
|
||||||
expect(d.disposed, true);
|
|
||||||
});
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ----------------------------------------------------------------------------
|
||||||
|
// Вспомогательные модули
|
||||||
|
|
||||||
|
class TestModule<T> extends Module {
|
||||||
|
final T value;
|
||||||
|
final String? name;
|
||||||
|
|
||||||
|
TestModule({required this.value, this.name});
|
||||||
|
@override
|
||||||
|
void builder(Scope currentScope) {
|
||||||
|
if (name == null) {
|
||||||
|
bind<T>().toInstance(value);
|
||||||
|
} else {
|
||||||
|
bind<T>().withName(name!).toInstance(value);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Вспомогательный модуль для подстановки builder'а через конструктор
|
||||||
|
class _InlineModule extends Module {
|
||||||
|
final void Function(Module, Scope) _builder;
|
||||||
|
_InlineModule(this._builder);
|
||||||
|
|
||||||
|
@override
|
||||||
|
void builder(Scope s) => _builder(this, s);
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,27 +1,3 @@
|
|||||||
## 3.0.0
|
|
||||||
|
|
||||||
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
|
|
||||||
|
|
||||||
## 3.0.0-dev.0
|
|
||||||
|
|
||||||
- chore(cherrypick_annotations): sync version with cherrypick 3.0.0-dev.0
|
|
||||||
|
|
||||||
## 1.1.2-dev.2
|
|
||||||
|
|
||||||
- **DOCS**(annotations): improve API documentation and usage example.
|
|
||||||
|
|
||||||
## 1.1.2-dev.1
|
|
||||||
|
|
||||||
- **DOCS**(pub): update homepage and documentation URLs in pubspec.yaml to new official site.
|
|
||||||
|
|
||||||
## 1.1.2-dev.0
|
|
||||||
|
|
||||||
- **DOCS**(annotations): unify and improve English DartDoc for all DI annotations.
|
|
||||||
|
|
||||||
## 1.1.1
|
|
||||||
|
|
||||||
- **FIX**(license): correct urls.
|
|
||||||
|
|
||||||
## 1.1.0
|
## 1.1.0
|
||||||
|
|
||||||
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
|
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
|
||||||
|
|||||||
@@ -192,7 +192,7 @@
|
|||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
You may obtain a copy of the License at
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
https://www.apache.org/licenses/LICENSE-2.0
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
Unless required by applicable law or agreed to in writing, software
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
|||||||
@@ -1,7 +1,3 @@
|
|||||||
[](https://github.com/pese-git/cherrypick/actions/workflows/pipeline.yml)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# cherrypick_annotations
|
# cherrypick_annotations
|
||||||
|
|
||||||
[](LICENSE)
|
[](LICENSE)
|
||||||
|
|||||||
@@ -12,9 +12,6 @@
|
|||||||
# The core lints are also what is used by pub.dev for scoring packages.
|
# The core lints are also what is used by pub.dev for scoring packages.
|
||||||
|
|
||||||
include: package:lints/recommended.yaml
|
include: package:lints/recommended.yaml
|
||||||
analyzer:
|
|
||||||
errors:
|
|
||||||
camel_case_types: ignore
|
|
||||||
|
|
||||||
# Uncomment the following section to specify additional rules.
|
# Uncomment the following section to specify additional rules.
|
||||||
|
|
||||||
|
|||||||
@@ -1,111 +0,0 @@
|
|||||||
// ignore: dangling_library_doc_comments
|
|
||||||
/// Example using cherrypick_annotations together with cherrypick (core) and cherrypick_generator.
|
|
||||||
|
|
||||||
///
|
|
||||||
/// Steps to use this example:
|
|
||||||
/// 1. Make sure your example/pubspec.yaml contains:
|
|
||||||
/// - cherrypick_annotations (this package)
|
|
||||||
/// - cherrypick (core DI engine)
|
|
||||||
/// - cherrypick_generator (as a dev_dependency)
|
|
||||||
/// - build_runner (as a dev_dependency)
|
|
||||||
/// 2. Run code generation to produce DI injectors and mixins:
|
|
||||||
/// ```sh
|
|
||||||
/// dart run build_runner build
|
|
||||||
/// ```
|
|
||||||
/// 3. The `_$ApiScreen` mixin will be generated automatically.
|
|
||||||
/// 4. In your app/bootstrap code, install modules and use the generated features.
|
|
||||||
///
|
|
||||||
/// See documentation and advanced details at:
|
|
||||||
/// https://pub.dev/packages/cherrypick_annotations
|
|
||||||
|
|
||||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
||||||
// In a real project, use this import:
|
|
||||||
// import 'package:cherrypick/cherrypick.dart';
|
|
||||||
|
|
||||||
// Temporary stub for demonstration purposes only.
|
|
||||||
// In real usage, import 'Module' from `package:cherrypick/cherrypick.dart`.
|
|
||||||
class Module {}
|
|
||||||
|
|
||||||
/// This mixin is a stub for documentation and IDE hints only.
|
|
||||||
/// In a real project, it will be generated by cherrypick_generator after running build_runner.
|
|
||||||
///
|
|
||||||
/// Do not implement or edit this by hand!
|
|
||||||
mixin _$ApiScreen {}
|
|
||||||
|
|
||||||
/// Example UI/service class with dependencies to be injected.
|
|
||||||
///
|
|
||||||
/// The [@injectable] annotation tells the generator to create an injector mixin for this class.
|
|
||||||
/// Fields marked with [@inject] will be automatically filled by the code generator (using DI).
|
|
||||||
@injectable()
|
|
||||||
class ApiScreen with _$ApiScreen {
|
|
||||||
/// The default (main) implementation of the API service.
|
|
||||||
@inject()
|
|
||||||
late final ApiService apiService;
|
|
||||||
|
|
||||||
/// An alternate API (mock) implementation, injected by name using @named.
|
|
||||||
@inject()
|
|
||||||
@named('mock')
|
|
||||||
late final ApiService mockApiService;
|
|
||||||
|
|
||||||
/// Logger injected from another scope (e.g., global singleton).
|
|
||||||
@inject()
|
|
||||||
@scope('global')
|
|
||||||
late final Logger logger;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Example DI module using CherryPick annotations.
|
|
||||||
///
|
|
||||||
/// The [@module] annotation tells the generator to treat this class as a source of bindings.
|
|
||||||
/// Methods annotated with [@singleton], [@named], [@provide], [@instance] will be registered into the DI container.
|
|
||||||
@module()
|
|
||||||
abstract class AppModule extends Module {
|
|
||||||
/// Global singleton logger available throughout the app.
|
|
||||||
@singleton()
|
|
||||||
Logger provideLogger() => Logger();
|
|
||||||
|
|
||||||
/// Main API implementation, identified with the name 'main'.
|
|
||||||
@named('main')
|
|
||||||
ApiService createApi() => ApiService();
|
|
||||||
|
|
||||||
/// Mock API implementation, identified as 'mock'.
|
|
||||||
@named('mock')
|
|
||||||
ApiService createMockApi() => MockApiService();
|
|
||||||
|
|
||||||
/// UserManager is created with runtime parameters, such as per-user session.
|
|
||||||
@provide()
|
|
||||||
UserManager createManager(@params() Map<String, dynamic> runtimeParams) {
|
|
||||||
return UserManager(runtimeParams['id'] as String);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
|
||||||
// Example implementations for demonstration only.
|
|
||||||
// In a real project, these would contain application/service logic.
|
|
||||||
|
|
||||||
/// The main API service.
|
|
||||||
class ApiService {}
|
|
||||||
|
|
||||||
/// A mock API implementation (for development or testing).
|
|
||||||
class MockApiService extends ApiService {}
|
|
||||||
|
|
||||||
/// Manages user operations, created using dynamic (runtime) parameters.
|
|
||||||
class UserManager {
|
|
||||||
final String id;
|
|
||||||
UserManager(this.id);
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Global logger service.
|
|
||||||
class Logger {}
|
|
||||||
|
|
||||||
void main() {
|
|
||||||
// After running code generation, injectors and mixins will be ready to use.
|
|
||||||
// Example integration (pseudo-code):
|
|
||||||
//
|
|
||||||
// import 'package:cherrypick/cherrypick.dart';
|
|
||||||
//
|
|
||||||
// final scope = CherryPick.openRootScope()..installModules([$AppModule()]);
|
|
||||||
// final screen = ApiScreen()..injectFields();
|
|
||||||
// print(screen.apiService); // <-- injected!
|
|
||||||
//
|
|
||||||
// This main() is provided for reference only.
|
|
||||||
}
|
|
||||||
@@ -1,9 +1,11 @@
|
|||||||
|
library;
|
||||||
|
|
||||||
//
|
//
|
||||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -11,24 +13,6 @@
|
|||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
//
|
//
|
||||||
|
|
||||||
/// Annotations for use with the CherryPick dependency injection generator.
|
|
||||||
///
|
|
||||||
/// These annotations are used on classes, methods, fields or parameters to
|
|
||||||
/// describe how they should participate in dependency injection.
|
|
||||||
/// See: https://pub.dev/packages/cherrypick
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
||||||
///
|
|
||||||
/// @injectable()
|
|
||||||
/// class MyService {
|
|
||||||
/// @inject()
|
|
||||||
/// late final Logger logger;
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
library;
|
|
||||||
|
|
||||||
export 'src/module.dart';
|
export 'src/module.dart';
|
||||||
export 'src/provide.dart';
|
export 'src/provide.dart';
|
||||||
export 'src/instance.dart';
|
export 'src/instance.dart';
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -13,31 +13,22 @@
|
|||||||
|
|
||||||
import 'package:meta/meta.dart';
|
import 'package:meta/meta.dart';
|
||||||
|
|
||||||
/// Marks a field for dependency injection by CherryPick's code generator.
|
/// 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.
|
||||||
///
|
///
|
||||||
/// Use `@inject()` on fields within a class marked with `@injectable()`.
|
/// ---
|
||||||
/// Such fields will be automatically injected from the DI [Scope]
|
|
||||||
/// when using the generated mixin or calling `.injectFields()`.
|
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Аннотация для внедрения зависимости в поле через фреймворк CherryPick DI.
|
||||||
|
/// Поместите её на поле класса — генератор кода автоматически подставит нужную зависимость.
|
||||||
|
///
|
||||||
|
/// Example / Пример:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
||||||
///
|
|
||||||
/// @injectable()
|
|
||||||
/// class LoginScreen with _\$LoginScreen {
|
|
||||||
/// @inject()
|
/// @inject()
|
||||||
/// late final AuthService authService;
|
/// late final SomeService service;
|
||||||
///
|
|
||||||
/// @inject()
|
|
||||||
/// @named('main')
|
|
||||||
/// late final ApiClient api;
|
|
||||||
/// }
|
|
||||||
///
|
|
||||||
/// // After running build_runner, call:
|
|
||||||
/// // LoginScreen().injectFields();
|
|
||||||
/// ```
|
/// ```
|
||||||
@experimental
|
@experimental
|
||||||
|
// ignore: camel_case_types
|
||||||
final class inject {
|
final class inject {
|
||||||
/// Creates an [inject] annotation for field injection.
|
|
||||||
const inject();
|
const inject();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -13,32 +13,26 @@
|
|||||||
|
|
||||||
import 'package:meta/meta.dart';
|
import 'package:meta/meta.dart';
|
||||||
|
|
||||||
/// Marks a class as injectable, enabling automatic field injection by CherryPick's code generator.
|
/// 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].
|
||||||
///
|
///
|
||||||
/// Use `@injectable()` on a class whose fields (marked with `@inject`) you want to be automatically injected from the DI [Scope].
|
/// ---
|
||||||
/// When used together with code generation (see cherrypick_generator), a mixin will be generated to inject fields.
|
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Помечает класс как внедряемый для фреймворка внедрения зависимостей CherryPick.
|
||||||
|
/// Если класс помечен аннотацией [@injectable()], генератор создаст миксин
|
||||||
|
/// для автоматического внедрения полей, отмеченных [@inject].
|
||||||
|
///
|
||||||
|
/// Example / Пример:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
||||||
///
|
|
||||||
/// @injectable()
|
/// @injectable()
|
||||||
/// class ProfileScreen with _\$ProfileScreen {
|
/// class MyWidget extends StatelessWidget {
|
||||||
/// @inject()
|
/// @inject()
|
||||||
/// late final UserManager manager;
|
/// late final MyService service;
|
||||||
///
|
|
||||||
/// @inject()
|
|
||||||
/// @named('main')
|
|
||||||
/// late final ApiClient api;
|
|
||||||
/// }
|
/// }
|
||||||
///
|
|
||||||
/// // After running build_runner, call:
|
|
||||||
/// // profileScreen.injectFields();
|
|
||||||
/// ```
|
/// ```
|
||||||
///
|
|
||||||
/// After running the generator, the mixin (`_\$ProfileScreen`) will be available to help auto-inject all [@inject] fields in your widget/service/controller.
|
|
||||||
@experimental
|
@experimental
|
||||||
|
// ignore: camel_case_types
|
||||||
final class injectable {
|
final class injectable {
|
||||||
/// Creates an [injectable] annotation for classes.
|
|
||||||
const injectable();
|
const injectable();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -11,40 +11,58 @@
|
|||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
//
|
//
|
||||||
|
|
||||||
import 'package:meta/meta.dart';
|
/// ENGLISH:
|
||||||
|
/// Annotation to specify that a new instance should be provided on each request.
|
||||||
/// Marks a provider method or class to always create a new instance (factory) in CherryPick DI.
|
|
||||||
///
|
///
|
||||||
/// Use `@instance()` to annotate methods or classes in your DI module/class
|
/// Use the `@instance()` annotation for methods or classes in your DI module
|
||||||
/// when you want a new object to be created on every injection (no singleton caching).
|
/// to declare that the DI container must create a new object every time
|
||||||
/// The default DI lifecycle is instance/factory unless otherwise specified.
|
/// the dependency is injected (i.e., no singleton behavior).
|
||||||
///
|
///
|
||||||
/// ### Example (in a module method)
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
||||||
///
|
|
||||||
/// @module()
|
/// @module()
|
||||||
/// abstract class FeatureModule {
|
/// abstract class AppModule extends Module {
|
||||||
/// @instance()
|
/// @instance()
|
||||||
/// MyService provideService() => MyService();
|
/// Foo foo() => Foo();
|
||||||
///
|
|
||||||
/// @singleton()
|
|
||||||
/// Logger provideLogger() => Logger();
|
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// ### Example (on a class, with @injectable)
|
/// This will generate:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// @injectable()
|
/// final class $AppModule extends AppModule {
|
||||||
/// @instance()
|
/// @override
|
||||||
/// class MyFactoryClass {
|
/// void builder(Scope currentScope) {
|
||||||
/// // ...
|
/// bind<Foo>().toInstance(() => foo());
|
||||||
|
/// }
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// See also: [@singleton]
|
/// RUSSIAN (Русский):
|
||||||
@experimental
|
/// Аннотация для создания нового экземпляра при каждом запросе.
|
||||||
|
///
|
||||||
|
/// Используйте `@instance()` для методов или классов в DI-модуле,
|
||||||
|
/// чтобы указать, что контейнер внедрения зависимостей должен создавать
|
||||||
|
/// новый объект при каждом обращении к зависимости (то есть, не синглтон).
|
||||||
|
///
|
||||||
|
/// Пример:
|
||||||
|
/// ```dart
|
||||||
|
/// @module()
|
||||||
|
/// abstract class AppModule extends Module {
|
||||||
|
/// @instance()
|
||||||
|
/// Foo foo() => Foo();
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// Будет сгенерирован следующий код:
|
||||||
|
/// ```dart
|
||||||
|
/// final class $AppModule extends AppModule {
|
||||||
|
/// @override
|
||||||
|
/// void builder(Scope currentScope) {
|
||||||
|
/// bind<Foo>().toInstance(() => foo());
|
||||||
|
/// }
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
// ignore: camel_case_types
|
||||||
final class instance {
|
final class instance {
|
||||||
/// Creates an [instance] annotation for classes or providers.
|
|
||||||
const instance();
|
const instance();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -11,40 +11,59 @@
|
|||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
//
|
//
|
||||||
|
|
||||||
import 'package:meta/meta.dart';
|
/// ENGLISH:
|
||||||
|
/// Annotation for marking Dart classes or libraries as modules.
|
||||||
/// Marks an abstract Dart class as a dependency injection module for CherryPick code generation.
|
|
||||||
///
|
///
|
||||||
/// Use `@module()` on your abstract class to indicate it provides DI bindings (via provider methods).
|
/// Use the `@module()` annotation on abstract classes (or on a library)
|
||||||
/// This enables code generation of a concrete module that registers all bindings from your methods.
|
/// 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.
|
||||||
///
|
///
|
||||||
/// Typical usage:
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
||||||
///
|
|
||||||
/// @module()
|
/// @module()
|
||||||
/// abstract class AppModule {
|
/// abstract class AppModule extends Module {
|
||||||
/// @singleton()
|
/// // Dependency definitions go here.
|
||||||
/// Logger provideLogger() => Logger();
|
|
||||||
///
|
|
||||||
/// @named('mock')
|
|
||||||
/// ApiClient mockApi() => MockApiClient();
|
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// The generated code will look like:
|
/// 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 code...
|
/// // Dependency registration...
|
||||||
/// }
|
/// }
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// See also: [@provide], [@singleton], [@instance], [@named]
|
/// RUSSIAN (Русский):
|
||||||
@experimental
|
/// Аннотация для пометки классов или библиотек Dart как модуля.
|
||||||
|
///
|
||||||
|
/// Используйте `@module()` для абстрактных классов (или библиотек), чтобы
|
||||||
|
/// показать, что класс реализует DI-модуль (Dependency Injection).
|
||||||
|
/// Обычно используется генераторами кода для автоматической регистрации
|
||||||
|
/// и конфигурирования зависимостей, определённых в модуле.
|
||||||
|
///
|
||||||
|
/// Пример:
|
||||||
|
/// ```dart
|
||||||
|
/// @module()
|
||||||
|
/// abstract class AppModule extends Module {
|
||||||
|
/// // Определения зависимостей
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// Будет сгенерирован код:
|
||||||
|
/// ```dart
|
||||||
|
/// final class $AppModule extends AppModule {
|
||||||
|
/// @override
|
||||||
|
/// void builder(Scope currentScope) {
|
||||||
|
/// // Регистрация зависимостей...
|
||||||
|
/// }
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
// ignore: camel_case_types
|
||||||
final class module {
|
final class module {
|
||||||
/// Creates a [module] annotation for use on a DI module class.
|
/// Creates a [module] annotation.
|
||||||
const module();
|
const module();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -11,52 +11,67 @@
|
|||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
//
|
//
|
||||||
|
|
||||||
import 'package:meta/meta.dart';
|
/// ENGLISH:
|
||||||
|
/// Annotation to assign a name or identifier to a class, method, or other element.
|
||||||
/// Assigns a name or key identifier to a class, field, factory method or parameter
|
|
||||||
/// for use in multi-registration scenarios (named dependencies) in CherryPick DI.
|
|
||||||
///
|
///
|
||||||
/// Use `@named('key')` to distinguish between multiple bindings/implementations
|
/// The `@named('value')` annotation allows you to specify a string name
|
||||||
/// of the same type—when registering and when injecting dependencies.
|
/// 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.
|
||||||
///
|
///
|
||||||
/// You can use `@named`:
|
/// Example:
|
||||||
/// - On provider/factory methods in a module
|
|
||||||
/// - On fields with `@inject()` to receive a named instance
|
|
||||||
/// - On function parameters (for method/constructor injection)
|
|
||||||
///
|
|
||||||
/// ### Example: On Provider Method
|
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// @module()
|
/// @module()
|
||||||
/// abstract class AppModule {
|
/// abstract class AppModule extends Module {
|
||||||
/// @named('main')
|
/// @named('dio')
|
||||||
/// ApiClient apiClient() => ApiClient();
|
/// Dio dio() => Dio();
|
||||||
///
|
|
||||||
/// @named('mock')
|
|
||||||
/// ApiClient mockApi() => MockApiClient();
|
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// ### Example: On Injectable Field
|
/// This will generate:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// @injectable()
|
/// final class $AppModule extends AppModule {
|
||||||
/// class WidgetModel with _\$WidgetModel {
|
/// @override
|
||||||
/// @inject()
|
/// void builder(Scope currentScope) {
|
||||||
/// @named('main')
|
/// bind<Dio>().toProvide(() => dio()).withName('dio').singleton();
|
||||||
/// late final ApiClient api;
|
/// }
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// ### Example: On Parameter
|
/// RUSSIAN (Русский):
|
||||||
|
/// Аннотация для задания имени или идентификатора классу, методу или другому элементу.
|
||||||
|
///
|
||||||
|
/// Аннотация `@named('значение')` позволяет указать строковое имя для зависимости,
|
||||||
|
/// фабрики или внедряемого значения. Это удобно для различения нескольких
|
||||||
|
/// регистраций одного типа в DI, генерации кода.
|
||||||
|
///
|
||||||
|
/// Пример:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// class UserScreen {
|
/// @module()
|
||||||
/// UserScreen(@named('current') User user);
|
/// abstract class AppModule extends Module {
|
||||||
|
/// @named('dio')
|
||||||
|
/// Dio dio() => Dio();
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
@experimental
|
///
|
||||||
|
/// Будет сгенерирован следующий код:
|
||||||
|
/// ```dart
|
||||||
|
/// final class $AppModule extends AppModule {
|
||||||
|
/// @override
|
||||||
|
/// void builder(Scope currentScope) {
|
||||||
|
/// bind<Dio>().toProvide(() => dio()).withName('dio').singleton();
|
||||||
|
/// }
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
// ignore: camel_case_types
|
||||||
final class named {
|
final class named {
|
||||||
/// The assigned name or identifier for the dependency, provider, or parameter.
|
/// EN: The assigned name or identifier for the element.
|
||||||
|
///
|
||||||
|
/// RU: Назначенное имя или идентификатор для элемента.
|
||||||
final String value;
|
final String value;
|
||||||
|
|
||||||
/// Creates a [named] annotation with the given [value] key or name.
|
/// EN: Creates a [named] annotation with the given [value].
|
||||||
|
///
|
||||||
|
/// RU: Создаёт аннотацию [named] с заданным значением [value].
|
||||||
const named(this.value);
|
const named(this.value);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -11,33 +11,46 @@
|
|||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
//
|
//
|
||||||
|
|
||||||
import 'package:meta/meta.dart';
|
/// ENGLISH:
|
||||||
|
/// Annotation to mark a method parameter for injection with run-time arguments.
|
||||||
/// Marks a parameter in a provider method to receive dynamic runtime arguments when resolving a dependency.
|
|
||||||
///
|
///
|
||||||
/// Use `@params()` in a DI module/factory method when the value must be supplied by the user/code at injection time,
|
/// Use the `@params()` annotation to specify that a particular parameter of a
|
||||||
/// not during static wiring (such as user input, navigation arguments, etc).
|
/// provider method should be assigned a value supplied at resolution time,
|
||||||
///
|
/// rather than during static dependency graph creation. This is useful in DI
|
||||||
/// This enables CherryPick and its codegen to generate .withParams or .toProvideWithParams bindings — so your provider can access runtime values.
|
/// when a dependency must receive dynamic data passed by the consumer
|
||||||
|
/// (via `.withParams(...)` in the generated code).
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
/// @provide()
|
||||||
|
/// String greet(@params() dynamic params) => 'Hello $params';
|
||||||
|
/// ```
|
||||||
///
|
///
|
||||||
/// @module()
|
/// This will generate:
|
||||||
/// abstract class FeatureModule {
|
|
||||||
/// @provide
|
|
||||||
/// UserManager createManager(@params Map<String, dynamic> runtimeParams) {
|
|
||||||
/// return UserManager.forUserId(runtimeParams['userId']);
|
|
||||||
/// }
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
/// Usage at injection/resolution:
|
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// final manager = scope.resolve<UserManager>(params: {'userId': myId});
|
/// bind<String>().toProvideWithParams((args) => greet(args));
|
||||||
/// ```
|
/// ```
|
||||||
@experimental
|
///
|
||||||
|
/// RUSSIAN (Русский):
|
||||||
|
/// Аннотация для пометки параметра метода, который будет внедряться со значением во время выполнения.
|
||||||
|
///
|
||||||
|
/// Используйте `@params()` чтобы указать, что конкретный параметр метода-провайдера
|
||||||
|
/// должен получать значение, передаваемое в момент обращения к зависимости,
|
||||||
|
/// а не на этапе построения графа зависимостей. Это полезно, если зависимость
|
||||||
|
/// должна получать данные динамически от пользователя или другого процесса
|
||||||
|
/// через `.withParams(...)` в сгенерированном коде.
|
||||||
|
///
|
||||||
|
/// Пример:
|
||||||
|
/// ```dart
|
||||||
|
/// @provide()
|
||||||
|
/// String greet(@params() dynamic params) => 'Hello $params';
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// Будет сгенерировано:
|
||||||
|
/// ```dart
|
||||||
|
/// bind<String>().toProvideWithParams((args) => greet(args));
|
||||||
|
/// ```
|
||||||
|
// ignore: camel_case_types
|
||||||
final class params {
|
final class params {
|
||||||
/// Marks a method/constructor parameter as supplied at runtime by the caller.
|
|
||||||
const params();
|
const params();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -11,34 +11,60 @@
|
|||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
//
|
//
|
||||||
|
|
||||||
import 'package:meta/meta.dart';
|
/// ENGLISH:
|
||||||
|
/// Annotation to declare a factory/provider method or class as a singleton.
|
||||||
/// Marks a method or class as a dependency provider (factory/provider) for CherryPick module code generation.
|
|
||||||
///
|
///
|
||||||
/// Use `@provide` on any method inside a `@module()` annotated class when you want that method
|
/// Use the `@singleton()` annotation on methods in your DI module to specify
|
||||||
/// to be used as a DI factory/provider during code generation.
|
/// that only one instance of the resulting object should be created and shared
|
||||||
///
|
/// for all consumers. This is especially useful in dependency injection
|
||||||
/// This should be used for methods that create dynamic, optional, or complex dependencies, especially
|
/// frameworks and service locators.
|
||||||
/// if you want to control the codegen/injection pipeline explicitly and support parameters.
|
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
||||||
///
|
|
||||||
/// @module()
|
/// @module()
|
||||||
/// abstract class FeatureModule {
|
/// abstract class AppModule extends Module {
|
||||||
/// @provide
|
|
||||||
/// Future<Api> provideApi(@params Map<String, dynamic> args) async => ...;
|
|
||||||
///
|
|
||||||
/// @singleton()
|
/// @singleton()
|
||||||
/// @provide
|
/// Dio dio() => Dio();
|
||||||
/// Logger provideLogger() => Logger();
|
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// See also: [@singleton], [@instance], [@params], [@named]
|
/// This generates the following code:
|
||||||
@experimental
|
/// ```dart
|
||||||
|
/// final class $AppModule extends AppModule {
|
||||||
|
/// @override
|
||||||
|
/// void builder(Scope currentScope) {
|
||||||
|
/// bind<Dio>().toProvide(() => dio()).singleton();
|
||||||
|
/// }
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// RUSSIAN (Русский):
|
||||||
|
/// Аннотация для объявления фабричного/провайдерного метода или класса синглтоном.
|
||||||
|
///
|
||||||
|
/// Используйте `@singleton()` для методов внутри DI-модуля, чтобы указать,
|
||||||
|
/// что соответствующий объект (экземпляр класса) должен быть создан только один раз
|
||||||
|
/// и использоваться всеми компонентами приложения (единый общий экземпляр).
|
||||||
|
/// Это характерно для систем внедрения зависимостей и сервис-локаторов.
|
||||||
|
///
|
||||||
|
/// Пример:
|
||||||
|
/// ```dart
|
||||||
|
/// @module()
|
||||||
|
/// abstract class AppModule extends Module {
|
||||||
|
/// @singleton()
|
||||||
|
/// Dio dio() => Dio();
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// Будет сгенерирован следующий код:
|
||||||
|
/// ```dart
|
||||||
|
/// final class $AppModule extends AppModule {
|
||||||
|
/// @override
|
||||||
|
/// void builder(Scope currentScope) {
|
||||||
|
/// bind<Dio>().toProvide(() => dio()).singleton();
|
||||||
|
/// }
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
// ignore: camel_case_types
|
||||||
final class provide {
|
final class provide {
|
||||||
/// Creates a [provide] annotation for marking provider methods/classes in DI modules.
|
|
||||||
const provide();
|
const provide();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -13,43 +13,25 @@
|
|||||||
|
|
||||||
import 'package:meta/meta.dart';
|
import 'package:meta/meta.dart';
|
||||||
|
|
||||||
/// Specifies the DI scope or region from which a dependency should be resolved.
|
/// 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.
|
||||||
///
|
///
|
||||||
/// Use `@scope('scopeName')` on an injected field, parameter, or provider method when you want
|
/// ---
|
||||||
/// to resolve a dependency not from the current scope, but from another named scope/subcontainer.
|
|
||||||
///
|
///
|
||||||
/// Useful for advanced DI scenarios: multi-feature/state isolation, navigation stacks, explicit subscopes, or testing.
|
/// Аннотация для указания области внедрения (scope) в CherryPick.
|
||||||
|
/// Используйте её на инъецируемом поле, чтобы определить из какой области
|
||||||
|
/// должна быть получена зависимость.
|
||||||
///
|
///
|
||||||
/// Example (injected field):
|
/// Example / Пример:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// @injectable()
|
|
||||||
/// class ProfileScreen with _\$ProfileScreen {
|
|
||||||
/// @inject()
|
/// @inject()
|
||||||
/// @scope('profile')
|
/// @scope('profile')
|
||||||
/// late final ProfileManager manager;
|
/// late final ProfileManager profileManager;
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Example (parameter):
|
|
||||||
/// ```dart
|
|
||||||
/// class TabBarModel {
|
|
||||||
/// TabBarModel(@scope('tabs') TabContext context);
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Example (in a module):
|
|
||||||
/// ```dart
|
|
||||||
/// @module()
|
|
||||||
/// abstract class FeatureModule {
|
|
||||||
/// @provide
|
|
||||||
/// Service service(@scope('shared') SharedConfig config);
|
|
||||||
/// }
|
|
||||||
/// ```
|
/// ```
|
||||||
@experimental
|
@experimental
|
||||||
|
// ignore: camel_case_types
|
||||||
final class scope {
|
final class scope {
|
||||||
/// The name/key of the DI scope from which to resolve this dependency.
|
|
||||||
final String? name;
|
final String? name;
|
||||||
|
|
||||||
/// Creates a [scope] annotation specifying which DI scope to use for the dependency resolution.
|
|
||||||
const scope(this.name);
|
const scope(this.name);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -11,32 +11,63 @@
|
|||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
//
|
//
|
||||||
|
|
||||||
import 'package:meta/meta.dart';
|
/// ENGLISH:
|
||||||
|
/// Annotation to declare a dependency as a singleton.
|
||||||
/// Marks a provider method or class so its instance is created only once and shared (singleton) for DI in CherryPick.
|
|
||||||
///
|
///
|
||||||
/// Use `@singleton()` on provider methods or classes in your DI module to ensure only one instance is ever created
|
/// Use the `@singleton()` annotation on provider methods inside a module
|
||||||
/// and reused across the application's lifetime (or scope lifetime).
|
/// to indicate that only a single instance of this dependency should be
|
||||||
|
/// created and shared throughout the application's lifecycle. This is
|
||||||
|
/// typically used in dependency injection frameworks or service locators
|
||||||
|
/// to guarantee a single shared instance.
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
||||||
///
|
|
||||||
/// @module()
|
/// @module()
|
||||||
/// abstract class AppModule {
|
/// abstract class AppModule extends Module {
|
||||||
/// @singleton()
|
/// @singleton()
|
||||||
/// ApiClient createApi() => ApiClient();
|
/// Dio dio() => Dio();
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// The generated code will ensure:
|
/// This will generate code like:
|
||||||
/// ```dart
|
/// ```dart
|
||||||
/// bind<ApiClient>().toProvide(() => createApi()).singleton();
|
/// final class $AppModule extends AppModule {
|
||||||
|
/// @override
|
||||||
|
/// void builder(Scope currentScope) {
|
||||||
|
/// bind<Dio>().toProvide(() => dio()).singleton();
|
||||||
|
/// }
|
||||||
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// See also: [@instance], [@provide], [@named]
|
/// RUSSIAN (Русский):
|
||||||
@experimental
|
/// Аннотация для объявления зависимости как синглтона.
|
||||||
|
///
|
||||||
|
/// Используйте `@singleton()` для методов-провайдеров внутри модуля,
|
||||||
|
/// чтобы указать, что соответствующий объект должен быть создан
|
||||||
|
/// единожды и использоваться во всём приложении (общий синглтон).
|
||||||
|
/// Это характерно для систем внедрения зависимостей и сервис-локаторов,
|
||||||
|
/// чтобы гарантировать один общий экземпляр.
|
||||||
|
///
|
||||||
|
/// Пример:
|
||||||
|
/// ```dart
|
||||||
|
/// @module()
|
||||||
|
/// abstract class AppModule extends Module {
|
||||||
|
/// @singleton()
|
||||||
|
/// Dio dio() => Dio();
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// Будет сгенерирован следующий код:
|
||||||
|
/// ```dart
|
||||||
|
/// final class $AppModule extends AppModule {
|
||||||
|
/// @override
|
||||||
|
/// void builder(Scope currentScope) {
|
||||||
|
/// bind<Dio>().toProvide(() => dio()).singleton();
|
||||||
|
/// }
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
// ignore: camel_case_types
|
||||||
final class singleton {
|
final class singleton {
|
||||||
/// Creates a [singleton] annotation for DI providers/classes.
|
/// Creates a [singleton] annotation.
|
||||||
const singleton();
|
const singleton();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,17 +1,10 @@
|
|||||||
name: cherrypick_annotations
|
name: cherrypick_annotations
|
||||||
description: |
|
description: |
|
||||||
Set of annotations for CherryPick dependency injection library. Enables code generation and declarative DI for Dart & Flutter projects.
|
Set of annotations for CherryPick dependency injection library. Enables code generation and declarative DI for Dart & Flutter projects.
|
||||||
version: 3.0.0
|
version: 1.1.0
|
||||||
homepage: https://cherrypick-di.netlify.app
|
documentation: https://github.com/pese-git/cherrypick/wiki
|
||||||
documentation: https://cherrypick-di.netlify.app/docs/intro
|
|
||||||
repository: https://github.com/pese-git/cherrypick/cherrypick_annotations
|
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
|
|
||||||
- dependency-injection
|
|
||||||
- dependency-management
|
|
||||||
- inversion-of-control
|
|
||||||
|
|
||||||
environment:
|
environment:
|
||||||
sdk: ">=3.5.2 <4.0.0"
|
sdk: ">=3.5.2 <4.0.0"
|
||||||
|
|||||||
@@ -1,59 +1,3 @@
|
|||||||
## 3.0.0
|
|
||||||
|
|
||||||
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
|
|
||||||
|
|
||||||
## 3.0.0-dev.1
|
|
||||||
|
|
||||||
- Update a dependency to the latest release.
|
|
||||||
|
|
||||||
## 3.0.0-dev.0
|
|
||||||
|
|
||||||
- chore(cherrypick_flutter): sync version with cherrypick 3.0.0-dev.12
|
|
||||||
|
|
||||||
## 1.1.3-dev.12
|
|
||||||
|
|
||||||
- Update a dependency to the latest release.
|
|
||||||
|
|
||||||
## 1.1.3-dev.11
|
|
||||||
|
|
||||||
- Update a dependency to the latest release.
|
|
||||||
|
|
||||||
## 1.1.3-dev.10
|
|
||||||
|
|
||||||
- **DOCS**(pub): update homepage and documentation URLs in pubspec.yaml to new official site.
|
|
||||||
|
|
||||||
## 1.1.3-dev.9
|
|
||||||
|
|
||||||
- **DOCS**(provider): add detailed English API documentation for CherryPickProvider Flutter integration.
|
|
||||||
|
|
||||||
## 1.1.3-dev.8
|
|
||||||
|
|
||||||
- Update a dependency to the latest release.
|
|
||||||
|
|
||||||
## 1.1.3-dev.7
|
|
||||||
|
|
||||||
- **FIX**(license): correct urls.
|
|
||||||
|
|
||||||
## 1.1.3-dev.6
|
|
||||||
|
|
||||||
- Update a dependency to the latest release.
|
|
||||||
|
|
||||||
## 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
|
## 1.1.3-dev.1
|
||||||
|
|
||||||
- Update a dependency to the latest release.
|
- Update a dependency to the latest release.
|
||||||
|
|||||||
@@ -192,7 +192,7 @@
|
|||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
You may obtain a copy of the License at
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
https://www.apache.org/licenses/LICENSE-2.0
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
Unless required by applicable law or agreed to in writing, software
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
|||||||
@@ -1,7 +1,3 @@
|
|||||||
[](https://github.com/pese-git/cherrypick/actions/workflows/pipeline.yml)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# CherryPick Flutter
|
# CherryPick Flutter
|
||||||
|
|
||||||
`cherrypick_flutter` offers a Flutter integration to access and manage dependency injection scopes using the `CherryPickProvider`. This setup facilitates accessing the root scope directly from the widget tree, providing a straightforward mechanism for dependences management within Flutter applications.
|
`cherrypick_flutter` offers a Flutter integration to access and manage dependency injection scopes using the `CherryPickProvider`. This setup facilitates accessing the root scope directly from the widget tree, providing a straightforward mechanism for dependences management within Flutter applications.
|
||||||
@@ -98,4 +94,4 @@ Contributions to improve this library are welcome. Feel free to open issues and
|
|||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the Apache License 2.0. A copy of the license can be obtained at [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
|
This project is licensed under the Apache License 2.0. A copy of the license can be obtained at [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
|
||||||
@@ -4,7 +4,7 @@ library;
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import 'package:flutter/widgets.dart';
|
|||||||
/// Licensed under the Apache License, Version 2.0 (the "License");
|
/// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
/// you may not use this file except in compliance with the License.
|
/// you may not use this file except in compliance with the License.
|
||||||
/// You may obtain a copy of the License at
|
/// You may obtain a copy of the License at
|
||||||
/// https://www.apache.org/licenses/LICENSE-2.0
|
/// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
/// Unless required by applicable law or agreed to in writing, software
|
/// Unless required by applicable law or agreed to in writing, software
|
||||||
/// distributed under the License is distributed on an "AS IS" BASIS,
|
/// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -14,87 +14,29 @@ import 'package:flutter/widgets.dart';
|
|||||||
/// limitations under the License.
|
/// limitations under the License.
|
||||||
///
|
///
|
||||||
|
|
||||||
/// {@template cherrypick_flutter_provider}
|
|
||||||
/// An [InheritedWidget] that provides convenient integration of CherryPick
|
|
||||||
/// dependency injection scopes into the Flutter widget tree.
|
|
||||||
///
|
|
||||||
/// Place `CherryPickProvider` at the top of your widget subtree to make a
|
|
||||||
/// [Scope] (or its descendants) available via `CherryPickProvider.of(context)`.
|
|
||||||
///
|
|
||||||
/// This is the recommended entry point for connecting CherryPick DI to your
|
|
||||||
/// Flutter app or feature area, enabling context-based scope management and
|
|
||||||
/// DI resolution in child widgets.
|
|
||||||
///
|
|
||||||
/// ### Example: Root Integration
|
|
||||||
/// ```dart
|
|
||||||
/// void main() {
|
|
||||||
/// final rootScope = CherryPick.openRootScope()
|
|
||||||
/// ..installModules([AppModule()]);
|
|
||||||
/// runApp(
|
|
||||||
/// CherryPickProvider(
|
|
||||||
/// child: MyApp(),
|
|
||||||
/// ),
|
|
||||||
/// );
|
|
||||||
/// }
|
|
||||||
///
|
|
||||||
/// // In any widget:
|
|
||||||
/// final provider = CherryPickProvider.of(context);
|
|
||||||
/// final scope = provider.openRootScope();
|
|
||||||
/// final myService = scope.resolve<MyService>();
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// ### Example: Subscope for a Feature/Screen
|
|
||||||
/// ```dart
|
|
||||||
/// Widget build(BuildContext context) {
|
|
||||||
/// final provider = CherryPickProvider.of(context);
|
|
||||||
/// final featureScope = provider.openSubScope(scopeName: 'featureA');
|
|
||||||
/// return MyFeatureScreen(scope: featureScope);
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// You can use [openRootScope] and [openSubScope] as helpers to get/create scopes.
|
|
||||||
/// {@endtemplate}
|
|
||||||
final class CherryPickProvider extends InheritedWidget {
|
final class CherryPickProvider extends InheritedWidget {
|
||||||
/// Opens (or returns) the application-wide root [Scope].
|
|
||||||
///
|
|
||||||
/// Use to make all dependencies available at the top of your widget tree.
|
|
||||||
Scope openRootScope() => CherryPick.openRootScope();
|
Scope openRootScope() => CherryPick.openRootScope();
|
||||||
|
|
||||||
/// Opens a subscope (child [Scope]) with the given [scopeName].
|
|
||||||
///
|
|
||||||
/// Useful to create isolated feature/module scopes in widget subtrees.
|
|
||||||
/// If [scopeName] is empty, an unnamed scope is created.
|
|
||||||
Scope openSubScope({String scopeName = '', String separator = '.'}) =>
|
Scope openSubScope({String scopeName = '', String separator = '.'}) =>
|
||||||
CherryPick.openScope(scopeName: scopeName, separator: separator);
|
CherryPick.openScope(scopeName: scopeName, separator: separator);
|
||||||
|
|
||||||
/// Creates a [CherryPickProvider] and exposes it to the widget subtree.
|
// Constructor for CherryPickProvider. Initializes with a required rootScope and child widget.
|
||||||
///
|
|
||||||
/// Place near the root of your widget tree. Use [child] to provide the subtree.
|
|
||||||
const CherryPickProvider({
|
const CherryPickProvider({
|
||||||
super.key,
|
super.key,
|
||||||
required super.child,
|
required super.child,
|
||||||
});
|
});
|
||||||
|
|
||||||
/// Locates the nearest [CherryPickProvider] up the widget tree from [context].
|
// Method to access the nearest CherryPickProvider instance from the context
|
||||||
///
|
|
||||||
/// Throws if not found. Use this to access DI [Scope] controls anywhere below the provider.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// final provider = CherryPickProvider.of(context);
|
|
||||||
/// final scope = provider.openRootScope();
|
|
||||||
/// ```
|
|
||||||
static CherryPickProvider of(BuildContext context) {
|
static CherryPickProvider of(BuildContext context) {
|
||||||
|
// Looks up the widget tree for an instance of CherryPickProvider
|
||||||
final CherryPickProvider? result =
|
final CherryPickProvider? result =
|
||||||
context.dependOnInheritedWidgetOfExactType<CherryPickProvider>();
|
context.dependOnInheritedWidgetOfExactType<CherryPickProvider>();
|
||||||
|
// Assert to ensure a CherryPickProvider is present in the context
|
||||||
assert(result != null, 'No CherryPickProvider found in context');
|
assert(result != null, 'No CherryPickProvider found in context');
|
||||||
return result!;
|
return result!;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Controls update notifications for dependent widgets.
|
// Determines whether the widget should notify dependents when it changes
|
||||||
///
|
|
||||||
/// Always returns false because the provider itself is stateless:
|
|
||||||
/// changes are to the underlying scopes, not the widget.
|
|
||||||
@override
|
@override
|
||||||
bool updateShouldNotify(CherryPickProvider oldWidget) {
|
bool updateShouldNotify(CherryPickProvider oldWidget) {
|
||||||
return false;
|
return false;
|
||||||
|
|||||||
@@ -1,16 +1,10 @@
|
|||||||
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: 3.0.0
|
version: 1.1.3-dev.1
|
||||||
homepage: https://cherrypick-di.netlify.app
|
homepage: https://pese-git.github.io/cherrypick-site/
|
||||||
documentation: https://cherrypick-di.netlify.app/docs/intro
|
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
|
|
||||||
- dependency-injection
|
|
||||||
- dependency-management
|
|
||||||
- inversion-of-control
|
|
||||||
|
|
||||||
environment:
|
environment:
|
||||||
sdk: ">=3.5.2 <4.0.0"
|
sdk: ">=3.5.2 <4.0.0"
|
||||||
@@ -19,7 +13,7 @@ environment:
|
|||||||
dependencies:
|
dependencies:
|
||||||
flutter:
|
flutter:
|
||||||
sdk: flutter
|
sdk: flutter
|
||||||
cherrypick: ^3.0.0
|
cherrypick: ^3.0.0-dev.1
|
||||||
|
|
||||||
dev_dependencies:
|
dev_dependencies:
|
||||||
flutter_test:
|
flutter_test:
|
||||||
|
|||||||
@@ -1,29 +1,3 @@
|
|||||||
## 3.0.0
|
|
||||||
|
|
||||||
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
|
|
||||||
|
|
||||||
## 3.0.0-dev.0
|
|
||||||
|
|
||||||
- chore(cherrypick_generator): sync version with cherrypick 3.0.0-dev.12
|
|
||||||
|
|
||||||
## 2.0.0-dev.2
|
|
||||||
|
|
||||||
- Update a dependency to the latest release.
|
|
||||||
|
|
||||||
## 2.0.0-dev.1
|
|
||||||
|
|
||||||
- **DOCS**(pub): update homepage and documentation URLs in pubspec.yaml to new official site.
|
|
||||||
|
|
||||||
## 2.0.0-dev.0
|
|
||||||
|
|
||||||
> Note: This release has breaking changes.
|
|
||||||
|
|
||||||
- **BREAKING** **DOCS**(generator): improve and unify English documentation and examples for all DI source files.
|
|
||||||
|
|
||||||
## 1.1.1
|
|
||||||
|
|
||||||
- **FIX**(license): correct urls.
|
|
||||||
|
|
||||||
## 1.1.0
|
## 1.1.0
|
||||||
|
|
||||||
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
|
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.
|
||||||
|
|||||||
@@ -192,7 +192,7 @@
|
|||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
You may obtain a copy of the License at
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
https://www.apache.org/licenses/LICENSE-2.0
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
Unless required by applicable law or agreed to in writing, software
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
|||||||
@@ -1,7 +1,3 @@
|
|||||||
[](https://github.com/pese-git/cherrypick/actions/workflows/pipeline.yml)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Cherrypick Generator
|
# Cherrypick Generator
|
||||||
|
|
||||||
**Cherrypick Generator** is a Dart code generation library for automating dependency injection (DI) boilerplate. It processes classes and fields annotated with [cherrypick_annotations](https://pub.dev/packages/cherrypick_annotations) and generates registration code for services, modules, and field injection for classes marked as `@injectable`. It supports advanced DI features such as scopes, named bindings, parameters, and asynchronous dependencies.
|
**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.
|
||||||
|
|||||||
@@ -1,37 +1,17 @@
|
|||||||
|
library;
|
||||||
|
|
||||||
//
|
//
|
||||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
// See the License for the specific language governing permissions and
|
// See the License for the specific language governing permissions and
|
||||||
// limitations under the License.
|
// limitations under the License.
|
||||||
//
|
//
|
||||||
library;
|
|
||||||
|
|
||||||
/// CherryPick code generation library: entry point for build_runner DI codegen.
|
|
||||||
///
|
|
||||||
/// This library exports generators for CherryPick dependency injection:
|
|
||||||
/// - [ModuleGenerator]: Generates DI module classes for all `@module()`-annotated classes.
|
|
||||||
/// - [InjectGenerator]: Generates field-injection mixins for classes annotated with `@injectable()`.
|
|
||||||
///
|
|
||||||
/// These generators are hooked into [build_runner] and cherrypick_generator's builder configuration.
|
|
||||||
/// Normally you do not import this directly; instead, add cherrypick_generator
|
|
||||||
/// as a dev_dependency and run `dart run build_runner build`.
|
|
||||||
///
|
|
||||||
/// Example usage in `build.yaml` or your project's workflow:
|
|
||||||
/// ```yaml
|
|
||||||
/// targets:
|
|
||||||
/// $default:
|
|
||||||
/// builders:
|
|
||||||
/// cherrypick_generator|cherrypick_generator:
|
|
||||||
/// generate_for:
|
|
||||||
/// - lib/**.dart
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// For annotation details, see `package:cherrypick_annotations`.
|
|
||||||
export 'module_generator.dart';
|
export 'module_generator.dart';
|
||||||
export 'inject_generator.dart';
|
export 'inject_generator.dart';
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -20,85 +20,28 @@ import 'package:source_gen/source_gen.dart';
|
|||||||
import 'package:analyzer/dart/element/element.dart';
|
import 'package:analyzer/dart/element/element.dart';
|
||||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart' as ann;
|
import 'package:cherrypick_annotations/cherrypick_annotations.dart' as ann;
|
||||||
|
|
||||||
/// CherryPick DI field injector generator for codegen.
|
/// InjectGenerator generates a mixin for a class marked with @injectable()
|
||||||
|
/// and injects all fields annotated with @inject(), using CherryPick DI.
|
||||||
///
|
///
|
||||||
/// Analyzes all Dart classes marked with `@injectable()` and generates a mixin (for example, `_$ProfileScreen`)
|
/// For Future<T> fields it calls .resolveAsync<T>(),
|
||||||
/// which contains the `_inject` method. This method will assign all fields annotated with `@inject()`
|
/// otherwise .resolve<T>() is used. Scope and named qualifiers are supported.
|
||||||
/// using the CherryPick DI container. Extra annotation qualifiers such as `@named` and `@scope` are respected
|
|
||||||
/// for each field. Nullable fields and Future/injectable async dependencies are also supported automatically.
|
|
||||||
///
|
///
|
||||||
/// ---
|
/// ---
|
||||||
///
|
///
|
||||||
/// ### Example usage in a project:
|
/// InjectGenerator генерирует миксин для класса с аннотацией @injectable()
|
||||||
|
/// и внедряет все поля, помеченные @inject(), используя DI-фреймворк CherryPick.
|
||||||
///
|
///
|
||||||
/// ```dart
|
/// Для Future<T> полей вызывается .resolveAsync<T>(),
|
||||||
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
/// для остальных — .resolve<T>(). Поддерживаются scope и named qualifier.
|
||||||
///
|
///
|
||||||
/// @injectable()
|
|
||||||
/// class MyScreen with _$MyScreen {
|
|
||||||
/// @inject()
|
|
||||||
/// late final Logger logger;
|
|
||||||
///
|
|
||||||
/// @inject()
|
|
||||||
/// @named('test')
|
|
||||||
/// late final HttpClient client;
|
|
||||||
///
|
|
||||||
/// @inject()
|
|
||||||
/// Future<Analytics>? analytics;
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// After running build_runner, this mixin will be auto-generated:
|
|
||||||
///
|
|
||||||
/// ```dart
|
|
||||||
/// mixin _$MyScreen {
|
|
||||||
/// void _inject(MyScreen instance) {
|
|
||||||
/// instance.logger = CherryPick.openRootScope().resolve<Logger>();
|
|
||||||
/// instance.client = CherryPick.openRootScope().resolve<HttpClient>(named: 'test');
|
|
||||||
/// instance.analytics = CherryPick.openRootScope().tryResolveAsync<Analytics>(); // nullable async inject
|
|
||||||
/// }
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// You may use the mixin (e.g., `myScreen._inject(myScreen)`) or expose your own public helper for instance field injection.
|
|
||||||
///
|
|
||||||
/// **Supported scenarios:**
|
|
||||||
/// - Ordinary injectable fields: `resolve<T>()`.
|
|
||||||
/// - Named qualifiers: `resolve<T>(named: ...)`.
|
|
||||||
/// - Scoping: `CherryPick.openScope(scopeName: ...).resolve<T>()`.
|
|
||||||
/// - Nullable/incomplete fields: `tryResolve`/`tryResolveAsync`.
|
|
||||||
/// - Async dependencies: `Future<T>`/`resolveAsync<T>()`.
|
|
||||||
///
|
|
||||||
/// See also:
|
|
||||||
/// * @inject
|
|
||||||
/// * @injectable
|
|
||||||
class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
|
class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
|
||||||
const InjectGenerator();
|
const InjectGenerator();
|
||||||
|
|
||||||
/// Main entry point for CherryPick field injection code generation.
|
/// The main entry point for code generation.
|
||||||
///
|
///
|
||||||
/// - Only triggers for classes marked with `@injectable()`.
|
/// Checks class validity, collects injectable fields, and produces injection code.
|
||||||
/// - Throws an error if used on non-class elements.
|
|
||||||
/// - Scans all fields marked with `@inject()` and gathers qualifiers (if any).
|
|
||||||
/// - Generates Dart code for a mixin that injects all dependencies into the target class instance.
|
|
||||||
///
|
///
|
||||||
/// Returns the Dart code as a String defining the new mixin.
|
/// Основная точка входа генератора. Проверяет класс, собирает инъектируемые поля и создает код внедрения зависимостей.
|
||||||
///
|
|
||||||
/// Example input (user code):
|
|
||||||
/// ```dart
|
|
||||||
/// @injectable()
|
|
||||||
/// class UserBloc with _$UserBloc {
|
|
||||||
/// @inject() late final AuthRepository authRepository;
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
/// Example output (generated):
|
|
||||||
/// ```dart
|
|
||||||
/// mixin _$UserBloc {
|
|
||||||
/// void _inject(UserBloc instance) {
|
|
||||||
/// instance.authRepository = CherryPick.openRootScope().resolve<AuthRepository>();
|
|
||||||
/// }
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
@override
|
@override
|
||||||
FutureOr<String> generateForAnnotatedElement(
|
FutureOr<String> generateForAnnotatedElement(
|
||||||
Element element,
|
Element element,
|
||||||
@@ -120,7 +63,8 @@ class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
|
|||||||
..writeln('mixin $mixinName {')
|
..writeln('mixin $mixinName {')
|
||||||
..writeln(' void _inject($className instance) {');
|
..writeln(' void _inject($className instance) {');
|
||||||
|
|
||||||
// Collect and process all @inject fields
|
// Collect and process all @inject fields.
|
||||||
|
// Собираем и обрабатываем все поля с @inject.
|
||||||
final injectFields =
|
final injectFields =
|
||||||
classElement.fields.where(_isInjectField).map(_parseInjectField);
|
classElement.fields.where(_isInjectField).map(_parseInjectField);
|
||||||
|
|
||||||
@@ -135,20 +79,20 @@ class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
|
|||||||
return buffer.toString();
|
return buffer.toString();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns true if a field is annotated with `@inject`.
|
/// Checks if a field has the @inject annotation.
|
||||||
///
|
///
|
||||||
/// Used to detect which fields should be processed for injection.
|
/// Проверяет, отмечено ли поле аннотацией @inject.
|
||||||
static bool _isInjectField(FieldElement field) {
|
static bool _isInjectField(FieldElement field) {
|
||||||
return field.metadata.any(
|
return field.metadata.any(
|
||||||
(m) => m.computeConstantValue()?.type?.getDisplayString() == 'inject',
|
(m) => m.computeConstantValue()?.type?.getDisplayString() == 'inject',
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Parses `@inject()` field and extracts all injection metadata
|
/// Parses the field for scope/named qualifiers and determines its type.
|
||||||
/// (core type, qualifiers, scope, nullability, etc).
|
/// Returns a [_ParsedInjectField] describing injection information.
|
||||||
///
|
///
|
||||||
/// Converts Dart field declaration and all parameterizing injection-related
|
/// Разбирает поле на наличие модификаторов scope/named и выясняет его тип.
|
||||||
/// annotations into a [_ParsedInjectField] which is used for codegen.
|
/// Возвращает [_ParsedInjectField] с информацией о внедрении.
|
||||||
static _ParsedInjectField _parseInjectField(FieldElement field) {
|
static _ParsedInjectField _parseInjectField(FieldElement field) {
|
||||||
String? scopeName;
|
String? scopeName;
|
||||||
String? namedValue;
|
String? namedValue;
|
||||||
@@ -176,7 +120,8 @@ class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
|
|||||||
isFuture = false;
|
isFuture = false;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Determine nullability for field types like T? or Future<T?>
|
// ***
|
||||||
|
// Добавим определение nullable для типа (например PostRepository? или Future<PostRepository?>)
|
||||||
bool isNullable = dartType.nullabilitySuffix ==
|
bool isNullable = dartType.nullabilitySuffix ==
|
||||||
NullabilitySuffix.question ||
|
NullabilitySuffix.question ||
|
||||||
(dartType is ParameterizedType &&
|
(dartType is ParameterizedType &&
|
||||||
@@ -194,17 +139,13 @@ class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Generates Dart code for a single dependency-injected field based on its metadata.
|
/// Generates a line of code that performs the dependency injection for a field.
|
||||||
|
/// Handles resolve/resolveAsync, scoping, and named qualifiers.
|
||||||
///
|
///
|
||||||
/// This code will resolve the field from the CherryPick DI container and assign it to the class instance.
|
/// Генерирует строку кода, которая внедряет зависимость для поля.
|
||||||
/// Correctly dispatches to resolve, tryResolve, resolveAsync, or tryResolveAsync methods,
|
/// Учитывает resolve/resolveAsync, scoping и named qualifier.
|
||||||
/// and applies container scoping or named resolution where required.
|
|
||||||
///
|
|
||||||
/// Returns literal Dart code as string (1 line).
|
|
||||||
///
|
|
||||||
/// Example output:
|
|
||||||
/// `instance.logger = CherryPick.openRootScope().resolve<Logger>();`
|
|
||||||
String _generateInjectionLine(_ParsedInjectField field) {
|
String _generateInjectionLine(_ParsedInjectField field) {
|
||||||
|
// Используем tryResolve для nullable, иначе resolve
|
||||||
final resolveMethod = field.isFuture
|
final resolveMethod = field.isFuture
|
||||||
? (field.isNullable
|
? (field.isNullable
|
||||||
? 'tryResolveAsync<${field.coreType}>'
|
? 'tryResolveAsync<${field.coreType}>'
|
||||||
@@ -225,29 +166,30 @@ class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Internal structure: describes all required information for generating the injection
|
/// Data structure representing all information required to generate
|
||||||
/// assignment for a given field.
|
/// injection code for a field.
|
||||||
///
|
///
|
||||||
/// Not exported. Used as a DTO in the generator for each field.
|
/// Структура данных, содержащая всю информацию,
|
||||||
|
/// необходимую для генерации кода внедрения для поля.
|
||||||
class _ParsedInjectField {
|
class _ParsedInjectField {
|
||||||
/// The name of the field to be injected.
|
/// The name of the field / Имя поля.
|
||||||
final String fieldName;
|
final String fieldName;
|
||||||
|
|
||||||
/// The Dart type to resolve (e.g. `Logger` from `Logger` or `Future<Logger>`).
|
/// The base type name (T or Future<T>) / Базовый тип (T или тип из Future<T>).
|
||||||
final String coreType;
|
final String coreType;
|
||||||
|
|
||||||
/// True if the field is an async dependency (Future<...>), otherwise false.
|
/// True if the field type is Future<T>; false otherwise
|
||||||
|
/// Истина, если поле — Future<T>, иначе — ложь.
|
||||||
final bool isFuture;
|
final bool isFuture;
|
||||||
|
|
||||||
/// True if the field accepts null (T?), otherwise false.
|
/// Optional scope annotation argument / Опциональное имя scope.
|
||||||
final bool isNullable;
|
|
||||||
|
|
||||||
/// The scoping for DI resolution, or null to use root scope.
|
|
||||||
final String? scopeName;
|
final String? scopeName;
|
||||||
|
|
||||||
/// Name qualifier for named resolution, or null if not set.
|
/// Optional named annotation argument / Опциональное имя named.
|
||||||
final String? namedValue;
|
final String? namedValue;
|
||||||
|
|
||||||
|
final bool isNullable;
|
||||||
|
|
||||||
_ParsedInjectField({
|
_ParsedInjectField({
|
||||||
required this.fieldName,
|
required this.fieldName,
|
||||||
required this.coreType,
|
required this.coreType,
|
||||||
@@ -258,8 +200,8 @@ class _ParsedInjectField {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Factory for creating the build_runner builder for DI field injection.
|
/// Builder factory. Used by build_runner.
|
||||||
///
|
///
|
||||||
/// Add this builder in your build.yaml if you're invoking CherryPick generators manually.
|
/// Фабрика билдера. Используется build_runner.
|
||||||
Builder injectBuilder(BuilderOptions options) =>
|
Builder injectBuilder(BuilderOptions options) =>
|
||||||
PartBuilder([InjectGenerator()], '.inject.cherrypick.g.dart');
|
PartBuilder([InjectGenerator()], '.inject.cherrypick.g.dart');
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -19,89 +19,75 @@ import 'package:cherrypick_annotations/cherrypick_annotations.dart' as ann;
|
|||||||
import 'src/generated_class.dart';
|
import 'src/generated_class.dart';
|
||||||
|
|
||||||
/// ---------------------------------------------------------------------------
|
/// ---------------------------------------------------------------------------
|
||||||
/// CherryPick Module Generator — Codegen for DI modules
|
/// ModuleGenerator for code generation of dependency-injected modules.
|
||||||
///
|
///
|
||||||
/// This generator scans Dart classes annotated with `@module()` and generates
|
/// ENGLISH
|
||||||
/// boilerplate for dependency injection registration automatically. Each public
|
/// This generator scans for Dart classes annotated with `@module()` and
|
||||||
/// method in such classes can be annotated to describe how an object should be
|
/// automatically generates boilerplate code for dependency injection
|
||||||
/// bound to the DI container (singleton, factory, named, with parameters, etc).
|
/// (DI) based on the public methods in those classes. Each method can be
|
||||||
|
/// annotated to describe how an object should be provided to the DI container.
|
||||||
|
/// The generated code registers those methods as bindings. This automates the
|
||||||
|
/// creation of factories, singletons, and named instances, reducing repetitive
|
||||||
|
/// manual code.
|
||||||
///
|
///
|
||||||
/// The generated code collects all such bind methods and produces a Dart
|
/// RUSSIAN
|
||||||
/// companion *module registration class* with a `.bindAll()` method, which you
|
/// Генератор зависимостей для DI-контейнера на основе аннотаций.
|
||||||
/// can use from your DI root to automatically register those dependencies.
|
/// Данный генератор автоматически создаёт код для внедрения зависимостей (DI)
|
||||||
///
|
/// на основе аннотаций в вашем исходном коде. Когда вы отмечаете класс
|
||||||
/// ## Example
|
/// аннотацией `@module()`, этот генератор обработает все его публичные методы
|
||||||
/// ```dart
|
/// и автоматически сгенерирует класс с биндингами (регистрациями зависимостей)
|
||||||
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
/// для DI-контейнера. Это избавляет от написания однообразного шаблонного кода.
|
||||||
///
|
|
||||||
/// @module()
|
|
||||||
/// abstract class AppModule {
|
|
||||||
/// @singleton()
|
|
||||||
/// Logger logger() => Logger();
|
|
||||||
///
|
|
||||||
/// @provide()
|
|
||||||
/// ApiService api(Logger logger) => ApiService(logger);
|
|
||||||
///
|
|
||||||
/// @named('dev')
|
|
||||||
/// FakeService fake() => FakeService();
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// After codegen, you will get (simplified):
|
|
||||||
/// ```dart
|
|
||||||
/// class _\$AppModuleCherrypickModule extend AppModule {
|
|
||||||
/// static void bindAll(CherryPickScope scope, AppModule module) {
|
|
||||||
/// scope.addSingleton<Logger>(() => module.logger());
|
|
||||||
/// scope.addFactory<ApiService>(() => module.api(scope.resolve<Logger>()));
|
|
||||||
/// scope.addFactory<FakeService>(() => module.fake(), named: 'dev');
|
|
||||||
/// }
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Use it e.g. in your bootstrap:
|
|
||||||
/// ```dart
|
|
||||||
/// final scope = CherryPick.openRootScope()..intallModules([_\$AppModuleCherrypickModule()]);
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Features supported:
|
|
||||||
/// - Singleton, factory, named, parametric, and async providers
|
|
||||||
/// - Eliminates all boilerplate for DI registration
|
|
||||||
/// - Works with abstract classes and real classes
|
|
||||||
/// - Error if @module() is applied to a non-class
|
|
||||||
///
|
|
||||||
/// See also: [@singleton], [@provide], [@named], [@module]
|
|
||||||
/// ---------------------------------------------------------------------------
|
/// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
class ModuleGenerator extends GeneratorForAnnotation<ann.module> {
|
class ModuleGenerator extends GeneratorForAnnotation<ann.module> {
|
||||||
/// Generates Dart source for a class marked with the `@module()` annotation.
|
/// -------------------------------------------------------------------------
|
||||||
|
/// ENGLISH
|
||||||
|
/// Generates the Dart source for a class marked with the `@module()` annotation.
|
||||||
|
/// - [element]: the original Dart class element.
|
||||||
|
/// - [annotation]: the annotation parameters (not usually used here).
|
||||||
|
/// - [buildStep]: the current build step info.
|
||||||
///
|
///
|
||||||
/// Throws [InvalidGenerationSourceError] if used on anything except a class.
|
/// RUSSIAN
|
||||||
///
|
/// Генерирует исходный код для класса-модуля с аннотацией `@module()`.
|
||||||
/// See file-level docs for usage and generated output example.
|
/// [element] — исходный класс, помеченный аннотацией.
|
||||||
|
/// [annotation] — значения параметров аннотации.
|
||||||
|
/// [buildStep] — информация о текущем шаге генерации.
|
||||||
|
/// -------------------------------------------------------------------------
|
||||||
@override
|
@override
|
||||||
String generateForAnnotatedElement(
|
String generateForAnnotatedElement(
|
||||||
Element element,
|
Element element,
|
||||||
ConstantReader annotation,
|
ConstantReader annotation,
|
||||||
BuildStep buildStep,
|
BuildStep buildStep,
|
||||||
) {
|
) {
|
||||||
|
// Only classes are supported for @module() annotation
|
||||||
|
// Обрабатываются только классы (другие элементы — ошибка)
|
||||||
if (element is! ClassElement) {
|
if (element is! ClassElement) {
|
||||||
throw InvalidGenerationSourceError(
|
throw InvalidGenerationSourceError(
|
||||||
'@module() can only be applied to classes.',
|
'@module() can only be applied to classes. / @module() может быть применён только к классам.',
|
||||||
element: element,
|
element: element,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
final classElement = element;
|
final classElement = element;
|
||||||
|
|
||||||
|
// Build a representation of the generated bindings based on class methods /
|
||||||
|
// Создаёт объект, описывающий, какие биндинги нужно сгенерировать на основании методов класса
|
||||||
final generatedClass = GeneratedClass.fromClassElement(classElement);
|
final generatedClass = GeneratedClass.fromClassElement(classElement);
|
||||||
|
|
||||||
|
// Generate the resulting Dart code / Генерирует итоговый Dart-код
|
||||||
return generatedClass.generate();
|
return generatedClass.generate();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// ---------------------------------------------------------------------------
|
/// ---------------------------------------------------------------------------
|
||||||
/// Codegen builder entry point: register this builder in build.yaml or your package.
|
/// ENGLISH
|
||||||
|
/// Entry point for build_runner. Returns a Builder used to generate code for
|
||||||
|
/// every file with a @module() annotation.
|
||||||
///
|
///
|
||||||
/// Used by build_runner. Generates .module.cherrypick.g.dart files for each
|
/// RUSSIAN
|
||||||
/// source file with an annotated @module() class.
|
/// Точка входа для генератора build_runner.
|
||||||
|
/// Возвращает Builder, используемый build_runner для генерации кода для всех
|
||||||
|
/// файлов, где встречается @module().
|
||||||
/// ---------------------------------------------------------------------------
|
/// ---------------------------------------------------------------------------
|
||||||
Builder moduleBuilder(BuilderOptions options) =>
|
Builder moduleBuilder(BuilderOptions options) =>
|
||||||
PartBuilder([ModuleGenerator()], '.module.cherrypick.g.dart');
|
PartBuilder([ModuleGenerator()], '.module.cherrypick.g.dart');
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -15,43 +15,9 @@ import 'package:analyzer/dart/element/element.dart';
|
|||||||
import 'exceptions.dart';
|
import 'exceptions.dart';
|
||||||
import 'metadata_utils.dart';
|
import 'metadata_utils.dart';
|
||||||
|
|
||||||
/// Provides static utility methods for validating annotation usage in CherryPick
|
/// Validates annotation combinations and usage patterns
|
||||||
/// dependency injection code generation.
|
|
||||||
///
|
|
||||||
/// This validator helps ensure that `@provide`, `@instance`, `@singleton`, `@params`,
|
|
||||||
/// `@inject`, `@named`, `@module`, and `@injectable` annotations are correctly and safely
|
|
||||||
/// combined in your codebase, preventing common configuration and codegen errors before
|
|
||||||
/// code is generated.
|
|
||||||
///
|
|
||||||
/// #### Example Usage
|
|
||||||
/// ```dart
|
|
||||||
/// void processMethod(MethodElement method) {
|
|
||||||
/// AnnotationValidator.validateMethodAnnotations(method);
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// All exceptions are thrown as [AnnotationValidationException] and will include
|
|
||||||
/// a helpful message and context.
|
|
||||||
///
|
|
||||||
/// ---
|
|
||||||
/// Typical checks performed by this utility:
|
|
||||||
/// - Mutual exclusivity (`@instance` vs `@provide`)
|
|
||||||
/// - Required presence for fields and methods
|
|
||||||
/// - Proper parameters for `@named` and `@params`
|
|
||||||
/// - Correct usage of injectable fields, module class methods, etc.
|
|
||||||
///
|
|
||||||
class AnnotationValidator {
|
class AnnotationValidator {
|
||||||
/// Validates annotations for a given [MethodElement].
|
/// Validates annotations on a method element
|
||||||
///
|
|
||||||
/// Checks:
|
|
||||||
/// - Mutual exclusivity of `@instance` and `@provide`.
|
|
||||||
/// - That a method is annotated with exactly one DI-producing annotation.
|
|
||||||
/// - If `@params` is present, that it is used together with `@provide`.
|
|
||||||
/// - Appropriate usage of `@singleton`.
|
|
||||||
/// - [@named] syntax and conventions.
|
|
||||||
/// - Parameter validation for method arguments.
|
|
||||||
///
|
|
||||||
/// Throws [AnnotationValidationException] on any violation.
|
|
||||||
static void validateMethodAnnotations(MethodElement method) {
|
static void validateMethodAnnotations(MethodElement method) {
|
||||||
final annotations = _getAnnotationNames(method.metadata);
|
final annotations = _getAnnotationNames(method.metadata);
|
||||||
|
|
||||||
@@ -60,28 +26,14 @@ class AnnotationValidator {
|
|||||||
_validateAnnotationParameters(method);
|
_validateAnnotationParameters(method);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Validates that a [FieldElement] has correct injection annotations.
|
/// Validates annotations on a field element
|
||||||
///
|
|
||||||
/// Specifically, ensures:
|
|
||||||
/// - Injectable fields are of valid type.
|
|
||||||
/// - No `void` injection.
|
|
||||||
/// - Correct scope naming if present.
|
|
||||||
///
|
|
||||||
/// Throws [AnnotationValidationException] if checks fail.
|
|
||||||
static void validateFieldAnnotations(FieldElement field) {
|
static void validateFieldAnnotations(FieldElement field) {
|
||||||
final annotations = _getAnnotationNames(field.metadata);
|
final annotations = _getAnnotationNames(field.metadata);
|
||||||
|
|
||||||
_validateInjectFieldAnnotations(field, annotations);
|
_validateInjectFieldAnnotations(field, annotations);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Validates all class-level DI annotations.
|
/// Validates annotations on a class element
|
||||||
///
|
|
||||||
/// Executes checks for:
|
|
||||||
/// - Module class validity (e.g. must have public DI methods if `@module`).
|
|
||||||
/// - Injectable class: at least one @inject field, field finalness, etc.
|
|
||||||
/// - Provides helpful context for error/warning reporting.
|
|
||||||
///
|
|
||||||
/// Throws [AnnotationValidationException] if checks fail.
|
|
||||||
static void validateClassAnnotations(ClassElement classElement) {
|
static void validateClassAnnotations(ClassElement classElement) {
|
||||||
final annotations = _getAnnotationNames(classElement.metadata);
|
final annotations = _getAnnotationNames(classElement.metadata);
|
||||||
|
|
||||||
@@ -89,9 +41,6 @@ class AnnotationValidator {
|
|||||||
_validateInjectableClassAnnotations(classElement, annotations);
|
_validateInjectableClassAnnotations(classElement, annotations);
|
||||||
}
|
}
|
||||||
|
|
||||||
// --- Internal helpers follow (private) ---
|
|
||||||
|
|
||||||
/// Helper: Returns the names of all annotation types on `metadata`.
|
|
||||||
static List<String> _getAnnotationNames(List<ElementAnnotation> metadata) {
|
static List<String> _getAnnotationNames(List<ElementAnnotation> metadata) {
|
||||||
return metadata
|
return metadata
|
||||||
.map((m) => m.computeConstantValue()?.type?.getDisplayString())
|
.map((m) => m.computeConstantValue()?.type?.getDisplayString())
|
||||||
@@ -100,9 +49,6 @@ class AnnotationValidator {
|
|||||||
.toList();
|
.toList();
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Validates that mutually exclusive method annotations are not used together.
|
|
||||||
///
|
|
||||||
/// For example, `@instance` and `@provide` cannot both be present.
|
|
||||||
static void _validateMutuallyExclusiveAnnotations(
|
static void _validateMutuallyExclusiveAnnotations(
|
||||||
MethodElement method,
|
MethodElement method,
|
||||||
List<String> annotations,
|
List<String> annotations,
|
||||||
@@ -122,10 +68,6 @@ class AnnotationValidator {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Validates correct annotation combinations, e.g.
|
|
||||||
/// - `@params` must be with `@provide`
|
|
||||||
/// - One of `@instance` or `@provide` must be present for a registration method
|
|
||||||
/// - Validates singleton usage
|
|
||||||
static void _validateAnnotationCombinations(
|
static void _validateAnnotationCombinations(
|
||||||
MethodElement method,
|
MethodElement method,
|
||||||
List<String> annotations,
|
List<String> annotations,
|
||||||
@@ -163,7 +105,6 @@ class AnnotationValidator {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Singleton-specific method annotation checks.
|
|
||||||
static void _validateSingletonUsage(
|
static void _validateSingletonUsage(
|
||||||
MethodElement method,
|
MethodElement method,
|
||||||
List<String> annotations,
|
List<String> annotations,
|
||||||
@@ -189,7 +130,6 @@ class AnnotationValidator {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Validates extra requirements or syntactic rules for annotation arguments, like @named.
|
|
||||||
static void _validateAnnotationParameters(MethodElement method) {
|
static void _validateAnnotationParameters(MethodElement method) {
|
||||||
// Validate @named annotation parameters
|
// Validate @named annotation parameters
|
||||||
final namedValue = MetadataUtils.getNamedValue(method.metadata);
|
final namedValue = MetadataUtils.getNamedValue(method.metadata);
|
||||||
@@ -230,11 +170,11 @@ class AnnotationValidator {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Checks that @params is used with compatible parameter type.
|
|
||||||
static void _validateParamsParameter(
|
static void _validateParamsParameter(
|
||||||
ParameterElement param, MethodElement method) {
|
ParameterElement param, MethodElement method) {
|
||||||
// @params parameter should typically be dynamic or Map<String, dynamic>
|
// @params parameter should typically be dynamic or Map<String, dynamic>
|
||||||
final paramType = param.type.getDisplayString();
|
final paramType = param.type.getDisplayString();
|
||||||
|
|
||||||
if (paramType != 'dynamic' &&
|
if (paramType != 'dynamic' &&
|
||||||
paramType != 'Map<String, dynamic>' &&
|
paramType != 'Map<String, dynamic>' &&
|
||||||
paramType != 'Map<String, dynamic>?') {
|
paramType != 'Map<String, dynamic>?') {
|
||||||
@@ -254,7 +194,6 @@ class AnnotationValidator {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Checks field-level annotation for valid injectable fields.
|
|
||||||
static void _validateInjectFieldAnnotations(
|
static void _validateInjectFieldAnnotations(
|
||||||
FieldElement field,
|
FieldElement field,
|
||||||
List<String> annotations,
|
List<String> annotations,
|
||||||
@@ -288,7 +227,6 @@ class AnnotationValidator {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Checks @module usage: must have at least one DI method, each with DI-annotation.
|
|
||||||
static void _validateModuleClassAnnotations(
|
static void _validateModuleClassAnnotations(
|
||||||
ClassElement classElement,
|
ClassElement classElement,
|
||||||
List<String> annotations,
|
List<String> annotations,
|
||||||
@@ -330,7 +268,6 @@ class AnnotationValidator {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Checks @injectable usage on classes and their fields.
|
|
||||||
static void _validateInjectableClassAnnotations(
|
static void _validateInjectableClassAnnotations(
|
||||||
ClassElement classElement,
|
ClassElement classElement,
|
||||||
List<String> annotations,
|
List<String> annotations,
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -12,59 +12,57 @@
|
|||||||
//
|
//
|
||||||
|
|
||||||
/// ----------------------------------------------------------------------------
|
/// ----------------------------------------------------------------------------
|
||||||
/// BindParameterSpec
|
/// BindParameterSpec - describes a single method parameter and how to resolve it.
|
||||||
///
|
///
|
||||||
/// Describes a single parameter for a DI provider/factory/binding method,
|
/// ENGLISH
|
||||||
/// specifying how that parameter is to be resolved in generated code.
|
/// Describes a single parameter for a provider/binding method in the DI system.
|
||||||
|
/// Stores the parameter type, its optional `@named` key for named resolution,
|
||||||
|
/// and whether it is a runtime "params" argument. Used to generate code that
|
||||||
|
/// resolves dependencies from the DI scope:
|
||||||
|
/// - If the parameter is a dependency type (e.g. SomeDep), emits:
|
||||||
|
/// currentScope.resolve<SomeDep>()
|
||||||
|
/// - If the parameter is named, emits:
|
||||||
|
/// currentScope.resolve<SomeDep>(named: 'yourName')
|
||||||
|
/// - If it's a runtime parameter (e.g. via @params()), emits:
|
||||||
|
/// args
|
||||||
///
|
///
|
||||||
/// Stores the parameter's type name, optional `@named` identifier (for named DI resolution),
|
/// RUSSIAN
|
||||||
/// and a flag for runtime (@params) arguments. Used in CherryPick generator
|
/// Описывает один параметр метода в DI, и его способ разрешения из контейнера.
|
||||||
/// for creating argument lists when invoking factories or provider methods.
|
/// Сохраняет имя типа, дополнительное имя (если параметр аннотирован через @named),
|
||||||
///
|
/// и признак runtime-параметра (@params).
|
||||||
/// ## Example usage
|
/// Для обычной зависимости типа (например, SomeDep) генерирует строку вида:
|
||||||
/// ```dart
|
/// currentScope.resolve<SomeDep>()
|
||||||
/// // Binding method: @provide() Logger provideLogger(@named('debug') Config config, @params Map<String, dynamic> args)
|
/// Для зависимости с именем:
|
||||||
/// final namedParam = BindParameterSpec('Config', 'debug');
|
/// currentScope.resolve<SomeDep>(named: 'имя')
|
||||||
/// final runtimeParam = BindParameterSpec('Map<String, dynamic>', null, isParams: true);
|
/// Для runtime-параметра:
|
||||||
/// print(namedParam.generateArg()); // prints: currentScope.resolve<Config>(named: 'debug')
|
/// args
|
||||||
/// print(runtimeParam.generateArg()); // prints: args
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// ## Code generation logic
|
|
||||||
/// - Injected: currentScope.resolve<Service>()
|
|
||||||
/// - Named: currentScope.resolve<Service>(named: 'name')
|
|
||||||
/// - @params: args
|
|
||||||
/// ----------------------------------------------------------------------------
|
/// ----------------------------------------------------------------------------
|
||||||
class BindParameterSpec {
|
class BindParameterSpec {
|
||||||
/// The type name of the parameter (e.g., 'UserRepository')
|
/// Type name of the parameter (e.g. SomeService)
|
||||||
|
/// Имя типа параметра (например, SomeService)
|
||||||
final String typeName;
|
final String typeName;
|
||||||
|
|
||||||
/// If non-null, this is the named-key for DI resolution (from @named).
|
/// Optional name for named resolution (from @named)
|
||||||
|
/// Необязательное имя для разрешения по имени (если аннотировано через @named)
|
||||||
final String? named;
|
final String? named;
|
||||||
|
|
||||||
/// True if this parameter is a runtime param (annotated with @params and
|
/// True if this parameter uses @params and should be provided from runtime args
|
||||||
/// filled by a runtime argument map).
|
/// Признак, что параметр — runtime (через @params)
|
||||||
final bool isParams;
|
final bool isParams;
|
||||||
|
|
||||||
BindParameterSpec(this.typeName, this.named, {this.isParams = false});
|
BindParameterSpec(this.typeName, this.named, {this.isParams = false});
|
||||||
|
|
||||||
/// Generates Dart code to resolve this parameter in the DI container.
|
/// --------------------------------------------------------------------------
|
||||||
|
/// generateArg
|
||||||
///
|
///
|
||||||
/// - For normal dependencies: resolves by type
|
/// ENGLISH
|
||||||
/// - For named dependencies: resolves by type and name
|
/// Generates Dart code for resolving the dependency from the DI scope,
|
||||||
/// - For @params: uses the supplied params variable (default 'args')
|
/// considering type, named, and param-argument.
|
||||||
///
|
///
|
||||||
/// ## Example
|
/// RUSSIAN
|
||||||
/// ```dart
|
/// Генерирует строку для получения зависимости из DI scope (с учётом имени
|
||||||
/// final a = BindParameterSpec('Api', null); // normal
|
/// и типа параметра или runtime-режима @params).
|
||||||
/// print(a.generateArg()); // currentScope.resolve<Api>()
|
/// --------------------------------------------------------------------------
|
||||||
///
|
|
||||||
/// final b = BindParameterSpec('Api', 'prod'); // named
|
|
||||||
/// print(b.generateArg()); // currentScope.resolve<Api>(named: 'prod')
|
|
||||||
///
|
|
||||||
/// final c = BindParameterSpec('Map<String,dynamic>', null, isParams: true); // params
|
|
||||||
/// print(c.generateArg()); // args
|
|
||||||
/// ```
|
|
||||||
String generateArg([String paramsVar = 'args']) {
|
String generateArg([String paramsVar = 'args']) {
|
||||||
if (isParams) {
|
if (isParams) {
|
||||||
return paramsVar;
|
return paramsVar;
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -19,64 +19,62 @@ import 'exceptions.dart';
|
|||||||
import 'type_parser.dart';
|
import 'type_parser.dart';
|
||||||
import 'annotation_validator.dart';
|
import 'annotation_validator.dart';
|
||||||
|
|
||||||
/// Enum representing the binding annotation applied to a module method.
|
|
||||||
enum BindingType {
|
enum BindingType {
|
||||||
/// Direct instance returned from the method (@instance).
|
|
||||||
instance,
|
instance,
|
||||||
|
|
||||||
/// Provider/factory function (@provide).
|
|
||||||
provide;
|
provide;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// ---------------------------------------------------------------------------
|
/// ---------------------------------------------------------------------------
|
||||||
/// BindSpec
|
/// BindSpec -- describes a binding specification generated for a dependency.
|
||||||
///
|
///
|
||||||
/// Describes a DI container binding as generated from a single public factory,
|
/// ENGLISH
|
||||||
/// instance, or provider method of a module (annotated with @instance or @provide).
|
/// Represents all the data necessary to generate a DI binding for a single
|
||||||
|
/// method in a module class. Each BindSpec corresponds to one public method
|
||||||
|
/// and contains information about its type, provider method, lifecycle (singleton),
|
||||||
|
/// parameters (with their annotations), binding strategy (instance/provide),
|
||||||
|
/// asynchronous mode, and named keys. It is responsible for generating the
|
||||||
|
/// correct Dart code to register this binding with the DI container, in both
|
||||||
|
/// sync and async cases, with and without named or runtime arguments.
|
||||||
///
|
///
|
||||||
/// Includes all annotation-driven parameters required to generate valid DI
|
/// RUSSIAN
|
||||||
/// registration Dart code in CherryPick:
|
/// Описывает параметры для создания одного биндинга зависимости (binding spec).
|
||||||
/// - Return type
|
/// Каждый биндинг соответствует одному публичному методу класса-модуля и
|
||||||
/// - Provider method name
|
/// содержит всю информацию для генерации кода регистрации этого биндинга в
|
||||||
/// - Singleton flag
|
/// DI-контейнере: тип возвращаемой зависимости, имя метода, параметры, аннотации
|
||||||
/// - Named identifier (from @named)
|
/// (@singleton, @named, @instance, @provide), асинхронность, признак runtime
|
||||||
/// - List of resolved or runtime (@params) parameters
|
/// аргументов и др. Генерирует правильный Dart-код для регистрации биндера.
|
||||||
/// - Binding mode (instance/provide)
|
|
||||||
/// - Async and parametric variants
|
|
||||||
///
|
|
||||||
/// ## Example usage
|
|
||||||
/// ```dart
|
|
||||||
/// // Suppose @provide() Api api(@named('test') Client client)
|
|
||||||
/// final bindSpec = BindSpec.fromMethod(methodElement);
|
|
||||||
/// print(bindSpec.generateBind(2)); // bind<Api>().toProvide(() => api(currentScope.resolve<Client>(named: 'test')));
|
|
||||||
/// ```
|
|
||||||
/// ---------------------------------------------------------------------------
|
/// ---------------------------------------------------------------------------
|
||||||
class BindSpec {
|
class BindSpec {
|
||||||
/// The type this binding provides (e.g. SomeService)
|
/// The type this binding provides (e.g. SomeService)
|
||||||
|
/// Тип, который предоставляет биндинг (например, SomeService)
|
||||||
final String returnType;
|
final String returnType;
|
||||||
|
|
||||||
/// Binding provider/factory method name
|
/// Method name that implements the binding
|
||||||
|
/// Имя метода, который реализует биндинг
|
||||||
final String methodName;
|
final String methodName;
|
||||||
|
|
||||||
/// Named identifier for DI resolution (null if unnamed)
|
/// Optional name for named dependency (from @named)
|
||||||
|
/// Необязательное имя, для именованной зависимости (используется с @named)
|
||||||
final String? named;
|
final String? named;
|
||||||
|
|
||||||
/// If true, binding is registered as singleton in DI
|
/// Whether the dependency is a singleton (@singleton annotation)
|
||||||
|
/// Является ли зависимость синглтоном (имеется ли аннотация @singleton)
|
||||||
final bool isSingleton;
|
final bool isSingleton;
|
||||||
|
|
||||||
/// Provider/factory method parameters (in order)
|
/// List of method parameters to inject dependencies with
|
||||||
|
/// Список параметров, которые требуются методу для внедрения зависимостей
|
||||||
final List<BindParameterSpec> parameters;
|
final List<BindParameterSpec> parameters;
|
||||||
|
|
||||||
/// Instance vs provider mode, from annotation choice
|
/// Binding type: 'instance' or 'provide' (@instance or @provide)
|
||||||
final BindingType bindingType;
|
final BindingType bindingType; // 'instance' | 'provide'
|
||||||
|
|
||||||
/// Async flag for .toInstanceAsync()
|
/// True if the method is asynchronous and uses instance binding (Future)
|
||||||
final bool isAsyncInstance;
|
final bool isAsyncInstance;
|
||||||
|
|
||||||
/// Async flag for .toProvideAsync()
|
/// True if the method is asynchronous and uses provide binding (Future)
|
||||||
final bool isAsyncProvide;
|
final bool isAsyncProvide;
|
||||||
|
|
||||||
/// True if a @params runtime parameter is present
|
/// True if the binding method accepts runtime "params" argument (@params)
|
||||||
final bool hasParams;
|
final bool hasParams;
|
||||||
|
|
||||||
BindSpec({
|
BindSpec({
|
||||||
@@ -91,12 +89,20 @@ class BindSpec {
|
|||||||
required this.hasParams,
|
required this.hasParams,
|
||||||
});
|
});
|
||||||
|
|
||||||
/// Generates a Dart code line for binding registration.
|
/// -------------------------------------------------------------------------
|
||||||
|
/// generateBind
|
||||||
///
|
///
|
||||||
/// Example (single-line):
|
/// ENGLISH
|
||||||
/// bind<Api>().toProvide(() => provideApi(currentScope.resolve<Client>(named: 'test'))).withName('prod').singleton();
|
/// Generates a line of Dart code registering the binding with the DI framework.
|
||||||
|
/// Produces something like:
|
||||||
|
/// bind<Type>().toProvide(() => method(args)).withName('name').singleton();
|
||||||
|
/// Indent parameter allows formatted multiline output.
|
||||||
///
|
///
|
||||||
/// The [indent] argument sets the space indentation for pretty-printing.
|
/// RUSSIAN
|
||||||
|
/// Формирует dart-код для биндинга, например:
|
||||||
|
/// bind<Type>().toProvide(() => method(args)).withName('name').singleton();
|
||||||
|
/// Параметр [indent] задаёт отступ для красивого форматирования кода.
|
||||||
|
/// -------------------------------------------------------------------------
|
||||||
String generateBind(int indent) {
|
String generateBind(int indent) {
|
||||||
final indentStr = ' ' * indent;
|
final indentStr = ' ' * indent;
|
||||||
final provide = _generateProvideClause(indent);
|
final provide = _generateProvideClause(indent);
|
||||||
@@ -145,7 +151,7 @@ class BindSpec {
|
|||||||
return _generatePlainProvideClause(indent);
|
return _generatePlainProvideClause(indent);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Generates code when using runtime parameters (@params).
|
/// EN / RU: Supports runtime parameters (@params).
|
||||||
String _generateWithParamsProvideClause(int indent) {
|
String _generateWithParamsProvideClause(int indent) {
|
||||||
// Safe variable name for parameters.
|
// Safe variable name for parameters.
|
||||||
const paramVar = 'args';
|
const paramVar = 'args';
|
||||||
@@ -172,7 +178,7 @@ class BindSpec {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Generates code when only resolved (not runtime) arguments used.
|
/// 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(', ');
|
||||||
|
|
||||||
@@ -235,17 +241,16 @@ class BindSpec {
|
|||||||
/// -------------------------------------------------------------------------
|
/// -------------------------------------------------------------------------
|
||||||
/// fromMethod
|
/// fromMethod
|
||||||
///
|
///
|
||||||
/// Constructs a [BindSpec] from an analyzer [MethodElement].
|
/// ENGLISH
|
||||||
|
/// Creates a BindSpec from a module class method by analyzing its return type,
|
||||||
|
/// annotations, list of parameters (with their own annotations), and async-ness.
|
||||||
|
/// Throws if a method does not have the required @instance() or @provide().
|
||||||
///
|
///
|
||||||
/// Validates and parses all type annotations, method/parameter DI hints,
|
/// RUSSIAN
|
||||||
/// and derives async and parametric flags as needed.
|
/// Создаёт спецификацию биндинга (BindSpec) из метода класса-модуля, анализируя
|
||||||
///
|
/// возвращаемый тип, аннотации, параметры (и их аннотации), а также факт
|
||||||
/// ## Example
|
/// асинхронности. Если нет @instance или @provide — кидает ошибку.
|
||||||
/// ```dart
|
/// -------------------------------------------------------------------------
|
||||||
/// final bindSpec = BindSpec.fromMethod(methodElement);
|
|
||||||
/// print(bindSpec.returnType); // e.g., 'Logger'
|
|
||||||
/// ```
|
|
||||||
/// Throws [AnnotationValidationException] or [CodeGenerationException] if invalid.
|
|
||||||
static BindSpec fromMethod(MethodElement method) {
|
static BindSpec fromMethod(MethodElement method) {
|
||||||
try {
|
try {
|
||||||
// Validate method annotations
|
// Validate method annotations
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -14,36 +14,10 @@
|
|||||||
import 'package:analyzer/dart/element/element.dart';
|
import 'package:analyzer/dart/element/element.dart';
|
||||||
import 'package:source_gen/source_gen.dart';
|
import 'package:source_gen/source_gen.dart';
|
||||||
|
|
||||||
/// ---------------------------------------------------------------------------
|
/// Enhanced exception class for CherryPick generator with detailed context information
|
||||||
/// CherryPickGeneratorException
|
|
||||||
///
|
|
||||||
/// The base exception for all CherryPick code generation and annotation
|
|
||||||
/// validation errors. This exception provides enhanced diagnostics including
|
|
||||||
/// the error category, helpful suggestions, and additional debugging context.
|
|
||||||
///
|
|
||||||
/// All errors are structured to be as helpful as possible for users
|
|
||||||
/// running build_runner and for CherryPick contributors debugging generators.
|
|
||||||
///
|
|
||||||
/// ## Example usage:
|
|
||||||
/// ```dart
|
|
||||||
/// if (someErrorCondition) {
|
|
||||||
/// throw AnnotationValidationException(
|
|
||||||
/// 'Custom message about what went wrong',
|
|
||||||
/// element: methodElement,
|
|
||||||
/// suggestion: 'Add @provide() or @instance() annotation',
|
|
||||||
/// context: {'found_annotations': annotations},
|
|
||||||
/// );
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
/// ---------------------------------------------------------------------------
|
|
||||||
class CherryPickGeneratorException extends InvalidGenerationSourceError {
|
class CherryPickGeneratorException extends InvalidGenerationSourceError {
|
||||||
/// A string describing the error category (for grouping).
|
|
||||||
final String category;
|
final String category;
|
||||||
|
|
||||||
/// An optional suggestion string for resolving the error.
|
|
||||||
final String? suggestion;
|
final String? suggestion;
|
||||||
|
|
||||||
/// Arbitrary key-value map for additional debugging information.
|
|
||||||
final Map<String, dynamic>? context;
|
final Map<String, dynamic>? context;
|
||||||
|
|
||||||
CherryPickGeneratorException(
|
CherryPickGeneratorException(
|
||||||
@@ -76,7 +50,7 @@ class CherryPickGeneratorException extends InvalidGenerationSourceError {
|
|||||||
buffer.writeln(' Type: ${element.runtimeType}');
|
buffer.writeln(' Type: ${element.runtimeType}');
|
||||||
buffer.writeln(' Location: ${element.source?.fullName ?? 'unknown'}');
|
buffer.writeln(' Location: ${element.source?.fullName ?? 'unknown'}');
|
||||||
|
|
||||||
// Try to show enclosing element info for extra context
|
// Note: enclosingElement may not be available in all analyzer versions
|
||||||
try {
|
try {
|
||||||
final enclosing = (element as dynamic).enclosingElement;
|
final enclosing = (element as dynamic).enclosingElement;
|
||||||
if (enclosing != null) {
|
if (enclosing != null) {
|
||||||
@@ -86,7 +60,7 @@ class CherryPickGeneratorException extends InvalidGenerationSourceError {
|
|||||||
// Ignore if enclosingElement is not available
|
// Ignore if enclosingElement is not available
|
||||||
}
|
}
|
||||||
|
|
||||||
// Arbitrary user context
|
// Additional context
|
||||||
if (context != null && context.isNotEmpty) {
|
if (context != null && context.isNotEmpty) {
|
||||||
buffer.writeln('');
|
buffer.writeln('');
|
||||||
buffer.writeln('Additional Context:');
|
buffer.writeln('Additional Context:');
|
||||||
@@ -95,7 +69,7 @@ class CherryPickGeneratorException extends InvalidGenerationSourceError {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
// Hint/suggestion if present
|
// Suggestion
|
||||||
if (suggestion != null) {
|
if (suggestion != null) {
|
||||||
buffer.writeln('');
|
buffer.writeln('');
|
||||||
buffer.writeln('💡 Suggestion: $suggestion');
|
buffer.writeln('💡 Suggestion: $suggestion');
|
||||||
@@ -105,24 +79,7 @@ class CherryPickGeneratorException extends InvalidGenerationSourceError {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// ---------------------------------------------------------------------------
|
/// Specific exception types for different error categories
|
||||||
/// AnnotationValidationException
|
|
||||||
///
|
|
||||||
/// Thrown when annotation usage is invalid (e.g., missing required annotation,
|
|
||||||
/// mutually exclusive annotations, or incorrect @named format).
|
|
||||||
///
|
|
||||||
/// Grouped as category "ANNOTATION_VALIDATION".
|
|
||||||
///
|
|
||||||
/// ## Example:
|
|
||||||
/// ```dart
|
|
||||||
/// throw AnnotationValidationException(
|
|
||||||
/// '@instance and @provide cannot be used together',
|
|
||||||
/// element: method,
|
|
||||||
/// suggestion: 'Use only one of @instance or @provide.',
|
|
||||||
/// context: {'method_name': method.displayName},
|
|
||||||
/// );
|
|
||||||
/// ```
|
|
||||||
/// ---------------------------------------------------------------------------
|
|
||||||
class AnnotationValidationException extends CherryPickGeneratorException {
|
class AnnotationValidationException extends CherryPickGeneratorException {
|
||||||
AnnotationValidationException(
|
AnnotationValidationException(
|
||||||
super.message, {
|
super.message, {
|
||||||
@@ -132,24 +89,6 @@ class AnnotationValidationException extends CherryPickGeneratorException {
|
|||||||
}) : super(category: 'ANNOTATION_VALIDATION');
|
}) : super(category: 'ANNOTATION_VALIDATION');
|
||||||
}
|
}
|
||||||
|
|
||||||
/// ---------------------------------------------------------------------------
|
|
||||||
/// TypeParsingException
|
|
||||||
///
|
|
||||||
/// Thrown when a Dart type cannot be interpreted/parsed for DI,
|
|
||||||
/// or if it's not compatible (void, raw Future, etc).
|
|
||||||
///
|
|
||||||
/// Grouped as category "TYPE_PARSING".
|
|
||||||
///
|
|
||||||
/// ## Example:
|
|
||||||
/// ```dart
|
|
||||||
/// throw TypeParsingException(
|
|
||||||
/// 'Cannot parse injected type',
|
|
||||||
/// element: field,
|
|
||||||
/// suggestion: 'Specify a concrete type. Avoid dynamic and raw Future.',
|
|
||||||
/// context: {'type': field.type.getDisplayString()},
|
|
||||||
/// );
|
|
||||||
/// ```
|
|
||||||
/// ---------------------------------------------------------------------------
|
|
||||||
class TypeParsingException extends CherryPickGeneratorException {
|
class TypeParsingException extends CherryPickGeneratorException {
|
||||||
TypeParsingException(
|
TypeParsingException(
|
||||||
super.message, {
|
super.message, {
|
||||||
@@ -159,23 +98,6 @@ class TypeParsingException extends CherryPickGeneratorException {
|
|||||||
}) : super(category: 'TYPE_PARSING');
|
}) : super(category: 'TYPE_PARSING');
|
||||||
}
|
}
|
||||||
|
|
||||||
/// ---------------------------------------------------------------------------
|
|
||||||
/// CodeGenerationException
|
|
||||||
///
|
|
||||||
/// Thrown on unexpected code generation or formatting failures
|
|
||||||
/// during generator execution.
|
|
||||||
///
|
|
||||||
/// Grouped as category "CODE_GENERATION".
|
|
||||||
///
|
|
||||||
/// ## Example:
|
|
||||||
/// ```dart
|
|
||||||
/// throw CodeGenerationException(
|
|
||||||
/// 'Could not generate module binding',
|
|
||||||
/// element: classElement,
|
|
||||||
/// suggestion: 'Check module class methods and signatures.',
|
|
||||||
/// );
|
|
||||||
/// ```
|
|
||||||
/// ---------------------------------------------------------------------------
|
|
||||||
class CodeGenerationException extends CherryPickGeneratorException {
|
class CodeGenerationException extends CherryPickGeneratorException {
|
||||||
CodeGenerationException(
|
CodeGenerationException(
|
||||||
super.message, {
|
super.message, {
|
||||||
@@ -185,23 +107,6 @@ class CodeGenerationException extends CherryPickGeneratorException {
|
|||||||
}) : super(category: 'CODE_GENERATION');
|
}) : super(category: 'CODE_GENERATION');
|
||||||
}
|
}
|
||||||
|
|
||||||
/// ---------------------------------------------------------------------------
|
|
||||||
/// DependencyResolutionException
|
|
||||||
///
|
|
||||||
/// Thrown if dependency information (for example, types or names)
|
|
||||||
/// cannot be resolved during code generation analysis.
|
|
||||||
///
|
|
||||||
/// Grouped as category "DEPENDENCY_RESOLUTION".
|
|
||||||
///
|
|
||||||
/// ## Example:
|
|
||||||
/// ```dart
|
|
||||||
/// throw DependencyResolutionException(
|
|
||||||
/// 'Dependency type not found in scope',
|
|
||||||
/// element: someElement,
|
|
||||||
/// suggestion: 'Check CherryPick registration for this type.',
|
|
||||||
/// );
|
|
||||||
/// ```
|
|
||||||
/// ---------------------------------------------------------------------------
|
|
||||||
class DependencyResolutionException extends CherryPickGeneratorException {
|
class DependencyResolutionException extends CherryPickGeneratorException {
|
||||||
DependencyResolutionException(
|
DependencyResolutionException(
|
||||||
super.message, {
|
super.message, {
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -12,48 +12,45 @@
|
|||||||
//
|
//
|
||||||
|
|
||||||
import 'package:analyzer/dart/element/element.dart';
|
import 'package:analyzer/dart/element/element.dart';
|
||||||
|
|
||||||
import 'bind_spec.dart';
|
import 'bind_spec.dart';
|
||||||
|
|
||||||
/// ---------------------------------------------------------------------------
|
/// ---------------------------------------------------------------------------
|
||||||
/// GeneratedClass
|
/// GeneratedClass -- represents the result of processing a single module class.
|
||||||
///
|
///
|
||||||
/// Represents a processed DI module class with all its binding methods analyzed.
|
/// ENGLISH
|
||||||
/// Stores:
|
/// Encapsulates all the information produced from analyzing a DI module class:
|
||||||
/// - The original class name,
|
/// - The original class name,
|
||||||
/// - The generated implementation class name (with $ prefix),
|
/// - Its generated class name (e.g., `$SomeModule`),
|
||||||
/// - The list of all BindSpec for the module methods,
|
/// - The collection of bindings (BindSpec) for all implemented provider methods.
|
||||||
/// - The source file name for reference or directive generation.
|
|
||||||
///
|
///
|
||||||
/// Provides static and instance methods to construct from a ClassElement
|
/// Also provides code generation functionality, allowing to generate the source
|
||||||
/// and generate Dart source code for the resulting DI registration class.
|
/// code for the derived DI module class, including all binding registrations.
|
||||||
///
|
///
|
||||||
/// ## Example usage
|
/// RUSSIAN
|
||||||
/// ```dart
|
/// Описывает результат обработки одного класса-модуля DI:
|
||||||
/// final gen = GeneratedClass.fromClassElement(myModuleClassElement);
|
/// - Имя оригинального класса,
|
||||||
/// print(gen.generate());
|
/// - Имя генерируемого класса (например, `$SomeModule`),
|
||||||
/// /*
|
/// - Список всех бидингов (BindSpec) — по публичным методам модуля.
|
||||||
/// Produces:
|
///
|
||||||
/// final class $MyModule extends MyModule {
|
/// Также содержит функцию генерации исходного кода для этого класса и
|
||||||
/// @override
|
/// регистрации всех зависимостей через bind(...).
|
||||||
/// void builder(Scope currentScope) {
|
|
||||||
/// bind<Service>().toProvide(() => provideService(currentScope.resolve<Dep>()));
|
|
||||||
/// ...
|
|
||||||
/// }
|
|
||||||
/// }
|
|
||||||
/// */
|
|
||||||
/// ```
|
|
||||||
/// ---------------------------------------------------------------------------
|
/// ---------------------------------------------------------------------------
|
||||||
class GeneratedClass {
|
class GeneratedClass {
|
||||||
/// Name of the original Dart module class.
|
/// The name of the original module class.
|
||||||
|
/// Имя исходного класса-модуля
|
||||||
final String className;
|
final String className;
|
||||||
|
|
||||||
/// Name of the generated class, e.g. `$MyModule`
|
/// The name of the generated class (e.g., $SomeModule).
|
||||||
|
/// Имя генерируемого класса (например, $SomeModule)
|
||||||
final String generatedClassName;
|
final String generatedClassName;
|
||||||
|
|
||||||
/// Binding specs for all provider/factory methods in the class.
|
/// List of all discovered bindings for the class.
|
||||||
|
/// Список всех обнаруженных биндингов
|
||||||
final List<BindSpec> binds;
|
final List<BindSpec> binds;
|
||||||
|
|
||||||
/// Source filename of the module class (for code references).
|
/// Source file name for the part directive
|
||||||
|
/// Имя исходного файла для part директивы
|
||||||
final String sourceFile;
|
final String sourceFile;
|
||||||
|
|
||||||
GeneratedClass(
|
GeneratedClass(
|
||||||
@@ -66,15 +63,16 @@ class GeneratedClass {
|
|||||||
/// -------------------------------------------------------------------------
|
/// -------------------------------------------------------------------------
|
||||||
/// fromClassElement
|
/// fromClassElement
|
||||||
///
|
///
|
||||||
/// Creates a [GeneratedClass] by analyzing a Dart [ClassElement].
|
/// ENGLISH
|
||||||
/// Collects all public non-abstract methods, creates a [BindSpec] for each,
|
/// Static factory: creates a GeneratedClass from a Dart ClassElement (AST representation).
|
||||||
/// and infers the generated class name using a `$` prefix.
|
/// Discovers all non-abstract methods, builds BindSpec for each, and computes the
|
||||||
|
/// generated class name by prefixing `$`.
|
||||||
///
|
///
|
||||||
/// ## Example usage
|
/// RUSSIAN
|
||||||
/// ```dart
|
/// Строит объект класса по элементу AST (ClassElement): имя класса,
|
||||||
/// final gen = GeneratedClass.fromClassElement(classElement);
|
/// сгенерированное имя, список BindSpec по всем не абстрактным методам.
|
||||||
/// print(gen.generatedClassName); // e.g. $AppModule
|
/// Имя ген-класса строится с префиксом `$`.
|
||||||
/// ```
|
/// -------------------------------------------------------------------------
|
||||||
static GeneratedClass fromClassElement(ClassElement element) {
|
static GeneratedClass fromClassElement(ClassElement element) {
|
||||||
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).
|
||||||
@@ -93,19 +91,16 @@ class GeneratedClass {
|
|||||||
/// -------------------------------------------------------------------------
|
/// -------------------------------------------------------------------------
|
||||||
/// generate
|
/// generate
|
||||||
///
|
///
|
||||||
/// Generates the Dart source code for the DI registration class.
|
/// ENGLISH
|
||||||
/// The generated class extends the original module, and the `builder` method
|
/// Generates Dart source code for the DI module class. The generated class
|
||||||
/// registers all bindings (dependencies) into the DI scope.
|
/// inherits from the original, overrides the 'builder' method, and registers
|
||||||
|
/// all bindings in the DI scope.
|
||||||
///
|
///
|
||||||
/// ## Example output
|
/// RUSSIAN
|
||||||
/// ```dart
|
/// Генерирует исходный Dart-код для класса-модуля DI.
|
||||||
/// final class $UserModule extends UserModule {
|
/// Новая версия класса наследует оригинальный, переопределяет builder(Scope),
|
||||||
/// @override
|
/// и регистрирует все зависимости через методы bind<Type>()...
|
||||||
/// void builder(Scope currentScope) {
|
/// -------------------------------------------------------------------------
|
||||||
/// bind<Service>().toProvide(() => provideService(currentScope.resolve<Dep>()));
|
|
||||||
/// }
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
String generate() {
|
String generate() {
|
||||||
final buffer = StringBuffer()
|
final buffer = StringBuffer()
|
||||||
..writeln('final class $generatedClassName extends $className {')
|
..writeln('final class $generatedClassName extends $className {')
|
||||||
@@ -113,6 +108,7 @@ class GeneratedClass {
|
|||||||
..writeln(' void builder(Scope currentScope) {');
|
..writeln(' void builder(Scope currentScope) {');
|
||||||
|
|
||||||
// For each binding, generate bind<Type>() code string.
|
// For each binding, generate bind<Type>() code string.
|
||||||
|
// Для каждого биндинга — генерируем строку bind<Type>()...
|
||||||
for (final bind in binds) {
|
for (final bind in binds) {
|
||||||
buffer.writeln(bind.generateBind(4));
|
buffer.writeln(bind.generateBind(4));
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -14,32 +14,30 @@
|
|||||||
import 'package:analyzer/dart/element/element.dart';
|
import 'package:analyzer/dart/element/element.dart';
|
||||||
|
|
||||||
/// ---------------------------------------------------------------------------
|
/// ---------------------------------------------------------------------------
|
||||||
/// MetadataUtils
|
/// MetadataUtils -- utilities for analyzing method and parameter annotations.
|
||||||
///
|
///
|
||||||
/// Static utilities for querying and extracting information from
|
/// ENGLISH
|
||||||
/// Dart annotations ([ElementAnnotation]) in the context of code generation,
|
/// Provides static utility methods to analyze Dart annotations on methods or
|
||||||
/// such as checking for the presence of specific DI-related annotations.
|
/// parameters. For instance, helps to find if an element is annotated with
|
||||||
/// Designed to be used internally by code generation and validation routines.
|
/// `@named()`, `@singleton()`, or other meta-annotations used in this DI framework.
|
||||||
///
|
///
|
||||||
/// # Example usage
|
/// RUSSIAN
|
||||||
/// ```dart
|
/// Утилиты для разбора аннотаций методов и параметров.
|
||||||
/// if (MetadataUtils.anyMeta(method.metadata, 'singleton')) {
|
/// Позволяют находить наличие аннотаций, например, @named() и @singleton(),
|
||||||
/// // The method is annotated with @singleton
|
/// у методов и параметров. Используется для анализа исходного кода при генерации.
|
||||||
/// }
|
|
||||||
/// final name = MetadataUtils.getNamedValue(field.metadata);
|
|
||||||
/// if (name != null) print('@named value: $name');
|
|
||||||
/// ```
|
|
||||||
/// ---------------------------------------------------------------------------
|
/// ---------------------------------------------------------------------------
|
||||||
class MetadataUtils {
|
class MetadataUtils {
|
||||||
/// Checks whether any annotation in [meta] matches the [typeName]
|
/// -------------------------------------------------------------------------
|
||||||
/// (type name is compared in a case-insensitive manner and can be partial).
|
/// anyMeta
|
||||||
///
|
///
|
||||||
/// Returns true if an annotation (such as @singleton, @provide, @named) is found.
|
/// ENGLISH
|
||||||
|
/// Checks if any annotation in the list has a type name that contains
|
||||||
|
/// [typeName] (case insensitive).
|
||||||
///
|
///
|
||||||
/// Example:
|
/// RUSSIAN
|
||||||
/// ```dart
|
/// Проверяет: есть ли среди аннотаций метка, имя которой содержит [typeName]
|
||||||
/// bool isSingleton = MetadataUtils.anyMeta(myMethod.metadata, 'singleton');
|
/// (регистр не учитывается).
|
||||||
/// ```
|
/// -------------------------------------------------------------------------
|
||||||
static bool anyMeta(List<ElementAnnotation> meta, String typeName) {
|
static bool anyMeta(List<ElementAnnotation> meta, String typeName) {
|
||||||
return meta.any((m) =>
|
return meta.any((m) =>
|
||||||
m
|
m
|
||||||
@@ -51,15 +49,17 @@ class MetadataUtils {
|
|||||||
false);
|
false);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Extracts the string value from a `@named('value')` annotation if present in [meta].
|
/// -------------------------------------------------------------------------
|
||||||
|
/// getNamedValue
|
||||||
///
|
///
|
||||||
/// Returns the named value or `null` if not annotated.
|
/// ENGLISH
|
||||||
|
/// Retrieves the value from a `@named('value')` annotation if present.
|
||||||
|
/// Returns the string value or null if not found.
|
||||||
///
|
///
|
||||||
/// Example:
|
/// RUSSIAN
|
||||||
/// ```dart
|
/// Находит значение из аннотации @named('значение').
|
||||||
/// // For: @named('dev') ApiClient provideApi() ...
|
/// Возвращает строку значения, если аннотация присутствует; иначе null.
|
||||||
/// final named = MetadataUtils.getNamedValue(method.metadata); // 'dev'
|
/// -------------------------------------------------------------------------
|
||||||
/// ```
|
|
||||||
static String? getNamedValue(List<ElementAnnotation> meta) {
|
static String? getNamedValue(List<ElementAnnotation> meta) {
|
||||||
for (final m in meta) {
|
for (final m in meta) {
|
||||||
final cv = m.computeConstantValue();
|
final cv = m.computeConstantValue();
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -16,35 +16,9 @@ import 'package:analyzer/dart/element/nullability_suffix.dart';
|
|||||||
import 'package:analyzer/dart/element/type.dart';
|
import 'package:analyzer/dart/element/type.dart';
|
||||||
import 'exceptions.dart';
|
import 'exceptions.dart';
|
||||||
|
|
||||||
/// Utility for analyzing and parsing Dart types for CherryPick DI code generation.
|
/// Enhanced type parser that uses AST analysis instead of regular expressions
|
||||||
///
|
|
||||||
/// This type parser leverages the Dart analyzer AST to extract nuanced information
|
|
||||||
/// from Dart types encountered in the source code, in particular for dependency
|
|
||||||
/// injection purposes. It is capable of extracting nullability, generics,
|
|
||||||
/// and Future-related metadata with strong guarantees and handles even nested generics.
|
|
||||||
///
|
|
||||||
/// # Example usage for parsing types:
|
|
||||||
/// ```dart
|
|
||||||
/// final parsed = TypeParser.parseType(method.returnType, method);
|
|
||||||
/// print(parsed);
|
|
||||||
/// print(parsed.resolveMethodName); // e.g. "resolveAsync" or "tryResolve"
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// # Supported scenarios:
|
|
||||||
/// - Nullable types (e.g., `List<String>?`)
|
|
||||||
/// - Generic types (e.g., `Map<String, User>`)
|
|
||||||
/// - Async types (`Future<T>`, including nested generics)
|
|
||||||
/// - Validation for DI compatibility (throws for `void`, warns on `dynamic`)
|
|
||||||
class TypeParser {
|
class TypeParser {
|
||||||
/// Parses a [DartType] and extracts detailed type information for use in code generation.
|
/// Parses a DartType and extracts detailed type information
|
||||||
///
|
|
||||||
/// If a type is not suitable or cannot be parsed, a [TypeParsingException] is thrown.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// final parsed = TypeParser.parseType(field.type, field);
|
|
||||||
/// if (parsed.isNullable) print('Field is nullable');
|
|
||||||
/// ```
|
|
||||||
static ParsedType parseType(DartType dartType, Element context) {
|
static ParsedType parseType(DartType dartType, Element context) {
|
||||||
try {
|
try {
|
||||||
return _parseTypeInternal(dartType, context);
|
return _parseTypeInternal(dartType, context);
|
||||||
@@ -75,7 +49,7 @@ class TypeParser {
|
|||||||
return _parseGenericType(dartType, context, isNullable);
|
return _parseGenericType(dartType, context, isNullable);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Simple type (non-generic, non-Future)
|
// Simple type
|
||||||
return ParsedType(
|
return ParsedType(
|
||||||
displayString: displayString,
|
displayString: displayString,
|
||||||
coreType: displayString.replaceAll('?', ''),
|
coreType: displayString.replaceAll('?', ''),
|
||||||
@@ -129,15 +103,7 @@ class TypeParser {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Validates that a parsed type is suitable for dependency injection.
|
/// Validates that a type is suitable for dependency injection
|
||||||
///
|
|
||||||
/// Throws [TypeParsingException] for void and may warn for dynamic.
|
|
||||||
///
|
|
||||||
/// Example:
|
|
||||||
/// ```dart
|
|
||||||
/// final parsed = TypeParser.parseType(field.type, field);
|
|
||||||
/// TypeParser.validateInjectableType(parsed, field);
|
|
||||||
/// ```
|
|
||||||
static void validateInjectableType(ParsedType parsedType, Element context) {
|
static void validateInjectableType(ParsedType parsedType, Element context) {
|
||||||
// Check for void type
|
// Check for void type
|
||||||
if (parsedType.coreType == 'void') {
|
if (parsedType.coreType == 'void') {
|
||||||
@@ -165,7 +131,7 @@ class TypeParser {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Represents a parsed type with full metadata for code generation.
|
/// Represents a parsed type with detailed information
|
||||||
class ParsedType {
|
class ParsedType {
|
||||||
/// The full display string of the type (e.g., "Future<List<String>?>")
|
/// The full display string of the type (e.g., "Future<List<String>?>")
|
||||||
final String displayString;
|
final String displayString;
|
||||||
@@ -173,19 +139,19 @@ class ParsedType {
|
|||||||
/// The core type name without nullability and Future wrapper (e.g., "List<String>")
|
/// The core type name without nullability and Future wrapper (e.g., "List<String>")
|
||||||
final String coreType;
|
final String coreType;
|
||||||
|
|
||||||
/// True if nullable (has `?`)
|
/// Whether the type is nullable
|
||||||
final bool isNullable;
|
final bool isNullable;
|
||||||
|
|
||||||
/// True if this type is a `Future<T>`
|
/// Whether the type is wrapped in Future
|
||||||
final bool isFuture;
|
final bool isFuture;
|
||||||
|
|
||||||
/// True if the type is a generic type (`List<T>`)
|
/// Whether the type has generic parameters
|
||||||
final bool isGeneric;
|
final bool isGeneric;
|
||||||
|
|
||||||
/// List of parsed type arguments in generics, if any.
|
/// Parsed type arguments for generic types
|
||||||
final List<ParsedType> typeArguments;
|
final List<ParsedType> typeArguments;
|
||||||
|
|
||||||
/// For `Future<T>`, this is the type inside the `Future`.
|
/// For Future types, the inner type
|
||||||
final ParsedType? innerType;
|
final ParsedType? innerType;
|
||||||
|
|
||||||
const ParsedType({
|
const ParsedType({
|
||||||
@@ -198,11 +164,7 @@ class ParsedType {
|
|||||||
this.innerType,
|
this.innerType,
|
||||||
});
|
});
|
||||||
|
|
||||||
/// Generates the type string suitable for code generation.
|
/// Returns the type string suitable for code generation
|
||||||
///
|
|
||||||
/// - For futures, the codegen type of the inner type is returned
|
|
||||||
/// - For generics, returns e.g. `List<User>`
|
|
||||||
/// - For plain types, just the name
|
|
||||||
String get codeGenType {
|
String get codeGenType {
|
||||||
if (isFuture && innerType != null) {
|
if (isFuture && innerType != null) {
|
||||||
return innerType!.codeGenType;
|
return innerType!.codeGenType;
|
||||||
@@ -217,10 +179,10 @@ class ParsedType {
|
|||||||
return coreType;
|
return coreType;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// True if this type should use `tryResolve` instead of `resolve` for DI.
|
/// Returns whether this type should use tryResolve instead of resolve
|
||||||
bool get shouldUseTryResolve => isNullable;
|
bool get shouldUseTryResolve => isNullable;
|
||||||
|
|
||||||
/// Returns the method name for DI, e.g. "resolve", "tryResolveAsync", etc.
|
/// Returns the appropriate resolve method name
|
||||||
String get resolveMethodName {
|
String get resolveMethodName {
|
||||||
if (isFuture) {
|
if (isFuture) {
|
||||||
return shouldUseTryResolve ? 'tryResolveAsync' : 'resolveAsync';
|
return shouldUseTryResolve ? 'tryResolveAsync' : 'resolveAsync';
|
||||||
|
|||||||
@@ -2,24 +2,17 @@ name: cherrypick_generator
|
|||||||
description: |
|
description: |
|
||||||
Source code generator for the cherrypick dependency injection system. Processes annotations to generate binding and module code for Dart & Flutter projects.
|
Source code generator for the cherrypick dependency injection system. Processes annotations to generate binding and module code for Dart & Flutter projects.
|
||||||
|
|
||||||
version: 3.0.0
|
version: 1.1.0
|
||||||
homepage: https://cherrypick-di.netlify.app
|
documentation: https://github.com/pese-git/cherrypick/wiki
|
||||||
documentation: https://cherrypick-di.netlify.app/docs/intro
|
|
||||||
repository: https://github.com/pese-git/cherrypick/cherrypick_generator
|
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
|
|
||||||
- dependency-injection
|
|
||||||
- dependency-management
|
|
||||||
- inversion-of-control
|
|
||||||
|
|
||||||
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: ^3.0.0
|
cherrypick_annotations: ^1.1.0
|
||||||
analyzer: ^7.0.0
|
analyzer: ^7.0.0
|
||||||
dart_style: ^3.0.0
|
dart_style: ^3.0.0
|
||||||
build: ^2.4.1
|
build: ^2.4.1
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
@@ -244,7 +244,8 @@ void main() {
|
|||||||
final result = bindSpec.generateBind(4);
|
final result = bindSpec.generateBind(4);
|
||||||
expect(
|
expect(
|
||||||
result,
|
result,
|
||||||
equals(" bind<ApiClient>()\n"
|
equals(
|
||||||
|
" bind<ApiClient>()\n"
|
||||||
" .toProvideAsync(() => createApiClient())\n"
|
" .toProvideAsync(() => createApiClient())\n"
|
||||||
" .withName('mainApi')\n"
|
" .withName('mainApi')\n"
|
||||||
" .singleton();"));
|
" .singleton();"));
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
// You may obtain a copy of the License at
|
// You may obtain a copy of the License at
|
||||||
// https://www.apache.org/licenses/LICENSE-2.0
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
// Unless required by applicable law or agreed to in writing, software
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user