Issue 78 refactor translator

.travis.yml

@@ -46,7 +46,7 @@ before_install:
   - mkdir -p ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d
   - if [ -f build/travis/php/$TRAVIS_PHP_VERSION.sh]; then ./build/travis/php/$TRAVIS_PHP_VERSION.sh; fi
   - if [[ "$PHP" != hhvm* ]]; then composer global require hirak/prestissimo; fi # Now composer can install components parallel
-  - if [[ "$HUMBUG" = "true" ]]; then composer require humbug/humbug; fi
+  - if [[ "$HUMBUG" = "true" ]]; then composer global require humbug/humbug; fi
   - git config --global user.name travis-ci
   - git config --global user.email travis@example.com
 

composer.json

@@ -11,7 +11,8 @@
         "viserio",
         "container",
         "pipeline",
-        "event"
+        "event",
+        "translation"
     ],
     "license"    : "MIT",
     "homepage"   : "https://github.com/narrowspark/framework",
@@ -124,6 +125,7 @@
         "roave/security-advisories"                          : "dev-master",
         "symfony/yaml"                                       : "^3.1",
         "spatie/array-to-xml"                                : "^2.1",
+        "sepia/po-parser"                                    : "^4.2",
         "yosymfony/toml"                                     : "^0.3"
     },
     "autoload": {

phpunit.xml.dist

@@ -100,9 +100,9 @@
         <testsuite name="Narrowspark Support Component Test Suite">
             <directory>./src/Viserio/Support/Tests</directory>
         </testsuite>
-<!--        <testsuite name="Narrowspark Translator Component Test Suite">
-            <directory>./src/Viserio/Translator/Tests</directory>
-        </testsuite> -->
+       <testsuite name="Narrowspark Translation Component Test Suite">
+            <directory>./src/Viserio/Translation/Tests</directory>
+        </testsuite>
 <!--         <testsuite name="Narrowspark View Component Test Suite">
             <directory>./src/Viserio/View/Tests</directory>
         </testsuite> -->

src/Viserio/Cache/CacheManager.php

@@ -1,16 +1,18 @@
 <?php
 namespace Viserio\Cache;
 
-use Cache\Adapter\Apc\ApcCachePool;
-use Cache\Adapter\Apcu\ApcuCachePool;
-use Cache\Adapter\Filesystem\FilesystemCachePool;
-use Cache\Adapter\Memcache\MemcacheCachePool;
-use Cache\Adapter\Memcached\MemcachedCachePool;
-use Cache\Adapter\MongoDB\MongoDBCachePool;
-use Cache\Adapter\PHPArray\ArrayCachePool;
-use Cache\Adapter\Predis\PredisCachePool;
-use Cache\Adapter\Redis\RedisCachePool;
-use Cache\Adapter\Void\VoidCachePool;
+use Cache\Adapter\{
+    Apc\ApcCachePool,
+    Apcu\ApcuCachePool,
+    Filesystem\FilesystemCachePool,
+    Memcache\MemcacheCachePool,
+    Memcached\MemcachedCachePool,
+    MongoDB\MongoDBCachePool,
+    PHPArray\ArrayCachePool,
+    Predis\PredisCachePool,
+    Redis\RedisCachePool,
+    Void\VoidCachePool
+};
 use League\Flysystem\Adapter\Local;
 use League\Flysystem\Filesystem as Flysystem;
 use Memcache;

src/Viserio/Config/Manager.php

@@ -3,9 +3,11 @@
 
 use ArrayIterator;
 use IteratorAggregate;
-use Viserio\Contracts\Config\Manager as ManagerContract;
-use Viserio\Contracts\Config\Repository as RepositoryContract;
-use Viserio\Contracts\Parsers\Loader as LoaderContract;
+use Viserio\Contracts\{
+    Config\Manager as ManagerContract,
+    Config\Repository as RepositoryContract,
+    Parsers\Loader as LoaderContract
+};
 
 class Manager implements ManagerContract, IteratorAggregate
 {
@@ -19,7 +21,7 @@ class Manager implements ManagerContract, IteratorAggregate
     /**
      * Fileloader instance.
      *
-     * @var \Viserio\Contracts\Config\Loader
+     * @var \Viserio\Contracts\Parsers\Loader
      */
     protected $loader;
 
@@ -61,38 +63,16 @@ public function __call(string $method, array $params = [])
      * Set Viserio's defaults using the repository.
      *
      * @param array $array
-     */
-    public function setArray(array $array): ManagerContract
-    {
-        $this->repository->setArray($array);
-
-        return $this;
-    }
-
-    /**
-     * Get the configuration loader.
-     *
-     * @param \Viserio\Contracts\Parsers\Loader $loader
      *
      * @return self
      */
-    public function setLoader(LoaderContract $loader): ManagerContract
+    public function setArray(array $array): ManagerContract
     {
-        $this->loader = $loader;
+        $this->repository->setArray($array);
 
         return $this;
     }
 
-    /**
-     * Get the configuration loader.
-     *
-     * @return \Viserio\Contracts\Parsers\Loader
-     */
-    public function getLoader(): LoaderContract
-    {
-        return $this->loader;
-    }
-
     /**
      * Import configuation from file.
      * Can be grouped together.
@@ -209,4 +189,28 @@ public function getIterator(): ArrayIterator
     {
         return $this->repository->getIterator();
     }
+
+    /**
+     * Set the file loader.
+     *
+     * @param \Viserio\Contracts\Parsers\Loader $loader
+     *
+     * @return self
+     */
+    public function setLoader(LoaderContract $loader)
+    {
+        $this->loader = $loader;
+
+        return $this;
+    }
+
+    /**
+     * Get the file loader.
+     *
+     * @return \Viserio\Contracts\Parsers\Loader
+     */
+    public function getLoader()
+    {
+        return $this->loader;
+    }
 }

src/Viserio/Config/Tests/ConfigManagerTest.php

@@ -16,7 +16,7 @@ class ConfigManagerTest extends \PHPUnit_Framework_TestCase
     private $root;
 
     /**
-     * @var \Viserio\Filesystem\FileLoader
+     * @var \Viserio\Parsers\FileLoader
      */
     private $fileloader;
 

src/Viserio/Config/composer.json

@@ -20,8 +20,7 @@
     "require": {
         "php"                             : "7.0.0 - 7.0.5 || ^7.0.7",
         "narrowspark/arr"                 : "^1.0",
-        "viserio/cotracts"                : "self.version",
-        "viserio/support"                 : "self.version"
+        "viserio/cotracts"                : "self.version"
     },
     "require-dev": {
         "phpunit/phpunit"                 : "^5.1",

src/Viserio/Contracts/Translator/NotFoundResourceException.php → src/Viserio/Contracts/Translation/Exception/NotFoundResourceException.php

@@ -1,5 +1,5 @@
 <?php
-namespace Viserio\Contracts\Translator;
+namespace Viserio\Contracts\Translation\Exception;
 
 use InvalidArgumentException;
 

src/Viserio/Contracts/Translator/MessageCatalogue.php → src/Viserio/Contracts/Translation/MessageCatalogue.php

@@ -1,5 +1,5 @@
 <?php
-namespace Viserio\Contracts\Translator;
+namespace Viserio\Contracts\Translation;
 
 interface MessageCatalogue
 {
@@ -34,8 +34,10 @@ public function all(string $domain = null): array;
      * @param string $id          The message id
      * @param string $translation The messages translation
      * @param string $domain      The domain name
+     *
+     * @return void
      */
-    public function set($id, string $translation, string $domain = 'messages');
+    public function set(string $id, string $translation, string $domain = 'messages');
 
     /**
      * Checks if a message has a translation.
@@ -72,14 +74,28 @@ public function get(string $id, string $domain = 'messages'): string;
      *
      * @param array  $messages An array of translations
      * @param string $domain   The domain name
+     *
+     * @return void
      */
     public function replace(array $messages, string $domain = 'messages');
 
+    /**
+     * Removes a record.
+     *
+     * @param string $messages
+     * @param string $domain
+     *
+     * @return void
+     */
+    public function remove(string $messages, string $domain = 'messages');
+
     /**
      * Adds translations for a given domain.
      *
      * @param array  $messages An array of translations
      * @param string $domain   The domain name
+     *
+     * @return void
      */
     public function add(array $messages, string $domain = 'messages');
 
@@ -89,6 +105,10 @@ public function add(array $messages, string $domain = 'messages');
      * The two catalogues must have the same locale.
      *
      * @param MessageCatalogue $catalogue A MessageCatalogue instance
+     *
+     * @throws \LogicException
+     *
+     * @return void
      */
     public function addCatalogue(MessageCatalogue $catalogue);
 
@@ -99,6 +119,10 @@ public function addCatalogue(MessageCatalogue $catalogue);
      * This is used to provide default translations when they do not exist for the current locale.
      *
      * @param MessageCatalogue $catalogue A MessageCatalogue instance
+     *
+     * @throws \LogicException
+     *
+     * @return void
      */
     public function addFallbackCatalogue(MessageCatalogue $catalogue);
 
@@ -108,4 +132,13 @@ public function addFallbackCatalogue(MessageCatalogue $catalogue);
      * @return MessageCatalogue|null A MessageCatalogue instance or null when no fallback has been set
      */
     public function getFallbackCatalogue();
+
+    /**
+     * Set parent.
+     *
+     * @param MessageCatalogue $parent
+     *
+     * @return self
+     */
+    public function setParent(MessageCatalogue $parent): MessageCatalogue;
 }

src/Viserio/Contracts/Translation/PluralCategory.php

@@ -0,0 +1,14 @@
+<?php
+namespace Viserio\Contracts\Translation;
+
+interface PluralCategory
+{
+    /**
+     * Returns category key by count.
+     *
+     * @param int|string $count
+     *
+     * @return int
+     */
+    public function category($count): int;
+}

src/Viserio/Contracts/Translation/TransChecker.php

@@ -0,0 +1,33 @@
+<?php
+namespace Viserio\Contracts\Translation;
+
+interface TransChecker
+{
+    /**
+     * Get the default locale being used.
+     *
+     * @return string
+     */
+    public function getDefaultLocale(): string;
+
+    /**
+     * Get the locales to check.
+     *
+     * @return array
+     */
+    public function getLocales(): array;
+
+    /**
+     * Get the ignored translation attributes.
+     *
+     * @return array
+     */
+    public function getIgnoredTranslations(): array;
+
+    /**
+     * Check the missing translations.
+     *
+     * @return array
+     */
+    public function check(): array;
+}