Call::addScore() - Code Metrics - Inspection of "cache wildcard match score so it is only calculate..." - phpspec/prophecy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#360)

unknown

created 2017-09-22 08:20 UTC

Call::addScore() A

↳ Parent: Call

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2

<?php

/*
 * This file is part of the Prophecy.
 * (c) Konstantin Kudryashov <[email protected]>
 *     Marcello Duarte <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Prophecy\Call;

use Exception;
use Prophecy\Argument\ArgumentsWildcard;

/**
 * Call object.
 *
 * @author Konstantin Kudryashov <[email protected]>
 */
class Call
{
    private $methodName;
    private $arguments;
    private $returnValue;
    private $exception;
    private $file;
    private $line;
    private $scores;

    /**
     * Initializes call.
     *
     * @param string      $methodName
     * @param array       $arguments
     * @param mixed       $returnValue
     * @param Exception   $exception
     * @param null|string $file
     * @param null|int    $line
     */
    public function __construct($methodName, array $arguments, $returnValue,
                                Exception $exception = null, $file, $line)
    {
        $this->methodName  = $methodName;
        $this->arguments   = $arguments;
        $this->returnValue = $returnValue;
        $this->exception   = $exception;
        $this->scores      = new \SplObjectStorage();

        if ($file) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->file = $file;
            $this->line = intval($line);
        }
    }

    /**
     * Returns called method name.
     *
     * @return string
     */
    public function getMethodName()
    {
        return $this->methodName;
    }

    /**
     * Returns called method arguments.
     *
     * @return array
     */
    public function getArguments()
    {
        return $this->arguments;
    }

    /**
     * Returns called method return value.
     *
     * @return null|mixed
     */
    public function getReturnValue()
    {
        return $this->returnValue;
    }

    /**
     * Returns exception that call thrown.
     *
     * @return null|Exception
     */
    public function getException()
    {
        return $this->exception;
    }

    /**
     * Returns callee filename.
     *
     * @return string
     */
    public function getFile()
    {
        return $this->file;
    }

    /**
     * Returns callee line number.
     *
     * @return int
     */
    public function getLine()
    {
        return $this->line;
    }

    /**
     * Returns short notation for callee place.
     *
     * @return string
     */
    public function getCallPlace()
    {
        if (null === $this->file) {
            return 'unknown';
        }

        return sprintf('%s:%d', $this->file, $this->line);
    }

    /**
     * Adds the wildcard match score for the provided wildcard.
     *
     * @param ArgumentsWildcard $wildcard
     * @param false|int $score
     *
     * @return $this
     */
    public function addScore(ArgumentsWildcard $wildcard, $score)
    {
        $this->scores[$wildcard] = $score;

        return $this;
    }

    /**
     * Returns wildcard match score for the provided wildcard. The score is
     * calculated if not already done.
     *
     * @param ArgumentsWildcard $wildcard
     *
     * @return false|int False OR integer score (higher - better)
     */
    public function getScore(ArgumentsWildcard $wildcard)
    {
        if (isset($this->scores[$wildcard])) {
            return $this->scores[$wildcard];
        }

        return $this->scores[$wildcard] = $wildcard->scoreArguments($this->getArguments());

    }
}


1			<?php
2
3			/*
4			* This file is part of the Prophecy.
5			* (c) Konstantin Kudryashov <[email protected]>
6			* Marcello Duarte <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Prophecy\Call;
13
14			use Exception;
15			use Prophecy\Argument\ArgumentsWildcard;
16
17			/**
18			* Call object.
19			*
20			* @author Konstantin Kudryashov <[email protected]>
21			*/
22			class Call
23			{
24			private $methodName;
25			private $arguments;
26			private $returnValue;
27			private $exception;
28			private $file;
29			private $line;
30			private $scores;
31
32			/**
33			* Initializes call.
34			*
35			* @param string $methodName
36			* @param array $arguments
37			* @param mixed $returnValue
38			* @param Exception $exception
39			* @param null\|string $file
40			* @param null\|int $line
41			*/
42			public function __construct($methodName, array $arguments, $returnValue,
43			Exception $exception = null, $file, $line)
44			{
45			$this->methodName = $methodName;
46			$this->arguments = $arguments;
47			$this->returnValue = $returnValue;
48			$this->exception = $exception;
49			$this->scores = new \SplObjectStorage();
50
51			if ($file) {
			0 ignored issues – show Bug Best Practice introduced 2017-09-22 08:25 UTC by Report Bug Copy Issue Report The expression `$file` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
52			$this->file = $file;
53			$this->line = intval($line);
54			}
55			}
56
57			/**
58			* Returns called method name.
59			*
60			* @return string
61			*/
62			public function getMethodName()
63			{
64			return $this->methodName;
65			}
66
67			/**
68			* Returns called method arguments.
69			*
70			* @return array
71			*/
72			public function getArguments()
73			{
74			return $this->arguments;
75			}
76
77			/**
78			* Returns called method return value.
79			*
80			* @return null\|mixed
81			*/
82			public function getReturnValue()
83			{
84			return $this->returnValue;
85			}
86
87			/**
88			* Returns exception that call thrown.
89			*
90			* @return null\|Exception
91			*/
92			public function getException()
93			{
94			return $this->exception;
95			}
96
97			/**
98			* Returns callee filename.
99			*
100			* @return string
101			*/
102			public function getFile()
103			{
104			return $this->file;
105			}
106
107			/**
108			* Returns callee line number.
109			*
110			* @return int
111			*/
112			public function getLine()
113			{
114			return $this->line;
115			}
116
117			/**
118			* Returns short notation for callee place.
119			*
120			* @return string
121			*/
122			public function getCallPlace()
123			{
124			if (null === $this->file) {
125			return 'unknown';
126			}
127
128			return sprintf('%s:%d', $this->file, $this->line);
129			}
130
131			/**
132			* Adds the wildcard match score for the provided wildcard.
133			*
134			* @param ArgumentsWildcard $wildcard
135			* @param false\|int $score
136			*
137			* @return $this
138			*/
139			public function addScore(ArgumentsWildcard $wildcard, $score)
140			{
141			$this->scores[$wildcard] = $score;
142
143			return $this;
144			}
145
146			/**
147			* Returns wildcard match score for the provided wildcard. The score is
148			* calculated if not already done.
149			*
150			* @param ArgumentsWildcard $wildcard
151			*
152			* @return false\|int False OR integer score (higher - better)
153			*/
154			public function getScore(ArgumentsWildcard $wildcard)
155			{
156			if (isset($this->scores[$wildcard])) {
157			return $this->scores[$wildcard];
158			}
159
160			return $this->scores[$wildcard] = $wildcard->scoreArguments($this->getArguments());
			0 ignored issues – show Bug Compatibility introduced 2017-09-22 08:25 UTC by Report Bug Copy Issue Report The expression `$this->scores[$wildcard]...$this->getArguments());` of type `integer\|false\|double` adds the type `double` to the return on line 160 which is incompatible with the return type documented by `Prophecy\Call\Call::getScore` of type `false\|integer`. Loading history...
161			}
162			}
163

phpspec / prophecy

Pull Request — master (#360)

Call::addScore() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like