virtualbox 0.4.1 → 0.4.2

data/lib/virtualbox/dvd.rb

@@ -10,7 +10,7 @@ module VirtualBox
   #     DVD.all
   #
   # # Empty Drives
-  # 
+  #
   # Sometimes it is useful to have an empty drive. This is the case where you
   # may have a DVD drive but it has no disk in it. To create an {AttachedDevice},
   # an image _must_ be specified, and an empty drive is a simple option. Creating
@@ -25,7 +25,7 @@ module VirtualBox
         raw = Command.vboxmanage("list dvds")
         parse_raw(raw)
       end
-      
+
       # Returns an empty drive. This is useful for creating new
       # or modifyingn existing {AttachedDevice} objects and
       # attaching an empty drive to them.
@@ -35,7 +35,7 @@ module VirtualBox
         new(:empty_drive)
       end
     end
-    
+
     def initialize(*args)
       if args.length == 1 && args[0] == :empty_drive
         @empty_drive = true
@@ -43,7 +43,7 @@ module VirtualBox
         super
       end
     end
-    
+
     # Override of {Image#empty_drive?}. This will only be true if
     # the DVD was created with {DVD.empty_drive}.
     #
@@ -51,12 +51,12 @@ module VirtualBox
     def empty_drive?
       @empty_drive || false
     end
-    
+
     # Override of {Image#image_type}.
     def image_type
       "dvddrive"
     end
-    
+
     # Deletes the DVD from VBox managed list and also from disk.
     # This method will fail if the disk is currently mounted to any
     # virtual machine. This method also does nothing for empty drives
@@ -68,7 +68,7 @@ module VirtualBox
     # @return [Boolean] True if command was successful, false otherwise.
     def destroy(raise_errors=false)
       return false if empty_drive?
-      
+
       Command.vboxmanage("closemedium dvd #{uuid} --delete")
       true
     rescue Exceptions::CommandFailedException

data/lib/virtualbox/ext/subclass_listing.rb

@@ -3,7 +3,7 @@ module VirtualBox::SubclassListing
   def self.included(base)
     base.extend ClassMethods
   end
-  
+
   module ClassMethods
     def subclasses(direct = false)
       classes = []

data/lib/virtualbox/extra_data.rb

@@ -7,7 +7,7 @@ module VirtualBox
   #
   # # Extra Data on a Virtual Machine
   #
-  # Setting extra data on a virtual machine is easy. All {VM} objects have a 
+  # Setting extra data on a virtual machine is easy. All {VM} objects have a
   # `extra_data` relationship which is just a simple ruby hash, so you can treat
   # it like one! Once the data is set, simply saving the VM will save the
   # extra data. An example below:
@@ -33,11 +33,11 @@ module VirtualBox
   #
   class ExtraData < Hash
     include AbstractModel::Dirty
-    
+
     attr_accessor :parent
-    
+
     @@global_data = nil
-    
+
     class <<self
       # Gets the global extra data. This will "cache" the data for
       # future use unless you set the `reload` paramter to true.
@@ -49,10 +49,10 @@ module VirtualBox
           raw = Command.vboxmanage("getextradata global enumerate")
           @@global_data = parse_kv_pairs(raw)
         end
-        
+
         @@global_data
       end
-      
+
       # Parses the key-value pairs from the extra data enumerated
       # output.
       #
@@ -64,11 +64,11 @@ module VirtualBox
           next unless line =~ /^Key: (.+?), Value: (.+?)$/i
           data[$1.to_s] = $2.strip.to_s
         end
-        
+
         data.clear_dirty!
         data
       end
-      
+
       # Populates a relationship with another model.
       #
       # **This method typically won't be used except internally.**
@@ -78,7 +78,7 @@ module VirtualBox
         raw = Command.vboxmanage("getextradata #{Command.shell_escape(caller.name)} enumerate")
         parse_kv_pairs(raw, caller)
       end
-      
+
       # Saves the relationship. This simply calls {#save} on every
       # member of the relationship.
       #
@@ -87,21 +87,21 @@ module VirtualBox
         data.save
       end
     end
-    
-    # Initializes an extra data object. 
+
+    # Initializes an extra data object.
     #
     # @param [Hash] data Initial attributes to populate.
     def initialize(parent=nil)
       @parent = parent || "global"
     end
-    
+
     # Set an extradata key-value pair. Overrides ruby hash implementation
     # to set dirty state. Otherwise that, behaves the same way.
     def []=(key,value)
       set_dirty!(key, self[key], value)
       super
     end
-    
+
     # Special accessor for parent name attribute. This returns
     # either the parent name if its a VM object, otherwise
     # just returns the default.
@@ -114,7 +114,7 @@ module VirtualBox
         parent
       end
     end
-    
+
     # Saves extra data. This method does the same thing for both new
     # and existing extra data, since virtualbox will overwrite old data or
     # create it if it doesn't exist.
@@ -127,14 +127,14 @@ module VirtualBox
         Command.vboxmanage("setextradata #{Command.shell_escape(parent_name)} #{Command.shell_escape(key)} #{Command.shell_escape(value[1])}")
         clear_dirty!(key)
       end
-      
+
       true
     rescue Exceptions::CommandFailedException
       raise if raise_errors
       false
     end
-    
-    # Deletes the extra data. 
+
+    # Deletes the extra data.
     #
     # @param [Boolean] raise_errors If true, {Exceptions::CommandFailedException}
     #   will be raised if the command failed.

data/lib/virtualbox/forwarded_port.rb

@@ -3,7 +3,7 @@ module VirtualBox
   # own private router for all virtual machines. Because of this,
   # the host machine can't access services within the guest machine.
   # To get around this, NAT supports port forwarding, which allows the
-  # guest machine services to be forwarded to some port on the host 
+  # guest machine services to be forwarded to some port on the host
   # machine. Port forwarding is done completely through {ExtraData}, but
   # is a complicated enough procedure that this class was made to
   # faciliate it.
@@ -43,7 +43,7 @@ module VirtualBox
   #
   # Properties of the model are exposed using standard ruby instance
   # methods which are generated on the fly. Because of this, they are not listed
-  # below as available instance methods. 
+  # below as available instance methods.
   #
   # These attributes can be accessed and modified via standard ruby-style
   # `instance.attribute` and `instance.attribute=` methods. The attributes are
@@ -74,7 +74,7 @@ module VirtualBox
     attribute :protocol, :default => "TCP"
     attribute :guestport
     attribute :hostport
-    
+
     class <<self
       # Populates a relationship with another model.
       #
@@ -83,10 +83,10 @@ module VirtualBox
       # @return [Array<ForwardedPort>]
       def populate_relationship(caller, data)
         relation = Proxies::Collection.new(caller)
-        
+
         caller.extra_data.each do |key, value|
           next unless key =~ /^(VBoxInternal\/Devices\/(.+?)\/(.+?)\/LUN#0\/Config\/(.+?)\/)Protocol$/i
-          
+
           port = new({
             :parent => caller,
             :name => $4.to_s,
@@ -96,15 +96,15 @@ module VirtualBox
             :guestport => caller.extra_data["#{$1.to_s}GuestPort"],
             :hostport => caller.extra_data["#{$1.to_s}HostPort"]
           })
-          
+
           port.existing_record!
-          
+
           relation.push(port)
         end
-        
+
         relation
       end
-      
+
       # Saves the relationship. This simply calls {#save} on every
       # member of the relationship.
       #
@@ -115,23 +115,23 @@ module VirtualBox
         end
       end
     end
-    
+
     # @param [Hash] data The initial attributes to populate.
     def initialize(data={})
       super()
       populate_attributes(data)
     end
-    
+
     # Validates a forwarded port.
     def validate
       super
-      
+
       validates_presence_of :parent
       validates_presence_of :name
       validates_presence_of :guestport
       validates_presence_of :hostport
     end
-    
+
     # Saves the forwarded port.
     #
     # @param [Boolean] raise_errors If true, {Exceptions::CommandFailedException}
@@ -139,25 +139,25 @@ module VirtualBox
     # @return [Boolean] True if command was successful, false otherwise.
     def save(raise_errors=false)
       return true if !new_record? && !changed?
-      
+
       if !valid?
         raise Exceptions::ValidationFailedException.new(errors) if raise_errors
         return false
       end
-      
+
       destroy(raise_errors) if name_changed?
-      
+
       parent.extra_data["#{key_prefix}Protocol"] = protocol
       parent.extra_data["#{key_prefix}GuestPort"] = guestport
       parent.extra_data["#{key_prefix}HostPort"] = hostport
       result = parent.extra_data.save(raise_errors)
-      
+
       clear_dirty!
       existing_record!
-      
+
       result
     end
-    
+
     # Destroys the port forwarding mapping.
     #
     # @param [Boolean] raise_errors If true, {Exceptions::CommandFailedException}
@@ -170,19 +170,19 @@ module VirtualBox
         results << parent.extra_data.delete("#{key_prefix(true)}Protocol", raise_errors)
         results << parent.extra_data.delete("#{key_prefix(true)}GuestPort", raise_errors)
         results << parent.extra_data.delete("#{key_prefix(true)}HostPort", raise_errors)
-        
+
         new_record!
       end
-      
+
       results.empty? || results.all? { |o| o == true }
     end
-    
+
     # Relationship callback when added to a collection. This is automatically
     # called by any relationship collection when this object is added.
     def added_to_relationship(parent)
       write_attribute(:parent, parent)
     end
-    
+
     # Returns the prefix to be used for the extra data key. Forwarded ports
     # are created by simply setting {ExtraData} on a {VM}. This class hides most
     # of the inner workings of it, but it requires a common prefix. This method

data/lib/virtualbox/hard_drive.rb

@@ -7,7 +7,7 @@ module VirtualBox
   # find all or a specific hard drive, respectively. Example below:
   #
   #     VirtualBox::HardDrive.all
-  # 
+  #
   # Or:
   #
   #     VirtualBox::HardDrive.find("Foo.vdi")
@@ -49,9 +49,9 @@ module VirtualBox
   # # Cloning Hard Drives
   #
   # Hard drives can just as easily be cloned as they can be created or destroyed.
-  # 
+  #
   #     hd = VirtualBox::HardDrive.find("foo")
-  #     cloned_hd = hd.clone("bar") 
+  #     cloned_hd = hd.clone("bar")
   #
   # In addition to simply cloning hard drives, this command can be used to
   # clone to a different format:
@@ -63,13 +63,13 @@ module VirtualBox
   #
   # Properties of the model are exposed using standard ruby instance
   # methods which are generated on the fly. Because of this, they are not listed
-  # below as available instance methods. 
+  # below as available instance methods.
   #
   # These attributes can be accessed and modified via standard ruby-style
   # `instance.attribute` and `instance.attribute=` methods. The attributes are
   # listed below. If you aren't sure what this means or you can't understand
   # why the below is listed, please read {Attributable}.
-  # 
+  #
   #     attribute :uuid, :readonly => true
   #     attribute :location
   #     attribute :accessible, :readonly => true
@@ -79,7 +79,7 @@ module VirtualBox
   class HardDrive < Image
     attribute :format, :default => "VDI"
     attribute :size
-    
+
     class <<self
       # Returns an array of all available hard drives as HardDrive
       # objects.
@@ -89,30 +89,30 @@ module VirtualBox
         raw = Command.vboxmanage("list hdds")
         parse_blocks(raw).collect { |v| find(v[:uuid]) }
       end
-      
+
       # Finds one specific hard drive by UUID or file name. If the
       # hard drive can not be found, will return `nil`.
       #
       # @return [HardDrive]
       def find(id)
         raw = Command.vboxmanage("showhdinfo #{id}")
-        
+
         # Return nil if the hard drive doesn't exist
         return nil if raw =~ /VERR_FILE_NOT_FOUND/
-        
+
         data = raw.split(/\n\n/).collect { |v| parse_block(v) }.find { |v| !v.nil? }
-        
+
         # Set equivalent fields
         data[:format] = data[:"storage format"]
         data[:size] = data[:"logical size"].split(/\s+/)[0] if data.has_key?(:"logical size")
-        
+
         # Return new object
         new(data)
       end
     end
-    
+
     # Clone hard drive, possibly also converting formats. All formats
-    # supported by your local VirtualBox installation are supported 
+    # supported by your local VirtualBox installation are supported
     # here. If no format is specified, the format of the source drive
     # will be used.
     #
@@ -126,27 +126,27 @@ module VirtualBox
     def clone(outputfile, format="VDI", raise_errors=false)
       raw = Command.vboxmanage("clonehd #{uuid} #{Command.shell_escape(outputfile)} --format #{format} --remember")
       return nil unless raw =~ /UUID: (.+?)$/
-      
+
       self.class.find($1.to_s)
     rescue Exceptions::CommandFailedException
       raise if raise_errors
       nil
     end
-    
+
     # Override of {Image#image_type}.
     def image_type
       "hdd"
     end
-    
+
     # Validates a hard drive.
     def validate
       super
-      
+
       validates_presence_of :format
       validates_presence_of :size
     end
-    
-    # Creates a new hard drive. 
+
+    # Creates a new hard drive.
     #
     # **This method should NEVER be called. Call {#save} instead.**
     #
@@ -158,25 +158,25 @@ module VirtualBox
         raise Exceptions::ValidationFailedException.new(errors) if raise_errors
         return false
       end
-      
+
       raw = Command.vboxmanage("createhd --filename #{location} --size #{size} --format #{read_attribute(:format)} --remember")
       return nil unless raw =~ /UUID: (.+?)$/
-      
+
       # Just replace our attributes with the newly created ones. This also
       # will set new_record to false.
       populate_attributes(self.class.find($1.to_s).attributes)
-      
+
       # Return the success of the command
       true
     rescue Exceptions::CommandFailedException
       raise if raise_errors
       false
     end
-    
+
     # Saves the hard drive object. If the hard drive is new,
     # this will create a new hard drive. Otherwise, it will
     # save any other details about the existing hard drive.
-    # 
+    #
     # Currently, **saving existing hard drives does nothing**.
     # This is a limitation of VirtualBox, rather than the library itself.
     #
@@ -191,10 +191,10 @@ module VirtualBox
         super
       end
     end
-    
+
     # Destroys the hard drive. This deletes the hard drive off
-    # of disk. 
-    # 
+    # of disk.
+    #
     # **This operation is not reversable.**
     #
     # @param [Boolean] raise_errors If true, {Exceptions::CommandFailedException}