Writing_On_GitHub_Fetch_Client::blob_by_path() - Code Metrics - Inspection of "Add Settings link on plugins page" - litefeel/writing-on-github - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 410349...4e2bae )

by litefeel

created 2017-08-14 06:14 UTC

Writing_On_GitHub_Fetch_Client::blob_by_path() A

↳ Parent: Writing_On_GitHub_Fetch_Client

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
eloc	5
nc	2
nop	1
dl	0
loc	8
ccs	0
cts	5
cp	0
crap	6
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Fetch API client class.
 * @package Writing_On_GitHub
 */

/**
 * Class Writing_On_GitHub_Fetch_Client
 */
class Writing_On_GitHub_Fetch_Client extends Writing_On_GitHub_Base_Client {

    /**
     * Compare a commit by sha with master from the GitHub API
     *
     * @param string $sha Sha for commit to retrieve.
     *
     * @return Writing_On_GitHub_File_Info[]|WP_Error

     */
    public function compare( $sha ) {
        // https://api.github.com/repos/litefeel/testwpsync/compare/861f87e8851b8debb78db548269d29f8da4d94ac...master
        $endpoint = $this->compare_endpoint();
        $branch = $this->branch();
        $data = $this->call( 'GET', "$endpoint/$sha...$branch" );

        if ( is_wp_error( $data ) ) {
            return $data;
        }

        $files = array();
        foreach ($data->files as $file) {

            $file->path = $file->filename;
            $files[] = new Writing_On_GitHub_File_Info($file);

        }

        return $files;
    }

    /**
     * Calls the content API to get the post's contents and metadata
     *
     * Returns Object the response from the API
     *
     * @param Writing_On_GitHub_Post $post Post to retrieve remote contents for.
     *
     * @return mixed

     */
    public function remote_contents( $post ) {
        return $this->call( 'GET', $this->content_endpoint( $post->github_path() ) );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }



    public function exists( $path ) {
        $result = $this->call( 'GET', $this->content_endpoint( $path ) );
        if ( is_wp_error( $result ) ) {

            return false;
        }
        return true;
    }

    /**
     * Retrieves a tree by sha recursively from the GitHub API
     *
     * @param string $sha Commit sha to retrieve tree from.
     *
     * @return Writing_On_GitHub_File_Info[]|WP_Error

     */
    public function tree_recursive( $sha = '_default' ) {

        if ( '_default' === $sha ) {
            $sha = $this->branch();

        }

        $data = $this->call( 'GET', $this->tree_endpoint() . '/' . $sha . '?recursive=1' );

        if ( is_wp_error( $data ) ) {
            return $data;
        }

        $files = array();

        foreach ( $data->tree as $index => $thing ) {
            // We need to remove the trees because
            // the recursive tree includes both
            // the subtrees as well the subtrees' blobs.
            if ( 'blob' === $thing->type ) {
                $thing->status = '';
                $files[] = new Writing_On_GitHub_File_Info( $thing );
            }
        }

        return $files;
    }

    /**
     * Retrieves the blob data for a given sha
     *
     * @param Writing_On_GitHub_File_Info $fileinfo
     *
     * @return Writing_On_GitHub_Blob|WP_Error

     */
    public function blob( Writing_On_GitHub_File_Info $fileinfo ) {
        $data = $this->call( 'GET', $this->blob_endpoint() . '/' . $fileinfo->sha );

        if ( is_wp_error( $data ) ) {
            return $data;
        }

        $data->path = $fileinfo->path;
        return new Writing_On_GitHub_Blob( $data );
    }

    /**
     * Get blob by path
     * @param  string $path
     * @return Writing_On_GitHub_Blob|WP_Error

     */
    public function blob_by_path( $path ) {
        $result = $this->call( 'GET', $this->content_endpoint( $path ) );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if ( is_wp_error( $result ) ) {
            return $result;
        }

        return new Writing_On_GitHub_Blob( $result );
    }
}


1		<?php
2		/**
3		* Fetch API client class.
4		* @package Writing_On_GitHub
5		*/
6
7		/**
8		* Class Writing_On_GitHub_Fetch_Client
9		*/
10		class Writing_On_GitHub_Fetch_Client extends Writing_On_GitHub_Base_Client {
11
12		/**
13		* Compare a commit by sha with master from the GitHub API
14		*
15		* @param string $sha Sha for commit to retrieve.
16		*
17		* @return Writing_On_GitHub_File_Info[]\|WP_Error
		0 ignored issues – show Documentation introduced 2017-08-10 06:19 UTC by Report Bug Copy Issue Report Should the return type not be `stdClass\|WP_Error\|array`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. If the return type contains the type array, this check recommends the use of a more specific type like `String[]` or `array<String>`. Loading history...
18		*/
19	1	public function compare( $sha ) {
20		// https://api.github.com/repos/litefeel/testwpsync/compare/861f87e8851b8debb78db548269d29f8da4d94ac...master
21	1	$endpoint = $this->compare_endpoint();
22	1	$branch = $this->branch();
23	1	$data = $this->call( 'GET', "$endpoint/$sha...$branch" );
24
25	1	if ( is_wp_error( $data ) ) {
26		return $data;
27		}
28
29	1	$files = array();
30	1	foreach ($data->files as $file) {
		0 ignored issues – show introduced 2017-08-08 13:48 UTC by Report Bug Copy Issue Report No space after opening parenthesis is prohibited Loading history... introduced 2017-08-08 13:48 UTC by Report Bug Copy Issue Report No space before closing parenthesis is prohibited Loading history...
31	1	$file->path = $file->filename;
32	1	$files[] = new Writing_On_GitHub_File_Info($file);
		0 ignored issues – show Coding Style introduced 2017-08-08 13:48 UTC by Report Bug Copy Issue Report Expected 1 spaces after opening bracket; 0 found Loading history... Coding Style introduced 2017-08-08 13:48 UTC by Report Bug Copy Issue Report Expected 1 spaces before closing bracket; 0 found Loading history...
33	1	}
34
35	1	return $files;
36		}
37
38		/**
39		* Calls the content API to get the post's contents and metadata
40		*
41		* Returns Object the response from the API
42		*
43		* @param Writing_On_GitHub_Post $post Post to retrieve remote contents for.
44		*
45		* @return mixed
		0 ignored issues – show Documentation introduced 2017-08-09 23:41 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `stdClass\|WP_Error`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
46		*/
47		public function remote_contents( $post ) {
48		return $this->call( 'GET', $this->content_endpoint( $post->github_path() ) );
		0 ignored issues – show Documentation introduced 2017-08-08 01:39 UTC by Report Bug Copy Issue Report `$post->github_path()` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
49		}
50
51
52
53		public function exists( $path ) {
54		$result = $this->call( 'GET', $this->content_endpoint( $path ) );
55		if ( is_wp_error( $result ) ) {
		0 ignored issues – show Unused Code introduced 2017-08-09 23:41 UTC by Report Bug Copy Issue Report This `if` statement, and the following `return` statement can be replaced with `return !is_wp_error($result);`. Loading history...
56		return false;
57		}
58		return true;
59		}
60
61		/**
62		* Retrieves a tree by sha recursively from the GitHub API
63		*
64		* @param string $sha Commit sha to retrieve tree from.
65		*
66		* @return Writing_On_GitHub_File_Info[]\|WP_Error
		0 ignored issues – show Documentation introduced 2017-08-10 06:19 UTC by Report Bug Copy Issue Report Should the return type not be `stdClass\|WP_Error\|array`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. If the return type contains the type array, this check recommends the use of a more specific type like `String[]` or `array<String>`. Loading history...
67		*/
68	6	public function tree_recursive( $sha = '_default' ) {
69
70	6	if ( '_default' === $sha ) {
71	6	$sha = $this->branch();
		0 ignored issues – show Coding Style introduced 2017-08-09 23:41 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$sha`. This often makes code more readable. Loading history...
72	6	}
73
74	6	$data = $this->call( 'GET', $this->tree_endpoint() . '/' . $sha . '?recursive=1' );
75
76	6	if ( is_wp_error( $data ) ) {
77	4	return $data;
78		}
79
80	2	$files = array();
81
82	2	foreach ( $data->tree as $index => $thing ) {
83		// We need to remove the trees because
84		// the recursive tree includes both
85		// the subtrees as well the subtrees' blobs.
86	2	if ( 'blob' === $thing->type ) {
87	2	$thing->status = '';
88	2	$files[] = new Writing_On_GitHub_File_Info( $thing );
89	2	}
90	2	}
91
92	2	return $files;
93		}
94
95		/**
96		* Retrieves the blob data for a given sha
97		*
98		* @param Writing_On_GitHub_File_Info $fileinfo
99		*
100		* @return Writing_On_GitHub_Blob\|WP_Error
		0 ignored issues – show Documentation introduced 2017-08-09 23:41 UTC by Report Bug Copy Issue Report Should the return type not be `stdClass\|WP_Error\|Writing_On_GitHub_Blob`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
101		*/
102	1	public function blob( Writing_On_GitHub_File_Info $fileinfo ) {
103	1	$data = $this->call( 'GET', $this->blob_endpoint() . '/' . $fileinfo->sha );
104
105	1	if ( is_wp_error( $data ) ) {
106	1	return $data;
107		}
108
109		$data->path = $fileinfo->path;
110		return new Writing_On_GitHub_Blob( $data );
111		}
112
113		/**
114		* Get blob by path
115		* @param string $path
116		* @return Writing_On_GitHub_Blob\|WP_Error
		0 ignored issues – show Documentation introduced 2017-08-14 00:56 UTC by Report Bug Copy Issue Report Should the return type not be `stdClass\|WP_Error\|Writing_On_GitHub_Blob`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
117		*/
118		public function blob_by_path( $path ) {
119		$result = $this->call( 'GET', $this->content_endpoint( $path ) );
		0 ignored issues – show Documentation introduced 2017-08-14 00:56 UTC by Report Bug Copy Issue Report `$path` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
120		if ( is_wp_error( $result ) ) {
121		return $result;
122		}
123
124		return new Writing_On_GitHub_Blob( $result );
125		}
126		}
127

litefeel / writing-on-github

Push — master ( 410349...4e2bae )

Writing_On_GitHub_Fetch_Client::blob_by_path() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like