Merge pull request #3 from battye/bugfix/hash-comment

Respect hashes as valid comments, migrate to GitHub Actions

Author: battye

.github/workflows/phpunit.yaml

@@ -0,0 +1,29 @@
+# .github/workflows/phpunit.yaml
+name: phpunit
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: ['5.6', '7.0', '7.1', '7.3', '7.4']
+
+    name: PHP ${{ matrix.php }} tests
+    steps:
+      - run: echo "This job for ${{ github.ref }} was automatically triggered by a ${{ github.event_name }} event on ${{ runner.os }}."
+
+      # basically git clone
+      - uses: actions/checkout@v2
+
+      # use PHP of specific version
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none # disable xdebug, pcov
+
+      # if we 2 steps like this, we can better see if composer failed or tests
+      - run: composer install --no-progress
+      - run: vendor/bin/simple-phpunit tests/
+      - run: echo "This job's status is ${{ job.status }}."

.travis.yml

@@ -51,7 +51,7 @@ $result = parser::parse_regex($regex, $file);
 
 ## Tests
 
-[![Latest Stable Version](https://poser.pugx.org/battye/php-array-parser/v/stable)](https://packagist.org/packages/battye/php-array-parser) [![Build Status](https://travis-ci.com/battye/php-array-parser.svg?branch=master)](https://travis-ci.com/battye/php-array-parser) [![Total Downloads](https://poser.pugx.org/battye/php-array-parser/downloads)](https://packagist.org/packages/battye/php-array-parser)
+[![Latest Stable Version](https://poser.pugx.org/battye/php-array-parser/v/stable)](https://packagist.org/packages/battye/php-array-parser) [![Total Downloads](https://poser.pugx.org/battye/php-array-parser/downloads)](https://packagist.org/packages/battye/php-array-parser) ![GitHub Actions CI](https://github.com/battye/php-array-parser/actions/workflows/phpunit.yaml/badge.svg?branch=master)
 
 The unit tests provide good examples of how to utilise this library and can be found in the `tests/` directory. To execute the unit tests, run:
 

README.md

@@ -209,7 +209,10 @@ public function is_comment_block($code)
 		// Long form block
 		$long = (substr($code, 0, 2) == '/*' && substr($code, -2) == '*/');
 
-		return ($short || $long);
+		// Hash form
+		$hash = (substr($code, 0, 1) === '#');
+
+		return ($short || $long || $hash);
 	}
 
 	/**
@@ -235,6 +238,9 @@ public function parse_array($square = false)
 
 		while (true)
 		{
+			// Immediately ignore any comments
+			$this->ignore_comments();
+
 			if ($this->tokens->does_match(")") || $this->tokens->does_match("]"))
 			{
 				// Reached the end of the array
@@ -303,6 +309,10 @@ public function parse_array($square = false)
 				{
 					// Array key (key => value)
 					$this->tokens->pop();
+
+					// Ignore comments in case someone put them on a new line within the array
+					$this->ignore_comments();
+
 					$result[$string] = $this->parse_value();
 				}
 

src/parser.php

@@ -93,6 +93,42 @@ public function testCanDetectVariable()
 		$this->assertArraySubset($expected_simple_output, $result);
 	}
 
+	/**
+	 * Test that we can include all types of comments in unusual places
+	 */
+	public function testComments()
+	{
+		$string = "array(0 => 
+			// upfront test comment
+			# upfront test comment
+			/* upfront test comment */					
+			array(
+				'one' => 1, // expect 1
+				/* internal test comment */		
+				'two' => 2, /* expect 2 */
+				# internal test comment
+				'three' => 3, # expect 3
+				// internal test comment
+			)
+			# a strange place for a test comment
+			)
+			/*
+				final test comment
+				but multi-line
+		 	*/
+			;";
+
+		$tokens = new tokens($string);
+		$parser = new parser($tokens);
+		$result = $parser->parse_array();
+
+		$expected_output = [
+			['one' => 1, 'two' => 2, 'three' => 3]
+		];
+
+		$this->assertArraySubset($expected_output, $result);
+	}
+
 	/**
 	 * Test that an event file is parsed correctly
 	 */