gir_ffi 0.2.3 → 0.3.0

data/test/integration/pretty_print_test.rb

@@ -7,10 +7,12 @@ GirFFI.setup :Regress
 describe "Pretty-printing" do
   def assert_syntax_ok str
     tmp = Tempfile.new "gir_ffi"
+    # TODO: Make #pretty_print add this preamble.
+    tmp.write "# coding: utf-8\n"
     tmp.write str
     tmp.flush
     is_ok = `ruby -c #{tmp.path} 2>&1`
-    assert_equal "Syntax OK\n", is_ok
+    is_ok.must_match(/^Syntax OK/)
   end
 
   describe "for the Regress module" do

data/test/test_helper.rb

@@ -4,6 +4,11 @@ if RUBY_PLATFORM == 'java'
   require 'rubygems'
 end
 
+if RUBY_VERSION >= "1.9" and ENV["SIMPLECOV"]
+  require 'simplecov'
+  SimpleCov.start
+end
+
 require 'minitest/spec'
 require 'minitest/autorun'
 require 'rr'

data/test/type_builder_test.rb

@@ -1,26 +1,9 @@
 require File.expand_path('gir_ffi_test_helper.rb', File.dirname(__FILE__))
 
+require 'ffi-gtk3'
+
 class TypeBuilderTest < MiniTest::Spec
   context "The Builder::Type class" do
-    context "for Gtk::Widget" do
-      setup do
-	@cbuilder = GirFFI::Builder::Type::Object.new get_introspection_data('Gtk', 'Widget')
-      end
-
-      context "looking at Gtk::Widget#show" do
-	setup do
-	  @go = get_method_introspection_data 'Gtk', 'Widget', 'show'
-	end
-
-	should "delegate definition to Builder::Function" do
-	  code = @cbuilder.send :function_definition, @go
-	  expected = GirFFI::Builder::Function.new(@go, Gtk::Lib).generate
-	  assert_equal cws(expected), cws(code)
-	end
-
-      end
-    end
-
     context 'the find_signal method' do
       should 'find the signal "test" for TestObj' do
 	builder = GirFFI::Builder::Type::Object.new get_introspection_data('Regress', 'TestObj')

data/test/unit/arg_helper_test.rb

@@ -2,18 +2,104 @@ require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
 
 describe GirFFI::ArgHelper do
   describe "::ptr_to_typed_array" do
-    describe "for pointers to class types" do
+    describe "for pointers to arrays of pointers to class types" do
       it "reads an array of pointers and wraps each in the class" do
         c = Class.new do
           def self.wrap a; "wrapped: #{a}"; end
         end
 
         mock(ptr = Object.new).read_array_of_pointer(2) { [:a, :b] }
+        mock(ptr).null? { false }
 
         result = GirFFI::ArgHelper.ptr_to_typed_array [:pointer, c], ptr, 2
 
         assert_equal ["wrapped: a", "wrapped: b"], result
       end
+
+      it "returns an empty array when passed a null pointer" do
+        result = GirFFI::ArgHelper.ptr_to_typed_array [:pointer, Class.new], FFI::Pointer.new(0), 42
+        result.must_equal []
+      end
+
+      it "returns an empty array when passed nil" do
+        result = GirFFI::ArgHelper.ptr_to_typed_array [:pointer, Class.new], nil, 42
+        result.must_equal []
+      end
+    end
+
+    describe "for pointers to arrays of class types" do
+      it "returns an empty array when passed a null pointer" do
+        result = GirFFI::ArgHelper.ptr_to_typed_array Class.new, FFI::Pointer.new(0), 42
+        result.must_equal []
+      end
+
+      it "returns an empty array when passed nil" do
+        result = GirFFI::ArgHelper.ptr_to_typed_array Class.new, nil, 42
+        result.must_equal []
+      end
+    end
+
+    describe "for pointers to string arrays" do
+      it "returns an empty array when passed a null pointer" do
+        result = GirFFI::ArgHelper.ptr_to_typed_array :utf8, FFI::Pointer.new(0), 42
+        result.must_equal []
+      end
+
+      it "returns an empty array when passed nil" do
+        result = GirFFI::ArgHelper.ptr_to_typed_array :utf8, nil, 42
+        result.must_equal []
+      end
+    end
+
+    describe "for pointers to arrays of base types" do
+      it "returns an empty array when passed a null pointer" do
+        result = GirFFI::ArgHelper.ptr_to_typed_array :gint32, FFI::Pointer.new(0), 0
+        result.must_equal []
+      end
+
+      it "returns an empty array when passed nil" do
+        result = GirFFI::ArgHelper.ptr_to_typed_array :gint32, nil, 0
+        result.must_equal []
+      end
+    end
+  end
+
+  describe "#object_to_inptr" do
+    describe "when called with an object implementing to_ptr" do
+      it "returns the result of to_ptr" do
+	obj = Object.new
+	def obj.to_ptr; :test_value; end
+	assert_equal :test_value, GirFFI::ArgHelper.object_to_inptr(obj)
+      end
+    end
+
+    describe "when called with nil" do
+      it "returns nil" do
+	assert_equal nil, GirFFI::ArgHelper.object_to_inptr(nil)
+      end
+    end
+
+    describe "when called with a string" do
+      it "stores the string in GirFFI::ArgHelper::OBJECT_STORE" do
+        str = "Foo"
+        ptr = GirFFI::ArgHelper.object_to_inptr(str)
+        result = GirFFI::ArgHelper::OBJECT_STORE[ptr.address]
+        result.must_equal str
+      end
+    end
+  end
+
+  describe "::object_pointer_to_object" do
+    it "finds the wrapping class by gtype and wraps the pointer in it" do
+      klsptr = GirFFI::InOutPointer.from :gtype, 0xdeadbeef
+      objptr = GirFFI::InOutPointer.from :pointer, klsptr
+
+      object_class = Class.new
+      mock(GirFFI::Builder).build_by_gtype(0xdeadbeef) { object_class }
+      mock(object_class).wrap(objptr) { "good-result" }
+
+      r = GirFFI::ArgHelper.object_pointer_to_object objptr
+      assert_equal "good-result", r
     end
   end
 end

data/test/unit/builder_test.rb

@@ -3,7 +3,7 @@ require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
 describe GirFFI::Builder do
   describe "::itypeinfo_to_callback_ffitype" do
     describe "for an :interface argument" do
-      setup do
+      before do
         @iface = Object.new
         stub(@info = Object.new).interface { @iface }
         stub(@info).tag { :interface }
@@ -27,5 +27,117 @@ describe GirFFI::Builder do
       end
     end
   end
+
+  describe "building Regress::TestSubObj" do
+    before do
+      save_module :Regress
+      save_module :GObject
+      GirFFI::Builder.build_class get_introspection_data('Regress', 'TestSubObj')
+    end
+
+    it "builds Regress namespace" do
+      assert Regress.const_defined? :Lib
+      assert Regress.respond_to? :method_missing
+    end
+
+    it "builds parent classes also" do
+      assert Regress.const_defined? :TestObj
+      assert Object.const_defined? :GObject
+      assert GObject.const_defined? :Object
+    end
+
+    it "sets up the inheritance chain" do
+      ancestors = Regress::TestSubObj.ancestors
+      assert_equal [
+        Regress::TestSubObj,
+        Regress::TestObj,
+        GObject::Object
+      ], ancestors[0..2]
+    end
+
+    it "creates a Regress::TestSubObj#to_ptr method" do
+      assert Regress::TestSubObj.public_method_defined? :to_ptr
+    end
+
+    after do
+      restore_module :Regress
+      restore_module :GObject
+    end
+  end
+
+  describe "building Regress" do
+    before do
+      save_module :Regress
+      GirFFI::Builder.build_module 'Regress'
+    end
+
+    it "creates a Lib module ready to attach functions from the shared library" do
+      gir = GObjectIntrospection::IRepository.default
+      expected = [gir.shared_library('Regress')]
+      assert_equal expected, Regress::Lib.ffi_libraries.map(&:name)
+    end
+
+    it "creates an array CALLBACKS inside the Regress::Lib module" do
+      assert_equal [], Regress::Lib::CALLBACKS
+    end
+
+    it "does not replace existing module" do
+      oldmodule = Regress
+      GirFFI::Builder.build_module 'Regress'
+      assert_equal oldmodule, Regress
+    end
+
+    it "does not replace existing Lib module" do
+      oldmodule = Regress::Lib
+      GirFFI::Builder.build_module 'Regress'
+      assert_equal oldmodule, Regress::Lib
+    end
+
+    after do
+      restore_module :Regress
+    end
+  end
+
+  describe "looking at Regress.test_array_gint32_in" do
+    setup do
+      save_module :Regress
+      GirFFI::Builder.build_module 'Regress'
+      @go = get_introspection_data 'Regress', 'test_array_gint32_in'
+    end
+
+    it "has correct introspection data" do
+      gir = GObjectIntrospection::IRepository.default
+      gir.require "Regress", nil
+      go2 = gir.find_by_name "Regress", "test_array_gint32_in"
+      assert_equal go2, @go
+    end
+
+    it "attaches function to Regress::Lib" do
+      GirFFI::Builder.send :attach_ffi_function, Regress::Lib, @go
+      assert_defines_singleton_method Regress::Lib, :regress_test_array_gint32_in
+    end
+
+    it "has :pointer, :pointer as types of the arguments for the attached function" do
+      assert_equal [:int32, :pointer], GirFFI::Builder.send(:ffi_function_argument_types, @go)
+    end
+
+    it "has :void as return type for the attached function" do
+      assert_equal :int32, GirFFI::Builder.send(:ffi_function_return_type, @go)
+    end
+
+    after do
+      restore_module :Regress
+    end
+  end
+
+  describe "looking at Regress::TestObj#instance_method" do
+    setup do
+      @go = get_method_introspection_data 'Regress', 'TestObj', 'instance_method'
+    end
+
+    it "has :pointer as types of the arguments for the attached function" do
+      assert_equal [:pointer], GirFFI::Builder.send(:ffi_function_argument_types, @go)
+    end
+  end
 end
 

data/test/unit/function_builder_test.rb

@@ -13,6 +13,7 @@ describe GirFFI::Builder::Function do
 
   it "builds a correct definition of Regress:test_array_fixed_out_objects" do
     go = get_introspection_data 'Regress', 'test_array_fixed_out_objects'
+    skip unless go
     fbuilder = GirFFI::Builder::Function.new go, DummyLib
     code = fbuilder.generate
 
@@ -23,7 +24,7 @@ describe GirFFI::Builder::Function do
         _v2 = _v1.to_sized_array_value 2
         return _v2
       end
-      CODE
+    CODE
 
     assert_equal expected.reset_indentation, code
   end
@@ -159,14 +160,14 @@ describe GirFFI::Builder::Function do
   end
 
   it "builds a correct definition for a simple method" do
-    go = get_method_introspection_data 'Gtk', 'Widget', 'show'
+    go = get_method_introspection_data 'Regress', 'TestObj', 'instance_method'
     fbuilder = GirFFI::Builder::Function.new go, DummyLib
     code = fbuilder.generate
 
     expected = <<-CODE
-      def show 
-        DummyLib.gtk_widget_show self
-        
+      def instance_method 
+        _v1 = DummyLib.regress_test_obj_instance_method self
+        return _v1
       end
     CODE
 

data/test/unit/gir_ffi_test.rb

@@ -0,0 +1,69 @@
+require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
+
+GirFFI.setup :GIMarshallingTests
+
+describe GirFFI do
+  describe "::define_type" do
+    describe "without a block" do
+      before do
+        @klass = Class.new GIMarshallingTests::OverridesObject
+        Object.const_set "Derived#{Sequence.next}", @klass
+        @gtype = GirFFI.define_type @klass
+      end
+
+      it "returns a GType for the derived class" do
+        parent_gtype = GIMarshallingTests::OverridesObject.get_gtype
+        @gtype.wont_equal parent_gtype
+        GObject.type_name(@gtype).must_equal @klass.name
+      end
+
+      it "makes #get_gtype on the registered class return the new GType" do
+        @klass.get_gtype.must_equal @gtype
+      end
+
+      it "registers a type with the same size as the parent" do
+        q = GObject.type_query @gtype
+        q.instance_size.must_equal GIMarshallingTests::OverridesObject::Struct.size
+      end
+
+      it "creates a struct class for the derived class with just one member" do
+        @klass::Struct.members.must_equal [:parent]
+      end
+
+      it "allows the new class to be instantiated" do
+        obj = @klass.new
+        type = GObject.type_from_instance obj
+        type.must_equal @gtype
+      end
+    end
+
+    describe "with a block with a call to #install_property" do
+      before do
+        @klass = Class.new GIMarshallingTests::OverridesObject
+        Object.const_set "Derived#{Sequence.next}", @klass
+        @gtype = GirFFI.define_type @klass do
+          install_property GObject.param_spec_int("foo", "foo bar",
+                                                  "The Foo Bar Property",
+                                                  10, 20, 15,
+                                                  3)
+        end
+      end
+
+      it "registers a type that is bigger than the parent" do
+        q = GObject.type_query @gtype
+        q.instance_size.must_be :>, GIMarshallingTests::OverridesObject::Struct.size
+      end
+
+      it "gives the types Struct the fields :parent and :foo" do
+        @klass::Struct.members.must_equal [:parent, :foo]
+      end
+
+      it "creates accessor functions for the property" do
+        obj = @klass.new
+        obj.foo = 13
+        obj.foo.must_equal 13
+      end
+    end
+  end
+end
+

data/test/unit/in_out_pointer_test.rb

@@ -4,7 +4,7 @@ require 'gir_ffi/in_out_pointer'
 
 describe GirFFI::InOutPointer do
   describe "an instance created with .from" do
-    setup do
+    before do
       @result = GirFFI::InOutPointer.from :gint32, 23
     end
 
@@ -28,7 +28,7 @@ describe GirFFI::InOutPointer do
   end
 
   describe "an instance created with .from_array" do
-    setup do
+    before do
       @result = GirFFI::InOutPointer.from_array :gint32, [24, 13]
     end
 
@@ -67,7 +67,7 @@ describe GirFFI::InOutPointer do
   end
 
   describe "in instance created with .for" do
-    setup do
+    before do
       @result = GirFFI::InOutPointer.for :gint32
     end
 

data/test/unit/in_pointer_test.rb

@@ -19,7 +19,7 @@ describe GirFFI::InPointer do
   end
 
   describe "an instance created with .from_array" do
-    setup do
+    before do
       @result = GirFFI::InPointer.from_array :gint32, [24, 13]
     end
 

data/test/unit/interface_builder_test.rb

@@ -11,6 +11,22 @@ describe GirFFI::Builder::Type::Interface do
       assert_equal "module Bar\n  extend InterfaceBase\nend", builder.pretty_print
     end
   end
+
+  describe "#build_class" do
+    before do
+      info = get_introspection_data 'GObject', 'TypePlugin'
+      @bldr = GirFFI::Builder::Type::Interface.new info
+      @iface = @bldr.build_class
+    end
+
+    it "builds an interface as a module" do
+      assert_instance_of Module, @iface
+    end
+
+    it "creates methods on the interface" do
+      assert_defines_instance_method @iface, :complete_interface_info
+    end
+  end
 end
 
 

data/test/unit/object_type_builder_test.rb

@@ -24,4 +24,19 @@ describe GirFFI::Builder::Type::Object do
       end
     end
   end
+
+  describe "#function_definition" do
+    before do
+      @cbuilder = GirFFI::Builder::Type::Object.new get_introspection_data('Regress', 'TestObj')
+      @go = get_method_introspection_data 'Regress', 'TestObj', 'instance_method'
+    end
+
+    it "delegates definition to Builder::Function" do
+      code = @cbuilder.send :function_definition, @go
+      expected = GirFFI::Builder::Function.new(@go, Regress::Lib).generate
+      assert_equal cws(expected), cws(code)
+    end
+
+  end
+
 end

data/test/unit/struct_builder_test.rb

@@ -75,11 +75,15 @@ describe GirFFI::Builder::Type::Struct do
       stub(GirFFI::Builder).build_module('Foo') { m }
 
       c = Class.new
+      c::Struct = Class.new
 
       refute c.method_defined?(:bar)
       refute c.method_defined?(:bar=)
 
-      @builder.instance_eval { @klass = c }
+      @builder.instance_eval {
+        @klass = c
+        @structklass = c::Struct
+      }
       @builder.send :setup_field_accessors
 
       assert c.method_defined?(:bar)

data/test/{unintrospectable_type_builder_test.rb → unit/unintrospectable_type_builder_test.rb}

@@ -1,4 +1,4 @@
-require File.expand_path('gir_ffi_test_helper.rb', File.dirname(__FILE__))
+require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
 
 describe GirFFI::Builder::Type::Unintrospectable do
   describe "building the GLocalFile type" do
@@ -47,4 +47,21 @@ describe GirFFI::Builder::Type::Unintrospectable do
       end
     end
   end
+
+  # FIXME: Testing a private method, and with rather a lot of
+  # mocking, too.
+  describe "#interfaces" do
+    it "skips interfaces that have no introspection data" do
+      bldr = GirFFI::Builder::Type::Unintrospectable.new(:some_type)
+
+      mock(bldr).interface_gtypes { [:foo, :bar ] }
+      mock(gir = Object.new).find_by_gtype(:foo) { :foo_info }
+      mock(gir).find_by_gtype(:bar) { nil }
+      bldr.instance_eval { @gir = gir }
+      mock(GirFFI::Builder).build_class(:foo_info) { :foo_module }
+
+      result = bldr.send :interfaces
+      result.must_equal [:foo_module]
+    end
+  end
 end

data/test/unit/user_defined_object_info_test.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
+
+describe GirFFI::UserDefined::IObjectInfo do
+  it "has the attribute #properties" do
+    inf = GirFFI::UserDefined::IObjectInfo.new
+    inf.properties.must_equal []
+    inf.properties << :foo
+    inf.properties.must_equal [:foo]
+    inf.properties = [:bar, :baz]
+    inf.properties.must_equal [:bar, :baz]
+  end
+
+  it "derives from GirFFI::UserDefined::IRegisteredTypeInfo" do
+    inf = GirFFI::UserDefined::IObjectInfo.new
+    inf.must_be_kind_of GirFFI::UserDefined::IRegisteredTypeInfo
+  end
+end
+

data/test/unit/user_defined_property_info_test.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
+
+describe GirFFI::UserDefined::IPropertyInfo do
+  it "has the attribute #property_type" do
+    inf = GirFFI::UserDefined::IPropertyInfo.new
+    inf.property_type = :foo
+    inf.property_type.must_equal :foo
+  end
+
+  it "derives from GirFFI::UserDefined::IBaseInfo" do
+    inf = GirFFI::UserDefined::IPropertyInfo.new
+    inf.must_be_kind_of GirFFI::UserDefined::IBaseInfo
+  end
+end

data/test/unit/user_defined_registered_type_info_test.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
+
+describe GirFFI::UserDefined::IRegisteredTypeInfo do
+  it "derives from GirFFI::UserDefined::IBaseInfo" do
+    inf = GirFFI::UserDefined::IRegisteredTypeInfo.new
+    inf.must_be_kind_of GirFFI::UserDefined::IBaseInfo
+  end
+end
+
+

data/test/unit/user_defined_type_builder_test.rb

@@ -0,0 +1,41 @@
+require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
+
+describe GirFFI::Builder::Type::UserDefined do
+  describe "with a block with a call to #install_property" do
+    before do
+      @klass = Class.new GIMarshallingTests::OverridesObject
+      Object.const_set "Derived#{Sequence.next}", @klass
+      @builder = GirFFI::Builder::Type::UserDefined.new @klass do
+        install_property GObject.param_spec_int("foo", "foo bar",
+                                                "The Foo Bar Property",
+                                                10, 20, 15,
+                                                3)
+      end
+      @builder.build_class
+    end
+
+    it "has one property of type GirFFI::UserDefined::IPropertyInfo" do
+      props = @builder.send(:properties)
+      props.length.must_equal 1
+      props[0].must_be_instance_of GirFFI::UserDefined::IPropertyInfo
+    end
+
+    describe "the info attribute" do
+      before do
+        @info = @builder.info
+      end
+
+      it "is an object of type GirFFI::UserDefined::IObjectInfo" do
+        @info.must_be_instance_of GirFFI::UserDefined::IObjectInfo
+      end
+
+      it "knows about the single property :foo" do
+        props = @info.properties
+        props.length.must_equal 1
+        foo_property = props[0]
+        foo_property.must_be_instance_of GirFFI::UserDefined::IPropertyInfo
+        foo_property.name.must_equal "foo"
+      end
+    end
+  end
+end