vagrant-vbguest 0.6.0.pre6 → 0.6.0

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 0.6.0 (unreleased)
+## 0.6.0 (2012-01-13)
 
  - Debian installer now cope with missing `dkms` package [GH-30]
  - Fixed some issues when runnig on just creating boxes [GH-31]
@@ -7,7 +7,8 @@
  - Installers no longer are shell scripts, but ruby classes
  - Users may pass in their own installer classes
    (yes! plugins in plugins)
- - New `sprintf` style `%{version}` placeholder for iso download path
+ - New `sprintf` style `%{version}` placeholder for iso download path.
+   (old `$VBOX_VERSION` placeholder still working)
  - Revisited command arguments to not just mirror config values:
    - New `--do` argument: force-run one of those commands:
      * `start`   : Try to start the GuestAdditions Service

data/lib/vagrant-vbguest/installer.rb

@@ -1,7 +1,8 @@
 module VagrantVbguest
 
-  # Handles the guest addins installation process
-
+  ##
+  # Dispatches the installation process to a rigistered
+  # Installer implementation.
   class Installer
 
     class NoInstallerFoundError < Vagrant::Errors::VagrantError
@@ -86,19 +87,19 @@ module VagrantVbguest
 
     def guest_version(reload=false)
       installer = guest_installer
-      raise NoInstallerFoundError, :method => 'check installation of' if !installer
+      raise NoInstallerFoundError, :method => 'check guest version of' if !installer
       installer.guest_version(reload)
     end
 
     def host_version
       installer = guest_installer
-      raise NoInstallerFoundError, :method => 'check installation of' if !installer
+      raise NoInstallerFoundError, :method => 'check host version of' if !installer
       installer.host_version
     end
 
     def running?
       installer = guest_installer
-      raise NoInstallerFoundError, :method => 'check installation of' if !installer
+      raise NoInstallerFoundError, :method => 'check current state of' if !installer
       installer.running?
     end
 
@@ -108,7 +109,6 @@ module VagrantVbguest
     #
     # @return [Installers::Base]
     def guest_installer
-
       @guest_installer ||= if @options[:installer].is_a? Class
         @options[:installer].new(@vm)
       else

data/lib/vagrant-vbguest/installers/base.rb

@@ -129,6 +129,9 @@ module VagrantVbguest
         vm.driver.version
       end
 
+      # Determinates the version of the GuestAdditions installer in use
+      #
+      # @return [String] The version code of the GuestAdditions installer
       def installer_version(path_to_installer)
         version = nil
         @vm.channel.sudo("#{path_to_installer} --info", :error_check => false) do |type, data|
@@ -139,18 +142,39 @@ module VagrantVbguest
         version
       end
 
+      # Helper to yield a warning message to the user, that the installation
+      # will start _now_.
+      # The message includes the host and installer version strings.
       def yield_installation_waring(path_to_installer)
         @vm.ui.warn I18n.t("vagrant.plugins.vbguest.installing#{@options[:force] ? '_forced' : ''}",
           :guest_version => guest_version,
-          :installer_version => installer_version(path_to_installer) || "unknown")
+          :installer_version => installer_version(path_to_installer) || I18n.t("vagrant.plugins.vbguest.unknown"))
       end
 
+      # Helper to yield a warning message to the user, that the installation
+      # will be rebuild using the installed GuestAdditions.
+      # The message includes the host and installer version strings.
       def yield_rebuild_warning
         @vm.ui.warn I18n.t("vagrant.plugins.vbguest.rebuild#{@options[:force] ? '_forced' : ''}",
           :guest_version => guest_version(true),
           :host_version => host_version)
       end
 
+      # GuestAdditions-iso-file-detection-magig.
+      #
+      # Detectio runs in those stages:
+      # 1. Uses the +iso_path+ config option, if present and not set to +:auto+
+      # 2. Look out for a local iso file
+      # 3. Use the default web URI
+      #
+      # If the detected or configured path is not a local file and remote downloads
+      # are allowed (the config option +:no_remote+ is NOT set) it will try to
+      # download that file into a temp file using Vagrants Downloaders.
+      # If remote downloads are prohibited (the config option +:no_remote+ IS set)
+      # a +VagrantVbguest::IsoPathAutodetectionError+ will be thrown
+      #
+      # @return [String] A absolute path to the GuestAdditions iso file.
+      #                  This might be a temp-file, e.g. when downloaded from web.
       def iso_file
         @iso_file ||= begin
           iso_path = options[:iso_path]
@@ -179,18 +203,35 @@ module VagrantVbguest
         end
       end
 
+      # Default web URI, where GuestAdditions iso file can be downloaded.
+      #
+      # @return [String] A URI template containing the versions placeholder.
       def web_iso_path
         "http://download.virtualbox.org/virtualbox/%{version}/VBoxGuestAdditions_%{version}.iso"
       end
 
+      # Finds GuestAdditions iso file on the host system.
+      # Returns +nil+ if none found.
+      #
+      # @return [String] Absolute path to the local GuestAdditions iso file, or +nil+ if not found.
       def local_iso_path
         media_manager_iso || guess_iso
       end
 
+      # Helper method which queries the VirtualBox media manager
+      # for a +VBoxGuestAdditions.iso+ file.
+      # Returns +nil+ if none found.
+      #
+      # @return [String] Absolute path to the local GuestAdditions iso file, or +nil+ if not found.
       def media_manager_iso
         (m = vm.driver.execute('list', 'dvds').match(/^.+:\s+(.*VBoxGuestAdditions.iso)$/i)) && m[1]
       end
 
+      # Makes an educated guess where the GuestAdditions iso file
+      # could be found on the host system depending on the OS.
+      # Returns +nil+ if no the file is not in it's place.
+      #
+      # @return [String] Absolute path to the local GuestAdditions iso file, or +nil+ if not found.
       def guess_iso
         path_platform = if Vagrant::Util::Platform.linux?
           "/usr/share/virtualbox/VBoxGuestAdditions.iso"
@@ -207,13 +248,20 @@ module VagrantVbguest
       end
 
       # A helper method to handle the GuestAdditions iso file upload
+      # into the guest box.
+      # The file will uploaded to the location given by the +tmp_path+ method.
+      #
+      # @example Default upload
+      #    upload(iso_file)
+      #
+      # @param [String] Path of the file to upload to the +tmp_path*
       def upload(file)
         vm.ui.info(I18n.t("vagrant.plugins.vbguest.start_copy_iso", :from => file, :to => tmp_path))
         vm.channel.upload(file, tmp_path)
       end
 
       # A helper method to delete the uploaded GuestAdditions iso file
-      # from the guest
+      # from the guest box
       def cleanup
         @download.cleanup if @download
         vm.channel.execute("test -f #{tmp_path} && rm #{tmp_path}", :error_check => false) do |type, data|

data/lib/vagrant-vbguest/installers/debian.rb

@@ -15,15 +15,7 @@ module VagrantVbguest
           vm.channel.sudo('apt-get update', opts, &block)
           vm.channel.sudo(install_dependencies_cmd, opts, &block)
         end
-        upload(iso_file)
-        vm.channel.sudo("mount #{tmp_path} -o loop #{mount_point}", opts, &block)
-
-        installer = File.join(mount_point, 'VBoxLinuxAdditions.run')
-        yield_installation_waring(installer)
-
-        vm.channel.sudo("#{installer} --nox11", opts, &block)
-
-        vm.channel.sudo("umount #{mount_point}", opts, &block)
+        super
       end
 
     protected

data/lib/vagrant-vbguest/installers/linux.rb

@@ -39,12 +39,12 @@ module VagrantVbguest
 
       # a generic way of installing GuestAdditions assuming all
       # dependencies on the guest are installed
-      def install(iso_file = nil, opts=nil, &block)
-        vm.ui.warn I18n.t("vagrant.plugins.vbguest.installer.generic_linux_installer")
+      def install(opts=nil, &block)
+        vm.ui.warn I18n.t("vagrant.plugins.vbguest.installer.generic_linux_installer") if self.class == Linux
         upload(iso_file)
-        vm.channel.sudo("mount #{tmp_path} -o loop #{mount_point}", opts, &block)
-        vm.channel.sudo("#{mount_point}/VBoxLinuxAdditions.run --nox11", opts, &block)
-        vm.channel.sudo("umount #{mount_point}", opts, &block)
+        mount_iso
+        execute_installer
+        unmount_iso
       end
 
       def running?(opts=nil, &block)
@@ -69,7 +69,6 @@ module VagrantVbguest
         @guest_version
       end
 
-
       def rebuild(opts=nil, &block)
         vm.channel.sudo('/etc/init.d/vboxadd setup', opts, &block)
       end
@@ -79,6 +78,29 @@ module VagrantVbguest
         vm.channel.sudo('/etc/init.d/vboxadd start', opts, &block)
       end
 
+
+      # A generic helper method to execute the installer. The iso file
+      # has to be mounted on +mount_point+.
+      # This also yields a installation warning to the user.
+      def execute_installer(opts=nil, &block)
+        installer = File.join(mount_point, 'VBoxLinuxAdditions.run')
+        yield_installation_waring(installer)
+        vm.channel.sudo("#{installer} --nox11", opts, &block)
+      end
+
+      # A generic helper method for mounting the GuestAdditions iso file
+      # on most linux system.
+      # Mounts the given uploaded file from +tmp_path+ on +mount_point+.
+      def mount_iso(opts=nil, &block)
+        vm.channel.sudo("mount #{tmp_path} -o loop #{mount_point}", opts, &block)
+      end
+
+      # A generic helper method for un-mounting the GuestAdditions iso file
+      # on most linux system
+      # Unmounts the +mount_point+.
+      def unmount_iso(opts=nil, &block)
+        vm.channel.sudo("umount #{mount_point}", opts, &block)
+      end
     end
   end
 end

data/lib/vagrant-vbguest/version.rb

@@ -1,3 +1,3 @@
 module VagrantVbguest
-  VERSION = "0.6.0.pre6"
+  VERSION = "0.6.0"
 end

data/locales/en.yml

@@ -18,6 +18,7 @@ en:
           Virtualbox on your host claims:   %{driver}
           VBoxService inside the vm claims: %{service}
           Going on, assuming VBoxService is correct...
+        unknown: unknown
 
         status:
           clean: "No installation found."

metadata

@@ -1,98 +1,88 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: vagrant-vbguest
-version: !ruby/object:Gem::Version 
-  hash: -4156320040
-  prerelease: 6
-  segments: 
-  - 0
-  - 6
-  - 0
-  - pre
-  - 6
-  version: 0.6.0.pre6
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Robert Schulze
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-01-07 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: micromachine
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 0
-        - 4
+      - !ruby/object:Gem::Version
         version: 1.0.4
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: i18n
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 6
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.6.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: log4r
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 1
-        - 9
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 1.1.9
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 2
-        - 0
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.2.0
   type: :development
-  version_requirements: *id004
-description: A Vagrant plugin which automatically installs the host's VirtualBox Guest Additions on the guest system.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: A Vagrant plugin which automatically installs the host's VirtualBox Guest
+  Additions on the guest system.
+email:
 - robert@dotless.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
@@ -118,39 +108,28 @@ files:
 - locales/en.yml
 - vagrant-vbguest.gemspec
 homepage: https://github.com/dotless-de/vagrant-vbguest
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Vagrant plugin to install the VirtualBoxAdditions into the guest VM
 test_files: []
-