is_a 0.0.3 → 0.1.0

data/README.md

@@ -18,6 +18,9 @@ Or install it yourself as:
 
 ## Usage
 
+### BasicObject
+If you got an object via `_id2ref` or from similar place - do not rush to duck-typing, it may be a BasicObject and not respond to `respond_to?`. IsA aims in handling such cases.
+
 ```ruby
 require 'is_a'
 
@@ -39,6 +42,31 @@ ObjectSpace._id2ref(id) == obj # => true
  #For 1.9.3 use BasicObject#__id__
 ```
 
+### Fast getting of lines from caller
+
+Ruby's `caller` is handy, but sometimes you do not need the whole array of strings it allocates generates on each call.
+
+`IsA.caller_line` (also global `caller_line`) is a lot faster and does not mess your heap that lot (allocates just the result string, meaning fewer GC):
+
+```ruby
+require 'is_a'
+require 'benchmark'
+n = 10000
+Benchmark.bm(11) do |x|
+  x.report("caller[1]") { n.times { caller[1] } }
+  x.report("caller_line") { n.times { caller_line(1) } }
+end
+```
+
+Results:
+
+```
+                  user     system      total        real
+caller[1]     0.430000   0.010000   0.440000 (  0.443102)
+caller_line   0.010000   0.000000   0.010000 (  0.002275)
+```
+
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -58,6 +58,20 @@ task :test => :compile do
     puts "object? FAIL"
   end
 
+  def test_caller
+    puts "Real caller: #{caller[0]}"
+    puts "Caller at 0: #{IsA.caller_line(0)}"
+    puts caller_line
+  end
+
+  test_caller
+
+  require 'benchmark'
+  n = 10000
+  Benchmark.bm(11) do |x|
+    x.report("caller[1]") { n.times { caller[1] } }
+    x.report("caller_line") { n.times { caller_line(1) } }
+  end
 
   #require 'heap_dump'
   #HeapDump.dump

data/ext/is_a/extconf.rb

@@ -1,3 +1,33 @@
 require 'mkmf'
+require 'debugger/ruby_core_source'
 
-create_makefile('is_a')
+unless ARGV.any? {|arg| arg.include?('--with-ruby-include') }
+  require 'rbconfig'
+  bindir = RbConfig::CONFIG['bindir']
+  if bindir =~ %r{(^.*/\.rbenv/versions)/([^/]+)/bin$}
+    ruby_include = "#{$1}/#{$2}/include/ruby-1.9.1/ruby-#{$2}"
+    ARGV << "--with-ruby-include=#{ruby_include}"
+  elsif bindir =~ %r{(^.*/\.rvm/rubies)/([^/]+)/bin$}
+    ruby_include = "#{$1}/#{$2}/include/ruby-1.9.1/#{$2}"
+    ruby_include = "#{ENV['rvm_path']}/src/#{$2}" unless File.exist?(ruby_include)
+    ARGV << "--with-ruby-include=#{ruby_include}"
+  end
+  puts "Using ruby source from #{ruby_include}"
+end
+
+hdrs = ->{
+  res = %w{
+    vm_core.h
+  }.all?{|hdr| have_header(hdr)}
+  res
+}
+
+# create_makefile('is_a')
+if !Debugger::RubyCoreSource::create_makefile_with_core(hdrs, "is_a")
+  STDERR.print("Makefile creation failed\n")
+  STDERR.print("*************************************************************\n\n")
+  STDERR.print("  NOTE: If your headers were not found, try passing\n")
+  STDERR.print("        --with-ruby-include=PATH_TO_HEADERS      \n\n")
+  STDERR.print("*************************************************************\n\n")
+  exit(1)
+end

data/ext/is_a/is_a.c

@@ -19,8 +19,82 @@ rb_object_id_of(VALUE self, VALUE obj)
   return rb_obj_id(obj);
 }
 
+
+#ifdef HAVE_VM_CORE_H
+#include "ruby/encoding.h"
+#include "vm_core.h"
+
+#define HAVE_CALLER_AT
+static VALUE caller_line(int offset)
+{
+  const rb_thread_t *th = ((rb_thread_t *)RTYPEDDATA_DATA(rb_thread_current()));
+  offset += 2;
+  if(offset < 0)
+    return Qnil;
+
+  rb_control_frame_t* cfp = th->cfp + offset;
+  const rb_control_frame_t* stack_end = (void *)(th->stack + th->stack_size);
+
+  if(cfp < stack_end){
+    if (cfp->iseq != 0) {
+      if (cfp->pc != 0) {
+        rb_iseq_t *iseq = cfp->iseq;
+        int line_no = rb_vm_get_sourceline(cfp);
+        VALUE file = iseq->filename,
+              name = iseq->name;
+        if (line_no) {
+          return rb_enc_sprintf(
+                rb_enc_compatible(file, name),
+                "%s:%d:in `%s'",
+                RSTRING_PTR(file), line_no, RSTRING_PTR(name));
+        } else {
+          return rb_enc_sprintf(
+                rb_enc_compatible(file, name),
+                "%s:in `%s'",
+                RSTRING_PTR(file), RSTRING_PTR(name));
+        }
+      }
+    } else {
+      // printf("CFUNC\n");
+      return Qnil;
+    }
+  } else {
+    // level is out of bounds
+  }
+  return Qnil;
+}
+
+static VALUE
+rb_caller_line(VALUE self, VALUE r_offset)
+{
+  int offset = NUM2INT(r_offset); // we are not interested in self
+  return caller_line(offset);
+}
+
+static VALUE rb_caller_line_global(int argc, VALUE* argv)
+{
+  VALUE level;
+  int lev;
+
+  rb_scan_args(argc, argv, "01", &level);
+
+  if (NIL_P(level))
+    lev = 0;
+  else
+    lev = NUM2INT(level);
+
+  if (lev < 0)
+    rb_raise(rb_eArgError, "negative level (%d)", lev);
+  return caller_line(lev);
+}
+#endif
+
 void Init_is_a(){
   rb_mIsA = rb_define_module("IsA");
   rb_define_singleton_method(rb_mIsA, "class_of", rb_get_class_of, 1);
   rb_define_singleton_method(rb_mIsA, "id_of", rb_object_id_of, 1);
+#ifdef HAVE_CALLER_AT
+  rb_define_singleton_method(rb_mIsA, "caller_line", rb_caller_line, 1);
+  rb_define_global_function("caller_line", rb_caller_line_global, -1);
+#endif
 }

data/is_a.gemspec

@@ -17,5 +17,6 @@ Gem::Specification.new do |gem|
 
   gem.extensions = "ext/is_a/extconf.rb"
 
+  gem.add_dependency("debugger-ruby_core_source")
   gem.add_development_dependency "rake-compiler"
 end

data/lib/is_a/version.rb

@@ -1,3 +1,3 @@
 module IsA
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: is_a
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-11 00:00:00.000000000Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: debugger-ruby_core_source
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
-  requirement: &70116595563300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +37,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70116595563300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Fear weak references to BasicObject no more
 email:
 - vasilyfedoseyev@gmail.com
@@ -52,17 +73,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3551024361612674054
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3551024361612674054
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Defines methods to introspect any ruby object more deeply
 test_files: []
-has_rdoc: