Compare commits

...

124 Commits

Author SHA1 Message Date
Sergey Penkovsky
298cb65ac8 chore(release): publish packages
- talker_cherrypick_logger@1.1.0-dev.4
2025-08-13 15:58:08 +03:00
Sergey Penkovsky
1b9db31c13 docs(readme): update install instructions to use pub.dev as default method and remove obsolete git example
The main installation guide now recommends pub.dev with ^latest tags. Removed the outdated GitHub install block for clarity and simplicity. No functional code changes.
2025-08-13 15:57:28 +03:00
Sergey Penkovsky
ca3cd2c8fd Merge pull request #20 from pese-git/code-format
style: reformat codebase using melos format
2025-08-13 15:46:05 +03:00
Sergey Penkovsky
c91e15319b style: reformat codebase using melos format
Applied consistent code formatting across all packages using \$ melos format
  └> dart format .
     └> RUNNING (in 8 packages)

--------------------------------------------------------------------------------
benchmark_di:
Formatted 18 files (0 changed) in 0.30 seconds.
benchmark_di: SUCCESS
--------------------------------------------------------------------------------
cherrypick:
Formatted 24 files (0 changed) in 0.34 seconds.
cherrypick: SUCCESS
--------------------------------------------------------------------------------
cherrypick_annotations:
Formatted 11 files (0 changed) in 0.14 seconds.
cherrypick_annotations: SUCCESS
--------------------------------------------------------------------------------
cherrypick_flutter:
Formatted 3 files (0 changed) in 0.15 seconds.
cherrypick_flutter: SUCCESS
--------------------------------------------------------------------------------
cherrypick_generator:
Formatted 17 files (0 changed) in 0.27 seconds.
cherrypick_generator: SUCCESS
--------------------------------------------------------------------------------
client_app:
Formatted 4 files (0 changed) in 0.14 seconds.
client_app: SUCCESS
--------------------------------------------------------------------------------
postly:
Formatted lib/router/app_router.gr.dart
Formatted 23 files (1 changed) in 0.33 seconds.
postly: SUCCESS
--------------------------------------------------------------------------------
talker_cherrypick_logger:
Formatted 4 files (0 changed) in 0.18 seconds.
talker_cherrypick_logger: SUCCESS
--------------------------------------------------------------------------------

$ melos format
  └> dart format .
     └> SUCCESS. No functional or logic changes included.
2025-08-13 15:38:44 +03:00
Sergey Penkovsky
99e662124f chore(release): publish packages
- talker_cherrypick_logger@1.1.0-dev.3
2025-08-13 15:27:51 +03:00
Sergey Penkovsky
03f54981f3 chore(talker_cherrypick_logger): update package description in pubspec.yaml 2025-08-13 15:26:53 +03:00
Sergey Penkovsky
349efe6ba6 chore(release): publish packages
- talker_cherrypick_logger@1.1.0-dev.2
2025-08-13 15:23:21 +03:00
Sergey Penkovsky
c2f0e027b6 fix(gitignore) - update gitignore 2025-08-13 15:18:39 +03:00
Sergey Penkovsky
f85036d20f chore(release): publish packages
- cherrypick@3.0.0-dev.9
 - cherrypick_annotations@1.1.2-dev.0
 - cherrypick_flutter@1.1.3-dev.9
 - cherrypick_generator@2.0.0-dev.0
 - talker_cherrypick_logger@1.1.0-dev.0
2025-08-13 15:11:23 +03:00
Sergey Penkovsky
db4d128d04 docs(readme): add talker_cherrypick_logger to Additional Modules section
Added information about the talker_cherrypick_logger official module in the Additional Modules table in README. This module provides seamless DI event logging integration with the Talker logging framework.
2025-08-13 15:07:12 +03:00
Sergey Penkovsky
2c4e2ed251 chore(pubspec): update metadata with homepage, docs, repository and topics
Added homepage URL, documentation, repository, issue tracker, and topics to pubspec.yaml for better package metadata. Removed 'publish_to: none' and outdated repository comment.
2025-08-13 14:56:10 +03:00
Sergey Penkovsky
7b4642f407 doc(readme): update readme 2025-08-13 09:11:06 +03:00
Sergey Penkovsky
7d45d00d6a docs(generator): improve and unify English documentation and examples for all DI source files
- Added comprehensive English documentation for all DI generator and support files:
  * inject_generator.dart — full class/method doc-comments, usage samples
  * module_generator.dart — doc-comments, feature explanation, complete example
  * src/annotation_validator.dart — class and detailed static method descriptions
  * src/type_parser.dart — doc, example for ParsedType and TypeParser, specific codegen notes
  * src/bind_spec.dart — interface, static factory, and codegen docs with DI scenarios
  * src/bind_parameters_spec.dart — details and samples for code generation logic
  * src/metadata_utils.dart — full doc and examples for annotation utilities
  * src/exceptions.dart — user- and contributor-friendly errors, structured output, category explanations
  * src/generated_class.dart — usage-centric doc-comments, example of resulting generated DI class
- Removed Russian/duplicate comments for full clarity and maintainability
- Ensured that new and existing contributors can easily extend and maintain DI code generation logic

BREAKING CHANGE: All documentation now English-only; comments include usage examples for each principal structure or routine

See #docs, #generator, #cherrypick
2025-08-13 08:57:06 +03:00
Sergey Penkovsky
884df50a34 docs(annotations): unify and improve English DartDoc for all DI annotations
- Updated all annotation files with complete English DartDoc, field/class/method usage, practical code samples
- Unified documentation style for @inject, @injectable, @instance, @singleton, @named, @scope, @params, @provide, @module
- Removed Russian comments for clarity and consistency
- Improved discoverability and IDE/autocomplete experience for CherryPick DI users
- No functional or API changes; documentation/dev experience only
2025-08-12 16:18:53 +03:00
Sergey Penkovsky
5710af2f9b docs(provider): add detailed English API documentation for CherryPickProvider Flutter integration
- Replaced all comments with complete DartDoc in English for CherryPickProvider
- Documented all methods (constructor, of, openRootScope, openSubScope, updateShouldNotify)
- Added code samples for typical Flutter+CherryPick integration, root and subscope usage
- Makes Flutter DI integration intuitive for new users and improves IDE support
- No logic or API changes, documentation only
2025-08-12 15:46:14 +03:00
Sergey Penkovsky
9312ef46ea docs(api): improve all DI core code documentation with English dartdoc and examples
- Full English API/class/method documentation for core CherryPick classes:
  * Binding<T>
  * BindingResolver<T>
  * CycleDetector and CycleDetectionMixin
  * GlobalCycleDetector and GlobalCycleDetectionMixin
  * Factory<T>
  * Module
  * Scope
- Each public and private method is now documented in clear DartDoc style with usages
- Added code samples for modules, scope, subscopes, DI resolve/async, cycle detection
- Russian comments completely replaced with English for consistency
- NO logic or API changes, documentation and devex improvement only

Also updated: pubspec.lock for workspace/example folders (auto by dependency changes)
2025-08-12 15:38:15 +03:00
Sergey Penkovsky
900cd68663 chore(release): publish packages
- cherrypick@3.0.0-dev.8
 - cherrypick_flutter@1.1.3-dev.8
2025-08-12 11:33:42 +03:00
Sergey Penkovsky
57e4196b95 Merge pull request #19 from pese-git/talker
Talker
2025-08-12 11:31:20 +03:00
Sergey Penkovsky
358da8f96b docs(logging): update Logging section in README with modern Observer usage and Talker integration examples 2025-08-12 00:32:39 +03:00
Sergey Penkovsky
ea2b6687f4 docs: add full English documentation and usage guide to README.md 2025-08-12 00:29:57 +03:00
Sergey Penkovsky
df00a2a5d2 doc(license): add licnese 2025-08-12 00:29:57 +03:00
Sergey Penkovsky
d5983a4a0b docs: add detailed English documentation and usage examples for TalkerCherryPickObserver 2025-08-12 00:29:57 +03:00
Sergey Penkovsky
125bccfa5a docs(observer): improve documentation, translate all comments to English, add usage examples 2025-08-12 00:29:57 +03:00
Sergey Penkovsky
12b97c9368 chore: update configs and lockfiles 2025-08-12 00:29:57 +03:00
Sergey Penkovsky
424aaa3e22 refactor(tests): replace MockLogger with MockObserver in scope tests to align with updated observer API 2025-08-12 00:29:57 +03:00
Sergey Penkovsky
2ec3a86a2f feat(core): add full DI lifecycle observability via onInstanceDisposed
- Call observer.onInstanceDisposed for every removed/cleaned-up instance in Scope lifecycle
- Makes instance disposal fully observable outside of cache events
- Ensures analytics/logging frameworks get notified of each object removal from memory

Part of complete CherryPickObserver integration for transparent diagnostics and monitoring of DI container.
2025-08-12 00:29:57 +03:00
Sergey Penkovsky
efed72cc39 refactor(core,logger)migrate to CherryPickObserver API and drop CherryPickLogger
BREAKING CHANGE:
- Removed the deprecated CherryPickLogger interface from cherrypick
- Logger/adapters (e.g., talker_cherrypick_logger) must now implement CherryPickObserver
- talker_cherrypick_logger: replace TalkerCherryPickLogger with TalkerCherryPickObserver
- All usages, docs, tests migrated to observer API
- Improved test mocks and integration tests for observer pattern
- Removed obsolete files: cherrypick/src/logger.dart, talker_cherrypick_logger/src/talker_cherrypick_logger.dart
- Updated README and example usages for new CherryPickObserver model

This refactor introduces a unified observer pattern (CherryPickObserver) to handle all DI lifecycle events, replacing the limited info/warn/error logger pattern.
All external logging adapters and integrations must migrate to use CherryPickObserver.
2025-08-12 00:29:41 +03:00
Sergey Penkovsky
4dc9e269cd 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 2025-08-12 00:25:28 +03:00
Sergey Penkovsky
d153ab4255 start implement talker logger for cherrypick 2025-08-12 00:25:28 +03:00
Sergey Penkovsky
6924ccd07b docs(README): add section with overview table for additional modules
- Introduce an 'Additional Modules' section before 'Contributing'
- Document cherrypick_annotations, cherrypick_generator, and cherrypick_flutter with pub.dev and README links
2025-08-11 23:14:23 +03:00
Sergey Penkovsky
26b843f791 docs(README): refactor structure and improve clarity of advanced features
- Move and consolidate 'Advanced Features' sections, including Logging, Circular Dependency Detection, Hierarchical Subscopes, and Performance Improvements
- Reword and reorganize 'Disposable' and 'Dependency Resolution API' sections
- Clean up list styling and table of contents for accuracy
- Add clarity to documentation links and info blocks
2025-08-11 22:55:31 +03:00
Sergey Penkovsky
8eafba4e4b docs(README): add 'Hierarchical Subscopes' section and update structure for advanced features clarity 2025-08-11 22:28:46 +03:00
Sergey Penkovsky
ad6e9bbc3d doc(readme): update title 2025-08-11 22:15:27 +03:00
Sergey Penkovsky
bea8affcab doc(readme): performance information moved to top of document 2025-08-11 22:06:38 +03:00
Sergey Penkovsky
1d7b9a9166 doc(readme): remove duplicate text 2025-08-11 22:01:09 +03:00
Sergey Penkovsky
016c212063 fix(doc): remove hide symbol 2025-08-11 21:54:24 +03:00
Sergey Penkovsky
d93d4173a2 chore(release): publish packages
- cherrypick@3.0.0-dev.7
 - cherrypick_annotations@1.1.1
 - cherrypick_flutter@1.1.3-dev.7
 - cherrypick_generator@1.1.1
2025-08-11 12:38:17 +03:00
Sergey Penkovsky
85aa23d7ed Update README.md 2025-08-11 12:35:02 +03:00
Sergey Penkovsky
51cf4a0dc0 docs(readme): add comprehensive section on annotations and DI code generation
- Added 'Using Annotations & Code Generation' section explaining DI annotations flow.
- Included full table of supported annotations, practical usage examples, setup steps, troubleshooting, and references.
- Improves onboarding for CherryPick users using @injectable, @module, @provide, @named, @scope, @params and related features.

See doc/annotations_en.md and generator/module READMEs for extended docs.
2025-08-11 12:24:44 +03:00
Sergey Penkovsky
8f980ff111 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. 2025-08-11 12:02:32 +03:00
Sergey Penkovsky
4d872d7c25 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. 2025-08-11 11:53:25 +03:00
Sergey Penkovsky
450f4231cb Merge pull request #14 from pese-git/dispose
Dispose
2025-08-11 11:40:57 +03:00
Sergey Penkovsky
cd1b9cf49d fix(comment): fix warnings 2025-08-08 23:42:35 +03:00
Sergey Penkovsky
33775f5748 fix(license): correct urls 2025-08-08 23:24:05 +03:00
Sergey Penkovsky
e5848784ac refactor(core): make closeRootScope async and await dispose
BREAKING CHANGE: closeRootScope is now async (returns Future<void> and must be awaited). This change improves resource lifecycle management by allowing asynchronous cleanup when disposing the root Scope. All usages of closeRootScope should be updated to use await.

- Change closeRootScope from void to Future<void> and add async keyword
- Await _rootScopefor correct async disposal
- Ensures proper disposal and better future extensibility for async resources

Closes #xxx (replace if issue exists)
2025-08-08 16:56:37 +03:00
Sergey Penkovsky
40b3cbb422 chore(release): publish packages
- cherrypick@3.0.0-dev.6
 - cherrypick_flutter@1.1.3-dev.6
2025-08-08 16:23:13 +03:00
Sergey Penkovsky
a4b0ddfa54 docs(faq): add best practice FAQ about using await with scope disposal
- Added FAQ section in documentation (README and tutorials, EN + RU) recommending always using await when calling CherryPick.closeRootScope, scope.closeScope, or scope.dispose, even if no services implement Disposable.
- Clarifies future-proof resource management for all users.
2025-08-08 16:08:33 +03:00
Sergey Penkovsky
547a15fa4e docs(faq): add best practice FAQ about using await with scope disposal
- Added FAQ section in documentation (README and tutorials, EN + RU) recommending always using await when calling CherryPick.closeRootScope, scope.closeScope, or scope.dispose, even if no services implement Disposable.
- Clarifies future-proof resource management for all users.
2025-08-08 16:08:33 +03:00
Sergey Penkovsky
a9c95f6a89 docs+feat: add Disposable interface source and usage example
feat(core,doc): unified async dispose mechanism for resource cleanup

BREAKING CHANGE:

- Added full support for asynchronous resource cleanup via a unified FutureOr<void> dispose() method in the Disposable interface.
- The Scope now provides only Future<void> dispose() for disposing all tracked resources and child scopes (sync-only dispose() was removed).
- All calls to cleanup in code and tests (scope itself, subscopes, and custom modules) now require await ...dispose().
- Documentation and all examples updated: resource management is always async and must be awaited; Disposable implementers may use both sync and async cleanup.
- Old-style, synchronous cleanup methods have been completely removed (API is now consistently async for all DI lifecycle management).
- Example and tutorial code now demonstrate async resource disposal patterns.
2025-08-08 16:08:29 +03:00
Sergey Penkovsky
61f2268d63 fix(riverpod-adapter): update implementation in riverpod_adapter.dart 2025-08-08 15:08:27 +03:00
Sergey Penkovsky
f6fcb76730 docs(benchmark): update DI benchmark reports with new scenario tables and updated explanations 2025-08-08 15:02:45 +03:00
Sergey Penkovsky
f8bbaf6c2c Merge pull request #18 from pese-git/logger
Logger
2025-08-08 14:27:53 +03:00
Sergey Penkovsky
2ebc997fea docs(readme): add comprehensive DI state and action logging to features 2025-08-08 13:40:39 +03:00
Sergey Penkovsky
d15f3063fc hotfix 2025-08-08 12:49:12 +03:00
Sergey Penkovsky
1e8b8db64a docs(helper): add complete DartDoc with real usage examples for CherryPick class 2025-08-08 12:43:09 +03:00
Sergey Penkovsky
c3ec52823e fix: improve global cycle detector logic 2025-08-08 12:24:07 +03:00
Sergey Penkovsky
16e05d27c5 docs(log_format): add detailed English documentation for formatLogMessage function 2025-08-08 11:28:12 +03:00
Sergey Penkovsky
1131be44da feat(core): refactor root scope API, improve logger injection, helpers, and tests
- BREAKING CHANGE: introduce CherryPick.openRootScope
- add logger injection to Scope
- refactor helper and scope logic
- improve internal logging
- enhance and update tests
- add log_format.dart module
2025-08-08 11:24:03 +03:00
Sergey Penkovsky
c971b59483 feat(postly): add explicit PrintLogger setup in main.dart for debug builds 2025-08-08 08:24:19 +03:00
Sergey Penkovsky
aa97632add feat(logger): add extensible logging API, usage examples, and bilingual documentation
- Introduce CherryPickLogger interface, PrintLogger and SilentLogger implementations
- Add setGlobalLogger() to CherryPick API for custom DI logging
- Log key events (scope, module, error) via logger throughout DI lifecycle
- Comprehensive comments and code documentation in both English and Russian
- Document usage of logging system in quick_start and full_tutorial documentation (EN/RU)
- Provide usage examples in docs and code comments
- No logging inside GlobalCycleDetectionMixin (design choice: exceptions handled at Scope, not detector/mixin level) and detailed architectural reasoning
- Update helper.dart, logger.dart: comments, examples, API doc improvements
BREAKING CHANGE: Projects can now inject any logger via CherryPick.setGlobalLogger; default log behavior clarified and docstrings/usage examples enhanced
2025-08-08 08:24:13 +03:00
Sergey Penkovsky
41d49e98d0 docs(report): update comparative DI benchmark results and conclusions for cherrypick, get_it, riverpod (eng, ru) 2025-08-07 16:46:53 +03:00
Sergey Penkovsky
44a8a3fcb2 chore(pubspec): update pubspec and lock files for all packages, version bump and deps sync 2025-08-07 16:28:47 +03:00
Sergey Penkovsky
475deac1e0 chore(release): publish packages
- cherrypick@3.0.0-dev.5
 - cherrypick_flutter@1.1.3-dev.5
2025-08-07 16:23:12 +03:00
Sergey Penkovsky
f06f4564d9 Merge pull request #15 from pese-git/improve
perf(scope): speed up dependency lookup with Map-based binding resolv…
2025-08-07 16:19:11 +03:00
Sergey Penkovsky
70731c7e94 refactor(scope): simplify _findBindingResolver<T> with one-liner and optional chaining
The function is now shorter, more readable and uses modern Dart null-safety idioms. No functional change.
2025-08-07 15:48:04 +03:00
Sergey Penkovsky
4d5f96705f Merge pull request #17 from pese-git/impr/complex_benchmark_impr
impr: BENCHMARK - complex benchmark improvements.
2025-08-07 15:01:27 +03:00
yarashevich_kv
d23d06f98e impr: BENCHMARK - fix for CherrypickDIAdapter. 2025-08-07 14:55:07 +03:00
Sergey Penkovsky
e1371f7038 docs: update architecture diagram in README to show adapter-centric universalRegistration pattern 2025-08-07 14:37:34 +03:00
Sergey Penkovsky
75db42428c docs: update README (en/ru) to reflect adapter-based universalRegistration pattern
- Show type-safe DIAdapter-centric registration for all scenarios
- Document new way to add scenarios/DI via universalRegistration<S extends Enum>
- Remove legacy function-based registration/manual switching from guide
- Provide examples for Dart and CLI usage with all DI adapters
2025-08-07 14:23:06 +03:00
Sergey Penkovsky
5336c22550 test: validate all benchmark scenarios and stress runs for all DI adapters
- Successfully executed all scenarios (register, chain, asyncChain, named, override, etc) for Cherrypick, GetIt, and Riverpod
- Verified correct integration of fully generic DIAdapter & universalRegistration architecture
- Ensured type-safety in all setup/registration flows after complete refactor
- All benchmarks run and pass under stress/load params for each DI adapter
2025-08-07 14:18:16 +03:00
Sergey Penkovsky
56bdb3946e refactor: full generic DIAdapter workflow & universalRegistration abstraction
- Made UniversalChainBenchmark and UniversalChainAsyncBenchmark fully generic with strong typing for DIAdapter<TContainer>
- Moved all universalRegistration logic inside adapters; removed global function and typedef
- Replaced dynamic/object-based registration with type-safe generic contracts end-to-end
- Updated CLI and usage: all DI and scenarios are invoked via type-safe generics
- Fixed all analysis errors, Riverpod async/future usages, and imports for full Dart 3 compatibility
- All benchmarks fully pass for Cherrypick, GetIt, and Riverpod adapters
2025-08-07 14:11:29 +03:00
Sergey Penkovsky
54446868e4 refactor: unify DIAdapter with generics, ensure type-safety & scalability in benchmark_di
- Refactor DIAdapter to generic abstract class; align interfaces for Cherrypick, GetIt, Riverpod.
- Remove all dynamic/object usage from dependency registration and bench scenarios.
- Universal getUniversalRegistration function now fully type-safe for all DIs.
- Fix teardown and lifecycle for RiverpodAdapter to prevent disposed Container errors.
- Update CLI and benchmark entry points; validated all scenarios and stress modes for each DI adapter.
2025-08-07 13:45:16 +03:00
Sergey Penkovsky
590b876cf4 feat: add Riverpod adapter, async-chain support via FutureProvider, full DI CLI/bench integration, benchmarking, ascii performance graphs in markdown 2025-08-07 13:12:56 +03:00
Sergey Penkovsky
f7a7ea4384 feat: full di benchmarks report (en/ru) + get_it scope+override support fix; fresh results for all scenarios and settings 2025-08-07 12:11:16 +03:00
Sergey Penkovsky
6b6564f8c3 refactor: rename benchmark_cherrypick to benchmark_di, update paths, pubspec, imports, and documentation 2025-08-07 10:34:50 +03:00
Sergey Penkovsky
da79f1e546 docs: update README.md and README.ru.md for universal DI benchmarks, scenarios, CLI options, and architecture diagram 2025-08-07 10:16:14 +03:00
Sergey Penkovsky
64f33b20a7 fix: universal benchmarks and DI registration; proper named binding; robust override support for cherrypick and get_it; improved CLI args 2025-08-07 09:15:26 +03:00
Sergey Penkovsky
d523a5f261 refactor: simplify DIAdapter interface with a single registration callback; update benchmarks and cherrypick adapter accordingly 2025-08-07 08:28:23 +03:00
Sergey Penkovsky
b72dec9944 Обновлен README.ru.md: новые современные сценарии, параметры CLI, форматы отчётов, инструкция по расширению 2025-08-06 23:22:05 +03:00
Sergey Penkovsky
352442e52d Update README.md with current benchmark scenarios, CLI options, and report formats (EN) 2025-08-06 23:19:37 +03:00
Sergey Penkovsky
134fc5207a Add English documentation comments to all benchmark_cherrypick source files (adapters, scenarios, CLI, reporters, runner) 2025-08-06 23:15:28 +03:00
Sergey Penkovsky
01d82e1cd3 feat(report): add legend to MarkdownReport output with explanation of columns 2025-08-06 22:53:33 +03:00
Sergey Penkovsky
1e6375f5ae refactor(report): round numeric values to 2 decimal places in MarkdownReport output 2025-08-06 22:41:08 +03:00
Sergey Penkovsky
3da71674d4 chore: fix current status, all implemented features and refactors 2025-08-06 22:35:49 +03:00
Sergey Penkovsky
ea39b9d0e1 feat(report): align MarkdownReport columns for readable ASCII/markdown output 2025-08-06 22:31:41 +03:00
Sergey Penkovsky
09ed186544 refactor(cli): modularize CLI — extract parser, runner, report and main logic into dedicated files 2025-08-06 22:19:13 +03:00
Sergey Penkovsky
3ce21f55e4 refactor(report): extract ReportGenerator abstraction for pretty/csv/json; simplify report rendering in main 2025-08-06 22:02:41 +03:00
Sergey Penkovsky
bae940f374 refactor(main): extract BenchmarkRunner and BenchmarkResult, simplify main loop, unify sync/async cases 2025-08-06 21:53:13 +03:00
Sergey Penkovsky
0fc1907173 chore(cleanup): remove unused legacy benchmarks and scenario files 2025-08-06 18:36:11 +03:00
Sergey Penkovsky
4d41266135 refactor(benchmark): clean up UniversalChainBenchmark, remove async logic, keep only sync scenario logic 2025-08-06 18:26:05 +03:00
Sergey Penkovsky
3a75bd5b28 feat(benchmark): add UniversalScenario enum and extend UniversalChainModule to support chain, register, named, override, async scenarios 2025-08-06 17:01:55 +03:00
Sergey Penkovsky
b27a7df161 refactor(structure): move benchmarks, scenarios, adapters, utils to dedicated folders; update imports/project layout 2025-08-06 16:21:31 +03:00
Sergey Penkovsky
553dbb6539 refactor(benchmarks): introduce DIAdapter abstraction, migrate all scenarios to use DIAdapter 2025-08-06 14:44:12 +03:00
Sergey Penkovsky
18905a068d docs(benchmarks): document memory_diff_kb, delta_peak_kb, peak_rss_kb in README files (EN+RU) 2025-08-06 14:07:44 +03:00
Sergey Penkovsky
6928daa50e docs(benchmarks): update README files with stability options, repeat/warmup params, stat fields, and usage examples 2025-08-06 13:48:51 +03:00
Sergey Penkovsky
7f488f873e docs(benchmarks): update README files with new CLI, matrix run, output formats, and usage instructions (EN+RU) 2025-08-06 13:35:39 +03:00
Sergey Penkovsky
926bbf15f4 refactor(benchmarks): unify benchmark structure, enable CLI parameterization, run matrix, add CSV/JSON/pretty output
- All benchmarks now use a unified base mixin for setup/teardown (BenchmarkWithScope).
- Added args package support: CLI flags for choosing benchmarks, chain counts, nesting depths, output format.
- Support for running benchmarks in matrix mode (multiple parameter sets).
- Machine-readable output: csv, json, pretty-table.
- Loop and naming lint fixes, unused imports removed.
2025-08-06 13:30:30 +03:00
yarashevich_kv
a5ef0dc437 impr: BENCHMARK - complex benchmark improvements. 2025-08-06 09:41:17 +03:00
Sergey Penkovsky
05cfca5977 docs(perf): clarify Map-based resolver optimization applies since v3.0.0 in all docs 2025-08-06 08:29:00 +03:00
Sergey Penkovsky
52a55219ab docs: update EN/RU quick start and tutorial with Fast Map-based lookup section; clarify performance benefit in README 2025-08-05 19:41:24 +03:00
Sergey Penkovsky
ffff33c744 perf(scope): speed up dependency lookup with Map-based binding resolver index
Optimize resolve()/tryResolve() to use O(1) Map-based lookup by type and name instead of iterating through all modules and bindings. Behavior of factory, singleton, instance, and named bindings is preserved.
2025-08-05 17:20:35 +03:00
Sergey Penkovsky
a4573ce8ef Add package topics to all pubspec.yaml files 2025-08-05 06:46:26 +03:00
Sergey Penkovsky
62868477fb chore(release): publish packages
- cherrypick@3.0.0-dev.2
 - cherrypick_flutter@1.1.3-dev.2
2025-08-04 08:54:37 +03:00
Sergey Penkovsky
a889cf0d40 Resolved all Dart analyzer warnings across multiple files 2025-08-01 11:20:23 +03:00
Sergey Penkovsky
123ed6ce02 Merge pull request #13 from pese-git/impr/binding_resolver
Refactored Binding by extracting BindingResolver to improve code structure and simplify the Binding class.
2025-08-01 11:01:30 +03:00
Sergey Penkovsky
7cc0743d94 Update benchmark results in README.ru.md with latest timings (RU version) 2025-08-01 08:48:27 +03:00
Sergey Penkovsky
63dae76ea9 Update benchmark results in README.md with latest timings 2025-08-01 08:47:55 +03:00
Sergey Penkovsky
a74c34876d feat(binding): add deprecated proxy async methods for backward compatibility and highlight transition to modern API 2025-08-01 08:44:31 +03:00
yarashevich_kv
9f0a8a84aa impr: fix after rebase. 2025-08-01 08:44:31 +03:00
yarashevich_kv
2cba7f2675 impr: add binding resolver class. 2025-08-01 08:44:31 +03:00
Sergey Penkovsky
1682ed9c08 Update benchmarks, lock files, and related documentation 2025-08-01 08:40:10 +03:00
Sergey Penkovsky
882ee92000 Update benchmark results in README.md with fresh timings 2025-08-01 08:39:12 +03:00
Sergey Penkovsky
9a3576f76d chore(release): publish packages
- cherrypick@3.0.0-dev.1
 - cherrypick_flutter@1.1.3-dev.1
2025-08-01 08:31:50 +03:00
Sergey Penkovsky
f7cc86ea66 docs: add quick guide for circular dependency detection to README 2025-08-01 08:31:50 +03:00
Sergey Penkovsky
1c8e38b0c9 chore(release): publish packages
- cherrypick@3.0.0-dev.0
 - cherrypick_flutter@1.1.3-dev.0
2025-08-01 08:31:50 +03:00
Sergey Penkovsky
d4af82ba01 Remove dead code: _createDependencyKey (no longer used, cycle detection not affected) 2025-08-01 08:31:50 +03:00
Sergey Penkovsky
5630efccfe feat: enable CherryPick cycle detection in debug mode and use safe root scope 2025-08-01 08:31:50 +03:00
Sergey Penkovsky
d63d52b817 feat: implement comprehensive circular dependency detection system
- Add two-level circular dependency detection (local and global)
- Implement CycleDetector for local scope cycle detection
- Implement GlobalCycleDetector for cross-scope cycle detection
- Add CircularDependencyException with detailed dependency chain info
- Integrate cycle detection into Scope class with unique scope IDs
- Extend CherryPick helper with cycle detection management API
- Add safe scope creation methods with automatic detection
- Support both synchronous and asynchronous dependency resolution
- Include comprehensive test coverage (72+ tests)
- Add bilingual documentation (English and Russian)
- Provide usage examples and architectural best practices
- Add performance recommendations and debug tools

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

fix: remove tmp files

update examples

update examples
2025-08-01 08:31:50 +03:00
Sergey Penkovsky
724dc9b3b5 Update lock files for dependency consistency 2025-08-01 08:30:53 +03:00
Sergey Penkovsky
6bdb9472b5 Update melos.yaml: add benchmark_cherrypick to managed packages 2025-08-01 08:30:12 +03:00
Sergey Penkovsky
23683119c2 Add complex DI benchmarks, main runner, and English README with summarized results for cherrypick core 2025-08-01 08:26:33 +03:00
Sergey Penkovsky
2c1f9d5969 doc: update manual 2025-07-29 08:10:08 +03:00
Sergey Penkovsky
e609c44f90 fix: update deps 2025-07-28 12:53:47 +03:00
Sergey Penkovsky
eb8cc1f566 update gitignore 2025-07-28 12:53:27 +03:00
127 changed files with 10303 additions and 984 deletions

6
.gitignore vendored
View File

@@ -17,4 +17,8 @@ pubspec_overrides.yaml
melos_cherrypick.iml
melos_cherrypick_workspace.iml
melos_cherrypick_flutter.iml
melos_cherrypick_flutter.iml
melos_benchmark_di.iml
melos_talker_cherrypick_logger.iml
coverage

View File

@@ -3,6 +3,397 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
## 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
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`cherrypick` - `v3.0.0-dev.1`](#cherrypick---v300-dev1)
- [`cherrypick_flutter` - `v1.1.3-dev.1`](#cherrypick_flutter---v113-dev1)
Packages with dependency updates only:
> Packages listed below depend on other packages in this workspace that have had changes. Their versions have been incremented to bump the minimum dependency versions of the packages they depend upon in this project.
- `cherrypick_flutter` - `v1.1.3-dev.1`
---
#### `cherrypick` - `v3.0.0-dev.1`
- **DOCS**: add quick guide for circular dependency detection to README.
## 2025-07-30
### Changes
---
Packages with breaking changes:
- [`cherrypick` - `v3.0.0-dev.0`](#cherrypick---v300-dev0)
Packages with other changes:
- [`cherrypick_flutter` - `v1.1.3-dev.0`](#cherrypick_flutter---v113-dev0)
---
#### `cherrypick` - `v3.0.0-dev.0`
- **BREAKING** **FEAT**: implement comprehensive circular dependency detection system.
#### `cherrypick_flutter` - `v1.1.3-dev.0`
- **FIX**: update deps.
## 2025-07-28
### Changes

View File

@@ -192,7 +192,7 @@
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
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,

View File

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

275
benchmark_di/README.md Normal file
View File

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

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

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

51
benchmark_di/REPORT.md Normal file
View File

@@ -0,0 +1,51 @@
# Comparative DI Benchmark Report: cherrypick vs get_it vs riverpod
## 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=10, nestingDepth=10 (Mean, PeakRSS)
| Scenario | cherrypick Mean (us) | cherrypick PeakRSS | get_it Mean (us) | get_it PeakRSS | riverpod Mean (us) | riverpod PeakRSS |
|--------------------|---------------------:|-------------------:|-----------------:|---------------:|-------------------:|-----------------:|
| RegisterSingleton | 13.00 | 273104 | 8.40 | 261872 | 9.80 | 268512 |
| ChainSingleton | 13.80 | 271072 | 2.00 | 262000 | 33.60 | 268784 |
| ChainFactory | 5.00 | 299216 | 4.00 | 297136 | 22.80 | 271296 |
| AsyncChain | 28.60 | 290640 | 24.60 | 342976 | 78.20 | 285920 |
| Named | 2.20 | 297008 | 0.20 | 449824 | 6.20 | 281136 |
| Override | 7.00 | 297024 | 0.00 | 449824 | 30.20 | 281152 |
## Maximum Load: chainCount=100, nestingDepth=100 (Mean, PeakRSS)
| Scenario | cherrypick Mean (us) | cherrypick PeakRSS | get_it Mean (us) | get_it PeakRSS | riverpod Mean (us) | riverpod PeakRSS |
|--------------------|---------------------:|-------------------:|-----------------:|---------------:|-------------------:|-----------------:|
| RegisterSingleton | 4.00 | 271072 | 1.00 | 262000 | 2.00 | 268688 |
| ChainSingleton | 76.60 | 303312 | 2.00 | 297136 | 221.80 | 270784 |
| ChainFactory | 80.00 | 293952 | 39.20 | 342720 | 195.80 | 308640 |
| AsyncChain | 251.40 | 297008 | 18.20 | 450640 | 748.80 | 285968 |
| Named | 2.20 | 297008 | 0.00 | 449824 | 1.00 | 281136 |
| Override | 104.80 | 301632 | 2.20 | 477344 | 120.80 | 294752 |
---
## Analysis
- **get_it** is the absolute leader in all scenarios, especially under deep/nested chains and async.
- **cherrypick** is highly competitive and much faster than riverpod on any complex graph.
- **riverpod** is only suitable for small/simple DI graphs due to major slowdowns with depth, async, or override.
### Recommendations
- Use **get_it** for performance-critical and deeply nested graphs.
- Use **cherrypick** for scalable/testable apps if a small speed loss is acceptable.
- Use **riverpod** only if you rely on Flutter integration and your DI chains are simple.
---
_Last updated: August 8, 2025._

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

@@ -0,0 +1,51 @@
# Сравнительный отчет DI-бенчмарка: cherrypick vs get_it vs riverpod
## Описание сценариев
1. **RegisterSingleton** — регистрация и получение объекта-синглтона (базовая скорость DI).
2. **ChainSingleton** — цепочка зависимостей A → B → ... → N (singleton). Глубокий singleton-резолвинг.
3. **ChainFactory** — все элементы цепочки — фабрики. Stateless построение графа.
4. **AsyncChain** — асинхронная цепочка (async factory). Тестирует async/await граф.
5. **Named** — регистрация двух биндингов с именами, разрешение по имени.
6. **Override** — регистрация биндинга/цепочки в дочернем scope. Проверка override/scoping.
---
## Сводная таблица: chainCount=10, nestingDepth=10 (Mean, PeakRSS)
| Сценарий | cherrypick Mean (мкс) | cherrypick PeakRSS | get_it Mean (мкс) | get_it PeakRSS | riverpod Mean (мкс) | riverpod PeakRSS |
|--------------------|----------------------:|-------------------:|------------------:|---------------:|--------------------:|-----------------:|
| RegisterSingleton | 13.00 | 273104 | 8.40 | 261872 | 9.80 | 268512 |
| ChainSingleton | 13.80 | 271072 | 2.00 | 262000 | 33.60 | 268784 |
| ChainFactory | 5.00 | 299216 | 4.00 | 297136 | 22.80 | 271296 |
| AsyncChain | 28.60 | 290640 | 24.60 | 342976 | 78.20 | 285920 |
| Named | 2.20 | 297008 | 0.20 | 449824 | 6.20 | 281136 |
| Override | 7.00 | 297024 | 0.00 | 449824 | 30.20 | 281152 |
## Максимальная нагрузка: chainCount=100, nestingDepth=100 (Mean, PeakRSS)
| Сценарий | cherrypick Mean (мкс) | cherrypick PeakRSS | get_it Mean (мкс) | get_it PeakRSS | riverpod Mean (мкс) | riverpod PeakRSS |
|--------------------|----------------------:|-------------------:|------------------:|---------------:|--------------------:|-----------------:|
| RegisterSingleton | 4.00 | 271072 | 1.00 | 262000 | 2.00 | 268688 |
| ChainSingleton | 76.60 | 303312 | 2.00 | 297136 | 221.80 | 270784 |
| ChainFactory | 80.00 | 293952 | 39.20 | 342720 | 195.80 | 308640 |
| AsyncChain | 251.40 | 297008 | 18.20 | 450640 | 748.80 | 285968 |
| Named | 2.20 | 297008 | 0.00 | 449824 | 1.00 | 281136 |
| Override | 104.80 | 301632 | 2.20 | 477344 | 120.80 | 294752 |
---
## Краткий анализ и рекомендации
- **get_it** всегда лидер, особенно на глубине/асинхронных графах.
- **cherrypick** заметно быстрее riverpod на сложных сценариях, опережая его в разы.
- **riverpod** подходит только для простых/небольших графов — при росте глубины или async/override резко проигрывает по скорости.
### Рекомендации
- Используйте **get_it** для критичных к скорости приложений/сложных графов зависимостей.
- Выбирайте **cherrypick** для масштабируемых, тестируемых архитектур, если микросекундная разница не критична.
- **riverpod** уместен только для реактивного UI или простых графов DI.
---
_Обновлено: 8 августа 2025_

View File

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

View File

@@ -0,0 +1,5 @@
import 'package:benchmark_di/cli/benchmark_cli.dart';
Future<void> main(List<String> args) async {
await BenchmarkCliRunner().run(args);
}

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,156 @@
import 'package:benchmark_di/scenarios/universal_binding_mode.dart';
import 'package:benchmark_di/scenarios/universal_scenario.dart';
import 'package:benchmark_di/scenarios/universal_service.dart';
import 'package: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');
}
}

View File

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

View File

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

View File

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

View File

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

132
benchmark_di/pubspec.lock Normal file
View File

@@ -0,0 +1,132 @@
# Generated by pub
# See https://dart.dev/tools/pub/glossary#lockfile
packages:
ansi_modifier:
dependency: transitive
description:
name: ansi_modifier
sha256: "4b97c241f345e49c929bd56d0198b567b7dfcca7ec8d4f798745c9ced998684c"
url: "https://pub.dev"
source: hosted
version: "0.1.4"
args:
dependency: "direct main"
description:
name: args
sha256: d0481093c50b1da8910eb0bb301626d4d8eb7284aa739614d2b394ee09e3ea04
url: "https://pub.dev"
source: hosted
version: "2.7.0"
async:
dependency: transitive
description:
name: async
sha256: "758e6d74e971c3e5aceb4110bfd6698efc7f501675bcfe0c775459a8140750eb"
url: "https://pub.dev"
source: hosted
version: "2.13.0"
benchmark_harness:
dependency: "direct dev"
description:
name: benchmark_harness
sha256: "83f65107165883ba8623eb822daacb23dcf9f795c66841de758c9dd7c5a0cf28"
url: "https://pub.dev"
source: hosted
version: "2.3.1"
benchmark_runner:
dependency: "direct dev"
description:
name: benchmark_runner
sha256: "7de181228eb74cb34507ded2260fe88b3b71e0aacfe0dfa794df49edaf041ca3"
url: "https://pub.dev"
source: hosted
version: "0.0.4"
cherrypick:
dependency: "direct main"
description:
path: "../cherrypick"
relative: true
source: path
version: "3.0.0-dev.9"
collection:
dependency: transitive
description:
name: collection
sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76"
url: "https://pub.dev"
source: hosted
version: "1.19.1"
exception_templates:
dependency: transitive
description:
name: exception_templates
sha256: "517f7c770da690073663f867ee2057ae2f4ffb28edae9da9faa624aa29ac76eb"
url: "https://pub.dev"
source: hosted
version: "0.3.1"
get_it:
dependency: "direct main"
description:
name: get_it
sha256: a4292e7cf67193f8e7c1258203104eb2a51ec8b3a04baa14695f4064c144297b
url: "https://pub.dev"
source: hosted
version: "8.2.0"
lazy_memo:
dependency: transitive
description:
name: lazy_memo
sha256: dcb30b4184a6d767e1d779d74ce784d752d38313b8fb4bad6b659ae7af4bb34d
url: "https://pub.dev"
source: hosted
version: "0.2.3"
lints:
dependency: "direct dev"
description:
name: lints
sha256: c35bb79562d980e9a453fc715854e1ed39e24e7d0297a880ef54e17f9874a9d7
url: "https://pub.dev"
source: hosted
version: "5.1.1"
meta:
dependency: transitive
description:
name: meta
sha256: "23f08335362185a5ea2ad3a4e597f1375e78bce8a040df5c600c8d3552ef2394"
url: "https://pub.dev"
source: hosted
version: "1.17.0"
path:
dependency: transitive
description:
name: path
sha256: "75cca69d1490965be98c73ceaea117e8a04dd21217b37b292c9ddbec0d955bc5"
url: "https://pub.dev"
source: hosted
version: "1.9.1"
riverpod:
dependency: "direct main"
description:
name: riverpod
sha256: "59062512288d3056b2321804332a13ffdd1bf16df70dcc8e506e411280a72959"
url: "https://pub.dev"
source: hosted
version: "2.6.1"
stack_trace:
dependency: transitive
description:
name: stack_trace
sha256: "8b27215b45d22309b5cddda1aa2b19bdfec9df0e765f2de506401c071d38d1b1"
url: "https://pub.dev"
source: hosted
version: "1.12.1"
state_notifier:
dependency: transitive
description:
name: state_notifier
sha256: b8677376aa54f2d7c58280d5a007f9e8774f1968d1fb1c096adcb4792fba29bb
url: "https://pub.dev"
source: hosted
version: "1.0.0"
sdks:
dart: ">=3.6.0 <4.0.0"

19
benchmark_di/pubspec.yaml Normal file
View File

@@ -0,0 +1,19 @@
name: benchmark_di
version: 0.1.0
publish_to: none
description: Universal benchmark for any DI library (cherrypick, get_it, and others)
environment:
sdk: '>=3.0.0 <4.0.0'
dependencies:
cherrypick:
path: ../cherrypick
args: ^2.7.0
get_it: ^8.2.0
riverpod: ^2.6.1
dev_dependencies:
lints: ^5.0.0
benchmark_harness: ^2.2.2
benchmark_runner: ^0.0.2

View File

@@ -21,4 +21,6 @@ doc/api/
*.js.map
# FVM Version Cache
.fvm/
.fvm/
pubspec_overrides.yaml

View File

@@ -1,3 +1,85 @@
## 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
- **DOCS**: add quick guide for circular dependency detection to README.
## 3.0.0-dev.0
> Note: This release has breaking changes.
- **BREAKING** **FEAT**: implement comprehensive circular dependency detection system.
## 2.2.0
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.

View File

@@ -192,7 +192,7 @@
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
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,

View File

@@ -1,19 +1,103 @@
# CherryPick
`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.
`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.
## 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
A **Binding** acts as a configuration for how to create or provide a particular dependency. Bindings support:
- Direct instance assignment (`toInstance()`, `toInstanceAsync()`)
- Lazy providers (sync/async functions)
- Provider functions supporting dynamic parameters
- Named instances for resolving by string key
- Optional singleton lifecycle
* Direct instance assignment (`toInstance()`, `toInstanceAsync()`)
* Lazy providers (sync/async functions)
* Provider functions supporting dynamic parameters
* Named instances for resolving by string key
* Optional singleton lifecycle
#### Example
@@ -80,22 +164,67 @@ final str = rootScope.resolve<String>();
// Resolve a dependency asynchronously
final result = await rootScope.resolveAsync<String>();
// Close the root scope once done
CherryPick.closeRootScope();
// Recommended: Close the root scope and release all resources
await 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
// Open a named child scope (e.g., for a feature/module)
final subScope = rootScope.openSubScope('featureScope')
..installModules([FeatureModule()]);
class CacheManager implements Disposable {
void dispose() {
cache.clear();
print('CacheManager disposed!');
}
}
// Resolve from subScope, with fallback to parents if missing
final dataBloc = await subScope.resolveAsync<DataBloc>();
final scope = CherryPick.openRootScope();
scope.installModules([
Module((bind) => bind<CacheManager>().toProvide(() => CacheManager()).singleton()),
]);
// ...later
await CherryPick.closeRootScope(); // prints: CacheManager disposed!
```
### Dependency Lookup API
#### Async Example
```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.
- `resolveAsync<T>()` — Async variant for dependencies requiring async binding.
@@ -107,6 +236,335 @@ Supports:
- Named dependencies
- 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
Below is a complete example illustrating modules, subscopes, async providers, and dependency resolution.
@@ -228,28 +686,52 @@ class ApiClientImpl implements ApiClient {
}
```
## Features
---
- [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)
## FAQ
### Q: Do I need to use `await` with CherryPick.closeRootScope(), CherryPick.closeScope(), or scope.dispose() if I have no Disposable services?
**A:**
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.
---
## Documentation Links
* Circular Dependency Detection [(En)](doc/cycle_detection.en.md)[(Ru)](doc/cycle_detection.ru.md)
---
## Additional Modules
CherryPick provides a set of official add-on modules for advanced use cases and specific platforms:
| Module name | Description |
|-------------|-------------|
| [**cherrypick_annotations**](https://pub.dev/packages/cherrypick_annotations) | Dart annotations for concise DI definitions and code generation. |
| [**cherrypick_generator**](https://pub.dev/packages/cherrypick_generator) | Code generator to produce DI bindings based on annotations. |
| [**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. |
---
## Contributing
Contributions are welcome! Please open issues or submit pull requests on [GitHub](https://github.com/pese-git/cherrypick).
---
## License
Licensed under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
Licensed under the [Apache License 2.0](https://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.
---
## Links
- [GitHub Repository](https://github.com/pese-git/cherrypick)
- [GitHub Repository](https://github.com/pese-git/cherrypick)

View File

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

View File

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

View File

@@ -0,0 +1,37 @@
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
}

View File

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

View File

@@ -0,0 +1,40 @@
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...');
}
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
}
/// Пример модуля CherryPick
class ModuleImpl extends Module {
@override
void builder(Scope scope) {
bind<MyService>().toProvide(() => MyService()).singleton();
}
}

View File

@@ -5,7 +5,7 @@ library;
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -13,7 +13,12 @@ library;
// limitations under the License.
//
export 'package:cherrypick/src/binding_resolver.dart';
export 'package:cherrypick/src/binding.dart';
export 'package:cherrypick/src/cycle_detector.dart';
export 'package:cherrypick/src/global_cycle_detector.dart';
export 'package:cherrypick/src/helper.dart';
export 'package:cherrypick/src/module.dart';
export 'package:cherrypick/src/scope.dart';
export 'package:cherrypick/src/disposable.dart';
export 'package:cherrypick/src/observer.dart';

Binary file not shown.

View File

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

View File

@@ -0,0 +1,240 @@
//
// 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:collection';
import 'package:cherrypick/src/observer.dart';
/// Exception thrown when a circular dependency is detected during dependency resolution.
///
/// 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 {
final String message;
final List<String> dependencyChain;
CircularDependencyException(this.message, this.dependencyChain);
@override
String toString() {
final chain = dependencyChain.join(' -> ');
return 'CircularDependencyException: $message\nDependency chain: $chain';
}
}
/// Circular dependency detector for CherryPick DI containers.
///
/// 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 {
final CherryPickObserver _observer;
final Set<String> _resolutionStack = HashSet<String>();
final List<String> _resolutionHistory = [];
CycleDetector({required CherryPickObserver observer}) : _observer = observer;
/// Starts tracking dependency resolution for type [T] and optional [named] qualifier.
///
/// Throws [CircularDependencyException] if a cycle is found.
void startResolving<T>({String? named}) {
final dependencyKey = _createDependencyKey<T>(named);
_observer.onDiagnostic(
'CycleDetector startResolving: $dependencyKey',
details: {
'event': 'startResolving',
'stackSize': _resolutionStack.length,
},
);
if (_resolutionStack.contains(dependencyKey)) {
final cycleStartIndex = _resolutionHistory.indexOf(dependencyKey);
final cycle = _resolutionHistory.sublist(cycleStartIndex)
..add(dependencyKey);
_observer.onCycleDetected(cycle);
_observer.onError('Cycle detected for $dependencyKey', null, null);
throw CircularDependencyException(
'Circular dependency detected for $dependencyKey',
cycle,
);
}
_resolutionStack.add(dependencyKey);
_resolutionHistory.add(dependencyKey);
}
/// Stops tracking dependency resolution for type [T] and optional [named] qualifier.
/// Should always be called after [startResolving], including for errors.
void finishResolving<T>({String? named}) {
final dependencyKey = _createDependencyKey<T>(named);
_observer.onDiagnostic(
'CycleDetector finishResolving: $dependencyKey',
details: {'event': 'finishResolving'},
);
_resolutionStack.remove(dependencyKey);
// Only remove from history if it's the last one
if (_resolutionHistory.isNotEmpty &&
_resolutionHistory.last == dependencyKey) {
_resolutionHistory.removeLast();
}
}
/// Clears all resolution state and resets the cycle detector.
void clear() {
_observer.onDiagnostic(
'CycleDetector clear',
details: {
'event': 'clear',
'description': 'resolution stack cleared',
},
);
_resolutionStack.clear();
_resolutionHistory.clear();
}
/// Returns true if dependency [T] (and [named], if specified) is being resolved right now.
bool isResolving<T>({String? named}) {
final dependencyKey = _createDependencyKey<T>(named);
return _resolutionStack.contains(dependencyKey);
}
/// Gets the current dependency resolution chain (for diagnostics or debugging).
List<String> get currentResolutionChain =>
List.unmodifiable(_resolutionHistory);
/// Returns a unique string key for type [T] (+name).
String _createDependencyKey<T>(String? named) {
final typeName = T.toString();
return named != null ? '$typeName@$named' : typeName;
}
}
/// Mixin for adding circular dependency detection support to custom DI containers/classes.
///
/// 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 {
CycleDetector? _cycleDetector;
CherryPickObserver get observer;
/// Turns on circular dependency detection for this class/container.
void enableCycleDetection() {
_cycleDetector = CycleDetector(observer: observer);
observer.onDiagnostic(
'CycleDetection enabled',
details: {
'event': 'enable',
'description': 'cycle detection enabled',
},
);
}
/// Shuts off detection and clears any cycle history for this container.
void disableCycleDetection() {
_cycleDetector?.clear();
observer.onDiagnostic(
'CycleDetection disabled',
details: {
'event': 'disable',
'description': 'cycle detection disabled',
},
);
_cycleDetector = null;
}
/// Returns true if detection is currently enabled.
bool get isCycleDetectionEnabled => _cycleDetector != null;
/// Executes [action] while tracking for circular DI cycles for [dependencyType] and [named].
///
/// Throws [CircularDependencyException] if a dependency cycle is detected.
///
/// Example:
/// ```dart
/// withCycleDetection(String, 'api', () => resolveApi());
/// ```
T withCycleDetection<T>(
Type dependencyType,
String? named,
T Function() action,
) {
if (_cycleDetector == null) {
return action();
}
final dependencyKey = named != null
? '${dependencyType.toString()}@$named'
: dependencyType.toString();
if (_cycleDetector!._resolutionStack.contains(dependencyKey)) {
final cycleStartIndex =
_cycleDetector!._resolutionHistory.indexOf(dependencyKey);
final cycle = _cycleDetector!._resolutionHistory.sublist(cycleStartIndex)
..add(dependencyKey);
observer.onCycleDetected(cycle);
observer.onError('Cycle detected for $dependencyKey', null, null);
throw CircularDependencyException(
'Circular dependency detected for $dependencyKey',
cycle,
);
}
_cycleDetector!._resolutionStack.add(dependencyKey);
_cycleDetector!._resolutionHistory.add(dependencyKey);
try {
return action();
} finally {
_cycleDetector!._resolutionStack.remove(dependencyKey);
if (_cycleDetector!._resolutionHistory.isNotEmpty &&
_cycleDetector!._resolutionHistory.last == dependencyKey) {
_cycleDetector!._resolutionHistory.removeLast();
}
}
}
/// Gets the current active dependency resolution chain.
List<String> get currentResolutionChain =>
_cycleDetector?.currentResolutionChain ?? [];
}

View File

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

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -12,6 +12,28 @@
//
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> {
/// Implement this to provide an instance of [T], with access to the resolving [scope].
T createInstance(Scope scope);
}

View File

@@ -0,0 +1,247 @@
//
// 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:collection';
import 'package:cherrypick/cherrypick.dart';
/// GlobalCycleDetector detects and prevents circular dependencies across an entire DI 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 {
static GlobalCycleDetector? _instance;
final CherryPickObserver _observer;
// Global set and chain history for all resolutions
final Set<String> _globalResolutionStack = HashSet<String>();
final List<String> _globalResolutionHistory = [];
// Map of active detectors for subscopes (rarely used directly)
final Map<String, CycleDetector> _scopeDetectors =
HashMap<String, CycleDetector>();
GlobalCycleDetector._internal({required CherryPickObserver observer})
: _observer = observer;
/// Returns the singleton global detector instance, initializing it if needed.
static GlobalCycleDetector get instance {
_instance ??=
GlobalCycleDetector._internal(observer: CherryPick.globalObserver);
return _instance!;
}
/// Reset internal state (useful for testing).
static void reset() {
_instance?._globalResolutionStack.clear();
_instance?._globalResolutionHistory.clear();
_instance?._scopeDetectors.clear();
_instance = null;
}
/// Start tracking resolution of dependency [T] with optional [named] and [scopeId].
/// Throws [CircularDependencyException] on cycle.
void startGlobalResolving<T>({String? named, String? scopeId}) {
final dependencyKey = _createDependencyKeyFromType(T, named, scopeId);
if (_globalResolutionStack.contains(dependencyKey)) {
final cycleStartIndex = _globalResolutionHistory.indexOf(dependencyKey);
final cycle = _globalResolutionHistory.sublist(cycleStartIndex)
..add(dependencyKey);
_observer.onCycleDetected(cycle, scopeName: scopeId);
_observer.onError(
'Global circular dependency detected for $dependencyKey', null, null);
throw CircularDependencyException(
'Global circular dependency detected for $dependencyKey',
cycle,
);
}
_globalResolutionStack.add(dependencyKey);
_globalResolutionHistory.add(dependencyKey);
}
/// Finish tracking a dependency. Should always be called after [startGlobalResolving].
void finishGlobalResolving<T>({String? named, String? scopeId}) {
final dependencyKey = _createDependencyKeyFromType(T, named, scopeId);
_globalResolutionStack.remove(dependencyKey);
if (_globalResolutionHistory.isNotEmpty &&
_globalResolutionHistory.last == dependencyKey) {
_globalResolutionHistory.removeLast();
}
}
/// Internally execute [action] with global cycle detection for [dependencyType], [named], [scopeId].
/// Throws [CircularDependencyException] on cycle.
T withGlobalCycleDetection<T>(
Type dependencyType,
String? named,
String? scopeId,
T Function() action,
) {
final dependencyKey =
_createDependencyKeyFromType(dependencyType, named, scopeId);
if (_globalResolutionStack.contains(dependencyKey)) {
final cycleStartIndex = _globalResolutionHistory.indexOf(dependencyKey);
final cycle = _globalResolutionHistory.sublist(cycleStartIndex)
..add(dependencyKey);
_observer.onCycleDetected(cycle, scopeName: scopeId);
_observer.onError(
'Global circular dependency detected for $dependencyKey', null, null);
throw CircularDependencyException(
'Global circular dependency detected for $dependencyKey',
cycle,
);
}
_globalResolutionStack.add(dependencyKey);
_globalResolutionHistory.add(dependencyKey);
try {
return action();
} finally {
_globalResolutionStack.remove(dependencyKey);
if (_globalResolutionHistory.isNotEmpty &&
_globalResolutionHistory.last == dependencyKey) {
_globalResolutionHistory.removeLast();
}
}
}
/// Get per-scope detector (not usually needed by consumers).
CycleDetector getScopeDetector(String scopeId) {
return _scopeDetectors.putIfAbsent(
scopeId, () => CycleDetector(observer: CherryPick.globalObserver));
}
/// Remove detector for a given scope.
void removeScopeDetector(String scopeId) {
_scopeDetectors.remove(scopeId);
}
/// Returns true if dependency [T] is currently being resolved in the global scope.
bool isGloballyResolving<T>({String? named, String? scopeId}) {
final dependencyKey = _createDependencyKeyFromType(T, named, scopeId);
return _globalResolutionStack.contains(dependencyKey);
}
/// Get current global dependency resolution chain (for debugging or diagnostics).
List<String> get globalResolutionChain =>
List.unmodifiable(_globalResolutionHistory);
/// Clears all global and per-scope state in this detector.
void clear() {
_globalResolutionStack.clear();
_globalResolutionHistory.clear();
_scopeDetectors.values.forEach(_detectorClear);
_scopeDetectors.clear();
}
void _detectorClear(detector) => detector.clear();
/// Creates a unique dependency key string including scope and name (for diagnostics/cycle checks).
String _createDependencyKeyFromType(
Type type, String? named, String? scopeId) {
final typeName = type.toString();
final namePrefix = named != null ? '@$named' : '';
final scopePrefix = scopeId != null ? '[$scopeId]' : '';
return '$scopePrefix$typeName$namePrefix';
}
}
/// Enhanced mixin for global circular dependency detection, to be mixed into
/// DI scopes or containers that want cross-scope protection.
///
/// 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 {
String? _scopeId;
bool _globalCycleDetectionEnabled = false;
/// Set the scope's unique identifier for global tracking (should be called at scope initialization).
void setScopeId(String scopeId) {
_scopeId = scopeId;
}
/// Get the scope's id, if configured.
String? get scopeId => _scopeId;
/// Enable global cross-scope circular dependency detection.
void enableGlobalCycleDetection() {
_globalCycleDetectionEnabled = true;
}
/// Disable global cycle detection (no cycle checks will be performed globally).
void disableGlobalCycleDetection() {
_globalCycleDetectionEnabled = false;
}
/// Returns true if global cycle detection is currently enabled for this scope/container.
bool get isGlobalCycleDetectionEnabled => _globalCycleDetectionEnabled;
/// Executes [action] with global cycle detection for [dependencyType] and [named].
/// Throws [CircularDependencyException] if a cycle is detected.
///
/// Example:
/// ```dart
/// withGlobalCycleDetection(UserService, null, () => resolveUser());
/// ```
T withGlobalCycleDetection<T>(
Type dependencyType,
String? named,
T Function() action,
) {
if (!_globalCycleDetectionEnabled) {
return action();
}
return GlobalCycleDetector.instance.withGlobalCycleDetection<T>(
dependencyType,
named,
_scopeId,
action,
);
}
/// Access the current global dependency resolution chain for diagnostics.
List<String> get globalResolutionChain =>
GlobalCycleDetector.instance.globalResolutionChain;
}

View File

@@ -3,103 +3,380 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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 'package:cherrypick/src/scope.dart';
import 'package:cherrypick/src/global_cycle_detector.dart';
import 'package:cherrypick/src/observer.dart';
import 'package:meta/meta.dart';
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;
/// Whether global cross-scope cycle detection is enabled ([Scope.enableGlobalCycleDetection]).
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 {
/// RU: Метод открывает главный [Scope].
/// ENG: The method opens the main [Scope].
/// Sets the global logger for all [Scope]s created by CherryPick.
///
/// return
/// Allows customizing log output and DI diagnostics globally.
///
/// 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() {
_rootScope ??= Scope(null);
_rootScope ??= Scope(null, observer: _globalObserver);
// Apply cycle detection settings
if (_globalCycleDetectionEnabled && !_rootScope!.isCycleDetectionEnabled) {
_rootScope!.enableCycleDetection();
}
if (_globalCrossScopeCycleDetectionEnabled &&
!_rootScope!.isGlobalCycleDetectionEnabled) {
_rootScope!.enableGlobalCycleDetection();
}
return _rootScope!;
}
/// RU: Метод закрывает главный [Scope].
/// ENG: The method close the main [Scope].
/// Disposes and resets the root [Scope] singleton.
///
/// Call before tests or when needing full re-initialization.
///
static void closeRootScope() {
/// Example:
/// ```dart
/// CherryPick.closeRootScope();
/// ```
static Future<void> closeRootScope() async {
if (_rootScope != null) {
await _rootScope!
.dispose(); // Автоматический вызов dispose для rootScope!
_rootScope = null;
}
}
/// RU: Метод открывает дочерний [Scope].
/// ENG: The method open the child [Scope].
/// Globally enables cycle detection for all new [Scope]s created by CherryPick.
///
/// Дочерний [Scope] открывается с [scopeName]
/// Child [Scope] open with [scopeName]
/// Strongly recommended for safety in all projects.
///
/// Example:
/// ```dart
/// CherryPick.enableGlobalCycleDetection();
/// ```
/// final String scopeName = 'firstScope.secondScope';
/// final subScope = CherryPick.openScope(scopeName);
static void enableGlobalCycleDetection() {
_globalCycleDetectionEnabled = true;
if (_rootScope != null) {
_rootScope!.enableCycleDetection();
}
}
/// Disables global local cycle detection. Existing and new scopes won't check for local cycles.
///
/// Example:
/// ```dart
/// CherryPick.disableGlobalCycleDetection();
/// ```
static void disableGlobalCycleDetection() {
_globalCycleDetectionEnabled = false;
if (_rootScope != null) {
_rootScope!.disableCycleDetection();
}
}
/// Returns `true` if global local cycle detection is enabled.
static bool get isGlobalCycleDetectionEnabled => _globalCycleDetectionEnabled;
/// Enables cycle detection for a particular scope tree.
///
/// [scopeName] - hierarchical string path (e.g. 'feature.api'), or empty for root.
/// [separator] - path separator (default: '.'), e.g. '/' for "feature/api/module"
///
/// Example:
/// ```dart
/// CherryPick.enableCycleDetectionForScope(scopeName: 'api.feature');
/// ```
static void enableCycleDetectionForScope(
{String scopeName = '', String separator = '.'}) {
final scope = _getScope(scopeName, separator);
scope.enableCycleDetection();
}
/// Disables cycle detection for a given scope. See [enableCycleDetectionForScope].
static void disableCycleDetectionForScope(
{String scopeName = '', String separator = '.'}) {
final scope = _getScope(scopeName, separator);
scope.disableCycleDetection();
}
/// Returns `true` if cycle detection is enabled for the requested scope.
///
/// Example:
/// ```dart
/// CherryPick.isCycleDetectionEnabledForScope(scopeName: 'feature.api');
/// ```
static bool isCycleDetectionEnabledForScope(
{String scopeName = '', String separator = '.'}) {
final scope = _getScope(scopeName, separator);
return scope.isCycleDetectionEnabled;
}
/// Returns the current dependency resolution chain inside the given scope.
///
/// Useful for diagnostics (to print what types are currently resolving).
///
/// Example:
/// ```dart
/// print(CherryPick.getCurrentResolutionChain(scopeName: 'feature.api'));
/// ```
static List<String> getCurrentResolutionChain(
{String scopeName = '', String separator = '.'}) {
final scope = _getScope(scopeName, separator);
return scope.currentResolutionChain;
}
/// Opens the root scope and enables local cycle detection.
///
/// Example:
/// ```dart
/// final safeRoot = CherryPick.openSafeRootScope();
/// ```
static Scope openSafeRootScope() {
final scope = openRootScope();
scope.enableCycleDetection();
return scope;
}
/// Opens a named/nested scope and enables local cycle detection for it.
///
/// Example:
/// ```dart
/// final api = CherryPick.openSafeScope(scopeName: 'feature.api');
/// ```
static Scope openSafeScope({String scopeName = '', String separator = '.'}) {
final scope = openScope(scopeName: scopeName, separator: separator);
scope.enableCycleDetection();
return scope;
}
/// Returns a [Scope] by path (or the root if none specified).
/// Used for internal diagnostics & helpers.
static Scope _getScope(String scopeName, String separator) {
if (scopeName.isEmpty) {
return openRootScope();
}
return openScope(scopeName: scopeName, separator: separator);
}
/// Opens (and creates nested subscopes if needed) a scope by hierarchical path.
///
/// [scopeName] - dot-separated path ("api.feature"). Empty = root.
/// [separator] - path delimiter (default: '.')
///
/// Applies global cycle detection settings to the returned scope.
///
/// Example:
/// ```dart
/// final apiScope = CherryPick.openScope(scopeName: 'network.super.api');
/// ```
@experimental
static Scope openScope({String scopeName = '', String separator = '.'}) {
if (scopeName.isEmpty) {
return openRootScope();
}
final nameParts = scopeName.split(separator);
if (nameParts.isEmpty) {
throw Exception('Can not open sub scope because scopeName can not split');
}
return nameParts.fold(
openRootScope(),
(Scope previousValue, String element) =>
previousValue.openSubScope(element));
final scope = nameParts.fold(openRootScope(),
(Scope previous, String element) => previous.openSubScope(element));
if (_globalCycleDetectionEnabled && !scope.isCycleDetectionEnabled) {
scope.enableCycleDetection();
}
if (_globalCrossScopeCycleDetectionEnabled &&
!scope.isGlobalCycleDetectionEnabled) {
scope.enableGlobalCycleDetection();
}
return scope;
}
/// RU: Метод открывает дочерний [Scope].
/// ENG: The method open the child [Scope].
/// Closes a named or root scope (if [scopeName] is omitted).
///
/// Дочерний [Scope] открывается с [scopeName]
/// Child [Scope] open with [scopeName]
/// [scopeName] - dot-separated hierarchical path (e.g. 'api.feature'). Empty = root.
/// [separator] - path delimiter.
///
/// Example:
/// ```dart
/// CherryPick.closeScope(scopeName: 'network.super.api');
/// ```
/// final String scopeName = 'firstScope.secondScope';
/// final subScope = CherryPick.closeScope(scopeName);
/// ```
///
///
@experimental
static void closeScope({String scopeName = '', String separator = '.'}) {
static Future<void> closeScope(
{String scopeName = '', String separator = '.'}) async {
if (scopeName.isEmpty) {
closeRootScope();
await closeRootScope();
return;
}
final nameParts = scopeName.split(separator);
if (nameParts.isEmpty) {
throw Exception(
'Can not close sub scope because scopeName can not split');
}
if (nameParts.length > 1) {
final lastPart = nameParts.removeLast();
final scope = nameParts.fold(
openRootScope(),
(Scope previousValue, String element) =>
previousValue.openSubScope(element));
scope.closeSubScope(lastPart);
final scope = nameParts.fold(openRootScope(),
(Scope previous, String element) => previous.openSubScope(element));
await scope.closeSubScope(lastPart);
} else {
openRootScope().closeSubScope(nameParts[0]);
await openRootScope().closeSubScope(nameParts.first);
}
}
/// Enables cross-scope cycle detection globally.
///
/// 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.
///
/// Strongly recommended for complex solutions with modular architecture.
///
/// Example:
/// ```dart
/// CherryPick.enableGlobalCrossScopeCycleDetection();
/// ```
static void enableGlobalCrossScopeCycleDetection() {
_globalCrossScopeCycleDetectionEnabled = true;
if (_rootScope != null) {
_rootScope!.enableGlobalCycleDetection();
}
}
/// Disables global cross-scope cycle detection.
///
/// Existing and new scopes stop checking for global (cross-scope) cycles.
/// The internal global cycle detector will be cleared as well.
///
/// Example:
/// ```dart
/// CherryPick.disableGlobalCrossScopeCycleDetection();
/// ```
static void disableGlobalCrossScopeCycleDetection() {
_globalCrossScopeCycleDetectionEnabled = false;
if (_rootScope != null) {
_rootScope!.disableGlobalCycleDetection();
}
GlobalCycleDetector.instance.clear();
}
/// Returns `true` if global cross-scope cycle detection is enabled.
///
/// Example:
/// ```dart
/// if (CherryPick.isGlobalCrossScopeCycleDetectionEnabled) {
/// print('Global cross-scope detection is ON');
/// }
/// ```
static bool get isGlobalCrossScopeCycleDetectionEnabled =>
_globalCrossScopeCycleDetectionEnabled;
/// Returns the current global dependency resolution chain (across all scopes).
///
/// Shows the cross-scope resolution stack, which is useful for advanced diagnostics
/// and debugging cycle issues that occur between scopes.
///
/// Example:
/// ```dart
/// print(CherryPick.getGlobalResolutionChain());
/// ```
static List<String> getGlobalResolutionChain() {
return GlobalCycleDetector.instance.globalResolutionChain;
}
/// Clears the global cross-scope cycle detector.
///
/// Useful in tests or when resetting application state.
///
/// Example:
/// ```dart
/// CherryPick.clearGlobalCycleDetector();
/// ```
static void clearGlobalCycleDetector() {
GlobalCycleDetector.reset();
}
/// Opens the root scope with both local and global cross-scope cycle detection enabled.
///
/// This is the safest way to start IoC for most apps — cycles will be detected
/// both inside a single scope and between scopes.
///
/// Example:
/// ```dart
/// final root = CherryPick.openGlobalSafeRootScope();
/// ```
static Scope openGlobalSafeRootScope() {
final scope = openRootScope();
scope.enableCycleDetection();
scope.enableGlobalCycleDetection();
return scope;
}
/// Opens the given named/nested scope and enables both local and cross-scope cycle detection on it.
///
/// Recommended when creating feature/module scopes in large apps.
///
/// Example:
/// ```dart
/// final featureScope = CherryPick.openGlobalSafeScope(scopeName: 'featureA.api');
/// ```
static Scope openGlobalSafeScope(
{String scopeName = '', String separator = '.'}) {
final scope = openScope(scopeName: scopeName, separator: separator);
scope.enableCycleDetection();
scope.enableGlobalCycleDetection();
return scope;
}
}

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -15,39 +15,71 @@ import 'dart:collection';
import 'package:cherrypick/src/binding.dart';
import 'package:cherrypick/src/scope.dart';
/// RU: Класс Module является основой для пользовательских модулей.
/// Этот класс нужен для инициализации [Scope].
/// Represents a DI module—a reusable group of dependency bindings.
///
/// RU: The Module class is the basis for custom modules.
/// This class is needed to initialize [Scope].
/// Extend [Module] to declaratively group related [Binding] definitions,
/// then install your module(s) into a [Scope] for dependency resolution.
///
/// 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 {
final Set<Binding> _bindingSet = HashSet();
/// RU: Метод добавляет в коллекцию модуля [Binding] экземпляр.
/// Begins the declaration of a new binding within this module.
///
/// ENG: The method adds an instance to the collection of the [Binding] module.
/// Typically used within [builder] to register all needed dependency bindings.
///
/// return [Binding<T>]
/// Example:
/// ```dart
/// bind<Api>().toProvide(() => MockApi());
/// bind<Config>().toInstance(Config.dev());
/// ```
Binding<T> bind<T>() {
final binding = Binding<T>();
_bindingSet.add(binding);
return binding;
}
/// RU: Метод возвращает коллекцию [Binding] экземпляров.
/// Returns the set of all [Binding] instances registered in this module.
///
/// ENG: The method returns a collection of [Binding] instances.
///
/// return [Set<Binding>]
/// This is typically used internally by [Scope] during module installation,
/// but can also be used for diagnostics or introspection.
Set<Binding> get bindingSet => _bindingSet;
/// RU: Абстрактный метод для инициализации пользовательских экземпляров.
/// В этом методе осуществляется конфигурация зависимостей.
/// Abstract method where all dependency bindings are registered.
///
/// ENG: Abstract method for initializing custom instances.
/// This method configures dependencies.
/// Override this method in your custom module subclass to declare
/// all dependency bindings to be provided by this module.
///
/// return [void]
/// The provided [currentScope] can be used for resolving other dependencies,
/// 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);
}

View File

@@ -0,0 +1,244 @@
//
// 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) {}
}

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -11,173 +11,492 @@
// limitations under the License.
//
import 'dart:collection';
import 'dart:math';
import 'package:cherrypick/src/binding.dart';
import 'package:cherrypick/src/cycle_detector.dart';
import 'package:cherrypick/src/disposable.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/observer.dart';
// import 'package:cherrypick/src/log_format.dart';
Scope openRootScope() => Scope(null);
class Scope {
/// Represents a DI scope (container) for modules, subscopes,
/// 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 {
final Scope? _parentScope;
/// RU: Метод возвращает родительский [Scope].
///
/// ENG: The method returns the parent [Scope].
///
/// return [Scope]
late final CherryPickObserver _observer;
@override
CherryPickObserver get observer => _observer;
/// 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;
final Map<String, Scope> _scopeMap = HashMap();
Scope(this._parentScope);
Scope(this._parentScope, {required CherryPickObserver observer})
: _observer = observer {
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();
/// RU: Метод открывает дочерний (дополнительный) [Scope].
// индекс для мгновенного поиска bindingов
final Map<Object, Map<String?, BindingResolver>> _bindingResolvers = {};
/// Generates a unique identifier string for this scope instance.
///
/// ENG: The method opens child (additional) [Scope].
/// Used internally for diagnostics, logging and global scope tracking.
String _generateScopeId() {
final random = Random();
final timestamp = DateTime.now().millisecondsSinceEpoch;
final randomPart = random.nextInt(10000);
return 'scope_${timestamp}_$randomPart';
}
/// Opens a named child [Scope] (subscope) as a descendant of the current scope.
///
/// return [Scope]
/// Subscopes inherit modules and DI context from their parent, but can override or extend bindings.
/// Useful for feature-isolation, screens, request/transaction lifetimes, and test separation.
///
/// Example:
/// ```dart
/// final featureScope = rootScope.openSubScope('feature');
/// featureScope.installModules([FeatureModule()]);
/// final dep = featureScope.resolve<MyDep>();
/// ```
Scope openSubScope(String name) {
if (!_scopeMap.containsKey(name)) {
_scopeMap[name] = Scope(this);
final childScope = Scope(this, observer: observer);
if (isCycleDetectionEnabled) {
childScope.enableCycleDetection();
}
if (isGlobalCycleDetectionEnabled) {
childScope.enableGlobalCycleDetection();
}
_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]!;
}
/// RU: Метод закрывает дочерний (дополнительный) [Scope].
/// Asynchronously closes and disposes a named child [Scope] (subscope).
///
/// ENG: The method closes child (additional) [Scope].
/// Ensures all [Disposable] objects and internal modules
/// in the subscope are properly cleaned up. Also removes any global cycle detectors associated with the subscope.
///
/// return [Scope]
void closeSubScope(String name) {
/// Example:
/// ```dart
/// await rootScope.closeSubScope('feature');
/// ```
Future<void> closeSubScope(String name) async {
final childScope = _scopeMap[name];
if (childScope != null) {
await childScope.dispose();
if (childScope.scopeId != null) {
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);
}
/// RU: Метод инициализирует пользовательские модули в [Scope].
/// Installs a list of custom [Module]s into the [Scope].
///
/// ENG: The method initializes custom modules in [Scope].
/// Each module registers bindings and configuration for dependencies.
/// After calling this, bindings are immediately available for resolve/tryResolve.
///
/// return [Scope]
/// Example:
/// ```dart
/// rootScope.installModules([AppModule(), NetworkModule()]);
/// ```
Scope installModules(List<Module> modules) {
_modulesList.addAll(modules);
if (modules.isNotEmpty) {
observer.onModulesInstalled(
modules.map((m) => m.runtimeType.toString()).toList(),
scopeName: scopeId,
);
}
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);
// Associate bindings with this scope's observer
for (final binding in module.bindingSet) {
binding.observer = observer;
binding.logAllDeferred();
}
}
_rebuildResolversIndex();
return this;
}
/// RU: Метод удаляет пользовательские модули из [Scope].
/// Removes all installed [Module]s and their bindings from this [Scope].
///
/// ENG: This method removes custom modules from [Scope].
/// Typically used in tests or when resetting app configuration/runtime environment.
/// Note: this does not dispose resolved [Disposable]s (call [dispose] for that).
///
/// return [Scope]
/// Example:
/// ```dart
/// testScope.dropModules();
/// ```
Scope dropModules() {
// [AlexeyYuPopkov](https://github.com/AlexeyYuPopkov) Thank you for the [Removed exception "ConcurrentModificationError"](https://github.com/pese-git/cherrypick/pull/2)
if (_modulesList.isNotEmpty) {
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();
_rebuildResolversIndex();
return this;
}
/// RU: Возвращает найденную зависимость, определенную параметром типа [T].
/// Выдает [StateError], если зависимость не может быть разрешена.
/// Если вы хотите получить [null], если зависимость не может быть найдена,
/// то используйте вместо этого [tryResolve]
/// return - возвращает объект типа [T] или [StateError]
/// Resolves a dependency of type [T], optionally by name and with params.
///
/// ENG: 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 then use [tryResolve] instead
/// return - returns an object of type [T] or [StateError]
/// Throws [StateError] if the dependency cannot be resolved. (Use [tryResolve] for fallible lookup).
/// Resolves from installed modules or recurses up the parent scope chain.
///
/// Example:
/// ```dart
/// final logger = scope.resolve<Logger>();
/// final special = scope.resolve<Service>(named: 'special');
/// ```
T resolve<T>({String? named, dynamic params}) {
var resolved = tryResolve<T>(named: named, params: params);
if (resolved != null) {
return resolved;
observer.onInstanceRequested(T.toString(), T, scopeName: scopeId);
T result;
if (isGlobalCycleDetectionEnabled) {
try {
result = withGlobalCycleDetection<T>(T, named, () {
return _resolveWithLocalDetection<T>(named: named, params: params);
});
} catch (e, s) {
observer.onError(
'Global cycle detection failed during resolve: $T',
e,
s,
);
rethrow;
}
} else {
throw StateError(
'Can\'t resolve dependency `$T`. Maybe you forget register it?');
try {
result = _resolveWithLocalDetection<T>(named: named, params: params);
} catch (e, s) {
observer.onError(
'Failed to resolve: $T',
e,
s,
);
rethrow;
}
}
_trackDisposable(result);
return result;
}
/// RU: Возвращает найденную зависимость типа [T] или null, если она не может быть найдена.
/// ENG: Returns found dependency of type [T] or null if it cannot be found.
/// Resolves [T] using the local cycle detector for this scope.
/// Throws [StateError] if not found or cycle is detected.
/// Used internally by [resolve].
T _resolveWithLocalDetection<T>({String? named, dynamic params}) {
return withCycleDetection<T>(T, named, () {
var resolved = _tryResolveInternal<T>(named: named, params: params);
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;
} else {
observer.onError(
'Failed to resolve: $T',
null,
null,
);
throw StateError(
'Can\'t resolve dependency `$T`. Maybe you forget register it?');
}
});
}
/// Attempts to resolve a dependency of type [T], optionally by name and with params.
///
/// 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}) {
// 1 Поиск зависимости по всем модулям текущего скоупа
if (_modulesList.isNotEmpty) {
for (var module in _modulesList) {
for (var binding in module.bindingSet) {
if (binding.key == T &&
((!binding.isNamed && named == null) ||
(binding.isNamed && named == binding.name))) {
switch (binding.mode) {
case Mode.instance:
return binding.instance;
case Mode.providerInstance:
return binding.provider;
case Mode.providerInstanceWithParams:
if (params == null) {
throw StateError('Param is null. Maybe you forget pass it');
}
return binding.providerWithParams(params);
default:
return null;
}
}
}
}
}
// 2 Поиск зависимостей в родительском скоупе
return _parentScope?.tryResolve(named: named, params: params);
}
/// RU: Асинхронно возвращает найденную зависимость, определенную параметром типа [T].
/// Выдает [StateError], если зависимость не может быть разрешена.
/// Если хотите получить [null], если зависимость не может быть найдена, используйте [tryResolveAsync].
/// return - возвращает объект типа [T] or [StateError]
///
/// 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]
///
Future<T> resolveAsync<T>({String? named, dynamic params}) async {
var resolved = await tryResolveAsync<T>(named: named, params: params);
if (resolved != null) {
return resolved;
T? result;
if (isGlobalCycleDetectionEnabled) {
result = withGlobalCycleDetection<T?>(T, named, () {
return _tryResolveWithLocalDetection<T>(named: named, params: params);
});
} else {
throw StateError(
'Can\'t resolve async dependency `$T`. Maybe you forget register it?');
result = _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.
/// Used internally by [tryResolve].
T? _tryResolveWithLocalDetection<T>({String? named, dynamic params}) {
if (isCycleDetectionEnabled) {
return withCycleDetection<T?>(T, named, () {
return _tryResolveInternal<T>(named: named, params: params);
});
} else {
return _tryResolveInternal<T>(named: named, params: params);
}
}
/// Locates and resolves [T] without cycle detection (direct lookup).
/// Returns null if not found. Used internally.
T? _tryResolveInternal<T>({String? named, dynamic params}) {
final resolver = _findBindingResolver<T>(named);
// 1 - Try from own modules; 2 - Fallback to parent
return resolver?.resolveSync(params) ??
_parentScope?.tryResolve(named: named, params: params);
}
/// Asynchronously resolves a dependency of type [T].
///
/// Throws [StateError] if not found. (Use [tryResolveAsync] for a fallible async resolve.)
///
/// 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 {
T result;
if (isGlobalCycleDetectionEnabled) {
result = await withGlobalCycleDetection<Future<T>>(T, named, () async {
return await _resolveAsyncWithLocalDetection<T>(
named: named, params: params);
});
} else {
result = await _resolveAsyncWithLocalDetection<T>(
named: named, params: params);
}
_trackDisposable(result);
return result;
}
/// Resolves [T] asynchronously using local cycle detector. Throws if not found.
/// Internal implementation for async [resolveAsync].
Future<T> _resolveAsyncWithLocalDetection<T>(
{String? named, dynamic params}) async {
return withCycleDetection<Future<T>>(T, named, () async {
var resolved =
await _tryResolveAsyncInternal<T>(named: named, params: params);
if (resolved != null) {
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;
} else {
observer.onError(
'Failed to async resolve: $T',
null,
null,
);
throw StateError(
'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 {
if (_modulesList.isNotEmpty) {
for (var module in _modulesList) {
for (var binding in module.bindingSet) {
if (binding.key == T &&
((!binding.isNamed && named == null) ||
(binding.isNamed && named == binding.name))) {
if (binding.instanceAsync != null) {
return await binding.instanceAsync;
}
T? result;
if (isGlobalCycleDetectionEnabled) {
result = await withGlobalCycleDetection<Future<T?>>(T, named, () async {
return await _tryResolveAsyncWithLocalDetection<T>(
named: named, params: params);
});
} else {
result = await _tryResolveAsyncWithLocalDetection<T>(
named: named, params: params);
}
if (result != null) _trackDisposable(result);
return result;
}
if (binding.asyncProvider != null) {
return await binding.asyncProvider?.call();
}
/// Attempts to resolve [T] asynchronously using local cycle detector. Returns null if missing.
/// Internal implementation for async [tryResolveAsync].
Future<T?> _tryResolveAsyncWithLocalDetection<T>(
{String? named, dynamic params}) async {
if (isCycleDetectionEnabled) {
return withCycleDetection<Future<T?>>(T, named, () async {
return await _tryResolveAsyncInternal<T>(named: named, params: params);
});
} else {
return await _tryResolveAsyncInternal<T>(named: named, params: params);
}
}
if (binding.asyncProviderWithParams != null) {
if (params == null) {
throw StateError('Param is null. Maybe you forget pass it');
}
return await binding.asyncProviderWithParams!(params);
}
}
}
/// Direct async resolution for [T] without cycle check. Returns null if missing. Internal use only.
Future<T?> _tryResolveAsyncInternal<T>(
{String? named, dynamic params}) async {
final resolver = _findBindingResolver<T>(named);
// 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 binding in module.bindingSet) {
_bindingResolvers.putIfAbsent(binding.key, () => {});
final nameKey = binding.isNamed ? binding.name : null;
_bindingResolvers[binding.key]![nameKey] = binding.resolver!;
}
}
return _parentScope?.tryResolveAsync(named: named, params: params);
}
/// Tracks resolved [Disposable] instances, to ensure dispose is called automatically.
/// Internal use only.
void _trackDisposable(Object? obj) {
if (obj is Disposable && !_disposables.contains(obj)) {
_disposables.add(obj);
}
}
/// Asynchronously disposes this [Scope], all tracked [Disposable] objects, and recursively
/// all its child subscopes.
///
/// 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 {
// First dispose children scopes
for (final subScope in _scopeMap.values) {
await subScope.dispose();
}
_scopeMap.clear();
// Then dispose own disposables
for (final d in _disposables) {
try {
await d.dispose();
} catch (_) {}
}
_disposables.clear();
}
}

View File

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

View File

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

View File

@@ -0,0 +1,49 @@
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}) {}
}

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,76 +1,193 @@
import 'package:cherrypick/src/module.dart';
import 'package:cherrypick/src/scope.dart';
import 'package:cherrypick/cherrypick.dart'
show Disposable, Module, Scope, CherryPick;
import 'dart:async';
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() {
// --------------------------------------------------------------------------
group('Scope & Subscope Management', () {
test('Scope has no parent if constructed with null', () {
final scope = Scope(null);
final observer = MockObserver();
final scope = Scope(null, observer: observer);
expect(scope.parentScope, null);
});
test('Can open and retrieve the same subScope by key', () {
final scope = Scope(null);
final subScope = scope.openSubScope('subScope');
expect(scope.openSubScope('subScope'), subScope);
final observer = MockObserver();
final scope = Scope(null, observer: observer);
expect(Scope(scope, observer: observer), isNotNull); // эквивалент
});
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', () {
final scope = Scope(null);
final subScope = scope.openSubScope("child");
expect(scope.openSubScope("child"), same(subScope));
scope.closeSubScope("child");
final newSubScope = scope.openSubScope("child");
expect(newSubScope, isNot(same(subScope)));
final observer = MockObserver();
final scope = Scope(null, observer: observer);
expect(Scope(scope, observer: observer), isNotNull); // эквивалент
// Нет необходимости тестировать open/closeSubScope в этом юните
});
});
// --------------------------------------------------------------------------
group('Dependency Resolution (standard)', () {
test("Throws StateError if value can't be resolved", () {
final scope = Scope(null);
final observer = MockObserver();
final scope = Scope(null, observer: observer);
expect(() => scope.resolve<String>(), throwsA(isA<StateError>()));
});
test('Resolves value after adding a dependency', () {
final observer = MockObserver();
final expectedValue = 'test string';
final scope = Scope(null)
final scope = Scope(null, observer: observer)
.installModules([TestModule<String>(value: expectedValue)]);
expect(scope.resolve<String>(), expectedValue);
});
test('Returns a value from parent scope', () {
final observer = MockObserver();
final expectedValue = 5;
final parentScope = Scope(null);
final scope = Scope(parentScope);
final parentScope = Scope(null, observer: observer);
final scope = Scope(parentScope, observer: observer);
parentScope.installModules([TestModule<int>(value: expectedValue)]);
expect(scope.resolve<int>(), expectedValue);
});
test('Returns several values from parent container', () {
final observer = MockObserver();
final expectedIntValue = 5;
final expectedStringValue = 'Hello world';
final parentScope = Scope(null).installModules([
final parentScope = Scope(null, observer: observer).installModules([
TestModule<int>(value: expectedIntValue),
TestModule<String>(value: expectedStringValue)
]);
final scope = Scope(parentScope);
final scope = Scope(parentScope, observer: observer);
expect(scope.resolve<int>(), expectedIntValue);
expect(scope.resolve<String>(), expectedStringValue);
});
test("Throws StateError if parent hasn't value too", () {
final parentScope = Scope(null);
final scope = Scope(parentScope);
final observer = MockObserver();
final parentScope = Scope(null, observer: observer);
final scope = Scope(parentScope, observer: observer);
expect(() => scope.resolve<int>(), throwsA(isA<StateError>()));
});
test("After dropModules resolves fail", () {
final scope = Scope(null)..installModules([TestModule<int>(value: 5)]);
final observer = MockObserver();
final scope = Scope(null, observer: observer)
..installModules([TestModule<int>(value: 5)]);
expect(scope.resolve<int>(), 5);
scope.dropModules();
expect(() => scope.resolve<int>(), throwsA(isA<StateError>()));
@@ -80,7 +197,8 @@ void main() {
// --------------------------------------------------------------------------
group('Named Dependencies', () {
test('Resolve named binding', () {
final scope = Scope(null)
final observer = MockObserver();
final scope = Scope(null, observer: observer)
..installModules([
TestModule<String>(value: "first"),
TestModule<String>(value: "second", name: "special")
@@ -88,18 +206,18 @@ void main() {
expect(scope.resolve<String>(named: "special"), "second");
expect(scope.resolve<String>(), "first");
});
test('Named binding does not clash with unnamed', () {
final scope = Scope(null)
final observer = MockObserver();
final scope = Scope(null, observer: observer)
..installModules([
TestModule<String>(value: "foo", name: "bar"),
]);
expect(() => scope.resolve<String>(), throwsA(isA<StateError>()));
expect(scope.resolve<String>(named: "bar"), "foo");
});
test("tryResolve returns null for missing named", () {
final scope = Scope(null)
final observer = MockObserver();
final scope = Scope(null, observer: observer)
..installModules([
TestModule<String>(value: "foo"),
]);
@@ -110,7 +228,8 @@ void main() {
// --------------------------------------------------------------------------
group('Provider with parameters', () {
test('Resolve dependency using providerWithParams', () {
final scope = Scope(null)
final observer = MockObserver();
final scope = Scope(null, observer: observer)
..installModules([
_InlineModule((m, s) {
m.bind<int>().toProvideWithParams((param) => (param as int) * 2);
@@ -124,38 +243,39 @@ void main() {
// --------------------------------------------------------------------------
group('Async Resolution', () {
test('Resolve async instance', () async {
final scope = Scope(null)
final observer = MockObserver();
final scope = Scope(null, observer: observer)
..installModules([
_InlineModule((m, s) {
m.bind<String>().toInstanceAsync(Future.value('async value'));
m.bind<String>().toInstance(Future.value('async value'));
}),
]);
expect(await scope.resolveAsync<String>(), "async value");
});
test('Resolve async provider', () async {
final scope = Scope(null)
final observer = MockObserver();
final scope = Scope(null, observer: observer)
..installModules([
_InlineModule((m, s) {
m.bind<int>().toProvideAsync(() async => 7);
m.bind<int>().toProvide(() async => 7);
}),
]);
expect(await scope.resolveAsync<int>(), 7);
});
test('Resolve async provider with param', () async {
final scope = Scope(null)
final observer = MockObserver();
final scope = Scope(null, observer: observer)
..installModules([
_InlineModule((m, s) {
m.bind<int>().toProvideAsyncWithParams((x) async => (x as int) * 3);
m.bind<int>().toProvideWithParams((x) async => (x as int) * 3);
}),
]);
expect(await scope.resolveAsync<int>(params: 2), 6);
expect(() => scope.resolveAsync<int>(), throwsA(isA<StateError>()));
});
test('tryResolveAsync returns null for missing', () async {
final scope = Scope(null);
final observer = MockObserver();
final scope = Scope(null, observer: observer);
final result = await scope.tryResolveAsync<String>();
expect(result, isNull);
});
@@ -164,45 +284,102 @@ void main() {
// --------------------------------------------------------------------------
group('Optional resolution and error handling', () {
test("tryResolve returns null for missing dependency", () {
final scope = Scope(null);
final observer = MockObserver();
final scope = Scope(null, observer: observer);
expect(scope.tryResolve<int>(), isNull);
});
});
// Не реализован:
// test("Container bind() throws state error (if it's parent already has a resolver)", () {
// final parentScope = new Scope(null).installModules([TestModule<String>(value: "string one")]);
// final scope = new Scope(parentScope);
// --------------------------------------------------------------------------
group('Disposable resource management', () {
test('scope.disposeAsync calls dispose on singleton disposable', () async {
final scope = CherryPick.openRootScope();
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(
// () => scope.installModules([TestModule<String>(value: "string two")]),
// throwsA(isA<StateError>()));
// });
// --------------------------------------------------------------------------
// Расширенные edge-тесты для dispose и subScope
group('Scope/subScope dispose edge cases', () {
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);
}

View File

@@ -23,4 +23,6 @@ doc/api/
# FVM Version Cache
.fvm/
melos_cherrypick_annotations.iml
melos_cherrypick_annotations.iml
pubspec_overrides.yaml

View File

@@ -1,3 +1,11 @@
## 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
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.

View File

@@ -192,7 +192,7 @@
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
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,

View File

@@ -12,6 +12,9 @@
# The core lints are also what is used by pub.dev for scoring packages.
include: package:lints/recommended.yaml
analyzer:
errors:
camel_case_types: ignore
# Uncomment the following section to specify additional rules.

View File

@@ -5,7 +5,7 @@ library;
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -13,22 +13,30 @@
import 'package:meta/meta.dart';
/// Annotation for field injection in CherryPick DI framework.
/// Apply this to a field, and the code generator will automatically inject
/// the appropriate dependency into it.
/// Marks a field for dependency injection by CherryPick's code generator.
///
/// ---
/// 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()`.
///
/// Аннотация для внедрения зависимости в поле через фреймворк CherryPick DI.
/// Поместите её на поле класса — генератор кода автоматически подставит нужную зависимость.
///
/// Example / Пример:
/// Example:
/// ```dart
/// @inject()
/// late final SomeService service;
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
///
/// @injectable()
/// class LoginScreen with _\$LoginScreen {
/// @inject()
/// late final AuthService authService;
///
/// @inject()
/// @named('main')
/// late final ApiClient api;
/// }
///
/// // After running build_runner, call:
/// // LoginScreen().injectFields();
/// ```
@experimental
// ignore: camel_case_types
final class inject {
const inject();
}

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -13,26 +13,31 @@
import 'package:meta/meta.dart';
/// Marks a class as injectable for the CherryPick dependency injection framework.
/// If a class is annotated with [@injectable()], the code generator will
/// create a mixin to perform automatic injection of fields marked with [@inject].
/// Marks a class as injectable, enabling automatic field injection by CherryPick's code generator.
///
/// ---
/// 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.
///
/// Помечает класс как внедряемый для фреймворка внедрения зависимостей CherryPick.
/// Если класс помечен аннотацией [@injectable()], генератор создаст миксин
/// для автоматического внедрения полей, отмеченных [@inject].
///
/// Example / Пример:
/// Example:
/// ```dart
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
///
/// @injectable()
/// class MyWidget extends StatelessWidget {
/// class ProfileScreen with _\$ProfileScreen {
/// @inject()
/// late final MyService service;
/// late final UserManager manager;
///
/// @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
// ignore: camel_case_types
final class injectable {
const injectable();
}

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -11,58 +11,39 @@
// limitations under the License.
//
/// ENGLISH:
/// Annotation to specify that a new instance should be provided on each request.
import 'package:meta/meta.dart';
/// Marks a provider method or class to always create a new instance (factory) in CherryPick DI.
///
/// Use the `@instance()` annotation for methods or classes in your DI module
/// to declare that the DI container must create a new object every time
/// the dependency is injected (i.e., no singleton behavior).
/// Use `@instance()` to annotate methods or classes in your DI module/class
/// when you want a new object to be created on every injection (no singleton caching).
/// The default DI lifecycle is instance/factory unless otherwise specified.
///
/// Example:
/// ### Example (in a module method)
/// ```dart
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
///
/// @module()
/// abstract class AppModule extends Module {
/// abstract class FeatureModule {
/// @instance()
/// Foo foo() => Foo();
/// MyService provideService() => MyService();
///
/// @singleton()
/// Logger provideLogger() => Logger();
/// }
/// ```
///
/// This will generate:
/// ### Example (on a class, with @injectable)
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Foo>().toInstance(() => foo());
/// }
/// @injectable()
/// @instance()
/// class MyFactoryClass {
/// // ...
/// }
/// ```
///
/// RUSSIAN (Русский):
/// Аннотация для создания нового экземпляра при каждом запросе.
///
/// Используйте `@instance()` для методов или классов в DI-модуле,
/// чтобы указать, что контейнер внедрения зависимостей должен создавать
/// новый объект при каждом обращении к зависимости (то есть, не синглтон).
///
/// Пример:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// @instance()
/// Foo foo() => Foo();
/// }
/// ```
///
/// Будет сгенерирован следующий код:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Foo>().toInstance(() => foo());
/// }
/// }
/// ```
// ignore: camel_case_types
/// See also: [@singleton]
@experimental
final class instance {
const instance();
}

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -11,59 +11,40 @@
// limitations under the License.
//
/// ENGLISH:
/// Annotation for marking Dart classes or libraries as modules.
import 'package:meta/meta.dart';
/// Marks an abstract Dart class as a dependency injection module for CherryPick code generation.
///
/// Use the `@module()` annotation on abstract classes (or on a library)
/// to indicate that the class represents a DI (Dependency Injection) module.
/// This is commonly used in code generation tools to automatically register
/// and configure dependencies defined within the module.
/// Use `@module()` on your abstract class to indicate it provides DI bindings (via provider methods).
/// This enables code generation of a concrete module that registers all bindings from your methods.
///
/// Example:
/// Typical usage:
/// ```dart
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
///
/// @module()
/// abstract class AppModule extends Module {
/// // Dependency definitions go here.
/// abstract class AppModule {
/// @singleton()
/// Logger provideLogger() => Logger();
///
/// @named('mock')
/// ApiClient mockApi() => MockApiClient();
/// }
/// ```
///
/// Generates code like:
/// The generated code will look like:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// // Dependency registration...
/// // Dependency registration code...
/// }
/// }
/// ```
///
/// RUSSIAN (Русский):
/// Аннотация для пометки классов или библиотек Dart как модуля.
///
/// Используйте `@module()` для абстрактных классов (или библиотек), чтобы
/// показать, что класс реализует DI-модуль (Dependency Injection).
/// Обычно используется генераторами кода для автоматической регистрации
/// и конфигурирования зависимостей, определённых в модуле.
///
/// Пример:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// // Определения зависимостей
/// }
/// ```
///
/// Будет сгенерирован код:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// // Регистрация зависимостей...
/// }
/// }
/// ```
// ignore: camel_case_types
/// See also: [@provide], [@singleton], [@instance], [@named]
@experimental
final class module {
/// Creates a [module] annotation.
/// Creates a [module] annotation for use on a DI module class.
const module();
}

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -11,67 +11,52 @@
// limitations under the License.
//
/// ENGLISH:
/// Annotation to assign a name or identifier to a class, method, or other element.
import 'package:meta/meta.dart';
/// 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.
///
/// The `@named('value')` annotation allows you to specify a string name
/// for a dependency, factory, or injectable. This is useful for distinguishing
/// between multiple registrations of the same type in dependency injection,
/// code generation, and for providing human-readable metadata.
/// Use `@named('key')` to distinguish between multiple bindings/implementations
/// of the same type—when registering and when injecting dependencies.
///
/// Example:
/// You can use `@named`:
/// - 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
/// @module()
/// abstract class AppModule extends Module {
/// @named('dio')
/// Dio dio() => Dio();
/// abstract class AppModule {
/// @named('main')
/// ApiClient apiClient() => ApiClient();
///
/// @named('mock')
/// ApiClient mockApi() => MockApiClient();
/// }
/// ```
///
/// This will generate:
/// ### Example: On Injectable Field
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Dio>().toProvide(() => dio()).withName('dio').singleton();
/// }
/// @injectable()
/// class WidgetModel with _\$WidgetModel {
/// @inject()
/// @named('main')
/// late final ApiClient api;
/// }
/// ```
///
/// RUSSIAN (Русский):
/// Аннотация для задания имени или идентификатора классу, методу или другому элементу.
///
/// Аннотация `@named('значение')` позволяет указать строковое имя для зависимости,
/// фабрики или внедряемого значения. Это удобно для различения нескольких
/// регистраций одного типа в DI, генерации кода.
///
/// Пример:
/// ### Example: On Parameter
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// @named('dio')
/// Dio dio() => Dio();
/// class UserScreen {
/// UserScreen(@named('current') User user);
/// }
/// ```
///
/// Будет сгенерирован следующий код:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Dio>().toProvide(() => dio()).withName('dio').singleton();
/// }
/// }
/// ```
// ignore: camel_case_types
@experimental
final class named {
/// EN: The assigned name or identifier for the element.
///
/// RU: Назначенное имя или идентификатор для элемента.
/// The assigned name or identifier for the dependency, provider, or parameter.
final String value;
/// EN: Creates a [named] annotation with the given [value].
///
/// RU: Создаёт аннотацию [named] с заданным значением [value].
/// Creates a [named] annotation with the given [value] key or name.
const named(this.value);
}

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -11,46 +11,33 @@
// limitations under the License.
//
/// ENGLISH:
/// Annotation to mark a method parameter for injection with run-time arguments.
import 'package:meta/meta.dart';
/// Marks a parameter in a provider method to receive dynamic runtime arguments when resolving a dependency.
///
/// Use the `@params()` annotation to specify that a particular parameter of a
/// provider method should be assigned a value supplied at resolution time,
/// rather than during static dependency graph creation. This is useful in DI
/// when a dependency must receive dynamic data passed by the consumer
/// (via `.withParams(...)` in the generated code).
/// Use `@params()` in a DI module/factory method when the value must be supplied by the user/code at injection time,
/// not during static wiring (such as user input, navigation arguments, etc).
///
/// This enables CherryPick and its codegen to generate .withParams or .toProvideWithParams bindings — so your provider can access runtime values.
///
/// Example:
/// ```dart
/// @provide()
/// String greet(@params() dynamic params) => 'Hello $params';
/// ```
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
///
/// This will generate:
/// @module()
/// abstract class FeatureModule {
/// @provide
/// UserManager createManager(@params Map<String, dynamic> runtimeParams) {
/// return UserManager.forUserId(runtimeParams['userId']);
/// }
/// }
/// ```
/// Usage at injection/resolution:
/// ```dart
/// bind<String>().toProvideWithParams((args) => greet(args));
/// final manager = scope.resolve<UserManager>(params: {'userId': myId});
/// ```
///
/// RUSSIAN (Русский):
/// Аннотация для пометки параметра метода, который будет внедряться со значением во время выполнения.
///
/// Используйте `@params()` чтобы указать, что конкретный параметр метода-провайдера
/// должен получать значение, передаваемое в момент обращения к зависимости,
/// а не на этапе построения графа зависимостей. Это полезно, если зависимость
/// должна получать данные динамически от пользователя или другого процесса
/// через `.withParams(...)` в сгенерированном коде.
///
/// Пример:
/// ```dart
/// @provide()
/// String greet(@params() dynamic params) => 'Hello $params';
/// ```
///
/// Будет сгенерировано:
/// ```dart
/// bind<String>().toProvideWithParams((args) => greet(args));
/// ```
// ignore: camel_case_types
@experimental
final class params {
/// Marks a method/constructor parameter as supplied at runtime by the caller.
const params();
}

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -11,60 +11,34 @@
// limitations under the License.
//
/// ENGLISH:
/// Annotation to declare a factory/provider method or class as a singleton.
import 'package:meta/meta.dart';
/// Marks a method or class as a dependency provider (factory/provider) for CherryPick module code generation.
///
/// Use the `@singleton()` annotation on methods in your DI module to specify
/// that only one instance of the resulting object should be created and shared
/// for all consumers. This is especially useful in dependency injection
/// frameworks and service locators.
/// Use `@provide` on any method inside a `@module()` annotated class when you want that method
/// to be used as a DI factory/provider during code generation.
///
/// This should be used for methods that create dynamic, optional, or complex dependencies, especially
/// if you want to control the codegen/injection pipeline explicitly and support parameters.
///
/// Example:
/// ```dart
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
///
/// @module()
/// abstract class AppModule extends Module {
/// abstract class FeatureModule {
/// @provide
/// Future<Api> provideApi(@params Map<String, dynamic> args) async => ...;
///
/// @singleton()
/// Dio dio() => Dio();
/// @provide
/// Logger provideLogger() => Logger();
/// }
/// ```
///
/// This generates the following code:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Dio>().toProvide(() => dio()).singleton();
/// }
/// }
/// ```
///
/// RUSSIAN (Русский):
/// Аннотация для объявления фабричного/провайдерного метода или класса синглтоном.
///
/// Используйте `@singleton()` для методов внутри DI-модуля, чтобы указать,
/// что соответствующий объект (экземпляр класса) должен быть создан только один раз
/// и использоваться всеми компонентами приложения (единый общий экземпляр).
/// Это характерно для систем внедрения зависимостей и сервис-локаторов.
///
/// Пример:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// @singleton()
/// Dio dio() => Dio();
/// }
/// ```
///
/// Будет сгенерирован следующий код:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Dio>().toProvide(() => dio()).singleton();
/// }
/// }
/// ```
// ignore: camel_case_types
/// See also: [@singleton], [@instance], [@params], [@named]
@experimental
final class provide {
/// Creates a [provide] annotation.
const provide();
}

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -13,25 +13,41 @@
import 'package:meta/meta.dart';
/// Annotation to specify a scope for dependency injection in CherryPick.
/// Use this on an injected field to indicate from which scope
/// the dependency must be resolved.
/// Specifies the DI scope or region from which a dependency should 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.
///
/// Аннотация для указания области внедрения (scope) в CherryPick.
/// Используйте её на инъецируемом поле, чтобы определить из какой области
/// должна быть получена зависимость.
/// Useful for advanced DI scenarios: multi-feature/state isolation, navigation stacks, explicit subscopes, or testing.
///
/// Example / Пример:
/// Example (injected field):
/// ```dart
/// @inject()
/// @scope('profile')
/// late final ProfileManager profileManager;
/// @injectable()
/// class ProfileScreen with _\$ProfileScreen {
/// @inject()
/// @scope('profile')
/// late final ProfileManager manager;
/// }
/// ```
///
/// 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
// ignore: camel_case_types
final class scope {
/// The name/key of the DI scope from which to resolve this dependency.
final String? name;
const scope(this.name);
}

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -11,63 +11,32 @@
// limitations under the License.
//
/// ENGLISH:
/// Annotation to declare a dependency as a singleton.
import 'package:meta/meta.dart';
/// Marks a provider method or class so its instance is created only once and shared (singleton) for DI in CherryPick.
///
/// Use the `@singleton()` annotation on provider methods inside a module
/// to indicate that only a single instance of this dependency should be
/// created and shared throughout the application's lifecycle. This is
/// typically used in dependency injection frameworks or service locators
/// to guarantee a single shared instance.
/// Use `@singleton()` on provider methods or classes in your DI module to ensure only one instance is ever created
/// and reused across the application's lifetime (or scope lifetime).
///
/// Example:
/// ```dart
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
///
/// @module()
/// abstract class AppModule extends Module {
/// abstract class AppModule {
/// @singleton()
/// Dio dio() => Dio();
/// ApiClient createApi() => ApiClient();
/// }
/// ```
///
/// This will generate code like:
/// The generated code will ensure:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Dio>().toProvide(() => dio()).singleton();
/// }
/// }
/// bind<ApiClient>().toProvide(() => createApi()).singleton();
/// ```
///
/// RUSSIAN (Русский):
/// Аннотация для объявления зависимости как синглтона.
///
/// Используйте `@singleton()` для методов-провайдеров внутри модуля,
/// чтобы указать, что соответствующий объект должен быть создан
/// единожды и использоваться во всём приложении (общий синглтон).
/// Это характерно для систем внедрения зависимостей и сервис-локаторов,
/// чтобы гарантировать один общий экземпляр.
///
/// Пример:
/// ```dart
/// @module()
/// abstract class AppModule extends Module {
/// @singleton()
/// Dio dio() => Dio();
/// }
/// ```
///
/// Будет сгенерирован следующий код:
/// ```dart
/// final class $AppModule extends AppModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Dio>().toProvide(() => dio()).singleton();
/// }
/// }
/// ```
// ignore: camel_case_types
/// See also: [@instance], [@provide], [@named]
@experimental
final class singleton {
/// Creates a [singleton] annotation.
/// Creates a [singleton] annotation for DI providers/classes.
const singleton();
}

View File

@@ -1,10 +1,16 @@
name: cherrypick_annotations
description: |
Set of annotations for CherryPick dependency injection library. Enables code generation and declarative DI for Dart & Flutter projects.
version: 1.1.0
version: 1.1.2-dev.0
documentation: https://github.com/pese-git/cherrypick/wiki
repository: https://github.com/pese-git/cherrypick/cherrypick_annotations
issue_tracker: https://github.com/pese-git/cherrypick/issues
topics:
- di
- ioc
- dependency-injection
- dependency-management
- inversion-of-control
environment:
sdk: ">=3.5.2 <4.0.0"

View File

@@ -1,3 +1,43 @@
## 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
- Update a dependency to the latest release.
## 1.1.3-dev.0
- **FIX**: update deps.
## 1.1.2
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.

View File

@@ -192,7 +192,7 @@
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
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,

View File

@@ -94,4 +94,4 @@ Contributions to improve this library are welcome. Feel free to open issues and
## License
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).
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).

View File

@@ -4,7 +4,7 @@ library;
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.

View File

@@ -6,7 +6,7 @@ import 'package:flutter/widgets.dart';
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
/// http://www.apache.org/licenses/LICENSE-2.0
/// 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.
@@ -14,29 +14,87 @@ import 'package:flutter/widgets.dart';
/// 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 {
/// 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();
/// 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 = '.'}) =>
CherryPick.openScope(scopeName: scopeName, separator: separator);
// Constructor for CherryPickProvider. Initializes with a required rootScope and child widget.
/// Creates a [CherryPickProvider] and exposes it to the widget subtree.
///
/// Place near the root of your widget tree. Use [child] to provide the subtree.
const CherryPickProvider({
super.key,
required super.child,
});
// Method to access the nearest CherryPickProvider instance from the context
/// Locates the nearest [CherryPickProvider] up the widget tree from [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) {
// Looks up the widget tree for an instance of CherryPickProvider
final CherryPickProvider? result =
context.dependOnInheritedWidgetOfExactType<CherryPickProvider>();
// Assert to ensure a CherryPickProvider is present in the context
assert(result != null, 'No CherryPickProvider found in context');
return result!;
}
// Determines whether the widget should notify dependents when it changes
/// Controls update notifications for dependent widgets.
///
/// Always returns false because the provider itself is stateless:
/// changes are to the underlying scopes, not the widget.
@override
bool updateShouldNotify(CherryPickProvider oldWidget) {
return false;

View File

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

View File

@@ -27,4 +27,6 @@ melos_cherrypick_generator.iml
**/*.mocks.dart
coverage
coverage
pubspec_overrides.yaml

View File

@@ -1,3 +1,13 @@
## 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
- Graduate package to a stable release. See pre-releases prior to this version for changelog entries.

View File

@@ -192,7 +192,7 @@
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
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,

View File

@@ -1,17 +1,37 @@
library;
//
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
//
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 'inject_generator.dart';

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -20,28 +20,85 @@ import 'package:source_gen/source_gen.dart';
import 'package:analyzer/dart/element/element.dart';
import 'package:cherrypick_annotations/cherrypick_annotations.dart' as ann;
/// InjectGenerator generates a mixin for a class marked with @injectable()
/// and injects all fields annotated with @inject(), using CherryPick DI.
/// CherryPick DI field injector generator for codegen.
///
/// For Future<T> fields it calls .resolveAsync<T>(),
/// otherwise .resolve<T>() is used. Scope and named qualifiers are supported.
/// Analyzes all Dart classes marked with `@injectable()` and generates a mixin (for example, `_$ProfileScreen`)
/// which contains the `_inject` method. This method will assign all fields annotated with `@inject()`
/// 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.
///
/// ---
///
/// InjectGenerator генерирует миксин для класса с аннотацией @injectable()
/// и внедряет все поля, помеченные @inject(), используя DI-фреймворк CherryPick.
/// ### Example usage in a project:
///
/// Для Future<T> полей вызывается .resolveAsync<T>(),
/// для остальных — .resolve<T>(). Поддерживаются scope и named qualifier.
/// ```dart
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
///
/// @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> {
const InjectGenerator();
/// The main entry point for code generation.
/// Main entry point for CherryPick field injection code generation.
///
/// Checks class validity, collects injectable fields, and produces injection code.
/// - Only triggers for classes marked with `@injectable()`.
/// - 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
FutureOr<String> generateForAnnotatedElement(
Element element,
@@ -63,8 +120,7 @@ class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
..writeln('mixin $mixinName {')
..writeln(' void _inject($className instance) {');
// Collect and process all @inject fields.
// Собираем и обрабатываем все поля с @inject.
// Collect and process all @inject fields
final injectFields =
classElement.fields.where(_isInjectField).map(_parseInjectField);
@@ -79,20 +135,20 @@ class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
return buffer.toString();
}
/// Checks if a field has the @inject annotation.
/// Returns true if a field is annotated with `@inject`.
///
/// Проверяет, отмечено ли поле аннотацией @inject.
/// Used to detect which fields should be processed for injection.
static bool _isInjectField(FieldElement field) {
return field.metadata.any(
(m) => m.computeConstantValue()?.type?.getDisplayString() == 'inject',
);
}
/// Parses the field for scope/named qualifiers and determines its type.
/// Returns a [_ParsedInjectField] describing injection information.
/// Parses `@inject()` field and extracts all injection metadata
/// (core type, qualifiers, scope, nullability, etc).
///
/// Разбирает поле на наличие модификаторов scope/named и выясняет его тип.
/// Возвращает [_ParsedInjectField] с информацией о внедрении.
/// Converts Dart field declaration and all parameterizing injection-related
/// annotations into a [_ParsedInjectField] which is used for codegen.
static _ParsedInjectField _parseInjectField(FieldElement field) {
String? scopeName;
String? namedValue;
@@ -120,8 +176,7 @@ class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
isFuture = false;
}
// ***
// Добавим определение nullable для типа (например PostRepository? или Future<PostRepository?>)
// Determine nullability for field types like T? or Future<T?>
bool isNullable = dartType.nullabilitySuffix ==
NullabilitySuffix.question ||
(dartType is ParameterizedType &&
@@ -139,13 +194,17 @@ class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
);
}
/// Generates a line of code that performs the dependency injection for a field.
/// Handles resolve/resolveAsync, scoping, and named qualifiers.
/// Generates Dart code for a single dependency-injected field based on its metadata.
///
/// Генерирует строку кода, которая внедряет зависимость для поля.
/// Учитывает resolve/resolveAsync, scoping и named qualifier.
/// 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,
/// 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) {
// Используем tryResolve для nullable, иначе resolve
final resolveMethod = field.isFuture
? (field.isNullable
? 'tryResolveAsync<${field.coreType}>'
@@ -166,30 +225,29 @@ class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
}
}
/// Data structure representing all information required to generate
/// injection code for a field.
/// Internal structure: describes all required information for generating the injection
/// assignment for a given field.
///
/// Структура данных, содержащая всю информацию,
/// необходимую для генерации кода внедрения для поля.
/// Not exported. Used as a DTO in the generator for each field.
class _ParsedInjectField {
/// The name of the field / Имя поля.
/// The name of the field to be injected.
final String fieldName;
/// The base type name (T or Future<T>) / Базовый тип (T или тип из Future<T>).
/// The Dart type to resolve (e.g. `Logger` from `Logger` or `Future<Logger>`).
final String coreType;
/// True if the field type is Future<T>; false otherwise
/// Истина, если поле — Future<T>, иначе — ложь.
/// True if the field is an async dependency (Future<...>), otherwise false.
final bool isFuture;
/// Optional scope annotation argument / Опциональное имя scope.
/// True if the field accepts null (T?), otherwise false.
final bool isNullable;
/// The scoping for DI resolution, or null to use root scope.
final String? scopeName;
/// Optional named annotation argument / Опциональное имя named.
/// Name qualifier for named resolution, or null if not set.
final String? namedValue;
final bool isNullable;
_ParsedInjectField({
required this.fieldName,
required this.coreType,
@@ -200,8 +258,8 @@ class _ParsedInjectField {
});
}
/// Builder factory. Used by build_runner.
/// Factory for creating the build_runner builder for DI field injection.
///
/// Фабрика билдера. Используется build_runner.
/// Add this builder in your build.yaml if you're invoking CherryPick generators manually.
Builder injectBuilder(BuilderOptions options) =>
PartBuilder([InjectGenerator()], '.inject.cherrypick.g.dart');

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -19,75 +19,89 @@ import 'package:cherrypick_annotations/cherrypick_annotations.dart' as ann;
import 'src/generated_class.dart';
/// ---------------------------------------------------------------------------
/// ModuleGenerator for code generation of dependency-injected modules.
/// CherryPick Module Generator — Codegen for DI modules
///
/// ENGLISH
/// This generator scans for Dart classes annotated with `@module()` and
/// automatically generates boilerplate code for dependency injection
/// (DI) based on the public methods in those classes. Each method can be
/// annotated to describe how an object should be provided to the DI container.
/// The generated code registers those methods as bindings. This automates the
/// creation of factories, singletons, and named instances, reducing repetitive
/// manual code.
/// This generator scans Dart classes annotated with `@module()` and generates
/// boilerplate for dependency injection registration automatically. Each public
/// method in such classes can be annotated to describe how an object should be
/// bound to the DI container (singleton, factory, named, with parameters, etc).
///
/// RUSSIAN
/// Генератор зависимостей для DI-контейнера на основе аннотаций.
/// Данный генератор автоматически создаёт код для внедрения зависимостей (DI)
/// на основе аннотаций в вашем исходном коде. Когда вы отмечаете класс
/// аннотацией `@module()`, этот генератор обработает все его публичные методы
/// и автоматически сгенерирует класс с биндингами (регистрациями зависимостей)
/// для DI-контейнера. Это избавляет от написания однообразного шаблонного кода.
/// The generated code collects all such bind methods and produces a Dart
/// companion *module registration class* with a `.bindAll()` method, which you
/// can use from your DI root to automatically register those dependencies.
///
/// ## Example
/// ```dart
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
///
/// @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> {
/// -------------------------------------------------------------------------
/// 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.
/// Generates Dart source for a class marked with the `@module()` annotation.
///
/// RUSSIAN
/// Генерирует исходный код для класса-модуля с аннотацией `@module()`.
/// [element] — исходный класс, помеченный аннотацией.
/// [annotation] — значения параметров аннотации.
/// [buildStep] — информация о текущем шаге генерации.
/// -------------------------------------------------------------------------
/// Throws [InvalidGenerationSourceError] if used on anything except a class.
///
/// See file-level docs for usage and generated output example.
@override
String generateForAnnotatedElement(
Element element,
ConstantReader annotation,
BuildStep buildStep,
) {
// Only classes are supported for @module() annotation
// Обрабатываются только классы (другие элементы — ошибка)
if (element is! ClassElement) {
throw InvalidGenerationSourceError(
'@module() can only be applied to classes. / @module() может быть применён только к классам.',
'@module() can only be applied to classes.',
element: element,
);
}
final classElement = element;
// Build a representation of the generated bindings based on class methods /
// Создаёт объект, описывающий, какие биндинги нужно сгенерировать на основании методов класса
final generatedClass = GeneratedClass.fromClassElement(classElement);
// Generate the resulting Dart code / Генерирует итоговый Dart-код
return generatedClass.generate();
}
}
/// ---------------------------------------------------------------------------
/// ENGLISH
/// Entry point for build_runner. Returns a Builder used to generate code for
/// every file with a @module() annotation.
/// Codegen builder entry point: register this builder in build.yaml or your package.
///
/// RUSSIAN
/// Точка входа для генератора build_runner.
/// Возвращает Builder, используемый build_runner для генерации кода для всех
/// файлов, где встречается @module().
/// Used by build_runner. Generates .module.cherrypick.g.dart files for each
/// source file with an annotated @module() class.
/// ---------------------------------------------------------------------------
Builder moduleBuilder(BuilderOptions options) =>
PartBuilder([ModuleGenerator()], '.module.cherrypick.g.dart');

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -15,9 +15,43 @@ import 'package:analyzer/dart/element/element.dart';
import 'exceptions.dart';
import 'metadata_utils.dart';
/// Validates annotation combinations and usage patterns
/// Provides static utility methods for validating annotation usage in CherryPick
/// 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 {
/// Validates annotations on a method element
/// Validates annotations for a given [MethodElement].
///
/// 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) {
final annotations = _getAnnotationNames(method.metadata);
@@ -26,14 +60,28 @@ class AnnotationValidator {
_validateAnnotationParameters(method);
}
/// Validates annotations on a field element
/// Validates that a [FieldElement] has correct injection annotations.
///
/// 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) {
final annotations = _getAnnotationNames(field.metadata);
_validateInjectFieldAnnotations(field, annotations);
}
/// Validates annotations on a class element
/// Validates all class-level DI annotations.
///
/// 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) {
final annotations = _getAnnotationNames(classElement.metadata);
@@ -41,6 +89,9 @@ class AnnotationValidator {
_validateInjectableClassAnnotations(classElement, annotations);
}
// --- Internal helpers follow (private) ---
/// Helper: Returns the names of all annotation types on `metadata`.
static List<String> _getAnnotationNames(List<ElementAnnotation> metadata) {
return metadata
.map((m) => m.computeConstantValue()?.type?.getDisplayString())
@@ -49,6 +100,9 @@ class AnnotationValidator {
.toList();
}
/// Validates that mutually exclusive method annotations are not used together.
///
/// For example, `@instance` and `@provide` cannot both be present.
static void _validateMutuallyExclusiveAnnotations(
MethodElement method,
List<String> annotations,
@@ -68,6 +122,10 @@ 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(
MethodElement method,
List<String> annotations,
@@ -105,6 +163,7 @@ class AnnotationValidator {
}
}
/// Singleton-specific method annotation checks.
static void _validateSingletonUsage(
MethodElement method,
List<String> annotations,
@@ -130,6 +189,7 @@ class AnnotationValidator {
}
}
/// Validates extra requirements or syntactic rules for annotation arguments, like @named.
static void _validateAnnotationParameters(MethodElement method) {
// Validate @named annotation parameters
final namedValue = MetadataUtils.getNamedValue(method.metadata);
@@ -170,11 +230,11 @@ class AnnotationValidator {
}
}
/// Checks that @params is used with compatible parameter type.
static void _validateParamsParameter(
ParameterElement param, MethodElement method) {
// @params parameter should typically be dynamic or Map<String, dynamic>
final paramType = param.type.getDisplayString();
if (paramType != 'dynamic' &&
paramType != 'Map<String, dynamic>' &&
paramType != 'Map<String, dynamic>?') {
@@ -194,6 +254,7 @@ class AnnotationValidator {
}
}
/// Checks field-level annotation for valid injectable fields.
static void _validateInjectFieldAnnotations(
FieldElement field,
List<String> annotations,
@@ -227,6 +288,7 @@ class AnnotationValidator {
}
}
/// Checks @module usage: must have at least one DI method, each with DI-annotation.
static void _validateModuleClassAnnotations(
ClassElement classElement,
List<String> annotations,
@@ -268,6 +330,7 @@ class AnnotationValidator {
}
}
/// Checks @injectable usage on classes and their fields.
static void _validateInjectableClassAnnotations(
ClassElement classElement,
List<String> annotations,

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -12,57 +12,59 @@
//
/// ----------------------------------------------------------------------------
/// BindParameterSpec - describes a single method parameter and how to resolve it.
/// BindParameterSpec
///
/// ENGLISH
/// Describes a single parameter for a provider/binding method in the DI system.
/// Stores the parameter type, its optional `@named` key for named resolution,
/// and whether it is a runtime "params" argument. Used to generate code that
/// resolves dependencies from the DI scope:
/// - If the parameter is a dependency type (e.g. SomeDep), emits:
/// currentScope.resolve<SomeDep>()
/// - If the parameter is named, emits:
/// currentScope.resolve<SomeDep>(named: 'yourName')
/// - If it's a runtime parameter (e.g. via @params()), emits:
/// args
/// Describes a single parameter for a DI provider/factory/binding method,
/// specifying how that parameter is to be resolved in generated code.
///
/// RUSSIAN
/// Описывает один параметр метода в DI, и его способ разрешения из контейнера.
/// Сохраняет имя типа, дополнительное имя (если параметр аннотирован через @named),
/// и признак runtime-параметра (@params).
/// Для обычной зависимости типа (например, SomeDep) генерирует строку вида:
/// currentScope.resolve<SomeDep>()
/// Для зависимости с именем:
/// currentScope.resolve<SomeDep>(named: 'имя')
/// Для runtime-параметра:
/// args
/// Stores the parameter's type name, optional `@named` identifier (for named DI resolution),
/// and a flag for runtime (@params) arguments. Used in CherryPick generator
/// for creating argument lists when invoking factories or provider methods.
///
/// ## Example usage
/// ```dart
/// // Binding method: @provide() Logger provideLogger(@named('debug') Config config, @params Map<String, dynamic> args)
/// final namedParam = BindParameterSpec('Config', 'debug');
/// final runtimeParam = BindParameterSpec('Map<String, dynamic>', null, isParams: true);
/// print(namedParam.generateArg()); // prints: currentScope.resolve<Config>(named: 'debug')
/// print(runtimeParam.generateArg()); // prints: args
/// ```
///
/// ## Code generation logic
/// - Injected: currentScope.resolve<Service>()
/// - Named: currentScope.resolve<Service>(named: 'name')
/// - @params: args
/// ----------------------------------------------------------------------------
class BindParameterSpec {
/// Type name of the parameter (e.g. SomeService)
/// Имя типа параметра (например, SomeService)
/// The type name of the parameter (e.g., 'UserRepository')
final String typeName;
/// Optional name for named resolution (from @named)
/// Необязательное имя для разрешения по имени (если аннотировано через @named)
/// If non-null, this is the named-key for DI resolution (from @named).
final String? named;
/// True if this parameter uses @params and should be provided from runtime args
/// Признак, что параметр — runtime (через @params)
/// True if this parameter is a runtime param (annotated with @params and
/// filled by a runtime argument map).
final bool isParams;
BindParameterSpec(this.typeName, this.named, {this.isParams = false});
/// --------------------------------------------------------------------------
/// generateArg
/// Generates Dart code to resolve this parameter in the DI container.
///
/// ENGLISH
/// Generates Dart code for resolving the dependency from the DI scope,
/// considering type, named, and param-argument.
/// - For normal dependencies: resolves by type
/// - For named dependencies: resolves by type and name
/// - For @params: uses the supplied params variable (default 'args')
///
/// RUSSIAN
/// Генерирует строку для получения зависимости из DI scope (с учётом имени
/// и типа параметра или runtime-режима @params).
/// --------------------------------------------------------------------------
/// ## Example
/// ```dart
/// final a = BindParameterSpec('Api', null); // normal
/// 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']) {
if (isParams) {
return paramsVar;

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -19,62 +19,64 @@ import 'exceptions.dart';
import 'type_parser.dart';
import 'annotation_validator.dart';
/// Enum representing the binding annotation applied to a module method.
enum BindingType {
/// Direct instance returned from the method (@instance).
instance,
/// Provider/factory function (@provide).
provide;
}
/// ---------------------------------------------------------------------------
/// BindSpec -- describes a binding specification generated for a dependency.
/// BindSpec
///
/// ENGLISH
/// Represents all the data necessary to generate a DI binding for a single
/// method in a module class. Each BindSpec corresponds to one public method
/// and contains information about its type, provider method, lifecycle (singleton),
/// parameters (with their annotations), binding strategy (instance/provide),
/// asynchronous mode, and named keys. It is responsible for generating the
/// correct Dart code to register this binding with the DI container, in both
/// sync and async cases, with and without named or runtime arguments.
/// Describes a DI container binding as generated from a single public factory,
/// instance, or provider method of a module (annotated with @instance or @provide).
///
/// RUSSIAN
/// Описывает параметры для создания одного биндинга зависимости (binding spec).
/// Каждый биндинг соответствует одному публичному методу класса-модуля и
/// содержит всю информацию для генерации кода регистрации этого биндинга в
/// DI-контейнере: тип возвращаемой зависимости, имя метода, параметры, аннотации
/// (@singleton, @named, @instance, @provide), асинхронность, признак runtime
/// аргументов и др. Генерирует правильный Dart-код для регистрации биндера.
/// Includes all annotation-driven parameters required to generate valid DI
/// registration Dart code in CherryPick:
/// - Return type
/// - Provider method name
/// - Singleton flag
/// - Named identifier (from @named)
/// - List of resolved or runtime (@params) parameters
/// - 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 {
/// The type this binding provides (e.g. SomeService)
/// Тип, который предоставляет биндинг (например, SomeService)
final String returnType;
/// Method name that implements the binding
/// Имя метода, который реализует биндинг
/// Binding provider/factory method name
final String methodName;
/// Optional name for named dependency (from @named)
/// Необязательное имя, для именованной зависимости (используется с @named)
/// Named identifier for DI resolution (null if unnamed)
final String? named;
/// Whether the dependency is a singleton (@singleton annotation)
/// Является ли зависимость синглтоном (имеется ли аннотация @singleton)
/// If true, binding is registered as singleton in DI
final bool isSingleton;
/// List of method parameters to inject dependencies with
/// Список параметров, которые требуются методу для внедрения зависимостей
/// Provider/factory method parameters (in order)
final List<BindParameterSpec> parameters;
/// Binding type: 'instance' or 'provide' (@instance or @provide)
final BindingType bindingType; // 'instance' | 'provide'
/// Instance vs provider mode, from annotation choice
final BindingType bindingType;
/// True if the method is asynchronous and uses instance binding (Future)
/// Async flag for .toInstanceAsync()
final bool isAsyncInstance;
/// True if the method is asynchronous and uses provide binding (Future)
/// Async flag for .toProvideAsync()
final bool isAsyncProvide;
/// True if the binding method accepts runtime "params" argument (@params)
/// True if a @params runtime parameter is present
final bool hasParams;
BindSpec({
@@ -89,20 +91,12 @@ class BindSpec {
required this.hasParams,
});
/// -------------------------------------------------------------------------
/// generateBind
/// Generates a Dart code line for binding registration.
///
/// ENGLISH
/// Generates a line of Dart code registering the binding with the DI framework.
/// Produces something like:
/// bind<Type>().toProvide(() => method(args)).withName('name').singleton();
/// Indent parameter allows formatted multiline output.
/// Example (single-line):
/// bind<Api>().toProvide(() => provideApi(currentScope.resolve<Client>(named: 'test'))).withName('prod').singleton();
///
/// RUSSIAN
/// Формирует dart-код для биндинга, например:
/// bind<Type>().toProvide(() => method(args)).withName('name').singleton();
/// Параметр [indent] задаёт отступ для красивого форматирования кода.
/// -------------------------------------------------------------------------
/// The [indent] argument sets the space indentation for pretty-printing.
String generateBind(int indent) {
final indentStr = ' ' * indent;
final provide = _generateProvideClause(indent);
@@ -151,7 +145,7 @@ class BindSpec {
return _generatePlainProvideClause(indent);
}
/// EN / RU: Supports runtime parameters (@params).
/// Generates code when using runtime parameters (@params).
String _generateWithParamsProvideClause(int indent) {
// Safe variable name for parameters.
const paramVar = 'args';
@@ -178,7 +172,7 @@ class BindSpec {
}
}
/// EN / RU: Supports only injected dependencies, not runtime (@params).
/// Generates code when only resolved (not runtime) arguments used.
String _generatePlainProvideClause(int indent) {
final argsStr = parameters.map((p) => p.generateArg()).join(', ');
@@ -241,16 +235,17 @@ class BindSpec {
/// -------------------------------------------------------------------------
/// fromMethod
///
/// ENGLISH
/// Creates a BindSpec from a module class method by analyzing its return type,
/// annotations, list of parameters (with their own annotations), and async-ness.
/// Throws if a method does not have the required @instance() or @provide().
/// Constructs a [BindSpec] from an analyzer [MethodElement].
///
/// RUSSIAN
/// Создаёт спецификацию биндинга (BindSpec) из метода класса-модуля, анализируя
/// возвращаемый тип, аннотации, параметры (и их аннотации), а также факт
/// асинхронности. Если нет @instance или @provide — кидает ошибку.
/// -------------------------------------------------------------------------
/// Validates and parses all type annotations, method/parameter DI hints,
/// and derives async and parametric flags as needed.
///
/// ## Example
/// ```dart
/// final bindSpec = BindSpec.fromMethod(methodElement);
/// print(bindSpec.returnType); // e.g., 'Logger'
/// ```
/// Throws [AnnotationValidationException] or [CodeGenerationException] if invalid.
static BindSpec fromMethod(MethodElement method) {
try {
// Validate method annotations

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -14,10 +14,36 @@
import 'package:analyzer/dart/element/element.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 {
/// A string describing the error category (for grouping).
final String category;
/// An optional suggestion string for resolving the error.
final String? suggestion;
/// Arbitrary key-value map for additional debugging information.
final Map<String, dynamic>? context;
CherryPickGeneratorException(
@@ -50,7 +76,7 @@ class CherryPickGeneratorException extends InvalidGenerationSourceError {
buffer.writeln(' Type: ${element.runtimeType}');
buffer.writeln(' Location: ${element.source?.fullName ?? 'unknown'}');
// Note: enclosingElement may not be available in all analyzer versions
// Try to show enclosing element info for extra context
try {
final enclosing = (element as dynamic).enclosingElement;
if (enclosing != null) {
@@ -60,7 +86,7 @@ class CherryPickGeneratorException extends InvalidGenerationSourceError {
// Ignore if enclosingElement is not available
}
// Additional context
// Arbitrary user context
if (context != null && context.isNotEmpty) {
buffer.writeln('');
buffer.writeln('Additional Context:');
@@ -69,7 +95,7 @@ class CherryPickGeneratorException extends InvalidGenerationSourceError {
});
}
// Suggestion
// Hint/suggestion if present
if (suggestion != null) {
buffer.writeln('');
buffer.writeln('💡 Suggestion: $suggestion');
@@ -79,7 +105,24 @@ 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 {
AnnotationValidationException(
super.message, {
@@ -89,6 +132,24 @@ class AnnotationValidationException extends CherryPickGeneratorException {
}) : 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 {
TypeParsingException(
super.message, {
@@ -98,6 +159,23 @@ class TypeParsingException extends CherryPickGeneratorException {
}) : 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 {
CodeGenerationException(
super.message, {
@@ -107,6 +185,23 @@ class CodeGenerationException extends CherryPickGeneratorException {
}) : 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 {
DependencyResolutionException(
super.message, {

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -12,45 +12,48 @@
//
import 'package:analyzer/dart/element/element.dart';
import 'bind_spec.dart';
/// ---------------------------------------------------------------------------
/// GeneratedClass -- represents the result of processing a single module class.
/// GeneratedClass
///
/// ENGLISH
/// Encapsulates all the information produced from analyzing a DI module class:
/// - The original class name,
/// - Its generated class name (e.g., `$SomeModule`),
/// - The collection of bindings (BindSpec) for all implemented provider methods.
/// Represents a processed DI module class with all its binding methods analyzed.
/// Stores:
/// - The original class name,
/// - The generated implementation class name (with $ prefix),
/// - The list of all BindSpec for the module methods,
/// - The source file name for reference or directive generation.
///
/// Also provides code generation functionality, allowing to generate the source
/// code for the derived DI module class, including all binding registrations.
/// Provides static and instance methods to construct from a ClassElement
/// and generate Dart source code for the resulting DI registration class.
///
/// RUSSIAN
/// Описывает результат обработки одного класса-модуля DI:
/// - Имя оригинального класса,
/// - Имя генерируемого класса (например, `$SomeModule`),
/// - Список всех бидингов (BindSpec) — по публичным методам модуля.
///
/// Также содержит функцию генерации исходного кода для этого класса и
/// регистрации всех зависимостей через bind(...).
/// ## Example usage
/// ```dart
/// final gen = GeneratedClass.fromClassElement(myModuleClassElement);
/// print(gen.generate());
/// /*
/// Produces:
/// final class $MyModule extends MyModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Service>().toProvide(() => provideService(currentScope.resolve<Dep>()));
/// ...
/// }
/// }
/// */
/// ```
/// ---------------------------------------------------------------------------
class GeneratedClass {
/// The name of the original module class.
/// Имя исходного класса-модуля
/// Name of the original Dart module class.
final String className;
/// The name of the generated class (e.g., $SomeModule).
/// Имя генерируемого класса (например, $SomeModule)
/// Name of the generated class, e.g. `$MyModule`
final String generatedClassName;
/// List of all discovered bindings for the class.
/// Список всех обнаруженных биндингов
/// Binding specs for all provider/factory methods in the class.
final List<BindSpec> binds;
/// Source file name for the part directive
/// Имя исходного файла для part директивы
/// Source filename of the module class (for code references).
final String sourceFile;
GeneratedClass(
@@ -63,16 +66,15 @@ class GeneratedClass {
/// -------------------------------------------------------------------------
/// fromClassElement
///
/// ENGLISH
/// Static factory: creates a GeneratedClass from a Dart ClassElement (AST representation).
/// Discovers all non-abstract methods, builds BindSpec for each, and computes the
/// generated class name by prefixing `$`.
/// Creates a [GeneratedClass] by analyzing a Dart [ClassElement].
/// Collects all public non-abstract methods, creates a [BindSpec] for each,
/// and infers the generated class name using a `$` prefix.
///
/// RUSSIAN
/// Строит объект класса по элементу AST (ClassElement): имя класса,
/// сгенерированное имя, список BindSpec по всем не абстрактным методам.
/// Имя ген-класса строится с префиксом `$`.
/// -------------------------------------------------------------------------
/// ## Example usage
/// ```dart
/// final gen = GeneratedClass.fromClassElement(classElement);
/// print(gen.generatedClassName); // e.g. $AppModule
/// ```
static GeneratedClass fromClassElement(ClassElement element) {
final className = element.displayName;
// Generated class name with '$' prefix (standard for generated Dart code).
@@ -91,16 +93,19 @@ class GeneratedClass {
/// -------------------------------------------------------------------------
/// generate
///
/// ENGLISH
/// Generates Dart source code for the DI module class. The generated class
/// inherits from the original, overrides the 'builder' method, and registers
/// all bindings in the DI scope.
/// Generates the Dart source code for the DI registration class.
/// The generated class extends the original module, and the `builder` method
/// registers all bindings (dependencies) into the DI scope.
///
/// RUSSIAN
/// Генерирует исходный Dart-код для класса-модуля DI.
/// Новая версия класса наследует оригинальный, переопределяет builder(Scope),
/// и регистрирует все зависимости через методы bind<Type>()...
/// -------------------------------------------------------------------------
/// ## Example output
/// ```dart
/// final class $UserModule extends UserModule {
/// @override
/// void builder(Scope currentScope) {
/// bind<Service>().toProvide(() => provideService(currentScope.resolve<Dep>()));
/// }
/// }
/// ```
String generate() {
final buffer = StringBuffer()
..writeln('final class $generatedClassName extends $className {')
@@ -108,7 +113,6 @@ class GeneratedClass {
..writeln(' void builder(Scope currentScope) {');
// For each binding, generate bind<Type>() code string.
// Для каждого биндинга — генерируем строку bind<Type>()...
for (final bind in binds) {
buffer.writeln(bind.generateBind(4));
}

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -14,30 +14,32 @@
import 'package:analyzer/dart/element/element.dart';
/// ---------------------------------------------------------------------------
/// MetadataUtils -- utilities for analyzing method and parameter annotations.
/// MetadataUtils
///
/// ENGLISH
/// Provides static utility methods to analyze Dart annotations on methods or
/// parameters. For instance, helps to find if an element is annotated with
/// `@named()`, `@singleton()`, or other meta-annotations used in this DI framework.
/// Static utilities for querying and extracting information from
/// Dart annotations ([ElementAnnotation]) in the context of code generation,
/// such as checking for the presence of specific DI-related annotations.
/// Designed to be used internally by code generation and validation routines.
///
/// RUSSIAN
/// Утилиты для разбора аннотаций методов и параметров.
/// Позволяют находить наличие аннотаций, например, @named() и @singleton(),
/// у методов и параметров. Используется для анализа исходного кода при генерации.
/// # Example usage
/// ```dart
/// if (MetadataUtils.anyMeta(method.metadata, 'singleton')) {
/// // The method is annotated with @singleton
/// }
/// final name = MetadataUtils.getNamedValue(field.metadata);
/// if (name != null) print('@named value: $name');
/// ```
/// ---------------------------------------------------------------------------
class MetadataUtils {
/// -------------------------------------------------------------------------
/// anyMeta
/// Checks whether any annotation in [meta] matches the [typeName]
/// (type name is compared in a case-insensitive manner and can be partial).
///
/// ENGLISH
/// Checks if any annotation in the list has a type name that contains
/// [typeName] (case insensitive).
/// Returns true if an annotation (such as @singleton, @provide, @named) is found.
///
/// RUSSIAN
/// Проверяет: есть ли среди аннотаций метка, имя которой содержит [typeName]
/// (регистр не учитывается).
/// -------------------------------------------------------------------------
/// Example:
/// ```dart
/// bool isSingleton = MetadataUtils.anyMeta(myMethod.metadata, 'singleton');
/// ```
static bool anyMeta(List<ElementAnnotation> meta, String typeName) {
return meta.any((m) =>
m
@@ -49,17 +51,15 @@ class MetadataUtils {
false);
}
/// -------------------------------------------------------------------------
/// getNamedValue
/// Extracts the string value from a `@named('value')` annotation if present in [meta].
///
/// ENGLISH
/// Retrieves the value from a `@named('value')` annotation if present.
/// Returns the string value or null if not found.
/// Returns the named value or `null` if not annotated.
///
/// RUSSIAN
/// Находит значение из аннотации @named('значение').
/// Возвращает строку значения, если аннотация присутствует; иначе null.
/// -------------------------------------------------------------------------
/// Example:
/// ```dart
/// // For: @named('dev') ApiClient provideApi() ...
/// final named = MetadataUtils.getNamedValue(method.metadata); // 'dev'
/// ```
static String? getNamedValue(List<ElementAnnotation> meta) {
for (final m in meta) {
final cv = m.computeConstantValue();

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -16,9 +16,35 @@ import 'package:analyzer/dart/element/nullability_suffix.dart';
import 'package:analyzer/dart/element/type.dart';
import 'exceptions.dart';
/// Enhanced type parser that uses AST analysis instead of regular expressions
/// Utility for analyzing and parsing Dart types for CherryPick DI code generation.
///
/// 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 {
/// Parses a DartType and extracts detailed type information
/// Parses a [DartType] and extracts detailed type information for use in code generation.
///
/// 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) {
try {
return _parseTypeInternal(dartType, context);
@@ -49,7 +75,7 @@ class TypeParser {
return _parseGenericType(dartType, context, isNullable);
}
// Simple type
// Simple type (non-generic, non-Future)
return ParsedType(
displayString: displayString,
coreType: displayString.replaceAll('?', ''),
@@ -103,7 +129,15 @@ class TypeParser {
);
}
/// Validates that a type is suitable for dependency injection
/// Validates that a parsed 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) {
// Check for void type
if (parsedType.coreType == 'void') {
@@ -131,7 +165,7 @@ class TypeParser {
}
}
/// Represents a parsed type with detailed information
/// Represents a parsed type with full metadata for code generation.
class ParsedType {
/// The full display string of the type (e.g., "Future<List<String>?>")
final String displayString;
@@ -139,19 +173,19 @@ class ParsedType {
/// The core type name without nullability and Future wrapper (e.g., "List<String>")
final String coreType;
/// Whether the type is nullable
/// True if nullable (has `?`)
final bool isNullable;
/// Whether the type is wrapped in Future
/// True if this type is a `Future<T>`
final bool isFuture;
/// Whether the type has generic parameters
/// True if the type is a generic type (`List<T>`)
final bool isGeneric;
/// Parsed type arguments for generic types
/// List of parsed type arguments in generics, if any.
final List<ParsedType> typeArguments;
/// For Future types, the inner type
/// For `Future<T>`, this is the type inside the `Future`.
final ParsedType? innerType;
const ParsedType({
@@ -164,7 +198,11 @@ class ParsedType {
this.innerType,
});
/// Returns the type string suitable for code generation
/// Generates 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 {
if (isFuture && innerType != null) {
return innerType!.codeGenType;
@@ -179,10 +217,10 @@ class ParsedType {
return coreType;
}
/// Returns whether this type should use tryResolve instead of resolve
/// True if this type should use `tryResolve` instead of `resolve` for DI.
bool get shouldUseTryResolve => isNullable;
/// Returns the appropriate resolve method name
/// Returns the method name for DI, e.g. "resolve", "tryResolveAsync", etc.
String get resolveMethodName {
if (isFuture) {
return shouldUseTryResolve ? 'tryResolveAsync' : 'resolveAsync';

View File

@@ -2,17 +2,23 @@ name: cherrypick_generator
description: |
Source code generator for the cherrypick dependency injection system. Processes annotations to generate binding and module code for Dart & Flutter projects.
version: 1.1.0
version: 2.0.0-dev.0
documentation: https://github.com/pese-git/cherrypick/wiki
repository: https://github.com/pese-git/cherrypick/cherrypick_generator
issue_tracker: https://github.com/pese-git/cherrypick/issues
topics:
- di
- ioc
- dependency-injection
- dependency-management
- inversion-of-control
environment:
sdk: ">=3.5.2 <4.0.0"
# Add regular dependencies here.
dependencies:
cherrypick_annotations: ^1.1.0
cherrypick_annotations: ^1.1.2-dev.0
analyzer: ^7.0.0
dart_style: ^3.0.0
build: ^2.4.1

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.
@@ -244,8 +244,7 @@ void main() {
final result = bindSpec.generateBind(4);
expect(
result,
equals(
" bind<ApiClient>()\n"
equals(" bind<ApiClient>()\n"
" .toProvideAsync(() => createApiClient())\n"
" .withName('mainApi')\n"
" .singleton();"));

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.

View File

@@ -3,7 +3,7 @@
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// 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.

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