Add optional types parameter to jsonLDSerialize

gbv · Aug 25, 2017 · 251e3ba · 251e3ba
1 parent 542cc8d
commit 251e3ba
Show file tree

Hide file tree

Showing 9 changed files with 52 additions and 44 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -5,6 +5,7 @@ This changelog tracks features and fixes of jskos PHP library.
 ## NEXT
 
 * Fix method Set->findURI to actually return an index
+* Add optional types parameter to jsonLDSerialize
 
 ## 0.3.2
 

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit bootstrap="./vendor/autoload.php" colors="true">
-    <testsuites name="JSKOS-PHP test suite">
+    <testsuites name="test suite">
         <directory>tests</directory>
     </testsuites>
     <filter>

diff --git a/src/ConceptBundle.php b/src/ConceptBundle.php
@@ -37,12 +37,13 @@ class ConceptBundle extends PrettyJsonSerializable
     /**
      * Returns data which should be serialized to JSON.
      * @param string $context
+     * @param bool $types
      */
-    public function jsonLDSerialize(string $context = self::DEFAULT_CONTEXT)
+    public function jsonLDSerialize(string $context = self::DEFAULT_CONTEXT, bool $types = null)
     {
         $members = [];
         foreach ($this->members as $m) {
-            $members[] = $m->jsonLDSerialize('');
+            $members[] = $m->jsonLDSerialize('', $types);
         }
         $json = [];
         if ($context) {

diff --git a/src/Container.php b/src/Container.php
@@ -167,13 +167,10 @@ public function getIterator()
 
     # extends PrettyJsonSerializable:
 
-    /**
-     * Return a data structure to serialize this container as JSON.
-     */
-    public function jsonLDSerialize(string $context = self::DEFAULT_CONTEXT)
+    public function jsonLDSerialize(string $context = self::DEFAULT_CONTEXT, bool $types = null)
     {
-        $set = array_map(function ($m) {
-            return is_object($m) ? $m->jsonLDSerialize('') : $m;
+        $set = array_map(function ($m) use ($types) {
+            return is_object($m) ? $m->jsonLDSerialize('', $types) : $m;
         }, $this->members);
 
         if (!$this->closed) {

diff --git a/src/DataType.php b/src/DataType.php
@@ -31,7 +31,7 @@ abstract class DataType extends PrettyJsonSerializable
     /**
      * Get field definition from FIELDS, including parent classes.
      */
-    protected static function fieldType(string $field, bool $strict=false)
+    protected static function fieldType(string $field, bool $strict = false)
     {
         $class = get_called_class();
         while ($class && $class != self::class) {
@@ -51,11 +51,11 @@ protected static function fieldType(string $field, bool $strict=false)
     private function fieldException($field, $message)
     {
         return new InvalidArgumentException(
-            get_called_class()."->$field must $message"
+            get_called_class() . "->$field must $message"
         );
     }
 
-    protected function setField(string $field, $value, bool $strict=true)
+    protected function setField(string $field, $value, bool $strict = true)
     {
         if ($field == '@context') {
             return;
@@ -72,7 +72,7 @@ protected function setField(string $field, $value, bool $strict=true)
             if ($type[0] == 'Set') {
                 if (!($value instanceof Set)) {
                     if (is_array($value)) {
-                        $class = 'JSKOS\\'.$type[1];
+                        $class = 'JSKOS\\' . $type[1];
                         $value = new Set(
                             array_map(function ($m) use ($class) {
                                 if (is_null($m)) {
@@ -135,7 +135,7 @@ public function &__get($field)
             }
         } else {
             trigger_error(
-                "Undefined property: ".get_called_class()."::$$field",
+                "Undefined property: " . get_called_class() . "::$$field",
                 \E_USER_NOTICE
             );
         }

diff --git a/src/LanguageMapOfLists.php b/src/LanguageMapOfLists.php
@@ -35,14 +35,11 @@ public function contains($member): bool
         return false;
     }
 
-    /**
-     * Return a data structure to serialize this container as JSON.
-     */
-    public function jsonLDSerialize(string $context = self::DEFAULT_CONTEXT)
+    public function jsonLDSerialize(string $context = self::DEFAULT_CONTEXT, bool $types = null)
     {
         $map = new \stdClass();
         foreach ($this->members as $lang => $list) {
-            $map->$lang = $list->jsonLDSerialize('');
+            $map->$lang = $list->jsonLDSerialize('', $types);
         }
         return $map;
     }

diff --git a/src/LanguageMapOfStrings.php b/src/LanguageMapOfStrings.php
@@ -11,10 +11,7 @@ class LanguageMapOfStrings extends LanguageMap
 {
     use StringContainer;
 
-    /**
-     * Return a data structure to serialize this container as JSON.
-     */
-    public function jsonLDSerialize(string $context = self::DEFAULT_CONTEXT)
+    public function jsonLDSerialize(string $context = self::DEFAULT_CONTEXT, bool $types = null)
     {
         return (object)$this->members;
     }

diff --git a/src/PrettyJsonSerializable.php b/src/PrettyJsonSerializable.php
@@ -26,20 +26,21 @@ public function jsonSerialize()
      * Keys are sorted by Unicode codepoint for stable output.
      *
      * @param string $context optional JSON-LD context URL. Use empty string to omit.
+     * @param bool $types include default type URIs.
      */
-    public function jsonLDSerialize(string $context = self::DEFAULT_CONTEXT)
+    public function jsonLDSerialize(string $context = self::DEFAULT_CONTEXT, bool $types = null)
     {
         $json = [];
 
         foreach ($this as $key => $value) {
             if (isset($value)) {
                 if ($value instanceof PrettyJsonSerializable) {
-                    $value = $value->jsonLDSerialize('');
+                    $value = $value->jsonLDSerialize('', false);
                 } elseif (is_array($value) and !count(array_filter(array_keys($value), 'is_string'))) {
                     $a = [];
                     foreach ($value as $m) {
                         if ($m instanceof PrettyJsonSerializable) {
-                            $m = $m->jsonLDSerialize('');
+                            $m = $m->jsonLDSerialize('', false);
                         }
                         $a[] = $m;
                     }
@@ -49,10 +50,14 @@ public function jsonLDSerialize(string $context = self::DEFAULT_CONTEXT)
             }
         }
 
+        # don't serialize implicitly deriveable types for brevity
         if ($context) {
             $json['@context'] = $context;
-        } elseif (count($json['type'] ?? []) == 1) {
-            # don't serialize implicitly deriveable types for brevity
+        }
+        if ($types === null) {
+            $types = (bool)$context;
+        }
+        if (!$types && count($json['type'] ?? []) == 1) {
             if ($json['type'][0] == static::TYPES[0]) {
                 unset($json['type']);
             }

diff --git a/tests/ConceptTest.php b/tests/ConceptTest.php
@@ -33,25 +33,35 @@ public function testClosed()
 
     public function testJson()
     {
-        $concept = new Concept(['uri'=>'x:1']);
-        $concept->prefLabel = ['en' => 'test'];
+        $fields = ['uri'=>'x:1'];
 
+        $concept = new Concept($fields);
+        $this->assertEquals($fields, $concept->jsonLDSerialize(''));
+        $this->assertEquals($fields, $concept->jsonLDSerialize('', false));
+
+        $fields['@context'] = 'e:x';
+        $this->assertEquals($fields, $concept->jsonLDSerialize('e:x', false));
+
+        $fields['type'] = [Concept::TYPES[0]];
+        $this->assertEquals($fields, $concept->jsonLDSerialize('e:x'));
+        $this->assertEquals($fields, $concept->jsonLDSerialize('e:x', true));
+
+        unset($fields['@context']);
+        $this->assertEquals($fields, $concept->jsonLDSerialize('', true));
+
+        $fields['@context'] = 'https://gbv.github.io/jskos/context.json';
+        $this->assertEquals($fields, $concept->jsonLDSerialize());
+
+
+        $concept->prefLabel = ($fields['prefLabel'] = ['en' => 'test']);
         $concept->narrower = [];
         $concept->narrower[] = new Concept(['uri'=>'x:2']);
-        $concept->broader = [null];
-        $concept->identifier = [null, 'y:1'];
-
-        $expect = [
-            '@context'  => 'https://gbv.github.io/jskos/context.json',
-            'type'      => [Concept::TYPES[0]],
-            'uri'       => 'x:1',
-            'prefLabel' => [ 'en' => 'test' ],
-            'narrower'  => [ [ 'uri' => 'x:2' ] ],
-            'broader'   => [ null ],
-            'identifier' => [ 'y:1', null ]
-        ];
-        ksort($expect);
-        $this->assertEquals(json_encode($expect), json_encode($concept));
+        $fields['narrower'] = [ [ 'uri' => 'x:2' ] ];
+        $concept->broader = ($fields['broader'] = [null]);
+        $concept->identifier =  [null, 'y:1', 'y:1'];
+        $fields['identifier'] = ['y:1', null];
+        ksort($fields);
+        $this->assertEquals(json_encode($fields), json_encode($concept));
     }
 
     public function testNested()