netglue/ZF2-Prismic-Module

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    protected function findBookmarkedRoutes(array $routes, $parent = '')
    {
        $searchParam = $this->routerOptions->getBookmarkParam();
        $out = array();
        foreach ($routes as $name => $route) {

Found in src/NetgluePrismic/Mvc/LinkResolver.php and 1 other location - About 5 hrs to fix

Read up
Read up

src/NetgluePrismic/Mvc/LinkResolver.php on lines 243..259

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 188.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Don't Repeat Yourself on the C2 Wiki
Duplicated Code on SourceMaking
Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    protected function findRoutesReferencedToMasks(array $routes, $parent = '')
    {
        $searchParam = $this->routerOptions->getMaskParam();
        $out = array();
        foreach ($routes as $name => $route) {

Found in src/NetgluePrismic/Mvc/LinkResolver.php and 1 other location - About 5 hrs to fix

Read up
Read up

src/NetgluePrismic/Mvc/LinkResolver.php on lines 179..195

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 188.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Don't Repeat Yourself on the C2 Wiki
Duplicated Code on SourceMaking
Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76

`HeadMetaListener` has 24 functions (exceeds 20 allowed). Consider refactoring.
Open

class HeadMetaListener implements ListenerAggregateInterface
{

    use ListenerAggregateTrait;

Found in src/NetgluePrismic/Mvc/Listener/HeadMetaListener.php - About 2 hrs to fix

Function `filterExcludedDocuments` has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

    private function filterExcludedDocuments(array $docs)
    {
        if(!count($this->exclude)) {
            return $docs;
        }

Found in src/NetgluePrismic/Service/SitemapGenerator.php - About 2 hrs to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading

`Prismic` has 22 functions (exceeds 20 allowed). Consider refactoring.
Open

class Prismic extends AbstractPlugin implements
    EventManagerAwareInterface,
    ApiAwareInterface,
    ContextAwareInterface
{

Found in src/NetgluePrismic/Mvc/Controller/Plugin/Prismic.php - About 2 hrs to fix

Method `oauthCallbackAction` has 34 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function oauthCallbackAction()
    {
        // We should have 'code' in GET params:
        $code = $this->params()->fromQuery('code');
        if (empty($code)) {

Found in src/NetgluePrismic/Mvc/Controller/PrismicController.php - About 1 hr to fix

Function `resolve` has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

    public function resolve($link)
    {
        if (!$link instanceof LinkInterface) {
            throw new Exception\InvalidArgumentException(sprintf(
                'Expected an instance of LinkInterface recieved %s %s',

Found in src/NetgluePrismic/Mvc/LinkResolver.php - About 1 hr to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading

Function `getDocument` has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

    public function getDocument()
    {
        if (!$this->document) {
            $document = null;
            if ($this->isBookmarkRequest()) {

Found in src/NetgluePrismic/Mvc/Controller/Plugin/Prismic.php - About 1 hr to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading

Method `resolve` has 30 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function resolve($link)
    {
        if (!$link instanceof LinkInterface) {
            throw new Exception\InvalidArgumentException(sprintf(
                'Expected an instance of LinkInterface recieved %s %s',

Found in src/NetgluePrismic/Mvc/LinkResolver.php - About 1 hr to fix

Method `getContainerByName` has 29 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function getContainerByName($name)
    {
        /**
         * Try to retrieve the generator from the cache. If it can't be found, create it
         */

Found in src/NetgluePrismic/Service/Sitemap.php - About 1 hr to fix

Method `webhookAction` has 27 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function webhookAction()
    {
        if (!$this->getRequest()->isPost()) {
            return $this->getResponse()
                ->setStatusCode(400)

Found in src/NetgluePrismic/Mvc/Controller/PrismicController.php - About 1 hr to fix

Function `setPreviewRef` has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    public function setPreviewRef(MvcEvent $event)
    {
        $ref = $this->getSessionRef();

        $cookie = $this->getCookieRef($event);

Found in src/NetgluePrismic/Mvc/Listener/SelectedRefListener.php - About 45 mins to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading

Function `documentToArray` has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

    protected function documentToArray(Document $document)
    {
        $type = $document->getType();
        $data = array();

Found in src/NetgluePrismic/Service/SitemapGenerator.php - About 45 mins to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading

Function `createService` has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    public function createService(ServiceLocatorInterface $serviceLocator) : CacheInterface
    {
        $config = $serviceLocator->get('Config');
        $config = isset($config['prismic'])
                ? $config['prismic']

Found in src/NetgluePrismic/Factory/PrismicCacheFactory.php - About 35 mins to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading

Function `getContainerByName` has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    public function getContainerByName($name)
    {
        /**
         * Try to retrieve the generator from the cache. If it can't be found, create it
         */

Found in src/NetgluePrismic/Service/Sitemap.php - About 35 mins to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading

Avoid too many `return` statements within this method.
Open

        return $link->getUrl($this);

Found in src/NetgluePrismic/Mvc/LinkResolver.php - About 30 mins to fix

Avoid too many `return` statements within this method.
Open

        return $this->getResponse()
            ->setStatusCode(200)
            ->setContent(PHP_EOL);

Found in src/NetgluePrismic/Mvc/Controller/PrismicController.php - About 30 mins to fix

Avoid too many `return` statements within this method.
Open

        return null;

Found in src/NetgluePrismic/Service/Sitemap.php - About 30 mins to fix

Function `changeRefAction` has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    public function changeRefAction()
    {
        $ref = $this->params()->fromQuery('ref');
        $url = $this->params()->fromQuery('url');
        if (!empty($url)) {

Found in src/NetgluePrismic/Mvc/Controller/PrismicController.php - About 25 mins to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading

Function `findBookmarkByDocument` has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

    public function findBookmarkByDocument($doc)
    {
        if (!$doc instanceof Document) {
            if (!$d = $this->getDocumentById($doc)) {
                throw new Exception\DocumentNotFoundException(sprintf(

Found in src/NetgluePrismic/Context.php - About 25 mins to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading