diff --git a/core/lib/Drupal/Core/Asset/AssetResolver.php b/core/lib/Drupal/Core/Asset/AssetResolver.php index 6186d2a..9927049 100644 --- a/core/lib/Drupal/Core/Asset/AssetResolver.php +++ b/core/lib/Drupal/Core/Asset/AssetResolver.php @@ -166,6 +166,7 @@ public function getCssAssets(AttachedAssetsInterface $assets, $optimize) { uasort($css, 'static::sort'); // Allow themes to remove CSS files by CSS files full path and file name. + // @todo Remove in Drupal 9.0.x. if ($stylesheet_remove = $theme_info->getStyleSheetsRemove()) { foreach ($css as $key => $options) { if (isset($stylesheet_remove[$key])) { diff --git a/core/lib/Drupal/Core/Asset/Exception/InvalidLibrariesOverrideSpecificationException.php b/core/lib/Drupal/Core/Asset/Exception/InvalidLibrariesOverrideSpecificationException.php new file mode 100644 index 0000000..89667aa --- /dev/null +++ b/core/lib/Drupal/Core/Asset/Exception/InvalidLibrariesOverrideSpecificationException.php @@ -0,0 +1,15 @@ +getLibrariesByExtension($extension); - return isset($extension[$name]) ? $extension[$name] : FALSE; + if (isset($extension[$name])) { + // Handle libraries that are marked for override or removal. + // @see \Drupal\Core\Asset\LibraryDiscoveryParser::applyLibrariesOverride() + if (isset($extension[$name]['override'])) { + $override = $extension[$name]['override']; + if ($override === FALSE) { + // Remove the library definition if FALSE is given. + unset($extension[$name]); + return FALSE; + } + else { + // Otherwise replace with existing library definition if it exists. + // Throw an exception if it doesn't. + list($new_extension, $new_name) = explode('/', $override); + if ($library = $this->getLibraryByName($new_extension, $new_name)) { + $extension[$name] = $library; + } + else { + throw new InvalidLibrariesOverrideSpecificationException(sprintf('The specified library %s does not exist.', $override)); + } + } + } + return $extension[$name]; + } + else { + return FALSE; + } + } /** diff --git a/core/lib/Drupal/Core/Asset/LibraryDiscoveryParser.php b/core/lib/Drupal/Core/Asset/LibraryDiscoveryParser.php index e6a4376..e7da564 100644 --- a/core/lib/Drupal/Core/Asset/LibraryDiscoveryParser.php +++ b/core/lib/Drupal/Core/Asset/LibraryDiscoveryParser.php @@ -8,6 +8,7 @@ namespace Drupal\Core\Asset; use Drupal\Core\Asset\Exception\IncompleteLibraryDefinitionException; +use Drupal\Core\Asset\Exception\InvalidLibrariesOverrideSpecificationException; use Drupal\Core\Asset\Exception\InvalidLibraryFileException; use Drupal\Core\Asset\Exception\LibraryDefinitionMissingLicenseException; use Drupal\Core\Extension\ModuleHandlerInterface; @@ -88,6 +89,7 @@ public function buildByExtension($extension) { } $libraries = $this->parseLibraryInfo($extension, $path); + $libraries = $this->applyLibrariesOverride($libraries, $extension); foreach ($libraries as $id => &$library) { if (!isset($library['js']) && !isset($library['css']) && !isset($library['drupalSettings'])) { @@ -185,6 +187,13 @@ public function buildByExtension($extension) { elseif ($this->fileValidUri($source)) { $options['data'] = $source; } + // A regular URI (e.g., http://example.com/example.js) without + // 'external' explicitly specified, which may happen if, e.g. + // libraries-override is used. + elseif ($this->isValidUri($source)) { + $options['type'] = 'external'; + $options['data'] = $source; + } // By default, file paths are relative to the registering extension. else { $options['data'] = $path . '/' . $source; @@ -314,6 +323,77 @@ protected function parseLibraryInfo($extension, $path) { } /** + * Apply libraries overrides specified for the current active theme. + * + * @param array $libraries + * The libraries definitions. + * @param string $extension + * The extension in which these libraries are defined. + * + * @return array + * The modified libraries definitions. + */ + protected function applyLibrariesOverride($libraries, $extension) { + $active_theme = $this->themeManager->getActiveTheme(); + $libraries_overrides = $active_theme->getLibrariesOverride(); + foreach ($libraries as $library_name => $library) { + // Process libraries overrides. + $namespaced_library_name = "$extension/$library_name"; + foreach ($libraries_overrides as $definition => $override) { + // Active theme defines an override for this library. + if ($this->isEntireLibrary($definition, $namespaced_library_name)) { + // The active theme defines an override for the whole library. Use the + // override key to specify that this library will be overridden when + // it is called. + // @see \Drupal\Core\Asset\LibraryDiscovery::getLibraryByName() + if ($override) { + $libraries[$library_name]['override'] = $override; + } + else { + $libraries[$library_name]['override'] = FALSE; + } + } + elseif ($this->isPartOfLibrary($definition, $namespaced_library_name)) { + // Active theme defines an override for an asset within this library. + // Throw an exception if the asset is not properly specified. + if (substr_count($definition, '/') < 3) { + throw new InvalidLibrariesOverrideSpecificationException(sprintf('Library asset %s is not correctly specified. It should be in the form "extension/library_name/sub_key/path/to/asset.js".', $definition)); + } + list(, , $sub_key, $value) = explode('/', $definition, 4); + if ($sub_key === 'drupalSettings') { + // drupalSettings may not be overridden. + throw new InvalidLibrariesOverrideSpecificationException(sprintf('drupalSettings may not be overridden in libraries-override. Trying to override %s. Use hook_library_info_alter() instead.', $definition)); + } + elseif ($sub_key === 'css') { + // SMACSS category should be incorporated into the asset name. + list($category, $value) = explode('/', $value, 2); + $parents = [$sub_key, $category, $value]; + $new_parents = [$sub_key, $category, $override]; + } + else { + $parents = [$sub_key, $value]; + $new_parents = [$sub_key, $override]; + } + // Get the attributes of the asset to be overridden. If the key does + // not exist, then throw an exception. + $key_exists = NULL; + $attributes = NestedArray::getValue($libraries[$library_name], $parents, $key_exists); + if ($key_exists) { + // Remove asset to be overridden, but keep its attributes. + NestedArray::unsetValue($libraries[$library_name], $parents); + if ($override) { + // Replace with an override if specified. + NestedArray::setValue($libraries[$library_name], $new_parents, $attributes); + } + } + } + } + } + + return $libraries; + } + + /** * Wraps drupal_get_path(). */ protected function drupalGetPath($type, $name) { @@ -327,4 +407,39 @@ protected function fileValidUri($source) { return file_valid_uri($source); } + /** + * Determines if the supplied string is a valid URI. + */ + protected function isValidUri($string) { + return count(explode('://', $string)) === 2; + } + + /** + * Checks if the specified definition asset is a full library. + * + * @param string $definition + * The asset definition being checked. + * @param string $library_name + * The name of the library. + * @return bool + * Returns true if $definition is a full library specified by $library_name. + */ + protected function isEntireLibrary($definition, $library_name) { + return $definition === $library_name; + } + + /** + * Determines if the specified asset definition is a part of a library. + * + * @param string $definition + * The asset definition being checked. + * @param string $library_name + * The name of the library. + * @return bool + * Returns true if the definition is part of the library, false otherwise. + */ + protected function isPartOfLibrary($definition, $library_name) { + return strpos($definition, "$library_name/") === 0; + } + } diff --git a/core/lib/Drupal/Core/Theme/ActiveTheme.php b/core/lib/Drupal/Core/Theme/ActiveTheme.php index c35afad..603dc94 100644 --- a/core/lib/Drupal/Core/Theme/ActiveTheme.php +++ b/core/lib/Drupal/Core/Theme/ActiveTheme.php @@ -81,6 +81,13 @@ class ActiveTheme { protected $regions; /** + * The libraries or library assets overridden by the theme. + * + * @var array + */ + protected $librariesOverride; + + /** * Constructs an ActiveTheme object. * * @param array $values @@ -96,6 +103,7 @@ public function __construct(array $values) { 'extension' => 'html.twig', 'base_themes' => [], 'regions' => [], + 'libraries_override' => [], ]; $this->name = $values['name']; @@ -107,6 +115,7 @@ public function __construct(array $values) { $this->extension = $values['extension']; $this->baseThemes = $values['base_themes']; $this->regions = $values['regions']; + $this->librariesOverride = $values['libraries_override']; } /** @@ -169,6 +178,8 @@ public function getLibraries() { * Returns the removed stylesheets by the theme. * * @return mixed + * + * @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0. */ public function getStyleSheetsRemove() { return $this->styleSheetsRemove; @@ -198,4 +209,25 @@ public function getRegions() { return array_keys($this->regions); } + /** + * Returns the libraries or library assets overridden by the active theme. + * + * The array returned is in the form: + * @code + * [ + * 'core/drupal.collapse' => 'test_theme/collapse', + * 'core/drupal.progress' => FALSE, + * 'classy/base/css/theme/css/layout.css' => 'css/test_theme_layout.css', + * 'core/drupal.dialog/css/theme/misc/dialog.theme.css' => FALSE, + * 'core/jquery/js/assets/vendor/jquery/jquery.min.js' => 'js/collapse.js', + * ] + * @endcode + * + * @return array + * The list of libraries overrides. + */ + public function getLibrariesOverride() { + return $this->librariesOverride; + } + } diff --git a/core/lib/Drupal/Core/Theme/ThemeInitialization.php b/core/lib/Drupal/Core/Theme/ThemeInitialization.php index 8b476a2..8a240d5 100644 --- a/core/lib/Drupal/Core/Theme/ThemeInitialization.php +++ b/core/lib/Drupal/Core/Theme/ThemeInitialization.php @@ -161,27 +161,27 @@ public function getActiveTheme(Extension $theme, array $base_themes = []) { $values['path'] = $theme_path; $values['name'] = $theme->getName(); - // Prepare stylesheets from this theme as well as all ancestor themes. - // We work it this way so that we can have child themes remove CSS files - // easily from parent. - $values['stylesheets_remove'] = array(); + // @todo Remove in Drupal 9.0.x. + $values['stylesheets_remove'] = $this->prepareStylesheetsRemove($theme, $base_themes); - // Grab stylesheets from base theme. + // Prepare libraries overrides from this theme and ancestor themes. This + // allows child themes to easily remove CSS files from base themes and + // modules. + $values['libraries_override'] = []; + + // Get libraries overrides declared by base themes. foreach ($base_themes as $base) { - $base_theme_path = $base->getPath(); - if (!empty($base->info['stylesheets-remove'])) { - foreach ($base->info['stylesheets-remove'] as $css_file) { - $css_file = $this->resolveStyleSheetPlaceholders($css_file); - $values['stylesheets_remove'][$css_file] = $css_file; + if (!empty($base->info['libraries-override'])) { + foreach ($base->info['libraries-override'] as $library => $override) { + $values['libraries_override'][$library] = $override ? $this->resolveThemeAssetPath($base, $library, $override) : $override; } } } - // Add stylesheets used by this theme. - if (!empty($theme->info['stylesheets-remove'])) { - foreach ($theme->info['stylesheets-remove'] as $css_file) { - $css_file = $this->resolveStyleSheetPlaceholders($css_file); - $values['stylesheets_remove'][$css_file] = $css_file; + // Add libraries overrides declared by this theme. + if (!empty($theme->info['libraries-override'])) { + foreach ($theme->info['libraries-override'] as $library => $override) { + $values['libraries_override'][$library] = $override ? $this->resolveThemeAssetPath($theme, $library, $override) : $override; } } @@ -241,6 +241,8 @@ protected function getExtensions() { * * @return string * CSS file where placeholders are replaced. + * + * @todo Remove in Drupal 9.0.x. */ protected function resolveStyleSheetPlaceholders($css_file) { $token_candidate = explode('/', $css_file)[0]; @@ -256,4 +258,82 @@ protected function resolveStyleSheetPlaceholders($css_file) { return str_replace($token_candidate, $extensions[$token]->getPath(), $css_file); } } + + /** + * Prepares stylesheets-remove specified in the *.info.yml file. + * + * @param \Drupal\Core\Extension\Extension $theme + * The theme extension object. + * @param \Drupal\Core\Extension\Extension[] $base_themes + * An array of base themes. + * + * @return string[] + * The list of stylesheets-remove specified in the *.info.yml file. + * + * @todo Remove in Drupal 9.0.x. + */ + protected function prepareStylesheetsRemove(Extension $theme, $base_themes) { + // Prepare stylesheets from this theme as well as all ancestor themes. + // We work it this way so that we can have child themes remove CSS files + // easily from parent. + $stylesheets_remove = array(); + // Grab stylesheets from base theme. + foreach ($base_themes as $base) { + $base_theme_path = $base->getPath(); + if (!empty($base->info['stylesheets-remove'])) { + foreach ($base->info['stylesheets-remove'] as $css_file) { + $css_file = $this->resolveStyleSheetPlaceholders($css_file); + $stylesheets_remove[$css_file] = $css_file; + } + } + } + + // Add stylesheets used by this theme. + if (!empty($theme->info['stylesheets-remove'])) { + foreach ($theme->info['stylesheets-remove'] as $css_file) { + $css_file = $this->resolveStyleSheetPlaceholders($css_file); + $stylesheets_remove[$css_file] = $css_file; + } + } + return $stylesheets_remove; + } + + /** + * Ensures that a full path is returned for an overriding theme asset. + * + * If the specified $source is a library, then the $destination is returned + * without change. + * + * @param \Drupal\Core\Extension\Extension $theme + * The theme or base theme. + * @param string $source + * The source asset path, i.e. the library to be replaced. + * @param string $destination + * The library or library asset replacing the source. + * + * @return string + * A fully resolved theme asset path relative to the Drupal directory. + */ + protected function resolveThemeAssetPath(Extension $theme, $source, $destination) { + // Full library definitions don't need to be resolved. + if (count(explode('/', $source)) === 2) { + return $destination; + } + // The destination is not an absolute path and it's not a URI (e.g. + // public://generated_js/example.js or http://example.com/js/my_js.js), so + // it's relative to the theme. + if ($destination[0] !== '/' && !$this->isValidUri($destination)) { + $theme_path = $theme->getPath(); + return '/' . $theme_path . '/' . $destination; + } + return $destination; + } + + /** + * Determines if the supplied string is a valid URI. + */ + protected function isValidUri($string) { + return count(explode('://', $string)) === 2; + } + } diff --git a/core/modules/system/src/Tests/Asset/LibraryDiscoveryIntegrationTest.php b/core/modules/system/src/Tests/Asset/LibraryDiscoveryIntegrationTest.php index 2ddccea..f2560fc 100644 --- a/core/modules/system/src/Tests/Asset/LibraryDiscoveryIntegrationTest.php +++ b/core/modules/system/src/Tests/Asset/LibraryDiscoveryIntegrationTest.php @@ -7,6 +7,7 @@ namespace Drupal\system\Tests\Asset; +use Drupal\Core\Asset\Exception\InvalidLibrariesOverrideSpecificationException; use Drupal\simpletest\KernelTestBase; /** @@ -17,29 +18,207 @@ class LibraryDiscoveryIntegrationTest extends KernelTestBase { /** + * The library discovery service. + * + * @var \Drupal\Core\Asset\LibraryDiscoveryInterface + */ + protected $libraryDiscovery; + + /** * {@inheritdoc} */ protected function setUp() { parent::setUp(); $this->container->get('theme_handler')->install(['test_theme', 'classy']); + $this->libraryDiscovery = $this->container->get('library.discovery'); } /** * Ensures that the element info can be altered by themes. */ public function testElementInfoByTheme() { + $this->activateTheme('test_theme'); + $this->assertTrue($this->libraryDiscovery->getLibraryByName('test_theme', 'kitten')); + } + + /** + * Tests that libraries-override are applied to library definitions. + */ + public function testLibrariesOverride() { + // Activate test theme that defines libraries overrides. + $this->activateTheme('test_theme'); + + // Assert that entire library was correctly overridden. + $this->assertEqual($this->libraryDiscovery->getLibraryByName('core', 'drupal.collapse'), $this->libraryDiscovery->getLibraryByName('test_theme', 'collapse'), 'Entire library correctly overridden.'); + + // Assert that library asset was correctly overridden. + $this->assertAssetInLibrary('core/modules/system/tests/themes/test_theme/css/test_theme_layout.css', 'classy', 'base', 'css'); + + // Assert that entire library was correctly removed. + $this->assertFalse($this->libraryDiscovery->getLibraryByName('core', 'drupal.progress'), 'Entire library correctly removed.'); + + // Assert that library asset was correctly removed. + $this->assertNoAssetInLibrary('core/misc/dialog.theme.css', 'core', 'drupal.dialog', 'css'); + + // Assert that overridden library asset still retains attributes. + $library = $this->libraryDiscovery->getLibraryByName('core', 'jquery'); + foreach ($library['js'] as $definition) { + if ($definition['data'] == 'core/modules/system/tests/themes/test_theme/js/collapse.js') { + $this->assertTrue($definition['minified'] && $definition['weight'] == -20, 'Previous attributes retained'); + break; + } + } + } + + /** + * Tests libraries-override on drupalSettings. + */ + public function testLibrariesOverrideDrupalSettings() { + // Activate test theme that attempts to override drupalSettings. + $this->activateTheme('test_theme_libraries_override_with_drupal_settings'); + + // Assert that drupalSettings cannot be overridden and throws an exception. + try { + $this->libraryDiscovery->getLibraryByName('core', 'drupal.ajax'); + $this->fail('Throw Exception when trying to override drupalSettings'); + } + catch (InvalidLibrariesOverrideSpecificationException $e) { + $expected_message = 'drupalSettings may not be overridden in libraries-override. Trying to override core/drupal.ajax/drupalSettings/ajaxPageState. Use hook_library_info_alter() instead.'; + $this->assertEqual($e->getMessage(), $expected_message, 'Throw Exception when trying to override drupalSettings'); + } + } + + /** + * Tests libraries-override on malformed assets. + */ + public function testLibrariesOverrideMalformedAsset() { + // Activate test theme that overrides with a malformed asset. + $this->activateTheme('test_theme_libraries_override_with_invalid_asset'); + + // Assert that improperly formed asset "specs" throw an exception. + try { + $this->libraryDiscovery->getLibraryByName('core', 'drupal.dialog'); + $this->fail('Throw Exception when specifying invalid override'); + } + catch (InvalidLibrariesOverrideSpecificationException $e) { + $expected_message = 'Library asset core/drupal.dialog/css is not correctly specified. It should be in the form "extension/library_name/sub_key/path/to/asset.js".'; + $this->assertEqual($e->getMessage(), $expected_message, 'Throw Exception when specifying invalid override'); + } + } + + /** + * Tests library assets with other ways for specifying paths. + */ + public function testLibrariesOverrideOtherAssetLibraryNames() { + // Activate test theme that defines libraries overrides on other types of + // assets. + $this->activateTheme('test_theme'); + + // Assert Drupal relative paths. + $this->assertAssetInLibrary('themes/my_theme/css/dropbutton.css', 'core', 'drupal.dropbutton', 'css'); + + // Assert stream wrapper paths. + $this->assertAssetInLibrary('public://my_css/vertical-tabs.css', 'core', 'drupal.vertical-tabs', 'css'); + + // Assert protocol-relative URI. + $this->assertAssetInLibrary('//my-server/my_theme/css/jquery_ui.css', 'core', 'jquery.ui', 'css'); + + // Assert regular URI. + $this->assertAssetInLibrary('http://example.com/my_theme/css/farbtastic.css', 'core', 'jquery.farbtastic', 'css'); + } + + /** + * Tests that base theme libraries-override still apply in sub themes. + */ + public function testBaseThemeLibrariesOverrideInSubTheme() { + // Activate test theme that has subthemes. + $this->activateTheme('test_subtheme'); + + // Assert that libraries-override specified in the base theme still applies + // in sub theme. + $this->assertNoAssetInLibrary('core/misc/dialog/dialog.js', 'core', 'drupal.dialog', 'js'); + $this->assertAssetInLibrary('core/modules/system/tests/themes/test_basetheme/css/farbtastic.css', 'core', 'jquery.farbtastic', 'css'); + } + + /** + * Activates a specified theme. + * + * Installs the theme if not already installed and makes it the active theme. + * + * @param string $theme_name + * The name of the theme to be activated. + */ + protected function activateTheme($theme_name) { + $this->container->get('theme_handler')->install([$theme_name]); + /** @var \Drupal\Core\Theme\ThemeInitializationInterface $theme_initializer */ $theme_initializer = $this->container->get('theme.initialization'); /** @var \Drupal\Core\Theme\ThemeManagerInterface $theme_manager */ $theme_manager = $this->container->get('theme.manager'); - /** @var \Drupal\Core\Render\ElementInfoManagerInterface $element_info */ - $library_discovery = $this->container->get('library.discovery'); + $theme_manager->setActiveTheme($theme_initializer->getActiveThemeByName($theme_name)); + } - $theme_manager->setActiveTheme($theme_initializer->getActiveThemeByName('test_theme')); - $this->assertTrue($library_discovery->getLibraryByName('test_theme', 'kitten')); + /** + * Asserts that the specified asset is in the given library. + * + * @param string $asset + * The asset file with the path for the file. + * @param string $extension + * The extension wherein the $library is defined. + * @param string $library_name + * Name of the library. + * @param mixed $sub_key + * The library sub_key where the given asset is defined. + * @param string $message + * (optional) A message to display with the assertion. + * + * @return bool + * TRUE if the specified asset is found in the library. + */ + protected function assertAssetInLibrary($asset, $extension, $library_name, $sub_key, $message = NULL) { + if (!isset($message)) { + $message = sprintf('Asset %s found in library %s', $asset, $library_name); + } + $library = $this->libraryDiscovery->getLibraryByName($extension, $library_name); + foreach ($library[$sub_key] as $definition) { + if ($asset == $definition['data']) { + return $this->pass($message); + } + } + return $this->fail($message); + } + + /** + * Asserts that the specified asset is not in the given library. + * + * @param string $asset + * The asset file with the path for the file. + * @param string $extension + * The extension where-in the $library_name is defined. + * @param string $library_name + * Name of the library. + * @param mixed $sub_key + * The library sub_key where the given asset is defined. + * @param string $message + * (optional) A message to display with the assertion. + * + * @return bool + * TRUE if the specified asset is not found in the library. + */ + protected function assertNoAssetInLibrary($asset, $extension, $library_name, $sub_key, $message = NULL) { + if (!isset($message)) { + $message = sprintf('Asset %s not found in library %s', $asset, $library_name); + } + $library = $this->libraryDiscovery->getLibraryByName($extension, $library_name); + foreach ($library[$sub_key] as $definition) { + if ($asset == $definition['data']) { + return $this->fail($message); + } + } + return $this->pass($message); } } diff --git a/core/modules/system/src/Tests/Theme/ThemeTest.php b/core/modules/system/src/Tests/Theme/ThemeTest.php index bab41ad..e870191 100644 --- a/core/modules/system/src/Tests/Theme/ThemeTest.php +++ b/core/modules/system/src/Tests/Theme/ThemeTest.php @@ -175,7 +175,7 @@ function testCSSOverride() { $config->set('css.preprocess', 0); $config->save(); $this->drupalGet('theme-test/suggestion'); - $this->assertNoText('system.module.css', 'The theme\'s .info.yml file is able to override a module CSS file from being added to the page.'); + $this->assertNoText('system.module.css', "The theme's .info.yml file is able to remove a module CSS file from being added to the page."); // Also test with aggregation enabled, simply ensuring no PHP errors are // triggered during drupal_build_css_cache() when a source file doesn't diff --git a/core/modules/system/tests/themes/test_basetheme/test_basetheme.info.yml b/core/modules/system/tests/themes/test_basetheme/test_basetheme.info.yml index dcb1a2f..587070c 100644 --- a/core/modules/system/tests/themes/test_basetheme/test_basetheme.info.yml +++ b/core/modules/system/tests/themes/test_basetheme/test_basetheme.info.yml @@ -7,3 +7,6 @@ libraries: - test_basetheme/global-styling stylesheets-remove: - '@theme_test/css/base-remove.css' +libraries-override: + core/drupal.dialog/js/misc/dialog/dialog.js: false + core/jquery.farbtastic/css/component/assets/vendor/farbtastic/farbtastic.css: css/farbtastic.css diff --git a/core/modules/system/tests/themes/test_theme/css/collapse.css b/core/modules/system/tests/themes/test_theme/css/collapse.css new file mode 100644 index 0000000..23f38b3 --- /dev/null +++ b/core/modules/system/tests/themes/test_theme/css/collapse.css @@ -0,0 +1,4 @@ +/** + * @file + * Test CSS asset file for test_theme.theme. + */ diff --git a/core/modules/system/tests/themes/test_theme/js/collapse.js b/core/modules/system/tests/themes/test_theme/js/collapse.js new file mode 100644 index 0000000..4d66841 --- /dev/null +++ b/core/modules/system/tests/themes/test_theme/js/collapse.js @@ -0,0 +1,4 @@ +/** + * @file + * Test JS asset file for test_theme.theme. + */ diff --git a/core/modules/system/tests/themes/test_theme/test_theme.info.yml b/core/modules/system/tests/themes/test_theme/test_theme.info.yml index e9d6602..9e12ea1 100644 --- a/core/modules/system/tests/themes/test_theme/test_theme.info.yml +++ b/core/modules/system/tests/themes/test_theme/test_theme.info.yml @@ -18,6 +18,25 @@ stylesheets-remove: - '@system/css/system.module.css' libraries: - test_theme/global-styling +libraries-override: + # Replace an entire library. + core/drupal.collapse: test_theme/collapse + # Remove an entire library. + core/drupal.progress: false + # Replace one particular library asset with another. + classy/base/css/theme/css/layout.css: css/test_theme_layout.css + # Remove one particular asset. + core/drupal.dialog/css/theme/misc/dialog.theme.css: false + # It works for JS as well. + core/jquery/js/assets/vendor/jquery/jquery.min.js: js/collapse.js + # Use Drupal relative paths. + core/drupal.dropbutton/css/component/misc/dropbutton/dropbutton.css: /themes/my_theme/css/dropbutton.css + # Use stream wrappers. + core/drupal.vertical-tabs/css/component/misc/vertical-tabs.css: public://my_css/vertical-tabs.css + # Use protocol-relative URI. + core/jquery.ui/css/component/assets/vendor/jquery.ui/themes/base/core.css: //my-server/my_theme/css/jquery_ui.css + # Use regular URI. + core/jquery.farbtastic/css/component/assets/vendor/farbtastic/farbtastic.css: http://example.com/my_theme/css/farbtastic.css regions: content: Content left: Left diff --git a/core/modules/system/tests/themes/test_theme/test_theme.libraries.yml b/core/modules/system/tests/themes/test_theme/test_theme.libraries.yml index c1fe4a5..d82f1d8 100644 --- a/core/modules/system/tests/themes/test_theme/test_theme.libraries.yml +++ b/core/modules/system/tests/themes/test_theme/test_theme.libraries.yml @@ -3,3 +3,10 @@ global-styling: css: base: kitten.css: {} +collapse: + js: + js/collapse.js: { } + + css: + base: + css/collapse.css: { } diff --git a/core/modules/system/tests/themes/test_theme_libraries_override_with_drupal_settings/test_theme_libraries_override_with_drupal_settings.info.yml b/core/modules/system/tests/themes/test_theme_libraries_override_with_drupal_settings/test_theme_libraries_override_with_drupal_settings.info.yml new file mode 100644 index 0000000..e6e6f1f --- /dev/null +++ b/core/modules/system/tests/themes/test_theme_libraries_override_with_drupal_settings/test_theme_libraries_override_with_drupal_settings.info.yml @@ -0,0 +1,10 @@ +name: 'Test theme libraries-override' +type: theme +description: 'Theme with drupalSettings libraries-override' +version: VERSION +base theme: classy +core: 8.x +libraries-override: + # drupalSettings libraries override. Should throw a + # \Drupal\Core\Asset\Exception\InvalidLibrariesOverrideSpecificationException. + core/drupal.ajax/drupalSettings/ajaxPageState: { } diff --git a/core/modules/system/tests/themes/test_theme_libraries_override_with_invalid_asset/test_theme_libraries_override_with_invalid_asset.info.yml b/core/modules/system/tests/themes/test_theme_libraries_override_with_invalid_asset/test_theme_libraries_override_with_invalid_asset.info.yml new file mode 100644 index 0000000..befe8d8 --- /dev/null +++ b/core/modules/system/tests/themes/test_theme_libraries_override_with_invalid_asset/test_theme_libraries_override_with_invalid_asset.info.yml @@ -0,0 +1,10 @@ +name: 'Test theme libraries-override' +type: theme +description: 'Theme with invalid libraries-override asset spec.' +version: VERSION +base theme: classy +core: 8.x +libraries-override: + # A malformed library asset name. Should throw a + # \Drupal\Core\Asset\Exception\InvalidLibrariesOverrideSpecificationException. + core/drupal.dialog/css: false diff --git a/core/tests/Drupal/Tests/Core/Asset/LibraryDiscoveryParserTest.php b/core/tests/Drupal/Tests/Core/Asset/LibraryDiscoveryParserTest.php index 9865cb2..2f5ed21 100644 --- a/core/tests/Drupal/Tests/Core/Asset/LibraryDiscoveryParserTest.php +++ b/core/tests/Drupal/Tests/Core/Asset/LibraryDiscoveryParserTest.php @@ -73,6 +73,15 @@ protected function setUp() { $this->moduleHandler = $this->getMock('Drupal\Core\Extension\ModuleHandlerInterface'); $this->themeManager = $this->getMock('Drupal\Core\Theme\ThemeManagerInterface'); + $mock_active_theme = $this->getMockBuilder('Drupal\Core\Theme\ActiveTheme') + ->disableOriginalConstructor() + ->getMock(); + $mock_active_theme->expects($this->any()) + ->method('getLibrariesOverride') + ->willReturn([]); + $this->themeManager->expects($this->any()) + ->method('getActiveTheme') + ->willReturn($mock_active_theme); $this->libraryDiscoveryParser = new TestLibraryDiscoveryParser($this->root, $this->moduleHandler, $this->themeManager); } diff --git a/core/tests/Drupal/Tests/Core/Theme/RegistryTest.php b/core/tests/Drupal/Tests/Core/Theme/RegistryTest.php index 0cb5a25..0cd6914 100644 --- a/core/tests/Drupal/Tests/Core/Theme/RegistryTest.php +++ b/core/tests/Drupal/Tests/Core/Theme/RegistryTest.php @@ -93,7 +93,7 @@ public function testGetRegistryForModule() { 'engine' => 'twig', 'owner' => 'twig', 'stylesheets_remove' => [], - 'stylesheets_override' => [], + 'libraries_override' => [], 'libraries' => [], 'extension' => '.twig', 'base_themes' => [], diff --git a/core/themes/bartik/bartik.info.yml b/core/themes/bartik/bartik.info.yml index 8b52f48..aa0c18d 100644 --- a/core/themes/bartik/bartik.info.yml +++ b/core/themes/bartik/bartik.info.yml @@ -5,10 +5,10 @@ description: 'A flexible, recolorable theme with many regions and a responsive, package: Core version: VERSION core: 8.x -stylesheets-remove: - - '@classy/css/layout.css' libraries: - bartik/global-styling +libraries-override: + classy/base/css/theme/css/layout.css: false ckeditor_stylesheets: - css/base/elements.css - css/components/captions.css @@ -33,4 +33,3 @@ regions: footer_third: 'Footer third' footer_fourth: 'Footer fourth' footer_fifth: 'Footer fifth' - diff --git a/core/themes/seven/seven.info.yml b/core/themes/seven/seven.info.yml index 1427896..2556e15 100644 --- a/core/themes/seven/seven.info.yml +++ b/core/themes/seven/seven.info.yml @@ -8,9 +8,9 @@ version: VERSION core: 8.x libraries: - seven/global-styling -stylesheets-remove: - - core/assets/vendor/jquery.ui/themes/base/dialog.css - - '@classy/css/layout.css' +libraries-override: + core/jquery.ui.dialog/css/component/assets/vendor/jquery.ui/themes/base/dialog.css: false + classy/base/css/theme/css/layout.css: false quickedit_stylesheets: - css/components/quickedit.css regions: