feat: added support for category grouping

database/migrations/create_pigeonhole_table.php.stub

@@ -13,6 +13,7 @@ return new class extends Migration
 
  $table->unsignedBigInteger('team_id')->nullable();
 
+ $table->string('type')->nullable();
  $table->string('name');
 
  $table->timestamps();

src/Actions/CreateCategory.php

@@ -9,7 +9,7 @@
 class CreateCategory implements CreatesCategories
 {
  /**
- * Create a new tax.
+ * Create a new category.
  *
  * @param mixed $user
  * @param array $data
@@ -28,10 +28,12 @@ public function __invoke($user, array $data, $teamId = null)
 
  Validator::make($data, [
  'name' => 'required|string|max:255',
+ 'type' => 'nullable|string|max:255',
  ])->validateWithBag('createCategory');
 
  $fields = collect($data)->only([
  'name',
+ 'type',
  ])->toArray();
 
  return Pigeonhole::$supportsTeams ?

src/Category.php

@@ -2,6 +2,7 @@
 
 namespace StarfolkSoftware\Pigeonhole;
 
+use Illuminate\Contracts\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphToMany;
@@ -24,6 +25,7 @@ class Category extends Model
  */
  protected $fillable = [
  'name',
+ 'type',
  ];
 
  /**
@@ -34,7 +36,7 @@ class Category extends Model
  protected $casts = [];
 
  /**
- * Get the team that owns the tax.
+ * Get the team that owns the category.
  *
  * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
  */
@@ -61,4 +63,28 @@ public function entries(string $class): MorphToMany
  'id'
  );
  }
+
+ /**
+ * Scope query with all the given types.
+ * 
+ * @param \Illuminate\Database\Eloquent\Builder $query
+ * @param array $types
+ * @return \Illuminate\Database\Eloquent\Builder
+ */
+ public function scopeOfTypes(Builder $query, array $types): Builder
+ {
+ return $query->whereIn('type', $types);
+ }
+
+ /**
+ * Scope query with the given type.
+ * 
+ * @param \Illuminate\Database\Eloquent\Builder $query
+ * @param string $type
+ * @return \Illuminate\Database\Eloquent\Builder
+ */
+ public function scopeOfType(Builder $query, string $type): Builder
+ {
+ return $query->where('type', $type);
+ }
 }

src/Contracts/CreatesCategories.php

@@ -5,7 +5,7 @@
 interface CreatesCategories
 {
  /**
- * Create a new tax.
+ * Create a new category.
  *
  * @param mixed $user
  * @param array $data

src/Contracts/DeletesCategories.php

@@ -7,11 +7,11 @@
 interface DeletesCategories
 {
  /**
- * Delete an existing tax.
+ * Delete an existing category.
  *
  * @param mixed $user
- * @param \StarfolkSoftware\Pigeonhole\Category $tax
+ * @param \StarfolkSoftware\Pigeonhole\Category $category
  * @return void
  */
- public function __invoke($user, Category $tax);
+ public function __invoke($user, Category $category);
 }

src/Contracts/UpdatesCategories.php

@@ -7,12 +7,12 @@
 interface UpdatesCategories
 {
  /**
- * Update an existing tax.
+ * Update an existing category.
  *
  * @param mixed $user
- * @param \StarfolkSoftware\Pigeonhole\Category $tax
+ * @param \StarfolkSoftware\Pigeonhole\Category $category
  * @param array $data
  * @return \StarfolkSoftware\Pigeonhole\Category
  */
- public function __invoke($user, Category $tax, array $data);
+ public function __invoke($user, Category $category, array $data);
 }

tests/Feature/Actions/CreateCategoryTest.php

@@ -0,0 +1,51 @@
+<?php
+
+use StarfolkSoftware\Pigeonhole\Category;
+use StarfolkSoftware\Pigeonhole\Contracts\CreatesCategories;
+use StarfolkSoftware\Pigeonhole\Tests\Mocks\TestUser;
+
+beforeAll(function () {
+ \StarfolkSoftware\Pigeonhole\Pigeonhole::supportsTeams(false);
+});
+
+it('can create a category', function () {
+ $createsCategories = app(CreatesCategories::class);
+
+ $user = TestUser::first();
+
+ $category = $createsCategories(
+ $user,
+ [
+ 'name' => 'Category',
+ ]
+ );
+
+ expect($category->refresh())
+ ->name->toBe('Category');
+});
+
+it('can create a category with type', function () {
+ $createsCategories = app(CreatesCategories::class);
+
+ $user = TestUser::first();
+
+ $category = $createsCategories(
+ $user,
+ [
+ 'name' => 'Category',
+ 'type' => 'product',
+ ]
+ );
+
+ expect($category->refresh())
+ ->name->toBe('Category');
+
+ expect($category->refresh())
+ ->type->toBe('product');
+
+ expect(Category::ofType('product')->count())
+ ->toBe(1);
+
+ expect(Category::ofTypes(['product', 'project'])->count())
+ ->toBe(1);
+});

tests/Feature/Actions/CategoryUpdateTest.php → tests/Feature/Actions/UpdateCategoryTest.php

@@ -8,21 +8,21 @@
  \StarfolkSoftware\Pigeonhole\Pigeonhole::supportsTeams(false);
 });
 
-it('can update a tax', function () {
+it('can update a category', function () {
  $updatesCategories = app(UpdatesCategories::class);
 
  $user = TestUser::first();
 
- $tax = Category::factory()->create();
+ $category = Category::factory()->create();
 
- $tax = $updatesCategories(
+ $category = $updatesCategories(
  $user,
- $tax,
+ $category,
  [
  'name' => 'Category',
  ]
  );
 
- expect($tax->refresh())
+ expect($category->refresh())
  ->name->toBe('Category');
 });

tests/Feature/CategoriesTest.php

@@ -12,14 +12,22 @@
 
  $response = actingAs($user)->post(route('categories.store'), [
  'name' => 'Category',
+ 'type' => 'product',
  'redirect' => '/redirect/path',
  ]);
 
  $response->assertRedirect('/redirect/path');
 
  $this->assertDatabaseHas('categories', [
  'name' => 'Category',
+ 'type' => 'product',
  ]);
+
+ expect(Category::count())->toEqual(1);
+
+ expect(Category::ofType('product')->count())->toEqual(1);
+
+ expect(Category::ofTypes(['product', 'project'])->count())->toEqual(1);
 });
 
 test('category can be updated', function () {