[#7] Add missing robots.txt file to the asset file types

.travis/test-script.sh

@@ -118,3 +118,41 @@ if [ ! -L "$SITE_WEB/themes/travis-test-image.jpg" ]; then
 else
  echo "${MSG_OK} 'composer drupal:paranoia' command re-created the web directory with new symlinks"
 fi
+
+##
+# Create a "customfile.txt", configure the 'drupal-asset-files' extra key,
+# run the command 'composer drupal:paranoia' and check if the file has been symlinked.
+#
+echo "${MSG_INFO} Create a \"customfile.txt\" and configure the 'drupal-asset-files' extra key to check if the file has been symlinked."
+
+touch "$SITE_APP/customfile.txt"
+composer config extra.drupal-asset-files.should-be-simlinked customfile.txt
+
+# Rebuild web directory.
+composer drupal:paranoia || exit 1
+
+if [ ! -L "$SITE_WEB/customfile.txt" ]; then
+ echo "${MSG_ERROR} 'composer drupal:paranoia' command did not re-create the web directory with extra symlinks"
+ exit 1
+else
+ echo "${MSG_OK} 'composer drupal:paranoia' command re-created the web directory with extra symlinks"
+fi
+
+##
+# Create a "customfile.php", configure the 'drupal-asset-files' extra key,
+# run the command 'composer drupal:paranoia' and check if the file has not been symlinked.
+#
+echo "${MSG_INFO} Create a \"customfile.php\" and configure the 'drupal-asset-files' extra key to check if the file has not been symlinked."
+
+touch "$SITE_APP/customfile.php"
+composer config extra.drupal-asset-files.should-not-be-simlinked customfile.php
+
+# Rebuild web directory.
+composer drupal:paranoia || exit 1
+
+if [ -L "$SITE_WEB/customfile.php" ]; then
+ echo "${MSG_ERROR} 'composer drupal:paranoia' command re-created the web directory with WRONG extra symlinks"
+ exit 1
+else
+ echo "${MSG_OK} 'composer drupal:paranoia' command did not re-create the web directory with WRONG extra symlinks"
+fi

README.md

@@ -47,6 +47,56 @@ composer require drupal-composer/drupal-paranoia:~1
 
 Done! Plugin and new docroot are now installed.
 
+## Optional Configuration
+
+### Modify the asset file types
+
+To extend the list of assets file types you can use the
+`drupal-asset-files` extra key:
+```json
+"extra": {
+ "drupal-asset-files": [
+ "somefile.txt",
+ "*.md"
+ ],
+ "..."
+}
+```
+
+If you need to modify it you can use the 
+`post-drupal-set-asset-file-types` event:
+```json
+"scripts": {
+ "post-drupal-set-asset-file-types": [
+ "DrupalProject\\composer\\ScriptHandler::setAssetFileTypes"
+ ],
+ "..."
+},
+```
+
+```php
+<?php
+
+/**
+ * @file
+ * Contains \DrupalProject\composer\ScriptHandler.
+ */
+
+namespace DrupalProject\composer;
+
+use DrupalComposer\DrupalParanoia\AssetFileTypesEvent;
+
+class ScriptHandler {
+
+ public static function setAssetFileTypes(AssetFileTypesEvent $event) {
+ $asset_file_types = $event->getAssetFileTypes();
+ // Do what you want with the asset file types.
+ $event->setAssetFileTypes($asset_file_types);
+ }
+
+}
+```
+
 ## Folder structure
 Your project now is basically structured on two folders.
 - __app__: Contains the files and folders of the full Drupal installation.

src/AssetFileTypesEvent.php

@@ -0,0 +1,94 @@
+<?php
+
+namespace DrupalComposer\DrupalParanoia;
+
+use Composer\Composer;
+use Composer\EventDispatcher\Event;
+use Composer\IO\IOInterface;
+
+/**
+ * Class AssetFileTypesEvent.
+ *
+ * @package DrupalComposer\DrupalParanoia
+ */
+class AssetFileTypesEvent extends Event {
+
+ /**
+ * This event occurs after the asset file types have been set.
+ *
+ * @var string
+ */
+ const POST_DRUPAL_SET_ASSET_FILE_TYPES = 'post-drupal-set-asset-file-types';
+
+ /**
+ * Composer object.
+ *
+ * @var \Composer\Composer
+ */
+ private $composer;
+
+ /**
+ * IO object.
+ *
+ * @var \Composer\IO\IOInterface
+ */
+ private $io;
+
+ /**
+ * Asset file types.
+ *
+ * @var array
+ */
+ private $assetFileTypes;
+
+ /**
+ * AssetFileTypesEvent constructor.
+ *
+ * @param array $assetFileTypes
+ * The asset file types.
+ * @param \Composer\Composer $composer
+ * The composer object.
+ * @param \Composer\IO\IOInterface $io
+ * The IOInterface object.
+ * @param array $args
+ * Arguments passed by the user
+ * @param array $flags
+ * Optional flags to pass data not as argument.
+ */
+ public function __construct(array $assetFileTypes, Composer $composer, IOInterface $io, array $args = array(), array $flags = array()) {
+ parent::__construct(self::POST_DRUPAL_SET_ASSET_FILE_TYPES, $args, $flags);
+
+ $this->composer = $composer;
+ $this->io = $io;
+ $this->assetFileTypes = $assetFileTypes;
+ }
+
+ /**
+ * @return \Composer\Composer
+ */
+ public function getComposer() {
+ return $this->composer;
+ }
+
+ /**
+ * @return \Composer\IO\IOInterface
+ */
+ public function getIo() {
+ return $this->io;
+ }
+
+ /**
+ * @return array
+ */
+ public function getAssetFileTypes() {
+ return $this->assetFileTypes;
+ }
+
+ /**
+ * @param array $assetFileTypes
+ */
+ public function setAssetFileTypes(array $assetFileTypes) {
+ $this->assetFileTypes = $assetFileTypes;
+ }
+
+}

src/Installer.php

@@ -20,6 +20,13 @@
  */
 class Installer {
 
+ /**
+ * Composer object.
+ *
+ * @var \Composer\Composer
+ */
+ protected $composer;
+
  /**
  * IO object.
  *
@@ -32,22 +39,7 @@ class Installer {
  *
  * @var array
  */
- public $assetFileTypes = [
- '.htaccess',
- '*.css',
- '*.eot',
- '*.ico',
- '*.gif',
- '*.jpeg',
- '*.jpg',
- '*.js',
- '*.otf',
- '*.png',
- '*.svg',
- '*.ttf',
- '*.woff',
- '*.woff2',
- ];
+ public $assetFileTypes;
 
  /**
  * Front controllers.
@@ -98,9 +90,10 @@ class Installer {
  * The IO object.
  */
  public function __construct(Composer $composer, IOInterface $io) {
+ $this->composer = $composer;
  $this->io = $io;
 
- $extra = $composer->getPackage()->getExtra();
+ $extra = $this->composer->getPackage()->getExtra();
 
  if (!isset($extra['drupal-app-dir'])) {
  throw new \RuntimeException('Please configure drupal-app-dir in your composer.json');
@@ -117,6 +110,8 @@ public function __construct(Composer $composer, IOInterface $io) {
  if (!empty($extra['drupal-web-dir-public-files'])) {
  $this->publicFilesSymlinkTarget = $extra['drupal-web-dir-public-files'];
  }
+
+ $this->setAssetFileTypes();
  }
 
  /**
@@ -262,6 +257,7 @@ public function createAssetSymlinks() {
  $finder->name($name);
  }
  $finder->exclude('sites/default/files');
+ $finder->notName('/\.php/');
 
  $cfs = new ComposerFilesystem();
 
@@ -299,4 +295,38 @@ public function createStubPhpFile($path) {
  $fs->dumpFile($webDir . '/' . $path, $content);
  }
 
+ /**
+ * Set the asset file types.
+ */
+ public function setAssetFileTypes() {
+ $this->assetFileTypes = [
+ 'robots.txt',
+ '.htaccess',
+ '*.css',
+ '*.eot',
+ '*.ico',
+ '*.gif',
+ '*.jpeg',
+ '*.jpg',
+ '*.js',
+ '*.otf',
+ '*.png',
+ '*.svg',
+ '*.ttf',
+ '*.woff',
+ '*.woff2',
+ ];
+
+ // Allow people to extend the list from a composer extra key.
+ $extra = $this->composer->getPackage()->getExtra();
+ if(!empty($extra['drupal-asset-files'])) {
+ $this->assetFileTypes = array_merge($this->assetFileTypes, $extra['drupal-asset-files']);
+ }
+
+ // Allow other plugins to alter the list of files.
+ $event = new AssetFileTypesEvent($this->assetFileTypes, $this->composer, $this->io);
+ $this->composer->getEventDispatcher()->dispatch($event->getName(), $event);
+ $this->assetFileTypes = $event->getAssetFileTypes();
+ }
+
 }