Morphatic\AutoDeploy\Origins\AbstractOrigin

Complexity

Total Complexity

2

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
	originated()	0	1	?
	verify()	0	1	?
	event()	0	1	?
	getRepoUrl()	0	1	?
	getCommitId()	0	1	?
A	__construct()	0	4	1
A	ipInRange()	0	7	1

<?php

namespace Morphatic\AutoDeploy\Origins;

use Illuminate\Http\Request;

abstract class AbstractOrigin implements OriginInterface
{
    /**
     * The name of the origin.
     *
     * @var string
     */
    public $name;

    /**
     * The Request object associated with this webhook.
     *
     * @var Illuminate\Http\Request
     */
    public $request;

    public function __construct(Request $request)

You have injected the Request via parameter $request. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via getCurrentRequest().

    {
        $this->request = $request;

It seems like $request of type object<Illuminate\Http\Request> is incompatible with the declared type object<Morphatic\AutoDeploy\Origins\Illuminate\Http\Request> of property $request.

    }

    /**
     * Determines whether or not the Request originated from the webhook origin.
     *
     * @param Illuminate\Http\Request $request The Request object

There is no parameter named $request. Was it maybe removed?

     *
     * @return bool Returns true if the request originated from this origin. False otherwise.
     */
    abstract public function originated();

function originated() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    /**
     * Verifies the authenticity of a webhook request from the origin.
     *
     * @param Illuminate\Http\Request $request The Request object

There is no parameter named $request. Was it maybe removed?

     *
     * @return bool Returns true if the request is authentic. False otherwise.
     */
    abstract public function verify();

function verify() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    /**
     * Gets the event the triggered the webhook request.
     *
     * @param Illuminate\Http\Request $request The Request object

There is no parameter named $request. Was it maybe removed?

     *
     * @return string The name of the event, e.g. push, release, create, etc.
     */
    abstract public function event();

    /**
     * Gets the URL to be cloned from.
     *
     * @param Illuminate\Http\Request $request The Request object

There is no parameter named $request. Was it maybe removed?

     *
     * @return string The URL of the repo.
     */
    abstract public function getRepoUrl();

    /**
     * Gets the ID of the commit that is to be cloned.
     *
     * @param Illuminate\Http\Request $request The Request object

There is no parameter named $request. Was it maybe removed?

     *
     * @return string The commit ID.
     */
    abstract public function getCommitId();

    /**
     * Determines if a target IP address is within a particular IP address range.
     *
     * @param string $target_ip The IP address to check
     * @param string $range_ip  The IP address defining the range
     * @param int    $cidr_mask The CIDR notation net mask defining the range
     *
     * @return bool True if the target IP falls within the specified range. Otherwise false.
     */
    protected function ipInRange($target_ip, $range_ip, $cidr_mask)

function ipInRange() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

$target_ip does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    {
        $target = sprintf('%032b', ip2long($target_ip));

$target_ip does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        $range = sprintf('%032b', ip2long($range_ip));

$range_ip does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

        return 0 === substr_compare($target, $range, 0, $cidr_mask);

$cidr_mask does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    }
}