Closes #2883: Imagify Plugin - Replace the documentation link with th…

…e upgrade one for Free users (#900)

Co-authored-by: Rémy Perona <[email protected]>

Tests/Fixtures/classes/Admin/AdminSubscriber/pluginActionLinks.php

@@ -0,0 +1,23 @@
+<?php
+
+return [
+	'test_data' => [
+		'testShouldReturnDocumentationLinkAmongPluginLinksIfPlanLabelIsNotStarter' => [
+			'config'   => [
+				'plan_id'     => 2,
+			],
+			'expected' => [
+                'Documentation'
+            ],
+		],
+		'testShouldReturnUpgradeLinkAmongPluginLinksIfPlanLabelIsStarter' => [
+			'config'   => [
+				'plan_id'     => 1,
+			],
+			'expected' => [
+                'Upgrade',
+                'class="imagify-plugin-upgrade"'
+            ],
+		],
+	]
+];

Tests/Unit/classes/Admin/AdminSubscriber/pluginActionLinks.php

@@ -0,0 +1,42 @@
+<?php
+namespace Imagify\Tests\Unit\classes;
+
+use Mockery;
+use Brain\Monkey\Functions;
+use Imagify\Tests\Unit\TestCase;
+use Imagify\User\User;
+use Imagify\Admin\AdminSubscriber;
+
+/**
+ * Tests for \Imagify\Admin\AdminSubscriber->plugin_action_links().
+ *
+ * @covers \Imagify\Admin\AdminSubscriber::plugin_action_links
+ * @group  ImagifyAPI
+ */
+class Test_PluginActionLinks extends TestCase {
+    protected $admin_subscriber, $user, $plan_id;
+
+    public function setUp(): void {
+        parent::setUp();
+
+        $this->user = Mockery::mock( User::class );
+        $this->admin_subscriber = new AdminSubscriber( $this->user );
+    }
+
+	/**
+	 * @dataProvider configTestData
+	 */
+	public function testShouldReturnAsExpected( $config, $expected ) {
+        $this->user->plan_id = $config['plan_id'];
+
+        Functions\when( 'imagify_get_external_url' )->justReturn( 'https://example.org' );
+        Functions\when( 'get_imagify_admin_url' )->justReturn( 'https://example.org' );
+
+        $plugin_action_links = $this->admin_subscriber->plugin_action_links([]);
+        $plugin_action_links = implode( '|', $plugin_action_links );
+
+        foreach ( $expected as $text ) {
+            $this->assertStringContainsString( $text, $plugin_action_links );
+        }
+	}
+}

Tests/Unit/inc/classes/ImagifyUser/getError.php

@@ -31,17 +31,43 @@ public function testShouldReturnFalseWhenFetchedUserData() {
 			'is_monthly'                   => true,
 		];
 
+		Functions\when( 'imagify_get_cached_user' )->justReturn( false );
 		Functions\when( 'get_imagify_user' )->justReturn( $userData );
 
 		$this->assertFalse( ( new User() )->get_error() );
 	}
 
+	/**
+	 * Test \Imagify\User\User() should return cached user data if available.
+	 */
+	public function testShouldReturnFromCachedUserDataIfAvailable() {
+		$userData = (object) [
+			'id'                           => 1,
+			'email'                        => '[email protected]',
+			'plan_id'                      => '1',
+			'plan_label'                   => 'free',
+			'quota'                        => 456,
+			'extra_quota'                  => 0,
+			'extra_quota_consumed'         => 0,
+			'consumed_current_month_quota' => 123,
+			'next_date_update'             => '',
+			'is_active'                    => 1,
+			'is_monthly'                   => true,
+		];
+
+		Functions\when( 'imagify_get_cached_user' )->justReturn( $userData );
+		Functions\expect( 'get_imagify_user' )->never();
+
+		$this->assertSame( '[email protected]', ( new User() )->email );
+	}
+
 	/**
 	 * Test \Imagify\User\User->get_error() should return a WP_Error object when couldn’t fetch user account data.
 	 */
 	public function testShouldReturnErrorWhenCouldNotFetchUserData() {
 		$wp_error = new WP_Error( 'error_id', 'Error Message' );
 
+		Functions\when( 'imagify_get_cached_user' )->justReturn( false );
 		Functions\when( 'get_imagify_user' )->justReturn( $wp_error );
 
 		$this->assertSame( $wp_error, ( new User() )->get_error() );

Tests/Unit/inc/classes/ImagifyUser/getPercentConsumedQuota.php

@@ -23,6 +23,7 @@ class Test_GetPercentConsumedQuota extends TestCase {
 	public function testShouldReturnZeroWhenCouldNotFetchUserData() {
 		$wp_error = new WP_Error( 'error_id', 'Error Message' );
 
+		Functions\when( 'imagify_get_cached_user' )->justReturn( false );
 		Functions\when( 'get_imagify_user' )->justReturn( $wp_error );
 		Functions\expect( 'imagify_round_half_five' )->never();
 
@@ -47,6 +48,7 @@ public function testShouldReturnQuotaWhenFetchedUserData() {
 			'is_monthly'                   => true,
 		];
 
+		Functions\when( 'imagify_get_cached_user' )->justReturn( false );
 		Functions\when( 'get_imagify_user' )->justReturn( $userData );
 		Functions\expect( 'imagify_round_half_five' )
 			->twice()

Tests/Unit/inc/classes/ImagifyUser/isOverQuota.php

@@ -22,6 +22,7 @@ class Test_IsOverQuota extends TestCase {
 	public function testShouldReturnFalseWhenCouldNotFetchUserData() {
 		$wp_error = new WP_Error( 'error_id', 'Error Message' );
 
+		Functions\when( 'imagify_get_cached_user' )->justReturn( false );
 		Functions\when( 'get_imagify_user' )->justReturn( $wp_error );
 
 		$this->assertFalse( ( new User() )->is_over_quota() );
@@ -45,6 +46,7 @@ public function testShouldReturnFalseWhenPaidAccount() {
 			'is_monthly'                   => true,
 		];
 
+		Functions\when( 'imagify_get_cached_user' )->justReturn( false );
 		Functions\when( 'get_imagify_user' )->justReturn( $userData );
 
 		$this->assertFalse( ( new User() )->is_over_quota() );
@@ -97,6 +99,7 @@ public function testShouldReturnTrueWhenFreeOverQuota() {
 	}
 
 	private function createMocks( $userData, $dataPreviousQuotaPercent ) {
+		Functions\when( 'imagify_get_cached_user' )->justReturn( false );
 		Functions\when( 'get_imagify_user' )->justReturn( $userData );
 		Functions\expect( 'imagify_round_half_five' )
 			->once()

Tests/Unit/phpunit.xml.dist

@@ -16,6 +16,7 @@
     <testsuites>
         <testsuite name="unit">
             <directory suffix=".php">inc</directory>
+            <directory suffix=".php">classes</directory>
         </testsuite>
     </testsuites>
 

assets/css/admin-bar.css

@@ -197,3 +197,7 @@
 	content: "\2715";
     color: #fff;
 }
+.imagify-plugin-upgrade {
+	color: #6f9c3b;
+	font-weight: 600;
+}

classes/Admin/AdminSubscriber.php

@@ -0,0 +1,67 @@
+<?php
+declare(strict_types=1);
+
+namespace Imagify\Admin;
+
+use Imagify\EventManagement\SubscriberInterface;
+use Imagify\User\User;
+
+/**
+ * Admin Subscriber
+ */
+class AdminSubscriber implements SubscriberInterface {
+
+	/**
+	 * User instance.
+	 *
+	 * @var User
+	 */
+	protected $user;
+
+	/**
+	 * Instantiate the class
+	 *
+	 * @param User $user User instance.
+	 */
+	public function __construct( User $user ) {
+		$this->user = $user;
+	}
+
+	/**
+	 * Returns an array of events this subscriber listens to
+	 *
+	 * @return array
+	 */
+	public static function get_subscribed_events() {
+		$basename = plugin_basename( IMAGIFY_FILE );
+
+		return [
+			'plugin_action_links_' . $basename               => 'plugin_action_links',
+			'network_admin_plugin_action_links_' . $basename => 'plugin_action_links',
+		];
+	}
+
+	/**
+	 * Add links to the plugin row in the plugins list.
+	 *
+	 * @since 1.7
+	 *
+	 * @param  array $actions An array of action links.
+	 * @return array
+	 */
+	public function plugin_action_links( $actions ) {
+		$text  = 1 !== $this->user->plan_id ? __( 'Documentation', 'imagify' ) : __( 'Upgrade', 'imagify' );
+		$url   = 1 !== $this->user->plan_id ? 'documentation' : 'subscription';
+		$class = 1 !== $this->user->plan_id ? '' : ' class="imagify-plugin-upgrade"';
+
+		array_unshift( $actions, sprintf( '<a href="%s" target="_blank"%s>%s</a>',
+			esc_url( imagify_get_external_url( $url ) ),
+			$class,
+			$text
+		) );
+
+		array_unshift( $actions, sprintf( '<a href="%s">%s</a>', esc_url( get_imagify_admin_url( 'bulk-optimization' ) ), __( 'Bulk Optimization', 'imagify' ) ) );
+		array_unshift( $actions, sprintf( '<a href="%s">%s</a>', esc_url( get_imagify_admin_url() ), __( 'Settings', 'imagify' ) ) );
+		return $actions;
+	}
+}

classes/Admin/ServiceProvider.php

@@ -0,0 +1,49 @@
+<?php
+declare(strict_types=1);
+
+namespace Imagify\Admin;
+
+use Imagify\Dependencies\League\Container\ServiceProvider\AbstractServiceProvider;
+use Imagify\Admin\AdminSubscriber;
+
+/**
+ * Service provider for Admin.
+ */
+class ServiceProvider extends AbstractServiceProvider {
+	/**
+	 * Services provided by this provider
+	 *
+	 * @var array
+	 */
+	protected $provides = [
+		'admin_subscriber',
+	];
+
+	/**
+	 * Subscribers provided by this provider
+	 *
+	 * @var array
+	 */
+	public $subscribers = [
+		'admin_subscriber',
+	];
+
+	/**
+	 * Registers the provided classes
+	 *
+	 * @return void
+	 */
+	public function register() {
+		$this->getContainer()->share( 'admin_subscriber', AdminSubscriber::class )
+			->addArgument( $this->getContainer()->get( 'user' ) );
+	}
+
+	/**
+	 * Returns the subscribers array
+	 *
+	 * @return array
+	 */
+	public function get_subscribers() {
+		return $this->subscribers;
+	}
+}

classes/User/User.php

@@ -125,7 +125,7 @@ class User {
 	 * @return void
 	 */
 	public function __construct() {
-		$user = get_imagify_user();
+		$user = imagify_get_cached_user() ?: get_imagify_user();
 
 		if ( is_wp_error( $user ) ) {
 			$this->error = $user;

config/providers.php

@@ -1,9 +1,10 @@
 <?php
 return [
+	'Imagify\User\ServiceProvider',
 	'Imagify\Avif\ServiceProvider',
 	'Imagify\CDN\ServiceProvider',
 	'Imagify\Picture\ServiceProvider',
 	'Imagify\Stats\ServiceProvider',
 	'Imagify\Webp\ServiceProvider',
-	'Imagify\User\ServiceProvider',
+	'Imagify\Admin\ServiceProvider',
 ];

inc/classes/class-imagify-views.php

@@ -120,11 +120,6 @@ public function init() {
 			add_action( 'network_admin_menu', [ $this, 'add_network_menus' ] );
 		}
 
-		// Action links in plugins list.
-		$basename = plugin_basename( IMAGIFY_FILE );
-		add_filter( 'plugin_action_links_' . $basename,               [ $this, 'plugin_action_links' ] );
-		add_filter( 'network_admin_plugin_action_links_' . $basename, [ $this, 'plugin_action_links' ] );
-
 		// Save the "per page" option value from the files list screen.
 		add_filter( 'set-screen-option', [ 'Imagify_Files_List_Table', 'save_screen_options' ], 10, 3 );
 
@@ -208,27 +203,6 @@ public function add_network_menus() {
 		}
 	}
 
-
-	/** ----------------------------------------------------------------------------------------- */
-	/** PLUGIN ACTION LINKS ===================================================================== */
-	/** ----------------------------------------------------------------------------------------- */
-
-	/**
-	 * Add links to the plugin row in the plugins list.
-	 *
-	 * @since 1.7
-	 *
-	 * @param  array $actions An array of action links.
-	 * @return array
-	 */
-	public function plugin_action_links( $actions ) {
-		array_unshift( $actions, sprintf( '<a href="%s" target="_blank">%s</a>', esc_url( imagify_get_external_url( 'documentation' ) ), __( 'Documentation', 'imagify' ) ) );
-		array_unshift( $actions, sprintf( '<a href="%s">%s</a>', esc_url( get_imagify_admin_url( 'bulk-optimization' ) ), __( 'Bulk Optimization', 'imagify' ) ) );
-		array_unshift( $actions, sprintf( '<a href="%s">%s</a>', esc_url( get_imagify_admin_url() ), __( 'Settings', 'imagify' ) ) );
-		return $actions;
-	}
-
-
 	/** ----------------------------------------------------------------------------------------- */
 	/** MAIN PAGE TEMPLATES ===================================================================== */
 	/** ----------------------------------------------------------------------------------------- */