From 948b44ee1e90773ba11d00cb2d348224ee11bc97 Mon Sep 17 00:00:00 2001 From: Alexis Degrugillier Date: Sat, 10 Mar 2018 16:23:00 +0100 Subject: Change code to be more robust The code doesn't rely on positionnal arguments anymore. It uses options. I've added some check to validate that the action performed are configured properly. --- cli/manipulate.translation.php | 102 ++++++++++++++++++++++++----------------- 1 file changed, 60 insertions(+), 42 deletions(-) (limited to 'cli') diff --git a/cli/manipulate.translation.php b/cli/manipulate.translation.php index 0e06993ef..19b229878 100644 --- a/cli/manipulate.translation.php +++ b/cli/manipulate.translation.php @@ -1,13 +1,13 @@ load(); -switch ($argv[1]) { - case 'add_language' : - $i18nData->addLanguage($argv[2]); - break; - case 'add_key' : - if (3 === $argc) { - help(); +switch ($options['a']) { + case 'add' : + if (array_key_exists('k', $options) && array_key_exists('v', $options) && array_key_exists('l', $options)) { + $i18nData->addValue($options['k'], $options['v'], $options['l']); + } elseif (array_key_exists('k', $options) && array_key_exists('v', $options)) { + $i18nData->addKey($options['k'], $options['v']); + } elseif (array_key_exists('l', $options)) { + $i18nData->addLanguage($options['l']); + } else { + error('You need to specify a valid set of options.'); } - $i18nData->addKey($argv[2], $argv[3]); break; - case 'add_value': - if (4 === $argc) { - help(); + case 'delete' : + if (array_key_exists('k', $options)) { + $i18nData->removeKey($options['k']); + } else { + error('You need to specify the key to delete.'); } - $i18nData->addValue($argv[2], $argv[3], $argv[4]); - break; - case 'duplicate_key' : - $i18nData->duplicateKey($argv[2]); break; - case 'delete_key' : - $i18nData->removeKey($argv[2]); + case 'duplicate' : + if (array_key_exists('k', $options)) { + $i18nData->duplicateKey($options['k']); + } else { + error('You need to specify the key to duplicate'); + } break; case 'format' : $i18nFile->dump($i18nData); @@ -48,47 +52,61 @@ if ($i18nData->hasChanged()) { $i18nFile->dump($i18nData); } +/** + * Output error message. + */ +function error($message) { + $error = << Date: Sat, 10 Mar 2018 16:32:35 +0100 Subject: Improve error catching --- cli/i18n/I18nData.php | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'cli') diff --git a/cli/i18n/I18nData.php b/cli/i18n/I18nData.php index b8f958288..77e0e2993 100644 --- a/cli/i18n/I18nData.php +++ b/cli/i18n/I18nData.php @@ -49,7 +49,8 @@ class I18nData { * @throws Exception */ public function addKey($key, $value) { - if (array_key_exists($key, $this->data[static::REFERENCE_LANGUAGE][$this->getFilenamePrefix($key)])) { + if (array_key_exists($this->getFilenamePrefix($key), $this->data[static::REFERENCE_LANGUAGE]) && + array_key_exists($key, $this->data[static::REFERENCE_LANGUAGE][$this->getFilenamePrefix($key)])) { throw new Exception('The selected key already exist.'); } $this->data[static::REFERENCE_LANGUAGE][$this->getFilenamePrefix($key)][$key] = $value; @@ -67,7 +68,8 @@ class I18nData { if (!in_array($language, $this->getAvailableLanguages())) { throw new Exception('The selected language does not exist.'); } - if (!array_key_exists($key, $this->data[static::REFERENCE_LANGUAGE][$this->getFilenamePrefix($key)])) { + if (!array_key_exists($this->getFilenamePrefix($key), $this->data[static::REFERENCE_LANGUAGE]) || + !array_key_exists($key, $this->data[static::REFERENCE_LANGUAGE][$this->getFilenamePrefix($key)])) { throw new Exception('The selected key does not exist for the selected language.'); } $this->data[$language][$this->getFilenamePrefix($key)][$key] = $value; @@ -80,7 +82,8 @@ class I18nData { * @throws Exception */ public function duplicateKey($key) { - if (!array_key_exists($key, $this->data[static::REFERENCE_LANGUAGE][$this->getFilenamePrefix($key)])) { + if (!array_key_exists($this->getFilenamePrefix($key), $this->data[static::REFERENCE_LANGUAGE]) || + !array_key_exists($key, $this->data[static::REFERENCE_LANGUAGE][$this->getFilenamePrefix($key)])) { throw new Exception('The selected key does not exist.'); } $value = $this->data[static::REFERENCE_LANGUAGE][$this->getFilenamePrefix($key)][$key]; @@ -102,7 +105,8 @@ class I18nData { * @throws Exception */ public function removeKey($key) { - if (!array_key_exists($key, $this->data[static::REFERENCE_LANGUAGE][$this->getFilenamePrefix($key)])) { + if (!array_key_exists($this->getFilenamePrefix($key), $this->data[static::REFERENCE_LANGUAGE]) || + !array_key_exists($key, $this->data[static::REFERENCE_LANGUAGE][$this->getFilenamePrefix($key)])) { throw new Exception('The selected key does not exist.'); } foreach ($this->getAvailableLanguages() as $language) { -- cgit v1.2.3 From f4da01294023146cd1f4bc13f1ba5f77702bb41b Mon Sep 17 00:00:00 2001 From: Alexis Degrugillier Date: Sun, 11 Mar 2018 10:53:32 +0100 Subject: Add option to ignore keys in cli tool --- cli/i18n/I18nData.php | 24 ++++++++++++++++ cli/i18n/I18nFile.php | 4 ++- cli/i18n/I18nFileInterface.php | 10 +++++++ cli/i18n/I18nIgnoreFile.php | 64 ++++++++++++++++++++++++++++++++++++++++++ cli/manipulate.translation.php | 26 +++++++++++++---- 5 files changed, 122 insertions(+), 6 deletions(-) create mode 100644 cli/i18n/I18nFileInterface.php create mode 100644 cli/i18n/I18nIgnoreFile.php (limited to 'cli') diff --git a/cli/i18n/I18nData.php b/cli/i18n/I18nData.php index 77e0e2993..2178d330d 100644 --- a/cli/i18n/I18nData.php +++ b/cli/i18n/I18nData.php @@ -116,6 +116,30 @@ class I18nData { } } + /** + * WARNING! This is valid only for ignore files. It's not the best way to + * handle that but as it's meant to be used only for the cli tool, there + * is no point of spending time on making it better than that. + * + * Ignore a key from a language, or reverse it. + * + * @param string $key + * @param string $language + * @param boolean $reverse + */ + public function ignore($key, $language, $reverse = false) { + $index = array_search($key, $this->data[$language]); + + if ($index && $reverse) { + unset($this->data[$language][$index]); + return; + } + if ($index && !$reverse) { + return; + } + $this->data[$language][] = $key; + } + /** * Check if the data has changed * diff --git a/cli/i18n/I18nFile.php b/cli/i18n/I18nFile.php index a07efdf88..bdcf3c079 100644 --- a/cli/i18n/I18nFile.php +++ b/cli/i18n/I18nFile.php @@ -1,8 +1,9 @@ i18nPath); foreach ($dirs as $dir) { if ($dir->isDot()) { diff --git a/cli/i18n/I18nFileInterface.php b/cli/i18n/I18nFileInterface.php new file mode 100644 index 000000000..c5aaf9fcd --- /dev/null +++ b/cli/i18n/I18nFileInterface.php @@ -0,0 +1,10 @@ +i18nPath = __DIR__ . '/ignore'; + } + + public function dump(I18nData $i18n) { + foreach ($i18n->getData() as $language => $content) { + $filename = $this->i18nPath . DIRECTORY_SEPARATOR . $language . '.php'; + file_put_contents($filename, $this->format($content)); + } + } + + public function load() { + $i18n = array(); + $files = new DirectoryIterator($this->i18nPath); + foreach ($files as $file) { + if (!$file->isFile()) { + continue; + } + $i18n[$file->getBasename('.php')] = (include $file->getPathname()); + } + + return new I18nData($i18n); + } + + /** + * Format an array of translation + * + * It takes an array of translation and format it to be dumped in a + * translation file. The array is first converted to a string then some + * formatting regexes are applied to match the original content. + * + * @param array $translation + * @return string + */ + private function format($translation) { + $translation = var_export(($translation), true); + $patterns = array( + '/array \(/', + '/=>\s*array/', + '/ {2}/', + '/\d+ => /', + ); + $replacements = array( + 'array(', + '=> array', + "\t", // Double quoting is mandatory to have a tab instead of the \t string + '', + ); + $translation = preg_replace($patterns, $replacements, $translation); + + // Double quoting is mandatory to have new lines instead of \n strings + return sprintf("load(); switch ($options['a']) { @@ -44,6 +48,13 @@ switch ($options['a']) { case 'format' : $i18nFile->dump($i18nData); break; + case 'ignore' : + if (array_key_exists('l', $options) && array_key_exists('k', $options)) { + $i18nData->ignore($options['k'], $options['l'], array_key_exists('r', $options)); + } else { + error('You need to specify a valid set of options.'); + } + break; default : help(); } @@ -80,7 +91,7 @@ DESCRIPTION -a=ACTION select the action to perform. Available actions are add, delete, - duplicate, and format. This option is mandatory. + duplicate, format, and ignore. This option is mandatory. -k=KEY select the key to work on. -v=VAL select the value to set. -l=LANG select the language to work on. @@ -105,6 +116,11 @@ Exemple 5: duplicate a key. It duplicates the key from the referential in every Exemple 6: format i18n files. php %1\$s -a format +Exemple 7: ignore a key. It adds the key in the ignore file to mark it as translated. + php %1\$s -a ignore -k my_key -l my_lang + +Exemple 8: revert ignore a key. It removes the key from the ignore file. + php %1\$s -a ignore -r -k my_key -l my_lang\n\n HELP; $file = str_replace(__DIR__ . '/', '', __FILE__); echo sprintf($help, $file); -- cgit v1.2.3