Skip to content

Commit

Permalink
feature #61 Display how many stars can be sent + hide reminder if non…
Browse files Browse the repository at this point in the history 
…e (nicolas-grekas)

This PR was merged into the 1.0-dev branch.

Discussion
----------

Display how many stars can be sent + hide reminder if none

![image](https://user-images.githubusercontent.com/243674/43842880-914f0244-9b26-11e8-9f7c-d63814d8a200.png)

Helps knowing beforehand if running the command is useful at all.

Commits
-------

06dc95c Display how many stars can be sent + hide reminder if none
  • Loading branch information
@nicolas-grekas
nicolas-grekas committed Aug 24, 2018
2 parents ca74c76 + 06dc95c commit 9474a63
Show file tree
Hide file tree
Showing 3 changed files with 252 additions and 185 deletions.
193 changes: 11 additions & 182 deletions src/Command/ThanksCommand.php
View file
Expand Up @@ -12,90 +12,16 @@
namespace Symfony\Thanks\Command;

use Composer\Command\BaseCommand;
use Composer\Composer;
use Composer\Downloader\TransportException;
use Composer\Json\JsonFile;
use Composer\Util\RemoteFilesystem;
use Composer\Factory;
use Composer\Plugin\PluginEvents;
use Composer\Plugin\PreFileDownloadEvent;
use Hirak\Prestissimo\CurlRemoteFilesystem;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Thanks\GitHubClient;

/**
* @author Nicolas Grekas <p@tchwork.com>
*/
class ThanksCommand extends BaseCommand
{
// This is a list of projects that should get a star on their main repository
// (when there is one) whenever you use any of their other repositories.
// When a project's main repo is also a dependency of their other repos (like amphp/amp),
// there is no need to list it here, as starring will transitively happen anyway.
private static $mainRepositories = [
'api-platform' => [
'name' => 'api-platform/api-platform',
'url' => 'https://github.com/api-platform/api-platform',
],
'cakephp' => [
'name' => 'cakephp/cakephp',
'url' => 'https://github.com/cakephp/cakephp',
],
'drupal' => [
'name' => 'drupal/drupal',
'url' => 'https://github.com/drupal/drupal',
],
'laravel' => [
'name' => 'laravel/laravel',
'url' => 'https://github.com/laravel/laravel',
],
'illuminate' => [
'name' => 'laravel/laravel',
'url' => 'https://github.com/laravel/laravel',
],
'nette' => [
'name' => 'nette/nette',
'url' => 'https://github.com/nette/nette',
],
'phpDocumentor' => [
'name' => 'phpDocumentor/phpDocumentor2',
'url' => 'https://github.com/phpDocumentor/phpDocumentor2',
],
'piwik' => [
'name' => 'piwik/piwik',
'url' => 'https://github.com/piwik/piwik',
],
'reactphp' => [
'name' => 'reactphp/react',
'url' => 'https://github.com/reactphp/react',
],
'sebastianbergmann' => [
'name' => 'phpunit/phpunit',
'url' => 'https://github.com/sebastianbergmann/phpunit',
],
'slimphp' => [
'name' => 'slimphp/Slim',
'url' => 'https://github.com/slimphp/Slim',
],
'Sylius' => [
'name' => 'Sylius/Sylius',
'url' => 'https://github.com/Sylius/Sylius',
],
'symfony' => [
'name' => 'symfony/symfony',
'url' => 'https://github.com/symfony/symfony',
],
'yiisoft' => [
'name' => 'yiisoft/yii2',
'url' => 'https://github.com/yiisoft/yii2',
],
'zendframework' => [
'name' => 'zendframework/zendframework',
'url' => 'https://github.com/zendframework/zendframework',
],
];

private $star = '★ ';
private $love = '💖 ';

Expand All @@ -104,7 +30,7 @@ protected function configure()
if ('Hyper' === getenv('TERM_PROGRAM')) {
$this->star = '⭐ ';
$this->love = '💖 ';
} elseif ('\\' === DIRECTORY_SEPARATOR) {
} elseif ('\\' === \DIRECTORY_SEPARATOR) {
$this->star = '*';
$this->love = '<3';
}
Expand All @@ -120,59 +46,9 @@ protected function configure()
protected function execute(InputInterface $input, OutputInterface $output)
{
$composer = $this->getComposer();
$repo = $composer->getRepositoryManager()->getLocalRepository();

$urls = [
'composer/composer' => 'https://github.com/composer/composer',
'php/php-src' => 'https://github.com/php/php-src',
'symfony/thanks' => 'https://github.com/symfony/thanks',
];

$directPackages = $this->getDirectlyRequiredPackageNames();
// symfony/thanks shouldn't trigger thanking symfony/symfony
unset($directPackages['symfony/thanks']);
foreach ($repo->getPackages() as $package) {
$extra = $package->getExtra();
$gitHub = new GitHubClient($composer, $this->getIO());

if (isset($extra['thanks']['name'], $extra['thanks']['url'])) {
$urls += [$extra['thanks']['name'] => $extra['thanks']['url']];
}

if (!$url = $package->getSourceUrl()) {
continue;
}

$urls[$package->getName()] = $url;

if (!preg_match('#^https://github.com/([^/]++)#', $url, $url)) {
continue;
}
$owner = $url[1];

// star the main repository, but only if this package is directly
// being required by the user's composer.json
if (isset(self::$mainRepositories[$owner], $directPackages[$package->getName()])) {
$urls[self::$mainRepositories[$owner]['name']] = self::$mainRepositories[$owner]['url'];
}
}

ksort($urls);

$rfs = Factory::createRemoteFilesystem($this->getIo(), $composer->getConfig());

$i = 0;
$template = '_%d: repository(owner:"%s",name:"%s"){id,viewerHasStarred}'."\n";
$graphql = '';

foreach ($urls as $package => $url) {
if (preg_match('#^https://github.com/([^/]++)/(.*?)(?:\.git)?$#i', $url, $url)) {
$graphql .= sprintf($template, ++$i, $url[1], $url[2]);
$aliases['_'.$i] = [$package, $url[0]];
}
}

$failures = [];
$repos = $this->callGitHub($rfs, sprintf("query{\n%s}", $graphql), $failures);
$repos = $gitHub->getRepositories($failures);

$template = '%1$s: addStar(input:{clientMutationId:"%s",starrableId:"%s"}){clientMutationId}'."\n";
$graphql = '';
Expand All @@ -189,76 +65,29 @@ protected function execute(InputInterface $input, OutputInterface $output)
$output->writeln('You already starred all your GitHub dependencies.');
} else {
if (!$input->getOption('dry-run')) {
$notStarred = $this->callGitHub($rfs, sprintf("mutation{\n%s}", $graphql));
$notStarred = $gitHub->call(sprintf("mutation{\n%s}", $graphql));
}

$output->writeln('Stars <comment>sent</> to:');
foreach ($repos as $alias => $repo) {
$output->writeln(sprintf(' %s %s - %s', $this->star, sprintf(isset($notStarred[$alias]) ? '<comment>%s</>' : '%s', $aliases[$alias][0]), $aliases[$alias][1]));
$output->writeln(sprintf(' %s %s - %s', $this->star, sprintf(isset($notStarred[$alias]) ? '<comment>%s</>' : '%s', $repo['package']), $repo['url']));
}
}

if ($failures) {
$output->writeln('');
$output->writeln('Some repositories could not be starred, please run <info>composer update</info> and try again:');

foreach ($failures as $alias => $message) {
$output->writeln(sprintf(' * %s - %s', $aliases[$alias][1], $message));
foreach ($failures as $alias => $failure) {
foreach ($failure['messages'] as $message) {
$output->writeln(sprintf(' * %s - %s', $failure['url'], $message));
}
}
}

$output->writeln(sprintf("\nThanks to you! %s", $this->love));
$output->writeln("Please consider contributing back in any way if you can!");
$output->writeln('Please consider contributing back in any way if you can!');

return 0;
}

private function callGitHub(RemoteFilesystem $rfs, $graphql, &$failures = [])
{
if ($eventDispatcher = $this->getComposer()->getEventDispatcher()) {
$preFileDownloadEvent = new PreFileDownloadEvent(PluginEvents::PRE_FILE_DOWNLOAD, $rfs, 'https://api.github.com/graphql');
$eventDispatcher->dispatch($preFileDownloadEvent->getName(), $preFileDownloadEvent);
if (!$preFileDownloadEvent->getRemoteFilesystem() instanceof CurlRemoteFilesystem) {
$rfs = $preFileDownloadEvent->getRemoteFilesystem();
}
}

$result = $rfs->getContents('github.com', 'https://api.github.com/graphql', false, [
'http' => [
'method' => 'POST',
'content' => json_encode(['query' => $graphql]),
'header' => ['Content-Type: application/json'],
],
]);
$result = json_decode($result, true);

if (isset($result['errors'][0]['message'])) {
if (!$result['data']) {
throw new TransportException($result['errors'][0]['message']);
}

foreach ($result['errors'] as $error) {
foreach ($error['path'] as $path) {
$failures += [$path => $error['message']];
unset($result['data'][$path]);
}
}
}

return $result['data'];
}

private function getDirectlyRequiredPackageNames()
{
$file = new JsonFile(Factory::getComposerFile(), null, $this->getIO());

if (!$file->exists()) {
throw new \Exception('Could not find your composer.json file!');
}

$data = $file->read() + ['require' => [], 'require-dev' => []];
$data = array_keys($data['require'] + $data['require-dev']);

return array_combine($data, $data);
}
}

0 comments on commit 9474a63

Please sign in to comment.