bindex 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f3058f9c6ca15bbd05c8857a4c13b931c10855c
-  data.tar.gz: b0dc1e2b67f95cd838f427a11c03608161c03cd6
+  metadata.gz: 34aa50088ea6aef2477158e8e8cc6e9c79bc61a9
+  data.tar.gz: f28ceecbdfcb050ad460d5b98ce1c49a3b471ae2
 SHA512:
-  metadata.gz: 3be4c3659396f2e68c9c3526bc5bd9c8e69325babb902d7bc4e0977bcf3c4b842e8c11a54af00169b926135672e28f836a4b41c88bfaa16b870ca010e41a47f2
-  data.tar.gz: f0a5337d9a0b35729f44b2d162e1c1e7028f147eaacfd270c10592e0ef8fd2d6f7bf7cf6ad1ef0e233c46b8379707cc06a2074956f6a74ab24b7f3dac1b34d3b
+  metadata.gz: 26de5ac63dd38eee300a749896c9eb24e3c2aa76a3f28264282e703fe7052217e4f0bc6c62a768ed85812b3afe1032a1bcc30a01a76fee7f0873f92b99edfe89
+  data.tar.gz: add6aec5daa85df64266f3632afb64cf38c098bab43dffa41311537de8ee7f24e400aa1b5c2aba772c8524d878d04dc93eca8f101ca3a0d98692dd40615bc6ab

data/README.md

@@ -5,11 +5,25 @@ where did the exception originated in. Bindex gives you the bindings as well.
 This can help you introspect the state of the Ruby program when the exception
 happened.
 
-### Usage
+## Usage
 
 **Do not** use this gem on production environments. The performance penalty isn't
 worth it anywhere outside of development.
 
+### API
+
+Bindex defines the following API:
+
+#### Exception#bindings
+
+Returns all the bindings up to the one in which the exception originated in.
+
+#### Bindex.current_bindings
+
+Returns all of the current Ruby execution state bindings. The first on is the
+current one, the second is the caller one, the third is the caller of the
+caller one and so on.
+
 ## Support
 
 ### CRuby

data/ext/bindex/com/gsamokovarov/bindex/JRubyIntegration.java

@@ -0,0 +1,49 @@
+package com.gsamokovarov.bindex;
+
+import org.jruby.Ruby;
+import org.jruby.RubyArray;
+import org.jruby.RubyModule;
+import org.jruby.RubyClass;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.builtin.IRubyObject;
+import org.jruby.runtime.builtin.InstanceVariables;
+import org.jruby.anno.JRubyMethod;
+
+public class JRubyIntegration {
+    public static void setup(Ruby runtime) {
+        RubyModule bindex = runtime.defineModule("Bindex");
+        bindex.defineAnnotatedMethods(BindexMethods.class);
+
+        RubyClass exception = runtime.getException();
+        exception.defineAnnotatedMethods(ExceptionExtensionMethods.class);
+
+        IRubyObject verbose = runtime.getVerbose();
+        try {
+            runtime.setVerbose(runtime.getNil());
+            runtime.addEventHook(new SetExceptionBindingsEventHook());
+        } finally {
+            runtime.setVerbose(verbose);
+        }
+    }
+
+    private static class BindexMethods {
+        @JRubyMethod(name = "current_bindings", meta = true)
+        public static IRubyObject currentBindings(ThreadContext context, IRubyObject self) {
+            return RubyBindingsCollector.collectCurrentFor(context);
+        }
+    }
+
+    private static class ExceptionExtensionMethods {
+        @JRubyMethod
+        public static IRubyObject bindings(ThreadContext context, IRubyObject self) {
+            InstanceVariables instanceVariables = self.getInstanceVariables();
+
+            IRubyObject bindings = instanceVariables.getInstanceVariable("@bindings");
+            if (bindings != null && !bindings.isNil()) {
+                return bindings;
+            }
+
+            return RubyArray.newArray(context.getRuntime());
+        }
+    }
+}

data/ext/bindex/cruby.c

@@ -1,5 +1,13 @@
 #include "bindex.h"
 
+VALUE bx_mBindex;
+
+static VALUE
+bx_current_bindings(VALUE self)
+{
+  return current_bindings();
+}
+
 static VALUE
 bx_exc_set_backtrace(VALUE self, VALUE bt)
 {
@@ -14,7 +22,7 @@ bx_exc_set_backtrace(VALUE self, VALUE bt)
 }
 
 static VALUE
-bx_exc_bindings(VALUE self, VALUE bt)
+bx_exc_bindings(VALUE self)
 {
   VALUE bindings;
 
@@ -29,6 +37,10 @@ bx_exc_bindings(VALUE self, VALUE bt)
 void
 Init_cruby(void)
 {
+  bx_mBindex = rb_define_module("Bindex");
+
+  rb_define_singleton_method(bx_mBindex, "current_bindings", bx_current_bindings, 0);
+
   rb_define_method(rb_eException, "set_backtrace", bx_exc_set_backtrace, 1);
   rb_define_method(rb_eException, "bindings", bx_exc_bindings, 0);
 }

data/ext/bindex/extconf.rb

@@ -17,6 +17,7 @@ when "ruby"
     $INCFLAGS << " -I./ruby_21/"
   end
 
+  $CFLAGS << " -Wall"
   $CFLAGS << " -g3 -O0" if ENV["DEBUG"]
 
   create_makefile("bindex/cruby")

data/lib/bindex/jruby.rb

@@ -4,17 +4,7 @@ else
   require 'bindex/jruby_internals'
 end
 
+java_import com.gsamokovarov.bindex.JRubyIntegration
 java_import com.gsamokovarov.bindex.SetExceptionBindingsEventHook
 
-begin
-  previous_verbose, $VERBOSE = $VERBOSE, nil
-  JRuby.runtime.add_event_hook(SetExceptionBindingsEventHook.new)
-ensure
-  $VERBOSE = previous_verbose
-end
-
-::Exception.class_eval do
-  def bindings
-    @bindings || []
-  end
-end
+JRubyIntegration.setup(JRuby.runtime)

data/lib/bindex/rubinius.rb

@@ -1,22 +1,5 @@
 module Bindex
-  class Rubinius
-    # Gets the current bindings for all available Ruby frames.
-    #
-    # Filters the internal Rubinius frames.
-    def self.current_bindings
-      locations = ::Rubinius::VM.backtrace(1, true)
-
-      InternalLocationFilter.new(locations).filter.map do |location|
-        Binding.setup(
-          location.variables,
-          location.variables.method,
-          location.constant_scope,
-          location.variables.self,
-          location
-        )
-      end
-    end
-
+  module Rubinius
     # Filters internal Rubinius locations.
     #
     # There are a couple of reasons why we wanna filter out the locations.
@@ -47,6 +30,23 @@ module Bindex
   end
 end
 
+# Gets the current bindings for all available Ruby frames.
+#
+# Filters the internal Rubinius and Bindex frames.
+def Bindex.current_bindings
+  locations = ::Rubinius::VM.backtrace(1, true)
+
+  Bindex::Rubinius::InternalLocationFilter.new(locations).filter.map do |location|
+    Binding.setup(
+      location.variables,
+      location.variables.method,
+      location.constant_scope,
+      location.variables.self,
+      location
+    )
+  end
+end
+
 ::Exception.class_eval do
   def bindings
     @bindings || []
@@ -58,7 +58,7 @@ end
 
   define_method(:raise_exception) do |exc|
     if exc.bindings.empty?
-      exc.instance_variable_set(:@bindings, Bindex::Rubinius.current_bindings)
+      exc.instance_variable_set(:@bindings, Bindex.current_bindings)
     end
 
     raise_exception.bind(self).call(exc)

data/lib/bindex/version.rb

@@ -1,3 +1,3 @@
 module Bindex
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/test/current_bindings_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CurrentBindingsTest < BaseTest
+  test 'first binding returned is the current one' do
+    assert_equal __LINE__, Bindex.current_bindings.first.eval('__LINE__')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bindex
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Genadi Samokovarov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-22 00:00:00.000000000 Z
+date: 2014-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -86,6 +86,7 @@ files:
 - ext/bindex/bindings.c
 - ext/bindex/com/gsamokovarov/bindex/BindingBuilder.java.erb
 - ext/bindex/com/gsamokovarov/bindex/CurrentBindingsIterator.java
+- ext/bindex/com/gsamokovarov/bindex/JRubyIntegration.java
 - ext/bindex/com/gsamokovarov/bindex/RubyBindingsCollector.java
 - ext/bindex/com/gsamokovarov/bindex/SetExceptionBindingsEventHook.java
 - ext/bindex/com/gsamokovarov/bindex/ThreadContextInterfaceException.java
@@ -231,6 +232,7 @@ files:
 - lib/bindex/jruby_internals_9k.jar
 - lib/bindex/rubinius.rb
 - lib/bindex/version.rb
+- test/current_bindings_test.rb
 - test/exception_test.rb
 - test/fixtures/basic_nested_fixture.rb
 - test/fixtures/custom_error_fixture.rb
@@ -263,6 +265,7 @@ signing_key:
 specification_version: 4
 summary: Bindings for your Ruby exceptions
 test_files:
+- test/current_bindings_test.rb
 - test/exception_test.rb
 - test/fixtures/basic_nested_fixture.rb
 - test/fixtures/custom_error_fixture.rb