LibraryFactory::validateDirectory() - Code Metrics - matks/MarkdownBlogBundle - Measure and Improve Code Quality continuously with Scrutinizer

LibraryFactory::validateDirectory() A
last analyzed 2017-12-22 14:15 UTC

↳ Parent: LibraryFactory

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

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

<?php

namespace Matks\MarkdownBlogBundle\Blog\Factory;

use Matks\MarkdownBlogBundle\Blog\ExternalPost;
use Matks\MarkdownBlogBundle\Blog\Library;
use Matks\MarkdownBlogBundle\Blog\Post;
use Matks\MarkdownBlogBundle\Blog\Register\LibraryRegisterInterface;
use Matks\MarkdownBlogBundle\Blog\Register\RegisterEntry;

class LibraryFactory
{
    /**
     * @var string
     */
    private $postsDirectory;

    /**
     * @var LibraryRegisterInterface
     */
    private $libraryRegister;

    /**
     * @param string                   $postsDirectory path of the posts directory
     * @param LibraryRegisterInterface $libraryRegister
     */
    public function __construct($postsDirectory, LibraryRegisterInterface $libraryRegister)
    {
        if (substr($postsDirectory, -1) !== '/') {
            $postsDirectory = $postsDirectory . '/';
        }

        $this->validateDirectory($postsDirectory);

        $this->postsDirectory  = $postsDirectory;
        $this->libraryRegister = $libraryRegister;
    }

    /**
     * @return Library
     */
    public function buildLibrary()
    {
        $markdownFiles = $this->getMarkdownFiles();
        $posts         = [];

        foreach ($markdownFiles as $markdownFile) {

            $onlyFilename = basename($markdownFile, '.md');
            if ($this->libraryRegister->isRegistered($onlyFilename)) {
                $entry = $this->libraryRegister->getEntry($onlyFilename);

                $post = $this->buildPostFromRegisterEntry($markdownFile, $entry);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            } else {
                $post = $this->buildPost($markdownFile);
            }

            $posts[] = $post;
        }

        $library = new Library($posts);

        return $library;
    }

    /**
     * @param string $filename
     *
     * @return Post
     */
    private function buildPost($filename)
    {
        $filepath    = $this->postsDirectory . $filename;
        $publishDate = $this->computeFilePublishDate($filepath);
        $name        = basename($filename, '.md');

        $post = new Post($filepath, $name, $publishDate);

        return $post;
    }

    /**
     * @param string        $filename
     * @param RegisterEntry $entry
     *
     * @return Post
     */
    private function buildPostFromRegisterEntry($filename, RegisterEntry $entry)
    {
        $filepath = $this->postsDirectory . $filename;

        if (null !== $entry->getPublishDate()) {
            $publishDate = $entry->getPublishDate();
        } else {
            $publishDate = $this->computeFilePublishDate($filepath);
        }

        if (null !== $entry->getAlias()) {
            $name = $entry->getAlias();
        } else {
            $name = basename($filename, '.md');
        }

        if ($entry->getBlogType() === Post::TYPE_EXTERNAL) {
            $post = new ExternalPost(
                $filepath,
                $name,
                $publishDate,
                $entry->getCategory(),
                $entry->getTags(),
                $entry->getUrl()
            );
        } else {
            $post = new Post(
                $filepath,
                $name,
                $publishDate,
                $entry->getCategory(),
                $entry->getTags()
            );
        }

        return $post;
    }

    /**
     * @param string $postsDirectory
     *
     * @throws \InvalidArgumentException
     */
    private function validateDirectory($postsDirectory)
    {
        if (false === is_dir($postsDirectory)) {
            throw new \InvalidArgumentException("$postsDirectory is not a directory");
        }
    }

    /**
     * @return string[]
     */
    private function getMarkdownFiles()
    {
        $scan = scandir($this->postsDirectory);

        $markdownFiles = [];
        foreach ($scan as $file) {
            if (in_array($file, ['.', '..'])) {
                continue;
            }

            $hasMdExtension = ('.md' === substr($file, -3));
            if (false === $hasMdExtension) {
                continue;
            }

            $markdownFiles[] = $file;
        }

        return $markdownFiles;
    }

    /**
     * @param string $filepath
     *
     * @return string
     */
    private function computeFilePublishDate($filepath)
    {
        $creationTimestamp = filectime($filepath);
        if (false === $creationTimestamp) {
            throw new \InvalidArgumentException("Could not get creation date of file $filepath");
        }
        $creationDateTime = new \DateTime('@' . $creationTimestamp);

        return $creationDateTime->format('Y-m-d');
    }
}


1		<?php
2
3		namespace Matks\MarkdownBlogBundle\Blog\Factory;
4
5		use Matks\MarkdownBlogBundle\Blog\ExternalPost;
6		use Matks\MarkdownBlogBundle\Blog\Library;
7		use Matks\MarkdownBlogBundle\Blog\Post;
8		use Matks\MarkdownBlogBundle\Blog\Register\LibraryRegisterInterface;
9		use Matks\MarkdownBlogBundle\Blog\Register\RegisterEntry;
10
11		class LibraryFactory
12		{
13		/**
14		* @var string
15		*/
16		private $postsDirectory;
17
18		/**
19		* @var LibraryRegisterInterface
20		*/
21		private $libraryRegister;
22
23		/**
24		* @param string $postsDirectory path of the posts directory
25		* @param LibraryRegisterInterface $libraryRegister
26		*/
27	1	public function __construct($postsDirectory, LibraryRegisterInterface $libraryRegister)
28		{
29	1	if (substr($postsDirectory, -1) !== '/') {
30	1	$postsDirectory = $postsDirectory . '/';
31	1	}
32
33	1	$this->validateDirectory($postsDirectory);
34
35	1	$this->postsDirectory = $postsDirectory;
36	1	$this->libraryRegister = $libraryRegister;
37	1	}
38
39		/**
40		* @return Library
41		*/
42		public function buildLibrary()
43		{
44	1	$markdownFiles = $this->getMarkdownFiles();
45	1	$posts = [];
46
47	1	foreach ($markdownFiles as $markdownFile) {
48
49	1	$onlyFilename = basename($markdownFile, '.md');
50	1	if ($this->libraryRegister->isRegistered($onlyFilename)) {
51	1	$entry = $this->libraryRegister->getEntry($onlyFilename);
52
53	1	$post = $this->buildPostFromRegisterEntry($markdownFile, $entry);
		0 ignored issues – show Bug introduced 2016-05-04 13:54 UTC by Report Bug Copy Issue Report It seems like `$entry` defined by `$this->libraryRegister->getEntry($onlyFilename)` on line `51` can be `null`; however, `Matks\MarkdownBlogBundle...PostFromRegisterEntry()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
54	1	} else {
55	1	$post = $this->buildPost($markdownFile);
56		}
57
58	1	$posts[] = $post;
59	1	}
60
61	1	$library = new Library($posts);
62
63	1	return $library;
64		}
65
66		/**
67		* @param string $filename
68		*
69		* @return Post
70		*/
71		private function buildPost($filename)
72		{
73	1	$filepath = $this->postsDirectory . $filename;
74	1	$publishDate = $this->computeFilePublishDate($filepath);
75	1	$name = basename($filename, '.md');
76
77	1	$post = new Post($filepath, $name, $publishDate);
78
79	1	return $post;
80		}
81
82		/**
83		* @param string $filename
84		* @param RegisterEntry $entry
85		*
86		* @return Post
87		*/
88		private function buildPostFromRegisterEntry($filename, RegisterEntry $entry)
89		{
90	1	$filepath = $this->postsDirectory . $filename;
91
92	1	if (null !== $entry->getPublishDate()) {
93	1	$publishDate = $entry->getPublishDate();
94	1	} else {
95		$publishDate = $this->computeFilePublishDate($filepath);
96		}
97
98	1	if (null !== $entry->getAlias()) {
99		$name = $entry->getAlias();
100		} else {
101	1	$name = basename($filename, '.md');
102		}
103
104	1	if ($entry->getBlogType() === Post::TYPE_EXTERNAL) {
105		$post = new ExternalPost(
106		$filepath,
107		$name,
108		$publishDate,
109		$entry->getCategory(),
110		$entry->getTags(),
111		$entry->getUrl()
112		);
113		} else {
114	1	$post = new Post(
115	1	$filepath,
116	1	$name,
117	1	$publishDate,
118	1	$entry->getCategory(),
119	1	$entry->getTags()
120	1	);
121		}
122
123	1	return $post;
124		}
125
126		/**
127		* @param string $postsDirectory
128		*
129		* @throws \InvalidArgumentException
130		*/
131		private function validateDirectory($postsDirectory)
132		{
133	1	if (false === is_dir($postsDirectory)) {
134	1	throw new \InvalidArgumentException("$postsDirectory is not a directory");
135		}
136	1	}
137
138		/**
139		* @return string[]
140		*/
141		private function getMarkdownFiles()
142		{
143	1	$scan = scandir($this->postsDirectory);
144
145	1	$markdownFiles = [];
146	1	foreach ($scan as $file) {
147	1	if (in_array($file, ['.', '..'])) {
148	1	continue;
149		}
150
151	1	$hasMdExtension = ('.md' === substr($file, -3));
152	1	if (false === $hasMdExtension) {
153	1	continue;
154		}
155
156	1	$markdownFiles[] = $file;
157	1	}
158
159	1	return $markdownFiles;
160		}
161
162		/**
163		* @param string $filepath
164		*
165		* @return string
166		*/
167		private function computeFilePublishDate($filepath)
168		{
169	1	$creationTimestamp = filectime($filepath);
170	1	if (false === $creationTimestamp) {
171		throw new \InvalidArgumentException("Could not get creation date of file $filepath");
172		}
173	1	$creationDateTime = new \DateTime('@' . $creationTimestamp);
174
175	1	return $creationDateTime->format('Y-m-d');
176		}
177		}
178

matks / MarkdownBlogBundle

LibraryFactory::validateDirectory() A last analyzed 2017-12-22 14:15 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

LibraryFactory::validateDirectory() A
last analyzed 2017-12-22 14:15 UTC