Merge pull request #17 from drupal-composer/generate-autoload

Fixes #16: Generate the autoload.php file at the Drupal project root.

Author: greg-1-anderson

README.md

@@ -3,6 +3,13 @@
 Composer plugin for automatically downloading Drupal scaffold files (like
 `index.php`, `update.php`, …) when using `drupal/core` via Composer.
 
+It is recommended that the vendor directory be placed in its standard location
+at the project root, outside of the Drupal root; however, the location of the
+vendor directory and the name of the Drupal root may be placed in whatever
+location suits the project.  Drupal-scaffold will generate the autoload.php 
+file at the Drupal root to require the Composer-generated autoload file in the 
+vendor directory.
+
 ## Usage
 
 `composer require drupal-composer/drupal-scaffold:dev-master` in your composer

src/Handler.php

@@ -82,6 +82,7 @@ public function onPostCmdEvent(\Composer\Script\Event $event) {
     // AND there are no scaffolding files present.
     if (isset($this->drupalCorePackage) && $this->checkAction($event)) {
       $this->downloadScaffold();
+      $this->generateAutoload();
     }
   }
 
@@ -149,6 +150,65 @@ public static function array_to_csv($data, $delimiter = ',', $enclosure = '"', $
     }, $data));
   }
 
+  /**
+   * Generate the autoload file at the project root.  Include the
+   * autoload file that Composer generated.
+   */
+  public function generateAutoload() {
+    $vendorPath = $this->getVendorPath();
+    $webroot = $this->getWebRoot();
+
+    // Calculate the relative path from the webroot (location of the
+    // project autoload.php) to the vendor directory.
+    $fs = new SymfonyFilesystem();
+    $relativeVendorPath = $fs->makePathRelative($vendorPath, realpath($webroot));
+
+    $fs->dumpFile($webroot . "/autoload.php", $this->autoLoadContents($relativeVendorPath));
+  }
+
+  /**
+   * Build the contents of the autoload file.
+   *
+   * @return string
+   */
+  protected function autoLoadContents($relativeVendorPath) {
+    $autoloadContents = <<<EOF
+<?php
+
+/**
+ * @file
+ * Includes the autoloader created by Composer.
+ * This file was generated by drupal-composer/drupal-scaffold.
+ * https://github.com/drupal-composer/drupal-scaffold
+ *
+ * @see composer.json
+ * @see index.php
+ * @see core/install.php
+ * @see core/rebuild.php
+ * @see core/modules/statistics/statistics.php
+ */
+
+return require __DIR__ . '/$relativeVendorPath/autoload.php';
+
+EOF;
+    return $autoloadContents;
+  }
+
+  /**
+   * Get the path to the 'vendor' directory.
+   *
+   * @return string
+   */
+  public function getVendorPath() {
+    $config = $this->composer->getConfig();
+    $filesystem = new Filesystem();
+    $filesystem->ensureDirectoryExists($config->get('vendor-dir'));
+    $basePath = $filesystem->normalizePath(realpath(getcwd()));
+    $vendorPath = $filesystem->normalizePath(realpath($config->get('vendor-dir')));
+
+    return $vendorPath;
+  }
+
   /**
    * Look up the Drupal core package object, or return it from where we cached
    * it in the $drupalCorePackage field.

src/Plugin.php

@@ -68,12 +68,24 @@ public function postCmd(\Composer\Script\Event $event) {
   }
 
   /**
-   * Script callback for putting in composer scripts.
+   * Script callback for putting in composer scripts to download the
+   * scaffold files.
    *
    * @param \Composer\Script\Event $event
    */
   public static function scaffold(\Composer\Script\Event $event) {
     $handler = new Handler($event->getComposer(), $event->getIO());
     $handler->downloadScaffold();
   }
+
+  /**
+   * Script callback for putting in composer scripts to generate the
+   * autoload file at the project root.
+   *
+   * @param \Composer\Script\Event $event
+   */
+  public static function generateAutoload(\Composer\Script\Event $event) {
+    $handler = new Handler($event->getComposer(), $event->getIO());
+    $handler->generateAutoload();
+  }
 }