Merge pull request #17 from carsdotcom/issue-16

fix: refresh has to invalidate json model attribute cache

Author: jwadhams

app/Traits/HasJsonModelAttributes.php

@@ -355,4 +355,14 @@ public function isEmpty(): bool
     {
         return collect($this->jsonModelAttributeCache)->every->isEmpty() && parent::isEmpty();
     }
+
+    /**
+     * The Laravel method ->refresh tries to reuse the object reference while reloading data from disk.
+     * Reload the new cache this attribute introduces, too.
+     */
+    public function refresh(): static
+    {
+        $this->emptyJsonModelAttributeCache();
+        return parent::refresh();
+    }
 }

tests/Unit/Traits/HasJsonModelAttributesTest.php

@@ -15,6 +15,7 @@
 use Tests\BaseTestCase;
 use Tests\MockClasses\ConcreteJsonModel;
 use Tests\MockClasses\ConcreteNullableJsonModel;
+use Tests\MockClasses\EventedModelWithJsonAttributes;
 
 /**
  * Class HasJsonModelAttributes
@@ -424,4 +425,23 @@ public function testAttributeCanBeTestedWithIsset()
         self::assertFalse($model->jsonModel->a ?? false);
         self::assertFalse($model->jsonModel->other ?? false);
     }
+
+    public function testAttributeIsResetByRefresh()
+    {
+        $model = mock(EventedModelWithJsonAttributes::class)->makePartial()->shouldAllowMockingProtectedMethods();
+        // We're mocking the guts of Model::refresh to not actually require a database
+        $model->shouldReceive('setKeysForSelectQuery')->once()->andReturnSelf();
+        $model->shouldReceive('useWritePdo')->andReturnSelf();
+        $model->shouldReceive('firstOrFail')->andReturn((object)['attributes' => ['thing' => ['a' => "aneurysm"]]]);
+
+        $model->thing->a = "Apple";
+        self::assertSame("Apple", $model->thing->a);
+
+        // You have to tell the model it exists (on disk) or refresh doesn't do anything.
+        $model->exists = true;
+        // The change wasn't saved, the model reverts to "disk"
+        $model->refresh();
+        self::assertEmpty(getProperty($model, 'jsonModelAttributeCache'));
+        self::assertSame('aneurysm', $model->thing->a);
+    }
 }