virtualbox 0.6.0 → 0.6.1

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.6.1

data/lib/virtualbox.rb

@@ -3,7 +3,7 @@ libdir = File.join(File.dirname(__FILE__), "virtualbox")
 require File.expand_path("ext/glob_loader", libdir)
 
 # Load them up
-VirtualBox::GlobLoader.glob_require(libdir, %w{ext/logger ext/platform ext/subclass_listing com abstract_model medium})
+VirtualBox::GlobLoader.glob_require(libdir, %w{ext/logger ext/platform ext/subclass_listing ext/byte_normalizer com abstract_model medium})
 
 # Setup the top-level module methods
 module VirtualBox

data/lib/virtualbox/abstract_model/attributable.rb

@@ -137,7 +137,8 @@ module VirtualBox
         #   a custom populate key to use for {Attributable#populate_attributes}
         def attribute(name, options = {})
           name = name.to_sym
-          attributes[name] = options
+          attributes[name] = @__attribute_scope || {}
+          attributes[name].merge!(options)
 
           # Create the method for reading this attribute
           define_method(name) { read_attribute(name) }
@@ -153,6 +154,19 @@ module VirtualBox
           end
         end
 
+        # Defines the specified scope for all attributes within the block.
+        # The scope is reset to the previous value once the block ends. Multiple
+        # scopes can be nested and they'll inherit from each other.
+        def attribute_scope(options, &block)
+          @__attribute_scope ||= {}
+          old_value = @__attribute_scope
+          @__attribute_scope = old_value.merge(options)
+
+          instance_eval(&block)
+
+          @__attribute_scope = old_value
+        end
+
         # Returns the hash of attributes and their associated options.
         def attributes
           @attributes ||= {}

data/lib/virtualbox/abstract_model/interface_attributes.rb

@@ -28,7 +28,7 @@ module VirtualBox
 
         # Convert the getter to a proc and call it
         getter = spec_to_proc(getter)
-        write_attribute(key, getter.call(interface))
+        write_attribute(key, getter.call(self, interface, key))
       end
 
       # Saves all the attributes which have an interface setter.
@@ -55,7 +55,7 @@ module VirtualBox
 
         # Convert the setter to a proc and call it
         setter = spec_to_proc(setter)
-        setter.call(interface, read_attribute(key))
+        setter.call(self, interface, key, read_attribute(key))
       end
 
       # Converts a getter/setter specification to a Proc which can be called
@@ -88,7 +88,7 @@ module VirtualBox
         if spec.is_a?(Symbol)
           # For symbols, wrap up a method send in a Proc and return
           # that
-          return Proc.new { |m, *args| m.send(spec, *args) }
+          return Proc.new { |this, m, key, *args| m.send(spec, *args) }
         end
       end
     end

data/lib/virtualbox/com/implementer/base.rb

@@ -4,6 +4,13 @@ module VirtualBox
       class Base < AbstractImplementer
         include Logger
 
+        # Returns the Ruby version as a float
+        #
+        # @return [Float]
+        def ruby_version
+          RUBY_VERSION.to_f
+        end
+
         # Finds and returns the `COM::Interface` class associated with the type.
         # If the class does not exist, a `NameError` will be raised.
         #

data/lib/virtualbox/com/implementer/mscom.rb

@@ -19,7 +19,12 @@ module VirtualBox
         # Reads a property from the interface with the given name.
         def read_property(name, opts)
           # First get the basic value from the COM object
-          value = @object[COM::FFI::Util.camelize(name.to_s)]
+          method = COM::FFI::Util.camelize(name.to_s)
+          value = if ruby_version >= 1.9
+            @object.send(method)
+          else
+            @object[method]
+          end
 
           # Then depending on the value type, we either return as-is or
           # must wrap it up in another interface class
@@ -30,7 +35,14 @@ module VirtualBox
         # value.
         def write_property(name, value, opts)
           # Set the property with a prepared value
-          @object[COM::FFI::Util.camelize(name.to_s)] = spec_to_args([opts[:value_type]], [value]).first
+          method = COM::FFI::Util.camelize(name.to_s)
+          value = spec_to_args([opts[:value_type]], [value]).first
+
+          if ruby_version >= 1.9
+            @object.send("#{method}=", value)
+          else
+            @object[method] = value
+          end
         end
 
         # Calls a function from the interface with the given name

data/lib/virtualbox/com/interface/progress.rb

@@ -41,15 +41,15 @@ module VirtualBox
           last_reported = -100
 
           while true
-            break if completed || canceled
-
             delta = percent - last_reported
             last_reported += delta
-            yield last_reported if delta >= interval_percent
+            yield self if delta >= interval_percent
 
             # This either sleeps for half a second or returns on
             # completion
             wait_for_completion(500)
+
+            break if completed || canceled
           end
         end
       end

data/lib/virtualbox/exceptions.rb

@@ -4,9 +4,6 @@ module VirtualBox
   module Exceptions
     class Exception < ::Exception; end
 
-    class CommandFailedException < Exception; end
-    class ConfigurationException < Exception; end
-    class InvalidRelationshipObjectException < Exception; end
     class NonSettableRelationshipException < Exception; end
     class ValidationFailedException < Exception; end
 

data/lib/virtualbox/ext/byte_normalizer.rb

@@ -0,0 +1,17 @@
+module VirtualBox::ByteNormalizer
+  # So that this is only defined once (suppress warnings)
+  if !defined?(THOUSAND)
+    THOUSAND = 1024.0
+    BYTE = 1.0
+    KILOBYTE = BYTE * THOUSAND
+    MEGABYTE = KILOBYTE * THOUSAND
+  end
+
+  def bytes_to_megabytes(b)
+    b / MEGABYTE
+  end
+
+  def megabytes_to_bytes(mb)
+    mb * MEGABYTE
+  end
+end

data/lib/virtualbox/hard_drive.rb

@@ -77,6 +77,8 @@ module VirtualBox
   # There are more attributes on the {Medium} model, which {HardDrive} inherits
   # from.
   class HardDrive < Medium
+    include ByteNormalizer
+
     attribute :format, :default => "VDI", :property => :format
     attribute :logical_size, :property => :logical_size
     attribute :physical_size, :readonly => true, :property => :size
@@ -105,6 +107,11 @@ module VirtualBox
       end
     end
 
+    # Custom getter to convert the physical size from bytes to megabytes.
+    def physical_size
+      bytes_to_megabytes(read_attribute(:physical_size))
+    end
+
     # Clone hard drive, possibly also converting formats. All formats
     # supported by your local VirtualBox installation are supported
     # here. If no format is specified, the format of the source drive

data/lib/virtualbox/hw_virtualization.rb

@@ -0,0 +1,57 @@
+module VirtualBox
+  # Represents the HW virtualization properties on a VM.
+  class HWVirtualization < AbstractModel
+    attribute :parent, :readonly => true, :property => false
+    attribute_scope(:property_getter => Proc.new { |instance, *args| instance.get_property(*args) },
+                    :property_setter => Proc.new { |instance, *args| instance.set_property(*args) }) do
+      attribute :enabled
+      attribute :exclusive
+      attribute :vpid
+      attribute :nested_paging
+    end
+
+    class <<self
+      # Populates a relationship with another model.
+      #
+      # **This method typically won't be used except internally.**
+      #
+      # @return [HWVirtualization]
+      def populate_relationship(caller, imachine)
+        data = new(caller, imachine)
+      end
+
+      # Saves the relationship.
+      #
+      # **This method typically won't be used except internally.**
+      def save_relationship(caller, instance)
+        instance.save
+      end
+    end
+
+    def initialize(parent, imachine)
+      write_attribute(:parent, parent)
+
+      # Load the attributes and mark the whole thing as existing
+      load_interface_attributes(imachine)
+      clear_dirty!
+      existing_record!
+    end
+
+    def get_property(interface, key)
+      interface.get_hw_virt_ex_property(key)
+    end
+
+    def set_property(interface, key, value)
+      interface.set_hw_virt_ex_property(key, value)
+    end
+
+    def save
+      parent.with_open_session do |session|
+        machine = session.machine
+
+        # Save them
+        save_changed_interface_attributes(machine)
+      end
+    end
+  end
+end

data/lib/virtualbox/vm.rb

@@ -121,6 +121,7 @@ module VirtualBox
     attribute :interface, :readonly => true, :property => false
     relationship :audio_adapter, :AudioAdapter
     relationship :bios, :BIOS
+    relationship :hw_virt, :HWVirtualization
     relationship :storage_controllers, :StorageController, :dependent => :destroy
     relationship :medium_attachments, :MediumAttachment
     relationship :shared_folders, :SharedFolder

data/test/virtualbox/abstract_model/attributable_test.rb

@@ -27,6 +27,40 @@ class AttributableTest < Test::Unit::TestCase
     end
   end
 
+  context "attribute scopes" do
+    class AttributeScopeA < EmptyAttributeModel
+      attribute :foo
+      attribute_scope(:bar => 7) do
+        attribute :foo2
+
+        attribute_scope(:baz => 3) do
+          attribute :bazzed
+        end
+      end
+
+      attribute :foo3, :bar => 10
+    end
+
+    setup do
+      @klass = AttributeScopeA
+    end
+
+    should "use attribute scope" do
+      assert_equal 7, @klass.attributes[:foo2][:bar]
+    end
+
+    should "not use attribute scope outside of the block" do
+      assert !@klass.attributes[:foo].has_key?(:bar)
+      assert_equal 10, @klass.attributes[:foo3][:bar]
+    end
+
+    should "properly nest" do
+      bazzed = @klass.attributes[:bazzed]
+      assert_equal 3, bazzed[:baz]
+      assert_equal 7, bazzed[:bar]
+    end
+  end
+
   context "attribute options" do
     context "custom populate keys" do
       class CustomPopulateModel < AttributeModel

data/test/virtualbox/abstract_model/interface_attributes_test.rb

@@ -25,14 +25,14 @@ class InterfaceAttributesTest < Test::Unit::TestCase
         result = mock("result")
         proc = @instance.spec_to_proc(:foo)
         @interface.expects(:foo).once.returns(result)
-        assert_equal result, proc.call(@interface)
+        assert_equal result, proc.call(nil, @interface)
       end
 
       should "forward all parameters" do
         result = mock("result")
         proc = @instance.spec_to_proc(:foo)
         @interface.expects(:foo).with(1, 2, 3).once.returns(result)
-        assert_equal result, proc.call(@interface, 1, 2, 3)
+        assert_equal result, proc.call(nil, @interface, :key, 1, 2, 3)
       end
     end
 

data/test/virtualbox/com/implementer/mscom_test.rb

@@ -59,26 +59,70 @@ class COMImplementerMSCOMTest < Test::Unit::TestCase
     end
 
     context "reading a property" do
-      should "read the property on the object and return it" do
-        name = :foo_bar
-        value = mock("value")
-        result = mock("result")
-        opts = { :value_type => :foo }
-        @object.expects(:[]).with('FooBar').once.returns(value)
-        @instance.expects(:returnable_value).with(value, opts[:value_type]).returns(result)
+      context "with ruby 1.8" do
+        setup do
+          @instance.stubs(:ruby_version).returns(1.8)
+        end
+
+        should "read the property on the object and return it" do
+          name = :foo_bar
+          value = mock("value")
+          result = mock("result")
+          opts = { :value_type => :foo }
+          @object.expects(:[]).with('FooBar').once.returns(value)
+          @instance.expects(:returnable_value).with(value, opts[:value_type]).returns(result)
 
-        assert_equal result, @instance.read_property(name, opts)
+          assert_equal result, @instance.read_property(name, opts)
+        end
+      end
+
+      context "with ruby 1.9" do
+        setup do
+          @instance.stubs(:ruby_version).returns(1.9)
+        end
+
+        should "read the property on the object and return it" do
+          name = :foo_bar
+          value = mock("value")
+          result = mock("result")
+          opts = { :value_type => :foo }
+          @object.expects(:FooBar).once.returns(value)
+          @instance.expects(:returnable_value).with(value, opts[:value_type]).returns(result)
+
+          assert_equal result, @instance.read_property(name, opts)
+        end
       end
     end
 
     context "writing a property" do
-      should "convert the args and set it on the object" do
-        name = :foo_bar
-        opts = { :value_type => :foo }
-        @instance.expects(:spec_to_args).with([:foo], [:value]).returns([:modified])
-        @object.expects(:[]=).with('FooBar', :modified).once
+      context "on ruby 1.8" do
+        setup do
+          @instance.stubs(:ruby_version).returns(1.8)
+        end
 
-        @instance.write_property(name, :value, opts)
+        should "convert the args and set it on the object" do
+          name = :foo_bar
+          opts = { :value_type => :foo }
+          @instance.expects(:spec_to_args).with([:foo], [:value]).returns([:modified])
+          @object.expects(:[]=).with('FooBar', :modified).once
+
+          @instance.write_property(name, :value, opts)
+        end
+      end
+
+      context "on ruby 1.9" do
+        setup do
+          @instance.stubs(:ruby_version).returns(1.9)
+        end
+
+        should "convert the args and set it on the object" do
+          name = :foo_bar
+          opts = { :value_type => :foo }
+          @instance.expects(:spec_to_args).with([:foo], [:value]).returns([:modified])
+          @object.expects(:FooBar=).with(:modified).once
+
+          @instance.write_property(name, :value, opts)
+        end
       end
     end
 

data/test/virtualbox/ext/byte_normalizer_test.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'test_helper')
+require 'virtualbox/ext/byte_normalizer'
+
+class ByteNormalizerTest < Test::Unit::TestCase
+  class A
+    include VirtualBox::ByteNormalizer
+  end
+
+  setup do
+    @instance = A.new
+  end
+
+  should "convert megabytes to bytes" do
+    expected = {
+      1 => 1_048_576,
+      345.4 => 362_178_150.4
+    }
+
+    expected.each do |input, out|
+      assert_equal out, @instance.megabytes_to_bytes(input)
+    end
+  end
+
+  should "convert bytes to megabytes" do
+    expected = {
+      1_048_576 => 1,
+      362_178_150.4 => 345.4
+    }
+
+    expected.each do |input, out|
+      assert_equal out, @instance.bytes_to_megabytes(input)
+    end
+  end
+end

data/test/virtualbox/hard_drive_test.rb

@@ -54,6 +54,15 @@ class HardDriveTest < Test::Unit::TestCase
       @instance = @klass.new(@interface)
     end
 
+    context "physical size" do
+      should "convert bytes to megabytes" do
+        nonnormalized = 37548181
+        normalized = @instance.bytes_to_megabytes(nonnormalized)
+        @instance.expects(:read_attribute).with(:physical_size).returns(nonnormalized)
+        assert_equal normalized, @instance.physical_size
+      end
+    end
+
     context "cloning" do
       setup do
         @system_properties = mock("system_properties")

data/test/virtualbox/hw_virtualization_test.rb

@@ -0,0 +1,103 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class HWVirtualizationTest < Test::Unit::TestCase
+  setup do
+    @klass = VirtualBox::HWVirtualization
+    @interface = mock("interface")
+    @parent = mock("parent")
+  end
+
+  context "class methods" do
+    context "populating relationship" do
+      setup do
+        @instance = mock("instance")
+        @klass.stubs(:new).returns(@instance)
+      end
+
+      should "call new for the interface" do
+        @klass.expects(:new).with(nil, @interface).once.returns(@instance)
+        assert_equal @instance, @klass.populate_relationship(nil, @interface)
+      end
+    end
+
+    context "saving relationship" do
+      should "call save with the interface on the instance" do
+        instance = mock("instance")
+        instance.expects(:save).once
+
+        @klass.save_relationship(nil, instance)
+      end
+    end
+  end
+
+  context "initializing" do
+    setup do
+      @klass.any_instance.stubs(:load_interface_attributes)
+    end
+
+    should "load interface attribtues" do
+      @klass.any_instance.expects(:load_interface_attributes).with(@interface).once
+      @klass.new(@parent, @interface)
+    end
+
+    should "not be dirty" do
+      @instance = @klass.new(@parent, @interface)
+      assert !@instance.changed?
+    end
+
+    should "be existing record" do
+      @instance = @klass.new(@parent, @interface)
+      assert !@instance.new_record?
+    end
+  end
+
+  context "instance methods" do
+    setup do
+      @klass.any_instance.stubs(:load_interface_attributes)
+
+      @parent = mock("parent")
+      @interface = mock("interface")
+      @instance = @klass.new(@parent, @interface)
+    end
+
+    context "getting a property" do
+      setup do
+        @key = :foo
+      end
+
+      should "call proper function on interface" do
+        result = mock("result")
+        @interface.expects(:get_hw_virt_ex_property).with(@key).returns(result)
+        assert_equal result, @instance.get_property(@interface, @key)
+      end
+    end
+
+    context "setting a property" do
+      setup do
+        @key = :foo
+        @value = :bar
+      end
+
+      should "call proper function on interface" do
+        @interface.expects(:set_hw_virt_ex_property).with(@key, @value).once
+        @instance.set_property(@interface, @key, @value)
+      end
+    end
+
+    context "saving" do
+      setup do
+        @bios_settings = mock("bios_settings")
+        @session = mock("session")
+        @machine = mock("machine")
+        @session.stubs(:machine).returns(@machine)
+        @parent.stubs(:with_open_session).yields(@session)
+      end
+
+      should "save the interface settings with the new bios settings" do
+        save_seq = sequence("save_seq")
+        @instance.expects(:save_changed_interface_attributes).with(@machine).once.in_sequence(save_seq)
+        @instance.save
+      end
+    end
+  end
+end

data/virtualbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{virtualbox}
-  s.version = "0.6.0"
+  s.version = "0.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mitchell Hashimoto"]
-  s.date = %q{2010-04-15}
+  s.date = %q{2010-04-24}
   s.description = %q{Create and modify virtual machines in VirtualBox using pure ruby.}
   s.email = %q{mitchell.hashimoto@gmail.com}
   s.extra_rdoc_files = [
@@ -113,6 +113,7 @@ Gem::Specification.new do |s|
      "lib/virtualbox/com/util.rb",
      "lib/virtualbox/dvd.rb",
      "lib/virtualbox/exceptions.rb",
+     "lib/virtualbox/ext/byte_normalizer.rb",
      "lib/virtualbox/ext/glob_loader.rb",
      "lib/virtualbox/ext/logger.rb",
      "lib/virtualbox/ext/platform.rb",
@@ -121,6 +122,7 @@ Gem::Specification.new do |s|
      "lib/virtualbox/forwarded_port.rb",
      "lib/virtualbox/global.rb",
      "lib/virtualbox/hard_drive.rb",
+     "lib/virtualbox/hw_virtualization.rb",
      "lib/virtualbox/lib.rb",
      "lib/virtualbox/media.rb",
      "lib/virtualbox/medium.rb",
@@ -156,12 +158,14 @@ Gem::Specification.new do |s|
      "test/virtualbox/com/mscom_interface_test.rb",
      "test/virtualbox/com/util_test.rb",
      "test/virtualbox/dvd_test.rb",
+     "test/virtualbox/ext/byte_normalizer_test.rb",
      "test/virtualbox/ext/platform_test.rb",
      "test/virtualbox/ext/subclass_listing_test.rb",
      "test/virtualbox/extra_data_test.rb",
      "test/virtualbox/forwarded_port_test.rb",
      "test/virtualbox/global_test.rb",
      "test/virtualbox/hard_drive_test.rb",
+     "test/virtualbox/hw_virtualization_test.rb",
      "test/virtualbox/lib_test.rb",
      "test/virtualbox/medium_attachment_test.rb",
      "test/virtualbox/medium_test.rb",
@@ -205,12 +209,14 @@ Gem::Specification.new do |s|
      "test/virtualbox/com/mscom_interface_test.rb",
      "test/virtualbox/com/util_test.rb",
      "test/virtualbox/dvd_test.rb",
+     "test/virtualbox/ext/byte_normalizer_test.rb",
      "test/virtualbox/ext/platform_test.rb",
      "test/virtualbox/ext/subclass_listing_test.rb",
      "test/virtualbox/extra_data_test.rb",
      "test/virtualbox/forwarded_port_test.rb",
      "test/virtualbox/global_test.rb",
      "test/virtualbox/hard_drive_test.rb",
+     "test/virtualbox/hw_virtualization_test.rb",
      "test/virtualbox/lib_test.rb",
      "test/virtualbox/medium_attachment_test.rb",
      "test/virtualbox/medium_test.rb",

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 0
-  version: 0.6.0
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Mitchell Hashimoto
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-15 00:00:00 -07:00
+date: 2010-04-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -137,6 +137,7 @@ files:
 - lib/virtualbox/com/util.rb
 - lib/virtualbox/dvd.rb
 - lib/virtualbox/exceptions.rb
+- lib/virtualbox/ext/byte_normalizer.rb
 - lib/virtualbox/ext/glob_loader.rb
 - lib/virtualbox/ext/logger.rb
 - lib/virtualbox/ext/platform.rb
@@ -145,6 +146,7 @@ files:
 - lib/virtualbox/forwarded_port.rb
 - lib/virtualbox/global.rb
 - lib/virtualbox/hard_drive.rb
+- lib/virtualbox/hw_virtualization.rb
 - lib/virtualbox/lib.rb
 - lib/virtualbox/media.rb
 - lib/virtualbox/medium.rb
@@ -180,12 +182,14 @@ files:
 - test/virtualbox/com/mscom_interface_test.rb
 - test/virtualbox/com/util_test.rb
 - test/virtualbox/dvd_test.rb
+- test/virtualbox/ext/byte_normalizer_test.rb
 - test/virtualbox/ext/platform_test.rb
 - test/virtualbox/ext/subclass_listing_test.rb
 - test/virtualbox/extra_data_test.rb
 - test/virtualbox/forwarded_port_test.rb
 - test/virtualbox/global_test.rb
 - test/virtualbox/hard_drive_test.rb
+- test/virtualbox/hw_virtualization_test.rb
 - test/virtualbox/lib_test.rb
 - test/virtualbox/medium_attachment_test.rb
 - test/virtualbox/medium_test.rb
@@ -253,12 +257,14 @@ test_files:
 - test/virtualbox/com/mscom_interface_test.rb
 - test/virtualbox/com/util_test.rb
 - test/virtualbox/dvd_test.rb
+- test/virtualbox/ext/byte_normalizer_test.rb
 - test/virtualbox/ext/platform_test.rb
 - test/virtualbox/ext/subclass_listing_test.rb
 - test/virtualbox/extra_data_test.rb
 - test/virtualbox/forwarded_port_test.rb
 - test/virtualbox/global_test.rb
 - test/virtualbox/hard_drive_test.rb
+- test/virtualbox/hw_virtualization_test.rb
 - test/virtualbox/lib_test.rb
 - test/virtualbox/medium_attachment_test.rb
 - test/virtualbox/medium_test.rb