pry-stack_explorer 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7458ddda997e35095c5ebe7330a0ff651c4e424fdf0abbc6178fc8d7ae8367cb
-  data.tar.gz: ef6c275c07566ae94163be5df2f3358b671c4692789432a8dcd0e864891ee018
+  metadata.gz: 53b80cf3c06d7bdfaec826bed2ad1963a7bc69331d656e73b84d00e97a500197
+  data.tar.gz: 1942e6ad4fd0b43279d860aa06b2ca354b64eac8b713d426996b9a93a12f48d9
 SHA512:
-  metadata.gz: c5f740846b70146461babd122cc2b67f4b97fce0697ffca96a8ec24be9abca029427a5500bc2e4b8d211fd574b31e719a8a97d9b9201b52c22c04a7137cb8a39
-  data.tar.gz: 80bdd4a91d73943051f83847ee7933763c06a3c089e50ed3e7b28d595a691a693bf1c4b5b11022bde82f7658922cc5bc3e81a025803deafad0ff7997135fc220
+  metadata.gz: 2c51eb15eb17f9edff667c93fbead5a7ffe7fa1c4cd3114e516a2057e37ab728e8436f5123908d0fac07a823b2a61fbcc50072429fc8f5081c3c85be5bcaf1d2
+  data.tar.gz: 24dc58f1bfda481a2eddee4e294c953e7ead4bee736da3f07bc142f237e7fcb8b41da9a1bd39517ae53fb34a892b7cd9f2faae3240c2e382031b09ba31eced21

data/README.md

@@ -31,7 +31,7 @@ Commands:
 
 In Gemfile:
 ```rb
-gem 'pry-stack_explorer', '~> 0.5.0'
+gem 'pry-stack_explorer', '~> 0.6.0'
 ```
 
 ```
@@ -43,7 +43,7 @@ gem install pry-stack_explorer
 
 
 ### Branches and compatible Ruby versions
-* v0.5: Ruby 2.6+, Pry 0.13+
+* v0.5, v0.6: Ruby 2.6+, Pry 0.13+
 * v0.4.11+: Ruby 2.5, Pry 0.12+ (branch `0-4` – end-of-life in March 2021)
 * v0.4.9.3: Older versions (unsupported)
 

data/lib/pry-stack_explorer/commands.rb

@@ -247,6 +247,7 @@ module PryStackExplorer
         opt.on :H, :head, "Display the first N stack frames (defaults to 10).", :optional_argument => true, :as => Integer, :default => 10
         opt.on :T, :tail, "Display the last N stack frames (defaults to 10).", :optional_argument => true, :as => Integer, :default => 10
         opt.on :c, :current, "Display N frames either side of current frame (default to 5).", :optional_argument => true, :as => Integer, :default => 5
+        opt.on :a, :app, "Display application frames only", optional_argument: true
       end
 
       def memoized_info(index, b, verbose)
@@ -290,26 +291,72 @@ module PryStackExplorer
       private :selected_stack_frames
 
       def process
-        if !frame_manager
-          output.puts "No caller stack available!"
+        return no_stack_available! unless frame_manager
+
+        title = "Showing all accessible frames in stack (#{frame_manager.bindings.size} in total):"
+
+        content = [
+          bold(title),
+          "---",
+          make_stack_lines
+        ].join("\n")
+
+        stagger_output content
+      end
+
+      private
+
+      def make_stack_lines
+        frames_with_indices.map do |b, i|
+          make_stack_line(b, i, (i == frame_manager.binding_index))
+        end.join("\n")
+      end
+
+      def frames_with_indices
+        if opts.present?(:app) && defined?(ActiveSupport::BacktraceCleaner)
+          app_frames
         else
-          content = ""
-          content << "\n#{bold("Showing all accessible frames in stack (#{frame_manager.bindings.size} in total):")}\n--\n"
-
-          base_frame_index, frames = selected_stack_frames
-          frames.each_with_index do |b, index|
-            i = index + base_frame_index
-            if i == frame_manager.binding_index
-              content << "=> ##{i} #{memoized_info(i, b, opts[:v])}\n"
-            else
-              content << "   ##{i} #{memoized_info(i, b, opts[:v])}\n"
-            end
-          end
+          offset_frames
+        end
+      end
+
+      # "=> #0  method_name <Class#method(...)>"
+      def make_stack_line(b, i, active)
+        arw = active ? "=>" : "  "
+
+        "#{arw} ##{i} #{memoized_info(i, b, opts[:v])}"
+      end
 
-          stagger_output content
+      def offset_frames
+        base_frame_index, frames = selected_stack_frames
+
+        frames.each_with_index.map do |frame, index|
+          [frame, index + base_frame_index]
         end
       end
 
+      def no_stack_available!
+        output.puts "No caller stack available!"
+      end
+
+      LOCATION_LAMBDA = ->(_binding){ _binding.source_location[0] }
+
+      def app_frames
+        locations = frame_manager.bindings.map(&LOCATION_LAMBDA)
+        filtered = backtrace_cleaner.clean(locations)
+
+        frame_manager.bindings
+          .each_with_index
+          .map
+          .select do |_binding, _index|
+            LOCATION_LAMBDA.call(_binding).in?(filtered)
+          end
+      end
+
+      # also see Rails::BacktraceCleaner
+      def backtrace_cleaner
+        @backtrace_cleaner ||= ActiveSupport::BacktraceCleaner.new
+      end
     end
 
     alias_command "show-stack", "stack"

data/lib/pry-stack_explorer/version.rb

@@ -1,3 +1,3 @@
 module PryStackExplorer
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-stack_explorer
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - John Mair (banisterfiend)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-31 00:00:00.000000000 Z
+date: 2021-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -83,7 +83,10 @@ files:
 homepage: https://github.com/pry/pry-stack_explorer
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/pry/pry-stack_explorer/issues
+  source_code_uri: https://github.com/pry/pry-stack_explorer
+  changelog_uri: https://github.com/pry/pry-stack_explorer/blob/master/CHANGELOG
 post_install_message:
 rdoc_options: []
 require_paths: