virtualbox 0.5.2 → 0.5.3

data/VERSION

@@ -1 +1 @@
-0.5.2
+0.5.3

data/lib/virtualbox.rb

@@ -4,6 +4,7 @@ $:.unshift(File.expand_path(File.dirname(__FILE__)))
 require 'nokogiri'
 
 # Internal Dependencies
+require 'virtualbox/ext/platform'
 require 'virtualbox/exceptions'
 require 'virtualbox/command'
 require 'virtualbox/abstract_model'

data/lib/virtualbox/command.rb

@@ -93,6 +93,13 @@ module VirtualBox
       # the ruby mailing list. I'm not sure how well it works but so far
       # it hasn't failed!
       def shell_escape(str)
+        if Platform.windows?
+          # Special case for windows. This is probably not 100% bullet proof
+          # but it gets the job done until we find trouble
+          str = "\"#{str}\"" if str =~ /\s/
+          return str
+        end
+
         str.to_s.gsub(/(?=[^a-zA-Z0-9_.\/\-\x7F-\xFF\n])/n, '\\').
                  gsub(/\n/, "'\n'").
                  sub(/^$/, "''")

data/lib/virtualbox/ext/platform.rb

@@ -0,0 +1,21 @@
+module VirtualBox
+  class Platform
+    class <<self
+      def mac?
+        platform.include?("darwin")
+      end
+
+      def windows?
+        platform.include?("mswin") || platform.include?("mingw")
+      end
+
+      def linux?
+        platform.include?("linux")
+      end
+
+      def platform
+        RUBY_PLATFORM.downcase
+      end
+    end
+  end
+end

data/lib/virtualbox/global.rb

@@ -54,15 +54,7 @@ module VirtualBox
     # The path to the global VirtualBox XML configuration file. This is
     # entirely system dependent and can be set with {vboxconfig=}. The default
     # is guessed based on the platform.
-    #
-    # TODO: Windows
-    @@vboxconfig = if RUBY_PLATFORM.downcase.include?("darwin")
-      "~/Library/VirtualBox/VirtualBox.xml"
-    elsif RUBY_PLATFORM.downcase.include?("linux")
-      "~/.VirtualBox/VirtualBox.xml"
-    else
-      "Unknown"
-    end
+    @@vboxconfig = nil
 
     relationship :vms, VM, :lazy => true
     relationship :media, Media
@@ -96,21 +88,36 @@ module VirtualBox
         @@vboxconfig = value
       end
 
+      # Returns the path to the virtual box configuration file. If the path
+      # has not yet been set, it attempts to infer it based on the
+      # platform ruby is running on.
+      def vboxconfig
+        return @@vboxconfig unless @@vboxconfig.nil?
+
+        if Platform.mac?
+          "~/Library/VirtualBox/VirtualBox.xml"
+        elsif Platform.linux? || Platform.windows?
+          "~/.VirtualBox/VirtualBox.xml"
+        else
+          "Unknown"
+        end
+      end
+
       # Returns the XML document of the configuration. This will raise an
       # {Exceptions::ConfigurationException} if the vboxconfig file doesn't
       # exist.
       #
       # @return [Nokogiri::XML::Document]
       def config
-        raise Exceptions::ConfigurationException.new("The path to the global VirtualBox config must be set. See Global.vboxconfig=") unless File.exist?(File.expand_path(@@vboxconfig))
-        Command.parse_xml(File.expand_path(@@vboxconfig))
+        raise Exceptions::ConfigurationException.new("The path to the global VirtualBox config must be set. See Global.vboxconfig=") unless File.exist?(File.expand_path(vboxconfig))
+        Command.parse_xml(File.expand_path(vboxconfig))
       end
 
       # Expands path relative to the configuration file.
       #
       # @return [String]
       def expand_path(path)
-        File.expand_path(path, File.dirname(@@vboxconfig))
+        File.expand_path(path, File.dirname(vboxconfig))
       end
     end
 

data/test/virtualbox/command_test.rb

@@ -54,6 +54,30 @@ class CommandTest < Test::Unit::TestCase
         assert_equal "400", VirtualBox::Command.shell_escape(400)
       end
     end
+
+    context "unix" do
+      setup do
+        VirtualBox::Platform.stubs(:windows?).returns(false)
+      end
+
+      should "convert properly" do
+        assert_equal "foo\\ bar", VirtualBox::Command.shell_escape("foo bar")
+      end
+    end
+
+    context "windows" do
+      setup do
+        VirtualBox::Platform.stubs(:windows?).returns(true)
+      end
+
+      should "wrap strings with spaces in quotes" do
+        assert_equal '"foo bar"', VirtualBox::Command.shell_escape("foo bar")
+      end
+
+      should "just return the string if it has no spaces" do
+        assert_equal "foo:bar", VirtualBox::Command.shell_escape('foo:bar')
+      end
+    end
   end
 
   context "executing commands" do

data/test/virtualbox/ext/platform_test.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'test_helper')
+require 'virtualbox/ext/platform'
+
+class PlatformTest < Test::Unit::TestCase
+  context "mac" do
+    should "return true if it contains darwin" do
+      success = ["i386-darwin", "i686-darwin10", "imadarwin"]
+      success.each do |item|
+        VirtualBox::Platform.stubs(:platform).returns(item)
+        assert VirtualBox::Platform.mac?
+      end
+    end
+  end
+
+  context "windows" do
+    should "return true if it contains mswin" do
+      success = ["i386-mswin32", "i686-mswin64", "imswin"]
+      success.each do |item|
+        VirtualBox::Platform.stubs(:platform).returns(item)
+        assert VirtualBox::Platform.windows?
+      end
+    end
+
+    should "return true if it contains mingw" do
+      success = ["i386-mingw32", "i686-mingw64", "mingw"]
+      success.each do |item|
+        VirtualBox::Platform.stubs(:platform).returns(item)
+        assert VirtualBox::Platform.windows?
+      end
+    end
+  end
+
+  context "linux" do
+    should "return true if it contains linux" do
+      success = ["i386-linux", "i686-linux241", "linux"]
+      success.each do |item|
+        VirtualBox::Platform.stubs(:platform).returns(item)
+        assert VirtualBox::Platform.linux?
+      end
+    end
+  end
+end

data/test/virtualbox/global_test.rb

@@ -1,6 +1,46 @@
 require File.join(File.dirname(__FILE__), '..', 'test_helper')
 
 class GlobalTest < Test::Unit::TestCase
+  context "the virtualbox config file path" do
+    setup do
+      VirtualBox::Global.vboxconfig = nil
+    end
+
+    teardown do
+      VirtualBox::Global.vboxconfig = "foo"
+    end
+
+    should "return the path if its set" do
+      VirtualBox::Global.vboxconfig = "foo"
+      assert_equal "foo", VirtualBox::Global.vboxconfig
+    end
+
+    should "return Mac-path if on mac" do
+      VirtualBox::Platform.stubs(:mac?).returns(true)
+      assert_equal "~/Library/VirtualBox/VirtualBox.xml", VirtualBox::Global.vboxconfig
+    end
+
+    should "return Windows-path if on windows" do
+      VirtualBox::Platform.stubs(:mac?).returns(false)
+      VirtualBox::Platform.stubs(:windows?).returns(true)
+      assert_equal "~/.VirtualBox/VirtualBox.xml", VirtualBox::Global.vboxconfig
+    end
+
+    should "return Linux-path if on linux" do
+      VirtualBox::Platform.stubs(:mac?).returns(false)
+      VirtualBox::Platform.stubs(:windows?).returns(false)
+      VirtualBox::Platform.stubs(:linux?).returns(true)
+      assert_equal "~/.VirtualBox/VirtualBox.xml", VirtualBox::Global.vboxconfig
+    end
+
+    should "return 'unknown' otherwise" do
+      VirtualBox::Platform.stubs(:mac?).returns(false)
+      VirtualBox::Platform.stubs(:windows?).returns(false)
+      VirtualBox::Platform.stubs(:linux?).returns(false)
+      assert_equal "Unknown", VirtualBox::Global.vboxconfig
+    end
+  end
+
   context "getting the global config" do
     should "only get it once, then cache" do
       VirtualBox::Global.expects(:config).returns(mock_xml_doc).once
@@ -26,6 +66,7 @@ class GlobalTest < Test::Unit::TestCase
 
   context "parsing configuration XML" do
     setup do
+      VirtualBox::Command.stubs(:vboxconfig).returns("foo")
       File.stubs(:exist?).returns(true)
       VirtualBox::Command.stubs(:parse_xml)
     end
@@ -63,7 +104,7 @@ class GlobalTest < Test::Unit::TestCase
 
   context "expanding path" do
     setup do
-      VirtualBox::Global.vboxconfig = "/foo/bar/baz.rb"
+      VirtualBox::Global.stubs(:vboxconfig).returns("/foo/bar/baz.rb")
     end
 
     should "expand the path properly" do

data/virtualbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{virtualbox}
-  s.version = "0.5.2"
+  s.version = "0.5.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mitchell Hashimoto"]
-  s.date = %q{2010-03-09}
+  s.date = %q{2010-03-16}
   s.description = %q{Create and modify virtual machines in VirtualBox using pure ruby.}
   s.email = %q{mitchell.hashimoto@gmail.com}
   s.extra_rdoc_files = [
@@ -37,6 +37,7 @@ Gem::Specification.new do |s|
      "lib/virtualbox/command.rb",
      "lib/virtualbox/dvd.rb",
      "lib/virtualbox/exceptions.rb",
+     "lib/virtualbox/ext/platform.rb",
      "lib/virtualbox/ext/subclass_listing.rb",
      "lib/virtualbox/extra_data.rb",
      "lib/virtualbox/forwarded_port.rb",
@@ -60,6 +61,7 @@ Gem::Specification.new do |s|
      "test/virtualbox/attached_device_test.rb",
      "test/virtualbox/command_test.rb",
      "test/virtualbox/dvd_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",
@@ -91,6 +93,7 @@ Gem::Specification.new do |s|
      "test/virtualbox/attached_device_test.rb",
      "test/virtualbox/command_test.rb",
      "test/virtualbox/dvd_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",

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 2
-  version: 0.5.2
+  - 3
+  version: 0.5.3
 platform: ruby
 authors: 
 - Mitchell Hashimoto
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-09 00:00:00 -08:00
+date: 2010-03-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,6 +61,7 @@ files:
 - lib/virtualbox/command.rb
 - lib/virtualbox/dvd.rb
 - lib/virtualbox/exceptions.rb
+- lib/virtualbox/ext/platform.rb
 - lib/virtualbox/ext/subclass_listing.rb
 - lib/virtualbox/extra_data.rb
 - lib/virtualbox/forwarded_port.rb
@@ -84,6 +85,7 @@ files:
 - test/virtualbox/attached_device_test.rb
 - test/virtualbox/command_test.rb
 - test/virtualbox/dvd_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
@@ -139,6 +141,7 @@ test_files:
 - test/virtualbox/attached_device_test.rb
 - test/virtualbox/command_test.rb
 - test/virtualbox/dvd_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