Implement indentation test and expectation in a single file

gerardroche · Feb 9, 2015 · 62109d3 · 62109d3
1 parent ba0165c
commit 62109d3
Show file tree

Hide file tree

Showing 19 changed files with 371 additions and 277 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,7 +10,10 @@
     - Append `;` on <kbd>Ctrl</kbd>+<kbd>Enter</kbd> in valid contexts
 * Minimise auto-complete noise: Completion rules now cancel completions for method declarations and class declarations with modifiers. e.g. typing at `public function |` and `abstract class |`.
 * Tests
-  - Added a language test suite. See [CONTRIBUTING.md](https://github.com/gerardroche/sublime-php-grammar/blob/master/CONTRIBUTING.md) for more details.
+    - Added a language test suite
+    - Added a indentation test and expectation in a single file test case
+
+    See [CONTRIBUTING.md](https://github.com/gerardroche/sublime-php-grammar/blob/master/CONTRIBUTING.md) for more details.
 
 ### Changes
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -22,34 +22,75 @@ _Note_: Test runner key bindings are disabled by default. To enable them set `"p
 
 ## Indentation Tests
 
-Two files are required for an indentation test.
+There are two options for writing indentation tests.
 
-1. `test/indentation/name_test.php`
-2. `test/indentation/name_test_expect.php`
+### Example 1 - Test and expectation in a single file
+
+##### `test/indentation/if_else_test.php`
+
+```
+--TEST--
+Basic if statement
+--FILE--
+<?php
+echo 'statement 1';
+if (true) {
+echo 'statement 2';
+echo 'statement 3';
+if (false) {
+echo 'statement 4';
+echo 'statement 5';
+} else {
+echo 'statement 6';
+echo 'statement 7';
+}
+echo 'statement 8';
+echo 'statement 9';
+}
+echo 'statement 10';
+?>
+--EXPECT--
+<?php
+echo 'Statement 1';
+if (true) {
+    echo 'Statement 2';
+    echo 'Statement 3';
+    if (false) {
+        echo 'Statement 4';
+        echo 'Statement 5';
+    } else {
+        echo 'Statement 6';
+        echo 'Statement 7';
+    }
+    echo 'Statement 8';
+    echo 'Statement 9';
+}
+echo 'Statement 10';
+?>
+```
 
-The contents of `name_test.php` file is loaded, reindented, and compared to the contents of `name_test_expect.php`. If they match the test passes, if not the test fails.
 
-### Example
+### Example 2 - Test and expectation in separate files
 
 ##### `test/indentation/if_else_test.php`
 
 ```
 <?php
-echo 'Statement 1';
+echo 'statement 1';
 if (true) {
-echo 'Statement 2';
-echo 'Statement 3';
+echo 'statement 2';
+echo 'statement 3';
 if (false) {
-echo 'Statement 4';
-echo 'Statement 5';
+echo 'statement 4';
+echo 'statement 5';
 } else {
-echo 'Statement 6';
-echo 'Statement 7';
+echo 'statement 6';
+echo 'statement 7';
 }
-echo 'Statement 8';
-echo 'Statement 9';
+echo 'statement 8';
+echo 'statement 9';
 }
-echo 'Statement 10';
+echo 'statement 10';
 ```
 
 ##### `test/indentation/if_else_expect.php`

diff --git a/test.py b/test.py
@@ -140,11 +140,23 @@ def getFileContents(self, name, ext):
         with open(file_name) as f:
             return f.read()
 
-    def createFileDataProiderTest(name):
+    def createFileDataProiderTest(test_file_name):
         def indentationTest(self):
-            self.view.insert(self.getFileContents(name, config.indentation_test_file_extension))
+            test_content = self.getFileContents(test_file_name, config.indentation_test_file_extension)
+
+            if '--TEST--' in test_content:
+                res = re.split('\n?--(?:TEST|FILE|EXPECT)--\n', test_content)
+                if not len(res) == 4:
+                    raise RuntimeError('Invalid indentation test: %s' % test_file_name)
+                test_content = res[2]
+                expected_content = res[3].rstrip("\n")
+            else:
+                expected_content = self.getFileContents(test_file_name, config.indentation_test_expect_file_extension)
+
+            self.view.insert(test_content)
             self.view.reindent()
-            self.assertEqual(self.getFileContents(name, config.indentation_test_expect_file_extension), self.view.to_str())
+            self.assertEqual(expected_content, self.view.to_str())
+
         return indentationTest
 
 class TestLanguage(unittest.TestCase):

diff --git a/test/indentation/comments_test.php b/test/indentation/comments_test.php
@@ -1,3 +1,6 @@
+--TEST--
+Comments
+--FILE--
 <?php
 
 // Single line comment content should preserve indentation i.e. everything
@@ -14,3 +17,22 @@
                     x
                 x
 */
+                ?>
+--EXPECT--
+<?php
+
+// Single line comment content should preserve indentation i.e. everything
+// after the double-slash should be ignored by indentation rules.
+//      x
+//                  x
+//              x
+
+/*
+Multi line comment content should preserve indentation i.e. everything
+between the forward-slash-star stat-forward-slash should be ignored by
+indentation rules.
+        x
+                    x
+                x
+*/
+                ?>
diff --git a/test/indentation/comments_test_expect.php b/test/indentation/comments_test_expect.php
diff --git a/test/indentation/declare_test.php b/test/indentation/declare_test.php
@@ -1,6 +1,9 @@
+--TEST--
+declare statment
+--FILE--
 <?php
 
-function start_with_at_least_one_indent() {
+function () {
 
                 declare(ticks = 0);
 
@@ -31,6 +34,39 @@ function start_with_at_least_one_indent() {
 
 }
 
-var_dump('begin...');
-start_with_at_least_one_indent();
-var_dump('done.');
+?>
+--EXPECT--
+<?php
+
+function () {
+
+    declare(ticks = 0);
+
+    declare(ticks = 0)
+    {
+        echo "Statement 1\n";
+        echo "Statement 2\n";
+    }
+
+    declare(ticks = 0) {
+        echo "Statement 1\n";
+        echo "Statement 2\n";
+    }
+
+    declare(ticks = 0) :
+        echo "Statement 1\n"; echo "Statement 2\n";
+    enddeclare;
+    var_dump('.');
+
+    ?>
+    <?php var_dump('.'); ?>
+    <?php declare(ticks = 0) : ?>
+        <?php echo "Statement 1\n"; ?>
+        <?= "Statement 2\n"; ?>
+    <?php enddeclare; ?>
+    <?php var_dump('.'); ?>
+    <?php
+
+}
+
+?>
diff --git a/test/indentation/declare_test_expect.php b/test/indentation/declare_test_expect.php
diff --git a/test/indentation/do_test.php b/test/indentation/do_test.php
@@ -1,6 +1,9 @@
+--TEST--
+Basic do statement
+--FILE--
 <?php
 
-function start_with_at_least_one_indent() {
+function () {
 
                 $i = 1;
                 do {
@@ -29,6 +32,37 @@ function start_with_at_least_one_indent() {
 
 }
 
-var_dump('begin...');
-start_with_at_least_one_indent();
-var_dump('done.');
+?>
+--EXPECT--
+<?php
+
+function () {
+
+    $i = 1;
+    do {
+        echo "$i\t".($i * $i)."\n";
+        ++$i;
+    } while ($i <= 4);
+    var_dump($i);
+
+    $i = 1;
+    do
+    {
+        echo "$i\t".($i * $i)."\n";
+        ++$i;
+    }
+    while ($i <= 4);
+    var_dump($i);
+
+    $i = 1;
+    do { echo "$i\t".($i * $i)."\n"; ++$i; } while ($i <= 4);
+    var_dump($i);
+
+    $i = 1;
+    do { echo "$i\t".($i * $i)."\n"; ++$i; }
+    while ($i <= 4);
+    var_dump($i);
+
+}
+
+?>
diff --git a/test/indentation/do_test_expect.php b/test/indentation/do_test_expect.php
diff --git a/test/indentation/namespaces_1_test.php b/test/indentation/namespaces_1_test.php
@@ -1,3 +1,6 @@
+--TEST--
+Basic namespace
+--FILE--
 <?php
 
 namespace NS1;
@@ -15,3 +18,25 @@
 use NS1\Sub1 as NS1;
 echo "Statement 3 " . __NAMESPACE__ . "\n";
 echo "Statement 4 " . __NAMESPACE__ . "\n";
+
+?>
+--EXPECT--
+<?php
+
+namespace NS1;
+echo "Statement 1" . __NAMESPACE__ . "\n";
+echo "Statement 2" . __NAMESPACE__ . "\n";
+
+namespace NS1\Sub1;
+use NS1;
+echo "Statement 1" . __NAMESPACE__ . "\n";
+echo "Statement 2" . __NAMESPACE__ . "\n";
+
+namespace NS3\Sub2;
+echo "Statement 1 " . __NAMESPACE__ . "\n";
+echo "Statement 2 " . __NAMESPACE__ . "\n";
+use NS1\Sub1 as NS1;
+echo "Statement 3 " . __NAMESPACE__ . "\n";
+echo "Statement 4 " . __NAMESPACE__ . "\n";
+
+?>