gir_ffi 0.0.4 → 0.0.5

data/tasks/notes.rake

@@ -1,13 +1,6 @@
 # The following code is copied straight from Bones 2.5.1
 #
 
-begin
-  require 'facets/ansicode'
-  HAVE_COLOR = true
-rescue LoadError
-  HAVE_COLOR = false
-end
-
 module Bones
 
 # A helper class used to find and display any annotations in a collection of
@@ -31,19 +24,18 @@ class AnnotationExtractor
   # will search for all athe annotations and display them on standard
   # output.
   #
-  def self.enumerate( project, tag, id = nil, opts = {} )
-    extractor = new(project, tag, id)
+  def self.enumerate tag, id = nil, opts = {}
+    extractor = new(tag, id)
     extractor.display(extractor.find, opts)
   end
 
-  attr_reader :tag, :project, :id
+  attr_reader :tag, :id
 
   # Creates a new annotation extractor configured to use the _project_ open
   # strcut and to search for the given _tag_ (which can be more than one tag
   # via a regular expression 'or' operation -- i.e. THIS|THAT|OTHER)
   #
-  def initialize( project, tag, id) 
-    @project = project
+  def initialize tag, id
     @tag = tag
     @id = @id_rgxp = nil
 
@@ -60,13 +52,9 @@ class AnnotationExtractor
     results = {}
     rgxp = %r/(#{tag}):?\s*(.*?)(?:\s*(?:-?%>|\*+\/))?$/o
 
-    extensions = project.notes.extensions.dup
-    exclude = if project.notes.exclude.empty? then nil
-              else Regexp.new(project.notes.exclude.join('|')) end
-
-    manifest.each do |fn|
-      next if exclude && exclude =~ fn
-      next unless extensions.include? File.extname(fn)
+    files = Dir.glob("lib/**/*.rb")
+    files += Dir.glob("test/**/*.rb")
+    files.each do |fn|
       results.update(extract_annotations_from(fn, rgxp))
     end
 
@@ -85,7 +73,6 @@ class AnnotationExtractor
 
       text = m[2]
       if text =~ @id_rgxp
-        text.gsub!(@id_rgxp) {|str| ANSICode.green(str)} if HAVE_COLOR
         list << Annotation.new(lineno, m[1], text)
       end
       list
@@ -110,25 +97,25 @@ class AnnotationExtractor
 end  # class AnnotationExtractor
 end  # module Bones
 
+note_tags = ["TODO", "FIXME", "OPTIMIZE"]
+
 desc "Enumerate all annotations"
 task :notes do |t|
   id = if t.application.top_level_tasks.length > 1
     t.application.top_level_tasks.slice!(1..-1).join(' ')
   end
   Bones::AnnotationExtractor.enumerate(
-      PROJ, PROJ.notes.tags.join('|'), id, :tag => true)
+      note_tags.join('|'), id, :tag => true)
 end
 
 namespace :notes do
-  PROJ.notes.tags.each do |tag|
+  note_tags.each do |tag|
     desc "Enumerate all #{tag} annotations"
     task tag.downcase.to_sym do |t|
       id = if t.application.top_level_tasks.length > 1
         t.application.top_level_tasks.slice!(1..-1).join(' ')
       end
-      Bones::AnnotationExtractor.enumerate(PROJ, tag, id)
+      Bones::AnnotationExtractor.enumerate(tag, id)
     end
   end
 end
-
-# EOF

data/tasks/setup.rb

@@ -1,138 +1,6 @@
-
-require 'rake'
 require 'rake/clean'
-require 'fileutils'
-require 'ostruct'
-require 'find'
-
-# TODO: Clean up bones' task set to remove unwanted parts.
-
-PROJ = OpenStruct.new(
-  # Project Defaults
-  :name => nil,
-  :summary => nil,
-  :description => nil,
-  :changes => nil,
-  :authors => nil,
-  :email => nil,
-  :url => "\000",
-  :version => ENV['VERSION'] || '0.0.0',
-  :exclude => %w(tmp$ bak$ ~$ CVS \.svn/ \.git/ ^pkg/),
-  :release_name => ENV['RELEASE'],
-
-  # System Defaults
-  :ruby_opts => %w(-w),
-  :libs => [],
-  :history_file => 'History.txt',
-  :readme_file => 'README.txt',
-  :ignore_file => '.bnsignore',
-
-  # File Annotations
-  :notes => OpenStruct.new(
-    :exclude => %w(^tasks/setup\.rb$),
-    :extensions => %w(.txt .rb .erb .rdoc) << '',
-    :tags => %w(FIXME OPTIMIZE TODO)
-  ),
-
-  # Test::Unit
-  :test => OpenStruct.new(
-    :files => FileList['test/**/*_test.rb'],
-    :file  => 'test/all.rb',
-    :opts  => []
-  )
-)
 
 # Load the other rake files in the tasks folder
 tasks_dir = File.expand_path(File.dirname(__FILE__))
-post_load_fn = File.join(tasks_dir, 'post_load.rake')
 rakefiles = Dir.glob(File.join(tasks_dir, '*.rake')).sort
-rakefiles.unshift(rakefiles.delete(post_load_fn)).compact!
 import(*rakefiles)
-
-# Setup the project libraries
-%w(lib ext).each {|dir| PROJ.libs << dir if test ?d, dir}
-
-%w(facets/ansicode).each do |lib|
-  begin
-    require lib
-    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", true}
-  rescue LoadError
-    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", false}
-  end
-end
-
-# Reads a file at +path+ and spits out an array of the +paragraphs+
-# specified.
-#
-#    changes = paragraphs_of('History.txt', 0..1).join("\n\n")
-#    summary, *description = paragraphs_of('README.txt', 3, 3..8)
-#
-def paragraphs_of( path, *paragraphs )
-  title = String === paragraphs.first ? paragraphs.shift : nil
-  ary = File.read(path).delete("\r").split(/\n\n+/)
-
-  result = if title
-    tmp, matching = [], false
-    rgxp = %r/^=+\s*#{Regexp.escape(title)}/i
-    paragraphs << (0..-1) if paragraphs.empty?
-
-    ary.each do |val|
-      if val =~ rgxp
-        break if matching
-        matching = true
-        rgxp = %r/^=+/i
-      elsif matching
-        tmp << val
-      end
-    end
-    tmp
-  else ary end
-
-  result.values_at(*paragraphs)
-end
-
-# Adds the given arguments to the include path if they are not already there
-#
-def ensure_in_path( *args )
-  args.each do |path|
-    path = File.expand_path(path)
-    $:.unshift(path) if test(?d, path) and not $:.include?(path)
-  end
-end
-
-# Scans the current working directory and creates a list of files that are
-# candidates to be in the manifest.
-#
-def manifest
-  files = []
-  exclude = PROJ.exclude.dup
-  comment = %r/^\s*#/
- 
-  # process the ignore file and add the items there to the exclude list
-  if test(?f, PROJ.ignore_file)
-    ary = []
-    File.readlines(PROJ.ignore_file).each do |line|
-      next if line =~ comment
-      line.chomp!
-      line.strip!
-      next if line.nil? or line.empty?
-
-      glob = line =~ %r/\*\./ ? File.join('**', line) : line
-      Dir.glob(glob).each {|fn| ary << "^#{Regexp.escape(fn)}"}
-    end
-    exclude.concat ary
-  end
-
-  # generate a regular expression from the exclude list
-  exclude = Regexp.new(exclude.join('|'))
-
-  Find.find '.' do |path|
-    path.sub! %r/^(\.\/|\/)/o, ''
-    next unless test ?f, path
-    next if path =~ exclude
-    files << path
-  end
-  files.sort!
-end
-
-# EOF

data/tasks/test.rake

@@ -1,22 +1,14 @@
-
-if test(?e, PROJ.test.file) or not PROJ.test.files.to_a.empty?
 require 'rake/testtask'
 
 namespace :test do
 
   Rake::TestTask.new(:run) do |t|
-    t.libs = PROJ.libs
-    t.test_files = if test(?f, PROJ.test.file) then [PROJ.test.file]
-                   else PROJ.test.files end
-    t.ruby_opts += PROJ.ruby_opts
-    t.ruby_opts += PROJ.test.opts
+    t.libs = ['lib']
+    t.test_files = FileList['test/**/*_test.rb']
+    t.ruby_opts += ["-w"]
   end
 
-end  # namespace :test
+end
 
 desc 'Alias to test:run'
 task :test => 'test:run'
-
-end
-
-# EOF

data/test/arg_helper_test.rb

@@ -16,10 +16,10 @@ class ArgHelperTest < Test::Unit::TestCase
     end
   end
 
-  context "The string_array_to_inoutptr method" do
+  context "The utf8_array_to_inoutptr method" do
     context "when called with an array of strings" do
       setup do
-	@result = GirFFI::ArgHelper.string_array_to_inoutptr ["foo", "bar", "baz"]
+	@result = GirFFI::ArgHelper.utf8_array_to_inoutptr ["foo", "bar", "baz"]
       end
 
       should "return a FFI::Pointer" do
@@ -34,7 +34,7 @@ class ArgHelperTest < Test::Unit::TestCase
     end
     context "when called with nil" do
       should "return nil" do
-	assert_nil GirFFI::ArgHelper.string_array_to_inoutptr nil
+	assert_nil GirFFI::ArgHelper.utf8_array_to_inoutptr nil
       end
     end
   end
@@ -50,7 +50,7 @@ class ArgHelperTest < Test::Unit::TestCase
     end
   end
 
-  context "The outptr_to_string_array method" do
+  context "The outptr_to_utf8_array method" do
     context "when called with a valid pointer to a string array" do
       setup do
 	p = GirFFI::AllocationHelper.safe_malloc FFI.type_size(:pointer) * 2
@@ -64,7 +64,7 @@ class ArgHelperTest < Test::Unit::TestCase
 
       should "return the string array" do
 	assert_equal ["one", "two"],
-	  GirFFI::ArgHelper.outptr_to_string_array(@ptr, 2)
+	  GirFFI::ArgHelper.outptr_to_utf8_array(@ptr, 2)
       end
     end
 
@@ -83,13 +83,13 @@ class ArgHelperTest < Test::Unit::TestCase
 
       should "return render the null pointer as nil" do
 	assert_equal ["one", "two", nil],
-	  GirFFI::ArgHelper.outptr_to_string_array(@ptr, 3)
+	  GirFFI::ArgHelper.outptr_to_utf8_array(@ptr, 3)
       end
     end
 
     context "when called with nil" do
       should "return nil" do
-	assert_nil GirFFI::ArgHelper.outptr_to_string_array(nil, 0)
+	assert_nil GirFFI::ArgHelper.outptr_to_utf8_array(nil, 0)
       end
     end
   end
@@ -109,4 +109,22 @@ class ArgHelperTest < Test::Unit::TestCase
       end
     end
   end
+
+  context "The pointer_outptr method" do
+    should "return a pointer to a null pointer" do
+      ptr = GirFFI::ArgHelper.pointer_outptr
+      pptr = ptr.read_pointer
+      assert pptr.null?
+    end
+  end
+
+  context "The object_pointer_to_object method" do
+    should "return an object of the correct class" do
+      GirFFI.setup :Everything
+      o = Everything::TestSubObj.new
+      o2 = GirFFI::ArgHelper.object_pointer_to_object o.to_ptr
+      assert_instance_of Everything::TestSubObj, o2
+      assert_equal o.to_ptr, o2.to_ptr
+    end
+  end
 end

data/test/builder_test.rb

@@ -3,7 +3,6 @@ require 'gir_ffi'
 
 class BuilderTest < Test::Unit::TestCase
   context "The GirFFI::Builder module" do
-    # TODO: Use gir's sample Everything library for testing instead.
     context "building GObject::Object" do
       setup do
 	cleanup_module :GObject
@@ -12,8 +11,8 @@ class BuilderTest < Test::Unit::TestCase
 
       should "create a Lib module in the parent namespace ready to attach functions from gobject-2.0" do
 	gir = GirFFI::IRepository.default
-	expected = gir.shared_library 'GObject'
-	assert_same_elements [*expected], GObject::Lib.ffi_libraries.map(&:name)
+	expected = gir.shared_library('GObject')
+	assert_equal [expected], GObject::Lib.ffi_libraries.map(&:name)
       end
 
       should "create an array CALLBACKS inside the GObject::Lib module" do
@@ -60,7 +59,7 @@ class BuilderTest < Test::Unit::TestCase
       end
 
       should "create a Gtk::Window#to_ptr method" do
-	assert_contains Gtk::Window.instance_methods.map(&:to_sym), :to_ptr
+	assert Gtk::Window.instance_methods.map(&:to_sym).include? :to_ptr
       end
 
       should "result in Gtk::Window.new to succeed" do
@@ -78,7 +77,7 @@ class BuilderTest < Test::Unit::TestCase
 	# The Gtk module has more than one library on my current machine.
 	gir = GirFFI::IRepository.default
 	expected = (gir.shared_library 'Gtk').split(',')
-	assert_same_elements expected, Gtk::Lib.ffi_libraries.map(&:name)
+	assert_equal expected.sort, Gtk::Lib.ffi_libraries.map(&:name).sort
       end
 
       should "create an array CALLBACKS inside the Gtk::Lib module" do
@@ -102,7 +101,7 @@ class BuilderTest < Test::Unit::TestCase
       setup do
 	@go = get_function_introspection_data 'Gtk', 'main'
       end
-      # TODO: function_introspection_data should not return introspection data if not a function.
+
       should "have correct introspection data" do
 	gir = GirFFI::IRepository.default
 	gir.require "Gtk", nil
@@ -119,7 +118,7 @@ class BuilderTest < Test::Unit::TestCase
 	end
 
 	GirFFI::Builder.send :attach_ffi_function, libmod, @go
-	assert_contains libmod.public_methods.map(&:to_sym), :gtk_main
+	assert libmod.public_methods.map(&:to_sym).include? :gtk_main
       end
     end
 
@@ -130,8 +129,6 @@ class BuilderTest < Test::Unit::TestCase
       end
 
       should "have :pointer, :pointer as types of the arguments for the attached function" do
-	# FIXME: Ideally, we attach the function and test that it requires
-	# the correct argument types.
 	assert_equal [:pointer, :pointer], GirFFI::Builder.send(:ffi_function_argument_types, @go)
       end
 
@@ -160,7 +157,7 @@ class BuilderTest < Test::Unit::TestCase
 
       should "have the correct types of the arguments for the attached function" do
 	argtypes = GirFFI::Builder.send(:ffi_function_argument_types, @go)
-	assert_equal [:pointer, :string, GObject::Callback, :pointer, GObject::ClosureNotify, GObject::ConnectFlags],
+	assert_equal [:pointer, :pointer, GObject::Callback, :pointer, GObject::ClosureNotify, GObject::ConnectFlags],
 	  argtypes
       end
 
@@ -182,11 +179,12 @@ class BuilderTest < Test::Unit::TestCase
 
     context "building Everything::TestStructA" do
       setup do
+	@fieldnames = [:some_int, :some_int8, :some_double, :some_enum]
 	GirFFI::Builder.build_class 'Everything', 'TestStructA'
       end
 
       should "set up the correct struct members" do
-	assert_equal [:some_int, :some_int8, :some_double, :some_enum],
+	assert_equal @fieldnames,
 	  Everything::TestStructA::Struct.members
       end
 
@@ -199,7 +197,7 @@ class BuilderTest < Test::Unit::TestCase
       should "set up struct members with the correct types" do
 	tags = [:int, :int8, :double, Everything::TestEnum]
 	assert_equal tags.map {|t| FFI.find_type t},
-	  Everything::TestStructA::Struct.layout.fields.map(&:type)
+	  @fieldnames.map {|f| Everything::TestStructA::Struct.layout[f].type}
       end
     end
 
@@ -215,7 +213,7 @@ class BuilderTest < Test::Unit::TestCase
 
       should "set up union members with the correct offset" do
 	assert_equal [0, 0, 0, 0, 0],
-	  GObject::TypeCValue::Struct.layout.fields.map(&:offset)
+	  GObject::TypeCValue::Struct.offsets.map {|o| o[1]}
       end
 
       should "set up the inner class as derived from FFI::Union" do
@@ -237,12 +235,14 @@ class BuilderTest < Test::Unit::TestCase
 	GirFFI::Builder.build_class 'Everything', 'TestBoxed'
       end
 
-      should "set up #_real_new as an alias to #new" do
-	assert Everything::TestBoxed.respond_to? "_real_new"
+      should "set up #wrap" do
+	assert Everything::TestBoxed.respond_to? "wrap"
       end
-    end
 
-    # TODO: Should not allow functions to be called as methods, etc.
+      should "set up #allocate" do
+	assert Everything::TestBoxed.respond_to? "allocate"
+      end
+    end
 
     context "built Everything module" do
       setup do
@@ -252,7 +252,7 @@ class BuilderTest < Test::Unit::TestCase
 
       should "have a method_missing method" do
 	ms = (Everything.public_methods - Module.public_methods).map(&:to_sym)
-	assert_contains ms, :method_missing
+	assert ms.include? :method_missing
       end
 
       should "autocreate the TestObj class" do
@@ -266,8 +266,6 @@ class BuilderTest < Test::Unit::TestCase
       end
     end
 
-    # TODO: Turn this into full test of instance method creation, including
-    # inheritance issues.
     context "built Everything::TestObj" do
       setup do
 	cleanup_module :Everything
@@ -306,7 +304,7 @@ class BuilderTest < Test::Unit::TestCase
 	should "have the correct types of the arguments for the attached function" do
 	  info = get_method_introspection_data 'Everything', 'TestObj',
 	    'torture_signature_0'
-	  assert_equal [:pointer, :int, :pointer, :pointer, :string, :pointer, :uint],
+	  assert_equal [:pointer, :int, :pointer, :pointer, :pointer, :pointer, :uint],
 	    GirFFI::Builder.send(:ffi_function_argument_types, info)
 	end
       end
@@ -338,5 +336,22 @@ class BuilderTest < Test::Unit::TestCase
 	assert_equal 0, subobj.instance_method
       end
     end
+
+    context "built Gio::ThreadedSocketService" do
+      setup do
+	cleanup_module :Gio
+	GirFFI::Builder.build_module 'Gio'
+      end
+
+      context "when parent constructor has been called" do
+	setup do
+	  Gio::SocketService.new
+	end
+
+	should "still use its own constructor" do
+	  assert_nothing_raised { Gio::ThreadedSocketService.new 2 }
+	end
+      end
+    end
   end
 end

data/test/class_base_test.rb

@@ -3,13 +3,6 @@ require 'gir_ffi/class_base'
 
 class ClassBaseTest < Test::Unit::TestCase
   context "A class derived from GirFFI::Base" do
-    setup do
-      @klass = Class.new(GirFFI::ClassBase) do
-	# Boilerplate to make regular #new work again.
-	def initialize; end
-	def self.new; self._real_new; end
-      end
-    end
     # TODO: See if we can test some part of Base again.
     should "pass" do
       assert true

data/test/class_builder_test.rb

@@ -49,6 +49,12 @@ class ClassBuilderTest < Test::Unit::TestCase
 	sig = builder.find_signal 'test'
 	assert_equal 'test', sig.name
       end
+
+      should 'find the signal "changed" for Gtk::Entry' do
+	builder = GirFFI::ClassBuilder.new 'Gtk', 'Entry'
+	sig = builder.find_signal 'changed'
+	assert_equal 'changed', sig.name
+      end
     end
 
     context "for GObject::TypeCValue (a union)" do