array $options change to object $context

contributte · Jul 20, 2021 · e2fe507 · e2fe507
1 parent c5f42cc
commit e2fe507
Show file tree

Hide file tree

Showing 30 changed files with 107 additions and 70 deletions.
diff --git a/src/Bridge/Imagine/Config/ImagineConfigFilterRegistry.php b/src/Bridge/Imagine/Config/ImagineConfigFilterRegistry.php
@@ -4,9 +4,9 @@
 
 use Contributte\Imagist\Bridge\Imagine\OperationInterface;
 use Contributte\Imagist\Config\ConfigFilterStack;
+use Contributte\Imagist\Context\ContextImageAware;
 use Contributte\Imagist\Exceptions\UnexpectedErrorException;
 use Contributte\Imagist\Filter\FilterInterface;
-use Contributte\Imagist\Scope\Scope;
 use Imagine\Image\ImageInterface;
 use InvalidArgumentException;
 
@@ -29,12 +29,16 @@ public function addOperation(ImagineConfigOperationInterface $operation): void
 		$this->operations[$operation->getName()] = $operation;
 	}
 
-	public function supports(FilterInterface $filter, Scope $scope): bool
+	public function supports(FilterInterface $filter, ContextImageAware $context): bool
 	{
 		return isset($this->configFilterStacks[$filter->getName()]);
 	}
 
-	public function operate(ImageInterface $image, FilterInterface $filter): void
+	public function operate(
+		ImageInterface $image,
+		FilterInterface $filter,
+		ContextImageAware $context
+	): void
 	{
 		if (!isset($this->configFilterStacks[$filter->getName()])) {
 			throw new UnexpectedErrorException();
@@ -47,7 +51,7 @@ public function operate(ImageInterface $image, FilterInterface $filter): void
 
 			$operation = $this->operations[$configFilter->getName()];
 
-			$operation->operate($image, $filter, $configFilter->getArguments());
+			$operation->operate($image, $filter, $context, $configFilter->getArguments());
 		}
 	}
 

diff --git a/src/Bridge/Imagine/Config/ImagineConfigOperationInterface.php b/src/Bridge/Imagine/Config/ImagineConfigOperationInterface.php
@@ -2,6 +2,7 @@
 
 namespace Contributte\Imagist\Bridge\Imagine\Config;
 
+use Contributte\Imagist\Context\ContextImageAware;
 use Contributte\Imagist\Filter\FilterInterface;
 use Imagine\Image\ImageInterface;
 
@@ -13,6 +14,11 @@ public function getName(): string;
 	/**
 	 * @param mixed[] $arguments
 	 */
-	public function operate(ImageInterface $image, FilterInterface $filter, array $arguments): void;
+	public function operate(
+		ImageInterface $image,
+		FilterInterface $filter,
+		ContextImageAware $context,
+		array $arguments
+	): void;
 
 }
diff --git a/src/Bridge/Imagine/Config/Operation/ResizeConfigOperation.php b/src/Bridge/Imagine/Config/Operation/ResizeConfigOperation.php
@@ -3,6 +3,7 @@
 namespace Contributte\Imagist\Bridge\Imagine\Config\Operation;
 
 use Contributte\Imagist\Bridge\Imagine\Config\ImagineConfigOperationInterface;
+use Contributte\Imagist\Context\ContextImageAware;
 use Contributte\Imagist\Filter\FilterInterface;
 use Imagine\Image\Box;
 use Imagine\Image\ImageInterface;
@@ -19,7 +20,7 @@ public function getName(): string
 	/**
 	 * @param mixed[] $arguments
 	 */
-	public function operate(ImageInterface $image, FilterInterface $filter, array $arguments): void
+	public function operate(ImageInterface $image, FilterInterface $filter, ContextImageAware $context, array $arguments): void
 	{
 		if (count($arguments) !== 2) {
 			throw new InvalidArgumentException('Config filter resize must have two arguments.');

diff --git a/src/Bridge/Imagine/FilterProcessor.php b/src/Bridge/Imagine/FilterProcessor.php
@@ -3,6 +3,8 @@
 namespace Contributte\Imagist\Bridge\Imagine;
 
 use Contributte\Imagist\Bridge\Imagine\Exceptions\OperationNotFoundException;
+use Contributte\Imagist\Context\Context;
+use Contributte\Imagist\Context\ContextImageAware;
 use Contributte\Imagist\File\FileInterface;
 use Contributte\Imagist\Filter\FilterProcessorInterface;
 use Imagine\Gd\Imagine as GdImagine;
@@ -42,23 +44,22 @@ protected function createImagine(): ImagineInterface
 		throw new RuntimeException('PHP extension not found, need imagick or gd or gmagick');
 	}
 
-	/**
-	 * @param mixed[] $options
-	 */
-	public function process(FileInterface $target, FileInterface $source, array $options = []): string
+	public function process(FileInterface $target, FileInterface $source, Context $context): string
 	{
 		$filter = $target->getImage()->getFilter();
 		if (!$filter) {
 			return $target->getContent();
 		}
 
-		$operation = $this->operationRegistry->get($filter, $target->getImage()->getScope());
+		$context = new ContextImageAware($target->getImage(), $context);
+
+		$operation = $this->operationRegistry->get($filter, $context);
 
 		if (!$operation) {
 			throw new OperationNotFoundException($target->getImage());
 		}
 
-		$operation->operate($image = $this->createImageInstance($source), $filter);
+		$operation->operate($image = $this->createImageInstance($source), $filter, $context);
 
 		return $image->get($source->getMimeType()->toSuffix());
 	}

diff --git a/src/Bridge/Imagine/OperationInterface.php b/src/Bridge/Imagine/OperationInterface.php
@@ -2,15 +2,19 @@
 
 namespace Contributte\Imagist\Bridge\Imagine;
 
+use Contributte\Imagist\Context\ContextImageAware;
 use Contributte\Imagist\Filter\FilterInterface;
-use Contributte\Imagist\Scope\Scope;
 use Imagine\Image\ImageInterface;
 
 interface OperationInterface
 {
 
-	public function supports(FilterInterface $filter, Scope $scope): bool;
+	public function supports(FilterInterface $filter, ContextImageAware $context): bool;
 
-	public function operate(ImageInterface $image, FilterInterface $filter): void;
+	public function operate(
+		ImageInterface $image,
+		FilterInterface $filter,
+		ContextImageAware $context
+	): void;
 
 }
diff --git a/src/Bridge/Imagine/OperationRegistry.php b/src/Bridge/Imagine/OperationRegistry.php
@@ -2,8 +2,8 @@
 
 namespace Contributte\Imagist\Bridge\Imagine;
 
+use Contributte\Imagist\Context\ContextImageAware;
 use Contributte\Imagist\Filter\FilterInterface;
-use Contributte\Imagist\Scope\Scope;
 
 final class OperationRegistry implements OperationRegistryInterface
 {
@@ -16,10 +16,10 @@ public function add(OperationInterface $operation): void
 		$this->operations[] = $operation;
 	}
 
-	public function get(FilterInterface $filter, Scope $scope): ?OperationInterface
+	public function get(FilterInterface $filter, ContextImageAware $context): ?OperationInterface
 	{
 		foreach ($this->operations as $operation) {
-			if ($operation->supports($filter, $scope)) {
+			if ($operation->supports($filter, $context)) {
 				return $operation;
 			}
 		}

diff --git a/src/Bridge/Imagine/OperationRegistryInterface.php b/src/Bridge/Imagine/OperationRegistryInterface.php
@@ -2,14 +2,14 @@
 
 namespace Contributte\Imagist\Bridge\Imagine;
 
+use Contributte\Imagist\Context\ContextImageAware;
 use Contributte\Imagist\Filter\FilterInterface;
-use Contributte\Imagist\Scope\Scope;
 
 interface OperationRegistryInterface
 {
 
 	public function add(OperationInterface $operation): void;
 
-	public function get(FilterInterface $filter, Scope $scope): ?OperationInterface;
+	public function get(FilterInterface $filter, ContextImageAware $context): ?OperationInterface;
 
 }
diff --git a/src/Bridge/Nette/Filter/NetteFilterProcessor.php b/src/Bridge/Nette/Filter/NetteFilterProcessor.php
@@ -3,6 +3,7 @@
 namespace Contributte\Imagist\Bridge\Nette\Filter;
 
 use Contributte\Imagist\Bridge\Nette\Filter\Exceptions\OperationNotFoundException;
+use Contributte\Imagist\Context\Context;
 use Contributte\Imagist\File\FileInterface;
 use Contributte\Imagist\Filter\FilterProcessorInterface;
 use Nette\Utils\Image;
@@ -17,7 +18,7 @@ public function __construct(NetteOperationRegistryInterface $operationRegistry)
 		$this->operationRegistry = $operationRegistry;
 	}
 
-	public function process(FileInterface $target, FileInterface $source, array $options = []): string
+	public function process(FileInterface $target, FileInterface $source, Context $context): string
 	{
 		$filter = $target->getImage()->getFilter();
 		if (!$filter) {

diff --git a/src/Bridge/Nette/Latte/LatteImageProvider.php b/src/Bridge/Nette/Latte/LatteImageProvider.php
@@ -23,7 +23,7 @@ public function __construct(LinkGeneratorInterface $linkGenerator)
 	 * @param mixed[] $options
 	 * @param mixed[] $filters
 	 */
-	public function link($id, array $options, array ...$filters): ?string
+	public function link($id, array $options, array $filters): ?string
 	{
 		if (is_string($id)) {
 			$image = new PersistentImage($id);
@@ -45,14 +45,13 @@ public function link($id, array $options, array ...$filters): ?string
 			throw new InvalidArgumentException('Cannot use now two or more filters.');
 		}
 
-		foreach ($filters as $options) {
-			if (count($options) === 0) {
-				throw new InvalidArgumentException('First filter does not contain filter name.');
+		foreach ($filters as $name => $opts) {
+			if (is_numeric($name)) {
+				$name = $opts;
+				$opts = [];
 			}
 
-			[$name] = array_splice($options, 0, 1);
-
-			$image = $image->withFilter($name, $options);
+			$image = $image->withFilter($name, $opts);
 		}
 
 		return $this->linkGenerator->link($image, $options);

diff --git a/src/Bridge/Nette/Macro/ImageMacro.php b/src/Bridge/Nette/Macro/ImageMacro.php
@@ -80,8 +80,7 @@ private function extractFilter(MacroNode $node, PhpWriter $writer): string
 			}, $node->modifiers);
 		} else {
 			$modifiers = array_map(
-				function (string $modifier) use ($writer): string
-				{
+				function (string $modifier) use ($writer): string {
 					if (!str_contains($modifier, ':')) {
 						return $modifier;
 					}

diff --git a/src/Database/DatabaseConverter.php b/src/Database/DatabaseConverter.php
@@ -36,7 +36,11 @@ public function convertToDatabase(?ImageInterface $image): ?string
 
 		if ($image instanceof PromisedImageInterface) {
 			if ($image->isPending()) {
-				throw new InvalidArgumentException(sprintf('Given image "%s" is still pending', PromisedImage::getSourceId($image)));
+				if ($image instanceof PromisedImage) {
+					throw new InvalidArgumentException(sprintf('Given image "%s" is still pending', PromisedImage::getSourceId($image)));
+				}
+
+				throw new InvalidArgumentException('Given image is still pending');
 			}
 
 			$image = $image->getResult();

diff --git a/src/Filter/FilterProcessorInterface.php b/src/Filter/FilterProcessorInterface.php
@@ -2,14 +2,12 @@
 
 namespace Contributte\Imagist\Filter;
 
+use Contributte\Imagist\Context\Context;
 use Contributte\Imagist\File\FileInterface;
 
 interface FilterProcessorInterface
 {
 
-	/**
-	 * @param mixed[] $options
-	 */
-	public function process(FileInterface $target, FileInterface $source, array $options = []): string;
+	public function process(FileInterface $target, FileInterface $source, Context $context): string;
 
 }
diff --git a/src/Filter/OriginalFilterProcessor.php b/src/Filter/OriginalFilterProcessor.php
@@ -2,6 +2,7 @@
 
 namespace Contributte\Imagist\Filter;
 
+use Contributte\Imagist\Context\Context;
 use Contributte\Imagist\File\FileInterface;
 
 final class OriginalFilterProcessor implements FilterProcessorInterface
@@ -10,7 +11,7 @@ final class OriginalFilterProcessor implements FilterProcessorInterface
 	/**
 	 * @inheritDoc
 	 */
-	public function process(FileInterface $target, FileInterface $source, array $options = []): string
+	public function process(FileInterface $target, FileInterface $source, Context $context): string
 	{
 		return $source->getContent();
 	}

diff --git a/src/Filter/VoidFilterProcessor.php b/src/Filter/VoidFilterProcessor.php
@@ -2,6 +2,7 @@
 
 namespace Contributte\Imagist\Filter;
 
+use Contributte\Imagist\Context\Context;
 use Contributte\Imagist\File\FileInterface;
 use LogicException;
 
@@ -11,7 +12,7 @@ final class VoidFilterProcessor implements FilterProcessorInterface
 	/**
 	 * @inheritDoc
 	 */
-	public function process(FileInterface $target, FileInterface $source, array $options = []): string
+	public function process(FileInterface $target, FileInterface $source, Context $context): string
 	{
 		if ($target->getImage()->getFilter()) {
 			throw new LogicException(sprintf('%s does not support filters', self::class));

diff --git a/src/ImageStorageInterface.php b/src/ImageStorageInterface.php
@@ -2,14 +2,15 @@
 
 namespace Contributte\Imagist;
 
+use Contributte\Imagist\Context\Context;
 use Contributte\Imagist\Entity\ImageInterface;
 use Contributte\Imagist\Entity\PersistentImageInterface;
 
 interface ImageStorageInterface
 {
 
-	public function persist(ImageInterface $image): PersistentImageInterface;
+	public function persist(ImageInterface $image, ?Context $context = null): PersistentImageInterface;
 
-	public function remove(PersistentImageInterface $image): PersistentImageInterface;
+	public function remove(PersistentImageInterface $image, ?Context $context = null): PersistentImageInterface;
 
 }
diff --git a/src/Persister/EmptyImagePersister.php b/src/Persister/EmptyImagePersister.php
@@ -2,6 +2,7 @@
 
 namespace Contributte\Imagist\Persister;
 
+use Contributte\Imagist\Context\Context;
 use Contributte\Imagist\Entity\EmptyImage;
 use Contributte\Imagist\Entity\EmptyImageInterface;
 use Contributte\Imagist\Entity\ImageInterface;
@@ -18,12 +19,12 @@ public function setStrict(bool $strict): void
 		$this->strict = $strict;
 	}
 
-	public function supports(ImageInterface $image): bool
+	public function supports(ImageInterface $image, Context $context): bool
 	{
 		return $image instanceof EmptyImageInterface;
 	}
 
-	public function persist(ImageInterface $image): PersistentImageInterface
+	public function persist(ImageInterface $image, Context $context): PersistentImageInterface
 	{
 		if ($this->strict) {
 			throw new InvalidArgumentException('Cannot persist empty image');

diff --git a/src/Persister/ImagePersisterAbstract.php b/src/Persister/ImagePersisterAbstract.php
@@ -2,6 +2,7 @@
 
 namespace Contributte\Imagist\Persister;
 
+use Contributte\Imagist\Context\Context;
 use Contributte\Imagist\Entity\ImageInterface;
 use Contributte\Imagist\File\FileFactoryInterface;
 use Contributte\Imagist\Filter\FilterProcessorInterface;
@@ -19,13 +20,13 @@ public function __construct(FileFactoryInterface $fileFactory, FilterProcessorIn
 		$this->filterProcessor = $filterProcessor;
 	}
 
-	protected function save(ImageInterface $image): void
+	protected function save(ImageInterface $image, Context $context): void
 	{
 		$target = $this->fileFactory->create($image);
 		$source = $this->fileFactory->create($image->getOriginal());
 
 		$target->setContent(
-			$this->filterProcessor->process($target, $source)
+			$this->filterProcessor->process($target, $source, $context)
 		);
 	}
 

diff --git a/src/Persister/PersistentImagePersister.php b/src/Persister/PersistentImagePersister.php
@@ -2,6 +2,7 @@
 
 namespace Contributte\Imagist\Persister;
 
+use Contributte\Imagist\Context\Context;
 use Contributte\Imagist\Entity\EmptyImageInterface;
 use Contributte\Imagist\Entity\ImageInterface;
 use Contributte\Imagist\Entity\PersistentImageInterface;
@@ -17,12 +18,12 @@ public function setStrict(bool $strict): void
 		$this->strict = $strict;
 	}
 
-	public function supports(ImageInterface $image): bool
+	public function supports(ImageInterface $image, Context $context): bool
 	{
 		return $image instanceof PersistentImageInterface && !$image instanceof EmptyImageInterface;
 	}
 
-	public function persist(ImageInterface $image): ImageInterface
+	public function persist(ImageInterface $image, Context $context): ImageInterface
 	{
 		if (!$image->getFilter()) {
 			if ($this->strict) {
@@ -32,7 +33,7 @@ public function persist(ImageInterface $image): ImageInterface
 			return $image;
 		}
 
-		$this->save($image);
+		$this->save($image, $context);
 
 		return $image;
 	}