vagrant-wizard 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2037e39c36f1bcac7076d8382b341d596458e39fb2706e8f7fd27e63dad674c1
-  data.tar.gz: e954b4f407d95115de932b82ca7dca33b676202aab97ddabc3d66d40ef58a18e
+  metadata.gz: 8c183815a69a812fc4d310b0e52541bfe78ac6941a5e54602dafcb8c14377b41
+  data.tar.gz: c45e43ba46124236729f44cd5bbebd336a054ad1f574f73aff40758779aafae9
 SHA512:
-  metadata.gz: 562bf75d191b95ce0f5d23063d234f5972d53ffa214dc08e8884833b9ec7497847fa9d5c4e622980c8b6ded0a5f98147f635433085278e13c6c6800901665dfb
-  data.tar.gz: ef844d0970ea3f503b3540a7bde147bf8398c48e9b09002607b8f49d45815eda092c456988bb0630416f5aa23089961051a23fceb7cdea16f106abbe97ef484a
+  metadata.gz: 97ef469ce8de5218e80286a5f9d4f6f4db2cc60a155549fc50cbb8739c274fee16c109060b1dee25cf94be83078624cb0cc115e3c9cb18b9c9f5216c51c92169
+  data.tar.gz: d4799435b5f6a1b388754ba9ffed8ad1e1f1bb65b27e108d98e1cd4e407796405131e47b10d5bcf31bac6f1ad46c79ab79d793059e055e68ffc8f571da75c156

data/Gemfile.lock

@@ -28,7 +28,8 @@ GIT
 PATH
   remote: .
   specs:
-    vagrant-wizard (0.1.0)
+    vagrant-wizard (0.2.15)
+      tty-prompt (~> 0.19.0)
 
 GEM
   remote: https://rubygems.org/
@@ -78,7 +79,6 @@ GEM
     pastel (0.7.3)
       equatable (~> 0.6)
       tty-color (~> 0.5)
-    rake (10.5.0)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
@@ -132,9 +132,6 @@ PLATFORMS
   x64-mingw32
 
 DEPENDENCIES
-  bundler (~> 1.17)
-  rake (~> 10)
-  tty-prompt
   vagrant!
   vagrant-wizard!
 

data/README.md

@@ -4,14 +4,14 @@ Vagrant plugin to easily generate configuration files.
 ## Overview
 Vagrant Wizard allows users to generate YAML configuration files for their
 Vagrant environments using a predefined set of prompts described in a
-**vagrant-wizard.yml** file.
+**config.wizard.yml** file.
 
 ## Usage
-By default, prompts are defined in **vagrant-wizard.yml** and determine which
+By default, prompts are defined in **config.wizard.yml** and determine which
 information is requested from the user. The path to this file can be changed
 in your vagrantfile.
 
-An example **vagrant-wizard.yml** for a MEAN localdev environment might be:
+An example **config.wizard.yml** for a MEAN localdev environment might be:
 
     ---
     prompts:
@@ -50,10 +50,10 @@ If the user passed the ``--advanced`` flag they will also be prompted
 to select the amount of memory to allow the virtual machine to use.
 
 Upon completing the prompts, a new YAML file is created containing the values
-entered by the user. By default, this file is named **vagrant-config.yml**.
+entered by the user. By default, this file is named **config.yml**.
 
 ### Prompts
-The **vagrant-wizard.yml** file has only a ``prompts`` key which contains
+The **config.wizard.yml** file has only a ``prompts`` key which contains
 a list of prompt definitions. Each prompt can accept the following fields:
 
 |Field       |Description                                                |
@@ -101,21 +101,20 @@ correspond to one of the ``value``s specified in the ``choices`` field.
 ### Default Configuration
 Occasionally there will be a need to store values in a configuration file that
 do not actually require user input. These configurations can be specified in
-**vagrant-wizard.default.yml**, and will automatically be passed to any
+**config.defaults.yml**, and will automatically be passed to any
 configuration file that gets generated using Vagrant Wizard.
 
-If the configuration provided by **vagrant-wizard.default.yml** conflicts
-with the configuration specified by the user, the configuration specified
-by the user will overwrite the configuration specified in
-**vagrant-wizard.default.yml**.
+If the configuration provided by **config.defaults.yml** conflicts with the
+configuration specified by the user, the configuration specified by the user
+will overwrite the configuration specified in **config.defaults.yml**.
 
 ### Presets
 Preset configurations can be created and stored in the **wizard-presets**
 directory. A preset is a YAML file whose filename ends in *.preset.yml* and
 which contains a list of key/value pairs which can be automatically used to
-answer prompts specified in **vagrant-wizard.yml**.
+answer prompts specified in **config.wizard.yml**.
 
-For example, a preset for the example **vagrant-wizard.yml** file above might
+For example, a preset for the example **config.wizard.yml** file above might
 be named ``node-10.preset.yml`` and look like this:
 
     meta:
@@ -136,11 +135,36 @@ vagrantfile.
 
 The following configuration options are available:
 
-|Config              |Description                                                             |Default                         |
-|--------------------|------------------------------------------------------------------------|--------------------------------|
-|``config_path``     |Path to Vagrant Wizard config file                                      |``./vagrant-wizard.yml``        |
-|``defaults_path``   |Path to default configuration file                                      |``./vagrant-wizard.default.yml``|
-|``output_path``     |Path to output configuration file                                       |``./vagrant-config.yml``        |
-|``presets_dir_path``|Path to presets directory                                               |``./wizard-presets``            |
-|``prompt_overwrite``|Whether or not to prompt for confirmation before overwriting config file|``true``                        |
-|``prompt_presets``  |Whether or not to prompt for preset selection                           |``true``                        |
+|Config              |Description                                                             |Default                  |
+|--------------------|------------------------------------------------------------------------|-------------------------|
+|``wizard_path``     |Path to Vagrant Wizard config file                                      |``./config.wizard.yml``  |
+|``defaults_path``   |Path to configuration defaults file                                     |``./config.defaults.yml``|
+|``config_path``     |Path to output configuration file                                       |``./config.yml``         |
+|``presets_dir_path``|Path to presets directory                                               |``./wizard-presets``     |
+|``prompt_overwrite``|Whether or not to prompt for confirmation before overwriting config file|``true``                 |
+|``prompt_presets``  |Whether or not to prompt for preset selection                           |``true``                 |
+
+You may find yourself in an interesting predicament when trying to run
+``vagrant wizard`` for the first time. The ``wizard`` command requires
+configuration information from your Vagrantfile to function, but your
+Vagrantfile may not function without a configuration file present.
+
+In these cases, you can use Vagrant Wizard's ``API`` object in your Vagrantfile
+to force the wizard to appear if a configuration file does not already exist:
+
+    # Top of vagrantfile
+    settings = nil
+    if Vagrant.has_plugin?('vagrant-wizard')
+        require 'vagrant-wizard'
+        settings = (VagrantWizard::API.new).require_config
+    end
+    # Optionally attempt to load ./config.yml manually here if 'vagrant-wizard' is not installed.
+    # ...
+    if settings == nil
+      puts "No configuration file found at ./config.yml"
+      exit
+    end
+    # Proceed with regular Vagrant configuration
+    Vagrant.require_version ">= 2.1.2"
+    Vagrant.configure("2") do |config|
+    ...

data/lib/vagrant-wizard.rb

@@ -1,8 +1,61 @@
+require 'tty-prompt'
+
 module VagrantWizard
-  require 'vagrant-wizard/version'
-  require 'vagrant-wizard/plugin'
-  require 'vagrant-wizard/config'
-  require 'vagrant-wizard/loader'
-  require 'vagrant-wizard/prompt-parser'
-  require 'vagrant-wizard/inputs/input'
+  require_relative 'vagrant-wizard/version'
+  require_relative 'vagrant-wizard/plugin'
+  require_relative 'vagrant-wizard/config'
+  require_relative 'vagrant-wizard/prompt-display'
+
+  class API
+    attr_accessor :config_path
+    attr_accessor :defaults_path
+    attr_accessor :wizard_path
+    attr_accessor :presets_dir_path
+    attr_accessor :prompt_presets
+    attr_accessor :prompt_overwrite
+    attr_accessor :advanced
+
+    def initialize
+      @config_path = './config.yml'
+      @defaults_path = './config.defaults.yml'
+      @wizard_path = './config.wizard.yml'
+      @presets_dir_path = './wizard-presets'
+      @prompt_presets = true
+      @prompt_overwrite = true
+      @advanced = false
+    end
+
+    def require_config
+      if File.exist?(@config_path)
+        return YAML.load_file(@config_path)
+      end
+
+      puts "You do not have a configuration file set up for this Vagrant environment."
+
+      confirmationString = 'Would you like to create a configuration file using Vagrant Wizard?'
+      confirmation = TTY::Prompt.new
+
+      if (confirmation.yes?(confirmationString))
+        promptDisplay = PromptDisplay.new
+
+        promptDisplay.wizard_path = @wizard_path
+        promptDisplay.defaults_path = @defaults_path
+        promptDisplay.presets_dir_path = @presets_dir_path
+        promptDisplay.config_path = @config_path
+        promptDisplay.prompt_presets = @prompt_presets
+        promptDisplay.prompt_overwrite = @prompt_overwrite
+        promptDisplay.advanced = @advanced
+        
+        promptDisplay.display
+
+        # User has been prompted, check again for config file.
+        if File.exist?(@config_path)
+          return YAML.load_file(@config_path)
+        end
+      end
+
+      return nil
+    end
+
+  end
 end

data/lib/vagrant-wizard/commands/wizard.rb

@@ -1,8 +1,11 @@
 require 'vagrant'
 require 'tty-prompt'
 
-require 'vagrant-wizard';
-require 'yaml';
+require 'vagrant-wizard'
+require 'vagrant-wizard/loader'
+require 'vagrant-wizard/prompt-parser'
+
+require 'yaml'
 
 module VagrantWizard
   module Commands
@@ -22,110 +25,17 @@ module VagrantWizard
       end
 
       def execute
-        loader = VagrantWizard::Loader.new(@config.config_path)
-        if (loader.data == nil)
-          puts "Wizard config file cannot be found!"
-          return
-        end
-
-        defaultData = Hash.new
-        if (File.exist?(@config.defaults_path))
-          defaultData = YAML.load(File.read(@config.defaults_path))
-        end
-
-        presets = Hash.new
-        presets['(None)'] = {}
-        preset = nil;
-        if (@config.prompt_presets == true && Dir.exist?(@config.presets_dir_path))
-          presetPrompt = TTY::Prompt.new
-          showPresets = presetPrompt.yes?("Select from a preset configuration?")
-          if (showPresets == true)
-            presetFilesYml = Dir["#{@config.presets_dir_path}/*.preset.yml"]
-            presetFilesYaml = Dir["#{@config.presets_dir_path}/*.preset.yaml"]
-            presetFiles = presetFilesYml + presetFilesYaml
-
-            presetFiles.each do |presetFile|
-              presetData = YAML.load(File.read(presetFile))
-              # Skip preset definitions that do not have a meta section
-              if (presetData == false || !presetData.key?('meta'))
-                next
-              end
-              presets[presetData['meta']['name']] = presetData['config']
-            end
-
-            presetChoice = TTY::Prompt.new
-            preset = presetChoice.select('Select a preset', presets)
-          end
-        end
+        promptDisplay = PromptDisplay.new
 
-        outputData = Hash.new
+        promptDisplay.wizard_path = @config.wizard_path
+        promptDisplay.defaults_path = @config.defaults_path
+        promptDisplay.presets_dir_path = @config.presets_dir_path
+        promptDisplay.config_path = @config.config_path
+        promptDisplay.prompt_presets = @config.prompt_presets
+        promptDisplay.prompt_overwrite = @config.prompt_overwrite
+        promptDisplay.advanced = @advanced
 
-        loader.data['prompts'].each do |prompt|
-          presetData = nil
-          if (preset != nil)
-            preset.each do |preset|
-              if (!preset.key?('key') || !preset.key?('value'))
-                next
-              end
-              if (preset['key'] == prompt['key'])
-                presetData = preset['value']
-                break
-              end
-            end
-          end
-
-          output = nil
-          if (presetData != nil)
-            key = prompt['key']
-            output = presetData
-          else
-            parser = PromptParser.new(prompt)
-            parser.advanced = @advanced
-            parser.prompt()
-            key = parser.key
-            output = parser.output
-          end
-          
-          keyParts = key.split('|');
-          keyName = keyParts[-1];
-          currentHash = outputData
-          keyParts[0..-2].each do |keyPart|
-            if !currentHash.key?(keyPart)
-              currentHash[keyPart] = Hash.new
-            end
-            currentHash = currentHash[keyPart]
-          end
-          currentHash[keyName] = output
-        end
-
-        def merge_recursively(a, b)
-          a.merge!(b) do |key, a_item, b_item|
-            if a_item.is_a?(Hash)
-              merge_recursively(a_item, b_item)
-            else
-              b_item
-            end
-          end
-        end
-
-        outputData = merge_recursively(defaultData, outputData)
-
-        outputYaml = outputData.to_yaml
-        canOverwrite = true
-        if File.exist?(@config.output_path)
-          if @config.prompt_overwrite == true
-            confirmation = TTY::Prompt.new
-            canOverwrite = confirmation.yes?("Overwrite your existing configuration?")
-          else
-            canOverwrite = true
-          end
-        end
-        if canOverwrite == true
-          File.open(@config.output_path, "w") do |file|
-            file.write outputYaml
-          end
-        end
-        0
+        promptDisplay.display
       end
     end
   end

data/lib/vagrant-wizard/config.rb

@@ -2,29 +2,29 @@ require 'vagrant'
 
 module VagrantWizard
   class Config < Vagrant.plugin('2', :config)
-    attr_accessor :config_path
+    attr_accessor :wizard_path
     attr_accessor :defaults_path
-    attr_accessor :output_path
+    attr_accessor :config_path
     attr_accessor :prompt_presets
     attr_accessor :presets_dir_path
     attr_accessor :prompt_overwrite
 
     def initialize
-      @config_path      = UNSET_VALUE
+      @wizard_path      = UNSET_VALUE
       @defaults_path    = UNSET_VALUE
-      @output_path      = UNSET_VALUE
+      @config_path      = UNSET_VALUE
       @prompt_presets   = UNSET_VALUE
       @presets_dir_path = UNSET_VALUE
-      @propmt_overwrite = UNSET_VALUE
+      @prompt_overwrite = UNSET_VALUE
     end
 
     def finalize!
-      @config_path      = './vagrant-wizard.yml'         if @config_path      == UNSET_VALUE
-      @defaults_path    = './vagrant-wizard.default.yml' if @defaults_path    == UNSET_VALUE
-      @output_path      = './vagrant-config.yml'         if @output_path      == UNSET_VALUE
-      @prompt_presets   = true                           if @prompt_presets   == UNSET_VALUE
-      @presets_dir_path = './wizard-presets'             if @presets_dir_path == UNSET_VALUE
-      @prompt_overwrite = true                           if @prompt_overwrite == UNSET_VALUE
+      @wizard_path      = './config.wizard.yml'   if @wizard_path      == UNSET_VALUE
+      @defaults_path    = './config.defaults.yml' if @defaults_path    == UNSET_VALUE
+      @config_path      = './config.yml'          if @config_path      == UNSET_VALUE
+      @prompt_presets   = true                    if @prompt_presets   == UNSET_VALUE
+      @presets_dir_path = './wizard-presets'      if @presets_dir_path == UNSET_VALUE
+      @prompt_overwrite = true                    if @prompt_overwrite == UNSET_VALUE
     end
   end
 end

data/lib/vagrant-wizard/inputs/confirm.rb

@@ -1,3 +1,5 @@
+require_relative "input"
+
 require "tty-prompt"
 
 class VagrantWizard::Confirm < VagrantWizard::Input

data/lib/vagrant-wizard/inputs/password.rb

@@ -1,3 +1,5 @@
+require_relative "input"
+
 require "tty-prompt"
 
 class VagrantWizard::Password < VagrantWizard::Input

data/lib/vagrant-wizard/inputs/prompt.rb

@@ -1,3 +1,5 @@
+require_relative "input"
+
 require "tty-prompt"
 
 class VagrantWizard::Prompt < VagrantWizard::Input

data/lib/vagrant-wizard/inputs/select.rb

@@ -1,3 +1,5 @@
+require_relative "input"
+
 require "tty-prompt"
 
 class VagrantWizard::Select < VagrantWizard::Input

data/lib/vagrant-wizard/plugin.rb

@@ -1,6 +1,5 @@
 require 'vagrant'
 require 'vagrant-wizard'
-require 'vagrant-wizard/version'
 
 require 'yaml'
 

data/lib/vagrant-wizard/prompt-display.rb

@@ -0,0 +1,225 @@
+require 'tty-prompt'
+require 'yaml'
+
+require 'vagrant-wizard'
+require 'vagrant-wizard/prompt-parser'
+
+module VagrantWizard
+
+  class PromptDisplay
+    attr_accessor :defaults_path
+    attr_accessor :wizard_path
+    attr_accessor :config_path
+    attr_accessor :prompt_presets
+    attr_accessor :presets_dir_path
+    attr_accessor :prompt_overwrite
+    attr_accessor :advanced
+
+    def initialize
+      @defaults_path = nil
+      @wizard_path = nil
+      @config_path = nil
+      @prompt_presets = true
+      @presets_dir_path = nil
+      @prompt_overwrite = true
+      @advanced = false
+    end
+
+    def display
+      config = load_config_file
+      if config == nil
+        puts "Error: Wizard configuration file does not exist at `#{@wizard_path}`"
+        return
+      end
+      preset = nil
+      if @prompt_presets
+        preset = show_presets_prompt
+      end
+      results = Hash.new
+      config['prompts'].each do |prompt|
+        result = display_prompt(prompt, preset)
+        results = insert_prompt_output(result, results)
+      end
+      defaults = load_default_config
+      if defaults != nil
+        results = merge_recursively(defaults, results)
+      end
+
+      output_results(results)
+    end
+
+    private
+
+    # Loads the wizard configuration file and returns a hash of its data.
+    #
+    # If file does not exist, nil is returned.
+    def load_config_file
+      if File.exist?(@wizard_path)
+        return YAML.load_file(@wizard_path)
+      end
+      return nil
+    end
+
+    # Loads the default configuration file and returns a hash of its data.
+    #
+    # If file does not exist, nil is returned.
+    def load_default_config
+      if (File.exist?(@defaults_path))
+        return YAML.load_file(@defaults_path)
+      end
+      return nil
+    end
+
+    # Displays the presets prompt
+    #
+    # If the specified presets path does not exist, no prompt is shown and nil
+    # is returned.
+    #
+    # If the user declines to select a preset, nil is returned.
+    def show_presets_prompt
+      # Short-circuit if presets path is not specified or does not exist
+      if @presets_dir_path == nil || !Dir.exist?(@presets_dir_path)
+        return nil
+      end
+      
+      # Ask user if they want to select a preset
+      confirmationString = "Select a configuration preset?"
+      confirmationPrompt = TTY::Prompt.new
+
+      if confirmationPrompt.yes?(confirmationString)
+        presets = get_presets(true)
+        presetSelectionString = "Select a preset"
+        presetSelectionPrompt = TTY::Prompt.new
+        return presetSelectionPrompt.select(presetSelectionString, presets)
+      end
+
+      return nil
+    end
+
+    # Gets a hash of available presets.
+    #
+    # Optionally includes a '(None)' option.
+    def get_presets(includeNone = false)
+      presets = Hash.new
+
+      # Add '(None)' entry if requested.
+      if includeNone == true
+        presets['(None)'] = {}
+      end
+
+      # Short-circuit if presets path is not specified or does not exist.
+      if @presets_dir_path == nil || !Dir.exist?(@presets_dir_path)
+        return presets
+      end
+
+      # Get all *.preset.yml and *.preset.yaml files in presets dir
+      presetFilesYml = Dir["#{@presets_dir_path}/*.preset.yml"]
+      presetFilesYaml = Dir["#{@presets_dir_path}/*.preset.yaml"]
+      presetFiles = presetFilesYml + presetFilesYaml
+
+      # Iterate each preset file
+      presetFiles.each do |presetFile|
+        presetData = YAML.load_file(presetFile)
+        # Skip this preset if YAML load failed or if data is missing.
+        if (presetData == false || !presetData.key?('meta'))
+          next
+        end
+        if (!presetData['meta'].key?('name') || !presetData.key?('config'))
+          next
+        end
+        # Add this preset
+        presets[presetData['meta']['name']] = presetData['config']
+      end
+
+      return presets
+    end
+
+    # Displays a single prompt and returns the result.
+    def display_prompt(prompt, preset = nil)
+      presetData = nil
+      if (preset != nil)
+        # Fetch preset data if it exists.
+        preset.each do |preset|
+          if (preset_has_key(preset, prompt['key']))
+            presetData = preset['value']
+            break
+          end
+        end
+      end
+
+      # Return preset data if it exists.
+      if (presetData != nil)
+        return { 'key' => prompt['key'], 'value' => presetData }
+      end
+
+      promptParser = PromptParser.new(prompt)
+      promptParser.advanced = @advanced
+      promptParser.prompt()
+
+      return { 'key' => promptParser.key, 'value' => promptParser.output }
+    end
+
+    # Determines if the given preset has the given key
+    def preset_has_key(preset, key)
+      if (!preset.key?('key'))
+        return false
+      end
+      return preset['key'] == key
+    end
+
+    # Inserts prompt result into a hash of output and returns the result.
+    def insert_prompt_output(new_output, existing_output)
+      key = new_output['key']
+      keyParts = key.split('|')
+      keyName = keyParts[-1]
+      currentHash = existing_output
+
+      keyParts[0..-2].each do |keyPart|
+        # Create new key if it does not exist.
+        if !currentHash.key?(keyPart)
+          currentHash[keyPart] = Hash.new
+        end
+        # Reset current hash
+        currentHash = currentHash[keyPart]
+      end
+      currentHash[keyName] = new_output['value']
+
+      return existing_output
+    end
+
+    # Merges two hashes recursively, with B taking precedence over A.
+    def merge_recursively(a, b)
+      a.merge!(b) do |key, a_item, b_item|
+        if a_item.is_a?(Hash)
+          merge_recursively(a_item, b_item)
+        else
+          b_item
+        end
+      end
+    end
+
+    # Output results
+    def output_results(results)
+      shouldWrite = true
+      if File.exist?(@config_path)
+        if @prompt_overwrite == true
+          confirmation = TTY::Prompt.new
+          confirmationString = 'Overwrite existing configuration file?'
+          shouldWrite = confirmation.yes?(confirmationString)
+        end
+      end
+
+      if shouldWrite == true
+        File.open(@config_path, 'w') do |file|
+          file.write results.to_yaml
+          puts "Output configuration to `#{@config_path}`"
+          return
+        end
+      end
+
+      puts "Output discarded"
+    end
+
+  end
+
+end

data/lib/vagrant-wizard/prompt-parser.rb

@@ -15,7 +15,7 @@ class VagrantWizard::PromptParser
     promptQuestion = @prompt['prompt']
 
     begin
-      require_relative "inputs/#{promptType}"
+      require "vagrant-wizard/inputs/#{promptType}"
     rescue LoadError
       puts "Unable to process input type '#{promptType}'"
       if @prompt.key?('default')

data/lib/vagrant-wizard/version.rb

@@ -1,3 +1,5 @@
+require "yaml"
+
 module VagrantWizard
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-wizard
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Joe D'Amore
@@ -78,6 +78,7 @@ files:
 - lib/vagrant-wizard/inputs/select.rb
 - lib/vagrant-wizard/loader.rb
 - lib/vagrant-wizard/plugin.rb
+- lib/vagrant-wizard/prompt-display.rb
 - lib/vagrant-wizard/prompt-parser.rb
 - lib/vagrant-wizard/version.rb
 - vagrant-wizard.gemspec