Changelog::jsonUnserialize() - Code Metrics - Inspection of "Tests for KeepAChangelogParser" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/changelog-tooling ( fa9ac3...7f5585 )

unknown

created 2021-02-18 20:43 UTC

Changelog::jsonUnserialize() B

↳ Parent: Changelog

Complexity

Conditions	7
Paths	10

Size

Total Lines

Duplication

Lines	3
Ratio	13.64 %

Importance

Changes

Metric	Value
cc	7
nc	10
nop	1
dl	3
loc	22
rs	8.6346
c	0
b	0
f	0

<?php // phpcs:ignore WordPress.Files.FileName.NotHyphenatedLowercase
/**
 * Class representing a changelog.
 *
 * @package automattic/jetpack-changelogger
 */

// phpcs:disable WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid

namespace Automattic\Jetpack\Changelog;

use InvalidArgumentException;
use JsonSerializable;

/**
 * Class representing a changelog.
 */
class Changelog implements JsonSerializable {

	/**
	 * Content before the changelog itself.
	 *
	 * @var string
	 */
	protected $prologue = '';

	/**
	 * Content after the changelog itself.
	 *
	 * @var string
	 */
	protected $epilogue = '';

	/**
	 * Changelog entries, one per version.
	 *
	 * @var ChangelogEntry[]
	 */
	protected $entries = array();

	/**
	 * Get the prologue content.
	 *
	 * @return string
	 */
	public function getPrologue() {
		return $this->prologue;
	}

	/**
	 * Set the prologue content.
	 *
	 * @param string $prologue Prologue content to set.
	 * @return $this
	 */
	public function setPrologue( $prologue ) {
		$this->prologue = (string) $prologue;
		return $this;
	}

	/**
	 * Get the epilogue content.
	 *
	 * @return string
	 */
	public function getEpilogue() {
		return $this->epilogue;
	}

	/**
	 * Set the epilogue content.
	 *
	 * @param string $epilogue Epilogue content to set.
	 * @return $this
	 */
	public function setEpilogue( $epilogue ) {
		$this->epilogue = (string) $epilogue;
		return $this;
	}

	/**
	 * Get the list of changelog entries.
	 *
	 * @return ChangelogEntry[]
	 */
	public function getEntries() {
		return $this->entries;
	}

	/**
	 * Set the list of changelog entries.
	 *
	 * This replaces all existing entries.
	 *
	 * @param ChangelogEntry[] $entries Changelog entries.
	 * @return $this
	 * @throws InvalidArgumentException If an argument is invalid.
	 */
	public function setEntries( array $entries ) {
		foreach ( $entries as $i => $entry ) {
			if ( ! $entry instanceof ChangelogEntry ) {
				$what = is_object( $entry ) ? get_class( $entry ) : gettype( $entry );
				throw new InvalidArgumentException( __METHOD__ . ": Expected a ChangelogEntry, got $what at index $i" );
			}
		}
		$this->entries = array_values( $entries );
		return $this;
	}

	/**
	 * Get the latest changelog entry.
	 *
	 * @return ChangelogEntry|null
	 */
	public function getLatestEntry() {
		return isset( $this->entries[0] ) ? $this->entries[0] : null;
	}

	/**
	 * Add a new entry as the latest.
	 *
	 * @param ChangelogEntry $entry New entry.

	 * @return $this
	 */
	public function addEntry( ChangelogEntry $entry = null ) {
		array_unshift( $this->entries, $entry );
		return $this;
	}

	/**
	 * Get the list of versions in the changelog.
	 *
	 * @return string[]
	 */
	public function getVersions() {
		$ret = array();
		foreach ( $this->entries as $entry ) {
			$ret[] = $entry->getVersion();
		}
		return $ret;
	}

	/**
	 * Find an entry by version.
	 *
	 * @param string $version Version to search for.
	 * @param string $operator Operator as for `version_compare()`. Note the
	 *   passed `$version` is passed to `version_compare()` as the second
	 *   argument, and the first entry matching is returned.
	 * @return ChangelogEntry|null
	 */
	public function findEntryByVersion( $version, $operator = '==' ) {
		foreach ( $this->entries as $entry ) {
			if ( version_compare( $entry->getVersion(), $version, $operator ) ) {
				return $entry;
			}
		}
		return null;
	}

	/**
	 * Fetch all entries by a version check.
	 *
	 * @param array $constraints Version constraints. Keys are operations
	 *   recognized by `version_compare()`, values are the version to compare
	 *   with as the second argument.
	 * @return ChangelogEntry[]
	 */
	public function findEntriesByVersions( $constraints ) {
		$ret = array();
		foreach ( $this->entries as $entry ) {
			foreach ( $constraints as $op => $version ) {
				if ( ! version_compare( $entry->getVersion(), $version, $op ) ) {
					continue 2;
				}
			}
			$ret[] = $entry;
		}
		return $ret;
	}

	/**
	 * Return data for serializing to JSON.
	 *
	 * @return array
	 */
	public function jsonSerialize() {
		return array(
			'__class__' => static::class,
			'prologue'  => $this->prologue,
			'epilogue'  => $this->epilogue,
			'entries'   => $this->entries,
		);
	}

	/**
	 * Unserialize from JSON.
	 *
	 * @param array $data JSON data as returned by self::jsonSerialize().
	 * @return static
	 * @throws InvalidArgumentException If the data is invalid.
	 */
	public static function jsonUnserialize( $data ) {
		$data = (array) $data;
		if ( ! isset( $data['__class__'] ) ) {
			throw new InvalidArgumentException( 'Invalid data' );
		}
		$class = $data['__class__'];
		unset( $data['__class__'] );
		if ( ! class_exists( $class ) || ! is_a( $class, static::class, true ) ) {
			throw new InvalidArgumentException( "Cannot instantiate $class via " . static::class . '::' . __FUNCTION__ );
		}
		$ret = new $class();
		if ( isset( $data['prologue'] ) ) {
			$ret->setPrologue( $data['prologue'] );
		}
		if ( isset( $data['epilogue'] ) ) {
			$ret->setEpilogue( $data['epilogue'] );
		}
		if ( isset( $data['entries'] ) ) {
			$ret->setEntries( array_map( array( ChangelogEntry::class, 'jsonUnserialize' ), $data['entries'] ) );
		}
		return $ret;
	}

}


1		<?php // phpcs:ignore WordPress.Files.FileName.NotHyphenatedLowercase
2		/**
3		* Class representing a changelog.
4		*
5		* @package automattic/jetpack-changelogger
6		*/
7
8		// phpcs:disable WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
9
10		namespace Automattic\Jetpack\Changelog;
11
12		use InvalidArgumentException;
13		use JsonSerializable;
14
15		/**
16		* Class representing a changelog.
17		*/
18		class Changelog implements JsonSerializable {
19
20		/**
21		* Content before the changelog itself.
22		*
23		* @var string
24		*/
25		protected $prologue = '';
26
27		/**
28		* Content after the changelog itself.
29		*
30		* @var string
31		*/
32		protected $epilogue = '';
33
34		/**
35		* Changelog entries, one per version.
36		*
37		* @var ChangelogEntry[]
38		*/
39		protected $entries = array();
40
41		/**
42		* Get the prologue content.
43		*
44		* @return string
45		*/
46		public function getPrologue() {
47		return $this->prologue;
48		}
49
50		/**
51		* Set the prologue content.
52		*
53		* @param string $prologue Prologue content to set.
54		* @return $this
55		*/
56		public function setPrologue( $prologue ) {
57		$this->prologue = (string) $prologue;
58		return $this;
59		}
60
61		/**
62		* Get the epilogue content.
63		*
64		* @return string
65		*/
66		public function getEpilogue() {
67		return $this->epilogue;
68		}
69
70		/**
71		* Set the epilogue content.
72		*
73		* @param string $epilogue Epilogue content to set.
74		* @return $this
75		*/
76		public function setEpilogue( $epilogue ) {
77		$this->epilogue = (string) $epilogue;
78		return $this;
79		}
80
81		/**
82		* Get the list of changelog entries.
83		*
84		* @return ChangelogEntry[]
85		*/
86		public function getEntries() {
87		return $this->entries;
88		}
89
90		/**
91		* Set the list of changelog entries.
92		*
93		* This replaces all existing entries.
94		*
95		* @param ChangelogEntry[] $entries Changelog entries.
96		* @return $this
97		* @throws InvalidArgumentException If an argument is invalid.
98		*/
99	View Code Duplication	public function setEntries( array $entries ) {
100		foreach ( $entries as $i => $entry ) {
101		if ( ! $entry instanceof ChangelogEntry ) {
102		$what = is_object( $entry ) ? get_class( $entry ) : gettype( $entry );
103		throw new InvalidArgumentException( __METHOD__ . ": Expected a ChangelogEntry, got $what at index $i" );
104		}
105		}
106		$this->entries = array_values( $entries );
107		return $this;
108		}
109
110		/**
111		* Get the latest changelog entry.
112		*
113		* @return ChangelogEntry\|null
114		*/
115		public function getLatestEntry() {
116		return isset( $this->entries[0] ) ? $this->entries[0] : null;
117		}
118
119		/**
120		* Add a new entry as the latest.
121		*
122		* @param ChangelogEntry $entry New entry.
		0 ignored issues – show Documentation introduced 2021-02-18 18:28 UTC by Report Bug Copy Issue Report Should the type for parameter `$entry` not be `null\|ChangelogEntry`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
123		* @return $this
124		*/
125		public function addEntry( ChangelogEntry $entry = null ) {
126		array_unshift( $this->entries, $entry );
127		return $this;
128		}
129
130		/**
131		* Get the list of versions in the changelog.
132		*
133		* @return string[]
134		*/
135		public function getVersions() {
136		$ret = array();
137		foreach ( $this->entries as $entry ) {
138		$ret[] = $entry->getVersion();
139		}
140		return $ret;
141		}
142
143		/**
144		* Find an entry by version.
145		*
146		* @param string $version Version to search for.
147		* @param string $operator Operator as for `version_compare()`. Note the
148		* passed `$version` is passed to `version_compare()` as the second
149		* argument, and the first entry matching is returned.
150		* @return ChangelogEntry\|null
151		*/
152		public function findEntryByVersion( $version, $operator = '==' ) {
153		foreach ( $this->entries as $entry ) {
154		if ( version_compare( $entry->getVersion(), $version, $operator ) ) {
155		return $entry;
156		}
157		}
158		return null;
159		}
160
161		/**
162		* Fetch all entries by a version check.
163		*
164		* @param array $constraints Version constraints. Keys are operations
165		* recognized by `version_compare()`, values are the version to compare
166		* with as the second argument.
167		* @return ChangelogEntry[]
168		*/
169		public function findEntriesByVersions( $constraints ) {
170		$ret = array();
171		foreach ( $this->entries as $entry ) {
172		foreach ( $constraints as $op => $version ) {
173		if ( ! version_compare( $entry->getVersion(), $version, $op ) ) {
174		continue 2;
175		}
176		}
177		$ret[] = $entry;
178		}
179		return $ret;
180		}
181
182		/**
183		* Return data for serializing to JSON.
184		*
185		* @return array
186		*/
187		public function jsonSerialize() {
188		return array(
189		'__class__' => static::class,
190		'prologue' => $this->prologue,
191		'epilogue' => $this->epilogue,
192		'entries' => $this->entries,
193		);
194		}
195
196		/**
197		* Unserialize from JSON.
198		*
199		* @param array $data JSON data as returned by self::jsonSerialize().
200		* @return static
201		* @throws InvalidArgumentException If the data is invalid.
202		*/
203		public static function jsonUnserialize( $data ) {
204		$data = (array) $data;
205		if ( ! isset( $data['__class__'] ) ) {
206		throw new InvalidArgumentException( 'Invalid data' );
207		}
208		$class = $data['__class__'];
209		unset( $data['__class__'] );
210	View Code Duplication	if ( ! class_exists( $class ) \|\| ! is_a( $class, static::class, true ) ) {
211		throw new InvalidArgumentException( "Cannot instantiate $class via " . static::class . '::' . __FUNCTION__ );
212		}
213		$ret = new $class();
214		if ( isset( $data['prologue'] ) ) {
215		$ret->setPrologue( $data['prologue'] );
216		}
217		if ( isset( $data['epilogue'] ) ) {
218		$ret->setEpilogue( $data['epilogue'] );
219		}
220		if ( isset( $data['entries'] ) ) {
221		$ret->setEntries( array_map( array( ChangelogEntry::class, 'jsonUnserialize' ), $data['entries'] ) );
222		}
223		return $ret;
224		}
225
226		}
227

Automattic / jetpack

Push — add/changelog-tooling ( fa9ac3...7f5585 )

Changelog::jsonUnserialize() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like