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 Writing_On_GitHub_Database 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 Writing_On_GitHub_Database, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 10 | class Writing_On_GitHub_Database { |
||
| 11 | |||
| 12 | /** |
||
| 13 | * Application container. |
||
| 14 | * |
||
| 15 | * @var Writing_On_GitHub |
||
| 16 | */ |
||
| 17 | protected $app; |
||
| 18 | |||
| 19 | /** |
||
| 20 | * Currently whitelisted post types. |
||
| 21 | * |
||
| 22 | * @var array |
||
| 23 | */ |
||
| 24 | protected $whitelisted_post_types = array( 'post', 'page' ); |
||
| 25 | |||
| 26 | /** |
||
| 27 | * Currently whitelisted post statuses. |
||
| 28 | * |
||
| 29 | * @var array |
||
| 30 | */ |
||
| 31 | protected $whitelisted_post_statuses = array( 'publish' ); |
||
| 32 | |||
| 33 | /** |
||
| 34 | * Instantiates a new Database object. |
||
| 35 | * |
||
| 36 | * @param Writing_On_GitHub $app Application container. |
||
| 37 | */ |
||
| 38 | public function __construct( Writing_On_GitHub $app ) { |
||
| 41 | |||
| 42 | /** |
||
| 43 | * Queries the database for all of the supported posts. |
||
| 44 | * |
||
| 45 | * @return Writing_On_GitHub_Post[]|WP_Error |
||
| 46 | */ |
||
| 47 | public function fetch_all_supported(bool $force = false) { |
||
|
|
|||
| 48 | $args = array( |
||
| 49 | 'post_type' => $this->get_whitelisted_post_types(), |
||
| 50 | 'post_status' => $this->get_whitelisted_post_statuses(), |
||
| 51 | 'nopaging' => true, |
||
| 52 | 'fields' => 'ids', |
||
| 53 | ); |
||
| 54 | |||
| 55 | $query = new WP_Query( apply_filters( 'wogh_pre_fetch_all_supported', $args ) ); |
||
| 56 | |||
| 57 | $post_ids = $query->get_posts(); |
||
| 58 | |||
| 59 | if ( ! $post_ids ) { |
||
| 60 | return new WP_Error( |
||
| 61 | 'no_results', |
||
| 62 | __( 'Querying for supported posts returned no results.', 'writing-on-github' ) |
||
| 63 | ); |
||
| 64 | } |
||
| 65 | |||
| 66 | $results = array(); |
||
| 67 | foreach ( $post_ids as $post_id ) { |
||
| 68 | // Do not export posts that have already been exported |
||
| 69 | if ( ! get_post_meta( $post_id, '_wogh_sha', true ) || |
||
| 70 | ! get_post_meta( $post_id, '_wogh_github_path', true) ) { |
||
| 71 | |||
| 72 | $results[] = new Writing_On_GitHub_Post( $post_id, $this->app->api() ); |
||
| 73 | } |
||
| 74 | } |
||
| 75 | |||
| 76 | return $results; |
||
| 77 | } |
||
| 78 | |||
| 79 | /** |
||
| 80 | * Queries a post and returns it if it's supported. |
||
| 81 | * |
||
| 82 | * @param int $post_id Post ID to fetch. |
||
| 83 | * |
||
| 84 | * @return WP_Error|Writing_On_GitHub_Post |
||
| 85 | */ |
||
| 86 | public function fetch_by_id( $post_id ) { |
||
| 104 | |||
| 105 | /** |
||
| 106 | * Saves an array of Post objects to the database |
||
| 107 | * and associates their author as well as their latest |
||
| 108 | * |
||
| 109 | * @param Writing_On_GitHub_Post[] $posts Array of Posts to save. |
||
| 110 | * @param string $email Author email. |
||
| 111 | * |
||
| 112 | * @return string|WP_Error |
||
| 113 | */ |
||
| 114 | public function save_posts( array $posts ) { |
||
| 178 | |||
| 179 | protected function post_args( $post ) { |
||
| 228 | |||
| 229 | /** |
||
| 230 | * Deletes a post from the database based on its GitHub path. |
||
| 231 | * |
||
| 232 | * @param string $path Path of Post to delete. |
||
| 233 | * |
||
| 234 | * @return string|WP_Error |
||
| 235 | */ |
||
| 236 | public function delete_post_by_path( $path ) { |
||
| 318 | |||
| 319 | public function delete_post( $post_id ) { |
||
| 344 | |||
| 345 | /** |
||
| 346 | * Returns the list of post type permitted. |
||
| 347 | * |
||
| 348 | * @return array |
||
| 349 | */ |
||
| 350 | protected function get_whitelisted_post_types() { |
||
| 353 | |||
| 354 | /** |
||
| 355 | * Returns the list of post status permitted. |
||
| 356 | * |
||
| 357 | * @return array |
||
| 358 | */ |
||
| 359 | protected function get_whitelisted_post_statuses() { |
||
| 362 | |||
| 363 | /** |
||
| 364 | * Formats a whitelist array for a query. |
||
| 365 | * |
||
| 366 | * @param array $whitelist Whitelisted posts to format into query. |
||
| 367 | * |
||
| 368 | * @return string Whitelist formatted for query |
||
| 369 | */ |
||
| 370 | protected function format_for_query( $whitelist ) { |
||
| 377 | |||
| 378 | /** |
||
| 379 | * Verifies that both the post's status & type |
||
| 380 | * are currently whitelisted |
||
| 381 | * |
||
| 382 | * @param Writing_On_GitHub_Post $post Post to verify. |
||
| 383 | * |
||
| 384 | * @return boolean True if supported, false if not. |
||
| 385 | */ |
||
| 386 | protected function is_post_supported( Writing_On_GitHub_Post $post ) { |
||
| 406 | |||
| 407 | /** |
||
| 408 | * Retrieves the commit user for a provided display name |
||
| 409 | * |
||
| 410 | * Searches for a user with provided display name or returns |
||
| 411 | * the default user saved in the database. |
||
| 412 | * |
||
| 413 | * @param string $display_name User display name to search for. |
||
| 414 | * |
||
| 415 | * @return WP_Error|WP_User |
||
| 416 | */ |
||
| 417 | protected function fetch_commit_user( $display_name ) { |
||
| 453 | |||
| 454 | /** |
||
| 455 | * Sets the author latest revision |
||
| 456 | * of the provided post ID to the provided user. |
||
| 457 | * |
||
| 458 | * @param int $post_id Post ID to update revision author. |
||
| 459 | * @param int $user_id User ID for revision author. |
||
| 460 | * |
||
| 461 | * @return string|WP_Error |
||
| 462 | */ |
||
| 463 | protected function set_revision_author( $post_id, $user_id ) { |
||
| 486 | |||
| 487 | /** |
||
| 488 | * Updates the user ID for the provided post ID. |
||
| 489 | * |
||
| 490 | * Bypassing triggering any hooks, including creating new revisions. |
||
| 491 | * |
||
| 492 | * @param int $post_id Post ID to update. |
||
| 493 | * @param int $user_id User ID to update to. |
||
| 494 | * |
||
| 495 | * @return string|WP_Error |
||
| 496 | */ |
||
| 497 | protected function set_post_author( $post_id, $user_id ) { |
||
| 530 | |||
| 531 | /** |
||
| 532 | * Update the provided post's blob sha. |
||
| 533 | * |
||
| 534 | * @param Writing_On_GitHub_Post $post Post to update. |
||
| 535 | * @param string $sha Sha to update to. |
||
| 536 | * |
||
| 537 | * @return bool|int |
||
| 538 | */ |
||
| 539 | public function set_post_sha( $post, $sha ) { |
||
| 542 | } |
||
| 543 |
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.