Initial functionality

Author: subotkevic

.gitignore

@@ -0,0 +1,4 @@
+/.idea/
+/vendor/
+.DS_Store
+composer.lock

README.md

@@ -2,3 +2,62 @@
 JSON Translation Helper scans your project for `__()`, `lang()` translation helper methods and `@lang` directives, then it creates keys in your JSON translation files. 
 
 And yes, it avoids duplicates – helper creates only non-existing keys. Ready for your translation.
+
+## Installation
+
+First, install JSON Translation Helper using the Composer require command:
+
+```
+composer require subotkevic/laravel-json-translation-helper
+```
+
+That's it. Package registers service provider automatically.
+
+## Usage
+
+### Translation files
+
+First, you have to create your translation files for languages you will translate your application to. 
+
+For example, if you want your application to have a Spanish translation, you should create a `resources/lang/es.json` file.
+
+Of course you can have multiple translation files:
+```
+resources/
+    lang/
+        es.json
+        fr.json
+```
+
+Make sure that your translation files is valid JSON, otherwise our package will not work:
+
+```
+{
+    "I love programming.": "Me encanta programar."
+}
+```
+
+If you don't have any translations for now, just **make sure your file is not empty**, but actually an empty JSON object:
+```
+{}
+```
+
+### Scan your application
+
+Finally, to scan your application for missing translation keys just run:
+
+```
+php artisan translation:scan
+```
+
+## Customization
+
+You can change the default paths to scan your application from, the output directory where your JSON translation files are located, and even the file extensions you want to scan from.
+
+First, publish the configuration file:
+
+```
+php artisan vendor:publish --provider="JsonTranslationHelper\TranslationHelperServiceProvider"
+```
+
+Then in the `config/translation-helper.php` you can change default values of `scan_directories`, `file_extensions` and `output_directory`.

composer.json

@@ -0,0 +1,40 @@
+{
+    "name": "subotkevic/laravel-json-translation-helper",
+    "description": "Searches for translation keys – inserts into JSON translation files.",
+    "type": "project",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Artur Subotkevič",
+            "email": "artur@subotkevic.com"
+        }
+    ],
+    "require": {
+        "php": ">=7.0.0",
+        "laravel/framework": ">=5.4.x-dev",
+        "ext-json": "*"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "~6.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Translator\\": "src/"
+        },
+        "files": [
+            "src/helpers.php"
+        ]
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "JsonTranslationHelper\\Tests\\": "tests/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "JsonTranslationHelper\\TranslationHelperServiceProvider"
+            ]
+        }
+    }
+}

src/Command/TranslationHelperCommand.php

@@ -0,0 +1,153 @@
+<?php
+
+namespace JsonTranslationHelper\Command;
+
+use Illuminate\Console\Command;
+
+class TranslationHelperCommand extends Command
+{
+    /**
+     * @var string
+     */
+    protected $signature = 'translation:scan';
+
+    /**
+     * @var string
+     */
+    protected $description = 'Searches for translation keys – inserts into JSON translation files.';
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        $translationKeys = $this->findProjectTranslationsKeys();
+        $translationFiles = $this->getProjectTranslationFiles();
+
+        foreach ($translationFiles as $file) {
+            $translationData = $this->getAlreadyTranslatedKeys($file);
+            $this->line("lang " . str_replace('.json', '', basename($file)));
+            $added = [];
+
+            foreach ($translationKeys as $key) {
+                if (!isset($translationData[$key])) {
+                    $this->warn(" - Added {$key}");
+                    $translationData[$key] = '';
+                    $added[] = $key;
+                }
+            }
+
+            if ($added) {
+                $this->line("Updating translation file...");
+                $this->writeNewTranslationFile($file, $translationData);
+                $this->info("Done!");
+            } else {
+                $this->warn("Nothing new found for this language.");
+            }
+            $this->line("");
+        }
+    }
+
+    /**
+     * @return array
+     */
+    private function findProjectTranslationsKeys()
+    {
+        $allKeys = [];
+        $viewsDirectories = config('translation-helper.views_directories');
+        $fileExtensions = config('translation-helper.file_extensions');
+
+        foreach($viewsDirectories as $directory) {
+            foreach ($fileExtensions as $extension) {
+                $this->getTranslationKeysFromDir($allKeys, $directory, $extension);
+            }
+        }
+
+        ksort($allKeys);
+
+        return $allKeys;
+    }
+
+    /**
+     * @param array $keys
+     * @param string $dirPath
+     * @param string $fileExt
+     */
+    private function getTranslationKeysFromDir(&$keys, $dirPath, $fileExt = 'php')
+    {
+        $files = glob_recursive("{$dirPath}/*.{$fileExt}", GLOB_BRACE);
+
+        foreach ($files as $file) {
+            $content = $this->getSanitizedContent($file);
+
+            $this->getTranslationKeysFromFunction($keys, 'lang', $content);
+            $this->getTranslationKeysFromFunction($keys, '__', $content);
+        }
+    }
+
+    /**
+     * @param array $keys
+     * @param string $functionName
+     * @param string $content
+     */
+    private function getTranslationKeysFromFunction(&$keys, $functionName, $content)
+    {
+        $matches = [];
+
+        preg_match_all("#{$functionName}\(\'(.*?)\'\)#", $content, $matches);
+
+        if ( ! empty($matches)) {
+            foreach ($matches[1] as $match) {
+                $match = str_replace('"', "'", str_replace("\'", "'", $match));
+
+                if ( ! empty($match)) {
+                    $keys[$match] = $match;
+                }
+            }
+        }
+    }
+
+    /**
+     * @return array
+     */
+    private function getProjectTranslationFiles()
+    {
+        $path = config('translation-helper.translations_output');
+        $files = glob("{$path}/*.json", GLOB_BRACE);
+
+        return $files;
+    }
+
+    /**
+     * @param string $filePath
+     * @return array
+     */
+    private function getAlreadyTranslatedKeys($filePath)
+    {
+        $current = json_decode(file_get_contents($filePath), true);
+
+        ksort($current);
+
+        return $current;
+    }
+
+    /**
+     * @param string $filePath
+     * @param array $translations
+     */
+    private function writeNewTranslationFile($filePath, $translations)
+    {
+        file_put_contents($filePath, json_encode($translations, JSON_PRETTY_PRINT|JSON_UNESCAPED_UNICODE));
+    }
+
+    /**
+     * @param string $filePath
+     * @return string
+     */
+    private function getSanitizedContent($filePath)
+    {
+        return str_replace("\n", ' ', file_get_contents($filePath));
+    }
+}

src/TranslationHelperServiceProvider.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace JsonTranslationHelper;
+
+use Illuminate\Support\ServiceProvider;
+
+class TranslationHelperServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap the application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                \JsonTranslationHelper\Command\TranslationHelperCommand::class,
+            ]);
+        }
+
+        $this->mergeConfigFrom(__DIR__ . '/config/translation-helper.php', 'translation-helper');
+
+        $this->publishes([
+            __DIR__ . '/config/translation-helper.php' => base_path('config/translation-helper.php'),
+        ], 'config');
+    }
+}

src/config/translation-helper.php

@@ -0,0 +1,26 @@
+<?php
+
+return [
+    /**
+     * Directories to scan for missing translation keys.
+     */
+    'scan_directories' => [
+        app_path(),
+        resource_path('views'),
+        resource_path('assets'),
+    ],
+
+    /**
+     * File extensions to scan from.
+     */
+    'file_extensions' => [
+        'php',
+        //'js',
+        //'vue',
+    ],
+
+    /**
+     * Directory where your JSON translation files are located.
+     */
+    'output_directory' => resource_path('lang'),
+];

src/helpers.php

@@ -0,0 +1,36 @@
+<?php
+
+if ( ! function_exists('lang')) {
+    /**
+     * Translate the given message.
+     *
+     * @param  string $key
+     * @param  array $replace
+     * @param  string $locale
+     * @return \Illuminate\Contracts\Translation\Translator|string
+     */
+    function lang($key = null, $replace = [], $locale = null)
+    {
+        return __($key, $replace, $locale);
+    }
+}
+
+if ( ! function_exists('glob_recursive')) {
+    /**
+     * Find path names matching a pattern recursively
+     *
+     * @param $pattern
+     * @param int $flags
+     * @return array
+     */
+    function glob_recursive($pattern, $flags = 0)
+    {
+        $files = glob($pattern, $flags);
+
+        foreach (glob(dirname($pattern) . '/*', GLOB_ONLYDIR | GLOB_NOSORT) as $dir) {
+            $files = array_merge($files, glob_recursive($dir . '/' . basename($pattern), $flags));
+        }
+
+        return $files;
+    }
+}