bindex 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a529d393523162bc2f77aba87dba5b0f40296e83275ad974f8daf3e153647860
-  data.tar.gz: d3de0fc8593a6b60e373471b57ec39d5198e7cb76a65c90d7d1ce06d5d173955
+  metadata.gz: dc0cd337ca86dbea712a96611e763bac2bfa6c5d071800dc31debfc9247014b2
+  data.tar.gz: cf366a1aeefb502da4a3fd8232b25ead77948edcae7a7e19519638f5548275a1
 SHA512:
-  metadata.gz: bd8a0e928378ccaab83e4bd9225c2332145269ff5a0f1337b8b126f40ec97e8356243c297ba71117685e1c3e8ec45d87708647fca2cfc3e32cded3fbc8858872
-  data.tar.gz: 7ddc6e5758b5010190dad749349fb815ca681f251ffdae3fc0be215e1a15d76ad61ae43636ecbeb58c2fe87b2253d14d1fe9cf55bf7ed22aa1f805e5ca1ffb4f
+  metadata.gz: 37399ff142e9ac9248d161ed88af04b8cb84fcec714e472078aa509a160ba3fe744c75caa1d084275cad601ede518e748841e3b71443ee75ed5c796c5331eb2c
+  data.tar.gz: 8568a9a1b78ebf4bf58ceb461e3aed432901284aa8dbd8bf8321818cf90e0b60455a20b8a1c87ce42956d41606ca041437d37162c6721d94703a1e8f6f915220

data/.travis.yml

@@ -1,13 +1,10 @@
 language: ruby
 
 rvm:
-  - ruby-2.3.3
-  - ruby-2.4.0
+  - ruby-2.5
+  - ruby-2.6
   - ruby-head
 
-  - jruby-9.1.8.0
-  - jruby-head
-
 allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
@@ -18,6 +15,4 @@ env:
 
 before_install: gem install bundler
 
-sudo: false
-
 cache: bundler

data/README.md

@@ -1,4 +1,4 @@
-# Skiptrace [![Build Status](https://travis-ci.org/gsamokovarov/bindex.svg?branch=master)](https://travis-ci.org/gsamokovarov/bindex)
+# Skiptrace [![Build Status](https://travis-ci.org/gsamokovarov/skiptrace.svg?branch=master)](https://travis-ci.org/gsamokovarov/skiptrace)
 
 When Ruby raises an exception, it leaves you a backtrace to help you figure out
 where did the exception originated in. Skiptrace gives you the bindings as well.
@@ -18,6 +18,11 @@ Skiptrace defines the following API:
 
 Returns all the bindings up to the one in which the exception originated in.
 
+#### Exception#binding_locations
+
+Returns an array of `Skiptrace::Location` objects that are like [`Thread::Backtrace::Location`](https://ruby-doc.org/core-2.6.3/Thread/Backtrace/Location.html)
+but also carry a `Binding` object for that frame through the `#binding` method.
+
 #### Skiptrace.current_bindings
 
 Returns all of the current Ruby execution state bindings. The first one is the
@@ -28,7 +33,7 @@ caller one and so on.
 
 ### CRuby
 
-CRuby 2.0.0 and above is supported.
+CRuby 2.5.0 and above is supported.
 
 ### JRuby
 

data/Rakefile

@@ -7,7 +7,7 @@ Bundler::GemHelper.install_tasks name: ENV.fetch('GEM_NAME', 'skiptrace')
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
-  t.test_files = FileList['test/*_test.rb']
+  t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
 end
 
@@ -17,7 +17,7 @@ when 'ruby'
 
   Rake::ExtensionTask.new('skiptrace') do |ext|
     ext.name = 'cruby'
-    ext.lib_dir = 'lib/skiptrace'
+    ext.lib_dir = 'lib/skiptrace/internal'
   end
 
   task default: [:clean, :compile, :test]
@@ -26,7 +26,7 @@ when 'jruby'
 
   Rake::JavaExtensionTask.new('skiptrace') do |ext|
     ext.name = 'jruby_internals'
-    ext.lib_dir = 'lib/skiptrace'
+    ext.lib_dir = 'lib/skiptrace/internal'
     ext.source_version = '1.8'
     ext.target_version = '1.8'
   end

data/lib/skiptrace.rb

@@ -1,11 +1,14 @@
 case RUBY_ENGINE
 when 'rbx'
-  require 'skiptrace/rubinius'
+  require 'skiptrace/internal/rubinius'
 when 'jruby'
-  require 'skiptrace/jruby'
+  require 'skiptrace/internal/jruby'
 when 'ruby'
-  require 'skiptrace/cruby'
+  require 'skiptrace/internal/cruby'
 end
 
-require "skiptrace/version"
-
+require 'skiptrace/location'
+require 'skiptrace/binding_locations'
+require 'skiptrace/binding_ext'
+require 'skiptrace/exception_ext'
+require 'skiptrace/version'

data/lib/skiptrace/binding_ext.rb

@@ -0,0 +1,5 @@
+class Binding
+  def source_location
+    eval '[__FILE__, __LINE__.to_i]'
+  end unless method_defined?(:source_location)
+end

data/lib/skiptrace/binding_locations.rb

@@ -0,0 +1,34 @@
+module Skiptrace
+  class BindingLocations < BasicObject
+    def initialize(locations, bindings)
+      @locations = locations
+      @bindings = bindings
+      @cached_locations = {}
+    end
+
+    private
+
+    def cached_location(location)
+      @cached_locations[location.to_s] ||= Location.new(location, guess_binding_around(location))
+    end
+
+    def guess_binding_around(location)
+      location && @bindings.find do |binding|
+        binding.source_location == [location.path, location.lineno]
+      end
+    end
+
+    def method_missing(name, *args, &block)
+      case maybe_location = @locations.public_send(name, *args, &block)
+      when ::Thread::Backtrace::Location
+        cached_location(maybe_location)
+      else
+        maybe_location
+      end
+    end
+
+    def respond_to_missing?(name, include_all = false)
+      @locations.respond_to?(name, include_all)
+    end
+  end
+end

data/lib/skiptrace/exception_ext.rb

@@ -0,0 +1,5 @@
+class Exception
+  def binding_locations
+    @binding_locations ||= Skiptrace::BindingLocations.new(backtrace_locations, bindings)
+  end
+end

data/lib/skiptrace/internal/jruby.rb

@@ -0,0 +1,7 @@
+require 'skiptrace/internal/jruby_internals'
+
+module Skiptrace
+  java_import com.gsamokovarov.skiptrace.JRubyIntegration
+
+  JRubyIntegration.setup(JRuby.runtime)
+end

data/lib/skiptrace/location.rb

@@ -0,0 +1,34 @@
+module Skiptrace
+  class Location
+    attr_reader :binding
+
+    def initialize(location, binding)
+      @location = location
+      @binding = binding
+    end
+
+    def absolute_path
+      @location.absolute_path
+    end
+
+    def base_label
+      @location.base_label
+    end
+
+    def inspect
+      @location.inspect
+    end
+
+    def label
+      @location.label
+    end
+
+    def lineno
+      @location.lineno
+    end
+
+    def to_s
+      @location.to_s
+    end
+  end
+end

data/lib/skiptrace/version.rb

@@ -1,3 +1,3 @@
 module Skiptrace
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/skiptrace.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/gsamokovarov/skiptrace"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = ">= 2.0.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/test/fixtures/basic_nested_fixture.rb

@@ -1,13 +1,17 @@
-class BasicNestedFixture
-  def call
-    raise_an_error
-  rescue => exc
-    exc
-  end
+module Skiptrace
+  module BasicNestedFixture
+    extend self
+
+    def call
+      raise_an_error
+    rescue => exc
+      exc
+    end
 
-  private
+    private
 
     def raise_an_error
       raise
     end
+  end
 end

data/test/fixtures/custom_error_fixture.rb

@@ -1,9 +1,11 @@
-class CustomErrorFixture
-  Error = Class.new(StandardError)
+module Skiptrace
+  module CustomErrorFixture
+    Error = Class.new(StandardError)
 
-  def call
-    raise Error
-  rescue => exc
-    exc
+    def self.call
+      raise Error
+    rescue => exc
+      exc
+    end
   end
 end

data/test/fixtures/eval_nested_fixture.rb

@@ -1,13 +1,17 @@
-class EvalNestedFixture
-  def call
-    tap { raise_an_error_in_eval }
-  rescue => exc
-    exc
-  end
+module Skiptrace
+  module EvalNestedFixture
+    extend self
+
+    def call
+      tap { raise_an_error_in_eval }
+    rescue => exc
+      exc
+    end
 
-  private
+    private
 
     def raise_an_error_in_eval
       eval 'raise', binding, __FILE__, __LINE__
     end
+  end
 end

data/test/fixtures/flat_fixture.rb

@@ -1,7 +1,9 @@
-class FlatFixture
-  def call
-    raise
-  rescue => exc
-    exc
+module Skiptrace
+  module FlatFixture
+    def self.call
+      raise
+    rescue => exc
+      exc
+    end
   end
 end

data/test/fixtures/reraised_fixture.rb

@@ -1,11 +1,14 @@
-class ReraisedFixture
-  def call
-    reraise_an_error
-  rescue => exc
-    exc
-  end
+module Skiptrace
+  module ReraisedFixture
+    extend self
 
-  private
+    def call
+      reraise_an_error
+    rescue => exc
+      exc
+    end
+
+    private
 
     def raise_an_error_in_eval
       method_that_raises
@@ -16,4 +19,5 @@ class ReraisedFixture
     def method_that_raises
       raise
     end
+  end
 end

data/test/skiptrace/current_bindings_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+module Skiptrace
+  class CurrentBindingsTest < Test
+    test 'first binding returned is the current one' do
+      _, lineno = Skiptrace.current_bindings.first.source_location
+
+      assert_equal __LINE__ - 2, lineno
+    end
+  end
+end

data/test/skiptrace/exception_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+module Skiptrace
+  class ExceptionTest < Test
+    test 'bindings returns all the bindings of where the error originated' do
+      exc = FlatFixture.()
+
+      assert_equal 4, exc.bindings.first.source_location.last
+    end
+
+    test 'bindings returns all the bindings of where a custom error originate' do
+      exc = CustomErrorFixture.()
+
+      assert_equal 6, exc.bindings.first.source_location.last
+    end
+
+    test 'bindings goes down the stack' do
+      exc = BasicNestedFixture.()
+
+      assert_equal 14, exc.bindings.first.source_location.last
+    end
+
+    test 'bindings inside of an eval' do
+      exc = EvalNestedFixture.()
+
+      assert_equal 14, exc.bindings.first.source_location.last
+    end
+
+    test "re-raising doesn't lose bindings information" do
+      exc = ReraisedFixture.()
+
+      assert_equal 6, exc.bindings.first.source_location.last
+    end
+
+    test 'bindings is empty when exception is still not raised' do
+      exc = RuntimeError.new
+
+      assert_equal [], exc.bindings
+    end
+
+    test 'bindings is empty when set backtrace is badly called' do
+      exc = RuntimeError.new
+
+      # Exception#set_backtrace expects a string or array of strings. If the
+      # input isn't like this it will raise a TypeError.
+      assert_raises(TypeError) do
+        exc.set_backtrace([nil])
+      end
+
+      assert_equal [], exc.bindings
+    end
+
+    test 'binding_locations maps closely to backtrace_locations' do
+      exc = FlatFixture.()
+
+      exc.binding_locations.first.tap do |location|
+        assert_equal 4, location.lineno
+        assert_equal exc, location.binding.eval('exc')
+      end
+
+      exc.binding_locations[1].tap do |location|
+        assert_equal 54, location.lineno
+        assert_equal exc, location.binding.eval('exc')
+      end
+    end
+  end
+end

data/test/skiptrace/location_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+module Skiptrace
+  class LocationTest < Test
+    test 'behaves like Thread::Backtrace::Location' do
+      native_location = caller_locations.first
+      location = Skiptrace::Location.new(native_location, binding)
+
+      assert_equal native_location.absolute_path, location.absolute_path
+      assert_equal native_location.base_label, location.base_label
+      assert_equal native_location.inspect, location.inspect
+      assert_equal native_location.label, location.label
+      assert_equal native_location.to_s, location.to_s
+
+      assert_equal [__FILE__, __LINE__ - 8], location.binding.source_location
+    end
+  end
+end

data/test/test_helper.rb

@@ -10,8 +10,10 @@ Dir["#{current_directory}/fixtures/**/*.rb"].each do |fixture|
   require fixture
 end
 
-class BaseTest < MiniTest::Test
-  def self.test(name, &block)
-    define_method("test_#{name}", &block)
+module Skiptrace
+  class Test < MiniTest::Test
+    def self.test(name, &block)
+      define_method("test_#{name}", &block)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bindex
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Genadi Samokovarov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -93,18 +93,23 @@ files:
 - ext/skiptrace/extconf.rb
 - lib/bindex.rb
 - lib/skiptrace.rb
-- lib/skiptrace/jruby.rb
-- lib/skiptrace/jruby_internals.jar
-- lib/skiptrace/rubinius.rb
+- lib/skiptrace/binding_ext.rb
+- lib/skiptrace/binding_locations.rb
+- lib/skiptrace/exception_ext.rb
+- lib/skiptrace/internal/jruby.rb
+- lib/skiptrace/internal/jruby_internals.jar
+- lib/skiptrace/internal/rubinius.rb
+- lib/skiptrace/location.rb
 - lib/skiptrace/version.rb
 - skiptrace.gemspec
-- test/current_bindings_test.rb
-- test/exception_test.rb
 - test/fixtures/basic_nested_fixture.rb
 - test/fixtures/custom_error_fixture.rb
 - test/fixtures/eval_nested_fixture.rb
 - test/fixtures/flat_fixture.rb
 - test/fixtures/reraised_fixture.rb
+- test/skiptrace/current_bindings_test.rb
+- test/skiptrace/exception_test.rb
+- test/skiptrace/location_test.rb
 - test/test_helper.rb
 homepage: https://github.com/gsamokovarov/bindex
 licenses:
@@ -130,11 +135,12 @@ 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
 - test/fixtures/eval_nested_fixture.rb
 - test/fixtures/flat_fixture.rb
 - test/fixtures/reraised_fixture.rb
+- test/skiptrace/current_bindings_test.rb
+- test/skiptrace/exception_test.rb
+- test/skiptrace/location_test.rb
 - test/test_helper.rb

data/lib/skiptrace/jruby.rb

@@ -1,5 +0,0 @@
-require 'skiptrace/jruby_internals'
-
-java_import com.gsamokovarov.skiptrace.JRubyIntegration
-
-JRubyIntegration.setup(JRuby.runtime)

data/test/current_bindings_test.rb

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

data/test/exception_test.rb

@@ -1,51 +0,0 @@
-require 'test_helper'
-
-class ExceptionTest < BaseTest
-  test 'bindings returns all the bindings of where the error originated' do
-    exc = FlatFixture.new.call
-
-    assert_equal 3, exc.bindings.first.eval('__LINE__')
-  end
-
-  test 'bindings returns all the bindings of where a custom error originate' do
-    exc = CustomErrorFixture.new.call
-
-    assert_equal 5, exc.bindings.first.eval('__LINE__')
-  end
-
-  test 'bindings goes down the_stack' do
-    exc = BasicNestedFixture.new.call
-
-    assert_equal 11, exc.bindings.first.eval('__LINE__')
-  end
-
-  test 'bindings inside_of_an_eval' do
-    exc = EvalNestedFixture.new.call
-
-    assert_equal 11, exc.bindings.first.eval('__LINE__')
-  end
-
-  test "re-raising doesn't lose bindings information" do
-    exc = ReraisedFixture.new.call
-
-    assert_equal 3, exc.bindings.first.eval('__LINE__')
-  end
-
-  test 'bindings is_empty_when_exception_is_still_not_raised' do
-    exc = RuntimeError.new
-
-    assert_equal [], exc.bindings
-  end
-
-  test 'bindings is_empty_when_set_backtrace_is_badly_called' do
-    exc = RuntimeError.new
-
-    # Exception#set_backtrace expects a string or array of strings. If the
-    # input isn't like this it will raise a TypeError.
-    assert_raises(TypeError) do
-      exc.set_backtrace([nil])
-    end
-
-    assert_equal [], exc.bindings
-  end
-end