Add wp i18n make-php command

README.md

@@ -224,6 +224,32 @@ wp i18n make-mo <source> [<destination>]
 
 
 
+### wp i18n make-php
+
+Create PHP files from PO files.
+
+~~~
+wp i18n make-php <source> [<destination>]
+~~~
+
+**OPTIONS**
+
+	<source>
+		Path to an existing PO file or a directory containing multiple PO files.
+
+	[<destination>]
+		Path to the destination directory for the resulting PHP files. Defaults to the source directory.
+
+**EXAMPLES**
+
+    # Create PHP files for all PO files in the current directory.
+    $ wp i18n make-php .
+
+    # Create a PHP file from a single PO file in a specific directory.
+    $ wp i18n make-php example-plugin-de_DE.po languages
+
+
+
 ### wp i18n update-po
 
 Update PO files from a POT file.

composer.json

@@ -42,6 +42,7 @@
             "i18n make-pot",
             "i18n make-json",
             "i18n make-mo",
+            "i18n make-php",
             "i18n update-po"
         ]
     },

features/makephp.feature

@@ -0,0 +1,167 @@
+Feature: Generate PHP files from PO files
+
+  Background:
+    Given an empty directory
+
+  Scenario: Bail for invalid source directories
+    When I try `wp i18n make-php foo`
+    Then STDERR should contain:
+      """
+      Error: Source file or directory does not exist!
+      """
+    And the return code should be 1
+
+  Scenario: Uses source folder as destination by default
+    Given an empty foo-plugin directory
+    And a foo-plugin/foo-plugin-de_DE.po file:
+      """
+      # Copyright (C) 2018 Foo Plugin
+      # This file is distributed under the same license as the Foo Plugin package.
+      msgid ""
+      msgstr ""
+      "Project-Id-Version: Foo Plugin\n"
+      "Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/foo-plugin\n"
+      "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+      "Language-Team: LANGUAGE <LL@li.org>\n"
+      "Language: de_DE\n"
+      "MIME-Version: 1.0\n"
+      "Content-Type: text/plain; charset=UTF-8\n"
+      "Content-Transfer-Encoding: 8bit\n"
+      "POT-Creation-Date: 2018-05-02T22:06:24+00:00\n"
+      "PO-Revision-Date: 2018-05-02T22:06:24+00:00\n"
+      "X-Domain: foo-plugin\n"
+      "Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+      #: foo-plugin.js:15
+      msgid "Foo Plugin"
+      msgstr "Foo Plugin"
+      """
+
+    When I run `wp i18n make-php foo-plugin`
+    Then STDOUT should contain:
+      """
+      Success: Created 1 file.
+      """
+    And the return code should be 0
+    And the foo-plugin/foo-plugin-de_DE.php file should exist
+
+  Scenario: Allows setting custom destination directory
+    Given an empty foo-plugin directory
+    And a foo-plugin/foo-plugin-de_DE.po file:
+      """
+      # Copyright (C) 2018 Foo Plugin
+      # This file is distributed under the same license as the Foo Plugin package.
+      msgid ""
+      msgstr ""
+      "Project-Id-Version: Foo Plugin\n"
+      "Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/foo-plugin\n"
+      "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+      "Language-Team: LANGUAGE <LL@li.org>\n"
+      "Language: de_DE\n"
+      "MIME-Version: 1.0\n"
+      "Content-Type: text/plain; charset=UTF-8\n"
+      "Content-Transfer-Encoding: 8bit\n"
+      "POT-Creation-Date: 2018-05-02T22:06:24+00:00\n"
+      "PO-Revision-Date: 2018-05-02T22:06:24+00:00\n"
+      "X-Domain: foo-plugin\n"
+      "Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+      #: foo-plugin.js:15
+      msgid "Foo Plugin"
+      msgstr "Foo Plugin"
+      """
+
+    When I run `wp i18n make-php foo-plugin result`
+    Then STDOUT should contain:
+      """
+      Success: Created 1 file.
+      """
+    And the return code should be 0
+    And the result/foo-plugin-de_DE.php file should exist
+
+  Scenario: Does include headers
+    Given an empty foo-plugin directory
+    And a foo-plugin/foo-plugin-de_DE.po file:
+      """
+      # Copyright (C) 2018 Foo Plugin
+      # This file is distributed under the same license as the Foo Plugin package.
+      msgid ""
+      msgstr ""
+      "Project-Id-Version: Foo Plugin\n"
+      "Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/foo-plugin\n"
+      "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+      "Language-Team: LANGUAGE <LL@li.org>\n"
+      "Language: de_DE\n"
+      "MIME-Version: 1.0\n"
+      "Content-Type: text/plain; charset=UTF-8\n"
+      "Content-Transfer-Encoding: 8bit\n"
+      "POT-Creation-Date: 2018-05-02T22:06:24+00:00\n"
+      "PO-Revision-Date: 2018-05-02T22:06:24+00:00\n"
+      "X-Domain: foo-plugin\n"
+      "Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+      #: foo-plugin.js:15
+      msgid "Foo Plugin"
+      msgstr "Foo Plugin"
+      """
+
+    When I run `wp i18n make-php foo-plugin`
+    Then STDOUT should contain:
+      """
+      Success: Created 1 file.
+      """
+    And the return code should be 0
+    And STDERR should be empty
+    And the foo-plugin/foo-plugin-de_DE.php file should contain:
+      """
+      'language'=>'de_DE'
+      """
+    And the foo-plugin/foo-plugin-de_DE.php file should contain:
+      """
+      'domain'=>'foo-plugin'
+      """
+    And the foo-plugin/foo-plugin-de_DE.php file should contain:
+      """
+      'plural-forms'=>'nplurals=2; plural=(n != 1);'
+      """
+    And the foo-plugin/foo-plugin-de_DE.php file should contain:
+      """
+      'messages'=>[''=>['Foo Plugin'=>['Foo Plugin']]]
+      """
+
+  Scenario: Does include translations
+    Given an empty foo-plugin directory
+    And a foo-plugin/foo-plugin-de_DE.po file:
+      """
+      # Copyright (C) 2018 Foo Plugin
+      # This file is distributed under the same license as the Foo Plugin package.
+      msgid ""
+      msgstr ""
+      "Project-Id-Version: Foo Plugin\n"
+      "Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/foo-plugin\n"
+      "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+      "Language-Team: LANGUAGE <LL@li.org>\n"
+      "Language: de_DE\n"
+      "MIME-Version: 1.0\n"
+      "Content-Type: text/plain; charset=UTF-8\n"
+      "Content-Transfer-Encoding: 8bit\n"
+      "POT-Creation-Date: 2018-05-02T22:06:24+00:00\n"
+      "PO-Revision-Date: 2018-05-02T22:06:24+00:00\n"
+      "X-Domain: foo-plugin\n"
+      "Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+      #: foo-plugin.js:15
+      msgid "Foo Plugin"
+      msgstr "Bar Plugin"
+      """
+
+    When I run `wp i18n make-php foo-plugin`
+    Then STDOUT should contain:
+      """
+      Success: Created 1 file.
+      """
+    And the return code should be 0
+    And the foo-plugin/foo-plugin-de_DE.php file should contain:
+      """
+      'messages'=>[''=>['Foo Plugin'=>['Bar Plugin']]]
+      """

i18n-command.php

@@ -30,4 +30,6 @@
 
 WP_CLI::add_command( 'i18n make-mo', '\WP_CLI\I18n\MakeMoCommand' );
 
+WP_CLI::add_command( 'i18n make-php', '\WP_CLI\I18n\MakePhpCommand' );
+
 WP_CLI::add_command( 'i18n update-po', '\WP_CLI\I18n\UpdatePoCommand' );

src/MakePhpCommand.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace WP_CLI\I18n;
+
+use DirectoryIterator;
+use Gettext\Translations;
+use IteratorIterator;
+use SplFileInfo;
+use WP_CLI;
+use WP_CLI\Utils;
+use WP_CLI_Command;
+
+class MakePhpCommand extends WP_CLI_Command {
+	/**
+	 * Create PHP files from PO files.
+	 *
+	 * ## OPTIONS
+	 *
+	 * <source>
+	 * : Path to an existing PO file or a directory containing multiple PO files.
+	 *
+	 * [<destination>]
+	 * : Path to the destination directory for the resulting PHP files. Defaults to the source directory.
+	 *
+	 * ## EXAMPLES
+	 *
+	 *     # Create PHP files for all PO files in the current directory.
+	 *     $ wp i18n make-php .
+	 *
+	 *     # Create a PHP file from a single PO file in a specific directory.
+	 *     $ wp i18n make-php example-plugin-de_DE.po languages
+	 *
+	 * @when before_wp_load
+	 *
+	 * @throws WP_CLI\ExitException
+	 */
+	public function __invoke( $args, $assoc_args ) {
+		$source = realpath( $args[0] );
+		if ( ! $source || ( ! is_file( $source ) && ! is_dir( $source ) ) ) {
+			WP_CLI::error( 'Source file or directory does not exist!' );
+		}
+
+		$destination = is_file( $source ) ? dirname( $source ) : $source;
+		if ( isset( $args[1] ) ) {
+			$destination = $args[1];
+		}
+
+		// Two is_dir() checks in case of a race condition.
+		if ( ! is_dir( $destination )
+			&& ! mkdir( $destination, 0777, true )
+			&& ! is_dir( $destination )
+		) {
+			WP_CLI::error( 'Could not create destination directory!' );
+		}
+
+		if ( is_file( $source ) ) {
+			$files = [ new SplFileInfo( $source ) ];
+		} else {
+			$files = new IteratorIterator( new DirectoryIterator( $source ) );
+		}
+
+		$result_count = 0;
+		/** @var DirectoryIterator $file */
+		foreach ( $files as $file ) {
+			if ( 'po' !== $file->getExtension() ) {
+				continue;
+			}
+
+			if ( ! $file->isFile() || ! $file->isReadable() ) {
+				WP_CLI::warning( sprintf( 'Could not read file %s', $file->getFilename() ) );
+				continue;
+			}
+
+			$file_basename    = basename( $file->getFilename(), '.po' );
+			$destination_file = "{$destination}/{$file_basename}.php";
+
+			$translations = Translations::fromPoFile( $file->getPathname() );
+			if ( ! PhpArrayGenerator::toFile( $translations, $destination_file ) ) {
+				WP_CLI::warning( sprintf( 'Could not create file %s', $destination_file ) );
+				continue;
+			}
+
+			++$result_count;
+		}
+
+		WP_CLI::success( sprintf( 'Created %d %s.', $result_count, Utils\pluralize( 'file', $result_count ) ) );
+	}
+}