Download the Franc binary and tests

Author: avvertix

README.md

@@ -16,17 +16,26 @@ You can install the package via composer:
 composer require oneofftech/laravel-language-recognizer
 ```
 
+The language recognition, when performed using the local driver, 
+is done using the [Franc](https://github.com/wooorm/franc) library, in particular
+a [packaged version](https://github.com/avvertix/franc-bin) in form on an executable. 
+
+To download the executable version run:
+
+```bash
+php artisan language-recognizer:install-local-driver
+```
+
 You can publish the config file with:
+
 ```bash
 php artisan vendor:publish --provider="Oneofftech\LaravelLanguageRecognizer\LaravelLanguageRecognizerServiceProvider" --tag="laravel-language-recognizer-config"
 ```
 
-This is the contents of the published config file:
+> If you change the path to the Franc binary, as configured in the local driver, ensure that the file is moved or present in that location. You can run `php artisan language-recognizer:install-local-driver` to download the binary in the configured location
 
-```php
-return [
-];
-```
+This configuration file allows to specifiy the drivers for performing the language
+recognition and their eventual options.
 
 ## Usage
 
@@ -38,6 +47,8 @@ LanguageRecognizer::recognize('Which language is used in this string!');
 
 ## Testing
 
+A test suite is available. To execute the tests run:
+
 ```bash
 composer test
 ```

composer.json

@@ -19,17 +19,16 @@
         "php": "^7.4|^8.0",
         "illuminate/contracts": "^8.37",
         "illuminate/support": "^8.37",
+        "illuminate/http": "^8.37",
         "symfony/process": "^5.1.4"
     },
     "require-dev": {
         "brianium/paratest": "^6.2",
         "nunomaduro/collision": "^5.3",
         "orchestra/testbench": "^6.15",
         "phpunit/phpunit": "^9.3",
-        "vimeo/psalm": "^4.8"
-    },
-    "suggest": {
-        "illuminate/http": "To allow download of language recognizer executable from https://github.com/avvertix/franc-bin"
+        "vimeo/psalm": "^4.8",
+        "guzzlehttp/guzzle": "^7.0.1"
     },
     "autoload": {
         "psr-4": {
@@ -43,7 +42,7 @@
     },
     "scripts": {
         "psalm": "vendor/bin/psalm",
-        "test": "./vendor/bin/testbench package:test --parallel --no-coverage",
+        "test": "vendor/bin/phpunit --no-coverage",
         "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
     },
     "config": {

config/language-recognizer.php

@@ -16,7 +16,7 @@
              |
              | The binary path must end with the linux executable file name
              */
-            'path' => env('LANGUAGE_RECOGNIZER_LOCAL_BIN_PATH', './bin/language-guesser'),
+            'path' => env('LANGUAGE_RECOGNIZER_LOCAL_BIN_PATH', './bin/language-recognizer'),
             // 'exclude' => ['cat','sot','kat','bcl','glg','lao','lit','umb','tsn','vec','nso','ban','bug','knc','kng','ibb','lug','ace','bam','tzm','ydd','kmb','lun','shn','war','dyu','wol','nds','mkd','vmw','zgh','ewe','khk','slv','ayr','bem','emk','bci','bum','epo','pam','tiv','tpi','ven','ssw','nyn','kbd','iii','yao','lav','quz','src','rup','sco','tso','rmy','men','fon','nhn','dip','kde','snn','kbp','tem','toi','est','snk','cjk','ada','aii','quy','rmn','bin','gaa','ndo'],
         ],
 

src/Commands/InstallLocalRecognizerCommand.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace Oneofftech\LaravelLanguageRecognizer\Commands;
+
+use Exception;
+use Illuminate\Console\Command;
+use Illuminate\Support\Str;
+use Illuminate\Support\Facades\Http;
+
+class InstallLocalRecognizerCommand extends Command
+{
+    public $signature = 'language-recognizer:install-local-driver {--path=}';
+
+    public $description = 'Install the local Franc binary used to recognize the language of a text';
+
+
+    /**
+     * Artifacts urls keyed based on operating system
+     * 
+     * @var array
+     */
+    protected static $urls = [
+        'linux' => 'https://github.com/avvertix/franc-bin/releases/download/v1.0.0/franc-bin-linux',
+        'darwin' => 'https://github.com/avvertix/franc-bin/releases/download/v1.0.0/franc-bin-macos',
+        'winnt' => 'https://github.com/avvertix/franc-bin/releases/download/v1.0.0/franc-bin-win.exe',
+    ];
+
+
+    /**
+     * @return int
+     *
+     */
+    public function handle()
+    {
+        $this->comment('Downloading Franc from binary from https://github.com/avvertix/franc-bin');
+
+        $os = $this->getOs();
+        
+        $url = self::$urls[$os] ?? null;
+        
+        if(is_null($url)){
+            throw new Exception("Unsupported operating system [{$os}]");
+        }
+
+        $this->info($url);
+
+        $downloadPath = $this->getDownloadPath();
+
+        if(!is_dir($directory = dirname($downloadPath))){
+            mkdir($directory);
+        }
+
+        Http::withOptions([
+            'sink' => $downloadPath,
+        ])->timeout(30)->get($url);
+
+        $this->comment('All done');
+
+        return 0;
+    }
+
+    protected function getOs()
+    {
+        return strtolower(PHP_OS);
+    }
+
+    protected function getDownloadPath()
+    {
+        $pathOption = $this->option('path');
+        
+        if($pathOption){
+
+            if($this->getOs() === 'winnt' && ! Str::endsWith($pathOption, '.exe')){
+                return $pathOption.'.exe';
+            }
+
+            return $pathOption;
+        }
+        
+        $suffixes = [
+            'winnt' => '.exe',
+        ];
+
+        $configuredPath = config('language-recognizer.drivers.local.path');
+
+        $resolvedPath = Str::startsWith($configuredPath, '.') ? base_path($configuredPath) : $configuredPath;
+
+        return $resolvedPath . ($suffixes[$this->getOs()] ?? '');
+    }
+}

src/Drivers/LocalLanguageRecognizerDriver.php

@@ -12,6 +12,13 @@
 
 class LocalLanguageRecognizerDriver implements LanguageRecognizer
 {
+    /**
+     * The path of the Franc binary
+     * 
+     * @var string
+     */
+    protected $binaryPath = null;
+
     public function __construct($config)
     {
         if (empty($config['path'])) {
@@ -21,6 +28,9 @@ public function __construct($config)
         $this->binaryPath = $this->obtainBinaryPath($config['path']);
     }
 
+    /**
+     * @return false|string
+     */
     protected function obtainBinaryPath($configuredPath)
     {
         $basePath = Str::startsWith($configuredPath, '.') ? base_path($configuredPath) : $configuredPath;
@@ -66,7 +76,7 @@ public function recognize($text, $limit = 2): array
             })->toArray();
     }
 
-    private function run($text)
+    private function run($text): string
     {
         $options = [$this->binaryPath, '--all'];
 
@@ -97,7 +107,7 @@ private function run($text)
                 throw new Exception((new ProcessFailedException($process))->getMessage());
             }
         } catch (ProcessFailedException $ex) {
-            throw new Exception($ex->getMessage(), $ex->getCode(), $ex);
+            throw new Exception($ex->getMessage(), 143, $ex);
         }
 
         return $process->getOutput();

src/LaravelLanguageRecognizer.php

@@ -26,6 +26,9 @@ public function driver($driver = null)
         return parent::driver($driver);
     }
 
+    /**
+     * @return \Oneofftech\LaravelLanguageRecognizer\Drivers\LocalLanguageRecognizerDriver
+     */
     protected function createLocalDriver()
     {
         return new LocalLanguageRecognizerDriver($this->container['config']['language-recognizer.drivers.local']);

src/LaravelLanguageRecognizerServiceProvider.php

@@ -3,15 +3,18 @@
 namespace Oneofftech\LaravelLanguageRecognizer;
 
 use Illuminate\Support\ServiceProvider;
+use Oneofftech\LaravelLanguageRecognizer\Commands\InstallLocalRecognizerCommand;
 
 class LaravelLanguageRecognizerServiceProvider extends ServiceProvider
 {
-    public function boot()
+    public function boot(): void
     {
         if ($this->app->runningInConsole()) {
-            // $this->commands([
-            //     ScaffoldAuthenticationControllers::class,
-            // ]);
+
+            $this->commands([
+                InstallLocalRecognizerCommand::class,
+            ]);
+            
             $this->publishes([
                 __DIR__.'/../config/language-recognizer.php' => config_path('language-recognizer.php'),
             ]);

tests/Integration/InstallCommandTest.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Oneofftech\LaravelLanguageRecognizer\Tests\Integration;
+
+use Illuminate\Support\Facades\Artisan;
+
+class InstallCommandTest extends TestCase
+{
+    /** @test */
+    public function download_the_franc_binary_to_custom_path()
+    {
+        $exit = Artisan::call('language-recognizer:install-local-driver', ['--path' => __DIR__ . '/../../bin/language-guesser']);
+
+        $this->assertEquals(0, $exit);
+        $this->assertFileExists(__DIR__ . '/../../bin/language-guesser' . (strtolower(PHP_OS) === 'winnt' ?'.exe':'' ));
+    }
+    
+    /** @test */
+    public function download_the_franc_binary_to_default_path()
+    {
+        $this->app['config']->set('language-recognizer.drivers.local.path', './bin/language-guesser');
+
+        $exit = Artisan::call('language-recognizer:install-local-driver');
+
+        $this->assertEquals(0, $exit);
+        $this->assertFileExists(base_path('bin/language-guesser') . (strtolower(PHP_OS) === 'winnt' ?'.exe':'' ));
+    }
+
+}

tests/Integration/LaravelLanguageRecognizerFacadeTest.php

@@ -11,7 +11,7 @@ class LaravelLanguageRecognizerFacadeTest extends TestCase
     public function default_local_driver_can_be_obtained()
     {
         $this->app['config']->set('language-recognizer.default', 'local');
-        $this->app['config']->set('language-recognizer.drivers.local.path', __DIR__ . '/../../bin/language-guesser');
+        $this->app['config']->set('language-recognizer.drivers.local.path', __DIR__ . '/../../bin/language-recognizer');
 
         $service = LanguageRecognizer::driver('local');
 
@@ -22,7 +22,7 @@ public function default_local_driver_can_be_obtained()
     public function recognition_can_be_done_from_facade()
     {
         $this->app['config']->set('language-recognizer.default', 'local');
-        $this->app['config']->set('language-recognizer.drivers.local.path', __DIR__ . '/../../bin/language-guesser');
+        $this->app['config']->set('language-recognizer.drivers.local.path', __DIR__ . '/../../bin/language-recognizer');
 
         $languages = LanguageRecognizer::recognize('This is a string');
 

tests/Integration/LaravelLanguageRecognizerServiceProviderTest.php

@@ -31,7 +31,7 @@ public function default_local_driver_can_be_set()
     public function default_local_driver_can_be_instantiated()
     {
         $this->app['config']->set('language-recognizer.default', 'local');
-        $this->app['config']->set('language-recognizer.drivers.local.path', __DIR__ . '/../../bin/language-guesser');
+        $this->app['config']->set('language-recognizer.drivers.local.path', __DIR__ . '/../../bin/language-recognizer');
 
         $service = $this->app[LaravelLanguageRecognizer::class];