Added the is_hidden field to the Property model

Changelog.md

@@ -13,6 +13,7 @@
 - Removed the Vanilo v2 `Framework` namespace compatibility layer
 - Added the `currency` field to the orders table
 - Added `currency` field to the Channel model/table
+- Added the `is_hidden` field to the `Property` model
 
 ## 3.x Series
 

src/Properties/Changelog.md

@@ -5,6 +5,7 @@
 ## Unreleased
 ##### 2023-XX-YY
 
+- Added the `is_hidden` field to the `Property` model
 - Dropped PHP 8.0 & PHP 8.1 Support
 - Dropped Laravel 9 Support
 

src/Properties/Models/Property.php

@@ -16,6 +16,7 @@
 
 use Cviebrock\EloquentSluggable\Sluggable;
 use Cviebrock\EloquentSluggable\SluggableScopeHelpers;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Support\Collection;
@@ -29,7 +30,11 @@
  * @property string     $slug
  * @property string     $type
  * @property array      $configuration
+ * @property bool       $is_hidden
  * @property Collection $propertyValues
+ *
+ * @method static Builder hiddenOnes()
+ * @method static Builder visibleOnes()
  */
 class Property extends Model implements PropertyContract
 {
@@ -43,7 +48,8 @@ class Property extends Model implements PropertyContract
     protected $guarded = ['id', 'created_at', 'updated_at'];
 
     protected $casts = [
-        'configuration' => 'array'
+        'configuration' => 'array',
+        'is_hidden' => 'boolean',
     ];
 
     public function getType(): PropertyType
@@ -79,12 +85,22 @@ public function propertyValues(): HasMany
         return $this->hasMany(PropertyValueProxy::modelClass());
     }
 
+    public function scopeHiddenOnes(Builder $query): Builder
+    {
+        return $query->where('is_hidden', true);
+    }
+
+    public function scopeVisibleOnes(Builder $query): Builder
+    {
+        return $query->where('is_hidden', false);
+    }
+
     public function sluggable(): array
     {
         return [
             'slug' => [
-                'source' => 'name'
-            ]
+                'source' => 'name',
+            ],
         ];
     }
 }

src/Properties/Tests/PropertyTest.php

@@ -14,6 +14,7 @@
 
 namespace Vanilo\Properties\Tests;
 
+use Illuminate\Support\Str;
 use Vanilo\Properties\Models\Property;
 
 class PropertyTest extends TestCase
@@ -25,13 +26,15 @@ public function all_mutable_fields_can_be_mass_assigned()
             'name' => 'Funkiness',
             'type' => 'text',
             'slug' => 'funkiness',
+            'is_hidden' => true,
             'configuration' => ['x' => 'y', 'a' => 'b']
         ]);
 
         $this->assertEquals('Funkiness', $property->name);
         $this->assertEquals('text', $property->type);
         $this->assertEquals('funkiness', $property->slug);
         $this->assertEquals(['x' => 'y', 'a' => 'b'], $property->configuration);
+        $this->assertTrue($property->is_hidden);
     }
 
     /** @test */
@@ -42,10 +45,15 @@ public function all_mutable_fields_can_be_set()
         $property->name = 'Creepiness';
         $property->type = 'number';
         $property->slug = 'creepiness';
+        $property->is_hidden = true;
         $property->configuration = ['bam' => 'zdish', 'bumm' => 'tsish'];
 
+        $property->save();
+        $property->refresh();
+
         $this->assertEquals('Creepiness', $property->name);
         $this->assertEquals('number', $property->type);
+        $this->assertTrue($property->is_hidden);
         $this->assertEquals('creepiness', $property->slug);
 
         $cfg = $property->configuration;
@@ -125,4 +133,27 @@ public function it_can_be_retrieved_by_slug_using_the_static_finder_method()
         $this->assertInstanceOf(Property::class, $screen);
         $this->assertEquals('Screen Size', $screen->name);
     }
+
+    /** @test */
+    public function the_hidden_scopes_can_be_used_to_query_models()
+    {
+        for ($i = 0; $i < 8; $i++) {
+            Property::create([
+                'name' => Str::ulid()->toBase58(),
+                'type' => 'text',
+                'is_hidden' => true,
+            ]);
+        }
+        for ($i = 0; $i < 5; $i++) {
+            Property::create([
+                'name' => Str::ulid()->toBase58(),
+                'type' => 'text',
+                'is_hidden' => false,
+            ]);
+        }
+
+        $this->assertEquals(5, Property::visibleOnes()->count());
+        $this->assertEquals(8, Property::hiddenOnes()->count());
+
+    }
 }

src/Properties/resources/database/migrations/2023_08_23_155708_add_hidden_field_to_properties.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class () extends Migration {
+    public function up(): void
+    {
+        Schema::table('properties', function (Blueprint $table) {
+            $table->boolean('is_hidden')->default(false)->after('configuration');
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::table('properties', function (Blueprint $table) {
+            $table->dropColumn('is_hidden');
+        });
+    }
+};