miodi 0.2.1

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 53

miodi #

Dependency Injection tools for Dart.

https://pub.dartlang.org/packages/miodi

Docs and Example project #

Example project is under development.

Docs are pending.

Example #

Create component:


class AppComponent extends MiodiComponent {
  static String testScope = 'test';
  final String param;

  AppComponent(this.param);

  @override
  List<MiodiModule> get modules => [
        module([
          singleton(Database, () => DatabaseImpl()),
          factory(User, () => User())
        ]),
        module([
          singleton(Logger, () => FileLogger(param)),
          factory(LogSender, () => LogSender(get())),
          scope(testScope, ScopeObject, () => ScopeObject())
        ])
      ];
}

class ScopeObject {}

abstract class Database {}

class DatabaseImpl implements Database {}

class User {}

abstract class Logger {}

class FileLogger implements Logger {
  final String tag;
  FileLogger(this.tag);
}

class LogSender {
  final Logger logger;
  LogSender(this.logger);
}

In the body of the component, use the get() method to get dependencies (from the current or other modules). You can use several components. You can also use the component's constructor to represent dependencies in modules.

Usage example:

final appComponent = AppComponent('TAG');

void main() async {
  Miodi.init([appComponent]);

  Database database = inject();
  //if you have a lot of big components override method 'String get componentNamespace' in your components
  //this will speed up the search for dependencies
  User user = inject('customComponentNamespace');
  
  
  ScopeObject scopeObject = scopeInject(AppComponent.testScope);
  
  //For cleaning of scopes it is NECESSARY!! use cleaning methods.
  //otherwise they will work as singleton
  clearScope(AppComponent.testScope);
  
  //and use 'injectAsync' if object creation takes time or requires delays
  Logger fileLogger = await injectAsync();

  LogSender sender = inject();
  sender.sendLog();
}

[0.2.1] - 03.11.2018

  • Add default scope, add optional delay before clear scope obj

[0.2.0] - 03.11.2018

  • Add custom scopes

[0.1.2] - 01.11.2018

  • Fix lib/miodi.dart

[0.1.1] - 01.11.2018

  • Miodi beta-version added correct errors

[0.0.1] - 01.11.2018

  • Miodi beta-version

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  miodi: ^0.2.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:miodi/miodi.dart';
  
Version Uploaded Documentation Archive
0.6.1 Jan 30, 2019 Go to the documentation of miodi 0.6.1 Download miodi 0.6.1 archive
0.5.2 Dec 22, 2018 Go to the documentation of miodi 0.5.2 Download miodi 0.5.2 archive
0.5.1 Dec 22, 2018 Go to the documentation of miodi 0.5.1 Download miodi 0.5.1 archive
0.4.0 Dec 16, 2018 Go to the documentation of miodi 0.4.0 Download miodi 0.4.0 archive
0.3.1 Dec 9, 2018 Go to the documentation of miodi 0.3.1 Download miodi 0.3.1 archive
0.3.0 Nov 24, 2018 Go to the documentation of miodi 0.3.0 Download miodi 0.3.0 archive
0.2.5 Nov 5, 2018 Go to the documentation of miodi 0.2.5 Download miodi 0.2.5 archive
0.2.4 Nov 5, 2018 Go to the documentation of miodi 0.2.4 Download miodi 0.2.4 archive
0.2.2 Nov 3, 2018 Go to the documentation of miodi 0.2.2 Download miodi 0.2.2 archive
0.2.1 Nov 3, 2018 Go to the documentation of miodi 0.2.1 Download miodi 0.2.1 archive

All 14 versions...

Popularity:
Describes how popular the package is relative to other packages. [more]
18
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
53
Learn more about scoring.

We analyzed this package on Feb 14, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.1.0
  • pana: 0.12.13

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:miodi/miodi.dart.

Health issues and suggestions

Document public APIs. (-1 points)

95 out of 95 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Format lib/core/component.dart.

Run dartfmt to format lib/core/component.dart.

Format lib/core/configuration.dart.

Run dartfmt to format lib/core/configuration.dart.

Format lib/core/consts.dart.

Run dartfmt to format lib/core/consts.dart.

Fix additional 4 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/core/module.dart (Run dartfmt to format lib/core/module.dart.)
  • lib/core/providers.dart (Run dartfmt to format lib/core/providers.dart.)
  • lib/error/errors.dart (Run dartfmt to format lib/error/errors.dart.)
  • lib/miodi.dart (Run dartfmt to format lib/miodi.dart.)

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and miodi.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
Dev dependencies
test ^1.5.0