gir_ffi 0.2.1 → 0.2.2

data/History.txt

@@ -1,3 +1,10 @@
+== 0.2.2 / 2011-12-07
+
+* Fix issue #19: Check if a GLib::PtrArray.add method was generated
+  before attempting to remove it.
+* Fix two issues with pretty printing that made output for GLib have syntax
+  errors.
+
 == 0.2.1 / 2011-11-20
 
 * Fix handling of output parameters that are arrays of pointers to

data/lib/ffi-glib/ptr_array.rb

@@ -16,7 +16,7 @@ module GLib
       end
 
       # Remove stub generated by builder.
-      undef :add
+      undef :add if method_defined? :add
 
       def add array, data
         array.add data

data/lib/ffi-gobject_introspection/i_function_info.rb

@@ -28,5 +28,9 @@ module GObjectIntrospection
     def throws?
       flags & 32 != 0
     end
+
+    def safe_name
+      name == '' ? '_' : name
+    end
   end
 end

data/lib/gir_ffi/builder/function.rb

@@ -43,13 +43,13 @@ module GirFFI::Builder
     end
 
     def filled_out_template
-      return <<-CODE
-	def #{@info.name} #{inargs.join(', ')}
-	  #{pre.join("\n")}
-	  #{capture}::#{@libmodule}.#{@info.symbol} #{callargs.join(', ')}
-	  #{post.join("\n")}
-	end
-      CODE
+      lines = pre
+      lines << "#{capture}::#{@libmodule}.#{@info.symbol} #{callargs.join(', ')}"
+      lines << post
+
+      code = "def #{@info.safe_name} #{inargs.join(', ')}\n"
+      code << lines.join("\n").indent
+      code << "\nend\n"
     end
 
     def inargs

data/lib/gir_ffi/builder/type/callback.rb

@@ -14,8 +14,11 @@ module GirFFI
         end
 
         def pretty_print
+          args = argument_types.map do |arg|
+            arg.is_a?(FFI::Enum) ? arg.tag : arg.inspect
+          end
           return "#{@classname} = Lib.callback #{callback_sym.inspect}, " +
-            "#{argument_types.inspect}, #{return_type.inspect}"
+            "[#{args.join(', ')}], #{return_type.inspect}"
         end
 
         def callback_sym

data/lib/gir_ffi/builder/type/struct_based.rb

@@ -13,7 +13,9 @@ module GirFFI
         include WithLayout
 
         def pretty_print
-          "class #{@classname}\nend"
+          s = "class #{@classname}\n"
+          s << pretty_print_methods
+          s << "end"
         end
 
         private

data/lib/gir_ffi/builder/type/with_methods.rb

@@ -6,11 +6,8 @@ module GirFFI
       # :object, :interface.
       module WithMethods
         def setup_method method
-          klass = build_class
-          meta = (class << klass; self; end)
-
           go = method_introspection_data method
-          attach_and_define_method method, go, meta
+          attach_and_define_method method, go, meta_class
         end
 
         def setup_instance_method method
@@ -20,6 +17,11 @@ module GirFFI
 
         private
 
+        def meta_class
+          klass = build_class
+          return (class << klass; self; end)
+        end
+
         def method_introspection_data method
           info.find_method method
         end
@@ -29,8 +31,12 @@ module GirFFI
           return !data.nil? && data.method? ? data : nil
         end
 
+        def function_definition_builder go
+          Builder::Function.new(go, lib)
+        end
+
         def function_definition go
-          Builder::Function.new(go, lib).generate
+          function_definition_builder(go).generate
         end
 
         def attach_and_define_method method, go, modul
@@ -55,6 +61,11 @@ module GirFFI
           "
         end
 
+        def pretty_print_methods
+          info.get_methods.map do |minfo|
+            function_definition_builder(minfo).pretty_print.indent + "\n"
+          end.join
+        end
       end
     end
   end

data/lib/gir_ffi/version.rb

@@ -1,4 +1,4 @@
 module GirFFI
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end
 

data/test/ffi-gobject_introspection/i_function_info_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../test_helper.rb', File.dirname(__FILE__))
+
+describe GObjectIntrospection::IFunctionInfo do
+  describe "#safe_name" do
+    it "keeps lower case names lower case" do
+      stub(ptr = Object.new).null? { false }
+      info = GObjectIntrospection::IFunctionInfo.wrap ptr
+      stub(info).name { "foo" }
+
+      assert_equal "foo", info.safe_name
+    end
+
+    it "returns a non-empty string if name is empty" do
+      stub(ptr = Object.new).null? { false }
+      info = GObjectIntrospection::IFunctionInfo.wrap ptr
+      stub(info).name { "" }
+
+      assert_equal "_", info.safe_name
+    end
+  end
+end
+
+

data/test/integration/pretty_print_test.rb

@@ -1,11 +1,31 @@
 require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
 
-describe "Pretty-printing the Regress module" do
-  before do
-    GirFFI.setup :Regress
+require 'tempfile'
+
+GirFFI.setup :Regress
+
+describe "Pretty-printing" do
+  def assert_syntax_ok str
+    tmp = Tempfile.new "gir_ffi"
+    tmp.write str
+    tmp.flush
+    is_ok = `ruby -c #{tmp.path} 2>&1`
+    assert_equal "Syntax OK\n", is_ok
+  end
+
+  describe "for the Regress module" do
+    it "runs without throwing an exception" do
+      Regress._builder.pretty_print
+    end
+
+    it "results in valid Ruby" do
+      assert_syntax_ok Regress._builder.pretty_print
+    end
   end
 
-  it "runs without throwing an exception" do
-    Regress._builder.pretty_print
+  describe "for the GLib module" do
+    it "results in valid Ruby" do
+      assert_syntax_ok GLib._builder.pretty_print
+    end
   end
 end

data/test/unit/callback_builder_test.rb

@@ -13,6 +13,20 @@ describe GirFFI::Builder::Type::Callback do
       assert_equal "TheCallback = Lib.callback :TheCallback, [:baz, :qux], :ret_type",
         builder.pretty_print
     end
+
+    it "renders enum argument types by their tags" do
+      stub(enum = FFI::Enum.new([])).tag { :EnumTag }
+
+      mock(info = Object.new).safe_name { "TheCallback" }
+      stub(info).namespace { "Foo" }
+      mock(GirFFI::Builder).ffi_function_return_type(info) { :ret_type }
+      mock(GirFFI::Builder).ffi_function_argument_types(info) { [ enum ] }
+
+      builder = GirFFI::Builder::Type::Callback.new(info)
+
+      assert_equal "TheCallback = Lib.callback :TheCallback, [EnumTag], :ret_type",
+        builder.pretty_print
+    end
   end
 end
 

data/test/unit/function_builder_test.rb

@@ -16,15 +16,16 @@ describe GirFFI::Builder::Function do
     fbuilder = GirFFI::Builder::Function.new go, Lib
     code = fbuilder.generate
 
-    expected =
-      "def test_array_fixed_out_objects
+    expected = <<-CODE
+      def test_array_fixed_out_objects 
         _v1 = GirFFI::InOutPointer.for_array [:pointer, ::Regress::TestObj]
         ::Lib.regress_test_array_fixed_out_objects _v1
         _v2 = _v1.to_sized_array_value 2
         return _v2
-      end"
+      end
+      CODE
 
-    assert_equal cws(expected), cws(code)
+    assert_equal expected.reset_indentation, code
   end
 
 end

data/test/unit/struct_builder_test.rb

@@ -2,13 +2,41 @@ require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
 
 describe GirFFI::Builder::Type::Struct do
   describe "#pretty_print" do
-    it "returns a class block" do
-      mock(info = Object.new).safe_name { "Bar" }
-      stub(info).namespace { "Foo" }
+    describe "for a struct with no methods" do
+      it "returns a class block" do
+        mock(info = Object.new).safe_name { "Bar" }
+        stub(info).namespace { "Foo" }
+        stub(info).get_methods { [] }
 
-      builder = GirFFI::Builder::Type::Struct.new(info)
+        builder = GirFFI::Builder::Type::Struct.new(info)
 
-      assert_equal "class Bar\nend", builder.pretty_print
+        assert_equal "class Bar\nend", builder.pretty_print
+      end
+    end
+
+    describe "for a struct with a method" do
+      it "returns a class block with the pretty printed method inside" do
+        # FIXME: Loads of mocks. Make info objects create their own builders.
+
+        # Function info and its builder
+        stub(func_info = Object.new).info_type { :function }
+        mock(func_builder = Object.new).pretty_print { "def foo\n  function_body\nend" }
+        mock(GirFFI::Builder::Function).new(func_info, :bla) { func_builder }
+
+        # Struct info
+        mock(info = Object.new).safe_name { "Bar" }
+        stub(info).namespace { "Foo" }
+        mock(info).get_methods { [func_info] }
+
+        # Struct builder
+        builder = GirFFI::Builder::Type::Struct.new(info)
+        stub(builder).lib { :bla }
+
+        res = builder.pretty_print
+        expected = "class Bar\n  def foo\n    function_body\n  end\nend"
+
+        assert_equal expected, res
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gir_ffi
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-20 00:00:00.000000000 Z
+date: 2011-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &12290620 !ruby/object:Gem::Requirement
+  requirement: &11478020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.8
   type: :runtime
   prerelease: false
-  version_requirements: *12290620
+  version_requirements: *11478020
 - !ruby/object:Gem::Dependency
   name: indentation
-  requirement: &12289700 !ruby/object:Gem::Requirement
+  requirement: &11477500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *12289700
+  version_requirements: *11477500
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &12288300 !ruby/object:Gem::Requirement
+  requirement: &11477020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.0.2
   type: :development
   prerelease: false
-  version_requirements: *12288300
+  version_requirements: *11477020
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &12285900 !ruby/object:Gem::Requirement
+  requirement: &11476540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.2
   type: :development
   prerelease: false
-  version_requirements: *12285900
+  version_requirements: *11476540
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &12284940 !ruby/object:Gem::Requirement
+  requirement: &11476060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *12284940
+  version_requirements: *11476060
 description: 
 email:
 - matijs@matijs.net
@@ -170,6 +170,7 @@ files:
 - test/ffi-gobject_introspection/i_object_info_test.rb
 - test/ffi-gobject_introspection/i_base_info_test.rb
 - test/ffi-gobject_introspection/lib_test.rb
+- test/ffi-gobject_introspection/i_function_info_test.rb
 - test/ffi-gobject_introspection/i_constant_info_test.rb
 - test/test_helper.rb
 - test/girffi_test.rb
@@ -273,6 +274,7 @@ test_files:
 - test/ffi-gobject/value_test.rb
 - test/ffi-gobject_introspection/i_base_info_test.rb
 - test/ffi-gobject_introspection/i_constant_info_test.rb
+- test/ffi-gobject_introspection/i_function_info_test.rb
 - test/ffi-gobject_introspection/i_object_info_test.rb
 - test/ffi-gobject_introspection/i_repository_test.rb
 - test/ffi-gobject_introspection/lib_test.rb