/
TranslateBehaviorTest.php
396 lines (355 loc) · 11.4 KB
/
TranslateBehaviorTest.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since CakePHP(tm) v 3.0.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
namespace Cake\Test\TestCase\Model\Behavior;
use Cake\Collection\Collection;
use Cake\Event\Event;
use Cake\Model\Behavior\TranslateBehavior;
use Cake\ORM\Entity;
use Cake\ORM\TableRegistry;
use Cake\TestSuite\TestCase;
/**
* Translate behavior test case
*/
class TranslateBehaviorTest extends TestCase {
/**
* fixtures
*
* @var array
*/
public $fixtures = [
'core.translate',
'core.article',
'core.comment'
];
public function tearDown() {
parent::tearDown();
TableRegistry::clear();
}
/**
* Returns an array with all the translations found for a set of records
*
* @return Collection
*/
protected function _extractTranslations($data) {
return (new Collection($data))->map(function($row) {
$translations = $row->get('_translations');
if (!$translations) {
return [];
}
return array_map(function($t) {
return $t->toArray();
}, $translations);
});
}
/**
* Tests that fields from a translated model are overriden
*
* @return void
*/
public function testFindSingleLocale() {
$table = TableRegistry::get('Articles');
$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
$table->locale('eng');
$results = $table->find()->combine('title', 'body', 'id')->toArray();
$expected = [
1 => ['Title #1' => 'Content #1'],
2 => ['Title #2' => 'Content #2'],
3 => ['Title #3' => 'Content #3'],
];
$this->assertSame($expected, $results);
}
/**
* Tests that overriding fields with the translate behavior works when
* using conditions and that all other columns are preserved
*
* @return void
*/
public function testFindSingleLocaleWithConditions() {
$table = TableRegistry::get('Articles');
$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
$table->locale('eng');
$results = $table->find()
->where(['Articles.id' => 2])
->all();
$this->assertCount(1, $results);
$row = $results->first();
$expected = [
'id' => 2,
'title' => 'Title #2',
'body' => 'Content #2',
'author_id' => 3,
'published' => 'Y',
'_locale' => 'eng'
];
$this->assertEquals($expected, $row->toArray());
}
/**
* Tests that translating fields work when other formatters are used
*
* @return void
*/
public function testFindList() {
$table = TableRegistry::get('Articles');
$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
$table->locale('eng');
$results = $table->find('list')->toArray();
$expected = [1 => 'Title #1', 2 => 'Title #2', 3 => 'Title #3'];
$this->assertSame($expected, $results);
}
/**
* Tests that the query count return the correct results
*
* @return void
*/
public function testFindCount() {
$table = TableRegistry::get('Articles');
$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
$table->locale('eng');
$this->assertEquals(3, $table->find()->count());
}
/**
* Tests that it is possible to get all translated fields at once
*
* @return void
*/
public function testFindTranslations() {
$table = TableRegistry::get('Articles');
$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
$results = $table->find('translations');
$expected = [
[
'eng' => ['title' => 'Title #1', 'body' => 'Content #1', 'locale' => 'eng'],
'deu' => ['title' => 'Titel #1', 'body' => 'Inhalt #1', 'locale' => 'deu'],
'cze' => ['title' => 'Titulek #1', 'body' => 'Obsah #1', 'locale' => 'cze']
],
[
'eng' => ['title' => 'Title #2', 'body' => 'Content #2', 'locale' => 'eng'],
'deu' => ['title' => 'Titel #2', 'body' => 'Inhalt #2', 'locale' => 'deu'],
'cze' => ['title' => 'Titulek #2', 'body' => 'Obsah #2', 'locale' => 'cze']
],
[
'eng' => ['title' => 'Title #3', 'body' => 'Content #3', 'locale' => 'eng'],
'deu' => ['title' => 'Titel #3', 'body' => 'Inhalt #3', 'locale' => 'deu'],
'cze' => ['title' => 'Titulek #3', 'body' => 'Obsah #3', 'locale' => 'cze']
]
];
$translations = $this->_extractTranslations($results);
$this->assertEquals($expected, $translations->toArray());
$expected = [
1 => ['First Article' => 'First Article Body'],
2 => ['Second Article' => 'Second Article Body'],
3 => ['Third Article' => 'Third Article Body']
];
$grouped = $results->combine('title', 'body', 'id');
$this->assertEquals($expected, $grouped->toArray());
}
/**
* Tests that it is possible to request just a few translations
*
* @return void
*/
public function testFindFilteredTranslations() {
$table = TableRegistry::get('Articles');
$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
$results = $table->find('translations', ['locales' => ['deu', 'cze']]);
$expected = [
[
'deu' => ['title' => 'Titel #1', 'body' => 'Inhalt #1', 'locale' => 'deu'],
'cze' => ['title' => 'Titulek #1', 'body' => 'Obsah #1', 'locale' => 'cze']
],
[
'deu' => ['title' => 'Titel #2', 'body' => 'Inhalt #2', 'locale' => 'deu'],
'cze' => ['title' => 'Titulek #2', 'body' => 'Obsah #2', 'locale' => 'cze']
],
[
'deu' => ['title' => 'Titel #3', 'body' => 'Inhalt #3', 'locale' => 'deu'],
'cze' => ['title' => 'Titulek #3', 'body' => 'Obsah #3', 'locale' => 'cze']
]
];
$translations = $this->_extractTranslations($results);
$this->assertEquals($expected, $translations->toArray());
$expected = [
1 => ['First Article' => 'First Article Body'],
2 => ['Second Article' => 'Second Article Body'],
3 => ['Third Article' => 'Third Article Body']
];
$grouped = $results->combine('title', 'body', 'id');
$this->assertEquals($expected, $grouped->toArray());
}
/**
* Tests that it is possible to combine find('list') and find('translations')
*
* @return void
*/
public function testFindTranslationsList() {
$table = TableRegistry::get('Articles');
$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
$results = $table
->find('list', [
'idField' => 'title',
'valueField' => '_translations.deu.title',
'groupField' => 'id'
])
->find('translations', ['locales' => ['deu']]);
$expected = [
1 => ['First Article' => 'Titel #1'],
2 => ['Second Article' => 'Titel #2'],
3 => ['Third Article' => 'Titel #3']
];
$this->assertEquals($expected, $results->toArray());
}
/**
* Tests that you can both override fields and find all translations
*
* @return void
*/
public function testFindTranslationsWithFieldOverriding() {
$table = TableRegistry::get('Articles');
$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
$table->locale('cze');
$results = $table->find('translations', ['locales' => ['deu', 'cze']]);
$expected = [
[
'deu' => ['title' => 'Titel #1', 'body' => 'Inhalt #1', 'locale' => 'deu'],
'cze' => ['title' => 'Titulek #1', 'body' => 'Obsah #1', 'locale' => 'cze']
],
[
'deu' => ['title' => 'Titel #2', 'body' => 'Inhalt #2', 'locale' => 'deu'],
'cze' => ['title' => 'Titulek #2', 'body' => 'Obsah #2', 'locale' => 'cze']
],
[
'deu' => ['title' => 'Titel #3', 'body' => 'Inhalt #3', 'locale' => 'deu'],
'cze' => ['title' => 'Titulek #3', 'body' => 'Obsah #3', 'locale' => 'cze']
]
];
$translations = $this->_extractTranslations($results);
$this->assertEquals($expected, $translations->toArray());
$expected = [
1 => ['Titulek #1' => 'Obsah #1'],
2 => ['Titulek #2' => 'Obsah #2'],
3 => ['Titulek #3' => 'Obsah #3']
];
$grouped = $results->combine('title', 'body', 'id');
$this->assertEquals($expected, $grouped->toArray());
}
/**
* Tests that fields can be overriden in a hasMany association
*
* @return void
*/
public function testFindSingleLocaleHasMany() {
$table = TableRegistry::get('Articles');
$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
$table->hasMany('Comments');
$comments = $table->hasMany('Comments')->target();
$comments->addBehavior('Translate', ['fields' => ['comment']]);
$table->locale('eng');
$comments->locale('eng');
$results = $table->find()->contain(['Comments' => function($q) {
return $q->select(['id', 'comment', 'article_id']);
}]);
$list = new Collection($results->first()->comments);
$expected = [
1 => 'Comment #1',
2 => 'Comment #2',
3 => 'Comment #3',
4 => 'Comment #4'
];
$this->assertEquals($expected, $list->combine('id', 'comment')->toArray());
}
/**
* Test that it is possible to bring translations from hasMany relations
*
* @return void
*/
public function testTranslationsHasMany() {
$table = TableRegistry::get('Articles');
$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
$table->hasMany('Comments');
$comments = $table->hasMany('Comments')->target();
$comments->addBehavior('Translate', ['fields' => ['comment']]);
$results = $table->find('translations')->contain([
'Comments' => function($q) {
return $q->find('translations')->select(['id', 'comment', 'article_id']);
}
]);
$comments = $results->first()->comments;
$expected = [
[
'eng' => ['comment' => 'Comment #1', 'locale' => 'eng']
],
[
'eng' => ['comment' => 'Comment #2', 'locale' => 'eng']
],
[
'eng' => ['comment' => 'Comment #3', 'locale' => 'eng']
],
[
'eng' => ['comment' => 'Comment #4', 'locale' => 'eng'],
'spa' => ['comment' => 'Comentario #4', 'locale' => 'spa']
]
];
$translations = $this->_extractTranslations($comments);
$this->assertEquals($expected, $translations->toArray());
}
/**
* Tests that it is possible to both override fields with a translation and
* also find separately other translations
*
* @return void
*/
public function testTranslationsHasManyWithOverride() {
$table = TableRegistry::get('Articles');
$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
$table->hasMany('Comments');
$comments = $table->hasMany('Comments')->target();
$comments->addBehavior('Translate', ['fields' => ['comment']]);
$table->locale('cze');
$comments->locale('eng');
$results = $table->find('translations')->contain([
'Comments' => function($q) {
return $q->find('translations')->select(['id', 'comment', 'article_id']);
}
]);
$comments = $results->first()->comments;
$expected = [
1 => 'Comment #1',
2 => 'Comment #2',
3 => 'Comment #3',
4 => 'Comment #4'
];
$list = new Collection($comments);
$this->assertEquals($expected, $list->combine('id', 'comment')->toArray());
$expected = [
[
'eng' => ['comment' => 'Comment #1', 'locale' => 'eng']
],
[
'eng' => ['comment' => 'Comment #2', 'locale' => 'eng']
],
[
'eng' => ['comment' => 'Comment #3', 'locale' => 'eng']
],
[
'eng' => ['comment' => 'Comment #4', 'locale' => 'eng'],
'spa' => ['comment' => 'Comentario #4', 'locale' => 'spa']
]
];
$translations = $this->_extractTranslations($comments);
$this->assertEquals($expected, $translations->toArray());
$this->assertEquals('Titulek #1', $results->first()->title);
$this->assertEquals('Obsah #1', $results->first()->body);
}
}