[AssetMapper] Adding an option (true by default) to not publish dot files

weaverryan · weaverryan · commit 85c0ef6b4164 · 2023-11-23T20:30:30.000-05:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -899,6 +899,11 @@ private function addAssetMapperSection(ArrayNodeDefinition $rootNode, callable $
                             ->prototype('scalar')->end()
                             ->example(['*/assets/build/*', '*/*_.scss'])
                         ->end()
+                        // boolean called  defaulting to true
+                        ->booleanNode('exclude_dotfiles')
+                            ->info('If true, any files starting with "." will be excluded from the asset mapper')
+                            ->defaultTrue()
+                        ->end()
                         ->booleanNode('server')
                             ->info('If true, a "dev server" will return the assets from the public directory (true in "debug" mode only by default)')
                             ->defaultValue($this->debug)
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1351,7 +1351,8 @@ private function registerAssetMapperConfiguration(array $config, ContainerBuilde
 
         $container->getDefinition('asset_mapper.repository')
             ->setArgument(0, $paths)
-            ->setArgument(2, $excludedPathPatterns);
+            ->setArgument(2, $excludedPathPatterns)
+            ->setArgument(3, $config['exclude_dotfiles']);
 
         $container->getDefinition('asset_mapper.public_assets_path_resolver')
             ->setArgument(0, $config['public_prefix']);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/asset_mapper.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/asset_mapper.php
@@ -74,6 +74,7 @@
                 abstract_arg('array of asset mapper paths'),
                 param('kernel.project_dir'),
                 abstract_arg('array of excluded path patterns'),
+                abstract_arg('exclude dot files'),
             ])
 
         ->set('asset_mapper.public_assets_path_resolver', PublicAssetsPathResolver::class)
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
@@ -196,6 +196,7 @@
             <xsd:element name="importmap-script-attribute" type="asset_mapper_attribute" minOccurs="0" maxOccurs="unbounded" />
         </xsd:sequence>
         <xsd:attribute name="enabled" type="xsd:boolean" />
+        <xsd:attribute name="exclude-dotfiles" type="xsd:boolean" />
         <xsd:attribute name="server" type="xsd:boolean" />
         <xsd:attribute name="public-prefix" type="xsd:string" />
         <xsd:attribute name="missing-import-mode" type="missing-import-mode" />
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -137,6 +137,7 @@ public function testAssetMapperCanBeEnabled()
             'importmap_polyfill' => 'es-module-shims',
             'vendor_dir' => '%kernel.project_dir%/assets/vendor',
             'importmap_script_attributes' => [],
+            'exclude_dotfiles' => true,
         ];
 
         $this->assertEquals($defaultConfig, $config['asset_mapper']);
@@ -674,6 +675,7 @@ protected static function getBundleDefaultConfig()
                 'importmap_polyfill' => 'es-module-shims',
                 'vendor_dir' => '%kernel.project_dir%/assets/vendor',
                 'importmap_script_attributes' => [],
+                'exclude_dotfiles' => true,
             ],
             'cache' => [
                 'pools' => [],
diff --git a/src/Symfony/Component/AssetMapper/AssetMapperRepository.php b/src/Symfony/Component/AssetMapper/AssetMapperRepository.php
@@ -33,6 +33,7 @@ public function __construct(
         private readonly array $paths,
         private readonly string $projectRootDir,
         private readonly array $excludedPathPatterns = [],
+        private readonly bool $excludeDotFiles = true,
     ) {
     }
 
@@ -185,6 +186,10 @@ private function isExcluded(string $filesystemPath): bool
             }
         }
 
+        if ($this->excludeDotFiles && str_starts_with(basename($filesystemPath), '.')) {
+            return true;
+        }
+
         return false;
     }
 }
diff --git a/src/Symfony/Component/AssetMapper/Tests/AssetMapperRepositoryTest.php b/src/Symfony/Component/AssetMapper/Tests/AssetMapperRepositoryTest.php
@@ -162,4 +162,24 @@ public function testExcludedPaths()
         $this->assertNull($repository->find('file3.css'));
         $this->assertNull($repository->findLogicalPath(__DIR__.'/Fixtures/dir2/file3.css'));
     }
+
+    public function testDotFilesExcluded()
+    {
+        $repository = new AssetMapperRepository([
+            'dot_file' => '',
+        ], __DIR__.'/Fixtures', [], true);
+
+        $actualAssets = array_keys($repository->all());
+        $this->assertEquals([], $actualAssets);
+    }
+
+    public function testDotFilesNotExcluded()
+    {
+        $repository = new AssetMapperRepository([
+            'dot_file' => '',
+        ], __DIR__.'/Fixtures', [], false);
+
+        $actualAssets = array_keys($repository->all());
+        $this->assertEquals(['.dotfile'], $actualAssets);
+    }
 }
diff --git a/src/Symfony/Component/AssetMapper/Tests/Fixtures/dot_file/.dotfile b/src/Symfony/Component/AssetMapper/Tests/Fixtures/dot_file/.dotfile
@@ -0,0 +1 @@
+I'm a dot file!

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ public function __construct(`
`33`	`33`	`private readonly array $paths,`
`34`	`34`	`private readonly string $projectRootDir,`
`35`	`35`	`private readonly array $excludedPathPatterns = [],`
	`36`	`+ private readonly bool $excludeDotFiles = true,`
`36`	`37`	`) {`
`37`	`38`	`}`
`38`	`39`
`@@ -185,6 +186,10 @@ private function isExcluded(string $filesystemPath): bool`
`185`	`186`	`}`
`186`	`187`	`}`
`187`	`188`
	`189`	`+ if ($this->excludeDotFiles && str_starts_with(basename($filesystemPath), '.')) {`
	`190`	`+ return true;`
	`191`	`+ }`
	`192`	`+`
`188`	`193`	`return false;`
`189`	`194`	`}`
`190`	`195`	`}`