TranslateBehaviorTest.php

<?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         3.0.0
 * @license       http://www.opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Test\TestCase\Model\Behavior;

use Cake\Collection\Collection;
use Cake\Event\Event;
use Cake\I18n\I18n;
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.translates',
		'core.articles',
		'core.comments',
		'core.authors'
	];

	public function tearDown() {
		parent::tearDown();
		I18n::locale(I18n::defaultLocale());
		TableRegistry::clear();
	}

/**
 * Returns an array with all the translations found for a set of records
 *
 * @param array|\Traversable $data
 * @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 fields from a translated model use the I18n class locale
 * and that it propogates to associated models
 *
 * @return void
 */
	public function testFindSingleLocaleAssociatedEnv() {
		I18n::locale('eng');

		$table = TableRegistry::get('Articles');
		$table->addBehavior('Translate', ['fields' => ['title', 'body']]);

		$table->hasMany('Comments');
		$table->Comments->addBehavior('Translate', ['fields' => ['comment']]);

		$results = $table->find()
			->select(['id', 'title', 'body'])
			->contain(['Comments' => ['fields' => ['article_id', 'comment']]])
			->hydrate(false)
			->toArray();

		$expected = [
			[
				'id' => 1,
				'title' => 'Title #1',
				'body' => 'Content #1',
				'comments' => [
					['article_id' => 1, 'comment' => 'Comment #1', '_locale' => 'eng'],
					['article_id' => 1, 'comment' => 'Comment #2', '_locale' => 'eng'],
					['article_id' => 1, 'comment' => 'Comment #3', '_locale' => 'eng'],
					['article_id' => 1, 'comment' => 'Comment #4', '_locale' => 'eng']
				],
				'_locale' => 'eng'
			],
			[
				'id' => 2,
				'title' => 'Title #2',
				'body' => 'Content #2',
				'comments' => [
					['article_id' => 2, 'comment' => 'First Comment for Second Article', '_locale' => 'eng'],
					['article_id' => 2, 'comment' => 'Second Comment for Second Article', '_locale' => 'eng']
				],
				'_locale' => 'eng'
			],
			[
				'id' => 3,
				'title' => 'Title #3',
				'body' => 'Content #3',
				'comments' => [],
				'_locale' => 'eng'
			]
		];
		$this->assertSame($expected, $results);

		I18n::locale('spa');

		$results = $table->find()
			->select(['id', 'title', 'body'])
			->contain(['Comments' => ['fields' => ['article_id', 'comment']]])
			->hydrate(false)
			->toArray();

		$expected = [
			[
				'id' => 1,
				'title' => 'First Article',
				'body' => 'First Article Body',
				'comments' => [
					['article_id' => 1, 'comment' => 'First Comment for First Article', '_locale' => 'spa'],
					['article_id' => 1, 'comment' => 'Second Comment for First Article', '_locale' => 'spa'],
					['article_id' => 1, 'comment' => 'Third Comment for First Article', '_locale' => 'spa'],
					['article_id' => 1, 'comment' => 'Comentario #4', '_locale' => 'spa']
				],
				'_locale' => 'spa'
			],
			[
				'id' => 2,
				'title' => 'Second Article',
				'body' => 'Second Article Body',
				'comments' => [
					['article_id' => 2, 'comment' => 'First Comment for Second Article', '_locale' => 'spa'],
					['article_id' => 2, 'comment' => 'Second Comment for Second Article', '_locale' => 'spa']
				],
				'_locale' => 'spa'
			],
			[
				'id' => 3,
				'title' => 'Third Article',
				'body' => 'Third Article Body',
				'comments' => [],
				'_locale' => 'spa'
			]
		];
		$this->assertSame($expected, $results);
	}

/**
 * Tests that fields from a translated model are not overriden if translation
 * is null
 *
 * @return void
 */
	public function testFindSingleLocaleWithNullTranslation() {
		$table = TableRegistry::get('Comments');
		$table->addBehavior('Translate', ['fields' => ['comment']]);
		$table->locale('spa');
		$results = $table->find()
			->where(['Comments.id' => 6])
			->combine('id', 'comment')->toArray();
		$expected = [6 => 'Second Comment for Second Article'];
		$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);
	}

/**
 * Tests that it is possible to translate belongsTo associations
 *
 * @return void
 */
	public function testFindSingleLocaleBelongsto() {
		$table = TableRegistry::get('Articles');
		$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
		$authors = $table->belongsTo('Authors')->target();
		$authors->addBehavior('Translate', ['fields' => ['name']]);

		$table->locale('eng');
		$authors->locale('eng');

		$results = $table->find()
			->select(['title', 'body'])
			->order(['title' => 'asc'])
			->contain(['Authors' => function ($q) {
				return $q->select(['id', 'name']);
			}]);

		$expected = [
			[
				'title' => 'Title #1',
				'body' => 'Content #1',
				'author' => ['id' => 1, 'name' => 'May-rianoh', '_locale' => 'eng'],
				'_locale' => 'eng'
			],
			[
				'title' => 'Title #2',
				'body' => 'Content #2',
				'author' => ['id' => 3, 'name' => 'larry', '_locale' => 'eng'],
				'_locale' => 'eng'
			],
			[
				'title' => 'Title #3',
				'body' => 'Content #3',
				'author' => ['id' => 1, 'name' => 'May-rianoh', '_locale' => 'eng'],
				'_locale' => 'eng'
			]
		];
		$results = array_map(function ($r) {
			return $r->toArray();
		}, $results->toArray());
		$this->assertEquals($expected, $results);
	}

/**
 * Tests that updating an existing record translations work
 *
 * @return void
 */
	public function testUpdateSingleLocale() {
		$table = TableRegistry::get('Articles');
		$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
		$table->locale('eng');
		$article = $table->find()->first();
		$this->assertEquals(1, $article->get('id'));
		$article->set('title', 'New translated article');
		$table->save($article);
		$this->assertNull($article->get('_i18n'));

		$article = $table->find()->first();
		$this->assertEquals(1, $article->get('id'));
		$this->assertEquals('New translated article', $article->get('title'));
		$this->assertEquals('Content #1', $article->get('body'));

		$table->locale(false);
		$article = $table->find()->first();
		$this->assertEquals(1, $article->get('id'));
		$this->assertEquals('First Article', $article->get('title'));

		$table->locale('eng');
		$article->set('title', 'Wow, such translated article');
		$article->set('body', 'A translated body');
		$table->save($article);
		$this->assertNull($article->get('_i18n'));

		$article = $table->find()->first();
		$this->assertEquals(1, $article->get('id'));
		$this->assertEquals('Wow, such translated article', $article->get('title'));
		$this->assertEquals('A translated body', $article->get('body'));
	}

/**
 * Tests adding new translation to a record
 *
 * @return void
 */
	public function testInsertNewTranslations() {
		$table = TableRegistry::get('Articles');
		$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
		$table->locale('fra');

		$article = $table->find()->first();
		$this->assertEquals(1, $article->get('id'));
		$article->set('title', 'Le titre');
		$table->save($article);
		$this->assertEquals('fra', $article->get('_locale'));

		$article = $table->find()->first();
		$this->assertEquals(1, $article->get('id'));
		$this->assertEquals('Le titre', $article->get('title'));
		$this->assertEquals('First Article Body', $article->get('body'));

		$article->set('title', 'Un autre titre');
		$article->set('body', 'Le contenu');
		$table->save($article);
		$this->assertNull($article->get('_i18n'));

		$article = $table->find()->first();
		$this->assertEquals('Un autre titre', $article->get('title'));
		$this->assertEquals('Le contenu', $article->get('body'));
	}

/**
 * Tests that it is possible to use the _locale property to specify the language
 * to use for saving an entity
 *
 * @return void
 */
	public function testUpdateTranslationWithLocaleInEntity() {
		$table = TableRegistry::get('Articles');
		$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
		$article = $table->find()->first();
		$this->assertEquals(1, $article->get('id'));
		$article->set('_locale', 'fra');
		$article->set('title', 'Le titre');
		$table->save($article);
		$this->assertNull($article->get('_i18n'));

		$article = $table->find()->first();
		$this->assertEquals(1, $article->get('id'));
		$this->assertEquals('First Article', $article->get('title'));
		$this->assertEquals('First Article Body', $article->get('body'));

		$table->locale('fra');
		$article = $table->find()->first();
		$this->assertEquals(1, $article->get('id'));
		$this->assertEquals('Le titre', $article->get('title'));
		$this->assertEquals('First Article Body', $article->get('body'));
	}

/**
 * Tests that translations are added to the whitelist of associations to be
 * saved
 *
 * @return void
 */
	public function testSaveTranslationWithAssociationWhitelist() {
		$table = TableRegistry::get('Articles');
		$table->hasMany('Comments');
		$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
		$table->locale('fra');

		$article = $table->find()->first();
		$this->assertEquals(1, $article->get('id'));
		$article->set('title', 'Le titre');
		$table->save($article, ['associated' => ['Comments']]);
		$this->assertNull($article->get('_i18n'));

		$article = $table->find()->first();
		$this->assertEquals('Le titre', $article->get('title'));
	}

/**
 * Tests that after deleting a translated entity, all translations are also removed
 *
 * @return void
 */
	public function testDelete() {
		$table = TableRegistry::get('Articles');
		$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
		$article = $table->find()->first();
		$this->assertTrue($table->delete($article));

		$translations = TableRegistry::get('I18n')->find()
			->where(['model' => 'Articles', 'foreign_key' => $article->id])
			->count();
		$this->assertEquals(0, $translations);
	}

/**
 * Tests saving multiple translations at once when the translations already
 * exist in the database
 *
 * @return void
 */
	public function testSaveMultipleTranslations() {
		$table = TableRegistry::get('Articles');
		$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
		$article = $results = $table->find('translations')->first();

		$translations = $article->get('_translations');
		$translations['deu']->set('title', 'Another title');
		$translations['eng']->set('body', 'Another body');
		$article->set('_translations', $translations);
		$table->save($article);
		$this->assertNull($article->get('_i18n'));

		$article = $results = $table->find('translations')->first();
		$translations = $article->get('_translations');
		$this->assertEquals('Another title', $translations['deu']->get('title'));
		$this->assertEquals('Another body', $translations['eng']->get('body'));
	}

/**
 * Tests saving multiple existing translations and adding new ones
 *
 * @return void
 */
	public function testSaveMultipleNewTranslations() {
		$table = TableRegistry::get('Articles');
		$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
		$article = $results = $table->find('translations')->first();

		$translations = $article->get('_translations');
		$translations['deu']->set('title', 'Another title');
		$translations['eng']->set('body', 'Another body');
		$translations['spa'] = new Entity(['title' => 'Titulo']);
		$translations['fre'] = new Entity(['title' => 'Titre']);
		$article->set('_translations', $translations);
		$table->save($article);
		$this->assertNull($article->get('_i18n'));

		$article = $results = $table->find('translations')->first();
		$translations = $article->get('_translations');
		$this->assertEquals('Another title', $translations['deu']->get('title'));
		$this->assertEquals('Another body', $translations['eng']->get('body'));
		$this->assertEquals('Titulo', $translations['spa']->get('title'));
		$this->assertEquals('Titre', $translations['fre']->get('title'));
	}

/**
 * Tests that iterating a resultset twice when using the translations finder
 * will not cause any errors nor information loss
 *
 * @return void
 */
	public function testUseCountInFindTranslations() {
		$table = TableRegistry::get('Articles');
		$table->addBehavior('Translate', ['fields' => ['title', 'body']]);
		$articles = $results = $table->find('translations');
		$all = $articles->all();
		$this->assertCount(3, $all);
		$article = $all->first();
		$this->assertNotEmpty($article->get('_translations'));
	}

}