Skip to content

Commit

Permalink
moved some code to a dedicated class
Browse files Browse the repository at this point in the history
  • Loading branch information
schmittjoh committed Oct 1, 2012
1 parent aedeb0f commit 4e769e1
Show file tree
Hide file tree
Showing 2 changed files with 117 additions and 66 deletions.
69 changes: 3 additions & 66 deletions src/Composer/Command/ValidateCommand.php
Expand Up @@ -12,6 +12,7 @@

namespace Composer\Command;

use Composer\Util\ConfigValidator;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Output\OutputInterface;
Expand Down Expand Up @@ -69,72 +70,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
return 1;
}

$errors = array();
$publishErrors = array();
$warnings = array();

// validate json schema
$laxValid = false;
$valid = false;
try {
$json = new JsonFile($file, new RemoteFilesystem($this->getIO()));
$manifest = $json->read();

$json->validateSchema(JsonFile::LAX_SCHEMA);
$laxValid = true;
$json->validateSchema();
$valid = true;
} catch (JsonValidationException $e) {
foreach ($e->getErrors() as $message) {
if ($laxValid) {
$publishErrors[] = '<error>Publish Error: ' . $message . '</error>';
} else {
$errors[] = '<error>' . $message . '</error>';
}
}
} catch (\Exception $e) {
$output->writeln('<error>' . $e->getMessage() . '</error>');

return 1;
}

// validate actual data
if (!empty($manifest['license'])) {
$licenseValidator = new SpdxLicenseIdentifier();
if (!$licenseValidator->validate($manifest['license'])) {
$warnings[] = sprintf(
'License %s is not a valid SPDX license identifier, see http://www.spdx.org/licenses/ if you use an open license',
json_encode($manifest['license'])
);
}
} else {
$warnings[] = 'No license specified, it is recommended to do so';
}

if (!empty($manifest['name']) && preg_match('{[A-Z]}', $manifest['name'])) {
$suggestName = preg_replace('{(?:([a-z])([A-Z])|([A-Z])([A-Z][a-z]))}', '\\1\\3-\\2\\4', $manifest['name']);
$suggestName = strtolower($suggestName);

$warnings[] = sprintf(
'Name "%s" does not match the best practice (e.g. lower-cased/with-dashes). We suggest using "%s" instead. As such you will not be able to submit it to Packagist.',
$manifest['name'],
$suggestName
);
}

// TODO validate package repositories' packages using the same technique as below
try {
$loader = new ValidatingArrayLoader(new ArrayLoader(), false);
if (!isset($manifest['version'])) {
$manifest['version'] = '1.0.0';
}
if (!isset($manifest['name'])) {
$manifest['name'] = 'dummy/dummy';
}
$loader->load($manifest);
} catch (\Exception $e) {
$errors = array_merge($errors, explode("\n", $e->getMessage()));
}
$validator = new ConfigValidator($this->getIO());
list($errors, $publishErrors, $warnings) = $validator->validate($file);

// output errors/warnings
if (!$errors && !$publishErrors && !$warnings) {
Expand Down
114 changes: 114 additions & 0 deletions src/Composer/Util/ConfigValidator.php
@@ -0,0 +1,114 @@
<?php

/*
* This file is part of Composer.
*
* (c) Nils Adermann <naderman@naderman.de>
* Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Composer\Util;

use Composer\Package\Loader\ArrayLoader;
use Composer\Package\Loader\ValidatingArrayLoader;
use Composer\Json\JsonValidationException;
use Composer\IO\IOInterface;
use Composer\Json\JsonFile;

/**
* Validates a composer configuration.
*
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ConfigValidator
{
private $io;

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

/**
* Validates the config, and returns the result.
*
* @param string $file The path to the file
*
* @return array a triple containing the errors, publishable errors, and warnings
*/
public function validate($file)
{
$errors = array();
$publishErrors = array();
$warnings = array();

// validate json schema
$laxValid = false;
$valid = false;
try {
$json = new JsonFile($file, new RemoteFilesystem($this->io));
$manifest = $json->read();

$json->validateSchema(JsonFile::LAX_SCHEMA);
$laxValid = true;
$json->validateSchema();
$valid = true;
} catch (JsonValidationException $e) {
foreach ($e->getErrors() as $message) {
if ($laxValid) {
$publishErrors[] = '<error>Publish Error: ' . $message . '</error>';
} else {
$errors[] = '<error>' . $message . '</error>';
}
}
} catch (\Exception $e) {
$output->writeln('<error>' . $e->getMessage() . '</error>');

return 1;
}

// validate actual data
if (!empty($manifest['license'])) {
$licenseValidator = new SpdxLicenseIdentifier();
if (!$licenseValidator->validate($manifest['license'])) {
$warnings[] = sprintf(
'License %s is not a valid SPDX license identifier, see http://www.spdx.org/licenses/ if you use an open license',
json_encode($manifest['license'])
);
}
} else {
$warnings[] = 'No license specified, it is recommended to do so';
}

if (!empty($manifest['name']) && preg_match('{[A-Z]}', $manifest['name'])) {
$suggestName = preg_replace('{(?:([a-z])([A-Z])|([A-Z])([A-Z][a-z]))}', '\\1\\3-\\2\\4', $manifest['name']);
$suggestName = strtolower($suggestName);

$warnings[] = sprintf(
'Name "%s" does not match the best practice (e.g. lower-cased/with-dashes). We suggest using "%s" instead. As such you will not be able to submit it to Packagist.',
$manifest['name'],
$suggestName
);
}

// TODO validate package repositories' packages using the same technique as below
try {
$loader = new ValidatingArrayLoader(new ArrayLoader(), false);
if (!isset($manifest['version'])) {
$manifest['version'] = '1.0.0';
}
if (!isset($manifest['name'])) {
$manifest['name'] = 'dummy/dummy';
}
$loader->load($manifest);
} catch (\Exception $e) {
$errors = array_merge($errors, explode("\n", $e->getMessage()));
}

return array($errors, $publishErrors, $warnings);
}
}

0 comments on commit 4e769e1

Please sign in to comment.