Properties - Code Metrics - Inspection of "Minor fixes and code improvements" - xeriab/konfig - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 33953d...4a13d7 )

by Xeriab

created 2016-10-19 09:52 UTC

Properties C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	437
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
wmc	73
c	1
b	1
f	0
lcom	1
cbo	4
dl	0
loc	437
ccs	11
cts	11
cp	1
rs	5.5447

10 Methods

Rating	Name	Size	Complexity
B	parse()	28	2
A	getSupportedFileExtensions()	4	1
F	parseProperties()	145	34
F	extractData()	98	21
A	unescapeProperties()	8	2
A	deleteFields()	10	3
A	getProperties()	18	4
A	loadFile()	13	4
A	exportFormat()	6	1
A	__toString()	4	1

How to fix Complexity

<?php

/**
 * Konfig.
 *
 * Yet another simple configuration loader library.
 *
 * PHP version 5
 *
 * @category Library
 * @package  Konfig
 * @author   Xeriab Nabil (aka KodeBurner) <[email protected]>
 * @license  https://raw.github.com/xeriab/konfig/master/LICENSE MIT
 * @link     https://xeriab.github.io/projects/konfig
 */

namespace Exen\Konfig\FileParser;

use Exception;
use Exen\Konfig\Arr;
use Exen\Konfig\Utils;
use Exen\Konfig\Exception\ParseException;

/**
 * Properties
 * Konfig's Java-Properties parser class.
 *
 * @category FileParser
 * @package  Konfig
 * @author   Xeriab Nabil (aka KodeBurner) <[email protected]>
 * @license  https://raw.github.com/xeriab/konfig/master/LICENSE MIT
 * @link     https://xeriab.github.io/projects/konfig
 *
 * @implements Exen\Konfig\FileParser\AbstractFileParser
 */
class Properties extends AbstractFileParser
{
    /**
     * Loads a PROPERTIES file as an array.
     *
     * @param string $path File path
     *
     * @throws ParseException If there is an error parsing PROPERTIES file
     *
     * @return array The parsed data
     *
     * @since 0.2.4
     */
    public function parse($path)
    {
        $data = null;

        $this->loadFile($path);

        // if (!$data || empty($data) || !is_array($data)) {
        //     throw new ParseException(
        //         [
        //         'message' => 'Error parsing PROPERTIES file',
        //         'file' => $path,
        //         ]
        //     );
        // }

        try {
            $data = $this->getProperties();
        } catch (Exception $ex) {
            throw new ParseException(
                [
                    'message' => 'Error parsing PROPERTIES file',
                    'exception' => $ex
                ]
            );
        }

        return $data;
    }

    /**
     * {@inheritdoc}
     *
     * @return array Supported extensions
     *
     * @since 0.1.0
     */
    public function getSupportedFileExtensions()
    {
        return ['properties'];
    }

    /**
     * Parse Java-Properties
     *
     * @return             array The parsed data
     * @since              0.2.6
     * @codeCoverageIgnore
     */
    private function parseProperties()
    {
        $analysis = [];

        static $isWaitingForOtherLine = false;

        foreach ($this->parsedFile as $lineNb => $line) {

            $ifl = array_flip(array_keys($this->parsedFile))[$lineNb] + 1;

            if ((empty($line) || is_null($line)) && !$isWaitingForOtherLine) {
                $analysis[$lineNb] = ['emptyline', null, 'line' => $ifl];
                continue;
            }

            if (!$isWaitingForOtherLine && Utils::stringStart('#', $line)) {
                $analysis[$lineNb] = [
                    'comment',
                    trim(substr($line, 0)),
                    'line' => $ifl
                ];

                continue;
            }

            // Property name, check for escaped equal sign
            if (substr_count($line, '=') > substr_count($line, '\=')) {
                $temp = explode('=', $line, 2);
                $temp = Utils::trimArrayElements($temp);

                if (count($temp) === 2) {
                    $temp[1] = Utils::removeQuotes($temp[1]);
                    $analysis[$lineNb] = [
                        'property',
                        $temp[0],
                        $temp[1],
                        'line' => $ifl
                    ];
                }

                unset($temp);

                continue;
            } else {
                throw new Exception('Wrong Configuration');
                // break;
            }

            // Multiline data
            if (substr_count($line, '=') === 0) {
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
                $analysis[$lineNb] = ['multiline', null, $line, 'line' => $ifl];
                continue;
            }
        }

        // Second pass, we associate comments to entities
        $counter = Utils::getNumberLinesMatching('comment', $analysis);

        while ($counter > 0) {
            foreach ($analysis as $lineNb => $line) {
                if ($line[0] === 'comment'
                    && isset($analysis[$lineNb + 1][0])
                    && $analysis[$lineNb + 1][0] === 'comment'
                ) {
                    $analysis[$lineNb][1] .= ' ' . $analysis[$lineNb + 1][1];
                    $analysis[$lineNb + 1][0] = 'erase';

                    break;
                } elseif ($line[0] === 'comment'
                    && isset($analysis[$lineNb + 1][0])
                    && $analysis[$lineNb + 1][0] === 'property'
                ) {
                    // $analysis[$lineNb + 1][3] = $line[1];
                    $analysis[$lineNb][0] = 'erase';
                } elseif ($line[0] === 'comment'
                    && isset($analysis[$lineNb + 1][0])
                    && $analysis[$lineNb + 1][0] === 'emptyline'
                ) {
                    // $analysis[$lineNb + 1][3] = $line[1];
                    $analysis[$lineNb][0] = 'erase';
                }
            }

            $counter = Utils::getNumberLinesMatching('comment', $analysis);
            $analysis = $this->deleteFields('erase', $analysis);
        }

        // Count emptylines
        $counter = Utils::getNumberLinesMatching('emptyline', $analysis);

        while ($counter > 0) {
            foreach ($analysis as $lineNb => $line) {
                if ($line[0] === 'emptyline') {
                    $analysis[$lineNb][0] = 'erase';
                }
            }

            $counter = Utils::getNumberLinesMatching('emptyline', $analysis);
            $analysis = $this->deleteFields('erase', $analysis);
        }

        // Third pass, we merge multiline strings

        // We remove the backslashes at end of strings if they exist
        $analysis = Utils::stripBackslashes($analysis);

        // Count # of multilines
        $counter = Utils::getNumberLinesMatching('multiline', $analysis);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        while ($counter > 0) {
            foreach ($analysis as $lineNb => $line) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                if ($line[0] === 'multiline'
                    && isset($analysis[$lineNb - 1][0])
                    && $analysis[$lineNb - 1][0] === 'property'
                ) {
                    $analysis[$lineNb - 1][2] .= ' ' . trim($line[2]);
                    $analysis[$lineNb][0] = 'erase';

                    break;
                } elseif ($line[0] === 'multiline'
                    && isset($analysis[$lineNb - 1][0])
                    && $analysis[$lineNb - 1][0] === 'emptyline'
                ) {
                    // $analysis[$lineNb - 1][2] .= ' ' . trim($line[2]);
                    $analysis[$lineNb][0] = 'erase';
                }
            }

            $counter = Utils::getNumberLinesMatching('multiline', $analysis);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $analysis = $this->deleteFields('erase', $analysis);
        }

        // Step 4, we clean up strings from escaped characters in properties
        $analysis = $this->unescapeProperties($analysis);

        // Step 5, we only have properties now, remove redondant field 0
        foreach ($analysis as $key => $value) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (preg_match('/^[1-9][0-9]*$/', $value[2])) {
                $value[2] = intval($value[2]);
            }

            array_splice($analysis[$key], 0, 1);
        }

        return $analysis;
    }

    /**
     * {@inheritdoc}
     *
     * @return array The exteacted data
     *
     * @since              0.2.4
     * @codeCoverageIgnore
     */
    public function extractData()
    {
        $analysis = [];

        // First pass, we categorize each line
        foreach ($this->parsedFile as $lineNb => $line) {

            // Property name, check for escaped equal sign
            if (Utils::stringStart('#', $line)) {
                $analysis[$lineNb] = ['comment', trim(substr($line, 0))];
                continue;
            }

            // Property name, check for escaped equal sign
            if (substr_count($line, '=') > substr_count($line, '\=')) {
                $temp = explode('=', $line, 2);
                $temp = Utils::trimArrayElements($temp);

                if (count($temp) === 2) {
                    $temp[1] = Utils::removeQuotes($temp[1]);
                    $analysis[$lineNb] = ['property', $temp[0], $temp[1]];
                }

                unset($temp);

                continue;
            }

            // Multiline data
            if (substr_count($line, '=') === 0) {
                $analysis[$lineNb] = ['multiline', '', $line];
                continue;
            }
        }

        // Second pass, we associate comments to entities
        $counter = Utils::getNumberLinesMatching('comment', $analysis);

        while ($counter > 0) {
            foreach ($analysis as $lineNb => $line) {
                if ($line[0] === 'comment'
                    && isset($analysis[$lineNb + 1][0])
                    && $analysis[$lineNb + 1][0] === 'comment'
                ) {
                    $analysis[$lineNb][1] .= ' '.$analysis[$lineNb + 1][1];
                    $analysis[$lineNb + 1][0] = 'erase';

                    break;
                } elseif ($line[0] === 'comment'
                    && isset($analysis[$lineNb + 1][0])
                    && $analysis[$lineNb + 1][0] === 'property'
                ) {
                    $analysis[$lineNb + 1][3] = $line[1];
                    $analysis[$lineNb][0] = 'erase';
                }
            }

            $counter = Utils::getNumberLinesMatching('comment', $analysis);
            $analysis = $this->deleteFields('erase', $analysis);
        }

        // Third pass, we merge multiline strings

        // We remove the backslashes at end of strings if they exist
        $analysis = Utils::stripBackslashes($analysis);

        // Count # of multilines
        $counter = Utils::getNumberLinesMatching('multiline', $analysis);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        while ($counter > 0) {
            foreach ($analysis as $lineNb => $line) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                if ($line[0] === 'multiline'
                    && isset($analysis[$lineNb - 1][0])
                    && $analysis[$lineNb - 1][0] === 'property'
                ) {
                    $analysis[$lineNb - 1][2] .= ' ' . trim($line[2]);
                    $analysis[$lineNb][0] = 'erase';
                    break;
                }
            }

            $counter = Utils::getNumberLinesMatching('multiline', $analysis);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $analysis = $this->deleteFields('erase', $analysis);
        }

        // Step 4, we clean up strings from escaped characters in properties
        $analysis = $this->unescapeProperties($analysis);

        // Step 5, we only have properties now, remove redondant field 0
        foreach ($analysis as $key => $value) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (preg_match('/^[1-9][0-9]*$/', $value[2])) {
                $value[2] = intval($value[2]);
            }

            array_splice($analysis[$key], 0, 1);
        }

        return $analysis;
    }

    /**
     * {@inheritdoc}
     *
     * @param array|null $analysis Configuration items
     *
     * @return array The configuration items
     *
     * @since              0.2.4
     * @codeCoverageIgnore
     */
    private function unescapeProperties($analysis)
    {
        foreach ($analysis as $key => $value) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $analysis[$key][2] = str_replace('\=', '=', $value[2]);
        }

        return $analysis;
    }

    /**
     * {@inheritdoc}
     *
     * @param string     $field    Field name
     * @param array|null $analysis Configuration items
     *
     * @return array Configuration items after deletion
     *
     * @since              0.2.4
     * @codeCoverageIgnore
     */
    private function deleteFields($field, $analysis)
    {
        foreach ($analysis as $key => $value) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($value[0] === $field) {
                unset($analysis[$key]);
            }
        }

        return array_values($analysis);
    }

    /**
     * {@inheritdoc}
     *
     * @param string|bool|null $file File path
     *
     * @return array Configuration items
     *
     * @since              0.2.4
     * @codeCoverageIgnore
     */
    public function getProperties($file = null)
    {
        if ($file && !is_null($file)) {
            $this->loadFile($file);
        }

        // $source = $this->extractData();
        $source = $this->parseProperties();
        $data = [];

        foreach ($source as $value) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            Arr::set($data, $value[0], $value[1]);
        }

        unset($this->parsedFile);

        return $data;
    }

    /**
     * Loads in the given file and parses it.
     *
     * @param string|bool|null $file File to load
     *
     * @return array The parsed file data
     *
     * @since              0.2.4
     * @codeCoverageIgnore
     */
    protected function loadFile($file = null)
    {
        $this->file = is_file($file) ? $file : false;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        $contents = $this->parseVars(Utils::getContent($this->file));
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        if ($this->file && !is_null($file)) {
            $this->parsedFile = Utils::fileContentToArray($contents);

            // $this->parsedFile = Utils::fileToArray($this->file);
        } else {
            $this->parsedFile = false;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        }
    }

    /**
     * Returns the formatted configuration file contents.
     *
     * @param array $contents configuration array
     *
     * @return string formatted configuration file contents
     *
     * @since              0.2.4
     * @codeCoverageIgnore
     */
    protected function exportFormat($contents = null)
    {
        throw new Exception(
            'Saving configuration to `Properties` is not supported at this time'
        );
    }

    /**
     * __toString.
     *
     * @return             string
     * @since              0.1.2
     * @codeCoverageIgnore
     */
    public function __toString()
    {
        return 'Exen\Konfig\FileParser\Properties' . PHP_EOL;
    }
}

// END OF ./src/FileParser/Properties.php FILE


1			<?php
2
3			/**
4			* Konfig.
5			*
6			* Yet another simple configuration loader library.
7			*
8			* PHP version 5
9			*
10			* @category Library
11			* @package Konfig
12			* @author Xeriab Nabil (aka KodeBurner) <[email protected]>
13			* @license https://raw.github.com/xeriab/konfig/master/LICENSE MIT
14			* @link https://xeriab.github.io/projects/konfig
15			*/
16
17			namespace Exen\Konfig\FileParser;
18
19			use Exception;
20			use Exen\Konfig\Arr;
21			use Exen\Konfig\Utils;
22			use Exen\Konfig\Exception\ParseException;
23
24			/**
25			* Properties
26			* Konfig's Java-Properties parser class.
27			*
28			* @category FileParser
29			* @package Konfig
30			* @author Xeriab Nabil (aka KodeBurner) <[email protected]>
31			* @license https://raw.github.com/xeriab/konfig/master/LICENSE MIT
32			* @link https://xeriab.github.io/projects/konfig
33			*
34			* @implements Exen\Konfig\FileParser\AbstractFileParser
35			*/
36			class Properties extends AbstractFileParser
37			{
38			/**
39			* Loads a PROPERTIES file as an array.
40			*

xeriab / konfig

Push — master ( 33953d...4a13d7 )

Properties C

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

10 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like