gir_ffi 0.8.6 → 0.9.0

data/test/ffi-gobject/value_test.rb

@@ -73,11 +73,18 @@ describe GObject::Value do
   end
 
   describe '#set_value' do
-    it 'handles char values' do
+    it 'handles signed char values' do
       value = -83
       gv = GObject::Value.for_gtype GObject::TYPE_CHAR
       gv.set_value value
-      gv.get_char.must_equal value
+      gv.get_schar.must_equal value
+    end
+
+    it 'handles unsigned char values' do
+      value = 174
+      gv = GObject::Value.for_gtype GObject::TYPE_UCHAR
+      gv.set_value value
+      gv.get_uchar.must_equal value
     end
 
     it 'handles enum values presented as symbols' do
@@ -178,10 +185,17 @@ describe GObject::Value do
       assert_equal true, result
     end
 
-    it 'unwraps a char' do
-      value = 3
+    it 'unwraps a signed char' do
+      value = -42
       gv = GObject::Value.for_gtype GObject::TYPE_CHAR
-      gv.set_char value
+      gv.set_schar value
+      gv.get_value.must_equal value
+    end
+
+    it 'unwraps an unsigned char' do
+      value = 173
+      gv = GObject::Value.for_gtype GObject::TYPE_UCHAR
+      gv.set_uchar value
       gv.get_value.must_equal value
     end
 

data/test/ffi-gobject_test.rb

@@ -23,7 +23,7 @@ describe GObject do
       callback = FFI::Function.new(:bool, argtypes) { |_a, _b, _c, _d| true }
       ::GObject::Lib.g_signal_connect_data s, 'incoming', callback, nil, nil, 0
       rv = GObject.signal_emit s, 'incoming'
-      assert_equal true, rv.get_value
+      assert_equal true, rv
     end
 
     it 'passes in extra arguments' do
@@ -95,7 +95,7 @@ describe GObject do
       s = Gio::SocketService.new
       GObject.signal_connect(s, 'incoming') { true }
       rv = GObject.signal_emit s, 'incoming'
-      assert_equal true, rv.get_value
+      assert_equal true, rv
     end
 
     it 'requires a block' do

data/test/gir_ffi/builders/argument_builder_test.rb

@@ -42,6 +42,10 @@ describe GirFFI::Builders::ArgumentBuilder do
           builder.closure = false
         end
 
+        it 'has the correct value for method_argument_name' do
+          builder.method_argument_name.must_equal arg_info.name
+        end
+
         it 'has the correct value for #pre_conversion' do
           builder.pre_conversion.must_equal ['_v1 = GirFFI::InPointer.from(:void, user_data)']
         end
@@ -53,11 +57,17 @@ describe GirFFI::Builders::ArgumentBuilder do
 
       describe 'when it is a closure' do
         before do
-          builder.closure = true
+          callback = Object.new
+          allow(callback).to receive(:call_argument_name).and_return 'foo'
+          builder.closure = callback
+        end
+
+        it 'has the correct value for method_argument_name' do
+          builder.method_argument_name.must_be_nil
         end
 
         it 'has the correct value for #pre_conversion' do
-          builder.pre_conversion.must_equal ['_v1 = GirFFI::InPointer.from_closure_data(user_data)']
+          builder.pre_conversion.must_equal ['_v1 = GirFFI::InPointer.from_closure_data(foo.object_id)']
         end
 
         it 'has the correct value for #post_conversion' do

data/test/gir_ffi/builders/constructor_builder_test.rb

@@ -9,9 +9,9 @@ describe GirFFI::Builders::ConstructorBuilder do
       let(:function_info) { get_method_introspection_data 'Regress', 'TestObj', 'new' }
       it 'builds a constructor' do
         code.must_equal <<-CODE.reset_indentation
-          def self.new(*args)
+          def self.new(*args, &block)
             obj = allocate
-            obj.__send__ :initialize, *args
+            obj.__send__ :initialize, *args, &block
             obj
           end
         CODE
@@ -22,10 +22,10 @@ describe GirFFI::Builders::ConstructorBuilder do
       let(:function_info) { get_method_introspection_data 'Regress', 'TestObj', 'new_from_file' }
       it 'builds a custom constructor' do
         code.must_equal <<-CODE.reset_indentation
-          def self.new_from_file(*args)
+          def self.new_from_file(*args, &block)
             raise NoMethodError unless self == Regress::TestObj
             obj = allocate
-            obj.__send__ :initialize_from_file, *args
+            obj.__send__ :initialize_from_file, *args, &block
             obj
           end
         CODE

data/test/gir_ffi/builders/function_builder_test.rb

@@ -39,10 +39,10 @@ describe GirFFI::Builders::FunctionBuilder do
       let(:function_info) { get_introspection_data 'Regress', 'test_callback_destroy_notify' }
       it 'builds a correct definition' do
         code.must_equal <<-CODE.reset_indentation
-          def self.test_callback_destroy_notify(callback, user_data, notify)
+          def self.test_callback_destroy_notify(&callback)
             _v1 = Regress::TestCallbackUserData.from(callback)
-            _v2 = GirFFI::InPointer.from_closure_data(user_data)
-            _v3 = GLib::DestroyNotify.from(notify)
+            _v2 = GirFFI::InPointer.from_closure_data(_v1.object_id)
+            _v3 = GLib::DestroyNotify.default
             _v4 = Regress::Lib.regress_test_callback_destroy_notify _v1, _v2, _v3
             return _v4
           end
@@ -62,6 +62,49 @@ describe GirFFI::Builders::FunctionBuilder do
       end
     end
 
+    describe 'for functions that return a GValue' do
+      let(:function_info) { get_introspection_data 'GIMarshallingTests', 'gvalue_return' }
+      it 'creates a call to #get_value' do
+        code.must_equal <<-CODE.reset_indentation
+          def self.gvalue_return
+            _v1 = GIMarshallingTests::Lib.gi_marshalling_tests_gvalue_return
+            _v2 = GObject::Value.wrap(_v1).get_value
+            return _v2
+          end
+        CODE
+      end
+    end
+
+    describe 'for functions that have a GValue out argument' do
+      let(:function_info) { get_introspection_data 'GIMarshallingTests', 'gvalue_out' }
+      it 'creates a call to #get_value' do
+        code.must_equal <<-CODE.reset_indentation
+          def self.gvalue_out
+            _v1 = GirFFI::InOutPointer.for [:pointer, GObject::Value]
+            GIMarshallingTests::Lib.gi_marshalling_tests_gvalue_out _v1
+            _v2 = GObject::Value.wrap(_v1.to_value).get_value
+            return _v2
+          end
+        CODE
+      end
+    end
+
+    describe 'for functions that have a caller-allocated GValue out argument' do
+      let(:function_info) { get_introspection_data 'GIMarshallingTests', 'gvalue_out_caller_allocates' }
+
+      it 'creates a call to #get_value' do
+        skip unless function_info
+        code.must_equal <<-CODE.reset_indentation
+          def self.gvalue_out_caller_allocates
+            _v1 = GObject::Value.new
+            GIMarshallingTests::Lib.gi_marshalling_tests_gvalue_out_caller_allocates _v1
+            _v2 = _v1.get_value
+            return _v2
+          end
+        CODE
+      end
+    end
+
     describe 'for functions with a nullable input array' do
       let(:function_info) { get_introspection_data 'Regress', 'test_array_int_null_in' }
       it 'builds correct definition' do

data/test/gir_ffi/builders/object_builder_test.rb

@@ -60,5 +60,30 @@ describe GirFFI::Builders::ObjectBuilder do
     it 'returns the class struct type' do
       obj_builder.object_class_struct.must_equal Regress::TestObjClass
     end
+
+    it 'returns the parent struct type for classes without their own struct' do
+      binding_info = get_introspection_data 'GObject', 'Binding'
+      builder = GirFFI::Builders::ObjectBuilder.new binding_info
+      builder.object_class_struct.must_equal GObject::ObjectClass
+    end
+  end
+
+  # TODO: Improve this spec to use less mocking
+  describe 'for a struct without defined fields' do
+    it 'uses a single field of the parent struct type as the default layout' do
+      @gir = GObjectIntrospection::IRepository.default
+      @gir.require 'GObject', nil
+
+      allow(info = Object.new).to receive(:parent).and_return @gir.find_by_name 'GObject', 'Object'
+      allow(info).to receive(:fields).and_return []
+      allow(info).to receive(:info_type).and_return :object
+      allow(info).to receive(:safe_name).and_return 'Bar'
+      allow(info).to receive(:namespace).and_return 'Foo'
+
+      @classbuilder = GirFFI::Builders::ObjectBuilder.new info
+
+      spec = @classbuilder.send :layout_specification
+      assert_equal [:parent, GObject::Object::Struct, 0], spec
+    end
   end
 end

data/test/gir_ffi/builders/property_builder_test.rb

@@ -8,7 +8,7 @@ describe GirFFI::Builders::PropertyBuilder do
     it 'generates the correct getter definition' do
       expected = <<-CODE.reset_indentation
       def list
-        _v1 = get_property("list").get_value_plain
+        _v1 = get_property("list")
         _v2 = GLib::List.wrap(:utf8, _v1)
         _v2
       end
@@ -34,7 +34,7 @@ describe GirFFI::Builders::PropertyBuilder do
     it 'generates the correct getter definition' do
       expected = <<-CODE.reset_indentation
       def hash_table
-        _v1 = get_property("hash-table").get_value_plain
+        _v1 = get_property("hash-table")
         _v2 = GLib::HashTable.wrap([:utf8, :gint8], _v1)
         _v2
       end
@@ -68,7 +68,7 @@ describe GirFFI::Builders::PropertyBuilder do
     it 'generates the correct getter definition' do
       expected = <<-CODE.reset_indentation
       def some_strv
-        get_property("some-strv").get_value
+        get_property("some-strv")
       end
       CODE
 
@@ -92,7 +92,7 @@ describe GirFFI::Builders::PropertyBuilder do
     it 'generates the correct getter definition' do
       expected = <<-CODE.reset_indentation
       def string
-        get_property("string").get_value
+        get_property("string")
       end
       CODE
 

data/test/gir_ffi/builders/struct_builder_test.rb

@@ -46,21 +46,23 @@ describe GirFFI::Builders::StructBuilder do
     end
   end
 
-  describe 'for a struct without defined fields' do
-    it 'uses a single field of the parent struct type as the default layout' do
-      @gir = GObjectIntrospection::IRepository.default
-      @gir.require 'GObject', nil
-
-      allow(info = Object.new).to receive(:parent).and_return @gir.find_by_name 'GObject', 'Object'
-      allow(info).to receive(:fields).and_return []
-      allow(info).to receive(:info_type).and_return :object
-      allow(info).to receive(:safe_name).and_return 'Bar'
-      allow(info).to receive(:namespace).and_return 'Foo'
+  describe '#superclass' do
+    it 'returns StructBase for a normal struct' do
+      info = get_introspection_data 'Regress', 'TestStructA'
+      builder = GirFFI::Builders::StructBuilder.new info
+      builder.superclass.must_equal GirFFI::StructBase
+    end
 
-      @classbuilder = GirFFI::Builders::ObjectBuilder.new info
+    it 'returns the GObject parent class for a type class' do
+      info = get_introspection_data 'GIMarshallingTests', 'SubSubObjectClass'
+      builder = GirFFI::Builders::StructBuilder.new info
+      builder.superclass.must_equal GIMarshallingTests::SubObjectClass
+    end
 
-      spec = @classbuilder.send :layout_specification
-      assert_equal [:parent, GObject::Object::Struct, 0], spec
+    it 'returns ObjectClass for InitiallyUnownedClass' do
+      info = get_introspection_data 'GObject', 'InitiallyUnownedClass'
+      builder = GirFFI::Builders::StructBuilder.new info
+      builder.superclass.must_equal GObject::ObjectClass
     end
   end
 end

data/test/gir_ffi/builders/unintrospectable_boxed_builder_test.rb

@@ -0,0 +1,33 @@
+require 'gir_ffi_test_helper'
+
+GirFFI.setup :GIMarshallingTests
+
+describe GirFFI::Builders::UnintrospectableBoxedBuilder do
+  let(:instance) { GIMarshallingTests::PropertiesObject.new }
+  let(:property) { instance.object_class.find_property 'some-boxed-glist' }
+  let(:gtype) { property.value_type }
+  let(:info) { GirFFI::UnintrospectableBoxedInfo.new(gtype) }
+  let(:bldr) { GirFFI::Builders::UnintrospectableBoxedBuilder.new(info) }
+  let(:klass) { bldr.build_class }
+
+  before do
+    skip unless get_property_introspection_data('GIMarshallingTests',
+                                                'PropertiesObject',
+                                                'some-boxed-glist')
+  end
+
+  it 'builds a class' do
+    klass.must_be_instance_of Class
+  end
+
+  it 'builds a class derived from GirFFI::BoxedBase' do
+    klass.ancestors.must_include GirFFI::BoxedBase
+  end
+
+  it 'returns the same class when built again' do
+    other_bldr = GirFFI::Builders::UnintrospectableBoxedBuilder.new(info)
+    other_klass = other_bldr.build_class
+
+    other_klass.must_equal klass
+  end
+end

data/test/gir_ffi/builders/unintrospectable_builder_test.rb

@@ -52,5 +52,11 @@ describe GirFFI::Builders::UnintrospectableBuilder do
         signal.name.must_equal 'notify'
       end
     end
+
+    describe '#object_class_struct' do
+      it 'returns the parent class struct' do
+        @bldr.object_class_struct.must_equal GObject::ObjectClass
+      end
+    end
   end
 end

data/test/gir_ffi/builders/user_defined_builder_test.rb

@@ -44,7 +44,7 @@ describe GirFFI::Builders::UserDefinedBuilder do
       it 'makes the property retrievable using #get_property' do
         obj = klass.new
         obj.foo = 13
-        obj.get_property('foo').get_value.must_equal 13
+        obj.get_property('foo').must_equal 13
       end
 
       it 'makes the property settable using #set_property' do
@@ -121,4 +121,10 @@ describe GirFFI::Builders::UserDefinedBuilder do
       GObject.type_from_instance(obj).must_equal klass.gtype
     end
   end
+
+  describe '#object_class_struct' do
+    it 'returns the parent class struct' do
+      builder.object_class_struct.must_equal GIMarshallingTests::ObjectClass
+    end
+  end
 end

data/test/gir_ffi/callback_base_test.rb

@@ -3,8 +3,18 @@ require 'gir_ffi_test_helper'
 describe GirFFI::CallbackBase do
   describe '.store_callback' do
     it 'stores the passed in proc in CALLBACKS' do
-      GirFFI::CallbackBase.store_callback 'some-callback'
-      GirFFI::CallbackBase::CALLBACKS.last.must_equal 'some-callback'
+      dummy_proc = 'some-callback'
+      GirFFI::CallbackBase.store_callback dummy_proc
+      GirFFI::CallbackBase::CALLBACKS[dummy_proc.object_id].must_equal dummy_proc
+    end
+  end
+
+  describe '.drop_callback' do
+    it 'removes the corresponding proc from CALLBACKS' do
+      dummy_proc = 'some-callback'
+      GirFFI::CallbackBase.store_callback dummy_proc
+      GirFFI::CallbackBase.drop_callback dummy_proc.object_id
+      GirFFI::CallbackBase::CALLBACKS[dummy_proc.object_id].must_be_nil
     end
   end
 end

data/test/gir_ffi/object_base_test.rb

@@ -1,5 +1,7 @@
 require 'gir_ffi_test_helper'
 
+GirFFI.setup :Regress
+
 describe GirFFI::ObjectBase do
   let(:derived_class) { Class.new GirFFI::ObjectBase }
 
@@ -15,4 +17,16 @@ describe GirFFI::ObjectBase do
       derived_class.to_ffi_type.must_equal derived_class
     end
   end
+
+  describe '.object_class' do
+    it 'returns an object of the class struct type' do
+      Regress::TestObj.object_class.must_be_instance_of Regress::TestObjClass
+    end
+
+    it 'caches its result' do
+      first = Regress::TestObj.object_class
+      second = Regress::TestObj.object_class
+      second.must_be :eql?, first
+    end
+  end
 end

data/test/integration/callback_exceptions_test.rb

@@ -0,0 +1,61 @@
+require 'gir_ffi_test_helper'
+
+GirFFI.setup :Regress
+
+class CallbackTestException < RuntimeError; end
+
+describe 'An exception in a callback' do
+  describe 'for signals' do
+    let(:object) { Regress::TestSubObj.new }
+
+    before do
+      object.signal_connect 'test' do
+        raise CallbackTestException, 'Boom'
+      end
+    end
+
+    describe 'when the signal is emitted synchronously' do
+      it 'raises an error' do
+        proc { GObject.signal_emit object, 'test' }.must_raise CallbackTestException
+      end
+    end
+
+    describe 'when the signal is emitted during an event loop' do
+      it 'causes loop run to be terminated with an exception' do
+        main_loop = GLib::MainLoop.new nil, false
+
+        GLib.timeout_add GLib::PRIORITY_DEFAULT, 1 do
+          GObject.signal_emit object, 'test'
+          false
+        end
+        # Guard against runaway loop
+        GLib.timeout_add GLib::PRIORITY_DEFAULT, 500 do
+          main_loop.quit
+        end
+        proc do
+          main_loop.run
+        end.must_raise CallbackTestException
+      end
+    end
+  end
+
+  describe 'for other callbacks' do
+    describe 'when the callback occurs during an event loop' do
+      it 'causes loop run to be terminated with an exception' do
+        main_loop = GLib::MainLoop.new nil, false
+
+        GLib.timeout_add GLib::PRIORITY_DEFAULT, 1 do
+          raise CallbackTestException, 'Boom'
+        end
+        # Guard against runaway loop
+        GLib.timeout_add GLib::PRIORITY_DEFAULT, 500 do
+          main_loop.quit
+        end
+
+        proc do
+          main_loop.run
+        end.must_raise CallbackTestException
+      end
+    end
+  end
+end