add the ability to get a list of dirty attributes including Json attributes

Author: Darryl Kuhn

src/Dialect/Json.php

@@ -16,7 +16,10 @@ trait Json
         '#>>' ];
 
     /**
-     * Holds the map of attributes and the JSON colums they are stored in.
+     * Holds the map of attributes and the JSON colums they are stored in. This
+     * will take the form of:
+     *  [ 'json_element_1' => 'original_column',
+     *    'json_element_2' => 'original_column' ]
      *
      * @var array
      */
@@ -247,7 +250,6 @@ protected function mutateAttribute($key, $value)
             return null;
         }
 
-
         return parent::mutateAttribute($key, $value);
     }
 
@@ -294,6 +296,34 @@ public function setJsonAttribute($attribute, $key, $value)
         return;
     }
 
+    /**
+     * Add json attributes to the list of things that have changed (when
+     * they've changed)
+     *
+     * @return Array
+     */
+    public function getDirty( $includeJson = false )
+    {
+        $dirty = parent::getDirty();
+
+        if ( !$includeJson ) {
+            return $dirty;
+        }
+
+        foreach (array_unique($this->jsonAttributes) as $attribute) {
+            $originals[$attribute] = json_decode(array_get($this->original,$attribute,'null'), true);
+        }
+
+        foreach ($this->jsonAttributes as $jsonAttribute => $jsonColumn) {
+            if ($this->$jsonAttribute !== null &&
+                $this->$jsonAttribute !== array_get($originals[$jsonColumn], $jsonAttribute)) {
+                $dirty[$jsonAttribute] = json_encode($this->$jsonAttribute);
+            }
+        }
+
+        return $dirty;
+    }
+
     /**
      * Allows you to specify if the actual JSON column housing the attributes
      * should be shown on toArray() and toJson() calls. Set this value in the

tests/JsonDialectTest.php

@@ -143,6 +143,26 @@ public function testHintedJsonColumns()
         $this->assertEquals( $mock->testColumn, json_encode(['foo'=>'bar']) );
     }
 
+    /**
+     * Assert that defined JSON attributes are returned in the getDirty()
+     * response when expected.
+     */
+    public function testGetDirtyJson()
+    {
+        // Mock the model with data
+        $mock = new MockJsonDialectModel;
+        $mock->hintJsonStructure( 'testColumn', json_encode(['foo'=>null]) );
+
+        // At this point 'foo' should not be dirty
+        $this->assertArrayNotHasKey( 'foo', $mock->getDirty(true) );
+
+        $mock->setAttribute('testColumn', json_encode(['foo' => 'bar']));
+
+        // Now that 'foo' has been changed it should show up in the getDirty()
+        // response
+        $this->assertArrayHasKey( 'foo', $mock->getDirty(true) );
+    }
+
     /**
      * Assert that an exception is thrown when given invalid json as a
      * structure hint