Files
Testing/tbb/wp-content/plugins/wp-rss-aggregator/src/Data/ChangelogDataSet.php
sean 0e8a8b3028
Some checks failed
deploy-testing / deploy (push) Has been cancelled
Initial testing snapshot
2026-11-17 16:15:01 -05:00

190 lines
3.7 KiB
PHP

<?php
namespace RebelCode\Wpra\Core\Data;
use ArrayIterator;
use RebelCode\Wpra\Core\Util\IteratorDelegateTrait;
use RuntimeException;
/**
* A data set for changelog files that adhere to the {@link http://keepachangelog.com Keep a Changelog} standard.
*
* @since 4.13
*/
class ChangelogDataSet implements DataSetInterface
{
/* @since 4.13 */
use IteratorDelegateTrait;
/**
* The path to the changelog file.
*
* @since 4.13
*
* @var string
*/
protected $file;
/**
* The parsed changelog data.
*
* @since 4.13
*
* @var array
*/
protected $parsed;
/**
* Constructor.
*
* @since 4.13
*
* @param string $file The path to the changelog file.
*/
public function __construct($file)
{
$this->file = $file;
$this->parsed = null;
}
/**
* Checks if the changelog needs to be parsed and if so, it is parsed.
*
* @since 4.13
*/
protected function init()
{
if ($this->parsed === null) {
$this->parse();
}
}
/**
* Parses the changelog file.
*
* @since 4.13
*/
protected function parse()
{
$handle = fopen($this->file, 'r');
$this->parsed = [];
$currHeading = 0;
$version = '';
do {
$buffer = fgets($handle);
if ($buffer === false) {
break;
}
// If a level-2 heading
if (strpos($buffer, '## ', 0) === 0) {
$currHeading = 2;
preg_match('/##\s\[([^\]]+)\]\s+-\s+(.*)/', $buffer, $matches);
if (isset($matches[1])) {
$version = trim($matches[1]);
$date = isset($matches[2]) ? trim($matches[2]) : '';
$this->parsed[$version] = [
'date' => $date,
'lines' => [],
'raw' => '',
];
}
continue;
}
if ($currHeading === 2) {
$this->parsed[$version]['lines'][] = $buffer;
$this->parsed[$version]['raw'] .= $buffer;
}
} while (true);
fclose($handle);
}
/**
* {@inheritdoc}
*
* @since 4.13
*/
public function offsetGet($offset)
{
$this->init();
if (isset($this->parsed[$offset])) {
return $this->parsed[$offset];
}
throw new RuntimeException(sprintf(__('No changelog entry found for version %s', 'wprss'), $offset));
}
/**
* {@inheritdoc}
*
* @since 4.13
*/
public function offsetExists($offset)
{
$this->init();
return isset($this->parsed[$offset]);
}
/**
* {@inheritdoc}
*
* @since 4.13
*/
public function offsetSet($offset, $value)
{
$this->init();
$this->parsed[$offset] = $value;
}
/**
* {@inheritdoc}
*
* @since 4.13
*/
public function offsetUnset($offset)
{
$this->init();
unset($this->parsed[$offset]);
}
/**
* {@inheritdoc}
*
* @since 4.13
*/
protected function getIterator()
{
$this->init();
return new ArrayIterator($this->parsed);
}
/**
* {@inheritdoc}
*
* @since 4.13
*/
public function __toString()
{
$this->init();
$string = '';
foreach ($this as $version => $info) {
$string .= sprintf('## %s (%s)', $version, $info['date']) . PHP_EOL . $info['raw'] . PHP_EOL;
}
return $string;
}
}