feat: refactor to configurable model and merged PR #8 (#9)

* fix: getNestedTree with Model::shouldBeStrict()

* ci(tests): update test workflow to include coverage and upgrade codecov

* refactor(command): extract model class retrieval to method

* feat(enums): add documentation and utility methods

* feat(taxonomy): make taxonomy model configurable

* test: add comprehensive test coverage for taxonomy features

* style(tests): remove trailing whitespace in test files

* fix(taxonomy): eager load children relation when getting descendants

* test: disable lazy loading and add description field to products

* test(command): add tests for handle method execution and signature

* docs: add codecov badge and reorder existing badges

* test(model): add description to fillable fields

* test: add unit tests for DuplicateSlugException

* test(taxonomy): add unit tests for taxonomy filtering functionality

* test: add unit tests for TaxonomyManager

* test(taxonomy): add additional unit tests for Taxonomy model

* test: eager load nested children in taxonomy descendants test

* test: add unit tests for TaxonomyProvider registration

* test: remove unused ReflectionClass imports from test files

* refactor(taxonomy): make wouldCreateCircularReference method public

* test(taxonomy): add circular reference check in move operation test

* test: add tests for rebuild nested set command and createOrUpdate method

---------

Co-authored-by: HassanDomeDenea <hassan.domedenea@gmail.com>

Author: aliziodev

.github/workflows/tests.yml

@@ -47,10 +47,8 @@ jobs:
       - name: List Installed Dependencies
         run: composer show -D
 
-      - name: Execute tests
-        run: php vendor/bin/pest --no-coverage
-        env:
-          PEST_NO_COVERAGE: true
+      - name: Execute tests with coverage
+        run: php vendor/bin/pest --coverage-clover=coverage.xml
 
       - name: Execute PHPStan
         run: vendor/bin/phpstan analyse --memory-limit=2G
@@ -84,9 +82,9 @@ jobs:
           fi
       
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v5
         with:
+          token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage.xml
           flags: unittests
-          name: codecov-umbrella
-          fail_ci_if_error: false
+          name: codecov-umbrella

README.id.md

@@ -5,11 +5,11 @@
 
 # Laravel Taxonomy
 
+[![codecov](https://codecov.io/gh/aliziodev/laravel-taxonomy/branch/master/graph/badge.svg)](https://codecov.io/gh/aliziodev/laravel-taxonomy)
 [![Tests](https://github.com/aliziodev/laravel-taxonomy/workflows/Tests/badge.svg)](https://github.com/aliziodev/laravel-taxonomy/actions)
 [![Code Quality](https://github.com/aliziodev/laravel-taxonomy/workflows/Code%20Quality/badge.svg)](https://github.com/aliziodev/laravel-taxonomy/actions)
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/aliziodev/laravel-taxonomy.svg)](https://packagist.org/packages/aliziodev/laravel-taxonomy)
 [![Total Downloads](https://img.shields.io/packagist/dt/aliziodev/laravel-taxonomy.svg)](https://packagist.org/packages/aliziodev/laravel-taxonomy)
-[![License](https://img.shields.io/packagist/l/aliziodev/laravel-taxonomy.svg)](https://packagist.org/packages/aliziodev/laravel-taxonomy)
 [![PHP Version](https://img.shields.io/packagist/php-v/aliziodev/laravel-taxonomy.svg)](https://packagist.org/packages/aliziodev/laravel-taxonomy)
 [![Laravel Version](https://img.shields.io/badge/Laravel-11.0%2B-orange.svg)](https://laravel.com/)
 

README.md

@@ -5,11 +5,11 @@
 
 # Laravel Taxonomy
 
+[![codecov](https://codecov.io/gh/aliziodev/laravel-taxonomy/branch/master/graph/badge.svg)](https://codecov.io/gh/aliziodev/laravel-taxonomy)
 [![Tests](https://github.com/aliziodev/laravel-taxonomy/workflows/Tests/badge.svg)](https://github.com/aliziodev/laravel-taxonomy/actions)
 [![Code Quality](https://github.com/aliziodev/laravel-taxonomy/workflows/Code%20Quality/badge.svg)](https://github.com/aliziodev/laravel-taxonomy/actions)
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/aliziodev/laravel-taxonomy.svg)](https://packagist.org/packages/aliziodev/laravel-taxonomy)
 [![Total Downloads](https://img.shields.io/packagist/dt/aliziodev/laravel-taxonomy.svg)](https://packagist.org/packages/aliziodev/laravel-taxonomy)
-[![License](https://img.shields.io/packagist/l/aliziodev/laravel-taxonomy.svg)](https://packagist.org/packages/aliziodev/laravel-taxonomy)
 [![PHP Version](https://img.shields.io/packagist/php-v/aliziodev/laravel-taxonomy.svg)](https://packagist.org/packages/aliziodev/laravel-taxonomy)
 [![Laravel Version](https://img.shields.io/badge/Laravel-11.0%2B-orange.svg)](https://laravel.com/)
 

src/Console/Commands/RebuildNestedSetCommand.php

@@ -25,6 +25,16 @@ class RebuildNestedSetCommand extends Command
      */
     protected $description = 'Rebuild nested set values (lft, rgt, depth) for taxonomy hierarchies';
 
+    /**
+     * Get the taxonomy model class from config.
+     *
+     * @return class-string<\Aliziodev\LaravelTaxonomy\Models\Taxonomy>
+     */
+    protected function getModelClass(): string
+    {
+        return config('taxonomy.model', Taxonomy::class);
+    }
+
     /**
      * Execute the console command.
      */
@@ -80,7 +90,8 @@ protected function rebuildType(string $type): void
     {
         $this->line("Rebuilding type: {$type}");
 
-        $count = Taxonomy::where('type', $type)->count();
+        $modelClass = $this->getModelClass();
+        $count = $modelClass::where('type', $type)->count();
         if ($count === 0) {
             $this->line("  No taxonomies found for type: {$type}");
 
@@ -90,7 +101,8 @@ protected function rebuildType(string $type): void
         $startTime = microtime(true);
 
         // Use the model's rebuild method
-        Taxonomy::rebuildNestedSet($type);
+        $modelClass = $this->getModelClass();
+        $modelClass::rebuildNestedSet($type);
 
         $duration = round(microtime(true) - $startTime, 2);
         $this->line("  Rebuilt {$count} taxonomies in {$duration} seconds");
@@ -121,7 +133,9 @@ protected function getAvailableTypes(): array
      */
     protected function getExistingTypes(): array
     {
-        return Taxonomy::select('type')
+        $modelClass = $this->getModelClass();
+
+        return $modelClass::select('type')
             ->distinct()
             ->pluck('type')
             ->toArray();
@@ -135,7 +149,8 @@ protected function getExistingTypes(): array
     protected function confirmRebuild(array $types): bool
     {
         $typesList = implode(', ', $types);
-        $count = Taxonomy::whereIn('type', $types)->count();
+        $modelClass = $this->getModelClass();
+        $count = $modelClass::whereIn('type', $types)->count();
 
         $this->warn("This will rebuild nested set values for {$count} taxonomies.");
         $this->warn("Types: {$typesList}");

src/Enums/TaxonomyType.php

@@ -2,6 +2,16 @@
 
 namespace Aliziodev\LaravelTaxonomy\Enums;
 
+/**
+ * Taxonomy Type Enum.
+ *
+ * Defines the available taxonomy types that can be used throughout the application.
+ * Each type represents a different categorization method for organizing content.
+ *
+ * @author Aliziodev
+ *
+ * @since 1.0.0
+ */
 enum TaxonomyType: string
 {
     case Category = 'category';
@@ -15,15 +25,26 @@ enum TaxonomyType: string
     case Variant = 'variant';
 
     /**
-     * Get all enum values.
+     * Get all enum values as an array of strings.
      *
-     * @return array<string>
+     * This method returns all the string values of the enum cases,
+     * useful for validation, database seeding, or form options.
+     *
+     * @return array<int, string> Array of all enum values
      */
     public static function values(): array
     {
         return array_column(self::cases(), 'value');
     }
 
+    /**
+     * Get the human-readable label for the taxonomy type.
+     *
+     * Returns a properly formatted, user-friendly label for display purposes.
+     * This is useful for UI elements, form labels, and user-facing content.
+     *
+     * @return string The human-readable label
+     */
     public function label(): string
     {
         return match ($this) {
@@ -38,4 +59,36 @@ public function label(): string
             self::Variant => 'Variant',
         };
     }
+
+    /**
+     * Alias for the label() method.
+     *
+     * Provides an alternative method name for getting the human-readable label.
+     * This method exists for consistency with other Laravel conventions.
+     *
+     * @return string The human-readable label
+     */
+    public function getLabel(): string
+    {
+        return $this->label();
+    }
+
+    /**
+     * Get all taxonomy types as an array of options.
+     *
+     * Returns an array of associative arrays, each containing 'value' and 'label' keys.
+     * This format is particularly useful for generating form select options, API responses,
+     * or any scenario where you need both the enum value and its display label.
+     *
+     * @return array<int, array{value: string, label: string}> Array of option arrays
+     */
+    public static function options(): array
+    {
+        return collect(self::cases())->map(function ($case) {
+            return [
+                'value' => $case->value,
+                'label' => $case->label(),
+            ];
+        })->toArray();
+    }
 }

src/Models/Taxonomy.php

@@ -193,6 +193,11 @@ public function descendants(): Collection
         /** @var \Illuminate\Database\Eloquent\Collection<int, self> $descendants */
         $descendants = new Collection;
 
+        // Load children relationship if not already loaded
+        if (! $this->relationLoaded('children')) {
+            $this->load('children');
+        }
+
         foreach ($this->children as $child) {
             /* @var self $child */
             $descendants->push($child);
@@ -521,7 +526,7 @@ public function moveToParent(?int $parentId): void
     /**
      * Check if moving to the given parent would create a circular reference.
      */
-    protected function wouldCreateCircularReference(int $parentId): bool
+    public function wouldCreateCircularReference(int $parentId): bool
     {
         // If trying to move to itself
         if ($parentId === $this->id) {
@@ -821,7 +826,7 @@ protected static function buildNestedTree(Collection $taxonomies): Collection
             } else {
                 // Child level - add to parent's children collection
                 $parent = end($stack);
-                if ($parent && ! $parent->children_nested) {
+                if ($parent && empty($parent->children_nested)) {
                     /** @var \Illuminate\Database\Eloquent\Collection<int, static> $childrenNested */
                     $childrenNested = new Collection;
                     $parent->setAttribute('children_nested', $childrenNested);