puts_debuggerer 0.11.0 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43ff23befa76e5fc66ff64e550594c4e0c4a2055d586329ee731c075c6ab54a7
-  data.tar.gz: 1224fadbcca6b036eac9ed58d9ce60d5e7f7a6cd3a6742de05e4f82cb9107b8e
+  metadata.gz: 6f1e480d2a8330d48a546c7e89a2479185cfad2bc1f6b8cf1a9750494de27406
+  data.tar.gz: e135390dd68993136fd2fd4d22d4721dd8a12454f5ce71f2ad164f453358e1db
 SHA512:
-  metadata.gz: 13af30103a2bfa13e3e579f9083ed366fb4fa168e53a7c685e9181c60fb194dc24430e49d14348d4ae59f7573430b1f665987182b101a4a5da28394acf9b485e
-  data.tar.gz: 3b6eb47ca8c5758f3ffe6405ca94031bc05ee2cfad09cbb1f20fec85aea0fef42c0900a9ccd43916f4f567aed1d7c8f5ec9ec779c69c586cd9f5052e8b809047
+  metadata.gz: 752b67073d6ffda81d890aa568a74f48f7f09b3321c4d5b6e7f51ea8a5c098b0feebe77e3ca5d4f0a80eb842844e8d76f8f75443ab075f153d761842594664db
+  data.tar.gz: bb327d1a2633282307da402569697746c4f0ba91e0c93955728fb9ba647bec9d7d2100406040afe950c630d4a0e9774d3afdc94ac0e8bf1795b429e231dda2d4

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # 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`
+- Support `f: :t` shortcut to passing `footer: true`
+- Support `w: :t` shortcut to passing `wrapper: true`
+
+## 0.12.0
+
+- Upgrade `awesome_print` to `~> 1.9.2`
+- Support passing pd options as part of a printed hash instead of requiring a separate hash (e.g. `pd(path: path, header: true)` instead of `pd({path: path}, header: true)` )
+- Support empty use of pd statement + options (e.g. `pd` or `pd header: true`)
+
 ## 0.11.0
 
 - Pry support

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

@@ -33,7 +33,7 @@ Output:
 
 ## Background
 
-It can be quite frustrating to lose puts statements in a large output or log file. One way to help find them is add an announcer (e.g. `puts "The Order Total"`) or a header (e.g. `puts '*'*80`) before every puts statement. Unfortunately, that leads to repetitive wasteful effort that adds up quickly over many work sessions and interrupts thinking flow while solving problems.
+It can be quite frustrating to lose puts statements in a large output or log file. One way to help find them is add an announcer (e.g. `puts "The Order Total"`) or a header (e.g. `puts '>'*80`) before every puts statement. Unfortunately, that leads to repetitive wasteful effort that adds up quickly over many work sessions and interrupts thinking flow while solving problems.
 
 puts_debuggerer automates that work via the short and simple `pd` command, automatically printing meaningful headers for output and accelerating problem solving work due to ease of typing.
 
@@ -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: '>'*80
+pd order_total, header: true
 pd order_summary
-pd order_details, footer: '<'*80
+pd order_details, footer: true
+```
+
+Or use the `f` shortcut:
+
+```ruby
+pd order_total, h: :t
+pd order_summary
+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,7 +190,7 @@ 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`).
@@ -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]]
@@ -279,7 +311,7 @@ pd order_details
  => "[Hard Cover] Pragmatic Ruby Book - English Version"
 ```
 
-There are many more options and powerful features in [puts_debuggerer](https://rubygems.org/gems/puts_debuggerer) as detailed below.
+There are many more options and features in [puts_debuggerer](https://rubygems.org/gems/puts_debuggerer) as detailed below.
 
 ## Instructions
 
@@ -288,7 +320,7 @@ There are many more options and powerful features in [puts_debuggerer](https://r
 Add the following to bundler's `Gemfile`.
 
 ```ruby
-gem 'puts_debuggerer', '~> 0.10.3'
+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.10.3
+gem install puts_debuggerer -v0.13.2
 ```
 
 ```ruby
@@ -311,7 +343,6 @@ Or the shorter form (often helpful to quickly troubleshoot an app):
 require 'pd'
 ```
 
-
 ### Awesome Print
 
 [puts_debuggerer](https://rubygems.org/gems/puts_debuggerer) comes with [awesome_print](https://github.com/awesome-print/awesome_print).
@@ -471,11 +502,11 @@ Example Printout:
 ```
 
 #### `PutsDebuggerer.header`
-(default = `'*'*80`)
+(default = `'>'*80`) [shortcut: `h`]
 
 Header to include at the top of every print out.
 * Default value is `nil`
-* Value `true` enables header as `'*'*80`
+* Value `true` enables header as `'>'*80`
 * Value `false`, `nil`, or empty string disables header
 * Any other string value gets set as a custom header
 
@@ -494,6 +525,21 @@ Prints out:
   => "1"
 ```
 
+Shortcut Example:
+
+```ruby
+pd (x=1), h: :t
+```
+
+Prints out:
+
+```bash
+>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+[PD] /Users/User/example.rb:1
+   > pd (x=1), h: :t
+  => "1"
+```
+
 Global Option Example:
 
 ```ruby
@@ -516,11 +562,11 @@ Prints out:
 ```
 
 #### `PutsDebuggerer.footer`
-(default = `'*'*80`)
+(default = `'<'*80`) [shortcut: `f`]
 
 Footer to include at the bottom of every print out.
 * Default value is `nil`
-* Value `true` enables footer as `'*'*80`
+* Value `true` enables footer as `'<'*80`
 * Value `false`, `nil`, or empty string disables footer
 * Any other string value gets set as a custom footer
 
@@ -539,6 +585,21 @@ Prints out:
 <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
 ```
 
+Shortcut Example:
+
+```ruby
+pd (x=1), f: :t
+```
+
+Prints out:
+
+```bash
+[PD] /Users/User/example.rb:1
+   > pd (x=1), f: :t
+  => "1"
+<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
+```
+
 Global Option Example:
 
 ```ruby
@@ -561,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`
@@ -585,6 +646,22 @@ Prints out:
 ********************************************************************************
 ```
 
+Shortcut Example:
+
+```ruby
+pd (x=1), w: :t
+```
+
+Prints out:
+
+```bash
+********************************************************************************
+[PD] /Users/User/example.rb:1
+   > pd x=1, w: :t
+  => "1"
+********************************************************************************
+```
+
 Global Option Example:
 
 ```ruby
@@ -717,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]"`)
 
@@ -788,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.
@@ -800,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\'
@@ -1009,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.11.0
+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

data/lib/puts_debuggerer.rb

@@ -63,6 +63,14 @@ module PutsDebuggerer
   STACK_TRACE_CALL_LINE_NUMBER_REGEX = /\:(\d+)\:in /
   STACK_TRACE_CALL_SOURCE_FILE_REGEX = /[ ]*([^:]+)\:\d+\:in /
   STACK_TRACE_CALL_SOURCE_FILE_REGEX_OPAL = /(http[^\)]+)/
+  OPTIONS = [:app_path, :source_line_count, :header, :h, :wrapper, :w, :footer, :f, :printer, :print_engine, :announcer, :formatter, :caller, :run_at]
+  OPTION_ALIASES = {
+    a: :announcer,
+    c: :caller,
+    h: :header,
+    f: :footer,
+    w: :wrapper,
+  }
 
   class << self
     # Application root path to exclude when printing out file path
@@ -469,7 +477,18 @@ module PutsDebuggerer
     end
 
     def determine_options(objects)
-      objects.delete_at(-1) if objects.size > 1 && objects.last.is_a?(Hash)
+      if objects.size > 1 && objects.last.is_a?(Hash)
+        convert_options(objects.delete_at(-1))
+      elsif objects.size == 1 && objects.first.is_a?(Hash)
+        hash = objects.first
+        convert_options(hash.slice(*OPTIONS).tap do
+          hash.delete_if {|option| OPTIONS.include?(option)}
+        end)
+      end
+    end
+    
+    def convert_options(hash)
+      Hash[hash.map { |key, value| OPTION_ALIASES[key] ? ( value == :t ?  [OPTION_ALIASES[key], true] : [OPTION_ALIASES[key], value] ) : [key, value]}]
     end
 
     def determine_object(objects)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.2
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-15 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.9.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,14 +84,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.4
 - !ruby/object:Gem::Dependency
@@ -136,20 +136,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
-- !ruby/object:Gem::Dependency
-  name: undercover
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.4
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
@@ -220,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.31
 signing_key:
 specification_version: 4
 summary: Ruby library for improved puts debugging, automatically displaying bonus