Jetpack_Admin_Page - Code Metrics - Inspection of "General: Create test class for Jetpack_Options wit..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/jetpack-options-tests-file ( 8ce060...d6f196 )

unknown

created 2016-11-28 19:43 UTC

Jetpack_Admin_Page B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	215
Duplicated Lines	6.05 %

Coupling/Cohesion

Components	4
Dependencies	2

Importance

Changes

Metric	Value
dl	13
loc	215
rs	8.295
c	0
b	0
f	0
wmc	42
lcom	4
cbo	2

17 Methods

Rating	Name	Duplication	Size	Complexity
	add_page_actions()	0	1	?
	get_page_hook()	0	1	?
	page_admin_scripts()	0	1	?
	page_render()	0	1	?
A	additional_styles()	0	1	1
A	__construct()	0	10	3
B	add_actions()	0	30	6
A	admin_head()	13	15	4
A	render()	0	8	2
A	admin_help()	0	3	1
A	admin_page_load()	0	4	1
A	admin_page_top()	0	3	1
A	admin_page_bottom()	0	3	1
A	admin_scripts()	0	4	1
A	admin_styles()	0	7	3
A	is_wp_version_too_old()	0	4	2
C	check_plan_deactivate_modules()	0	65	16

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Jetpack_Admin_Page often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Jetpack_Admin_Page, and based on these observations, apply Extract Interface, too.

<?php

// Shared logic between Jetpack admin pages
abstract class Jetpack_Admin_Page {
	// Add page specific actions given the page hook
	abstract function add_page_actions( $hook );

	// Create a menu item for the page and returns the hook
	abstract function get_page_hook();

	// Enqueue and localize page specific scripts
	abstract function page_admin_scripts();

	// Render page specific HTML
	abstract function page_render();

	/**
	 * Should we block the page rendering because the site is in IDC?
	 * @var bool
	 */
	static $block_page_rendering_for_idc;
class A {
    var $property;
}

	/**
	 * Flag to know if we already checked the plan.
	 *
	 * @since 4.4.0
	 *
	 * @var bool
	 */
	static $plan_checked = false;
class A {
    var $property;
}

	/**
	 * Function called after admin_styles to load any additional needed styles.
	 *
	 * @since 4.3.0
	 */
	function additional_styles() {}

	function __construct() {
		$this->jetpack = Jetpack::init();
class MyClass { }

$x = new MyClass();
$x->foo = true;
		self::$block_page_rendering_for_idc = (
			Jetpack::validate_sync_error_idc_option() && ! Jetpack_Options::get_option( 'safe_mode_confirmed' )
		);

		if ( ! self::$block_page_rendering_for_idc ) {
			add_action( 'admin_enqueue_scripts', array( $this, 'additional_styles' ) );
		}
	}

	function add_actions() {

		// If user is not an admin and site is in Dev Mode, don't do anything
		if ( ! current_user_can( 'manage_options' ) && Jetpack::is_development_mode() ) {
			return;
		}

		// Don't add in the modules page unless modules are available!
		if ( $this->dont_show_if_not_active && ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
			return;
		}

		// Initialize menu item for the page in the admin
		$hook = $this->get_page_hook();

		// Attach hooks common to all Jetpack admin pages based on the created
		// hook
		add_action( "load-$hook",                array( $this, 'admin_help'      ) );
		add_action( "load-$hook",                array( $this, 'admin_page_load' ) );
		add_action( "admin_head-$hook",          array( $this, 'admin_head'      ) );

		add_action( "admin_print_styles-$hook",  array( $this, 'admin_styles'    ) );
		add_action( "admin_print_scripts-$hook", array( $this, 'admin_scripts'   ) );

		// Check if the site plan changed and deactivate modules accordingly.
		add_action( 'current_screen', array( $this, 'check_plan_deactivate_modules' ) );

		// Attach page specific actions in addition to the above
		$this->add_page_actions( $hook );
	}

	function admin_head() {
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
			/**
			 * Fires in the <head> of a particular Jetpack configuation page.
			 *
			 * The dynamic portion of the hook name, `$_GET['configure']`,
			 * refers to the slug of module, such as 'stats', 'sso', etc.
			 * A complete hook for the latter would be
			 * 'jetpack_module_configuation_head_sso'.
			 *
			 * @since 3.0.0
			 */
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
		}
	}

	// Render the page with a common top and bottom part, and page specific content
	function render() {
		// We're in an IDC: we need a decision made before we show the UI again.
		if ( self::$block_page_rendering_for_idc ) {
			return;
		}

		$this->page_render();
	}

	function admin_help() {
		$this->jetpack->admin_help();
	}

	function admin_page_load() {
		// This is big.  For the moment, just call the existing one.
		$this->jetpack->admin_page_load();
	}

	function admin_page_top() {
		include_once( JETPACK__PLUGIN_DIR . '_inc/header.php' );
	}

	function admin_page_bottom() {
		include_once( JETPACK__PLUGIN_DIR . '_inc/footer.php' );
	}

	// Add page specific scripts and jetpack stats for all menu pages
	function admin_scripts() {
		$this->page_admin_scripts(); // Delegate to inheriting class
		add_action( 'admin_footer', array( $this->jetpack, 'do_stats' ) );
	}

	// Enqueue the Jetpack admin stylesheet
	function admin_styles() {
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';

		wp_enqueue_style( 'jetpack-admin', plugins_url( "css/jetpack-admin{$min}.css", JETPACK__PLUGIN_FILE ), array( 'genericons' ), JETPACK__VERSION . '-20121016' );
		wp_style_add_data( 'jetpack-admin', 'rtl', 'replace' );
		wp_style_add_data( 'jetpack-admin', 'suffix', $min );
	}

	function is_wp_version_too_old() {
		global $wp_version;
		return ( ! function_exists( 'rest_api_init' ) || version_compare( $wp_version, '4.4-z', '<=' ) );
	}

	/**
	 * Checks the site plan and deactivates modules that were active but are no longer included in the plan.
	 *
	 * @since 4.4.0
	 *
	 * @param $page
	 *
	 * @return bool|array
	 */
	function check_plan_deactivate_modules( $page ) {
		if (
			Jetpack::is_development_mode()
			|| ! in_array(
				$page->base,
				array(
					'toplevel_page_jetpack',
					'admin_page_jetpack_modules',
					'jetpack_page_vaultpress',
					'jetpack_page_stats',
					'jetpack_page_akismet-key-config'
				)
			)
			|| true === self::$plan_checked
		) {
			return false;
		}

		self::$plan_checked = true;
		$previous = get_option( 'jetpack_active_plan', '' );
		$response = rest_do_request( new WP_REST_Request( 'GET', '/jetpack/v4/site' ) );

		if ( ! is_object( $response ) || $response->is_error() ) {

			// If we can't get information about the current plan we don't do anything
			self::$plan_checked = true;
			return;
		}

		$current = $response->get_data();
		$current = json_decode( $current['data'] );

		$to_deactivate = array();
		if ( isset( $current->plan->product_slug ) ) {
			if (
				empty( $previous )
				|| ! isset( $previous['product_slug'] )
				|| $previous['product_slug'] !== $current->plan->product_slug
			) {
				$active = Jetpack::get_active_modules();
				switch ( $current->plan->product_slug ) {
					case 'jetpack_free':
						$to_deactivate = array( 'seo-tools', 'videopress' );
						break;
					case 'jetpack_personal':
					case 'jetpack_personal_monthly':
						$to_deactivate = array( 'seo-tools', 'videopress' );
						break;
					case 'jetpack_premium':
					case 'jetpack_premium_monthly':
						$to_deactivate = array( 'seo-tools' );
						break;
				}
				$to_deactivate = array_intersect( $active, $to_deactivate );
				if ( ! empty( $to_deactivate ) ) {
					Jetpack::update_active_modules( array_filter( array_diff( $active, $to_deactivate ) ) );
				}
			}
		}
		return array(
			'previous'   => $previous,
			'current'    => $current,
			'deactivate' => $to_deactivate
		);
	}
}


1		<?php
2
3		// Shared logic between Jetpack admin pages
4		abstract class Jetpack_Admin_Page {
5		// Add page specific actions given the page hook
6		abstract function add_page_actions( $hook );
7
8		// Create a menu item for the page and returns the hook
9		abstract function get_page_hook();
10
11		// Enqueue and localize page specific scripts
12		abstract function page_admin_scripts();
13
14		// Render page specific HTML
15		abstract function page_render();
16
17		/**
18		* Should we block the page rendering because the site is in IDC?
19		* @var bool
20		*/
21		static $block_page_rendering_for_idc;
		0 ignored issues – show Coding Style introduced 2016-11-14 20:40 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$block_page_rendering_for_idc`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
22
23		/**
24		* Flag to know if we already checked the plan.
25		*
26		* @since 4.4.0
27		*
28		* @var bool
29		*/
30		static $plan_checked = false;
		0 ignored issues – show Coding Style introduced 2016-11-18 18:47 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$plan_checked`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
31
32		/**
33		* Function called after admin_styles to load any additional needed styles.
34		*
35		* @since 4.3.0
36		*/
37		function additional_styles() {}
38
39		function __construct() {
40		$this->jetpack = Jetpack::init();
		0 ignored issues – show Bug introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report The property `jetpack` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
41		self::$block_page_rendering_for_idc = (
42		Jetpack::validate_sync_error_idc_option() && ! Jetpack_Options::get_option( 'safe_mode_confirmed' )
43		);
44
45		if ( ! self::$block_page_rendering_for_idc ) {
46		add_action( 'admin_enqueue_scripts', array( $this, 'additional_styles' ) );
47		}
48		}
49
50		function add_actions() {
51
52		// If user is not an admin and site is in Dev Mode, don't do anything
53		if ( ! current_user_can( 'manage_options' ) && Jetpack::is_development_mode() ) {
54		return;
55		}
56
57		// Don't add in the modules page unless modules are available!
58		if ( $this->dont_show_if_not_active && ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
		0 ignored issues – show Bug introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report The property `dont_show_if_not_active` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
59		return;
60		}
61
62		// Initialize menu item for the page in the admin
63		$hook = $this->get_page_hook();
64
65		// Attach hooks common to all Jetpack admin pages based on the created
66		// hook
67		add_action( "load-$hook", array( $this, 'admin_help' ) );
68		add_action( "load-$hook", array( $this, 'admin_page_load' ) );
69		add_action( "admin_head-$hook", array( $this, 'admin_head' ) );
70
71		add_action( "admin_print_styles-$hook", array( $this, 'admin_styles' ) );
72		add_action( "admin_print_scripts-$hook", array( $this, 'admin_scripts' ) );
73
74		// Check if the site plan changed and deactivate modules accordingly.
75		add_action( 'current_screen', array( $this, 'check_plan_deactivate_modules' ) );
76
77		// Attach page specific actions in addition to the above
78		$this->add_page_actions( $hook );
79		}
80
81		function admin_head() {
82	View Code Duplication	if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
83		/**
84		* Fires in the <head> of a particular Jetpack configuation page.
85		*
86		* The dynamic portion of the hook name, `$_GET['configure']`,
87		* refers to the slug of module, such as 'stats', 'sso', etc.
88		* A complete hook for the latter would be
89		* 'jetpack_module_configuation_head_sso'.
90		*
91		* @since 3.0.0
92		*/
93		do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
94		}
95		}
96
97		// Render the page with a common top and bottom part, and page specific content
98		function render() {
99		// We're in an IDC: we need a decision made before we show the UI again.
100		if ( self::$block_page_rendering_for_idc ) {
101		return;
102		}
103
104		$this->page_render();
105		}
106
107		function admin_help() {
108		$this->jetpack->admin_help();
109		}
110
111		function admin_page_load() {
112		// This is big. For the moment, just call the existing one.
113		$this->jetpack->admin_page_load();
114		}
115
116		function admin_page_top() {
117		include_once( JETPACK__PLUGIN_DIR . '_inc/header.php' );
118		}
119
120		function admin_page_bottom() {
121		include_once( JETPACK__PLUGIN_DIR . '_inc/footer.php' );
122		}
123
124		// Add page specific scripts and jetpack stats for all menu pages
125		function admin_scripts() {
126		$this->page_admin_scripts(); // Delegate to inheriting class
127		add_action( 'admin_footer', array( $this->jetpack, 'do_stats' ) );
128		}
129
130		// Enqueue the Jetpack admin stylesheet
131		function admin_styles() {
132		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
133
134		wp_enqueue_style( 'jetpack-admin', plugins_url( "css/jetpack-admin{$min}.css", JETPACK__PLUGIN_FILE ), array( 'genericons' ), JETPACK__VERSION . '-20121016' );
135		wp_style_add_data( 'jetpack-admin', 'rtl', 'replace' );
136		wp_style_add_data( 'jetpack-admin', 'suffix', $min );
137		}
138
139		function is_wp_version_too_old() {
140		global $wp_version;
141		return ( ! function_exists( 'rest_api_init' ) \|\| version_compare( $wp_version, '4.4-z', '<=' ) );
142		}
143
144		/**
145		* Checks the site plan and deactivates modules that were active but are no longer included in the plan.
146		*
147		* @since 4.4.0
148		*
149		* @param $page
150		*
151		* @return bool\|array
152		*/
153		function check_plan_deactivate_modules( $page ) {
154		if (
155		Jetpack::is_development_mode()
156		\|\| ! in_array(
157		$page->base,
158		array(
159		'toplevel_page_jetpack',
160		'admin_page_jetpack_modules',
161		'jetpack_page_vaultpress',
162		'jetpack_page_stats',
163		'jetpack_page_akismet-key-config'
164		)
165		)
166		\|\| true === self::$plan_checked
167		) {
168		return false;
169		}
170
171		self::$plan_checked = true;
172		$previous = get_option( 'jetpack_active_plan', '' );
173		$response = rest_do_request( new WP_REST_Request( 'GET', '/jetpack/v4/site' ) );
174
175		if ( ! is_object( $response ) \|\| $response->is_error() ) {
176
177		// If we can't get information about the current plan we don't do anything
178		self::$plan_checked = true;
179		return;
180		}
181
182		$current = $response->get_data();
183		$current = json_decode( $current['data'] );
184
185		$to_deactivate = array();
186		if ( isset( $current->plan->product_slug ) ) {
187		if (
188		empty( $previous )
189		\|\| ! isset( $previous['product_slug'] )
190		\|\| $previous['product_slug'] !== $current->plan->product_slug
191		) {
192		$active = Jetpack::get_active_modules();
193		switch ( $current->plan->product_slug ) {
194		case 'jetpack_free':
195		$to_deactivate = array( 'seo-tools', 'videopress' );
196		break;
197		case 'jetpack_personal':
198		case 'jetpack_personal_monthly':
199		$to_deactivate = array( 'seo-tools', 'videopress' );
200		break;
201		case 'jetpack_premium':
202		case 'jetpack_premium_monthly':
203		$to_deactivate = array( 'seo-tools' );
204		break;
205		}
206		$to_deactivate = array_intersect( $active, $to_deactivate );
207		if ( ! empty( $to_deactivate ) ) {
208		Jetpack::update_active_modules( array_filter( array_diff( $active, $to_deactivate ) ) );
209		}
210		}
211		}
212		return array(
213		'previous' => $previous,
214		'current' => $current,
215		'deactivate' => $to_deactivate
216		);
217		}
218		}
219

Automattic / jetpack