[main] Update framework to version 10

.env.example

@@ -5,12 +5,20 @@ APP_DEBUG=true
 APP_LOG_LEVEL=debug
 APP_URL=http://localhost
 
+APP_OFFLINE=0
+APP_PORT=8180
+APP_SERVICE=mensa.php
+WWWUSER=1000
+WWWGROUP=1000
+FORWARD_DB_PORT=3307
+
 DB_CONNECTION=mysql
 DB_HOST=127.0.0.1
 DB_PORT=3306
 DB_DATABASE=homestead
 DB_USERNAME=homestead
 DB_PASSWORD=secret
+DB_ROOT_PASSWORD=verysecret
 
 BROADCAST_DRIVER=log
 CACHE_DRIVER=file
@@ -65,4 +73,4 @@ ADLDAP_ADMIN_USERNAME=
 ADLDAP_ADMIN_PASSWORD=
 ADLDAP_CONTROLLERS=
 ADLDAP_PORT=
-ADLDAP_BASEDN=
+ADLDAP_BASEDN=

.github/workflows/docker-publish.yml

@@ -0,0 +1,81 @@
+name: Docker
+
+on:
+  push:
+    # Publish `main` as Docker `latest` image.
+    tags: [ 'v*.*.*' ]
+  workflow_dispatch:
+
+
+env:
+  # Use docker.io for Docker Hub if empty
+  REGISTRY: ghcr.io
+  # github.repository as <account>/<repo>
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  # Run tests.
+  # See also https://docs.docker.com/docker-hub/builds/automated-testing/
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Copy .env
+        run: |
+           if [[ ! -f '.env' ]];then
+               cp '.env.example' '.env'
+           fi
+      - name: Install Dependencies
+        run: composer require laravel/sail -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+
+      - name: Run tests
+        run: |
+          if [ -f docker-compose.test.yml ]; then
+            docker-compose --file docker-compose.test.yml build
+            docker-compose --file docker-compose.test.yml run sut
+          else
+            docker-compose build
+          fi
+  # Push image to GitHub Packages.
+  # See also https://docs.docker.com/docker-hub/builds/
+  push:
+    # Ensure test job passes before pushing image.
+    needs: test
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # Login against a Docker registry except on PR
+      # https://github.com/docker/login-action
+      - name: Log into registry ${{ env.REGISTRY }}
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@28218f9b04b4f3f62068d7b6ce6ca5b26e35336c
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      # Build and push Docker image with Buildx (don't push on PR)
+      # https://github.com/docker/build-push-action
+      - name: Build and push Docker image
+        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/laravel.yml

@@ -0,0 +1,36 @@
+name: Laravel
+
+on:
+  push:
+    branches: [ development ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  laravel-tests:
+
+    runs-on: ubuntu-latest
+    env: 
+        DB_CONNECTION: sqlite
+        DB_DATABASE: database.sqlite
+    steps:
+      - uses: actions/checkout@v2
+      - name: Copy .env
+        run: php -r "file_exists('.env') || copy('.env.example', '.env');"
+      - name: Install Dependencies
+        run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+      - name: Generate key
+        run: php artisan key:generate
+      - name: Directory Permissions
+        run: chmod -R 777 storage bootstrap/cache
+      - name: Create Database
+        run: |
+          mkdir -p database
+          touch database/database.sqlite
+      - name: Fill database
+        run: | 
+          php artisan migrate:fresh
+          php artisan db:seed
+      - name: Execute tests (Unit and Feature tests) via PHPUnit
+        run: vendor/bin/phpunit

README.md

@@ -0,0 +1,65 @@
+*Main*
+
+[![Docker (Branch: Main)](https://github.com/VSLCatena/mensa/actions/workflows/docker-publish.yml/badge.svg?branch=main-docker)](https://github.com/VSLCatena/mensa/actions/workflows/docker-publish.yml)
+[![Laravel (Branch: main)](https://github.com/VSLCatena/mensa/actions/workflows/laravel.yml/badge.svg?branch=main-docker)](https://github.com/VSLCatena/mensa/actions/workflows/laravel.yml)
+
+*Development*
+
+[![Docker (Branch: development)](https://github.com/VSLCatena/mensa/actions/workflows/docker-publish.yml/badge.svg?branch=development)](https://github.com/VSLCatena/mensa/actions/workflows/docker-publish.yml)
+[![Laravel (Branch: development)](https://github.com/VSLCatena/mensa/actions/workflows/laravel.yml/badge.svg?branch=development)](https://github.com/VSLCatena/mensa/actions/workflows/laravel.yml)
+
+
+# mensa
+Mensa is an enrollment system for dinner that we use at our student association.
+You can create dinners and assign them to cooks, who can change the dinner by adding a menu and changing some extra 
+info.
+
+The back-end works through a PHP server, the front-end is html/javascript which talks to back-end through AJAX calls.
+This means that with very little adjustments you could split front-end from back-end.
+
+
+## Setup
+
+### .env file
+All configuration of the app itself should be doable through the .env file.
+If you don't have a .env file available, you can duplicate the .env.example file to create a new .env file.
+
+### Authorization
+For authorization we use Active Directory. For this you'll need to make sure PHP-LDAP works
+
+### Building the app
+For production I recommend to look at, and following the 
+[Laravel deployment page](https://laravel.com/docs/8.x/deployment). 
+Here you can see the laravel requirements and some optimizations you can do for Laravel such as caching options.
+
+#### Here are just the bare minimals for development purposes:
+To set up composer (Package manager for PHP):  
+`composer install`
+
+To set up npm (Package manager for Javascript):  
+`npm install`  
+`npm run dev`
+
+To run migrations:  
+`php artisan migrate`
+
+To fill in mock data in the database:  
+`php artisan db:seed`
+
+
+
+## Running the app for development
+For running the PHP server:  
+`php artisan serve`  
+This will keep a server running, and changes are reflected immediately.  
+
+For compiling the front-end source:  
+`npm run watch`  
+This will keep npm running, a new build will automatically start on every file changes,
+so changes are reflected on page refresh.
+
+These two commands have made my life a lot better :)
+
+
+## Docker
+Info about how to get it working in docker can be found [Here](docs/DOCKER.md)

app/Console/Kernel.php

@@ -22,8 +22,10 @@ class Kernel extends ConsoleKernel
      * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
      * @return void
      */
-    protected function schedule(Schedule $schedule)
+    protected function schedule(Schedule $schedule): void
     {
+        // $schedule->command('inspire')->hourly();
+
         // Remove all expired sign ins that past the 15 minutes
         $schedule->command('users:deleteunconfirmed')
             ->everyFiveMinutes();
@@ -40,7 +42,7 @@ protected function schedule(Schedule $schedule)
      *
      * @return void
      */
-    protected function commands()
+    protected function commands(): void
     {
         $this->load(__DIR__.'/Commands');
 

app/Exceptions/Handler.php

@@ -2,75 +2,45 @@
 
 namespace App\Exceptions;
 
-use Exception;
 use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
-use Illuminate\Http\Request;
+use Throwable;
 
+use Illuminate\Http\Request;
 class Handler extends ExceptionHandler
 {
     /**
-     * A list of the exception types that are not reported.
+     * The list of the inputs that are never flashed to the session on validation exceptions.
      *
-     * @var array
-     */
-    protected $dontReport = [
-        //
-    ];
-
-    /**
-     * A list of the inputs that are never flashed for validation exceptions.
-     *
-     * @var array
+     * @var array<int, string>
      */
     protected $dontFlash = [
+        'current_password',
         'password',
         'password_confirmation',
     ];
 
     /**
-     * Report or log an exception.
-     *
-     * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
-     *
-     * @param  \Exception  $exception
-     * @return void
+     * Register the exception handling callbacks for the application.
      */
-    public function report(Exception $exception)
+    public function register(): void
     {
-        parent::report($exception);
-    }
-
-    /**
-     * Render an exception into an HTTP response.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Exception  $exception
-     * @return \Illuminate\Http\Response
-     */
-    public function render($request, Exception $exception)
-    {
-        if($this->isHttpException($exception))
-        {
-            switch ($exception->getStatusCode())
-            {
-                // not found
-                case 404:
-                    return redirect(route('home'));
-                    break;
-
-                // internal error
-                case '500':
-                    return redirect(route('home'));
-                    break;
-
-                default:
-                    return $this->renderHttpException($exception);
-                    break;
+        $this->renderable(function (Throwable $exception, Request $request) {
+             if($this->isHttpException($exception))
+             {
+                switch ($exception->getStatusCode())
+                {
+                    case 404:
+                        return redirect(route('home'));
+                        break;
+                    case '500':
+                        return redirect(route('home'));
+                        break;
+
+                    default:
+                        return $this->renderHttpException($exception);
+                        break;
+                }
             }
-        }
-        else
-        {
-            return parent::render($request, $exception);
-        }
+        });
     }
 }

app/Http/Controllers/Controller.php

@@ -2,12 +2,11 @@
 
 namespace App\Http\Controllers;
 
-use Illuminate\Foundation\Bus\DispatchesJobs;
 use Illuminate\Routing\Controller as BaseController;
 use Illuminate\Foundation\Validation\ValidatesRequests;
 use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
 
 class Controller extends BaseController
 {
-    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
+    use AuthorizesRequests, ValidatesRequests;
 }