Merge pull request #215 from jonnybarnes/develop

MTM: Get main branch up to date

.env.example

@@ -56,9 +56,13 @@ PIWIK=false
 PIWIK_ID=1
 PIWIK_URL=https://analytics.jmb.lv/piwik.php
 
+FATHOM_ID=
+
 APP_TIMEZONE=UTC
 APP_LANG=en
 APP_LOG=daily
 SECURE_SESSION_COOKIE=true
 
-SLACK_WEBHOOK_URL=
+LOG_SLACK_WEBHOOK_URL=
+
+FONT_LINK=

.env.github

@@ -0,0 +1,66 @@
+APP_NAME=Laravel
+APP_ENV=testing
+APP_KEY=SomeRandomString # Leave this
+APP_DEBUG=false
+APP_LOG_LEVEL=warning
+
+DB_CONNECTION=pgsql
+DB_HOST=127.0.0.1
+DB_PORT=5432
+DB_DATABASE=jbuktest
+DB_USERNAME=postgres
+DB_PASSWORD=postgres
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=file
+SESSION_DRIVER=file
+QUEUE_DRIVER=sync
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_DRIVER=smtp
+MAIL_HOST=smtp.mailtrap.io
+MAIL_PORT=2525
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+
+PUSHER_APP_ID=
+PUSHER_APP_KEY=
+PUSHER_APP_SECRET=
+
+AWS_S3_KEY=your-key
+AWS_S3_SECRET=your-secret
+AWS_S3_REGION=region
+AWS_S3_BUCKET=your-bucket
+AWS_S3_URL=https://xxxxxxx.s3-region.amazonaws.com
+
+APP_URL=https://example.com # This one is necessary
+APP_LONGURL=example.com
+APP_SHORTURL=examp.le
+
+ADMIN_USER=admin # pick something better, this is used for `/admin`
+ADMIN_PASS=password
+DISPLAY_NAME="Joe Bloggs" # This is used for example in the header and titles
+
+TWITTER_CONSUMER_KEY=
+TWITTER_CONSUMER_SECRET=
+TWITTER_ACCESS_TOKEN=
+TWITTER_ACCESS_TOKEN_SECRET=
+
+SCOUT_DRIVER=pgsql
+
+PIWIK=false
+
+FATHOM_ID=
+
+APP_TIMEZONE=UTC
+APP_LANG=en
+APP_LOG=daily
+SECURE_SESSION_COOKIE=true
+
+LOG_SLACK_WEBHOOK_URL=
+
+FONT_LINK=

.env.travis

@@ -1,7 +1,7 @@
 APP_ENV=testing
 APP_DEBUG=true
 APP_KEY=base64:6DJhvZLVjE6dD4Cqrteh+6Z5vZlG+v/soCKcDHLOAH0=
-APP_URL=http://jonnybarnes.localhost:8000
+APP_URL=http://jonnybarnes.localhost
 APP_LONGURL=jonnybarnes.localhost
 APP_SHORTURL=jmb.localhost
 

.github/workflows/run-tests.yml

@@ -0,0 +1,56 @@
+name: Run Tests
+
+on:
+  pull_request:
+
+jobs:
+  phpunit:
+    runs-on: ubuntu-20.04
+
+    name: PHPUnit test suite
+
+    services:
+      postgres:
+        image: postgres:12
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: jbuktest
+        ports:
+          - 5432:5432
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cache node modules
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-${{ hashFiles('**/package.json') }}
+      - name: Install npm dependencies
+        run: npm install
+      - name: Install ImageMagick
+        run: sudo apt install imagemagick
+      - name: Setup PHP with pecl extension
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+          tools: pecl, phpcs
+          extensions: imagick
+      - name: Copy .env
+        run: php -r "file_exists('.env') || copy('.env.github', '.env');"
+      - name: Install dependencies
+        run: composer install -q --no-ansi --no-interaction --no-progress
+      - name: Generate key
+        run: php artisan key:generate
+      - name: Setup directory permissions
+        run: chmod -R 777 storage bootstrap/cache
+      - name: Setup test database
+        run: |
+          php artisan migrate
+          php artisan db:seed
+      - name: Execute tests (Unit and Feature tests) via PHPUnit
+        run: vendor/bin/phpunit
+      - name: Run phpcs
+        run: phpcs
+      - name: Check for security vulnerabilities
+        run: php vendor/bin/security-checker security:check

.gitignore

@@ -1,6 +1,4 @@
 /node_modules
-/public/hot
-/public/storage
 /storage/*.key
 /vendor
 .env
@@ -10,7 +8,13 @@ Homestead.yaml
 npm-debug.log
 yarn-error.log
 /.idea
+/lsp
+.phpstorm.meta.php
+_ide_helper.php
 # Custom paths in /public
 /public/coverage
+/public/hot
+/public/storage
+/public/fonts
 /public/files
 /public/keybase.txt

.styleci.yml

@@ -2,7 +2,6 @@ preset: laravel
 
 disabled:
   - concat_without_spaces
-  - simplified_null_return
   - single_import_per_statement
 
 finder:

.stylelintrc

@@ -1,5 +1,5 @@
 {
-    "extends": "stylelint-config-standard",
+    "extends": ["stylelint-config-standard", "stylelint-a11y/recommended"],
     "rules": {
         "indentation": 4
     }

.travis.yml

@@ -1,70 +0,0 @@
-language: php
-
-sudo: false
-dist: trusty
-
-cache:
-  - apt
-
-addons:
-  hosts:
-    - jmb.localhost
-    - jonnybarnes.localhost
-  postgresql: "9.6"
-  apt:
-    packages:
-      - nginx-full
-      - realpath
-      - postgresql-9.6-postgis-2.3
-      - imagemagick
-      #- google-chrome-stable
-  artifacts:
-    s3_region: "eu-west-1"
-    paths:
-      - $(ls tests/Browser/screenshots/*.png | tr "\n" ":")
-      - $(ls tests/Browser/console/*.log | tr "\n" ":")
-      - $(ls storage/logs/*.log | tr "\n" ":")
-      - $(ls /tmp/*.log | tr "\n" ":")
-
-services:
-  - postgresql
-
-env:
-  global:
-    - setup=basic
-
-php:
-  - 7.2
-  - 7.3
-
-before_install:
-  - printf "\n" | pecl install imagick
-  - cp .env.travis .env
-  - echo 'error_log = "/tmp/php.error.log"' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
-  - psql -U travis -c 'create database travis_ci_test'
-  - psql -U travis -d travis_ci_test -c 'create extension postgis'
-  - travis_retry composer self-update --preview
-  - curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
-
-install:
-  - if [[ $setup = 'basic' ]];  then travis_retry composer install --no-interaction --prefer-dist; fi
-  - if [[ $setup = 'stable' ]]; then travis_retry composer update --no-interaction --prefer-dist --prefer-stable; fi
-  - if [[ $setup = 'lowest' ]]; then travis_retry composer update --no-interaction --prefer-dist --prefer-lowest --prefer-stable; fi
-  - travis/install-nginx.sh
-  - . $HOME/.nvm/nvm.sh
-  - nvm install stable
-  - nvm use stable
-  - npm i puppeteer
-
-before_script:
-  - php artisan key:generate
-  - php artisan migrate
-  - php artisan db:seed
-  #- google-chrome-stable --headless --disable-gpu --remote-debugging-port=9515 http://localhost:8000 &
-  #- sleep 5
-
-script:
-  - php vendor/bin/phpunit
-  - php phpcs.phar
-  #- php artisan dusk
-  - php vendor/bin/security-checker security:check

app/Console/Commands/MigratePlaceDataFromPostgis.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace App\Console\Commands;
+
+use App\Models\Place;
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\DB;
+
+class MigratePlaceDataFromPostgis extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'places:migratefrompostgis';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Copy Postgis data to normal latitude longitude fields';
+
+    /**
+     * Create a new command instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        $locationColumn = DB::selectOne(DB::raw("
+            SELECT EXISTS (
+                SELECT 1
+                FROM information_schema.columns
+                WHERE table_name = 'places'
+                AND column_name = 'location'
+            )
+        "));
+
+        if (! $locationColumn->exists) {
+            $this->info('There is no Postgis location data in the table. Exiting.');
+
+            return 0;
+        }
+
+        $latitudeColumn = DB::selectOne(DB::raw("
+            SELECT EXISTS (
+                SELECT 1
+                FROM information_schema.columns
+                WHERE table_name = 'places'
+                AND column_name = 'latitude'
+            )
+        "));
+
+        if (! $latitudeColumn->exists) {
+            $this->error('Latitude and longitude columns have not been created yet');
+
+            return 1;
+        }
+
+        $places = Place::all();
+
+        $places->each(function ($place) {
+            $this->info('Extracting Postgis data for place: ' . $place->name);
+
+            $place->latitude = $place->location->getLat();
+            $place->longitude = $place->location->getLng();
+            $place->save();
+        });
+
+        return 0;
+    }
+}

app/Console/Commands/ReDownloadWebMentions.php

@@ -4,9 +4,9 @@ declare(strict_types=1);
 
 namespace App\Console\Commands;
 
+use App\Jobs\DownloadWebMention;
 use App\Models\WebMention;
 use Illuminate\Console\Command;
-use App\Jobs\DownloadWebMention;
 
 class ReDownloadWebMentions extends Command
 {

app/Console/Kernel.php

@@ -27,6 +27,7 @@ class Kernel extends ConsoleKernel
     protected function schedule(Schedule $schedule)
     {
         $schedule->command('horizon:snapshot')->everyFiveMinutes();
+        $schedule->command('telescope:prune --hours=48')->daily();
     }
 
     /**
@@ -36,7 +37,7 @@ class Kernel extends ConsoleKernel
      */
     protected function commands()
     {
-        $this->load(__DIR__.'/Commands');
+        $this->load(__DIR__ . '/Commands');
 
         require base_path('routes/console.php');
     }

app/Exceptions/Handler.php

@@ -2,11 +2,16 @@
 
 namespace App\Exceptions;
 
-use App;
 use Exception;
-use Illuminate\Support\Facades\Route;
-use Illuminate\Session\TokenMismatchException;
+use GuzzleHttp\Client;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+use Illuminate\Session\TokenMismatchException;
+use Illuminate\Support\Facades\Route;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+use Throwable;
 
 /**
  * @codeCoverageIgnore
@@ -19,7 +24,8 @@ class Handler extends ExceptionHandler
      * @var array
      */
     protected $dontReport = [
-        \Symfony\Component\HttpKernel\Exception\HttpException::class,
+        NotFoundHttpException::class,
+        ModelNotFoundException::class,
     ];
 
     /**
@@ -37,53 +43,61 @@ class Handler extends ExceptionHandler
      *
      * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
      *
-     * @param  \Exception  $exception
+     * @param Throwable $throwable
      * @return void
+     * @throws Exception
+     * @throws Throwable
      */
-    public function report(Exception $exception)
+    public function report(Throwable $throwable)
     {
-        $guzzle = new \GuzzleHttp\Client([
-            'headers' => [
-                'Content-Type' => 'application/json',
-            ],
-        ]);
+        parent::report($throwable);
 
-        $guzzle->post(
-            env('SLACK_WEBHOOK_URL'),
-            [
-                'body' => json_encode([
-                    'attachments' => [[
-                        'fallback' => 'There was an exception.',
-                        'pretext' => 'There was an exception.',
-                        'color' => '#d00000',
-                        'author_name' => App::environment(),
-                        'author_link' => config('app.url'),
-                        'fields' => [[
-                            'title' => get_class($exception) ?? 'Unkown Exception',
-                            'value' => $exception->getMessage() ?? '',
+        if ($this->shouldReport($throwable)) {
+            $guzzle = new Client([
+                'headers' => [
+                    'Content-Type' => 'application/json',
+                ],
+            ]);
+
+            $exceptionName = get_class($throwable) ?? 'Unknown Exception';
+            $title = $exceptionName . ': ' . $throwable->getMessage();
+
+            $guzzle->post(
+                config('logging.slack'),
+                [
+                    'body' => json_encode([
+                        'attachments' => [[
+                            'fallback' => 'There was an exception.',
+                            'pretext' => 'There was an exception.',
+                            'color' => '#d00000',
+                            'author_name' => app()->environment(),
+                            'author_link' => config('app.url'),
+                            'fields' => [[
+                                'title' => $title,
+                                'value' => request()->method() . ' ' . request()->fullUrl(),
+                            ]],
+                            'ts' => time(),
                         ]],
-                        'ts' => time(),
-                    ]],
-                ]),
-            ]
-        );
-
-        parent::report($exception);
+                    ]),
+                ]
+            );
+        }
     }
 
     /**
      * Render an exception into an HTTP response.
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Exception  $exception
-     * @return \Illuminate\Http\Response
+     * @param Request $request
+     * @param Throwable $throwable
+     * @return Response
+     * @throws Throwable
      */
-    public function render($request, Exception $exception)
+    public function render($request, Throwable $throwable)
     {
-        if ($exception instanceof TokenMismatchException) {
+        if ($throwable instanceof TokenMismatchException) {
             Route::getRoutes()->match($request);
         }
 
-        return parent::render($request, $exception);
+        return parent::render($request, $throwable);
     }
 }

app/Http/Controllers/Admin/ArticlesController.php

@@ -4,11 +4,11 @@ declare(strict_types=1);
 
 namespace App\Http\Controllers\Admin;
 
-use App\Models\Article;
-use Illuminate\View\View;
-use Illuminate\Http\Request;
 use App\Http\Controllers\Controller;
+use App\Models\Article;
 use Illuminate\Http\RedirectResponse;
+use Illuminate\Http\Request;
+use Illuminate\View\View;
 
 class ArticlesController extends Controller
 {

app/Http/Controllers/Admin/ClientsController.php

@@ -4,11 +4,11 @@ declare(strict_types=1);
 
 namespace App\Http\Controllers\Admin;
 
-use Illuminate\View\View;
-use Illuminate\Http\Request;
-use App\Models\MicropubClient;
 use App\Http\Controllers\Controller;
+use App\Models\MicropubClient;
 use Illuminate\Http\RedirectResponse;
+use Illuminate\Http\Request;
+use Illuminate\View\View;
 
 class ClientsController extends Controller
 {

app/Http/Controllers/Admin/ContactsController.php

@@ -4,14 +4,14 @@ declare(strict_types=1);
 
 namespace App\Http\Controllers\Admin;
 
-use GuzzleHttp\Client;
-use App\Models\Contact;
-use Illuminate\View\View;
-use Illuminate\Support\Arr;
-use Illuminate\Http\Request;
 use App\Http\Controllers\Controller;
+use App\Models\Contact;
+use GuzzleHttp\Client;
 use Illuminate\Filesystem\Filesystem;
 use Illuminate\Http\RedirectResponse;
+use Illuminate\Http\Request;
+use Illuminate\Support\Arr;
+use Illuminate\View\View;
 
 class ContactsController extends Controller
 {

app/Http/Controllers/Admin/HomeController.php

@@ -4,8 +4,8 @@ declare(strict_types=1);
 
 namespace App\Http\Controllers\Admin;
 
-use Illuminate\View\View;
 use App\Http\Controllers\Controller;
+use Illuminate\View\View;
 
 class HomeController extends Controller
 {

app/Http/Controllers/Admin/LikesController.php

@@ -4,11 +4,11 @@ declare(strict_types=1);
 
 namespace App\Http\Controllers\Admin;
 
-use App\Models\Like;
-use App\Jobs\ProcessLike;
-use Illuminate\View\View;
 use App\Http\Controllers\Controller;
+use App\Jobs\ProcessLike;
+use App\Models\Like;
 use Illuminate\Http\RedirectResponse;
+use Illuminate\View\View;
 
 class LikesController extends Controller
 {

app/Http/Controllers/Admin/NotesController.php

@@ -4,12 +4,12 @@ declare(strict_types=1);
 
 namespace App\Http\Controllers\Admin;
 
-use App\Models\Note;
-use Illuminate\View\View;
-use Illuminate\Http\Request;
-use App\Jobs\SendWebMentions;
 use App\Http\Controllers\Controller;
+use App\Jobs\SendWebMentions;
+use App\Models\Note;
 use Illuminate\Http\RedirectResponse;
+use Illuminate\Http\Request;
+use Illuminate\View\View;
 
 class NotesController extends Controller
 {

app/Http/Controllers/Admin/PlacesController.php

@@ -4,17 +4,15 @@ declare(strict_types=1);
 
 namespace App\Http\Controllers\Admin;
 
-use App\Models\Place;
-use Illuminate\View\View;
-use Illuminate\Http\Request;
-use App\Services\PlaceService;
 use App\Http\Controllers\Controller;
+use App\Models\Place;
+use App\Services\PlaceService;
 use Illuminate\Http\RedirectResponse;
-use Phaza\LaravelPostgis\Geometries\Point;
+use Illuminate\View\View;
 
 class PlacesController extends Controller
 {
-    protected $placeService;
+    protected PlaceService $placeService;
 
     public function __construct(PlaceService $placeService)
     {
@@ -24,7 +22,7 @@ class PlacesController extends Controller
     /**
      * List the places that can be edited.
      *
-     * @return \Illuminate\View\View
+     * @return View
      */
     public function index(): View
     {
@@ -36,7 +34,7 @@ class PlacesController extends Controller
     /**
      * Show the form to make a new place.
      *
-     * @return \Illuminate\View\View
+     * @return View
      */
     public function create(): View
     {
@@ -46,12 +44,18 @@ class PlacesController extends Controller
     /**
      * Process a request to make a new place.
      *
-     * @return \Illuminate\Http\RedirectResponse
+     * @return RedirectResponse
      */
     public function store(): RedirectResponse
     {
-        $data = request()->only(['name', 'description', 'latitude', 'longitude']);
-        $place = $this->placeService->createPlace($data);
+        $this->placeService->createPlace(
+            request()->only([
+                'name',
+                'description',
+                'latitude',
+                'longitude',
+            ])
+        );
 
         return redirect('/admin/places');
     }
@@ -60,7 +64,7 @@ class PlacesController extends Controller
      * Display the form to edit a specific place.
      *
      * @param  int  $placeId
-     * @return \Illuminate\View\View
+     * @return View
      */
     public function edit(int $placeId): View
     {
@@ -73,17 +77,15 @@ class PlacesController extends Controller
      * Process a request to edit a place.
      *
      * @param  int  $placeId
-     * @return \Illuminate\Http\RedirectResponse
+     * @return RedirectResponse
      */
     public function update(int $placeId): RedirectResponse
     {
         $place = Place::findOrFail($placeId);
         $place->name = request()->input('name');
         $place->description = request()->input('description');
-        $place->location = new Point(
-            (float) request()->input('latitude'),
-            (float) request()->input('longitude')
-        );
+        $place->latitude = request()->input('latitude');
+        $place->longitude = request()->input('longitude');
         $place->icon = request()->input('icon');
         $place->save();
 
@@ -94,12 +96,12 @@ class PlacesController extends Controller
      * List the places we can merge with the current place.
      *
      * @param  int  $placeId
-     * @return \Illuminate\View\View
+     * @return View
      */
     public function mergeIndex(int $placeId): View
     {
         $first = Place::find($placeId);
-        $results = Place::near(new Point($first->latitude, $first->longitude))->get();
+        $results = Place::near((object) ['latitude' => $first->latitude, 'longitude' => $first->longitude])->get();
         $places = [];
         foreach ($results as $place) {
             if ($place->slug !== $first->slug) {
@@ -115,7 +117,7 @@ class PlacesController extends Controller
      *
      * @param  int  $placeId1
      * @param  int  $placeId2
-     * @return \Illuminate\View\View
+     * @return View
      */
     public function mergeEdit(int $placeId1, int $placeId2): View
     {
@@ -128,7 +130,7 @@ class PlacesController extends Controller
     /**
      * Process the request to merge two places.
      *
-     * @return \Illuminate\Http\RedirectResponse
+     * @return RedirectResponse
      */
     public function mergeStore(): RedirectResponse
     {

app/Http/Controllers/ArticlesController.php

@@ -5,18 +5,19 @@ declare(strict_types=1);
 namespace App\Http\Controllers;
 
 use App\Models\Article;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Http\RedirectResponse;
 use Illuminate\View\View;
 use Jonnybarnes\IndieWeb\Numbers;
-use Illuminate\Http\RedirectResponse;
 
 class ArticlesController extends Controller
 {
     /**
      * Show all articles (with pagination).
      *
-     * @param  int  $year
-     * @param  int  $month
-     * @return \Illuminate\View\View
+     * @param int|null $year
+     * @param int|null $month
+     * @return View
      */
     public function index(int $year = null, int $month = null): View
     {
@@ -31,19 +32,24 @@ class ArticlesController extends Controller
     /**
      * Show a single article.
      *
-     * @param  int  $year
-     * @param  int  $month
-     * @param  string  $slug
-     * @return \Illuminate\Http\RedirectResponse|\Illuminate\View\View
+     * @param int $year
+     * @param int $month
+     * @param string $slug
+     * @return RedirectResponse|View
      */
     public function show(int $year, int $month, string $slug)
     {
-        $article = Article::where('titleurl', $slug)->firstOrFail();
+        try {
+            $article = Article::where('titleurl', $slug)->firstOrFail();
+        } catch (ModelNotFoundException $exception) {
+            abort(404);
+        }
+
         if ($article->updated_at->year != $year || $article->updated_at->month != $month) {
             return redirect('/blog/'
                             . $article->updated_at->year
                             . '/' . $article->updated_at->format('m')
-                            .'/' . $slug);
+                            . '/' . $slug);
         }
 
         return view('articles.show', compact('article'));
@@ -53,13 +59,18 @@ class ArticlesController extends Controller
      * We only have the ID, work out post title, year and month
      * and redirect to it.
      *
-     * @param  int  $idFromUrl
-     * @return \Illuminte\Http\RedirectResponse
+     * @param int $idFromUrl
+     * @return RedirectResponse
      */
     public function onlyIdInUrl(int $idFromUrl): RedirectResponse
     {
-        $realId = resolve(Numbers::class)->b60tonum($idFromUrl);
-        $article = Article::findOrFail($realId);
+        $realId = resolve(Numbers::class)->b60tonum((string) $idFromUrl);
+
+        try {
+            $article = Article::findOrFail($realId);
+        } catch (ModelNotFoundException $exception) {
+            abort(404);
+        }
 
         return redirect($article->link);
     }