Rollout::activatePercentage() - Code Metrics - Inspection of "Add feature data" - opensoft/rollout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#24)

unknown

created 2018-06-03 16:34 UTC

Rollout::activatePercentage() A

↳ Parent: Rollout

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 *
 */

namespace Opensoft\Rollout;

use Opensoft\Rollout\Storage\StorageInterface;

/**
 * @author Richard Fullmer <[email protected]>
 */
class Rollout
{
    /**
     * @var StorageInterface
     */
    private $storage;

    /**
     * @var array
     */
    private $groups;

    /**
     * @param StorageInterface $storage
     */
    public function __construct(StorageInterface $storage)
    {
        $this->storage = $storage;
        $this->groups = array(
            'all' => function(RolloutUserInterface $user) { return $user !== null; }
        );
    }

    /**
     * @param string $feature
     */
    public function activate($feature)
    {
        $feature = $this->get($feature);
        if ($feature) {
            $feature->setPercentage(100);
            $this->save($feature);
        }
    }

    /**
     * @param string $feature
     */
    public function deactivate($feature)
    {
        $feature = $this->get($feature);
        if ($feature) {
            $feature->clear();
            $this->save($feature);
        }
    }

    /**
     * @param string $feature
     * @param string $group
     */
    public function activateGroup($feature, $group)
    {
        $feature = $this->get($feature);
        if ($feature) {
            $feature->addGroup($group);
            $this->save($feature);
        }
    }

    /**
     * @param string $feature
     * @param string $group
     */
    public function deactivateGroup($feature, $group)
    {
        $feature = $this->get($feature);
        if ($feature) {
            $feature->removeGroup($group);
            $this->save($feature);
        }
    }

    /**
     * @param string $feature
     * @param RolloutUserInterface $user
     */
    public function activateUser($feature, RolloutUserInterface $user)
    {
        $feature = $this->get($feature);
        if ($feature) {
            $feature->addUser($user);
            $this->save($feature);
        }
    }

    /**
     * @param string $feature
     * @param RolloutUserInterface $user
     */
    public function deactivateUser($feature, RolloutUserInterface $user)
    {
        $feature = $this->get($feature);
        if ($feature) {
            $feature->removeUser($user);
            $this->save($feature);
        }
    }

    /**
     * @param string $group
     * @param \Closure $closure
     */
    public function defineGroup($group, \Closure $closure)
    {
        $this->groups[$group] = $closure;
    }

    /**
     * @param string $feature
     * @param RolloutUserInterface|null $user
     * @param array $requestParameters
     * @return bool
     */
    public function isActive($feature, RolloutUserInterface $user = null, array $requestParameters = array())
    {
        $feature = $this->get($feature);

        return $feature ? $feature->isActive($this, $user, $requestParameters) : false;
    }

    /**
     * @param string $feature
     * @param integer $percentage
     */
    public function activatePercentage($feature, $percentage)
    {
        $feature = $this->get($feature);
        if ($feature) {
            $feature->setPercentage($percentage);
            $this->save($feature);
        }
    }

    /**
     * @param string $feature
     */
    public function deactivatePercentage($feature)
    {
        $feature = $this->get($feature);
        if ($feature) {
            $feature->setPercentage(0);
            $this->save($feature);
        }
    }

    /**
     * @param string $feature
     * @param string $requestParam
     */
    public function activateRequestParam($feature, $requestParam)
    {
        $feature = $this->get($feature);
        if ($feature) {
            $feature->setRequestParam($requestParam);
            $this->save($feature);
        }
    }

    /**
     * @param string $feature
     */
    public function deactivateRequestParam($feature)
    {
        $feature = $this->get($feature);
        if ($feature) {
            $feature->setRequestParam('');
            $this->save($feature);
        }
    }

    /**
     * @param string $group
     * @param RolloutUserInterface|null $user
     * @return bool
     */
    public function isActiveInGroup($group, RolloutUserInterface $user = null)
    {
        if (!isset($this->groups[$group])) {
            return false;
        }

        $g = $this->groups[$group];

        return $g && $g($user);
    }

    /**
     * @param string $feature
     * @return Feature
     */
    public function get($feature)
    {
        $settings = $this->storage->get($this->key($feature));

        if (!empty($settings)) {
            $f = new Feature($feature, $settings);
        } else {
            $f = new Feature($feature);

            $this->save($f);
        }

        return $f;
    }

    /**
     * Remove a feature definition from rollout
     *
     * @param string $feature
     */
    public function remove($feature)
    {
        $this->storage->remove($this->key($feature));

        $features = $this->features();
        if (in_array($feature, $features)) {
            $features = array_diff($features, array($feature));
        }
        $this->storage->set($this->featuresKey(), implode(',', $features));
    }

    /**
     * Update feature specific data
     *
     * @example $rollout->setFeatureData('chat', array(
     *  'description'  => 'foo',
     *  'release_date' => 'bar',
     *  'whatever'     => 'baz'
     * ));
     *
     * @param string $feature
     * @param array  $data
     */
    public function setFeatureData($feature, array $data)
    {
        $feature = $this->get($feature);
        if ($feature) {
            $feature->setData(array_merge($feature->getData(), $data));
            $this->save($feature);
        }
    }

    /**
     * Clear all feature data
     *
     * @param  string $feature
     */
    public function clearFeatureData($feature)
    {
        $feature = $this->get($feature);
        if ($feature) {
            $feature->setData(array());
            $this->save($feature);
        }
    }

    /**
     * @return array
     */
    public function features()
    {
        $content = $this->storage->get($this->featuresKey());

        if (!empty($content)) {
            return explode(',', $content);
        }

        return array();
    }

    /**
     * @param string $name
     * @return string
     */
    private function key($name)
    {
        return 'feature:' . $name;
    }

    /**
     * @return string
     */
    private function featuresKey()
    {
        return 'feature:__features__';
    }

    /**
     * @param Feature $feature
     */
    protected function save(Feature $feature)
    {
        $name = $feature->getName();
        $this->storage->set($this->key($name), $feature->serialize());

        $features = $this->features();
        if (!in_array($name, $features)) {
            $features[] = $name;
        }
        $this->storage->set($this->featuresKey(), implode(',', $features));
    }
}


1			<?php
2			/**
3			*
4			*/
5
6			namespace Opensoft\Rollout;
7
8			use Opensoft\Rollout\Storage\StorageInterface;
9
10			/**
11			* @author Richard Fullmer <[email protected]>
12			*/
13			class Rollout
14			{
15			/**
16			* @var StorageInterface
17			*/
18			private $storage;
19
20			/**
21			* @var array
22			*/
23			private $groups;
24
25			/**
26			* @param StorageInterface $storage
27			*/
28			public function __construct(StorageInterface $storage)
29			{
30			$this->storage = $storage;
31			$this->groups = array(
32			'all' => function(RolloutUserInterface $user) { return $user !== null; }
33			);
34			}
35
36			/**
37			* @param string $feature
38			*/
39			public function activate($feature)
40			{
41			$feature = $this->get($feature);
42			if ($feature) {
43			$feature->setPercentage(100);
44			$this->save($feature);
45			}
46			}
47
48			/**
49			* @param string $feature
50			*/
51			public function deactivate($feature)
52			{
53			$feature = $this->get($feature);
54			if ($feature) {
55			$feature->clear();
56			$this->save($feature);
57			}
58			}
59
60			/**
61			* @param string $feature
62			* @param string $group
63			*/
64			public function activateGroup($feature, $group)
65			{
66			$feature = $this->get($feature);
67			if ($feature) {
68			$feature->addGroup($group);
69			$this->save($feature);
70			}
71			}
72
73			/**
74			* @param string $feature
75			* @param string $group
76			*/
77			public function deactivateGroup($feature, $group)
78			{
79			$feature = $this->get($feature);
80			if ($feature) {
81			$feature->removeGroup($group);
82			$this->save($feature);
83			}
84			}
85
86			/**
87			* @param string $feature
88			* @param RolloutUserInterface $user
89			*/
90			public function activateUser($feature, RolloutUserInterface $user)
91			{
92			$feature = $this->get($feature);
93			if ($feature) {
94			$feature->addUser($user);
95			$this->save($feature);
96			}
97			}
98
99			/**
100			* @param string $feature
101			* @param RolloutUserInterface $user
102			*/
103			public function deactivateUser($feature, RolloutUserInterface $user)
104			{
105			$feature = $this->get($feature);
106			if ($feature) {
107			$feature->removeUser($user);
108			$this->save($feature);
109			}
110			}
111
112			/**
113			* @param string $group
114			* @param \Closure $closure
115			*/
116			public function defineGroup($group, \Closure $closure)
117			{
118			$this->groups[$group] = $closure;
119			}
120
121			/**
122			* @param string $feature
123			* @param RolloutUserInterface\|null $user
124			* @param array $requestParameters
125			* @return bool
126			*/
127			public function isActive($feature, RolloutUserInterface $user = null, array $requestParameters = array())
128			{
129			$feature = $this->get($feature);
130
131			return $feature ? $feature->isActive($this, $user, $requestParameters) : false;
132			}
133
134			/**
135			* @param string $feature
136			* @param integer $percentage
137			*/
138			public function activatePercentage($feature, $percentage)
139			{
140			$feature = $this->get($feature);
141			if ($feature) {
142			$feature->setPercentage($percentage);
143			$this->save($feature);
144			}
145			}
146
147			/**
148			* @param string $feature
149			*/
150			public function deactivatePercentage($feature)
151			{
152			$feature = $this->get($feature);
153			if ($feature) {
154			$feature->setPercentage(0);
155			$this->save($feature);
156			}
157			}
158
159			/**
160			* @param string $feature
161			* @param string $requestParam
162			*/
163			public function activateRequestParam($feature, $requestParam)
164			{
165			$feature = $this->get($feature);
166			if ($feature) {
167			$feature->setRequestParam($requestParam);
168			$this->save($feature);
169			}
170			}
171
172			/**
173			* @param string $feature
174			*/
175			public function deactivateRequestParam($feature)
176			{
177			$feature = $this->get($feature);
178			if ($feature) {
179			$feature->setRequestParam('');
180			$this->save($feature);
181			}
182			}
183
184			/**
185			* @param string $group
186			* @param RolloutUserInterface\|null $user
187			* @return bool
188			*/
189			public function isActiveInGroup($group, RolloutUserInterface $user = null)
190			{
191			if (!isset($this->groups[$group])) {
192			return false;
193			}
194
195			$g = $this->groups[$group];
196
197			return $g && $g($user);
198			}
199
200			/**
201			* @param string $feature
202			* @return Feature
203			*/
204			public function get($feature)
205			{
206			$settings = $this->storage->get($this->key($feature));
207
208			if (!empty($settings)) {
209			$f = new Feature($feature, $settings);
210			} else {
211			$f = new Feature($feature);
212
213			$this->save($f);
214			}
215
216			return $f;
217			}
218
219			/**
220			* Remove a feature definition from rollout
221			*
222			* @param string $feature
223			*/
224			public function remove($feature)
225			{
226			$this->storage->remove($this->key($feature));
227
228			$features = $this->features();
229			if (in_array($feature, $features)) {
230			$features = array_diff($features, array($feature));
231			}
232			$this->storage->set($this->featuresKey(), implode(',', $features));
233			}
234
235			/**
236			* Update feature specific data
237			*
238			* @example $rollout->setFeatureData('chat', array(
239			* 'description' => 'foo',
240			* 'release_date' => 'bar',
241			* 'whatever' => 'baz'
242			* ));
243			*
244			* @param string $feature
245			* @param array $data
246			*/
247			public function setFeatureData($feature, array $data)
248			{
249			$feature = $this->get($feature);
250			if ($feature) {
251			$feature->setData(array_merge($feature->getData(), $data));
252			$this->save($feature);
253			}
254			}
255
256			/**
257			* Clear all feature data
258			*
259			* @param string $feature
260			*/
261			public function clearFeatureData($feature)
262			{
263			$feature = $this->get($feature);
264			if ($feature) {
265			$feature->setData(array());
266			$this->save($feature);
267			}
268			}
269
270			/**
271			* @return array
272			*/
273			public function features()
274			{
275			$content = $this->storage->get($this->featuresKey());
276
277			if (!empty($content)) {
278			return explode(',', $content);
279			}
280
281			return array();
282			}
283
284			/**
285			* @param string $name
286			* @return string
287			*/
288			private function key($name)
289			{
290			return 'feature:' . $name;
291			}
292
293			/**
294			* @return string
295			*/
296			private function featuresKey()
297			{
298			return 'feature:__features__';
299			}
300
301			/**
302			* @param Feature $feature
303			*/
304			protected function save(Feature $feature)
305			{
306			$name = $feature->getName();
307			$this->storage->set($this->key($name), $feature->serialize());
308
309			$features = $this->features();
310			if (!in_array($name, $features)) {
311			$features[] = $name;
312			}
313			$this->storage->set($this->featuresKey(), implode(',', $features));
314			}
315			}
316

opensoft / rollout

GitHub Access Token became invalid

Pull Request — master (#24)

Rollout::activatePercentage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like