Merge pull request #101 from dunglas/embed_data

Embed Schema.org and GoodRelations files directly in the project

Author: dunglas

tests/data/schema.rdfa renamed to data/schema.rdfa

@@ -28,8 +28,15 @@
  */
 final class TypesGeneratorConfiguration implements ConfigurationInterface
 {
-    public const SCHEMA_ORG_RDFA_URL = 'https://schema.org/docs/schema_org_rdfa.html';
-    public const GOOD_RELATIONS_OWL_URL = 'https://purl.org/goodrelations/v1.owl';
+    /**
+     * @see https://schema.org/docs/schema_org_rdfa.html
+     */
+    public const SCHEMA_ORG_RDFA_URL = __DIR__.'/../data/schema.rdfa';
+
+    /**
+     * @see https://purl.org/goodrelations/v1.owl
+     */
+    public const GOOD_RELATIONS_OWL_URL = __DIR__.'/../data/v1.owl';
     public const SCHEMA_ORG_NAMESPACE = 'http://schema.org/';
 
     /**
@@ -43,9 +50,7 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->children()
                 ->arrayNode('rdfa')
                     ->info('RDFa files')
-                    ->defaultValue([
-                        ['uri' => self::SCHEMA_ORG_RDFA_URL, 'format' => null],
-                    ])
+                    ->defaultValue([['uri' => realpath(self::SCHEMA_ORG_RDFA_URL), 'format' => 'rdfa']])
                     ->beforeNormalization()
                         ->ifArray()
                         ->then(function (array $v) {
@@ -59,14 +64,15 @@ function ($rdfa) {
                     ->end()
                     ->prototype('array')
                         ->children()
-                            ->scalarNode('uri')->defaultValue(self::SCHEMA_ORG_RDFA_URL)->info('RDFa URI to use')->example(self::SCHEMA_ORG_RDFA_URL)->end()
+                            ->scalarNode('uri')->defaultValue(realpath(self::SCHEMA_ORG_RDFA_URL))->info('RDFa URI to use')->example('https://schema.org/docs/schema_org_rdfa.html')->end()
                             ->scalarNode('format')->defaultNull()->info('RDFa URI data format')->example('rdfxml')->end()
                         ->end()
                     ->end()
                 ->end()
                 ->arrayNode('relations')
                     ->info('OWL relation files to use')
-                    ->defaultValue([self::GOOD_RELATIONS_OWL_URL])
+                    ->example('https://purl.org/goodrelations/v1.owl')
+                    ->defaultValue([realpath(self::GOOD_RELATIONS_OWL_URL)])
                     ->prototype('scalar')->end()
                 ->end()
                 ->booleanNode('debug')->defaultFalse()->info('Debug mode')->end()

tests/data/v1.owl renamed to data/v1.owl

@@ -26,7 +26,7 @@ public function testDumpConfiguration()
     {
         $commandTester = new CommandTester(new DumpConfigurationCommand());
         $this->assertEquals(0, $commandTester->execute([]));
-        $this->assertEquals(<<<YAML
+        $this->assertEquals(sprintf(<<<'YAML'
 config:
 
     # RDFa files
@@ -36,16 +36,16 @@ public function testDumpConfiguration()
         -
 
             # RDFa URI to use
-            uri:                  'https://schema.org/docs/schema_org_rdfa.html' # Example: https://schema.org/docs/schema_org_rdfa.html
+            uri:                  %s # Example: https://schema.org/docs/schema_org_rdfa.html
 
             # RDFa URI data format
             format:               null # Example: rdfxml
 
     # OWL relation files to use
-    relations:
+    relations:            # Example: https://purl.org/goodrelations/v1.owl
 
         # Default:
-        - https://purl.org/goodrelations/v1.owl
+        - %s
 
     # Debug mode
     debug:                false
@@ -196,6 +196,6 @@ interface:            null
 
 
 YAML
-, $commandTester->getDisplay());
+, realpath(__DIR__.'/../../data/schema.rdfa'), realpath(__DIR__.'/../../data/v1.owl')), $commandTester->getDisplay());
     }
 }

src/TypesGeneratorConfiguration.php

@@ -26,7 +26,7 @@ public function testExtractCardinalities()
     {
         $commandTester = new CommandTester(new ExtractCardinalitiesCommand());
         $this->assertEquals(0, $commandTester->execute(
-            ['--schemaorg-file' => __DIR__.'/../data/schema.rdfa', '--goodrelations-file' => __DIR__.'/../data/v1.owl']
+            ['--schemaorg-file' => __DIR__.'/../../data/schema.rdfa', '--goodrelations-file' => __DIR__.'/../../data/v1.owl']
         ));
 
         $this->assertEquals(<<<'JSON'

tests/Command/DumpConfigurationTest.php

@@ -1,6 +1,3 @@
-rdfa: [{ uri: tests/data/schema.rdfa, format: rdfa }]
-relations: [tests/data/v1.owl]
-
 # The PHP namespace of generated entities
 namespaces:
   entity: 'AddressBook\Entity'

tests/Command/ExtractCardinalitiesCommandTest.php

@@ -1,5 +1,3 @@
-rdfa: [{ uri: tests/data/schema.rdfa, format: rdfa }]
-relations: [tests/data/v1.owl]
 annotationGenerators: # Generators we want to use
   - ApiPlatform\SchemaGenerator\AnnotationGenerator\PhpDocAnnotationGenerator
   - ApiPlatform\SchemaGenerator\AnnotationGenerator\DoctrineOrmAnnotationGenerator

tests/config/address-book.yaml

@@ -1,5 +1,3 @@
-rdfa: [{ uri: tests/data/schema.rdfa, format: rdfa }]
-relations: [tests/data/v1.owl]
 header: |
   /*
    * This file is part of the Ecommerce package.

tests/config/blog.yaml

@@ -1,6 +1,3 @@
-rdfa: [{ uri: tests/data/schema.rdfa, format: rdfa }]
-relations: [tests/data/v1.owl]
-
 fluentMutatorMethods: true
 types:
   Person:

tests/config/ecommerce.yaml

@@ -1,6 +1,3 @@
-rdfa: [{ uri: tests/data/schema.rdfa, format: rdfa }]
-relations: [tests/data/v1.owl]
-
 id:
   generationStrategy: auto
 types: