ensure that custom schemas conform to default schemas + return Custom…

… objects
frictionlessdata · May 11, 2017 · ec82007 · ec82007
1 parent 8dc17e1
commit ec82007
Show file tree

Hide file tree

Showing 11 changed files with 111 additions and 58 deletions.
diff --git a/src/Datapackages/CustomDatapackage.php b/src/Datapackages/CustomDatapackage.php
@@ -0,0 +1,7 @@
+<?php
+namespace frictionlessdata\datapackage\Datapackages;
+
+class CustomDatapackage extends DefaultDatapackage
+{
+
+}
diff --git a/src/Datapackages/TabularDatapackage.php b/src/Datapackages/TabularDatapackage.php
@@ -0,0 +1,7 @@
+<?php
+namespace frictionlessdata\datapackage\Datapackages;
+
+class TabularDatapackage extends DefaultDatapackage
+{
+
+}
diff --git a/src/Exceptions/DatapackageValidationFailedException.php b/src/Exceptions/DatapackageValidationFailedException.php
@@ -11,6 +11,6 @@ class DatapackageValidationFailedException extends \Exception
     public function __construct($validationErrors)
     {
         $this->validationErrors = $validationErrors;
-        parent::__construct("DefaultDatapackage validation failed: ".DatapackageValidationError::getErrorMessages($validationErrors));
+        parent::__construct("Datapackage validation failed: ".DatapackageValidationError::getErrorMessages($validationErrors));
     }
 }
diff --git a/src/Factory.php b/src/Factory.php
@@ -1,5 +1,7 @@
 <?php namespace frictionlessdata\datapackage;
+use frictionlessdata\datapackage\Datapackages\BaseDatapackage;
 use frictionlessdata\datapackage\Resources\BaseResource;
+use frictionlessdata\datapackage\Resources\DefaultResource;
 use JsonSchema\Validator;
 
 /**
@@ -21,7 +23,7 @@ class Factory
      *  - URL (must be in either 'http' or 'https' schemes)
      *  - local filesystem (POSIX) path
      * @param mixed $source
-     * @param null|string $basePath
+     * @param null|string $basePath optional, required only if you want to use relative paths
      * @return Datapackages\BaseDatapackage
      * @throws Exceptions\DatapackageInvalidSourceException
      * @throws Exceptions\DatapackageValidationFailedException
@@ -131,7 +133,16 @@ public static function validate($source, $basePath=null)
 
     public static function getDatapackageClass($descriptor)
     {
-        return Registry::getDatapackageClass($descriptor);
+        $profile = Registry::getDatapackageValidationProfile($descriptor);
+        if ($profile == "tabular-data-package") {
+            $datapackageClass = "frictionlessdata\\datapackage\\Datapackages\TabularDatapackage";
+        } elseif ($profile == "data-package") {
+            $datapackageClass = "frictionlessdata\\datapackage\\Datapackages\DefaultDatapackage";
+        } else {
+            $datapackageClass = "frictionlessdata\\datapackage\\Datapackages\CustomDatapackage";
+        }
+        /** @var BaseDatapackage $datapackageClass */
+        return $datapackageClass;
     }
 
     /**
@@ -140,7 +151,16 @@ public static function getDatapackageClass($descriptor)
      */
     public static function getResourceClass($descriptor)
     {
-        return Registry::getResourceClass($descriptor);
+        $profile = Registry::getResourceValidationProfile($descriptor);
+        if ($profile == "tabular-data-resource") {
+            $resourceClass = "frictionlessdata\\datapackage\\Resources\TabularResource";
+        } elseif ($profile == "data-resource") {
+            $resourceClass = "frictionlessdata\\datapackage\\Resources\DefaultResource";
+        } else {
+            $resourceClass = "frictionlessdata\\datapackage\\Resources\CustomResource";
+        }
+        /** @var BaseResource $resourceClass */
+        return $resourceClass;
     }
     /**
      * allows extending classes to add custom sources

diff --git a/src/Registry.php b/src/Registry.php
@@ -2,25 +2,13 @@
 use frictionlessdata\datapackage\Resources\BaseResource;
 
 /**
- * repository of known profiles and the corresponding classes and validation requirements
+ * repository of known profiles and the corresponding schemas
  */
 class Registry
 {
     /**
-     * @param $descriptor
-     * @return BaseResource::class
+     * get the profile which should be used for validation from the given resource descriptor
      */
-    public static function getResourceClass($descriptor)
-    {
-        if (static::getResourceValidationProfile($descriptor) == "tabular-data-resource") {
-            $resourceClass = "frictionlessdata\\datapackage\\Resources\\TabularResource";
-        } else {
-            $resourceClass = "frictionlessdata\\datapackage\\Resources\\DefaultResource";
-        }
-        /** @var BaseResource $resourceClass */
-        return $resourceClass;
-    }
-
     public static function getResourceValidationProfile($descriptor)
     {
         if (isset($descriptor->profile) && $descriptor->profile != "default") {
@@ -30,11 +18,10 @@ public static function getResourceValidationProfile($descriptor)
         }
     }
 
-    public static function getDatapackageClass($descriptor)
-    {
-        return "frictionlessdata\\datapackage\\Datapackages\\DefaultDatapackage";
-    }
-
+    /**
+     * get the profile which should be used for validation from the given datapackage descriptor
+     * corresponds to the id from the registry
+     */
     public static function getDatapackageValidationProfile($descriptor)
     {
         if (isset($descriptor->profile) && $descriptor->profile != "default") {
@@ -44,28 +31,24 @@ public static function getDatapackageValidationProfile($descriptor)
         }
     }
 
-    public static function getDatapackageJsonSchemaFile($profile)
-    {
-        if (in_array($profile, ["data-package", "tabular-data-package"])) {
-            // known profile id
-            return realpath(dirname(__FILE__))."/Validators/schemas/".$profile.".json";
-        } else {
-            // unknown profile / file or url
-            return false;
-        }
-    }
-
-    public static function getResourceJsonSchemaFile($profile)
+    /**
+     * given a normalized profile - get the corresponding schema file for known schema in the registry
+     * returns false in case of unknown schema
+     * works the same for both datapackage schema and resource schemas
+     */
+    public static function getJsonSchemaFile($profile)
     {
-        if (in_array($profile, ["data-resource", "tabular-data-resource"])) {
-            // known profile id
-            return realpath(dirname(__FILE__))."/Validators/schemas/".$profile.".json";
-        } else {
-            // unknown profile / file or url
-            return false;
+        foreach (static::getAllSchemas() as $schema) {
+            if ($schema->id != "registry" && $schema->id == $profile) {
+                return realpath(dirname(__FILE__))."/Validators/schemas/".$schema->schema_path;
+            }
         }
+        return false;
     }
 
+    /**
+     * returns array of all known schemas in the registry
+     */
     public static function getAllSchemas()
     {
         // registry schema

diff --git a/src/Resources/CustomResource.php b/src/Resources/CustomResource.php
@@ -0,0 +1,6 @@
+<?php
+namespace frictionlessdata\datapackage\Resources;
+
+class CustomResource extends DefaultResource
+{
+}
diff --git a/src/Validators/BaseValidator.php b/src/Validators/BaseValidator.php
@@ -108,15 +108,15 @@ protected function getValidationErrorMessage($error)
      * does the validation, adds errors to the validator object using _addError method
      */
     protected function validateSchema()
+    {
+        $this->validateSchemaUrl($this->getValidationSchemaUrl());
+    }
+
+    protected function validateSchemaUrl($url)
     {
         $validator = new \JsonSchema\Validator();
         $descriptor = $this->getDescriptorForValidation();
-        $validator->validate(
-            $descriptor,
-            (object)[
-                "\$ref" => $this->getValidationSchemaUrl()
-            ]
-        );
+        $validator->validate($descriptor, (object)["\$ref" => $url]);
         if (!$validator->isValid()) {
             foreach ($validator->getErrors() as $error) {
                 $this->addError(

diff --git a/src/Validators/DatapackageValidator.php b/src/Validators/DatapackageValidator.php
@@ -19,6 +19,19 @@ protected function getValidationProfile()
         return Registry::getDatapackageValidationProfile($this->descriptor);
     }
 
+    protected function validateSchema()
+    {
+        parent::validateSchema();
+        if ($this->getValidationProfile() != "data-package") {
+            // all schemas must be an extension of datapackage spec
+            $this->validateSchemaUrl(
+                $this->convertValidationSchemaFilenameToUrl(
+                    $this->getJsonSchemaFileFromRegistry("data-package")
+                )
+            );
+        }
+    }
+
     protected function validateKeys()
     {
         foreach ($this->descriptor->resources as $resourceDescriptor) {
@@ -35,7 +48,7 @@ protected function resourceValidate($resourceDescriptor)
 
     protected function getJsonSchemaFileFromRegistry($profile)
     {
-        if ($filename = Registry::getDatapackageJsonSchemaFile($profile)) {
+        if ($filename = Registry::getJsonSchemaFile($profile)) {
             return $filename;
         } else {
             return parent::getJsonSchemaFileFromRegistry($profile);

diff --git a/src/Validators/ResourceValidator.php b/src/Validators/ResourceValidator.php
@@ -49,7 +49,7 @@ protected function validateKeys()
 
     protected function getJsonSchemaFileFromRegistry($profile)
     {
-        if ($filename = Registry::getResourceJsonSchemaFile($profile)) {
+        if ($filename = Registry::getJsonSchemaFile($profile)) {
             return $filename;
         } else {
             return parent::getJsonSchemaFileFromRegistry($profile);

diff --git a/tests/DatapackageTest.php b/tests/DatapackageTest.php
@@ -50,7 +50,7 @@ public function testNativePHPObjectWithoutBasePathShouldFail()
         $descriptor = $this->simpleDescriptor;
         $this->assertDatapackageException(
             "frictionlessdata\\datapackage\\Exceptions\\DatapackageValidationFailedException",
-            'DefaultDatapackage validation failed: data source file does not exist or is not readable: foo.txt',
+            'Datapackage validation failed: data source file does not exist or is not readable: foo.txt',
             function() use ($descriptor) { Factory::datapackage($descriptor); }
         );
     }
@@ -68,7 +68,7 @@ public function testJsonStringWithoutBasePathShouldFail()
         $source = json_encode($this->simpleDescriptor);
         $this->assertDatapackageException(
             "frictionlessdata\\datapackage\\Exceptions\\DatapackageValidationFailedException",
-            'DefaultDatapackage validation failed: data source file does not exist or is not readable: foo.txt',
+            'Datapackage validation failed: data source file does not exist or is not readable: foo.txt',
             function() use ($source) { Factory::datapackage($source); }
         );
     }
@@ -186,7 +186,7 @@ public function testDatapackageValidationFailedShouldPreventConstruct()
         } catch (Exceptions\DatapackageValidationFailedException $e) {
             $caughtException = $e;
         }
-        $this->assertEquals("DefaultDatapackage validation failed: [resources] The property resources is required", $caughtException->getMessage());
+        $this->assertEquals("Datapackage validation failed: [resources] The property resources is required", $caughtException->getMessage());
     }
 
     public function testTabularResourceDescriptorValidation()

diff --git a/tests/RegistryTest.php b/tests/RegistryTest.php
@@ -39,7 +39,7 @@ public function testDatapackageWithDataPackageProfile()
     public function testDatapackageWithTabularDataPackageProfile()
     {
         $this->assertDatapackageClassProfile(
-            "frictionlessdata\\datapackage\\Datapackages\\DefaultDatapackage",
+            "frictionlessdata\\datapackage\\Datapackages\\TabularDatapackage",
             "tabular-data-package",
             (object)["profile" => "tabular-data-package"]
         );
@@ -99,7 +99,7 @@ public function testCustomProfileFromJsonSchemaFile()
             $this->fail();
         } catch (DatapackageValidationFailedException $e) {
             $this->assertEquals(
-                "DefaultDatapackage validation failed: [custom] The property custom is required",
+                "Datapackage validation failed: [custom] The property custom is required",
                 $e->getMessage()
             );
         }
@@ -109,7 +109,7 @@ public function testCustomProfileFromJsonSchemaFile()
             $this->fail();
         } catch (DatapackageValidationFailedException $e) {
             $this->assertEquals(
-                "DefaultDatapackage validation failed: [custom[0]] Integer value found, but a string is required, [custom[1]] Integer value found, but a string is required, [custom[2]] Integer value found, but a string is required",
+                "Datapackage validation failed: [custom[0]] Integer value found, but a string is required, [custom[1]] Integer value found, but a string is required, [custom[2]] Integer value found, but a string is required",
                 $e->getMessage()
             );
         }
@@ -120,7 +120,7 @@ public function testCustomProfileFromJsonSchemaFile()
             $this->fail("should raise an exception because test-custom-profile requires foobar attribute (array of strings)");
         } catch (DatapackageValidationFailedException $e) {
             $this->assertEquals(
-                "DefaultDatapackage validation failed: [foobar] String value found, but an array is required",
+                "Datapackage validation failed: [foobar] String value found, but an array is required",
                 $e->getMessage()
             );
         }
@@ -141,15 +141,32 @@ public function testCustomProfileFromJsonSchemaFile()
         ], $datapackage->descriptor());
     }
 
+    public function testCustomSchemaMustConformToDatapackageSchema()
+    {
+        $descriptor = (object)[
+            "profile" => "http://json-schema.org/schema",
+            "resources" => [] // this is allows for json-schema.org/schema - but for datapackage it has minimum of 1
+        ];
+        try {
+            Factory::datapackage($descriptor);
+            $this->fail();
+        } catch (DatapackageValidationFailedException $e) {
+            $this->assertEquals(
+                'Datapackage validation failed: [resources] There must be a minimum of 1 items in the array',
+                $e->getMessage()
+            );
+        }
+    }
+
     protected function assertDatapackageClassProfile($expectedClass, $expectedProfile, $descriptor)
     {
-        $this->assertEquals($expectedClass, Registry::getDatapackageClass($descriptor));
+        $this->assertEquals($expectedClass, Factory::getDatapackageClass($descriptor));
         $this->assertEquals($expectedProfile, Registry::getDatapackageValidationProfile($descriptor));
     }
 
     protected function assertResourceClassProfile($expectedClass, $expectedProfile, $descriptor)
     {
-        $this->assertEquals($expectedClass, Registry::getResourceClass($descriptor));
+        $this->assertEquals($expectedClass, Factory::getResourceClass($descriptor));
         $this->assertEquals($expectedProfile, Registry::getResourceValidationProfile($descriptor));
     }