libvirt-ruby 0.0.4 → 0.0.5

data/README.rdoc

@@ -12,7 +12,13 @@ This gem has as a dependencie the libvirt package. Google it and u will find how
 
 == Usage
 
-You should one of the classes defined and call method dispatcher passing parameters:
+You should use one of the classes defined and call the method directly:
+ Libvirt::Ruby::Connect.Close([:int])
+
+The parameter of the function should be an array where the last instance is the return of the C function.
+
+
+The old method dispatcher still can be called, but is now deprecated. Call dispatcher passing as parameters:
  first -> the method just like the one from Libvirt in C as a string except the vir and the name of the Class just like 'Close' from 'virConnectClose'
  second -> the args of the function in C in the same order
  third -> a symbol of the retun of the function.
@@ -30,10 +36,9 @@ Give it a try in another distro and let me know if it works.
 
 Add Support for a ton of thigs. =D
 Improve a lot of things:
- * Use method missing and deprecate dispatcher.
- * Find a way to make the test suit pass without the lib. By now it only works if u have it installed.
+ * Remove all classes and make gem wotk without them. Using Just one class: Libvirt::Ruby
  * Create more Exceptions for another type of errors.
- * Create pages on Wiki teaching how to isntall libvirt on each distro.
+ * Create pages on Wiki teaching how to install libvirt on several distros.
  ...
 
 == Contribute

data/lib/libvirt-ruby/util.rb

@@ -3,7 +3,16 @@ module Libvirt
     class Util
       extend FFI::Library
 
+      def self.method_missing(method, *args)
+        args.flatten!
+        return_type = args.delete(args.last)
+        dispatcher(method, args, return_type)
+      end
+
       def self.dispatcher(method, args = [], return_type = nil)
+        unless not_direct_call?
+          warn "[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead."
+        end
         begin
           ffi_lib "libvirt"
           attach_function (self.klass + method.to_s), (self.klass + method.to_s), args, return_type
@@ -14,6 +23,12 @@ module Libvirt
           raise Libvirt::Ruby::Exceptions::MissingLib
         end
       end
+
+      private
+
+      def self.not_direct_call?
+        caller[1][/`.*'/][1..-2] == 'method_missing'
+      end
     end
   end
 end

data/lib/libvirt-ruby/version.rb

@@ -1,5 +1,5 @@
 module Libvirt
   module Ruby
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/spec/libvirt-ruby/connect_spec.rb

@@ -4,14 +4,28 @@ describe Libvirt::Ruby::Connect do
   let(:connect) { Libvirt::Ruby::Connect }
 
   context "when calling method #dispatcher" do
+    context "that is now deprecated" do
+      before :each do
+        connect.stub(:ffi_lib).with("libvirt")
+        connect.stub(:attach_function).with("virConnectClose", "virConnectClose", [], :int)
+        connect.stub(:send).with("virConnectClose", [])
+      end
+
+      it "should raise a deprecated method warning" do
+        connect.should_receive(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+        connect.dispatcher('Close', [], :int)
+      end
+    end
+
     context "with libvirt installed" do
       before :each do
+        connect.stub(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
         connect.stub(:ffi_lib).with("libvirt")
       end
 
       context "and a valid libvirt function" do
         before :each do
-          connect.stub(:attach_function).with("virConnectClose", "virConnectClose", [], :int).and_return(true)
+          connect.stub(:attach_function).with("virConnectClose", "virConnectClose", [], :int)
           connect.stub(:send).with("virConnectClose", [])
         end
 
@@ -40,9 +54,69 @@ describe Libvirt::Ruby::Connect do
     end
 
     context "without libvirt installed" do
+      before :each do
+        connect.stub(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+      end
+
       it "should raise an exception" do
         lambda { connect.dispatcher('Abc', [], :int) }.should raise_error(Libvirt::Ruby::Exceptions::MissingLib)
       end
     end
   end
+
+  context "when calling any libvirt function directly" do
+    context "that is the new way" do
+      before :each do
+        connect.stub(:ffi_lib).with("libvirt")
+        connect.stub(:attach_function).with("virConnectClose", "virConnectClose", [], :int)
+        connect.stub(:send).with("virConnectClose", [])
+      end
+
+      it "should  not raise a deprecated method warning" do
+        connect.should_not_receive(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+        connect.Close([:int])
+      end
+    end
+
+    context "with libvirt installed" do
+      before :each do
+        connect.stub(:ffi_lib).with("libvirt")
+      end
+
+      context "and the function is a valid one" do
+        before :each do
+          connect.stub(:attach_function).with("virConnectClose", "virConnectClose", [], :int).and_return(true)
+          connect.stub(:send).with("virConnectClose", [])
+        end
+
+        after :each do
+          connect.Close([:int])
+        end
+
+        it "should attach it as a binding for C's function" do
+          connect.should_receive(:attach_function).with("virConnectClose", "virConnectClose", [], :int).and_return(true)
+        end
+
+        it "should call the new attached method" do
+          connect.should_receive(:send).with("virConnectClose", [])
+        end
+      end
+
+      context "and the function is not a valid one" do
+        before :each do
+          connect.stub(:attach_function).with("virConnectAbc", "virConnectAbc", [], :int).and_raise(FFI::NotFoundError.new('Abc', 'libvirt'))
+        end
+
+        it "should raise an exception" do
+          lambda { connect.Abc([:int]) }.should raise_error(Libvirt::Ruby::Exceptions::InvalidFunction)
+        end
+      end
+    end
+
+    context "without libvirt installed" do
+      it "should raise an exception" do
+        lambda { connect.Abc([:int])  }.should raise_error(Libvirt::Ruby::Exceptions::MissingLib)
+      end
+    end
+  end
 end

data/spec/libvirt-ruby/domain_spec.rb

@@ -4,8 +4,22 @@ describe Libvirt::Ruby::Domain do
   let(:domain) { Libvirt::Ruby::Domain }
 
   context "when calling method #dispatcher" do
+    context "that is now deprecated" do
+      before :each do
+        domain.stub(:ffi_lib).with("libvirt")
+        domain.stub(:attach_function).with("virDomainCreate", "virDomainCreate", [], :int)
+        domain.stub(:send).with("virDomainCreate", [])
+      end
+
+      it "should raise a deprecated method warning" do
+        domain.should_receive(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+        domain.dispatcher('Create', [], :int)
+      end
+    end
+
     context "with libvirt installed" do
       before :each do
+        domain.stub(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
         domain.stub(:ffi_lib).with("libvirt")
       end
 
@@ -40,9 +54,69 @@ describe Libvirt::Ruby::Domain do
     end
 
     context "without libvirt installed" do
+      before :each do
+        domain.stub(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+      end
+
       it "should raise an exception" do
         lambda { domain.dispatcher('Abc', [], :int) }.should raise_error(Libvirt::Ruby::Exceptions::MissingLib)
       end
     end
   end
+
+  context "when calling any libvirt function directly" do
+    context "that is the new way" do
+      before :each do
+        domain.stub(:ffi_lib).with("libvirt")
+        domain.stub(:attach_function).with("virDomainCreate", "virDomainCreate", [], :int)
+        domain.stub(:send).with("virDomainCreate", [])
+      end
+
+      it "should  not raise a deprecated method warning" do
+        domain.should_not_receive(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+        domain.Create([:int])
+      end
+    end
+
+    context "with libvirt installed" do
+      before :each do
+        domain.stub(:ffi_lib).with("libvirt")
+      end
+
+      context "and the function is a valid one" do
+        before :each do
+          domain.stub(:attach_function).with("virDomainCreate", "virDomainCreate", [], :int).and_return(true)
+          domain.stub(:send).with("virDomainCreate", [])
+        end
+
+        after :each do
+          domain.Create([:int])
+        end
+
+        it "should attach it as a binding for C's function" do
+          domain.should_receive(:attach_function).with("virDomainCreate", "virDomainCreate", [], :int).and_return(true)
+        end
+
+        it "should call the new attached method" do
+          domain.should_receive(:send).with("virDomainCreate", [])
+        end
+      end
+
+      context "and the function is not a valid one" do
+        before :each do
+          domain.stub(:attach_function).with("virDomainAbc", "virDomainAbc", [], :int).and_raise(FFI::NotFoundError.new('Abc', 'libvirt'))
+        end
+
+        it "should raise an exception" do
+          lambda { domain.Abc([:int]) }.should raise_error(Libvirt::Ruby::Exceptions::InvalidFunction)
+        end
+      end
+    end
+
+    context "without libvirt installed" do
+      it "should raise an exception" do
+        lambda { domain.Abc([:int]) }.should raise_error(Libvirt::Ruby::Exceptions::MissingLib)
+      end
+    end
+  end
 end

data/spec/libvirt-ruby/network_spec.rb

@@ -4,8 +4,22 @@ describe Libvirt::Ruby::Network do
   let(:network) { Libvirt::Ruby::Network }
 
   context "when calling method #dispatcher" do
+    context "that is now deprecated" do
+      before :each do
+        network.stub(:ffi_lib).with("libvirt")
+        network.stub(:attach_function).with("virNetworkRef", "virNetworkRef", [], :int)
+        network.stub(:send).with("virNetworkRef", [])
+      end
+
+      it "should raise a deprecated method warning" do
+        network.should_receive(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+        network.dispatcher('Ref', [], :int)
+      end
+    end
+
     context "with libvirt installed" do
       before :each do
+        network.stub(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
         network.stub(:ffi_lib).with("libvirt")
       end
 
@@ -40,9 +54,69 @@ describe Libvirt::Ruby::Network do
     end
 
     context "without libvirt installed" do
+      before :each do
+        network.stub(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+      end
+
       it "should raise an exception" do
         lambda { network.dispatcher('Abc', [], :int) }.should raise_error(Libvirt::Ruby::Exceptions::MissingLib)
       end
     end
   end
+
+  context "when calling any libvirt function directly" do
+    context "that is the new way" do
+      before :each do
+        network.stub(:ffi_lib).with("libvirt")
+        network.stub(:attach_function).with("virNetworkRef", "virNetworkRef", [], :int)
+        network.stub(:send).with("virNetworkRef", [])
+      end
+
+      it "should  not raise a deprecated method warning" do
+        network.should_not_receive(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+        network.Ref([:int])
+      end
+    end
+
+    context "with libvirt installed" do
+      before :each do
+        network.stub(:ffi_lib).with("libvirt")
+      end
+
+      context "and the function is a valid one" do
+        before :each do
+          network.stub(:attach_function).with("virNetworkRef", "virNetworkRef", [], :int).and_return(true)
+          network.stub(:send).with("virNetworkRef", [])
+        end
+
+        after :each do
+          network.Ref([:int])
+        end
+
+        it "should attach it as a binding for C's function" do
+          network.should_receive(:attach_function).with("virNetworkRef", "virNetworkRef", [], :int).and_return(true)
+        end
+
+        it "should call the new attached method" do
+          network.should_receive(:send).with("virNetworkRef", [])
+        end
+      end
+
+      context "and the function is not a valid one" do
+        before :each do
+          network.stub(:attach_function).with("virNetworkAbc", "virNetworkAbc", [], :int).and_raise(FFI::NotFoundError.new('Abc', 'libvirt'))
+        end
+
+        it "should raise an exception" do
+          lambda { network.Abc([:int]) }.should raise_error(Libvirt::Ruby::Exceptions::InvalidFunction)
+        end
+      end
+    end
+
+    context "without libvirt installed" do
+      it "should raise an exception" do
+        lambda { network.Abc([:int]) }.should raise_error(Libvirt::Ruby::Exceptions::MissingLib)
+      end
+    end
+  end
 end

data/spec/libvirt-ruby/storage_pool_spec.rb

@@ -4,8 +4,22 @@ describe Libvirt::Ruby::StoragePool do
   let(:storage_pool) { Libvirt::Ruby::StoragePool }
 
   context "when calling method #dispatcher" do
+    context "that is now deprecated" do
+      before :each do
+        storage_pool.stub(:ffi_lib).with("libvirt")
+        storage_pool.stub(:attach_function).with("virStoragePoolRefresh", "virStoragePoolRefresh", [], :int)
+        storage_pool.stub(:send).with("virStoragePoolRefresh", [])
+      end
+
+      it "should raise a deprecated method warning" do
+        storage_pool.should_receive(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+        storage_pool.dispatcher('Refresh', [], :int)
+      end
+    end
+
     context "with libvirt installed" do
       before :each do
+        storage_pool.stub(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
         storage_pool.stub(:ffi_lib).with("libvirt")
       end
 
@@ -40,9 +54,69 @@ describe Libvirt::Ruby::StoragePool do
     end
 
     context "without libvirt installed" do
+      before :each do
+        storage_pool.stub(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+      end
+
       it "should raise an exception" do
         lambda { storage_pool.dispatcher('Abc', [], :int) }.should raise_error(Libvirt::Ruby::Exceptions::MissingLib)
       end
     end
   end
+
+  context "when calling any libvirt function directly" do
+    context "that is the new way" do
+      before :each do
+        storage_pool.stub(:ffi_lib).with("libvirt")
+        storage_pool.stub(:attach_function).with("virStoragePoolRefresh", "virStoragePoolRefresh", [], :int)
+        storage_pool.stub(:send).with("virStoragePoolRefresh", [])
+      end
+
+      it "should  not raise a deprecated method warning" do
+        storage_pool.should_not_receive(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+        storage_pool.Refresh([:int])
+      end
+    end
+
+    context "with libvirt installed" do
+      before :each do
+        storage_pool.stub(:ffi_lib).with("libvirt")
+      end
+
+      context "and the function is a valid one" do
+        before :each do
+          storage_pool.stub(:attach_function).with("virStoragePoolRefresh", "virStoragePoolRefresh", [], :int).and_return(true)
+          storage_pool.stub(:send).with("virStoragePoolRefresh", [])
+        end
+
+        after :each do
+          storage_pool.Refresh([:int])
+        end
+
+        it "should attach it as a binding for C's function" do
+          storage_pool.should_receive(:attach_function).with("virStoragePoolRefresh", "virStoragePoolRefresh", [], :int).and_return(true)
+        end
+
+        it "should call the new attached method" do
+          storage_pool.should_receive(:send).with("virStoragePoolRefresh", [])
+        end
+      end
+
+      context "and the function is not a valid one" do
+        before :each do
+          storage_pool.stub(:attach_function).with("virStoragePoolAbc", "virStoragePoolAbc", [], :int).and_raise(FFI::NotFoundError.new('Abc', 'libvirt'))
+        end
+
+        it "should raise an exception" do
+          lambda { storage_pool.Abc([:int]) }.should raise_error(Libvirt::Ruby::Exceptions::InvalidFunction)
+        end
+      end
+    end
+
+    context "without libvirt installed" do
+      it "should raise an exception" do
+        lambda { storage_pool.Abc([:int]) }.should raise_error(Libvirt::Ruby::Exceptions::MissingLib)
+      end
+    end
+  end
 end

data/spec/libvirt-ruby/storage_vol_spec.rb

@@ -4,8 +4,22 @@ describe Libvirt::Ruby::StorageVol do
   let(:storage_vol) { Libvirt::Ruby::StorageVol }
 
   context "when calling method #dispatcher" do
+    context "that is now deprecated" do
+      before :each do
+        storage_vol.stub(:ffi_lib).with("libvirt")
+        storage_vol.stub(:attach_function).with("virStorageVolResize", "virStorageVolResize", [], :int)
+        storage_vol.stub(:send).with("virStorageVolResize", [])
+      end
+
+      it "should raise a deprecated method warning" do
+        storage_vol.should_receive(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+        storage_vol.dispatcher('Resize', [], :int)
+      end
+    end
+
     context "with libvirt installed" do
       before :each do
+        storage_vol.stub(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
         storage_vol.stub(:ffi_lib).with("libvirt")
       end
 
@@ -40,9 +54,69 @@ describe Libvirt::Ruby::StorageVol do
     end
 
     context "without libvirt installed" do
+      before :each do
+        storage_vol.stub(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+      end
+
       it "should raise an exception" do
         lambda { storage_vol.dispatcher('Abc', [], :int) }.should raise_error(Libvirt::Ruby::Exceptions::MissingLib)
       end
     end
   end
+
+  context "when calling method #dispatcher" do
+    context "that is the new way" do
+      before :each do
+        storage_vol.stub(:ffi_lib).with("libvirt")
+        storage_vol.stub(:attach_function).with("virStorageVolResize", "virStorageVolResize", [], :int)
+        storage_vol.stub(:send).with("virStorageVolResize", [])
+      end
+
+      it "should  not raise a deprecated method warning" do
+        storage_vol.should_not_receive(:warn).with("[DEPRECATION] `dispatcher` is deprecated.  Please call the function directly instead.")
+        storage_vol.Resize([:int])
+      end
+    end
+
+    context "with libvirt installed" do
+      before :each do
+        storage_vol.stub(:ffi_lib).with("libvirt")
+      end
+
+      context "and the function is a valid one" do
+        before :each do
+          storage_vol.stub(:attach_function).with("virStorageVolResize", "virStorageVolResize", [], :int).and_return(true)
+          storage_vol.stub(:send).with("virStorageVolResize", [])
+        end
+
+        after :each do
+          storage_vol.Resize([:int])
+        end
+
+        it "should attach it as a binding for C's function" do
+          storage_vol.should_receive(:attach_function).with("virStorageVolResize", "virStorageVolResize", [], :int).and_return(true)
+        end
+
+        it "should call the new attached method" do
+          storage_vol.should_receive(:send).with("virStorageVolResize", [])
+        end
+      end
+
+      context "and the function is not a valid one" do
+        before :each do
+          storage_vol.stub(:attach_function).with("virStorageVolAbc", "virStorageVolAbc", [], :int).and_raise(FFI::NotFoundError.new('Abc', 'libvirt'))
+        end
+
+        it "should raise an exception" do
+          lambda { storage_vol.Abc([:int]) }.should raise_error(Libvirt::Ruby::Exceptions::InvalidFunction)
+        end
+      end
+    end
+
+    context "without libvirt installed" do
+      it "should raise an exception" do
+        lambda { storage_vol.Abc([:int]) }.should raise_error(Libvirt::Ruby::Exceptions::MissingLib)
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libvirt-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-26 00:00:00.000000000 Z
+date: 2012-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &5985660 !ruby/object:Gem::Requirement
+  requirement: &12021240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *5985660
+  version_requirements: *12021240
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &5984880 !ruby/object:Gem::Requirement
+  requirement: &12020740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *5984880
+  version_requirements: *12020740
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &5984120 !ruby/object:Gem::Requirement
+  requirement: &12019800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *5984120
+  version_requirements: *12019800
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &5983600 !ruby/object:Gem::Requirement
+  requirement: &12019200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *5983600
+  version_requirements: *12019200
 description: Access Libvirt's C Library through ruby classes and methods
 email: plribeiro3000@gmail.com
 executables: []