gir_ffi 0.7.9 → 0.7.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9da5e936faa40d8974a094267b9da5c302fd08c
-  data.tar.gz: 441e768cda62450ab418c941703e9cff26e28c0a
+  metadata.gz: c78011dfb34b7799b25df253c661de0b9bce5115
+  data.tar.gz: d83510e42c93f89563af82eb7e4d4316def805f5
 SHA512:
-  metadata.gz: 09115a044eee555798d204123d566e10c7fb291f679fb2bfa6d18123716a618de6dcbcd5a23e49fc890b8d2c221046df21f34ac52e92d9939a1cd723fbdac3af
-  data.tar.gz: 6cb2722920829fe0e81ca48ee8fd8e19d5fade1f34d461608c6d8cb43b5421917074b8173a0010e0a07e796ea57d0369799c3db39f81b6b8571a8beea5d5a8a4
+  metadata.gz: bd02e60de28ecdeff0b15eed790feed6c2e744df44bd473b10914573acced71c6c6613e55cf7f5bfbd62e21501fa6322274bc341be2a1de943ea574fdee82409
+  data.tar.gz: de8a61b783c0f46e9b83acb5157a3305bb66abda3e201f930021acf78786ea12b9d743e3c6783015df5b7663c5bb4c0c7ff430ff57cb64c6b5bed3b9fcc9c0ff

data/Changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.7.10 / 2015-09-16
+
+* Allow ffi-gobject and ffi-glib to be required directly
+* Improve documentation
+* Remove arbitrary refcount check from finalizer (by John Cupitt)
+
 ## 0.7.9 / 2015-05-05
 
 * Unset GValues in finalizer
@@ -89,8 +95,6 @@
 * 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/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# The gem's dependencies are specified in gir_ffi.gemspec
+gemspec
+
+if ENV['CI']
+  gem 'coveralls', type: :development, platform: :mri
+else
+  gem 'simplecov', '~> 0.10.0', type: :development, platform: :mri
+  gem 'pry', '~> 0.10.0', type: :development
+end

data/README.md

@@ -8,11 +8,12 @@ Ruby bindings for GNOME using the GObject Introspection Repository.
 
 ## Status
 
-[![Gem Version](https://badge.fury.io/rb/gir_ffi.png)](http://badge.fury.io/rb/gir_ffi)
-[![Dependency Status](https://gemnasium.com/mvz/gir_ffi.png)](https://gemnasium.com/mvz/gir_ffi)
-[![Build Status](https://travis-ci.org/mvz/gir_ffi.png?branch=master)](https://travis-ci.org/mvz/gir_ffi)
-[![Code Climate](https://codeclimate.com/github/mvz/gir_ffi.png)](https://codeclimate.com/github/mvz/gir_ffi)
-[![Coverage Status](https://coveralls.io/repos/mvz/gir_ffi/badge.png)](https://coveralls.io/r/mvz/gir_ffi)
+[![Gem Version](https://badge.fury.io/rb/gir_ffi.svg)](http://badge.fury.io/rb/gir_ffi)
+[![Dependency Status](https://gemnasium.com/mvz/gir_ffi.svg)](https://gemnasium.com/mvz/gir_ffi)
+[![Build Status](https://travis-ci.org/mvz/gir_ffi.svg?branch=master)](https://travis-ci.org/mvz/gir_ffi)
+[![Code Climate](https://codeclimate.com/github/mvz/gir_ffi/badges/gpa.svg)](https://codeclimate.com/github/mvz/gir_ffi)
+[![Coverage Status](https://coveralls.io/repos/mvz/gir_ffi/badge.svg?branch=master&service=github)](https://coveralls.io/github/mvz/gir_ffi?branch=master)
+[![Documentation Status](https://inch-ci.org/github/mvz/gir_ffi.svg?branch=master)](https://inch-ci.org/github/mvz/gir_ffi/branch/master)
 
 ## Features
 

data/lib/ffi-glib.rb

@@ -1,5 +1,4 @@
-# NOTE: Do not require this file directly. Require 'gir_ffi' instead.
-#
+require 'gir_ffi/core'
 
 GirFFI.setup :GLib
 

data/lib/ffi-glib/array.rb

@@ -20,6 +20,18 @@ module GLib
       wrap type, ptr
     end
 
+    # @api private
+    def self.from_enumerable elmtype, it
+      new(elmtype).tap { |arr| arr.append_vals it }
+    end
+
+    # @api private
+    def self.calculated_element_size type
+      ffi_type = GirFFI::TypeMap.type_specification_to_ffi_type(type)
+      FFI.type_size(ffi_type)
+    end
+
+    # @override
     def append_vals ary
       bytes = GirFFI::InPointer.from_array element_type, ary
       Lib.g_array_append_vals(self, bytes, ary.length)
@@ -36,10 +48,6 @@ module GLib
       @struct[:len]
     end
 
-    def data_ptr
-      @struct[:data]
-    end
-
     def get_element_size
       Lib.g_array_get_element_size self
     end
@@ -50,6 +58,7 @@ module GLib
       to_a == other.to_a
     end
 
+    # @api private
     def reset_typespec typespec = nil
       if typespec
         @element_type = typespec
@@ -60,15 +69,10 @@ module GLib
       self
     end
 
-    def self.from_enumerable elmtype, it
-      new(elmtype).tap { |arr| arr.append_vals it }
-    end
-
     private
 
-    def self.calculated_element_size type
-      ffi_type = GirFFI::TypeMap.type_specification_to_ffi_type(type)
-      FFI.type_size(ffi_type)
+    def data_ptr
+      @struct[:data]
     end
 
     def calculated_element_size

data/lib/ffi-glib/bytes.rb

@@ -7,12 +7,13 @@ module GLib
 
     remove_method :get_data if method_defined? :get_data
 
-    # Override for GBytes#get_data, needed due to mis-identification of the
-    # element-type of the resulting sized array.
+    # @override
     def get_data
       length_ptr = GirFFI::InOutPointer.for :gsize
       data_ptr = Lib.g_bytes_get_data self, length_ptr
       length = length_ptr.to_value
+      # NOTE: Needed due to mis-identification of the element-type of the
+      # resulting sized array for the default binding.
       GirFFI::SizedArray.wrap(:guint8, length, data_ptr)
     end
 

data/lib/ffi-glib/hash_table.rb

@@ -11,26 +11,6 @@ module GLib
     attr_reader :key_type
     attr_reader :value_type
 
-    def each
-      prc = proc {|keyptr, valptr, _userdata|
-        key = GirFFI::ArgHelper.cast_from_pointer key_type, keyptr
-        val = GirFFI::ArgHelper.cast_from_pointer value_type, valptr
-        yield key, val
-      }
-      callback = GLib::HFunc.from prc
-      ::GLib::Lib.g_hash_table_foreach to_ptr, callback, nil
-    end
-
-    def to_hash
-      Hash[to_a]
-    end
-
-    def insert key, value
-      keyptr = GirFFI::InPointer.from key_type, key
-      valptr = GirFFI::InPointer.from value_type, value
-      ::GLib::Lib.g_hash_table_insert to_ptr, keyptr, valptr
-    end
-
     class << self; remove_method :new; end
 
     def self.new keytype, valtype
@@ -38,11 +18,7 @@ module GLib
         hash_function_for(keytype), equality_function_for(keytype))
     end
 
-    def reset_typespec typespec
-      @key_type, @value_type = *typespec
-      self
-    end
-
+    # @api private
     def self.from_enumerable typespec, hash
       ghash = new(*typespec)
       hash.each do |key, val|
@@ -51,6 +27,7 @@ module GLib
       ghash
     end
 
+    # @api private
     def self.hash_function_for keytype
       case keytype
       when :utf8
@@ -60,6 +37,7 @@ module GLib
       end
     end
 
+    # @api private
     def self.equality_function_for keytype
       case keytype
       when :utf8
@@ -69,9 +47,37 @@ module GLib
       end
     end
 
+    # @api private
     def self.find_support_function name
       lib = ::GLib::Lib.ffi_libraries.first
       lib.find_function(name)
     end
+
+    def each
+      prc = proc {|keyptr, valptr, _userdata|
+        key = GirFFI::ArgHelper.cast_from_pointer key_type, keyptr
+        val = GirFFI::ArgHelper.cast_from_pointer value_type, valptr
+        yield key, val
+      }
+      callback = GLib::HFunc.from prc
+      ::GLib::Lib.g_hash_table_foreach to_ptr, callback, nil
+    end
+
+    def to_hash
+      Hash[to_a]
+    end
+
+    # @override
+    def insert key, value
+      keyptr = GirFFI::InPointer.from key_type, key
+      valptr = GirFFI::InPointer.from value_type, value
+      ::GLib::Lib.g_hash_table_insert to_ptr, keyptr, valptr
+    end
+
+    # @api private
+    def reset_typespec typespec
+      @key_type, @value_type = *typespec
+      self
+    end
   end
 end

data/lib/ffi-gobject.rb

@@ -1,5 +1,4 @@
-# NOTE: Do not require this file directly. Require 'gir_ffi' instead.
-#
+require 'gir_ffi/core'
 
 GirFFI.setup :GObject
 

data/lib/ffi-gobject/closure.rb

@@ -2,7 +2,12 @@ GObject.load_class :Closure
 
 module GObject
   # Overrides for GClosure, GObject's base class for closure objects.
+  #
+  # To create Closure objects wrapping Ruby code, use {RubyClosure}.
   class Closure
+    # @override
+    #
+    # @param [Proc] marshal The marshaller to use for this closure object
     def set_marshal marshal
       callback = GObject::ClosureMarshal.from marshal
       Lib.g_closure_set_marshal self, callback

data/lib/ffi-gobject/object.rb

@@ -14,7 +14,7 @@ module GObject
     def self.make_finalizer ptr, name
       proc {
         rc = GObject::Object::Struct.new(ptr)[:ref_count]
-        if rc == 0 || rc > 100
+        if rc == 0 
           warn "not unreffing #{name}:#{ptr} (#{rc})"
         else
           GObject::Lib.g_object_unref ptr

data/lib/ffi-gobject/ruby_closure.rb

@@ -1,32 +1,20 @@
 require 'ffi-gobject/closure'
 
 module GObject
-  # This class encapsulates Ruby
-  # blocks as GObject Closures.
+  # Encapsulates Ruby blocks as GObject Closures.
   class RubyClosure < Closure
+    # @api private
     BLOCK_STORE = {}
 
-    # Extend the standard GClosure layout with a field block_id to store
+    # Extend the standard +GObject::Closure+ layout with a field block_id to store
     # the object_id of the associated block.
+    #
+    # @api private
     class Struct < FFI::Struct
       layout :parent, Closure::Struct, 0,
              :block_id, :int64
     end
 
-    def block
-      BLOCK_STORE[@struct[:block_id]]
-    end
-
-    def block= block
-      id = block.object_id
-      BLOCK_STORE[id] = block
-      @struct[:block_id] = id
-    end
-
-    def invoke_block *args
-      block.call(*args)
-    end
-
     def self.new &block
       raise ArgumentError unless block_given?
 
@@ -37,6 +25,7 @@ module GObject
       closure
     end
 
+    # @api private
     def self.marshaller closure, return_value, param_values, _invocation_hint, _marshal_data
       # TODO: Improve by registering RubyClosure as a GObject type
       rclosure = wrap(closure.to_ptr)
@@ -48,5 +37,24 @@ module GObject
 
       return_value.set_ruby_value(result) if return_value
     end
+
+    # @api private
+    # TODO: Re-structure so block= and invoke_block can become private methods
+    def block= block
+      id = block.object_id
+      BLOCK_STORE[id] = block
+      @struct[:block_id] = id
+    end
+
+    # @api private
+    def invoke_block *args
+      block.call(*args)
+    end
+
+    private
+
+    def block
+      BLOCK_STORE[@struct[:block_id]]
+    end
   end
 end

data/lib/gir_ffi.rb

@@ -1,37 +1,4 @@
-require 'ffi'
-
-require 'gir_ffi-base'
-
-require 'ffi-gobject_introspection'
-
-require 'gir_ffi/ffi_ext'
-require 'gir_ffi/class_base'
-require 'gir_ffi/type_map'
-require 'gir_ffi/info_ext'
-require 'gir_ffi/in_pointer'
-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/version'
-
-# Main module containing classes and modules needed for generating GLib and
-# GObject bindings.
-module GirFFI
-  def self.setup module_name, version = nil
-    module_name = module_name.to_s
-    GirFFI::Builder.build_module module_name, version
-  end
-
-  def self.define_type klass, &block
-    info = UserDefinedTypeInfo.new(klass, &block)
-    Builders::UserDefinedBuilder.new(info).build_class
-
-    klass.gtype
-  end
-end
+require 'gir_ffi/core'
 
 require 'ffi-glib'
 require 'ffi-gobject'

data/lib/gir_ffi/core.rb

@@ -0,0 +1,34 @@
+require 'ffi'
+
+require 'gir_ffi-base'
+
+require 'ffi-gobject_introspection'
+
+require 'gir_ffi/ffi_ext'
+require 'gir_ffi/class_base'
+require 'gir_ffi/type_map'
+require 'gir_ffi/info_ext'
+require 'gir_ffi/in_pointer'
+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/version'
+
+# Main module containing classes and modules needed for generating GLib and
+# GObject bindings.
+module GirFFI
+  def self.setup module_name, version = nil
+    module_name = module_name.to_s
+    GirFFI::Builder.build_module module_name, version
+  end
+
+  def self.define_type klass, &block
+    info = UserDefinedTypeInfo.new(klass, &block)
+    Builders::UserDefinedBuilder.new(info).build_class
+
+    klass.gtype
+  end
+end

data/lib/gir_ffi/version.rb

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

data/test/ffi-glib/array_test.rb

@@ -70,12 +70,14 @@ describe GLib::Array do
   describe '.from' do
     it 'creates a GArray from an array of :gint32' do
       arr = GLib::Array.from :gint32, [3, 2, 1]
-      arr.data_ptr.read_array_of_int32(3).must_equal [3, 2, 1]
+      arr.must_be_instance_of GLib::Array
+      arr.to_a.must_equal [3, 2, 1]
     end
 
     it 'creates a GArray from an array of :gboolean' do
       arr = GLib::Array.from :gboolean, [true, false, true]
-      arr.data_ptr.read_array_of_int(3).must_equal [1, 0, 1]
+      arr.must_be_instance_of GLib::Array
+      arr.to_a.must_equal [true, false, true]
     end
 
     it 'return its argument if given a GArray' do

data/test/ffi-glib/ruby_closure_test.rb

@@ -16,7 +16,7 @@ describe GObject::RubyClosure do
     a = 0
     c = GObject::RubyClosure.new { a = 2 }
     c2 = GObject::RubyClosure.wrap(c.to_ptr)
-    c2.block.call
+    c2.invoke_block
     assert_equal 2, a
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gir_ffi
 version: !ruby/object:Gem::Version
-  version: 0.7.9
+  version: 0.7.10
 platform: ruby
 authors:
 - Matijs van Zuijlen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.5.1
+        version: '5.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.5.1
+        version: '5.5'
 - !ruby/object:Gem::Dependency
   name: minitest-rspec_mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -98,11 +98,11 @@ files:
 - COPYING.LIB
 - Changelog.md
 - DESIGN.md
+- Gemfile
 - README.md
 - Rakefile
 - TODO.md
 - examples/main_loop.rb
-- gir_ffi.gemspec
 - lib/ffi-glib.rb
 - lib/ffi-glib/array.rb
 - lib/ffi-glib/array_methods.rb
@@ -202,6 +202,7 @@ files:
 - lib/gir_ffi/builders/with_layout.rb
 - lib/gir_ffi/callback_base.rb
 - lib/gir_ffi/class_base.rb
+- lib/gir_ffi/core.rb
 - lib/gir_ffi/enum_base.rb
 - lib/gir_ffi/error_argument_info.rb
 - lib/gir_ffi/error_type_info.rb
@@ -370,7 +371,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: FFI-based GObject binding using the GObject Introspection Repository

data/gir_ffi.gemspec

@@ -1,41 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.join(File.dirname(__FILE__), 'lib/gir_ffi/version.rb')
-
-Gem::Specification.new do |s|
-  s.name = "gir_ffi"
-  s.version = GirFFI::VERSION
-
-  s.summary = "FFI-based GObject binding using the GObject Introspection Repository"
-  s.required_ruby_version = %q{>= 1.9.3}
-
-  s.authors = ["Matijs van Zuijlen"]
-  s.email = ["matijs@matijs.net"]
-  s.homepage = "http://www.github.com/mvz/ruby-gir-ffi"
-
-  s.license = 'LGPL-2.1'
-
-  s.description = <<-DESC
-    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.
-  DESC
-
-  s.files = Dir[ '{lib,test,tasks,examples}/**/*',
-                 "*.md",
-                 "*.gemspec",
-                 "Rakefile",
-                 "COPYING.LIB" ] & `git ls-files -z`.split("\0")
-
-  s.rdoc_options = ["--main", "README.md"]
-  s.extra_rdoc_files = ["DESIGN.md", "Changelog.md", "README.md", "TODO.md"]
-
-  s.add_runtime_dependency('ffi', ["~> 1.8"])
-  s.add_runtime_dependency('indentation', ["~> 0.1.1"])
-
-  s.add_development_dependency('minitest', ["~> 5.5.1"])
-  s.add_development_dependency('minitest-rspec_mocks', ["~> 0.2.0"])
-  s.add_development_dependency('rake', ["~> 10.1"])
-
-  s.require_paths = ["lib"]
-end