Normalize set values when passing objects (#9)

Author: dafeder

.circleci/config.yml

@@ -3,6 +3,7 @@ jobs:
   build:
     environment:
       CC_TEST_REPORTER_ID: 8ec926841c6dfead9c848fd063c569e11b06be11442a8175d588e10607ee2150
+      XDEBUG_MODE: coverage
     docker:
       - image: circleci/php:7-cli-node-browsers-legacy
     working_directory: ~/repo

.gitignore

@@ -1,5 +1,10 @@
 vendor/
 .phpunit*
 .vscode/
-/.idea/
+/.idea/codeStyles/codeStyleConfig.xml
 /composer.lock
+/.idea/modules.xml
+/.idea/php.xml
+/.idea/RootedJsonData.iml
+/.idea/vcs.xml
+/.idea/workspace.xml

src/RootedJsonData.php

@@ -31,41 +31,40 @@ class RootedJsonData
      */
     public function __construct(string $json = "{}", string $schema = "{}")
     {
-        $decoded = json_decode($json);
-
-        if (!isset($decoded)) {
-            throw new InvalidArgumentException("Invalid JSON: " . json_last_error_msg());
-        }
-
         if (Schema::fromJsonString($schema)) {
             $this->schema = $schema;
         }
 
-        $data = new JsonObject($json, true);
-        $result = self::validate($data, $this->schema);
+        $result = self::validate($json, $this->schema);
         if (!$result->isValid()) {
             throw new ValidationException("JSON Schema validation failed.", $result);
         }
 
-        $this->data = $data;
+        $this->data = new JsonObject($json, true);
     }
 
     /**
-     * Validate a JsonObject.
+     * Validate JSON.
      *
-     * @param JsonObject $data
-     *   JsonData object to validate against schema.
+     * @param string $json
+     *   JSON string to validate against schema.
      * @param string $schema
      *   JSON Schema string.
      *
      * @return ValidationResult
      *   Validation result object, contains error report if invalid.
      */
-    public static function validate(JsonObject $data, string $schema): ValidationResult
+    public static function validate(string $json, string $schema): ValidationResult
     {
+        $decoded = json_decode($json);
+
+        if (!isset($decoded)) {
+            throw new InvalidArgumentException("Invalid JSON: " . json_last_error_msg());
+        }
+
         $opiSchema = Schema::fromJsonString($schema);
         $validator = new Validator();
-        return $validator->schemaValidation(json_decode("{$data}"), $opiSchema);
+        return $validator->schemaValidation($decoded, $opiSchema);
     }
 
     /**
@@ -75,7 +74,17 @@ public static function validate(JsonObject $data, string $schema): ValidationRes
      */
     public function __toString()
     {
-        return (string) $this->data;
+        return $this->data->getJson();
+    }
+    
+    /**
+     * Return pretty-formatted JSON string
+     *
+     * @return string
+     */
+    public function pretty()
+    {
+        return $this->data->getJson(JSON_PRETTY_PRINT);
     }
 
     /**
@@ -103,7 +112,7 @@ public function get(string $path)
      */
     public function __get(string $path)
     {
-        return $this->data->get($path);
+        return $this->get($path);
     }
 
     /**
@@ -117,6 +126,7 @@ public function __get(string $path)
      */
     public function set(string $path, $value)
     {
+        $this->normalizeSetValue($value);
         $validationJsonObject = new JsonObject((string) $this->data);
         $validationJsonObject->set($path, $value);
 
@@ -130,6 +140,22 @@ public function set(string $path, $value)
         return $this->data->set($path, $value);
     }
 
+    /**
+     * Ensure consistent data type whether RootedJsonData or stdClass.
+     *
+     * @param mixed $value
+     */
+    private function normalizeSetValue(&$value)
+    {
+        if ($value instanceof RootedJsonData) {
+            $value = $value->{"$"};
+        }
+        if ($value instanceof \stdClass) {
+            $value = new RootedJsonData(json_encode($value));
+            $this->normalizeSetValue($value);
+        }
+    }
+
     /**
      * @see \JsonPath\JsonObject::__get()
      *
@@ -140,15 +166,29 @@ public function set(string $path, $value)
      */
     public function __set($path, $value)
     {
-        return $this->data->set($path, $value);
+        return $this->set($path, $value);
     }
 
-    public function __isset($name)
+    /**
+     * Magic __isset method for a path.
+     *
+     * @param mixed $path
+     *   Check if a property at this path is set or not.
+     *
+     * @return bool
+     */
+    public function __isset($path)
     {
         $notSmart = new JsonObject("{$this->data}");
-        return $notSmart->get($name) ? true : false;
+        return $notSmart->get($path) ? true : false;
     }
 
+    /**
+     * Get the JSON Schema as a string.
+     *
+     * @return string
+     *   The JSON Schema for this object.
+     */
     public function getSchema()
     {
         return $this->schema;

tests/RootedJsonDatatTest.php

@@ -11,7 +11,7 @@
 
 class RootedJsonDataTest extends TestCase
 {
-    public function testSeamlessExperience()
+    public function testJsonInOut()
     {
         $data = new RootedJsonData();
         $data->set("$.title", "Hello");
@@ -88,22 +88,36 @@ public function testJsonIntegrityFailureAfterChange()
         $json = '{"number":51}';
         $schema = '{"type":"object","properties": {"number":{ "type":"number"}}}';
         $data = new RootedJsonData($json, $schema);
-        $this->assertEquals($json, "{$data}");
 
         $data->set("$.number", "Alice");
+    }
 
-        // Test with magic setter as well.
+    /**
+     * Do schemas still work with magic setter?
+     */
+    public function testJsonIntegrityFailureMagicSetter()
+    {
         $this->expectExceptionMessage("\$[number] expects a number");
+
+        $json = '{"number":51}';
+        $schema = '{"type":"object","properties": {"number":{ "type":"number"}}}';
+        $data = new RootedJsonData($json, $schema);
         $data->{"$[number]"} = "Alice";
     }
 
+    /**
+     * Simple get value from JSON path.
+     */
     public function testJsonPathGetter()
     {
         $json = '{"container":{"number":51}}';
         $data = new RootedJsonData($json);
         $this->assertEquals(51, $data->get("$.container.number"));
     }
 
+    /**
+     * Simple set by JSON path.
+     */
     public function testJsonPathSetter()
     {
         $json = '{"container":{"number":51}}';
@@ -112,11 +126,46 @@ public function testJsonPathSetter()
         $this->assertEquals(52, $data->get("$.container.number"));
     }
 
+    /**
+     * Adding JSON structures in multiple formats should have predictable results.
+     */
+    public function testAddJsonData()
+    {
+        // Test adding RootedJsonData structure.
+        $json = '{}';
+        $containerSchema = '{"type":"object","properties":{"number":{"type":"number"}}}';
+        $schema = '{"type":"object","properties":{"container":'.$containerSchema.'}}';
+        $subJson = '{"number":51}';
+        $data = new RootedJsonData($json, $schema);
+        $data->set("$.container", new RootedJsonData($subJson));
+        $this->assertEquals(51, $data->get("$.container.number"));
+        
+        // If we add stdClass object, it should be work and be an array.
+        $data2 = new RootedJsonData($json, $schema);
+        $data2->set("$.container", json_decode($subJson));
+        $this->assertEquals(51, $data2->get("$.container.number"));
+        $this->assertIsArray($data2->get("$.container"));
+    }
+    
+    /**
+     * getSchema() should return the same string that was provided to constructor.
+     */
     public function testSchemaGetter()
     {
         $json = '{"number":51}';
         $schema = '{"type": "object","properties":{"number":{"type":"number"}}}';
         $data = new RootedJsonData($json, $schema);
         $this->assertEquals($schema, $data->getSchema());
     }
+
+    /**
+     * Regular string should be one line, pretty() should return multiple lines.
+     */
+    public function testPretty()
+    {
+        $json = '{"number":51}';
+        $data = new RootedJsonData($json);
+        $this->assertEquals(0, substr_count("$data", "\n"));
+        $this->assertEquals(2, substr_count($data->pretty(), "\n"));
+    }
 }