emlynwest / changelog

src/Parser/KeepAChangeLog.php

<?php

/**

 * @category Library

 * @license MIT http://opensource.org/licenses/MIT

 * @link https://github.com/emlynwest/changelog

 */


namespace ChangeLog\Parser;


use ChangeLog\Log;

use ChangeLog\ParserInterface;

use ChangeLog\Release;

use DateTime;


/**

 * Allows change logs to be parsed from the http://keepachangelog.com format.

 */

class KeepAChangeLog implements ParserInterface

{


	/**

	 * Takes the given content and parses it into a populated Log object.

	 *

	 * @param string[] $content

	 *

	 * @return Log

	 */

	public function parse($content)

	{

		$log = new Log;

		$description = [];

		$links = [];

		$matches = [];

		$bodyEnded = false;


		$line = current($content);

		while ($line !== false)

		{

			$line = ltrim($line);


			if (preg_match('/^#(?!#).+/', $line) === 1)

			{

				$log->setTitle($this->trimHashes($line));

			}

			elseif (preg_match('/^##(?!#).+/', $line) === 1)

			{

				$release = $this->parseRelease($content);

				$log->addRelease($release);

				$bodyEnded = true;

			}

			elseif (preg_match('/^\[(.+)\]: (.+)/', $line, $matches))

			{

				if (count($matches) >= 3)

				{

					$links[$matches[1]] = $matches[2];

				}

				$bodyEnded = true;

			}

			elseif ( ! $bodyEnded)

			{

				$description[] = $line;

			}


			$line = next($content);

		}


		$log->setDescription(implode("\n", $description));


		// Assign the releases their real links

		$this->assignLinks($log, $links);


		return $log;

	}


	/**

	 * Trims off whitespace and excess hashes from the start of a string.

	 *

	 * @param string $line

	 *

	 * @return string

	 */

	public function trimHashes($line)

	{

		return ltrim($line, "\t\n\r\0\x0B# ");

	}


	/**

	 * Returns true if $haystack starts with $needle.

	 *

	 * @param $haystack

	 * @param $needle

	 *

	 * @return bool

	 */

	public function startsWith($haystack, $needle)

	{

		return (substr($haystack, 0, strlen($needle)) === $needle);

	}


	/**

	 * Builds a release.

	 *

	 * @param string[] $content

	 *

	 * @return Release

	 */

	public function parseRelease(&$content)

	{

		$release = new Release;

		$types = [];

		$lastType = '';

		$nameSet = false;


		$line = current($content);

		while ($line !== false)

		{

			$line = ltrim($line);


			if ($this->startsWith($line, '###'))

			{

				$type = $this->trimHashes($line);

				$types[$type] = [];

				$lastType = $type;

			}

			elseif ($nameSet &&

Consider adding parentheses for clarity. Current Interpretation: ($nameSet && $this->startsWith($line, '##')) || $this->startsWith($line, '['), Probably Intended Meaning: $nameSet && ($this->startsWith($line, '##') || $this->startsWith($line, '['))

				$this->startsWith($line, '##') ||

				$this->startsWith($line, '[')

			)

			{

				prev($content);

				break;

			}

			elseif ($this->startsWith($line, '##'))

			{

				$this->handleName($release, $line);

				$nameSet = true;

			}

			else

			{

				$change = ltrim($line, "\t\n\r\0\x0B -");


				if ($change !== '')

				{

					$types[$lastType][] = $change;

				}

			}


			$line = next($content);

		}


		$release->setAllChanges($types);

		return $release;

	}


	/**

	 * Pulls out the needed information from a Release title and assigns that to the

	 * given release.

	 *

	 * @param Release $release

	 * @param string  $line

	 */

	protected function handleName(Release $release, $line)

	{

		$this->setName($release, $line);

		$this->setDate($release, $line);

		$this->setLink($release, $line);

		$this->setYanked($release, $line);

	}


	/**

	 * Extracts and sets the name of the link if there is one.

	 *

	 * @param Release $release

	 * @param string  $line

	 */

	protected function setLink(Release $release, $line)

	{

		$matches = [];


		if (preg_match('/^## \[([\w\.-\.]+)\](?:\[(\w+)\])?/', $line, $matches))

		{

			if (count($matches) >= 3)

			{

				$release->setLink($matches[2]);

				$release->setLinkName($matches[2]);

			}

			else

			{

				$release->setLink($matches[1]);

			}

		}

	}


	/**

	 * Extracts and sets the yanked flag.

	 *

	 * @param Release $release

	 * @param string  $line

	 */

	protected function setYanked(Release $release, $line)

	{

		if (preg_match('/\[YANKED\]$/i', $line))

		{

			$release->setYanked(true);

		}

	}


	/**

	 * Extracts and sets the release Date.

	 *

	 * @param Release $release

	 * @param string  $line

	 */

	protected function setDate(Release $release, $line)

	{

		$matches = [];

		if (preg_match('/[0-9]{4,}-[0-9]{2,}-[0-9]{2,}/', $line, $matches))

		{

			$date = DateTime::createFromFormat('Y-m-d', $matches[0]);

			if ($date)

$date is of type DateTime, thus it always evaluated to true.

			{

				$release->setDate($date);

			}

		}

	}


	/**

	 * Extracts and sets the Release name.

	 *

	 * @param Release $release

	 * @param string  $line

	 */

	protected function setName(Release $release, $line)

	{

		$matches = [];

		if (preg_match('/([\w\.-]{1,})/', $line, $matches))

		{

			$release->setName($matches[0]);

		}

	}


	/**

	 * @param $log

	 * @param $links

	 *

	 * @since

	 */

	protected function assignLinks($log, $links)

	{

		/** @var Release $release */

		foreach ($log as $release)

		{

			$link = null;

			$linkName = $release->getLink();

			if (isset($links[$linkName]))

			{

				$link = $links[$linkName];

			}

			$release->setLink($link);

		}

	}


}