vagrant-mountaineer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e0a3a2995954e1ca95e0374cf005e5570f50035c
-  data.tar.gz: 399eb3632ee0f1db04ac1498e82c82dd9d444f9e
+SHA256:
+  metadata.gz: f358b480e0de95b796c8826290bc505fcde1a79009940492561f073077f79cd2
+  data.tar.gz: df09a5ed6049241b926ad1edfe7d34a7aeccb2b4f3585a2577cf0c738baf49bc
 SHA512:
-  metadata.gz: ca0cfcded828c97723a3d3ef7db403e73cf6c12b20894e7ef9e0373103ff2d47baf5b563b802d1dc981bf10b939c8cb877bf169e4ef53d103670eb3bf0b379bf
-  data.tar.gz: bcef4d3585cbf232e480b1efe7d8c353e54ebf924a9d654f8f19278406d2a11b16a49230726e77389ecb6e83bca052e912a4c752b097ff2ec388fa947b711f4c
+  metadata.gz: d703380f4903badc053e240870a84f387b911847ea461d6b1ca9b93e00b235db2c3a3b1455eda2aa54c7238acd24330eb6d641fff6ae25029ffc36276de5b964
+  data.tar.gz: '074038c6a312607a121e66a2cb7ea5746c6632073818db8595429835cd256d7ba968dc0a069a50bb430750e27b18c3ba285258aa4046989dc68b095e6e22d9a3'

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.2.0 (2018-04-22)
+
+- Enhancements
+  - A list of all mountpoints can be printed by using the info subcommand
+  - Projects can be defined as optional
+
 ## v0.1.0 (2017-03-07)
 
 - Initial Release

data/README.md

@@ -42,12 +42,29 @@ project 'test_nfs',
     options: {
       type: :nfs
     }
+
+project 'optional',
+    guestpath: '/data/plugin-optional',
+    hostpath: './may-not-exist',
+    optional: true
 ```
 
 Values for `:guestpath ` and `:hostpath` are required. Additional options
 (like `type`) can be configuring using the `:options` key. The name of the
 project will be used as the mount identifier.
 
+If a project is defined as `optional` it will not be mounted if the host
+path is missing. For the time being this is done silently.
+
+
+### Mountpoint Listing
+
+You can list all known mountpoints in all machines:
+
+```shell
+vagrant mountaineer info
+```
+
 
 ## License
 

data/lib/vagrant/mountaineer.rb

@@ -1,6 +1,6 @@
 require 'vagrant'
 
-I18n.load_path << File.expand_path('../../../locales/en.yml', __FILE__)
+I18n.load_path << File.expand_path('../../locales/en.yml', __dir__)
 I18n.reload!
 
 require 'vagrant/mountaineer/synopsis'
@@ -12,5 +12,6 @@ require 'vagrant/mountaineer/util'
 
 require 'vagrant/mountaineer/action'
 require 'vagrant/mountaineer/action/hook_projects'
+require 'vagrant/mountaineer/command'
 require 'vagrant/mountaineer/config'
 require 'vagrant/mountaineer/plugin'

data/lib/vagrant/mountaineer/action.rb

@@ -1,12 +1,11 @@
 module VagrantPlugins
   module Mountaineer
-    # Vagrant plugin definition
+    # Action hook definition
     module Action
       include Vagrant::Action::Builtin
 
       def self.hook_projects
         Vagrant::Action::Builder.new.tap do |builder|
-          builder.use ConfigValidate
           builder.use HookProjects
         end
       end

data/lib/vagrant/mountaineer/action/hook_projects.rb

@@ -1,7 +1,7 @@
 module VagrantPlugins
   module Mountaineer
     module Action
-      # Vagrant project hook
+      # Project hook to load and mount projectfile contents
       class HookProjects
         PROJECTFILE = VagrantPlugins::Mountaineer::Projectfile
         REGISTRY    = VagrantPlugins::Mountaineer::Registry
@@ -35,6 +35,8 @@ module VagrantPlugins
 
         def mount_projects
           @registry.projects.each do |name, project|
+            next if skip_mount?(project)
+
             @machine.config.vm.synced_folders[name] = project[:options].merge(
               disabled:  false,
               guestpath: project[:guestpath],
@@ -42,6 +44,12 @@ module VagrantPlugins
             )
           end
         end
+
+        def skip_mount?(project)
+          project.key?(:optional) &&
+            project[:optional] == true &&
+            !File.directory?(project[:hostpath])
+        end
       end
     end
   end

data/lib/vagrant/mountaineer/command.rb

@@ -0,0 +1,66 @@
+module VagrantPlugins
+  module Mountaineer
+    # Defines the mountaineer command
+    class Command < Vagrant.plugin(2, :command)
+      HOOK_PROJECTS = VagrantPlugins::Mountaineer::Action::HookProjects
+      UTIL          = VagrantPlugins::Mountaineer::Util
+
+      def self.synopsis
+        'mountaineer utility commands'
+      end
+
+      def execute
+        send(select_command(@argv))
+      end
+
+      private
+
+      def display_help
+        @env.ui.info('Available commands:')
+        @env.ui.info('  - help')
+        @env.ui.info('  - info')
+      end
+
+      def display_info
+        first_vm = true
+
+        with_target_vms do |vm|
+          vm.action_raw(:mountaineer_command, HOOK_PROJECTS)
+
+          vm.env.ui.info("Machine: #{vm.name}")
+          display_machine_mounts(vm)
+
+          vm.env.ui.info('') if first_vm
+
+          first_vm = false
+        end
+      end
+
+      def display_machine_mounts(machine)
+        mounts = get_machine_mounts(machine)
+        pad_to = UTIL.pad_to(mounts)
+
+        mounts.each do |guestpath, hostpath|
+          guestpath = guestpath.ljust(pad_to)
+          hostpath  = Pathname.new(machine.env.root_path) + hostpath
+
+          machine.env.ui.info(" - #{guestpath} (Host: #{hostpath})")
+        end
+      end
+
+      def get_machine_mounts(machine)
+        machine.config.vm.synced_folders.sort.map do |_name, sf|
+          [sf[:guestpath], sf[:hostpath]]
+        end.to_h
+      end
+
+      def select_command(argv)
+        case argv[0]
+        when 'help' then :display_help
+        when 'info' then :display_info
+        else :display_help
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/mountaineer/config.rb

@@ -1,6 +1,6 @@
 module VagrantPlugins
   module Mountaineer
-    # Defines the vagrant configuration
+    # Vagrant configuration definition
     class Config < Vagrant.plugin(2, :config)
       UTIL = VagrantPlugins::Mountaineer::Util
 

data/lib/vagrant/mountaineer/plugin.rb

@@ -5,6 +5,10 @@ module VagrantPlugins
       name 'vagrant-mountaineer'
       description VagrantPlugins::Mountaineer::SYNOPSIS
 
+      command :mountaineer do
+        Command
+      end
+
       config :mountaineer do
         Config
       end

data/lib/vagrant/mountaineer/projectfile.rb

@@ -8,7 +8,7 @@ module VagrantPlugins
       end
 
       def exist?
-        nil != path
+        !path.nil?
       end
 
       def path

data/lib/vagrant/mountaineer/registry.rb

@@ -1,6 +1,6 @@
 module VagrantPlugins
   module Mountaineer
-    # Vagrant project registry
+    # Project registry
     class Registry
       I18N_KEY = 'vagrant_mountaineer.registry'.freeze
 
@@ -25,7 +25,7 @@ module VagrantPlugins
 
       def project(name, config = nil)
         config           = {} unless config.is_a?(Hash)
-        config[:options] = {} unless config.is_a?(Hash)
+        config[:options] = {} unless config[:options].is_a?(Hash)
 
         return config_warning(name) unless valid_config?(config)
 

data/lib/vagrant/mountaineer/util.rb

@@ -11,6 +11,12 @@ module VagrantPlugins
 
         file_path
       end
+
+      def self.pad_to(items)
+        items = items.keys unless items.is_a?(Array)
+
+        items.map(&:length).max
+      end
     end
   end
 end

data/lib/vagrant/mountaineer/version.rb

@@ -1,6 +1,6 @@
 module VagrantPlugins
   # Defines the current plugin version
   module Mountaineer
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-mountaineer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marc Neudert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-07 00:00:00.000000000 Z
+date: 2018-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.34'
+        version: '0.55'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.34'
+        version: '0.55'
 description: Vagrant plugin to mount projects specified in a Projectfile to one of
   your vagrant boxes
 email:
@@ -80,6 +80,7 @@ files:
 - lib/vagrant/mountaineer.rb
 - lib/vagrant/mountaineer/action.rb
 - lib/vagrant/mountaineer/action/hook_projects.rb
+- lib/vagrant/mountaineer/command.rb
 - lib/vagrant/mountaineer/config.rb
 - lib/vagrant/mountaineer/plugin.rb
 - lib/vagrant/mountaineer/projectfile.rb
@@ -109,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Mounts projects from a Projectfile