ruby18_source_location 0.1 → 0.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+*.so
+*.o
+.rvmrc
+ext/Makefile

data/LICENSE.MIT

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Conrad Irwin <conrad.irwin@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+The `ruby18_source_location` gem backports the `source_location` instance method of `Method`, `UnboundMethod` and
+`Proc` from Ruby 1.9.
+
+This allows you to use `Method#source_location` on ruby 1.8.7, and also all the other gems that depend on it.
+
+Usage
+-----
+
+    gem install ruby18_source_location
+
+```ruby
+    require 'rubygems'
+    require 'ruby18_source_location'
+
+    def example
+      2
+    end
+
+    puts method(:example).source_location.inspect
+    # => ["/tmp/example.rb", 4]
+
+    puts Proc.new{}.source_location.inspect
+    # => ["/tmp/example.rb", 11]
+
+    puts method(:puts).source_location.inspect
+    # => nil
+```
+
+Known issues
+------------
+
+Under Ruby-1.8.7, it's not currently possible to get the `source_location` of methods defined by `attr_reader`,
+`attr_writer` or `attr_accessor`, unless you are running Ruby Enterprise Edition.
+
+Meta-foo
+--------
+
+This is made available under the MIT license (see LICENSE.MIT), contributions and bug reports are welcome.

data/Rakefile

@@ -0,0 +1,32 @@
+
+def dir(*args); Dir.chdir(File.join(File.dirname(__FILE__), *args)); end
+desc "Compile local copy"
+task :compile do
+  dir('ext')
+  system "ruby extconf.rb && make"
+end
+
+task :clean do
+  dir('ext')
+  system "make clean"
+end
+
+desc "Package the gem"
+task :gem do
+  dir('.')
+  system "gem build ruby18_source_location.gemspec"
+end
+
+desc "Run the tests"
+task :test do
+  dir("test")
+  system "ruby test_ruby18_source_location.rb"
+end
+
+desc "Run an interactive shell"
+task :pry do
+  dir('.')
+  system "pry -f -r ext/ruby18_source_location -r test/examples"
+end
+
+task :default => [:clean, :compile, :test]

data/ext/ruby18_source_location.c

@@ -1,32 +1,7 @@
-// Include the Ruby headers and goodies
 #include "ruby.h"
+#include "node.h"
 
-typedef struct RNode {
-    unsigned long flags;
-    char *nd_file;
-    union {
-        struct RNode *node;
-        ID id;
-        VALUE value;
-        VALUE (*cfunc)(ANYARGS);
-        ID *tbl;
-    } u1;
-    union {
-        struct RNode *node;
-        ID id;
-        long argc;
-        VALUE value;
-    } u2;
-    union {
-        struct RNode *node;
-        ID id;
-        long state;
-        struct global_entry *entry;
-        long cnt;
-        VALUE value;
-    } u3;
-} NODE;
-
+// Cargo-culted from ruby internal headers.
 struct FRAME {
     VALUE self;
     int argc;
@@ -68,20 +43,17 @@ struct BLOCK {
     struct BLOCK *outer;
     struct BLOCK *prev;
 };
-#define RNODE(obj)  (R_CAST(RNode)(obj))
-#define NODE_LSHIFT (FL_USHIFT+8)
-#define NODE_LMASK  (((long)1<<(sizeof(NODE*)*CHAR_BIT-NODE_LSHIFT))-1)
-#define nd_line(n) ((unsigned int)(((RNODE(n))->flags>>NODE_LSHIFT)&NODE_LMASK))
 
 
-static VALUE
-source_pair(const char *filename, int lineno)
-{
-    VALUE array = rb_ary_new();
-    rb_ary_push(array, rb_str_new2(filename));
-    rb_ary_push(array, INT2FIX(lineno));
+static VALUE method_source_location(VALUE);
+static VALUE proc_source_location(VALUE);
 
-    return array;
+void
+Init_ruby18_source_location()
+{
+    rb_define_method(rb_cUnboundMethod, "source_location", method_source_location, 0);
+    rb_define_method(rb_cMethod, "source_location", method_source_location, 0);
+    rb_define_method(rb_cProc, "source_location", proc_source_location, 0);
 }
 
 static VALUE
@@ -90,10 +62,17 @@ node_source_location(NODE *node)
     const char *filename = node->nd_file;
     int lineno = nd_line(node);
 
-    if (filename && lineno)
-        return source_pair(filename, lineno);
+    if (filename && lineno) {
+        VALUE str = rb_str_new2(filename);
 
-    return Qnil;
+        // TODO: is there a better way of telling whether the file should be absolute
+        if (Qtrue == rb_funcall(rb_cFile, rb_intern("exist?"), 1, str))
+            str = rb_file_expand_path(str, Qnil);
+
+        return rb_assoc_new(str, INT2FIX(lineno));
+    }
+
+    rb_raise(rb_eRuntimeError, "source_location: no file for node");
 }
 
 /*
@@ -108,18 +87,52 @@ static VALUE
 method_source_location(VALUE method)
 {
     struct METHOD *data;
+    struct BLOCK *block;
     NODE *node;
 
     Data_Get_Struct(method, struct METHOD, data);
-    if (node = data->body) {
+
+    if (!(node = data->body))
+        rb_raise(rb_eRuntimeError, "source_location: no body for method");
+
+    switch (nd_type(node)) {
+    // methods defined by C extensions
+    case NODE_CFUNC:
+        return Qnil;
+
+    // attr_accessor :foo
+    case NODE_IVAR:    // method(:foo)
+    case NODE_ATTRSET: // method(:foo=)
+
+        // ruby enterpise edition fixes nd_line on these nodes
+#ifdef MBARI_API
         return node_source_location(node);
+#else
+        // FIXME, Ruby-1.8.7 returns a bad nd_line on these.
+        return Qnil;
+#endif
+
+    // def foo; end
+    case NODE_SCOPE:
+        return node_source_location((NODE *)node->u3.value);
+
+    // define_method(:foo, method(:bar))
+    case NODE_DMETHOD:
+        return method_source_location(node->u3.value);
+
+    // define_method(:foo) { }, define_method(:foo, &bar)
+    case NODE_BMETHOD:
+        return proc_source_location(node->u3.value);
+
+    default:
+        rb_raise(rb_eRuntimeError, "source_location: unhandled method type %d", nd_type(node));
+
     }
-    return Qnil;
 }
 
 /*
  * call-seq:
- *    meth.source_location  => [String, Fixnum]
+ *    proc.source_location  => [String, Fixnum]
  *
  * returns a pair of the Filename and line number on which the method is defined
  *
@@ -130,18 +143,16 @@ proc_source_location(VALUE block)
 {
     struct BLOCK *data;
     NODE *node;
-
     Data_Get_Struct(block, struct BLOCK, data);
-    if ((node = data->frame.node) || (node = data->body)) {
+
+    // Proc.new {}, or Proc.new &proc
+    if ((node = data->frame.node) && nd_type(node) == NODE_ITER)
         return node_source_location(node);
-    }
-    return Qnil;
-}
 
-void
-Init_ruby18_source_location()
-{
-    rb_define_method(rb_cUnboundMethod, "source_location", method_source_location, 0);
-    rb_define_method(rb_cMethod, "source_location", method_source_location, 0);
-    rb_define_method(rb_cProc, "source_location", proc_source_location, 0);
+    // Proc.new &method(:foo)
+    if ((node = data->body) && nd_type(node) == NODE_IFUNC)
+        return method_source_location(node->u2.value);
+
+    rb_raise(rb_eRuntimeError, "source_location: unhandled proc type");
+
 }

data/ruby18_source_location.gemspec

@@ -0,0 +1,14 @@
+
+Gem::Specification.new do |s|
+  s.name = "ruby18_source_location"
+  s.version = "0.2"
+  s.platform = Gem::Platform::RUBY
+  s.author = "Conrad Irwin"
+  s.email = "conrad.irwin@gmail.com"
+  s.homepage = "http://github.com/ConradIrwin/ruby18_source_location"
+  s.summary = "Add .source_location to methods in Ruby 1.8.7"
+  s.description = "Allows you to make use of lots of ruby 1.9.2 specific goodness"
+  s.files = `git ls-files`.split("\n")
+  s.extensions = "ext/extconf.rb"
+  s.require_path = "ext"
+end

data/test/examples.rb

@@ -0,0 +1,64 @@
+class Example
+
+  def example1
+
+  end
+
+  define_method(:example2) {
+
+  }
+
+  Example3 = Proc.new do
+
+  end
+
+  Example4 = lambda {
+
+  }
+
+  define_method(:example5, Example3)
+
+  define_method(:example6, &Example4)
+
+  define_method(:example7, instance_method(:example1))
+
+  define_method(:example8, &Example.new.method(:example2))
+
+  Example9 = Proc.new &Example3
+
+  Example10 = Proc.new &Example.new.method(:example1)
+
+  eval <<-EVAL
+    def example11
+
+    end
+  EVAL
+
+  eval <<-EVAL, binding, __FILE__, __LINE__+1
+    def example12
+
+    end
+  EVAL
+
+  def self.example13
+
+  end
+
+  alias example14 example1
+
+  alias_method :example15, :example2
+
+  attr_reader :example16
+
+  attr_accessor :example17
+
+  def example18(&block)
+    block
+  end
+
+  Example19 = lambda &method(:puts)
+end
+
+
+
+# vim: number

data/test/test_ruby18_source_location.rb

@@ -0,0 +1,106 @@
+require 'test/unit'
+
+puts "Testing with #{RUBY_VERSION}"
+if Method.method_defined?(:source_location)
+  warn "using BUILTING source_location"
+else
+  require "#{File.dirname(__FILE__)}/../ext/ruby18_source_location"
+end
+require "#{File.dirname(__FILE__)}/examples"
+
+class TestRuby18SourceLocation < Test::Unit::TestCase
+
+  def assert_on_line(line, method)
+    assert_equal [File.expand_path('./examples.rb'), line], method.source_location
+  end
+
+  def assert_same_source(m1, m2)
+    assert_equal m1.source_location, m2.source_location
+  end
+
+  def test_normal_method
+    assert_on_line 3, Example.instance_method(:example1)
+  end
+
+  def test_define_method_with_block
+    assert_on_line 7, Example.instance_method(:example2)
+  end
+
+  def test_proc_new
+    assert_on_line 11, Example::Example3
+  end
+
+  def test_lambda
+    assert_on_line 15, Example::Example4
+  end
+
+  def test_define_method_with_proc_arg
+    assert_same_source Example::Example3, Example.new.method(:example5)
+  end
+
+  def test_define_method_with_amp_proc
+    assert_same_source Example::Example4, Example.new.method(:example6)
+  end
+
+  def test_define_method_with_method_arg
+    assert_same_source Example.new.method(:example1), Example.new.method(:example7)
+  end
+
+  def test_define_method_with_amp_method
+    assert_same_source Example.new.method(:example2), Example.new.method(:example8)
+  end
+
+  def test_proc_with_amp_proc
+    assert_same_source Example::Example3, Example::Example9
+  end
+
+  def test_proc_with_amp_method
+    assert_same_source Example.instance_method(:example1), Example::Example10
+  end
+
+  def test_eval
+    assert_equal ['(eval)', 1], Example.instance_method(:example11).source_location
+  end
+
+  def test_eval_with_overridden_line
+    assert_on_line 38, Example.new.method(:example12)
+  end
+
+  def test_class_method
+    assert_on_line 43, Example.method(:example13)
+  end
+
+  def test_alias
+    assert_same_source Example.new.method(:example1), Example.new.method(:example14)
+  end
+
+  def test_alias_method
+    assert_same_source Example.new.method(:example2), Example.new.method(:example15)
+  end
+
+  def test_c_method
+    assert_equal nil, method(:puts).source_location
+  end
+
+  def test_attr_reader
+    assert_on_line 51, Example.instance_method(:example16)
+  end
+
+  def test_attr_accessor
+    assert_on_line 53, Example.instance_method(:example17)
+  end
+
+  def test_attr_assign
+    assert_on_line 53, Example.instance_method(:example17=)
+  end
+
+  def test_blocks
+    assert_equal [File.expand_path(__FILE__), __LINE__], Example.new.example18{
+
+    }.source_location
+  end
+
+  def test_lambdas_with_c_methods
+    assert_equal nil, Example::Example19.source_location
+  end
+end

metadata

@@ -1,65 +1,54 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby18_source_location
-version: !ruby/object:Gem::Version 
-  hash: 9
+version: !ruby/object:Gem::Version
+  version: '0.2'
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  version: "0.1"
 platform: ruby
-authors: 
+authors:
 - Conrad Irwin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-22 00:00:00 Z
+date: 2011-10-23 00:00:00.000000000Z
 dependencies: []
-
 description: Allows you to make use of lots of ruby 1.9.2 specific goodness
 email: conrad.irwin@gmail.com
 executables: []
-
-extensions: 
+extensions:
 - ext/extconf.rb
 extra_rdoc_files: []
-
-files: 
-- ext/ruby18_source_location.c
+files:
+- .gitignore
+- LICENSE.MIT
+- README.md
+- Rakefile
 - ext/extconf.rb
+- ext/ruby18_source_location.c
+- ruby18_source_location.gemspec
+- test/examples.rb
+- test/test_ruby18_source_location.rb
 homepage: http://github.com/ConradIrwin/ruby18_source_location
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - ext
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Add .source_location to methods in Ruby 1.8.7
 test_files: []
-