mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-24 05:25:19 +00:00
Compare commits
28 Commits
cherrypick
...
cli
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
76c77b1f6d | ||
|
|
edc2a14ad7 | ||
|
|
71d3ef77a9 | ||
|
|
0eec549b57 | ||
|
|
a3648209b9 | ||
|
|
c722ad0c07 | ||
|
|
8468eff5f7 | ||
|
|
24bb47f741 | ||
|
|
b5f6fff8d1 | ||
|
|
e7f20d8f63 | ||
|
|
e057bb487b | ||
|
|
2e7c9129bb | ||
|
|
292af4a4f3 | ||
|
|
5220ebc4b9 | ||
|
|
a0a0a967a2 | ||
|
|
a9260e0413 | ||
|
|
dd608031a2 | ||
|
|
49e3654ab8 | ||
|
|
bc28ff79ef | ||
|
|
52bc66f2f9 | ||
|
|
79a050d056 | ||
|
|
3beb53a094 | ||
|
|
21955640d9 | ||
|
|
a62052daa5 | ||
|
|
7dbaa59c01 | ||
|
|
8438697107 | ||
|
|
9c42ba4cef | ||
|
|
1f6ee172a1 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -7,7 +7,7 @@
|
||||
.idea/
|
||||
.vscode/
|
||||
|
||||
|
||||
**/generated
|
||||
**/*.g.dart
|
||||
**/*.gr.dart
|
||||
**/*.freezed.dart
|
||||
|
||||
102
CHANGELOG.md
102
CHANGELOG.md
@@ -3,6 +3,108 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## 2025-07-15
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- [`cherrypick_generator` - `v1.1.0-dev.6`](#cherrypick_generator---v110-dev6)
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`cherrypick` - `v2.2.0-dev.2`](#cherrypick---v220-dev2)
|
||||
- [`cherrypick_flutter` - `v1.1.2-dev.2`](#cherrypick_flutter---v112-dev2)
|
||||
|
||||
Packages with dependency updates only:
|
||||
|
||||
> Packages listed below depend on other packages in this workspace that have had changes. Their versions have been incremented to bump the minimum dependency versions of the packages they depend upon in this project.
|
||||
|
||||
- `cherrypick_flutter` - `v1.1.2-dev.2`
|
||||
|
||||
---
|
||||
|
||||
#### `cherrypick_generator` - `v1.1.0-dev.6`
|
||||
|
||||
- **FIX**: format test code.
|
||||
- **FEAT**(generator): support output_dir and build_extensions config for generated files.
|
||||
- **BREAKING** **FEAT**(generator): complete code generation testing framework with 100% test coverage.
|
||||
|
||||
#### `cherrypick` - `v2.2.0-dev.2`
|
||||
|
||||
- **DOCS**: move and update quick start guides to ./doc directory.
|
||||
|
||||
|
||||
## 2025-06-04
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`cherrypick_generator` - `v1.1.0-dev.5`](#cherrypick_generator---v110-dev5)
|
||||
|
||||
---
|
||||
|
||||
#### `cherrypick_generator` - `v1.1.0-dev.5`
|
||||
|
||||
- **FEAT**: implement tryResolve via generate code.
|
||||
|
||||
|
||||
## 2025-05-28
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`cherrypick_generator` - `v1.1.0-dev.4`](#cherrypick_generator---v110-dev4)
|
||||
|
||||
---
|
||||
|
||||
#### `cherrypick_generator` - `v1.1.0-dev.4`
|
||||
|
||||
- **FIX**: fixed warnings.
|
||||
|
||||
|
||||
## 2025-05-23
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`cherrypick_annotations` - `v1.1.0-dev.1`](#cherrypick_annotations---v110-dev1)
|
||||
- [`cherrypick_generator` - `v1.1.0-dev.3`](#cherrypick_generator---v110-dev3)
|
||||
|
||||
---
|
||||
|
||||
#### `cherrypick_annotations` - `v1.1.0-dev.1`
|
||||
|
||||
- **FEAT**: implement InjectGenerator.
|
||||
|
||||
#### `cherrypick_generator` - `v1.1.0-dev.3`
|
||||
|
||||
- **FEAT**: implement InjectGenerator.
|
||||
|
||||
|
||||
## 2025-05-23
|
||||
|
||||
### Changes
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
## 2.2.0-dev.2
|
||||
|
||||
- **DOCS**: move and update quick start guides to ./doc directory.
|
||||
|
||||
## 2.2.0-dev.1
|
||||
|
||||
- **FIX**: fix warnings.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
name: cherrypick
|
||||
description: Cherrypick is a small dependency injection (DI) library for dart/flutter projects.
|
||||
version: 2.2.0-dev.1
|
||||
version: 2.2.0-dev.2
|
||||
homepage: https://pese-git.github.io/cherrypick-site/
|
||||
documentation: https://github.com/pese-git/cherrypick/wiki
|
||||
repository: https://github.com/pese-git/cherrypick
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
## 1.1.0-dev.1
|
||||
|
||||
- **FEAT**: implement InjectGenerator.
|
||||
|
||||
## 1.1.0-dev.0
|
||||
|
||||
- **FEAT**: implement generator for dynamic params.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
[](LICENSE)
|
||||
|
||||
A lightweight set of Dart annotations designed for dependency injection (DI) frameworks and code generation, inspired by modern approaches like Dagger and Injectable. Works best in tandem with [`cherrypick_generator`](https://pub.dev/packages/cherrypick_generator).
|
||||
A lightweight set of Dart annotations for dependency injection (DI) frameworks and code generation, inspired by modern approaches like Dagger and Injectable. Optimized for use with [`cherrypick_generator`](https://pub.dev/packages/cherrypick_generator).
|
||||
|
||||
---
|
||||
|
||||
@@ -10,10 +10,13 @@ A lightweight set of Dart annotations designed for dependency injection (DI) fra
|
||||
|
||||
- **@module** – Marks a class as a DI module for service/provider registration.
|
||||
- **@singleton** – Declares that a method or class should be provided as a singleton.
|
||||
- **@instance** – Marks a method or class so that a new instance is provided on each request (not a singleton).
|
||||
- **@provide** – Marks a method whose return value should be registered as a provider, supporting dependency injection into parameters.
|
||||
- **@named** – Assigns a string name to a binding for keyed resolution.
|
||||
- **@instance** – Marks a method or class so that a new instance is provided on each request.
|
||||
- **@provide** – Marks a method whose return value should be registered as a provider, supporting DI into its parameters.
|
||||
- **@named** – Assigns a string name to a binding for keyed resolution and injection.
|
||||
- **@params** – Indicates that a parameter should be injected with runtime-supplied arguments.
|
||||
- **@injectable** – Marks a class as eligible for automatic field injection. Fields annotated with `@inject` will be injected by the code generator.
|
||||
- **@inject** – Marks a field to be automatically injected by the code generator.
|
||||
- **@scope** – Declares the DI scope from which a dependency should be resolved for a field.
|
||||
|
||||
These annotations streamline DI configuration and serve as markers for code generation tools such as [`cherrypick_generator`](https://pub.dev/packages/cherrypick_generator).
|
||||
|
||||
@@ -32,18 +35,21 @@ Add as a `dev_dependency` for code generation:
|
||||
|
||||
```yaml
|
||||
dev_dependencies:
|
||||
cherrypick_generator: ^latest
|
||||
build_runner: ^latest
|
||||
cherrypick_generator:
|
||||
```
|
||||
|
||||
### 2. Annotate your DI modules and providers
|
||||
---
|
||||
|
||||
### 2. Annotate your DI modules, providers, and injectable classes
|
||||
|
||||
#### **Module and Provider Example**
|
||||
|
||||
```dart
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
@module()
|
||||
abstract class AppModule extends Module {
|
||||
abstract class AppModule {
|
||||
@singleton()
|
||||
Dio dio() => Dio();
|
||||
|
||||
@@ -61,7 +67,7 @@ abstract class AppModule extends Module {
|
||||
}
|
||||
```
|
||||
|
||||
When used with `cherrypick_generator`, code similar to the following will be generated:
|
||||
With `cherrypick_generator`, code like the following will be generated:
|
||||
|
||||
```dart
|
||||
final class $AppModule extends AppModule {
|
||||
@@ -78,13 +84,78 @@ final class $AppModule extends AppModule {
|
||||
|
||||
---
|
||||
|
||||
#### **Field Injection Example**
|
||||
|
||||
```dart
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
@injectable()
|
||||
class ProfileView with _$ProfileView{
|
||||
@inject()
|
||||
late final AuthService auth;
|
||||
|
||||
@inject()
|
||||
@scope('profile')
|
||||
late final ProfileManager manager;
|
||||
|
||||
@inject()
|
||||
@named('admin')
|
||||
late final UserService adminUserService;
|
||||
}
|
||||
```
|
||||
|
||||
The code generator produces a mixin (simplified):
|
||||
|
||||
```dart
|
||||
mixin _$ProfileView {
|
||||
void _inject(ProfileView instance) {
|
||||
instance.auth = CherryPick.openRootScope().resolve<AuthService>();
|
||||
instance.manager = CherryPick.openScope(scopeName: 'profile').resolve<ProfileManager>();
|
||||
instance.adminUserService = CherryPick.openRootScope().resolve<UserService>(named: 'admin');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Annotation Reference
|
||||
|
||||
### `@injectable`
|
||||
|
||||
```dart
|
||||
@injectable()
|
||||
class MyWidget { ... }
|
||||
```
|
||||
Marks a class as injectable for CherryPick DI. The code generator will generate a mixin to perform automatic injection of fields marked with `@inject()`.
|
||||
|
||||
---
|
||||
|
||||
### `@inject`
|
||||
|
||||
```dart
|
||||
@inject()
|
||||
late final SomeService service;
|
||||
```
|
||||
Applied to a field to request automatic injection of the dependency using the CherryPick DI framework.
|
||||
|
||||
---
|
||||
|
||||
### `@scope`
|
||||
|
||||
```dart
|
||||
@inject()
|
||||
@scope('profile')
|
||||
late final ProfileManager manager;
|
||||
```
|
||||
Specifies the scope from which the dependency should be resolved for an injected field.
|
||||
|
||||
---
|
||||
|
||||
### `@module`
|
||||
|
||||
```dart
|
||||
@module()
|
||||
abstract class AppModule extends Module {}
|
||||
abstract class AppModule {}
|
||||
```
|
||||
Use on classes to mark them as a DI module. This is the root for registering your dependency providers.
|
||||
|
||||
@@ -126,7 +197,8 @@ Use on methods to indicate they provide a dependency to the DI module. Dependenc
|
||||
@named('token')
|
||||
String token() => 'abc';
|
||||
```
|
||||
Assigns a name to a binding for keyed injection or resolution.
|
||||
Assigns a name to a binding for keyed injection or resolution.
|
||||
Can be used on both provider methods and fields.
|
||||
|
||||
---
|
||||
|
||||
@@ -136,7 +208,7 @@ Assigns a name to a binding for keyed injection or resolution.
|
||||
@provide()
|
||||
String greet(@params() dynamic params) => 'Hello $params';
|
||||
```
|
||||
Use on method parameters to indicate that this parameter should receive runtime-supplied arguments during dependency resolution (for example, via `.toProvide*((params) => greate(params))` in generated code).
|
||||
Indicates that this parameter should receive runtime-supplied arguments during dependency resolution.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -19,3 +19,6 @@ export 'src/instance.dart';
|
||||
export 'src/singleton.dart';
|
||||
export 'src/named.dart';
|
||||
export 'src/params.dart';
|
||||
export 'src/inject.dart';
|
||||
export 'src/injectable.dart';
|
||||
export 'src/scope.dart';
|
||||
|
||||
34
cherrypick_annotations/lib/src/inject.dart
Normal file
34
cherrypick_annotations/lib/src/inject.dart
Normal file
@@ -0,0 +1,34 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:meta/meta.dart';
|
||||
|
||||
/// Annotation for field injection in CherryPick DI framework.
|
||||
/// Apply this to a field, and the code generator will automatically inject
|
||||
/// the appropriate dependency into it.
|
||||
///
|
||||
/// ---
|
||||
///
|
||||
/// Аннотация для внедрения зависимости в поле через фреймворк CherryPick DI.
|
||||
/// Поместите её на поле класса — генератор кода автоматически подставит нужную зависимость.
|
||||
///
|
||||
/// Example / Пример:
|
||||
/// ```dart
|
||||
/// @inject()
|
||||
/// late final SomeService service;
|
||||
/// ```
|
||||
@experimental
|
||||
// ignore: camel_case_types
|
||||
final class inject {
|
||||
const inject();
|
||||
}
|
||||
38
cherrypick_annotations/lib/src/injectable.dart
Normal file
38
cherrypick_annotations/lib/src/injectable.dart
Normal file
@@ -0,0 +1,38 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:meta/meta.dart';
|
||||
|
||||
/// Marks a class as injectable for the CherryPick dependency injection framework.
|
||||
/// If a class is annotated with [@injectable()], the code generator will
|
||||
/// create a mixin to perform automatic injection of fields marked with [@inject].
|
||||
///
|
||||
/// ---
|
||||
///
|
||||
/// Помечает класс как внедряемый для фреймворка внедрения зависимостей CherryPick.
|
||||
/// Если класс помечен аннотацией [@injectable()], генератор создаст миксин
|
||||
/// для автоматического внедрения полей, отмеченных [@inject].
|
||||
///
|
||||
/// Example / Пример:
|
||||
/// ```dart
|
||||
/// @injectable()
|
||||
/// class MyWidget extends StatelessWidget {
|
||||
/// @inject()
|
||||
/// late final MyService service;
|
||||
/// }
|
||||
/// ```
|
||||
@experimental
|
||||
// ignore: camel_case_types
|
||||
final class injectable {
|
||||
const injectable();
|
||||
}
|
||||
37
cherrypick_annotations/lib/src/scope.dart
Normal file
37
cherrypick_annotations/lib/src/scope.dart
Normal file
@@ -0,0 +1,37 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:meta/meta.dart';
|
||||
|
||||
/// Annotation to specify a scope for dependency injection in CherryPick.
|
||||
/// Use this on an injected field to indicate from which scope
|
||||
/// the dependency must be resolved.
|
||||
///
|
||||
/// ---
|
||||
///
|
||||
/// Аннотация для указания области внедрения (scope) в CherryPick.
|
||||
/// Используйте её на инъецируемом поле, чтобы определить из какой области
|
||||
/// должна быть получена зависимость.
|
||||
///
|
||||
/// Example / Пример:
|
||||
/// ```dart
|
||||
/// @inject()
|
||||
/// @scope('profile')
|
||||
/// late final ProfileManager profileManager;
|
||||
/// ```
|
||||
@experimental
|
||||
// ignore: camel_case_types
|
||||
final class scope {
|
||||
final String? name;
|
||||
const scope(this.name);
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
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-dev.0
|
||||
version: 1.1.0-dev.1
|
||||
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
|
||||
|
||||
201
cherrypick_cli/LICENSE
Normal file
201
cherrypick_cli/LICENSE
Normal file
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
93
cherrypick_cli/README.md
Normal file
93
cherrypick_cli/README.md
Normal file
@@ -0,0 +1,93 @@
|
||||
# CherryPick CLI
|
||||
|
||||
A command-line tool for managing and generating `build.yaml` configuration for the [CherryPick](https://github.com/pese-git/cherrypick) dependency injection ecosystem for Dart & Flutter.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
- 📦 Quickly add or update CherryPick generator sections in your project's `build.yaml`.
|
||||
- 🛡️ Safely preserves unrelated configs and packages.
|
||||
- 📝 Always outputs a human-friendly, formatted YAML file.
|
||||
- 🏷️ Supports custom output directories and custom build.yaml file paths.
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. **Navigate to the CLI package directory:**
|
||||
```bash
|
||||
cd cherrypick_cli
|
||||
```
|
||||
2. **Get dependencies:**
|
||||
```bash
|
||||
dart pub get
|
||||
```
|
||||
3. **Run the CLI:**
|
||||
```bash
|
||||
dart run cherrypick_cli init --output_dir=lib/generated
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
### Show help
|
||||
```bash
|
||||
dart run cherrypick_cli --help
|
||||
```
|
||||
|
||||
### Add or update CherryPick sections in build.yaml
|
||||
```bash
|
||||
dart run cherrypick_cli init --output_dir=lib/generated
|
||||
```
|
||||
|
||||
#### Options:
|
||||
- `--output_dir`, `-o` — Directory for generated code (default: `lib/generated`)
|
||||
- `--build_yaml`, `-f` — Path to build.yaml file (default: `build.yaml`)
|
||||
|
||||
#### Example with custom build.yaml
|
||||
```bash
|
||||
dart run cherrypick_cli init --output_dir=custom/dir --build_yaml=custom_build.yaml
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## What does it do?
|
||||
- Adds or updates the following sections in your `build.yaml` (or custom file):
|
||||
- `cherrypick_generator|inject_generator`
|
||||
- `cherrypick_generator|module_generator`
|
||||
- Ensures all YAML is pretty-printed and readable.
|
||||
- Leaves unrelated configs untouched.
|
||||
|
||||
---
|
||||
|
||||
## Example Output
|
||||
```yaml
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|inject_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
^lib/{{}}.dart:
|
||||
- lib/generated/{{}}.inject.cherrypick.g.dart
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
cherrypick_generator|module_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
^lib/di/{{}}.dart:
|
||||
- lib/generated/di/{{}}.module.cherrypick.g.dart
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
Pull requests and issues are welcome! See the [main CherryPick repo](https://github.com/pese-git/cherrypick) for more.
|
||||
|
||||
## License
|
||||
See [LICENSE](LICENSE).
|
||||
8
cherrypick_cli/bin/cherrypick_cli.dart
Normal file
8
cherrypick_cli/bin/cherrypick_cli.dart
Normal file
@@ -0,0 +1,8 @@
|
||||
import 'package:args/command_runner.dart';
|
||||
import 'package:cherrypick_cli/src/commands/init_command.dart';
|
||||
|
||||
void main(List<String> args) {
|
||||
final runner = CommandRunner('cherrypick_cli', 'CherryPick CLI')
|
||||
..addCommand(InitCommand());
|
||||
runner.run(args);
|
||||
}
|
||||
34
cherrypick_cli/lib/src/commands/init_command.dart
Normal file
34
cherrypick_cli/lib/src/commands/init_command.dart
Normal file
@@ -0,0 +1,34 @@
|
||||
import 'package:args/command_runner.dart';
|
||||
import '../utils/build_yaml_updater.dart';
|
||||
|
||||
class InitCommand extends Command {
|
||||
@override
|
||||
final name = 'init';
|
||||
@override
|
||||
final description = 'Adds or updates cherrypick_generator sections in build.yaml, preserving other packages.';
|
||||
|
||||
InitCommand() {
|
||||
argParser.addOption(
|
||||
'output_dir',
|
||||
abbr: 'o',
|
||||
defaultsTo: 'lib/generated',
|
||||
help: 'Directory for generated code.',
|
||||
);
|
||||
argParser.addOption(
|
||||
'build_yaml',
|
||||
abbr: 'f',
|
||||
defaultsTo: 'build.yaml',
|
||||
help: 'Path to build.yaml file.',
|
||||
);
|
||||
}
|
||||
|
||||
@override
|
||||
void run() {
|
||||
final outputDir = argResults?['output_dir'] as String? ?? 'lib/generated';
|
||||
final buildYaml = argResults?['build_yaml'] as String? ?? 'build.yaml';
|
||||
updateCherrypickBuildYaml(
|
||||
buildYamlPath: buildYaml,
|
||||
outputDir: outputDir,
|
||||
);
|
||||
}
|
||||
}
|
||||
76
cherrypick_cli/lib/src/utils/build_yaml_updater.dart
Normal file
76
cherrypick_cli/lib/src/utils/build_yaml_updater.dart
Normal file
@@ -0,0 +1,76 @@
|
||||
import 'dart:io';
|
||||
import 'package:yaml/yaml.dart';
|
||||
import 'package:json2yaml/json2yaml.dart';
|
||||
|
||||
void updateCherrypickBuildYaml({
|
||||
String buildYamlPath = 'build.yaml',
|
||||
String outputDir = 'lib/generated',
|
||||
}) {
|
||||
final file = File(buildYamlPath);
|
||||
final exists = file.existsSync();
|
||||
Map config = {};
|
||||
if (exists) {
|
||||
final content = file.readAsStringSync();
|
||||
final loaded = loadYaml(content);
|
||||
config = _deepYamlToMap(loaded);
|
||||
}
|
||||
|
||||
// Гарантируем вложенность
|
||||
config['targets'] ??= {};
|
||||
final targets = config['targets'] as Map;
|
||||
targets['\$default'] ??= {};
|
||||
final def = targets['\$default'] as Map;
|
||||
def['builders'] ??= {};
|
||||
final builders = def['builders'] as Map;
|
||||
|
||||
builders['cherrypick_generator|inject_generator'] = {
|
||||
'options': {
|
||||
'build_extensions': {
|
||||
'^lib/{{}}.dart': ['${outputDir}/{{}}.inject.cherrypick.g.dart']
|
||||
},
|
||||
'output_dir': outputDir
|
||||
},
|
||||
'generate_for': ['lib/**.dart']
|
||||
};
|
||||
|
||||
builders['cherrypick_generator|module_generator'] = {
|
||||
'options': {
|
||||
'build_extensions': {
|
||||
'^lib/di/{{}}.dart': ['${outputDir}/di/{{}}.module.cherrypick.g.dart']
|
||||
},
|
||||
'output_dir': outputDir
|
||||
},
|
||||
'generate_for': ['lib/**.dart']
|
||||
};
|
||||
|
||||
final yamlString = json2yaml(_stringifyKeys(config), yamlStyle: YamlStyle.pubspecYaml);
|
||||
file.writeAsStringSync(yamlString);
|
||||
print('✅ build.yaml has been successfully updated and formatted (cherrypick sections added/updated).');
|
||||
}
|
||||
|
||||
dynamic _stringifyKeys(dynamic node) {
|
||||
if (node is Map) {
|
||||
return Map.fromEntries(
|
||||
node.entries.map(
|
||||
(e) => MapEntry(e.key.toString(), _stringifyKeys(e.value)),
|
||||
),
|
||||
);
|
||||
} else if (node is List) {
|
||||
return node.map(_stringifyKeys).toList();
|
||||
} else {
|
||||
return node;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// Рекурсивно преобразует YamlMap/YamlList в обычные Map/List
|
||||
dynamic _deepYamlToMap(dynamic node) {
|
||||
if (node is YamlMap) {
|
||||
return Map.fromEntries(node.entries.map((e) => MapEntry(e.key, _deepYamlToMap(e.value))));
|
||||
} else if (node is YamlList) {
|
||||
return node.map(_deepYamlToMap).toList();
|
||||
} else {
|
||||
return node;
|
||||
}
|
||||
}
|
||||
|
||||
85
cherrypick_cli/pubspec.lock
Normal file
85
cherrypick_cli/pubspec.lock
Normal file
@@ -0,0 +1,85 @@
|
||||
# Generated by pub
|
||||
# See https://dart.dev/tools/pub/glossary#lockfile
|
||||
packages:
|
||||
args:
|
||||
dependency: "direct main"
|
||||
description:
|
||||
name: args
|
||||
sha256: d0481093c50b1da8910eb0bb301626d4d8eb7284aa739614d2b394ee09e3ea04
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.7.0"
|
||||
collection:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: collection
|
||||
sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.19.1"
|
||||
json2yaml:
|
||||
dependency: "direct main"
|
||||
description:
|
||||
name: json2yaml
|
||||
sha256: da94630fbc56079426fdd167ae58373286f603371075b69bf46d848d63ba3e51
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "3.0.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"
|
||||
source_span:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: source_span
|
||||
sha256: "254ee5351d6cb365c859e20ee823c3bb479bf4a293c22d17a9f1bf144ce86f7c"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.10.1"
|
||||
string_scanner:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: string_scanner
|
||||
sha256: "921cd31725b72fe181906c6a94d987c78e3b98c2e205b397ea399d4054872b43"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.4.1"
|
||||
term_glyph:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: term_glyph
|
||||
sha256: "7f554798625ea768a7518313e58f83891c7f5024f88e46e7182a4558850a4b8e"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.2.2"
|
||||
yaml:
|
||||
dependency: "direct main"
|
||||
description:
|
||||
name: yaml
|
||||
sha256: b9da305ac7c39faa3f030eccd175340f968459dae4af175130b3fc47e40d76ce
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "3.1.3"
|
||||
yaml_edit:
|
||||
dependency: "direct main"
|
||||
description:
|
||||
name: yaml_edit
|
||||
sha256: fb38626579fb345ad00e674e2af3a5c9b0cc4b9bfb8fd7f7ff322c7c9e62aef5
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.2.2"
|
||||
sdks:
|
||||
dart: ">=3.5.0 <4.0.0"
|
||||
13
cherrypick_cli/pubspec.yaml
Normal file
13
cherrypick_cli/pubspec.yaml
Normal file
@@ -0,0 +1,13 @@
|
||||
name: cherrypick_cli
|
||||
version: 0.1.0
|
||||
publish_to: none
|
||||
description: CLI tool for CherryPick DI ecosystem
|
||||
environment:
|
||||
sdk: ">=3.0.0 <4.0.0"
|
||||
dependencies:
|
||||
args: ^2.4.2
|
||||
yaml: ^3.1.2
|
||||
yaml_edit: ^2.1.1
|
||||
json2yaml: ^3.0.0
|
||||
executables:
|
||||
cherrypick_cli:
|
||||
@@ -1,3 +1,7 @@
|
||||
## 1.1.2-dev.2
|
||||
|
||||
- Update a dependency to the latest release.
|
||||
|
||||
## 1.1.2-dev.1
|
||||
|
||||
- Update a dependency to the latest release.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
name: cherrypick_flutter
|
||||
description: "Flutter library that allows access to the root scope through the context using `CherryPickProvider`."
|
||||
version: 1.1.2-dev.1
|
||||
version: 1.1.2-dev.2
|
||||
homepage: https://pese-git.github.io/cherrypick-site/
|
||||
documentation: https://github.com/pese-git/cherrypick/wiki
|
||||
repository: https://github.com/pese-git/cherrypick
|
||||
@@ -13,7 +13,7 @@ environment:
|
||||
dependencies:
|
||||
flutter:
|
||||
sdk: flutter
|
||||
cherrypick: ^2.2.0-dev.1
|
||||
cherrypick: ^2.2.0-dev.2
|
||||
|
||||
dev_dependencies:
|
||||
flutter_test:
|
||||
|
||||
4
cherrypick_generator/.gitignore
vendored
4
cherrypick_generator/.gitignore
vendored
@@ -25,4 +25,6 @@ doc/api/
|
||||
|
||||
melos_cherrypick_generator.iml
|
||||
|
||||
**/*.mocks.dart
|
||||
**/*.mocks.dart
|
||||
|
||||
coverage
|
||||
@@ -1,3 +1,23 @@
|
||||
## 1.1.0-dev.6
|
||||
|
||||
> Note: This release has breaking changes.
|
||||
|
||||
- **FIX**: format test code.
|
||||
- **FEAT**(generator): support output_dir and build_extensions config for generated files.
|
||||
- **BREAKING** **FEAT**(generator): complete code generation testing framework with 100% test coverage.
|
||||
|
||||
## 1.1.0-dev.5
|
||||
|
||||
- **FEAT**: implement tryResolve via generate code.
|
||||
|
||||
## 1.1.0-dev.4
|
||||
|
||||
- **FIX**: fixed warnings.
|
||||
|
||||
## 1.1.0-dev.3
|
||||
|
||||
- **FEAT**: implement InjectGenerator.
|
||||
|
||||
## 1.1.0-dev.2
|
||||
|
||||
- **FIX**: update instance generator code.
|
||||
|
||||
@@ -1,54 +1,139 @@
|
||||
# Cherrypick Generator
|
||||
|
||||
**Cherrypick Generator** is a Dart code generation library for automatic boilerplate creation in dependency injection (DI) modules. It processes classes annotated with `@module()` (from [cherrypick_annotations](https://pub.dev/packages/cherrypick_annotations)) and generates code for registering dependencies, handling singletons, named bindings, runtime parameters, and more.
|
||||
**Cherrypick Generator** is a Dart code generation library for automating dependency injection (DI) boilerplate. It processes classes and fields annotated with [cherrypick_annotations](https://pub.dev/packages/cherrypick_annotations) and generates registration code for services, modules, and field injection for classes marked as `@injectable`. It supports advanced DI features such as scopes, named bindings, parameters, and asynchronous dependencies.
|
||||
|
||||
---
|
||||
|
||||
### Advanced: Customizing Generated File Paths (`build_extensions`)
|
||||
|
||||
You can further control the filenames and subdirectory structure of generated files using the `build_extensions` option in `build.yaml`. This is especially useful in large apps for keeping DI artifacts organized under `lib/generated/` or any custom location.
|
||||
|
||||
**Example advanced build.yaml:**
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|inject_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/app.dart': ['lib/generated/app.inject.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
cherrypick_generator|module_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/di/{{}}.dart': ['lib/generated/di/{{}}.module.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
```
|
||||
|
||||
- **output_dir**: Path where all generated files are placed (e.g., `lib/generated`)
|
||||
- **build_extensions**: Allows templating of generated filenames and locations. You can use wildcards like `{{}}` to keep directory structure or group related files.
|
||||
|
||||
**If you use these options, be sure to update your imports accordingly, for example:**
|
||||
|
||||
```dart
|
||||
import 'package:your_package/generated/app.inject.cherrypick.g.dart';
|
||||
import 'package:your_package/generated/di/app_module.module.cherrypick.g.dart';
|
||||
```
|
||||
|
||||
### FAQ / Troubleshooting
|
||||
|
||||
- If files are missing or located in unexpected directories, double-check your `output_dir` and `build_extensions` configuration.
|
||||
- If you change generation paths, always update your imports in the codebase.
|
||||
- These options are backward compatible: omitting them preserves pre-existing (side-by-source) output behavior.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
- **Automatic Binding Generation:**
|
||||
Generates `bind<Type>()` registration code for every method in a DI module marked with `@module()`.
|
||||
- **Automatic Field Injection:**
|
||||
Detects classes annotated with `@injectable()`, and generates mixins to inject all fields annotated with `@inject()`, supporting scope and named qualifiers.
|
||||
|
||||
- **Support for DI Annotations:**
|
||||
Understands and processes meta-annotations such as `@singleton`, `@named`, `@instance`, `@provide`, and `@params`.
|
||||
- **Module and Service Registration:**
|
||||
For classes annotated with `@module()`, generates service registration code for methods using annotations such as `@provide`, `@instance`, `@singleton`, `@named`, and `@params`.
|
||||
|
||||
- **Runtime & Compile-Time Parameters:**
|
||||
Handles both injected (compile-time) and runtime parameters for provider/binding methods.
|
||||
- **Scope & Named Qualifier Support:**
|
||||
Supports advanced DI features:
|
||||
• Field-level scoping with `@scope('scopename')`
|
||||
• Named dependencies via `@named('value')`
|
||||
|
||||
- **Synchronous & Asynchronous Support:**
|
||||
Correctly distinguishes between synchronous and asynchronous bindings (including `Future<T>` return types).
|
||||
Handles both synchronous and asynchronous services (including `Future<T>`) for both field injection and module registration.
|
||||
|
||||
- **Named Bindings:**
|
||||
Allows registration of named services via the `@named()` annotation.
|
||||
- **Parameters and Runtime Arguments:**
|
||||
Recognizes and wires both injected dependencies and runtime parameters using `@params`.
|
||||
|
||||
- **Singletons:**
|
||||
Registers singletons via the `@singleton` annotation.
|
||||
- **Error Handling:**
|
||||
Validates annotations at generation time. Provides helpful errors for incorrect usage (e.g., using `@injectable` on non-class elements).
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **Annotations**
|
||||
Annotate your module classes and methods using `@module()`, `@instance`, `@provide`, `@singleton`, and `@named` as needed.
|
||||
### 1. Annotate your code
|
||||
|
||||
2. **Code Scanning**
|
||||
During the build process (with `build_runner`), the generator scans your annotated classes.
|
||||
Use annotations from [cherrypick_annotations](https://pub.dev/packages/cherrypick_annotations):
|
||||
|
||||
3. **Code Generation**
|
||||
For each `@module()` class, a new class (with a `$` prefix) is generated.
|
||||
This class overrides the `builder(Scope)` method to register all bindings.
|
||||
- `@injectable()` — on classes to enable field injection
|
||||
- `@inject()` — on fields to specify they should be injected
|
||||
- `@scope()`, `@named()` — on fields or parameters for advanced wiring
|
||||
- `@module()` — on classes to mark as DI modules
|
||||
- `@provide`, `@instance`, `@singleton`, `@params` — on methods and parameters for module-based DI
|
||||
|
||||
4. **Binding Logic**
|
||||
Each binding method's signature and annotations are analyzed. Registration code is generated according to:
|
||||
- Return type (sync/async)
|
||||
- Annotations (`@singleton`, `@named`, etc.)
|
||||
- Parameter list (DI dependencies, `@named`, or `@params` for runtime values)
|
||||
### 2. Run the generator
|
||||
|
||||
Use `build_runner` to process your code and generate `.module.cherrypick.g.dart` and `.inject.cherrypick.g.dart` files.
|
||||
|
||||
### 3. Use the output in your application
|
||||
|
||||
- For modules: Register DI providers using the generated `$YourModule` class.
|
||||
- For services: Enable field injection on classes using the generated mixin.
|
||||
|
||||
---
|
||||
|
||||
## Example
|
||||
## Field Injection Example
|
||||
|
||||
Given the following annotated Dart code:
|
||||
Given the following:
|
||||
|
||||
```dart
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
@injectable()
|
||||
class MyWidget with _$MyWidget {
|
||||
@inject()
|
||||
late final AuthService auth;
|
||||
|
||||
@inject()
|
||||
@scope('profile')
|
||||
late final ProfileManager manager;
|
||||
|
||||
@inject()
|
||||
@named('special')
|
||||
late final ApiClient specialApi;
|
||||
}
|
||||
```
|
||||
|
||||
**The generator will output (simplified):**
|
||||
```dart
|
||||
mixin _$MyWidget {
|
||||
void _inject(MyWidget instance) {
|
||||
instance.auth = CherryPick.openRootScope().resolve<AuthService>();
|
||||
instance.manager = CherryPick.openScope(scopeName: 'profile').resolve<ProfileManager>();
|
||||
instance.specialApi = CherryPick.openRootScope().resolve<ApiClient>(named: 'special');
|
||||
}
|
||||
}
|
||||
```
|
||||
You can then mix this into your widget to enable automatic DI at runtime.
|
||||
|
||||
---
|
||||
|
||||
## Module Registration Example
|
||||
|
||||
Given:
|
||||
|
||||
```dart
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
@@ -57,98 +142,112 @@ import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
class MyModule {
|
||||
@singleton
|
||||
@instance
|
||||
SomeService provideService(ApiClient client);
|
||||
AuthService provideAuth(Api api);
|
||||
|
||||
@provide
|
||||
@named('special')
|
||||
Future<Handler> createHandler(@params Map<String, dynamic> params);
|
||||
@named('logging')
|
||||
Future<Logger> provideLogger(@params Map<String, dynamic> args);
|
||||
}
|
||||
```
|
||||
|
||||
The generator will output (simplified):
|
||||
|
||||
**The generator will output (simplified):**
|
||||
```dart
|
||||
final class $MyModule extends MyModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<SomeService>()
|
||||
.toInstance(provideService(currentScope.resolve<ApiClient>()))
|
||||
bind<AuthService>()
|
||||
.toInstance(provideAuth(currentScope.resolve<Api>()))
|
||||
.singleton();
|
||||
|
||||
bind<Handler>()
|
||||
.toProvideAsyncWithParams((args) => createHandler(args))
|
||||
.withName('special');
|
||||
bind<Logger>()
|
||||
.toProvideAsyncWithParams((args) => provideLogger(args))
|
||||
.withName('logging');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Generated Code Overview
|
||||
## Key Points
|
||||
|
||||
- **Constructor Registration:**
|
||||
All non-abstract methods are considered as providers and processed for DI registration.
|
||||
|
||||
- **Parameter Handling:**
|
||||
Each method parameter is analyzed:
|
||||
- Standard DI dependency: resolved via `currentScope.resolve<Type>()`.
|
||||
- Named dependency: resolved via `currentScope.resolve<Type>(named: 'name')`.
|
||||
- Runtime parameter (`@params`): passed through as-is (e.g., `args`).
|
||||
|
||||
- **Binding Types:**
|
||||
Supports both `.toInstance()` and `.toProvide()` (including async variants).
|
||||
|
||||
- **Singleton/Named:**
|
||||
Appends `.singleton()` and/or `.withName('name')` as appropriate.
|
||||
- **Rich Annotation Support:**
|
||||
Mix and match field, parameter, and method annotations for maximum flexibility.
|
||||
- **Scope and Named Resolution:**
|
||||
Use `@scope('...')` and `@named('...')` to precisely control where and how dependencies are wired.
|
||||
- **Async/Synchronous:**
|
||||
The generator distinguishes between sync (`resolve<T>`) and async (`resolveAsync<T>`) dependencies.
|
||||
- **Automatic Mixins:**
|
||||
For classes with `@injectable()`, a mixin is generated that injects all relevant fields (using constructor or setter).
|
||||
- **Comprehensive Error Checking:**
|
||||
Misapplied annotations (e.g., `@injectable()` on non-class) produce clear build-time errors.
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
1. **Add dependencies**
|
||||
In your `pubspec.yaml`:
|
||||
1. **Add dependencies**
|
||||
|
||||
```yaml
|
||||
dependencies:
|
||||
cherrypick_annotations: ^x.y.z
|
||||
cherrypick_annotations: ^latest
|
||||
|
||||
dev_dependencies:
|
||||
cherrypick_generator: ^latest
|
||||
build_runner: ^2.1.0
|
||||
cherrypick_generator: ^x.y.z
|
||||
```
|
||||
|
||||
2. **Apply annotations**
|
||||
Annotate your DI modules and provider methods as shown above.
|
||||
2. **Annotate your classes and modules as above**
|
||||
|
||||
3. **Run the generator**
|
||||
```
|
||||
3. **Run the generator**
|
||||
|
||||
```shell
|
||||
dart run build_runner build
|
||||
# or with Flutter:
|
||||
# or, if using Flutter:
|
||||
flutter pub run build_runner build
|
||||
```
|
||||
|
||||
4. **Import and use the generated code**
|
||||
The generated files (suffix `.cherrypick.g.dart`) contain your `$YourModule` classes ready for use with your DI framework.
|
||||
4. **Use generated code**
|
||||
|
||||
- Import the generated `.inject.cherrypick.g.dart` or `.cherrypick.g.dart` files where needed
|
||||
|
||||
---
|
||||
|
||||
## Advanced
|
||||
## Advanced Usage
|
||||
|
||||
- **Customizing Parameter Names:**
|
||||
Use the `@named('value')` annotation on methods and parameters for named bindings.
|
||||
### Custom output directory for generated code (output_dir)
|
||||
|
||||
- **Runtime Arguments:**
|
||||
Use `@params` to designate parameters as runtime arguments that are supplied at injection time.
|
||||
You can control the directory where the generated files (`*.inject.cherrypick.g.dart`, `*.module.cherrypick.g.dart`) are placed using the `output_dir` option in your `build.yaml`:
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|injectBuilder:
|
||||
options:
|
||||
output_dir: lib/generated
|
||||
cherrypick_generator|moduleBuilder:
|
||||
options:
|
||||
output_dir: lib/generated
|
||||
```
|
||||
|
||||
**If `output_dir` is omitted, generated files are placed next to the original sources (default behavior).**
|
||||
|
||||
After running code generation, you will find files like `lib/generated/app.inject.cherrypick.g.dart` and `lib/generated/your_module.module.cherrypick.g.dart`. You can import them as needed from that directory.
|
||||
|
||||
- **Combining Modules and Field Injection:**
|
||||
It's possible to mix both style of DI — modules for binding, and field injection for consuming services.
|
||||
- **Parameter and Named Injection:**
|
||||
Use `@named` on both provider and parameter for named registration and lookup; use `@params` to pass runtime arguments.
|
||||
- **Async Factories:**
|
||||
Methods returning `Future<T>` generate the appropriate `.toProvideAsync()` or `.toInstanceAsync()` bindings.
|
||||
Methods returning Future<T> generate async bindings and async field resolution logic.
|
||||
|
||||
---
|
||||
|
||||
## Developer Notes
|
||||
|
||||
- The generator relies on Dart's analyzer, source_gen, and build packages.
|
||||
- Each class and method is parsed for annotations; missing required annotations (like `@instance` or `@provide`) will result in a generation error.
|
||||
- The generated code is designed to extend your original module classes while injecting all binding logic.
|
||||
- The generator relies on the Dart analyzer, `source_gen`, and `build` packages.
|
||||
- All classes and methods are parsed for annotations.
|
||||
- Improper annotation usage will result in generator errors.
|
||||
|
||||
---
|
||||
|
||||
@@ -162,6 +261,7 @@ Licensed under the Apache License, Version 2.0
|
||||
|
||||
## Contribution
|
||||
|
||||
Pull requests and issues are welcome! Please open git issues or submit improvements as needed.
|
||||
Pull requests and issues are welcome! Please open GitHub issues or submit improvements.
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
@@ -28,3 +28,7 @@ include: package:lints/recommended.yaml
|
||||
|
||||
# For additional information about configuring this file, see
|
||||
# https://dart.dev/guides/language/analysis-options
|
||||
|
||||
analyzer:
|
||||
errors:
|
||||
deprecated_member_use: ignore
|
||||
@@ -1,16 +1,25 @@
|
||||
builders:
|
||||
inject_generator:
|
||||
import: "package:cherrypick_generator/inject_generator.dart"
|
||||
builder_factories: ["injectBuilder"]
|
||||
build_extensions: {".dart": [".inject.cherrypick.g.dart"]}
|
||||
auto_apply: dependents
|
||||
build_to: source
|
||||
applies_builders: ["source_gen|combining_builder"]
|
||||
module_generator:
|
||||
import: "package:cherrypick_generator/module_generator.dart"
|
||||
builder_factories: ["moduleBuilder"]
|
||||
build_extensions: {".dart": [".cherrypick.g.dart"]}
|
||||
build_extensions: {".dart": [".module.cherrypick.g.dart"]}
|
||||
auto_apply: dependents
|
||||
required_inputs: ["lib/**"]
|
||||
runs_before: []
|
||||
build_to: source
|
||||
applies_builders: ["source_gen|combining_builder"]
|
||||
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|module_generator:
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
- lib/**.dart
|
||||
cherrypick_generator|inject_generator:
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
|
||||
137
cherrypick_generator/coverage_analysis.py
Normal file
137
cherrypick_generator/coverage_analysis.py
Normal file
@@ -0,0 +1,137 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Анализ покрытия тестами для CherryPick Generator
|
||||
"""
|
||||
|
||||
import re
|
||||
import os
|
||||
|
||||
def analyze_lcov_file(lcov_path):
|
||||
"""Анализирует LCOV файл и возвращает статистику покрытия"""
|
||||
|
||||
if not os.path.exists(lcov_path):
|
||||
print(f"❌ LCOV файл не найден: {lcov_path}")
|
||||
return
|
||||
|
||||
with open(lcov_path, 'r') as f:
|
||||
content = f.read()
|
||||
|
||||
# Разбиваем на секции по файлам
|
||||
file_sections = content.split('SF:')[1:] # Убираем первую пустую секцию
|
||||
|
||||
total_lines = 0
|
||||
total_hit = 0
|
||||
files_coverage = {}
|
||||
|
||||
for section in file_sections:
|
||||
lines = section.strip().split('\n')
|
||||
if not lines:
|
||||
continue
|
||||
|
||||
file_path = lines[0]
|
||||
file_name = os.path.basename(file_path)
|
||||
|
||||
# Подсчитываем строки
|
||||
da_lines = [line for line in lines if line.startswith('DA:')]
|
||||
|
||||
file_total = len(da_lines)
|
||||
file_hit = 0
|
||||
|
||||
for da_line in da_lines:
|
||||
# DA:line_number,hit_count
|
||||
parts = da_line.split(',')
|
||||
if len(parts) >= 2:
|
||||
hit_count = int(parts[1])
|
||||
if hit_count > 0:
|
||||
file_hit += 1
|
||||
|
||||
if file_total > 0:
|
||||
coverage_percent = (file_hit / file_total) * 100
|
||||
files_coverage[file_name] = {
|
||||
'total': file_total,
|
||||
'hit': file_hit,
|
||||
'percent': coverage_percent
|
||||
}
|
||||
|
||||
total_lines += file_total
|
||||
total_hit += file_hit
|
||||
|
||||
# Общая статистика
|
||||
overall_percent = (total_hit / total_lines) * 100 if total_lines > 0 else 0
|
||||
|
||||
print("📊 АНАЛИЗ ПОКРЫТИЯ ТЕСТАМИ CHERRYPICK GENERATOR")
|
||||
print("=" * 60)
|
||||
|
||||
print(f"\n🎯 ОБЩАЯ СТАТИСТИКА:")
|
||||
print(f" Всего строк кода: {total_lines}")
|
||||
print(f" Покрыто тестами: {total_hit}")
|
||||
print(f" Общее покрытие: {overall_percent:.1f}%")
|
||||
|
||||
print(f"\n📁 ПОКРЫТИЕ ПО ФАЙЛАМ:")
|
||||
|
||||
# Сортируем по проценту покрытия
|
||||
sorted_files = sorted(files_coverage.items(), key=lambda x: x[1]['percent'], reverse=True)
|
||||
|
||||
for file_name, stats in sorted_files:
|
||||
percent = stats['percent']
|
||||
hit = stats['hit']
|
||||
total = stats['total']
|
||||
|
||||
# Эмодзи в зависимости от покрытия
|
||||
if percent >= 80:
|
||||
emoji = "✅"
|
||||
elif percent >= 50:
|
||||
emoji = "🟡"
|
||||
else:
|
||||
emoji = "❌"
|
||||
|
||||
print(f" {emoji} {file_name:<25} {hit:>3}/{total:<3} ({percent:>5.1f}%)")
|
||||
|
||||
print(f"\n🏆 РЕЙТИНГ КОМПОНЕНТОВ:")
|
||||
|
||||
# Группируем по типам компонентов
|
||||
core_files = ['bind_spec.dart', 'bind_parameters_spec.dart', 'generated_class.dart']
|
||||
utils_files = ['metadata_utils.dart']
|
||||
generator_files = ['module_generator.dart', 'inject_generator.dart']
|
||||
|
||||
def calculate_group_coverage(file_list):
|
||||
group_total = sum(files_coverage.get(f, {}).get('total', 0) for f in file_list)
|
||||
group_hit = sum(files_coverage.get(f, {}).get('hit', 0) for f in file_list)
|
||||
return (group_hit / group_total * 100) if group_total > 0 else 0
|
||||
|
||||
core_coverage = calculate_group_coverage(core_files)
|
||||
utils_coverage = calculate_group_coverage(utils_files)
|
||||
generators_coverage = calculate_group_coverage(generator_files)
|
||||
|
||||
print(f" 🔧 Core Components: {core_coverage:>5.1f}%")
|
||||
print(f" 🛠️ Utils: {utils_coverage:>5.1f}%")
|
||||
print(f" ⚙️ Generators: {generators_coverage:>5.1f}%")
|
||||
|
||||
print(f"\n📈 РЕКОМЕНДАЦИИ:")
|
||||
|
||||
# Файлы с низким покрытием
|
||||
low_coverage = [(f, s) for f, s in files_coverage.items() if s['percent'] < 50]
|
||||
if low_coverage:
|
||||
print(" 🎯 Приоритет для улучшения:")
|
||||
for file_name, stats in sorted(low_coverage, key=lambda x: x[1]['percent']):
|
||||
print(f" • {file_name} ({stats['percent']:.1f}%)")
|
||||
|
||||
# Файлы без покрытия
|
||||
zero_coverage = [(f, s) for f, s in files_coverage.items() if s['percent'] == 0]
|
||||
if zero_coverage:
|
||||
print(" ❗ Требуют срочного внимания:")
|
||||
for file_name, stats in zero_coverage:
|
||||
print(f" • {file_name} (0% покрытия)")
|
||||
|
||||
print(f"\n✨ ДОСТИЖЕНИЯ:")
|
||||
high_coverage = [(f, s) for f, s in files_coverage.items() if s['percent'] >= 80]
|
||||
if high_coverage:
|
||||
print(" 🏅 Отлично протестированы:")
|
||||
for file_name, stats in sorted(high_coverage, key=lambda x: x[1]['percent'], reverse=True):
|
||||
print(f" • {file_name} ({stats['percent']:.1f}%)")
|
||||
|
||||
return files_coverage, overall_percent
|
||||
|
||||
if __name__ == "__main__":
|
||||
lcov_path = "coverage/lcov.info"
|
||||
analyze_lcov_file(lcov_path)
|
||||
110
cherrypick_generator/lib/cherrypick_custom_builders.dart
Normal file
110
cherrypick_generator/lib/cherrypick_custom_builders.dart
Normal file
@@ -0,0 +1,110 @@
|
||||
import 'dart:async';
|
||||
import 'package:build/build.dart';
|
||||
import 'package:path/path.dart' as p;
|
||||
import 'package:source_gen/source_gen.dart';
|
||||
import 'inject_generator.dart';
|
||||
import 'module_generator.dart';
|
||||
|
||||
/// Универсальный Builder для генераторов Cherrypick с поддержкой кастомного output_dir
|
||||
/// (указывает директорию для складывания сгенерированных файлов через build.yaml)
|
||||
class CustomOutputBuilder extends Builder {
|
||||
final Generator generator;
|
||||
final String extension;
|
||||
final String outputDir;
|
||||
final Map<String, List<String>> customBuildExtensions;
|
||||
|
||||
CustomOutputBuilder(this.generator, this.extension, this.outputDir, this.customBuildExtensions);
|
||||
|
||||
@override
|
||||
Map<String, List<String>> get buildExtensions {
|
||||
if (customBuildExtensions.isNotEmpty) {
|
||||
return customBuildExtensions;
|
||||
}
|
||||
// Дефолт: рядом с исходником, как PartBuilder
|
||||
return {
|
||||
'.dart': [extension],
|
||||
};
|
||||
}
|
||||
|
||||
@override
|
||||
Future<void> build(BuildStep buildStep) async {
|
||||
final inputId = buildStep.inputId;
|
||||
print('[CustomOutputBuilder] build() called for input: \\${inputId.path}');
|
||||
final library = await buildStep.resolver.libraryFor(inputId);
|
||||
print('[CustomOutputBuilder] resolved library for: \\${inputId.path}');
|
||||
final generated = await generator.generate(LibraryReader(library), buildStep);
|
||||
print('[CustomOutputBuilder] gen result for input: \\${inputId.path}, isNull: \\${generated == null}, isEmpty: \\${generated?.isEmpty}');
|
||||
if (generated == null || generated.isEmpty) return;
|
||||
String outputPath;
|
||||
if (customBuildExtensions.isNotEmpty) {
|
||||
// Кастомная директория/шаблон
|
||||
final inputPath = inputId.path;
|
||||
final relativeInput = p.relative(inputPath, from: 'lib/');
|
||||
final parts = p.split(relativeInput);
|
||||
String subdir = '';
|
||||
String baseName = parts.last.replaceAll('.dart', '');
|
||||
if (parts.length > 1) {
|
||||
subdir = parts.first; // Например, 'di'
|
||||
}
|
||||
outputPath = subdir.isEmpty
|
||||
? p.join('lib', 'generated', '$baseName$extension')
|
||||
: p.join('lib', 'generated', subdir, '$baseName$extension');
|
||||
} else {
|
||||
// Дефолт: рядом с исходником
|
||||
outputPath = p.setExtension(inputId.path, extension);
|
||||
}
|
||||
final outputId = AssetId(inputId.package, outputPath);
|
||||
// part of - всегда авто!
|
||||
final partOfPath = p.relative(inputId.path, from: p.dirname(outputPath));
|
||||
|
||||
// Check if generated code starts with formatting header
|
||||
String finalCode;
|
||||
if (generated.startsWith('// dart format width=80')) {
|
||||
// Find the end of the header (after "// GENERATED CODE - DO NOT MODIFY BY HAND")
|
||||
final lines = generated.split('\n');
|
||||
int headerEndIndex = -1;
|
||||
|
||||
for (int i = 0; i < lines.length; i++) {
|
||||
if (lines[i].startsWith('// GENERATED CODE - DO NOT MODIFY BY HAND')) {
|
||||
headerEndIndex = i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (headerEndIndex != -1) {
|
||||
// Insert part of directive after the header
|
||||
final headerLines = lines.sublist(0, headerEndIndex + 1);
|
||||
final remainingLines = lines.sublist(headerEndIndex + 1);
|
||||
|
||||
final headerPart = headerLines.join('\n');
|
||||
final remainingPart = remainingLines.join('\n');
|
||||
|
||||
// Preserve trailing newline if original had one
|
||||
final hasTrailingNewline = generated.endsWith('\n');
|
||||
finalCode = '$headerPart\n\npart of \'$partOfPath\';\n$remainingPart${hasTrailingNewline ? '' : '\n'}';
|
||||
} else {
|
||||
// Fallback: add part of at the beginning
|
||||
finalCode = "part of '$partOfPath';\n\n$generated";
|
||||
}
|
||||
} else {
|
||||
// No header, add part of at the beginning
|
||||
finalCode = "part of '$partOfPath';\n\n$generated";
|
||||
}
|
||||
|
||||
print('[CustomOutputBuilder] writing to output: \\${outputId.path}');
|
||||
await buildStep.writeAsString(outputId, finalCode);
|
||||
print('[CustomOutputBuilder] successfully written for input: \\${inputId.path}');
|
||||
}
|
||||
}
|
||||
|
||||
Builder injectCustomBuilder(BuilderOptions options) {
|
||||
final outputDir = options.config['output_dir'] as String? ?? '';
|
||||
final buildExtensions = (options.config['build_extensions'] as Map?)?.map((k,v)=>MapEntry(k.toString(), (v as List).map((item)=>item.toString()).toList())) ?? {};
|
||||
return CustomOutputBuilder(InjectGenerator(), '.inject.cherrypick.g.dart', outputDir, buildExtensions);
|
||||
}
|
||||
|
||||
Builder moduleCustomBuilder(BuilderOptions options) {
|
||||
final outputDir = options.config['output_dir'] as String? ?? '';
|
||||
final buildExtensions = (options.config['build_extensions'] as Map?)?.map((k,v)=>MapEntry(k.toString(), (v as List).map((item)=>item.toString()).toList())) ?? {};
|
||||
return CustomOutputBuilder(ModuleGenerator(), '.module.cherrypick.g.dart', outputDir, buildExtensions);
|
||||
}
|
||||
@@ -14,3 +14,4 @@ library;
|
||||
//
|
||||
|
||||
export 'module_generator.dart';
|
||||
export 'inject_generator.dart';
|
||||
|
||||
267
cherrypick_generator/lib/inject_generator.dart
Normal file
267
cherrypick_generator/lib/inject_generator.dart
Normal file
@@ -0,0 +1,267 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'dart:async';
|
||||
import 'package:analyzer/dart/constant/value.dart';
|
||||
|
||||
|
||||
import 'package:build/build.dart';
|
||||
import 'package:source_gen/source_gen.dart';
|
||||
import 'package:analyzer/dart/element/element.dart';
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart' as ann;
|
||||
import 'cherrypick_custom_builders.dart' as custom;
|
||||
import 'src/exceptions.dart';
|
||||
import 'src/type_parser.dart';
|
||||
import 'src/annotation_validator.dart';
|
||||
|
||||
/// InjectGenerator generates a mixin for a class marked with @injectable()
|
||||
/// and injects all fields annotated with @inject(), using CherryPick DI.
|
||||
///
|
||||
/// For Future<T> fields it calls .resolveAsync<T>(),
|
||||
/// otherwise .resolve<T>() is used. Scope and named qualifiers are supported.
|
||||
///
|
||||
/// ---
|
||||
///
|
||||
/// InjectGenerator генерирует миксин для класса с аннотацией @injectable()
|
||||
/// и внедряет все поля, помеченные @inject(), используя DI-фреймворк CherryPick.
|
||||
///
|
||||
/// Для Future<T> полей вызывается .resolveAsync<T>(),
|
||||
/// для остальных — .resolve<T>(). Поддерживаются scope и named qualifier.
|
||||
///
|
||||
class InjectGenerator extends GeneratorForAnnotation<ann.injectable> {
|
||||
const InjectGenerator();
|
||||
|
||||
/// The main entry point for code generation.
|
||||
///
|
||||
/// Checks class validity, collects injectable fields, and produces injection code.
|
||||
///
|
||||
/// Основная точка входа генератора. Проверяет класс, собирает инъектируемые поля и создает код внедрения зависимостей.
|
||||
@override
|
||||
FutureOr<String> generateForAnnotatedElement(
|
||||
Element element,
|
||||
ConstantReader annotation,
|
||||
BuildStep buildStep,
|
||||
) {
|
||||
if (element is! ClassElement) {
|
||||
throw CherryPickGeneratorException(
|
||||
'@injectable() can only be applied to classes',
|
||||
element: element,
|
||||
category: 'INVALID_TARGET',
|
||||
suggestion: 'Apply @injectable() to a class instead of ${element.runtimeType}',
|
||||
);
|
||||
}
|
||||
|
||||
final classElement = element;
|
||||
|
||||
try {
|
||||
// Validate class annotations
|
||||
AnnotationValidator.validateClassAnnotations(classElement);
|
||||
|
||||
return _generateInjectionCode(classElement);
|
||||
} catch (e) {
|
||||
if (e is CherryPickGeneratorException) {
|
||||
rethrow;
|
||||
}
|
||||
throw CodeGenerationException(
|
||||
'Failed to generate injection code: $e',
|
||||
element: classElement,
|
||||
suggestion: 'Check that all @inject fields have valid types and annotations',
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/// Generates the injection code for a class
|
||||
String _generateInjectionCode(ClassElement classElement) {
|
||||
final className = classElement.name;
|
||||
final mixinName = '_\$$className';
|
||||
|
||||
// Collect and process all @inject fields.
|
||||
final injectFields = classElement.fields
|
||||
.where(_isInjectField)
|
||||
.map((field) => _parseInjectField(field, classElement))
|
||||
.toList();
|
||||
|
||||
final buffer = StringBuffer()
|
||||
..writeln('// dart format width=80')
|
||||
..writeln('// GENERATED CODE - DO NOT MODIFY BY HAND')
|
||||
..writeln()
|
||||
..writeln('// **************************************************************************')
|
||||
..writeln('// InjectGenerator')
|
||||
..writeln('// **************************************************************************')
|
||||
..writeln()
|
||||
..writeln('mixin $mixinName {');
|
||||
|
||||
if (injectFields.isEmpty) {
|
||||
// For empty classes, generate a method with empty body
|
||||
buffer.writeln(' void _inject($className instance) {}');
|
||||
} else {
|
||||
buffer.writeln(' void _inject($className instance) {');
|
||||
for (final parsedField in injectFields) {
|
||||
buffer.writeln(_generateInjectionLine(parsedField));
|
||||
}
|
||||
buffer.writeln(' }');
|
||||
}
|
||||
|
||||
buffer.writeln('}');
|
||||
|
||||
return '${buffer.toString()}\n';
|
||||
}
|
||||
|
||||
/// Checks if a field has the @inject annotation.
|
||||
///
|
||||
/// Проверяет, отмечено ли поле аннотацией @inject.
|
||||
static bool _isInjectField(FieldElement field) {
|
||||
return field.metadata.any(
|
||||
(m) => m.computeConstantValue()?.type?.getDisplayString() == 'inject',
|
||||
);
|
||||
}
|
||||
|
||||
/// Parses the field for scope/named qualifiers and determines its type.
|
||||
/// Returns a [_ParsedInjectField] describing injection information.
|
||||
///
|
||||
/// Разбирает поле на наличие модификаторов scope/named и выясняет его тип.
|
||||
/// Возвращает [_ParsedInjectField] с информацией о внедрении.
|
||||
static _ParsedInjectField _parseInjectField(FieldElement field, ClassElement classElement) {
|
||||
try {
|
||||
// Validate field annotations
|
||||
AnnotationValidator.validateFieldAnnotations(field);
|
||||
|
||||
// Parse type using improved type parser
|
||||
final parsedType = TypeParser.parseType(field.type, field);
|
||||
TypeParser.validateInjectableType(parsedType, field);
|
||||
|
||||
// Extract metadata
|
||||
String? scopeName;
|
||||
String? namedValue;
|
||||
|
||||
for (final meta in field.metadata) {
|
||||
final DartObject? obj = meta.computeConstantValue();
|
||||
final type = obj?.type?.getDisplayString();
|
||||
if (type == 'scope') {
|
||||
scopeName = obj?.getField('name')?.toStringValue();
|
||||
} else if (type == 'named') {
|
||||
namedValue = obj?.getField('value')?.toStringValue();
|
||||
}
|
||||
}
|
||||
|
||||
return _ParsedInjectField(
|
||||
fieldName: field.name,
|
||||
parsedType: parsedType,
|
||||
scopeName: scopeName,
|
||||
namedValue: namedValue,
|
||||
);
|
||||
} catch (e) {
|
||||
if (e is CherryPickGeneratorException) {
|
||||
rethrow;
|
||||
}
|
||||
throw DependencyResolutionException(
|
||||
'Failed to parse inject field "${field.name}"',
|
||||
element: field,
|
||||
suggestion: 'Check that the field type is valid and properly imported',
|
||||
context: {
|
||||
'field_name': field.name,
|
||||
'field_type': field.type.getDisplayString(),
|
||||
'class_name': classElement.name,
|
||||
'error': e.toString(),
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/// Generates a line of code that performs the dependency injection for a field.
|
||||
/// Handles resolve/resolveAsync, scoping, and named qualifiers.
|
||||
///
|
||||
/// Генерирует строку кода, которая внедряет зависимость для поля.
|
||||
/// Учитывает resolve/resolveAsync, scoping и named qualifier.
|
||||
String _generateInjectionLine(_ParsedInjectField field) {
|
||||
final resolveMethod = '${field.parsedType.resolveMethodName}<${field.parsedType.codeGenType}>';
|
||||
final fieldName = field.fieldName;
|
||||
|
||||
// Build the scope call
|
||||
final openCall = (field.scopeName != null && field.scopeName!.isNotEmpty)
|
||||
? "CherryPick.openScope(scopeName: '${field.scopeName}')"
|
||||
: "CherryPick.openRootScope()";
|
||||
|
||||
// Build the parameters
|
||||
final hasNamedParam = field.namedValue != null && field.namedValue!.isNotEmpty;
|
||||
final params = hasNamedParam ? "(named: '${field.namedValue}')" : '()';
|
||||
|
||||
// Create the full line
|
||||
final fullLine = " instance.$fieldName = $openCall.$resolveMethod$params;";
|
||||
|
||||
// Check if line is too long (dart format width=80, accounting for indentation)
|
||||
if (fullLine.length <= 80) {
|
||||
return fullLine;
|
||||
}
|
||||
|
||||
// Format long lines with proper line breaks
|
||||
if (hasNamedParam && field.scopeName != null && field.scopeName!.isNotEmpty) {
|
||||
// For scoped calls with named parameters, break after openScope
|
||||
return " instance.$fieldName = CherryPick.openScope(\n"
|
||||
" scopeName: '${field.scopeName}',\n"
|
||||
" ).$resolveMethod(named: '${field.namedValue}');";
|
||||
} else if (hasNamedParam) {
|
||||
// For named parameters without scope, break after the method call
|
||||
return " instance.$fieldName = $openCall.$resolveMethod(\n"
|
||||
" named: '${field.namedValue}',\n"
|
||||
" );";
|
||||
} else if (field.scopeName != null && field.scopeName!.isNotEmpty) {
|
||||
// For scoped calls without named params, break after openScope with proper parameter formatting
|
||||
return " instance.$fieldName = CherryPick.openScope(\n"
|
||||
" scopeName: '${field.scopeName}',\n"
|
||||
" ).$resolveMethod();";
|
||||
} else {
|
||||
// For simple long calls, break after openRootScope
|
||||
return " instance.$fieldName = $openCall\n"
|
||||
" .$resolveMethod();";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Data structure representing all information required to generate
|
||||
/// injection code for a field.
|
||||
///
|
||||
/// Структура данных, содержащая всю информацию,
|
||||
/// необходимую для генерации кода внедрения для поля.
|
||||
class _ParsedInjectField {
|
||||
/// The name of the field / Имя поля.
|
||||
final String fieldName;
|
||||
|
||||
/// Parsed type information / Информация о типе поля.
|
||||
final ParsedType parsedType;
|
||||
|
||||
/// Optional scope annotation argument / Опциональное имя scope.
|
||||
final String? scopeName;
|
||||
|
||||
/// Optional named annotation argument / Опциональное имя named.
|
||||
final String? namedValue;
|
||||
|
||||
_ParsedInjectField({
|
||||
required this.fieldName,
|
||||
required this.parsedType,
|
||||
this.scopeName,
|
||||
this.namedValue,
|
||||
});
|
||||
|
||||
@override
|
||||
String toString() {
|
||||
return '_ParsedInjectField(fieldName: $fieldName, parsedType: $parsedType, '
|
||||
'scopeName: $scopeName, namedValue: $namedValue)';
|
||||
}
|
||||
}
|
||||
|
||||
/// Builder factory. Used by build_runner.
|
||||
///
|
||||
/// Фабрика билдера. Используется build_runner.
|
||||
Builder injectBuilder(BuilderOptions options) =>
|
||||
custom.injectCustomBuilder(options);
|
||||
@@ -15,9 +15,10 @@ import 'package:analyzer/dart/element/element.dart';
|
||||
import 'package:build/build.dart';
|
||||
import 'package:source_gen/source_gen.dart';
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart' as ann;
|
||||
|
||||
import 'src/generated_class.dart';
|
||||
|
||||
import 'src/exceptions.dart';
|
||||
import 'src/annotation_validator.dart';
|
||||
import 'cherrypick_custom_builders.dart' as custom;
|
||||
/// ---------------------------------------------------------------------------
|
||||
/// ModuleGenerator for code generation of dependency-injected modules.
|
||||
///
|
||||
@@ -62,20 +63,40 @@ class ModuleGenerator extends GeneratorForAnnotation<ann.module> {
|
||||
// Only classes are supported for @module() annotation
|
||||
// Обрабатываются только классы (другие элементы — ошибка)
|
||||
if (element is! ClassElement) {
|
||||
throw InvalidGenerationSourceError(
|
||||
'@module() can only be applied to classes. / @module() может быть применён только к классам.',
|
||||
throw CherryPickGeneratorException(
|
||||
'@module() can only be applied to classes',
|
||||
element: element,
|
||||
category: 'INVALID_TARGET',
|
||||
suggestion: 'Apply @module() to a class instead of ${element.runtimeType}',
|
||||
);
|
||||
}
|
||||
|
||||
final classElement = element;
|
||||
|
||||
// Build a representation of the generated bindings based on class methods /
|
||||
// Создаёт объект, описывающий, какие биндинги нужно сгенерировать на основании методов класса
|
||||
final generatedClass = GeneratedClass.fromClassElement(classElement);
|
||||
try {
|
||||
// Validate class annotations
|
||||
AnnotationValidator.validateClassAnnotations(classElement);
|
||||
|
||||
// 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();
|
||||
// Generate the resulting Dart code
|
||||
return generatedClass.generate();
|
||||
} catch (e) {
|
||||
if (e is CherryPickGeneratorException) {
|
||||
rethrow;
|
||||
}
|
||||
throw CodeGenerationException(
|
||||
'Failed to generate module code for class "${classElement.name}"',
|
||||
element: classElement,
|
||||
suggestion: 'Check that all methods have valid @instance or @provide annotations',
|
||||
context: {
|
||||
'class_name': classElement.name,
|
||||
'method_count': classElement.methods.length,
|
||||
'error': e.toString(),
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -89,5 +110,8 @@ class ModuleGenerator extends GeneratorForAnnotation<ann.module> {
|
||||
/// Возвращает Builder, используемый build_runner для генерации кода для всех
|
||||
/// файлов, где встречается @module().
|
||||
/// ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
|
||||
Builder moduleBuilder(BuilderOptions options) =>
|
||||
PartBuilder([ModuleGenerator()], '.cherrypick.g.dart');
|
||||
custom.moduleCustomBuilder(options);
|
||||
314
cherrypick_generator/lib/src/annotation_validator.dart
Normal file
314
cherrypick_generator/lib/src/annotation_validator.dart
Normal file
@@ -0,0 +1,314 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:analyzer/dart/element/element.dart';
|
||||
import 'exceptions.dart';
|
||||
import 'metadata_utils.dart';
|
||||
|
||||
/// Validates annotation combinations and usage patterns
|
||||
class AnnotationValidator {
|
||||
/// Validates annotations on a method element
|
||||
static void validateMethodAnnotations(MethodElement method) {
|
||||
final annotations = _getAnnotationNames(method.metadata);
|
||||
|
||||
_validateMutuallyExclusiveAnnotations(method, annotations);
|
||||
_validateAnnotationCombinations(method, annotations);
|
||||
_validateAnnotationParameters(method);
|
||||
}
|
||||
|
||||
/// Validates annotations on a field element
|
||||
static void validateFieldAnnotations(FieldElement field) {
|
||||
final annotations = _getAnnotationNames(field.metadata);
|
||||
|
||||
_validateInjectFieldAnnotations(field, annotations);
|
||||
}
|
||||
|
||||
/// Validates annotations on a class element
|
||||
static void validateClassAnnotations(ClassElement classElement) {
|
||||
final annotations = _getAnnotationNames(classElement.metadata);
|
||||
|
||||
_validateModuleClassAnnotations(classElement, annotations);
|
||||
_validateInjectableClassAnnotations(classElement, annotations);
|
||||
}
|
||||
|
||||
static List<String> _getAnnotationNames(List<ElementAnnotation> metadata) {
|
||||
return metadata
|
||||
.map((m) => m.computeConstantValue()?.type?.getDisplayString())
|
||||
.where((name) => name != null)
|
||||
.cast<String>()
|
||||
.toList();
|
||||
}
|
||||
|
||||
static void _validateMutuallyExclusiveAnnotations(
|
||||
MethodElement method,
|
||||
List<String> annotations,
|
||||
) {
|
||||
// @instance and @provide are mutually exclusive
|
||||
if (annotations.contains('instance') && annotations.contains('provide')) {
|
||||
throw AnnotationValidationException(
|
||||
'Method cannot have both @instance and @provide annotations',
|
||||
element: method,
|
||||
suggestion: 'Use either @instance for direct instances or @provide for factory methods',
|
||||
context: {
|
||||
'method_name': method.displayName,
|
||||
'annotations': annotations,
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
static void _validateAnnotationCombinations(
|
||||
MethodElement method,
|
||||
List<String> annotations,
|
||||
) {
|
||||
// @params can only be used with @provide
|
||||
if (annotations.contains('params') && !annotations.contains('provide')) {
|
||||
throw AnnotationValidationException(
|
||||
'@params annotation can only be used with @provide annotation',
|
||||
element: method,
|
||||
suggestion: 'Remove @params or add @provide annotation',
|
||||
context: {
|
||||
'method_name': method.displayName,
|
||||
'annotations': annotations,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
// Methods must have either @instance or @provide
|
||||
if (!annotations.contains('instance') && !annotations.contains('provide')) {
|
||||
throw AnnotationValidationException(
|
||||
'Method must be marked with either @instance or @provide annotation',
|
||||
element: method,
|
||||
suggestion: 'Add @instance() for direct instances or @provide() for factory methods',
|
||||
context: {
|
||||
'method_name': method.displayName,
|
||||
'available_annotations': annotations,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
// @singleton validation
|
||||
if (annotations.contains('singleton')) {
|
||||
_validateSingletonUsage(method, annotations);
|
||||
}
|
||||
}
|
||||
|
||||
static void _validateSingletonUsage(
|
||||
MethodElement method,
|
||||
List<String> annotations,
|
||||
) {
|
||||
// Singleton with params might not make sense in some contexts
|
||||
if (annotations.contains('params')) {
|
||||
// This is a warning, not an error - could be useful for parameterized singletons
|
||||
// We could add a warning system later
|
||||
}
|
||||
|
||||
// Check if return type is suitable for singleton
|
||||
final returnType = method.returnType.getDisplayString();
|
||||
if (returnType == 'void') {
|
||||
throw AnnotationValidationException(
|
||||
'Singleton methods cannot return void',
|
||||
element: method,
|
||||
suggestion: 'Remove @singleton annotation or change return type',
|
||||
context: {
|
||||
'method_name': method.displayName,
|
||||
'return_type': returnType,
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
static void _validateAnnotationParameters(MethodElement method) {
|
||||
// Validate @named annotation parameters
|
||||
final namedValue = MetadataUtils.getNamedValue(method.metadata);
|
||||
if (namedValue != null) {
|
||||
if (namedValue.isEmpty) {
|
||||
throw AnnotationValidationException(
|
||||
'@named annotation cannot have empty value',
|
||||
element: method,
|
||||
suggestion: 'Provide a non-empty string value for @named annotation',
|
||||
context: {
|
||||
'method_name': method.displayName,
|
||||
'named_value': namedValue,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
// Check for valid naming conventions
|
||||
if (!RegExp(r'^[a-zA-Z_][a-zA-Z0-9_]*$').hasMatch(namedValue)) {
|
||||
throw AnnotationValidationException(
|
||||
'@named value should follow valid identifier naming conventions',
|
||||
element: method,
|
||||
suggestion: 'Use alphanumeric characters and underscores only, starting with a letter or underscore',
|
||||
context: {
|
||||
'method_name': method.displayName,
|
||||
'named_value': namedValue,
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// Validate method parameters for @params usage
|
||||
for (final param in method.parameters) {
|
||||
final paramAnnotations = _getAnnotationNames(param.metadata);
|
||||
if (paramAnnotations.contains('params')) {
|
||||
_validateParamsParameter(param, method);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static void _validateParamsParameter(ParameterElement param, MethodElement method) {
|
||||
// @params parameter should typically be dynamic or Map<String, dynamic>
|
||||
final paramType = param.type.getDisplayString();
|
||||
|
||||
if (paramType != 'dynamic' &&
|
||||
paramType != 'Map<String, dynamic>' &&
|
||||
paramType != 'Map<String, dynamic>?') {
|
||||
// This is more of a warning - other types might be valid
|
||||
// We could add a warning system for this
|
||||
}
|
||||
|
||||
// Check if parameter is required when using @params
|
||||
try {
|
||||
final hasDefault = (param as dynamic).defaultValue != null;
|
||||
if (param.isRequired && !hasDefault) {
|
||||
// This might be intentional, so we don't throw an error
|
||||
// but we could warn about it
|
||||
}
|
||||
} catch (e) {
|
||||
// Ignore if defaultValue is not available in this analyzer version
|
||||
}
|
||||
}
|
||||
|
||||
static void _validateInjectFieldAnnotations(
|
||||
FieldElement field,
|
||||
List<String> annotations,
|
||||
) {
|
||||
if (!annotations.contains('inject')) {
|
||||
return; // Not an inject field, nothing to validate
|
||||
}
|
||||
|
||||
// Check if field type is suitable for injection
|
||||
final fieldType = field.type.getDisplayString();
|
||||
if (fieldType == 'void') {
|
||||
throw AnnotationValidationException(
|
||||
'Cannot inject void type',
|
||||
element: field,
|
||||
suggestion: 'Use a concrete type instead of void',
|
||||
context: {
|
||||
'field_name': field.displayName,
|
||||
'field_type': fieldType,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
// Validate scope annotation if present
|
||||
for (final meta in field.metadata) {
|
||||
final obj = meta.computeConstantValue();
|
||||
final type = obj?.type?.getDisplayString();
|
||||
if (type == 'scope') {
|
||||
// Empty scope name is treated as no scope (uses root scope)
|
||||
// This is allowed for backward compatibility and convenience
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static void _validateModuleClassAnnotations(
|
||||
ClassElement classElement,
|
||||
List<String> annotations,
|
||||
) {
|
||||
if (!annotations.contains('module')) {
|
||||
return; // Not a module class
|
||||
}
|
||||
|
||||
// Check if class has public methods
|
||||
final publicMethods = classElement.methods.where((m) => m.isPublic).toList();
|
||||
if (publicMethods.isEmpty) {
|
||||
throw AnnotationValidationException(
|
||||
'Module class must have at least one public method',
|
||||
element: classElement,
|
||||
suggestion: 'Add public methods with @instance or @provide annotations',
|
||||
context: {
|
||||
'class_name': classElement.displayName,
|
||||
'method_count': publicMethods.length,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
// Validate that public methods have appropriate annotations
|
||||
for (final method in publicMethods) {
|
||||
final methodAnnotations = _getAnnotationNames(method.metadata);
|
||||
if (!methodAnnotations.contains('instance') && !methodAnnotations.contains('provide')) {
|
||||
throw AnnotationValidationException(
|
||||
'Public methods in module class must have @instance or @provide annotation',
|
||||
element: method,
|
||||
suggestion: 'Add @instance() or @provide() annotation to the method',
|
||||
context: {
|
||||
'class_name': classElement.displayName,
|
||||
'method_name': method.displayName,
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static void _validateInjectableClassAnnotations(
|
||||
ClassElement classElement,
|
||||
List<String> annotations,
|
||||
) {
|
||||
if (!annotations.contains('injectable')) {
|
||||
return; // Not an injectable class
|
||||
}
|
||||
|
||||
// Check if class has injectable fields
|
||||
final injectFields = classElement.fields.where((f) {
|
||||
final fieldAnnotations = _getAnnotationNames(f.metadata);
|
||||
return fieldAnnotations.contains('inject');
|
||||
}).toList();
|
||||
|
||||
// Allow injectable classes without @inject fields to generate empty mixins
|
||||
// This can be useful for classes that will have @inject fields added later
|
||||
// or for testing purposes
|
||||
if (injectFields.isEmpty) {
|
||||
// Just log a warning but don't throw an exception
|
||||
// print('Warning: Injectable class ${classElement.displayName} has no @inject fields');
|
||||
}
|
||||
|
||||
// Validate that injectable fields are properly declared
|
||||
for (final field in injectFields) {
|
||||
// Injectable fields should be late final for immutability after injection
|
||||
if (!field.isFinal) {
|
||||
throw AnnotationValidationException(
|
||||
'Injectable fields should be final for immutability',
|
||||
element: field,
|
||||
suggestion: 'Add final keyword to injectable field (preferably late final)',
|
||||
context: {
|
||||
'class_name': classElement.displayName,
|
||||
'field_name': field.displayName,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
// Check if field is late (recommended pattern)
|
||||
try {
|
||||
final isLate = (field as dynamic).isLate ?? false;
|
||||
if (!isLate) {
|
||||
// This is a warning, not an error - late final is recommended but not required
|
||||
// We could add a warning system later
|
||||
}
|
||||
} catch (e) {
|
||||
// Ignore if isLate is not available in this analyzer version
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -12,10 +12,13 @@
|
||||
//
|
||||
|
||||
import 'package:analyzer/dart/element/element.dart';
|
||||
import 'package:source_gen/source_gen.dart';
|
||||
|
||||
|
||||
import 'bind_parameters_spec.dart';
|
||||
import 'metadata_utils.dart';
|
||||
import 'exceptions.dart';
|
||||
import 'type_parser.dart';
|
||||
import 'annotation_validator.dart';
|
||||
|
||||
enum BindingType {
|
||||
instance,
|
||||
@@ -105,10 +108,42 @@ class BindSpec {
|
||||
final indentStr = ' ' * indent;
|
||||
final provide = _generateProvideClause(indent);
|
||||
final postfix = _generatePostfix();
|
||||
return '$indentStr'
|
||||
'bind<$returnType>()'
|
||||
'$provide'
|
||||
'$postfix;';
|
||||
|
||||
// Create the full single-line version first
|
||||
final singleLine = '${indentStr}bind<$returnType>()$provide$postfix;';
|
||||
|
||||
// Check if we need multiline formatting
|
||||
final needsMultiline = singleLine.length > 80 || provide.contains('\n');
|
||||
|
||||
if (!needsMultiline) {
|
||||
return singleLine;
|
||||
}
|
||||
|
||||
// For multiline formatting, check if we need to break after bind<Type>()
|
||||
if (provide.contains('\n')) {
|
||||
// Provider clause is already multiline
|
||||
if (postfix.isNotEmpty) {
|
||||
// If there's a postfix, break after bind<Type>()
|
||||
final multilinePostfix = _generateMultilinePostfix(indent);
|
||||
return '${indentStr}bind<$returnType>()'
|
||||
'\n${' ' * (indent + 4)}$provide'
|
||||
'$multilinePostfix;';
|
||||
} else {
|
||||
// No postfix, keep bind<Type>() with provide start
|
||||
return '${indentStr}bind<$returnType>()$provide;';
|
||||
}
|
||||
} else {
|
||||
// Simple multiline: break after bind<Type>()
|
||||
if (postfix.isNotEmpty) {
|
||||
final multilinePostfix = _generateMultilinePostfix(indent);
|
||||
return '${indentStr}bind<$returnType>()'
|
||||
'\n${' ' * (indent + 4)}$provide'
|
||||
'$multilinePostfix;';
|
||||
} else {
|
||||
return '${indentStr}bind<$returnType>()'
|
||||
'\n${' ' * (indent + 4)}$provide;';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Internal method: decides how the provide clause should be generated by param kind.
|
||||
@@ -122,6 +157,7 @@ class BindSpec {
|
||||
// Safe variable name for parameters.
|
||||
const paramVar = 'args';
|
||||
final fnArgs = parameters.map((p) => p.generateArg(paramVar)).join(', ');
|
||||
// Use multiline format only if args are long or contain newlines
|
||||
final multiLine = fnArgs.length > 60 || fnArgs.contains('\n');
|
||||
switch (bindingType) {
|
||||
case BindingType.instance:
|
||||
@@ -131,7 +167,6 @@ class BindSpec {
|
||||
// ? '.toInstanceAsync(($fnArgs) => $methodName($fnArgs))'
|
||||
// : '.toInstance(($fnArgs) => $methodName($fnArgs))';
|
||||
case BindingType.provide:
|
||||
default:
|
||||
if (isAsyncProvide) {
|
||||
return multiLine
|
||||
? '.toProvideAsyncWithParams(\n${' ' * (indent + 2)}($paramVar) => $methodName($fnArgs))'
|
||||
@@ -147,22 +182,33 @@ class BindSpec {
|
||||
/// EN / RU: Supports only injected dependencies, not runtime (@params).
|
||||
String _generatePlainProvideClause(int indent) {
|
||||
final argsStr = parameters.map((p) => p.generateArg()).join(', ');
|
||||
final multiLine = argsStr.length > 60 || argsStr.contains('\n');
|
||||
|
||||
// Check if we need multiline formatting based on total line length
|
||||
final singleLineCall = '$methodName($argsStr)';
|
||||
final needsMultiline = singleLineCall.length >= 45 || argsStr.contains('\n');
|
||||
|
||||
switch (bindingType) {
|
||||
case BindingType.instance:
|
||||
return isAsyncInstance
|
||||
? '.toInstanceAsync($methodName($argsStr))'
|
||||
: '.toInstance($methodName($argsStr))';
|
||||
case BindingType.provide:
|
||||
default:
|
||||
if (isAsyncProvide) {
|
||||
return multiLine
|
||||
? '.toProvideAsync(\n${' ' * (indent + 2)}() => $methodName($argsStr))'
|
||||
: '.toProvideAsync(() => $methodName($argsStr))';
|
||||
if (needsMultiline) {
|
||||
final lambdaIndent = (isSingleton || named != null) ? indent + 6 : indent + 2;
|
||||
final closingIndent = (isSingleton || named != null) ? indent + 4 : indent;
|
||||
return '.toProvideAsync(\n${' ' * lambdaIndent}() => $methodName($argsStr),\n${' ' * closingIndent})';
|
||||
} else {
|
||||
return '.toProvideAsync(() => $methodName($argsStr))';
|
||||
}
|
||||
} else {
|
||||
return multiLine
|
||||
? '.toProvide(\n${' ' * (indent + 2)}() => $methodName($argsStr))'
|
||||
: '.toProvide(() => $methodName($argsStr))';
|
||||
if (needsMultiline) {
|
||||
final lambdaIndent = (isSingleton || named != null) ? indent + 6 : indent + 2;
|
||||
final closingIndent = (isSingleton || named != null) ? indent + 4 : indent;
|
||||
return '.toProvide(\n${' ' * lambdaIndent}() => $methodName($argsStr),\n${' ' * closingIndent})';
|
||||
} else {
|
||||
return '.toProvide(() => $methodName($argsStr))';
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -173,6 +219,20 @@ class BindSpec {
|
||||
final singletonPart = isSingleton ? '.singleton()' : '';
|
||||
return '$namePart$singletonPart';
|
||||
}
|
||||
|
||||
/// EN / RU: Generates multiline postfix with proper indentation.
|
||||
String _generateMultilinePostfix(int indent) {
|
||||
final parts = <String>[];
|
||||
if (named != null) {
|
||||
parts.add(".withName('$named')");
|
||||
}
|
||||
if (isSingleton) {
|
||||
parts.add('.singleton()');
|
||||
}
|
||||
if (parts.isEmpty) return '';
|
||||
|
||||
return parts.map((part) => '\n${' ' * (indent + 4)}$part').join('');
|
||||
}
|
||||
|
||||
/// -------------------------------------------------------------------------
|
||||
/// fromMethod
|
||||
@@ -188,73 +248,93 @@ class BindSpec {
|
||||
/// асинхронности. Если нет @instance или @provide — кидает ошибку.
|
||||
/// -------------------------------------------------------------------------
|
||||
static BindSpec fromMethod(MethodElement method) {
|
||||
var returnType = method.returnType.getDisplayString();
|
||||
try {
|
||||
// Validate method annotations
|
||||
AnnotationValidator.validateMethodAnnotations(method);
|
||||
|
||||
// Parse return type using improved type parser
|
||||
final parsedReturnType = TypeParser.parseType(method.returnType, method);
|
||||
|
||||
final methodName = method.displayName;
|
||||
|
||||
// Check for @singleton annotation.
|
||||
final isSingleton = MetadataUtils.anyMeta(method.metadata, 'singleton');
|
||||
|
||||
final methodName = method.displayName;
|
||||
// Check for @singleton annotation.
|
||||
final isSingleton = MetadataUtils.anyMeta(method.metadata, 'singleton');
|
||||
// Get @named value if present.
|
||||
final named = MetadataUtils.getNamedValue(method.metadata);
|
||||
|
||||
// Get @named value if present.
|
||||
final named = MetadataUtils.getNamedValue(method.metadata);
|
||||
// Parse each method parameter.
|
||||
final params = <BindParameterSpec>[];
|
||||
bool hasParams = false;
|
||||
for (final p in method.parameters) {
|
||||
final typeStr = p.type.getDisplayString();
|
||||
final paramNamed = MetadataUtils.getNamedValue(p.metadata);
|
||||
final isParams = MetadataUtils.anyMeta(p.metadata, 'params');
|
||||
if (isParams) hasParams = true;
|
||||
params.add(BindParameterSpec(typeStr, paramNamed, isParams: isParams));
|
||||
}
|
||||
|
||||
// Parse each method parameter.
|
||||
final params = <BindParameterSpec>[];
|
||||
bool hasParams = false;
|
||||
for (final p in method.parameters) {
|
||||
final typeStr = p.type.getDisplayString();
|
||||
final paramNamed = MetadataUtils.getNamedValue(p.metadata);
|
||||
final isParams = MetadataUtils.anyMeta(p.metadata, 'params');
|
||||
if (isParams) hasParams = true;
|
||||
params.add(BindParameterSpec(typeStr, paramNamed, isParams: isParams));
|
||||
}
|
||||
// Determine bindingType: @instance or @provide.
|
||||
final hasInstance = MetadataUtils.anyMeta(method.metadata, 'instance');
|
||||
final hasProvide = MetadataUtils.anyMeta(method.metadata, 'provide');
|
||||
|
||||
if (!hasInstance && !hasProvide) {
|
||||
throw AnnotationValidationException(
|
||||
'Method must be marked with either @instance() or @provide() annotation',
|
||||
element: method,
|
||||
suggestion: 'Add @instance() for direct instances or @provide() for factory methods',
|
||||
context: {
|
||||
'method_name': methodName,
|
||||
'return_type': parsedReturnType.displayString,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
final bindingType = hasInstance ? BindingType.instance : BindingType.provide;
|
||||
|
||||
// Determine bindingType: @instance or @provide.
|
||||
final hasInstance = MetadataUtils.anyMeta(method.metadata, 'instance');
|
||||
final hasProvide = MetadataUtils.anyMeta(method.metadata, 'provide');
|
||||
if (!hasInstance && !hasProvide) {
|
||||
throw InvalidGenerationSourceError(
|
||||
'Method $methodName must be marked with @instance() or @provide().',
|
||||
// PROHIBIT @params with @instance bindings!
|
||||
if (bindingType == BindingType.instance && hasParams) {
|
||||
throw AnnotationValidationException(
|
||||
'@params() (runtime arguments) cannot be used together with @instance()',
|
||||
element: method,
|
||||
suggestion: 'Use @provide() instead if you want runtime arguments',
|
||||
context: {
|
||||
'method_name': methodName,
|
||||
'binding_type': 'instance',
|
||||
'has_params': hasParams,
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
// Set async flags based on parsed type
|
||||
final isAsyncInstance = bindingType == BindingType.instance && parsedReturnType.isFuture;
|
||||
final isAsyncProvide = bindingType == BindingType.provide && parsedReturnType.isFuture;
|
||||
|
||||
return BindSpec(
|
||||
returnType: parsedReturnType.codeGenType,
|
||||
methodName: methodName,
|
||||
isSingleton: isSingleton,
|
||||
named: named,
|
||||
parameters: params,
|
||||
bindingType: bindingType,
|
||||
isAsyncInstance: isAsyncInstance,
|
||||
isAsyncProvide: isAsyncProvide,
|
||||
hasParams: hasParams,
|
||||
);
|
||||
} catch (e) {
|
||||
if (e is CherryPickGeneratorException) {
|
||||
rethrow;
|
||||
}
|
||||
throw CodeGenerationException(
|
||||
'Failed to create BindSpec from method "${method.displayName}"',
|
||||
element: method,
|
||||
suggestion: 'Check that the method has valid annotations and return type',
|
||||
context: {
|
||||
'method_name': method.displayName,
|
||||
'return_type': method.returnType.getDisplayString(),
|
||||
'error': e.toString(),
|
||||
},
|
||||
);
|
||||
}
|
||||
final bindingType =
|
||||
hasInstance ? BindingType.instance : BindingType.provide;
|
||||
|
||||
// PROHIBIT @params with @instance bindings!
|
||||
if (bindingType == BindingType.instance && hasParams) {
|
||||
throw InvalidGenerationSourceError(
|
||||
'@params() (runtime arguments) cannot be used together with @instance() on method $methodName. '
|
||||
'Use @provide() instead if you want runtime arguments.',
|
||||
element: method,
|
||||
);
|
||||
}
|
||||
|
||||
// -- Extract inner type for Future<T> and set async flags.
|
||||
bool isAsyncInstance = false;
|
||||
bool isAsyncProvide = false;
|
||||
final futureInnerType = _extractFutureInnerType(returnType);
|
||||
if (futureInnerType != null) {
|
||||
returnType = futureInnerType;
|
||||
if (bindingType == BindingType.instance) isAsyncInstance = true;
|
||||
if (bindingType == BindingType.provide) isAsyncProvide = true;
|
||||
}
|
||||
|
||||
return BindSpec(
|
||||
returnType: returnType,
|
||||
methodName: methodName,
|
||||
isSingleton: isSingleton,
|
||||
named: named,
|
||||
parameters: params,
|
||||
bindingType: bindingType,
|
||||
isAsyncInstance: isAsyncInstance,
|
||||
isAsyncProvide: isAsyncProvide,
|
||||
hasParams: hasParams,
|
||||
);
|
||||
}
|
||||
|
||||
/// EN / RU: Extracts inner type from Future<T>, returns e.g. "T" or null.
|
||||
static String? _extractFutureInnerType(String typeName) {
|
||||
final match = RegExp(r'^Future<(.+)>$').firstMatch(typeName);
|
||||
return match?.group(1)?.trim();
|
||||
}
|
||||
}
|
||||
|
||||
117
cherrypick_generator/lib/src/exceptions.dart
Normal file
117
cherrypick_generator/lib/src/exceptions.dart
Normal file
@@ -0,0 +1,117 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:analyzer/dart/element/element.dart';
|
||||
import 'package:source_gen/source_gen.dart';
|
||||
|
||||
/// Enhanced exception class for CherryPick generator with detailed context information
|
||||
class CherryPickGeneratorException extends InvalidGenerationSourceError {
|
||||
final String category;
|
||||
final String? suggestion;
|
||||
final Map<String, dynamic>? context;
|
||||
|
||||
CherryPickGeneratorException(
|
||||
String message, {
|
||||
required Element element,
|
||||
required this.category,
|
||||
this.suggestion,
|
||||
this.context,
|
||||
}) : super(
|
||||
_formatMessage(message, category, suggestion, context, element),
|
||||
element: element,
|
||||
);
|
||||
|
||||
static String _formatMessage(
|
||||
String message,
|
||||
String category,
|
||||
String? suggestion,
|
||||
Map<String, dynamic>? context,
|
||||
Element element,
|
||||
) {
|
||||
final buffer = StringBuffer();
|
||||
|
||||
// Header with category
|
||||
buffer.writeln('[$category] $message');
|
||||
|
||||
// Element context
|
||||
buffer.writeln('');
|
||||
buffer.writeln('Context:');
|
||||
buffer.writeln(' Element: ${element.displayName}');
|
||||
buffer.writeln(' Type: ${element.runtimeType}');
|
||||
buffer.writeln(' Location: ${element.source?.fullName ?? 'unknown'}');
|
||||
|
||||
// Note: enclosingElement may not be available in all analyzer versions
|
||||
try {
|
||||
final enclosing = (element as dynamic).enclosingElement;
|
||||
if (enclosing != null) {
|
||||
buffer.writeln(' Enclosing: ${enclosing.displayName}');
|
||||
}
|
||||
} catch (e) {
|
||||
// Ignore if enclosingElement is not available
|
||||
}
|
||||
|
||||
// Additional context
|
||||
if (context != null && context.isNotEmpty) {
|
||||
buffer.writeln('');
|
||||
buffer.writeln('Additional Context:');
|
||||
context.forEach((key, value) {
|
||||
buffer.writeln(' $key: $value');
|
||||
});
|
||||
}
|
||||
|
||||
// Suggestion
|
||||
if (suggestion != null) {
|
||||
buffer.writeln('');
|
||||
buffer.writeln('💡 Suggestion: $suggestion');
|
||||
}
|
||||
|
||||
return buffer.toString();
|
||||
}
|
||||
}
|
||||
|
||||
/// Specific exception types for different error categories
|
||||
class AnnotationValidationException extends CherryPickGeneratorException {
|
||||
AnnotationValidationException(
|
||||
super.message, {
|
||||
required super.element,
|
||||
super.suggestion,
|
||||
super.context,
|
||||
}) : super(category: 'ANNOTATION_VALIDATION');
|
||||
}
|
||||
|
||||
class TypeParsingException extends CherryPickGeneratorException {
|
||||
TypeParsingException(
|
||||
super.message, {
|
||||
required super.element,
|
||||
super.suggestion,
|
||||
super.context,
|
||||
}) : super(category: 'TYPE_PARSING');
|
||||
}
|
||||
|
||||
class CodeGenerationException extends CherryPickGeneratorException {
|
||||
CodeGenerationException(
|
||||
super.message, {
|
||||
required super.element,
|
||||
super.suggestion,
|
||||
super.context,
|
||||
}) : super(category: 'CODE_GENERATION');
|
||||
}
|
||||
|
||||
class DependencyResolutionException extends CherryPickGeneratorException {
|
||||
DependencyResolutionException(
|
||||
super.message, {
|
||||
required super.element,
|
||||
super.suggestion,
|
||||
super.context,
|
||||
}) : super(category: 'DEPENDENCY_RESOLUTION');
|
||||
}
|
||||
@@ -49,10 +49,15 @@ class GeneratedClass {
|
||||
/// Список всех обнаруженных биндингов
|
||||
final List<BindSpec> binds;
|
||||
|
||||
/// Source file name for the part directive
|
||||
/// Имя исходного файла для part директивы
|
||||
final String sourceFile;
|
||||
|
||||
GeneratedClass(
|
||||
this.className,
|
||||
this.generatedClassName,
|
||||
this.binds,
|
||||
this.sourceFile,
|
||||
);
|
||||
|
||||
/// -------------------------------------------------------------------------
|
||||
@@ -72,13 +77,15 @@ class GeneratedClass {
|
||||
final className = element.displayName;
|
||||
// Generated class name with '$' prefix (standard for generated Dart code).
|
||||
final generatedClassName = r'$' + className;
|
||||
// Get source file name
|
||||
final sourceFile = element.source.shortName;
|
||||
// Collect bindings for all non-abstract methods.
|
||||
final binds = element.methods
|
||||
.where((m) => !m.isAbstract)
|
||||
.map(BindSpec.fromMethod)
|
||||
.toList();
|
||||
|
||||
return GeneratedClass(className, generatedClassName, binds);
|
||||
return GeneratedClass(className, generatedClassName, binds, sourceFile);
|
||||
}
|
||||
|
||||
/// -------------------------------------------------------------------------
|
||||
@@ -95,11 +102,17 @@ class GeneratedClass {
|
||||
/// и регистрирует все зависимости через методы bind<Type>()...
|
||||
/// -------------------------------------------------------------------------
|
||||
String generate() {
|
||||
final buffer = StringBuffer();
|
||||
|
||||
buffer.writeln('final class $generatedClassName extends $className {');
|
||||
buffer.writeln(' @override');
|
||||
buffer.writeln(' void builder(Scope currentScope) {');
|
||||
final buffer = StringBuffer()
|
||||
..writeln('// dart format width=80')
|
||||
..writeln('// GENERATED CODE - DO NOT MODIFY BY HAND')
|
||||
..writeln()
|
||||
..writeln('// **************************************************************************')
|
||||
..writeln('// ModuleGenerator')
|
||||
..writeln('// **************************************************************************')
|
||||
..writeln()
|
||||
..writeln('final class $generatedClassName extends $className {')
|
||||
..writeln(' @override')
|
||||
..writeln(' void builder(Scope currentScope) {');
|
||||
|
||||
// For each binding, generate bind<Type>() code string.
|
||||
// Для каждого биндинга — генерируем строку bind<Type>()...
|
||||
@@ -107,8 +120,9 @@ class GeneratedClass {
|
||||
buffer.writeln(bind.generateBind(4));
|
||||
}
|
||||
|
||||
buffer.writeln(' }');
|
||||
buffer.writeln('}');
|
||||
buffer
|
||||
..writeln(' }')
|
||||
..writeln('}');
|
||||
|
||||
return buffer.toString();
|
||||
}
|
||||
|
||||
216
cherrypick_generator/lib/src/type_parser.dart
Normal file
216
cherrypick_generator/lib/src/type_parser.dart
Normal file
@@ -0,0 +1,216 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:analyzer/dart/element/element.dart';
|
||||
import 'package:analyzer/dart/element/nullability_suffix.dart';
|
||||
import 'package:analyzer/dart/element/type.dart';
|
||||
import 'exceptions.dart';
|
||||
|
||||
/// Enhanced type parser that uses AST analysis instead of regular expressions
|
||||
class TypeParser {
|
||||
/// Parses a DartType and extracts detailed type information
|
||||
static ParsedType parseType(DartType dartType, Element context) {
|
||||
try {
|
||||
return _parseTypeInternal(dartType, context);
|
||||
} catch (e) {
|
||||
throw TypeParsingException(
|
||||
'Failed to parse type: ${dartType.getDisplayString()}',
|
||||
element: context,
|
||||
suggestion: 'Ensure the type is properly imported and accessible',
|
||||
context: {
|
||||
'original_type': dartType.getDisplayString(),
|
||||
'error': e.toString(),
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
static ParsedType _parseTypeInternal(DartType dartType, Element context) {
|
||||
final displayString = dartType.getDisplayString();
|
||||
final isNullable = dartType.nullabilitySuffix == NullabilitySuffix.question;
|
||||
|
||||
// Check if it's a Future type
|
||||
if (dartType.isDartAsyncFuture) {
|
||||
return _parseFutureType(dartType, context, isNullable);
|
||||
}
|
||||
|
||||
// Check if it's a generic type (List, Map, etc.)
|
||||
if (dartType is ParameterizedType && dartType.typeArguments.isNotEmpty) {
|
||||
return _parseGenericType(dartType, context, isNullable);
|
||||
}
|
||||
|
||||
// Simple type
|
||||
return ParsedType(
|
||||
displayString: displayString,
|
||||
coreType: displayString.replaceAll('?', ''),
|
||||
isNullable: isNullable,
|
||||
isFuture: false,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
);
|
||||
}
|
||||
|
||||
static ParsedType _parseFutureType(DartType dartType, Element context, bool isNullable) {
|
||||
if (dartType is! ParameterizedType || dartType.typeArguments.isEmpty) {
|
||||
throw TypeParsingException(
|
||||
'Future type must have a type argument',
|
||||
element: context,
|
||||
suggestion: 'Use Future<T> instead of raw Future',
|
||||
context: {'type': dartType.getDisplayString()},
|
||||
);
|
||||
}
|
||||
|
||||
final innerType = dartType.typeArguments.first;
|
||||
final innerParsed = _parseTypeInternal(innerType, context);
|
||||
|
||||
return ParsedType(
|
||||
displayString: dartType.getDisplayString(),
|
||||
coreType: innerParsed.coreType,
|
||||
isNullable: isNullable || innerParsed.isNullable,
|
||||
isFuture: true,
|
||||
isGeneric: innerParsed.isGeneric,
|
||||
typeArguments: innerParsed.typeArguments,
|
||||
innerType: innerParsed,
|
||||
);
|
||||
}
|
||||
|
||||
static ParsedType _parseGenericType(ParameterizedType dartType, Element context, bool isNullable) {
|
||||
final typeArguments = dartType.typeArguments
|
||||
.map((arg) => _parseTypeInternal(arg, context))
|
||||
.toList();
|
||||
|
||||
final baseType = dartType.element?.name ?? dartType.getDisplayString();
|
||||
|
||||
return ParsedType(
|
||||
displayString: dartType.getDisplayString(),
|
||||
coreType: baseType,
|
||||
isNullable: isNullable,
|
||||
isFuture: false,
|
||||
isGeneric: true,
|
||||
typeArguments: typeArguments,
|
||||
);
|
||||
}
|
||||
|
||||
/// Validates that a type is suitable for dependency injection
|
||||
static void validateInjectableType(ParsedType parsedType, Element context) {
|
||||
// Check for void type
|
||||
if (parsedType.coreType == 'void') {
|
||||
throw TypeParsingException(
|
||||
'Cannot inject void type',
|
||||
element: context,
|
||||
suggestion: 'Use a concrete type instead of void',
|
||||
);
|
||||
}
|
||||
|
||||
// Check for dynamic type (warning)
|
||||
if (parsedType.coreType == 'dynamic') {
|
||||
// This could be a warning instead of an error
|
||||
throw TypeParsingException(
|
||||
'Using dynamic type reduces type safety',
|
||||
element: context,
|
||||
suggestion: 'Consider using a specific type instead of dynamic',
|
||||
);
|
||||
}
|
||||
|
||||
// Validate nested types for complex generics
|
||||
for (final typeArg in parsedType.typeArguments) {
|
||||
validateInjectableType(typeArg, context);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Represents a parsed type with detailed information
|
||||
class ParsedType {
|
||||
/// The full display string of the type (e.g., "Future<List<String>?>")
|
||||
final String displayString;
|
||||
|
||||
/// The core type name without nullability and Future wrapper (e.g., "List<String>")
|
||||
final String coreType;
|
||||
|
||||
/// Whether the type is nullable
|
||||
final bool isNullable;
|
||||
|
||||
/// Whether the type is wrapped in Future
|
||||
final bool isFuture;
|
||||
|
||||
/// Whether the type has generic parameters
|
||||
final bool isGeneric;
|
||||
|
||||
/// Parsed type arguments for generic types
|
||||
final List<ParsedType> typeArguments;
|
||||
|
||||
/// For Future types, the inner type
|
||||
final ParsedType? innerType;
|
||||
|
||||
const ParsedType({
|
||||
required this.displayString,
|
||||
required this.coreType,
|
||||
required this.isNullable,
|
||||
required this.isFuture,
|
||||
required this.isGeneric,
|
||||
required this.typeArguments,
|
||||
this.innerType,
|
||||
});
|
||||
|
||||
/// Returns the type string suitable for code generation
|
||||
String get codeGenType {
|
||||
if (isFuture && innerType != null) {
|
||||
return innerType!.codeGenType;
|
||||
}
|
||||
|
||||
// For generic types, include type arguments
|
||||
if (isGeneric && typeArguments.isNotEmpty) {
|
||||
final args = typeArguments.map((arg) => arg.codeGenType).join(', ');
|
||||
return '$coreType<$args>';
|
||||
}
|
||||
|
||||
return coreType;
|
||||
}
|
||||
|
||||
/// Returns whether this type should use tryResolve instead of resolve
|
||||
bool get shouldUseTryResolve => isNullable;
|
||||
|
||||
/// Returns the appropriate resolve method name
|
||||
String get resolveMethodName {
|
||||
if (isFuture) {
|
||||
return shouldUseTryResolve ? 'tryResolveAsync' : 'resolveAsync';
|
||||
}
|
||||
return shouldUseTryResolve ? 'tryResolve' : 'resolve';
|
||||
}
|
||||
|
||||
@override
|
||||
String toString() {
|
||||
return 'ParsedType(displayString: $displayString, coreType: $coreType, '
|
||||
'isNullable: $isNullable, isFuture: $isFuture, isGeneric: $isGeneric)';
|
||||
}
|
||||
|
||||
@override
|
||||
bool operator ==(Object other) {
|
||||
if (identical(this, other)) return true;
|
||||
return other is ParsedType &&
|
||||
other.displayString == displayString &&
|
||||
other.coreType == coreType &&
|
||||
other.isNullable == isNullable &&
|
||||
other.isFuture == isFuture &&
|
||||
other.isGeneric == isGeneric;
|
||||
}
|
||||
|
||||
@override
|
||||
int get hashCode {
|
||||
return displayString.hashCode ^
|
||||
coreType.hashCode ^
|
||||
isNullable.hashCode ^
|
||||
isFuture.hashCode ^
|
||||
isGeneric.hashCode;
|
||||
}
|
||||
}
|
||||
@@ -2,7 +2,7 @@ name: cherrypick_generator
|
||||
description: |
|
||||
Source code generator for the cherrypick dependency injection system. Processes annotations to generate binding and module code for Dart & Flutter projects.
|
||||
|
||||
version: 1.1.0-dev.2
|
||||
version: 1.1.0-dev.6
|
||||
documentation: https://github.com/pese-git/cherrypick/wiki
|
||||
repository: https://github.com/pese-git/cherrypick/cherrypick_generator
|
||||
issue_tracker: https://github.com/pese-git/cherrypick/issues
|
||||
@@ -12,14 +12,17 @@ environment:
|
||||
|
||||
# Add regular dependencies here.
|
||||
dependencies:
|
||||
cherrypick_annotations: ^1.1.0-dev.0
|
||||
analyzer: ^6.7.0
|
||||
dart_style: ^2.3.7
|
||||
cherrypick_annotations: ^1.1.0-dev.1
|
||||
analyzer: ^7.0.0
|
||||
dart_style: ^3.0.0
|
||||
build: ^2.4.1
|
||||
build_runner: ^2.4.13
|
||||
source_gen: ^1.5.0
|
||||
source_gen: ^2.0.0
|
||||
collection: ^1.18.0
|
||||
path: ^1.9.1
|
||||
|
||||
dev_dependencies:
|
||||
lints: ^5.0.0
|
||||
lints: ^4.0.0
|
||||
mockito: ^5.4.4
|
||||
test: ^1.25.8
|
||||
build_test: ^2.1.7
|
||||
build_runner: ^2.4.13
|
||||
|
||||
415
cherrypick_generator/test/annotation_validator_test.dart
Normal file
415
cherrypick_generator/test/annotation_validator_test.dart
Normal file
@@ -0,0 +1,415 @@
|
||||
import 'package:test/test.dart';
|
||||
import 'package:analyzer/dart/element/element.dart';
|
||||
import 'package:analyzer/dart/constant/value.dart';
|
||||
import 'package:analyzer/dart/element/type.dart';
|
||||
import 'package:analyzer/source/source.dart';
|
||||
import 'package:cherrypick_generator/src/annotation_validator.dart';
|
||||
import 'package:cherrypick_generator/src/exceptions.dart';
|
||||
|
||||
void main() {
|
||||
group('AnnotationValidator', () {
|
||||
group('validateMethodAnnotations', () {
|
||||
test('should pass for valid @instance method', () {
|
||||
final method = _createMockMethod(
|
||||
name: 'createService',
|
||||
annotations: ['instance'],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateMethodAnnotations(method),
|
||||
returnsNormally,
|
||||
);
|
||||
});
|
||||
|
||||
test('should pass for valid @provide method', () {
|
||||
final method = _createMockMethod(
|
||||
name: 'createService',
|
||||
annotations: ['provide'],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateMethodAnnotations(method),
|
||||
returnsNormally,
|
||||
);
|
||||
});
|
||||
|
||||
test('should throw for method with both @instance and @provide', () {
|
||||
final method = _createMockMethod(
|
||||
name: 'createService',
|
||||
annotations: ['instance', 'provide'],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateMethodAnnotations(method),
|
||||
throwsA(isA<AnnotationValidationException>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should throw for method with @params but no @provide', () {
|
||||
final method = _createMockMethod(
|
||||
name: 'createService',
|
||||
annotations: ['instance', 'params'],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateMethodAnnotations(method),
|
||||
throwsA(isA<AnnotationValidationException>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should throw for method with neither @instance nor @provide', () {
|
||||
final method = _createMockMethod(
|
||||
name: 'createService',
|
||||
annotations: ['singleton'],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateMethodAnnotations(method),
|
||||
throwsA(isA<AnnotationValidationException>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should pass for @provide method with @params', () {
|
||||
final method = _createMockMethod(
|
||||
name: 'createService',
|
||||
annotations: ['provide', 'params'],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateMethodAnnotations(method),
|
||||
returnsNormally,
|
||||
);
|
||||
});
|
||||
|
||||
test('should pass for @singleton method', () {
|
||||
final method = _createMockMethod(
|
||||
name: 'createService',
|
||||
annotations: ['provide', 'singleton'],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateMethodAnnotations(method),
|
||||
returnsNormally,
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
group('validateFieldAnnotations', () {
|
||||
test('should pass for valid @inject field', () {
|
||||
final field = _createMockField(
|
||||
name: 'service',
|
||||
annotations: ['inject'],
|
||||
type: 'String',
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateFieldAnnotations(field),
|
||||
returnsNormally,
|
||||
);
|
||||
});
|
||||
|
||||
test('should throw for @inject field with void type', () {
|
||||
final field = _createMockField(
|
||||
name: 'service',
|
||||
annotations: ['inject'],
|
||||
type: 'void',
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateFieldAnnotations(field),
|
||||
throwsA(isA<AnnotationValidationException>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should pass for non-inject field', () {
|
||||
final field = _createMockField(
|
||||
name: 'service',
|
||||
annotations: [],
|
||||
type: 'String',
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateFieldAnnotations(field),
|
||||
returnsNormally,
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
group('validateClassAnnotations', () {
|
||||
test('should pass for valid @module class', () {
|
||||
final classElement = _createMockClass(
|
||||
name: 'AppModule',
|
||||
annotations: ['module'],
|
||||
methods: [
|
||||
_createMockMethod(name: 'createService', annotations: ['provide']),
|
||||
],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateClassAnnotations(classElement),
|
||||
returnsNormally,
|
||||
);
|
||||
});
|
||||
|
||||
test('should throw for @module class with no public methods', () {
|
||||
final classElement = _createMockClass(
|
||||
name: 'AppModule',
|
||||
annotations: ['module'],
|
||||
methods: [],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateClassAnnotations(classElement),
|
||||
throwsA(isA<AnnotationValidationException>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should throw for @module class with unannotated public methods', () {
|
||||
final classElement = _createMockClass(
|
||||
name: 'AppModule',
|
||||
annotations: ['module'],
|
||||
methods: [
|
||||
_createMockMethod(name: 'createService', annotations: []),
|
||||
],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateClassAnnotations(classElement),
|
||||
throwsA(isA<AnnotationValidationException>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should pass for valid @injectable class', () {
|
||||
final classElement = _createMockClass(
|
||||
name: 'AppService',
|
||||
annotations: ['injectable'],
|
||||
fields: [
|
||||
_createMockField(name: 'dependency', annotations: ['inject'], type: 'String', isFinal: true),
|
||||
],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateClassAnnotations(classElement),
|
||||
returnsNormally,
|
||||
);
|
||||
});
|
||||
|
||||
test('should pass for @injectable class with no inject fields', () {
|
||||
final classElement = _createMockClass(
|
||||
name: 'AppService',
|
||||
annotations: ['injectable'],
|
||||
fields: [
|
||||
_createMockField(name: 'dependency', annotations: [], type: 'String'),
|
||||
],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateClassAnnotations(classElement),
|
||||
returnsNormally,
|
||||
);
|
||||
});
|
||||
|
||||
test('should throw for @injectable class with non-final inject fields', () {
|
||||
final classElement = _createMockClass(
|
||||
name: 'AppService',
|
||||
annotations: ['injectable'],
|
||||
fields: [
|
||||
_createMockField(
|
||||
name: 'dependency',
|
||||
annotations: ['inject'],
|
||||
type: 'String',
|
||||
isFinal: false,
|
||||
),
|
||||
],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateClassAnnotations(classElement),
|
||||
throwsA(isA<AnnotationValidationException>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should pass for @injectable class with final inject fields', () {
|
||||
final classElement = _createMockClass(
|
||||
name: 'AppService',
|
||||
annotations: ['injectable'],
|
||||
fields: [
|
||||
_createMockField(
|
||||
name: 'dependency',
|
||||
annotations: ['inject'],
|
||||
type: 'String',
|
||||
isFinal: true,
|
||||
),
|
||||
],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => AnnotationValidator.validateClassAnnotations(classElement),
|
||||
returnsNormally,
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// Mock implementations for testing
|
||||
MethodElement _createMockMethod({
|
||||
required String name,
|
||||
required List<String> annotations,
|
||||
}) {
|
||||
return _MockMethodElement(name, annotations);
|
||||
}
|
||||
|
||||
FieldElement _createMockField({
|
||||
required String name,
|
||||
required List<String> annotations,
|
||||
required String type,
|
||||
bool isFinal = false,
|
||||
}) {
|
||||
return _MockFieldElement(name, annotations, type, isFinal);
|
||||
}
|
||||
|
||||
ClassElement _createMockClass({
|
||||
required String name,
|
||||
required List<String> annotations,
|
||||
List<MethodElement> methods = const [],
|
||||
List<FieldElement> fields = const [],
|
||||
}) {
|
||||
return _MockClassElement(name, annotations, methods, fields);
|
||||
}
|
||||
|
||||
class _MockMethodElement implements MethodElement {
|
||||
final String _name;
|
||||
final List<String> _annotations;
|
||||
|
||||
_MockMethodElement(this._name, this._annotations);
|
||||
|
||||
@override
|
||||
Source get source => _MockSource();
|
||||
|
||||
@override
|
||||
String get displayName => _name;
|
||||
|
||||
@override
|
||||
String get name => _name;
|
||||
|
||||
@override
|
||||
List<ElementAnnotation> get metadata => _annotations.map((a) => _MockElementAnnotation(a)).toList();
|
||||
|
||||
@override
|
||||
bool get isPublic => true;
|
||||
|
||||
@override
|
||||
List<ParameterElement> get parameters => [];
|
||||
|
||||
@override
|
||||
DartType get returnType => _MockDartType('String');
|
||||
|
||||
@override
|
||||
noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
|
||||
}
|
||||
|
||||
class _MockFieldElement implements FieldElement {
|
||||
final String _name;
|
||||
final List<String> _annotations;
|
||||
final String _type;
|
||||
final bool _isFinal;
|
||||
|
||||
_MockFieldElement(this._name, this._annotations, this._type, this._isFinal);
|
||||
|
||||
@override
|
||||
Source get source => _MockSource();
|
||||
|
||||
@override
|
||||
String get displayName => _name;
|
||||
|
||||
@override
|
||||
String get name => _name;
|
||||
|
||||
@override
|
||||
List<ElementAnnotation> get metadata => _annotations.map((a) => _MockElementAnnotation(a)).toList();
|
||||
|
||||
@override
|
||||
bool get isFinal => _isFinal;
|
||||
|
||||
@override
|
||||
DartType get type => _MockDartType(_type);
|
||||
|
||||
@override
|
||||
noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
|
||||
}
|
||||
|
||||
class _MockClassElement implements ClassElement {
|
||||
final String _name;
|
||||
final List<String> _annotations;
|
||||
final List<MethodElement> _methods;
|
||||
final List<FieldElement> _fields;
|
||||
|
||||
_MockClassElement(this._name, this._annotations, this._methods, this._fields);
|
||||
|
||||
@override
|
||||
Source get source => _MockSource();
|
||||
|
||||
@override
|
||||
String get displayName => _name;
|
||||
|
||||
@override
|
||||
String get name => _name;
|
||||
|
||||
@override
|
||||
List<ElementAnnotation> get metadata => _annotations.map((a) => _MockElementAnnotation(a)).toList();
|
||||
|
||||
@override
|
||||
List<MethodElement> get methods => _methods;
|
||||
|
||||
@override
|
||||
List<FieldElement> get fields => _fields;
|
||||
|
||||
@override
|
||||
noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
|
||||
}
|
||||
|
||||
class _MockElementAnnotation implements ElementAnnotation {
|
||||
final String _type;
|
||||
|
||||
_MockElementAnnotation(this._type);
|
||||
|
||||
@override
|
||||
DartObject? computeConstantValue() {
|
||||
return _MockDartObject(_type);
|
||||
}
|
||||
|
||||
@override
|
||||
noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
|
||||
}
|
||||
|
||||
class _MockDartObject implements DartObject {
|
||||
final String _type;
|
||||
|
||||
_MockDartObject(this._type);
|
||||
|
||||
@override
|
||||
DartType? get type => _MockDartType(_type);
|
||||
|
||||
@override
|
||||
noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
|
||||
}
|
||||
|
||||
class _MockDartType implements DartType {
|
||||
final String _name;
|
||||
|
||||
_MockDartType(this._name);
|
||||
|
||||
@override
|
||||
String getDisplayString({bool withNullability = true}) => _name;
|
||||
|
||||
@override
|
||||
noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
|
||||
}
|
||||
class _MockSource implements Source {
|
||||
@override
|
||||
String get fullName => 'mock_source.dart';
|
||||
|
||||
@override
|
||||
noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
|
||||
}
|
||||
307
cherrypick_generator/test/bind_spec_test.dart
Normal file
307
cherrypick_generator/test/bind_spec_test.dart
Normal file
@@ -0,0 +1,307 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:cherrypick_generator/src/bind_spec.dart';
|
||||
import 'package:test/test.dart';
|
||||
|
||||
void main() {
|
||||
group('BindSpec Tests', () {
|
||||
group('BindSpec Creation', () {
|
||||
test('should create BindSpec with all properties', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'ApiClient',
|
||||
methodName: 'createApiClient',
|
||||
isSingleton: true,
|
||||
named: 'mainApi',
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: true,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
expect(bindSpec.returnType, equals('ApiClient'));
|
||||
expect(bindSpec.methodName, equals('createApiClient'));
|
||||
expect(bindSpec.isSingleton, isTrue);
|
||||
expect(bindSpec.named, equals('mainApi'));
|
||||
expect(bindSpec.parameters, isEmpty);
|
||||
expect(bindSpec.bindingType, equals(BindingType.provide));
|
||||
expect(bindSpec.isAsyncInstance, isFalse);
|
||||
expect(bindSpec.isAsyncProvide, isTrue);
|
||||
expect(bindSpec.hasParams, isFalse);
|
||||
});
|
||||
|
||||
test('should create BindSpec with minimal properties', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
expect(bindSpec.returnType, equals('String'));
|
||||
expect(bindSpec.methodName, equals('getString'));
|
||||
expect(bindSpec.isSingleton, isFalse);
|
||||
expect(bindSpec.named, isNull);
|
||||
expect(bindSpec.bindingType, equals(BindingType.instance));
|
||||
});
|
||||
});
|
||||
|
||||
group('Bind Generation - Instance', () {
|
||||
test('should generate simple instance bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, equals(' bind<String>().toInstance(getString());'));
|
||||
});
|
||||
|
||||
test('should generate singleton instance bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: true,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result,
|
||||
equals(' bind<String>().toInstance(getString()).singleton();'));
|
||||
});
|
||||
|
||||
test('should generate named instance bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
named: 'testString',
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result,
|
||||
equals(
|
||||
" bind<String>().toInstance(getString()).withName('testString');"));
|
||||
});
|
||||
|
||||
test('should generate named singleton instance bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: true,
|
||||
named: 'testString',
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result,
|
||||
equals(
|
||||
" bind<String>().toInstance(getString()).withName('testString').singleton();"));
|
||||
});
|
||||
|
||||
test('should generate async instance bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: true,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result, equals(' bind<String>().toInstanceAsync(getString());'));
|
||||
});
|
||||
});
|
||||
|
||||
group('Bind Generation - Provide', () {
|
||||
test('should generate simple provide bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result, equals(' bind<String>().toProvide(() => getString());'));
|
||||
});
|
||||
|
||||
test('should generate async provide bind', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: true,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result,
|
||||
equals(' bind<String>().toProvideAsync(() => getString());'));
|
||||
});
|
||||
|
||||
test('should generate provide bind with params', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: true,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result,
|
||||
equals(
|
||||
' bind<String>().toProvideWithParams((args) => getString());'));
|
||||
});
|
||||
|
||||
test('should generate async provide bind with params', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: true,
|
||||
hasParams: true,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result,
|
||||
equals(
|
||||
' bind<String>().toProvideAsyncWithParams((args) => getString());'));
|
||||
});
|
||||
});
|
||||
|
||||
group('Complex Scenarios', () {
|
||||
test('should generate bind with all options', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'ApiClient',
|
||||
methodName: 'createApiClient',
|
||||
isSingleton: true,
|
||||
named: 'mainApi',
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: true,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(
|
||||
result,
|
||||
equals(
|
||||
" bind<ApiClient>()\n"
|
||||
" .toProvideAsync(() => createApiClient())\n"
|
||||
" .withName('mainApi')\n"
|
||||
" .singleton();"));
|
||||
});
|
||||
|
||||
test('should handle different indentation', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result2 = bindSpec.generateBind(2);
|
||||
expect(result2, startsWith(' '));
|
||||
|
||||
final result8 = bindSpec.generateBind(8);
|
||||
expect(result8, startsWith(' '));
|
||||
});
|
||||
|
||||
test('should handle complex type names', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'Map<String, List<User>>',
|
||||
methodName: 'getComplexData',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('bind<Map<String, List<User>>>()'));
|
||||
expect(result, contains('toProvide'));
|
||||
expect(result, contains('getComplexData'));
|
||||
});
|
||||
});
|
||||
|
||||
group('BindingType Enum', () {
|
||||
test('should have correct enum values', () {
|
||||
expect(BindingType.instance, isNotNull);
|
||||
expect(BindingType.provide, isNotNull);
|
||||
expect(BindingType.values, hasLength(2));
|
||||
expect(BindingType.values, contains(BindingType.instance));
|
||||
expect(BindingType.values, contains(BindingType.provide));
|
||||
});
|
||||
|
||||
test('should have correct string representation', () {
|
||||
expect(BindingType.instance.toString(), contains('instance'));
|
||||
expect(BindingType.provide.toString(), contains('provide'));
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
@@ -1,13 +1,32 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:test/test.dart';
|
||||
|
||||
void main() {
|
||||
group('A group of tests', () {
|
||||
setUp(() {
|
||||
// Additional setup goes here.
|
||||
});
|
||||
// Import working test suites
|
||||
import 'simple_test.dart' as simple_tests;
|
||||
import 'bind_spec_test.dart' as bind_spec_tests;
|
||||
import 'metadata_utils_test.dart' as metadata_utils_tests;
|
||||
// Import integration test suites (now working!)
|
||||
import 'module_generator_test.dart' as module_generator_tests;
|
||||
import 'inject_generator_test.dart' as inject_generator_tests;
|
||||
|
||||
test('First Test', () {
|
||||
expect(2, 2);
|
||||
});
|
||||
void main() {
|
||||
group('CherryPick Generator Tests', () {
|
||||
group('Simple Tests', simple_tests.main);
|
||||
group('BindSpec Tests', bind_spec_tests.main);
|
||||
group('MetadataUtils Tests', metadata_utils_tests.main);
|
||||
group('ModuleGenerator Tests', module_generator_tests.main);
|
||||
group('InjectGenerator Tests', inject_generator_tests.main);
|
||||
});
|
||||
}
|
||||
|
||||
604
cherrypick_generator/test/inject_generator_test.dart
Normal file
604
cherrypick_generator/test/inject_generator_test.dart
Normal file
@@ -0,0 +1,604 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:build/build.dart';
|
||||
import 'package:build_test/build_test.dart';
|
||||
import 'package:cherrypick_generator/inject_generator.dart';
|
||||
import 'package:source_gen/source_gen.dart';
|
||||
import 'package:test/test.dart';
|
||||
|
||||
void main() {
|
||||
group('InjectGenerator Tests', () {
|
||||
setUp(() {
|
||||
// InjectGenerator setup if needed
|
||||
});
|
||||
|
||||
group('Basic Injection', () {
|
||||
test('should generate mixin for simple injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
late final MyService service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().resolve<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate mixin for nullable injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
late final MyService? service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().tryResolve<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Named Injection', () {
|
||||
test('should generate mixin for named injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@named('myService')
|
||||
late final MyService service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().resolve<MyService>(
|
||||
named: 'myService',
|
||||
);
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate mixin for named nullable injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@named('myService')
|
||||
late final MyService? service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().tryResolve<MyService>(
|
||||
named: 'myService',
|
||||
);
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Scoped Injection', () {
|
||||
test('should generate mixin for scoped injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@scope('userScope')
|
||||
late final MyService service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openScope(
|
||||
scopeName: 'userScope',
|
||||
).resolve<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate mixin for scoped named injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@scope('userScope')
|
||||
@named('myService')
|
||||
late final MyService service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openScope(
|
||||
scopeName: 'userScope',
|
||||
).resolve<MyService>(named: 'myService');
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Async Injection', () {
|
||||
test('should generate mixin for Future injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
late final Future<MyService> service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().resolveAsync<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate mixin for nullable Future injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
late final Future<MyService?> service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().tryResolveAsync<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate mixin for named Future injection', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@named('myService')
|
||||
late final Future<MyService> service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().resolveAsync<MyService>(
|
||||
named: 'myService',
|
||||
);
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Multiple Fields', () {
|
||||
test('should generate mixin for multiple injected fields', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class ApiService {}
|
||||
class DatabaseService {}
|
||||
class CacheService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
late final ApiService apiService;
|
||||
|
||||
@inject()
|
||||
@named('cache')
|
||||
late final CacheService? cacheService;
|
||||
|
||||
@inject()
|
||||
@scope('dbScope')
|
||||
late final Future<DatabaseService> dbService;
|
||||
|
||||
// Non-injected field should be ignored
|
||||
String nonInjectedField = "test";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.apiService = CherryPick.openRootScope().resolve<ApiService>();
|
||||
instance.cacheService = CherryPick.openRootScope().tryResolve<CacheService>(
|
||||
named: 'cache',
|
||||
);
|
||||
instance.dbService = CherryPick.openScope(
|
||||
scopeName: 'dbScope',
|
||||
).resolveAsync<DatabaseService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Complex Types', () {
|
||||
test('should handle generic types', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
late final List<String> stringList;
|
||||
|
||||
@inject()
|
||||
late final Map<String, int> stringIntMap;
|
||||
|
||||
@inject()
|
||||
late final Future<List<String>> futureStringList;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.stringList = CherryPick.openRootScope().resolve<List<String>>();
|
||||
instance.stringIntMap = CherryPick.openRootScope()
|
||||
.resolve<Map<String, int>>();
|
||||
instance.futureStringList = CherryPick.openRootScope()
|
||||
.resolveAsync<List<String>>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Error Cases', () {
|
||||
test('should throw error for non-class element', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
@injectable()
|
||||
void notAClass() {}
|
||||
''';
|
||||
|
||||
await expectLater(
|
||||
() => _testGeneration(input, ''),
|
||||
throwsA(isA<InvalidGenerationSourceError>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should generate empty mixin for class without @inject fields',
|
||||
() async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
String normalField = "test";
|
||||
int anotherField = 42;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Edge Cases', () {
|
||||
test('should handle empty scope name', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@scope('')
|
||||
late final MyService service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().resolve<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should handle empty named value', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_widget.inject.cherrypick.g.dart';
|
||||
|
||||
class MyService {}
|
||||
|
||||
@injectable()
|
||||
class TestWidget {
|
||||
@inject()
|
||||
@named('')
|
||||
late final MyService service;
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_widget.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// InjectGenerator
|
||||
// **************************************************************************
|
||||
|
||||
mixin _\$TestWidget {
|
||||
void _inject(TestWidget instance) {
|
||||
instance.service = CherryPick.openRootScope().resolve<MyService>();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/// Helper function to test code generation
|
||||
Future<void> _testGeneration(String input, String expectedOutput) async {
|
||||
await testBuilder(
|
||||
injectBuilder(BuilderOptions.empty),
|
||||
{
|
||||
'a|lib/test_widget.dart': input,
|
||||
},
|
||||
outputs: {
|
||||
'a|lib/test_widget.inject.cherrypick.g.dart': expectedOutput,
|
||||
},
|
||||
reader: await PackageAssetReader.currentIsolate(),
|
||||
);
|
||||
}
|
||||
72
cherrypick_generator/test/metadata_utils_test.dart
Normal file
72
cherrypick_generator/test/metadata_utils_test.dart
Normal file
@@ -0,0 +1,72 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:cherrypick_generator/src/metadata_utils.dart';
|
||||
import 'package:test/test.dart';
|
||||
|
||||
void main() {
|
||||
group('MetadataUtils Tests', () {
|
||||
group('Basic Functionality', () {
|
||||
test('should handle empty metadata lists', () {
|
||||
expect(MetadataUtils.anyMeta([], 'singleton'), isFalse);
|
||||
expect(MetadataUtils.getNamedValue([]), isNull);
|
||||
});
|
||||
|
||||
test('should be available for testing', () {
|
||||
// This test ensures the MetadataUtils class is accessible
|
||||
// More comprehensive tests would require mock setup or integration tests
|
||||
expect(MetadataUtils, isNotNull);
|
||||
});
|
||||
|
||||
test('should handle null inputs gracefully', () {
|
||||
expect(MetadataUtils.anyMeta([], ''), isFalse);
|
||||
expect(MetadataUtils.getNamedValue([]), isNull);
|
||||
});
|
||||
|
||||
test('should have static methods available', () {
|
||||
// Verify that the static methods exist and can be called
|
||||
// This is a basic smoke test
|
||||
expect(() => MetadataUtils.anyMeta([], 'test'), returnsNormally);
|
||||
expect(() => MetadataUtils.getNamedValue([]), returnsNormally);
|
||||
});
|
||||
});
|
||||
|
||||
group('Method Signatures', () {
|
||||
test('anyMeta should return bool', () {
|
||||
final result = MetadataUtils.anyMeta([], 'singleton');
|
||||
expect(result, isA<bool>());
|
||||
});
|
||||
|
||||
test('getNamedValue should return String or null', () {
|
||||
final result = MetadataUtils.getNamedValue([]);
|
||||
expect(result, anyOf(isA<String>(), isNull));
|
||||
});
|
||||
});
|
||||
|
||||
group('Edge Cases', () {
|
||||
test('should handle various annotation names', () {
|
||||
// Test with different annotation names
|
||||
expect(MetadataUtils.anyMeta([], 'singleton'), isFalse);
|
||||
expect(MetadataUtils.anyMeta([], 'provide'), isFalse);
|
||||
expect(MetadataUtils.anyMeta([], 'instance'), isFalse);
|
||||
expect(MetadataUtils.anyMeta([], 'named'), isFalse);
|
||||
expect(MetadataUtils.anyMeta([], 'params'), isFalse);
|
||||
});
|
||||
|
||||
test('should handle empty strings', () {
|
||||
expect(MetadataUtils.anyMeta([], ''), isFalse);
|
||||
expect(MetadataUtils.getNamedValue([]), isNull);
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
648
cherrypick_generator/test/module_generator_test.dart
Normal file
648
cherrypick_generator/test/module_generator_test.dart
Normal file
@@ -0,0 +1,648 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:test/test.dart';
|
||||
import 'package:build_test/build_test.dart';
|
||||
import 'package:build/build.dart';
|
||||
|
||||
import 'package:cherrypick_generator/module_generator.dart';
|
||||
import 'package:source_gen/source_gen.dart';
|
||||
|
||||
void main() {
|
||||
group('ModuleGenerator Tests', () {
|
||||
setUp(() {
|
||||
// ModuleGenerator setup if needed
|
||||
});
|
||||
|
||||
group('Simple Module Generation', () {
|
||||
test('should generate basic module with instance binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@instance()
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toInstance(testString());
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate basic module with provide binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toProvide(() => testString());
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Singleton Bindings', () {
|
||||
test('should generate singleton instance binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@instance()
|
||||
@singleton()
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toInstance(testString()).singleton();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate singleton provide binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
@singleton()
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toProvide(() => testString()).singleton();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Named Bindings', () {
|
||||
test('should generate named instance binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@instance()
|
||||
@named('testName')
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toInstance(testString()).withName('testName');
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate named singleton binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
@singleton()
|
||||
@named('testName')
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>()
|
||||
.toProvide(() => testString())
|
||||
.withName('testName')
|
||||
.singleton();
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Async Bindings', () {
|
||||
test('should generate async instance binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@instance()
|
||||
Future<String> testString() async => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toInstanceAsync(testString());
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate async provide binding', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
Future<String> testString() async => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toProvideAsync(() => testString());
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate async binding with params', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
Future<String> testString(@params() dynamic params) async => "Hello \$params";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toProvideAsyncWithParams((args) => testString(args));
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Dependencies Injection', () {
|
||||
test('should generate binding with injected dependencies', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
class ApiClient {}
|
||||
class Repository {}
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
Repository repository(ApiClient client) => Repository();
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<Repository>().toProvide(
|
||||
() => repository(currentScope.resolve<ApiClient>()),
|
||||
);
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate binding with named dependencies', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
class ApiClient {}
|
||||
class Repository {}
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
Repository repository(@named('api') ApiClient client) => Repository();
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<Repository>().toProvide(
|
||||
() => repository(currentScope.resolve<ApiClient>(named: 'api')),
|
||||
);
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Runtime Parameters', () {
|
||||
test('should generate binding with params', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
String testString(@params() dynamic params) => "Hello \$params";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toProvideWithParams((args) => testString(args));
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
|
||||
test('should generate async binding with params', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@provide()
|
||||
Future<String> testString(@params() dynamic params) async => "Hello \$params";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toProvideAsyncWithParams((args) => testString(args));
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Complex Scenarios', () {
|
||||
test('should generate module with multiple bindings', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
class ApiClient {}
|
||||
class Repository {}
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@instance()
|
||||
@singleton()
|
||||
@named('baseUrl')
|
||||
String baseUrl() => "https://api.example.com";
|
||||
|
||||
@provide()
|
||||
@singleton()
|
||||
ApiClient apiClient(@named('baseUrl') String url) => ApiClient();
|
||||
|
||||
@provide()
|
||||
Repository repository(ApiClient client) => Repository();
|
||||
|
||||
@provide()
|
||||
@named('greeting')
|
||||
String greeting(@params() dynamic name) => "Hello \$name";
|
||||
}
|
||||
''';
|
||||
|
||||
const expectedOutput = '''
|
||||
// dart format width=80
|
||||
// GENERATED CODE - DO NOT MODIFY BY HAND
|
||||
|
||||
part of 'test_module.dart';
|
||||
|
||||
// **************************************************************************
|
||||
// ModuleGenerator
|
||||
// **************************************************************************
|
||||
|
||||
final class \$TestModule extends TestModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<String>().toInstance(baseUrl()).withName('baseUrl').singleton();
|
||||
bind<ApiClient>()
|
||||
.toProvide(
|
||||
() => apiClient(currentScope.resolve<String>(named: 'baseUrl')),
|
||||
)
|
||||
.singleton();
|
||||
bind<Repository>().toProvide(
|
||||
() => repository(currentScope.resolve<ApiClient>()),
|
||||
);
|
||||
bind<String>()
|
||||
.toProvideWithParams((args) => greeting(args))
|
||||
.withName('greeting');
|
||||
}
|
||||
}
|
||||
''';
|
||||
|
||||
await _testGeneration(input, expectedOutput);
|
||||
});
|
||||
});
|
||||
|
||||
group('Error Cases', () {
|
||||
test('should throw error for non-class element', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
void notAClass() {}
|
||||
''';
|
||||
|
||||
await expectLater(
|
||||
() => _testGeneration(input, ''),
|
||||
throwsA(isA<InvalidGenerationSourceError>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should throw error for method without @instance or @provide',
|
||||
() async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
String testString() => "Hello World";
|
||||
}
|
||||
''';
|
||||
|
||||
await expectLater(
|
||||
() => _testGeneration(input, ''),
|
||||
throwsA(isA<InvalidGenerationSourceError>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should throw error for @params with @instance', () async {
|
||||
const input = '''
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
part 'test_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class TestModule extends Module {
|
||||
@instance()
|
||||
String testString(@params() dynamic params) => "Hello \$params";
|
||||
}
|
||||
''';
|
||||
|
||||
await expectLater(
|
||||
() => _testGeneration(input, ''),
|
||||
throwsA(isA<InvalidGenerationSourceError>()),
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/// Helper function to test code generation
|
||||
Future<void> _testGeneration(String input, String expectedOutput) async {
|
||||
await testBuilder(
|
||||
moduleBuilder(BuilderOptions.empty),
|
||||
{
|
||||
'a|lib/test_module.dart': input,
|
||||
},
|
||||
outputs: {
|
||||
'a|lib/test_module.module.cherrypick.g.dart': expectedOutput,
|
||||
},
|
||||
reader: await PackageAssetReader.currentIsolate(),
|
||||
);
|
||||
}
|
||||
176
cherrypick_generator/test/simple_test.dart
Normal file
176
cherrypick_generator/test/simple_test.dart
Normal file
@@ -0,0 +1,176 @@
|
||||
//
|
||||
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
|
||||
import 'package:cherrypick_generator/src/bind_spec.dart';
|
||||
import 'package:test/test.dart';
|
||||
|
||||
void main() {
|
||||
group('Simple Generator Tests', () {
|
||||
group('BindSpec', () {
|
||||
test('should create BindSpec with correct properties', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
expect(bindSpec.returnType, equals('String'));
|
||||
expect(bindSpec.methodName, equals('getString'));
|
||||
expect(bindSpec.isSingleton, isFalse);
|
||||
expect(bindSpec.bindingType, equals(BindingType.instance));
|
||||
});
|
||||
|
||||
test('should generate basic bind code', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('bind<String>()'));
|
||||
expect(result, contains('toInstance'));
|
||||
expect(result, contains('getString'));
|
||||
});
|
||||
|
||||
test('should generate singleton bind code', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: true,
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('singleton()'));
|
||||
});
|
||||
|
||||
test('should generate named bind code', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
named: 'testName',
|
||||
parameters: [],
|
||||
bindingType: BindingType.instance,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains("withName('testName')"));
|
||||
});
|
||||
|
||||
test('should generate provide bind code', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('toProvide'));
|
||||
expect(result, contains('() => getString'));
|
||||
});
|
||||
|
||||
test('should generate async provide bind code', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: true,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('toProvideAsync'));
|
||||
});
|
||||
|
||||
test('should generate params bind code', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'String',
|
||||
methodName: 'getString',
|
||||
isSingleton: false,
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: false,
|
||||
hasParams: true,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('toProvideWithParams'));
|
||||
expect(result, contains('(args) => getString()'));
|
||||
});
|
||||
|
||||
test('should generate complex bind with all options', () {
|
||||
final bindSpec = BindSpec(
|
||||
returnType: 'ApiClient',
|
||||
methodName: 'createApiClient',
|
||||
isSingleton: true,
|
||||
named: 'mainApi',
|
||||
parameters: [],
|
||||
bindingType: BindingType.provide,
|
||||
isAsyncInstance: false,
|
||||
isAsyncProvide: true,
|
||||
hasParams: false,
|
||||
);
|
||||
|
||||
final result = bindSpec.generateBind(4);
|
||||
expect(result, contains('bind<ApiClient>()'));
|
||||
expect(result, contains('toProvideAsync'));
|
||||
expect(result, contains("withName('mainApi')"));
|
||||
expect(result, contains('singleton()'));
|
||||
});
|
||||
});
|
||||
|
||||
group('BindingType Enum', () {
|
||||
test('should have correct values', () {
|
||||
expect(BindingType.instance, isNotNull);
|
||||
expect(BindingType.provide, isNotNull);
|
||||
expect(BindingType.values.length, equals(2));
|
||||
});
|
||||
});
|
||||
|
||||
group('Generator Classes', () {
|
||||
test('should be able to import generators', () {
|
||||
// Test that we can import the generator classes
|
||||
expect(BindSpec, isNotNull);
|
||||
expect(BindingType, isNotNull);
|
||||
});
|
||||
});
|
||||
});
|
||||
}
|
||||
231
cherrypick_generator/test/type_parser_test.dart
Normal file
231
cherrypick_generator/test/type_parser_test.dart
Normal file
@@ -0,0 +1,231 @@
|
||||
import 'package:test/test.dart';
|
||||
|
||||
import 'package:analyzer/dart/element/element.dart';
|
||||
import 'package:analyzer/source/source.dart';
|
||||
import 'package:cherrypick_generator/src/type_parser.dart';
|
||||
import 'package:cherrypick_generator/src/exceptions.dart';
|
||||
|
||||
void main() {
|
||||
group('TypeParser', () {
|
||||
group('parseType', () {
|
||||
test('should parse simple types correctly', () {
|
||||
// This would require setting up analyzer infrastructure
|
||||
// For now, we'll test the ParsedType class directly
|
||||
});
|
||||
|
||||
test('should parse Future types correctly', () {
|
||||
// This would require setting up analyzer infrastructure
|
||||
// For now, we'll test the ParsedType class directly
|
||||
});
|
||||
|
||||
test('should parse nullable types correctly', () {
|
||||
// This would require setting up analyzer infrastructure
|
||||
// For now, we'll test the ParsedType class directly
|
||||
});
|
||||
|
||||
test('should throw TypeParsingException for invalid types', () {
|
||||
// This would require setting up analyzer infrastructure
|
||||
// For now, we'll test the ParsedType class directly
|
||||
});
|
||||
});
|
||||
|
||||
group('validateInjectableType', () {
|
||||
test('should throw for void type', () {
|
||||
final parsedType = ParsedType(
|
||||
displayString: 'void',
|
||||
coreType: 'void',
|
||||
isNullable: false,
|
||||
isFuture: false,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => TypeParser.validateInjectableType(parsedType, _createMockElement()),
|
||||
throwsA(isA<TypeParsingException>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should throw for dynamic type', () {
|
||||
final parsedType = ParsedType(
|
||||
displayString: 'dynamic',
|
||||
coreType: 'dynamic',
|
||||
isNullable: false,
|
||||
isFuture: false,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => TypeParser.validateInjectableType(parsedType, _createMockElement()),
|
||||
throwsA(isA<TypeParsingException>()),
|
||||
);
|
||||
});
|
||||
|
||||
test('should pass for valid types', () {
|
||||
final parsedType = ParsedType(
|
||||
displayString: 'String',
|
||||
coreType: 'String',
|
||||
isNullable: false,
|
||||
isFuture: false,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
);
|
||||
|
||||
expect(
|
||||
() => TypeParser.validateInjectableType(parsedType, _createMockElement()),
|
||||
returnsNormally,
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
group('ParsedType', () {
|
||||
test('should return correct codeGenType for simple types', () {
|
||||
final parsedType = ParsedType(
|
||||
displayString: 'String',
|
||||
coreType: 'String',
|
||||
isNullable: false,
|
||||
isFuture: false,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
);
|
||||
|
||||
expect(parsedType.codeGenType, equals('String'));
|
||||
});
|
||||
|
||||
test('should return correct codeGenType for Future types', () {
|
||||
final innerType = ParsedType(
|
||||
displayString: 'String',
|
||||
coreType: 'String',
|
||||
isNullable: false,
|
||||
isFuture: false,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
);
|
||||
|
||||
final parsedType = ParsedType(
|
||||
displayString: 'Future<String>',
|
||||
coreType: 'Future<String>',
|
||||
isNullable: false,
|
||||
isFuture: true,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
innerType: innerType,
|
||||
);
|
||||
|
||||
expect(parsedType.codeGenType, equals('String'));
|
||||
});
|
||||
|
||||
test('should return correct resolveMethodName for sync types', () {
|
||||
final parsedType = ParsedType(
|
||||
displayString: 'String',
|
||||
coreType: 'String',
|
||||
isNullable: false,
|
||||
isFuture: false,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
);
|
||||
|
||||
expect(parsedType.resolveMethodName, equals('resolve'));
|
||||
});
|
||||
|
||||
test('should return correct resolveMethodName for nullable sync types', () {
|
||||
final parsedType = ParsedType(
|
||||
displayString: 'String?',
|
||||
coreType: 'String',
|
||||
isNullable: true,
|
||||
isFuture: false,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
);
|
||||
|
||||
expect(parsedType.resolveMethodName, equals('tryResolve'));
|
||||
});
|
||||
|
||||
test('should return correct resolveMethodName for async types', () {
|
||||
final parsedType = ParsedType(
|
||||
displayString: 'Future<String>',
|
||||
coreType: 'String',
|
||||
isNullable: false,
|
||||
isFuture: true,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
);
|
||||
|
||||
expect(parsedType.resolveMethodName, equals('resolveAsync'));
|
||||
});
|
||||
|
||||
test('should return correct resolveMethodName for nullable async types', () {
|
||||
final parsedType = ParsedType(
|
||||
displayString: 'Future<String?>',
|
||||
coreType: 'String',
|
||||
isNullable: true,
|
||||
isFuture: true,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
);
|
||||
|
||||
expect(parsedType.resolveMethodName, equals('tryResolveAsync'));
|
||||
});
|
||||
|
||||
test('should implement equality correctly', () {
|
||||
final parsedType1 = ParsedType(
|
||||
displayString: 'String',
|
||||
coreType: 'String',
|
||||
isNullable: false,
|
||||
isFuture: false,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
);
|
||||
|
||||
final parsedType2 = ParsedType(
|
||||
displayString: 'String',
|
||||
coreType: 'String',
|
||||
isNullable: false,
|
||||
isFuture: false,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
);
|
||||
|
||||
expect(parsedType1, equals(parsedType2));
|
||||
expect(parsedType1.hashCode, equals(parsedType2.hashCode));
|
||||
});
|
||||
|
||||
test('should implement toString correctly', () {
|
||||
final parsedType = ParsedType(
|
||||
displayString: 'String',
|
||||
coreType: 'String',
|
||||
isNullable: false,
|
||||
isFuture: false,
|
||||
isGeneric: false,
|
||||
typeArguments: [],
|
||||
);
|
||||
|
||||
final result = parsedType.toString();
|
||||
expect(result, contains('ParsedType'));
|
||||
expect(result, contains('String'));
|
||||
expect(result, contains('isNullable: false'));
|
||||
expect(result, contains('isFuture: false'));
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// Mock element for testing
|
||||
Element _createMockElement() {
|
||||
return _MockElement();
|
||||
}
|
||||
|
||||
class _MockElement implements Element {
|
||||
@override
|
||||
String get displayName => 'MockElement';
|
||||
|
||||
@override
|
||||
String get name => 'MockElement';
|
||||
|
||||
@override
|
||||
Source? get source => null;
|
||||
|
||||
@override
|
||||
noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
|
||||
}
|
||||
140
doc/annotations_en.md
Normal file
140
doc/annotations_en.md
Normal file
@@ -0,0 +1,140 @@
|
||||
# DI Code Generation with Annotations (CherryPick)
|
||||
|
||||
CherryPick enables smart, fully-automated dependency injection (DI) for Dart/Flutter via annotations and code generation.
|
||||
This eliminates boilerplate and guarantees correctness—just annotate, run the generator, and use!
|
||||
|
||||
---
|
||||
|
||||
## 1. How does it work?
|
||||
|
||||
You annotate classes, fields, and modules using [cherrypick_annotations].
|
||||
The [cherrypick_generator] processes these, generating code that registers your dependencies and wires up fields or modules.
|
||||
|
||||
You then run:
|
||||
```sh
|
||||
dart run build_runner build --delete-conflicting-outputs
|
||||
```
|
||||
— and use the generated files in your app.
|
||||
|
||||
---
|
||||
|
||||
## 2. Supported Annotations
|
||||
|
||||
| Annotation | Where | Purpose |
|
||||
|-------------------|-----------------|----------------------------------------------------------|
|
||||
| `@injectable()` | class | Enables auto field injection; mixin will be generated |
|
||||
| `@inject()` | field | Field will be injected automatically |
|
||||
| `@scope()` | field/param | Use a named scope when resolving this dep |
|
||||
| `@named()` | field/param | Bind/resolve a named interface implementation |
|
||||
| `@module()` | class | Marks as a DI module (methods = providers) |
|
||||
| `@provide` | method | Registers a type via this provider method |
|
||||
| `@instance` | method | Registers a direct instance (like singleton/factory) |
|
||||
| `@singleton` | method/class | The target is a singleton |
|
||||
| `@params` | param | Accepts runtime/constructor params for providers |
|
||||
|
||||
**You can combine annotations as needed for advanced use-cases.**
|
||||
|
||||
---
|
||||
|
||||
## 3. Practical Examples
|
||||
|
||||
### A. Field Injection (recommended for widgets/classes)
|
||||
|
||||
```dart
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
@injectable()
|
||||
class MyWidget with _$MyWidget { // the generated mixin
|
||||
@inject()
|
||||
late final AuthService auth;
|
||||
|
||||
@inject()
|
||||
@scope('profile')
|
||||
late final ProfileManager profile;
|
||||
|
||||
@inject()
|
||||
@named('special')
|
||||
late final ApiClient specialApi;
|
||||
}
|
||||
```
|
||||
|
||||
- After running build_runner, the mixin _$MyWidget is created.
|
||||
- Call `MyWidget().injectFields();` (method name may be `_inject` or similar) to populate the fields!
|
||||
|
||||
### B. Module Binding (recommended for global app services)
|
||||
|
||||
```dart
|
||||
@module()
|
||||
abstract class AppModule extends Module {
|
||||
@singleton
|
||||
AuthService provideAuth(Api api) => AuthService(api);
|
||||
|
||||
@provide
|
||||
@named('logging')
|
||||
Future<Logger> provideLogger(@params Map<String, dynamic> args) async => ...
|
||||
}
|
||||
```
|
||||
|
||||
- Providers can return async(`Future<T>`) or sync.
|
||||
- `@singleton` = one instance per scope.
|
||||
|
||||
---
|
||||
|
||||
## 4. Using the Generated Code
|
||||
|
||||
1. Add to your `pubspec.yaml`:
|
||||
|
||||
```yaml
|
||||
dependencies:
|
||||
cherrypick: any
|
||||
cherrypick_annotations: any
|
||||
|
||||
dev_dependencies:
|
||||
cherrypick_generator: any
|
||||
build_runner: any
|
||||
```
|
||||
|
||||
2. Import generated files (e.g. `app_module.module.cherrypick.g.dart`, `your_class.inject.cherrypick.g.dart`).
|
||||
|
||||
3. Register modules:
|
||||
|
||||
```dart
|
||||
final scope = openRootScope()
|
||||
..installModules([$AppModule()]);
|
||||
```
|
||||
|
||||
4. For classes with auto-injected fields, mix in the generated mixin and call the injector:
|
||||
|
||||
```dart
|
||||
final widget = MyWidget();
|
||||
widget.injectFields(); // or use the mixin's helper
|
||||
```
|
||||
|
||||
5. All dependencies are now available and ready to use!
|
||||
|
||||
---
|
||||
|
||||
## 5. Advanced Features
|
||||
|
||||
- **Named and Scoped dependencies:** use `@named`, `@scope` on fields/methods and in resolve().
|
||||
- **Async support:** Providers or injected fields can be Future<T> (resolveAsync).
|
||||
- **Runtime parameters:** Decorate a parameter with `@params`, and use `resolve<T>(params: ...)`.
|
||||
- **Combining strategies:** Mix field injection (`@injectable`) and module/provider (`@module` + methods) in one app.
|
||||
|
||||
---
|
||||
|
||||
## 6. Troubleshooting
|
||||
|
||||
- Make sure all dependencies are annotated, imports are correct, and run `build_runner` on every code/DI change.
|
||||
- Errors in annotation usage (e.g. `@singleton` on non-class/method) will be shown at build time.
|
||||
- Use the `.g.dart` files directly—do not edit them by hand.
|
||||
|
||||
---
|
||||
|
||||
## 7. References
|
||||
|
||||
- [Cherrypick Generator README (extended)](../cherrypick_generator/README.md)
|
||||
- Example: `examples/postly`
|
||||
- [API Reference](../cherrypick/doc/api/)
|
||||
|
||||
---
|
||||
137
doc/annotations_ru.md
Normal file
137
doc/annotations_ru.md
Normal file
@@ -0,0 +1,137 @@
|
||||
# Генерация DI-кода через аннотации (CherryPick)
|
||||
|
||||
CherryPick позволяет получить умный и полностью автоматизированный DI для Dart/Flutter на основе аннотаций и генерации кода.
|
||||
Это убирает boilerplate — просто ставьте аннотации, запускайте генератор и используйте результат!
|
||||
|
||||
---
|
||||
|
||||
## 1. Как это работает?
|
||||
|
||||
Вы размечаете классы, поля и модули с помощью [cherrypick_annotations].
|
||||
[cherrypick_generator] анализирует их и создаёт код для регистрации зависимостей и подстановки полей или модулей.
|
||||
|
||||
Далее — запускайте:
|
||||
```sh
|
||||
dart run build_runner build --delete-conflicting-outputs
|
||||
```
|
||||
— и используйте сгенерированные файлы в проекте.
|
||||
|
||||
---
|
||||
|
||||
## 2. Поддерживаемые аннотации
|
||||
|
||||
| Аннотация | Где применить | Значение |
|
||||
|--------------------|------------------|------------------------------------------------------------|
|
||||
| `@injectable()` | класс | Включает автоподстановку полей, генерируется mixin |
|
||||
| `@inject()` | поле | Поле будет автоматически подставлено DI |
|
||||
| `@scope()` | поле/параметр | Использовать определённый scope при разрешении |
|
||||
| `@named()` | поле/параметр | Именованный биндинг для интерфейсов/реализаций |
|
||||
| `@module()` | класс | Класс как DI-модуль (методы — провайдеры) |
|
||||
| `@provide` | метод | Регистрирует тип через этот метод-провайдер |
|
||||
| `@instance` | метод | Регистрирует как прямой инстанс (singleton/factory, как есть)|
|
||||
| `@singleton` | метод/класс | Синглтон (один экземпляр на scope) |
|
||||
| `@params` | параметр | Пробрасывает параметры рантайм/конструктора в DI |
|
||||
|
||||
Миксуйте аннотации для сложных сценариев!
|
||||
|
||||
---
|
||||
|
||||
## 3. Примеры использования
|
||||
|
||||
### A. Field Injection (рекомендуется для виджетов/классов)
|
||||
|
||||
```dart
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
@injectable()
|
||||
class MyWidget with _$MyWidget {
|
||||
@inject()
|
||||
late final AuthService auth;
|
||||
|
||||
@inject()
|
||||
@scope('profile')
|
||||
late final ProfileManager profile;
|
||||
|
||||
@inject()
|
||||
@named('special')
|
||||
late final ApiClient specialApi;
|
||||
}
|
||||
```
|
||||
- После build_runner появится mixin _$MyWidget.
|
||||
- Вызовите `MyWidget().injectFields();` (или соответствующий метод из mixin), чтобы заполнить поля.
|
||||
|
||||
### B. Binding через модуль (вариант для глобальных сервисов)
|
||||
|
||||
```dart
|
||||
@module()
|
||||
abstract class AppModule extends Module {
|
||||
@singleton
|
||||
AuthService provideAuth(Api api) => AuthService(api);
|
||||
|
||||
@provide
|
||||
@named('logging')
|
||||
Future<Logger> provideLogger(@params Map<String, dynamic> args) async => ...
|
||||
}
|
||||
```
|
||||
- Методы-провайдеры поддерживают async (Future<T>) и singleton.
|
||||
|
||||
---
|
||||
|
||||
## 4. Использование сгенерированного кода
|
||||
|
||||
1. В `pubspec.yaml`:
|
||||
|
||||
```yaml
|
||||
dependencies:
|
||||
cherrypick: any
|
||||
cherrypick_annotations: any
|
||||
|
||||
dev_dependencies:
|
||||
cherrypick_generator: any
|
||||
build_runner: any
|
||||
```
|
||||
|
||||
2. Импортируйте сгенерированные файлы (`app_module.module.cherrypick.g.dart`, `your_class.inject.cherrypick.g.dart`).
|
||||
|
||||
3. Регистрируйте модули так:
|
||||
|
||||
```dart
|
||||
final scope = openRootScope()
|
||||
..installModules([$AppModule()]);
|
||||
```
|
||||
|
||||
4. Для классов с автоподстановкой полей (field injection): используйте mixin и вызовите injector:
|
||||
|
||||
```dart
|
||||
final widget = MyWidget();
|
||||
widget.injectFields(); // или эквивалентный метод из mixin
|
||||
```
|
||||
|
||||
5. Все зависимости готовы к использованию!
|
||||
|
||||
---
|
||||
|
||||
## 5. Расширенные возможности
|
||||
|
||||
- **Именованные и scope-зависимости:** используйте `@named`, `@scope` в полях/методах/resolve.
|
||||
- **Async:** Провайдеры и поля могут быть Future<T> (resolveAsync).
|
||||
- **Параметры рантайм:** через `@params` прямо к провайдеру: `resolve<T>(params: ...)`.
|
||||
- **Комбинированная стратегия:** можно смешивать field injection и модульные провайдеры в одном проекте.
|
||||
|
||||
---
|
||||
|
||||
## 6. Советы и FAQ
|
||||
|
||||
- Проверьте аннотации, пути import и запускайте build_runner после каждого изменения DI/кода.
|
||||
- Ошибки применения аннотаций появляются на этапе генерации.
|
||||
- Никогда не редактируйте .g.dart файлы вручную.
|
||||
|
||||
---
|
||||
|
||||
## 7. Полезные ссылки
|
||||
|
||||
- [README по генератору](../cherrypick_generator/README.md)
|
||||
- Пример интеграции: `examples/postly`
|
||||
- [API Reference](../cherrypick/doc/api/)
|
||||
|
||||
---
|
||||
446
doc/full_tutorial_en.md
Normal file
446
doc/full_tutorial_en.md
Normal file
@@ -0,0 +1,446 @@
|
||||
# Full Guide to CherryPick DI for Dart and Flutter: Dependency Injection with Annotations and Automatic Code Generation
|
||||
|
||||
**CherryPick** is a powerful tool for dependency injection in Dart and Flutter projects. It offers a modern approach with code generation, async providers, named and parameterized bindings, and field injection using annotations.
|
||||
|
||||
> Tools:
|
||||
> - [`cherrypick`](https://pub.dev/packages/cherrypick) — runtime DI core
|
||||
> - [`cherrypick_annotations`](https://pub.dev/packages/cherrypick_annotations) — DI annotations
|
||||
> - [`cherrypick_generator`](https://pub.dev/packages/cherrypick_generator) — DI code generation
|
||||
>
|
||||
|
||||
---
|
||||
|
||||
## CherryPick advantages vs other DI frameworks
|
||||
|
||||
- 📦 Simple declarative API for registering and resolving dependencies
|
||||
- ⚡️ Full support for both sync and async registrations
|
||||
- 🧩 DI via annotations with codegen, including advanced field injection
|
||||
- 🏷️ Named bindings for multiple interface implementations
|
||||
- 🏭 Parameterized bindings for runtime factories (e.g., by ID)
|
||||
- 🌲 Flexible scope system for dependency isolation and hierarchy
|
||||
- 🕹️ Optional resolution (`tryResolve`)
|
||||
- 🐞 Clear compile-time errors for invalid annotation or DI configuration
|
||||
|
||||
---
|
||||
|
||||
## How CherryPick works: core concepts
|
||||
|
||||
### Dependency registration (bindings)
|
||||
|
||||
```dart
|
||||
bind<MyService>().toProvide(() => MyServiceImpl());
|
||||
bind<MyRepository>().toProvideAsync(() async => await initRepo());
|
||||
bind<UserService>().toProvideWithParams((id) => UserService(id));
|
||||
|
||||
// Singleton
|
||||
bind<MyApi>().toProvide(() => MyApi()).singleton();
|
||||
|
||||
// Register an already created object
|
||||
final config = AppConfig.dev();
|
||||
bind<AppConfig>().toInstance(config);
|
||||
|
||||
// Register an already running Future/async value
|
||||
final setupFuture = loadEnvironment();
|
||||
bind<Environment>().toInstanceAsync(setupFuture);
|
||||
```
|
||||
|
||||
- **toProvide** — regular sync factory
|
||||
- **toProvideAsync** — async factory (if you need to await a Future)
|
||||
- **toProvideWithParams / toProvideAsyncWithParams** — factories with runtime parameters
|
||||
- **toInstance** — registers an already created object as a dependency
|
||||
- **toInstanceAsync** — registers an already started Future as an async dependency
|
||||
|
||||
### Named bindings
|
||||
|
||||
You can register several implementations of an interface under different names:
|
||||
|
||||
```dart
|
||||
bind<ApiClient>().toProvide(() => ApiClientProd()).withName('prod');
|
||||
bind<ApiClient>().toProvide(() => ApiClientMock()).withName('mock');
|
||||
|
||||
// Resolving by name:
|
||||
final api = scope.resolve<ApiClient>(named: 'mock');
|
||||
```
|
||||
|
||||
### Lifecycle: singleton
|
||||
|
||||
- `.singleton()` — single instance per Scope lifetime
|
||||
- By default, every resolve creates a new object
|
||||
|
||||
### Parameterized bindings
|
||||
|
||||
Allows you to create dependencies with runtime parameters, e.g., a service for a user with a given ID:
|
||||
|
||||
```dart
|
||||
bind<UserService>().toProvideWithParams((userId) => UserService(userId));
|
||||
|
||||
// Resolve:
|
||||
final userService = scope.resolveWithParams<UserService>(params: '123');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Scope management: dependency hierarchy
|
||||
|
||||
For most business cases, a single root scope is enough, but CherryPick supports nested scopes:
|
||||
|
||||
```dart
|
||||
final rootScope = CherryPick.openRootScope();
|
||||
final profileScope = rootScope.openSubScope('profile')
|
||||
..installModules([ProfileModule()]);
|
||||
```
|
||||
|
||||
- **Subscope** can override parent dependencies.
|
||||
- When resolving, first checks its own scope, then up the hierarchy.
|
||||
|
||||
|
||||
## Managing names and scope hierarchy (subscopes) in CherryPick
|
||||
|
||||
CherryPick supports nested scopes, each can be "root" or a child. For accessing/managing the hierarchy, CherryPick uses scope names (strings) as well as convenient open/close methods.
|
||||
|
||||
### Open subScope by name
|
||||
|
||||
CherryPick uses separator-delimited strings to search and build scope trees, for example:
|
||||
|
||||
```dart
|
||||
final subScope = CherryPick.openScope(scopeName: 'profile.settings');
|
||||
```
|
||||
|
||||
- Here, `'profile.settings'` will open 'profile' subscope in root, then 'settings' subscope in 'profile'.
|
||||
- Default separator is a dot (`.`), can be changed via `separator` argument.
|
||||
|
||||
**Example with another separator:**
|
||||
|
||||
```dart
|
||||
final subScope = CherryPick.openScope(
|
||||
scopeName: 'project>>dev>>api',
|
||||
separator: '>>',
|
||||
);
|
||||
```
|
||||
|
||||
### Hierarchy & access
|
||||
|
||||
Each hierarchy level is a separate scope.
|
||||
This is convenient for restricting/localizing dependencies, for example:
|
||||
- `main.profile` — dependencies only for user profile
|
||||
- `main.profile.details` — even narrower context
|
||||
|
||||
### Closing subscopes
|
||||
|
||||
To close a specific subScope, use the same path:
|
||||
|
||||
```dart
|
||||
CherryPick.closeScope(scopeName: 'profile.settings');
|
||||
```
|
||||
|
||||
- Closing a top-level scope (`profile`) wipes all children too.
|
||||
|
||||
### Methods summary
|
||||
|
||||
| Method | Description |
|
||||
|---------------------------|--------------------------------------------------------|
|
||||
| `openRootScope()` | Open/get root scope |
|
||||
| `closeRootScope()` | Close root scope, remove all dependencies |
|
||||
| `openScope(scopeName)` | Open scope(s) by name & hierarchy (`'a.b.c'`) |
|
||||
| `closeScope(scopeName)` | Close specified scope or subScope |
|
||||
|
||||
---
|
||||
|
||||
**Recommendations:**
|
||||
Use meaningful names and dot notation for scope structuring in large apps—this improves readability and dependency management on any level.
|
||||
|
||||
---
|
||||
|
||||
**Example:**
|
||||
|
||||
```dart
|
||||
// Opens scopes by hierarchy: app -> module -> page
|
||||
final scope = CherryPick.openScope(scopeName: 'app.module.page');
|
||||
|
||||
// Closes 'module' and all nested subscopes
|
||||
CherryPick.closeScope(scopeName: 'app.module');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
This lets you scale CherryPick DI for any app complexity!
|
||||
|
||||
---
|
||||
|
||||
## Safe dependency resolution
|
||||
|
||||
If not sure a dependency exists, use tryResolve/tryResolveAsync:
|
||||
|
||||
```dart
|
||||
final service = scope.tryResolve<OptionalService>(); // returns null if not exists
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Dependency injection with annotations & code generation
|
||||
|
||||
CherryPick supports DI with annotations, letting you eliminate manual DI setup.
|
||||
|
||||
### Annotation structure
|
||||
|
||||
| Annotation | Purpose | Where to use |
|
||||
|---------------|---------------------------|------------------------------------|
|
||||
| `@module` | DI module | Classes |
|
||||
| `@singleton` | Singleton | Module methods |
|
||||
| `@instance` | New object | Module methods |
|
||||
| `@provide` | Provider | Methods (with DI params) |
|
||||
| `@named` | Named binding | Method argument/Class fields |
|
||||
| `@params` | Parameter passing | Provider argument |
|
||||
| `@injectable` | Field injection support | Classes |
|
||||
| `@inject` | Auto-injection | Class fields |
|
||||
| `@scope` | Scope/realm | Class fields |
|
||||
|
||||
### Example DI module
|
||||
|
||||
```dart
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
@module()
|
||||
abstract class AppModule extends Module {
|
||||
@singleton()
|
||||
@provide()
|
||||
ApiClient apiClient() => ApiClient();
|
||||
|
||||
@provide()
|
||||
UserService userService(ApiClient api) => UserService(api);
|
||||
|
||||
@singleton()
|
||||
@provide()
|
||||
@named('mock')
|
||||
ApiClient mockApiClient() => ApiClientMock();
|
||||
}
|
||||
```
|
||||
- Methods annotated with `@provide` become DI factories.
|
||||
- Add other annotations to specify binding type or name.
|
||||
|
||||
Generated code will look like:
|
||||
|
||||
```dart
|
||||
class $AppModule extends AppModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<ApiClient>().toProvide(() => apiClient()).singleton();
|
||||
bind<UserService>().toProvide(() => userService(currentScope.resolve<ApiClient>()));
|
||||
bind<ApiClient>().toProvide(() => mockApiClient()).withName('mock').singleton();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Example: field injection
|
||||
|
||||
```dart
|
||||
@injectable()
|
||||
class ProfileBloc with _$ProfileBloc {
|
||||
@inject()
|
||||
late final AuthService auth;
|
||||
|
||||
@inject()
|
||||
@named('admin')
|
||||
late final UserService adminUser;
|
||||
|
||||
ProfileBloc() {
|
||||
_inject(this); // injectFields — generated method
|
||||
}
|
||||
}
|
||||
```
|
||||
- Generator creates a mixin (`_$ProfileBloc`) which automatically resolves and injects dependencies into fields.
|
||||
- The `@named` annotation links a field to a named implementation.
|
||||
|
||||
Example generated code:
|
||||
|
||||
```dart
|
||||
mixin $ProfileBloc {
|
||||
@override
|
||||
void _inject(ProfileBloc instance) {
|
||||
instance.auth = CherryPick.openRootScope().resolve<AuthService>();
|
||||
instance.adminUser = CherryPick.openRootScope().resolve<UserService>(named: 'admin');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### How to connect it
|
||||
|
||||
```dart
|
||||
void main() async {
|
||||
final scope = CherryPick.openRootScope();
|
||||
scope.installModules([
|
||||
$AppModule(),
|
||||
]);
|
||||
// DI via field injection
|
||||
final bloc = ProfileBloc();
|
||||
runApp(MyApp(bloc: bloc));
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Async dependencies
|
||||
|
||||
For async providers, use `toProvideAsync`, and resolve them with `resolveAsync`:
|
||||
|
||||
```dart
|
||||
bind<RemoteConfig>().toProvideAsync(() async => await RemoteConfig.load());
|
||||
|
||||
// Usage:
|
||||
final config = await scope.resolveAsync<RemoteConfig>();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Validation and diagnostics
|
||||
|
||||
- If you use incorrect annotations or DI config, you'll get clear compile-time errors.
|
||||
- Binding errors are found during code generation, minimizing runtime issues and speeding up development.
|
||||
|
||||
---
|
||||
|
||||
## Flutter integration: cherrypick_flutter
|
||||
|
||||
### What it is
|
||||
|
||||
[`cherrypick_flutter`](https://pub.dev/packages/cherrypick_flutter) is the integration package for CherryPick DI in Flutter. It provides a convenient `CherryPickProvider` widget which sits in your widget tree and gives access to the root DI scope (and subscopes) from context.
|
||||
|
||||
### Features
|
||||
|
||||
- **Global DI Scope Access:**
|
||||
Use `CherryPickProvider` to access rootScope and subscopes anywhere in the widget tree.
|
||||
- **Context integration:**
|
||||
Use `CherryPickProvider.of(context)` for DI access inside your widgets.
|
||||
|
||||
### Usage Example
|
||||
|
||||
```dart
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:cherrypick_flutter/cherrypick_flutter.dart';
|
||||
|
||||
void main() {
|
||||
runApp(
|
||||
CherryPickProvider(
|
||||
child: MyApp(),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
class MyApp extends StatelessWidget {
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
final rootScope = CherryPickProvider.of(context).openRootScope();
|
||||
|
||||
return MaterialApp(
|
||||
home: Scaffold(
|
||||
body: Center(
|
||||
child: Text(
|
||||
rootScope.resolve<AppService>().getStatus(),
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- Here, `CherryPickProvider` wraps the app and gives DI scope access via context.
|
||||
- You can create subscopes, e.g. for screens or modules:
|
||||
`final subScope = CherryPickProvider.of(context).openSubScope(scopeName: "profileFeature");`
|
||||
|
||||
---
|
||||
## CherryPick is not just for Flutter!
|
||||
|
||||
You can use CherryPick in Dart CLI, server apps, and microservices. All major features work without Flutter.
|
||||
|
||||
---
|
||||
|
||||
## CherryPick Example Project: Step by Step
|
||||
|
||||
1. Add dependencies:
|
||||
```yaml
|
||||
dependencies:
|
||||
cherrypick: ^1.0.0
|
||||
cherrypick_annotations: ^1.0.0
|
||||
|
||||
dev_dependencies:
|
||||
build_runner: ^2.0.0
|
||||
cherrypick_generator: ^1.0.0
|
||||
```
|
||||
|
||||
2. Describe your modules using annotations.
|
||||
|
||||
3. To generate DI code:
|
||||
```shell
|
||||
dart run build_runner build --delete-conflicting-outputs
|
||||
```
|
||||
|
||||
4. Enjoy modern DI with no boilerplate!
|
||||
|
||||
---
|
||||
|
||||
### Advanced: Customizing Generated Code Location
|
||||
|
||||
CherryPick's code generator now supports flexible output configuration via `build.yaml`.
|
||||
|
||||
You can control both the output directory (using `output_dir`) and filename templates (using `build_extensions`):
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|inject_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/app.dart': ['lib/generated/app.inject.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
cherrypick_generator|module_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/di/{{}}.dart': ['lib/generated/di/{{}}.module.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
```
|
||||
|
||||
- **output_dir**: Folder where all generated files will be placed.
|
||||
- **build_extensions**: Allows full customization of generated file names and subfolders.
|
||||
|
||||
If you use these, be sure to update your imports accordingly, e.g.:
|
||||
```dart
|
||||
import 'package:your_project/generated/app.inject.cherrypick.g.dart';
|
||||
```
|
||||
If not specified, generated files will appear next to your source files, as before.
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## Conclusion
|
||||
|
||||
**CherryPick** is a modern DI solution for Dart and Flutter, combining a concise API and advanced annotation/codegen features. Scopes, parameterized providers, named bindings, and field-injection make it great for both small and large-scale projects.
|
||||
|
||||
**Full annotation list and their purposes:**
|
||||
|
||||
| Annotation | Purpose | Where to use |
|
||||
|---------------|---------------------------|------------------------------------|
|
||||
| `@module` | DI module | Classes |
|
||||
| `@singleton` | Singleton | Module methods |
|
||||
| `@instance` | New object | Module methods |
|
||||
| `@provide` | Provider | Methods (with DI params) |
|
||||
| `@named` | Named binding | Method argument/Class fields |
|
||||
| `@params` | Parameter passing | Provider argument |
|
||||
| `@injectable` | Field injection support | Classes |
|
||||
| `@inject` | Auto-injection | Class fields |
|
||||
| `@scope` | Scope/realm | Class fields |
|
||||
|
||||
---
|
||||
|
||||
## Useful Links
|
||||
|
||||
- [cherrypick](https://pub.dev/packages/cherrypick)
|
||||
- [cherrypick_annotations](https://pub.dev/packages/cherrypick_annotations)
|
||||
- [cherrypick_generator](https://pub.dev/packages/cherrypick_generator)
|
||||
- [Sources on GitHub](https://github.com/pese-git/cherrypick)
|
||||
450
doc/full_tutorial_ru.md
Normal file
450
doc/full_tutorial_ru.md
Normal file
@@ -0,0 +1,450 @@
|
||||
# Полный гайд по CherryPick DI для Dart и Flutter: внедрение зависимостей с аннотациями и автоматической генерацией кода
|
||||
|
||||
**CherryPick** — это мощный инструмент для инъекции зависимостей в проектах на Dart и Flutter. Он предлагает современный подход с поддержкой генерации кода, асинхронных провайдеров, именованных и параметризируемых биндингов, а также field injection с использованием аннотаций.
|
||||
|
||||
> Инструменты:
|
||||
> - [`cherrypick`](https://pub.dev/packages/cherrypick) — runtime DI core
|
||||
> - [`cherrypick_annotations`](https://pub.dev/packages/cherrypick_annotations) — аннотации для DI
|
||||
> - [`cherrypick_generator`](https://pub.dev/packages/cherrypick_generator) — генерация DI-кода
|
||||
>
|
||||
|
||||
---
|
||||
|
||||
## Преимущества CherryPick по сравнению с другими DI-фреймворками
|
||||
|
||||
- 📦 Простой декларативный API для регистрации и разрешения зависимостей.
|
||||
- ⚡️ Полная поддержка синхронных _и_ асинхронных регистраций.
|
||||
- 🧩 DI через аннотации с автогенерацией кода, включая field injection.
|
||||
- 🏷️ Именованные зависимости (named bindings).
|
||||
- 🏭 Параметризация биндингов для runtime-использования фабрик.
|
||||
- 🌲 Гибкая система Scope'ов для изоляции и иерархии зависимостей.
|
||||
- 🕹️ Опциональное разрешение (tryResolve).
|
||||
- 🐞 Ясные compile-time ошибки при неправильной аннотации или неверном DI-описании.
|
||||
|
||||
---
|
||||
|
||||
## Как работает CherryPick: основные концепции
|
||||
|
||||
### Регистрация зависимостей: биндинги
|
||||
|
||||
```dart
|
||||
bind<MyService>().toProvide(() => MyServiceImpl());
|
||||
bind<MyRepository>().toProvideAsync(() async => await initRepo());
|
||||
bind<UserService>().toProvideWithParams((id) => UserService(id));
|
||||
|
||||
// Singleton
|
||||
bind<MyApi>().toProvide(() => MyApi()).singleton();
|
||||
|
||||
// Зарегистрировать уже существующий объект
|
||||
final config = AppConfig.dev();
|
||||
bind<AppConfig>().toInstance(config);
|
||||
|
||||
// Зарегистрировать уже существующий Future/асинхронное значение
|
||||
final setupFuture = loadEnvironment();
|
||||
bind<Environment>().toInstanceAsync(setupFuture);
|
||||
```
|
||||
|
||||
|
||||
- **toProvide** — обычная синхронная фабрика.
|
||||
- **toProvideAsync** — асинхронная фабрика (например, если нужно дожидаться Future).
|
||||
- **toProvideWithParams / toProvideAsyncWithParams** — фабрики с параметрами.
|
||||
- **toInstance** — регистрирует уже созданный экземпляр класса как зависимость.
|
||||
- **toInstanceAsync** — регистрирует уже запущенный Future, как асинхронную зависимость.
|
||||
|
||||
### Именованные биндинги (Named)
|
||||
|
||||
Можно регистрировать несколько реализаций одного интерфейса под разными именами:
|
||||
|
||||
```dart
|
||||
bind<ApiClient>().toProvide(() => ApiClientProd()).withName('prod');
|
||||
bind<ApiClient>().toProvide(() => ApiClientMock()).withName('mock');
|
||||
|
||||
// Получение по имени:
|
||||
final api = scope.resolve<ApiClient>(named: 'mock');
|
||||
```
|
||||
|
||||
### Жизненный цикл: singleton
|
||||
|
||||
- `.singleton()` — один инстанс на всё время жизни Scope.
|
||||
- По умолчанию каждый resolve создаёт новый объект.
|
||||
|
||||
### Параметрические биндинги
|
||||
|
||||
Позволяют создавать зависимости с runtime-параметрами — например, сервис для пользователя с ID:
|
||||
|
||||
```dart
|
||||
bind<UserService>().toProvideWithParams((userId) => UserService(userId));
|
||||
|
||||
// Получение
|
||||
final userService = scope.resolveWithParams<UserService>(params: '123');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Управление Scope'ами: иерархия зависимостей
|
||||
|
||||
Для большинства бизнес-кейсов достаточно одного Scope (root), но CherryPick поддерживает создание вложенных Scope:
|
||||
|
||||
```dart
|
||||
final rootScope = CherryPick.openRootScope();
|
||||
final profileScope = rootScope.openSubScope('profile')
|
||||
..installModules([ProfileModule()]);
|
||||
```
|
||||
|
||||
- **Под-скоуп** может переопределять зависимости родителя.
|
||||
- При разрешении сначала проверяется свой Scope, потом иерархия вверх.
|
||||
|
||||
|
||||
## Работа с именованием и иерархией подскоупов (subscopes) в CherryPick
|
||||
|
||||
CherryPick поддерживает вложенные области видимости (scopes), где каждый scope может быть как "корневым", так и дочерним. Для доступа и управления иерархией используется понятие **scope name** (имя области видимости), а также удобные методы для открытия и закрытия скопов по строковым идентификаторам.
|
||||
|
||||
### Открытие subScope по имени
|
||||
|
||||
CherryPick использует строки с разделителями для поиска и построения дерева областей видимости. Например:
|
||||
|
||||
```dart
|
||||
final subScope = CherryPick.openScope(scopeName: 'profile.settings');
|
||||
```
|
||||
|
||||
- Здесь `'profile.settings'` означает, что сначала откроется подскоуп `profile` у rootScope, затем — подскоуп `settings` у `profile`.
|
||||
- Разделитель по умолчанию — точка (`.`). Его можно изменить, указав `separator` аргументом.
|
||||
|
||||
**Пример с другим разделителем:**
|
||||
|
||||
```dart
|
||||
final subScope = CherryPick.openScope(
|
||||
scopeName: 'project>>dev>>api',
|
||||
separator: '>>',
|
||||
);
|
||||
```
|
||||
|
||||
### Иерархия и доступ
|
||||
|
||||
Каждый уровень иерархии соответствует отдельному scope.
|
||||
Это удобно для ограничения и локализации зависимостей, например:
|
||||
- `main.profile` — зависимости только для профиля пользователя
|
||||
- `main.profile.details` — ещё более "узкая" область видимости
|
||||
|
||||
### Закрытие подскоупов
|
||||
|
||||
Чтобы закрыть конкретный subScope, используйте тот же путь:
|
||||
|
||||
```dart
|
||||
CherryPick.closeScope(scopeName: 'profile.settings');
|
||||
```
|
||||
|
||||
- Если закрываете верхний скоуп (`profile`), все дочерние тоже будут очищены.
|
||||
|
||||
### Кратко о методах
|
||||
|
||||
| Метод | Описание |
|
||||
|--------------------------|--------------------------------------------------------|
|
||||
| `openRootScope()` | Открыть/получить корневой scope |
|
||||
| `closeRootScope()` | Закрыть root scope, удалить все зависимости |
|
||||
| `openScope(scopeName)` | Открыть scope(ы) по имени с иерархией (`'a.b.c'`) |
|
||||
| `closeScope(scopeName)` | Закрыть указанный scope или subscope |
|
||||
|
||||
---
|
||||
|
||||
**Рекомендации:**
|
||||
Используйте осмысленные имена и "точечную" нотацию для структурирования зон видимости в крупных приложениях — это повысит читаемость и позволит удобно управлять зависимостями на любых уровнях.
|
||||
|
||||
---
|
||||
|
||||
**Пример:**
|
||||
|
||||
```dart
|
||||
// Откроет scopes по иерархии: app -> module -> page
|
||||
final scope = CherryPick.openScope(scopeName: 'app.module.page');
|
||||
|
||||
// Закроет 'module' и все вложенные subscopes
|
||||
CherryPick.closeScope(scopeName: 'app.module');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Это позволит масштабировать DI-подход CherryPick в приложениях любой сложности!
|
||||
|
||||
---
|
||||
|
||||
## Безопасное разрешение зависимостей
|
||||
|
||||
Если не уверены, что нужная зависимость есть, используйте tryResolve/tryResolveAsync:
|
||||
|
||||
```dart
|
||||
final service = scope.tryResolve<OptionalService>(); // вернет null, если нет
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Внедрение зависимостей через аннотации и автогенерацию
|
||||
|
||||
CherryPick поддерживает DI через аннотации, что позволяет полностью избавиться от ручного внедрения зависимостей.
|
||||
|
||||
### Структура аннотаций
|
||||
|
||||
| Аннотация | Для чего | Где применяют |
|
||||
| ------------- | ------------------------- | -------------------------------- |
|
||||
| `@module` | DI-модуль | Классы |
|
||||
| `@singleton` | Singleton | Методы класса |
|
||||
| `@instance` | Новый объект | Методы класса |
|
||||
| `@provide` | Провайдер | Методы (с DI params) |
|
||||
| `@named` | Именованный биндинг | Аргумент метода/Аттрибуты класса |
|
||||
| `@params` | Передача параметров | Аргумент провайдера |
|
||||
| `@injectable` | Поддержка field injection | Классы |
|
||||
| `@inject` | Автовнедрение | Аттрибуты класса |
|
||||
| `@scope` | Scope/realm | Аттрибуты класса |
|
||||
|
||||
### Пример DI-модуля
|
||||
|
||||
```dart
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
|
||||
@module()
|
||||
abstract class AppModule extends Module {
|
||||
@singleton()
|
||||
@provide()
|
||||
ApiClient apiClient() => ApiClient();
|
||||
|
||||
@provide()
|
||||
UserService userService(ApiClient api) => UserService(api);
|
||||
|
||||
@singleton()
|
||||
@provide()
|
||||
@named('mock')
|
||||
ApiClient mockApiClient() => ApiClientMock();
|
||||
}
|
||||
```
|
||||
- Методы, отмеченные `@provide`, становятся фабриками DI.
|
||||
- Можно добавлять другие аннотации для уточнения типа биндинга, имени.
|
||||
|
||||
Сгенерированный код будет выглядеть вот таким образом:
|
||||
|
||||
```dart
|
||||
class $AppModule extends AppModule {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<ApiClient>().toProvide(() => apiClient()).singelton();
|
||||
bind<UserService>().toProvide(() => userService(currentScope.resolve<ApiClient>()));
|
||||
bind<ApiClient>().toProvide(() => mockApiClient()).withName('mock').singelton();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
### Пример инъекций зависимостей через field injection
|
||||
|
||||
```dart
|
||||
@injectable()
|
||||
class ProfileBloc with _$ProfileBloc {
|
||||
@inject()
|
||||
late final AuthService auth;
|
||||
|
||||
@inject()
|
||||
@named('admin')
|
||||
late final UserService adminUser;
|
||||
|
||||
ProfileBloc() {
|
||||
_inject(this); // injectFields — сгенерированный метод
|
||||
}
|
||||
}
|
||||
```
|
||||
- Генератор создаёт mixin (`_$ProfileBloc`), который автоматически резолвит и подставляет зависимости в поля класса.
|
||||
- Аннотация `@named` привязывает конкретную реализацию по имени.
|
||||
|
||||
Сгенерированный код будет выглядеть вот таким образом:
|
||||
|
||||
```dart
|
||||
mixin $ProfileBloc {
|
||||
@override
|
||||
void _inject(ProfileBloc instance) {
|
||||
instance.auth = CherryPick.openRootScope().resolve<AuthService>();
|
||||
instance.adminUser = CherryPick.openRootScope().resolve<UserService>(named: 'admin');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
### Как это подключается
|
||||
|
||||
```dart
|
||||
void main() async {
|
||||
final scope = CherryPick.openRootScope();
|
||||
scope.installModules([
|
||||
$AppModule(),
|
||||
]);
|
||||
// DI через field injection
|
||||
final bloc = ProfileBloc();
|
||||
runApp(MyApp(bloc: bloc));
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Асинхронные зависимости
|
||||
|
||||
Для асинхронных провайдеров используйте `toProvideAsync`, а получать их — через `resolveAsync`:
|
||||
|
||||
```dart
|
||||
bind<RemoteConfig>().toProvideAsync(() async => await RemoteConfig.load());
|
||||
|
||||
// Использование:
|
||||
final config = await scope.resolveAsync<RemoteConfig>();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Проверка и диагностика
|
||||
|
||||
- При неправильных аннотациях или ошибках DI появляется понятное compile-time сообщение.
|
||||
- Ошибки биндингов выявляются при генерации кода. Это минимизирует runtime-ошибки и ускоряет разработку.
|
||||
|
||||
---
|
||||
|
||||
## Использование CherryPick с Flutter: пакет cherrypick_flutter
|
||||
|
||||
### Что это такое
|
||||
|
||||
[`cherrypick_flutter`](https://pub.dev/packages/cherrypick_flutter) — это пакет интеграции CherryPick DI с Flutter. Он предоставляет удобный виджет-провайдер `CherryPickProvider`, который размещается в вашем дереве виджетов и даёт доступ к root scope DI (и подскоупам) прямо из контекста.
|
||||
|
||||
### Ключевые возможности
|
||||
|
||||
- **Глобальный доступ к DI Scope:**
|
||||
Через `CherryPickProvider` вы легко получаете доступ к rootScope и подскоупам из любого места дерева Flutter.
|
||||
- **Интеграция с контекстом:**
|
||||
Используйте `CherryPickProvider.of(context)` для доступа к DI внутри ваших виджетов.
|
||||
|
||||
### Пример использования
|
||||
|
||||
```dart
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:cherrypick_flutter/cherrypick_flutter.dart';
|
||||
|
||||
void main() {
|
||||
runApp(
|
||||
CherryPickProvider(
|
||||
child: MyApp(),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
class MyApp extends StatelessWidget {
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
final rootScope = CherryPickProvider.of(context).openRootScope();
|
||||
|
||||
return MaterialApp(
|
||||
home: Scaffold(
|
||||
body: Center(
|
||||
child: Text(
|
||||
rootScope.resolve<AppService>().getStatus(),
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- В этом примере `CherryPickProvider` оборачивает приложение и предоставляет доступ к DI scope через контекст.
|
||||
- Вы можете создавать подскоупы, если нужно, например, для экранов или модулей:
|
||||
`final subScope = CherryPickProvider.of(context).openSubScope(scopeName: "profileFeature");`
|
||||
|
||||
---
|
||||
## CherryPick подходит не только для Flutter!
|
||||
|
||||
Вы можете использовать CherryPick и в Dart CLI, серверных проектах и микросервисах. Все основные возможности доступны и без Flutter.
|
||||
|
||||
---
|
||||
|
||||
## Пример проекта на CherryPick: полный путь
|
||||
|
||||
1. Установите зависимости:
|
||||
```yaml
|
||||
dependencies:
|
||||
cherrypick: ^1.0.0
|
||||
cherrypick_annotations: ^1.0.0
|
||||
|
||||
dev_dependencies:
|
||||
build_runner: ^2.0.0
|
||||
cherrypick_generator: ^1.0.0
|
||||
```
|
||||
|
||||
2. Описываете свои модули с помощью аннотаций.
|
||||
|
||||
3. Для автоматической генерации DI кода используйте:
|
||||
```shell
|
||||
dart run build_runner build --delete-conflicting-outputs
|
||||
```
|
||||
|
||||
4. Наслаждайтесь современным DI без боли!
|
||||
|
||||
---
|
||||
|
||||
### Продвинутая настройка путей генерации кода
|
||||
|
||||
В последних версиях генератора CherryPick добавлена поддержка гибкой настройки директорий и шаблонов имён файлов через `build.yaml`.
|
||||
|
||||
Вы можете управлять и папкой назначения (через `output_dir`), и шаблоном имён (через `build_extensions`):
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|inject_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/app.dart': ['lib/generated/app.inject.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
cherrypick_generator|module_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/di/{{}}.dart': ['lib/generated/di/{{}}.module.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
```
|
||||
|
||||
- **output_dir**: Папка, куда будут складываться все сгенерированные файлы.
|
||||
- **build_extensions**: Полный контроль над именами итоговых файлов и подпапками.
|
||||
|
||||
Если вы это используете, обязательно обновляйте импорты, например:
|
||||
```dart
|
||||
import 'package:your_project/generated/app.inject.cherrypick.g.dart';
|
||||
```
|
||||
Если не задать параметры, файлы будут сгенерированы рядом с исходными — как и раньше.
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## Заключение
|
||||
|
||||
**CherryPick** — это современное DI-решение для Dart и Flutter, сочетающее лаконичный API и расширенные возможности аннотирования и генерации кода. Гибкость Scopes, параметрические провайдеры, именованные биндинги и field-injection делают его особенно мощным как для небольших, так и для масштабных проектов.
|
||||
|
||||
|
||||
**Полный список аннотаций и их предназначение:**
|
||||
|
||||
| Аннотация | Для чего | Где применяют |
|
||||
| ------------- | ------------------------- | -------------------------------- |
|
||||
| `@module` | DI-модуль | Классы |
|
||||
| `@singleton` | Singleton | Методы класса |
|
||||
| `@instance` | Новый объект | Методы класса |
|
||||
| `@provide` | Провайдер | Методы (с DI params) |
|
||||
| `@named` | Именованный биндинг | Аргумент метода/Аттрибуты класса |
|
||||
| `@params` | Передача параметров | Аргумент провайдера |
|
||||
| `@injectable` | Поддержка field injection | Классы |
|
||||
| `@inject` | Автовнедрение | Аттрибуты класса |
|
||||
| `@scope` | Scope/realm | Аттрибуты класса |
|
||||
|
||||
---
|
||||
|
||||
## Полезные ссылки
|
||||
|
||||
- [cherrypick](https://pub.dev/packages/cherrypick)
|
||||
- [cherrypick_annotations](https://pub.dev/packages/cherrypick_annotations)
|
||||
- [cherrypick_generator](https://pub.dev/packages/cherrypick_generator)
|
||||
- [Исходники на GitHub](https://github.com/pese-git/cherrypick)
|
||||
@@ -19,7 +19,29 @@ There are two main methods for initializing a custom instance `toInstance ()` an
|
||||
|
||||
Example:
|
||||
|
||||
```dart
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Advanced: Customizing Code Generation Output
|
||||
|
||||
You can configure where generated files will be placed by updating your `build.yaml` (supports `output_dir` and `build_extensions`):
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|inject_generator:
|
||||
options:
|
||||
output_dir: lib/generated
|
||||
cherrypick_generator|module_generator:
|
||||
options:
|
||||
output_dir: lib/generated
|
||||
```
|
||||
|
||||
For full control and more examples, see the "Full Tutorial" or documentation on `build_extensions`.
|
||||
|
||||
---
|
||||
// initializing a text string instance through a method toInstance()
|
||||
Binding<String>().toInstance("hello world");
|
||||
|
||||
@@ -19,7 +19,29 @@ Binding - по сути это конфигуратор для пользов
|
||||
|
||||
Пример:
|
||||
|
||||
```dart
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Продвинутая настройка генерации кода
|
||||
|
||||
В файле `build.yaml` можно задать папку для сгенерированных файлов через параметр `output_dir` (а также использовать шаблон `build_extensions`):
|
||||
|
||||
```yaml
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|inject_generator:
|
||||
options:
|
||||
output_dir: lib/generated
|
||||
cherrypick_generator|module_generator:
|
||||
options:
|
||||
output_dir: lib/generated
|
||||
```
|
||||
|
||||
Для полной настройки и шаблонов см. раздел “Полный гайд” или документацию по `build_extensions`.
|
||||
|
||||
---
|
||||
// инициализация экземпляра текстовой строки через метод toInstance()
|
||||
Binding<String>().toInstance("hello world");
|
||||
|
||||
@@ -5,23 +5,18 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: _fe_analyzer_shared
|
||||
sha256: f256b0c0ba6c7577c15e2e4e114755640a875e885099367bf6e012b19314c834
|
||||
sha256: e55636ed79578b9abca5fecf9437947798f5ef7456308b5cb85720b793eac92f
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "72.0.0"
|
||||
_macros:
|
||||
dependency: transitive
|
||||
description: dart
|
||||
source: sdk
|
||||
version: "0.3.2"
|
||||
version: "82.0.0"
|
||||
analyzer:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: analyzer
|
||||
sha256: b652861553cd3990d8ed361f7979dc6d7053a9ac8843fa73820ab68ce5410139
|
||||
sha256: "904ae5bb474d32c38fb9482e2d925d5454cda04ddd0e55d2e6826bc72f6ba8c0"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "6.7.0"
|
||||
version: "7.4.5"
|
||||
args:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -34,26 +29,26 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: async
|
||||
sha256: "947bfcf187f74dbc5e146c9eb9c0f10c9f8b30743e341481c1e2ed3ecc18c20c"
|
||||
sha256: d2872f9c19731c2e5f10444b14686eb7cc85c76274bd6c16e1816bff9a3bab63
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.11.0"
|
||||
version: "2.12.0"
|
||||
boolean_selector:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: boolean_selector
|
||||
sha256: "6cfb5af12253eaf2b368f07bacc5a80d1301a071c73360d746b7f2e32d762c66"
|
||||
sha256: "8aab1771e1243a5063b8b0ff68042d67334e3feab9e95b9490f9a6ebf73b42ea"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.1.1"
|
||||
version: "2.1.2"
|
||||
build:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: build
|
||||
sha256: "80184af8b6cb3e5c1c4ec6d8544d27711700bc3e6d2efad04238c7b5290889f0"
|
||||
sha256: cef23f1eda9b57566c81e2133d196f8e3df48f244b317368d65c5943d91148f0
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.4.1"
|
||||
version: "2.4.2"
|
||||
build_config:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -74,26 +69,26 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: build_resolvers
|
||||
sha256: "339086358431fa15d7eca8b6a36e5d783728cf025e559b834f4609a1fcfb7b0a"
|
||||
sha256: b9e4fda21d846e192628e7a4f6deda6888c36b5b69ba02ff291a01fd529140f0
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.4.2"
|
||||
version: "2.4.4"
|
||||
build_runner:
|
||||
dependency: "direct dev"
|
||||
description:
|
||||
name: build_runner
|
||||
sha256: "028819cfb90051c6b5440c7e574d1896f8037e3c96cf17aaeb054c9311cfbf4d"
|
||||
sha256: "058fe9dce1de7d69c4b84fada934df3e0153dd000758c4d65964d0166779aa99"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.4.13"
|
||||
version: "2.4.15"
|
||||
build_runner_core:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: build_runner_core
|
||||
sha256: f8126682b87a7282a339b871298cc12009cb67109cfa1614d6436fb0289193e0
|
||||
sha256: "22e3aa1c80e0ada3722fe5b63fd43d9c8990759d0a2cf489c8c5d7b2bdebc021"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "7.3.2"
|
||||
version: "8.0.0"
|
||||
built_collection:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -114,10 +109,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: characters
|
||||
sha256: "04a925763edad70e8443c99234dc3328f442e811f1d8fd1a72f1c8ad0f69a605"
|
||||
sha256: f71061c654a3380576a52b451dd5532377954cf9dbd272a78fc8479606670803
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.3.0"
|
||||
version: "1.4.0"
|
||||
checked_yaml:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -139,7 +134,7 @@ packages:
|
||||
path: "../../cherrypick_annotations"
|
||||
relative: true
|
||||
source: path
|
||||
version: "1.1.0-dev.0"
|
||||
version: "1.1.0-dev.1"
|
||||
cherrypick_flutter:
|
||||
dependency: "direct main"
|
||||
description:
|
||||
@@ -153,15 +148,15 @@ packages:
|
||||
path: "../../cherrypick_generator"
|
||||
relative: true
|
||||
source: path
|
||||
version: "1.1.0-dev.1"
|
||||
version: "1.1.0-dev.5"
|
||||
clock:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: clock
|
||||
sha256: cb6d7f03e1de671e34607e909a7213e31d7752be4fb66a86d29fe1eb14bfb5cf
|
||||
sha256: fddb70d9b5277016c77a80201021d40a2247104d9f4aa7bab7157b7e3f05b84b
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.1.1"
|
||||
version: "1.1.2"
|
||||
code_builder:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -174,10 +169,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: collection
|
||||
sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a
|
||||
sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.18.0"
|
||||
version: "1.19.1"
|
||||
convert:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -206,18 +201,18 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: dart_style
|
||||
sha256: "7856d364b589d1f08986e140938578ed36ed948581fbc3bc9aef1805039ac5ab"
|
||||
sha256: "27eb0ae77836989a3bc541ce55595e8ceee0992807f14511552a898ddd0d88ac"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.3.7"
|
||||
version: "3.0.1"
|
||||
fake_async:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: fake_async
|
||||
sha256: "511392330127add0b769b75a987850d136345d9227c6b94c96a04cf4a391bf78"
|
||||
sha256: "6a95e56b2449df2273fd8c45a662d6947ce1ebb7aafe80e550a3f68297f3cacc"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.3.1"
|
||||
version: "1.3.2"
|
||||
file:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -276,6 +271,14 @@ packages:
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.3.2"
|
||||
http:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: http
|
||||
sha256: "2c11f3f94c687ee9bad77c171151672986360b2b001d109814ee7140b2cf261b"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.4.0"
|
||||
http_multi_server:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -320,18 +323,18 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: leak_tracker
|
||||
sha256: "3f87a60e8c63aecc975dda1ceedbc8f24de75f09e4856ea27daf8958f2f0ce05"
|
||||
sha256: c35baad643ba394b40aac41080300150a4f08fd0fd6a10378f8f7c6bc161acec
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "10.0.5"
|
||||
version: "10.0.8"
|
||||
leak_tracker_flutter_testing:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: leak_tracker_flutter_testing
|
||||
sha256: "932549fb305594d82d7183ecd9fa93463e9914e1b67cacc34bc40906594a1806"
|
||||
sha256: f8b613e7e6a13ec79cfdc0e97638fddb3ab848452eff057653abd3edba760573
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "3.0.5"
|
||||
version: "3.0.9"
|
||||
leak_tracker_testing:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -356,22 +359,14 @@ packages:
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.3.0"
|
||||
macros:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: macros
|
||||
sha256: "0acaed5d6b7eab89f63350bccd82119e6c602df0f391260d0e32b5e23db79536"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "0.1.2-main.4"
|
||||
matcher:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: matcher
|
||||
sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
|
||||
sha256: dc58c723c3c24bf8d3e2d3ad3f2f9d7bd9cf43ec6feaa64181775e60190153f2
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "0.12.16+1"
|
||||
version: "0.12.17"
|
||||
material_color_utilities:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -384,10 +379,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: meta
|
||||
sha256: bdb68674043280c3428e9ec998512fb681678676b3c54e773629ffe74419f8c7
|
||||
sha256: e3641ec5d63ebf0d9b41bd43201a66e3fc79a65db5f61fc181f04cd27aab950c
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.15.0"
|
||||
version: "1.16.0"
|
||||
mime:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -408,10 +403,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: path
|
||||
sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
|
||||
sha256: "75cca69d1490965be98c73ceaea117e8a04dd21217b37b292c9ddbec0d955bc5"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.9.0"
|
||||
version: "1.9.1"
|
||||
pool:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -456,39 +451,39 @@ packages:
|
||||
dependency: transitive
|
||||
description: flutter
|
||||
source: sdk
|
||||
version: "0.0.99"
|
||||
version: "0.0.0"
|
||||
source_gen:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: source_gen
|
||||
sha256: "14658ba5f669685cd3d63701d01b31ea748310f7ab854e471962670abcf57832"
|
||||
sha256: "35c8150ece9e8c8d263337a265153c3329667640850b9304861faea59fc98f6b"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.5.0"
|
||||
version: "2.0.0"
|
||||
source_span:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: source_span
|
||||
sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c"
|
||||
sha256: "254ee5351d6cb365c859e20ee823c3bb479bf4a293c22d17a9f1bf144ce86f7c"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.10.0"
|
||||
version: "1.10.1"
|
||||
stack_trace:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: stack_trace
|
||||
sha256: "73713990125a6d93122541237550ee3352a2d84baad52d375a4cad2eb9b7ce0b"
|
||||
sha256: "8b27215b45d22309b5cddda1aa2b19bdfec9df0e765f2de506401c071d38d1b1"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.11.1"
|
||||
version: "1.12.1"
|
||||
stream_channel:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: stream_channel
|
||||
sha256: ba2aa5d8cc609d96bbb2899c28934f9e1af5cddbd60a827822ea467161eb54e7
|
||||
sha256: "969e04c80b8bcdf826f8f16579c7b14d780458bd97f56d107d3950fdbeef059d"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.1.2"
|
||||
version: "2.1.4"
|
||||
stream_transform:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -501,26 +496,26 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: string_scanner
|
||||
sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde"
|
||||
sha256: "921cd31725b72fe181906c6a94d987c78e3b98c2e205b397ea399d4054872b43"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.2.0"
|
||||
version: "1.4.1"
|
||||
term_glyph:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: term_glyph
|
||||
sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84
|
||||
sha256: "7f554798625ea768a7518313e58f83891c7f5024f88e46e7182a4558850a4b8e"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.2.1"
|
||||
version: "1.2.2"
|
||||
test_api:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: test_api
|
||||
sha256: "5b8a98dafc4d5c4c9c72d8b31ab2b23fc13422348d2997120294d3bac86b4ddb"
|
||||
sha256: fb31f383e2ee25fbbfe06b40fe21e1e458d14080e3c67e7ba0acfde4df4e0bbd
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "0.7.2"
|
||||
version: "0.7.4"
|
||||
timing:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -549,10 +544,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: vm_service
|
||||
sha256: "5c5f338a667b4c644744b661f309fb8080bb94b18a7e91ef1dbd343bed00ed6d"
|
||||
sha256: "0968250880a6c5fe7edc067ed0a13d4bae1577fe2771dcf3010d52c4a9d3ca14"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "14.2.5"
|
||||
version: "14.3.1"
|
||||
watcher:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -594,5 +589,5 @@ packages:
|
||||
source: hosted
|
||||
version: "3.1.3"
|
||||
sdks:
|
||||
dart: ">=3.5.2 <4.0.0"
|
||||
dart: ">=3.7.0-0 <4.0.0"
|
||||
flutter: ">=3.18.0-18.0.pre.54"
|
||||
|
||||
@@ -11,10 +11,13 @@ environment:
|
||||
dependencies:
|
||||
flutter:
|
||||
sdk: flutter
|
||||
cherrypick: ^2.2.0-dev.1
|
||||
cherrypick_flutter: ^1.1.2-dev.1
|
||||
cherrypick:
|
||||
path: ../../cherrypick
|
||||
cherrypick_flutter:
|
||||
path: ../../cherrypick_flutter
|
||||
|
||||
cherrypick_annotations: ^1.1.0-dev.0
|
||||
cherrypick_annotations:
|
||||
path: ../../cherrypick_annotations
|
||||
|
||||
cupertino_icons: ^1.0.8
|
||||
|
||||
@@ -24,8 +27,9 @@ dev_dependencies:
|
||||
|
||||
flutter_lints: ^5.0.0
|
||||
|
||||
cherrypick_generator: ^1.1.0-dev.2
|
||||
build_runner: ^2.4.13
|
||||
cherrypick_generator:
|
||||
path: ../../cherrypick_generator
|
||||
build_runner: ^2.4.15
|
||||
|
||||
# For information on the generic Dart part of this file, see the
|
||||
# following page: https://dart.dev/tools/pub/pubspec
|
||||
|
||||
@@ -9,6 +9,13 @@
|
||||
# packages, and plugins designed to encourage good coding practices.
|
||||
include: package:flutter_lints/flutter.yaml
|
||||
|
||||
analyzer:
|
||||
exclude:
|
||||
- "**/*.g.dart"
|
||||
- "**/*.freezed.dart"
|
||||
- "**/*.gr.dart"
|
||||
- "**/*.config.dart"
|
||||
|
||||
linter:
|
||||
# The lint rules applied to this project can be customized in the
|
||||
# section below to disable rules from the `package:flutter_lints/flutter.yaml`
|
||||
|
||||
27
examples/postly/build.yaml
Normal file
27
examples/postly/build.yaml
Normal file
@@ -0,0 +1,27 @@
|
||||
targets:
|
||||
$default:
|
||||
builders:
|
||||
cherrypick_generator|inject_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/app.dart': ['lib/generated/app.inject.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
cherrypick_generator|module_generator:
|
||||
options:
|
||||
build_extensions:
|
||||
'^lib/di/{{}}.dart': ['lib/generated/di/{{}}.module.cherrypick.g.dart']
|
||||
output_dir: lib/generated
|
||||
generate_for:
|
||||
- lib/**.dart
|
||||
|
||||
#targets:
|
||||
# $default:
|
||||
# builders:
|
||||
# cherrypick_generator|module_generator:
|
||||
# generate_for:
|
||||
# - lib/**.dart
|
||||
# cherrypick_generator|inject_generator:
|
||||
# generate_for:
|
||||
# - lib/**.dart
|
||||
35
examples/postly/lib/app.dart
Normal file
35
examples/postly/lib/app.dart
Normal file
@@ -0,0 +1,35 @@
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||
|
||||
import 'domain/repository/post_repository.dart';
|
||||
import 'presentation/bloc/post_bloc.dart';
|
||||
import 'router/app_router.dart';
|
||||
|
||||
part 'generated/app.inject.cherrypick.g.dart';
|
||||
|
||||
@injectable()
|
||||
class MyApp extends StatelessWidget with _$MyApp {
|
||||
final _appRouter = AppRouter();
|
||||
|
||||
@named('repo')
|
||||
@inject()
|
||||
late final PostRepository repository;
|
||||
|
||||
MyApp({super.key}) {
|
||||
_inject(this);
|
||||
}
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return BlocProvider(
|
||||
create: (_) => PostBloc(repository),
|
||||
child: MaterialApp.router(
|
||||
routeInformationParser: _appRouter.defaultRouteParser(),
|
||||
routerDelegate: _appRouter.delegate(),
|
||||
theme: ThemeData.light(),
|
||||
),
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -5,7 +5,7 @@ import '../data/network/json_placeholder_api.dart';
|
||||
import '../data/post_repository_impl.dart';
|
||||
import '../domain/repository/post_repository.dart';
|
||||
|
||||
part 'app_module.cherrypick.g.dart';
|
||||
part '../generated/di/app_module.module.cherrypick.g.dart';
|
||||
|
||||
@module()
|
||||
abstract class AppModule extends Module {
|
||||
|
||||
@@ -1,36 +1,9 @@
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:postly/app.dart';
|
||||
import 'di/app_module.dart';
|
||||
import 'domain/repository/post_repository.dart';
|
||||
import 'presentation/bloc/post_bloc.dart';
|
||||
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||
import 'router/app_router.dart';
|
||||
|
||||
void main() {
|
||||
final scope = CherryPick.openRootScope();
|
||||
scope.installModules([$AppModule()]);
|
||||
|
||||
runApp(MyApp(scope: scope));
|
||||
}
|
||||
|
||||
class MyApp extends StatelessWidget {
|
||||
final Scope scope;
|
||||
final _appRouter = AppRouter();
|
||||
|
||||
MyApp({super.key, required this.scope});
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
// Получаем репозиторий через injector
|
||||
final repository = scope.resolve<PostRepository>(named: 'repo');
|
||||
|
||||
return BlocProvider(
|
||||
create: (_) => PostBloc(repository),
|
||||
child: MaterialApp.router(
|
||||
routeInformationParser: _appRouter.defaultRouteParser(),
|
||||
routerDelegate: _appRouter.delegate(),
|
||||
theme: ThemeData.light(),
|
||||
),
|
||||
);
|
||||
}
|
||||
CherryPick.openRootScope().installModules([$AppModule()]);
|
||||
runApp(MyApp());
|
||||
}
|
||||
|
||||
@@ -5,23 +5,18 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: _fe_analyzer_shared
|
||||
sha256: f256b0c0ba6c7577c15e2e4e114755640a875e885099367bf6e012b19314c834
|
||||
sha256: e55636ed79578b9abca5fecf9437947798f5ef7456308b5cb85720b793eac92f
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "72.0.0"
|
||||
_macros:
|
||||
dependency: transitive
|
||||
description: dart
|
||||
source: sdk
|
||||
version: "0.3.2"
|
||||
version: "82.0.0"
|
||||
analyzer:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: analyzer
|
||||
sha256: b652861553cd3990d8ed361f7979dc6d7053a9ac8843fa73820ab68ce5410139
|
||||
sha256: "904ae5bb474d32c38fb9482e2d925d5454cda04ddd0e55d2e6826bc72f6ba8c0"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "6.7.0"
|
||||
version: "7.4.5"
|
||||
args:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -34,10 +29,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: async
|
||||
sha256: "947bfcf187f74dbc5e146c9eb9c0f10c9f8b30743e341481c1e2ed3ecc18c20c"
|
||||
sha256: d2872f9c19731c2e5f10444b14686eb7cc85c76274bd6c16e1816bff9a3bab63
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.11.0"
|
||||
version: "2.12.0"
|
||||
auto_route:
|
||||
dependency: "direct main"
|
||||
description:
|
||||
@@ -50,10 +45,10 @@ packages:
|
||||
dependency: "direct dev"
|
||||
description:
|
||||
name: auto_route_generator
|
||||
sha256: c9086eb07271e51b44071ad5cff34e889f3156710b964a308c2ab590769e79e6
|
||||
sha256: c2e359d8932986d4d1bcad7a428143f81384ce10fef8d4aa5bc29e1f83766a46
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "9.0.0"
|
||||
version: "9.3.1"
|
||||
bloc:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -66,18 +61,18 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: boolean_selector
|
||||
sha256: "6cfb5af12253eaf2b368f07bacc5a80d1301a071c73360d746b7f2e32d762c66"
|
||||
sha256: "8aab1771e1243a5063b8b0ff68042d67334e3feab9e95b9490f9a6ebf73b42ea"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.1.1"
|
||||
version: "2.1.2"
|
||||
build:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: build
|
||||
sha256: "80184af8b6cb3e5c1c4ec6d8544d27711700bc3e6d2efad04238c7b5290889f0"
|
||||
sha256: cef23f1eda9b57566c81e2133d196f8e3df48f244b317368d65c5943d91148f0
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.4.1"
|
||||
version: "2.4.2"
|
||||
build_config:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -98,26 +93,26 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: build_resolvers
|
||||
sha256: "339086358431fa15d7eca8b6a36e5d783728cf025e559b834f4609a1fcfb7b0a"
|
||||
sha256: b9e4fda21d846e192628e7a4f6deda6888c36b5b69ba02ff291a01fd529140f0
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.4.2"
|
||||
version: "2.4.4"
|
||||
build_runner:
|
||||
dependency: "direct dev"
|
||||
description:
|
||||
name: build_runner
|
||||
sha256: "028819cfb90051c6b5440c7e574d1896f8037e3c96cf17aaeb054c9311cfbf4d"
|
||||
sha256: "058fe9dce1de7d69c4b84fada934df3e0153dd000758c4d65964d0166779aa99"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.4.13"
|
||||
version: "2.4.15"
|
||||
build_runner_core:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: build_runner_core
|
||||
sha256: f8126682b87a7282a339b871298cc12009cb67109cfa1614d6436fb0289193e0
|
||||
sha256: "22e3aa1c80e0ada3722fe5b63fd43d9c8990759d0a2cf489c8c5d7b2bdebc021"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "7.3.2"
|
||||
version: "8.0.0"
|
||||
built_collection:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -138,10 +133,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: characters
|
||||
sha256: "04a925763edad70e8443c99234dc3328f442e811f1d8fd1a72f1c8ad0f69a605"
|
||||
sha256: f71061c654a3380576a52b451dd5532377954cf9dbd272a78fc8479606670803
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.3.0"
|
||||
version: "1.4.0"
|
||||
checked_yaml:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -163,22 +158,22 @@ packages:
|
||||
path: "../../cherrypick_annotations"
|
||||
relative: true
|
||||
source: path
|
||||
version: "1.1.0-dev.0"
|
||||
version: "1.1.0-dev.1"
|
||||
cherrypick_generator:
|
||||
dependency: "direct dev"
|
||||
description:
|
||||
path: "../../cherrypick_generator"
|
||||
relative: true
|
||||
source: path
|
||||
version: "1.1.0-dev.1"
|
||||
version: "1.1.0-dev.5"
|
||||
clock:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: clock
|
||||
sha256: cb6d7f03e1de671e34607e909a7213e31d7752be4fb66a86d29fe1eb14bfb5cf
|
||||
sha256: fddb70d9b5277016c77a80201021d40a2247104d9f4aa7bab7157b7e3f05b84b
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.1.1"
|
||||
version: "1.1.2"
|
||||
code_builder:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -191,10 +186,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: collection
|
||||
sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a
|
||||
sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.18.0"
|
||||
version: "1.19.1"
|
||||
convert:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -223,10 +218,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: dart_style
|
||||
sha256: "7856d364b589d1f08986e140938578ed36ed948581fbc3bc9aef1805039ac5ab"
|
||||
sha256: "5b236382b47ee411741447c1f1e111459c941ea1b3f2b540dde54c210a3662af"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.3.7"
|
||||
version: "3.1.0"
|
||||
dartz:
|
||||
dependency: "direct main"
|
||||
description:
|
||||
@@ -255,10 +250,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: fake_async
|
||||
sha256: "511392330127add0b769b75a987850d136345d9227c6b94c96a04cf4a391bf78"
|
||||
sha256: "6a95e56b2449df2273fd8c45a662d6947ce1ebb7aafe80e550a3f68297f3cacc"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.3.1"
|
||||
version: "1.3.2"
|
||||
file:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -305,10 +300,10 @@ packages:
|
||||
dependency: "direct dev"
|
||||
description:
|
||||
name: freezed
|
||||
sha256: "44c19278dd9d89292cf46e97dc0c1e52ce03275f40a97c5a348e802a924bf40e"
|
||||
sha256: "59a584c24b3acdc5250bb856d0d3e9c0b798ed14a4af1ddb7dc1c7b41df91c9c"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.5.7"
|
||||
version: "2.5.8"
|
||||
freezed_annotation:
|
||||
dependency: "direct main"
|
||||
description:
|
||||
@@ -341,6 +336,14 @@ packages:
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.3.2"
|
||||
http:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: http
|
||||
sha256: "2c11f3f94c687ee9bad77c171151672986360b2b001d109814ee7140b2cf261b"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.4.0"
|
||||
http_multi_server:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -385,26 +388,26 @@ packages:
|
||||
dependency: "direct dev"
|
||||
description:
|
||||
name: json_serializable
|
||||
sha256: c2fcb3920cf2b6ae6845954186420fca40bc0a8abcc84903b7801f17d7050d7c
|
||||
sha256: c50ef5fc083d5b5e12eef489503ba3bf5ccc899e487d691584699b4bdefeea8c
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "6.9.0"
|
||||
version: "6.9.5"
|
||||
leak_tracker:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: leak_tracker
|
||||
sha256: "3f87a60e8c63aecc975dda1ceedbc8f24de75f09e4856ea27daf8958f2f0ce05"
|
||||
sha256: c35baad643ba394b40aac41080300150a4f08fd0fd6a10378f8f7c6bc161acec
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "10.0.5"
|
||||
version: "10.0.8"
|
||||
leak_tracker_flutter_testing:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: leak_tracker_flutter_testing
|
||||
sha256: "932549fb305594d82d7183ecd9fa93463e9914e1b67cacc34bc40906594a1806"
|
||||
sha256: f8b613e7e6a13ec79cfdc0e97638fddb3ab848452eff057653abd3edba760573
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "3.0.5"
|
||||
version: "3.0.9"
|
||||
leak_tracker_testing:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -429,22 +432,14 @@ packages:
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.3.0"
|
||||
macros:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: macros
|
||||
sha256: "0acaed5d6b7eab89f63350bccd82119e6c602df0f391260d0e32b5e23db79536"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "0.1.2-main.4"
|
||||
matcher:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: matcher
|
||||
sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
|
||||
sha256: dc58c723c3c24bf8d3e2d3ad3f2f9d7bd9cf43ec6feaa64181775e60190153f2
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "0.12.16+1"
|
||||
version: "0.12.17"
|
||||
material_color_utilities:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -457,10 +452,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: meta
|
||||
sha256: bdb68674043280c3428e9ec998512fb681678676b3c54e773629ffe74419f8c7
|
||||
sha256: e3641ec5d63ebf0d9b41bd43201a66e3fc79a65db5f61fc181f04cd27aab950c
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.15.0"
|
||||
version: "1.16.0"
|
||||
mime:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -489,10 +484,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: path
|
||||
sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
|
||||
sha256: "75cca69d1490965be98c73ceaea117e8a04dd21217b37b292c9ddbec0d955bc5"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.9.0"
|
||||
version: "1.9.1"
|
||||
petitparser:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -513,10 +508,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: protobuf
|
||||
sha256: "68645b24e0716782e58948f8467fd42a880f255096a821f9e7d0ec625b00c84d"
|
||||
sha256: "579fe5557eae58e3adca2e999e38f02441d8aa908703854a9e0a0f47fa857731"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "3.1.0"
|
||||
version: "4.1.0"
|
||||
provider:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -553,10 +548,10 @@ packages:
|
||||
dependency: "direct dev"
|
||||
description:
|
||||
name: retrofit_generator
|
||||
sha256: f76fdb2b66854690d5a332e7364d7561fc9dc2b3c924d7956ab8070495e21f6a
|
||||
sha256: "65d28d3a7b4db485f1c73fee8ee32f552ef23ee4ecb68ba491f39d80b73bdcbf"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "9.1.5"
|
||||
version: "9.2.0"
|
||||
shelf:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -577,15 +572,15 @@ packages:
|
||||
dependency: transitive
|
||||
description: flutter
|
||||
source: sdk
|
||||
version: "0.0.99"
|
||||
version: "0.0.0"
|
||||
source_gen:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: source_gen
|
||||
sha256: "14658ba5f669685cd3d63701d01b31ea748310f7ab854e471962670abcf57832"
|
||||
sha256: "35c8150ece9e8c8d263337a265153c3329667640850b9304861faea59fc98f6b"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.5.0"
|
||||
version: "2.0.0"
|
||||
source_helper:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -598,26 +593,26 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: source_span
|
||||
sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c"
|
||||
sha256: "254ee5351d6cb365c859e20ee823c3bb479bf4a293c22d17a9f1bf144ce86f7c"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.10.0"
|
||||
version: "1.10.1"
|
||||
stack_trace:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: stack_trace
|
||||
sha256: "73713990125a6d93122541237550ee3352a2d84baad52d375a4cad2eb9b7ce0b"
|
||||
sha256: "8b27215b45d22309b5cddda1aa2b19bdfec9df0e765f2de506401c071d38d1b1"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.11.1"
|
||||
version: "1.12.1"
|
||||
stream_channel:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: stream_channel
|
||||
sha256: ba2aa5d8cc609d96bbb2899c28934f9e1af5cddbd60a827822ea467161eb54e7
|
||||
sha256: "969e04c80b8bcdf826f8f16579c7b14d780458bd97f56d107d3950fdbeef059d"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "2.1.2"
|
||||
version: "2.1.4"
|
||||
stream_transform:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -630,26 +625,26 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: string_scanner
|
||||
sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde"
|
||||
sha256: "921cd31725b72fe181906c6a94d987c78e3b98c2e205b397ea399d4054872b43"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.2.0"
|
||||
version: "1.4.1"
|
||||
term_glyph:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: term_glyph
|
||||
sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84
|
||||
sha256: "7f554798625ea768a7518313e58f83891c7f5024f88e46e7182a4558850a4b8e"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "1.2.1"
|
||||
version: "1.2.2"
|
||||
test_api:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: test_api
|
||||
sha256: "5b8a98dafc4d5c4c9c72d8b31ab2b23fc13422348d2997120294d3bac86b4ddb"
|
||||
sha256: fb31f383e2ee25fbbfe06b40fe21e1e458d14080e3c67e7ba0acfde4df4e0bbd
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "0.7.2"
|
||||
version: "0.7.4"
|
||||
timing:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -678,10 +673,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: vm_service
|
||||
sha256: "5c5f338a667b4c644744b661f309fb8080bb94b18a7e91ef1dbd343bed00ed6d"
|
||||
sha256: "0968250880a6c5fe7edc067ed0a13d4bae1577fe2771dcf3010d52c4a9d3ca14"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "14.2.5"
|
||||
version: "14.3.1"
|
||||
watcher:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -731,5 +726,5 @@ packages:
|
||||
source: hosted
|
||||
version: "3.1.3"
|
||||
sdks:
|
||||
dart: ">=3.5.2 <4.0.0"
|
||||
dart: ">=3.7.0 <4.0.0"
|
||||
flutter: ">=3.18.0-18.0.pre.54"
|
||||
|
||||
@@ -12,12 +12,14 @@ dependencies:
|
||||
flutter:
|
||||
sdk: flutter
|
||||
|
||||
cherrypick: ^2.2.0-dev.1
|
||||
cherrypick_annotations: ^1.1.0-dev.0
|
||||
cherrypick:
|
||||
path: ../../cherrypick
|
||||
cherrypick_annotations:
|
||||
path: ../../cherrypick_annotations
|
||||
|
||||
dio: ^5.4.0
|
||||
retrofit: ^4.0.3
|
||||
freezed_annotation: ^2.3.2
|
||||
freezed_annotation: ^2.4.4
|
||||
dartz: ^0.10.1
|
||||
flutter_bloc: ^9.1.1
|
||||
auto_route: ^9.3.0+1
|
||||
@@ -30,11 +32,12 @@ dev_dependencies:
|
||||
|
||||
flutter_lints: ^5.0.0
|
||||
|
||||
cherrypick_generator: ^1.1.0-dev.2
|
||||
build_runner: 2.4.13
|
||||
cherrypick_generator:
|
||||
path: ../../cherrypick_generator
|
||||
build_runner: 2.4.15
|
||||
|
||||
retrofit_generator: ^9.1.5
|
||||
freezed: ^2.3.2
|
||||
freezed: ^2.5.8
|
||||
json_serializable: ^6.9.0
|
||||
auto_route_generator: ^9.0.0
|
||||
|
||||
|
||||
20
melos.yaml
20
melos.yaml
@@ -18,7 +18,23 @@ scripts:
|
||||
exec: dart format lib
|
||||
|
||||
test:
|
||||
exec: flutter test
|
||||
run: |
|
||||
echo "Running Dart tests..."
|
||||
melos exec --scope="cherrypick,cherrypick_annotations,cherrypick_generator" -- dart test --reporter=compact
|
||||
echo "Running Flutter tests..."
|
||||
melos exec --scope="cherrypick_flutter" -- flutter test --reporter=compact
|
||||
|
||||
test:dart:
|
||||
description: "Run tests for Dart packages only"
|
||||
exec: dart test --reporter=compact
|
||||
packageFilters:
|
||||
scope: ["cherrypick", "cherrypick_annotations", "cherrypick_generator"]
|
||||
|
||||
test:flutter:
|
||||
description: "Run tests for Flutter packages only"
|
||||
exec: flutter test --reporter=compact
|
||||
packageFilters:
|
||||
scope: ["cherrypick_flutter"]
|
||||
|
||||
codegen:
|
||||
run: |
|
||||
@@ -31,4 +47,4 @@ scripts:
|
||||
exec: dart pub upgrade --major-versions
|
||||
|
||||
drop:
|
||||
exec: flutter clean
|
||||
exec: flutter clean
|
||||
|
||||
14
pubspec.lock
14
pubspec.lock
@@ -5,23 +5,23 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: _fe_analyzer_shared
|
||||
sha256: "45cfa8471b89fb6643fe9bf51bd7931a76b8f5ec2d65de4fb176dba8d4f22c77"
|
||||
sha256: "16e298750b6d0af7ce8a3ba7c18c69c3785d11b15ec83f6dcd0ad2a0009b3cab"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "73.0.0"
|
||||
version: "76.0.0"
|
||||
_macros:
|
||||
dependency: transitive
|
||||
description: dart
|
||||
source: sdk
|
||||
version: "0.3.2"
|
||||
version: "0.3.3"
|
||||
analyzer:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: analyzer
|
||||
sha256: "4959fec185fe70cce007c57e9ab6983101dbe593d2bf8bbfb4453aaec0cf470a"
|
||||
sha256: "1f14db053a8c23e260789e9b0980fa27f2680dd640932cae5e1137cce0e46e1e"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "6.8.0"
|
||||
version: "6.11.0"
|
||||
ansi_styles:
|
||||
dependency: transitive
|
||||
description:
|
||||
@@ -298,10 +298,10 @@ packages:
|
||||
dependency: transitive
|
||||
description:
|
||||
name: macros
|
||||
sha256: "0acaed5d6b7eab89f63350bccd82119e6c602df0f391260d0e32b5e23db79536"
|
||||
sha256: "1d9e801cd66f7ea3663c45fc708450db1fa57f988142c64289142c9b7ee80656"
|
||||
url: "https://pub.dev"
|
||||
source: hosted
|
||||
version: "0.1.2-main.4"
|
||||
version: "0.1.3-main.0"
|
||||
matcher:
|
||||
dependency: transitive
|
||||
description:
|
||||
|
||||
Reference in New Issue
Block a user