gir_ffi 0.9.0 → 0.9.1

data/lib/gir_ffi/builders/field_builder.rb

@@ -9,6 +9,8 @@ module GirFFI
       # Convertor for fields for field getters. Used when building getter
       # methods.
       class GetterArgumentBuilder < BaseArgumentBuilder
+        attr_reader :array_length_idx
+
         def initialize(var_gen, field_argument_info, field_info,
                        array_length_idx: -1)
           super(var_gen, field_argument_info)
@@ -49,10 +51,6 @@ module GirFFI
           end
         end
 
-        def array_length_idx
-          @array_length_idx
-        end
-
         private
 
         def field_offset

data/lib/gir_ffi/builders/object_builder.rb

@@ -21,13 +21,11 @@ module GirFFI
       end
 
       def find_signal(signal_name)
-        seek_in_ancestor_infos { |info| info.find_signal signal_name } or
-          raise "Signal #{signal_name} not found"
+        seek_in_ancestor_infos { |info| info.find_signal signal_name }
       end
 
       def find_property(property_name)
-        seek_in_ancestor_infos { |info| info.find_property property_name } or
-          raise "Property #{property_name} not found"
+        seek_in_ancestor_infos { |info| info.find_property property_name }
       end
 
       def object_class_struct
@@ -38,6 +36,15 @@ module GirFFI
         @ancestor_infos ||= [info] + info.interfaces + parent_ancestor_infos
       end
 
+      def eligible_fields
+        info.fields.reject do |finfo|
+          fname = finfo.name
+          fname == 'parent_instance' ||
+            info.find_instance_method("get_#{fname}") ||
+            info.find_property(fname)
+        end
+      end
+
       protected
 
       def object_class_struct_info
@@ -51,11 +58,8 @@ module GirFFI
         setup_layout
         setup_constants
         stub_methods
-        if info.fundamental?
-          setup_field_accessors
-        else
-          setup_property_accessors
-        end
+        setup_field_accessors
+        setup_property_accessors
         setup_vfunc_invokers
         setup_interfaces
         provide_initializer
@@ -91,6 +95,12 @@ module GirFFI
         @parent_ancestor_infos ||= parent_builder.ancestor_infos
       end
 
+      def setup_field_accessors
+        eligible_fields.each do |finfo|
+          FieldBuilder.new(finfo).build
+        end
+      end
+
       def setup_property_accessors
         info.properties.each do |prop|
           PropertyBuilder.new(prop).build
@@ -119,6 +129,7 @@ module GirFFI
       def provide_initializer
         return if info.find_method 'new'
 
+        # FIXME: Only valid if the object descends from GObject::Object
         klass.class_eval "
           def initialize(properties = {})
             base_initialize(properties)

data/lib/gir_ffi/builders/type_builder.rb

@@ -29,7 +29,7 @@ module GirFFI
         union:                  UnionBuilder,
         unintrospectable_boxed: UnintrospectableBoxedBuilder,
         unintrospectable:       UnintrospectableBuilder
-      }
+      }.freeze
 
       def self.build(info)
         builder_for(info).build_class

data/lib/gir_ffi/builders/unintrospectable_builder.rb

@@ -1,4 +1,5 @@
 require 'gir_ffi/builders/object_builder'
+require 'gir_ffi/unintrospectable_signal_info'
 
 module GirFFI
   module Builders
@@ -19,6 +20,13 @@ module GirFFI
       def setup_instance_method(_method)
         false
       end
+
+      def find_signal(signal_name)
+        info = super
+        return info if info
+        signal_id = GObject.signal_lookup signal_name, target_gtype
+        return UnintrospectableSignalInfo.new(signal_id) if signal_id > 0
+      end
     end
   end
 end

data/lib/gir_ffi/builders/with_layout.rb

@@ -34,12 +34,6 @@ module GirFFI
         fields.map(&:layout_specification).flatten(1)
       end
 
-      def setup_field_accessors
-        fields.each do |finfo|
-          FieldBuilder.new(finfo).build
-        end
-      end
-
       def klass
         @klass ||= get_or_define_class namespace_module, @classname, superclass
       end

data/lib/gir_ffi/core.rb

@@ -14,8 +14,9 @@ require 'gir_ffi/in_out_pointer'
 require 'gir_ffi/sized_array'
 require 'gir_ffi/zero_terminated'
 require 'gir_ffi/arg_helper'
-require 'gir_ffi/user_defined_type_info'
 require 'gir_ffi/builder'
+require 'gir_ffi/user_defined_type_info'
+require 'gir_ffi/builders/user_defined_builder'
 require 'gir_ffi/version'
 
 # Main module containing classes and modules needed for generating GLib and

data/lib/gir_ffi/ffi_ext/pointer.rb

@@ -16,7 +16,7 @@ module GirFFI
 
       # FIXME: Should probably not be here.
       def to_object
-        return nil if self.null?
+        return nil if null?
         gtype = GObject.type_from_instance_pointer self
         Builder.build_by_gtype(gtype).direct_wrap self
       end

data/lib/gir_ffi/info_ext/i_type_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/builder_helper'
 
 module GirFFI
@@ -16,17 +17,14 @@ module GirFFI
           strv:     GObject::TYPE_STRV,
           utf8:     GObject::TYPE_STRING,
           void:     GObject::TYPE_NONE
-        }
+        }.freeze
       end
 
       def gtype
-        if tag == :interface
-          return interface.gtype
-        elsif (type = ITypeInfo.flattened_tag_to_gtype_map[flattened_tag])
-          return type
-        else
-          raise "Can't find GType for #{flattened_tag} pointer? = #{pointer?}"
-        end
+        return interface.gtype if tag == :interface
+        type = ITypeInfo.flattened_tag_to_gtype_map[flattened_tag]
+        return type if type
+        raise "Can't find GType for #{flattened_tag} pointer? = #{pointer?}"
       end
 
       def make_g_value
@@ -86,7 +84,7 @@ module GirFFI
         utf8:            'GirFFI::InPointer',
         void:            'GirFFI::InPointer',
         zero_terminated: 'GirFFI::ZeroTerminated'
-      }
+      }.freeze
 
       # TODO: Use class rather than class name
       def argument_class_name
@@ -133,13 +131,13 @@ module GirFFI
       TAGS_NEEDING_RUBY_TO_C_CONVERSION = [
         :array, :c, :callback, :error, :ghash, :glist, :gslist, :object,
         :ptr_array, :struct, :strv, :utf8, :void, :zero_terminated
-      ]
+      ].freeze
 
       TAGS_NEEDING_C_TO_RUBY_CONVERSION = [
         :array, :byte_array, :c, :error, :filename, :ghash, :glist, :gslist,
         :interface, :object, :ptr_array, :struct, :strv, :union, :utf8,
         :zero_terminated
-      ]
+      ].freeze
 
       def needs_ruby_to_c_conversion_for_functions?
         TAGS_NEEDING_RUBY_TO_C_CONVERSION.include?(flattened_tag)
@@ -180,7 +178,7 @@ module GirFFI
         end
       end
 
-      GOBJECT_VALUE_NAME = 'GObject::Value'
+      GOBJECT_VALUE_NAME = 'GObject::Value'.freeze
 
       def gvalue?
         argument_class_name == GOBJECT_VALUE_NAME

data/lib/gir_ffi/object_base.rb

@@ -43,7 +43,8 @@ module GirFFI
     # @return [GObjectIntrospection::IPropertyInfo] The property's info
     #
     def self.find_property(name)
-      gir_ffi_builder.find_property name
+      gir_ffi_builder.find_property name or
+        raise GirFFI::PropertyNotFoundError.new(name, self)
     end
 
     #
@@ -54,7 +55,8 @@ module GirFFI
     # @return [GObjectIntrospection::ISignalInfo] The signal's info
     #
     def self.find_signal(name)
-      gir_ffi_builder.find_signal name
+      gir_ffi_builder.find_signal name or
+        raise GirFFI::SignalNotFoundError.new(name, self)
     end
 
     def self.object_class

data/lib/gir_ffi/property_not_found_error.rb

@@ -0,0 +1,12 @@
+module GirFFI
+  # Exception class to be raised when a property is not found.
+  class PropertyNotFoundError < RuntimeError
+    attr_reader :property_name
+
+    def initialize(property_name, klass)
+      @property_name = property_name
+      @klass = klass
+      super "Property '#{property_name}' not found in #{klass}"
+    end
+  end
+end

data/lib/gir_ffi/signal_not_found_error.rb

@@ -0,0 +1,12 @@
+module GirFFI
+  # Exception class to be raised when a signal is not found.
+  class SignalNotFoundError < RuntimeError
+    attr_reader :signal_name
+
+    def initialize(signal_name, klass)
+      @signal_name = signal_name
+      @klass = klass
+      super "Signal '#{signal_name}' not found in #{klass}"
+    end
+  end
+end

data/lib/gir_ffi/sized_array.rb

@@ -42,6 +42,10 @@ module GirFFI
       pointer.put_bytes(0, value.to_ptr.read_bytes(size), 0, size)
     end
 
+    def self.wrap(element_type, size, pointer)
+      new element_type, size, pointer unless pointer.null?
+    end
+
     private
 
     def element_ffi_type
@@ -52,10 +56,6 @@ module GirFFI
       @element_size ||= FFI.type_size element_ffi_type
     end
 
-    def self.wrap(element_type, size, pointer)
-      new element_type, size, pointer unless pointer.null?
-    end
-
     class << self
       def from(element_type, size, item)
         return unless item

data/lib/gir_ffi/type_map.rb

@@ -36,7 +36,7 @@ module GirFFI
       gfloat:    :float,
       gdouble:   :double,
       void:      :void
-    }
+    }.freeze
 
     def self.map_basic_type(type)
       sym = type.to_sym

data/lib/gir_ffi/unintrospectable_boxed_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/info_ext/full_type_name'
 
 module GirFFI
@@ -18,7 +19,7 @@ module GirFFI
       GObject.type_name g_type
     end
 
-    DEFAULT_BOXED_NAMESPACE = 'GLib'
+    DEFAULT_BOXED_NAMESPACE = 'GLib'.freeze
 
     def namespace
       DEFAULT_BOXED_NAMESPACE

data/lib/gir_ffi/unintrospectable_signal_info.rb

@@ -0,0 +1,39 @@
+module GirFFI
+  # Represents a signal not found in the GIR, conforming, as needed, to the
+  # interface of GObjectIntrospection::ISignalInfo.
+  class UnintrospectableSignalInfo
+    attr_reader :signal_id
+
+    def initialize(signal_id)
+      @signal_id = signal_id
+    end
+
+    def name
+      GObject.signal_name signal_id
+    end
+
+    def wrap_in_closure(&block)
+      GObject::RubyClosure.new(&block)
+    end
+
+    def arguments_to_gvalues(instance, arguments)
+      param_gtypes = signal_query.param_types || []
+
+      argument_gvalues = param_gtypes.zip(arguments).map do |gtype, arg|
+        GObject::Value.for_gtype(gtype).tap { |it| it.set_value arg }
+      end
+
+      argument_gvalues.unshift GObject::Value.wrap_instance(instance)
+    end
+
+    def gvalue_for_return_value
+      GObject::Value.for_gtype signal_query.return_type
+    end
+
+    private
+
+    def signal_query
+      @signal_query ||= GObject.signal_query signal_id
+    end
+  end
+end

data/lib/gir_ffi/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 # Current GirFFI version
 module GirFFI
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'.freeze
 end

data/lib/gir_ffi-base/gobject/lib.rb

@@ -1,7 +1,7 @@
 require 'ffi/bit_masks'
 
 # NOTE: Monkey-patch BitMask to work on JRuby.
-class FFI::BitMasks::BitMask
+FFI::BitMasks::BitMask.class_eval do
   def reference_required?
     false
   end

data/tasks/rubocop.rake

@@ -0,0 +1,5 @@
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |task|
+  task.options << '--display-cop-names'
+end

data/tasks/test.rake

@@ -1,4 +1,5 @@
 require 'rake/testtask'
+require 'cucumber/rake/task'
 
 require 'rexml/document'
 require 'rexml/streamlistener'
@@ -185,6 +186,10 @@ namespace :test do
     make_stub_file 'Utility'
     make_stub_file 'WarnLib'
   end
+
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = 'features --format pretty'
+  end
 end
 
 file "test/lib/Makefile" => "test/lib/configure" do
@@ -194,3 +199,5 @@ end
 file "test/lib/configure" => ["test/lib/autogen.sh", "test/lib/configure.ac"] do
   sh %{cd test/lib && ./autogen.sh}
 end
+
+task test: 'test:all'

data/test/ffi-gobject/object_test.rb

@@ -19,7 +19,7 @@ describe GObject::Object do
     end
 
     it 'raises an error for properties that do not exist' do
-      proc { GObject::Object.new(dog: 'bark') }.must_raise ArgumentError
+      proc { GObject::Object.new(dog: 'bark') }.must_raise GirFFI::PropertyNotFoundError
     end
   end
 
@@ -27,6 +27,34 @@ describe GObject::Object do
     it 'is overridden to have arity 1' do
       GObject::Object.instance_method('get_property').arity.must_equal 1
     end
+
+    it 'raises an error for a property that does not exist' do
+      instance = GObject::Object.new
+      proc { instance.get_property 'foo-bar' }.must_raise GirFFI::PropertyNotFoundError
+    end
+  end
+
+  describe '#get_property_extended' do
+    it 'raises an error for a property that does not exist' do
+      instance = GObject::Object.new
+      proc { instance.get_property_extended 'foo-bar' }.
+        must_raise GirFFI::PropertyNotFoundError
+    end
+  end
+
+  describe '#set_property' do
+    it 'raises an error for a property that does not exist' do
+      instance = GObject::Object.new
+      proc { instance.set_property 'foo-bar', 123 }.must_raise GirFFI::PropertyNotFoundError
+    end
+  end
+
+  describe '#set_property_extended' do
+    it 'raises an error for a property that does not exist' do
+      instance = GObject::Object.new
+      proc { instance.set_property_extended 'foo-bar', 123 }.
+        must_raise GirFFI::PropertyNotFoundError
+    end
   end
 
   describe 'automatic accessor methods' do

data/test/ffi-gobject_introspection/i_object_info_test.rb

@@ -23,6 +23,22 @@ describe GObjectIntrospection::IObjectInfo do
     end
   end
 
+  describe '#find_property' do
+    let(:object_info) { get_introspection_data('GObject', 'Binding') }
+
+    it 'finds a property by name string' do
+      object_info.find_property('source-property').wont_be_nil
+    end
+
+    it 'finds a property by snake case string' do
+      object_info.find_property('source_property').wont_be_nil
+    end
+
+    it 'finds a property by name symbol' do
+      object_info.find_property(:source).wont_be_nil
+    end
+  end
+
   describe '#type_name' do
     it 'returns the correct name' do
       object_info.type_name.must_equal 'GObject'

data/test/ffi-gobject_test.rb

@@ -86,9 +86,8 @@ describe GObject do
 
     it 'does not allow connecting an invalid signal' do
       o = Regress::TestSubObj.new
-      assert_raises RuntimeError do
-        GObject.signal_connect(o, 'not-really-a-signal') {}
-      end
+      proc { GObject.signal_connect(o, 'not-really-a-signal') {} }.
+        must_raise GirFFI::SignalNotFoundError
     end
 
     it 'handles return values' do
@@ -100,9 +99,7 @@ describe GObject do
 
     it 'requires a block' do
       o = Regress::TestSubObj.new
-      assert_raises ArgumentError do
-        GObject.signal_connect o, 'test'
-      end
+      proc { GObject.signal_connect o, 'test' }.must_raise ArgumentError
     end
 
     it 'allows specifying signal detail' do

data/test/gir_ffi/builders/argument_builder_test.rb

@@ -344,7 +344,7 @@ describe GirFFI::Builders::ArgumentBuilder do
       end
 
       it 'has the correct value for method_argument_name' do
-        builder.method_argument_name.must_equal "#{arg_info.name}"
+        builder.method_argument_name.must_equal arg_info.name
       end
 
       it 'has the correct value for #pre_conversion' do
@@ -435,7 +435,7 @@ describe GirFFI::Builders::ArgumentBuilder do
 
         it 'has the correct value for #pre_conversion' do
           builder.pre_conversion.must_equal [
-            "GirFFI::ArgHelper.check_fixed_array_size 4, ints, \"ints\"",
+            'GirFFI::ArgHelper.check_fixed_array_size 4, ints, "ints"',
             '_v1 = GirFFI::InOutPointer.for [:pointer, :c]',
             '_v1.set_value GirFFI::SizedArray.from(:gint32, 4, ints)'
           ]

data/test/gir_ffi/builders/object_builder_test.rb

@@ -9,6 +9,10 @@ describe GirFFI::Builders::ObjectBuilder do
     GirFFI::Builders::ObjectBuilder.new(
       get_introspection_data('Regress', 'TestSubObj'))
   end
+  let(:param_spec_builder) do
+    GirFFI::Builders::ObjectBuilder.new(
+      get_introspection_data('GObject', 'ParamSpec'))
+  end
 
   describe '#find_signal' do
     it 'finds the signal "test" for TestObj' do
@@ -27,14 +31,8 @@ describe GirFFI::Builders::ObjectBuilder do
       sig.name.must_equal 'changed'
     end
 
-    it "raises an error for a signal that doesn't exist" do
-      msg = nil
-      begin
-        obj_builder.find_signal 'foo'
-      rescue RuntimeError => e
-        msg = e.message
-      end
-      assert_match(/^Signal/, msg)
+    it "returns nil for a signal that doesn't exist" do
+      obj_builder.find_signal('foo').must_be_nil
     end
   end
 
@@ -49,10 +47,8 @@ describe GirFFI::Builders::ObjectBuilder do
       prop.name.must_equal 'int'
     end
 
-    it 'raises an error if the property is not found' do
-      proc do
-        sub_obj_builder.find_property('this-property-does-not-exist')
-      end.must_raise RuntimeError
+    it 'returns nil if the property is not found' do
+      sub_obj_builder.find_property('this-property-does-not-exist').must_be_nil
     end
   end
 
@@ -86,4 +82,21 @@ describe GirFFI::Builders::ObjectBuilder do
       assert_equal [:parent, GObject::Object::Struct, 0], spec
     end
   end
+
+  describe '#eligible_fields' do
+    it 'skips fields that have a matching getter method' do
+      result = param_spec_builder.eligible_fields
+      result.map(&:name).wont_include 'name'
+    end
+
+    it 'skips fields that have a matching property' do
+      result = obj_builder.eligible_fields
+      result.map(&:name).wont_include 'hash_table'
+    end
+
+    it 'skips the parent instance field' do
+      result = obj_builder.eligible_fields
+      result.map(&:name).wont_include 'parent_instance'
+    end
+  end
 end

data/test/gir_ffi/builders/unintrospectable_builder_test.rb

@@ -1,15 +1,13 @@
 require 'gir_ffi_test_helper'
 
+GirFFI.setup :Gio
+GirFFI.setup :Gst
+Gst.init []
+
 describe GirFFI::Builders::UnintrospectableBuilder do
   describe 'building the GLocalFile type' do
     before do
-      # Ensure existence of GLocalFile type
-      GirFFI.setup :Gio
-      unless Gio::Lib.respond_to? :g_file_new_for_path
-        Gio.setup_method 'file_new_for_path'
-      end
-      ptr = GirFFI::InPointer.from :utf8, '/'
-      Gio::Lib.g_file_new_for_path(ptr)
+      Gio.file_new_for_path '/'
 
       @gtype = GObject.type_from_name 'GLocalFile'
       @info = GirFFI::UnintrospectableTypeInfo.new(@gtype)
@@ -37,14 +35,8 @@ describe GirFFI::Builders::UnintrospectableBuilder do
     end
 
     describe 'its #find_signal method' do
-      it "raises correct error for a signal that doesn't exist" do
-        msg = nil
-        begin
-          @bldr.find_signal 'foo'
-        rescue RuntimeError => e
-          msg = e.message
-        end
-        assert_match(/^Signal/, msg)
+      it "returns nil for a signal that doesn't exist" do
+        @bldr.find_signal('foo').must_be_nil
       end
 
       it 'finds signals in ancestor classes' do
@@ -59,4 +51,18 @@ describe GirFFI::Builders::UnintrospectableBuilder do
       end
     end
   end
+
+  describe 'building the GstFakeSink type' do
+    let(:instance) { Gst::ElementFactory.make('fakesink', 'sink') }
+    let(:klass) { instance.class }
+    let(:builder) { klass.gir_ffi_builder }
+
+    describe 'its #find_signal method' do
+      it 'finds signals that are not defined in the GIR' do
+        signal = builder.find_signal 'handoff'
+        signal.wont_be_nil
+        signal.name.must_equal 'handoff'
+      end
+    end
+  end
 end