Update CI Image (#37)

* Updating ci image to cimg/php:8.1.

* Updating styleci.

* Apply fixes from StyleCI

* Updating ci to version 2.1.

* Adding pecl install xdebug to ci.

Co-authored-by: StyleCI Bot <bot@styleci.io>

Author: ericdowell

.circleci/config.yml

@@ -1,12 +1,17 @@
-version: 2
+version: 2.1
 jobs:
   build:
     docker:
-      - image: ericdowell/laravel-circleci
+      - image: cimg/php:8.1
     environment:
       TZ: "/usr/share/zoneinfo/America/Chicago"
     steps:
       - checkout
+      - run:
+          name: Enable xdebug Extension
+          command: |
+            sudo pecl install xdebug
+            sudo docker-php-ext-enable xdebug
       - run:
           name: Install PHP Dependencies
           command: composer install --no-interaction --optimize-autoloader --prefer-dist

.styleci.yml

@@ -1 +1,6 @@
 preset: laravel
+disabled:
+  - no_unused_imports
+finder:
+  not-name:
+    - phpunit.php

src/Commands/RegisterUser.php

@@ -33,6 +33,7 @@ class RegisterUser extends Command
      * Execute the console command.
      *
      * @return mixed
+     *
      * @throws \RuntimeException
      */
     public function handle(): int
@@ -56,8 +57,7 @@ public function handle(): int
     /**
      * Get all the attributes to create the User model with.
      *
-     * @param \Illuminate\Database\Eloquent\Model $userInstance
-     *
+     * @param  \Illuminate\Database\Eloquent\Model  $userInstance
      * @return array
      */
     protected function getUserAttributes(Model $userInstance): array
@@ -86,6 +86,7 @@ protected function getUserAttributes(Model $userInstance): array
      * Return contents of json file if option is present.
      *
      * @return array
+     *
      * @throws \RuntimeException
      */
     protected function getAttributesFromFile(): array
@@ -104,8 +105,7 @@ protected function getAttributesFromFile(): array
     /**
      * Make sure email is valid, set email as part of attributes.
      *
-     * @param array $attributes
-     *
+     * @param  array  $attributes
      * @return void
      */
     protected function askForEmail(array &$attributes)
@@ -124,8 +124,7 @@ protected function askForEmail(array &$attributes)
     /**
      * Make sure password and confirmation password match, set hashed password as part of attributes.
      *
-     * @param array $attributes
-     *
+     * @param  array  $attributes
      * @return void
      */
     protected function askForPassword(array &$attributes)

src/Contracts/Models/MediaModel.php

@@ -26,7 +26,7 @@ public static function storage(): FilesystemAdapter;
     public function getBasePath(): string;
 
     /**
-     * @param \Illuminate\Http\UploadedFile $file
+     * @param  \Illuminate\Http\UploadedFile  $file
      * @return string
      */
     public function generatePath(UploadedFile $file): string;
@@ -37,33 +37,33 @@ public function generatePath(UploadedFile $file): string;
     public function getUrlAttribute(): string;
 
     /**
-     * @param \Illuminate\Http\UploadedFile $file
+     * @param  \Illuminate\Http\UploadedFile  $file
      * @return string
      */
     public function getFilename(UploadedFile $file): string;
 
     /**
      * Save a new model and return the instance.
      *
-     * @param \Illuminate\Http\UploadedFile $file
-     * @param array $attributes
+     * @param  \Illuminate\Http\UploadedFile  $file
+     * @param  array  $attributes
      * @return \ResourceController\Traits\Models\MediaModel|\Illuminate\Database\Eloquent\Model
      */
     public function createMedia(UploadedFile $file, array $attributes = []): Model;
 
     /**
      * Create and return an un-saved model instance, but file saved to disk.
      *
-     * @param \Illuminate\Http\UploadedFile $file
-     * @param  array $attributes
+     * @param  \Illuminate\Http\UploadedFile  $file
+     * @param  array  $attributes
      * @return \ResourceController\Traits\Models\MediaModel|\Illuminate\Database\Eloquent\Model
      */
     public function makeMedia(UploadedFile $file, array $attributes = []): Model;
 
     /**
      * Fill the model with an array of attributes.
      *
-     * @param \Illuminate\Http\UploadedFile $file
+     * @param  \Illuminate\Http\UploadedFile  $file
      * @return Model
      */
     public function fillMedia(UploadedFile $file): Model;

src/Controllers/AbstractModelController.php

@@ -124,6 +124,7 @@ protected function setModelAction(string $action): self
      * @param  string  $name
      * @param  \Illuminate\Http\Request|null  $request
      * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Model
+     *
      * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
      */
     protected function getModelParameter(string $name, Request $request = null): Model
@@ -141,7 +142,7 @@ protected function getModelParameter(string $name, Request $request = null): Mod
     }
 
     /**
-     * @param string $name
+     * @param  string  $name
      * @return string
      */
     protected function guessModelParameterNamespace(string $name): string
@@ -150,7 +151,7 @@ protected function guessModelParameterNamespace(string $name): string
     }
 
     /**
-     * @param string $name
+     * @param  string  $name
      * @return string
      */
     protected function guessModelParameterClass(string $name): string
@@ -160,7 +161,7 @@ protected function guessModelParameterClass(string $name): string
 
     /**
      * @param  string  $name
-     * @param  mixed   $model
+     * @param  mixed  $model
      * @return \Illuminate\Database\Eloquent\Model
      */
     protected function guessModelParameterFindOrFail(string $name, $model): Model
@@ -191,6 +192,7 @@ protected function getUserModel(Request $request = null): Model
      * an instanceof a specific interface/class.
      *
      * @param  \Illuminate\Database\Eloquent\Model  $model
+     *
      * @throws \RuntimeException
      */
     protected function isModelInstanceOf(Model $model): void
@@ -540,6 +542,7 @@ protected function gateDestroy(Model $instance): void
      *
      * @param  \Illuminate\Http\Request  $request
      * @return \Symfony\Component\HttpFoundation\Response|\Illuminate\Http\JsonResponse
+     *
      * @throws \Exception
      */
     public function destroy(Request $request)

src/Controllers/JsonHtml/AbstractModelController.php

@@ -58,6 +58,7 @@ protected function additionalViewData(array &$data): void
      * @param  int  $status
      * @param  array  $headers
      * @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
+     *
      * @throws \Throwable
      */
     protected function response($data = [], $status = null, array $headers = [])
@@ -132,6 +133,7 @@ protected function gateCreate(Model $instance): void
      * Show the form for creating a new resource.
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Throwable|\Symfony\Component\HttpKernel\Exception\NotFoundHttpException
      */
     public function create()
@@ -160,6 +162,7 @@ protected function gateEdit(Model $instance): void
      * Show the form for editing the specified resource.
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Throwable|\Symfony\Component\HttpKernel\Exception\NotFoundHttpException
      */
     public function edit()

src/ServiceProvider.php

@@ -50,8 +50,7 @@ protected function packageName()
     /**
      * Return the base path for this package.
      *
-     * @param string $path
-     *
+     * @param  string  $path
      * @return string
      */
     protected function packageBasePath(string $path)

src/Traits/Controllers/Response/WithHtml.php

@@ -35,6 +35,7 @@ protected function getTemplateName(): string
      *
      * @param  \Illuminate\Contracts\Support\Arrayable|array  $data
      * @return array|string
+     *
      * @throws \Throwable
      */
     protected function renderHtml(array $data = [])
@@ -51,6 +52,7 @@ protected function renderHtml(array $data = [])
      * @param  int  $status
      * @param  array  $headers
      * @return \Symfony\Component\HttpFoundation\Response|\Illuminate\Http\Response
+     *
      * @throws \Throwable
      */
     protected function response($data = [], $status = 200, array $headers = [])

src/Traits/Controllers/UploadMediaFile.php

@@ -36,6 +36,7 @@ abstract protected function setForeignKeys(FormRequest $request, array &$attribu
 
     /**
      * @param  \Illuminate\Database\Eloquent\Model  $model
+     *
      * @throws \RuntimeException
      */
     protected function isModelInstanceOf(Model $model): void
@@ -62,6 +63,7 @@ protected function getMedia(FormRequest $request): UploadedFile
      *
      * @param  FormRequest  $request
      * @return \Illuminate\Database\Eloquent\Model
+     *
      * @throws \RuntimeException
      */
     protected function modelCreate(FormRequest $request): Model

tests/src/Models/TestPost.php

@@ -11,12 +11,14 @@
  *
  * @property-read \ResourceController\Tests\Models\TestUser $user
  * @mixin \Illuminate\Database\Eloquent\Builder
+ *
  * @property int $id
  * @property string $title
  * @property string $body
  * @property int $test_user_id
  * @property \Carbon\Carbon|null $created_at
  * @property \Carbon\Carbon|null $updated_at
+ *
  * @method static \Illuminate\Database\Eloquent\Builder|\ResourceController\Tests\Models\TestPost whereBody($value)
  * @method static \Illuminate\Database\Eloquent\Builder|\ResourceController\Tests\Models\TestPost whereCreatedAt($value)
  * @method static \Illuminate\Database\Eloquent\Builder|\ResourceController\Tests\Models\TestPost whereId($value)