virtualbox 0.4.1 → 0.4.2

data/lib/virtualbox/image.rb

@@ -16,11 +16,11 @@ module VirtualBox
   # @abstract
   class Image < AbstractModel
     include SubclassListing
-    
+
     attribute :uuid, :readonly => true
     attribute :location
     attribute :accessible, :readonly => true
-    
+
     class <<self
       # Parses the raw output of virtualbox into image objects. Used by
       # subclasses to parse the output of their respective listing functions.
@@ -31,7 +31,7 @@ module VirtualBox
       def parse_raw(raw)
         parse_blocks(raw).collect { |v| new(v) }
       end
-      
+
       # Parses the blocks of the output from virtualbox. VirtualBox outputs
       # image listing in "blocks" which are then parsed down to their attributes.
       #
@@ -41,8 +41,8 @@ module VirtualBox
       def parse_blocks(raw)
         raw.split(/\n\n/).collect { |v| parse_block(v.chomp) }.compact
       end
-      
-      # Parses a single block from VirtualBox output. 
+
+      # Parses a single block from VirtualBox output.
       #
       # **This method typically won't be used except internally.**
       #
@@ -57,14 +57,14 @@ module VirtualBox
           next unless line =~ /^(.+?):\s+(.+?)$/
           hd[$1.downcase.to_sym] = $2.to_s
         end
-        
+
         # If we don't have a location but have a path, use that, as they
         # are equivalent but not consistent.
         hd[:location] = hd[:path] if hd.has_key?(:path)
-        
+
         hd
       end
-      
+
       # Searches the subclasses which implement all method, searching for
       # a matching UUID and returning that as the relationship.
       #
@@ -74,17 +74,17 @@ module VirtualBox
       def populate_relationship(caller, data)
         return DVD.empty_drive if data[:medium] == "emptydrive"
         return nil if data[:uuid].nil?
-        
+
         subclasses.each do |subclass|
           next unless subclass.respond_to?(:all)
-          
+
           matching = subclass.all.find { |obj| obj.uuid == data[:uuid] }
           return matching unless matching.nil?
         end
-        
+
         nil
       end
-      
+
       # Sets an image onto a relationship and/or removes it from a
       # relationship. This method is automatically called by {Relatable}.
       #
@@ -95,29 +95,29 @@ module VirtualBox
         # We don't actually destroy any images using this method,
         # so just return the new value as long as its a valid object
         raise Exceptions::InvalidRelationshipObjectException.new if new_value && !new_value.is_a?(Image)
-        
+
         return new_value
       end
     end
-    
+
     # **This should never be called directly on {Image}.** Instead, initialize
     # one of the subclasses.
     def initialize(info=nil)
       super()
-      
+
       populate_attributes(info) if info
     end
-    
+
     # The image type as a string for the virtualbox command line. This
     # method should be overridden by any subclass and is expected to
-    # return the type which is used in command line parameters for 
+    # return the type which is used in command line parameters for
     # attaching to storage controllers.
     #
     # @return [String]
     def image_type
       raise "This must be implemented by any subclasses"
     end
-    
+
     # Returns boolean showing if empty drive or not. This method should be
     # overriden by any subclass and is expected to return true of false
     # showing if this image represents an empty drive of whatever type
@@ -127,5 +127,12 @@ module VirtualBox
     def empty_drive?
       false
     end
+
+    # Returns the basename of the images location (the file name +extension)
+    #
+    # @return [String]
+    def filename
+      File.basename(location.to_s)
+    end
   end
 end

data/lib/virtualbox/nic.rb

@@ -18,7 +18,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
@@ -39,7 +39,7 @@ module VirtualBox
     attribute :macaddress
     attribute :cableconnected
     attribute :bridgeadapter
-    
+
     class <<self
       # Retrives the Nic data from human-readable vminfo. Since some data about
       # nics is not exposed in the machine-readable virtual machine info, some
@@ -51,16 +51,16 @@ module VirtualBox
       # @return [Hash]
       def nic_data(vmname)
         raw = VM.human_info(vmname)
-        
+
         # Complicated chain of methods just maps parse_nic over each line,
         # removing invalid ones, and then converting it into a single hash.
         raw.split("\n").collect { |v| parse_nic(v) }.compact.inject({}) do |acc, obj|
           acc.merge({ obj[0] => obj[1] })
         end
       end
-      
+
       # Parses nic data out of a single line of the human readable output
-      # of vm info. 
+      # of vm info.
       #
       # **This method typically won't be used except internally.**
       #
@@ -68,18 +68,18 @@ module VirtualBox
       def parse_nic(raw)
         return unless raw =~ /^NIC\s(\d):\s+(.+?)$/
         return if $2.to_s.strip == "disabled"
-        
+
         data = {}
         nicname = "nic#{$1}"
         $2.to_s.split(/,\s+/).each do |raw_property|
           next unless raw_property =~ /^(.+?):\s+(.+?)$/
-          
+
           data[$1.downcase.to_sym] = $2.to_s
         end
-        
+
         return nicname.to_sym, data
       end
-      
+
       # Populates the nic relationship for anything which is related to it.
       #
       # **This method typically won't be used except internally.**
@@ -87,25 +87,25 @@ module VirtualBox
       # @return [Array<Nic>]
       def populate_relationship(caller, data)
         nic_data = nic_data(caller.name)
-        
+
         relation = []
-        
+
         counter = 1
         loop do
           break unless data["nic#{counter}".to_sym]
-          
+
           nictype = nic_data["nic#{counter}".to_sym][:type] rescue nil
-          
+
           nic = new(counter, caller, data.merge({
             "nictype#{counter}".to_sym => nictype
           }))
           relation.push(nic)
           counter += 1
         end
-        
+
         relation
       end
-      
+
       # Saves the relationship. This simply calls {#save} on every
       # member of the relationship.
       #
@@ -117,32 +117,32 @@ module VirtualBox
         end
       end
     end
-    
-    # Since there is currently no way to create a _new_ nic, this is 
+
+    # Since there is currently no way to create a _new_ nic, this is
     # only used internally. Developers should NOT try to initialize their
     # own nic objects.
     def initialize(index, caller, data)
       super()
-      
+
       @index = index
-      
+
       # Setup the index specific attributes
       populate_data = {}
       self.class.attributes.each do |name, options|
         value = data["#{name}#{index}".to_sym]
         populate_data[name] = value
       end
-      
+
       populate_attributes(populate_data.merge({
         :parent => caller
       }))
     end
-    
+
     # Saves a single attribute of the nic. This method is automatically
     # called on {#save}.
     #
     # **This method typically won't be used except internally.**
-    def save_attribute(key, value, vmname)        
+    def save_attribute(key, value, vmname)
       Command.vboxmanage("modifyvm #{Command.shell_escape(vmname)} --#{key}#{@index} #{Command.shell_escape(value)}")
       super
     end

data/lib/virtualbox/proxies/collection.rb

@@ -5,21 +5,21 @@ module VirtualBox
     class Collection < Array
       def initialize(parent)
         super()
-        
+
         @parent = parent
       end
-      
+
       def <<(item)
         item.added_to_relationship(@parent) if item.respond_to?(:added_to_relationship)
         push(item)
       end
-      
+
       def clear
         each do |item|
           delete(item)
         end
       end
-      
+
       def delete(item)
         return unless super
         item.removed_from_relationship(@parent) if item.respond_to?(:removed_from_relationship)

data/lib/virtualbox/shared_folder.rb

@@ -2,7 +2,7 @@ module VirtualBox
   # Represents a shared folder in VirtualBox. In VirtualBox, shared folders are a
   # method for basically "symlinking" a folder on the guest system to a folder which
   # exists on the host system. This allows for sharing of files across the virtual
-  # machine. 
+  # machine.
   #
   # **Note:** Whenever modifying shared folders on a VM, the changes won't take
   # effect until a _cold reboot_ occurs. This means actually closing the virtual
@@ -36,7 +36,7 @@ module VirtualBox
   # a local variable named `vm`.**
   #
   # Nothing tricky here: You treat existing shared folder objects just as if they
-  # were new ones. Assign a new name and/or a new path, then save. 
+  # were new ones. Assign a new name and/or a new path, then save.
   #
   #     folder = vm.shared_folders.first
   #     folder.name = "rufus"
@@ -65,7 +65,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
@@ -88,7 +88,7 @@ module VirtualBox
     attribute :parent, :readonly => :readonly
     attribute :name, :populate_key => "SharedFolderNameMachineMapping"
     attribute :hostpath, :populate_key => "SharedFolderPathMachineMapping"
-    
+
     class <<self
       # Populates the shared folder relationship for anything which is related to it.
       #
@@ -97,19 +97,19 @@ module VirtualBox
       # @return [Array<SharedFolder>]
       def populate_relationship(caller, data)
         relation = Proxies::Collection.new(caller)
-        
+
         counter = 1
         loop do
           break unless data["SharedFolderNameMachineMapping#{counter}".downcase.to_sym]
-          
+
           folder = new(counter, caller, data)
           relation.push(folder)
           counter += 1
         end
-        
+
         relation
       end
-      
+
       # Saves the relationship. This simply calls {#save} on every
       # member of the relationship.
       #
@@ -121,7 +121,7 @@ module VirtualBox
         end
       end
     end
-    
+
     # @overload initialize(data={})
     #   Creates a new SharedFolder which is a new record. This
     #   should be attached to a VM and saved.
@@ -136,7 +136,7 @@ module VirtualBox
     #     to extract the relationship data.
     def initialize(*args)
       super()
-      
+
       if args.length == 3
         initialize_for_relationship(*args)
       elsif args.length == 1
@@ -147,7 +147,7 @@ module VirtualBox
         raise NoMethodError.new
       end
     end
-    
+
     # Initializes the record for use in a relationship. This
     # is automatically called by {#initialize} if it has three
     # parameters.
@@ -161,12 +161,12 @@ module VirtualBox
         value = data["#{key}#{index}".downcase.to_sym]
         populate_data[key] = value
       end
-      
+
       populate_attributes(populate_data.merge({
         :parent => caller
       }))
     end
-    
+
     # Initializes a record with initial data but keeping it a "new
     # record." This is called automatically if {#initialize} is given
     # only a single parameter. View {#initialize} for documentation.
@@ -174,52 +174,52 @@ module VirtualBox
       self.class.attributes.each do |name, options|
         data[options[:populate_key]] = data[name]
       end
-      
+
       populate_attributes(data)
       new_record!
     end
-    
+
     # Validates a shared folder.
     def validate
       super
-      
+
       validates_presence_of :parent
       validates_presence_of :name
       validates_presence_of :hostpath
     end
-    
+
     # Saves or creates a shared folder.
     #
     # @param [Boolean] raise_errors If true, {Exceptions::CommandFailedException}
     #   will be raised if the command failed.
     # @return [Boolean] True if command was successful, false otherwise.
-    def save(raise_errors=false)      
+    def save(raise_errors=false)
       return true unless changed?
-      
+
       if !valid?
         raise Exceptions::ValidationFailedException.new(errors) if raise_errors
         return false
       end
-      
+
       # If this isn't a new record, we destroy it first
       destroy(raise_errors) if !new_record?
-      
+
       Command.vboxmanage("sharedfolder add #{Command.shell_escape(parent.name)} --name #{Command.shell_escape(name)} --hostpath #{Command.shell_escape(hostpath)}")
       existing_record!
       clear_dirty!
-      
+
       true
     rescue Exceptions::CommandFailedException
       raise if raise_errors
       false
     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
-    
+
     # Destroys the shared folder. This doesn't actually delete the folder
     # from the host system. Instead, it simply removes the mapping to the
     # virtual machine, meaning it will no longer be possible to mount it
@@ -232,7 +232,7 @@ module VirtualBox
       # If the name changed, we have to be sure to use the previous
       # one.
       name_value = name_changed? ? name_was : name
-      
+
       Command.vboxmanage("sharedfolder remove #{Command.shell_escape(parent.name)} --name #{Command.shell_escape(name_value)}")
       true
     rescue Exceptions::CommandFailedException

data/lib/virtualbox/storage_controller.rb

@@ -1,7 +1,7 @@
 module VirtualBox
   # Represents a single storage controller which can be attached to a
   # virtual machine.
-  # 
+  #
   # **Currently, storage controllers can not be created from scratch.
   # Therefore, the only way to use this model is through a relationship
   # of a {VM} object.**
@@ -10,7 +10,7 @@ module VirtualBox
   #
   # Properties of the storage controller 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
@@ -46,7 +46,7 @@ module VirtualBox
     attribute :max_ports, :populate_key => :maxportcount
     attribute :ports, :populate_key => :portcount
     relationship :devices, AttachedDevice, :dependent => :destroy
-    
+
     class <<self
       # Populates a relationship with another model.
       #
@@ -55,7 +55,7 @@ module VirtualBox
       # @return [Array<StorageController>]
       def populate_relationship(caller, data)
         relation = []
-        
+
         counter = 0
         loop do
           break unless data["storagecontrollername#{counter}".to_sym]
@@ -63,17 +63,17 @@ module VirtualBox
           relation.push(nic)
           counter += 1
         end
-        
+
         relation
       end
-      
+
       # Destroys a relationship with another model.
       #
       # **This method typically won't be used except internally.**
       def destroy_relationship(caller, data, *args)
         data.each { |v| v.destroy(*args) }
       end
-      
+
       # Saves the relationship. This simply calls {#save} on every
       # member of the relationship.
       #
@@ -84,16 +84,16 @@ module VirtualBox
         end
       end
     end
-    
+
     # Since storage controllers still can't be created from scratch,
     # this method shouldn't be called. Instead, storage controllers
     # can be retrieved through relationships of other models such
     # as {VM}.
     def initialize(index, caller, data)
       super()
-      
+
       @index = index
-      
+
       # Setup the index specific attributes
       populate_data = {}
       self.class.attributes.each do |name, options|
@@ -101,16 +101,16 @@ module VirtualBox
         value = data["storagecontroller#{key}#{index}".to_sym]
         populate_data[key] = value
       end
-      
+
       # Make sure to merge in device data so those relationships will be
       # setup properly
       populate_data.merge!(extract_devices(index, data))
-      
+
       populate_attributes(populate_data.merge({
         :parent => caller
       }))
     end
-    
+
     # Extracts related devices for a storage controller.
     #
     # **This method typically won't be used except internally.**
@@ -118,14 +118,14 @@ module VirtualBox
     # @return [Hash]
     def extract_devices(index, data)
       name = data["storagecontrollername#{index}".downcase.to_sym].downcase
-      
+
       device_data = {}
       data.each do |k,v|
         next unless k.to_s =~ /^#{name}-/
-        
+
         device_data[k] = v
       end
-      
+
       device_data
     end
   end