Skip to content

Adds Form Request for Creating Departments #16973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions app/Http/Controllers/Api/DepartmentsController.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use App\Helpers\Helper;
use App\Http\Controllers\Controller;
use App\Http\Requests\StoreDepartmentRequest;
use App\Http\Transformers\DepartmentsTransformer;
use App\Http\Transformers\SelectlistTransformer;
use App\Models\Department;
Expand Down Expand Up @@ -94,11 +95,10 @@ public function index(Request $request) : JsonResponse | array
* @since [v4.0]
* @param \App\Http\Requests\ImageUploadRequest $request
*/
public function store(ImageUploadRequest $request) : JsonResponse
public function store(StoreDepartmentRequest $request): JsonResponse
{
$this->authorize('create', Department::class);
$department = new Department;
$department->fill($request->all());
$department->fill($request->validated());
$department = $request->handleImages($department);

$department->created_by = auth()->id();
Expand Down
32 changes: 32 additions & 0 deletions app/Http/Requests/StoreDepartmentRequest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?php

namespace App\Http\Requests;

use App\Models\Department;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Facades\Gate;

class StoreDepartmentRequest extends ImageUploadRequest
{
/**
* Determine if the user is authorized to make this request.
*/
public function authorize(): bool
{
return Gate::allows('create', new Department);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably need to allow this for users who can edit departments as well?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just the store request, update request would be separate

}

/**
* Get the validation rules that apply to the request.
*
* @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array<mixed>|string>
*/
public function rules(): array
{
$modelRules = (new Department)->getRules();

return array_merge(
$modelRules,
);
}
}
11 changes: 7 additions & 4 deletions app/Models/Department.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,13 @@ class Department extends SnipeModel
];

protected $rules = [
'name' => 'required|max:255|is_unique_department',
'location_id' => 'numeric|nullable',
'company_id' => 'numeric|nullable',
'manager_id' => 'numeric|nullable',
'name' => 'required|max:255|is_unique_department',
'location_id' => 'numeric|nullable|exists:locations,id',
'company_id' => 'numeric|nullable|exists:companies,id',
'manager_id' => 'numeric|nullable|exists:users,id',
'phone' => 'string|max:255|nullable',
'fax' => 'string|max:255|nullable',
'notes' => 'string|max:255|nullable',
];

/**
Expand Down
77 changes: 71 additions & 6 deletions tests/Feature/Departments/Api/CreateDepartmentsTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
namespace Tests\Feature\Departments\Api;

use App\Models\AssetModel;
use App\Models\Company;
use App\Models\Department;
use App\Models\Category;
use App\Models\Location;
use App\Models\User;
use Illuminate\Testing\Fluent\AssertableJson;
use Tests\TestCase;
Expand All @@ -13,30 +15,93 @@ class CreateDepartmentsTest extends TestCase
{


public function testRequiresPermissionToCreateDepartment()
public function test_requires_permission_to_create_department()
{
$this->actingAsForApi(User::factory()->create())
->postJson(route('api.departments.store'))
->assertForbidden();
}

public function testCanCreateDepartment()
public function test_can_create_department_with_all_fields()
{
$response = $this->actingAsForApi(User::factory()->superuser()->create())
$company = Company::factory()->create();
$location = Location::factory()->create();
$manager = User::factory()->create();
$user = User::factory()->superuser()->create();
$response = $this->actingAsForApi($user)
->postJson(route('api.departments.store'), [
'name' => 'Test Department',
'notes' => 'Test Note',
'name' => 'Test Department',
'company_id' => $company->id,
'location_id' => $location->id,
'manager_id' => $manager->id,
'notes' => 'Test Note',
'phone' => '1234567890',
'fax' => '1234567890',
])
->assertOk()
->assertStatusMessageIs('success')
->assertStatus(200)
->json();

$this->assertTrue(Department::where('name', 'Test Department')->exists());

$department = Department::find($response['payload']['id']);
$this->assertEquals('Test Department', $department->name);
$this->assertEquals('Test Note', $department->notes);

$this->assertDatabaseHas('departments', [
'name' => 'Test Department',
'company_id' => $company->id,
'location_id' => $location->id,
'manager_id' => $manager->id,
'notes' => 'Test Note',
'phone' => '1234567890',
'fax' => '1234567890',
'created_by' => $user->id,
]);
}

public function test_name_required_for_department()
{
$response = $this->actingAsForApi(User::factory()->superuser()->create())
->postJson(route('api.departments.store'), [
'company_id' => Company::factory()->create()->id,
])
->assertOk()
->assertStatusMessageIs('error');
}

public function test_only_name_required_for_department()
{
$response = $this->actingAsForApi(User::factory()->superuser()->create())
->postJson(route('api.departments.store'), [
'name' => 'Test Department',
])
->assertOk()
->assertStatusMessageIs('success');
}

public function test_arrays_not_allowed_for_numeric_fields()
{
$response = $this->actingAsForApi(User::factory()->superuser()->create())
->postJson(route('api.departments.store'), [
'name' => 'Test Department',
'company_id' => [1, 2],
])
->assertOk()
->assertStatusMessageIs('error');
}

public function test_arrays_of_strings_are_not_allowed_for_numeric_fields()
{
$response = $this->actingAsForApi(User::factory()->superuser()->create())
->postJson(route('api.departments.store'), [
'name' => 'Test Department',
'company_id' => ['1', '2'],
])
->assertOk()
->assertStatusMessageIs('error');
}



}
Loading