gir_ffi 0.7.10 → 0.8.0

data/lib/gir_ffi/object_base.rb

@@ -3,7 +3,7 @@ module GirFFI
   class ObjectBase < ClassBase
     # 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
+    def self.wrap(ptr)
       ptr.to_object
     end
 
@@ -14,7 +14,7 @@ module GirFFI
     #
     # @return [GObjectIntrospection::IPropertyInfo] The property's info
     #
-    def self.find_property name
+    def self.find_property(name)
       gir_ffi_builder.find_property name
     end
 
@@ -25,20 +25,15 @@ module GirFFI
     #
     # @return [GObjectIntrospection::ISignalInfo] The signal's info
     #
-    def self.find_signal name
+    def self.find_signal(name)
       gir_ffi_builder.find_signal name
     end
 
-    # @deprecated Use #to_ffi_type instead. Will be removed in 0.8.0.
-    def self.to_ffitype
-      to_ffi_type
-    end
-
     def self.to_ffi_type
       :pointer
     end
 
-    def self.copy_value_to_pointer value, pointer, offset = 0
+    def self.copy_value_to_pointer(value, pointer, offset = 0)
       pointer.put_pointer offset, value.to_ptr
     end
 

data/lib/gir_ffi/receiver_argument_info.rb

@@ -5,7 +5,7 @@ module GirFFI
   class ReceiverArgumentInfo
     attr_reader :argument_type
 
-    def initialize type
+    def initialize(type)
       @argument_type = type
     end
 

data/lib/gir_ffi/receiver_type_info.rb

@@ -4,7 +4,7 @@ module GirFFI
   class ReceiverTypeInfo
     include InfoExt::ITypeInfo
 
-    def initialize interface_info
+    def initialize(interface_info)
       @interface_info = interface_info
     end
 

data/lib/gir_ffi/registered_type_base.rb

@@ -6,11 +6,6 @@ module GirFFI
   module RegisteredTypeBase
     include TypeBase
 
-    # @deprecated Use #gtype. Will be removed in 0.8.0.
-    def get_gtype
-      gtype
-    end
-
     def gtype
       self::G_TYPE
     end

data/lib/gir_ffi/return_value_info.rb

@@ -4,7 +4,7 @@ module GirFFI
     attr_reader :argument_type
     attr_reader :ownership_transfer
 
-    def initialize type, ownership_transfer, skip
+    def initialize(type, ownership_transfer, skip)
       @argument_type = type
       @ownership_transfer = ownership_transfer
       @skip = skip

data/lib/gir_ffi/sized_array.rb

@@ -4,7 +4,7 @@ module GirFFI
     include Enumerable
     attr_reader :element_type, :size
 
-    def initialize element_type, size, pointer
+    def initialize(element_type, size, pointer)
       @element_type = element_type
       @size = size
       @pointer = pointer
@@ -14,7 +14,7 @@ module GirFFI
       @pointer
     end
 
-    def index idx
+    def index(idx)
       ptr = GirFFI::InOutPointer.new element_type, @pointer + idx * element_size
       ptr.to_ruby_value
     end
@@ -25,7 +25,7 @@ module GirFFI
       end
     end
 
-    def == other
+    def ==(other)
       to_a == other.to_a
     end
 
@@ -33,11 +33,11 @@ module GirFFI
       size * element_size
     end
 
-    def self.get_value_from_pointer pointer
+    def self.get_value_from_pointer(pointer)
       pointer
     end
 
-    def self.copy_value_to_pointer value, pointer
+    def self.copy_value_to_pointer(value, pointer)
       size = value.size_in_bytes
       pointer.put_bytes(0, value.to_ptr.read_bytes(size), 0, size)
     end
@@ -52,12 +52,12 @@ module GirFFI
       @element_size ||= FFI.type_size element_ffi_type
     end
 
-    def self.wrap element_type, size, pointer
+    def self.wrap(element_type, size, pointer)
       new element_type, size, pointer unless pointer.null?
     end
 
     class << self
-      def from element_type, size, item
+      def from(element_type, size, item)
         return unless item
 
         case item
@@ -72,19 +72,19 @@ module GirFFI
 
       private
 
-      def from_sized_array size, sized_array
+      def from_sized_array(size, sized_array)
         check_size size, sized_array.size
         sized_array
       end
 
-      def from_enumerable element_type, expected_size, arr
+      def from_enumerable(element_type, expected_size, arr)
         size = arr.size
         check_size expected_size, size
         ptr = GirFFI::InPointer.from_array element_type, arr
         wrap element_type, size, ptr
       end
 
-      def check_size expected_size, size
+      def check_size(expected_size, size)
         if expected_size > 0 && size != expected_size
           raise ArgumentError, "Expected size #{expected_size}, got #{size}"
         end

data/lib/gir_ffi/type_map.rb

@@ -38,16 +38,16 @@ module GirFFI
       void:      :void
     }
 
-    def self.map_basic_type type
+    def self.map_basic_type(type)
       sym = type.to_sym
       TAG_TYPE_MAP[sym] || sym
     end
 
-    def self.type_specification_to_ffitype type
+    def self.type_specification_to_ffitype(type)
       type_specification_to_ffi_type type
     end
 
-    def self.type_specification_to_ffi_type type
+    def self.type_specification_to_ffi_type(type)
       case type
       when Module
         type.to_ffi_type

data/lib/gir_ffi/unintrospectable_type_info.rb

@@ -6,7 +6,9 @@ module GirFFI
   class UnintrospectableTypeInfo
     attr_reader :g_type
 
-    def initialize gtype, gir = GObjectIntrospection::IRepository.default, gobject = GObject
+    def initialize(gtype,
+                   gir = GObjectIntrospection::IRepository.default,
+                   gobject = GObject)
       @g_type = gtype
       @gir = gir
       @gobject = gobject

data/lib/gir_ffi/user_data_argument_info.rb

@@ -4,7 +4,7 @@ module GirFFI
   class UserDataArgumentInfo
     attr_reader :argument_type
 
-    def initialize type
+    def initialize(type)
       @argument_type = type
     end
 

data/lib/gir_ffi/user_defined_property_info.rb

@@ -2,7 +2,7 @@ module GirFFI
   # Represents a property of a user defined type, conforming, as needed, to the
   # interface of GObjectIntrospection::IPropertyInfo.
   class UserDefinedPropertyInfo
-    def initialize param_spec
+    def initialize(param_spec)
       @param_spec = param_spec
     end
 

data/lib/gir_ffi/user_defined_type_info.rb

@@ -8,7 +8,7 @@ module GirFFI
   class UserDefinedTypeInfo
     attr_reader :properties, :vfunc_implementations
 
-    def initialize klass
+    def initialize(klass)
       @klass = klass
       @properties = []
       @vfunc_implementations = []
@@ -19,15 +19,15 @@ module GirFFI
       @klass
     end
 
-    def install_property property
+    def install_property(property)
       @properties << UserDefinedPropertyInfo.new(property)
     end
 
-    def install_vfunc_implementation name, implementation
+    def install_vfunc_implementation(name, implementation)
       @vfunc_implementations << VFuncImplementation.new(name, implementation)
     end
 
-    def find_instance_method _method
+    def find_instance_method(_method)
       nil
     end
 

data/lib/gir_ffi/version.rb

@@ -1,4 +1,4 @@
 # Current GirFFI version
 module GirFFI
-  VERSION = '0.7.10'
+  VERSION = '0.8.0'
 end

data/lib/gir_ffi/vfunc_implementation.rb

@@ -3,7 +3,7 @@ module GirFFI
   class VFuncImplementation
     attr_reader :name, :implementation
 
-    def initialize name, implementation
+    def initialize(name, implementation)
       @name = name
       @implementation = implementation
     end

data/lib/gir_ffi/zero_terminated.rb

@@ -5,7 +5,7 @@ module GirFFI
 
     attr_reader :element_type
 
-    def initialize elm_t, ptr
+    def initialize(elm_t, ptr)
       @element_type = elm_t
       @ptr = ptr
     end
@@ -14,11 +14,11 @@ module GirFFI
       @ptr
     end
 
-    def self.from type, arg
+    def self.from(type, arg)
       new type, InPointer.from_array(type, arg)
     end
 
-    def self.wrap type, arg
+    def self.wrap(type, arg)
       new type, arg
     end
 
@@ -31,13 +31,13 @@ module GirFFI
       end
     end
 
-    def == other
+    def ==(other)
       to_a == other.to_a
     end
 
     private
 
-    def read_value offset
+    def read_value(offset)
       val = @ptr.send(getter_method, offset)
       val unless val.zero?
     end
@@ -46,7 +46,7 @@ module GirFFI
       @getter_method ||= "get_#{ffi_type}"
     end
 
-    def wrap_value val
+    def wrap_value(val)
       case element_type
       when Array
         element_type.last.wrap val

data/test/base_test_helper.rb

@@ -23,7 +23,7 @@ GObjectIntrospection::IRepository.prepend_search_path File.join(File.dirname(__F
 
 module GObjectIntrospection
   class IRepository
-    def shared_library_with_regress namespace
+    def shared_library_with_regress(namespace)
       case namespace
       when 'Regress'
         return File.join(File.dirname(__FILE__), 'lib', 'libregress.so')
@@ -42,41 +42,41 @@ end
 Thread.abort_on_exception = true
 
 module BaseTestExtensions
-  def assert_defines_singleton_method klass, method, msg = nil
+  def assert_defines_singleton_method(klass, method, msg = nil)
     method = method.to_sym
     methods = klass.singleton_methods(false).map(&:to_sym)
-    msg = message(msg) {
+    msg = message(msg) do
       "Expected #{mu_pp(klass)} to define singleton method #{mu_pp(method)}, " \
         "but only found #{mu_pp(methods)}"
-    }
+    end
     assert_includes methods, method, msg
   end
 
-  def refute_defines_singleton_method klass, method, msg = nil
+  def refute_defines_singleton_method(klass, method, msg = nil)
     method = method.to_sym
     methods = klass.singleton_methods(false).map(&:to_sym)
-    msg = message(msg) {
+    msg = message(msg) do
       "Expected #{mu_pp(klass)} not to define singleton method #{mu_pp(method)}"
-    }
+    end
     refute_includes methods, method, msg
   end
 
-  def assert_defines_instance_method klass, method, msg = nil
+  def assert_defines_instance_method(klass, method, msg = nil)
     method = method.to_sym
     methods = klass.instance_methods(false).map(&:to_sym)
-    msg = message(msg) {
+    msg = message(msg) do
       "Expected #{mu_pp(klass)} to define instance method #{mu_pp(method)}, " \
         "but only found #{mu_pp(methods)}"
-    }
+    end
     assert_includes methods, method, msg
   end
 
-  def refute_defines_instance_method klass, method, msg = nil
+  def refute_defines_instance_method(klass, method, msg = nil)
     method = method.to_sym
     methods = klass.instance_methods(false).map(&:to_sym)
-    msg = message(msg) {
+    msg = message(msg) do
       "Expected #{mu_pp(klass)} not to define instance method #{mu_pp(method)}"
-    }
+    end
     refute_includes methods, method, msg
   end
 end

data/test/ffi-gobject/object_test.rb

@@ -15,7 +15,7 @@ describe GObject::Object do
         @x
       end
 
-      def set_x val
+      def set_x(val)
         @x = val
       end
     end
@@ -68,4 +68,25 @@ describe GObject::Object do
       end
     end
   end
+
+  describe 'upon garbage collection' do
+    it 'lowers the reference count' do
+      if defined?(RUBY_ENGINE) && %w(jruby rbx).include?(RUBY_ENGINE)
+        skip 'cannot be reliably tested on JRuby and Rubinius'
+      end
+
+      object = GObject::Object.new GObject::TYPE_OBJECT, nil
+      ptr = object.to_ptr
+      ref_count(ptr).must_equal 1
+
+      # Lose reference to object to allow garbage collection
+      object = nil # rubocop:disable Lint/UselessAssignment
+
+      GC.start
+      GC.start
+      GC.start
+
+      ref_count(ptr).must_equal 0
+    end
+  end
 end

data/test/ffi-gobject/value_test.rb

@@ -45,77 +45,77 @@ describe GObject::Value do
   describe '#set_value' do
     it 'handles char values' do
       value = 83
-      gv = GObject::Value.for_g_type GObject::TYPE_CHAR
+      gv = GObject::Value.for_gtype GObject::TYPE_CHAR
       gv.set_value value
       gv.get_char.must_equal value
     end
 
     it 'handles enum values presented as symbols' do
       value = :value2
-      gv = GObject::Value.for_g_type Regress::TestEnum.gtype
+      gv = GObject::Value.for_gtype Regress::TestEnum.gtype
       gv.set_value value
       gv.get_value.must_equal value
     end
 
     it 'handles enum values presented as numbers' do
       value = :value2
-      gv = GObject::Value.for_g_type Regress::TestEnum.gtype
+      gv = GObject::Value.for_gtype Regress::TestEnum.gtype
       gv.set_value Regress::TestEnum[value]
       gv.get_value.must_equal value
     end
 
     it 'handles GType values' do
       value = GObject::TYPE_STRING
-      gv = GObject::Value.for_g_type GObject::TYPE_GTYPE
+      gv = GObject::Value.for_gtype GObject::TYPE_GTYPE
       gv.set_value value
       gv.get_gtype.must_equal value
     end
 
     it 'handles int64 values' do
       value = 0x1234_5678_9012_3456
-      gv = GObject::Value.for_g_type GObject::TYPE_INT64
+      gv = GObject::Value.for_gtype GObject::TYPE_INT64
       gv.set_value value
       gv.get_int64.must_equal value
     end
 
     it 'handles long values' do
       value = FFI.type_size(:long) == 8 ? 0x1234_5678_9012_3456 : 0x1234_5678
-      gv = GObject::Value.for_g_type GObject::TYPE_LONG
+      gv = GObject::Value.for_gtype GObject::TYPE_LONG
       gv.set_value value
       gv.get_long.must_equal value
     end
 
     it 'handles uchar values' do
       value = 83
-      gv = GObject::Value.for_g_type GObject::TYPE_UCHAR
+      gv = GObject::Value.for_gtype GObject::TYPE_UCHAR
       gv.set_value value
       gv.get_uchar.must_equal value
     end
 
     it 'handles uint values' do
       value = 0x1234_5678
-      gv = GObject::Value.for_g_type GObject::TYPE_UINT
+      gv = GObject::Value.for_gtype GObject::TYPE_UINT
       gv.set_value value
       gv.get_uint.must_equal value
     end
 
     it 'handles uint64 values' do
       value = 0x1234_5678_9012_3456
-      gv = GObject::Value.for_g_type GObject::TYPE_UINT64
+      gv = GObject::Value.for_gtype GObject::TYPE_UINT64
       gv.set_value value
       gv.get_uint64.must_equal value
     end
 
     it 'handles ulong values' do
       value = FFI.type_size(:long) == 8 ? 0x1234_5678_9012_3456 : 0x1234_5678
-      gv = GObject::Value.for_g_type GObject::TYPE_ULONG
+      gv = GObject::Value.for_gtype GObject::TYPE_ULONG
       gv.set_value value
       gv.get_ulong.must_equal value
     end
 
     it 'handles variant values' do
       value = GLib::Variant.new_string('Foo')
-      gv = GObject::Value.for_g_type GObject::TYPE_VARIANT
+      gv = GObject::Value.for_gtype GObject::TYPE_VARIANT
       gv.set_value value
       gv.get_variant.must_equal value
     end
@@ -136,84 +136,84 @@ describe GObject::Value do
 
     it 'unwraps a char' do
       value = 3
-      gv = GObject::Value.for_g_type GObject::TYPE_CHAR
+      gv = GObject::Value.for_gtype GObject::TYPE_CHAR
       gv.set_char value
       gv.get_value.must_equal value
     end
 
     it 'unwraps an enum value' do
       value = :value2
-      gv = GObject::Value.for_g_type Regress::TestEnum.gtype
+      gv = GObject::Value.for_gtype Regress::TestEnum.gtype
       gv.set_enum Regress::TestEnum[value]
       gv.get_value.must_equal value
     end
 
     it 'unwraps a flags value' do
       value = Regress::TestFlags[:flag1] | Regress::TestFlags[:flag3]
-      gv = GObject::Value.for_g_type Regress::TestFlags.gtype
+      gv = GObject::Value.for_gtype Regress::TestFlags.gtype
       gv.set_flags value
       gv.get_value.must_equal value
     end
 
     it 'unwraps a GType' do
       value = GObject::TYPE_STRING
-      gv = GObject::Value.for_g_type GObject::TYPE_GTYPE
+      gv = GObject::Value.for_gtype GObject::TYPE_GTYPE
       gv.set_gtype value
       gv.get_value.must_equal value
     end
 
     it 'unwraps an int64' do
       value = 0x1234_5678_9012_3456
-      gv = GObject::Value.for_g_type GObject::TYPE_INT64
+      gv = GObject::Value.for_gtype GObject::TYPE_INT64
       gv.set_int64 value
       gv.get_value.must_equal value
     end
 
     it 'unwraps a long' do
       value = FFI.type_size(:long) == 8 ? 0x1234_5678_9012_3456 : 0x1234_5678
-      gv = GObject::Value.for_g_type GObject::TYPE_LONG
+      gv = GObject::Value.for_gtype GObject::TYPE_LONG
       gv.set_long value
       gv.get_value.must_equal value
     end
 
     it 'unwraps an uchar' do
       value = 3
-      gv = GObject::Value.for_g_type GObject::TYPE_UCHAR
+      gv = GObject::Value.for_gtype GObject::TYPE_UCHAR
       gv.set_uchar value
       gv.get_value.must_equal value
     end
 
     it 'unwraps an uint' do
       value = 0x1234_5678
-      gv = GObject::Value.for_g_type GObject::TYPE_UINT
+      gv = GObject::Value.for_gtype GObject::TYPE_UINT
       gv.set_uint value
       gv.get_value.must_equal value
     end
 
     it 'unwraps an uint64' do
       value = 0x1234_5678_9012_3456
-      gv = GObject::Value.for_g_type GObject::TYPE_UINT64
+      gv = GObject::Value.for_gtype GObject::TYPE_UINT64
       gv.set_uint64 value
       gv.get_value.must_equal value
     end
 
     it 'unwraps a ulong' do
       value = FFI.type_size(:long) == 8 ? 0x1234_5678_9012_3456 : 0x1234_5678
-      gv = GObject::Value.for_g_type GObject::TYPE_ULONG
+      gv = GObject::Value.for_gtype GObject::TYPE_ULONG
       gv.set_ulong value
       gv.get_value.must_equal value
     end
 
     it 'unwraps a variant' do
       value = GLib::Variant.new_string('Foo')
-      gv = GObject::Value.for_g_type GObject::TYPE_VARIANT
+      gv = GObject::Value.for_gtype GObject::TYPE_VARIANT
       gv.set_variant value
       gv.get_value.must_equal value
     end
 
     it 'works with a ByteArray' do
       ba = GLib::ByteArray.new.append('some bytes')
-      v = GObject::Value.for_g_type GObject::TYPE_BYTE_ARRAY
+      v = GObject::Value.for_gtype GObject::TYPE_BYTE_ARRAY
       v.set_boxed ba
 
       result = v.get_value
@@ -224,7 +224,7 @@ describe GObject::Value do
 
     it 'works with an Array' do
       arr = GLib::Array.from(:uint, [1, 2, 3])
-      v = GObject::Value.for_g_type GObject::TYPE_ARRAY
+      v = GObject::Value.for_gtype GObject::TYPE_ARRAY
       v.set_boxed arr
 
       result = v.get_value