BaseDatapackage::copy() - Code Metrics - Inspection of "Update the save() method to set relative paths for..." - frictionlessdata/datapackage-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#42)

unknown

created 2019-04-02 04:52 UTC

BaseDatapackage::copy() A

↳ Parent: BaseDatapackage

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace frictionlessdata\datapackage\Datapackages;

use frictionlessdata\datapackage\Factory;
use frictionlessdata\datapackage\Registry;
use frictionlessdata\datapackage\Utils;
use frictionlessdata\datapackage\Validators\DatapackageValidator;
use frictionlessdata\datapackage\Exceptions\DatapackageValidationFailedException;
use Chumper\Zipper\Zipper;

abstract class BaseDatapackage implements \Iterator
{
    /**
     * BaseDatapackage constructor.
     *
     * @param object      $descriptor
     * @param null|string $basePath
     *
     * @throws DatapackageValidationFailedException
     */
    public function __construct($descriptor, $basePath = null, $skipValidations = false)
    {
        $this->descriptor = $descriptor;
        $this->basePath = $basePath;
        $this->skipValidations = $skipValidations;
        if (!$this->skipValidations) {
            $this->revalidate();
        }
    }

    public static function create($name, $resources, $basePath = null)
    {
        $datapackage = new static((object) [
            'name' => $name,
            'resources' => [],
        ], $basePath, true);
        foreach ($resources as $resource) {
            $datapackage->addResource($resource);

        }

        return $datapackage;
    }

    public function revalidate()
    {
        $this->rewind();
        $validationErrors = $this->datapackageValidate();
        if (count($validationErrors) > 0) {
            throw new DatapackageValidationFailedException($validationErrors);
        }
    }

    public static function handlesDescriptor($descriptor)
    {
        return static::handlesProfile(Registry::getDatapackageValidationProfile($descriptor));
    }

    /**
     * returns the descriptor as-is, without adding default values or normalizing.
     *
     * @return object
     */
    public function descriptor()
    {
        return $this->descriptor;
    }

    public function resources()
    {
        $resources = [];
        foreach ($this->descriptor->resources as $resourceDescriptor) {
            $resources[$resourceDescriptor->name] = $this->initResource($resourceDescriptor);
        }

        return $resources;
    }

    public function getResource($name)
    {
        foreach ($this->descriptor->resources as $resourceDescriptor) {
            if ($resourceDescriptor->name == $name) {
                return $this->initResource($resourceDescriptor);
            }
        }
        throw new \Exception("couldn't find matching resource with name =  '{$name}'");
    }

    public function addResource($name, $resource)
    {
        if (is_a($resource, 'frictionlessdata\\datapackage\\Resources\\BaseResource')) {
            $resource = $resource->descriptor();
        } else {
            $resource = Utils::objectify($resource);
        }
        $resource->name = $name;
        $resourceDescriptors = [];
        $gotMatch = false;
        foreach ($this->descriptor->resources as $resourceDescriptor) {
            if ($resourceDescriptor->name == $resource->name) {
                $resourceDescriptors[] = $resource;
                $gotMatch = true;
            } else {
                $resourceDescriptors[] = $resourceDescriptor;
            }
        }
        if (!$gotMatch) {
            $resourceDescriptors[] = $resource;
        }
        $this->descriptor->resources = $resourceDescriptors;
        if (!$this->skipValidations) {
            $this->revalidate();
        }
    }

    // TODO: remove this function and use the getResource / addResource directly (will need to modify a lot of tests code)
    public function resource($name, $resource = null)
    {
        if ($resource) {
            $this->addResource($name, $resource);
        } else {
            return $this->getResource($name);
        }
    }

    public function removeResource($name)
    {
        $resourceDescriptors = [];
        foreach ($this->descriptor->resources as $resourceDescriptor) {
            if ($resourceDescriptor->name != $name) {
                $resourceDescriptors[] = $resourceDescriptor;
            }
        }
        $this->descriptor->resources = $resourceDescriptors;
        if (!$this->skipValidations) {
            $this->revalidate();
        }
    }

    public function saveDescriptor($filename)
    {
        return file_put_contents($filename, json_encode($this->descriptor()));
    }

    // standard iterator functions - to iterate over the resources
    public function rewind()
    {
        $this->currentResourcePosition = 0;
    }

    public function current()
    {
        return $this->initResource($this->descriptor()->resources[$this->currentResourcePosition]);
    }

    public function key()
    {
        return $this->currentResourcePosition;
    }

    public function next()
    {
        ++$this->currentResourcePosition;
    }

    public function valid()
    {
        return isset($this->descriptor()->resources[$this->currentResourcePosition]);
    }

    public function save($zip_filename)
    {
        $zipper = new Zipper();

        $packageCopy = $this->copy();

        $base = tempnam(sys_get_temp_dir(), 'datapackage-zip-');
        $files = [
            'datapackage.json' => $base.'datapackage.json',
        ];
        $ri = 0;

        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;
        }

        $packageCopy->saveDescriptor($files['datapackage.json']);

        /* @noinspection PhpUnhandledExceptionInspection Never occurs with our args */
        $zipper->make($zip_filename)->add($files)->close();
        foreach (array_values($files) as $file) {
            unlink($file);
        }
    }

    public 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
     */
    protected function initResource($descriptor)
    {
        return Factory::resource($descriptor, $this->basePath, $this->skipValidations);
    }

    protected function datapackageValidate()
    {
        return DatapackageValidator::validate($this->descriptor(), $this->basePath);
    }

    protected static function handlesProfile($profile)
    {
        return false;
    }
}


1			<?php
2
3			namespace frictionlessdata\datapackage\Datapackages;
4
5			use frictionlessdata\datapackage\Factory;
6			use frictionlessdata\datapackage\Registry;
7			use frictionlessdata\datapackage\Utils;
8			use frictionlessdata\datapackage\Validators\DatapackageValidator;
9			use frictionlessdata\datapackage\Exceptions\DatapackageValidationFailedException;
10			use Chumper\Zipper\Zipper;
11
12			abstract class BaseDatapackage implements \Iterator
13			{
14			/**
15			* BaseDatapackage constructor.
16			*
17			* @param object $descriptor
18			* @param null\|string $basePath
19			*
20			* @throws DatapackageValidationFailedException
21			*/
22			public function __construct($descriptor, $basePath = null, $skipValidations = false)
23			{
24			$this->descriptor = $descriptor;
25			$this->basePath = $basePath;
26			$this->skipValidations = $skipValidations;
27			if (!$this->skipValidations) {
28			$this->revalidate();
29			}
30			}
31
32			public static function create($name, $resources, $basePath = null)
33			{
34			$datapackage = new static((object) [
35			'name' => $name,
36			'resources' => [],
37			], $basePath, true);
38			foreach ($resources as $resource) {
39			$datapackage->addResource($resource);
			0 ignored issues – show Bug introduced 2017-11-30 14:10 UTC by Report Bug Copy Issue Report The call to `addResource()` misses a required argument `$resource`. This check looks for function calls that miss required arguments. Loading history...
40			}
41
42			return $datapackage;
43			}
44
45			public function revalidate()
46			{
47			$this->rewind();
48			$validationErrors = $this->datapackageValidate();
49			if (count($validationErrors) > 0) {
50			throw new DatapackageValidationFailedException($validationErrors);
51			}
52			}
53
54			public static function handlesDescriptor($descriptor)
55			{
56			return static::handlesProfile(Registry::getDatapackageValidationProfile($descriptor));
57			}
58
59			/**
60			* returns the descriptor as-is, without adding default values or normalizing.
61			*
62			* @return object
63			*/
64			public function descriptor()
65			{
66			return $this->descriptor;
67			}
68
69			public function resources()
70			{
71			$resources = [];
72			foreach ($this->descriptor->resources as $resourceDescriptor) {
73			$resources[$resourceDescriptor->name] = $this->initResource($resourceDescriptor);
74			}
75
76			return $resources;
77			}
78
79			public function getResource($name)
80			{
81			foreach ($this->descriptor->resources as $resourceDescriptor) {
82			if ($resourceDescriptor->name == $name) {
83			return $this->initResource($resourceDescriptor);
84			}
85			}
86			throw new \Exception("couldn't find matching resource with name = '{$name}'");
87			}
88
89			public function addResource($name, $resource)
90			{
91			if (is_a($resource, 'frictionlessdata\\datapackage\\Resources\\BaseResource')) {
92			$resource = $resource->descriptor();
93			} else {
94			$resource = Utils::objectify($resource);
95			}
96			$resource->name = $name;
97			$resourceDescriptors = [];
98			$gotMatch = false;
99			foreach ($this->descriptor->resources as $resourceDescriptor) {
100			if ($resourceDescriptor->name == $resource->name) {
101			$resourceDescriptors[] = $resource;
102			$gotMatch = true;
103			} else {
104			$resourceDescriptors[] = $resourceDescriptor;
105			}
106			}
107			if (!$gotMatch) {
108			$resourceDescriptors[] = $resource;
109			}
110			$this->descriptor->resources = $resourceDescriptors;
111			if (!$this->skipValidations) {
112			$this->revalidate();
113			}
114			}
115
116			// TODO: remove this function and use the getResource / addResource directly (will need to modify a lot of tests code)
117			public function resource($name, $resource = null)
118			{
119			if ($resource) {
120			$this->addResource($name, $resource);
121			} else {
122			return $this->getResource($name);
123			}
124			}
125
126			public function removeResource($name)
127			{
128			$resourceDescriptors = [];
129			foreach ($this->descriptor->resources as $resourceDescriptor) {
130			if ($resourceDescriptor->name != $name) {
131			$resourceDescriptors[] = $resourceDescriptor;
132			}
133			}
134			$this->descriptor->resources = $resourceDescriptors;
135			if (!$this->skipValidations) {
136			$this->revalidate();
137			}
138			}
139
140			public function saveDescriptor($filename)
141			{
142			return file_put_contents($filename, json_encode($this->descriptor()));
143			}
144
145			// standard iterator functions - to iterate over the resources
146			public function rewind()
147			{
148			$this->currentResourcePosition = 0;
149			}
150
151			public function current()
152			{
153			return $this->initResource($this->descriptor()->resources[$this->currentResourcePosition]);
154			}
155
156			public function key()
157			{
158			return $this->currentResourcePosition;
159			}
160
161			public function next()
162			{
163			++$this->currentResourcePosition;
164			}
165
166			public function valid()
167			{
168			return isset($this->descriptor()->resources[$this->currentResourcePosition]);
169			}
170
171			public function save($zip_filename)
172			{
173			$zipper = new Zipper();
174
175			$packageCopy = $this->copy();
176
177			$base = tempnam(sys_get_temp_dir(), 'datapackage-zip-');
178			$files = [
179			'datapackage.json' => $base.'datapackage.json',
180			];
181			$ri = 0;
182
183			foreach ($packageCopy->resources() as $resource) {
184			$resourceFiles = [];
185			$fileNames = $resource->save($base.'resource-'.$ri);
186			foreach ($fileNames as $fileName) {
187			$relname = str_replace($base.'resource-'.$ri, '', $fileName);
188			$files['resource-'.$ri.$relname] = $fileName;
189			$resourceFiles []= 'resource-'.$ri.$relname;
190			}
191			$resource->descriptor()->path = count($resourceFiles) == 1 ? $resourceFiles[0] : $resourceFiles;
192			++$ri;
193			}
194
195			$packageCopy->saveDescriptor($files['datapackage.json']);
196
197			/* @noinspection PhpUnhandledExceptionInspection Never occurs with our args */
198			$zipper->make($zip_filename)->add($files)->close();
199			foreach (array_values($files) as $file) {
200			unlink($file);
201			}
202			}
203
204			public function copy()
205			{
206			return new static($this->descriptor, $this->basePath, true);
207			}
208
209			protected $descriptor;
210			protected $currentResourcePosition = 0;
211			protected $basePath;
212			protected $skipValidations = false;
213
214			/**
215			* called by the resources iterator for each iteration.
216			*
217			* @param object $descriptor
218			*
219			* @return \frictionlessdata\datapackage\Resources\BaseResource
220			*/
221			protected function initResource($descriptor)
222			{
223			return Factory::resource($descriptor, $this->basePath, $this->skipValidations);
224			}
225
226			protected function datapackageValidate()
227			{
228			return DatapackageValidator::validate($this->descriptor(), $this->basePath);
229			}
230
231			protected static function handlesProfile($profile)
232			{
233			return false;
234			}
235			}
236

frictionlessdata / datapackage-php

Pull Request — master (#42)

BaseDatapackage::copy() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like