gir_ffi 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4030d6c4cfb00268801490cc1bb1ea0fcecfd533
-  data.tar.gz: 36be619abbb6889c67c7ab2726c6eaa3708f7946
+  metadata.gz: 8cf0a7c44fc03dbe6b94889b4f2d9fb4d0ffd3d4
+  data.tar.gz: 125f3d704a2d1dbf911503efd0ee15b7b520b96f
 SHA512:
-  metadata.gz: ae9124773e81ce3c8ce21882fa164296f40c06d14c3032f57b121a4026967fb0e6e210d60dacaa171f21997f34a19855e407ed425c7fba0d1d2dbc47fa47e4e9
-  data.tar.gz: 0b647b4e8bec822e25f96a249efc0ea0ce4b9177b17de87d18d3f17f384d5f70480f7986ff920697a6e06709b752d0407ed3d88f485b43a290081e2ffecee01e
+  metadata.gz: c8701346e6ed89cac5567fff4c564c536debc9a64f0cd91f1c61792e363265f84ab385c8a410fb52acb65ecbfab105fa085f39e4a10e20534388e7e5fe5e7fac
+  data.tar.gz: 922d806dd05c7e353fb5e382ab04ae982abc7fe96bb470a855d937ef273b524d1ecd3d6a9346480c23cb28f56bb7137697370bb2af179a1e91b7946c7654e87b

data/Changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.7.1 / 2014-01-17
+
+* Handle method setup for methods with unsafe names (i.e., g_iconv())
+* Add override for GLib::IConv.open
+
+# Changelog
+
 ## 0.7.0 / 2014-01-11
 
 * Type handling:

data/lib/ffi-glib/iconv.rb

@@ -0,0 +1,14 @@
+module GLib
+  load_class :IConv
+
+  # Overrides for IConv
+  class IConv
+    def self.open(to_codeset, from_codeset)
+      to_ptr = GirFFI::InPointer.from(:utf8, to_codeset)
+      from_ptr = GirFFI::InPointer.from(:utf8, from_codeset)
+      result_ptr = Lib.g_iconv_open(to_ptr, from_ptr)
+      wrap(result_ptr)
+    end
+  end
+end
+

data/lib/ffi-glib.rb

@@ -6,6 +6,7 @@ GirFFI.setup :GLib
 require 'ffi-glib/array'
 require 'ffi-glib/byte_array'
 require 'ffi-glib/hash_table'
+require 'ffi-glib/iconv'
 require 'ffi-glib/list'
 require 'ffi-glib/ptr_array'
 require 'ffi-glib/s_list'
@@ -37,5 +38,7 @@ module GLib
     attach_function :g_ptr_array_new, [], :pointer
     attach_function :g_ptr_array_add, [:pointer, :pointer], :void
     attach_function :g_ptr_array_foreach, [:pointer, Func, :pointer], :pointer
+
+    attach_function :g_iconv_open, [:pointer, :pointer], :pointer
   end
 end

data/lib/ffi-gobject_introspection/i_function_info.rb

@@ -1,6 +1,6 @@
 module GObjectIntrospection
-  # Wraps a GIFunctioInfo struct.
-  # Represents a function.
+  # Wraps a GIFunctionInfo struct.
+  # Represents a function or method.
   class IFunctionInfo < ICallableInfo
     def symbol
       Lib.g_function_info_get_symbol @gobj

data/lib/gir_ffi/builders/with_methods.rb

@@ -27,11 +27,12 @@ module GirFFI
       end
 
       def attach_and_define_method method, go, modul
-        return false if go.nil?
+        return unless go
+        method = go.safe_name
         Builder.attach_ffi_function lib, go
-        modul.class_eval { remove_method method }
+        modul.class_eval { remove_method method if method_defined? method }
         build_class.class_eval function_definition(go)
-        true
+        return method
       end
 
       def stub_methods

data/lib/gir_ffi/class_base.rb

@@ -14,16 +14,13 @@ module GirFFI
     GIR_FFI_BUILDER = NullBuilder.new
 
     def setup_and_call method, *arguments, &block
-      result = self.class.ancestors.any? do |klass|
-        klass.respond_to?(:setup_instance_method) &&
-          klass.setup_instance_method(method.to_s)
-      end
+      method_name = self.class.try_in_ancestors(:setup_instance_method, method.to_s)
 
-      unless result
-        raise RuntimeError, "Unable to set up instance method #{method} in #{self}"
+      unless method_name
+        raise RuntimeError, "Unable to set up instance method '#{method}' in #{self}"
       end
 
-      self.send method, *arguments, &block
+      self.send method_name, *arguments, &block
     end
 
     if RUBY_PLATFORM == 'java'
@@ -39,16 +36,23 @@ module GirFFI
     end
 
     def self.setup_and_call method, *arguments, &block
-      result = self.ancestors.any? do |klass|
-        klass.respond_to?(:setup_method) &&
-          klass.setup_method(method.to_s)
-      end
+      method_name = self.try_in_ancestors(:setup_method, method.to_s)
 
-      unless result
-        raise RuntimeError, "Unable to set up method #{method} in #{self}"
+      unless method_name
+        raise RuntimeError, "Unable to set up method '#{method}' in #{self}"
       end
 
-      self.send method, *arguments, &block
+      self.send method_name, *arguments, &block
+    end
+
+    def self.try_in_ancestors(method, *arguments)
+      self.ancestors.each do |klass|
+        if klass.respond_to?(method)
+          result = klass.send(method, *arguments)
+          return result if result
+        end
+      end
+      return
     end
 
     class << self

data/lib/gir_ffi/method_stubber.rb

@@ -7,12 +7,11 @@ module GirFFI
     end
 
     def method_stub
-      symbol = @info.name
-      "
-        def #{@info.method? ? '' : 'self.'}#{symbol} *args, &block
-          setup_and_call :#{symbol}, *args, &block
+      <<-STUB.reset_indentation
+        def #{@info.method? ? '' : 'self.'}#{@info.safe_name} *args, &block
+          setup_and_call #{@info.name.to_sym.inspect}, *args, &block
         end
-      "
+      STUB
     end
   end
 end

data/lib/gir_ffi/version.rb

@@ -1,3 +1,3 @@
 module GirFFI
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/test/ffi-glib/iconv_test.rb

@@ -0,0 +1,18 @@
+require 'gir_ffi_test_helper'
+
+describe GLib::IConv do
+  describe ".open" do
+    it "creates a new instance of GLib::Iconv" do
+      instance = GLib::IConv.open("ascii", "utf-8")
+      instance.must_be_instance_of GLib::IConv
+    end
+  end
+
+  let(:instance) { GLib::IConv.open("ascii", "utf-8") }
+
+  describe "#setup_and_call" do
+    it "works for the method called ''" do
+      instance.setup_and_call :'', nil, nil, nil, nil
+    end
+  end
+end

data/test/gir_ffi/builders/union_builder_test.rb

@@ -5,8 +5,8 @@ describe GirFFI::Builders::UnionBuilder do
   let(:builder) { GirFFI::Builders::UnionBuilder.new union_info }
 
   describe "#setup_instance_method" do
-    it "returns false looking for a method that doesn't exist" do
-      builder.setup_instance_method('blub').must_equal false
+    it "returns nil looking for a method that doesn't exist" do
+      builder.setup_instance_method('blub').must_be_nil
     end
   end
 

data/test/gir_ffi/builders/with_methods_test.rb

@@ -0,0 +1,30 @@
+require 'gir_ffi_test_helper'
+
+GirFFI.setup :Regress
+
+describe GirFFI::Builders::WithMethods do
+  describe "#setup_instance_method" do
+    it "restores a method that was removed" do
+      Regress::TestObj.class_eval { remove_method "instance_method" }
+
+      builder = Regress::TestObj.gir_ffi_builder
+
+      builder.setup_instance_method "instance_method"
+
+      obj = Regress::TestObj.constructor
+      obj.must_respond_to "instance_method"
+    end
+
+    it "returns the name of the generated method" do
+      builder = Regress::TestObj.gir_ffi_builder
+      result = builder.setup_instance_method "instance_method"
+      result.must_equal "instance_method"
+    end
+
+    it "returns the name of the generated method if different from the info name" do
+      builder = GLib::IConv.gir_ffi_builder
+      result = builder.setup_instance_method ""
+      result.must_equal "_"
+    end
+  end
+end

data/test/gir_ffi/class_base_test.rb

@@ -70,13 +70,13 @@ describe GirFFI::ClassBase do
     end
   end
 
-  describe "a descendant with multiple builders" do
+  describe ".setup_and_call" do
     it "looks up class methods in all builders" do
-      mock(builder = Object.new).setup_method("foo") { true }
+      mock(builder = Object.new).setup_method("foo") { "foo" }
       klass = Class.new GirFFI::ClassBase
       klass.const_set :GIR_FFI_BUILDER, builder
 
-      mock(sub_builder = Object.new).setup_method("foo") { false }
+      mock(sub_builder = Object.new).setup_method("foo") { nil }
       sub_klass = Class.new klass do
         def self.foo; end
       end
@@ -85,12 +85,28 @@ describe GirFFI::ClassBase do
       sub_klass.setup_and_call :foo
     end
 
-    it "looks up class methods in all builders" do
-      mock(builder = Object.new).setup_instance_method("foo") { true }
+    it "calls the method given by the result of .setup_method" do
+      mock(builder = Object.new).setup_method("foo") { "bar" }
+      klass = Class.new GirFFI::ClassBase do
+        def self.bar
+          "correct-result"
+        end
+        def self.new; self._real_new; end
+      end
+      klass.const_set :GIR_FFI_BUILDER, builder
+
+      result = klass.setup_and_call :foo
+      result.must_equal "correct-result"
+    end
+  end
+
+  describe "#setup_and_call" do
+    it "looks up instance methods in all builders" do
+      mock(builder = Object.new).setup_instance_method("foo") { "foo" }
       klass = Class.new GirFFI::ClassBase
       klass.const_set :GIR_FFI_BUILDER, builder
 
-      mock(sub_builder = Object.new).setup_instance_method("foo") { false }
+      mock(sub_builder = Object.new).setup_instance_method("foo") { nil }
       sub_klass = Class.new klass do
         def foo; end
         def initialize; end
@@ -102,5 +118,21 @@ describe GirFFI::ClassBase do
 
       obj.setup_and_call :foo
     end
+
+    it "calls the method given by the result of .setup_instance_method" do
+      mock(builder = Object.new).setup_instance_method("foo") { "bar" }
+      klass = Class.new GirFFI::ClassBase do
+        def bar
+          "correct-result"
+        end
+        def self.new; self._real_new; end
+      end
+      klass.const_set :GIR_FFI_BUILDER, builder
+
+      obj = klass.new
+
+      result = obj.setup_and_call :foo
+      result.must_equal "correct-result"
+    end
   end
 end

data/test/gir_ffi/method_stubber_test.rb

@@ -0,0 +1,59 @@
+require 'gir_ffi_test_helper'
+
+describe GirFFI::MethodStubber do
+  describe "#method_stub" do
+    let(:stubber) { GirFFI::MethodStubber.new(method_info) }
+    let(:result) { stubber.method_stub }
+
+    describe "for a regular method" do
+      let(:method_info) {
+        get_method_introspection_data("Regress", "TestObj", "instance_method") }
+
+      it "creates a method stub" do
+        result.must_equal <<-STUB.reset_indentation
+          def instance_method *args, &block
+            setup_and_call :instance_method, *args, &block
+          end
+        STUB
+      end
+    end
+
+    describe "for a static method" do
+      let(:method_info) {
+        get_method_introspection_data("Regress", "TestObj", "static_method") }
+
+      it "creates a class method stub" do
+        result.must_equal <<-STUB.reset_indentation
+          def self.static_method *args, &block
+            setup_and_call :static_method, *args, &block
+          end
+        STUB
+      end
+    end
+
+    describe "for a module function" do
+      let(:method_info) {
+        get_introspection_data("Regress", "test_int") }
+
+      it "creates a module method stub" do
+        result.must_equal <<-STUB.reset_indentation
+          def self.test_int *args, &block
+            setup_and_call :test_int, *args, &block
+          end
+        STUB
+      end
+    end
+
+    describe "for a method with an empty name" do
+      let(:method_info) { get_method_introspection_data("GLib", "IConv", "") }
+
+      it "creates a method stub with a safe name that sets up the unsafe method" do
+        result.must_equal <<-STUB.reset_indentation
+          def _ *args, &block
+            setup_and_call :"", *args, &block
+          end
+        STUB
+      end
+    end
+  end
+end

data/test/integration/generated_gimarshallingtests_test.rb

@@ -210,6 +210,7 @@ describe GIMarshallingTests do
 
   describe "GIMarshallingTests::Interface3" do
     it "has a working method #test_variant_array_in" do
+      skip unless get_introspection_data 'GIMarshallingTests', 'Interface3'
       derived_klass.class_eval { include GIMarshallingTests::Interface3 }
       instance = make_derived_instance do |info|
         info.install_vfunc_implementation :test_variant_array_in, proc {|obj, in_|

data/test/integration/generated_glib_test.rb

@@ -0,0 +1,10 @@
+require 'gir_ffi_test_helper'
+
+# Tests generated classes, methods and functions in the GLib namespace.
+describe "The generated GLib module" do
+  it "can auto-generate the GLib::IConv class" do
+    klass = GLib::IConv
+
+    klass.must_be_instance_of Class
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gir_ffi
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Matijs van Zuijlen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-11 00:00:00.000000000 Z
+date: 2014-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -80,7 +80,11 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
-description: 
+description: |2
+      GirFFI creates bindings for GObject-based libraries at runtime based on introspection
+      data provided by the GObject Introspection Repository (GIR) system. Bindings are created
+      at runtime and use FFI to interface with the C libraries. In cases where the GIR does not
+      provide enough or correct information to create sane bindings, overrides may be created.
 email:
 - matijs@matijs.net
 executables: []
@@ -203,6 +207,7 @@ files:
 - lib/ffi-glib/variant.rb
 - lib/ffi-glib/array_methods.rb
 - lib/ffi-glib/s_list.rb
+- lib/ffi-glib/iconv.rb
 - lib/ffi-gobject_introspection/i_struct_info.rb
 - lib/ffi-gobject_introspection/i_callback_info.rb
 - lib/ffi-gobject_introspection/i_arg_info.rb
@@ -238,6 +243,7 @@ files:
 - test/integration/method_lookup_test.rb
 - test/integration/generated_gimarshallingtests_test.rb
 - test/integration/generated_gio_test.rb
+- test/integration/generated_glib_test.rb
 - test/integration/generated_pango_test.rb
 - test/integration/generated_secret_test.rb
 - test/integration/generated_gobject_test.rb
@@ -267,7 +273,9 @@ files:
 - test/gir_ffi/builders/object_builder_test.rb
 - test/gir_ffi/builders/property_builder_test.rb
 - test/gir_ffi/builders/module_builder_test.rb
+- test/gir_ffi/builders/with_methods_test.rb
 - test/gir_ffi/builders/user_defined_builder_test.rb
+- test/gir_ffi/method_stubber_test.rb
 - test/gir_ffi/variable_name_generator_test.rb
 - test/gir_ffi/ffi_ext/pointer_test.rb
 - test/gir_ffi/class_base_test.rb
@@ -294,6 +302,7 @@ files:
 - test/ffi-glib/s_list_test.rb
 - test/ffi-glib/hash_table_test.rb
 - test/ffi-glib/list_test.rb
+- test/ffi-glib/iconv_test.rb
 - test/ffi-glib/array_test.rb
 - test/ffi-glib/ptr_array_test.rb
 - test/ffi-glib/byte_array_test.rb
@@ -325,7 +334,8 @@ files:
 - Rakefile
 - COPYING.LIB
 homepage: http://www.github.com/mvz/ruby-gir-ffi
-licenses: []
+licenses:
+- LGPL-2.1
 metadata: {}
 post_install_message: 
 rdoc_options:
@@ -354,6 +364,7 @@ test_files:
 - test/ffi-glib/array_test.rb
 - test/ffi-glib/byte_array_test.rb
 - test/ffi-glib/hash_table_test.rb
+- test/ffi-glib/iconv_test.rb
 - test/ffi-glib/list_test.rb
 - test/ffi-glib/ptr_array_test.rb
 - test/ffi-glib/ruby_closure_test.rb
@@ -394,6 +405,7 @@ test_files:
 - test/gir_ffi/builders/union_builder_test.rb
 - test/gir_ffi/builders/user_defined_builder_test.rb
 - test/gir_ffi/builders/vfunc_builder_test.rb
+- test/gir_ffi/builders/with_methods_test.rb
 - test/gir_ffi/callback_base_test.rb
 - test/gir_ffi/class_base_test.rb
 - test/gir_ffi/ffi_ext/pointer_test.rb
@@ -409,6 +421,7 @@ test_files:
 - test/gir_ffi/info_ext/safe_constant_name_test.rb
 - test/gir_ffi/info_ext/safe_function_name_test.rb
 - test/gir_ffi/interface_base_test.rb
+- test/gir_ffi/method_stubber_test.rb
 - test/gir_ffi/object_base_test.rb
 - test/gir_ffi/sized_array_test.rb
 - test/gir_ffi/type_map_test.rb
@@ -422,6 +435,7 @@ test_files:
 - test/integration/derived_classes_test.rb
 - test/integration/generated_gimarshallingtests_test.rb
 - test/integration/generated_gio_test.rb
+- test/integration/generated_glib_test.rb
 - test/integration/generated_gobject_test.rb
 - test/integration/generated_pango_ft2_test.rb
 - test/integration/generated_pango_test.rb