gir_ffi 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be09f0c7b882ddc0bb3dfdc7d0c78a799f364523
-  data.tar.gz: 0a5cff8324417259a1092c686e9d3ffc492efebf
+  metadata.gz: a1ad50242508ce93d6d0b6751cd18b550f3f8137
+  data.tar.gz: b4ea1af0594d95c7293edabbf4f108506b2d46c4
 SHA512:
-  metadata.gz: 26639dd911992a83273376f6421f9eee8f802386d3b345a62feacd4b6a7d5fac9f7cc55cba160428ceb59c7e4740404b990761892fddef705bb4dd94bcf1fa21
-  data.tar.gz: 63a71dd6cf133b0e7f0dcaf335961297b968e3cc3293170e9f5b9daf9709ad6562cc1df92e8c4b4749af61b9966a8540153a316002ef2b0b8bf817dd02199837
+  metadata.gz: 71bc54a2a76ddaa7a8d3633c02ce1ccc123ca036031e7c207fb6808aa81c995e30bf2eb4ffa7bc78321401f09887d1118862e7178534d12bc962c32099889355
+  data.tar.gz: 099c5f239a3f1d7222871f1ad3f78730e733dbbc6c8f7fe278740b261390271f7aa072174ccf3a92b3246ead586d52bd29c09c22596474ede0282ef612c86ea7

data/Changelog.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.8.4 / 2015-12-03
+
+* Handle classes with lower-case names
+* Make ObjectBase a DataConverter so FFI handles it natively
+* Use more of gobject-introspection's test libraries for testing
+* Simplify constructor overrides: Custom initializers will no longer be
+  overwritten when setting up the corresponding constructor.
+* Override GObject::Object.new to not require a GType argument
+
 ## 0.8.3 / 2015-11-13
 
 * Fix handling of signal handler return values
@@ -50,7 +59,6 @@
 * Increase refcount for :object return values of vfuncs with full transfer
 * Increase refcount for outgoing :object arguments of vfuncs with full ownership
   transfer
-* Apply more RuboCop rules
 * Support Ruby 2.2
 * Rename several methods. The old names are deprecated and will be removed in 0.8.0.
 

data/Gemfile

@@ -8,6 +8,6 @@ if ENV['CI']
     gem 'coveralls', type: :development
   end
 else
-  gem 'simplecov', '~> 0.10.0', type: :development, platform: :mri
+  gem 'simplecov', '~> 0.11.0', type: :development, platform: :mri
   gem 'pry', '~> 0.10.0', type: :development
 end

data/README.md

@@ -64,8 +64,9 @@ GirFFI is developed on Debian sid, and tested through Travis CI on Ubuntu
 12.04. Older versions of gobject-introspection than the ones used there
 are therefore not officially supported (although they may work).
 
-On Debian and Ubuntu, installing `libgirepository1.0-dev` and
-`gobject-introspection` should be enough to get `rake test` working.
+On Debian and Ubuntu, installing `libgirepository1.0-dev`,
+`gobject-introspection` and `gir1.2-gtop-2.0` should be enough to get
+`rake test` working.
 
 GirFFI has not been tested on Mac OS X or Microsoft Windows. YMMV.
 

data/lib/ffi-glib/bytes.rb

@@ -32,20 +32,6 @@ module GLib
       end
     end
 
-    # Why redefine new here? The class builder will only define the full
-    # version of 'new' on first call, causing both new and initialize to be
-    # defined. This overwrites the custom version of initialize below.
-    # TODO: Improve class builder so this trick is not needed.
-    class << self
-      undef new
-    end
-
-    def self.new(*args)
-      obj = allocate
-      obj.__send__ :initialize, *args
-      obj
-    end
-
     def initialize(arr)
       data = GirFFI::SizedArray.from :guint8, arr.size, arr
       store_pointer Lib.g_bytes_new data.to_ptr, data.size

data/lib/ffi-glib/hash_table.rb

@@ -78,6 +78,5 @@ module GLib
       lib = ::GLib::Lib.ffi_libraries.first
       lib.find_function(name)
     end
-
   end
 end

data/lib/ffi-gobject/object.rb

@@ -5,6 +5,13 @@ module GObject
   class Object
     setup_method 'new'
 
+    def initialize_with_automatic_gtype(properties)
+      initialize_without_automatic_gtype(self.class.gtype, properties)
+    end
+
+    alias_method :initialize_without_automatic_gtype, :initialize
+    alias_method :initialize, :initialize_with_automatic_gtype
+
     def store_pointer(ptr)
       super
       klass = self.class

data/lib/ffi-gobject_introspection/i_base_info.rb

@@ -106,6 +106,10 @@ module GObjectIntrospection
       Lib.g_base_info_is_deprecated @gobj
     end
 
+    def attribute(name)
+      Lib.g_base_info_get_attribute @gobj, name
+    end
+
     def self.wrap(ptr)
       new ptr unless ptr.null?
     end

data/lib/ffi-gobject_introspection/lib.rb

@@ -68,6 +68,7 @@ module GObjectIntrospection
 
     attach_function :g_base_info_ref, [:pointer], :void
     attach_function :g_base_info_unref, [:pointer], :void
+    attach_function :g_base_info_get_attribute, [:pointer, :string], :string
     attach_function :g_base_info_get_type, [:pointer], :IInfoType
     attach_function :g_base_info_get_name, [:pointer], :string
     attach_function :g_base_info_get_namespace, [:pointer], :string

data/lib/gir_ffi/boxed_base.rb

@@ -17,8 +17,8 @@ module GirFFI
       value.struct
     end
 
-    def self.get_value_from_pointer(pointer)
-      pointer.to_ptr
+    def self.get_value_from_pointer(pointer, offset)
+      pointer + offset
     end
 
     def self.copy_value_to_pointer(value, pointer, offset = 0)

data/lib/gir_ffi/builders/callback_argument_builder.rb

@@ -32,7 +32,9 @@ module GirFFI
       end
 
       def capture_variable_name
-        result_name if [:out, :inout].include? direction unless array_arg
+        unless array_arg
+          result_name if [:out, :inout].include? direction
+        end
       end
 
       def pre_conversion

data/lib/gir_ffi/builders/closure_return_value_builder.rb

@@ -11,4 +11,3 @@ module GirFFI
     end
   end
 end
-

data/lib/gir_ffi/builders/module_builder.rb

@@ -33,12 +33,19 @@ module GirFFI
       end
 
       def build_namespaced_class(classname)
-        info = gir.find_by_name @namespace, classname.to_s
+        info = find_namespaced_class_info(classname)
+        Builder.build_class info
+      end
+
+      def find_namespaced_class_info(classname)
+        name = classname.to_s
+        info = gir.find_by_name(@namespace, name) ||
+          gir.find_by_name(@namespace, name.sub(/^./, &:downcase))
         unless info
           raise NameError,
                 "Class #{classname} not found in namespace #{@namespace}"
         end
-        Builder.build_class info
+        info
       end
 
       private

data/lib/gir_ffi/builders/null_class_builder.rb

@@ -1,5 +1,6 @@
 module GirFFI
   module Builders
+    # Class builder that does nothing
     class NullClassBuilder
       def setup_method(_)
         nil

data/lib/gir_ffi/builders/registered_type_builder.rb

@@ -42,7 +42,11 @@ module GirFFI
 
       def define_method(method_info)
         if method_info.constructor?
-          build_class.class_eval InitializerBuilder.new(method_info).method_definition
+          initializer_builder = InitializerBuilder.new(method_info)
+          initializer_name = initializer_builder.method_name.to_sym
+          unless build_class.private_instance_methods(false).include? initializer_name
+            build_class.class_eval initializer_builder.method_definition
+          end
           build_class.class_eval ConstructorBuilder.new(method_info).method_definition
         else
           build_class.class_eval FunctionBuilder.new(method_info).method_definition

data/lib/gir_ffi/callback_base.rb

@@ -69,8 +69,8 @@ module GirFFI
       pointer.put_pointer 0, to_native(value, nil)
     end
 
-    def self.get_value_from_pointer(pointer)
-      from_native pointer.get_pointer(0), nil
+    def self.get_value_from_pointer(pointer, offset)
+      from_native pointer.get_pointer(offset), nil
     end
   end
 end

data/lib/gir_ffi/enum_base.rb

@@ -34,8 +34,8 @@ module GirFFI
       pointer.put_int32 0, to_native(value, nil)
     end
 
-    def get_value_from_pointer(pointer)
-      from_native pointer.get_int32(0), nil
+    def get_value_from_pointer(pointer, offset)
+      from_native pointer.get_int32(offset), nil
     end
 
     def setup_and_call(method, arguments, &block)

data/lib/gir_ffi/in_out_pointer.rb

@@ -17,7 +17,7 @@ module GirFFI
     def to_value
       case value_ffi_type
       when Module
-        value_ffi_type.get_value_from_pointer(self)
+        value_ffi_type.get_value_from_pointer(self, 0)
       when Symbol
         send("get_#{value_ffi_type}", 0)
       else

data/lib/gir_ffi/info_ext/i_registered_type_info.rb

@@ -17,7 +17,7 @@ module GirFFI
         return info if info && info.method?
       end
 
-      def find_method(method)
+      def find_method(_method)
         raise 'Must be overridden in subclass'
       end
     end

data/lib/gir_ffi/object_base.rb

@@ -1,6 +1,30 @@
+require 'gir_ffi/class_base'
+
 module GirFFI
   # Base class for all generated classes of type :object.
   class ObjectBase < ClassBase
+    extend FFI::DataConverter
+
+    def self.native_type
+      FFI::Type::POINTER
+    end
+
+    def self.to_ffi_type
+      self
+    end
+
+    def self.to_native(it, _)
+      it.to_ptr
+    end
+
+    def self.get_value_from_pointer(pointer, offset = 0)
+      pointer.get_pointer offset
+    end
+
+    def self.copy_value_to_pointer(value, pointer, offset = 0)
+      pointer.put_pointer offset, value.to_ptr
+    end
+
     # Wrap the passed pointer in an instance of its type's corresponding class,
     # generally assumed to be a descendant of the current type.
     def self.wrap(ptr)
@@ -29,14 +53,6 @@ module GirFFI
       gir_ffi_builder.find_signal name
     end
 
-    def self.to_ffi_type
-      :pointer
-    end
-
-    def self.copy_value_to_pointer(value, pointer, offset = 0)
-      pointer.put_pointer offset, value.to_ptr
-    end
-
     def self.object_class
       gir_ffi_builder.object_class
     end

data/lib/gir_ffi/sized_array.rb

@@ -33,8 +33,8 @@ module GirFFI
       size * element_size
     end
 
-    def self.get_value_from_pointer(pointer)
-      pointer
+    def self.get_value_from_pointer(pointer, offset)
+      pointer + offset
     end
 
     def self.copy_value_to_pointer(value, pointer)

data/lib/gir_ffi/version.rb

@@ -1,4 +1,4 @@
 # Current GirFFI version
 module GirFFI
-  VERSION = '0.8.3'
+  VERSION = '0.8.4'
 end

data/lib/gir_ffi/zero_terminated.rb

@@ -38,7 +38,7 @@ module GirFFI
     private
 
     def read_value(offset)
-      val = @ptr.send(getter_method, offset)
+      val = fetch_value(offset)
       val unless val.zero?
     end
 
@@ -46,6 +46,17 @@ module GirFFI
       @getter_method ||= "get_#{ffi_type}"
     end
 
+    def fetch_value(offset)
+      case ffi_type
+      when Module
+        ffi_type.get_value_from_pointer(@ptr, offset)
+      when Symbol
+        @ptr.send(getter_method, offset)
+      else
+        raise NotImplementedError
+      end
+    end
+
     def wrap_value(val)
       case element_type
       when Array

data/lib/gir_ffi-base/glib/boolean.rb

@@ -22,8 +22,8 @@ module GLib
       pointer.put_int 0, to_native(value, nil)
     end
 
-    def self.get_value_from_pointer(pointer)
-      from_native pointer.get_int(0), nil
+    def self.get_value_from_pointer(pointer, offset)
+      from_native pointer.get_int(offset), nil
     end
   end
 end

data/tasks/test.rake

@@ -28,40 +28,40 @@ class Listener
     obj_name = attrs['name']
     case name
     when "constant"
-      result.puts "  it \"has the constant #{obj_name}\" do"
+      result.puts "  it 'has the constant #{obj_name}' do"
     when "record", "class", "enumeration", "bitfield", "interface", "union"
-      result.puts "  describe \"#{namespace}::#{obj_name}\" do"
+      result.puts "  describe '#{namespace}::#{obj_name}' do"
       @inside_class = name
     when "constructor"
-      result.puts "    it \"creates an instance using ##{obj_name}\" do"
+      result.puts "    it 'creates an instance using ##{obj_name}' do"
     when "field"
       if @inside_class != 'class'
         if attrs['private'] == "1"
-          result.puts "    it \"has a private field #{obj_name}\" do"
+          result.puts "    it 'has a private field #{obj_name}' do"
         elsif attrs['writable'] == "1"
-          result.puts "    it \"has a writable field #{obj_name}\" do"
+          result.puts "    it 'has a writable field #{obj_name}' do"
         else
-          result.puts "    it \"has a read-only field #{obj_name}\" do"
+          result.puts "    it 'has a read-only field #{obj_name}' do"
         end
       end
     when "function", "method"
       spaces = @inside_class ? "  " : ""
-      result.puts "  #{spaces}it \"has a working #{name} ##{obj_name}\" do"
+      result.puts "  #{spaces}it 'has a working #{name} ##{obj_name}' do"
     when "member"
-      result.puts "    it \"has the member :#{obj_name}\" do"
+      result.puts "    it 'has the member :#{obj_name}' do"
     when "namespace"
       result.puts "describe #{obj_name} do"
     when "property"
       accessor_name = obj_name.gsub(/-/, '_')
       result.puts "    describe \"its '#{obj_name}' property\" do"
-      result.puts "      it \"can be retrieved with #get_property\" do"
+      result.puts "      it 'can be retrieved with #get_property' do"
       result.puts "      end"
-      result.puts "      it \"can be retrieved with ##{accessor_name}\" do"
+      result.puts "      it 'can be retrieved with ##{accessor_name}' do"
       result.puts "      end"
       if attrs['writable'] == '1'
-        result.puts "      it \"can be set with #set_property\" do"
+        result.puts "      it 'can be set with #set_property' do"
         result.puts "      end"
-        result.puts "      it \"can be set with ##{accessor_name}=\" do"
+        result.puts "      it 'can be set with ##{accessor_name}=' do"
         result.puts "      end"
       end
     when "glib:signal"
@@ -145,7 +145,7 @@ namespace :test do
     t.test_files = FileList['test/integration/**/*_test.rb']
   end
 
-  desc 'Build Regress test library and typelib'
+  desc 'Build test libraries and typelibs'
   task :lib => "test/lib/Makefile" do
     sh %{cd test/lib && make}
   end
@@ -169,19 +169,21 @@ namespace :test do
                    :overrides,
                    :integration]
 
-  desc "Create stubs for Regress and GIMarshallingTests tests"
-  task :stub => :lib do
-    file = File.new 'test/lib/Regress-1.0.gir'
+  def make_stub_file(libname)
+    file = File.new "test/lib/#{libname}-1.0.gir"
     listener = Listener.new
-    listener.result = File.open('tmp/regress_lines.rb', 'w')
-    listener.namespace = "Regress"
+    listener.result = File.open("tmp/#{libname.downcase}_lines.rb", 'w')
+    listener.namespace = libname
     REXML::Document.parse_stream file, listener
+  end
 
-    file = File.new 'test/lib/GIMarshallingTests-1.0.gir'
-    listener = Listener.new
-    listener.result = File.open('tmp/gimarshallingtests_lines.rb', 'w')
-    listener.namespace = "GIMarshallingTests"
-    REXML::Document.parse_stream file, listener
+  desc "Create stubs for integration tests"
+  task :stub => :lib do
+    make_stub_file 'Everything'
+    make_stub_file 'GIMarshallingTests'
+    make_stub_file 'Regress'
+    make_stub_file 'Utility'
+    make_stub_file 'WarnLib'
   end
 end
 

data/test/base_test_helper.rb

@@ -3,6 +3,7 @@ require 'rubygems' if RUBY_PLATFORM == 'java'
 begin
   require 'simplecov'
   SimpleCov.start do
+    track_files 'lib/**/*.rb'
     add_filter '/test/'
   end
 
@@ -25,10 +26,8 @@ module GObjectIntrospection
   class IRepository
     def shared_library_with_regress(namespace)
       case namespace
-      when 'Regress'
-        return File.join(File.dirname(__FILE__), 'lib', 'libregress.so')
-      when 'GIMarshallingTests'
-        return File.join(File.dirname(__FILE__), 'lib', 'libgimarshallingtests.so')
+      when 'Everything', 'GIMarshallingTests', 'Regress', 'Utility', 'WarnLib'
+        return File.join(File.dirname(__FILE__), 'lib', "lib#{namespace.downcase}.so")
       else
         return shared_library_without_regress namespace
       end

data/test/ffi-gobject/object_test.rb

@@ -3,6 +3,12 @@ require 'gir_ffi_test_helper'
 require 'ffi-gobject'
 
 describe GObject::Object do
+  describe '.new' do
+    it 'is overridden to take only one argument' do
+      GObject::Object.new(nil).must_be_instance_of GObject::Object
+    end
+  end
+
   describe '#get_property' do
     it 'is overridden to have arity 1' do
       GObject::Object.instance_method('get_property').arity.must_equal 1
@@ -20,7 +26,7 @@ describe GObject::Object do
       end
     end
 
-    subject { AccessorTest.new GObject::TYPE_OBJECT, nil }
+    subject { AccessorTest.new nil }
 
     it 'reads x by calling get_x' do
       subject.set_x(1)
@@ -34,7 +40,7 @@ describe GObject::Object do
   end
 
   describe '#signal_connect' do
-    subject { GObject::Object.new GObject::TYPE_OBJECT, nil }
+    subject { GObject::Object.new nil }
 
     it 'delegates to GObject' do
       expect(GObject).to receive(:signal_connect).with(subject, 'some-event', nil)
@@ -52,7 +58,7 @@ describe GObject::Object do
   end
 
   describe '#signal_connect_after' do
-    subject { GObject::Object.new GObject::TYPE_OBJECT, nil }
+    subject { GObject::Object.new nil }
 
     it 'delegates to GObject' do
       expect(GObject).to receive(:signal_connect_after).with(subject, 'some-event', nil)
@@ -75,7 +81,7 @@ describe GObject::Object do
         skip 'cannot be reliably tested on JRuby and Rubinius'
       end
 
-      object = GObject::Object.new GObject::TYPE_OBJECT, nil
+      object = GObject::Object.new nil
       ptr = object.to_ptr
       ref_count(ptr).must_equal 1
 

data/test/ffi-gobject_introspection/i_property_info_test.rb

@@ -22,8 +22,9 @@ describe GObjectIntrospection::IPropertyInfo do
   end
 
   describe "for GObject::Binding's 'target-property' property" do
-    let(:property_info) {
-      get_property_introspection_data 'GObject', 'Binding', 'target-property' }
+    let(:property_info) do
+      get_property_introspection_data 'GObject', 'Binding', 'target-property'
+    end
 
     it 'returns :utf8 as its type' do
       property_info.property_type.tag.must_equal :utf8

data/test/gir_ffi/builders/module_builder_test.rb

@@ -1,17 +1,40 @@
 require 'gir_ffi_test_helper'
 
 describe GirFFI::Builders::ModuleBuilder do
-  describe '#build_namespaced_class' do
+  let(:gir) { GObjectIntrospection::IRepository.default }
+
+  describe '#find_namespaced_class_info' do
+    it 'finds the info in the GIR' do
+      allow(gir).to receive(:require).with('Foo', nil)
+
+      builder = GirFFI::Builders::ModuleBuilder.new 'Foo'
+
+      expect(gir).to receive(:find_by_name).with('Foo', 'Bar').and_return 'gir info'
+
+      builder.find_namespaced_class_info(:Bar).must_equal 'gir info'
+    end
+
+    it 'checks downcased class name as an alternative' do
+      allow(gir).to receive(:require).with('Foo', nil)
+
+      builder = GirFFI::Builders::ModuleBuilder.new 'Foo'
+
+      expect(gir).to receive(:find_by_name).with('Foo', 'Bar').and_return nil
+      expect(gir).to receive(:find_by_name).with('Foo', 'bar').and_return 'gir info'
+
+      builder.find_namespaced_class_info(:Bar).must_equal 'gir info'
+    end
+
     it 'raises a clear error if the named class does not exist' do
-      gir = GObjectIntrospection::IRepository.default
       allow(gir).to receive(:require).with('Foo', nil)
 
       builder = GirFFI::Builders::ModuleBuilder.new 'Foo'
 
       expect(gir).to receive(:find_by_name).with('Foo', 'Bar').and_return nil
+      expect(gir).to receive(:find_by_name).with('Foo', 'bar').and_return nil
 
       assert_raises NameError do
-        builder.build_namespaced_class :Bar
+        builder.find_namespaced_class_info :Bar
       end
     end
   end

data/test/gir_ffi/object_base_test.rb

@@ -11,8 +11,8 @@ describe GirFFI::ObjectBase do
   end
 
   describe '.to_ffi_type' do
-    it 'returns :pointer' do
-      derived_class.to_ffi_type.must_equal :pointer
+    it 'returns itself' do
+      derived_class.to_ffi_type.must_equal derived_class
     end
   end
 end