puts_debuggerer 0.13.2 → 0.13.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f1e480d2a8330d48a546c7e89a2479185cfad2bc1f6b8cf1a9750494de27406
-  data.tar.gz: e135390dd68993136fd2fd4d22d4721dd8a12454f5ce71f2ad164f453358e1db
+  metadata.gz: cef89b14f7e9ae764d7231ddaa5ab880ccaacd5366cdde5db8cebf6096ef6ddc
+  data.tar.gz: 0ce08e74da428ede072d3d343e983a499f78939ddd5134ed262ca8505fb824d5
 SHA512:
-  metadata.gz: 752b67073d6ffda81d890aa568a74f48f7f09b3321c4d5b6e7f51ea8a5c098b0feebe77e3ca5d4f0a80eb842844e8d76f8f75443ab075f153d761842594664db
-  data.tar.gz: bb327d1a2633282307da402569697746c4f0ba91e0c93955728fb9ba647bec9d7d2100406040afe950c630d4a0e9774d3afdc94ac0e8bf1795b429e231dda2d4
+  metadata.gz: f473268d3f34d3e12ce51152a9eb4e2295448a623c087705072101d15603da5792abc7d02d2eeb272fba4369727c273d9cc9cf5845cd3d36869bdbc7971b0da5
+  data.tar.gz: d91edb075e81269b9f3a7589cd2f84b0126ff0b9c66633d51cdca3829e25119051a00270fb194fe17c2a7a430c7c7b65d63696cf422162a944aeaf367c5d1d5f

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## 0.13.5
+
+- Fix not printing source line in Rails app w/ Pry
+- Note that Pry's compatibility (inside Pry) is experimental and fragile because Pry's API is not reliable
+
+## 0.13.4
+
+- Reverted change to default `printer` behavior from 0.13.3 to avoid causing a double-print to stdout as it turns out `puts` is not always needed since Rails redirects to standard out by default in `Rails.logger.debug` calls
+
+## 0.13.3
+
+- Update default `printer` behavior for Rails to always output via `puts` (not just in tests) in addition to `Rails.logger.debug`
+- Update custom implementation of `caller` for Opal to accept args (optional `start` and `length` or alternatively `range`) just like the Ruby API
+
 ## 0.13.2
 
 - Fix issue caused by MiniTest Rails having `IRB` constant declared despite being outside of IRB

data/README.md

@@ -1,4 +1,5 @@
 # Puts Debuggerer (debugger-less debugging FTW)
+## [Featured in State of the Art Rails 2021 Edition](https://github.com/DanielVartanov/state-of-the-art-rails/tree/3d538fc6ba5287ce6c1ed15ced598ce19bbe81b5)
 [![Gem Version](https://badge.fury.io/rb/puts_debuggerer.svg)](http://badge.fury.io/rb/puts_debuggerer)
 [![Build Status](https://travis-ci.org/AndyObtiva/puts_debuggerer.svg?branch=master)](https://travis-ci.org/AndyObtiva/puts_debuggerer)
 [![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/puts_debuggerer/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/puts_debuggerer?branch=master)
@@ -317,20 +318,28 @@ There are many more options and features in [puts_debuggerer](https://rubygems.o
 
 ### Option 1: Bundler
 
+This is the recommended way for installing in [Rails](rubyonrails.org) apps in addition to configuring the [`app_path` option](#putsdebuggererapp_path).
+
 Add the following to bundler's `Gemfile`.
 
 ```ruby
-gem 'puts_debuggerer', '~> 0.13.2'
+gem 'puts_debuggerer', '~> 0.13.5'
 ```
 
-This is the recommended way for [Rails](rubyonrails.org) apps. Optionally, you may create an initializer under `config/initializers` named `puts_debuggerer_options.rb` to enable further customizations as per the [Options](#options) section below.
+Run:
+
+```
+bundle
+```
+
+Optionally, you may configure the [Rails](rubyonrails.org) initializer `config/initializers/puts_debuggerer_options.rb` with further customizations as per the [Options](#options) section below.
 
 ### Option 2: Manual
 
 Or manually install and require library.
 
 ```bash
-gem install puts_debuggerer -v0.13.2
+gem install puts_debuggerer -v0.13.5
 ```
 
 ```ruby
@@ -388,7 +397,7 @@ Output:
   => "Show me the result of the calculation: 4.0"
 ```
 
-In addition to the main object/expression output, you get to see the source file name, line number, and source code to help you debug and troubleshoot problems quicker (it even works in IRB and Pry).
+In addition to the main object/expression output, you get to see the source file name, line number, and source code to help you debug and troubleshoot problems quicker (it even works in IRB).
 
 Second, quickly locate printed lines using the Find feature (e.g. CTRL+F) by looking for:
 * [PD]
@@ -483,8 +492,15 @@ Details about all the available options are included below.
 #### `PutsDebuggerer.app_path`
 (default = `nil`)
 
-Sets absolute application path. Makes `pd` file output relative to it.
-If [Rails](rubyonrails.org) was detected, it is automatically defaulted to `Rails.root.to_s`
+Sets absolute application path. Makes `pd` file path output relative to it.
+
+In [Rails](rubyonrails.org), you can add the following code to a `config/initializers/puts_debuggerer_options.rb` file to make all output relative to [Rails](rubyonrails.org) application path:
+
+```ruby
+PutsDebuggerer.app_path = Rails.root.to_s
+```
+
+Example:
 
 ```ruby
 # /Users/User/finance_calculator_app/pd_test.rb                                 # line 1
@@ -747,19 +763,21 @@ lambda do |output|
 end
 ```
 
-Example:
+Example of adding the following code to `config/initializers/puts_debuggerer_options.rb`:
 
 ```ruby
-# File Name: /Users/User/example.rb
-PutsDebuggerer.printer = lambda {|output| Rails.logger.error(output)}
+# File Name: /Users/user/railsapp/config/initializers/puts_debuggerer_options.rb
+PutsDebuggerer.printer = lambda do |output|
+  puts output
+end
 str = "Hello"
 pd str
 ```
 
-Prints out in the Rails app log as error lines:
+Prints out the following in standard out stream only (not in log files):
 
 ```bash
-[PD] /Users/User/example.rb:5
+[PD] /Users/user/railsapp/config/initializers/puts_debuggerer_options.rb:6
    > pd str
   => Hello
 ```
@@ -1060,7 +1078,7 @@ Prints out `puts __caller_source_line__`
 - [Ruby](https://www.ruby-lang.org/en/)
 - [JRuby](https://www.jruby.org/)
 - IRB (including Rails Console)
-- Pry
+- Pry (experimental and fragile because Pry's API is not reliable)
 
 ### Opal Ruby
 

data/VERSION

@@ -1 +1 @@
-0.13.2
+0.13.5

data/lib/puts_debuggerer/core_ext/kernel.rb

@@ -88,11 +88,23 @@ module Kernel
 
   # Implement caller backtrace method in Opal since it returns an empty array in Opal v1
   if RUBY_ENGINE == 'opal'
-    def caller
+    def caller(*args)
+      dup_args = args.dup
+      start = args.shift if args.first.is_a?(Integer)
+      length = args.shift if args.first.is_a?(Integer)
+      range = args.shift if args.first.is_a?(Range)
+      if range
+        start = range.begin
+        length = range.end - start
+      end
       begin
         raise 'error'
       rescue => e
-        e.backtrace[2..-1]
+        the_backtrace = e.backtrace
+        start ||= 0
+        start = 2 + start
+        length ||= the_backtrace.size - start
+        the_backtrace[start, length]
       end
     end
   end
@@ -144,7 +156,7 @@ module Kernel
     source_line_number ||= __caller_line_number__(caller_depth+1)
     source_file ||= __caller_file__(caller_depth+1)
     source_line = ''
-    if defined?(Pry)
+    if defined?(Pry) && source_file.include?('(pry)')
       @pry_instance ||= Pry.new
       source_line = Pry::Command::Hist.new(pry_instance: @pry_instance).call.instance_variable_get(:@buffer).split("\n")[source_line_number - 1] # TODO handle multi-lines in source_line_count
     elsif defined?(IRB) && TOPLEVEL_BINDING.receiver.respond_to?(:conf)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.13.5
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
+rubygems_version: 3.3.1
 signing_key:
 specification_version: 4
 summary: Ruby library for improved puts debugging, automatically displaying bonus