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() { |
||
71 | |||
72 | static function defered_register_blocks( $request ) { |
||
76 | |||
77 | static function register_blocks() { |
||
103 | |||
104 | /** |
||
105 | * Return the Gutenberg extensions (blocks and plugins) directory |
||
106 | * |
||
107 | * @return string The Gutenberg extensions directory |
||
108 | */ |
||
109 | public static function get_blocks_directory() { |
||
119 | |||
120 | /** |
||
121 | * Checks for a given .json file in the blocks folder. |
||
122 | * |
||
123 | * @param $preset The name of the .json file to look for. |
||
124 | * |
||
125 | * @return bool True if the file is found. |
||
126 | */ |
||
127 | public static function preset_exists( $preset ) { |
||
130 | |||
131 | /** |
||
132 | * Decodes JSON loaded from a preset file in the blocks folder |
||
133 | * |
||
134 | * @param $preset The name of the .json file to load. |
||
135 | * |
||
136 | * @return mixed Returns an object if the file is present, or false if a valid .json file is not present. |
||
137 | */ |
||
138 | public static function get_preset( $preset ) { |
||
141 | |||
142 | /** |
||
143 | * Filters the results of `apply_filter( 'jetpack_set_available_blocks', array() )` |
||
144 | * using the merged contents of `blocks-manifest.json` ( $preset_blocks ) |
||
145 | * and self::$jetpack_blocks ( $internal_blocks ) |
||
146 | * |
||
147 | * @param $blocks The default list. |
||
148 | * |
||
149 | * @return array A list of blocks: eg [ 'publicize', 'markdown' ] |
||
150 | */ |
||
151 | public static function jetpack_set_available_blocks( $blocks ) { |
||
163 | |||
164 | /** |
||
165 | * @return array A list of block-availability information, eg: [ "publicize" => ["available" => true ], "markdown" => [ "available" => false, "unavailable_reason" => 'missing_module' ] ] |
||
166 | */ |
||
167 | public static function get_block_availability() { |
||
201 | |||
202 | /** |
||
203 | * Check if Gutenberg editor is available |
||
204 | * |
||
205 | * @since 6.7.0 |
||
206 | * |
||
207 | * @return bool |
||
208 | */ |
||
209 | public static function is_gutenberg_available() { |
||
212 | |||
213 | /** |
||
214 | * Check whether conditions indicate Gutenberg blocks should be loaded |
||
215 | * |
||
216 | * Loading blocks is enabled by default and may be disabled via filter: |
||
217 | * add_filter( 'jetpack_gutenberg', '__return_false' ); |
||
218 | * |
||
219 | * @since 6.7.0 |
||
220 | * |
||
221 | * @return bool |
||
222 | */ |
||
223 | public static function should_load_blocks() { |
||
237 | |||
238 | /** |
||
239 | * Only enqueue block assets when needed. |
||
240 | * |
||
241 | * @param string $type slug of the block. |
||
242 | * @param array $script_dependencies An array of view-side Javascript dependencies to be enqueued. |
||
243 | * |
||
244 | * @return void |
||
245 | */ |
||
246 | public static function load_assets_as_required( $type, $script_dependencies = array() ) { |
||
275 | |||
276 | /** |
||
277 | * Check if an asset exists for a block. |
||
278 | * |
||
279 | * @param string $file Path of the file we are looking for. |
||
280 | * |
||
281 | * @return bool $block_has_asset Does the file exist. |
||
282 | */ |
||
283 | public static function block_has_asset( $file ) { |
||
286 | |||
287 | /** |
||
288 | * Get the version number to use when loading the file. Allows us to bypass cache when developing. |
||
289 | * |
||
290 | * @param string $file Path of the file we are looking for. |
||
291 | * |
||
292 | * @return string $script_version Version number. |
||
293 | */ |
||
294 | public static function get_asset_version( $file ) { |
||
299 | |||
300 | /** |
||
301 | * Load Gutenberg editor assets |
||
302 | * |
||
303 | * @since 6.7.0 |
||
304 | * |
||
305 | * @return void |
||
306 | */ |
||
307 | public static function enqueue_block_editor_assets() { |
||
372 | } |
||
373 |
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.