Merge pull request phpbb#124 from iMattPro/update-events

Process simple dispatcher events too

Author: iMattPro

src/Events/php_exporter.php

@@ -119,10 +119,13 @@ public function crawl_php_file($file)
 					$event_line = $i;
 					$this->set_current_event($this->get_event_name($event_line, false), $event_line);
 
-					// Find variables of the event
-					$arguments = $this->get_vars_from_array();
-					$doc_vars  = $this->get_vars_from_docblock();
-					$this->validate_vars_docblock_array($arguments, $doc_vars);
+					// Find variables of the event if it has them
+					if (strpos($this->file_lines[$event_line], 'compact('))
+					{
+						$arguments = $this->get_vars_from_array();
+						$doc_vars  = $this->get_vars_from_docblock();
+						$this->validate_vars_docblock_array($arguments, $doc_vars);
+					}
 				}
 				else
 				{
@@ -185,20 +188,8 @@ public function get_event_name($event_line, $is_dispatch)
 		$event_text_line = $this->file_lines[$event_line];
 		$event_text_line = ltrim($event_text_line, " \t");
 
-		if ($is_dispatch)
-		{
-			$regex = '#\$([a-z](?:[a-z0-9_]|->)*)';
-			$regex .= '->dispatch\(';
-			$regex .= '\'%s\'';
-			$regex .= '\);#';
-		}
-		else
-		{
-			$regex = '#extract\(\$([a-z](?:[a-z0-9_]|->)*)';
-			$regex .= '->trigger_event\(';
-			$regex .= '\'%s\'';
-			$regex .= ', compact\(\$vars\)\)\);#';
-		}
+		$event = $is_dispatch ? 'dispatch' : 'trigger_event';
+		$regex = '/->(?:' . $event . ')\(([\'"])%s\1/';
 
 		$match = array();
 		preg_match(sprintf($regex, $this->preg_match_event_name()), $event_text_line, $match);

tests/events/invalid_name_simple.php

@@ -0,0 +1,8 @@
+<?php
+/**
+ * Modify the data for post submitting
+ *
+ * @event rxu.postsmerging.posts_merging_end
+ * @since 2.0.0
+ */
+$phpbb_dispatcher->trigger_event('rxu.PostsMerging.posts_merging_end');

tests/events/invalid_name_simple_dispatch.php

@@ -0,0 +1,8 @@
+<?php
+/**
+ * Modify the data for post submitting
+ *
+ * @event rxu.postsmerging.posts_merging_end
+ * @since 2.0.0
+ */
+$phpbb_dispatcher->dispatch('rxu.PostsMerging.posts_merging_end');

tests/events/valid_name_simple.php

@@ -0,0 +1,8 @@
+<?php
+/**
+ * Modify the data for post submitting
+ *
+ * @event rxu.postsmerging.posts_merging_end
+ * @since 2.0.0
+ */
+$phpbb_dispatcher->trigger_event('rxu.postsmerging.posts_merging_end');

tests/events/valid_name_simple_dispatch.php

@@ -0,0 +1,8 @@
+<?php
+/**
+ * Modify the data for post submitting
+ *
+ * @event rxu.postsmerging.posts_merging_end
+ * @since 2.0.0
+ */
+$phpbb_dispatcher->dispatch('rxu.postsmerging.posts_merging_end');

tests/php_exporter_test.php

@@ -34,29 +34,34 @@ public function extension_data()
 		];
 
 		return [
-			[27, './tests/events/invalid_name_long_multi.php', 'rxu.PostsMerging.posts_merging_end', $expected_vars, $expected_errors],
-			[17, './tests/events/invalid_name_long_single.php', 'rxu.PostsMerging.posts_merging_end', $expected_vars, $expected_errors],
-			[27, './tests/events/invalid_name_short_multi.php', 'rxu.PostsMerging.posts_merging_end', $expected_vars, $expected_errors],
-			[17, './tests/events/invalid_name_short_single.php', 'rxu.PostsMerging.posts_merging_end', $expected_vars, $expected_errors],
-			[27, './tests/events/valid_name_long_multi.php', 'rxu.postsmerging.posts_merging_end', $expected_vars],
-			[17, './tests/events/valid_name_long_single.php', 'rxu.postsmerging.posts_merging_end', $expected_vars],
-			[27, './tests/events/valid_name_short_multi.php', 'rxu.postsmerging.posts_merging_end', $expected_vars],
-			[17, './tests/events/valid_name_short_single.php', 'rxu.postsmerging.posts_merging_end', $expected_vars],
+			[27, './tests/events/invalid_name_long_multi.php', false, 'rxu.PostsMerging.posts_merging_end', $expected_vars, $expected_errors],
+			[17, './tests/events/invalid_name_long_single.php', false, 'rxu.PostsMerging.posts_merging_end', $expected_vars, $expected_errors],
+			[27, './tests/events/invalid_name_short_multi.php', false, 'rxu.PostsMerging.posts_merging_end', $expected_vars, $expected_errors],
+			[17, './tests/events/invalid_name_short_single.php', false, 'rxu.PostsMerging.posts_merging_end', $expected_vars, $expected_errors],
+			[7, './tests/events/invalid_name_simple.php', false, 'rxu.PostsMerging.posts_merging_end', [], $expected_errors],
+			[7, './tests/events/invalid_name_simple_dispatch.php', true, 'rxu.PostsMerging.posts_merging_end', [], $expected_errors],
+			[27, './tests/events/valid_name_long_multi.php', false, 'rxu.postsmerging.posts_merging_end', $expected_vars],
+			[17, './tests/events/valid_name_long_single.php', false, 'rxu.postsmerging.posts_merging_end', $expected_vars],
+			[27, './tests/events/valid_name_short_multi.php', false, 'rxu.postsmerging.posts_merging_end', $expected_vars],
+			[17, './tests/events/valid_name_short_single.php', false, 'rxu.postsmerging.posts_merging_end', $expected_vars],
+			[7, './tests/events/valid_name_simple.php', false, 'rxu.postsmerging.posts_merging_end', []],
+			[7, './tests/events/valid_name_simple_dispatch.php', true, 'rxu.postsmerging.posts_merging_end', []],
 		];
 	}
 
 	/**
 	 * @dataProvider extension_data
 	 */
-	public function test_event_name($line, $content, $expected_name, $expected_vars, $expected_errors = [])
+	public function test_event_name($line, $file, $is_dispatch, $expected_name, $expected_vars, $expected_errors = [])
 	{
+		$content = file_get_contents($file);
 		$output   = new Output();
 		$exporter = new php_exporter($output, '');
-		$exporter->set_content(explode("\n", file_get_contents($content)));
+		$exporter->set_content(explode("\n", $content));
 
-		$name = $exporter->get_event_name($line, false);
+		$name = $exporter->get_event_name($line, $is_dispatch);
 		$exporter->set_current_event($name, $line);
-		$vars = $exporter->get_vars_from_array(false);
+		$vars = strpos($content, 'compact(') ? $exporter->get_vars_from_array(false) : [];
 
 		self::assertEquals($expected_name, $name);
 		self::assertEquals($expected_vars, $vars);