Changeset 13422 for trunk/tests/phpunit/testcases/core/class-bp-component.php

Timestamp:

02/15/2023 10:23:05 AM (22 months ago)

Author:

imath

Message:

Improve BP_Component methods relative to setting BP Rewrites

So far BP_Component::add_rewrite_tags(),
BP_Component::add_rewrite_rules() & BP_Component::add_permastructs()
were just firing hooks. Thanks to the BP Rewrites plugin we were able to
test how we can use them to actually enjoy the WP Rewrite API in
BuddyPress. Compared to what was tested in this feature as plugin, some
improvements has been brought so that it's easier to benefit from the BP
Rewrites API for custom components (analyzing the included PHPUnit tests
can give BP plugin authors a preview about how to process).

Introduce the BP_Component::pre_query() method to avoid superfluous Post
queries when a BuddyPress page is displayed.

The src/bp-core/bp-rewrites.php file has also been inited, this is the
place where all Core component rewrites function will be placed.

Props r-a-y, johnjamesjacoby, boonebgorges

See #4954

File:

• trunk/tests/phpunit/testcases/core/class-bp-component.php (modified) (1 diff)

trunk/tests/phpunit/testcases/core/class-bp-component.php

@@ -93 +93 @@
         $this->assertEquals( $expected, $example->block_globals['bp/example-block']->props );
     }
+
+    /**
+     * @group bp_rewrites
+     */
+    public function test_component_rewrite_globals() {
+        $expected = array(
+            'directory'          => 'bp_examples',
+            'single_item'        => 'bp_example',
+            'single_item_action' => 'bp_example_action',
+        );
+
+        $example = new BPTest_Component(
+            array(
+                'globals' => array(
+                    'rewrite_ids' => array(
+                        'directory'          => 'examples ',
+                        'single_item'        => 'Exam?ple',
+                        'single_item_action' => 'bp_example_action',
+                    )
+                ),
+            )
+        );
+
+        do_action( 'bp_setup_globals' );
+
+        $this->assertEquals( $expected, $example->rewrite_ids );
+    }
+
+    /**
+     * @group bp_rewrites
+     */
+    public function test_component_add_rewrite_tags() {
+        $example = new BPTest_Component(
+            array(
+                'globals' => array(
+                    'rewrite_ids' => array(
+                        'directory'      => 'examples',
+                        'directory_type' => 'example_type',
+                    )
+                ),
+            )
+        );
+
+        do_action( 'bp_setup_globals' );
+
+        $expected_directory_regex = '([1]{1,})';
+        $rewrite_tags             = array(
+            'directory_type' => '([^/]+)',
+        );
+
+        $example->add_rewrite_tags( $rewrite_tags );
+
+        global $wp_rewrite;
+
+        $position = array_search( '%' . $example->rewrite_ids['directory'] . '%', $wp_rewrite->rewritecode, true );
+        $this->assertEquals( $wp_rewrite->rewritereplace[ $position ], $expected_directory_regex );
+
+        $position = array_search( '%' . $example->rewrite_ids['directory_type'] . '%', $wp_rewrite->rewritecode, true );
+        $this->assertEquals( $wp_rewrite->rewritereplace[ $position ], $rewrite_tags['directory_type'] );
+    }
+
+    /**
+     * @group bp_rewrites
+     */
+    public function test_component_add_rewrite_rules() {
+        $example = new BPTest_Component(
+            array(
+                'globals' => array(
+                    'root_slug'   => 'examples',
+                    'rewrite_ids' => array(
+                        'directory'             => 'examples',
+                        'directory_type'        => 'example_type',
+                        'single_item'           => 'example',
+                        'single_item_component' => 'example_component',
+                    )
+                ),
+            )
+        );
+
+        do_action( 'bp_setup_globals' );
+
+        $rewrite_tags = array(
+            'directory_type' => '([^/]+)',
+        );
+
+        $example->add_rewrite_tags( $rewrite_tags );
+
+        $rewrite_rules = array(
+            'directory_type' => array(
+                'order' => 95,
+                'regex' => $example->root_slug . '/type/([^/]+)/?$',
+                'query' => 'index.php?' . $example->rewrite_ids['directory'] . '=1&' . $example->rewrite_ids['directory_type'] . '=$matches[1]',
+            ),
+        );
+
+        $example->add_rewrite_rules( $rewrite_rules );
+
+        global $wp_rewrite;
+        $this->assertEquals( $wp_rewrite->extra_rules_top[ $rewrite_rules['directory_type']['regex'] ], $rewrite_rules['directory_type']['query'] );
+    }
+
+    /**
+     * @group bp_rewrites
+     */
+    public function test_component_add_permastructs() {
+        $example = new BPTest_Component(
+            array(
+                'globals' => array(
+                    'has_directory' => true,
+                    'root_slug'     => 'examples',
+                    'rewrite_ids'   => array(
+                        'directory'      => 'examples',
+                        'example_signup' => 'signup',
+                    )
+                ),
+            )
+        );
+
+        do_action( 'bp_setup_globals' );
+
+        $expected     = 'example-signup/%' . $example->rewrite_ids['example_signup'] . '%';
+        $permastructs = array(
+            $example->rewrite_ids['example_signup'] => array(
+                'permastruct' => $expected,
+                'args'        => array(),
+            ),
+        );
+
+        $example->add_permastructs( $permastructs );
+
+        global $wp_rewrite;
+
+        // The directory permastruct should be created automatically.
+        $this->assertTrue( isset( $wp_rewrite->extra_permastructs['bp_examples'] ) );
+
+        // The custom permastruct should be created as requested.
+        $this->assertEquals( $wp_rewrite->extra_permastructs[ $example->rewrite_ids['example_signup'] ]['struct'], $expected );
+    }
 }