Add some tests, badges, and styleci

Author: aarondfrancis

.github/workflows/tests.yml

@@ -0,0 +1,57 @@
+name: Tests
+
+on: [ push, pull_request ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, 'ci skip')"
+    strategy:
+      fail-fast: false
+      matrix:
+        php: [ 7.2, 7.3, 7.4, 8.0 ]
+        laravel: [ 7.*, 8.* ]
+        dependency-version: [ prefer-lowest, prefer-stable ]
+        include:
+          - laravel: 7.*
+            testbench: 5.*
+
+          - laravel: 7.*
+            dependency-version: prefer-lowest
+            composer-version: --1
+
+          - laravel: 8.*
+            testbench: 6.*
+
+        exclude:
+          # Laravel 8 requires PHP 7.3.
+          - laravel: 8.*
+            php: 7.2
+
+    name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.composer/cache/files
+          key: dependencies-laravel-${{ matrix.laravel }}-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
+          coverage: none
+
+      - name: Install dependencies
+        run: |
+          composer self-update ${{ matrix.composer-version }}
+          composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
+          composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
+
+      - name: Execute tests
+        run: vendor/bin/phpunit

.styleci.yml

@@ -0,0 +1,11 @@
+preset: laravel
+
+disabled:
+  - concat_without_spaces
+  - not_operator_with_successor_space
+  - cast_spaces
+  - trailing_comma_in_multiline_array
+  - heredoc_to_nowdoc
+  - phpdoc_summary
+
+risky: false

README.md

@@ -1 +1,5 @@
 # Laravel Torchlight Client
+
+[![Tests](https://github.com/torchlight-api/torchlight-laravel/actions/workflows/tests.yml/badge.svg)](https://github.com/torchlight-api/torchlight-laravel/actions/workflows/tests.yml) 
+
+[![Latest Stable Version](https://poser.pugx.org/torchlight/laravel/v)](//packagist.org/packages/torchlight/laravel) [![Total Downloads](https://poser.pugx.org/torchlight/laravel/downloads)](//packagist.org/packages/torchlight/laravel) [![License](https://poser.pugx.org/torchlight/laravel/license)](//packagist.org/packages/torchlight/laravel)

composer.json

@@ -13,7 +13,8 @@
         "php": "^7.2|^8.0",
         "illuminate/support": "^7.0|^8.0",
         "illuminate/console": "^7.0|^8.0",
-        "illuminate/http": "^7.0|^8.0"
+        "illuminate/http": "^7.0|^8.0",
+        "guzzlehttp/guzzle": "^7.2"
     },
     "require-dev": {
         "orchestra/testbench": "^5.0|^6.0",

config/torchlight.php

@@ -7,11 +7,14 @@
 
     // Which theme you want to use. You can find all of the themes at
     // https://torchlight.dev/themes, or you can provide your own.
-    'theme' => 'material-theme-palenight',
+    'theme' => env('TORCHLIGHT_THEME', 'material-theme-palenight'),
 
     // Your API token from torchlight.dev.
     'token' => env('TORCHLIGHT_TOKEN'),
 
     // If you want to register the blade directives, set this to true.
     'blade_components' => true,
+
+    // The Host of the API.
+    'host' => env('TORCHLIGHT_HOST', 'https://api.torchlight.dev'),
 ];

src/Blade/BladeManager.php

@@ -19,19 +19,29 @@ public static function registerBlock(Block $block)
         static::$blocks[] = $block;
     }
 
-    public static function render(Response $response)
+    public static function renderResponse(Response $response)
     {
-        // Bail early if there are no blocks on this page.
+        // Bail early if there are no blocks registered.
         if (!static::$blocks) {
             return $response;
         }
 
+        return $response->setContent(
+            static::renderContent($response->content())
+        );
+    }
+
+    public static function renderContent($content)
+    {
+        // Bail early if there are no blocks registered.
+        if (!static::$blocks) {
+            return $content;
+        }
+
         $blocks = (new Client)->highlight(static::$blocks);
 
         static::$blocks = [];
 
-        $content = $response->content();
-
         foreach ($blocks as $block) {
             $swap = [
                 $block->placeholder() => $block->highlighted,
@@ -45,6 +55,6 @@ public static function render(Response $response)
             }
         }
 
-        return $response->setContent($content);
+        return $content;
     }
 }

src/Blade/CodeComponent.php

@@ -32,7 +32,7 @@ public function __construct($language, $theme = null, $contents = null)
         $this->theme = $theme;
         $this->contents = $contents;
 
-        $this->block = Block::make()->setLanguage($this->language)->setTheme($this->theme);
+        $this->block = Block::make()->language($this->language)->theme($this->theme);
     }
 
     public function capture($contents)
@@ -43,7 +43,7 @@ public function capture($contents)
             $contents = file_get_contents(resource_path($contents));
         }
 
-        BladeManager::registerBlock($this->block->setCode($contents));
+        BladeManager::registerBlock($this->block->code($contents));
     }
 
     /**
@@ -54,10 +54,9 @@ public function capture($contents)
     public function render()
     {
         // Put all of the attributes on the code element, merging in our placeholder
-        // classes and style string. Echo out the slot, but capture capture it
-        // using output buffering. We then pass it through as the contents to
-        // highlight, leaving the placeholder there so we can replace it
-        // later with fully highlighted code.
+        // classes and style string. Echo out the slot, but capture it using output
+        // buffering. We then pass it through as the contents to highlight, leaving
+        // the placeholder so we can replace it later with fully highlighted code.
         return <<<'EOT'
 <code {{
         $attributes->except('style')->merge([

src/Block.php

@@ -5,27 +5,64 @@
 
 namespace Hammerstone\Torchlight;
 
-use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Str;
 
 class Block
 {
+    /**
+     * The language of the code that is being highlighted.
+     *
+     * @var string
+     */
     public $language;
 
+    /**
+     * The theme of the code.
+     *
+     * @var string
+     */
     public $theme;
 
+    /**
+     * The code itself.
+     *
+     * @var string
+     */
     public $code;
 
-    public $highlighted;
-
+    /**
+     * The highlighted code, wrapped in pre+code tags.
+     *
+     * @var string
+     */
     public $wrapped;
 
+    /**
+     * The highlighted code, not wrapped.
+     *
+     * @var string
+     */
+    public $highlighted;
+
+    /**
+     * Classes that should be applied to the code tag.
+     *
+     * @var string
+     */
     public $classes;
 
+    /**
+     * Styles that should be applied to the code tag.
+     *
+     * @var string
+     */
     public $styles;
 
-    public $cacheBust = 0;
-
+    /**
+     * The unique ID for the block.
+     *
+     * @var string
+     */
     protected $id;
 
     /**
@@ -45,9 +82,6 @@ public function __construct($id = null)
         // Generate a unique UUID.
         $this->id = $id ?? (string)Str::uuid();
 
-        // An easy way to bust all caches.
-        $this->cacheBust = config('torchlight.bust', 0);
-
         // Set a default theme.
         $this->theme = config('torchlight.theme');
     }
@@ -65,10 +99,11 @@ public function id()
      */
     public function hash()
     {
-        return md5($this->language . $this->theme . $this->code . $this->cacheBust);
+        return md5($this->language . $this->theme . $this->code . config('torchlight.bust'));
     }
 
     /**
+     * @param string $extra
      * @return string
      */
     public function placeholder($extra = '')
@@ -84,7 +119,7 @@ public function placeholder($extra = '')
      * @param $language
      * @return $this
      */
-    public function setLanguage($language)
+    public function language($language)
     {
         $this->language = $language;
 
@@ -95,7 +130,7 @@ public function setLanguage($language)
      * @param $theme
      * @return $this
      */
-    public function setTheme($theme)
+    public function theme($theme)
     {
         if ($theme) {
             $this->theme = $theme;
@@ -108,29 +143,18 @@ public function setTheme($theme)
      * @param $code
      * @return $this
      */
-    public function setCode($code)
+    public function code($code)
     {
         $this->code = $this->clean($code);
 
         return $this;
     }
 
-    /**
-     * @param $number
-     * @return $this
-     */
-    public function setCacheBust($number)
-    {
-        $this->cacheBust = $number;
-
-        return $this;
-    }
-
     /**
      * @param $wrapped
      * @return $this
      */
-    public function setWrapped($wrapped)
+    public function wrapped($wrapped)
     {
         $this->wrapped = $wrapped;
 
@@ -148,7 +172,6 @@ public function toRequestParams()
             'language' => $this->language,
             'theme' => $this->theme,
             'code' => $this->code,
-            'bust' => $this->cacheBust
         ];
     }