TypeConverter::convertToBSONType() - Code Metrics - Inspection of "[WIP] Ensure methods return correct values" - alcaeus/mongo-php-adapter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#17)

by Andreas

created 2016-01-05 09:18 UTC

TypeConverter::convertToBSONType() A

↳ Parent: TypeConverter

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
ccs	7
cts	7
cp	1
rs	9.4286
cc	2
eloc	6
nc	2
nop	1
crap	2

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

namespace Alcaeus\MongoDbAdapter;

/**
 * @internal
 */
class TypeConverter
{
    public static function convertLegacyArrayToObject($array)
    {
        // TODO: provide actual class once mongodb/mongo-php-library#78 has been merged
        $result = [];

        foreach ($array as $key => $value) {
            $result[$key] = (is_array($value)) ? static::convertLegacyArrayToObject($value) : static::convertToBSONType($value);
        }

        return self::ensureCorrectType($result);
    }

    public static function convertObjectToLegacyArray($object)
    {
        $result = [];

        foreach ($object as $key => $value) {
            // TODO: use actual class instead of \stdClass once mongodb/mongo-php-library#78 has been merged
            $result[$key] = ($value instanceof \stdClass || is_array($value)) ? static::convertObjectToLegacyArray($value) : static::convertToLegacyType($value);
        }

        return $result;
    }

    public static function convertToLegacyType($value)
    {
        switch (true) {
            case $value instanceof \MongoDB\BSON\ObjectID:
if ($x instanceof DoesNotExist) {
    // Do something.
}
                return new \MongoId($value);
            case $value instanceof \MongoDB\BSON\Binary:
if ($x instanceof DoesNotExist) {
    // Do something.
}
                return new \MongoBinData($value);
            case $value instanceof \MongoDB\BSON\Javascript:
if ($x instanceof DoesNotExist) {
    // Do something.
}
                return new \MongoCode($value);
            case $value instanceof \MongoDB\BSON\MaxKey:
if ($x instanceof DoesNotExist) {
    // Do something.
}
                return new \MongoMaxKey();
            case $value instanceof \MongoDB\BSON\MinKey:
if ($x instanceof DoesNotExist) {
    // Do something.
}
                return new \MongoMinKey();
            case $value instanceof \MongoDB\BSON\Regex:
if ($x instanceof DoesNotExist) {
    // Do something.
}
                return new \MongoRegex($value);
            case $value instanceof \MongoDB\BSON\Timestamp:
if ($x instanceof DoesNotExist) {
    // Do something.
}
                return new \MongoTimestamp($value);
            case $value instanceof \MongoDB\BSON\UTCDatetime:
if ($x instanceof DoesNotExist) {
    // Do something.
}
                return new \MongoDate($value);
            default:
                return $value;
        }
    }

    public static function convertToBSONType($value)
    {
        switch (true) {
            case $value instanceof TypeInterface:
                return $value->toBSONType();

            default:
                return $value;
        }
    }

    /**
     * @param array $array
     * @return bool
     */
    public static function isNumericArray(array $array)
    {
        return $array === [] || is_numeric(array_keys($array)[0]);
    }

    /**
     * Converts all arrays with non-numeric keys to stdClass
     *
     * @param array $array
     * @return array|\stdClass
     */
    private static function ensureCorrectType(array $array)
    {
        // Empty arrays are left untouched since they may be an empty list or empty document
        if (static::isNumericArray($array)) {
            return $array;
        }

        // Can convert array to stdClass
        $object = new \stdClass();
        foreach ($array as $key => $value) {
            $object->$key = $value;
        }

        return $object;
    }
}


1		<?php
2		/*
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*/
15
16		namespace Alcaeus\MongoDbAdapter;
17
18		/**
19		* @internal
20		*/
21		class TypeConverter
22		{
23	44	public static function convertLegacyArrayToObject($array)
24		{
25		// TODO: provide actual class once mongodb/mongo-php-library#78 has been merged
26	44	$result = [];
27
28	44	foreach ($array as $key => $value) {
29	44	$result[$key] = (is_array($value)) ? static::convertLegacyArrayToObject($value) : static::convertToBSONType($value);
30	44	}
31
32	44	return self::ensureCorrectType($result);
33		}
34
35	24	public static function convertObjectToLegacyArray($object)
36		{
37	24	$result = [];
38
39	24	foreach ($object as $key => $value) {
40		// TODO: use actual class instead of \stdClass once mongodb/mongo-php-library#78 has been merged
41	24	$result[$key] = ($value instanceof \stdClass \|\| is_array($value)) ? static::convertObjectToLegacyArray($value) : static::convertToLegacyType($value);
42	24	}
43
44	24	return $result;
45		}
46
47	26	public static function convertToLegacyType($value)
48		{
49	26	switch (true) {
50	26	case $value instanceof \MongoDB\BSON\ObjectID:
		1 ignored issue – show Bug introduced 2015-12-30 16:39 UTC by Report Bug Copy Issue Report The class `MongoDB\BSON\ObjectID` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
51	8	return new \MongoId($value);
52	26	case $value instanceof \MongoDB\BSON\Binary:
		1 ignored issue – show Bug introduced 2016-01-03 10:53 UTC by Report Bug Copy Issue Report The class `MongoDB\BSON\Binary` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
53		return new \MongoBinData($value);
54	26	case $value instanceof \MongoDB\BSON\Javascript:
		1 ignored issue – show Bug introduced 2016-01-04 10:46 UTC by Report Bug Copy Issue Report The class `MongoDB\BSON\Javascript` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
55		return new \MongoCode($value);
56	26	case $value instanceof \MongoDB\BSON\MaxKey:
		1 ignored issue – show Bug introduced 2016-01-04 10:46 UTC by Report Bug Copy Issue Report The class `MongoDB\BSON\MaxKey` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
57		return new \MongoMaxKey();
58	26	case $value instanceof \MongoDB\BSON\MinKey:
		1 ignored issue – show Bug introduced 2016-01-04 10:46 UTC by Report Bug Copy Issue Report The class `MongoDB\BSON\MinKey` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
59		return new \MongoMinKey();
60	26	case $value instanceof \MongoDB\BSON\Regex:
		1 ignored issue – show Bug introduced 2016-01-04 10:46 UTC by Report Bug Copy Issue Report The class `MongoDB\BSON\Regex` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
61		return new \MongoRegex($value);
62	26	case $value instanceof \MongoDB\BSON\Timestamp:
		1 ignored issue – show Bug introduced 2016-01-04 10:46 UTC by Report Bug Copy Issue Report The class `MongoDB\BSON\Timestamp` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
63		return new \MongoTimestamp($value);
64	26	case $value instanceof \MongoDB\BSON\UTCDatetime:
		1 ignored issue – show Bug introduced 2016-01-04 10:46 UTC by Report Bug Copy Issue Report The class `MongoDB\BSON\UTCDatetime` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
65		return new \MongoDate($value);
66	26	default:
67	26	return $value;
68	26	}
69		}
70
71	44	public static function convertToBSONType($value)
72		{
73	44	switch (true) {
74	44	case $value instanceof TypeInterface:
75	9	return $value->toBSONType();
76
77	44	default:
78	44	return $value;
79	44	}
80		}
81
82		/**
83		* @param array $array
84		* @return bool
85		*/
86	44	public static function isNumericArray(array $array)
87		{
88	44	return $array === [] \|\| is_numeric(array_keys($array)[0]);
89		}
90
91		/**
92		* Converts all arrays with non-numeric keys to stdClass
93		*
94		* @param array $array
95		* @return array\|\stdClass
96		*/
97	44	private static function ensureCorrectType(array $array)
98		{
99		// Empty arrays are left untouched since they may be an empty list or empty document
100	44	if (static::isNumericArray($array)) {
101	7	return $array;
102		}
103
104		// Can convert array to stdClass
105	44	$object = new \stdClass();
106	44	foreach ($array as $key => $value) {
107	44	$object->$key = $value;
108	44	}
109
110	44	return $object;
111		}
112		}
113

alcaeus / mongo-php-adapter

Pull Request — master (#17)

TypeConverter::convertToBSONType() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like