angel_toggle 1.0.0

  • README.md
  • Installing
  • Versions
  • 0

toggle

version 1.0.0 build status coverage: 100%

Allows you to substitute one service for another while testing. The primary use case is to test an application using in-memory services, although it may be using database services in the real world. This makes tests a bit faster, and also means that you don't have to write any boilerplate code to clean up a database between test runs.

Installation

In your pubspec.yaml file:

dependencies:
  angel_toggle: ^1.0.0

Usage

Within angel_toggle, there are two ways to specify that your application is running in "test mode":

  1. app.properties contains a key testMode, the value of which is true.
  2. Platform.script contains the string test (case-insensitive). This means you have to do no further configuration when running from the test/ directory.

This package exports a single plug-in:

toggleService

If the application is running in test mode, then the second generator will be called. Otherwise, it defaults to the first generator.

If you really need to delay the mounting of the service, add this plug-in to app.justBeforeStart. If no second generator is provided, it will default to a MapService.

import 'package:angel_framework/angel_framework.dart';
import 'package:angel_toggle/angel_toggle.dart';

configureServer(Angel app) async {
  await app.configure(toggleService('/api/todos', () => new MongoService(...)));
}

Using the plug-in will print a message to the console, notifying you that a service has been toggled out.

Use this package as a library

1. Depend on it

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


dependencies:
  angel_toggle: ^1.0.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:angel_toggle/angel_toggle.dart';
  
Version Uploaded Documentation Archive
1.0.0 May 27, 2017 Go to the documentation of angel_toggle 1.0.0 Download angel_toggle 1.0.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
--
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
--
Overall:
Weighted score of the above. [more]
0
Learn more about scoring.

The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.

Analysis issues and suggestions

Fix dependencies in pubspec.yaml.

Running pub upgrade failed with the following output:

ERR: The current Dart SDK version is 2.1.0.
 
 Because angel_framework >=0.0.0-dev.1 <1.1.3 requires SDK version <2.0.0 and angel_framework >=1.1.3 <2.0.0-alpha depends on container ^0.1.2, angel_framework >=0.0.0-dev.1 <2.0.0-alpha requires container ^0.1.2.
 So, because container >=0.1.1 requires SDK version >=1.8.0 <2.0.0 and angel_toggle depends on angel_framework ^1.0.0, version solving failed.

Health suggestions

Format lib/angel_toggle.dart.

Run dartfmt to format lib/angel_toggle.dart.

Maintenance issues and suggestions

Fix platform conflicts. (-20 points)

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

Running dartdoc failed. (-10 points)

Make sure dartdoc runs without any issues.

Maintain CHANGELOG.md. (-20 points)

Changelog entries help clients to follow the progress in your code.

Package is getting outdated. (-54.79 points)

The package was released 80 weeks ago.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use angel_toggle.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.19.0