RequiredPositionsFilled::isComplete() - Code Metrics - Inspection of "Update tests and add logging for debugging" - bristol-su/assign-roles - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — develop ( 50df9e...3f084e )

by Toby
created 2020-06-28 13:27 UTC
RequiredPositionsFilled::isComplete() A

↳ Parent: RequiredPositionsFilled
Complexity

Conditions	3
Paths	3
Size

Total Lines	18
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	5
CRAP Score	4.7861
Importance

Changes	2
Bugs	0	Features	0
Metric	Value
cc	3
eloc	12
c	2
b	0
f	0
nc	3
nop	3
dl	0
loc	18
ccs	5
cts	12
cp	0.4167
crap	4.7861
rs	9.8666
<?php


namespace BristolSU\Module\AssignRoles\CompletionConditions;

use BristolSU\ControlDB\Contracts\Models\Group;
use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Repositories\Position;
use BristolSU\ControlDB\Contracts\Repositories\Role as RoleRepository;
use BristolSU\Module\AssignRoles\Fields\RequiredPositions;
use BristolSU\Module\AssignRoles\Support\LogicRoleRepository;
use BristolSU\Module\AssignRoles\Support\RequiredSettingRetrieval;
use BristolSU\Module\AssignRoles\Support\SettingRetrievalException;
use BristolSU\Support\ActivityInstance\ActivityInstance;
use BristolSU\Support\Completion\Contracts\CompletionCondition;
use BristolSU\Support\Logic\Contracts\Audience\LogicAudience;
use BristolSU\Support\Logic\Contracts\LogicRepository;
use BristolSU\Support\Logic\Facade\LogicTester;
use BristolSU\Support\ModuleInstance\Contracts\ModuleInstance;
use FormSchema\Generator\Field;
use FormSchema\Schema\Form;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Log;

class RequiredPositionsFilled extends CompletionCondition

{

    /**

     * @var RoleRepository
     */
    private $roleRepository;


    public function __construct(string $moduleAlias, RoleRepository $roleRepository)

    {
        parent::__construct($moduleAlias);
        $this->roleRepository = $roleRepository;
    }

    /**

     * @inheritDoc
     */

    public function isComplete($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance): bool
    {
        try {
            Log::info('--- TESTING ---');
            $remainingPositions = $this->positionsStillToFill($settings, $activityInstance, $moduleInstance);
        } catch (SettingRetrievalException $e) {
            Log::debug(
              sprintf(

                'Setting could not be found for activity instance %d and module instance %d',

                $activityInstance->id,

                $moduleInstance->id()

              )

            );
            return false;
        }
       
        Log::info('Result is ' . (count($remainingPositions) === 0 ? 'true' : 'false'));
       return count($remainingPositions) === 0;

    }
    
    public function percentage($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance): int

    {
        $group = $this->getGroup($activityInstance);

        try {
            $requiredPositions = $this->getRequiredPositions($settings, $group);
            $remainingPositions = $this->positionsStillToFill($settings, $activityInstance, $moduleInstance);
        } catch (SettingRetrievalException $e) {
            return false;

        }
        
        if(count($requiredPositions) === 0) {

            return 100;
        }
        
        $filled = count($requiredPositions) - count($remainingPositions);
        
        $percentage = (int) round(($filled/count($requiredPositions)) * 100, 0);

        if($percentage > 100) {

            return 100;
        }
        return $percentage;
    }

    protected function positionsStillToFill($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance)

    {
        $group = $this->getGroup($activityInstance);
        Log::info('Using group ' . $group->id());
        $roles = $this->rolesThroughGroup($group, $moduleInstance)->filter(function(Role $role) {

            return $role->users()->count() > 0;
        });
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
        
        Log::info('Roles to be used: ' . json_encode($roles->map(function($role) {

            return $role->id();
          })));
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
        
        Log::info('Required positions ' . (string) collect($this->getRequiredPositions($settings, $group)));
        return collect($this->getRequiredPositions($settings, $group))->filter(function(int $positionId) use ($roles) {

            return $roles->filter(function(Role $role) use ($positionId) {

                return $role->positionId() === $positionId;
            })->count() === 0;
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
        });
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
    }
    
    /**

     * @inheritDoc
     */

    public function options(): Form
    {
        return \FormSchema\Generator\Form::make()->withField(
            Field::make(RequiredPositions::class, 'required')
                ->label('Required Positions')->featured(true)->required(true)
                ->default([])->hint('Define which positions are required')
                ->help('Define the positions that are required for any given logic group')
                ->logic($this->getLogic())
                ->positions($this->getPositions())
        )->getSchema();
    }

    /**

     * @inheritDoc
     */

    public function name(): string
    {
        return 'Required Positions are filled';
    }

    /**

     * @inheritDoc
     */

    public function description(): string
    {
        return 'Positions that are marked as required for a group have been filled';
    }

    /**

     * @inheritDoc
     */

    public function alias(): string
    {
        return 'required_positions_are_filled';
    }

    private function getLogic()

    {
        try {
            return collect(app(LogicRepository::class)->all());
        } catch (\Exception $e) {
            return collect();
        }
    }

    private function getPositions()

    {
        try {
            return collect(app(Position::class)->all());
        } catch (\Exception $e) {
            return collect();
        }
    }

    /**
     * Get the group from an activity instance
     * 
     * @param ActivityInstance $activityInstance

     * @return Group|\BristolSU\ControlDB\Models\Group

     */
    private function getGroup(ActivityInstance $activityInstance)

    {
        if($activityInstance->resource_type === 'group') {

            return $activityInstance->participant();

        }
        return $activityInstance->participant()->group();

    }

    private function getRequiredPositions(array $settings, Group $group)

    {
        return app(RequiredSettingRetrieval::class)->getSettings($group, $settings);
    }

    private function rolesThroughGroup(Group $group, ModuleInstance $moduleInstance)

    {
        $roles = $group->roles();
        Log::info('Roles through group pre logic filtering: ' . json_encode($roles->map(function($role) {

              return $role->id();
          })));
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
        if($this->logicGroupId($moduleInstance) !== null) {

            $logicGroup = app(LogicRepository::class)->getById($this->logicGroupId($moduleInstance));
            $logicGroup = app(LogicRepository::class)->getById(/** @scrutinizer ignore-type */ $this->logicGroupId($moduleInstance));
            return $roles->filter(function(\BristolSU\ControlDB\Contracts\Models\Role $role) use ($moduleInstance, $logicGroup) {

                return LogicTester::evaluate($logicGroup, null, $role->group(), $role);
            })->values();
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
        }

        Log::info('Roles through group post logic filtering: ' . json_encode($roles->map(function($role) {

              return $role->id();
          })));
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
        
        return $roles;
    }

    private function logicGroupId(ModuleInstance $moduleInstance)

    {
        $id = $moduleInstance->setting('logic_group', null);
        if($id === null) {

            return null;
        }
        return (int) $id;
    }
    
}
bristol-su / assign-roles

GitHub Access Token became invalid

Push — develop ( 50df9e...3f084e )

RequiredPositionsFilled::isComplete() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
