Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

docs(dependency-injection): revise Dart and TS code and prose#1573

Merged
kwalrath merged 3 commits into from
Jun 3, 2016
Merged

docs(dependency-injection): revise Dart and TS code and prose #1573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f9dac13
docs(dependency-injection): revised Dart and TS code and prose
chalin May 29, 2016
6e8f602
post-review updates
chalin Jun 1, 2016
118d4a5
post-post-review updates
chalin Jun 3, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file addedpublic/docs/_examples/dependency-injection/dart/example-config.json
View file
Open in desktop
Empty file.
25 changes: 10 additions & 15 deletions public/docs/_examples/dependency-injection/dart/lib/app_component.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
// #docplaster
// #docregion
// #docregion imports
import 'package:angular2/core.dart';

import 'app_config.dart';
import 'car/car_component.dart';
import 'heroes/heroes_component.dart';
import 'logger_service.dart';
import 'user_service.dart';
//PENDING: check whether we intend to hide injector_component.dart & providers_component.dart; if so, change docregion name?
// #enddocregion imports
import 'injector_component.dart';
import 'test_component.dart';
import 'providers_component.dart';

@Component(
Expand All@@ -31,21 +27,21 @@ import 'providers_component.dart';
CarComponent,
HeroesComponent,
InjectorComponent,
TestComponent,
ProvidersComponent
],
// #docregion providers
// #docregion providers
providers: const [
Logger,
UserService,
const Provider(AppConfig, useValue: config1)]
// #enddocregion providers
Logger, UserService,
const Provider(APP_CONFIG, useFactory: heroDiConfigFactory)]

@kwalrathkwalrathJun 1, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

APP_CONFIG seems like an un-Darty name. (But if it's mentioned in text, it'd be easier to leave this capitalization.)

@chalinchalinJun 1, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The OpaqueToken section will need to be revisited once #1563 gets resolved so I decided to leave the token name like it is in the TS example (because then the token name and the interface name will match, both being AppConfig).

// #enddocregion providers
)
class AppComponent {
final UserService _userService;
final String title;

//#docregion ctor
AppComponent(AppConfig config, this._userService)
//#docregion ctor
AppComponent(@Inject(APP_CONFIG) AppConfig config, this._userService)
: title = config.title;
// #enddocregion ctor

Expand All@@ -61,7 +57,6 @@ class AppComponent {
return _userService.user;
}

String get userInfo => 'Current user, ${user.name}, is'
'${isAuthorized ? "" : " not"} authorized. ';
String get userInfo => 'Current user, ${user.name}, is' +
(isAuthorized ? '' : ' not') + ' authorized. ';
}
// #enddocregion
10 changes: 0 additions & 10 deletions public/docs/_examples/dependency-injection/dart/lib/app_component_1.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,13 +16,3 @@ import 'heroes/heroes_component_1.dart';
class AppComponent {
final String title = 'Dependency Injection';
}
// #enddocregion

/*
//#docregion ctor-di-fail
// FAIL! Injectable `config` is not a class!
AppComponent(HeroService heroService, Map config) {
title = config['title'];
}
//#enddocregion ctor-di-fail
*/
13 changes: 8 additions & 5 deletions public/docs/_examples/dependency-injection/dart/lib/app_component_2.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,13 +21,16 @@ import 'logger_service.dart';
],
providers: const [
Logger,
const Provider(AppConfig, useValue: config1)
])
// #docregion providers
const Provider(APP_CONFIG, useValue: heroDiConfig)
// #enddocregion providers
]
)
class AppComponent {
final String title;

// #docregion ctor
AppComponent(AppConfig config)
: title = config.title;
// #enddocregion
AppComponent(@Inject(APP_CONFIG) Map config)
: title = config['title'];
// #enddocregion ctor
}
32 changes: 21 additions & 11 deletions public/docs/_examples/dependency-injection/dart/lib/app_config.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,27 @@
// #docregion
// #docregion token
import 'package:angular2/core.dart';

//#docregion const-class
@Injectable()
class AppConfig {
final apiEndpoint;
final String title;
const APP_CONFIG = const OpaqueToken('app.config');
// #enddocregion token

// #docregion config
const Map heroDiConfig = const <String,String>{
'apiEndpoint' : 'api.heroes.com',
'title' : 'Dependency Injection'
};
// #enddocregion config

const AppConfig(this.apiEndpoint, this.title);
// #docregion config-alt
class AppConfig {
String apiEndpoint;
String title;
}
//#enddocregion const-class

//#docregion const-object
const config1 = const AppConfig('api.heroes.com', 'Dependency Injection');
//#enddocregion const-object
AppConfig heroDiConfigFactory() => new AppConfig()
..apiEndpoint = 'api.heroes.com'
..title = 'Dependency Injection';
// #enddocregion config-alt

const appConfigProvider = const Provider(APP_CONFIG,
useFactory: heroDiConfigFactory,
deps: const []);
17 changes: 7 additions & 10 deletions public/docs/_examples/dependency-injection/dart/lib/car/car.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
// #docregion
import 'package:angular2/core.dart';

@Injectable()
// #docregion engine
class Engine {
final int cylinders = 4;
final int cylinders;

Engine() : cylinders = 4;
Engine.withCylinders(this.cylinders);
}
// #enddocregion engine

@Injectable()
// #docregion tires
class Tires {
String make = 'Flintstone';
String model = 'Square';
}

// #enddocregion tires
@Injectable()
class Car {
//#docregion car-ctor
Expand All@@ -24,11 +22,10 @@ class Car {
String description = 'DI';

Car(this.engine, this.tires);

// #enddocregion car-ctor

// Method using the engine and tires
String drive() => '$description car with ${engine.cylinders} cylinders'
' and ${tires.make} tires.';
String drive() => '$description car with '
'${engine.cylinders} cylinders and '
'${tires.make} tires.';
}
// #enddocregion car
59 changes: 24 additions & 35 deletions public/docs/_examples/dependency-injection/dart/lib/car/car_creations.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,50 +3,39 @@
import 'car.dart';

///////// example 1 ////////////
Car simpleCar() {
//#docregion car-ctor-instantiation
Car simpleCar() =>
//#docregion car-ctor-instantiation
// Simple car with 4 cylinders and Flintstone tires.
var car = new Car(new Engine(), new Tires());
//#enddocregion car-ctor-instantiation
car.description = 'Simple';
return car;
}
///////// example 2 ////////////
new Car(new Engine(), new Tires())
// #enddocregion car-ctor-instantiation
..description = 'Simple';

//#docregion car-ctor-instantiation-with-param
class Engine2 implements Engine {
final int cylinders;
///////// example 2 ////////////

Engine2(this.cylinders);
}
//#enddocregion car-ctor-instantiation-with-param

Car superCar() {
//#docregion car-ctor-instantiation-with-param
// Super car with 12 cylinders and Flintstone tires.
var bigCylinders = 12;
var car = new Car(new Engine2(bigCylinders), new Tires());
//#enddocregion car-ctor-instantiation-with-param
car.description = 'Super';
return car;
// #docregion car-ctor-instantiation-with-param
class Engine2 extends Engine {
Engine2(cylinders) : super.withCylinders(cylinders);
}

Car superCar() =>
// Super car with 12 cylinders and Flintstone tires.
new Car(new Engine2(12), new Tires())
..description = 'Super';
// #enddocregion car-ctor-instantiation-with-param

/////////// example 3 //////////

//#docregion car-ctor-instantiation-with-mocks
//#docregion car-ctor-instantiation-with-mocks
class MockEngine extends Engine {
final int cylinders = 8;
MockEngine() : super.withCylinders(8);
}

class MockTires extends Tires {
String make = 'YokoGoodStone';
MockTires() { make = 'YokoGoodStone'; }
}

//#enddocregion car-ctor-instantiation-with-mocks
Car testCar() {
//#docregion car-ctor-instantiation-with-mocks
// Test car with 8 cylinders and YokoGoodStone tires.
var car = new Car(new MockEngine(), new MockTires());
//#enddocregion car-ctor-instantiation-with-mocks
car.description = 'Test';
return car;
}
Car testCar() =>
// Test car with 8 cylinders and YokoGoodStone tires.
new Car(new MockEngine(), new MockTires())
..description = 'Test';
// #enddocregion car-ctor-instantiation-with-mocks
7 changes: 3 additions & 4 deletions public/docs/_examples/dependency-injection/dart/lib/car/car_factory.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,10 +3,9 @@ import 'car.dart';

// BAD pattern!
class CarFactory {
Car createCar() {
return new Car(createEngine(), createTires())
..description = 'Factory';
}
Car createCar() =>
new Car(createEngine(), createTires())
..description = 'Factory';

Engine createEngine() => new Engine();
Tires createTires() => new Tires();
Expand Down
35 changes: 13 additions & 22 deletions public/docs/_examples/dependency-injection/dart/lib/car/car_injector.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,27 @@
// #docplaster
//#docregion
import 'package:angular2/core.dart';

import '../logger_service.dart';
import 'car.dart';

//#docregion injector
//#docregion injector
Car useInjector() {
ReflectiveInjector injector;
//#enddocregion injector

// #enddocregion injector
/*
//#docregion injector-no-new
// Cannot 'new' an ReflectiveInjector like this!
var injector = new ReflectiveInjector([Car, Engine, Tires, Logger]);
//#enddocregion injector-no-new
*/

//#docregion injector

//#docregion injector-create-and-call
injector = ReflectiveInjector.resolveAndCreate([Car, Engine, Tires, Logger]);
//#docregion injector-call
// #docregion injector-no-new
// Cannot instantiate an ReflectiveInjector like this!
var injector = new ReflectiveInjector([Car, Engine, Tires]);
// #enddocregion injector-no-new
*/
// #docregion injector, injector-create-and-call
injector = ReflectiveInjector.resolveAndCreate([Car, Engine, Tires]);
// #docregion injector-call
var car = injector.get(Car);
//#enddocregion injector-call
//#enddocregion injector-create-and-call

// #enddocregion injector-call, injector-create-and-call
car.description = 'Injector';

injector = ReflectiveInjector.resolveAndCreate([Logger]);
var logger = injector.get(Logger);
logger.log('Injector car.drive() said: ' + car.drive());
return car;
}
//#enddocregion injector

//#enddocregion
3 changes: 2 additions & 1 deletion public/docs/_examples/dependency-injection/dart/lib/car/car_no_di.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ class Car {

// Method using the engine and tires
String drive() => '$description car with '
'${engine.cylinders} cylinders and ${tires.make} tires.';
'${engine.cylinders} cylinders and '
'${tires.make} tires.';
}
//#enddocregion car
8 changes: 5 additions & 3 deletions public/docs/_examples/dependency-injection/dart/lib/heroes/hero.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
// #docregion
class Hero {
num id;
String name;
bool isSecret = false;
final int id;
final String name;
final bool isSecret;

Hero(this.id, this.name, [this.isSecret = false]);
}
7 changes: 4 additions & 3 deletions public/docs/_examples/dependency-injection/dart/lib/heroes/hero_list_component.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ import 'hero_service.dart';
class HeroListComponent {
final List<Hero> heroes;

//#docregion ctor-signature
HeroListComponent(HeroService heroService) : heroes = heroService.getHeroes();
//#enddocregion ctor-signature
// #docregion ctor-signature
HeroListComponent(HeroService heroService)
// #enddocregion ctor-signature
: heroes = heroService.getHeroes();
}
12 changes: 10 additions & 2 deletions public/docs/_examples/dependency-injection/dart/lib/heroes/hero_list_component_2.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
// #docplaster
// #docregion
import 'package:angular2/core.dart';

import 'hero.dart';
// #enddocregion
import 'hero_service_1.dart';
/*
// #docregion
import 'hero_service.dart';
// #enddocregion
*/
// #docregion

@Component(
selector: 'hero-list',
Expand All@@ -13,8 +21,8 @@ import 'hero_service.dart';
class HeroListComponent {
final List<Hero> heroes;

//#docregion ctor
// #docregion ctor
HeroListComponent(HeroService heroService)
: heroes = heroService.getHeroes();
//#enddocregion ctor
// #enddocregion ctor
}
2 changes: 1 addition & 1 deletion public/docs/_examples/dependency-injection/dart/lib/heroes/hero_service.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,5 +20,5 @@ class HeroService {
.where((hero) => _isAuthorized || !hero.isSecret)
.toList();
}
// #enddocregion internals
// #enddocregion internals
}
3 changes: 3 additions & 0 deletions public/docs/_examples/dependency-injection/dart/lib/heroes/hero_service_1.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
// #docregion
import 'package:angular2/core.dart';

import 'hero.dart';
import 'mock_heroes.dart';

@Injectable()
class HeroService {
List<Hero> getHeroes() => HEROES;
}
1 change: 0 additions & 1 deletion public/docs/_examples/dependency-injection/dart/lib/heroes/hero_service_2.dart
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ class HeroService {

//#docregion ctor
HeroService(this._logger);

//#enddocregion ctor
List<Hero> getHeroes() {
_logger.log('Getting heroes ...');
Expand Down
Loading