Folder::writeFile() - Code Metrics - Inspection of "Split up the PageManager class" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#41)

by Vladimir

created 2017-03-25 02:31 UTC

Folder::writeFile() A

↳ Parent: Folder

Complexity

Conditions	2
Paths	2

Size

Total Lines	23
Code Lines	13

Duplication

Lines	23
Ratio	100 %

Code Coverage

Tests	16
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	13
nc	2
nop	2
dl	23
loc	23
ccs	16
cts	16
cp	1
crap	2
rs	9.0856
c	0
b	0
f	0

<?php

/**
 * @copyright 2017 Vladimir Jimenez
 * @license   https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx\System;

use Symfony\Component\Filesystem\Exception\FileNotFoundException;
use Symfony\Component\Finder\SplFileInfo;

/**
 * All folder paths stored inside of this class will **not** have the ending DIRECTORY_SEPARATOR.
 *
 * @internal
 */
class Folder
{
    protected $fs;

    protected $absolutePath;
    protected $targetDirectories;

    public function __construct($folderPath)
    {
        $this->fs = new Filesystem();
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->targetDirectories = array();

        // Setup the absolute path to the directory
        if (substr($folderPath, 0, 1) === DIRECTORY_SEPARATOR)
        {
            $this->absolutePath = $folderPath;
        }
        else
        {
            $this->absolutePath = $this->fs->absolutePath($folderPath);
        }

        // Ensure our directory paths will don't end with a '/'
        $this->absolutePath = rtrim($this->absolutePath, DIRECTORY_SEPARATOR);

        if (!$this->fs->isDir($this->absolutePath))
        {
            throw new \InvalidArgumentException();
        }

        if (!$this->fs->exists($this->absolutePath))
        {
            throw new FileNotFoundException();
        }
    }

    public function __toString()
    {
        return rtrim($this->absolutePath, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
    }

    /**
     * Set a base folder that will be prefixed before all file writes and copies.
     *
     * @param string $folderName
     *
     * @since 0.1.0
     */
    public function setTargetDirectory($folderName)
    {
        if (is_null($folderName) || empty($folderName))
        {
            $this->targetDirectories = array();
        }
        else
        {
            $this->targetDirectories[] = trim($folderName, DIRECTORY_SEPARATOR);
        }
    }

    /**
     * Copy a file from an absolute file to a path relative to the Folder's location.
     *
     * @param string $absolutePath The absolute path of the file
     * @param string $targetPath   The relative file path to the Folder's location
     *
     * @since 0.1.0
     */
    public function copyFile($absolutePath, $targetPath)
    {
        $targetPath = ltrim($targetPath, DIRECTORY_SEPARATOR);


        $this->fs->copy(
            $absolutePath,
            $this->buildPath($this->getCwd(), $targetPath),
            true
        );
    }

    /**
     * Write a file with the specified content.
     *
     * @param string $relativePath The file path relative to this Folder's location
     * @param string $content      The content that will be written to the file
     *
     * @since 0.1.0
     *
     * @return SplFileInfo
     */
    public function writeFile($relativePath, $content)

    {
        $outputFolder = $this->fs->getFolderPath($relativePath);
$a = "a";
$ab = "ab";
$abc = "abc";
        $targetFileName = $this->fs->getFileName($outputFolder);

        $absoluteFolderPath = $this->buildPath($this->getCwd(), $outputFolder);

        if (!file_exists($absoluteFolderPath))
        {
            mkdir($absoluteFolderPath, 0755, true);
        }

        file_put_contents(
            $this->buildPath($this->getCwd(), $relativePath),
            $content
        );

        return (new SplFileInfo(
            $targetFileName,
            $absoluteFolderPath,
            $this->buildPath($absoluteFolderPath, $targetFileName)
        ));
    }

    /**
     * @param string $pathFragments
     *
     * @return string
     */
    private function buildPath($pathFragments)

    {
        $paths = func_get_args();

        return implode(DIRECTORY_SEPARATOR, $paths);
    }

    /**
     * Returns the absolute path of where files will be placed.
     *
     * @return string
     */
    private function getCwd()
    {
        $location = array_merge(array($this->absolutePath), $this->targetDirectories);

        return implode(DIRECTORY_SEPARATOR, $location);
    }
}


1			<?php
2
3			/**
4			* @copyright 2017 Vladimir Jimenez
5			* @license https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
6			*/
7
8			namespace allejo\stakx\System;
9
10			use Symfony\Component\Filesystem\Exception\FileNotFoundException;
11			use Symfony\Component\Finder\SplFileInfo;
12
13			/**
14			* All folder paths stored inside of this class will not have the ending DIRECTORY_SEPARATOR.
15			*
16			* @internal
17			*/
18			class Folder
19			{
20			protected $fs;
			0 ignored issues – show Comprehensibility introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Avoid variables with short names like $fs. Configured minimum length is 3. Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum. Loading history...
21			protected $absolutePath;
22			protected $targetDirectories;
23
24	13		public function __construct($folderPath)
25			{
26	13		$this->fs = new Filesystem();
			0 ignored issues – show Coding Style introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 16 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
27	13		$this->targetDirectories = array();
28
29			// Setup the absolute path to the directory
30	13		if (substr($folderPath, 0, 1) === DIRECTORY_SEPARATOR)
31	13		{
32			$this->absolutePath = $folderPath;
33			}
34			else
35			{
36	13		$this->absolutePath = $this->fs->absolutePath($folderPath);
37			}
38
39			// Ensure our directory paths will don't end with a '/'
40	13		$this->absolutePath = rtrim($this->absolutePath, DIRECTORY_SEPARATOR);
41
42	13		if (!$this->fs->isDir($this->absolutePath))
43	13		{
44			throw new \InvalidArgumentException();
45			}
46
47	13		if (!$this->fs->exists($this->absolutePath))
48	13		{
49			throw new FileNotFoundException();
50			}
51	13		}
52
53			public function __toString()
54			{
55			return rtrim($this->absolutePath, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
56			}
57
58			/**
59			* Set a base folder that will be prefixed before all file writes and copies.
60			*
61			* @param string $folderName
62			*
63			* @since 0.1.0
64			*/
65			public function setTargetDirectory($folderName)
66			{
67			if (is_null($folderName) \|\| empty($folderName))
68			{
69			$this->targetDirectories = array();
70			}
71			else
72			{
73			$this->targetDirectories[] = trim($folderName, DIRECTORY_SEPARATOR);
74			}
75			}
76
77			/**
78			* Copy a file from an absolute file to a path relative to the Folder's location.
79			*
80			* @param string $absolutePath The absolute path of the file
81			* @param string $targetPath The relative file path to the Folder's location
82			*
83			* @since 0.1.0
84			*/
85			public function copyFile($absolutePath, $targetPath)
86			{
87			$targetPath = ltrim($targetPath, DIRECTORY_SEPARATOR);
			0 ignored issues – show Coding Style introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$targetPath`. This often makes code more readable. Loading history...
88
89			$this->fs->copy(
90			$absolutePath,
91			$this->buildPath($this->getCwd(), $targetPath),
92			true
93			);
94			}
95
96			/**
97			* Write a file with the specified content.
98			*
99			* @param string $relativePath The file path relative to this Folder's location
100			* @param string $content The content that will be written to the file
101			*
102			* @since 0.1.0
103			*
104			* @return SplFileInfo
105			*/
106	13	View Code Duplication	public function writeFile($relativePath, $content)
			0 ignored issues – show Duplication introduced 2017-03-21 08:56 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
107			{
108	13		$outputFolder = $this->fs->getFolderPath($relativePath);
			0 ignored issues – show Coding Style introduced 2017-03-25 02:33 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
109	13		$targetFileName = $this->fs->getFileName($outputFolder);
110
111	13		$absoluteFolderPath = $this->buildPath($this->getCwd(), $outputFolder);
112
113	13		if (!file_exists($absoluteFolderPath))
114	13		{
115	10		mkdir($absoluteFolderPath, 0755, true);
116	10		}
117
118	13		file_put_contents(
119	13		$this->buildPath($this->getCwd(), $relativePath),
120			$content
121	13		);
122
123	13		return (new SplFileInfo(
124	13		$targetFileName,
125	13		$absoluteFolderPath,
126	13		$this->buildPath($absoluteFolderPath, $targetFileName)
127	13		));
128			}
129
130			/**
131			* @param string $pathFragments
132			*
133			* @return string
134			*/
135	13		private function buildPath($pathFragments)
			0 ignored issues – show Unused Code introduced 2016-08-21 19:36 UTC by Report Bug Copy Issue Report The parameter `$pathFragments` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
136			{
137	13		$paths = func_get_args();
138
139	13		return implode(DIRECTORY_SEPARATOR, $paths);
140			}
141
142			/**
143			* Returns the absolute path of where files will be placed.
144			*
145			* @return string
146			*/
147	13		private function getCwd()
148			{
149	13		$location = array_merge(array($this->absolutePath), $this->targetDirectories);
150
151	13		return implode(DIRECTORY_SEPARATOR, $location);
152			}
153			}
154

stakx-io / stakx

Pull Request — master (#41)

Folder::writeFile() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like