bindex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30c71c3e8372b14f944f36e0d4bbbbeef20afa73
+  data.tar.gz: d01dd1e87366ad5eabdc415890c0c8efee3bb5dc
+SHA512:
+  metadata.gz: 38aa516e2594f473fcc7cdc4e412240d01a29da7866ca043fff5f1119bf7e70b54f04e7545b9225995a34934dab9c8a52579a27292e46a4a7c6d0a2d885a8db4
+  data.tar.gz: 8307b1fe43ca21e3bbd83dee6a69818d1c3a7f3fbccf7951d8861d13a5aae3bae6d1b353412f42a54cedaaf9fd61470ea887e4efe5c049adb7b5e75f69399507

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+.ycm_extra_conf.py*
+mkmf.log
+ext/bindex/com/gsamokovarov/bindex/BindingBuilder.java

data/.travis.yml

@@ -0,0 +1,48 @@
+language: ruby
+
+rvm:
+  - ruby-1.9.3-p551
+  - ruby-1.9.3-p550
+  - ruby-1.9.3-p547
+  - ruby-1.9.3-p545
+  - ruby-1.9.3-p484
+
+  - ruby-2.0.0-p598
+  - ruby-2.0.0-p576
+  - ruby-2.0.0-p481
+  - ruby-2.0.0-p451
+  - ruby-2.0.0-p353
+  - ruby-2.0.0-p247
+  - ruby-2.0.0-p195
+  - ruby-2.0.0-p0
+
+  - ruby-2.1.5
+  - ruby-2.1.4
+  - ruby-2.1.3
+  - ruby-2.1.2-clang
+  - ruby-2.1.2
+  - ruby-2.1.1-clang
+  - ruby-2.1.1
+  - ruby-2.1.0-rc1
+  - ruby-2.1.0-preview2
+  - ruby-2.1.0-preview1
+  - ruby-2.1.0
+
+  - ruby-head
+
+  - rbx-2.2.7
+  - rbx-2.2.6
+  - rbx-2.2.2
+
+  - jruby-head
+  - jruby-1.7.9-d19
+  - jruby-1.7.17
+  - jruby-1.7.11
+
+env:
+  global:
+    - JRUBY_OPTS=-J-Djruby.compile.mode=OFF
+
+before_install: gem install bundler
+
+sudo: false

data/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Contributing
+
+1. Fork it ( https://github.com/gsamokovarov/bindex/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Etiquette
+
+If you want to contribute code, which is not your own or is heavily inspired by
+someone else's code, please give them a warm shoutout in the pull request (or
+the commit message) and the code itself.
+
+Of course, don't try to sneak in non MIT compatible code.

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# Rubinius 2.2.2 travis tests complain about this one.
+platforms :rbx do
+  gem "rubysl-mutex_m"
+  gem "rubysl-open3"
+  gem "rubysl-singleton"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Genadi Samokovarov
+
+MIT License
+
+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 @@
+# Bindex [![Build Status](https://travis-ci.org/gsamokovarov/bindex.svg?branch=master)](https://travis-ci.org/gsamokovarov/bindex)
+
+When Ruby raises an exception, it leaves you backtraces to help you figure out
+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
+
+**Do not** use this gem on production environments. The performance penalty isn't
+worth it anywhere outside of development.
+
+## Support
+
+### CRuby
+
+CRuby 1.9.2 and below is **not** supported.
+
+### JRuby
+
+To get the best support, run JRuby in interpreted mode.
+
+```bash
+export JRUBY_OPTS=-J-Djruby.compile.mode=OFF
+
+# If you run JRuby 1.7.12 and above, you can use:
+export JRUBY_OPTS=--dev
+```
+
+### Rubinius
+
+Internal errors like `ZeroDevisionError` aren't caught.
+
+## Credits
+
+Thanks to John Mair for his work on binding_of_caller, which is a huge
+inspiration. Thanks to Charlie Somerville for better_errors where the idea
+comes from. Thanks to Koichi Sasada for the debug inspector API in CRuby.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'erb'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+def jruby_9k?
+  JRUBY_VERSION.start_with?('9')
+end
+
+def root
+  Pathname.new File.expand_path('..', __FILE__)
+end
+
+def render_template(template_path, target = nil)
+  target ||= root.join(template_path).to_s.chomp('.erb')
+  template = ERB.new File.read(root.join(template_path))
+  File.write target, template.result(binding)
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+case RUBY_ENGINE
+when 'ruby'
+  require 'rake/extensiontask'
+
+  Rake::ExtensionTask.new('bindex') do |ext|
+    ext.name = 'cruby'
+    ext.lib_dir = 'lib/bindex'
+  end
+
+  task default: [:clean, :compile, :test]
+when 'jruby'
+  require 'rake/javaextensiontask'
+
+  Rake::JavaExtensionTask.new('bindex') do |ext|
+    ext.name = jruby_9k? ? 'jruby_internals_9k' : 'jruby_internals'
+    ext.lib_dir = 'lib/bindex'
+  end
+
+  render_template 'ext/bindex/com/gsamokovarov/bindex/BindingBuilder.java.erb'
+
+  task default: [:clean, :compile, :test]
+else
+  task default: [:test]
+end

data/bindex.gemspec

@@ -0,0 +1,27 @@
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+
+require 'bindex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bindex"
+  spec.version       = Bindex::VERSION
+  spec.authors       = ["Genadi Samokovarov"]
+  spec.email         = ["gsamokovarov@gmail.com"]
+  spec.extensions    = ["ext/bindex/extconf.rb"]
+  spec.summary       = "Bindings for your Ruby exceptions"
+  spec.homepage      = "https://github.com/gsamokovarov/bindex"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/bindex/extconf.rb"]
+
+  spec.add_development_dependency "minitest", "~> 5.4"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake-compiler"
+end

data/ext/bindex/bindex.h

@@ -0,0 +1,11 @@
+#ifndef _BINDEX_H
+#define _BINDEX_H
+
+#include <ruby.h>
+
+VALUE current_bindings(void);
+
+/* This will come from one of the ruby_*.h files. */
+extern VALUE rb_check_backtrace(VALUE);
+
+#endif

data/ext/bindex/bindings.c

@@ -0,0 +1,106 @@
+#include "bindex.h"
+
+#ifdef RUBY_193
+
+#include "ruby_193.h"
+
+static rb_thread_t *current_thread;
+
+#define GetCoreDataFromValueAsExpr(obj, type, ptr) \
+  ((ptr) = (type*)DATA_PTR(obj))
+
+#define ruby_current_thread \
+  GetCoreDataFromValueAsExpr(rb_thread_current(), rb_thread_t, current_thread)
+
+/*
+ * Create a binding from a thread and control frame.
+ *
+ * Based on rb_binding new, defined in proc.c. A major difference from
+ * rb_binding_new is that it doesn't raises an exception, when we try to create
+ * Binding on top of a Fiber.
+ *
+ * The reason for this is that binding_new is to be used in exception handling
+ * code. If we raise, it may lead to an infinite recursion.
+ *
+ * Also, we'll assume a bit more hostile environment and check if cfp->iseq is
+ * NULL.
+ *
+ * Ruby nil is returned when the control frame pointer isn't suitable.
+ */
+
+static VALUE
+binding_new(rb_thread_t *th, rb_control_frame_t *cfp)
+{
+  VALUE bindval;
+  rb_binding_t *bind;
+
+  if (cfp == NULL || cfp->iseq == NULL) {
+    return Qnil;
+  }
+
+  bindval = binding_alloc(rb_cBinding);
+
+  GetBindingPtr(bindval, bind);
+  bind->env = rb_vm_make_env_object(th, cfp);
+  bind->filename = cfp->iseq->filename;
+  bind->line_no = rb_vm_get_sourceline(cfp);
+  return bindval;
+}
+
+VALUE
+current_bindings(void)
+{
+  rb_thread_t *th = GET_THREAD();
+  rb_control_frame_t *cfp = th->cfp;
+  rb_control_frame_t *cfp_limit = RUBY_VM_END_CONTROL_FRAME(th);
+  VALUE binding, bindings = rb_ary_new();
+
+  while (cfp_limit > cfp) {
+    cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
+    binding = binding_new(th, cfp);
+
+    if (!NIL_P(binding)) {
+      rb_ary_push(bindings, binding);
+    }
+  }
+
+  return bindings;
+}
+
+#else
+
+#include <ruby/debug.h>
+
+#ifdef RUBY_20
+#include "ruby_20.h"
+#elif RUBY_21
+#include "ruby_21.h"
+#elif RUBY_21PREVIEW
+#include "ruby_21preview.h"
+#endif
+
+static VALUE
+current_bindings_callback(const rb_debug_inspector_t *context, void *data)
+{
+  VALUE locations = rb_debug_inspector_backtrace_locations(context);
+  VALUE binding, bindings = rb_ary_new();
+  long i, length = RARRAY_LEN(locations);
+
+  for (i = 0; i < length; i++) {
+    binding = rb_debug_inspector_frame_binding_get(context, i);
+
+    if (!NIL_P(binding)) {
+      rb_ary_push(bindings, binding);
+    }
+  }
+
+  return bindings;
+}
+
+VALUE
+current_bindings(void)
+{
+  return rb_debug_inspector_open(current_bindings_callback, NULL);
+}
+
+#endif

data/ext/bindex/com/gsamokovarov/bindex/BindingBuilder.java.erb

@@ -0,0 +1,17 @@
+package com.gsamokovarov.bindex;
+
+import org.jruby.runtime.DynamicScope;
+import org.jruby.runtime.Binding;
+import org.jruby.runtime.Frame;
+import org.jruby.runtime.DynamicScope;
+import org.jruby.runtime.backtrace.BacktraceElement;
+
+class BindingBuilder {
+    public static Binding build(Frame frame, DynamicScope scope, BacktraceElement element) {
+    <% if jruby_9k? %>
+        return new Binding(frame, scope, element.clone());
+    <% else %>
+        return new Binding(frame, scope.getStaticScope().getModule(), scope, element.clone());
+    <% end %>
+    }
+}

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

@@ -0,0 +1,54 @@
+package com.gsamokovarov.bindex;
+
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.DynamicScope;
+import org.jruby.runtime.Binding;
+import org.jruby.runtime.Frame;
+import org.jruby.runtime.DynamicScope;
+import org.jruby.runtime.backtrace.BacktraceElement;
+import java.util.Iterator;
+import java.util.NoSuchElementException;
+
+class CurrentBindingsIterator implements Iterator<Binding> {
+    private Frame[] frameStack;
+    private int frameIndex;
+
+    private DynamicScope[] scopeStack;
+    private int scopeIndex;
+
+    private BacktraceElement[] backtrace;
+    private int backtraceIndex;
+
+    CurrentBindingsIterator(ThreadContext context) {
+        ThreadContextInternals contextInternals = new ThreadContextInternals(context);
+
+        this.frameStack = contextInternals.getFrameStack();
+        this.frameIndex = contextInternals.getFrameIndex();
+
+        this.scopeStack = contextInternals.getScopeStack();
+        this.scopeIndex = contextInternals.getScopeIndex();
+
+        this.backtrace = contextInternals.getBacktrace();
+        this.backtraceIndex = contextInternals.getBacktraceIndex();
+    }
+
+    public boolean hasNext() {
+        return frameIndex >= 0 && scopeIndex >= 0 && backtraceIndex >= 0;
+    }
+
+    public Binding next() {
+        if (!hasNext()) {
+            throw new NoSuchElementException();
+        }
+
+        Frame frame = frameStack[frameIndex--];
+        DynamicScope scope = scopeStack[scopeIndex--];
+        BacktraceElement element = backtrace[backtraceIndex--];
+
+        return BindingBuilder.build(frame, scope, element);
+    }
+
+    public void remove() {
+        throw new UnsupportedOperationException();
+    }
+}

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

@@ -0,0 +1,34 @@
+package com.gsamokovarov.bindex;
+
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.Binding;
+import org.jruby.runtime.DynamicScope;
+import org.jruby.runtime.builtin.IRubyObject;
+import org.jruby.RubyBinding;
+import org.jruby.RubyArray;
+import org.jruby.Ruby;
+import java.util.Iterator;
+
+public class RubyBindingsCollector {
+    private final Ruby runtime;
+    private Iterator<Binding> iterator;
+
+    public static RubyArray collectCurrentFor(ThreadContext context) {
+        return new RubyBindingsCollector(context).collectCurrent();
+    }
+
+    private RubyBindingsCollector(ThreadContext context) {
+        this.iterator = new CurrentBindingsIterator(context);
+        this.runtime = context.getRuntime();
+    }
+
+    private RubyArray collectCurrent() {
+        RubyArray bindings = RubyArray.newArray(runtime);
+
+        while (iterator.hasNext()) {
+            bindings.append(((IRubyObject) RubyBinding.newBinding(runtime, iterator.next())));
+        }
+
+        return bindings;
+    }
+}