ManagesAttachments::addAttachment() - Code Metrics - Inspection of "Added attachments test" - testmonitor/devops-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5cc041...a53be1 )

by Thijs

created 2019-12-01 14:10 UTC

ManagesAttachments::addAttachment() A

↳ Parent: ManagesAttachments

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	23
ccs	11
cts	11
cp	1
rs	9.552
c	0
b	0
f	0
cc	1
nc	1
nop	3
crap	1

<?php

namespace TestMonitor\DevOps\Actions;

use TestMonitor\DevOps\Resources\Attachment;
use TestMonitor\DevOps\Transforms\TransformsAttachments;

trait ManagesAttachments
{
    use TransformsAttachments;

    /**
     * Add a new attachment.
     *
     * @param string $path
     * @param string $workItemId
     *
     * @param string $projectId
     * @return \TestMonitor\DevOps\Resources\Attachment
     */
    public function addAttachment(string $path, string $workItemId, string $projectId): Attachment
    {
        // First, upload the file...
        $response = $this->post(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            "{$projectId}/_apis/wit/attachments",
            [
                'headers' => ['Content-Type' => 'application/octet-stream'],
                'query' => ['fileName' => basename($path), 'api-version' => $this->apiVersion],
class MyClass { }

$x = new MyClass();
$x->foo = true;
                'body' => fopen($path, 'r'),
            ]
        );

        // ...then, attach it to the work item
        $this->patch(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            "{$projectId}/_apis/wit/workitems/{$workItemId}",
            [
                'headers' => ['Content-Type' => 'application/json-patch+json'],
                'json' => $this->toDevOpsAttachment($response['url']),
            ]
        );

        return $this->fromDevOpsAttachment($response);
    }
}


1		<?php
2
3		namespace TestMonitor\DevOps\Actions;
4
5		use TestMonitor\DevOps\Resources\Attachment;
6		use TestMonitor\DevOps\Transforms\TransformsAttachments;
7
8		trait ManagesAttachments
9		{
10		use TransformsAttachments;
11
12		/**
13		* Add a new attachment.
14		*
15		* @param string $path
16		* @param string $workItemId
17		*
18		* @param string $projectId
19		* @return \TestMonitor\DevOps\Resources\Attachment
20		*/
21	5	public function addAttachment(string $path, string $workItemId, string $projectId): Attachment
22		{
23		// First, upload the file...
24	5	$response = $this->post(
		0 ignored issues – show Bug introduced 2019-11-30 12:38 UTC by Report Bug Copy Issue Report It seems like `post()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
25	5	"{$projectId}/_apis/wit/attachments",
26		[
27	5	'headers' => ['Content-Type' => 'application/octet-stream'],
28	5	'query' => ['fileName' => basename($path), 'api-version' => $this->apiVersion],
		0 ignored issues – show Bug introduced 2019-11-30 12:38 UTC by Report Bug Copy Issue Report The property `apiVersion` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
29	5	'body' => fopen($path, 'r'),
30		]
31		);
32
33		// ...then, attach it to the work item
34	1	$this->patch(
		0 ignored issues – show Bug introduced 2019-11-30 12:38 UTC by Report Bug Copy Issue Report It seems like `patch()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
35	1	"{$projectId}/_apis/wit/workitems/{$workItemId}",
36		[
37	1	'headers' => ['Content-Type' => 'application/json-patch+json'],
38	1	'json' => $this->toDevOpsAttachment($response['url']),
39		]
40		);
41
42	1	return $this->fromDevOpsAttachment($response);
43		}
44		}
45

testmonitor / devops-client

Push — master ( 5cc041...a53be1 )

ManagesAttachments::addAttachment() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like