Implemented some of the improvements from codacy

cz-lucas · cz-lucas · commit dabd04e8a1b1 · 2025-11-28T15:01:11.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -70,4 +70,7 @@ storage/ldap_client_tls.cert
 storage/ldap_client_tls.key
 /storage/framework/testing
 
-/.phpunit.cache
+/.phpunit.cache
+
+#Ignore vscode AI rules
+.github/instructions/codacy.instructions.md
diff --git a/app/Http/Controllers/Api/PredefinedFilterController.php b/app/Http/Controllers/Api/PredefinedFilterController.php
@@ -37,9 +37,9 @@ public function index(Request $request) : JsonResponse | array
         $sort = $request->input('sort', 'name');
         $order = $request->input('order', 'asc');
 
-        $allowed_columns = ['id', 'name', 'is_public', 'created_by'];
+        $allowedColumns = ['id', 'name', 'is_public', 'created_by'];
         
-        if (!in_array($sort, $allowed_columns)) {
+        if (!in_array($sort, $allowedColumns)) {
             $sort = 'name';
         }
 
diff --git a/app/Http/Controllers/Assets/AssetsController.php b/app/Http/Controllers/Assets/AssetsController.php
@@ -49,6 +49,7 @@ class AssetsController extends Controller
     protected $qrCodeDimensions = ['height' => 3.5, 'width' => 3.5];
     protected $barCodeDimensions = ['height' => 2, 'width' => 22];
     protected PredefinedFilterService $predefinedFilterService;
+
     public function __construct(PredefinedFilterService $predefinedFilterService)
     {
         $this->middleware('auth');
@@ -74,7 +75,7 @@ public function index(Request $request): View
         $advancedSearchViewPermission = AdvancedSearch::userHasViewPermission($user);
         $predefined_filter_id = $request->input('predefinedFilterId');
         
-        if($advancedSearchViewPermission) {
+        if ($advancedSearchViewPermission) {
             // Validate if it's a valid integer
             if (filter_var($predefined_filter_id, FILTER_VALIDATE_INT) === false && $predefined_filter_id != null) {
                 throw new InvalidArgumentException('You provided an invalid parameter for predefinedFilterId (must be an integer).');
@@ -96,10 +97,11 @@ public function index(Request $request): View
             $predefined_filter_name = null;
         }
 
-        return view('hardware/index')->with('company', $company)
-                                     ->with('advanced_search_permission', $advancedSearchViewPermission)
-                                     ->with('predefined_filter_id', $predefined_filter_id)
-                                     ->with('predefined_filter_name', $predefined_filter_name);
+        return view('hardware/index')
+            ->with('company', $company)
+            ->with('advanced_search_permission', $advancedSearchViewPermission)
+            ->with('predefined_filter_id', $predefined_filter_id)
+            ->with('predefined_filter_name', $predefined_filter_name);
     }
 
     /**
@@ -589,7 +591,7 @@ public function getAssetBySerial(Request $request): RedirectResponse
      * @since [v3.0]
      * @return \Illuminate\Http\RedirectResponse
      */
-    public function getAssetByTag(Request $request, $tag = null): RedirectResponse
+    public function getAssetByTag(Request $request, $tag=null): RedirectResponse
     {
         $tag = $tag ? $tag : $request->get('assetTag');
         $topsearch = ($request->get('topsearch') == 'true');
diff --git a/app/Http/Controllers/PredefinedFilterController.php b/app/Http/Controllers/PredefinedFilterController.php
@@ -57,11 +57,11 @@ public function view(PredefinedFilter $filter) : View|RedirectResponse
     *
     * @param  int $Id
     */
-    public function destroy($Id) : RedirectResponse
+    public function destroy($id) : RedirectResponse
     {
         $user = auth()->user();
 
-        $filter = PredefinedFilter::find($Id);
+        $filter = PredefinedFilter::find($id);
 
         if (!$filter) {
             return redirect()->route('predefined-filters.index')
diff --git a/app/Http/Transformers/PredefinedFiltersTransformer.php b/app/Http/Transformers/PredefinedFiltersTransformer.php
@@ -53,14 +53,13 @@ public function transformPredefinedFilter($filter)
             }
             $array['groups'] = $groups;
         } else {
-
             $array['groups'] = null;
         }
 
-        $permissions_array['available_actions'] = [
+        $permissionsArray['available_actions'] = [
             'update' => $filter->created_by === auth()->id() || $filter->userHasPermission(auth()->user(), 'edit'),
             'delete' => $filter->created_by === auth()->id() || $filter->userHasPermission(auth()->user(), 'delete')
         ];
-        return $array += $permissions_array;
+        return $array += $permissionsArray;
     }
 }
diff --git a/app/Services/FilterService/FilterService.php b/app/Services/FilterService/FilterService.php
@@ -8,6 +8,7 @@
 use App\Models\User;
 use App\Models\Location;
 use App\Models\Asset;
+use UnexpectedValueException;
 
 class FilterService
 {
@@ -231,7 +232,7 @@ protected function handleAssignedTo($value, $inner, $operator){
         // Check if type is valid
         $validTypes = [Asset::class, Location::class, User::class];
         if (!in_array($value['type'], $validTypes)) {
-            throw new \UnexpectedValueException('You\'ve provided an invalid type');
+            throw new UnexpectedValueException('You\'ve provided an invalid type');
         }
                 
         if ($value['value'] == '') {
diff --git a/app/Services/PredefinedFilterPermissionService.php b/app/Services/PredefinedFilterPermissionService.php
@@ -34,16 +34,16 @@ public function delete(int $id): void
         $permission->delete();
     }
 
-    public function deletePermissionByFilterId($filter_id): void
+    public function deletePermissionByFilterId($filterId): void
     {
-        $permissions = PredefinedFilterPermission::where('predefined_filter_id', '=', $filter_id)->get();
+        $permissions = PredefinedFilterPermission::where('predefined_filter_id', '=', $filterId)->get();
         foreach($permissions as $permission) {
             $permission->delete();
         }
     }
 
-    public function getPermissionsByPredefinedFilterId(int $filter_id)
+    public function getPermissionsByPredefinedFilterId(int $filterId)
     {
-        return PredefinedFilterPermission::where('predefined_filter_id', '=', $filter_id)->get();
+        return PredefinedFilterPermission::where('predefined_filter_id', '=', $filterId)->get();
     }
 }
diff --git a/app/Services/PredefinedFilterService.php b/app/Services/PredefinedFilterService.php
@@ -54,10 +54,10 @@ public function getAllViewableFilters(): Collection
             })->values();
     }
 
-    public function getFilterWithOptionalPermissionsById(int $id, bool $include_predefined_filter_groups = true)
+    public function getFilterWithOptionalPermissionsById(int $id, bool $includePredefinedFilterGroups = true)
     {
         $predefinedFilter = PredefinedFilter::find($id);
-        if ($include_predefined_filter_groups && $predefinedFilter) {
+        if ($includePredefinedFilterGroups && $predefinedFilter) {
             $permissions = $this->predefinedFilterPermissionService->getPermissionsByPredefinedFilterId($id);
             $predefinedFilter['permissions'] = $permissions;
         }
@@ -142,7 +142,7 @@ public function getFilterWithIdAndNameValues(int $id)
 
     public function createFilter($validated): PredefinedFilter
     {
-        $filter_create_response = PredefinedFilter::create([
+        $createResponse = PredefinedFilter::create([
             'name' => $validated['name'],
             'filter_data' => $validated['filter_data'],
             'created_by' => Auth::id(),
@@ -152,12 +152,12 @@ public function createFilter($validated): PredefinedFilter
         // Set permissions
         if (array_key_exists('permissions', $validated) && count($validated['permissions']) > 0) {
             foreach ($validated['permissions'] as $permission) {
-                $permission['predefined_filter_id'] = $filter_create_response->id;
+                $permission['predefined_filter_id'] = $createResponse->id;
                 $this->predefinedFilterPermissionService->store($permission);
             }
         }
 
-        return $filter_create_response;
+        return $createResponse;
     }
 
     public function updateFilter(PredefinedFilter $filter, array $validated): PredefinedFilter
@@ -172,9 +172,9 @@ public function updateFilter(PredefinedFilter $filter, array $validated): Predef
 
         // Update permissions
         if (array_key_exists('permissions', $validated)) {
-            $currently_set_permssions = $this->predefinedFilterPermissionService->getPermissionsByPredefinedFilterId($filter->id);
-            $new_permissions = $validated['permissions'];
-            $permission_diff = $this->syncPermissions($currently_set_permssions->toArray(), $new_permissions);
+            $currentlySetPermssions = $this->predefinedFilterPermissionService->getPermissionsByPredefinedFilterId($filter->id);
+            $newPermissions = $validated['permissions'];
+            $permission_diff = $this->syncPermissions($currentlySetPermssions->toArray(), $newPermissions);
 
             try {
                 DB::transaction(function () use ($permission_diff, $filter) {
diff --git a/database/seeders/PredefinedFilterPermissionSeeder.php b/database/seeders/PredefinedFilterPermissionSeeder.php
@@ -20,10 +20,10 @@ public function run(): void
     {
         PredefinedFilterPermission::query()->delete();
 
-        $user_to_delete = User::where("email","predefinedfilters@permission.com")->first();
+        $userToDelete = User::where("email","predefinedfilters@permission.com")->first();
 
-        if ($user_to_delete) {
-            $user_to_delete->delete();
+        if ($userToDelete) {
+            $userToDelete->delete();
         }
 
         $user = User::firstOrCreate(
diff --git a/resources/assets/js/advancedSearch/filterInputs.js b/resources/assets/js/advancedSearch/filterInputs.js
@@ -305,7 +305,6 @@ class AssignedEntityFilterInput extends TextFilterInput {
             type: type,
             value: value
         }
-
     }
 
     setValue(newValue, logic, operator) {
diff --git a/tests/Feature/AssetQuery/CombinedQueryTest.php b/tests/Feature/AssetQuery/CombinedQueryTest.php
diff --git a/tests/Unit/Models/PredefinedFilter/PredefinedFilterFilterAssetsTest.php b/tests/Unit/Models/PredefinedFilter/PredefinedFilterFilterAssetsTest.php

Original file line number	Diff line number	Diff line change
`@@ -37,9 +37,9 @@ public function index(Request $request) : JsonResponse \| array`
`37`	`37`	`$sort = $request->input('sort', 'name');`
`38`	`38`	`$order = $request->input('order', 'asc');`
`39`	`39`
`40`		`- $allowed_columns = ['id', 'name', 'is_public', 'created_by'];`
	`40`	`+ $allowedColumns = ['id', 'name', 'is_public', 'created_by'];`
`41`	`41`
`42`		`- if (!in_array($sort, $allowed_columns)) {`
	`42`	`+ if (!in_array($sort, $allowedColumns)) {`
`43`	`43`	`$sort = 'name';`
`44`	`44`	`}`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -57,11 +57,11 @@ public function view(PredefinedFilter $filter) : View\|RedirectResponse`
`57`	`57`	`*`
`58`	`58`	`* @param int $Id`
`59`	`59`	`*/`
`60`		`- public function destroy($Id) : RedirectResponse`
	`60`	`+ public function destroy($id) : RedirectResponse`
`61`	`61`	`{`
`62`	`62`	`$user = auth()->user();`
`63`	`63`
`64`		`- $filter = PredefinedFilter::find($Id);`
	`64`	`+ $filter = PredefinedFilter::find($id);`
`65`	`65`
`66`	`66`	`if (!$filter) {`
`67`	`67`	`return redirect()->route('predefined-filters.index')`
Original file line number	Diff line number	Diff line change
`@@ -53,14 +53,13 @@ public function transformPredefinedFilter($filter)`
`53`	`53`	`}`
`54`	`54`	`$array['groups'] = $groups;`
`55`	`55`	`} else {`
`56`		`-`
`57`	`56`	`$array['groups'] = null;`
`58`	`57`	`}`
`59`	`58`
`60`		`- $permissions_array['available_actions'] = [`
	`59`	`+ $permissionsArray['available_actions'] = [`
`61`	`60`	`'update' => $filter->created_by === auth()->id() \|\| $filter->userHasPermission(auth()->user(), 'edit'),`
`62`	`61`	`'delete' => $filter->created_by === auth()->id() \|\| $filter->userHasPermission(auth()->user(), 'delete')`
`63`	`62`	`];`
`64`		`- return $array += $permissions_array;`
	`63`	`+ return $array += $permissionsArray;`
`65`	`64`	`}`
`66`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`use App\Models\User;`
`9`	`9`	`use App\Models\Location;`
`10`	`10`	`use App\Models\Asset;`
	`11`	`+use UnexpectedValueException;`
`11`	`12`
`12`	`13`	`class FilterService`
`13`	`14`	`{`
`@@ -231,7 +232,7 @@ protected function handleAssignedTo($value, $inner, $operator){`
`231`	`232`	`// Check if type is valid`
`232`	`233`	`$validTypes = [Asset::class, Location::class, User::class];`
`233`	`234`	`if (!in_array($value['type'], $validTypes)) {`
`234`		`- throw new \UnexpectedValueException('You\'ve provided an invalid type');`
	`235`	`+ throw new UnexpectedValueException('You\'ve provided an invalid type');`
`235`	`236`	`}`
`236`	`237`
`237`	`238`	`if ($value['value'] == '') {`
Original file line number	Diff line number	Diff line change
`@@ -34,16 +34,16 @@ public function delete(int $id): void`
`34`	`34`	`$permission->delete();`
`35`	`35`	`}`
`36`	`36`
`37`		`- public function deletePermissionByFilterId($filter_id): void`
	`37`	`+ public function deletePermissionByFilterId($filterId): void`
`38`	`38`	`{`
`39`		`- $permissions = PredefinedFilterPermission::where('predefined_filter_id', '=', $filter_id)->get();`
	`39`	`+ $permissions = PredefinedFilterPermission::where('predefined_filter_id', '=', $filterId)->get();`
`40`	`40`	`foreach($permissions as $permission) {`
`41`	`41`	`$permission->delete();`
`42`	`42`	`}`
`43`	`43`	`}`
`44`	`44`
`45`		`- public function getPermissionsByPredefinedFilterId(int $filter_id)`
	`45`	`+ public function getPermissionsByPredefinedFilterId(int $filterId)`
`46`	`46`	`{`
`47`		`- return PredefinedFilterPermission::where('predefined_filter_id', '=', $filter_id)->get();`
	`47`	`+ return PredefinedFilterPermission::where('predefined_filter_id', '=', $filterId)->get();`
`48`	`48`	`}`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,10 +20,10 @@ public function run(): void`
`20`	`20`	`{`
`21`	`21`	`PredefinedFilterPermission::query()->delete();`
`22`	`22`
`23`		`- $user_to_delete = User::where("email","[email protected]")->first();`
	`23`	`+ $userToDelete = User::where("email","[email protected]")->first();`
`24`	`24`
`25`		`- if ($user_to_delete) {`
`26`		`- $user_to_delete->delete();`
	`25`	`+ if ($userToDelete) {`
	`26`	`+ $userToDelete->delete();`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`$user = User::firstOrCreate(`
Original file line number	Diff line number	Diff line change
`@@ -305,7 +305,6 @@ class AssignedEntityFilterInput extends TextFilterInput {`
`305`	`305`	`type: type,`
`306`	`306`	`value: value`
`307`	`307`	`}`
`308`		`-`
`309`	`308`	`}`
`310`	`309`
`311`	`310`	`setValue(newValue, logic, operator) {`