MongoGridFS - Code Metrics - Inspection of "[WIP] Implement MongoGridFS" - alcaeus/mongo-php-adapter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#15)

unknown

created 2016-01-04 10:55 UTC

MongoGridFS B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	325
Duplicated Lines	10.77 %

Coupling/Cohesion

Components	2
Dependencies	7

Metric	Value
wmc	46
lcom	2
cbo	7
dl	35
loc	325
rs	8.4

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	17	3
A	drop()	0	5	1
A	find()	7	7	1
C	storeFile()	0	22	7
A	insertChunksFromFile()	14	14	2
A	calculateMD5()	0	7	1
A	storeBytes()	0	13	3
A	insertFile()	0	7	1
A	insertChunksFromBytes()	14	14	2
A	insertChunk()	0	9	1
A	findOne()	0	8	2
A	remove()	0	10	2
A	delete()	0	11	3
A	storeUpload()	0	8	3
A	__get()	0	10	3
A	put()	0	4	1
A	ensureIndexes()	0	9	2
B	ensureChunksIndex()	0	9	5
A	ensureFilesIndex()	0	9	3

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like MongoGridFS often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use MongoGridFS, and based on these observations, apply Extract Interface, too.

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

class MongoGridFS extends MongoCollection {
namespace YourVendor;

class YourClass { }
    const DEFAULT_CHUNK_SIZE = 262144; // 256 kb

    const ASCENDING = 1;
    const DESCENDING = -1;

    /**
     * @link http://php.net/manual/en/class.mongogridfs.php#mongogridfs.props.chunks
     * @var $chunks MongoCollection
     */
    public $chunks;

    /**
     * @link http://php.net/manual/en/class.mongogridfs.php#mongogridfs.props.filesname
     * @var $filesName string
     */
    protected $filesName;

    /**
     * @link http://php.net/manual/en/class.mongogridfs.php#mongogridfs.props.chunksname
     * @var $chunksName string
     */
    protected $chunksName;

    /**
     * @var MongoDB
     */
    protected $database;

    protected $ensureIndexes = false;


    /**
     * Files as stored across two collections, the first containing file meta
     * information, the second containing chunks of the actual file. By default,
     * fs.files and fs.chunks are the collection names used.
     *
     * @link http://php.net/manual/en/mongogridfs.construct.php
     * @param MongoDB $db Database
     * @param string $prefix [optional] <p>Optional collection name prefix.</p>
     * @param mixed $chunks  [optional]
     * @return MongoGridFS

     */
    public function __construct(MongoDB $db, $prefix = "fs", $chunks = null)
    {
        if ($chunks) {
            trigger_error(E_DEPRECATED, "The 'chunks' argument is deprecated and ignored");
        }
        if (empty($prefix)) {
            throw new \InvalidArgumentException('prefix can not be empty');
        }

        $this->database = $db;
        $this->filesName = $prefix . '.files';
        $this->chunksName = $prefix . '.chunks';

        $this->chunks = $db->selectCollection($this->chunksName);

        parent::__construct($db, $this->filesName);
    }

    /**
     * Drops the files and chunks collections
     * @link http://php.net/manual/en/mongogridfs.drop.php
     * @return array The database response
     */
    public function drop()
    {
        $this->chunks->drop();
        parent::drop();
    }

    /**
     * @link http://php.net/manual/en/mongogridfs.find.php
     * @param array $query The query
     * @param array $fields Fields to return
     * @return MongoGridFSCursor A MongoGridFSCursor
     */
    public function find(array $query = array(), array $fields = array())

    {
        $cursor = new MongoGridFSCursor($this, $this->db->getConnection(), (string)$this, $query, $fields);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $cursor->setReadPreference($this->getReadPreference());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $cursor;
    }

    /**
     * Stores a file in the database
     * @link http://php.net/manual/en/mongogridfs.storefile.php
     * @param string $filename The name of the file
     * @param array $extra Other metadata to add to the file saved
     * @param array $options Options for the store. "safe": Check that this store succeeded
     * @return mixed Returns the _id of the saved object
     */
    public function storeFile($filename, $extra = array(), $options = array())

    {
        if (is_string($filename)) {
            $md5 = md5_file($filename);
            $shortName = basename($filename);
            $filename = fopen($filename, 'r');
        }
        if (! is_resource($filename)) {
            throw new \InvalidArgumentException();
        }
        $length = fstat($filename)['size'];
        $extra['chunkSize'] = isset($extra['chunkSize']) ? $extra['chunkSize']: self::DEFAULT_CHUNK_SIZE;
        $extra['_id'] = isset($extra['_id']) ?: new MongoId();
        $extra['length'] = $length;
        $extra['md5'] = isset($md5) ? $md5 : $this->calculateMD5($filename, $length);
        $extra['filename'] = isset($extra['filename']) ? $extra['filename'] : $shortName;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

        $fileDocument = $this->insertFile($extra);
        $this->insertChunksFromFile($filename, $fileDocument);

        return $fileDocument['_id'];
    }

    private function insertChunksFromFile($file, $fileInfo)

    {
        $length = $fileInfo['length'];
        $chunkSize = $fileInfo['chunkSize'];
        $fileId = $fileInfo['_id'];
        $offset = 0;
        $i = 0;

        while ($offset < $length) {
            $data = fread($file, $chunkSize);
            $this->insertChunk($fileId, $data, $i++);
            $offset += $chunkSize;
        }
    }

    private function calculateMD5($file, $length)
    {
        // XXX: this could be really a bad idea with big files...
        $data = fread($file, $length);
        fseek($file, 0);
        return md5($data);
    }

    /**
     * Chunkifies and stores bytes in the database
     * @link http://php.net/manual/en/mongogridfs.storebytes.php
     * @param string $bytes A string of bytes to store
     * @param array $extra Other metadata to add to the file saved
     * @param array $options Options for the store. "safe": Check that this store succeeded
     * @return mixed The _id of the object saved
     */
    public function storeBytes($bytes, $extra = array(), $options = array())

    {
        $length = mb_strlen($bytes, '8bit');
        $extra['chunkSize'] = isset($extra['chunkSize']) ? $extra['chunkSize'] : self::DEFAULT_CHUNK_SIZE;
        $extra['_id'] = isset($extra['_id']) ?: new MongoId();
        $extra['length'] = $length;
        $extra['md5'] = md5($bytes);

        $file = $this->insertFile($extra);
        $this->insertChunksFromBytes($bytes, $file);

        return $file['_id'];
    }

    private function insertFile($metadata)
    {
        $this->ensureIndexes();
        $metadata['uploadDate'] = new MongoDate();
        $this->insert($metadata);
        return $metadata;
    }

    private function insertChunksFromBytes($bytes, $fileInfo)

    {
        $length = $fileInfo['length'];
        $chunkSize = $fileInfo['chunkSize'];
        $fileId = $fileInfo['_id'];
        $offset = 0;
        $i = 0;

        while ($offset < $length) {
            $data = mb_substr($bytes, $offset, $chunkSize, '8bit');
            $this->insertChunk($fileId, $data, $i++);
            $offset += $chunkSize;
        }
    }

    private function insertChunk($id, $data, $chunkNumber)
    {
        $chunk = [
            'files_id' => $id,
            'n' => $chunkNumber,
            'data' => new MongoBinData($data),
        ];
        return $this->chunks->insert($chunk);
    }


    /**
     * Returns a single file matching the criteria
     * @link http://www.php.net/manual/en/mongogridfs.findone.php
     * @param array $query The fields for which to search.
     * @param array $fields Fields of the results to return.
     * @return MongoGridFSFile|null
     */
    public function findOne(array $query = array(), array $fields = array())
    {
        $file = parent::findOne($query, $fields);
        if (! $file) {
            return;
        }
        return new MongoGridFSFile($this, $file);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Removes files from the collections
     * @link http://www.php.net/manual/en/mongogridfs.remove.php
     * @param array $criteria Description of records to remove.
     * @param array $options Options for remove. Valid options are: "safe"- Check that the remove succeeded.
     * @throws MongoCursorException
     * @return boolean
     */
    public function remove(array $criteria = [], array $options = [])
    {
        $matchingFiles = parent::find($criteria, ['_id' => 1]);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

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

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        $ids = [];
        foreach ($matchingFiles as $file) {
            $ids[] = $file['_id'];
        }
        $this->chunks->remove(['files_id' => ['$in' => $ids]], ['justOne' => false]);
        return parent::remove($criteria, ['justOne' => false] + $options);
    }

    /**
     * Delete a file from the database
     * @link http://php.net/manual/en/mongogridfs.delete.php
     * @param mixed $id _id of the file to remove
     * @return boolean Returns true if the remove was successfully sent to the database.
     */
    public function delete($id)
    {
        if (is_string($id)) {
            $id = new MongoId($id);
        }
        if (! $id instanceof MongoId) {
            return false;
        }
        $this->chunks->remove(['files_id' => $id], ['justOne' => false]);
        return parent::remove(['_id' => $id]);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

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

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Saves an uploaded file directly from a POST to the database
     * @link http://www.php.net/manual/en/mongogridfs.storeupload.php
     * @param string $name The name attribute of the uploaded file, from <input type="file" name="something"/>.
     * @param array $metadata An array of extra fields for the uploaded file.
     * @return mixed Returns the _id of the uploaded file.
     */
    public function storeUpload($name, array $metadata = [])
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (! isset($_FILES[$name]) || $_FILES[$name]['error'] !== UPLOAD_ERR_OK) {
            throw new \InvalidArgumentException();
        }
        $metadata += ['filename' => $_FILES[$name]['name']];
        return $this->storeFile($_FILES[$name]['tmp_name'], $metadata);
    }

    /**
     * Retrieve a file from the database
     * @link http://www.php.net/manual/en/mongogridfs.get.php
     * @param mixed $id _id of the file to find.
     * @return MongoGridFSFile|null Returns the file, if found, or NULL.
     */
    public function __get($id)
    {
        if (is_string($id)) {
            $id = new MongoId($id);
        }
        if (! $id instanceof MongoId) {
            return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
        return $this->findOne(['_id' => $id]);

    }

    /**
     * Stores a file in the database
     * @link http://php.net/manual/en/mongogridfs.put.php
     * @param string $filename The name of the file
     * @param array $extra Other metadata to add to the file saved
     * @return mixed Returns the _id of the saved object
     */
    public function put($filename, array $extra = array())
    {
        return $this->storeFile($filename, $extra);
    }

    private function ensureIndexes()
    {
        if ($this->ensureIndexes) {
            return;
        }
        $this->ensureFilesIndex();
        $this->ensureChunksIndex();
        $this->ensuredIndexes = true;

    }

    private function ensureChunksIndex()
    {
        foreach ($this->chunks->getIndexInfo() as $index) {
            if (isset($index['unique']) && $index['unique'] && $index['key'] === ['files_id' => 1, 'n' => 1]) {
                return;
            }
        }
        $this->chunks->createIndex(['files_id' => 1, 'n' => 1], ['unique' => true]);
    }

    private function ensureFilesIndex()
    {
        foreach ($this->getIndexInfo() as $index) {
            if ($index['key'] === ['filename' => 1, 'uploadDate' => 1]) {
                return;
            }
        }
        $this->createIndex(['filename' => 1, 'uploadDate' => 1]);
    }

}


alcaeus / mongo-php-adapter