Data - Code Metrics - Inspection of "Code cleanup (WIP)" - seblucas/cops - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#274)

by Markus

created 2016-07-03 22:39 UTC

Data B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	200
Duplicated Lines	7 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

93.75%

Importance

Changes	5
Bugs	2	Features	1

Metric	Value
dl	14
loc	200
ccs	90
cts	96
cp	0.9375
rs	8.2857
c	5
b	2
f	1
wmc	39
lcom	1
cbo	2

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	isKnownType()	0	3	1
A	getMimeType()	0	17	4
A	isEpubValidOnKobo()	0	3	2
A	getFilename()	0	3	1
A	getUpdatedFilename()	0	3	1
A	getUpdatedFilenameEpub()	0	3	1
A	getUpdatedFilenameKepub()	0	5	1
A	getDataLink()	0	9	3
A	getHtmlLink()	0	3	1
A	getLocalPath()	0	3	1
C	getHtmlLinkWithRewriting()	1	17	5
A	getDataByBook()	12	12	2
A	handleThumbnailLink()	0	18	4
D	getLink()	1	29	11

How to fix Duplicated Code

<?php
/**
 * COPS (Calibre OPDS PHP Server) class file
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Sébastien Lucas <[email protected]>
 */

class Data extends Base
namespace YourVendor;

class YourClass { }
{
    public $id;
    public $name;
    public $format;
    public $realFormat;
    public $extension;
    public $book;

    public static $mimetypes = array(
        'aac'   => 'audio/aac',
        'azw'   => 'application/x-mobipocket-ebook',
        'azw1'  => 'application/x-topaz-ebook',
        'azw2'  => 'application/x-kindle-application',
        'azw3'  => 'application/x-mobi8-ebook',
        'cbz'   => 'application/x-cbz',
        'cbr'   => 'application/x-cbr',
        'djv'   => 'image/vnd.djvu',
        'djvu'  => 'image/vnd.djvu',
        'doc'   => 'application/msword',
        'epub'  => 'application/epub+zip',
        'fb2'   => 'text/fb2+xml',
        'ibooks'=> 'application/x-ibooks+zip',
        'kepub' => 'application/epub+zip',
        'kobo'  => 'application/x-koboreader-ebook',
        'm4a'   => 'audio/mp4',
        'mobi'  => 'application/x-mobipocket-ebook',
        'mp3'   => 'audio/mpeg',
        'lit'   => 'application/x-ms-reader',
        'lrs'   => 'text/x-sony-bbeb+xml',
        'lrf'   => 'application/x-sony-bbeb',
        'lrx'   => 'application/x-sony-bbeb',
        'ncx'   => 'application/x-dtbncx+xml',
        'opf'   => 'application/oebps-package+xml',
        'otf'   => 'application/x-font-opentype',
        'pdb'   => 'application/vnd.palm',
        'pdf'   => 'application/pdf',
        'prc'   => 'application/x-mobipocket-ebook',
        'rtf'   => 'application/rtf',
        'svg'   => 'image/svg+xml',
        'ttf'   => 'application/x-font-truetype',
        'tpz'   => 'application/x-topaz-ebook',
        'wav'   => 'audio/wav',
        'wmf'   => 'image/wmf',
        'xhtml' => 'application/xhtml+xml',
        'xpgt'  => 'application/adobe-page-template+xml',
        'zip'   => 'application/zip'
    );

    public function __construct($post, $book = null) {
        $this->id = $post->id;
        $this->name = $post->name;
        $this->format = $post->format;
        $this->realFormat = str_replace ("ORIGINAL_", "", $post->format);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        $this->extension = strtolower ($this->realFormat);
        $this->book = $book;
    }

    public function isKnownType () {
        return array_key_exists ($this->extension, self::$mimetypes);
    }

    public function getMimeType () {
        $result = "application/octet-stream";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        if ($this->isKnownType ()) {
            return self::$mimetypes [$this->extension];
        } elseif (function_exists('finfo_open') === true) {
            $finfo = finfo_open(FILEINFO_MIME_TYPE);

            if (is_resource($finfo) === true)
            {
                $result = finfo_file($finfo, $this->getLocalPath ());
            }

            finfo_close($finfo);

        }
        return $result;
    }

    public function isEpubValidOnKobo () {
        return $this->format == "EPUB" || $this->format == "KEPUB";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }

    public function getFilename () {
        return $this->name . "." . strtolower ($this->format);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }

    public function getUpdatedFilename () {
        return $this->book->getAuthorsSort () . " - " . $this->book->title;
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }

    public function getUpdatedFilenameEpub () {
        return $this->getUpdatedFilename () . ".epub";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }

    public function getUpdatedFilenameKepub () {
        $str = $this->getUpdatedFilename () . ".kepub.epub";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        return str_replace(array(':', '#', '&'),
                           array('-', '-', ' '), $str );
    }

    public function getDataLink ($rel, $title = NULL) {
        global $config;
function myFunction($a, $b) {
    // Do something
}

        if ($rel == Link::OPDS_ACQUISITION_TYPE && $config['cops_use_url_rewriting'] == "1") {
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            return $this->getHtmlLinkWithRewriting($title);
        }

        return self::getLink ($this->book, $this->extension, $this->getMimeType (), $rel, $this->getFilename (), $this->id, $title);
    }

    public function getHtmlLink () {
        return $this->getDataLink(Link::OPDS_ACQUISITION_TYPE)->href;
    }

    public function getLocalPath () {
        return $this->book->path . "/" . $this->getFilename ();
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
    }

    public function getHtmlLinkWithRewriting ($title = NULL) {
        global $config;
function myFunction($a, $b) {
    // Do something
}

        $database = "";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        if (!is_null (GetUrlParam (DB))) $database = GetUrlParam (DB) . "/";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

        $href = "download/" . $this->id . "/" . $database;
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

        if ($config['cops_provide_kepub'] == "1" &&
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            $this->isEpubValidOnKobo () &&
            preg_match("/Kobo/", $_SERVER['HTTP_USER_AGENT'])) {
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            $href .= rawurlencode ($this->getUpdatedFilenameKepub ());
        } else {
            $href .= rawurlencode ($this->getFilename ());
        }
        return new Link ($href, $this->getMimeType (), Link::OPDS_ACQUISITION_TYPE, $title);
    }

    public static function getDataByBook ($book) {

        $out = array ();
        $result = parent::getDb ()->prepare('select id, format, name
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
                                             from data where book = ?');
        $result->execute (array ($book->id));

        while ($post = $result->fetchObject ())
        {
            array_push ($out, new Data ($post, $book));
        }
        return $out;
    }

    public static function handleThumbnailLink ($urlParam, $height) {
        global $config;
function myFunction($a, $b) {
    // Do something
}

        if (is_null ($height)) {
            if (preg_match ('/feed.php/', $_SERVER["SCRIPT_NAME"])) {
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
                $height = $config['cops_opds_thumbnail_height'];
            }
            else
            {
                $height = $config['cops_html_thumbnail_height'];
            }
        }
        if ($config['cops_thumbnail_handling'] != "1") {
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            $urlParam = addURLParameter($urlParam, "height", $height);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        }

        return $urlParam;
    }

    public static function getLink ($book, $type, $mime, $rel, $filename, $idData, $title = NULL, $height = NULL)
    {
        global $config;
function myFunction($a, $b) {
    // Do something
}

        $urlParam = addURLParameter("", "data", $idData);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;

        if (Base::useAbsolutePath () ||
            $rel == Link::OPDS_THUMBNAIL_TYPE ||
            ($type == "epub" && $config['cops_update_epub-metadata']))
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        {
            if ($type != "jpg") $urlParam = addURLParameter($urlParam, "type", $type);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            if ($rel == Link::OPDS_THUMBNAIL_TYPE) {
                $urlParam = self::handleThumbnailLink($urlParam, $height);
            }
            $urlParam = addURLParameter($urlParam, "id", $book->id);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            if (!is_null (GetUrlParam (DB))) $urlParam = addURLParameter ($urlParam, DB, GetUrlParam (DB));

            if ($config['cops_thumbnail_handling'] != "1" &&
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
                !empty ($config['cops_thumbnail_handling']) &&
                $rel == Link::OPDS_THUMBNAIL_TYPE) {
                return new Link ($config['cops_thumbnail_handling'], $mime, $rel, $title);
            } else {
                return new Link ("fetch.php?" . $urlParam, $mime, $rel, $title);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            }
        }
        else
        {
            return new Link (str_replace('%2F','/',rawurlencode ($book->path."/".$filename)), $mime, $rel, $title);
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
        }
    }
}


Pull Request — master (#274)

Data B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

15 Methods

How to fix Duplicated Code

Duplicated Code

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
2			/**
3			* COPS (Calibre OPDS PHP Server) class file
4			*
5			* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
6			* @author Sébastien Lucas <[email protected]>
7			*/
8
9			class Data extends Base
			0 ignored issues – show Coding Style Compatibility introduced 2016-06-30 15:05 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
10			{
11			public $id;
12			public $name;
13			public $format;
14			public $realFormat;
15			public $extension;
16			public $book;
17
18			public static $mimetypes = array(
19			'aac' => 'audio/aac',
20			'azw' => 'application/x-mobipocket-ebook',
21			'azw1' => 'application/x-topaz-ebook',
22			'azw2' => 'application/x-kindle-application',
23			'azw3' => 'application/x-mobi8-ebook',
24			'cbz' => 'application/x-cbz',
25			'cbr' => 'application/x-cbr',
26			'djv' => 'image/vnd.djvu',
27			'djvu' => 'image/vnd.djvu',
28			'doc' => 'application/msword',
29			'epub' => 'application/epub+zip',
30			'fb2' => 'text/fb2+xml',
31			'ibooks'=> 'application/x-ibooks+zip',
32			'kepub' => 'application/epub+zip',
33			'kobo' => 'application/x-koboreader-ebook',
34			'm4a' => 'audio/mp4',
35			'mobi' => 'application/x-mobipocket-ebook',
36			'mp3' => 'audio/mpeg',
37			'lit' => 'application/x-ms-reader',
38			'lrs' => 'text/x-sony-bbeb+xml',
39			'lrf' => 'application/x-sony-bbeb',

seblucas / cops

Pull Request — master (#274)

Data B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

15 Methods

How to fix Duplicated Code

Duplicated Code

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like