Merge with style fixes

Author: Krisell

README.md

@@ -1,6 +1,6 @@
 # Laravel Translation Json Cache
 
-When using the `.json` option for translations, the json-file is read and parsed for every request. This package provides an artisan command to cache the parsed data as a php-file, pretty much the same was as routes and configs can be cached. This gives a performance boost since no JSON-parsing has to be done and the opcache can be used. The actual performance boost depends on the size of the translation file and the filesystem, see below.
+When using the `.json` option for translations, the json-file is read and parsed for every request. This package provides an artisan command to cache the parsed data as a php-file, pretty much the same was as routes and configs can be cached. This gives a performance boost since no JSON-parsing has to be done and the opcache can be used. The actual performance boost depends on the size of the translation file and the disk speed, see below.
 
 ## Installation
 ```bash
@@ -28,10 +28,13 @@ Run `translation-json:cache` during deployment in the same way you run `route:ca
 The cached files are stored in the `bootstrap/cache` directory and are named `translation-{$locale}.php`.
 
 ## Performance boost
-On my Macbook Pro 2018 (2.6 GHz i7), Laravel Valet, and using a JSON translation file of 1500 strings (real strings of varying length), the first call to `__("A")` during a request takes about `1.2 ms`. Enabling this package and the same call takes `0.08 ms`, i.e. the actual performance boost is in the order of `1 ms`, which is substantial considering that a simple full request could be as fast as `10 ms`.
+On a Macbook Pro 2018 (2.6 GHz i7), using Laravel Valet, and having a JSON translation file of 1500 strings (real strings of varying length), the first call to `__("A")` during a request takes about `1.2 ms`. Enabling this package and the same call takes `0.08 ms`, i.e. the actual performance boost is in the order of `1 ms`, which is substantial considering that a simple full request could be as fast as `10 ms`.
 
-I have been using this package in production (1500 strings for each language) and I have to say the performance boost is not as noticable there. This may be because our server setup uses docker and an all in-memory disk. I'm open to additional measurements, please feel free to contribute!
+I have been using this solution in production for a while (1500 strings for each language) and I have to say the performance boost is not really noticable there (comparing CPU graphs, which of course depends on a lot of other changes as well). The difference may be smaller since our server setup uses docker and an all in-memory disk. Please feel free to contribute with additional measurements under other circumstances or with other sizes of the JSON files.
 
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+
+## Future work
+I realize the JSON-option may not be the preferred one, and that most people already use php-files for storing their translation data hierachically. In that case, a similar approach could still possibly save time on parsing and traversal, but this is outside the scope of this package. Feel free to investigate this idéa further in a new package!

src/Console/Commands/ClearTranslationJsonCache.php

@@ -10,7 +10,8 @@ class ClearTranslationJsonCache extends Command
 {
     protected $signature = 'translation-json:clear';
 
-    protected $description = 'Deletes cached translation JSON-files, letting the application fallback to the JSON files.';
+    protected $description = 'Deletes cached translation JSON-files,
+        letting the application fallback to the JSON files.';
 
     public function handle()
     {

src/Console/Commands/MakeTranslationJsonCache.php

@@ -28,7 +28,7 @@ public function handle()
         $this->info("Translation JSON cached successfully!");
     }
 
-    private function getTranslationJsonFiles () {
+    private function getTranslationJsonFiles() {
         return collect(File::files(base_path().'/resources/lang'))->map(function ($file) {
             return $file->getFilename();
         })->filter(function ($filename) {

tests/Feature/MakeJsonCacheCommandTest.php

@@ -39,7 +39,7 @@ function one_cache_file_is_created_for_each_language()
     }
 
     /** @test */
-    function the_data_in_the_cached_file_corresponds_to_the_json_file ()
+    function the_data_in_the_cached_file_corresponds_to_the_json_file()
     {
         file_put_contents(base_path().'/resources/lang/en.json', '{"Test":"Testing123"}');
 

tests/Feature/TranslationJsonCacheTest.php

@@ -5,21 +5,21 @@
 class TranslationJsonCacheTest extends TestCase
 {
     /** @test */
-    function the_cache_file_is_used_when_it_exists ()
+    function the_cache_file_is_used_when_it_exists()
     {
         file_put_contents(base_path().'/bootstrap/cache/translation-en.php', '<?php return ["Test" => "Testing"];');
 
         $this->assertEquals("Testing", __("Test"));
     }
 
     /** @test */
-    function the_cache_file_is_not_used_when_it_does_not_exist ()
+    function the_cache_file_is_not_used_when_it_does_not_exist()
     {
         $this->assertEquals("Test", __("Test"));
     }
 
     /** @test */
-    function the_cached_file_takes_presendece_if_it_differs_from_the_json_file ()
+    function the_cached_file_takes_presendece_if_it_differs_from_the_json_file()
     {
         file_put_contents(base_path().'/bootstrap/cache/translation-en.php', '<?php return ["Test" => "Testing123"];');
         file_put_contents(base_path().'/resources/lang/en.json', '{"Test":"Testing"}');