Changeset 13774

Timestamp:

06/04/2024 02:53:48 PM (2 years ago)

Author:

amieiro

Message:

Translation. Add the option to show statistics from the start date we want.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/cli

Files:

• class-stats-print.php (modified) (2 diffs)
• class-stats.php (modified) (7 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/cli/class-stats-print.php

@@ -3 +3 @@
 namespace WordPressdotorg\GlotPress\Customizations\CLI;
 
+use DateTime;
 use WP_CLI;
 use WP_CLI_Command;
@@ -8 +9 @@
 class Stats_Print extends WP_CLI_Command  {
 
+        /**
+         * Prints statistics starting from a specified date.
+         *
+         * ## OPTIONS
+         *
+         * [--start_date=<start_date>]
+         * : The start date for the statistics in 'Y-m-d' format.
+         *   If not provided, defaults to one week before the current date.
+         *
+         * ## EXAMPLES
+         *
+         *     # Print statistics starting from one week before the current date.
+         *     wp wporg-translate show-stats --url=translate.wordpress.org
+         *
+         *     # Print statistics starting from 2023-10-25.
+         *     wp wporg-translate show-stats --start_date=2023-10-25 --url=translate.wordpress.org
+         *
+         * @param array $args       Positional arguments.
+         * @param array $assoc_args Associative arguments.
+         */
         public function __invoke( $args, $assoc_args ) {
+                if ( !isset( $assoc_args['start_date'] ) ) {
+                        $start_date = date( 'Y-m-d', strtotime( '-1 week' ) );
+                } else {
+                        $start_date     = $assoc_args['start_date'];
+                        $start_datetime = DateTime::createFromFormat( 'Y-m-d', $start_date ) ;
+                        $is_valid_date  = $start_datetime && $start_datetime->format( 'Y-m-d' ) === $start_date;
+                        if ( ! $is_valid_date ) {
+                                WP_CLI::error( 'The --start_date parameter must be in the format Y-m-d. E.g.: 2023-10-24' );
+                                return;
+                        }
+                }
                 $stats = new Stats();
-                $stats( true );
+                $stats( true, $start_date );
         }
 }

sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-gp-customizations/inc/cli/class-stats.php

@@ -14 +14 @@
 
 use DateTime;
-use Exception;
-use GP;
 use GP_Locale;
-use GP_Locales;
 use WP_CLI;
-use WP_CLI_Command;
 use WP_Query;
 use WordPressdotorg\GlotPress\Routes\Plugin;
@@ -163 +159 @@
          * Prints the Polyglots stats or stores them on a page.
          *
-         * @param bool $echo_the_values Whether it should print the info in the CLI or stores it on a page.
+         * @param bool        $echo_the_values Whether it should print the info in the CLI or stores it on a page.
+         * @param string|null $old_date        The date to compare the stats with. Format: 'Y-m-d'.
          *
          * @return void
          */
-        public function __invoke( bool $echo_the_values = false ) {
+        public function __invoke( bool $echo_the_values = false, string $old_date = null ): void {
                 global $wpdb;
 
@@ -190 +187 @@
                 $this->print_managers_stats();
                 $this->print_most_active_translators();
-                $this->store_stats();
-                $this->print_stats_comparison( gmdate( 'Y-m-d' ) );
+                // Don't store the stats if we execute the command in the CLI, to avoid storing the same stats twice.
+                if ( ! $echo_the_values ) {
+                        $this->store_stats();
+                }
+                $this->print_stats_comparison( gmdate( 'Y-m-d' ), $old_date );
 
                 $this->update_page();
@@ -360 +360 @@
          *
          * @param string $current_date The date for which we display the stats.
-         * @param string $old_date The date to compare the stats with.
+         * @param string $old_date     The date to compare the stats with.
          *
          * @return void
@@ -375 +375 @@
                         return;
                 }
-                if ( ! $this->echo_the_values ) {
-                        $this->stats_comparison = $this->create_gutenberg_heading( 'Summary for weekly stats' );
-                } else {
-                        $this->print_wpcli_heading( 'Summary for weekly stats' );
+
+                $current_datetime = DateTime::createFromFormat( 'Y-m-d', $current_date );
+                $old_datetime     = DateTime::createFromFormat( 'Y-m-d', $old_date );
+                if ( ! $current_datetime || ! $old_datetime ) {
+                        return;
+                }
+                $interval        = $current_datetime->diff( $old_datetime );
+                $days_difference = $interval->days;
+
+                if ( ! $this->echo_the_values ) {
+                        $this->stats_comparison = $this->create_gutenberg_heading( "Summary for the last $days_difference days" );
+                } else {
+                        $this->print_wpcli_heading( "Summary for the last $days_difference days" );
                 }
                 $stats_diff = new \stdClass();
@@ -395 +404 @@
                 $code .= 'Requests: There are ' . $current_date_data->requests_unresolved . ' unresolved editor requests out of ' . $current_date_data->requests_total . ' (' . $this->prefix_num( $stats_diff->requests_unresolved ) . ') total and ' . $current_date_data->locale_requests_unresolved . ' unresolved locale requests out of ' . $current_date_data->locale_requests_total . ' (' . $this->prefix_num( $stats_diff->locale_requests_unresolved ) . ') total.' . PHP_EOL . PHP_EOL;
 
-                $code .= 'Translators: There are ' . $current_date_data->translators_gtes . ' (' . $this->prefix_num( $stats_diff->translators_gtes ) . ') GTEs, ' . $current_date_data->translators_ptes . ' (' . $this->prefix_num( $stats_diff->translators_ptes ) . ') PTEs and ' . $current_date_data->translators_contributors . ' (' . $this->prefix_num( $stats_diff->translators_contributors ) . ') translation contributors.' . PHP_EOL;
-                $code .= '(A wordpress.org account could have multiple roles over different locale)' . PHP_EOL . PHP_EOL;
-
-                $code .= 'Site language: ' . $current_date_data->wp_translated_sites_pct . '% (' . $this->prefix_num( round( $stats_diff->wp_translated_sites_pct, 3 ) ) . '%) of WordPress sites are running a translated WordPress site. ' . PHP_EOL;
+                $code .= 'Translators: There are ' . number_format_i18n( $current_date_data->translators_gtes ) . ' (' . $this->prefix_num( $stats_diff->translators_gtes ) . ') GTEs, ' . number_format_i18n( $current_date_data->translators_ptes ) . ' (' . $this->prefix_num( $stats_diff->translators_ptes ) . ') PTEs and ' . number_format_i18n( $current_date_data->translators_contributors ) . ' (' . $this->prefix_num( $stats_diff->translators_contributors ) . ') translation contributors.' . PHP_EOL;
+                $code .= '(A wordpress.org account could have multiple roles over different locale).' . PHP_EOL . PHP_EOL;
+
+                $code .= 'Site language: ' . $current_date_data->wp_translated_sites_pct . '% (' . $this->prefix_num( round( $stats_diff->wp_translated_sites_pct, 3 ), 3 ) . '%) of WordPress sites are running a translated WordPress site. ' . PHP_EOL;
                 if ( ! $this->echo_the_values ) {
                         $this->stats_comparison .= $this->create_gutenberg_code( $code );
@@ -421 +430 @@
          * Prefix numbers greater than zero with plus sign and plus_minus sign if number is zero.
          *
-         * @param int $num Number to be prefixed.
+         * @param float $number          Number to be prefixed.
+         * @param int   $number_decimals Number of decimals to be displayed.
          *
          * @return string Prefixed number
          */
-        private function prefix_num( $num ) {
-                if ( 0 === $num ) {
+        private function prefix_num( $number, $number_decimals = 0 ) {
+                if ( 0 === $number ) {
                         return '±0';
                 }
-                return $num > 0 ? sprintf( '+%d', $num ) : $num;
+                return $number > 0 ? sprintf( '+%s', number_format_i18n( $number, $number_decimals ) ) : number_format_i18n( $number, $number_decimals );
         }