Merge pull request #43 from AD7six/gitattributes

Maintainence

Author: AD7six

.gitattributes

@@ -0,0 +1,6 @@
+# Remove files for archives generated using `git archive`
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.travis.yml export-ignore
+tests

.travis.yml

@@ -1,10 +1,9 @@
 language: php
 
 php:
-  - 5.4
-  - 5.5
   - 5.6
   - 7.0
+  - 7.1
 
 sudo: false
 
@@ -23,25 +22,21 @@ matrix:
     - php: 7.0
       env: PHPCS=1 DEFAULT=0
 
-    - php: 5.6
-      env: COVERALLS=1 DEFAULT=0 DB=mysql db_dsn='mysql://[email protected]/cakephp_test'
-
-  allow_failures:
-    - env: COVERALLS=1 DEFAULT=0 DB=mysql db_dsn='mysql://[email protected]/cakephp_test'
-
 before_script:
+  - if [[ $TRAVIS_PHP_VERSION != 7.0 ]]; then phpenv config-rm xdebug.ini; fi
+
   - composer self-update
   - composer install --no-interaction --prefer-source
-  - sh -c "if [ '$DB' = 'mysql' ]; then mysql -e 'CREATE DATABASE cakephp_test;'; fi"
-  - sh -c "if [ '$DB' = 'pgsql' ]; then psql -c 'CREATE DATABASE cakephp_test;' -U postgres; fi"
-  - sh -c "if [ '$COVERALLS' = '1' ]; then composer require --dev satooshi/php-coveralls:dev-master; fi"
-  - sh -c "if [ '$COVERALLS' = '1' ]; then mkdir -p build/logs; fi"
+  - if [[ $DB = 'mysql' ]]; then mysql -e 'CREATE DATABASE cakephp_test;'; fi
+  - if [[ $DB = 'pgsql' ]]; then psql -c 'CREATE DATABASE cakephp_test;' -U postgres; fi
 
 script:
-  - sh -c "if [ '$DEFAULT' = '1' ]; then phpunit --stderr; fi"
-  - sh -c "if [ '$PHPCS' = '1' ]; then vendor/bin/phpcs -p -n --extensions=php --standard=vendor/cakephp/cakephp-codesniffer/CakePHP ./src ./tests; fi"
-  - sh -c "if [ '$COVERALLS' = '1' ]; then phpunit --stderr --coverage-clover build/logs/clover.xml; fi"
-  - sh -c "if [ '$COVERALLS' = '1' ]; then php vendor/bin/coveralls -c .coveralls.yml -v; fi"
+  - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION != 7.0 ]]; then vendor/bin/phpunit; fi
+  - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.0 ]]; then vendor/bin/phpunit --coverage-clover=clover.xml; fi
+  - if [[ $PHPCS = 1 ]]; then vendor/bin/phpcs -p -n --extensions=php --standard=vendor/cakephp/cakephp-codesniffer/CakePHP ./src ./tests; fi
+
+after_success:
+- if [[ $DEFAULT = 1 && $DB = 'mysql' && $TRAVIS_PHP_VERSION = 7.0 ]]; then bash <(curl -s https://codecov.io/bash); fi
 
 notifications:
   email: false

README.md

@@ -1,6 +1,7 @@
 # Shadow translate
 
 [![Build Status](https://img.shields.io/travis/AD7six/cakephp-shadow-translate/master.svg?style=flat-square)](https://travis-ci.org/AD7six/cakephp-shadow-translate)
+[![Coverage Status](https://img.shields.io/codecov/c/github/AD7six/cakephp-shadow-translate.svg?style=flat-square)](https://codecov.io/github/AD7six/cakephp-shadow-translate)
 [![Coverage Status](https://img.shields.io/coveralls/AD7six/cakephp-shadow-translate/master.svg?style=flat-square)](https://coveralls.io/r/AD7six/cakephp-shadow-translate)
 [![Total Downloads](https://img.shields.io/packagist/dt/ad7six/shadow-translate.svg?style=flat-square)](https://packagist.org/packages/ad7six/shadow-translate)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE.txt)
@@ -27,23 +28,23 @@ blog tutorial as a start point, the following table would already exist:
 
 ```sql
 CREATE TABLE posts (
-	id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
-	title VARCHAR(50),
-	body TEXT,
-	created DATETIME DEFAULT NULL,
-	modified DATETIME DEFAULT NULL
+    id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
+    title VARCHAR(50),
+    body TEXT,
+    created DATETIME DEFAULT NULL,
+    modified DATETIME DEFAULT NULL
 );
 ```
 
 To prepare for using the shadow translate behavior, the following table would be created:
 
 ```sql
 CREATE TABLE posts_translations (
-	id INT UNSIGNED,
-	locale VARCHAR(5),
-	title VARCHAR(50),
-	body TEXT,
-	PRIMARY KEY (id, locale)
+    id INT UNSIGNED,
+    locale VARCHAR(5),
+    title VARCHAR(50) DEFAULT NULL,
+    body TEXT DEFAULT NULL,
+    PRIMARY KEY (id, locale)
 );
 ```
 
@@ -56,9 +57,9 @@ Usage is very similar to the core's behavior so e.g.:
 ```php
 class PostsTable extends Table {
 
-	public function initialize(array $config) {
-		$this->addBehavior('ShadowTranslate.ShadowTranslate');
-	}
+    public function initialize(array $config) {
+        $this->addBehavior('ShadowTranslate.ShadowTranslate');
+    }
 }
 ```
 

composer.json

@@ -9,15 +9,14 @@
             "email": "[email protected]"
         }
     ],
-    "minimum-stability": "dev",
     "require": {
-        "cakephp/orm": "~3.0",
-        "cakephp/i18n": "~3.0"
+        "cakephp/orm": "^3.4.3",
+        "cakephp/i18n": "^3.4.3"
     },
     "require-dev": {
-        "phpunit/phpunit": "*",
-        "cakephp/cakephp": "~3.1",
-        "cakephp/cakephp-codesniffer": "dev-master"
+        "phpunit/phpunit": "<6.0",
+        "cakephp/cakephp": "^3.4.3",
+        "cakephp/cakephp-codesniffer": "~2.3"
     },
     "autoload": {
         "psr-4": {

phpunit.xml phpunit.xml.dist

@@ -29,13 +29,9 @@
 	</listeners>
 
 	<filter>
-		<blacklist>
-			<directory suffix=".php">./vendor/</directory>
-			<directory suffix=".ctp">./vendor/</directory>
-
-			<directory suffix=".php">./tests/</directory>
-			<directory suffix=".ctp">./tests/</directory>
-		</blacklist>
+		<whitelist>
+			<directory suffix=".php">./src/</directory>
+		</whitelist>
 	</filter>
 
 </phpunit>

src/Model/Behavior/ShadowTranslateBehavior.php

@@ -243,6 +243,7 @@ protected function _traverseClause(Query $query, $name = '', $config = [])
             if (in_array($field, $fields)) {
                 $joinRequired = true;
                 $expression->setField("$alias.$field");
+
                 return;
             }
 
@@ -269,20 +270,52 @@ public function beforeSave(Event $event, EntityInterface $entity, ArrayObject $o
         $newOptions = [$this->_translationTable->alias() => ['validate' => false]];
         $options['associated'] = $newOptions + $options['associated'];
 
+        // Check early if empty translations are present in the entity.
+        // If this is the case, unset them to prevent persistence.
+        // This only applies if $this->_config['allowEmptyTranslations'] is false
+        if ($this->_config['allowEmptyTranslations'] === false) {
+            $this->_unsetEmptyFields($entity);
+        }
+
         $this->_bundleTranslatedFields($entity);
         $bundled = $entity->get('_i18n') ?: [];
+        $noBundled = count($bundled) === 0;
 
-        if ($locale === $this->config('defaultLocale')) {
+        // No additional translation records need to be saved,
+        // as the entity is in the default locale.
+        if ($noBundled && $locale === $this->config('defaultLocale')) {
             return;
         }
+
         $values = $entity->extract($this->_translationFields(), true);
         $fields = array_keys($values);
+        $noFields = empty($fields);
 
-        if (empty($fields)) {
+        // If there are no fields and no bundled translations, or both fields
+        // in the default locale and bundled translations we can
+        // skip the remaining logic as its not necessary.
+        if ($noFields && $noBundled || ($fields && $bundled)) {
             return;
         }
+
         $primaryKey = (array)$this->_table->primaryKey();
         $id = $entity->get(current($primaryKey));
+
+        // When we have no key and bundled translations, we
+        // need to mark the entity dirty so the root
+        // entity persists.
+        if ($noFields && $bundled && !$id) {
+            foreach ($this->_translationFields() as $field) {
+                $entity->dirty($field, true);
+            }
+
+            return;
+        }
+
+        if ($noFields) {
+            return;
+        }
+
         $where = compact('id', 'locale');
 
         $translation = $this->_translationTable()->find()
@@ -314,6 +347,30 @@ public function beforeSave(Event $event, EntityInterface $entity, ArrayObject $o
         }
     }
 
+    /**
+     * Returns a fully aliased field name for translated fields.
+     *
+     * If the requested field is configured as a translation field, field with
+     * an alias of a corresponding association is returned. Table-aliased
+     * field name is returned for all other fields.
+     *
+     * @param string $field Field name to be aliased.
+     * @return string
+     */
+    public function translationField($field)
+    {
+        if ($this->locale() === $this->getConfig('defaultLocale')) {
+            return $this->_table->aliasField($field);
+        }
+
+        $translatedFields = $this->_translationFields();
+        if (in_array($field, $translatedFields)) {
+            return $this->config('hasOneAlias') . '.' . $field;
+        }
+
+        return $this->_table->aliasField($field);
+    }
+
     /**
      * Modifies the results from a table find in order to merge the translated fields
      * into each entity for a given locale.

tests/Fixture/ArticlesTranslationsFixture.php

@@ -17,7 +17,7 @@ class ArticlesTranslationsFixture extends TestFixture
     public $fields = [
         'id' => ['type' => 'integer'],
         'locale' => ['type' => 'string', 'null' => false],
-        'title' => ['type' => 'string', 'null' => false],
+        'title' => ['type' => 'string', 'null' => true],
         'body' => 'text',
         '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id', 'locale']]],
     ];

tests/Fixture/GroupsTranslationsFixture.php

@@ -0,0 +1,30 @@
+<?php
+namespace ShadowTranslate\Test\Fixture;
+
+use Cake\TestSuite\Fixture\TestFixture;
+
+/**
+ * Class GroupsTranslationsFixture
+ *
+ */
+class GroupsTranslationsFixture extends TestFixture
+{
+    /**
+     * fields property
+     *
+     * @var array
+     */
+    public $fields = [
+        'id' => ['type' => 'integer'],
+        'locale' => ['type' => 'string', 'null' => false],
+        'title' => ['type' => 'string'],
+        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id', 'locale']]],
+    ];
+
+    /**
+     * records property
+     *
+     * @var array
+     */
+    public $records = [];
+}

tests/Fixture/SpecialTagsTranslationsFixture.php

@@ -0,0 +1,32 @@
+<?php
+namespace ShadowTranslate\Test\Fixture;
+
+use Cake\TestSuite\Fixture\TestFixture;
+
+/**
+ * Class SpecialTagsTranslationsFixture
+ */
+class SpecialTagsTranslationsFixture extends TestFixture
+{
+
+    /**
+     * fields property
+     *
+     * @var array
+     */
+    public $fields = [
+        'id' => ['type' => 'integer'],
+        'locale' => ['type' => 'string', 'null' => false],
+        'extra_info' => ['type' => 'string'],
+        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id', 'locale']]],
+    ];
+
+    /**
+     * records property
+     *
+     * @var array
+     */
+    public $records = [
+        ['id' => 2, 'locale' => 'eng', 'extra_info' => 'Translated Info'],
+    ];
+}