Skip to content

Commit

Permalink
Add Guide, tweak class
Browse files Browse the repository at this point in the history
  • Loading branch information
@MGatner
MGatner committed Jun 8, 2021
1 parent 865c73a commit 3987bff
Show file tree
Hide file tree
Showing 5 changed files with 598 additions and 32 deletions.
95 changes: 70 additions & 25 deletions system/Publisher/Publisher.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use CodeIgniter\Files\File;
use CodeIgniter\HTTP\URI;
use CodeIgniter\Publisher\Exceptions\PublisherException;
use RuntimeException;
use Throwable;

/**
Expand Down Expand Up @@ -64,6 +65,13 @@ class Publisher
*/
private $errors = [];

/**
* List of file published curing the last write operation.
*
* @var string[]
*/
private $published = [];

/**
* Base path to use for the source.
*
Expand All @@ -85,7 +93,7 @@ class Publisher
*
* @return self[]
*/
public static function discover(string $directory = 'Publishers'): array
final public static function discover(string $directory = 'Publishers'): array
{
if (isset(self::$discovered[$directory]))
{
Expand Down Expand Up @@ -301,25 +309,50 @@ public function __destruct()
}

/**
* Reads files in the sources and copies them out to their destinations.
* Reads files from the sources and copies them out to their destinations.
* This method should be reimplemented by child classes intended for
* discovery.
*
* @return boolean
*/
public function publish(): bool
{
if ($this->source === ROOTPATH && $this->destination === FCPATH)
{
throw new RuntimeException('Child classes of Publisher should provide their own source and destination or publish method.');
}

return $this->addPath('/')->merge(true);
}

//--------------------------------------------------------------------

/**
* Returns the source directory.
*
* @return string
*/
final public function getSource(): string
{
return $this->source;
}

/**
* Returns the destination directory.
*
* @return string
*/
final public function getDestination(): string
{
return $this->destination;
}

/**
* Returns the temporary workspace, creating it if necessary.
*
* @return string
*/
protected function getScratch(): string
final public function getScratch(): string
{
if (is_null($this->scratch))
{
Expand All @@ -335,24 +368,36 @@ protected function getScratch(): string
*
* @return array<string,Throwable>
*/
public function getErrors(): array
final public function getErrors(): array
{
return $this->errors;
}

/**
* Returns the files published by the last write operation.
*
* @return string[]
*/
final public function getPublished(): array
{
return $this->published;
}

/**
* Optimizes and returns the current file list.
*
* @return string[]
*/
public function getFiles(): array
final public function getFiles(): array
{
$this->files = array_unique($this->files, SORT_STRING);
sort($this->files, SORT_STRING);

return $this->files;
}

//--------------------------------------------------------------------

/**
* Sets the file list directly, files are still subject to verification.
* This works as a "reset" method with [].
Expand All @@ -361,23 +406,21 @@ public function getFiles(): array
*
* @return $this
*/
public function setFiles(array $files)
final public function setFiles(array $files)
{
$this->files = [];

return $this->addFiles($files);
}

//--------------------------------------------------------------------

/**
* Verifies and adds files to the list.
*
* @param string[] $files
*
* @return $this
*/
public function addFiles(array $files)
final public function addFiles(array $files)
{
foreach ($files as $file)
{
Expand All @@ -394,7 +437,7 @@ public function addFiles(array $files)
*
* @return $this
*/
public function addFile(string $file)
final public function addFile(string $file)
{
$this->files[] = self::resolveFile($file);

Expand All @@ -408,7 +451,7 @@ public function addFile(string $file)
*
* @return $this
*/
public function removeFiles(array $files)
final public function removeFiles(array $files)
{
$this->files = array_diff($this->files, $files);

Expand All @@ -422,7 +465,7 @@ public function removeFiles(array $files)
*
* @return $this
*/
public function removeFile(string $file)
final public function removeFile(string $file)
{
return $this->removeFiles([$file]);
}
Expand All @@ -438,7 +481,7 @@ public function removeFile(string $file)
*
* @return $this
*/
public function addDirectories(array $directories, bool $recursive = false)
final public function addDirectories(array $directories, bool $recursive = false)
{
foreach ($directories as $directory)
{
Expand All @@ -456,7 +499,7 @@ public function addDirectories(array $directories, bool $recursive = false)
*
* @return $this
*/
public function addDirectory(string $directory, bool $recursive = false)
final public function addDirectory(string $directory, bool $recursive = false)
{
$directory = self::resolveDirectory($directory);

Expand Down Expand Up @@ -486,7 +529,7 @@ public function addDirectory(string $directory, bool $recursive = false)
*
* @return $this
*/
public function addPaths(array $paths, bool $recursive = true)
final public function addPaths(array $paths, bool $recursive = true)
{
foreach ($paths as $path)
{
Expand All @@ -504,7 +547,7 @@ public function addPaths(array $paths, bool $recursive = true)
*
* @return $this
*/
public function addPath(string $path, bool $recursive = true)
final public function addPath(string $path, bool $recursive = true)
{
$full = $this->source . $path;

Expand All @@ -530,7 +573,7 @@ public function addPath(string $path, bool $recursive = true)
*
* @return $this
*/
public function addUris(array $uris)
final public function addUris(array $uris)
{
foreach ($uris as $uri)
{
Expand All @@ -547,7 +590,7 @@ public function addUris(array $uris)
*
* @return $this
*/
public function addUri(string $uri)
final public function addUri(string $uri)
{
// Figure out a good filename (using URI strips queries and fragments)
$file = $this->getScratch() . basename((new URI($uri))->getPath());
Expand All @@ -569,7 +612,7 @@ public function addUri(string $uri)
*
* @return $this
*/
public function removePattern(string $pattern, string $scope = null)
final public function removePattern(string $pattern, string $scope = null)
{
if ($pattern === '')
{
Expand All @@ -592,7 +635,7 @@ public function removePattern(string $pattern, string $scope = null)
*
* @return $this
*/
public function retainPattern(string $pattern, string $scope = null)
final public function retainPattern(string $pattern, string $scope = null)
{
if ($pattern === '')
{
Expand All @@ -613,7 +656,7 @@ public function retainPattern(string $pattern, string $scope = null)
*
* @return $this
*/
public function wipe()
final public function wipe()
{
self::wipeDirectory($this->destination);

Expand All @@ -629,9 +672,9 @@ public function wipe()
*
* @return boolean Whether all files were copied successfully
*/
public function copy(bool $replace = true): bool
final public function copy(bool $replace = true): bool
{
$this->errors = [];
$this->errors = $this->published = [];

foreach ($this->getFiles() as $file)
{
Expand All @@ -640,6 +683,7 @@ public function copy(bool $replace = true): bool
try
{
self::safeCopyFile($file, $to, $replace);
$this->published[] = $to;
}
catch (Throwable $e)
{
Expand All @@ -658,9 +702,9 @@ public function copy(bool $replace = true): bool
*
* @return boolean Whether all files were copied successfully
*/
public function merge(bool $replace = true): bool
final public function merge(bool $replace = true): bool
{
$this->errors = [];
$this->errors = $this->published = [];

// Get the file from source for special handling
$sourced = self::filterFiles($this->getFiles(), $this->source);
Expand All @@ -678,6 +722,7 @@ public function merge(bool $replace = true): bool
try
{
self::safeCopyFile($file, $to, $replace);
$this->published[] = $to;
}
catch (Throwable $e)
{
Expand Down
55 changes: 52 additions & 3 deletions tests/_support/Publishers/TestPublisher.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,62 @@

use CodeIgniter\Publisher\Publisher;

class TestPublisher extends Publisher
final class TestPublisher extends Publisher
{
/**
* Runs the defined Operations.
* Fakes an error on the given file.
*
* @return $this
*/
public static function setError(string $file)
{
self::$error = $file;
}

/**
* A file to cause an error
*
* @var string
*/
private static $error = '';

/**
* Base path to use for the source.
*
* @var string
*/
protected $source = SUPPORTPATH . 'Files';

/**
* Base path to use for the destination.
*
* @var string
*/
protected $destination = WRITEPATH;

/**
* Fakes a publish event so no files are actually copied.
*/
public function publish(): bool
{
$this->downloadFromUrls($urls)->mergeToDirectory(FCPATH . 'assets');
$this->errors = $this->published = [];

$this->addPath('');

// Copy each sourced file to its relative destination
foreach ($this->getFiles() as $file)
{
if ($file === self::$error)
{
$this->errors[$file] = new RuntimeException('Have an error, dear.');
}
else
{
// Resolve the destination path
$this->published[] = $this->destination . substr($file, strlen($this->source));
}
}

return $this->errors === [];
}
}
Loading

0 comments on commit 3987bff

Please sign in to comment.