Add Composer plugin which scaffolds a Vagtranfile

Author: oxyc

Vagrantfile

@@ -3,17 +3,29 @@
 
 require './lib/drupalvm/vagrant'
 
-# Absolute paths on the host machine.
-host_drupalvm_dir = File.dirname(File.expand_path(__FILE__))
-host_project_dir = ENV['DRUPALVM_PROJECT_ROOT'] || host_drupalvm_dir
-host_config_dir = ENV['DRUPALVM_CONFIG_DIR'] ? "#{host_project_dir}/#{ENV['DRUPALVM_CONFIG_DIR']}" : host_project_dir
+drupalvm_env = ENV['DRUPALVM_ENV'] || 'vagrant'
 
-# Absolute paths on the guest machine.
-guest_project_dir = '/vagrant'
-guest_drupalvm_dir = ENV['DRUPALVM_DIR'] ? "/vagrant/#{ENV['DRUPALVM_DIR']}" : guest_project_dir
-guest_config_dir = ENV['DRUPALVM_CONFIG_DIR'] ? "/vagrant/#{ENV['DRUPALVM_CONFIG_DIR']}" : guest_project_dir
+# Default paths when the project is based on Drupal VM.
+host_project_dir = host_drupalvm_dir = host_config_dir = __dir__
+guest_project_dir = guest_drupalvm_dir = guest_config_dir = '/vagrant'
 
-drupalvm_env = ENV['DRUPALVM_ENV'] || 'vagrant'
+if File.exist?("#{host_project_dir}/composer.json")
+  cconfig = load_composer_config("#{host_project_dir}/composer.json")
+
+  # If Drupal VM is a Composer dependency set the correct path.
+  vendor_dir = `composer config vendor-dir`.strip
+  drupalvm_path = "#{vendor_dir}/geerlingguy/drupal-vm"
+  if Dir.exist?("#{host_project_dir}/#{drupalvm_path}")
+    host_drupalvm_dir = "#{host_project_dir}/#{drupalvm_path}"
+    guest_drupalvm_dir = "#{guest_project_dir}/#{drupalvm_path}"
+  end
+
+  # Read config_dir from composer.json if set.
+  if cconfig.include?('config_dir')
+    host_config_dir = "#{host_project_dir}/#{cconfig['config_dir']}"
+    guest_config_dir = "#{guest_project_dir}/#{cconfig['config_dir']}"
+  end
+end
 
 default_config_file = "#{host_drupalvm_dir}/default.config.yml"
 unless File.exist?(default_config_file)

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "geerlingguy/drupal-vm",
-    "type": "vm",
+    "type": "composer-plugin",
     "description": "A VM for local Drupal development, built with Vagrant + Ansible",
     "keywords": ["vagrant", "vm", "virtual machine", "drupal"],
     "homepage": "https://www.drupalvm.com",
@@ -20,5 +20,15 @@
         "source": "https://github.com/geerlingguy/drupal-vm",
         "docs": "http://docs.drupalvm.com"
     },
-    "require": {}
+    "require": {
+        "composer-plugin-api": "^1.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "JJG\\DrupalVM\\": "composer/src/"
+        }
+    },
+    "extra": {
+        "class": "JJG\\DrupalVM\\Plugin"
+    }
 }

composer/src/Plugin.php

@@ -0,0 +1,65 @@
+<?php
+/**
+ * @file
+ * Contains JJG\DrupalVM|Plugin.
+ */
+
+namespace JJG\DrupalVM;
+
+use Composer\Composer;
+use Composer\EventDispatcher\EventSubscriberInterface;
+use Composer\Factory;
+use Composer\IO\IOInterface;
+use Composer\Plugin\PluginInterface;
+use Composer\Script\Event;
+use Composer\Script\ScriptEvents;
+
+class Plugin implements PluginInterface, EventSubscriberInterface {
+
+    /**
+     * @var \Composer\Composer
+     */
+    protected $composer;
+
+    /**
+     * @var \Composer\IO\IOInterface
+     */
+    protected $io;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function activate(Composer $composer, IOInterface $io) {
+        $this->composer = $composer;
+        $this->io = $io;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedEvents() {
+        return array(
+            ScriptEvents::POST_INSTALL_CMD => 'addVagrantfile',
+            ScriptEvents::POST_UPDATE_CMD => 'addVagrantfile',
+        );
+    }
+
+    /**
+     * Add/update project Vagrantfile.
+     *
+     * @param \Composer\Script\Event $event
+     */
+    public function addVagrantfile(Event $event) {
+
+        $baseDir = dirname(Factory::getComposerFile());
+        $source = __DIR__ . '/../../Vagrantfile';
+        $target =  $baseDir . '/Vagrantfile';
+
+        if (file_exists($source)) {
+            if (!file_exists($target) || md5_file($source) != md5_file($target)) {
+                copy($source, $target);
+            }
+        }
+    }
+
+}

lib/drupalvm/vagrant.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'yaml'
 
 # Cross-platform way of finding an executable in the $PATH.
@@ -33,6 +34,16 @@ def resolve_jinja_variables(vconfig)
   end
 end
 
+# Return the drupalvm extra-field from the passed composer.json
+def load_composer_config(path)
+  cconfig = {}
+  composer_conf = JSON.parse(File.read(path))
+  if composer_conf['extra'] && composer_conf['extra']['drupalvm']
+    cconfig = composer_conf['extra']['drupalvm']
+  end
+  cconfig
+end
+
 # Return the combined configuration content all files provided.
 def load_config(files)
   vconfig = {}