drx 0.3.1 → 0.3.2

data/examples/drx_datamapper19.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'dm-core'
+$: << File.join('/home/mooffie/_drx.git/lib')
+require 'drx'
+
+
+
+#
+# This is part of a blogging website. Users write posts. A post
+# belongs to a user.
+#
+
+class Post
+  include DataMapper::Resource
+
+  property :post_id,  Serial
+  property :title,    String
+  property :body,     Text
+
+  belongs_to :user
+end
+
+class User
+  include DataMapper::Resource
+
+  property :user_uid,  Serial
+  property :name,      String
+  property :mail,      String
+end
+
+post = Post.new
+
+p post
+require 'drx'
+post.see

data/ext/drx_core.c

@@ -1,5 +1,14 @@
 #include "ruby.h"
-#include "st.h"
+
+#ifndef RUBY_VM
+# define RUBY_1_8
+#endif
+
+#ifdef RUBY_1_8
+# include "st.h"
+#else
+# include "ruby/st.h"
+#endif
 
 /**
  * Gets the Ruby's engine type of a variable.
@@ -10,11 +19,9 @@ static VALUE t_get_type(VALUE self, VALUE obj)
 }
 
 // Helper for t_get_iv_tbl().
-int record_var(st_data_t key, st_data_t value, VALUE hash) {
-  // I originally did the following, but it breaks for object::Tk*. Perhaps these
-  // values are T_NODEs? (e.g. aliases) @todo: debug using INT2FIX(TYPE(value)).
-  rb_hash_aset(hash, ID2SYM(key), value);
-  // So...
+static int record_var(st_data_t key, st_data_t value, VALUE hash) {
+  // We don't put the 'value' in the hash because it may not be a Ruby
+  // conventional value but a NODE (and acidentally printing it may crash ruby).
   rb_hash_aset(hash, ID2SYM(key), Qtrue);
   return ST_CONTINUE;
 }
@@ -31,9 +38,13 @@ static VALUE t_get_iv_tbl(VALUE self, VALUE obj)
     rb_raise(rb_eTypeError, "Only T_OBJECT/T_CLASS/T_MODULE is expected as the argument (got %d)", TYPE(obj));
   }
 
+#ifdef RUBY_1_8
   if (ROBJECT(obj)->iv_tbl) {
     st_foreach(ROBJECT(obj)->iv_tbl, record_var, (st_data_t)hash);
   }
+#else
+  rb_ivar_foreach(obj, record_var, hash);
+#endif
 
   return hash;
 }
@@ -58,11 +69,10 @@ static VALUE t_get_ivar(VALUE self, VALUE obj, VALUE var_name)
  */
 static VALUE t_get_super(VALUE self, VALUE obj)
 {
-  VALUE super;
   if (TYPE(obj) != T_CLASS && TYPE(obj) != T_ICLASS && TYPE(obj) != T_MODULE) {
     rb_raise(rb_eTypeError, "Only T_CLASS/T_MODULE is expected as the argument (got %d)", TYPE(obj));
   }
-  return RCLASS(obj)->super ? RCLASS(obj)->super : Qnil;
+  return RCLASS_SUPER(obj) ? RCLASS_SUPER(obj) : Qnil;
 }
 
 /**
@@ -85,9 +95,13 @@ static VALUE t_get_flags(VALUE self, VALUE obj)
 }
 
 // Helper for t_get_m_tbl().
-int record_method(st_data_t key, st_data_t value, VALUE hash) {
-  // @todo: Store something useful in the values?
-  rb_hash_aset(hash, key == ID_ALLOCATOR ? rb_str_new2("<Allocator>") : ID2SYM(key), INT2FIX(666));
+// @todo: Store something useful in the values?
+static int record_method(st_data_t key, st_data_t value, VALUE hash) {
+  static ID id_allocator_symb = 0;
+  if (!id_allocator_symb) {
+    id_allocator_symb = rb_intern("<Allocator>");
+  }
+  rb_hash_aset(hash, ID2SYM(key == ID_ALLOCATOR ? id_allocator_symb : key), Qtrue);
   return ST_CONTINUE;
 }
 
@@ -118,6 +132,7 @@ static VALUE t_get_address(VALUE self, VALUE obj)
   return INT2NUM(obj);
 }
 
+#ifdef RUBY_1_8
 // {{{ Locating methods
 
 #include "node.h"
@@ -126,7 +141,7 @@ static VALUE t_get_address(VALUE self, VALUE obj)
 
 static VALUE t_do_locate_method(NODE *ND_method) {
   NODE *ND_scope = NULL, *ND_block = NULL;
-  VALUE place;
+  VALUE location;
   char line_s[20];
 
   //
@@ -195,23 +210,24 @@ static VALUE t_do_locate_method(NODE *ND_method) {
     return RSTR("<I'm expecting a NODE_BLOCK here...>");
   }
 
-  sprintf(line_s, "%d:", nd_line(ND_block));
-  place = RSTR(line_s);
-  rb_str_cat2(place, ND_block->nd_file);
+  location = rb_ary_new();
+  rb_ary_push(location, RSTR(ND_block->nd_file));
+  rb_ary_push(location, INT2FIX(nd_line(ND_block)));
 
-  return place;
+  return location;
 }
 
 /*
  *  call-seq:
- *     Drx::Core::locate_method(Date, "to_s")  => str
+ *     Drx::Core::locate_method(Date, "to_s")  => ...
  *
- *  Locates the filename and line-number where a method was defined. Returns a
- *  string of the form "89:/path/to/file.rb", or nil if the method doesn't exist,
- *  or a string of the form "<identifier>".
+ *  Locates the filename and line-number where a method was defined.
  *
- *  If the method exists but isn't a Ruby method (e.g., if it's written in C),
- *  an <identifier> string is returned. E.g., <c>, <alias>, <attr reader>.
+ *  Returns one of:
+ *   - [ "/path/to/file.rb", 89 ]
+ *   - A string of the form "<identifier>" if the method isn't written
+ *     in Ruby. Possibilities are <c>, <alias>, <attr reader>, and more.
+ *   - raises NameError if the method doesn't exist.
  */
 static VALUE t_locate_method(VALUE self, VALUE obj, VALUE method_name)
 {
@@ -221,19 +237,17 @@ static VALUE t_locate_method(VALUE self, VALUE obj, VALUE method_name)
   if (TYPE(obj) != T_CLASS && TYPE(obj) != T_ICLASS && TYPE(obj) != T_MODULE) {
     rb_raise(rb_eTypeError, "Only T_CLASS/T_MODULE is expected as the argument (got %d)", TYPE(obj));
   }
-  if (!RCLASS(obj)->m_tbl) {
-    return Qnil;
-  }
   c_name = StringValuePtr(method_name);
   ID id = rb_intern(c_name);
-  if (st_lookup(RCLASS(obj)->m_tbl, id, (st_data_t *)&method_node))  {
+  if (RCLASS(obj)->m_tbl && st_lookup(RCLASS(obj)->m_tbl, id, (st_data_t *)&method_node))  {
     return t_do_locate_method(method_node);
   } else {
-    return Qnil;
+    rb_raise(rb_eNameError, "method not found");
   }
 }
 
 // }}}
+#endif // RUBY_1_8
 
 VALUE mDrx;
 VALUE mCore;
@@ -249,18 +263,19 @@ void Init_drx_core() {
   rb_define_module_function(mCore, "get_address", t_get_address, 1);
   rb_define_module_function(mCore, "get_type", t_get_type, 1);
   rb_define_module_function(mCore, "get_ivar", t_get_ivar, 2);
+#ifdef RUBY_1_8
   rb_define_module_function(mCore, "locate_method", t_locate_method, 2);
-  rb_define_const(mCore, "FL_SINGLETON", INT2FIX(FL_SINGLETON));
-  rb_define_const(mCore, "T_OBJECT", INT2FIX(T_OBJECT));
-  rb_define_const(mCore, "T_CLASS", INT2FIX(T_CLASS));
-  rb_define_const(mCore, "T_ICLASS", INT2FIX(T_ICLASS));
-  rb_define_const(mCore, "T_MODULE", INT2FIX(T_MODULE));
-
   // For the following, see explanation in t_do_locate_method().
   rb_eval_string("\
     class ::Proc;\
       def _location;\
-        if to_s =~ /@(.*?):(\\d+)>$/ then \"#$2:#$1\" end;\
+        if to_s =~ /@(.*?):(\\d+)>$/ then [$1, $2.to_i] end;\
       end;\
     end");
+#endif
+  rb_define_const(mCore, "FL_SINGLETON", INT2FIX(FL_SINGLETON));
+  rb_define_const(mCore, "T_OBJECT", INT2FIX(T_OBJECT));
+  rb_define_const(mCore, "T_CLASS", INT2FIX(T_CLASS));
+  rb_define_const(mCore, "T_ICLASS", INT2FIX(T_ICLASS));
+  rb_define_const(mCore, "T_MODULE", INT2FIX(T_MODULE));
 }

data/lib/drx/graphviz.rb

@@ -1,4 +1,4 @@
-# Adds Graphviz diagraming capability to ObjInfo
+# Adds Graphviz diagramming capability to ObjInfo
 
 module Drx
 
@@ -38,16 +38,19 @@ module Drx
     # Create an ID for the DOT node representing this object.
     def dot_id
        ('o' + address.to_s).sub('-', '_')
+       # Tip: when examining the DOT output you may wish to
+       # uncomment the following line. It will show you which
+       # ruby object the DOT node represents.
+       #('o' + address.to_s).sub('-', '_') + " /* #{repr} */ "
     end
 
     # Creates a pseudo URL for the HTML imagemap.
     def dot_url
-      "http://server/obj/#{dot_id}"
+      "http://ruby/object/#{dot_id}"
     end
 
     # Quotes a string to be used in DOT source.
     def dot_quote(s)
-      # @todo: find the documentation for tr()?
       '"' + s.gsub('\\') { '\\\\' }.gsub('"', '\\"').gsub("\n", '\\n') + '"'
     end
 
@@ -111,18 +114,26 @@ module Drx
       end
     end
 
-    def dot_source(level = 0, opts = {}, &block) # :yield:
+    # Builds the DOT source for the diagram. if you're only interested
+    # in the output image, use generate_diagram() instead.
+    def dot_source(opts = {}, &block) # :yield:
+      opts = opts.dup
+      opts[:base] = self
+      @@seen = {}
+
+      out = 'digraph {' "\n"
+      out << @@sizes[opts[:size] || '100%']
+      out << dot_fragment(opts, &block)
+      out << '}' "\n"
+      out
+    end
+
+    def dot_fragment(opts = {}, &block) # :yield:
       out = ''
-      # Note: since 'obj' may be a T_ICLASS, it doesn't repond to many methods,
+      # Note: since 'obj' may be a T_ICLASS, it doesn't respond to many methods,
       # including is_a?. So when we're querying things we're using Drx calls
       # instead.
 
-      if level.zero?
-        out << 'digraph {' "\n"
-        out << @@sizes[opts[:size] || '100%']
-        @@seen = {}
-      end
-
       seen = @@seen[address]
       @@seen[address] = true
 
@@ -137,8 +148,8 @@ module Drx
 
       if class_like?
         if spr = self.super and display_super?(spr)
-          out << spr.dot_source(level+1, opts, &block)
-          if [Module, ObjInfo.new(Module).klass.the_object].include? the_object
+          out << spr.dot_fragment(opts, &block)
+          if insignificant_super_arrow?(opts)
             # We don't want these relatively insignificant lines to clutter the display,
             # so we paint them lightly and tell DOT they aren't to affect the layout (width=0).
             out << "#{dot_id} -> #{spr.dot_id} [color=gray85, weight=0];" "\n"
@@ -150,16 +161,38 @@ module Drx
 
       kls = effective_klass
       if display_klass?(kls)
-        out << kls.dot_source(level+1, opts, &block)
-        out << "#{dot_id} -> #{kls.dot_id} [style=dotted];" "\n"
+        out << kls.dot_fragment(opts, &block)
+        # Recall that in Ruby there are two main inheritance groups: the class
+        # inheritance and the singleton inheritance.
+        #
+        # When an ICLASS has a singleton, we want this singleton to appear close
+        # to the ICLASS, because we want to keep the two groups visually distinct.
+        # We do this by setting the arrow's weight to 1.0.
+        #
+        # (To see the effect of this, set the weight unconditionally to '0' and
+        # see the graph for DataMapper.)
+        weight = t_iclass? ? 1 : 0
+        out << "#{dot_id} -> #{kls.dot_id} [style=dotted, weight=#{weight}];" "\n"
         out << "{ rank=same; #{dot_id}; #{kls.dot_id}; }" "\n"
       end
 
-      if level.zero?
-        out << '}' "\n"
-      end
+      out
+    end
 
-      return out
+    # Whether the 'super' arrow is infignificant and must not affect the DOT
+    # layout
+    #
+    # A Ruby object graph is cyclic. We don't want to feed DOT a cyclic graph
+    # because it will ruin our nice "rectangular" layout. The purpose of the
+    # following method is to break the cycle. Normally we break the cycle at
+    # Module (and its singleton). When the user is examining a module, we
+    # instead break the cycle at Class (and its singleton).
+    def insignificant_super_arrow?(opts)
+      if opts[:base].t_module?
+        [Class, ObjInfo.new(Class).klass.the_object].include? the_object
+      else
+        [Module, ObjInfo.new(Module).klass.the_object].include? the_object
+      end
     end
 
     # Whether to display the klass.
@@ -167,12 +200,12 @@ module Drx
       if t_iclass?
         # We're interested in an ICLASS's klass only if it isn't Module.
         #
-        # Usualy this means that the ICLASS has a singleton (see "Singletons
+        # Usually this means that the ICLASS has a singleton (see "Singletons
         # of included modules" in display_super?()). We want to see this
         # singleton.
         return Module != kls.the_object
       else
-        # Displaying a singletone's klass is confusing and usually unneeded.
+        # Displaying a singleton's klass is confusing and usually unneeded.
         return !singleton?
       end
     end
@@ -215,7 +248,7 @@ module Drx
     #   end
     #
     def generate_diagram(files, opts = {}, &block)
-      source = self.dot_source(0, opts, &block)
+      source = self.dot_source(opts, &block)
       File.open(files['dot'], 'w') { |f| f.write(source) }
       command = GRAPHVIZ_COMMAND % [files['dot'], files['gif'], files['map']]
       message = Kernel.`(command)  # `

data/lib/drx/objinfo.rb

@@ -35,8 +35,29 @@ module Drx
     end
 
     # Returns the source-code position where a method is defined.
+    #
+    # Returns one of:
+    #  - [ 'file.rb', 12 ]
+    #  - "<c>", "<undef>", "<alias>", etc., if not a ruby code (for Ruby 1.9,
+    #    returns only "<c>").
+    #  - nil, if functionality not implemented.
+    #  - raises NameError if method not found.
     def locate_method(method_name)
-      Core::locate_method(@obj, method_name)
+      if Core.respond_to? :locate_method
+        # Ruby 1.8
+        Core::locate_method(@obj, method_name)
+      elsif Method.method_defined? :source_location
+        # Ruby 1.9
+        location = @obj.instance_method(method_name).source_location
+        if location
+          location
+        else
+          '<c>'
+        end
+      else
+        # Some version of ruby that doesn't have Method#source_loction
+        nil
+      end
     end
 
     def has_iv_tbl?

data/lib/drx/tk/app.rb

@@ -74,7 +74,7 @@ module Drx
         }
         @methodsbox.bind('Double-Button-1') {
           if @methodsbox.has_selection?
-            locate_method(current_object, @methodsbox.get_selection)
+            edit(current_object, @methodsbox.get_selection)
           end
         }
         @eval_entry.bind('Key-Return') {
@@ -160,15 +160,15 @@ module Drx
         end
       end
 
-      def locate_method(obj, method_name)
-        place = ObjInfo.new(obj).locate_method(method_name)
-        if !place
+      def edit(obj, method_name)
+        location = ObjInfo.new(obj).locate_method(method_name) rescue nil
+        if !location
           output "Method #{method_name} doesn't exist\n", 'info'
         else
-          if place =~ /\A(\d+):(.*)/
-            open_up_editor($2, $1)
+          if location.is_a? String
+            output "Can't locate method, because it's a: #{location}\n", 'info'
           else
-            output "Can't locate method, because: #{place}\n", 'info'
+            open_up_editor(location[0], location[1])
           end
         end
       end

data/lib/drx/tk/imagemap.rb

@@ -187,7 +187,9 @@ module TkImageMap
     # DOT outputs oval elements as polygons with many many sides. Since Tk doesn't
     # draw them well, we convert such polygons to ovals.
     def self.to_oval(coords)
-      points = coords.enum_slice(2).to_a
+      require 'enumerator'
+      #points = coords.each_slice(2).to_a # Doesn't work for older 1.8's.
+      points = coords.enum_for(:each_slice, 2).to_a
       if points.size < 10
         # If there are few sides, we assume it's a real polygon.
         return nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: drx
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Mooffie
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-29 00:00:00 +03:00
+date: 2010-04-02 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
@@ -34,6 +34,7 @@ files:
 - examples/drx_test.rb
 - examples/drx_test3.rb
 - examples/drx_test2.rb
+- examples/drx_datamapper19.rb
 has_rdoc: true
 homepage: http://drx.rubyforge.org/
 licenses: []
@@ -45,9 +46,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ~>
+  - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.8.0
+      version: 1.8.2
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
@@ -61,6 +62,6 @@ rubyforge_project: drx
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Inspect Ruby objects.
+summary: Object inspector for Ruby.
 test_files: []