Update the save() method to set relative paths for resources. Fixes #41.

Author: jonrmitchell

src/Datapackages/BaseDatapackage.php

@@ -183,20 +183,27 @@ public function save($zip_filename)
     {
         Package::isZipPresent();
         $zip = new ZipArchive();
+
+        $packageCopy = $this->copy();
+
         $base = tempnam(sys_get_temp_dir(), 'datapackage-zip-');
         $files = [
             'datapackage.json' => $base.'datapackage.json',
         ];
         $ri = 0;
-        foreach ($this as $resource) {
+        foreach ($packageCopy->resources() as $resource) {
+            $resourceFiles = [];
             $fileNames = $resource->save($base.'resource-'.$ri);
             foreach ($fileNames as $fileName) {
                 $relname = str_replace($base.'resource-'.$ri, '', $fileName);
                 $files['resource-'.$ri.$relname] = $fileName;
+                $resourceFiles[] = 'resource-'.$ri.$relname;
             }
+            $resource->descriptor()->path = count($resourceFiles) == 1 ? $resourceFiles[0] : $resourceFiles;
             ++$ri;
         }
-        $this->saveDescriptor($files['datapackage.json']);
+        $packageCopy->saveDescriptor($files['datapackage.json']);
+
         register_shutdown_function(function () use ($base) {
             Utils::removeDir($base);
         });
@@ -210,19 +217,24 @@ public function save($zip_filename)
         }
     }
 
+    protected function copy()
+    {
+        return new static($this->descriptor, $this->basePath, true);
+    }
+
     protected $descriptor;
     protected $currentResourcePosition = 0;
     protected $basePath;
     protected $skipValidations = false;
 
-  /**
-   * called by the resources iterator for each iteration.
-   *
-   * @param object $descriptor
-   *
-   * @return \frictionlessdata\datapackage\Resources\BaseResource
-   * @throws \frictionlessdata\datapackage\Exceptions\ResourceValidationFailedException
-   */
+    /**
+     * called by the resources iterator for each iteration.
+     *
+     * @param object $descriptor
+     *
+     * @return \frictionlessdata\datapackage\Resources\BaseResource
+     * @throws \frictionlessdata\datapackage\Exceptions\ResourceValidationFailedException
+     */
     protected function initResource($descriptor)
     {
         return Factory::resource($descriptor, $this->basePath, $this->skipValidations);

tests/DatapackageTest.php

@@ -476,6 +476,29 @@ public function testCreateEditDatapackageDescriptor()
         $zip->close();
         unlink($filename);
         $tempdir = $tempdir.DIRECTORY_SEPARATOR;
+
+        //after saving to disk, the paths are updated
+        $expectedDatapackageDescriptor = (object) [
+            'name' => 'my-datapackage-name',
+            'resources' => [
+                (object) [
+                    'name' => 'my-default-resource',
+                    'path' => ["resource-0-data-0", "resource-0-data-1"],
+                ],
+                (object) [
+                    'name' => 'my-renamed-tabular-resource',
+                    'path' => "resource-1.csv",
+                    'profile' => 'tabular-data-resource',
+                    'schema' => (object) [
+                        'fields' => [
+                            (object) ['name' => 'id', 'type' => 'integer'],
+                            (object) ['name' => 'name', 'type' => 'string'],
+                        ],
+                    ],
+                ],
+            ],
+        ];
+
         $this->assertEquals($expectedDatapackageDescriptor, json_decode(file_get_contents($tempdir.'datapackage.json')));
         $this->assertEquals('foo', file_get_contents($tempdir.'resource-0-data-0'));
         $this->assertEquals("testing 改善\n", file_get_contents($tempdir.'resource-0-data-1'));
@@ -484,6 +507,39 @@ public function testCreateEditDatapackageDescriptor()
         Utils::removeDir($tempdir);
     }
 
+    public function testSaveAndLoadZip()
+    {
+        //create example csv
+        file_put_contents('/tmp/example.csv', "name,email\nJohn Doe,john@example.com");
+
+        //create a new datapackage object
+        $package = Package::create(['name' => 'csv-example','profile' => 'tabular-data-package']);
+
+        //add a csv file
+        $package->addResource('example.csv', [
+            "profile" => "tabular-data-resource",
+            "schema" => ["fields" => [["name" => "name", "type" => "string"],["name" => "email", "type" => "string"]]],
+            "path" => '/tmp/example.csv'
+        ]);
+
+        //save the datapackage
+        if (is_file('datapackage.zip')) {
+            unlink('datapackage.zip');
+        }
+        $package->save("datapackage.zip");
+
+        //delete example csv
+        unlink('/tmp/example.csv');
+
+        //load the new package
+        $package2 = Package::load('datapackage.zip');
+
+        //assert you get expected content back out
+        $this->assertEquals([['name' => 'John Doe', 'email' => 'john@example.com']], $package2->resource('example.csv')->read());
+
+        unlink('datapackage.zip');
+    }
+
     public function testLoadDatapackageZip()
     {
         $package = Package::load(dirname(__FILE__).'/fixtures/datapackage_zip.zip');
@@ -626,21 +682,21 @@ public function testCsvDialect()
                         'CommitteeTypeDesc' => 'ועדה  משותפת',
                         'Email' => null,
                         'StartDate' => Carbon::__set_state(array(
-                                'date' => '2004-08-12 00:00:00.000000',
-                                'timezone_type' => 3,
-                                'timezone' => 'UTC',
-                            )),
+                            'date' => '2004-08-12 00:00:00.000000',
+                            'timezone_type' => 3,
+                            'timezone' => 'UTC',
+                        )),
                         'FinishDate' => null,
                         'AdditionalTypeID' => null,
                         'AdditionalTypeDesc' => null,
                         'ParentCommitteeID' => null,
                         'CommitteeParentName' => null,
                         'IsCurrent' => true,
                         'LastUpdatedDate' => Carbon::__set_state(array(
-                                'date' => '2015-03-20 12:02:57.000000',
-                                'timezone_type' => 3,
-                                'timezone' => 'UTC',
-                            )),
+                            'date' => '2015-03-20 12:02:57.000000',
+                            'timezone_type' => 3,
+                            'timezone' => 'UTC',
+                        )),
                     ), $row);
                 }
                 ++$rowNum;