QueerCodingGirl\Rollout\RolloutAbstract

Complexity

Total Complexity

22

Size/Duplication

Total Lines	229
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	getFeature()	0	9	2
A	getFeatures()	0	6	1
A	saveFeature()	0	9	2
A	getKey()	0	4	1
A	getFeaturesKey()	0	4	1
A	activate()	0	6	1
A	deactivate()	0	6	1
A	activateRole()	0	6	1
A	deactivateRole()	0	6	1
A	activateGroup()	0	6	1
A	deactivateGroup()	0	6	1
A	activateUser()	0	6	1
A	deactivateUser()	0	6	1
A	activatePercentage()	0	6	1
A	deactivatePercentage()	0	6	1
A	isActive()	0	5	1
A	userHasRole()	0	8	2
A	userHasGroup()	0	8	2

<?php

namespace QueerCodingGirl\Rollout;


use QueerCodingGirl\Rollout\Feature\FeatureFactoryAbstract;
use QueerCodingGirl\Rollout\Interfaces\DeterminableUserInterface;
use QueerCodingGirl\Rollout\Interfaces\KeyValueStorageInterface;
use QueerCodingGirl\Rollout\Interfaces\RolloutableInterface;

/**
 * Class RolloutAbstract
 * @package QueerCodingGirl\Rollout
 */
abstract class RolloutAbstract
{
    /**
     * @var KeyValueStorageInterface
     */
    protected $storage;

    /**
     * @var FeatureFactoryAbstract
     */
    protected $featureFactory;

    /**
     * @param string $featureName
     * @return RolloutableInterface
     */
    public function getFeature($featureName)
    {
        $featureConfigString = $this->storage->get($this->getKey($featureName));
        $feature = $this->featureFactory->getFeature($featureName);
        if (false === empty($featureConfigString)) {
            $feature->configureByConfigString($featureConfigString);
        }
        return $feature;
    }

    /**
     * Get all feature names
     * @return string[]
     */
    public function getFeatures()
    {
        $featuresString = $this->storage->get($this->getFeaturesKey());
        $features = explode(',', $featuresString);
        return $features;
    }

    /**
     * Saves a feature to the storage
     * @param RolloutableInterface $feature
     */
    protected function saveFeature(RolloutableInterface $feature)
    {
        $this->storage->set($this->getKey($feature->getName()), (string)$feature);
        $features = $this->getFeatures();
        if (false === in_array($feature->getName(), $features)) {
            $features[] = $feature->getName();
        }
        $this->storage->set($this->getFeaturesKey(), implode(',', $features));
    }

    /**
     * Get the storage key for a feature name
     * @param string $featureName
     * @return string
     */
    protected function getKey($featureName)
    {
        return 'feature:' . $featureName;
    }

    /**
     * Get the storage key for all features (the feature list)
     * @return string
     */
    protected function getFeaturesKey()
    {
        return 'feature:__features__';
    }

    /**
     * Activates a feature (for everyone)
     * @param string $featureName
     */
    public function activate($featureName)
    {
        $feature = $this->getFeature($featureName);
        $feature->setPercentage(100);
        $this->saveFeature($feature);
    }

    /**
     * Deactivates a feature (for everyone)
     * @param string $featureName
     */
    public function deactivate($featureName)
    {
        $feature = $this->getFeature($featureName);
        $feature->clearConfig();
        $this->saveFeature($feature);
    }

    /**
     * Activates a feature for a specific role
     * @param string $featureName
     * @param string $roleName
     */
    public function activateRole($featureName, $roleName)
    {
        $feature = $this->getFeature($featureName);
        $feature->addRole($roleName);
        $this->saveFeature($feature);
    }

    /**
     * Deactivates a feature for a specific role.
     * @param string $featureName
     * @param string $roleName
     */
    public function deactivateRole($featureName, $roleName)
    {
        $feature = $this->getFeature($featureName);
        $feature->removeRole($roleName);
        $this->saveFeature($feature);
    }

    /**
     * Activates a feature for a specific group
     * @param string $featureName
     * @param string $groupName
     */
    public function activateGroup($featureName, $groupName)
    {
        $feature = $this->getFeature($featureName);
        $feature->addGroup($groupName);
        $this->saveFeature($feature);
    }

    /**
     * Deactivates a feature for a specific group.
     * @param string $featureName
     * @param string $groupName
     */
    public function deactivateGroup($featureName, $groupName)
    {
        $feature = $this->getFeature($featureName);
        $feature->removeGroup($groupName);
        $this->saveFeature($feature);
    }

    /**
     * Activates a feature for a specific user
     * @param string $featureName
     * @param integer $userId
     */
    public function activateUser($featureName, $userId)
    {
        $feature = $this->getFeature($featureName);
        $feature->addUser($userId);
        $this->saveFeature($feature);
    }

    /**
     * Deactivates a feature for a specific user
     * @param string $featureName
     * @param integer $userId
     */
    public function deactivateUser($featureName, $userId)
    {
        $feature = $this->getFeature($featureName);
        $feature->removeUser($userId);
        $this->saveFeature($feature);
    }

    /**
     * Activates a feature for a percentage of users
     * @param string $featureName
     * @param integer $percentage
     */
    public function activatePercentage($featureName, $percentage)
    {
        $feature = $this->getFeature($featureName);
        $feature->setPercentage($percentage);
        $this->saveFeature($feature);
    }

    /**
     * Deactivates the percentage activation for a feature
     * @param string $featureName
     */
    public function deactivatePercentage($featureName)
    {
        $feature = $this->getFeature($featureName);
        $feature->setPercentage(0);
        $this->saveFeature($feature);
    }

    /**
     * Checks if a feature is active
     * @param string $featureName
     * @param DeterminableUserInterface $user
     * @return bool
     */
    public function isActive($featureName, DeterminableUserInterface $user = null)
    {
        $feature = $this->getFeature($featureName);
        return $feature->isActive($this, $user);
    }

    /**
     * Checks if a user has the given role
     * @param string $roleName
     * @param DeterminableUserInterface $user
     * @return bool
     */
    public function userHasRole($roleName, DeterminableUserInterface $user)
    {
        $userHasRole = false;
        if (true === in_array($roleName, $user->getRoles())) {
            $userHasRole = true;
        }
        return $userHasRole;
    }

    /**
     * Checks if a user has the given group
     * @param string $groupName
     * @param DeterminableUserInterface $user
     * @return bool
     */
    public function userHasGroup($groupName, DeterminableUserInterface $user)
    {
        $userHasGroup = false;
        if (true === in_array($groupName, $user->getGroups())) {
            $userHasGroup = true;
        }
        return $userHasGroup;
    }
}