Use newer versions of blade & gettext

composer.json

@@ -11,8 +11,11 @@
         }
     ],
     "require": {
-        "eftec/bladeone": "3.52",
-        "gettext/gettext": "^4.8",
+        "eftec/bladeone": "^4.11",
+        "gettext/gettext": "^5.7",
+        "gettext/js-scanner": "^1.1",
+        "gettext/php-scanner": "^v1.3.1",
+        "gettext/translator": "^1.2",
         "mck89/peast": "^1.13.11",
         "wp-cli/wp-cli": "^2.12"
     },

src/BladeCodeExtractor.php

@@ -42,8 +42,6 @@ final class BladeCodeExtractor extends BladeGettextExtractor {
 		],
 	];
 
-	protected static $functionsScannerClass = 'WP_CLI\I18n\PhpFunctionsScanner';
-
 	/**
 	 * {@inheritdoc}
 	 */

src/BladeGettextExtractor.php

@@ -4,14 +4,10 @@
 
 use eftec\bladeone\BladeOne;
 
-// Modified Gettext Blade extractor that
-// uses the up-to-date BladeOne standalone Blade engine,
-// correctly supports fromStringMultiple.
-
 /**
  * Class to get gettext strings from blade.php files returning arrays.
  */
-class BladeGettextExtractor extends \Gettext\Extractors\PhpCode {
+class BladeGettextExtractor extends PhpCodeExtractor {
 
 	/**
 	 * Prepares a Blade compiler/engine and returns it.

src/IterableCodeExtractor.php

@@ -70,10 +70,10 @@
 				$headers = FileDataExtractor::get_file_data_from_string( $text, [ 'Template Name' => 'Template Name' ] );
 
 				if ( ! empty( $headers['Template Name'] ) ) {
-					$translation = new Translation( '', $headers['Template Name'] );
-					$translation->addExtractedComment( 'Template Name of the theme' );
+					$translation = Translation::create( '', $headers['Template Name'] );
+					$translation->getComments()->add( 'Template Name of the theme' );
 
-					$translations[] = $translation;
+					$translations->add( $translation );
 				}
 			}
 
@@ -88,17 +88,17 @@
 				);
 
 				if ( ! empty( $headers['Title'] ) ) {
-					$translation = new Translation( 'Pattern title', $headers['Title'] );
-					$translation->addReference( $options['file'] );
+					$translation = Translation::create( 'Pattern title', $headers['Title'] );
+					$translation->getReferences()->add( $options['file'] );
 
-					$translations[] = $translation;
+					$translations->add( $translation );
 				}
 
 				if ( ! empty( $headers['Description'] ) ) {
-					$translation = new Translation( 'Pattern description', $headers['Description'] );
-					$translation->addReference( $options['file'] );
+					$translation = Translation::create( 'Pattern description', $headers['Description'] );
+					$translation->getReferences()->add( $options['file'] );
 
-					$translations[] = $translation;
+					$translations->add( $translation );
 				}
 			}
 
@@ -339,4 +339,37 @@
 	protected static function trim_leading_slash( $path ) {
 		return ltrim( $path, '/' );
 	}
+
+	/**
+	 * Formerly part php-gettext 4.x.
+	 */
+	protected static function getFiles( $file ) {
+		if ( empty( $file ) ) {
+			throw new InvalidArgumentException( 'There is not any file defined' );
+		}
+
+		if ( is_string( $file ) ) {
+			if ( ! is_file( $file ) ) {
+				throw new InvalidArgumentException( "'$file' is not a valid file" );
+			}
+
+			if ( ! is_readable( $file ) ) {
+				throw new InvalidArgumentException( "'$file' is not a readable file" );
+			}
+
+			return [ $file ];
+		}
+
+		if ( is_array( $file ) ) {
+			$files = [];
+
+			foreach ( $file as $f ) {
+				$files = array_merge( $files, self::getFiles( $f ) );
+			}
+
+			return $files;
+		}
+
+		throw new InvalidArgumentException( 'The first argument must be string or array' );
+	}
 }

src/JedGenerator.php

@@ -2,7 +2,7 @@
 
 namespace WP_CLI\I18n;
 
-use Gettext\Generators\Jed;
+use Gettext\Generator\Generator;
 use Gettext\Translation;
 use Gettext\Translations;
 
@@ -11,72 +11,83 @@
  *
  * Adds some more meta data to JED translation files than the default generator.
  */
-class JedGenerator extends Jed {
+class JedGenerator extends Generator {
 	/**
-	 * {@parentDoc}.
+	 * Options passed to json_encode().
+	 *
+	 * @var int JSON options.
 	 */
-	public static function toString( Translations $translations, array $options = [] ) {
-		$options += static::$options;
-		$domain   = $translations->getDomain() ?: 'messages';
-		$messages = static::buildMessages( $translations );
-
-		$configuration = [
-			'' => [
-				'domain'       => $domain,
-				'lang'         => $translations->getLanguage() ?: 'en',
-				'plural-forms' => $translations->getHeader( 'Plural-Forms' ) ?: 'nplurals=2; plural=(n != 1);',
-			],
-		];
-
-		$data = [
-			'translation-revision-date' => $translations->getHeader( 'PO-Revision-Date' ),
-			'generator'                 => 'WP-CLI/' . WP_CLI_VERSION,
-			'source'                    => $options['source'],
-			'domain'                    => $domain,
-			'locale_data'               => [
-				$domain => $configuration + $messages,
-			],
-		];
-
-		return json_encode( $data, $options['json'] );
-	}
+	protected $json_options = 0;
 
 	/**
-	 * Generates an array with all translations.
+	 * Source file.
 	 *
-	 * @param Translations $translations
+	 * @var string Source file.
+	 */
+	protected $source = '';
+
+	/**
+	 * Constructor.
 	 *
-	 * @return array
+	 * @param int    $json_options Options passed to json_encode().
+	 * @param string $source       Source file.
 	 */
-	public static function buildMessages( Translations $translations ) {
-		$plural_forms      = $translations->getPluralForms();
-		$number_of_plurals = is_array( $plural_forms ) ? ( $plural_forms[0] - 1 ) : null;
-		$messages          = [];
-		$context_glue      = chr( 4 );
+	public function __construct( int $json_options, string $source ) {
+		$this->json_options = $json_options;
+		$this->source       = $source;
+	}
 
-		foreach ( $translations as $translation ) {
-			/** @var Translation $translation */
+	public function generateString( Translations $translations ): string {
+		$array = $this->generateArray( $translations );
+
+		return json_encode( $array, $this->json_options );
+	}
 
-			if ( $translation->isDisabled() ) {
+	public function generateArray( Translations $translations ): array {
+		$pluralForm = $translations->getHeaders()->getPluralForm();
+		$pluralSize = is_array( $pluralForm ) ? ( $pluralForm[0] - 1 ) : null;
+		$messages   = [];
+
+		foreach ( $translations as $translation ) {
+			if ( ! $translation->getTranslation() || $translation->isDisabled() ) {
 				continue;
 			}
 
-			$key = $translation->getOriginal();
+			$context  = $translation->getContext() ?: '';
+			$original = $translation->getOriginal();
 
-			if ( $translation->hasContext() ) {
-				$key = $translation->getContext() . $context_glue . $key;
+			if ( ! isset( $messages[ $context ] ) ) {
+				$messages[ $context ] = [];
 			}
 
-			if ( $translation->hasPluralTranslations( true ) ) {
-				$message = $translation->getPluralTranslations( $number_of_plurals );
-				array_unshift( $message, $translation->getTranslation() );
+			if ( self::hasPluralTranslations( $translation ) ) {
+				$messages[ $context ][ $original ] = $translation->getPluralTranslations( $pluralSize );
+				array_unshift( $messages[ $context ][ $original ], $translation->getTranslation() );
 			} else {
-				$message = [ $translation->getTranslation() ];
+				$messages[ $context ][ $original ] = $translation->getTranslation();
 			}
-
-			$messages[ $key ] = $message;
 		}
 
-		return $messages;
+		$configuration = [
+			'' => [
+				'domain'       => $translations->getDomain(),
+				'lang'         => $translations->getLanguage() ?: 'en',
+				'plural-forms' => $translations->getHeaders()->getPluralForm() ?: 'nplurals=2; plural=(n != 1);',
+			],
+		];
+
+		return [
+			'translation-revision-date' => $translations->getHeaders()->get( 'PO-Revision-Date' ),
+			'generator'                 => 'WP-CLI/' . WP_CLI_VERSION,
+			'source'                    => $this->source,
+			'domain'                    => $translations->getDomain(),
+			'locale_data'               => [
+				$translations->getDomain() => $configuration + $messages,
+			],
+		];
+	}
+
+	private static function hasPluralTranslations( Translation $translation ): bool {
+		return implode( '', $translation->getPluralTranslations() ) !== '';
 	}
 }

src/JsCodeExtractor.php

@@ -3,35 +3,40 @@
 namespace WP_CLI\I18n;
 
 use Exception;
-use Gettext\Extractors\JsCode;
+use Gettext\Scanner\JsScanner;
 use Gettext\Translations;
 use Peast\Syntax\Exception as PeastException;
 use WP_CLI;
 
-final class JsCodeExtractor extends JsCode {
+final class JsCodeExtractor {
 	use IterableCodeExtractor;
 
+	protected $functions = [
+		'__'  => 'text_domain',
+		'_x'  => 'text_context_domain',
+		'_n'  => 'single_plural_number_domain',
+		'_nx' => 'single_plural_number_context_domain',
+	];
+
 	public static $options = [
 		'extractComments' => [ 'translators', 'Translators' ],
 		'constants'       => [],
-		'functions'       => [
-			'__'  => 'text_domain',
-			'_x'  => 'text_context_domain',
-			'_n'  => 'single_plural_number_domain',
-			'_nx' => 'single_plural_number_context_domain',
-		],
+		'functions'       => [],
 	];
 
-	protected static $functionsScannerClass = 'WP_CLI\I18n\JsFunctionsScanner';
-
 	/**
 	 * @inheritdoc
 	 */
 	public static function fromString( $text, Translations $translations, array $options = [] ) {
 		WP_CLI::debug( "Parsing file {$options['file']}", 'make-pot' );
 
 		try {
-			self::fromStringMultiple( $text, [ $translations ], $options );
+			$options += self::$options;
+
+			$scanner = new JsScanner( $translations );
+			$scanner->setFunctions( self::$options['functions'] );
+			$scanner->extractCommentsStartingWith( $options['extractComments'] );
+			$scanner->scanString( $text, $options['file'] );
 		} catch ( PeastException $exception ) {
 			WP_CLI::debug(
 				sprintf(
@@ -54,16 +59,4 @@
 			);
 		}
 	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public static function fromStringMultiple( $text, array $translations, array $options = [] ) {
-		$options += self::$options;
-
-		/** @var JsFunctionsScanner $functions */
-		$functions = new self::$functionsScannerClass( $text );
-		$functions->enableCommentsExtraction( $options['extractComments'] );
-		$functions->saveGettextFunctions( $translations, $options );
-	}
 }

src/JsFunctionsScanner.php

@@ -178,7 +178,7 @@
 				$translation = $translations->insert( $context, $original, $plural );
 
 				if ( $add_reference ) {
-					$translation->addReference( $file, $line );
+					$translation->getReferences()->add( $file, $line );
 				}
 
 				if (
@@ -203,7 +203,7 @@
 					$prefixes       = array_filter( (array) $this->extract_comments );
 
 					if ( $parsed_comment->checkPrefixes( $prefixes ) ) {
-						$translation->addExtractedComment( $parsed_comment->getComment() );
+						$translation->getComments()->add( $parsed_comment->getComment() );
 
 						$this->comments_cache[] = $comment;
 					}

src/JsonSchemaExtractor.php

@@ -2,12 +2,12 @@
 
 namespace WP_CLI\I18n;
 
-use Gettext\Extractors\Extractor;
+use Gettext\Translation;
 use Gettext\Translations;
 use WP_CLI;
 use WP_CLI\Utils;
 
-class JsonSchemaExtractor extends Extractor {
+class JsonSchemaExtractor {
 	use IterableCodeExtractor;
 
 	/**
@@ -82,7 +82,7 @@
 	/**
 	 * @inheritdoc
 	 */
 	public static function fromString( $text, Translations $translations, array $options = [] ) {
 		$file = $options['file'];
 		WP_CLI::debug( "Parsing file {$file}", 'make-pot' );
 
@@ -127,12 +127,14 @@
 		}
 
 		if ( is_string( $i18n_schema ) && is_string( $settings ) ) {
-			$translation = $translations->insert( $i18n_schema, $settings );
+			$translation = Translation::create( $i18n_schema, $settings );
 
 			if ( $file ) {
-				$translation->addReference( $file );
+				$translation->getReferences()->add( $file );
 			}
 
+			$translations->add( $translation );
+
 			return;
 		}