Automattic /
jetpack
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() { |
||
| 80 | |||
| 81 | /** |
||
| 82 | * Checks for a given .json file in the `_inc/blocks` folder. |
||
| 83 | * |
||
| 84 | * @param $preset The name of the .json file to look for. |
||
| 85 | * |
||
| 86 | * @return bool True if the file is found. |
||
| 87 | */ |
||
| 88 | public static function preset_exists( $preset ) { |
||
| 91 | |||
| 92 | /** |
||
| 93 | * Decodes JSON loaded from a preset file in `_inc/blocks` |
||
| 94 | * |
||
| 95 | * @param $preset The name of the .json file to load. |
||
| 96 | * |
||
| 97 | * @return mixed Returns an object if the file is present, or false if a valid .json file is not present. |
||
| 98 | */ |
||
| 99 | public static function get_preset( $preset ) { |
||
| 102 | |||
| 103 | /** |
||
| 104 | * Filters the results of `apply_filter( 'jetpack_set_available_blocks', array() )` |
||
| 105 | * using the merged contents of `_inc/blocks/blocks-manifest.json` ( $preset_blocks ) |
||
| 106 | * and self::$jetpack_blocks ( $internal_blocks ) |
||
| 107 | * |
||
| 108 | * @param $blocks The default list. |
||
| 109 | * |
||
| 110 | * @return array A list of blocks: eg [ 'publicize', 'markdown' ] |
||
| 111 | */ |
||
| 112 | public static function jetpack_set_available_blocks( $blocks ) { |
||
| 113 | $preset_blocks_manifest = self::preset_exists( 'block-manifest' ) ? self::get_preset( 'block-manifest' ) : (object) array( 'blocks' => $blocks ); |
||
| 114 | $preset_blocks = isset( $preset_blocks_manifest->blocks ) ? (array) $preset_blocks_manifest->blocks : array() ; |
||
| 115 | $internal_blocks = array_keys( self::$jetpack_blocks ); |
||
| 116 | |||
| 117 | if ( Jetpack_Constants::is_true( 'JETPACK_BETA_BLOCKS' ) ) { |
||
| 118 | $beta_blocks = isset( $preset_blocks_manifest->betaBlocks ) ? (array) $preset_blocks_manifest->betaBlocks : array(); |
||
| 119 | return array_unique( array_merge( $preset_blocks, $beta_blocks, $internal_blocks ) ); |
||
| 120 | } |
||
| 121 | |||
| 122 | return array_unique( array_merge( $preset_blocks, $internal_blocks ) ); |
||
| 123 | } |
||
| 124 | |||
| 125 | /** |
||
| 126 | * @return array A list of block-availability information, eg: [ "publicize" => ["available" => true ], "markdown" => [ "available" => false, "unavailable_reason" => 'missing_module' ] ] |
||
| 127 | */ |
||
| 128 | public static function get_block_availability() { |
||
| 129 | |||
| 130 | if ( ! self::should_load_blocks() ) { |
||
| 131 | return array(); |
||
| 132 | } |
||
| 133 | |||
| 134 | $blocks_availability = array(); // default |
||
| 135 | |||
| 136 | foreach ( self::$jetpack_blocks as $type => $args ) { |
||
| 137 | if ( ! in_array( $type, self::$blocks_index ) ) { |
||
| 138 | // Jetpack shouldn't expose blocks that are not in the manifest. |
||
| 139 | continue; |
||
| 140 | } |
||
| 141 | $availability = $args['availability']; |
||
| 142 | $available = array( |
||
| 143 | 'available' => ( isset( $availability['available'] ) ? (bool) $availability['available'] : true ), |
||
| 144 | ); |
||
| 145 | $unavailability_reason = array(); |
||
| 146 | if ( ! $available['available'] ) { |
||
| 147 | $unavailability_reason = array( |
||
| 148 | 'unavailable_reason' => ( isset( $availability['unavailable_reason'] ) ? $availability['unavailable_reason'] : 'unknown' ) |
||
| 149 | ); |
||
| 150 | } |
||
| 151 | $blocks_availability[ $type ] = array_merge( $available, $unavailability_reason ); |
||
| 152 | } |
||
| 153 | |||
| 154 | foreach ( self::$blocks_index as $block ) { |
||
| 155 | if ( ! isset( $blocks_availability[ $block ] ) ) { |
||
| 156 | $blocks_availability[ $block ] = array( 'available' => false, 'unavailable_reason' => 'missing_module' ); |
||
| 157 | } |
||
| 158 | } |
||
| 159 | |||
| 160 | return $blocks_availability; |
||
| 161 | } |
||
| 162 | |||
| 163 | /** |
||
| 164 | * Check if Gutenberg editor is available |
||
| 165 | * |
||
| 166 | * @since 6.7.0 |
||
| 167 | * |
||
| 168 | * @return bool |
||
| 169 | */ |
||
| 170 | public static function is_gutenberg_available() { |
||
| 171 | return function_exists( 'register_block_type' ); |
||
| 172 | } |
||
| 173 | |||
| 174 | /** |
||
| 175 | * Check whether conditions indicate Gutenberg blocks should be loaded |
||
| 176 | * |
||
| 177 | * Loading blocks is enabled by default and may be disabled via filter: |
||
| 178 | * add_filter( 'jetpack_gutenberg', '__return_false' ); |
||
| 179 | * |
||
| 180 | * @since 6.7.0 |
||
| 181 | * |
||
| 182 | * @return bool |
||
| 183 | */ |
||
| 184 | public static function should_load_blocks() { |
||
| 185 | if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) { |
||
| 186 | return false; |
||
| 187 | } |
||
| 188 | |||
| 189 | /** |
||
| 190 | * Filter to disable Gutenberg blocks |
||
| 191 | * |
||
| 192 | * @since 6.5.0 |
||
| 193 | * |
||
| 194 | * @param bool true Whether to load Gutenberg blocks |
||
| 195 | */ |
||
| 196 | return (bool) apply_filters( 'jetpack_gutenberg', true ); |
||
| 197 | } |
||
| 198 | |||
| 199 | /** |
||
| 200 | * Only enqueue block assets when needed. |
||
| 201 | * |
||
| 202 | * @param string $type slug of the block. |
||
| 203 | * @param array $script_dependencies An array of view-side Javascript dependencies to be enqueued. |
||
| 204 | * |
||
| 205 | * @return void |
||
| 206 | */ |
||
| 207 | public static function load_assets_as_required( $type, $script_dependencies = array() ) { |
||
| 208 | if ( is_admin() ) { |
||
| 209 | // A block's view assets will not be required in wp-admin. |
||
| 210 | return; |
||
| 211 | } |
||
| 212 | |||
| 213 | $type = sanitize_title_with_dashes( $type ); |
||
| 214 | // Enqueue styles. |
||
| 215 | $style_relative_path = '_inc/blocks/' . $type . '/view' . ( is_rtl() ? '.rtl' : '' ) . '.css'; |
||
| 216 | View Code Duplication | if ( self::block_has_asset( $style_relative_path ) ) { |
|
| 217 | $style_version = self::get_asset_version( $style_relative_path ); |
||
| 218 | $view_style = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE ); |
||
| 219 | wp_enqueue_style( 'jetpack-block-' . $type, $view_style, array(), $style_version ); |
||
| 220 | } |
||
| 221 | |||
| 222 | // Enqueue script. |
||
| 223 | $script_relative_path = '_inc/blocks/' . $type . '/view.js'; |
||
| 224 | View Code Duplication | if ( self::block_has_asset( $script_relative_path ) ) { |
|
| 225 | $script_version = self::get_asset_version( $script_relative_path ); |
||
| 226 | $view_script = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE ); |
||
| 227 | wp_enqueue_script( 'jetpack-block-' . $type, $view_script, $script_dependencies, $script_version, false ); |
||
| 228 | } |
||
| 229 | |||
| 230 | wp_localize_script( |
||
| 231 | 'jetpack-block-' . $type, |
||
| 232 | 'Jetpack_Block_Assets_Base_Url', |
||
| 233 | plugins_url( '_inc/blocks/', JETPACK__PLUGIN_FILE ) |
||
| 234 | ); |
||
| 235 | } |
||
| 236 | |||
| 237 | /** |
||
| 238 | * Check if an asset exists for a block. |
||
| 239 | * |
||
| 240 | * @param string $file Path of the file we are looking for. |
||
| 241 | * |
||
| 242 | * @return bool $block_has_asset Does the file exist. |
||
| 243 | */ |
||
| 244 | public static function block_has_asset( $file ) { |
||
| 247 | |||
| 248 | /** |
||
| 249 | * Get the version number to use when loading the file. Allows us to bypass cache when developing. |
||
| 250 | * |
||
| 251 | * @param string $file Path of the file we are looking for. |
||
| 252 | * |
||
| 253 | * @return string $script_version Version number. |
||
| 254 | */ |
||
| 255 | public static function get_asset_version( $file ) { |
||
| 260 | |||
| 261 | /** |
||
| 262 | * Load Gutenberg editor assets |
||
| 263 | * |
||
| 264 | * @since 6.7.0 |
||
| 265 | * |
||
| 266 | * @return void |
||
| 267 | */ |
||
| 268 | public static function enqueue_block_editor_assets() { |
||
| 331 | } |
||
| 332 |
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
$italyis not defined by the methodfinale(...).The most likely cause is that the parameter was removed, but the annotation was not.