puts_debuggerer 0.13.1 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ebff6f84d78f7241fdb021e55a6d90ab94a1a2827cfd9a1dee2280a28a34d42
-  data.tar.gz: d5960273c6cde51e258c4b426cfff5ff00bf67f4961c32c85011698888c228d2
+  metadata.gz: 6f1e480d2a8330d48a546c7e89a2479185cfad2bc1f6b8cf1a9750494de27406
+  data.tar.gz: e135390dd68993136fd2fd4d22d4721dd8a12454f5ce71f2ad164f453358e1db
 SHA512:
-  metadata.gz: 9b82d39c624a8d151d6d72c73b0f464e74935cf4d0c88140c700f533647ad3f089b8be41cb3f0e2e7c97ea06b917d57ef4f91292accc6a2b74d4cd50198ca442
-  data.tar.gz: ffcc096603c4b46a1e134b2ab8de5090403fc579505bd6a7a5b9eaa9e87561faa6ef5d5196d88157fe92ea370a4c309bc0edeb9da278ec8128cdbf88743884c5
+  metadata.gz: 752b67073d6ffda81d890aa568a74f48f7f09b3321c4d5b6e7f51ea8a5c098b0feebe77e3ca5d4f0a80eb842844e8d76f8f75443ab075f153d761842594664db
+  data.tar.gz: bb327d1a2633282307da402569697746c4f0ba91e0c93955728fb9ba647bec9d7d2100406040afe950c630d4a0e9774d3afdc94ac0e8bf1795b429e231dda2d4

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 0.13.2
+
+- Fix issue caused by MiniTest Rails having `IRB` constant declared despite being outside of IRB
+
+## 0.13.1
+
+- Support `a: '[PD]'` shortcut to passing `announcer: '[PD]'`
+- Support `c: :t` shortcut to passing `caller: true`
+
 ## 0.13.0
 
 - Support `h: :t` shortcut to passing `header: true`

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2020 - Andy Maleh
+Copyright (c) 2017-2021 - Andy Maleh
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -114,7 +114,7 @@ Output:
  => "[Hard Cover] Pragmatic Ruby Book - English Version"
 ```
 
-What if you would like to add a header for faster findability of groups of related pd statements? Just use the `header` option (or `h`):
+What if you would like to add a header for faster findability of groups of related pd statements? Just use the `header` option:
 
 ```ruby
 pd order_total, header: true
@@ -122,6 +122,14 @@ pd order_summary
 pd order_details
 ```
 
+Or the `h` shortcut:
+
+```ruby
+pd order_total, h: :t
+pd order_summary
+pd order_details
+```
+
 Output:
 
 ```
@@ -145,12 +153,20 @@ Output:
  => "[Hard Cover] Pragmatic Ruby Book - English Version"
 ```
 
-Wanna customize the header and add a footer too? No problem:
+Wanna add a footer too? No problem!
+
+```ruby
+pd order_total, header: true
+pd order_summary
+pd order_details, footer: true
+```
+
+Or use the `f` shortcut:
 
 ```ruby
-pd order_total, header: '>'*80
+pd order_total, h: :t
 pd order_summary
-pd order_details, footer: '<'*80
+pd order_details, f: :t
 ```
 
 Output:
@@ -158,7 +174,7 @@ Output:
 ```
    (2.7ms)  CREATE TABLE "ar_internal_metadata" ("key" character varying PRIMARY KEY, "value" character varying, "created_at" timestamp NOT NULL, "updated_at" timestamp NOT NULL)
   ActiveRecord::InternalMetadata Load (0.4ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = $1 LIMIT $2  [["key", :environment], ["LIMIT", 1]]
->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+################################################################################
 [PD] /Users/User/ordering/order.rb:39
   > pd order_total, header: '>'*80
  => 195.50
@@ -174,10 +190,10 @@ Output:
 [PD] /Users/User/ordering/order.rb:41
   > pd order_details, footer: '<'*80
  => "[Hard Cover] Pragmatic Ruby Book - English Version"
- <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
+################################################################################
 ```
 
-Need a quick stack trace? Just use the `caller` option (you may surround with header and footer too via `wrapper` or `w`).
+Need a quick stack trace? Just use the `caller` option (you may surround with header and footer too via `wrapper`).
 
 ```ruby
 pd order_total, caller: true, wrapper: true
@@ -185,6 +201,14 @@ pd order_summary
 pd order_details
 ```
 
+Or use the `c` and `w` shortcuts:
+
+```ruby
+pd order_total, c: :t, w: :t
+pd order_summary
+pd order_details
+```
+
 Output:
 
 ```
@@ -254,6 +278,14 @@ pd order_summary
 pd order_details
 ```
 
+Or use shortcut syntax:
+
+```ruby
+pd order_total, c: 3, w: :t
+pd order_summary
+pd order_details
+```
+
 ```
    (2.7ms)  CREATE TABLE "ar_internal_metadata" ("key" character varying PRIMARY KEY, "value" character varying, "created_at" timestamp NOT NULL, "updated_at" timestamp NOT NULL)
   ActiveRecord::InternalMetadata Load (0.4ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = $1 LIMIT $2  [["key", :environment], ["LIMIT", 1]]
@@ -288,7 +320,7 @@ There are many more options and features in [puts_debuggerer](https://rubygems.o
 Add the following to bundler's `Gemfile`.
 
 ```ruby
-gem 'puts_debuggerer', '~> 0.13.1'
+gem 'puts_debuggerer', '~> 0.13.2'
 ```
 
 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.
@@ -298,7 +330,7 @@ This is the recommended way for [Rails](rubyonrails.org) apps. Optionally, you m
 Or manually install and require library.
 
 ```bash
-gem install puts_debuggerer -v0.13.1
+gem install puts_debuggerer -v0.13.2
 ```
 
 ```ruby
@@ -470,7 +502,7 @@ Example Printout:
 ```
 
 #### `PutsDebuggerer.header`
-(default = `'>'*80`)
+(default = `'>'*80`) [shortcut: `h`]
 
 Header to include at the top of every print out.
 * Default value is `nil`
@@ -530,7 +562,7 @@ Prints out:
 ```
 
 #### `PutsDebuggerer.footer`
-(default = `'<'*80`)
+(default = `'<'*80`) [shortcut: `f`]
 
 Footer to include at the bottom of every print out.
 * Default value is `nil`
@@ -590,7 +622,7 @@ Prints out:
 ```
 
 #### `PutsDebuggerer.wrapper`
-(default = `'*'*80`)
+(default = `'*'*80`) [shortcut: `w`]
 
 Wrapper to include at the top and bottom of every print out (both header and footer).
 * Default value is `nil`
@@ -762,7 +794,7 @@ Prints out:
 ```
 
 #### `PutsDebuggerer.announcer`
-(default = `"[PD]"`)
+(default = `"[PD]"`) [shortcut: `a`]
 
 Announcer (e.g. `[PD]`) to announce every print out with (default: `"[PD]"`)
 
@@ -833,7 +865,7 @@ FOOTER: ************************************************************************
 ```
 
 #### `PutsDebuggerer.caller`
-(default = nil)
+(default = nil) [shortcut: `c`]
 
 Caller backtrace included at the end of every print out
 Passed an argument of true/false, nil, or depth as an integer.
@@ -845,15 +877,33 @@ Example:
 
 ```ruby
 # File Name: /Users/User/sample_app/lib/sample.rb
-PutsDebuggerer.caller = 3
-pd (x=1)
+pd (x=1), caller: 3
 ```
 
-Prints out:
+Prints out (fictional):
 
 ```bash
-[PD] /Users/User/sample_app/lib/sample.rb:3
-    > pd x=1
+[PD] /Users/User/sample_app/lib/sample.rb:2
+    > pd x=1, caller: 3
+   => "1"
+     /Users/User/sample_app/lib/master_samples.rb:368:in \`block (3 levels) in <top (required)>\'
+     /Users/User/.rvm/rubies/ruby-2.4.0/lib/ruby/2.4.0/irb/workspace.rb:87:in \`eval\'
+     /Users/User/.rvm/rubies/ruby-2.4.0/lib/ruby/2.4.0/irb/workspace.rb:87:in \`evaluate\'
+     /Users/User/.rvm/rubies/ruby-2.4.0/lib/ruby/2.4.0/irb/context.rb:381:in \`evaluate\'
+```
+
+Shortcut Example:
+
+```ruby
+# File Name: /Users/User/sample_app/lib/sample.rb
+pd (x=1), c: 3
+```
+
+Prints out (fictional):
+
+```bash
+[PD] /Users/User/sample_app/lib/sample.rb:2
+    > pd x=1, caller: 3
    => "1"
      /Users/User/sample_app/lib/master_samples.rb:368:in \`block (3 levels) in <top (required)>\'
      /Users/User/.rvm/rubies/ruby-2.4.0/lib/ruby/2.4.0/irb/workspace.rb:87:in \`eval\'
@@ -1054,4 +1104,4 @@ Note that it ignores the configured printer when printing exceptions as it relie
 
 [MIT](LICENSE.txt)
 
-Copyright (c) 2017-2020 - Andy Maleh.
+Copyright (c) 2017-2021 - Andy Maleh.

data/VERSION

@@ -1 +1 @@
-0.13.1
+0.13.2

data/lib/puts_debuggerer/core_ext/kernel.rb

@@ -147,7 +147,7 @@ module Kernel
     if defined?(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)
+    elsif defined?(IRB) && TOPLEVEL_BINDING.receiver.respond_to?(:conf)
       source_line = TOPLEVEL_BINDING.receiver.conf.io.line(source_line_number) # TODO handle multi-lines in source_line_count
     else
       source_line = PutsDebuggerer::SourceFile.new(source_file).source(source_line_count, source_line_number)

data/lib/puts_debuggerer/source_file.rb

@@ -1,7 +1,7 @@
 module PutsDebuggerer
   class SourceFile
     def initialize(file_path)
-      @file = File.new(file_path) if file_path
+      @file = File.new(file_path) if file_path && File.exist?(file_path)
     end
     
     def source(source_line_count, source_line_number)
@@ -16,7 +16,7 @@ module PutsDebuggerer
     def source_lines(source_line_count, source_line_number)
       lines = []
       begin
-        while @file.lineno < source_line_number + source_line_count
+        while @file && @file.lineno < source_line_number + source_line_count
           file_line_number = @file.lineno + 1
           file_line = @file.readline
           if file_line_number >= source_line_number && file_line_number < source_line_number + source_line_count

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.13.2
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.31
 signing_key:
 specification_version: 4
 summary: Ruby library for improved puts debugging, automatically displaying bonus