TEC_Changelog_Formatter::parse( string $changelog )

Modified version of parse() from KeepAChangelogParser.


Parameters

$changelog

(string) (Required) Changelog contents.


Top ↑

Return

(AutomatticJetpackChangelogChangelog)


Top ↑

Source

File: bin/class-tec-changelog-formatter.php

	public function parse( $changelog ) {
		$ret = new Changelog();

		// Fix newlines and expand tabs.
		$changelog = strtr( $changelog, [ "\r\n" => "\n" ] );
		$changelog = strtr( $changelog, [ "\r" => "\n" ] );
		while ( strpos( $changelog, "\t" ) !== false ) {
			$changelog = preg_replace_callback(
				'/^([^\t\n]*)\t/m',
				function ( $m ) {
					return $m[1] . str_repeat( ' ', 4 - ( mb_strlen( $m[1] ) % 4 ) );
				},
				$changelog
			);
		}

		// Remove title. Check if the first line containing the defined title, and remove it.
		$changelog_parts = explode( "\n", $changelog, 2 );
		$first_line      = $changelog_parts[0] ?? '';
		$remaining       = $changelog_parts[1] ?? '';

		if ( false !== strpos( $first_line, $this->title ) ) {
			$changelog = $remaining;
		}

		// Entries make up the rest of the document.
		$entries = [];
		preg_match_all( '/^###\s+\[([^\n=]+)\]\s+([^\n=]+)([\s\S]*?)(?=^###\s+|\z)/m', $changelog, $version_sections );

		foreach ( $version_sections[0] as $section ) {
			$heading_pattern = '/^### +\[([^\] ]+)\] (.+)/';
			// Parse the heading and create a ChangelogEntry for it.
			preg_match( $heading_pattern, $section, $heading );
			if ( ! count( $heading ) ) {
				throw new InvalidArgumentException( "Invalid heading: $heading" );
			}

			$version   = $heading[1];
			$timestamp = $heading[2];
			if ( $timestamp === $this->get_unreleased_date() ) {
				$timestamp       = null;
				$entry_timestamp = new DateTime( 'now', new DateTimeZone( 'UTC' ) );
			} else {
				try {
					$timestamp = new DateTime( $timestamp, new DateTimeZone( 'UTC' ) );
				} catch ( \Exception $ex ) {
					throw new InvalidArgumentException( "Heading has an invalid timestamp: $heading", 0, $ex );
				}
				if ( strtotime( $heading[2], 0 ) !== strtotime( $heading[2], 1000000000 ) ) {
					throw new InvalidArgumentException( "Heading has a relative timestamp: $heading" );
				}
				$entry_timestamp = $timestamp;
			}

			$entry = $this->newChangelogEntry(
				$version,
				[
					'timestamp' => $timestamp,
				]
			);

			$entries[] = $entry;
			$content   = trim( preg_replace( $heading_pattern, '', $section ) );

			if ( '' === $content ) {
				// Huh, no changes.
				continue;
			}

			// Now parse all the subheadings and changes.
			while ( '' !== $content ) {
				$changes = [];
				$rows    = explode( "\n", $content );
				foreach ( $rows as $row ) {
					$is_entry = substr( $row, 0, 1 ) === $this->bullet;

					// It's a multi line entry - add them to previous as content unformatted.
					if ( ! $is_entry ) {
						$changes[ count( $changes ) - 1 ]['content'] .= "\n" . $row;
						continue;
					}

					$row = trim( $row );
					$row = preg_replace( '/\\' . $this->bullet . '/', '', $row, 1 );

					$row_segments = explode( $this->separator, $row, 2 );

					if ( count( $row_segments ) !== 2 ) {
						// Current row (change entry) does not have correct format.
						// It usually happens before migrating to Jetpack Changelogger.
						throw new Exception( 'Change entry does not have the correct format. Please update it manually and run this command again. Change entry: ' . $row );
					}

					array_push(
						$changes,
						[
							'subheading' => trim( $row_segments[0] ),
							'content'    => trim( $row_segments[1] ),
						]
					);
				}

				foreach ( $changes as $change ) {
					$entry->appendChange(
						$this->newChangeEntry(
							[
								'subheading' => $change['subheading'],
								'content'    => $change['content'],
								'timestamp'  => $entry_timestamp,
							]
						)
					);
				}
				$content = '';
			}
		}

		$ret->setEntries( $entries );

		return $ret;
	}