Send options to the API

Author: aarondfrancis

CHANGELOG.md

@@ -2,10 +2,15 @@
 
 ## Unreleased
 
+## 0.4.6 - 2021-07-27
+
+### Added
+- Added the ability to send `options` from the config file to the API.
+
 ## 0.4.5 - 2021-07-18
 
 ### Changed
-- The default response (used if a request fails) now includes the `<div class='line'>` wrappers.s
+- The default response (used if a request fails) now includes the `<div class='line'>` wrappers.
 
 ## 0.4.4 - 2021-06-16
 

config/torchlight.php

@@ -7,7 +7,7 @@
     'cache' => env('TORCHLIGHT_CACHE_DRIVER'),
 
     // Which theme you want to use. You can find all of the themes at
-    // https://torchlight.dev/themes.
+    // https://torchlight.dev/docs/themes.
     'theme' => env('TORCHLIGHT_THEME', 'material-theme-palenight'),
 
     // Your API token from torchlight.dev.
@@ -18,4 +18,25 @@
 
     // The Host of the API.
     'host' => env('TORCHLIGHT_HOST', 'https://api.torchlight.dev'),
+
+    // Global options to control blocks-level settings.
+    // https://torchlight.dev/docs/options
+    'options' => [
+        // Turn line numbers on or off globally.
+        'lineNumbers' => true,
+
+        // Control the `style` attribute applied to line numbers.
+        // 'lineNumbersStyle' => '',
+
+        // Turn on +/- diff indicators.
+        'diffIndicators' => true,
+
+        // If there are any diff indicators for a line, put them
+        // in place of the line number to save horizontal space.
+        'diffIndicatorsInPlaceOfLineNumbers' => true,
+
+        // When lines are collapsed, this is the text that will
+        // be shown to indicate that they can be expanded.
+        // 'summaryCollapsedIndicator' => '...',
+    ]
 ];

src/Block.php

@@ -114,7 +114,13 @@ protected function generateId()
      */
     public function hash()
     {
-        return md5($this->language . $this->theme . $this->code . Torchlight::config('bust'));
+        return md5(
+            $this->language
+            . $this->theme
+            . $this->code
+            . Torchlight::config('bust')
+            . json_encode(Torchlight::config('options'))
+        );
     }
 
     /**

src/Client.php

@@ -5,7 +5,6 @@
 
 namespace Torchlight;
 
-use GuzzleHttp\Promise\Promise;
 use Illuminate\Http\Client\ConnectionException;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
@@ -52,6 +51,7 @@ protected function request(Collection $blocks)
                 ->withToken($this->getToken())
                 ->post('highlight', [
                     'blocks' => $this->blocksAsRequestParam($blocks)->values()->toArray(),
+                    'options' => $this->getOptions(),
                 ]);
 
             if ($response->failed()) {
@@ -87,30 +87,6 @@ protected function request(Collection $blocks)
         return $blocks;
     }
 
-    protected function requestChunks($chunks)
-    {
-        $host = Torchlight::config('host', 'https://api.torchlight.dev');
-        $timeout = Torchlight::config('request_timeout', 5);
-
-        // Can't use Http::pool here because it's not
-        // available in Laravel 7 and early 8.
-        return $chunks
-            // This first map fires all the requests.
-            ->map(function ($blocks) use ($host, $timeout) {
-                return Http::async()
-                    ->baseUrl($host)
-                    ->timeout($timeout)
-                    ->withToken($this->getToken())
-                    ->post('highlight', [
-                        'blocks' => $this->blocksAsRequestParam($blocks)->values()->toArray(),
-                    ]);
-            })
-            // The second one waits for them all to finish.
-            ->map(function (Promise $request) {
-                return $request->wait();
-            });
-    }
-
     protected function collectionOfBlocks($blocks)
     {
         return collect($blocks)->each(function ($block) {
@@ -133,6 +109,17 @@ protected function getToken()
         return $token;
     }
 
+    protected function getOptions()
+    {
+        $options = Torchlight::config('options', []);
+
+        if (!is_array($options)) {
+            $options = [];
+        }
+
+        return $options;
+    }
+
     protected function potentiallyThrowRequestException($exception)
     {
         if ($exception) {

tests/BlockTest.php

@@ -94,7 +94,7 @@ public function to_request_params_includes_required_info()
 
         $this->assertEquals([
             'id' => 'id',
-            'hash' => '494dc5134843e4f6fdcc838e8bcd7f7c',
+            'hash' => '7580494fda334fc2329cdde34ad4a1d1',
             'language' => 'new language',
             'theme' => 'new theme',
             'code' => 'new code',

tests/ClientTest.php

@@ -39,7 +39,10 @@ protected function setUpTorchlight()
         config()->set('torchlight', [
             'theme' => 'material',
             'token' => 'token',
-            'bust' => 0
+            'bust' => 0,
+            'options' => [
+                'lineNumbers' => true
+            ]
         ]);
     }
 
@@ -54,9 +57,12 @@ public function it_sends_a_simple_request()
 
         Http::assertSent(function ($request) {
             return $request->hasHeader('Authorization', 'Bearer token')
+                && $request['options'] === [
+                    'lineNumbers' => true
+                ]
                 && $request['blocks'] === [[
                     'id' => 'id',
-                    'hash' => '49c75d827bf95472ac155c6b6cc42aaf',
+                    'hash' => 'e937def4cb365a758d1bf55ecc7fea5b',
                     'language' => 'php',
                     'theme' => 'material',
                     'code' => 'echo "hello world";',

tests/MiddlewareAndComponentTest.php

@@ -45,7 +45,7 @@ public function it_sends_a_simple_request_with_no_response()
         Http::assertSent(function ($request) {
             return $request['blocks'][0] === [
                 'id' => 'component',
-                'hash' => 'e99681f5450cbaf3774adc5eb74d637f',
+                'hash' => 'fe47ca550596fd0cea4664cc73774bcb',
                 'language' => 'php',
                 'theme' => 'material-theme-palenight',
                 'code' => 'echo "hello world";',