Jetpack_Sync_Module_Themes - Code Metrics - Inspection of "Jetpack Sync: Sync theme edit event" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/sync_edit_theme ( 9ba294 )

unknown

created 2017-05-08 17:45 UTC

Jetpack_Sync_Module_Themes B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	287
Duplicated Lines	2.44 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
dl	7
loc	287
rs	8.439
c	0
b	0
f	0
wmc	47
lcom	1
cbo	2

17 Methods

Rating	Name	Duplication	Size	Complexity
A	name()	0	3	1
A	init_listeners()	0	18	1
A	detect_theme_edit()	0	4	1
B	detect_theme_deletion()	0	25	5
C	check_upgrader()	7	42	7
A	init_full_sync_listeners()	0	3	1
A	sync_theme_support()	0	11	1
A	enqueue_full_sync_actions()	0	13	1
A	estimate_full_sync_actions()	0	3	1
A	init_before_send()	0	3	1
A	get_full_sync_actions()	0	3	1
A	expand_theme_data()	0	3	1
A	sync_add_widgets_to_sidebar()	0	20	3
B	sync_remove_widgets_from_sidebar()	0	28	5
B	sync_widgets_reordered()	0	22	4
C	sync_sidebar_widgets_actions()	0	50	10
A	get_theme_support_info()	0	18	3

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_Sync_Module_Themes 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_Sync_Module_Themes, and based on these observations, apply Extract Interface, too.

<?php

class Jetpack_Sync_Module_Themes extends Jetpack_Sync_Module {
	function name() {
		return 'themes';
	}

	public function init_listeners( $callable ) {
		add_action( 'switch_theme', array( $this, 'sync_theme_support' ) );
		add_action( 'jetpack_sync_current_theme_support', $callable );
		add_action( 'upgrader_process_complete', array( $this, 'check_upgrader'), 10, 2 );
		add_action( 'jetpack_installed_theme', $callable, 10, 2 );
		add_action( 'jetpack_updated_theme', $callable, 10, 2 );
		add_action( 'delete_site_transient_update_themes', array( $this, 'detect_theme_deletion') );
		add_action( 'jetpack_deleted_theme', $callable );
		add_action( 'wp_redirect', array($this, 'detect_theme_edit') );

		// Sidebar updates.
		add_action( 'update_option_sidebars_widgets', array( $this, 'sync_sidebar_widgets_actions' ), 10, 2 );
		add_action( 'jetpack_widget_added', $callable, 10, 2 );
		add_action( 'jetpack_widget_removed', $callable, 10, 2 );
		add_action( 'jetpack_widget_moved_to_inactive', $callable );
		add_action( 'jetpack_cleared_inactive_widgets', $callable );
		add_action( 'jetpack_widget_reordered', $callable );
	}

	public function detect_theme_edit( $redirect_url ) {
		$url = wp_parse_url( $redirect_url );
		error_log( print_r( $url ) );
	}

	public function detect_theme_deletion() {
		$backtrace = debug_backtrace();
		$delete_theme_call = null;
		foreach ( $backtrace as $call ) {
			if ( isset( $call['function'] ) && 'delete_theme' === $call['function'] ) {
				$delete_theme_call = $call;
				break;
			}
		}
		if ( empty( $delete_theme_call ) ) {
			return;
		}

		$slug = $delete_theme_call['args'][0];

		/**
		 * Signals to the sync listener that a theme was deleted and a sync action
		 * reflecting the deletion and theme slug should be sent
		 *
		 * @since 5.0.0
		 *
		 * @param string $slug Theme slug
		 */
		do_action( 'jetpack_deleted_theme', $slug );
	}

	public function check_upgrader( $upgrader, $details) {
		if ( ! isset( $details['type'] ) ||
			'theme' !== $details['type'] ||
			is_wp_error( $upgrader->skin->result ) ||
			! method_exists( $upgrader, 'theme_info' )
		) {
			return;
		}

		$theme = $upgrader->theme_info();
		$theme_info = array(
			'name' => $theme->get( 'Name' ),
			'version' => $theme->get( 'Version' ),
			'uri' => $theme->get( 'ThemeURI' ),
		);

		if ( 'install' === $details['action'] ) {
			/**
			 * Signals to the sync listener that a theme was installed and a sync action
			 * reflecting the installation and the theme info should be sent
			 *
			 * @since 4.9.0
			 *
			 * @param string $theme->theme_root Text domain of the theme
			 * @param mixed $theme_info Array of abbreviated theme info
			 */
			do_action( 'jetpack_installed_theme', $theme->stylesheet, $theme_info );
		}

		if ( 'update' === $details['action'] ) {
			/**
			 * Signals to the sync listener that a theme was updated and a sync action
			 * reflecting the update and the theme info should be sent
			 *
			 * @since 4.9.0
			 *
			 * @param string $theme->theme_root Text domain of the theme
			 * @param mixed $theme_info Array of abbreviated theme info
			 */
			do_action( 'jetpack_updated_theme', $theme->stylesheet, $theme_info );
		}
	}

	public function init_full_sync_listeners( $callable ) {
		add_action( 'jetpack_full_sync_theme_data', $callable );
	}

	public function sync_theme_support() {
		/**
		 * Fires when the client needs to sync theme support info
		 * Only sends theme support attributes whitelisted in Jetpack_Sync_Defaults::$default_theme_support_whitelist
		 *
		 * @since 4.2.0
		 *
		 * @param object the theme support hash
		 */
		do_action( 'jetpack_sync_current_theme_support' , $this->get_theme_support_info() );
	}

	public function enqueue_full_sync_actions( $config, $max_items_to_enqueue, $state ) {
		/**
		 * Tells the client to sync all theme data to the server
		 *
		 * @since 4.2.0
		 *
		 * @param boolean Whether to expand theme data (should always be true)
		 */
		do_action( 'jetpack_full_sync_theme_data', true );

		// The number of actions enqueued, and next module state (true == done)
		return array( 1, true );
	}

	public function estimate_full_sync_actions( $config ) {
		return 1;
	}
	
	public function init_before_send() {
		add_filter( 'jetpack_sync_before_send_jetpack_full_sync_theme_data', array( $this, 'expand_theme_data' ) );
	}

	function get_full_sync_actions() {
		return array( 'jetpack_full_sync_theme_data' );
	}

	function expand_theme_data() {
		return array( $this->get_theme_support_info() );
	}

	function sync_add_widgets_to_sidebar( $new_widgets, $old_widgets, $sidebar ) {
		$added_widgets = array_diff( $new_widgets, $old_widgets );
		if ( empty( $added_widgets ) ) {
			return array();
		}
		$moved_to_sidebar = array();
		foreach ( $added_widgets as $added_widget ) {
			$moved_to_sidebar[] = $added_widget;
			/**
			 * Helps Sync log that a widget got added
			 *
			 * @since 4.9.0
			 *
			 * @param string $sidebar, Sidebar id got changed
			 * @param string $added_widget, Widget id got added
			 */
			do_action( 'jetpack_widget_added', $sidebar, $added_widget );
		}
		return $moved_to_sidebar;
	}

	function sync_remove_widgets_from_sidebar( $new_widgets, $old_widgets, $sidebar, $inactive_widgets  ) {
		$removed_widgets = array_diff( $old_widgets, $new_widgets );

		if ( empty( $removed_widgets ) ) {
			return array();
		}

		$moved_to_inactive = array();

		foreach( $removed_widgets as $removed_widget ) {
			// Lets check if we didn't move the widget to in_active_widgets
			if ( isset( $inactive_widgets ) && ! in_array( $removed_widget, $inactive_widgets ) ) {
				/**
				 * Helps Sync log that a widgte got removed
				 *
				 * @since 4.9.0
				 *
				 * @param string $sidebar, Sidebar id got changed
				 * @param string $removed_widget, Widget id got removed
				 */
				do_action( 'jetpack_widget_removed', $sidebar, $removed_widget );
			} else {
				$moved_to_inactive[] = $removed_widget;
			}
		}
		return $moved_to_inactive;

	}

	function sync_widgets_reordered( $new_widgets, $old_widgets, $sidebar ) {
		$added_widgets = array_diff( $new_widgets, $old_widgets );
		if ( ! empty( $added_widgets ) ) {
			return;
		}
		$removed_widgets = array_diff( $old_widgets, $new_widgets );
		if ( ! empty( $removed_widgets ) ) {
			return;
		}

		if ( serialize( $old_widgets ) !== serialize( $new_widgets ) ) {
			/**
			 * Helps Sync log that a sidebar id got reordered
			 *
			 * @since 4.9.0
			 *
			 * @param string $sidebar, Sidebar id got changed
			 */
			do_action( 'jetpack_widget_reordered', $sidebar );
		}

	}

	function sync_sidebar_widgets_actions( $old_value, $new_value ) {

		// Don't really know how to deal with different array_values yet.
		if ( $old_value['array_version'] !== 3 || $new_value['array_version'] !== 3 ) {
			return;
		}

		$moved_to_inactive = array();
		$moved_to_sidebar = array();

		foreach ( $new_value as $sidebar => $new_widgets ) {
			if ( in_array( $sidebar, array( 'array_version', 'wp_inactive_widgets' ) ) ) {
				continue;
			}
			$old_widgets = isset( $old_value[ $sidebar ] )
				? $old_value[ $sidebar ]
				: array();

			$moved_to_inactive_recently = $this->sync_remove_widgets_from_sidebar( $new_widgets, $old_widgets, $sidebar, $new_value['wp_inactive_widgets'] );
			$moved_to_inactive = array_merge( $moved_to_inactive, $moved_to_inactive_recently );


			$moved_to_sidebar_recently = $this->sync_add_widgets_to_sidebar( $new_widgets, $old_widgets, $sidebar );
			$moved_to_sidebar = array_merge( $moved_to_sidebar, $moved_to_sidebar_recently );

			$this->sync_widgets_reordered( $new_widgets, $old_widgets, $sidebar );

		}

		// Treat inactive sidebar a bit differently
		if ( ! empty( $moved_to_inactive ) ) {
			/**
			 * Helps Sync log that a widgets IDs got moved to in active
			 *
			 * @since 4.9.0
			 *
			 * @param array $sidebar, Sidebar id got changed
			 */
			do_action( 'jetpack_widget_moved_to_inactive', $moved_to_inactive );
		} elseif ( empty( $moved_to_sidebar ) &&
		           empty( $new_value['wp_inactive_widgets']) &&
		           ! empty( $old_value['wp_inactive_widgets'] ) ) {
			/**
			 * Helps Sync log that a got cleared from inactive.
			 *
			 * @since 4.9.0
			 */
			do_action( 'jetpack_cleared_inactive_widgets' );
		} 
	}

	private function get_theme_support_info() {
		global $_wp_theme_features;

		$theme_support = array();

		foreach ( Jetpack_Sync_Defaults::$default_theme_support_whitelist as $theme_feature ) {

			$has_support = current_theme_supports( $theme_feature );
			if ( $has_support ) {
				$theme_support[ $theme_feature ] = $_wp_theme_features[ $theme_feature ];
			}
		}

		$theme = wp_get_theme();
		$theme_support['name'] = $theme->name;
		$theme_support['version'] =  $theme->version;

		return $theme_support;
	}
}


1		<?php
2
3		class Jetpack_Sync_Module_Themes extends Jetpack_Sync_Module {
4		function name() {
5		return 'themes';
6		}
7
8		public function init_listeners( $callable ) {
9		add_action( 'switch_theme', array( $this, 'sync_theme_support' ) );
10		add_action( 'jetpack_sync_current_theme_support', $callable );
11		add_action( 'upgrader_process_complete', array( $this, 'check_upgrader'), 10, 2 );
12		add_action( 'jetpack_installed_theme', $callable, 10, 2 );
13		add_action( 'jetpack_updated_theme', $callable, 10, 2 );
14		add_action( 'delete_site_transient_update_themes', array( $this, 'detect_theme_deletion') );
15		add_action( 'jetpack_deleted_theme', $callable );
16		add_action( 'wp_redirect', array($this, 'detect_theme_edit') );
17
18		// Sidebar updates.
19		add_action( 'update_option_sidebars_widgets', array( $this, 'sync_sidebar_widgets_actions' ), 10, 2 );
20		add_action( 'jetpack_widget_added', $callable, 10, 2 );
21		add_action( 'jetpack_widget_removed', $callable, 10, 2 );
22		add_action( 'jetpack_widget_moved_to_inactive', $callable );
23		add_action( 'jetpack_cleared_inactive_widgets', $callable );
24		add_action( 'jetpack_widget_reordered', $callable );
25		}
26
27		public function detect_theme_edit( $redirect_url ) {
28		$url = wp_parse_url( $redirect_url );
29		error_log( print_r( $url ) );
30		}
31
32		public function detect_theme_deletion() {
33		$backtrace = debug_backtrace();
34		$delete_theme_call = null;
35		foreach ( $backtrace as $call ) {
36		if ( isset( $call['function'] ) && 'delete_theme' === $call['function'] ) {
37		$delete_theme_call = $call;
38		break;
39		}
40		}
41		if ( empty( $delete_theme_call ) ) {
42		return;
43		}
44
45		$slug = $delete_theme_call['args'][0];
46
47		/**
48		* Signals to the sync listener that a theme was deleted and a sync action
49		* reflecting the deletion and theme slug should be sent
50		*
51		* @since 5.0.0
52		*
53		* @param string $slug Theme slug
54		*/
55		do_action( 'jetpack_deleted_theme', $slug );
56		}
57
58		public function check_upgrader( $upgrader, $details) {
59	View Code Duplication	if ( ! isset( $details['type'] ) \|\|
60		'theme' !== $details['type'] \|\|
61		is_wp_error( $upgrader->skin->result ) \|\|
62		! method_exists( $upgrader, 'theme_info' )
63		) {
64		return;
65		}
66
67		$theme = $upgrader->theme_info();
68		$theme_info = array(
69		'name' => $theme->get( 'Name' ),
70		'version' => $theme->get( 'Version' ),
71		'uri' => $theme->get( 'ThemeURI' ),
72		);
73
74		if ( 'install' === $details['action'] ) {
75		/**
76		* Signals to the sync listener that a theme was installed and a sync action
77		* reflecting the installation and the theme info should be sent
78		*
79		* @since 4.9.0
80		*
81		* @param string $theme->theme_root Text domain of the theme
82		* @param mixed $theme_info Array of abbreviated theme info
83		*/
84		do_action( 'jetpack_installed_theme', $theme->stylesheet, $theme_info );
85		}
86
87		if ( 'update' === $details['action'] ) {
88		/**
89		* Signals to the sync listener that a theme was updated and a sync action
90		* reflecting the update and the theme info should be sent
91		*
92		* @since 4.9.0
93		*
94		* @param string $theme->theme_root Text domain of the theme
95		* @param mixed $theme_info Array of abbreviated theme info
96		*/
97		do_action( 'jetpack_updated_theme', $theme->stylesheet, $theme_info );
98		}
99		}
100
101		public function init_full_sync_listeners( $callable ) {
102		add_action( 'jetpack_full_sync_theme_data', $callable );
103		}
104
105		public function sync_theme_support() {
106		/**
107		* Fires when the client needs to sync theme support info
108		* Only sends theme support attributes whitelisted in Jetpack_Sync_Defaults::$default_theme_support_whitelist
109		*
110		* @since 4.2.0
111		*
112		* @param object the theme support hash
113		*/
114		do_action( 'jetpack_sync_current_theme_support' , $this->get_theme_support_info() );
115		}
116
117		public function enqueue_full_sync_actions( $config, $max_items_to_enqueue, $state ) {
118		/**
119		* Tells the client to sync all theme data to the server
120		*
121		* @since 4.2.0
122		*
123		* @param boolean Whether to expand theme data (should always be true)
124		*/
125		do_action( 'jetpack_full_sync_theme_data', true );
126
127		// The number of actions enqueued, and next module state (true == done)
128		return array( 1, true );
129		}
130
131		public function estimate_full_sync_actions( $config ) {
132		return 1;
133		}
134
135		public function init_before_send() {
136		add_filter( 'jetpack_sync_before_send_jetpack_full_sync_theme_data', array( $this, 'expand_theme_data' ) );
137		}
138
139		function get_full_sync_actions() {
140		return array( 'jetpack_full_sync_theme_data' );
141		}
142
143		function expand_theme_data() {
144		return array( $this->get_theme_support_info() );
145		}
146
147		function sync_add_widgets_to_sidebar( $new_widgets, $old_widgets, $sidebar ) {
148		$added_widgets = array_diff( $new_widgets, $old_widgets );
149		if ( empty( $added_widgets ) ) {
150		return array();
151		}
152		$moved_to_sidebar = array();
153		foreach ( $added_widgets as $added_widget ) {
154		$moved_to_sidebar[] = $added_widget;
155		/**
156		* Helps Sync log that a widget got added
157		*
158		* @since 4.9.0
159		*
160		* @param string $sidebar, Sidebar id got changed
161		* @param string $added_widget, Widget id got added
162		*/
163		do_action( 'jetpack_widget_added', $sidebar, $added_widget );
164		}
165		return $moved_to_sidebar;
166		}
167
168		function sync_remove_widgets_from_sidebar( $new_widgets, $old_widgets, $sidebar, $inactive_widgets ) {
169		$removed_widgets = array_diff( $old_widgets, $new_widgets );
170
171		if ( empty( $removed_widgets ) ) {
172		return array();
173		}
174
175		$moved_to_inactive = array();
176
177		foreach( $removed_widgets as $removed_widget ) {
178		// Lets check if we didn't move the widget to in_active_widgets
179		if ( isset( $inactive_widgets ) && ! in_array( $removed_widget, $inactive_widgets ) ) {
180		/**
181		* Helps Sync log that a widgte got removed
182		*
183		* @since 4.9.0
184		*
185		* @param string $sidebar, Sidebar id got changed
186		* @param string $removed_widget, Widget id got removed
187		*/
188		do_action( 'jetpack_widget_removed', $sidebar, $removed_widget );
189		} else {
190		$moved_to_inactive[] = $removed_widget;
191		}
192		}
193		return $moved_to_inactive;
194
195		}
196
197		function sync_widgets_reordered( $new_widgets, $old_widgets, $sidebar ) {
198		$added_widgets = array_diff( $new_widgets, $old_widgets );
199		if ( ! empty( $added_widgets ) ) {
200		return;
201		}
202		$removed_widgets = array_diff( $old_widgets, $new_widgets );
203		if ( ! empty( $removed_widgets ) ) {
204		return;
205		}
206
207		if ( serialize( $old_widgets ) !== serialize( $new_widgets ) ) {
208		/**
209		* Helps Sync log that a sidebar id got reordered
210		*
211		* @since 4.9.0
212		*
213		* @param string $sidebar, Sidebar id got changed
214		*/
215		do_action( 'jetpack_widget_reordered', $sidebar );
216		}
217
218		}
219
220		function sync_sidebar_widgets_actions( $old_value, $new_value ) {
221
222		// Don't really know how to deal with different array_values yet.
223		if ( $old_value['array_version'] !== 3 \|\| $new_value['array_version'] !== 3 ) {
224		return;
225		}
226
227		$moved_to_inactive = array();
228		$moved_to_sidebar = array();
229
230		foreach ( $new_value as $sidebar => $new_widgets ) {
231		if ( in_array( $sidebar, array( 'array_version', 'wp_inactive_widgets' ) ) ) {
232		continue;
233		}
234		$old_widgets = isset( $old_value[ $sidebar ] )
235		? $old_value[ $sidebar ]
236		: array();
237
238		$moved_to_inactive_recently = $this->sync_remove_widgets_from_sidebar( $new_widgets, $old_widgets, $sidebar, $new_value['wp_inactive_widgets'] );
239		$moved_to_inactive = array_merge( $moved_to_inactive, $moved_to_inactive_recently );
240
241
242		$moved_to_sidebar_recently = $this->sync_add_widgets_to_sidebar( $new_widgets, $old_widgets, $sidebar );
243		$moved_to_sidebar = array_merge( $moved_to_sidebar, $moved_to_sidebar_recently );
244
245		$this->sync_widgets_reordered( $new_widgets, $old_widgets, $sidebar );
246
247		}
248
249		// Treat inactive sidebar a bit differently
250		if ( ! empty( $moved_to_inactive ) ) {
251		/**
252		* Helps Sync log that a widgets IDs got moved to in active
253		*
254		* @since 4.9.0
255		*
256		* @param array $sidebar, Sidebar id got changed
257		*/
258		do_action( 'jetpack_widget_moved_to_inactive', $moved_to_inactive );
259		} elseif ( empty( $moved_to_sidebar ) &&
260		empty( $new_value['wp_inactive_widgets']) &&
261		! empty( $old_value['wp_inactive_widgets'] ) ) {
262		/**
263		* Helps Sync log that a got cleared from inactive.
264		*
265		* @since 4.9.0
266		*/
267		do_action( 'jetpack_cleared_inactive_widgets' );
268		}
269		}
270
271		private function get_theme_support_info() {
272		global $_wp_theme_features;
273
274		$theme_support = array();
275
276		foreach ( Jetpack_Sync_Defaults::$default_theme_support_whitelist as $theme_feature ) {
		0 ignored issues – show Bug introduced 2016-04-27 23:36 UTC by Report Bug Copy Issue Report The property `default_theme_support_whitelist` cannot be accessed from this context as it is declared `private` in class `Jetpack_Sync_Defaults`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
277		$has_support = current_theme_supports( $theme_feature );
278		if ( $has_support ) {
279		$theme_support[ $theme_feature ] = $_wp_theme_features[ $theme_feature ];
280		}
281		}
282
283		$theme = wp_get_theme();
284		$theme_support['name'] = $theme->name;
285		$theme_support['version'] = $theme->version;
286
287		return $theme_support;
288		}
289		}
290

Automattic / jetpack