gir_ffi-pretty_printer 0.0.1

data/README.md

@@ -0,0 +1,32 @@
+# GirFFI-PrettyPrinter
+
+Pretty-printer for modules generated by GirFFI.
+
+## Features
+
+* Prints generated, overridden and hand-added methods.
+* Uses the `live_ast` gem to inspect runtime-generated methods.
+* Needs MRI 1.9.3.
+
+## Usage
+
+    # The pretty-printer must be required first!
+    require 'gir_ffi-pretty_printer'
+    require 'gir_ffi'
+
+    # Any version
+    GirFFI::PrettyPrinter.new.pretty_print 'GObject'
+    # A specific version
+    GirFFI::PrettyPrinter.new.pretty_print 'Gtk', '3.0'
+
+## Install
+
+    gem install gir_ffi-pretty_printer
+
+## License
+
+Copyright © 2012--2013, [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
+file COPYING.LIB for more information.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake/testtask'
+require 'yard'
+
+namespace :test do
+  Rake::TestTask.new(:unit) do |t|
+    t.libs = ['lib']
+    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|
+    t.libs = ['lib']
+    t.ruby_opts += ["-w -Itest"]
+    t.test_files = FileList['test/end_to_end/*_test.rb']
+    t.warning = true
+  end
+
+  task :all => [:unit, :end_to_end]
+end
+
+YARD::Rake::YardocTask.new
+
+task :test => 'test:all'
+
+task :default => 'test'
+

data/lib/gir_ffi-pretty_printer/pretty_printer.rb

@@ -0,0 +1,103 @@
+require 'live_ast/full'
+require 'live_ast/to_ruby'
+require 'gir_ffi'
+require 'indentation'
+
+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"
+  end
+
+  def pretty_print_function modul, mname
+    str = ""
+    begin
+      modul.setup_method mname.to_s unless modul.respond_to? mname
+
+      meth = modul.method mname
+      str << meth.to_ruby
+    rescue => e
+      warn "Printing #{modul.name}.#{mname} failed: #{e.message}"
+    end
+    str
+  end
+
+  def pretty_print_constant modul, const_name
+    value = modul.const_get(const_name)
+    "#{const_name} = #{value.inspect}"
+  end
+
+  def pretty_print module_name, version = nil
+    GirFFI.setup module_name, version
+    arr = []
+    gir = GObjectIntrospection::IRepository.default
+    modul = Kernel.const_get(module_name)
+    infos = gir.infos module_name
+
+    arr << "module #{module_name}"
+
+    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
+          klass = GirFFI::Builder.build_class info
+          arr << pretty_print_class(klass).indent
+        end
+      when :constant
+        arr << pretty_print_constant(modul, info.name).indent
+      when :function
+        arr << pretty_print_function(modul, info.name).indent
+      else
+        arr << "# XXX: Don't know how to print #{info.info_type}".indent
+      end
+    end
+
+    arr << "end"
+    arr.join "\n"
+  end
+end

data/lib/gir_ffi-pretty_printer.rb

@@ -0,0 +1 @@
+require 'gir_ffi-pretty_printer/pretty_printer'

data/test/gir_ffi-pretty_printer/pretty_printer_test.rb

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

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+
+require 'gir_ffi-pretty_printer'

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: gir_ffi-pretty_printer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matijs van Zuijlen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gir_ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: live_ast
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: boc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+description: Library and executable to pretty-print modules generated by GirFFI, taking
+  method overrides and hand-added methods into account.
+email:
+- matijs@matijs.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gir_ffi-pretty_printer.rb
+- lib/gir_ffi-pretty_printer/pretty_printer.rb
+- test/test_helper.rb
+- test/gir_ffi-pretty_printer/pretty_printer_test.rb
+- README.md
+- Rakefile
+homepage: http://www.github.com/mvz/gir_ffi-pretty_printer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Pretty-printer for modules generated by GirFFI
+test_files:
+- test/test_helper.rb
+- test/gir_ffi-pretty_printer/pretty_printer_test.rb
+has_rdoc: