Experiment::shouldRun() - Code Metrics - Inspection of "Remove the ability to have a null lab" - daylerees/scientist - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4)

by Steve

created 2016-02-07 07:42 UTC

Experiment::shouldRun() A

↳ Parent: Experiment

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Scientist;

use Scientist\Matchers\Matcher;
use Scientist\Matchers\StandardMatcher;

/**
 * Class Experiment
 *
 * An experiment allows us to implement our code in a new way without
 * risking the introduction of bugs or regressions.
 *
 * @package Scientist
 */
class Experiment
{
    /**
     * Experiment name.
     *
     * @var string
     */
    protected $name;

    /**
     * The control callback.
     *
     * @var callable
     */
    protected $control;

    /**
     * Trial callbacks.
     *
     * @var array
     */
    protected $trials = [];

    /**
     * Parameters for our callbacks.
     *
     * @var array
     */
    protected $params = [];

    /**
     * Laboratory instance.
     *
     * @var \Scientist\Laboratory
     */
    protected $laboratory;

    /**
     * Matcher for experiment values.
     *
     * @var \Scientist\Matchers\Matcher
     */
    protected $matcher;

    /**
     * Execution chance.
     *
     * @var integer
     */
    protected $chance = 100;

    /**
     * Create a new experiment.
     *
     * @param string                $name
     * @param \Scientist\Laboratory $laboratory
     */
    public function __construct($name, Laboratory $laboratory)
    {
        $this->name = $name;
        $this->laboratory = $laboratory;
        $this->matcher = new StandardMatcher;
    }

    /**
     * Fetch the experiment name.
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Retrieve the laboratory instance.
     *
     * @return \Scientist\Laboratory|null
     */
    public function getLaboratory()
    {
        return $this->laboratory;
    }

    /**
     * Register a control callback.
     *
     * @param callable $callback
     *
     * @return $this
     */
    public function control(callable $callback)
    {
        $this->control = $callback;

        return $this;
    }

    /**
     * Fetch the control callback.
     *
     * @return callable
     */
    public function getControl()
    {
        return $this->control;
    }

    /**
     * Register a trial callback.
     *
     * @param string   $name
     * @param callable $callback
     *
     * @return $this
     */
    public function trial($name, callable $callback)
    {
        $this->trials[$name] = $callback;

        return $this;
    }

    /**
     * Fetch a trial callback by name.
     *
     * @param string $name
     *
     * @return mixed
     */
    public function getTrial($name)
    {
        return $this->trials[$name];
    }

    /**
     * Fetch an array of trial callbacks.
     *
     * @return array
     */
    public function getTrials()
    {
        return $this->trials;
    }

    /**
     * Set a matcher for this experiment.
     *
     * @param \Scientist\Matchers\Matcher $matcher
     *
     * @return $this
     */
    public function matcher(Matcher $matcher)
    {
        $this->matcher = $matcher;

        return $this;
    }

    /**
     * Get the matcher for this experiment.
     *
     * @return \Scientist\Matchers\Matcher
     */
    public function getMatcher()
    {
        return $this->matcher;
    }

    /**
     * Set the execution chance.
     *
     * @param integer $chance
     *
     * @return $this
     */
    public function chance($chance)
    {
        $this->chance = (int) $chance;

        return $this;
    }

    /**
     * Get the execution chance.
     *
     * @return integer
     */
    public function getChance()
    {
        return $this->chance;
    }

    /**
     * Determine whether an experiment should run based on chance.
     *
     * @return boolean
     */
    public function shouldRun()
    {
        return rand(0, 100) <= $this->chance;
    }

    /**
     * Get the experiment parameters.
     *
     * @return array
     */
    public function getParams()
    {
        return $this->params;
    }

    /**
     * Execute the experiment within the laboratory.
     *
     * @return mixed
     */
    public function run()
    {
        $this->params = func_get_args();

        return $this->laboratory->runExperiment($this);
    }

    /**
     * Execute the experiment and return a report.
     *
     * @return \Scientist\Report
     */
    public function report()
    {
        $this->params = func_get_args();

        return $this->laboratory->getReport($this);
    }
}


1		<?php
2
3		namespace Scientist;
4
5		use Scientist\Matchers\Matcher;
6		use Scientist\Matchers\StandardMatcher;
7
8		/**
9		* Class Experiment
10		*
11		* An experiment allows us to implement our code in a new way without
12		* risking the introduction of bugs or regressions.
13		*
14		* @package Scientist
15		*/
16		class Experiment
17		{
18		/**
19		* Experiment name.
20		*
21		* @var string
22		*/
23		protected $name;
24
25		/**
26		* The control callback.
27		*
28		* @var callable
29		*/
30		protected $control;
31
32		/**
33		* Trial callbacks.
34		*
35		* @var array
36		*/
37		protected $trials = [];
38
39		/**
40		* Parameters for our callbacks.
41		*
42		* @var array
43		*/
44		protected $params = [];
45
46		/**
47		* Laboratory instance.
48		*
49		* @var \Scientist\Laboratory
50		*/
51		protected $laboratory;
52
53		/**
54		* Matcher for experiment values.
55		*
56		* @var \Scientist\Matchers\Matcher
57		*/
58		protected $matcher;
59
60		/**
61		* Execution chance.
62		*
63		* @var integer
64		*/
65		protected $chance = 100;
66
67		/**
68		* Create a new experiment.
69		*
70		* @param string $name
71		* @param \Scientist\Laboratory $laboratory
72		*/
73	21	public function __construct($name, Laboratory $laboratory)
74		{
75	21	$this->name = $name;
76	21	$this->laboratory = $laboratory;
77	21	$this->matcher = new StandardMatcher;
78	21	}
79
80		/**
81		* Fetch the experiment name.
82		*
83		* @return string
84		*/
85	12	public function getName()
86		{
87	12	return $this->name;
88		}
89
90		/**
91		* Retrieve the laboratory instance.
92		*
93		* @return \Scientist\Laboratory\|null
94		*/
95	1	public function getLaboratory()
96		{
97	1	return $this->laboratory;
98		}
99
100		/**
101		* Register a control callback.
102		*
103		* @param callable $callback
104		*
105		* @return $this
106		*/
107	14	public function control(callable $callback)
108		{
109	14	$this->control = $callback;
110
111	14	return $this;
112		}
113
114		/**
115		* Fetch the control callback.
116		*
117		* @return callable
118		*/
119	14	public function getControl()
120		{
121	14	return $this->control;
122		}
123
124		/**
125		* Register a trial callback.
126		*
127		* @param string $name
128		* @param callable $callback
129		*
130		* @return $this
131		*/
132	12	public function trial($name, callable $callback)
133		{
134	12	$this->trials[$name] = $callback;
135
136	12	return $this;
137		}
138
139		/**
140		* Fetch a trial callback by name.
141		*
142		* @param string $name
143		*
144		* @return mixed
145		*/
146	2	public function getTrial($name)
147		{
148	2	return $this->trials[$name];
149		}
150
151		/**
152		* Fetch an array of trial callbacks.
153		*
154		* @return array
155		*/
156	12	public function getTrials()
157		{
158	12	return $this->trials;
159		}
160
161		/**
162		* Set a matcher for this experiment.
163		*
164		* @param \Scientist\Matchers\Matcher $matcher
165		*
166		* @return $this
167		*/
168	1	public function matcher(Matcher $matcher)
169		{
170	1	$this->matcher = $matcher;
171
172	1	return $this;
173		}
174
175		/**
176		* Get the matcher for this experiment.
177		*
178		* @return \Scientist\Matchers\Matcher
179		*/
180	12	public function getMatcher()
181		{
182	12	return $this->matcher;
183		}
184
185		/**
186		* Set the execution chance.
187		*
188		* @param integer $chance
189		*
190		* @return $this
191		*/
192	2	public function chance($chance)
193		{
194	2	$this->chance = (int) $chance;
195
196	2	return $this;
197		}
198
199		/**
200		* Get the execution chance.
201		*
202		* @return integer
203		*/
204	1	public function getChance()
205		{
206	1	return $this->chance;
207		}
208
209		/**
210		* Determine whether an experiment should run based on chance.
211		*
212		* @return boolean
213		*/
214	6	public function shouldRun()
215		{
216	6	return rand(0, 100) <= $this->chance;
217		}
218
219		/**
220		* Get the experiment parameters.
221		*
222		* @return array
223		*/
224	13	public function getParams()
225		{
226	13	return $this->params;
227		}
228
229		/**
230		* Execute the experiment within the laboratory.
231		*
232		* @return mixed
233		*/
234	6	public function run()
235		{
236	6	$this->params = func_get_args();
237
238	6	return $this->laboratory->runExperiment($this);
239		}
240
241		/**
242		* Execute the experiment and return a report.
243		*
244		* @return \Scientist\Report
245		*/
246	3	public function report()
247		{
248	3	$this->params = func_get_args();
249
250	3	return $this->laboratory->getReport($this);
251		}
252		}
253

daylerees / scientist

Pull Request — master (#4)

Experiment::shouldRun() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like