NewPage::execute() - Code Metrics - Inspection of "Add date prefix to new page" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature-newpage-date-prefix ( 5ec592 )

by Arnaud

created 2020-01-13 15:04 UTC

NewPage::execute() C

↳ Parent: NewPage

Complexity

Conditions	10
Paths	59

Size

Total Lines

Duplication

Lines	7
Ratio	11.29 %

Importance

Changes

Metric	Value
dl	7
loc	62
rs	6.9624
c	0
b	0
f	0
cc	10
nc	59
nop	2

How to fix Long Method Complexity

<?php
/*
 * This file is part of the Cecil/Cecil package.
 *
 * Copyright (c) Arnaud Ligny <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Command;

use Cecil\Util\Plateform;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
use Symfony\Component\Process\Process;

class NewPage extends Command
{
    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this
            ->setName('new:page')
            ->setDescription('Create a new page')
            ->setDefinition(
                new InputDefinition([
                    new InputArgument('name', InputArgument::REQUIRED, 'New page name'),
                    new InputArgument('path', InputArgument::OPTIONAL, 'Use the given path as working directory'),
                    new InputOption('force', 'f', InputOption::VALUE_NONE, 'Override the file if already exist'),
                    new InputOption('open', 'o', InputOption::VALUE_NONE, 'Open editor automatically'),
                    new InputOption('prefix', 'p', InputOption::VALUE_NONE, 'Add date (`YYYY-MM-DD`) as a prefix'),
                ])
            )
            ->setHelp('Create a new page file (with a default title and the current date).');
    }

    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $name = (string) $input->getArgument('name');
        $force = $input->getOption('force');
        $open = $input->getOption('open');
        $prefix = $input->getOption('prefix');

        try {
            $nameParts = pathinfo($name);
            $dirname = $nameParts['dirname'];
            $filename = $nameParts['filename'];
            $date = date('Y-m-d');
            $title = $filename;
            // date prefix?
            $datePrefix = '';
            if ($prefix) {
                $datePrefix = sprintf('%s-', $date);
            }
            // path
            $fileRelativePath = sprintf(
                '%s/%s%s%s.md',
                $this->getBuilder($output)->getConfig()->get('content.dir'),
                !$dirname ?: $dirname . '/',
                $datePrefix,
                $filename
            );
            $filePath = $this->getPath() . '/' . $fileRelativePath;

            // file already exists?
            if ($this->fs->exists($filePath) && !$force) {

                $helper = $this->getHelper('question');
                $question = new ConfirmationQuestion(
                    sprintf('This page already exists. Do you want to override it? [y/n]', $this->getpath()),
                    false
                );
                if (!$helper->ask($input, $output, $question)) {
                    return;
                }
            }

            // create new file
            $fileContent = str_replace(
                ['%title%', '%date%'],
                [$title, $date],
                $this->findModel(sprintf('%s%s', !$dirname ?: $dirname . '/', $filename))
            );
            $this->fs->dumpFile($filePath, $fileContent);
            $output->writeln(sprintf('File "%s" created.', $fileRelativePath));

            // open editor?
            if ($open) {
                if (!$this->hasEditor($output)) {
                    $output->writeln('<comment>No editor configured.</comment>');
                }
                $this->openEditor($output, $filePath);
            }
        } catch (\Exception $e) {
            throw new \Exception(sprintf($e->getMessage()));
        }

        return 0;
    }

    /**
     * Find the page model and return its content.
     *
     * @param string $name
     *
     * @return string
     */
    protected function findModel(string $name): string
    {
        $section = strstr($name, '/', true);
        if ($section && file_exists($model = sprintf('%s/models/%s.md', $this->getPath(), $section))) {
            return file_get_contents($model);
        }
        if (file_exists($model = sprintf('%s/models/default.md', $this->getPath()))) {
            return file_get_contents($model);
        }

        return <<<'EOT'
---
title: '%title%'
date: '%date%'
draft: true
---

_[Your content here]_
EOT;
    }

    /**
     * Editor is configured?
     *
     * @param OutputInterface $output
     *
     * @return bool
     */
    protected function hasEditor(OutputInterface $output): bool
    {
        if ($this->getBuilder($output)->getConfig()->get('editor')) {

            return true;
        }

        return false;
    }

    /**
     * Open new file in editor (if configured).
     *
     * @param OutputInterface $output
     * @param string          $filePath
     *
     * @return void
     */
    protected function openEditor(OutputInterface $output, string $filePath)
    {
        if ($editor = $this->getBuilder($output)->getConfig()->get('editor')) {
            switch ($editor) {
                case 'typora':
                    if (Plateform::getOS() == Plateform::OS_OSX) {
                        $command = sprintf('open -a typora "%s"', $filePath);
                    }
                    break;
                default:
                    $command = sprintf('%s "%s"', $editor, $filePath);
                    break;
            }
            $process = Process::fromShellCommandline($command);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
            $process->run();
            if (!$process->isSuccessful()) {
                throw new \Exception(sprintf('Can\'t run "%s".', $command));
            }
        }
    }
}


1		<?php
2		/*
3		* This file is part of the Cecil/Cecil package.
4		*
5		* Copyright (c) Arnaud Ligny <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace Cecil\Command;
12
13		use Cecil\Util\Plateform;
14		use Symfony\Component\Console\Input\InputArgument;
15		use Symfony\Component\Console\Input\InputDefinition;
16		use Symfony\Component\Console\Input\InputInterface;
17		use Symfony\Component\Console\Input\InputOption;
18		use Symfony\Component\Console\Output\OutputInterface;
19		use Symfony\Component\Console\Question\ConfirmationQuestion;
20		use Symfony\Component\Process\Process;
21
22		class NewPage extends Command
23		{
24		/**
25		* {@inheritdoc}
26		*/
27	View Code Duplication	protected function configure()
28		{
29		$this
30		->setName('new:page')
31		->setDescription('Create a new page')
32		->setDefinition(
33		new InputDefinition([
34		new InputArgument('name', InputArgument::REQUIRED, 'New page name'),
35		new InputArgument('path', InputArgument::OPTIONAL, 'Use the given path as working directory'),
36		new InputOption('force', 'f', InputOption::VALUE_NONE, 'Override the file if already exist'),
37		new InputOption('open', 'o', InputOption::VALUE_NONE, 'Open editor automatically'),
38		new InputOption('prefix', 'p', InputOption::VALUE_NONE, 'Add date (`YYYY-MM-DD`) as a prefix'),
39		])
40		)
41		->setHelp('Create a new page file (with a default title and the current date).');
42		}
43
44		/**
45		* {@inheritdoc}
46		*/
47		protected function execute(InputInterface $input, OutputInterface $output)
48		{
49		$name = (string) $input->getArgument('name');
50		$force = $input->getOption('force');
51		$open = $input->getOption('open');
52		$prefix = $input->getOption('prefix');
53
54		try {
55		$nameParts = pathinfo($name);
56		$dirname = $nameParts['dirname'];
57		$filename = $nameParts['filename'];
58		$date = date('Y-m-d');
59		$title = $filename;
60		// date prefix?
61		$datePrefix = '';
62		if ($prefix) {
63		$datePrefix = sprintf('%s-', $date);
64		}
65		// path
66		$fileRelativePath = sprintf(
67		'%s/%s%s%s.md',
68		$this->getBuilder($output)->getConfig()->get('content.dir'),
69		!$dirname ?: $dirname . '/',
70		$datePrefix,
71		$filename
72		);
73		$filePath = $this->getPath() . '/' . $fileRelativePath;
74
75		// file already exists?
76	View Code Duplication	if ($this->fs->exists($filePath) && !$force) {
		0 ignored issues – show Duplication introduced 2020-01-10 11:46 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
77		$helper = $this->getHelper('question');
78		$question = new ConfirmationQuestion(
79		sprintf('This page already exists. Do you want to override it? [y/n]', $this->getpath()),
80		false
81		);
82		if (!$helper->ask($input, $output, $question)) {
83		return;
84		}
85		}
86
87		// create new file
88		$fileContent = str_replace(
89		['%title%', '%date%'],
90		[$title, $date],
91		$this->findModel(sprintf('%s%s', !$dirname ?: $dirname . '/', $filename))
92		);
93		$this->fs->dumpFile($filePath, $fileContent);
94		$output->writeln(sprintf('File "%s" created.', $fileRelativePath));
95
96		// open editor?
97		if ($open) {
98		if (!$this->hasEditor($output)) {
99		$output->writeln('<comment>No editor configured.</comment>');
100		}
101		$this->openEditor($output, $filePath);
102		}
103		} catch (\Exception $e) {
104		throw new \Exception(sprintf($e->getMessage()));
105		}
106
107		return 0;
108		}
109
110		/**
111		* Find the page model and return its content.
112		*
113		* @param string $name
114		*
115		* @return string
116		*/
117		protected function findModel(string $name): string
118		{
119		$section = strstr($name, '/', true);
120		if ($section && file_exists($model = sprintf('%s/models/%s.md', $this->getPath(), $section))) {
121		return file_get_contents($model);
122		}
123		if (file_exists($model = sprintf('%s/models/default.md', $this->getPath()))) {
124		return file_get_contents($model);
125		}
126
127		return <<<'EOT'
128		---
129		title: '%title%'
130		date: '%date%'
131		draft: true
132		---
133
134		_[Your content here]_
135		EOT;
136		}
137
138		/**
139		* Editor is configured?
140		*
141		* @param OutputInterface $output
142		*
143		* @return bool
144		*/
145		protected function hasEditor(OutputInterface $output): bool
146		{
147		if ($this->getBuilder($output)->getConfig()->get('editor')) {
		0 ignored issues – show Unused Code introduced 2020-01-13 15:06 UTC by Report Bug Copy Issue Report This `if` statement, and the following `return` statement can be replaced with `return (bool) $this->get...onfig()->get('editor');`. Loading history...
148		return true;
149		}
150
151		return false;
152		}
153
154		/**
155		* Open new file in editor (if configured).
156		*
157		* @param OutputInterface $output
158		* @param string $filePath
159		*
160		* @return void
161		*/
162		protected function openEditor(OutputInterface $output, string $filePath)
163		{
164		if ($editor = $this->getBuilder($output)->getConfig()->get('editor')) {
165		switch ($editor) {
166		case 'typora':
167		if (Plateform::getOS() == Plateform::OS_OSX) {
168		$command = sprintf('open -a typora "%s"', $filePath);
169		}
170		break;
171		default:
172		$command = sprintf('%s "%s"', $editor, $filePath);
173		break;
174		}
175		$process = Process::fromShellCommandline($command);
		0 ignored issues – show Bug introduced 2020-01-13 15:06 UTC by Report Bug Copy Issue Report The variable `$command` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
176		$process->run();
177		if (!$process->isSuccessful()) {
178		throw new \Exception(sprintf('Can\'t run "%s".', $command));
179		}
180		}
181		}
182		}
183

Cecilapp / Cecil

Push — feature-newpage-date-prefix ( 5ec592 )

NewPage::execute() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like