Added Angular pseudo classes to colon sniff and a way to configure it (…

…#40) * Added Angular pseudo classes to colon sniff and a way to configure it * Codestyle
hostnet · Jun 28, 2018 · 608f565 · 608f565
1 parent 753129c
commit 608f565
Show file tree

Hide file tree

Showing 5 changed files with 92 additions and 5 deletions.
diff --git a/src/Sniff/ColonSniff.php b/src/Sniff/ColonSniff.php
@@ -70,6 +70,46 @@ final class ColonSniff implements SniffInterface
         'extend',
     ];
 
+    /**
+     * @var string[]
+     * @see https://angular.io/guide/component-styles
+     */
+    private const PSEUDO_CLASSES_ANGULAR = [
+        'host',
+        'host-context',
+    ];
+
+    /**
+     * List of options which can be configured.
+     */
+    private const PSEUDO_CLASS_OPTIONS = [
+        'css' => self::PSEUDO_CLASSES,
+        'less' => self::PSEUDO_CLASSES_LESS,
+        'angular' => self::PSEUDO_CLASSES_ANGULAR,
+    ];
+
+    /**
+     * @var string[]
+     */
+    private $pseudo_classes;
+
+    public function __construct(string $pseudo_classes = 'css,less')
+    {
+        $this->pseudo_classes = array_merge([], ...array_map(function (string $class) {
+            $class = trim($class);
+
+            if (!isset(self::PSEUDO_CLASS_OPTIONS[$class])) {
+                throw new \LogicException(sprintf(
+                    'Unknown pseudo classes for "%s", options are: "%s".',
+                    $class,
+                    implode('", "', array_keys(self::PSEUDO_CLASS_OPTIONS))
+                ));
+            }
+
+            return self::PSEUDO_CLASS_OPTIONS[$class];
+        }, explode(',', $pseudo_classes)));
+    }
+
     public function register(): array
     {
         return [
@@ -102,7 +142,7 @@ public function process(File $file, int $stack_ptr): void
             'Colon should be followed by a single space.',
             $t->lines[0],
             $t->offsets[0],
-            $t->offsets[0] + strlen($t->chars)
+            $t->offsets[0] + \strlen($t->chars)
         );
     }
 
@@ -152,7 +192,6 @@ private function isModifier(array $tokens): bool
             return false;
         }
 
-        return $first->type === Token::T_WORD
-            && \in_array($first->chars, array_merge(self::PSEUDO_CLASSES, self::PSEUDO_CLASSES_LESS), true);
+        return $first->type === Token::T_WORD && \in_array($first->chars, $this->pseudo_classes, true);
     }
 }
diff --git a/test/Configuration/StandardConfigurationTest.php b/test/Configuration/StandardConfigurationTest.php
@@ -42,6 +42,7 @@ public function testGetFile()
             dirname(__DIR__) . $ds . 'Sniff' . $ds . 'fixtures' . $ds . 'bad_colors.less',
             dirname(__DIR__) . $ds . 'Sniff' . $ds . 'fixtures' . $ds . 'bad_variable.less',
             dirname(__DIR__) . $ds . 'Sniff' . $ds . 'fixtures' . $ds . 'colons.less',
+            dirname(__DIR__) . $ds . 'Sniff' . $ds . 'fixtures' . $ds . 'colons_angular.less',
             dirname(__DIR__) . $ds . 'Sniff' . $ds . 'fixtures' . $ds . 'color_variants.less',
             dirname(__DIR__) . $ds . 'Sniff' . $ds . 'fixtures' . $ds . 'comments.less',
             dirname(__DIR__) . $ds . 'Sniff' . $ds . 'fixtures' . $ds . 'curly.less',

diff --git a/test/Sniff/ColonSniffTest.php b/test/Sniff/ColonSniffTest.php
@@ -42,4 +42,43 @@ public function testSniff()
             new Violation(ColonSniff::class, 'Colon should be followed by a single space.', 3, 11, 12),
         ], $file->getViolations());
     }
+
+    public function testSniffAngular()
+    {
+        $file = new File(
+            'phpunit',
+            (new Tokenizer())->tokenize(file_get_contents(__DIR__ . '/fixtures/colons_angular.less'))
+        );
+
+        $sniffer = new Sniffer();
+        $sniffer->loadStandard(SingleStandard::load(ColonSniff::class, ['css,angular']));
+        $sniffer->process([$file]);
+
+        self::assertEquals([], $file->getViolations());
+    }
+
+    public function testSniffAngularWithoutAngularClass()
+    {
+        $file = new File(
+            'phpunit',
+            (new Tokenizer())->tokenize(file_get_contents(__DIR__ . '/fixtures/colons_angular.less'))
+        );
+
+        $sniffer = new Sniffer();
+        $sniffer->loadStandard(SingleStandard::load(ColonSniff::class, ['css']));
+        $sniffer->process([$file]);
+
+        self::assertEquals([
+            new Violation(ColonSniff::class, 'Colon should be followed by a single space.', 1, 1, 2),
+        ], $file->getViolations());
+    }
+
+    public function testSniffBadClass()
+    {
+        $this->expectException(\LogicException::class);
+        $this->expectExceptionMessage('Unknown pseudo classes for "foo", options are:');
+
+        $sniffer = new Sniffer();
+        $sniffer->loadStandard(SingleStandard::load(ColonSniff::class, ['foo']));
+    }
 }
diff --git a/test/Sniff/SingleStandard.php b/test/Sniff/SingleStandard.php
@@ -12,11 +12,15 @@
 
 class SingleStandard
 {
-    public static function load(string $sniff): Standard
+    public static function load(string $sniff, array $args = []): Standard
     {
         $file = tempnam(sys_get_temp_dir(), 'test_standard_');
 
-        file_put_contents($file, sprintf('<csssniffer><sniff class="%s" /></csssniffer>', $sniff));
+        $sniff_args = array_reduce($args, function (string $carry, string $arg) {
+            return $carry . '<arg>' . $arg . '</arg>';
+        }, '');
+
+        file_put_contents($file, sprintf('<csssniffer><sniff class="%s">%s</sniff></csssniffer>', $sniff, $sniff_args));
 
         try {
             $standard = Standard::loadFromXmlFile($file);

diff --git a/test/Sniff/fixtures/colons_angular.less b/test/Sniff/fixtures/colons_angular.less
@@ -0,0 +1,4 @@
+:host-context(.theme-light) h2 {
+    background-color: #ffffff;
+    color: #000000;
+}