Closes #2883: Imagify Plugin - Replace the documentation link with the upgrade one for Free users

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/inc/classes/classImagifyViews/pluginActionLinks.php

@@ -0,0 +1,70 @@
+<?php
+namespace Imagify\Tests\Unit\inc\classes\classImagifyViews;
+
+use Brain\Monkey\Functions;
+use Imagify\Tests\Unit\TestCase;
+use Imagify_Views;
+
+/**
+ * Tests for \Imagify_Views->plugin_action_links().
+ *
+ * @covers \Imagify_Views::plugin_action_links
+ * @group  ImagifyAPI
+ */
+class Test_PluginActionLinks extends TestCase {
+    protected $imagify_views;
+    protected $user_data = [
+        'id'                           => 1,
+        'email'                        => '[email protected]',
+        'plan_id'                      => '2',
+        '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,
+    ];
+
+    public function setUp(): void {
+        parent::setUp();
+
+        // Create Imagify_Views instance without calling the constructor
+        $reflection = new \ReflectionClass(Imagify_Views::class);
+        $this->imagify_views = $reflection->newInstanceWithoutConstructor();
+    }
+
+	/**
+	 * Test \Imagify_Views->plugin_action_links() should return Documentation link if plan label is not starter.
+	 */
+	public function testShouldReturnDocumentationLinkAmongPluginLinksIfPlanLabelIsNotStarter() {
+        Functions\when( 'imagify_get_cached_user' )->justReturn( (object) $this->user_data );
+        Functions\when( 'get_imagify_user' )->justReturn( (object) $this->user_data );
+        Functions\when( 'imagify_get_external_url' )->justReturn( 'https://example.org' );
+        Functions\when( 'get_imagify_admin_url' )->justReturn( 'https://example.org' );
+
+        $plugin_action_links = $this->imagify_views->plugin_action_links([]);
+        $plugin_action_links = implode( '|', $plugin_action_links );
+
+        $this->assertStringContainsString( 'Documentation', $plugin_action_links );
+	}
+
+	/**
+	 * Test \Imagify_Views->plugin_action_links() should return Upgrade link if plan label is starter.
+	 */
+	public function testShouldReturnUpgradeLinkAmongPluginLinksIfPlanLabelIsStarter() {
+        $this->user_data['plan_id'] = '1';
+
+        Functions\when( 'imagify_get_cached_user' )->justReturn( (object) $this->user_data );
+        Functions\when( 'get_imagify_user' )->justReturn( (object) $this->user_data );
+        Functions\when( 'imagify_get_external_url' )->justReturn( 'https://example.org' );
+        Functions\when( 'get_imagify_admin_url' )->justReturn( 'https://example.org' );
+
+        $plugin_action_links = $this->imagify_views->plugin_action_links([]);
+        $plugin_action_links = implode( '|', $plugin_action_links );
+
+        $this->assertStringContainsString( 'Upgrade', $plugin_action_links );
+        $this->assertStringContainsString( 'class="imagify-plugin-upgrade"', $plugin_action_links );
+	}
+}

assets/css/admin-bar.css

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

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;

inc/classes/class-imagify-views.php

@@ -222,7 +222,17 @@ public function add_network_menus() {
 	 * @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' ) ) );
+		$user  = new User();
+		$text  = 1 !== $user->plan_id ? __( 'Documentation', 'imagify' ) : __( 'Upgrade', 'imagify' );
+		$url   = 1 !== $user->plan_id ? 'documentation' : 'subscription';
+		$class = 1 !== $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;