import command refactor

Author: adammatysiak

README.md

@@ -1,3 +1,5 @@
+![Laravel-Lang-Import-Export by HighSolutions](https://raw.githubusercontent.com/highsolutions/laravel-lang-import-export/master/intro.jpg)
+
 Laravel-Lang-Import-Export
 ==========================
 
@@ -69,32 +71,65 @@ The package currently provides two commands, one for exporting the files and one
 
 ```bash
 php artisan lang:export
-php artisan lang:export en * --output=export
-php artisan lang:export en auth --A --X
+php artisan lang:export en * path/to/export
+php artisan lang:export en auth -A -X
 ```
 
-When you call command without parameters, export file will be generated for all localization files within default locale. But you can define **locale** explicitly. You can also export only one file (second parameter - **group**).
+When you call command without parameters, export file will be generated for all localization files within default locale. But you can define **locale** explicitly. You can also export only one file (second parameter - **group**) and define where to store file (you can provide name with and without .csv extension). When you use **output** argument, default path is base_path() -> catalog of your whole project.
 But there is few more useful parameters:
 
-| name of parameter | description                              | is required? | default value                      |
-|-------------------|------------------------------------------|--------------|------------------------------------|
-| locale            | The locale to be exported                | NO           | default lang of application        |
-| group             | The name of translation file to export   | NO           | \* - all files                     |
-| --O / --output    | Filename of exported translation files   | NO           | storage/app/lang-import-export.csv |
-| --A / --append    | Append name of group to the name of file | NO           | empty                              |
-| --X / --excel     | Set file encoding for Excel              | NO           | UTF-8                              |
-| --D / --delimiter | Field delimiter                          | NO           | ,                                  |
-| --E / --enclosure | Field enclosure                          | NO           | "                                  |
+| name of parameter | description                             | is required? | default value                      |
+|-------------------|-----------------------------------------|--------------|------------------------------------|
+| locale           | The locale to be exported                | NO           | default lang of application        |
+| group            | The name of translation file to export   | NO           | \* - all files                     |
+| output           | Filename of exported translation files   | NO           | storage/app/lang-import-export.csv |
+| -A / --append    | Append name of group to the name of file | NO           | empty                              |
+| -X / --excel     | Set file encoding (UTF-16) for Excel     | NO           | UTF-8                              |
+| -D / --delimiter | Field delimiter                          | NO           | ,                                  |
+| -E / --enclosure | Field enclosure                          | NO           | "                                  |
 
 ### Import
 
 ```
-php artisan lang-import:csv en auth /path/to/file
-php artisan lang-import:csv --delimiter=";" --enclosure='"' --escape='\\' en_US auth /some/file
+php artisan lang:import
+php artisan lang:import en * path/to/import
+php artisan lang:import en auth -X
 ```
 
-You have to pass  the __locale__, the __group__ and the __path to the CSV file__ as arguments. The group is the name of the langauge file without its extension. When you exported all files, write *. You may define options to match the CSV format of your input file.
+When you call command without parameters - it will try to read default file of export command without parameters for default locale and all localization files. You can of course specify all parameters (**locale**, **group**, **input**) and there is few more options:
+
+| name of parameter | description                                  | is required? | default value                      |
+|-------------------|----------------------------------------------|--------------|------------------------------------|
+| locale            | The locale to be imported                    | NO           | default lang of application        |
+| group             | The name of translation file to import       | NO           | * - all files                      |
+| output            | Filename of translation files to be imported | NO           | storage/app/lang-import-export.csv |
+| -X / --excel      | Set file encoding from Excel                 | NO           | UTF-8                              |
+| -D / --delimiter  | Field delimiter                              | NO           | ,                                  |
+| -E / --enclosure  | Field enclosure                              | NO           | "                                  |
+| -C / --escape     | Field escape                                 | NO           | \                                  |
+
+Changelog
+------------
+5.4.1
+- improved Excel support
+- support of [LaravelLocalization](https://github.com/mcamara/laravel-localization) routes files
+
+5.4.0
+- refactor whole repository
+- add support for Excel
+- add support for export and import all localization files
+- any arguments are not required
 
-### Credits
+Roadmap
+------------
+
+* Option for deleting export file after importing.
+* Option for excluding certain files (and system ones).
+* Unit tests!
+
+Credits
+------------
 
 This package was originally created by [UFirst](http://github.com/ufirstgroup) and is available here: [Laravel-lang-import-export](https://github.com/ufirstgroup/laravel-lang-import-export).
+
+Currently is developed by [HighSolutions](http://highsolutions.pl), software house from Poland in love in Laravel.

composer.json

@@ -14,7 +14,7 @@
     ],
     "license": "MIT",
     "require": {
-        "php": ">=5.4.0",
+        "php": ">=5.6.4",
         "illuminate/support": "~5.1"
     },
     "autoload": {

intro.jpg

@@ -16,9 +16,9 @@ class ExportToCsvCommand extends Command
      * @var string
      */
     protected $signature = 'lang:export 
-    						{locale : The locale to be exported (default - default lang of application).} 
-    						{group : The name of translation file to export (default - all files).} 
-    						{--O|output= : Filename of file to store exported translation files (optional, default - storage/app/lang-import-export.csv).} 
+    						{locale? : The locale to be exported (default - default lang of application).} 
+    						{group? : The name of translation file to export (default - all files).} 
+    						{output? : Filename of exported translation files (optional, default - storage/app/lang-import-export.csv).} 
     						{--A|append : Append name of group to the name of file (optional, default - empty).}
     						{--X|excel : Set file encoding for Excel (optional, default - UTF-8).}
     						{--D|delimiter=, : Field delimiter (optional, default - ",").} 
@@ -29,7 +29,7 @@ class ExportToCsvCommand extends Command
 	 *
 	 * @var string
 	 */
-	protected $description = "Exports the language files to CSV file.";
+	protected $description = "Exports the language files to CSV file";
 
 	/**
 	 * Parameters provided to command.
@@ -60,7 +60,7 @@ class ExportToCsvCommand extends Command
 	public function __construct()
 	{
 		parent::__construct();
-		$this->defaultPath = storage_path('app'. DIRECTORY_SEPARATOR .'lang-import-export');
+		$this->defaultPath = storage_path('app'. DIRECTORY_SEPARATOR .'lang-import-export') . $this->ext;
 	}
 
 	/**
@@ -90,8 +90,8 @@ private function getParameters()
 	{
 		$this->parameters = [
 			'group' => $this->argument('group'),
-			'locale' => $this->argument('locale') === false ? config('app.locale') : $this->argument('locale'),
-			'output' => $this->option('output') === false ? $this->defaultPath : base_path($this->option('output')),
+			'locale' => $this->argument('locale') === null ? config('app.locale') : $this->argument('locale'),
+			'output' => $this->argument('output') === null ? $this->defaultPath : base_path($this->argument('output')),
 			'append' => $this->option('append') !== false,
 			'excel' => $this->option('excel') !== false,
 			'delimiter' => $this->option('delimiter'),
@@ -122,7 +122,7 @@ private function setDefaultPath()
 	private function sayItsBeginning()
 	{
 		$this->info(PHP_EOL
-			. 'Translations export of '. ($this->parameters['group'] === false ? 'all groups' : $this->parameters['group'] .' group') .' has started.');
+			. 'Translations export of '. ($this->parameters['group'] === null ? 'all groups' : $this->parameters['group'] .' group') .' - started.');
 	}
 
 	/**
@@ -156,7 +156,10 @@ private function saveTranslations($translations)
 	 */
 	private function openFile()
 	{
-		if (!($output = fopen($this->parameters['output'] . $this->ext, 'w'))) {
+		if(substr($this->parameters['output'], -4) != $this->ext)
+			$this->parameters['output'] .= $this->ext;
+
+		if (!($output = fopen($this->parameters['output'], 'w'))) {
 			$output = fopen($this->defaultPath . $this->ext, 'w');
 		}
 		return $output;
@@ -217,8 +220,8 @@ private function closeFile($output)
 	 */
 	private function adjustToExcel()
 	{
-		$data = file_get_contents($this->parameters['output'] . $this->ext);
-		file_put_contents($this->parameters['output'] . $this->ext, chr(255) . chr(254) . mb_convert_encoding($data, 'UTF-16LE', 'UTF-8'));		
+		$data = file_get_contents($this->parameters['output']);
+		file_put_contents($this->parameters['output'], chr(255) . chr(254) . mb_convert_encoding($data, 'UTF-16LE', 'UTF-8'));		
 	}
 
 	/**
@@ -228,7 +231,7 @@ private function adjustToExcel()
 	 */
 	private function sayItsFinish()
 	{
-		$this->info('Finished! Translations saved to: '. (substr($this->parameters['output'], strlen(base_path()) + 1)) . $this->ext 
+		$this->info('Finished! Translations saved to: '. (substr($this->parameters['output'], strlen(base_path()) + 1))  
 			. PHP_EOL);
 	}
 

src/HighSolutions/LangImportExport/Console/ExportToCsvCommand.php

@@ -16,12 +16,13 @@ class ImportFromCsvCommand extends Command
      * @var string
      */
 	protected $signature = 'lang:import
-							{locale : The locale to be imported (default - default lang of application).} 
-    						{group : The name of translation file to imported (default - all files).} 
-    						{--I|input= : Filename of file to be imported with translation files(optional, default - storage/app/lang-import-export.csv).} 
+							{locale? : The locale to be imported (default - default lang of application).} 
+    						{group? : The name of translation file to imported (default - all files).} 
+    						{input? : Filename of file to be imported with translation files(optional, default - storage/app/lang-import-export.csv).} 
     						{--D|delimiter=, : Field delimiter (optional, default - ",").} 
     						{--E|enclosure=" : Field enclosure (optional, default - \'"\').} 
-    						{--C|escape=\\" : Field excape (optional, default - \'\\\').}';
+    						{--C|escape=" : Field escape (optional, default - \'"\').}
+    						{--X|excel : Set file encoding from Excel (optional, default - UTF-8).}';
 
 	/**
 	 * The console command description.
@@ -88,13 +89,17 @@ public function handle()
 	private function getParameters()
 	{
 		$this->parameters = [
+			'locale' => $this->argument('locale') === null ? config('app.locale') : $this->argument('locale'),
 			'group' => $this->argument('group'),
-			'locale' => $this->argument('locale') === false ? config('app.locale') : $this->argument('locale'),
-			'input' => $this->option('input') === false ? $this->defaultPath : base_path($this->option('input')),
+			'input' => $this->argument('input') === null ? $this->defaultPath : base_path($this->argument('input')),
 			'delimiter' => $this->option('delimiter'),
 			'enclosure' => $this->option('enclosure'),
 			'escape' => $this->option('escape'),
+			'excel' => $this->option('excel') !== false,
 		];	
+
+		if(substr($this->parameters['input'], -4) != $this->ext)
+			$this->parameters['input'] .= $this->ext;
 	}
 
 	/**
@@ -115,34 +120,84 @@ private function sayItsBeginning()
 	 */
 	private function getTranslations()
 	{
-		$translations = [];
+		$input = $this->openFile();
+
+		$translations = $this->readFile($input);
 
-		// Create output device and write CSV.
-		if (($input_fp = fopen($this->parameters['input'], 'r')) === false) {
+		$this->closeFile($input);
+
+		return $translations;
+	}
+
+	/**
+	 * Opens file to read content.
+	 * 
+	 * @return FileInputPointer
+	 */
+	private function openFile()
+	{
+		if (($input = fopen($this->parameters['input'], 'r')) === false) {
 			$this->error('Can\'t open the input file!');
 		}
 
-		// Write CSV lintes
-		while (($data = fgetcsv($input_fp, 0, $this->parameters['delimiter'], $this->parameters['enclosure'], $this->parameters['escape'])) !== false) {
+		return $input;
+	}
+
+	/**
+	 * Read content of file.
+	 * 
+	 * @param FilePointer $input
+	 * @throws \Exception
+	 * @return array
+	 */
+	private function readFile($input)
+	{
+		if($this->parameters['excel'])
+			$this->adjustFromExcel();
+
+		$translations = [];
+		while (($data = fgetcsv($input, 0, $this->parameters['delimiter'], $this->parameters['enclosure'], $this->parameters['escape'])) !== false) {
 			if(isset($translations[$data[0]]) == false)
 				$translations[$data[0]] = [];
 
+			if(sizeof($data) != 3)
+				throw new \Exception("Wrong format of file. Try launch command with -X option if you use Excel for editing file.");
+
 			$translations[$data[0]][$data[1]] = $data[2];
 		}
 
-		fclose($input_fp);
-
 		return $translations;
 	}
 
+	/**
+	 * Adjust file to Excel format.
+	 * 
+	 * @return void
+	 */
+	private function adjustFromExcel()
+	{
+		$data = file_get_contents($this->parameters['input']);
+		file_put_contents($this->parameters['input'], mb_convert_encoding($data, 'UTF-8', 'UTF-16'));		
+	}
+
+	/**
+	 * Close file.
+	 * 
+	 * @return void
+	 */
+	private function closeFile($input)
+	{
+		fclose($input);
+	}
+
 	/**
 	 * Save fetched translations to file.
 	 * 
 	 * @return void
 	 */
 	private function saveTranslations($translations)
 	{
-		LangListService::writeLangList($locale, $group, $translations);
+		LangListService::writeLangList($this->parameters['locale'], $this->parameters['group'], $translations);
 	}
 
 	/**
@@ -152,7 +207,7 @@ private function saveTranslations($translations)
 	 */
 	private function sayItsFinish()
 	{
-		$this->info('Finished! Translations imported from: '. (substr($this->parameters['output'], strlen(base_path()) + 1)) . $this->ext 
+		$this->info('Finished! Translations imported from: '. (substr($this->parameters['input'], strlen(base_path()) + 1))
 			. PHP_EOL);
 	}