Skip to content

Lock copied files to prevent removing files needed by other recipes #451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 21, 2019
Merged

Lock copied files to prevent removing files needed by other recipes #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/Configurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,22 +44,22 @@ public function __construct(Composer $composer, IOInterface $io, Options $option
];
}

public function install(Recipe $recipe, array $options = [])
public function install(Recipe $recipe, Lock $lock, array $options = [])
{
$manifest = $recipe->getManifest();
foreach (array_keys($this->configurators) as $key) {
if (isset($manifest[$key])) {
$this->get($key)->configure($recipe, $manifest[$key], $options);
$this->get($key)->configure($recipe, $manifest[$key], $lock, $options);
}
}
}

public function unconfigure(Recipe $recipe)
public function unconfigure(Recipe $recipe, Lock $lock)
{
$manifest = $recipe->getManifest();
foreach (array_keys($this->configurators) as $key) {
if (isset($manifest[$key])) {
$this->get($key)->unconfigure($recipe, $manifest[$key]);
$this->get($key)->unconfigure($recipe, $manifest[$key], $lock);
}
}
}
Expand Down
5 changes: 3 additions & 2 deletions src/Configurator/AbstractConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

use Composer\Composer;
use Composer\IO\IOInterface;
use Symfony\Flex\Lock;
use Symfony\Flex\Options;
use Symfony\Flex\Path;
use Symfony\Flex\Recipe;
Expand All @@ -35,9 +36,9 @@ public function __construct(Composer $composer, IOInterface $io, Options $option
$this->path = new Path($options->get('root-dir'));
}

abstract public function configure(Recipe $recipe, $config, array $options = []);
abstract public function configure(Recipe $recipe, $config, Lock $lock, array $options = []);

abstract public function unconfigure(Recipe $recipe, $config);
abstract public function unconfigure(Recipe $recipe, $config, Lock $lock);

protected function write($messages)
{
Expand Down
5 changes: 3 additions & 2 deletions src/Configurator/BundlesConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@

namespace Symfony\Flex\Configurator;

use Symfony\Flex\Lock;
use Symfony\Flex\Recipe;

/**
* @author Fabien Potencier <[email protected]>
*/
class BundlesConfigurator extends AbstractConfigurator
{
public function configure(Recipe $recipe, $bundles, array $options = [])
public function configure(Recipe $recipe, $bundles, Lock $lock, array $options = [])
{
$this->write('Enabling the package as a Symfony bundle');
$file = $this->getConfFile();
Expand All @@ -38,7 +39,7 @@ public function configure(Recipe $recipe, $bundles, array $options = [])
$this->dump($file, $registered);
}

public function unconfigure(Recipe $recipe, $bundles)
public function unconfigure(Recipe $recipe, $bundles, Lock $lock)
{
$this->write('Disabling the Symfony bundle');
$file = $this->getConfFile();
Expand Down
5 changes: 3 additions & 2 deletions src/Configurator/ComposerScriptsConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@
use Composer\Factory;
use Composer\Json\JsonFile;
use Composer\Json\JsonManipulator;
use Symfony\Flex\Lock;
use Symfony\Flex\Recipe;

/**
* @author Fabien Potencier <[email protected]>
*/
class ComposerScriptsConfigurator extends AbstractConfigurator
{
public function configure(Recipe $recipe, $scripts, array $options = [])
public function configure(Recipe $recipe, $scripts, Lock $lock, array $options = [])
{
$json = new JsonFile(Factory::getComposerFile());

Expand All @@ -35,7 +36,7 @@ public function configure(Recipe $recipe, $scripts, array $options = [])
file_put_contents($json->getPath(), $manipulator->getContents());
}

public function unconfigure(Recipe $recipe, $scripts)
public function unconfigure(Recipe $recipe, $scripts, Lock $lock)
{
$json = new JsonFile(Factory::getComposerFile());

Expand Down
5 changes: 3 additions & 2 deletions src/Configurator/ContainerConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,21 @@

namespace Symfony\Flex\Configurator;

use Symfony\Flex\Lock;
use Symfony\Flex\Recipe;

/**
* @author Fabien Potencier <[email protected]>
*/
class ContainerConfigurator extends AbstractConfigurator
{
public function configure(Recipe $recipe, $parameters, array $options = [])
public function configure(Recipe $recipe, $parameters, Lock $lock, array $options = [])
{
$this->write('Setting parameters');
$this->addParameters($parameters);
}

public function unconfigure(Recipe $recipe, $parameters)
public function unconfigure(Recipe $recipe, $parameters, Lock $lock)
{
$this->write('Unsetting parameters');
$target = $this->options->get('root-dir').'/'.$this->options->expandTargetDir('%CONFIG_DIR%/services.yaml');
Expand Down
23 changes: 14 additions & 9 deletions src/Configurator/CopyFromPackageConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,41 +12,45 @@
namespace Symfony\Flex\Configurator;

use LogicException;
use Symfony\Flex\Lock;
use Symfony\Flex\Recipe;

/**
* @author Fabien Potencier <[email protected]>
*/
class CopyFromPackageConfigurator extends AbstractConfigurator
{
public function configure(Recipe $recipe, $config, array $options = [])
public function configure(Recipe $recipe, $config, Lock $lock, array $options = [])
{
$this->write('Setting configuration and copying files');
$packageDir = $this->composer->getInstallationManager()->getInstallPath($recipe->getPackage());
$this->copyFiles($config, $packageDir, $this->options->get('root-dir'), $options['force'] ?? false);
$options = array_merge($this->options->toArray(), $options);

$this->copyFiles($config, $packageDir, $options);
}

public function unconfigure(Recipe $recipe, $config)
public function unconfigure(Recipe $recipe, $config, Lock $lock)
{
$this->write('Removing configuration and files');
$packageDir = $this->composer->getInstallationManager()->getInstallPath($recipe->getPackage());
$this->removeFiles($config, $packageDir, $this->options->get('root-dir'));
}

private function copyFiles(array $manifest, string $from, string $to, bool $overwrite = false)
private function copyFiles(array $manifest, string $from, array $options)
{
$to = $options['root-dir'] ?? '.';
foreach ($manifest as $source => $target) {
$target = $this->options->expandTargetDir($target);
if ('/' === substr($source, -1)) {
$this->copyDir($this->path->concatenate([$from, $source]), $this->path->concatenate([$to, $target]), $overwrite);
$this->copyDir($this->path->concatenate([$from, $source]), $this->path->concatenate([$to, $target]), $options);
} else {
$targetPath = $this->path->concatenate([$to, $target]);
if (!is_dir(\dirname($targetPath))) {
mkdir(\dirname($targetPath), 0777, true);
$this->write(sprintf('Created <fg=green>"%s"</>', $this->path->relativize(\dirname($targetPath))));
}

$this->copyFile($this->path->concatenate([$from, $source]), $targetPath, $overwrite);
$this->copyFile($this->path->concatenate([$from, $source]), $targetPath, $options);
}
}
}
Expand All @@ -67,7 +71,7 @@ private function removeFiles(array $manifest, string $from, string $to)
}
}

private function copyDir(string $source, string $target, bool $overwrite)
private function copyDir(string $source, string $target, array $options)
{
if (!is_dir($target)) {
mkdir($target, 0777, true);
Expand All @@ -82,13 +86,14 @@ private function copyDir(string $source, string $target, bool $overwrite)
$this->write(sprintf('Created <fg=green>"%s"</>', $this->path->relativize($targetPath)));
}
} elseif (!file_exists($targetPath)) {
$this->copyFile($item, $targetPath, $overwrite);
$this->copyFile($item, $targetPath, $options);
}
}
}

public function copyFile(string $source, string $target, bool $overwrite = false)
public function copyFile(string $source, string $target, array $options)
{
$overwrite = $options['force'] ?? false;
if (!$this->options->shouldWriteFile($target, $overwrite)) {
return;
}
Expand Down
64 changes: 53 additions & 11 deletions src/Configurator/CopyFromRecipeConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,51 +11,91 @@

namespace Symfony\Flex\Configurator;

use Symfony\Flex\Lock;
use Symfony\Flex\Recipe;

/**
* @author Fabien Potencier <[email protected]>
*/
class CopyFromRecipeConfigurator extends AbstractConfigurator
{
public function configure(Recipe $recipe, $config, array $options = [])
public function configure(Recipe $recipe, $config, Lock $lock, array $options = [])
{
$this->write('Setting configuration and copying files');
$this->copyFiles($config, $recipe->getFiles(), $this->options->get('root-dir'), $options['force'] ?? false);
$options = array_merge($this->options->toArray(), $options);

$lock->add($recipe->getName(), ['files' => $this->copyFiles($config, $recipe->getFiles(), $options)]);
}

public function unconfigure(Recipe $recipe, $config)
public function unconfigure(Recipe $recipe, $config, Lock $lock)
{
$this->write('Removing configuration and files');
$this->removeFiles($config, $recipe->getFiles(), $this->options->get('root-dir'));
$this->removeFiles($config, $this->getRemovableFilesFromRecipeAndLock($recipe, $lock), $this->options->get('root-dir'));
}

private function getRemovableFilesFromRecipeAndLock(Recipe $recipe, Lock $lock): array
{
$lockedFiles = array_unique(
array_reduce(
array_column($lock->all(), 'files'),
function (array $carry, array $package) {
return array_merge($carry, $package);
},
[]
)
);

$removableFiles = $recipe->getFiles();
foreach ($lockedFiles as $file) {
if (isset($removableFiles[$file])) {
unset($removableFiles[$file]);
}
}

return $removableFiles;
}

private function copyFiles(array $manifest, array $files, string $to, bool $overwrite = false)
private function copyFiles(array $manifest, array $files, array $options): array
{
$copiedFiles = [];
$to = $options['root-dir'] ?? '.';

foreach ($manifest as $source => $target) {
$target = $this->options->expandTargetDir($target);
if ('/' === substr($source, -1)) {
$this->copyDir($source, $this->path->concatenate([$to, $target]), $files, $overwrite);
$copiedFiles = array_merge(
$copiedFiles,
$this->copyDir($source, $this->path->concatenate([$to, $target]), $files, $options)
);
} else {
$this->copyFile($this->path->concatenate([$to, $target]), $files[$source]['contents'], $files[$source]['executable'], $overwrite);
$copiedFiles[] = $this->copyFile($this->path->concatenate([$to, $target]), $files[$source]['contents'], $files[$source]['executable'], $options);
}
}

return $copiedFiles;
}

private function copyDir(string $source, string $target, array $files, bool $overwrite = false)
private function copyDir(string $source, string $target, array $files, array $options): array
{
$copiedFiles = [];
foreach ($files as $file => $data) {
if (0 === strpos($file, $source)) {
$file = $this->path->concatenate([$target, substr($file, \strlen($source))]);
$this->copyFile($file, $data['contents'], $data['executable'], $overwrite);
$copiedFiles[] = $this->copyFile($file, $data['contents'], $data['executable'], $options);
}
}

return $copiedFiles;
}

private function copyFile(string $to, string $contents, bool $executable, bool $overwrite = false)
private function copyFile(string $to, string $contents, bool $executable, array $options): string
{
$overwrite = $options['force'] ?? false;
$basePath = $options['root-dir'] ?? '.';
$copiedFile = str_replace($basePath.\DIRECTORY_SEPARATOR, '', $to);

if (!$this->options->shouldWriteFile($to, $overwrite)) {
return;
return $copiedFile;
}

if (!is_dir(\dirname($to))) {
Expand All @@ -68,6 +108,8 @@ private function copyFile(string $to, string $contents, bool $executable, bool $
}

$this->write(sprintf('Created <fg=green>"%s"</>', $this->path->relativize($to)));

return $copiedFile;
}

private function removeFiles(array $manifest, array $files, string $to)
Expand Down
5 changes: 3 additions & 2 deletions src/Configurator/EnvConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@

namespace Symfony\Flex\Configurator;

use Symfony\Flex\Lock;
use Symfony\Flex\Recipe;

/**
* @author Fabien Potencier <[email protected]>
*/
class EnvConfigurator extends AbstractConfigurator
{
public function configure(Recipe $recipe, $vars, array $options = [])
public function configure(Recipe $recipe, $vars, Lock $lock, array $options = [])
{
$this->write('Added environment variable defaults');

Expand All @@ -28,7 +29,7 @@ public function configure(Recipe $recipe, $vars, array $options = [])
}
}

public function unconfigure(Recipe $recipe, $vars)
public function unconfigure(Recipe $recipe, $vars, Lock $lock)
{
$this->unconfigureEnvFiles($recipe, $vars);
$this->unconfigurePhpUnit($recipe, $vars);
Expand Down
5 changes: 3 additions & 2 deletions src/Configurator/GitignoreConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@

namespace Symfony\Flex\Configurator;

use Symfony\Flex\Lock;
use Symfony\Flex\Recipe;

/**
* @author Fabien Potencier <[email protected]>
*/
class GitignoreConfigurator extends AbstractConfigurator
{
public function configure(Recipe $recipe, $vars, array $options = [])
public function configure(Recipe $recipe, $vars, Lock $lock, array $options = [])
{
$this->write('Added entries to .gitignore');

Expand All @@ -39,7 +40,7 @@ public function configure(Recipe $recipe, $vars, array $options = [])
}
}

public function unconfigure(Recipe $recipe, $vars)
public function unconfigure(Recipe $recipe, $vars, Lock $lock)
{
$file = $this->options->get('root-dir').'/.gitignore';
if (!file_exists($file)) {
Expand Down
5 changes: 3 additions & 2 deletions src/Configurator/MakefileConfigurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@

namespace Symfony\Flex\Configurator;

use Symfony\Flex\Lock;
use Symfony\Flex\Recipe;

/**
* @author Fabien Potencier <[email protected]>
*/
class MakefileConfigurator extends AbstractConfigurator
{
public function configure(Recipe $recipe, $definitions, array $options = [])
public function configure(Recipe $recipe, $definitions, Lock $lock, array $options = [])
{
$this->write('Added Makefile entries');

Expand Down Expand Up @@ -53,7 +54,7 @@ public function configure(Recipe $recipe, $definitions, array $options = [])
}
}

public function unconfigure(Recipe $recipe, $vars)
public function unconfigure(Recipe $recipe, $vars, Lock $lock)
{
if (!file_exists($makefile = $this->options->get('root-dir').'/Makefile')) {
return;
Expand Down
Loading