debug_inspector 0.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0818f4d1a14ebba76cdf967f063526c1caae14f6
-  data.tar.gz: 5999c5d5a10721d1a824c648d1c9825491c5a1b0
+SHA256:
+  metadata.gz: a9c0e6d3b5bd68235adc5212ad47f99333f9522b6c4b823cb783eb94a2d59d90
+  data.tar.gz: e90e6a29a0fdaf86d2259a825ec4bd0b1687e572b90cc24d6d6f889dcb225747
 SHA512:
-  metadata.gz: c1598e9ae43dd251033b733e15998a5e40f1acd13ea3cdca657a371377dbae8da4739f51423e18d099723efa0e6b587ef0af14cf7a525a75f03235a056045fca
-  data.tar.gz: b33a0f6ff4a4ea8db69186c7578768e8309138dd84357b9cea49966ac1abd3291e3f65f6ed9816efa03c1325c05fc57be38f13e0196ff5d299e3a927337a5531
+  metadata.gz: df09cff61314f0af4f9fe0584e7417b0faa756652f1b6157895aae17cd852125a5b8c0535adfdfcdae8fd78e6e5ad845ac6101841373eba4eb75c29894a0674d
+  data.tar.gz: 1f329aeae5a8036e9959bdb43095ffcc92110a83f803f9835554a9b5a6b05253cf704006607d321d2abbe02847cce38f4f1f64c975197c03afa746b99c6e717f

data/.github/workflows/test.yml

@@ -0,0 +1,112 @@
+name: Test
+
+on:
+  push:
+    branches: [ master ]
+  schedule:
+    - cron: '0 0 11,25 * *' # roughly every two weeks to run on new Ruby versions
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: "Unit"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - macos-latest
+          - ubuntu-latest
+          - windows-latest
+        ruby:
+          - "2.1"
+          - "2.2"
+          - "2.3"
+          - "2.4"
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+
+    steps:
+
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Test
+      run: bundle exec rake
+
+  system:
+    name: "System"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - macos-latest
+          - ubuntu-latest
+          - windows-latest
+        ruby:
+          # This includes rubies that are not actually extended by this gem.
+          # We want to make sure the gem silently fails to load on those platforms.
+          - "2"
+          - "3.0"
+          - "jruby"
+          - "truffleruby"
+        exclude:
+          # Windows releases of jruby and truffleruby have issues. Skip them for now.
+          - { ruby: "jruby", os: "windows-latest" }
+          - { ruby: "truffleruby", os: "windows-latest" }
+
+    steps:
+
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Build gem
+      run: bundle exec gem build --verbose debug_inspector.gemspec
+
+    - name: Install gem
+      run: gem install --verbose debug_inspector*.gem
+
+    - name: Create directory for gem test
+      run: mkdir -p tmp/gem-test
+
+    - name: Create test Gemfile
+      run: echo "gem 'debug_inspector'" > Gemfile
+      working-directory: ./tmp/gem-test
+
+    - name: Get gem installation path
+      id: gem_path
+      run: |
+        gem_path=$(bundle show debug_inspector)
+        echo "gem_path is ${gem_path}"
+        echo "::set-output name=path::${gem_path}"
+      shell: bash
+      working-directory: ./tmp/gem-test
+
+    - name: List installed gem contents
+      run: find .
+      shell: bash
+      working-directory: ${{ steps.gem_path.outputs.path }}
+
+    - name: Test gem load
+      run: bundle exec ruby -e "require 'debug_inspector'"
+      working-directory: ./tmp/gem-test
+
+    - name: Test gem functionality
+      if: ${{ matrix.ruby != 'jruby' && matrix.ruby != 'truffleruby' }}
+      run: bundle exec ruby -e "require 'debug_inspector'; RubyVM::DebugInspector.open { |dc| dc.frame_binding(1) }"
+      working-directory: ./tmp/gem-test

data/.gitignore

@@ -0,0 +1,16 @@
+Gemfile.lock
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+Makefile

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in debug_inspector.gemspec
+gemspec
+
+gem "rake"
+gem "rake-compiler"
+gem "minitest"

data/README.md

@@ -1,11 +1,19 @@
+[![Build Status](https://github.com/banister/debug_inspector/workflows/Test/badge.svg?branch=master&event=push)](https://github.com/banister/debug_inspector/actions?query=branch%3Amaster)
+[![Gem Version](https://img.shields.io/gem/v/debug_inspector.svg)](https://rubygems.org/gems/debug_inspector)
+
 debug_inspector
 ===============
 
-(C) John Mair (banisterfiend) 2012
+_A Ruby wrapper for the MRI 2.0+ debug\_inspector API_
+
+The `debug_inspector` C extension and API were designed and built by [Koichi Sasada](https://github.com/ko1), this project
+is just a gemification of his work.
 
-_A Ruby wrapper for the new MRI 2.0 debug\_inspector API_
+**NOTES:**
 
-** This library only works on MRI 2.0. Requiring it on unsupported Rubies will resort in a no-op **
+* **Do not use this library outside of debugging situations**.
+* This library makes use of the debug inspector API which was new in MRI 2.0.0.
+* Only works on MRI 2 and 3. Requiring it on unsupported Rubies will result in a no-op
 
 Usage
 -----
@@ -13,19 +21,33 @@ Usage
 ```ruby
 require 'debug_inspector'
 
-# binding of nth caller frame (returns a Binding object)
-RubyVM::DebugInspector.open { |i| i.frame_binding(n) }
+# Open debug context
+# Passed `dc' is only active in a block
+RubyVM::DebugInspector.open { |dc|
+  # backtrace locations (returns an array of Thread::Backtrace::Location objects)
+  locs = dc.backtrace_locations
 
-# iseq of nth caller frame (returns a RubyVM::InstructionSequence object)
-RubyVM::DebugInspector.open { |i| i.frame_iseq(n) }
+  # you can get depth of stack frame with `locs.size'
+  locs.size.times do |i|
+    # binding of i-th caller frame (returns a Binding object or nil)
+    p dc.frame_binding(i)
 
-# class of nth caller frame
-RubyVM::DebugInspector.open { |i| i.frame_class(n) }
+    # iseq of i-th caller frame (returns a RubyVM::InstructionSequence object or nil)
+    p dc.frame_iseq(i)
 
-# backtrace locations (returns an array of Thread::Backtrace::Location objects)
-RubyVM::DebugInspector.open { |i| i.backtrace_locations }
+    # class of i-th caller frame
+    p dc.frame_class(i)
+  end
+}
 ```
 
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
 Contact
 -------
 
@@ -36,7 +58,7 @@ License
 
 (The MIT License)
 
-Copyright (c) 2012 (John Mair)
+Copyright (c) 2012-2013 (John Mair)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,72 +1,27 @@
-$:.unshift 'lib'
-require 'rake/clean'
-require "debug_inspector/version"
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-dlext = RbConfig::CONFIG['DLEXT']
-direc = File.expand_path(File.dirname(__FILE__))
-CLOBBER.include("**/*.#{dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
-CLEAN.include("ext/**/*.#{dlext}", "ext/**/*.log", "ext/**/*.o",
-              "ext/**/*~", "ext/**/*#*", "ext/**/*.obj", "**/*#*", "**/*#*.*",
-              "ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake", "**/*.rbc")
-desc "Show version"
-task :version do
-  puts "debug_inspector version: #{DebugInspector::VERSION}"
-end
-
-desc "run tests"
-task :default => [:test]
-
-desc "Run tests"
-task :test do
-  sh "bacon -Itest -rubygems -a -q"
-end
-
-task :pry do
-  puts "loading debug_inspector into pry"
-  sh "pry -r #{direc}/lib/debug_inspector"
-end
+def can_compile_extensions?
+  RUBY_ENGINE == "ruby"
+end 
 
-desc "build the binaries"
-task :compile do
-  chdir "#{direc}/ext/debug_inspector/" do
-    sh "ruby extconf.rb"
-    sh "make clean"
-    sh "make"
-    sh "cp *.#{dlext} ../../lib/"
-  end
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = true
+  t.verbose = true
 end
 
-desc 'cleanup the extensions'
-task :cleanup do
-  sh "rm -rf lib/debug_inspector.#{dlext}"
-  chdir "#{direc}/ext/debug_inspector/" do
-    sh 'make clean' rescue nil
-  end
-end
-
-desc "(re)install gem"
-task :reinstall => :gem do
-  sh "gem uninstall debug_inspector" rescue nil
-  sh "gem install -l #{direc}/debug_inspector-#{DebugInspector::VERSION}.gem"
-end
-
-task :install => :reinstall
-
-desc "build all platform gems at once"
-task :gem => [:clean, :rmgems] do
-  sh "gem build #{direc}/debug_inspector.gemspec"
-end
+require "rake/extensiontask"
 
-desc "remove all platform gems"
-task :rmgems do
-  sh "rm #{direc}/*.gem" rescue nil
+if can_compile_extensions?
+  task :build => :compile
+  task :default => [:clobber, :compile, :test]
+else
+  task :default => [:test]
 end
 
-desc "build and push latest gems"
-task :pushgems => :gem do
-  chdir(direc) do
-    Dir["*.gem"].each do |gemfile|
-      sh "gem push #{gemfile}"
-    end
-  end
+Rake::ExtensionTask.new("debug_inspector") do |ext|
+  ext.lib_dir = "lib"
 end

data/debug_inspector.gemspec

@@ -1,15 +1,37 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/debug_inspector/version', __FILE__)
-
-Gem::Specification.new do |s|
-  s.name    = "debug_inspector"
-  s.version = DebugInspector::VERSION
-  s.authors = ["John Mair (banisterfiend)"]
-  s.email = ["jrmair@gmail.com"]
-  s.homepage = "https://github.com/banister/debug_inspector"
-  s.summary = "A Ruby wrapper for the MRI 2.0 debug_inspector API"
-  s.description = s.summary
-  s.files         = `git ls-files`.split("\n")
-  s.platform = Gem::Platform::RUBY
-  s.extensions = ["ext/debug_inspector/extconf.rb"]
+# We don't want to define any constants if the gem extension isn't loaded, so not requiring the version file.
+
+Gem::Specification.new do |spec|
+  spec.name          = "debug_inspector"
+  spec.version       = "1.1.0"
+  spec.authors       = ["John Mair (banisterfiend)"]
+  spec.email         = ["jrmair@gmail.com"]
+
+  spec.summary       = %q{A Ruby wrapper for the MRI 2.0 debug_inspector API}
+  spec.description   = <<-TXT
+Adds methods to RubyVM::DebugInspector to allow for inspection of backtrace frames.
+
+The debug_inspector C extension and API were designed and built by Koichi Sasada, this project is just a gemification of his work.
+
+This library makes use of the debug inspector API which was added to MRI 2.0.0.
+Only works on MRI 2 and 3. Requiring it on unsupported Rubies will result in a no-op.
+
+Recommended for use only in debugging situations. Do not use this in production apps.
+TXT
+  spec.homepage      = "https://github.com/banister/debug_inspector"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/banister/debug_inspector"
+  spec.metadata["changelog_uri"] = "https://github.com/banister/debug_inspector/releases"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|bin)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  if RUBY_ENGINE == "ruby"
+    spec.extensions = ["ext/debug_inspector/extconf.rb"]
+  end
 end

data/ext/debug_inspector/debug_inspector.c

@@ -10,15 +10,7 @@
 **********************************************************************/
 
 #include "ruby/ruby.h"
-
-typedef struct rb_debug_inspector_struct rb_debug_inspector_t;
-typedef VALUE (*rb_debug_inspector_func_t)(const rb_debug_inspector_t *, void *);
-
-VALUE rb_debug_inspector_open(rb_debug_inspector_func_t func, void *data);
-VALUE rb_debug_inspector_frame_binding_get(const rb_debug_inspector_t *dc, int index);
-VALUE rb_debug_inspector_frame_class_get(const rb_debug_inspector_t *dc, int index);
-VALUE rb_debug_inspector_frame_iseq_get(const rb_debug_inspector_t *dc, int index);
-VALUE rb_debug_inspector_backtrace_locations(const rb_debug_inspector_t *dc);
+#include "ruby/debug.h"
 
 static size_t
 di_size(const void *dummy)
@@ -37,7 +29,7 @@ di_get_dc(VALUE self)
     const rb_debug_inspector_t *dc;
     TypedData_Get_Struct(self, const rb_debug_inspector_t, &di_data_type, dc);
     if (dc == 0) {
-	rb_raise(rb_eArgError, "invalid inspector context");
+	rb_raise(rb_eArgError, "invalid debug context");
     }
     return dc;
 }
@@ -70,6 +62,13 @@ di_frame_iseq(VALUE self, VALUE index)
     return rb_debug_inspector_frame_iseq_get(dc, NUM2INT(index));
 }
 
+static VALUE
+di_frame_self(VALUE self, VALUE index)
+{
+    const rb_debug_inspector_t *dc = di_get_dc(self);
+    return rb_debug_inspector_frame_self_get(dc, NUM2INT(index));
+}
+
 static VALUE
 breakpoint_i(const rb_debug_inspector_t *dc, void *ptr)
 {
@@ -114,4 +113,5 @@ Init_debug_inspector(void)
     rb_define_method(cDebugInspector, "frame_binding", di_binding, 1);
     rb_define_method(cDebugInspector, "frame_class", di_frame_class, 1);
     rb_define_method(cDebugInspector, "frame_iseq", di_frame_iseq, 1);
+    rb_define_method(cDebugInspector, "frame_self", di_frame_self, 1);
 }

data/ext/debug_inspector/extconf.rb

@@ -1,16 +1,17 @@
 def fake_makefile
-  File.open(File.join(File.dirname(__FILE__), "Makefile"), "w") {|f|
-    f.puts %[install:\n\techo "Nada."]
+  File.open("Makefile", "w") { |f|
+    f.puts '.PHONY: install'
+    f.puts 'install:'
+    f.puts "\t" + '@echo "This Ruby not supported by/does not require debug_inspector."'
   }
 end
 
-def mri_2?
+def mri_2_or_3?
   defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby" &&
-    RUBY_VERSION =~ /^2/
+    RUBY_VERSION =~ /^[23]/
 end
 
-  
-if mri_2?
+if mri_2_or_3?
   require 'mkmf'
   create_makefile('debug_inspector')
 else

data/lib/debug_inspector.rb

@@ -1,5 +1,17 @@
+require 'rbconfig'
+dlext = RbConfig::CONFIG['DLEXT']
 begin
-  require 'debug_inspector.so'
+  # If the installation task did its job, the extension is in lib/ next to this file.
+  require "debug_inspector.#{dlext}"
+  # We only want to define constants if the extension has loaded.
+  require_relative "rubyvm/debug_inspector/version"
 rescue LoadError
+  begin
+    # If not, maybe the extension is in ext/
+    require_relative "../ext/debug_inspector/debug_inspector.#{dlext}"
+    # We only want to define constants if the extension has loaded.
+    require_relative "rubyvm/debug_inspector/version"
+  rescue LoadError => e
+    puts "debug_inspector extension was not loaded"
+  end
 end
-

data/lib/rubyvm/debug_inspector/version.rb

@@ -0,0 +1,4 @@
+class RubyVM::DebugInspector
+  # Don't forget to update the version string in the gemspec file.
+  VERSION = "1.1.0"
+end

metadata

@@ -1,16 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: debug_inspector
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - John Mair (banisterfiend)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-08 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies: []
-description: A Ruby wrapper for the MRI 2.0 debug_inspector API
+description: |
+  Adds methods to RubyVM::DebugInspector to allow for inspection of backtrace frames.
+
+  The debug_inspector C extension and API were designed and built by Koichi Sasada, this project is just a gemification of his work.
+
+  This library makes use of the debug inspector API which was added to MRI 2.0.0.
+  Only works on MRI 2 and 3. Requiring it on unsupported Rubies will result in a no-op.
+
+  Recommended for use only in debugging situations. Do not use this in production apps.
 email:
 - jrmair@gmail.com
 executables: []
@@ -18,32 +26,39 @@ extensions:
 - ext/debug_inspector/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- Gemfile
 - README.md
 - Rakefile
 - debug_inspector.gemspec
 - ext/debug_inspector/debug_inspector.c
 - ext/debug_inspector/extconf.rb
 - lib/debug_inspector.rb
+- lib/rubyvm/debug_inspector/version.rb
 homepage: https://github.com/banister/debug_inspector
-licenses: []
-metadata: {}
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/banister/debug_inspector
+  source_code_uri: https://github.com/banister/debug_inspector
+  changelog_uri: https://github.com/banister/debug_inspector/releases
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.0.rc.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper for the MRI 2.0 debug_inspector API