gir_ffi-pretty_printer 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c0972787e8016633eadd896926b50eb5cb337e9
-  data.tar.gz: d4799c0d388521fce609befae9993b2f74588327
+  metadata.gz: b2a81f357003e2ff4209471ee6b1cc08a460919e
+  data.tar.gz: c7e37c2dd1a1c521247b0177098dfbfd90fd73cf
 SHA512:
-  metadata.gz: 86b9372afa74baceeeb287269d6e38653652778da8e6bf87de1e5e4b313f96f875250f18622954cd24b10c559dd08baf5204017fb8dce0e9b63c0afd68a63ef2
-  data.tar.gz: f134b17cc17e7b188feabd2195aeb4d27b0ff1dc61b8d3da75a390db86eb61a15c7ff7909ed929c4a5e5b8f5d4c5028a30a574e7d912f0d858d5a17d64bb5ae5
+  metadata.gz: db586351335e44d0424323ba4cb8884679cf2009017a90c9d742275a15fd0c72be2daf791a75f956cfe3b8e54817fb8d9c8737cab3f4e049ad241f054668cd2a
+  data.tar.gz: 7c80943037288f0dc9f819eabe84d28d9f2269a319275446c4fe3120a4529b5ccab9a0bb370d46eeaacf6add153ff55e81dd2ee91057440e98d8e524fe8b984f

data/README.md

@@ -6,18 +6,17 @@ Pretty-printer for modules generated by GirFFI.
 
 * Prints generated, overridden and hand-added methods.
 * Uses the `mvz-live_ast` gem to inspect runtime-generated methods.
-* Needs MRI 1.9.3 or higher.
+* Needs MRI 2.1 or higher.
 
 ## Usage
 
-    # The pretty-printer must be required first!
     require 'gir_ffi-pretty_printer'
-    require 'gir_ffi'
 
     # Any version
-    GirFFI::PrettyPrinter.new.pretty_print 'GObject'
+    puts GirFFI::PrettyPrinter.new.pretty_print 'GObject'
+
     # A specific version
-    GirFFI::PrettyPrinter.new.pretty_print 'Gtk', '3.0'
+    puts GirFFI::PrettyPrinter.new.pretty_print 'Gtk', '3.0'
 
 ## Install
 
@@ -25,7 +24,7 @@ Pretty-printer for modules generated by GirFFI.
 
 ## License
 
-Copyright © 2012--2014, [Matijs van Zuijlen](http://www.matijs.net/)
+Copyright © 2012–2015, [Matijs van Zuijlen](http://www.matijs.net/)
 
 GirFFI-PrettyPrinter is free software, distributed under the terms of
 the GNU Lesser General Public License, version 2.1 or later. See the

data/Rakefile

@@ -1,27 +1,28 @@
+require 'rake/clean'
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'yard'
 
 namespace :test do
   Rake::TestTask.new(:unit) do |t|
     t.libs = ['lib']
-    t.ruby_opts += ["-w -Itest"]
+    t.ruby_opts += ['-w -Itest']
     t.test_files = FileList['test/gir_ffi-pretty_printer/*_test.rb']
     t.warning = true
   end
 
-  Rake::TestTask.new(:end_to_end) do |t|
+  Rake::TestTask.new(:integration) do |t|
     t.libs = ['lib']
-    t.ruby_opts += ["-w -Itest"]
-    t.test_files = FileList['test/end_to_end/*_test.rb']
+    t.ruby_opts += ['-w -Itest']
+    t.test_files = FileList['test/integration/*_test.rb']
     t.warning = true
   end
 
-  task :all => [:unit, :end_to_end]
+  task all: [:unit, :integration]
 end
 
 YARD::Rake::YardocTask.new
 
-task :test => 'test:all'
-
-task :default => 'test'
+task test: 'test:all'
 
+task default: 'test'

data/lib/gir_ffi-pretty_printer/class_pretty_printer.rb

@@ -0,0 +1,84 @@
+class GirFFI::ClassPrettyPrinter
+  def initialize(klass)
+    @klass = klass
+    @printed_instance_methods = []
+  end
+
+  def pretty_print
+    arr = []
+    arr << "class #{@klass.name} < #{@klass.superclass.name}"
+    arr << pretty_print_singleton_methods.indent
+    arr << pretty_print_instance_methods.indent
+    arr << 'end'
+    arr.join "\n"
+  end
+
+  private
+
+  def pretty_print_instance_methods
+    arr =
+      instance_method_list.map { |mth| pretty_print_method(mth) } +
+      instance_method_list.map { |mth| pretty_print_alias(mth) }
+    arr.compact.join "\n"
+  end
+
+  def instance_method_name_list
+    @klass.instance_methods(false).sort
+  end
+
+  def instance_method_list
+    @instance_method_list ||=
+      instance_method_name_list.map { |name| @klass.instance_method name }
+  end
+
+  def pretty_print_alias(meth)
+    if meth.name != meth.original_name
+      "alias_method '#{meth.name}', '#{meth.original_name}'"
+    end
+  end
+
+  def pretty_print_method(meth)
+    return if instance_method_printed? meth.original_name
+    @printed_instance_methods << meth.original_name
+    method_source meth
+  end
+
+  def method_source(meth)
+    if meth.arity == -1
+      unless @klass.setup_instance_method meth.name.to_s
+        @klass.setup_instance_method ''
+      end
+
+      meth = @klass.instance_method meth.name
+    end
+
+    begin
+      meth.to_ruby
+    rescue => e
+      warn "Printing #{@klass.name}##{meth.name} failed: #{e.message}"
+    end
+  end
+
+  def instance_method_printed?(mname)
+    @printed_instance_methods.include? mname
+  end
+
+  def pretty_print_singleton_methods
+    arr = []
+    @klass.methods(false).sort.each do |mname|
+      meth = @klass.method mname
+
+      if meth.arity == -1
+        @klass.setup_method mname.to_s
+        meth = @klass.method mname
+      end
+
+      begin
+        arr << meth.to_ruby
+      rescue => e
+        warn "Printing #{@klass.name}.#{mname} failed: #{e.message}"
+      end
+    end
+    arr.join "\n"
+  end
+end

data/lib/gir_ffi-pretty_printer/pretty_printer.rb

@@ -2,57 +2,15 @@ require 'live_ast/full'
 require 'live_ast/to_ruby'
 require 'gir_ffi'
 require 'indentation'
+require 'gir_ffi-pretty_printer/class_pretty_printer'
 
 class GirFFI::PrettyPrinter
-  def pretty_print_class klass
-    arr = []
-    arr << "class #{klass.name} < #{klass.superclass.name}"
-    arr << pretty_print_singleton_methods(klass).indent
-    arr << pretty_print_instance_methods(klass).indent
-    arr << "end"
-    arr.join "\n"
-  end
-
-  def pretty_print_instance_methods klass
-    arr = []
-    klass.instance_methods(false).each do |mname|
-      meth = klass.instance_method mname
-
-      if meth.arity == -1
-        klass.setup_instance_method mname.to_s
-        meth = klass.instance_method mname
-      end
-
-      begin
-        arr << meth.to_ruby
-      rescue => e
-        warn "Printing #{klass.name}##{mname} failed: #{e.message}"
-      end
-    end
-    arr.join "\n"
-  end
-
-  def pretty_print_singleton_methods klass
-    arr = []
-    klass.methods(false).each do |mname|
-      meth = klass.method mname
-
-      if meth.arity == -1
-        klass.setup_method mname.to_s
-        meth = klass.method mname
-      end
-
-      begin
-        arr << meth.to_ruby
-      rescue => e
-        warn "Printing #{klass.name}.#{mname} failed: #{e.message}"
-      end
-    end
-    arr.join "\n"
+  def pretty_print_class(klass)
+    GirFFI::ClassPrettyPrinter.new(klass).pretty_print
   end
 
-  def pretty_print_function modul, mname
-    str = ""
+  def pretty_print_function(modul, mname)
+    str = ''
     begin
       modul.setup_method mname.to_s unless modul.respond_to? mname
 
@@ -64,12 +22,15 @@ class GirFFI::PrettyPrinter
     str
   end
 
-  def pretty_print_constant modul, const_name
+  def pretty_print_constant(modul, const_name)
     value = modul.const_get(const_name)
     "#{const_name} = #{value.inspect}"
+  rescue => e
+    warn "Printing #{modul.name}.#{const_name} failed: #{e.message}"
+    ''
   end
 
-  def pretty_print module_name, version = nil
+  def pretty_print(module_name, version = nil)
     GirFFI.setup module_name, version
     arr = []
     gir = GObjectIntrospection::IRepository.default
@@ -81,12 +42,11 @@ class GirFFI::PrettyPrinter
     infos.each do |info|
       case info.info_type
       when :struct, :object
-        # FIXME: We skip IConv for now since building it fails.
-        if info.name == "IConv"
-          warn "Skipping #{module_name}::#{info.name}"
-        else
+        begin
           klass = GirFFI::Builder.build_class info
           arr << pretty_print_class(klass).indent
+        rescue SyntaxError
+          warn "Skipping #{module_name}::#{info.name}: build failed"
         end
       when :constant
         arr << pretty_print_constant(modul, info.name).indent
@@ -97,7 +57,7 @@ class GirFFI::PrettyPrinter
       end
     end
 
-    arr << "end"
+    arr << "end\n"
     arr.join "\n"
   end
 end

data/test/gir_ffi-pretty_printer/class_pretty_printer_test.rb

@@ -0,0 +1,92 @@
+require 'test_helper'
+
+class SimpleClass
+  def bar
+    'hello'
+  end
+end
+
+class SimpleAlias
+  def bar
+    'hello'
+  end
+
+  alias_method :foo, :bar
+end
+
+class ComplexAlias
+  def baz
+    'original'
+  end
+
+  alias_method :baz_without_qux, :baz
+
+  def baz_with_qux
+    baz_without_qux + '-more'
+  end
+
+  alias_method :baz, :baz_with_qux
+end
+
+describe GirFFI::ClassPrettyPrinter do
+  let(:instance) { GirFFI::ClassPrettyPrinter.new klass }
+
+  describe '#pretty_print' do
+    describe 'for a class with a simple method definition' do
+      let(:klass) { SimpleClass }
+      it 'pretty-prints the class' do
+        expected = <<-END.reset_indentation.chomp
+          class SimpleClass < Object
+
+            def bar
+              "hello"
+            end
+          end
+        END
+
+        result = instance.pretty_print
+        result.must_equal expected
+      end
+    end
+
+    describe 'for a class with a simple aliased method' do
+      let(:klass) { SimpleAlias }
+      it 'pretty-prints the class' do
+        expected = <<-END.reset_indentation.chomp
+          class SimpleAlias < Object
+
+            def bar
+              "hello"
+            end
+            alias_method 'foo', 'bar'
+          end
+        END
+
+        result = instance.pretty_print
+        result.must_equal expected
+      end
+    end
+
+    describe 'for a class with an alias chain' do
+      let(:klass) { ComplexAlias }
+      it 'pretty-prints the class' do
+        expected = <<-END.reset_indentation.chomp
+          class ComplexAlias < Object
+
+            def baz_with_qux
+              (baz_without_qux + "-more")
+            end
+            def baz
+              "original"
+            end
+            alias_method 'baz', 'baz_with_qux'
+            alias_method 'baz_without_qux', 'baz'
+          end
+        END
+
+        result = instance.pretty_print
+        result.must_equal expected
+      end
+    end
+  end
+end

data/test/gir_ffi-pretty_printer/pretty_printer_test.rb

@@ -1,15 +1,10 @@
 require 'test_helper'
 describe GirFFI::PrettyPrinter do
-  describe "#initialize" do
-    it "takes no arguments" do
-      GirFFI::PrettyPrinter.new
-    end
-  end
-
-  describe "#pretty_print" do
+  describe '#pretty_print' do
     let(:instance) { GirFFI::PrettyPrinter.new }
-    it "pretty-prints a module without type specification" do
+    it 'pretty-prints a module without version specification' do
       instance.pretty_print 'GObject'
+      pass
     end
   end
 end