Extract get_courses with dependent methods from Sensei_Analysis_Overview_List_Table

includes/reports/overview/list-table/class-sensei-reports-overview-list-table-abstract.php

@@ -329,7 +329,6 @@ public function search_button() {
 		return __( 'Search Courses', 'sensei-lms' );
 	}
 
-
 	/**
 	 * Get the selected course ID.
 	 *

tests/unit-tests/reports/overview/data-provider/test-class-sensei-reports-overview-data-provider-courses.php

@@ -16,7 +16,7 @@ class Sensei_Reports_Overview_Data_Provider_Courses_Test extends WP_UnitTestCase
 	/**
 	 * Set up before each test.
 	 */
-	public function setup() {
+	public function setUp() {
 		parent::setUp();
 
 		$this->factory = new Sensei_Factory();

tests/unit-tests/reports/overview/list-table/test-class-sensei-reports-overview-list-table-abstract.php

@@ -0,0 +1,85 @@
+<?php
+
+class Sensei_Reports_Overview_List_Table_Abstract_Test extends WP_UnitTestCase {
+	private static $initial_hook_suffix;
+
+	public static function setUpBeforeClass() {
+		parent::setUpBeforeClass();
+		self::$initial_hook_suffix = $GLOBALS['hook_suffix'] ?? null;
+		$GLOBALS['hook_suffix']    = null;
+	}
+
+	public static function tearDownAfterClass() {
+		parent::tearDownAfterClass();
+		$GLOBALS['hook_suffix'] = self::$initial_hook_suffix;
+	}
+
+	public function testPrepareItems_WhenCalled_GetsItemsFromDataProvider() {
+		$data_provider = $this->createMock( Sensei_Reports_Overview_Data_Provider_Interface::class );
+
+		$list_table = $this->getMockBuilder( Sensei_Reports_Overview_List_Table_Abstract::class )
+			->setConstructorArgs( [ 'a', $data_provider ] )
+			->getMockForAbstractClass();
+		$list_table->method( 'get_additional_filters' )->willReturn( [ 'a' => 1 ] );
+
+		$data_provider
+			->expects( self::once() )
+			->method( 'get_items' )
+			->with(
+				[
+					'number'  => 20,
+					'offset'  => 0,
+					'orderby' => '',
+					'order'   => 'DESC',
+					'a'       => 1,
+				]
+			)
+			->willReturn( [] );
+		$list_table->prepare_items();
+	}
+
+	public function testGenerateReport_WhenCalled_ReturnsMatchingArray() {
+		$post1 = new WP_Post( new stdClass() );
+		$post2 = new WP_Post( new stdClass() );
+
+		$data_provider = $this->createMock( Sensei_Reports_Overview_Data_Provider_Interface::class );
+		$data_provider
+			->method( 'get_items' )
+			->with(
+				[
+					'number'  => -1,
+					'offset'  => 0,
+					'orderby' => '',
+					'order'   => 'DESC',
+					'a'       => 1,
+				]
+			)
+			->willReturn( [ $post1, $post2 ] );
+
+		$list_table = $this->getMockBuilder( Sensei_Reports_Overview_List_Table_Abstract::class )
+			->setMethods( [ 'get_additional_filters', 'get_row_data' ] )
+			->setConstructorArgs( [ 'a', $data_provider ] )
+			->getMockForAbstractClass();
+		$list_table
+			->method( 'get_additional_filters' )
+			->willReturn( [ 'a' => 1 ] );
+		$list_table
+			->method( 'get_row_data' )
+			->willReturnMap(
+				[
+					[ $post1, [ 'b' => 2 ] ],
+					[ $post2, [ 'c' => 3 ] ],
+				]
+			);
+		$list_table->columns = [ 'd', 'e', 'f' ];
+
+		$actual = $list_table->generate_report();
+
+		$expected = [
+			[ 'd', 'e', 'f' ],
+			[ 'b' => 2 ],
+			[ 'c' => 3 ],
+		];
+		self::assertSame( $expected, $actual );
+	}
+}

tests/unit-tests/reports/overview/list-table/test-class-sensei-reports-overview-list-table-courses.php

@@ -7,4 +7,123 @@
  */
 class Sensei_Reports_Overview_List_Table_Courses_Test extends WP_UnitTestCase {
 
+	private static $initial_hook_suffix;
+
+	/**
+	 * Factory for setting up testing data.
+	 *
+	 * @var Sensei_Factory
+	 */
+	private $factory;
+
+	public static function setUpBeforeClass() {
+		parent::setUpBeforeClass();
+		self::$initial_hook_suffix = $GLOBALS['hook_suffix'] ?? null;
+		$GLOBALS['hook_suffix']    = null;
+	}
+
+	public static function tearDownAfterClass() {
+		parent::tearDownAfterClass();
+		$GLOBALS['hook_suffix'] = self::$initial_hook_suffix;
+	}
+
+	/**
+	 * Set up before each test.
+	 */
+	public function setUp() {
+		parent::setUp();
+
+		$this->factory = new Sensei_Factory();
+	}
+
+	/**
+	 * Tear down after each test.
+	 */
+	public function tearDown() {
+		parent::tearDown();
+
+		$this->factory->tearDown();
+	}
+
+	public function testGetColumns_NoCompletionsFound_ReturnsMatchingArray() {
+		$grading = $this->createMock( Sensei_Grading::class );
+		$grading->method( 'get_courses_average_grade' )->willReturn( 2 );
+		$course = $this->createMock( Sensei_Course::class );
+		$course->method( 'get_days_to_completion_total' )->willReturn( 3 );
+		$list_table              = new Sensei_Reports_Overview_List_Table_Courses(
+			$grading,
+			$course,
+			$this->createMock( Sensei_Reports_Overview_Data_Provider_Interface::class )
+		);
+		$list_table->total_items = 1;
+
+		$actual = $list_table->get_columns();
+
+		$expected = [
+			'title'              => 'Course (1)',
+			'last_activity'      => 'Last Activity',
+			'completions'        => 'Completed (0)',
+			'average_percent'    => 'Average Grade (2%)',
+			'days_to_completion' => 'Days to Completion (3)',
+		];
+
+		self::assertSame( $expected, $actual );
+	}
+
+	public function testGetColumns_CompletionsFound_ReturnsMatchingArray() {
+		$user_id   = $this->factory->user->create();
+		$course_id = $this->factory->course->create();
+		Sensei_Utils::update_course_status( $user_id, $course_id, 'complete' );
+		$grading = $this->createMock( Sensei_Grading::class );
+		$grading->method( 'get_courses_average_grade' )->willReturn( 2 );
+		$course = $this->createMock( Sensei_Course::class );
+		$course->method( 'get_days_to_completion_total' )->willReturn( 3 );
+		$list_table              = new Sensei_Reports_Overview_List_Table_Courses(
+			$grading,
+			$course,
+			$this->createMock( Sensei_Reports_Overview_Data_Provider_Interface::class )
+		);
+		$list_table->total_items = 4;
+
+		$actual = $list_table->get_columns();
+
+		$expected = [
+			'title'              => 'Course (4)',
+			'last_activity'      => 'Last Activity',
+			'completions'        => 'Completed (1)',
+			'average_percent'    => 'Average Grade (2%)',
+			'days_to_completion' => 'Days to Completion (3)',
+		];
+
+		self::assertSame( $expected, $actual );
+	}
+
+	public function testGetSortableColumns_WhenCalled_ReturnsMatchingArray() {
+		$list_table = new Sensei_Reports_Overview_List_Table_Courses(
+			$this->createMock( Sensei_Grading::class ),
+			$this->createMock( Sensei_Course::class ),
+			$this->createMock( Sensei_Reports_Overview_Data_Provider_Interface::class )
+		);
+
+		$actual = $list_table->get_sortable_columns();
+
+		$expected = [
+			'title'           => [ 'title', false ],
+			'completions'     => [ 'completions', false ],
+			'average_percent' => [ 'average_percent', false ],
+		];
+		self::assertSame( $expected, $actual );
+	}
+
+	public function testSearchButton_WhenCalled_ReturnsMatchingString() {
+		$list_table = new Sensei_Reports_Overview_List_Table_Courses(
+			$this->createMock( Sensei_Grading::class ),
+			$this->createMock( Sensei_Course::class ),
+			$this->createMock( Sensei_Reports_Overview_Data_Provider_Interface::class )
+		);
+
+		$actual = $list_table->search_button();
+
+		self::assertSame( 'Search Courses', $actual );
+	}
 }