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

Commit bacc4bc

Browse files
chalinkwalrath
authored andcommitted
docs(guide/{di,ts,toh-[23]}): follow-up to #1654 (#1767)
Mainly Dart-side review, following #1654. dependency-injection: - Renamed components in providers_component.dart - E2e suites passed: - public/docs/_examples/dependency-injection/dart - public/docs/_examples/dependency-injection/ts template-syntax: - Removed unused global variable. - Suites passed: public/docs/_examples/template-syntax/dart public/docs/_examples/template-syntax/ts toh-2 & 3: - Clean-up.
1 parent a7435c3 commit bacc4bc

File tree

4 files changed

+63
-66
lines changed

4 files changed

+63
-66
lines changed

public/docs/_examples/dependency-injection/dart/lib/providers_component.dart

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ const template = '{{log}}';
1818
providers: const [Logger]
1919
// #enddocregion providers-1, providers-logger
2020
)
21-
class ProviderComponent1 {
21+
class Provider1Component {
2222
String log;
2323

24-
ProviderComponent1(Logger logger) {
24+
Provider1Component(Logger logger) {
2525
logger.log('Hello from logger provided with Logger class');
2626
log = logger.logs[0];
2727
}
@@ -31,15 +31,15 @@ class ProviderComponent1 {
3131
@Component(
3232
selector: 'provider-3',
3333
template: '{{log}}',
34-
providers:
34+
providers:
3535
// #docregion providers-3
3636
const [const Provider(Logger, useClass: Logger)]
3737
// #enddocregion providers-3
3838
)
39-
class ProviderComponent3 {
39+
class Provider3Component {
4040
String log;
4141

42-
ProviderComponent3(Logger logger) {
42+
Provider3Component(Logger logger) {
4343
logger.log('Hello from logger provided with useClass:Logger');
4444
log = logger.logs[0];
4545
}
@@ -56,10 +56,10 @@ class BetterLogger extends Logger {}
5656
const [const Provider(Logger, useClass: BetterLogger)]
5757
// #enddocregion providers-4
5858
)
59-
class ProviderComponent4 {
59+
class Provider4Component {
6060
String log;
6161

62-
ProviderComponent4(Logger logger) {
62+
Provider4Component(Logger logger) {
6363
logger.log('Hello from logger provided with useClass:BetterLogger');
6464
log = logger.logs[0];
6565
}
@@ -87,10 +87,10 @@ class EvenBetterLogger extends Logger {
8787
const [UserService, const Provider(Logger, useClass: EvenBetterLogger)]
8888
// #enddocregion providers-5
8989
)
90-
class ProviderComponent5 {
90+
class Provider5Component {
9191
String log;
9292

93-
ProviderComponent5(Logger logger) {
93+
Provider5Component(Logger logger) {
9494
logger.log('Hello from EvenBetterlogger');
9595
log = logger.logs[0];
9696
}
@@ -116,10 +116,10 @@ class OldLogger extends Logger {
116116
const Provider(OldLogger, useClass: NewLogger)]
117117
// #enddocregion providers-6a
118118
)
119-
class ProviderComponent6a {
119+
class Provider6aComponent {
120120
String log;
121121

122-
ProviderComponent6a(NewLogger newLogger, OldLogger oldLogger) {
122+
Provider6aComponent(NewLogger newLogger, OldLogger oldLogger) {
123123
if (newLogger == oldLogger) {
124124
throw new Exception('expected the two loggers to be different instances');
125125
}
@@ -140,10 +140,10 @@ class ProviderComponent6a {
140140
const Provider(OldLogger, useExisting: NewLogger)]
141141
// #enddocregion providers-6b
142142
)
143-
class ProviderComponent6b {
143+
class Provider6bComponent {
144144
String log;
145145

146-
ProviderComponent6b(NewLogger newLogger, OldLogger oldLogger) {
146+
Provider6bComponent(NewLogger newLogger, OldLogger oldLogger) {
147147
if (newLogger != oldLogger) {
148148
throw new Exception('expected the two loggers to be the same instance');
149149
}
@@ -178,10 +178,10 @@ const silentLogger = const SilentLogger();
178178
const [const Provider(Logger, useValue: silentLogger)]
179179
// #enddocregion providers-7
180180
)
181-
class ProviderComponent7 {
181+
class Provider7Component {
182182
String log;
183183

184-
ProviderComponent7(Logger logger) {
184+
Provider7Component(Logger logger) {
185185
logger.log('Hello from logger provided with useValue');
186186
log = logger.logs[0];
187187
}
@@ -191,13 +191,13 @@ class ProviderComponent7 {
191191
selector: 'provider-8',
192192
template: '{{log}}',
193193
providers: const [heroServiceProvider, Logger, UserService])
194-
class ProviderComponent8 {
195-
// #docregion provider-8-ctor
196-
ProviderComponent8(HeroService heroService);
197-
// #enddocregion provider-8-ctor
198-
194+
class Provider8Component {
199195
// must be true else this component would have blown up at runtime
200196
var log = 'Hero service injected successfully via heroServiceProvider';
197+
198+
// #docregion provider-8-ctor
199+
Provider8Component(HeroService heroService);
200+
// #enddocregion provider-8-ctor
201201
}
202202

203203
@Component(
@@ -208,12 +208,12 @@ class ProviderComponent8 {
208208
const Provider(APP_CONFIG, useValue: heroDiConfig)]
209209
// #enddocregion providers-9
210210
)
211-
class ProviderComponent9 implements OnInit {
211+
class Provider9Component implements OnInit {
212212
Map _config;
213213
String log;
214214

215215
// #docregion provider-9-ctor
216-
ProviderComponent9(@Inject(APP_CONFIG) this._config);
216+
Provider9Component(@Inject(APP_CONFIG) this._config);
217217
// #enddocregion provider-9-ctor
218218

219219
@override
@@ -225,7 +225,7 @@ class ProviderComponent9 implements OnInit {
225225
// Sample providers 1 to 7 illustrate a required logger dependency.
226226
// Optional logger, can be null.
227227
@Component(selector: 'provider-10', template: '{{log}}')
228-
class ProviderComponent10 implements OnInit {
228+
class Provider10Component implements OnInit {
229229
final Logger _logger;
230230
String log;
231231

@@ -234,11 +234,10 @@ class ProviderComponent10 implements OnInit {
234234
HeroService(@Optional() this._logger) {
235235
// #enddocregion provider-10-ctor
236236
*/
237-
ProviderComponent10(@Optional() this._logger) {
237+
Provider10Component(@Optional() this._logger) {
238238
const someMessage = 'Hello from the injected logger';
239239
// #docregion provider-10-ctor
240-
if (_logger != null)
241-
_logger.log(someMessage);
240+
_logger?.log(someMessage);
242241
}
243242
// #enddocregion provider-10-ctor
244243

@@ -263,15 +262,15 @@ class ProviderComponent10 implements OnInit {
263262
<div id="p9"><provider-9></provider-9></div>
264263
<div id="p10"><provider-10></provider-10></div>''',
265264
directives: const [
266-
ProviderComponent1,
267-
ProviderComponent3,
268-
ProviderComponent4,
269-
ProviderComponent5,
270-
ProviderComponent6a,
271-
ProviderComponent6b,
272-
ProviderComponent7,
273-
ProviderComponent8,
274-
ProviderComponent9,
275-
ProviderComponent10
265+
Provider1Component,
266+
Provider3Component,
267+
Provider4Component,
268+
Provider5Component,
269+
Provider6aComponent,
270+
Provider6bComponent,
271+
Provider7Component,
272+
Provider8Component,
273+
Provider9Component,
274+
Provider10Component
276275
])
277276
class ProvidersComponent {}

public/docs/_examples/template-syntax/dart/lib/hero_detail_component.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ import 'package:angular2/core.dart';
44

55
import 'hero.dart';
66

7-
var nextHeroDetailId = 1;
8-
97
// #docregion input-output-2
108
@Component(
119
// #enddocregion input-output-2

public/docs/_examples/toh-2/dart/lib/app_component.dart

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,21 @@ class Hero {
88
Hero(this.id, this.name);
99
}
1010

11+
// #docregion hero-array
12+
final List<Hero> mockHeroes = [
13+
new Hero(11, 'Mr. Nice'),
14+
new Hero(12, 'Narco'),
15+
new Hero(13, 'Bombasto'),
16+
new Hero(14, 'Celeritas'),
17+
new Hero(15, 'Magneta'),
18+
new Hero(16, 'RubberMan'),
19+
new Hero(17, 'Dynama'),
20+
new Hero(18, 'Dr IQ'),
21+
new Hero(19, 'Magma'),
22+
new Hero(20, 'Tornado')
23+
];
24+
// #enddocregion hero-array
25+
1126
@Component(
1227
selector: 'my-app',
1328
template: '''
@@ -94,18 +109,3 @@ class AppComponent {
94109
}
95110
// #enddocregion on-select
96111
}
97-
// #enddocregion
98-
99-
// #docregion hero-array
100-
final List<Hero> mockHeroes = [
101-
new Hero(11, 'Mr. Nice'),
102-
new Hero(12, 'Narco'),
103-
new Hero(13, 'Bombasto'),
104-
new Hero(14, 'Celeritas'),
105-
new Hero(15, 'Magneta'),
106-
new Hero(16, 'RubberMan'),
107-
new Hero(17, 'Dynama'),
108-
new Hero(18, 'Dr IQ'),
109-
new Hero(19, 'Magma'),
110-
new Hero(20, 'Tornado')
111-
];

public/docs/_examples/toh-3/dart/lib/app_component.dart

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@ import 'hero.dart';
88
import 'hero_detail_component.dart';
99
// #enddocregion hero-detail-import
1010

11+
final List<Hero> mockHeroes = [
12+
new Hero(11, 'Mr. Nice'),
13+
new Hero(12, 'Narco'),
14+
new Hero(13, 'Bombasto'),
15+
new Hero(14, 'Celeritas'),
16+
new Hero(15, 'Magneta'),
17+
new Hero(16, 'RubberMan'),
18+
new Hero(17, 'Dynama'),
19+
new Hero(18, 'Dr IQ'),
20+
new Hero(19, 'Magma'),
21+
new Hero(20, 'Tornado')
22+
];
23+
1124
@Component(
1225
selector: 'my-app',
1326
// #docregion hero-detail-template
@@ -87,16 +100,3 @@ class AppComponent {
87100
selectedHero = hero;
88101
}
89102
}
90-
91-
final List<Hero> mockHeroes = [
92-
new Hero(11, 'Mr. Nice'),
93-
new Hero(12, 'Narco'),
94-
new Hero(13, 'Bombasto'),
95-
new Hero(14, 'Celeritas'),
96-
new Hero(15, 'Magneta'),
97-
new Hero(16, 'RubberMan'),
98-
new Hero(17, 'Dynama'),
99-
new Hero(18, 'Dr IQ'),
100-
new Hero(19, 'Magma'),
101-
new Hero(20, 'Tornado')
102-
];

0 commit comments

Comments
 (0)