Feature::isInActiveGroup() - Code Metrics - Inspection of "Group eligibility for anonymous users" - opensoft/rollout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#18)

by Arthur

created 2017-07-09 14:09 UTC

Feature::isInActiveGroup() A

↳ Parent: Feature

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 *
 */

namespace Opensoft\Rollout;

/**
 * @author Richard Fullmer <[email protected]>
 */
class Feature
{
    /**
     * @var string
     */
    private $name;

    /**
     * @var array
     */
    private $groups = array();

    /**
     * @var array
     */
    private $users = array();

    /**
     * @var integer
     */
    private $percentage = 0;

    /**
     * @var string|null
     */
    private $requestParam;

    /**
     * @param string $name
     * @param string|null $settings
     */
    public function __construct($name, $settings = null)
    {
        $this->name = $name;
        if ($settings) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $settings = explode('|', $settings);
            if (count($settings) == 4) {
                $rawRequestParam = array_pop($settings);
                $this->requestParam = $rawRequestParam;
            }

            list($rawPercentage, $rawUsers, $rawGroups) = $settings;
            $this->percentage = (int) $rawPercentage;
            $this->users = !empty($rawUsers) ? explode(',', $rawUsers) : array();
            $this->groups = !empty($rawGroups) ? explode(',', $rawGroups) : array();
        } else {
            $this->clear();
        }
    }

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

    /**
     * @param integer $percentage
     */
    public function setPercentage($percentage)
    {
        $this->percentage = $percentage;
    }

    /**
     * @return integer
     */
    public function getPercentage()
    {
        return $this->percentage;
    }

    /**
     * @return string
     */
    public function serialize()
    {
        return implode('|', array(
            $this->percentage,
            implode(',', $this->users),
            implode(',', $this->groups),
            $this->requestParam,
        ));
    }

    /**
     * @param RolloutUserInterface $user
     */
    public function addUser(RolloutUserInterface $user)
    {
        if (!in_array($user->getRolloutIdentifier(), $this->users)) {
            $this->users[] = $user->getRolloutIdentifier();
        }
    }

    /**
     * @param RolloutUserInterface $user
     */
    public function removeUser(RolloutUserInterface $user)
    {
        if (($key = array_search($user->getRolloutIdentifier(), $this->users)) !== false) {
            unset($this->users[$key]);
        }
    }

    /**
     * @return array
     */
    public function getUsers()
    {
        return $this->users;
    }

    /**
     * @param string $group
     */
    public function addGroup($group)
    {
        if (!in_array($group, $this->groups)) {
            $this->groups[] = $group;
        }
    }

    /**
     * @param string $group
     */
    public function removeGroup($group)
    {
        if (($key = array_search($group, $this->groups)) !== false) {
            unset($this->groups[$key]);
        }
    }

    /**
     * @return array
     */
    public function getGroups()
    {
        return $this->groups;
    }

    /**
     * @return string|null
     */
    public function getRequestParam()
    {
        return $this->requestParam;
    }

    /**
     * @param string|null $requestParam
     */
    public function setRequestParam($requestParam)
    {
        $this->requestParam = $requestParam;
    }

    /**
     * Clear the feature of all configuration
     */
    public function clear()
    {
        $this->groups = array();
        $this->users = array();
        $this->percentage = 0;
        $this->requestParam = '';
    }

    /**
     * Is the feature active?
     *
     * @param Rollout $rollout
     * @param RolloutUserInterface|null $user
     * @param array $requestParameters
     * @return bool
     */
    public function isActive(Rollout $rollout, RolloutUserInterface $user = null, array $requestParameters = array())
    {
        if (null == $user) {
            return $this->isParamInRequestParams($requestParameters)
                || $this->percentage == 100
                || $this->isInActiveGroup($rollout);
        }

        return $this->isParamInRequestParams($requestParameters) ||
            $this->isUserInPercentage($user) ||
            $this->isUserInActiveUsers($user) ||
            $this->isInActiveGroup($rollout, $user);
    }

    /**
     * @return array
     */
    public function toArray()
    {
        return array(
            'percentage' => $this->percentage,
            'groups' => $this->groups,
            'users' => $this->users,
            'requestParam' => $this->requestParam,
        );
    }

    /**
     * @param array $requestParameters
     * @return bool
     */
    private function isParamInRequestParams(array $requestParameters)
    {
        $param = explode('=', $this->requestParam);
        $key = array_shift($param);
        $value = array_shift($param);

        return $key && array_key_exists($key, $requestParameters) &&
            (empty($value) || $requestParameters[$key] == $value);
    }

    /**
     * @param RolloutUserInterface $user
     * @return bool
     */
    private function isUserInPercentage(RolloutUserInterface $user)
    {
        return abs(crc32($user->getRolloutIdentifier()) % 100) < $this->percentage;
    }

    /**
     * @param RolloutUserInterface $user
     * @return boolean
     */
    private function isUserInActiveUsers(RolloutUserInterface $user)
    {
        return in_array($user->getRolloutIdentifier(), $this->users);
    }

    /**
     * @param Rollout $rollout
     * @param RolloutUserInterface|null $user
     * @return bool
     */
    private function isInActiveGroup(Rollout $rollout, RolloutUserInterface $user = null)
    {
        foreach ($this->groups as $group) {
            if ($rollout->isActiveInGroup($group, $user)) {
                return true;
            }
        }

        return false;
    }
}


1			<?php
2			/**
3			*
4			*/
5
6			namespace Opensoft\Rollout;
7
8			/**
9			* @author Richard Fullmer <[email protected]>
10			*/
11			class Feature
12			{
13			/**
14			* @var string
15			*/
16			private $name;
17
18			/**
19			* @var array
20			*/
21			private $groups = array();
22
23			/**
24			* @var array
25			*/
26			private $users = array();
27
28			/**
29			* @var integer
30			*/
31			private $percentage = 0;
32
33			/**
34			* @var string\|null
35			*/
36			private $requestParam;
37
38			/**
39			* @param string $name
40			* @param string\|null $settings
41			*/
42			public function __construct($name, $settings = null)
43			{
44			$this->name = $name;
45			if ($settings) {
			0 ignored issues – show Bug Best Practice introduced 2016-07-26 22:50 UTC by Report Bug Copy Issue Report The expression `$settings` of type `string\|null` 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...
46			$settings = explode('\|', $settings);
47			if (count($settings) == 4) {
48			$rawRequestParam = array_pop($settings);
49			$this->requestParam = $rawRequestParam;
50			}
51
52			list($rawPercentage, $rawUsers, $rawGroups) = $settings;
53			$this->percentage = (int) $rawPercentage;
54			$this->users = !empty($rawUsers) ? explode(',', $rawUsers) : array();
55			$this->groups = !empty($rawGroups) ? explode(',', $rawGroups) : array();
56			} else {
57			$this->clear();
58			}
59			}
60
61			/**
62			* @return string
63			*/
64			public function getName()
65			{
66			return $this->name;
67			}
68
69			/**
70			* @param integer $percentage
71			*/
72			public function setPercentage($percentage)
73			{
74			$this->percentage = $percentage;
75			}
76
77			/**
78			* @return integer
79			*/
80			public function getPercentage()
81			{
82			return $this->percentage;
83			}
84
85			/**
86			* @return string
87			*/
88			public function serialize()
89			{
90			return implode('\|', array(
91			$this->percentage,
92			implode(',', $this->users),
93			implode(',', $this->groups),
94			$this->requestParam,
95			));
96			}
97
98			/**
99			* @param RolloutUserInterface $user
100			*/
101			public function addUser(RolloutUserInterface $user)
102			{
103			if (!in_array($user->getRolloutIdentifier(), $this->users)) {
104			$this->users[] = $user->getRolloutIdentifier();
105			}
106			}
107
108			/**
109			* @param RolloutUserInterface $user
110			*/
111			public function removeUser(RolloutUserInterface $user)
112			{
113			if (($key = array_search($user->getRolloutIdentifier(), $this->users)) !== false) {
114			unset($this->users[$key]);
115			}
116			}
117
118			/**
119			* @return array
120			*/
121			public function getUsers()
122			{
123			return $this->users;
124			}
125
126			/**
127			* @param string $group
128			*/
129			public function addGroup($group)
130			{
131			if (!in_array($group, $this->groups)) {
132			$this->groups[] = $group;
133			}
134			}
135
136			/**
137			* @param string $group
138			*/
139			public function removeGroup($group)
140			{
141			if (($key = array_search($group, $this->groups)) !== false) {
142			unset($this->groups[$key]);
143			}
144			}
145
146			/**
147			* @return array
148			*/
149			public function getGroups()
150			{
151			return $this->groups;
152			}
153
154			/**
155			* @return string\|null
156			*/
157			public function getRequestParam()
158			{
159			return $this->requestParam;
160			}
161
162			/**
163			* @param string\|null $requestParam
164			*/
165			public function setRequestParam($requestParam)
166			{
167			$this->requestParam = $requestParam;
168			}
169
170			/**
171			* Clear the feature of all configuration
172			*/
173			public function clear()
174			{
175			$this->groups = array();
176			$this->users = array();
177			$this->percentage = 0;
178			$this->requestParam = '';
179			}
180
181			/**
182			* Is the feature active?
183			*
184			* @param Rollout $rollout
185			* @param RolloutUserInterface\|null $user
186			* @param array $requestParameters
187			* @return bool
188			*/
189			public function isActive(Rollout $rollout, RolloutUserInterface $user = null, array $requestParameters = array())
190			{
191			if (null == $user) {
192			return $this->isParamInRequestParams($requestParameters)
193			\|\| $this->percentage == 100
194			\|\| $this->isInActiveGroup($rollout);
195			}
196
197			return $this->isParamInRequestParams($requestParameters) \|\|
198			$this->isUserInPercentage($user) \|\|
199			$this->isUserInActiveUsers($user) \|\|
200			$this->isInActiveGroup($rollout, $user);
201			}
202
203			/**
204			* @return array
205			*/
206			public function toArray()
207			{
208			return array(
209			'percentage' => $this->percentage,
210			'groups' => $this->groups,
211			'users' => $this->users,
212			'requestParam' => $this->requestParam,
213			);
214			}
215
216			/**
217			* @param array $requestParameters
218			* @return bool
219			*/
220			private function isParamInRequestParams(array $requestParameters)
221			{
222			$param = explode('=', $this->requestParam);
223			$key = array_shift($param);
224			$value = array_shift($param);
225
226			return $key && array_key_exists($key, $requestParameters) &&
227			(empty($value) \|\| $requestParameters[$key] == $value);
228			}
229
230			/**
231			* @param RolloutUserInterface $user
232			* @return bool
233			*/
234			private function isUserInPercentage(RolloutUserInterface $user)
235			{
236			return abs(crc32($user->getRolloutIdentifier()) % 100) < $this->percentage;
237			}
238
239			/**
240			* @param RolloutUserInterface $user
241			* @return boolean
242			*/
243			private function isUserInActiveUsers(RolloutUserInterface $user)
244			{
245			return in_array($user->getRolloutIdentifier(), $this->users);
246			}
247
248			/**
249			* @param Rollout $rollout
250			* @param RolloutUserInterface\|null $user
251			* @return bool
252			*/
253			private function isInActiveGroup(Rollout $rollout, RolloutUserInterface $user = null)
254			{
255			foreach ($this->groups as $group) {
256			if ($rollout->isActiveInGroup($group, $user)) {
257			return true;
258			}
259			}
260
261			return false;
262			}
263			}
264

opensoft / rollout

GitHub Access Token became invalid

Pull Request — master (#18)

Feature::isInActiveGroup() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like