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:
Complex classes like Jetpack_Gutenberg 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_Gutenberg, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
30 | class Jetpack_Gutenberg { |
||
31 | |||
32 | /** |
||
33 | * Array of blocks we will be registering. |
||
34 | * |
||
35 | * @var array $blocks Array of blocks we will be registering. |
||
36 | */ |
||
37 | private static $jetpack_blocks = array(); |
||
38 | private static $blocks_index = array(); |
||
39 | /** |
||
40 | * Add a block to the list of blocks to be registered. |
||
41 | * |
||
42 | * @param string $type Slug of the block. |
||
43 | * @param array $args Arguments that are passed into the register_block_type. |
||
44 | */ |
||
45 | public static function add_block( $type, $args, $availability ) { |
||
48 | |||
49 | /** |
||
50 | * Register all Jetpack blocks available. |
||
51 | * |
||
52 | * @return void|WP_Block_Type|false The registered block type on success, or false on failure. |
||
53 | */ |
||
54 | public static function load_blocks() { |
||
85 | |||
86 | /** |
||
87 | * Return the Gutenberg extensions (blocks and plugins) directory |
||
88 | * |
||
89 | * @return string The Gutenberg extensions directory |
||
90 | */ |
||
91 | public static function get_blocks_directory() { |
||
101 | |||
102 | /** |
||
103 | * Checks for a given .json file in the blocks folder. |
||
104 | * |
||
105 | * @param $preset The name of the .json file to look for. |
||
106 | * |
||
107 | * @return bool True if the file is found. |
||
108 | */ |
||
109 | public static function preset_exists( $preset ) { |
||
112 | |||
113 | /** |
||
114 | * Decodes JSON loaded from a preset file in the blocks folder |
||
115 | * |
||
116 | * @param $preset The name of the .json file to load. |
||
117 | * |
||
118 | * @return mixed Returns an object if the file is present, or false if a valid .json file is not present. |
||
119 | */ |
||
120 | public static function get_preset( $preset ) { |
||
123 | |||
124 | /** |
||
125 | * Filters the results of `apply_filter( 'jetpack_set_available_blocks', array() )` |
||
126 | * using the merged contents of `blocks-manifest.json` ( $preset_blocks ) |
||
127 | * and self::$jetpack_blocks ( $internal_blocks ) |
||
128 | * |
||
129 | * @param $blocks The default list. |
||
130 | * |
||
131 | * @return array A list of blocks: eg [ 'publicize', 'markdown' ] |
||
132 | */ |
||
133 | public static function jetpack_set_available_blocks( $blocks ) { |
||
145 | |||
146 | /** |
||
147 | * @return array A list of block-availability information, eg: [ "publicize" => ["available" => true ], "markdown" => [ "available" => false, "unavailable_reason" => 'missing_module' ] ] |
||
148 | */ |
||
149 | public static function get_block_availability() { |
||
183 | |||
184 | /** |
||
185 | * Check if Gutenberg editor is available |
||
186 | * |
||
187 | * @since 6.7.0 |
||
188 | * |
||
189 | * @return bool |
||
190 | */ |
||
191 | public static function is_gutenberg_available() { |
||
194 | |||
195 | /** |
||
196 | * Check whether conditions indicate Gutenberg blocks should be loaded |
||
197 | * |
||
198 | * Loading blocks is enabled by default and may be disabled via filter: |
||
199 | * add_filter( 'jetpack_gutenberg', '__return_false' ); |
||
200 | * |
||
201 | * @since 6.7.0 |
||
202 | * |
||
203 | * @return bool |
||
204 | */ |
||
205 | public static function should_load_blocks() { |
||
219 | |||
220 | /** |
||
221 | * Only enqueue block assets when needed. |
||
222 | * |
||
223 | * @param string $type slug of the block. |
||
224 | * @param array $script_dependencies An array of view-side Javascript dependencies to be enqueued. |
||
225 | * @param array $localize_data An array of view-side Javascript object accessible though the window object |
||
226 | * |
||
227 | * @return void |
||
228 | */ |
||
229 | public static function load_assets_as_required( $type, $script_dependencies = array(), $localize_data = array() ) { |
||
266 | |||
267 | /** |
||
268 | * Check if an asset exists for a block. |
||
269 | * |
||
270 | * @param string $file Path of the file we are looking for. |
||
271 | * |
||
272 | * @return bool $block_has_asset Does the file exist. |
||
273 | */ |
||
274 | public static function block_has_asset( $file ) { |
||
277 | |||
278 | /** |
||
279 | * Get the version number to use when loading the file. Allows us to bypass cache when developing. |
||
280 | * |
||
281 | * @param string $file Path of the file we are looking for. |
||
282 | * |
||
283 | * @return string $script_version Version number. |
||
284 | */ |
||
285 | public static function get_asset_version( $file ) { |
||
290 | |||
291 | /** |
||
292 | * Load Gutenberg editor assets |
||
293 | * |
||
294 | * @since 6.7.0 |
||
295 | * |
||
296 | * @return void |
||
297 | */ |
||
298 | public static function enqueue_block_editor_assets() { |
||
363 | } |
||
364 |
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italy
is not defined by the methodfinale(...)
.The most likely cause is that the parameter was removed, but the annotation was not.