puts_debuggerer 0.13.5 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cef89b14f7e9ae764d7231ddaa5ab880ccaacd5366cdde5db8cebf6096ef6ddc
-  data.tar.gz: 0ce08e74da428ede072d3d343e983a499f78939ddd5134ed262ca8505fb824d5
+  metadata.gz: d233d55e6a6fd44243d0c03cc1a0d94452e8d6ca5ad1c363b286094ecbbea19b
+  data.tar.gz: cdc0375b20f5289213ebe2177d6812423654ed09e2405e490b60bb244011e923
 SHA512:
-  metadata.gz: f473268d3f34d3e12ce51152a9eb4e2295448a623c087705072101d15603da5792abc7d02d2eeb272fba4369727c273d9cc9cf5845cd3d36869bdbc7971b0da5
-  data.tar.gz: d91edb075e81269b9f3a7589cd2f84b0126ff0b9c66633d51cdca3829e25119051a00270fb194fe17c2a7a430c7c7b65d63696cf422162a944aeaf367c5d1d5f
+  metadata.gz: bd63f2cfba6602e0e090e565949782fe734ab62ca4f233114cdc7abb1b08ca213f8810f186f7ee8c5c63c9edfe04c39bc5661fc18ecd5ff20be18cd4fe3ef63c
+  data.tar.gz: 7c485c0dece0ee52bf9913b96620746974d8f28191a7ff182faeea18c84b65b331ba87d98b4038d60193c50170c5707d2eeaa0788bdc43950474dc6c28f5c0b8

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 1.0.1
+
+- Fix issue with deleting `pd` options from a `Hash` if it was the only argument breaking the guarantee that `pd` never modifies the printed object, which could cause bugs.
+- Fix issue with attempting to modify a frozen `Hash` when passing a frozen `Hash` as the only argument for `pd` method
+
+## 1.0.0
+
+-  Support including class/method after file/line in every `pd` printout
+
 ## 0.13.5
 
 - Fix not printing source line in Rails app w/ Pry

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2021 - Andy Maleh
+Copyright (c) 2017-2024 - 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

@@ -1,17 +1,19 @@
-# 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)
+# Puts Debuggerer 1.0.1
+## Debugger-less Debugging FTW
+## [Featured in State of the Art Rails 2023 Edition](https://github.com/DanielVartanov/state-of-the-art-rails/tree/bd7a509f5f0ab07cebfeada779b5c73e1eaf22ed)
 [![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)
 [![Maintainability](https://api.codeclimate.com/v1/badges/81d8f6e046eb1b4a36f4/maintainability)](https://codeclimate.com/github/AndyObtiva/puts_debuggerer/maintainability)
 
 (credit to Aaron Patterson for partial inspiration: https://tenderlovemaking.com/2016/02/05/i-am-a-puts-debuggerer.html)
 
+If you like [Awesome_Print](https://rubygems.org/gems/awesome_print) (or [Amazing_Print](https://github.com/amazing-print/amazing_print)), you will love Puts Debuggerer (which builds upon them)!
+
 Debuggers are great! They help us troubleshoot complicated programming problems by inspecting values produced by code, line by line. They are invaluable when trying to understand what is going on in a large application composed of thousands or millions of lines of code.
 
-In day-to-day test-driven development and simple app debugging though, a puts statement can be a lot quicker in revealing what is going on than halting execution completely just to inspect a single value or a few. This is certainly true when writing the simplest possible code that could possibly work, and running a test every few seconds or minutes. Still, there are a number of problems with puts debugging, like difficulty in locating puts statements in a large output log, knowing which methods and line numbers were invoked, identifying which variables were printed, and seeing the content of structured hashes and arrays in an understandable format.
+In day-to-day test-driven development and simple app debugging though, a puts statement can be a lot quicker in revealing what is going on than halting execution completely just to inspect a single value or a few. This is certainly true when writing the simplest possible code that could possibly work, and running a test every few seconds or minutes. Still, there are a number of problems with puts debugging, like difficulty in locating puts statements in a large output log, knowing which files, line numbers, and methods the puts statements were invoked from, identifying which variables were printed, and seeing the content of structured hashes and arrays in an understandable format.
 
-Enter [puts_debuggerer](https://rubygems.org/gems/puts_debuggerer)! A guilt-free puts debugging Ruby gem FTW that prints file names, line numbers, code statements, headers, footers, stack traces, and formats output nicely courtesy of [awesome_print](https://rubygems.org/gems/awesome_print).
+Enter [puts_debuggerer](https://rubygems.org/gems/puts_debuggerer)! A guilt-free puts debugging Ruby gem FTW that prints file names, line numbers, class names, method names, code statements, headers, footers, and stack traces; and formats output nicely courtesy of [awesome_print](https://rubygems.org/gems/awesome_print) (or [amazing_print](https://github.com/amazing-print/amazing_print) if you prefer).
 
 [puts_debuggerer](https://rubygems.org/gems/puts_debuggerer) automates tips mentioned in [this blog post](https://tenderlovemaking.com/2016/02/05/i-am-a-puts-debuggerer.html) by Aaron Patterson using the `pd` method available everywhere after requiring the [gem](https://rubygems.org/gems/puts_debuggerer).
 
@@ -20,18 +22,25 @@ Basic Example:
 ```ruby
 # /Users/User/trivia_app.rb      # line 1
 require 'pd'                     # line 2
-bug_or_band = 'beattle'          # line 3
-pd bug_or_band                   # line 4
+class TriviaApp                  # line 3
+  def question                   # line 4
+    bug_or_band = 'Beatles'      # line 5
+    pd bug_or_band               # line 6
+  end                            # line 7
+end                              # line 8
+TriviaApp.new.question           # line 9
 ```
 
 Output:
 
 ```bash
-[PD] /Users/User/trivia_app.rb:4
-   > pd bug_or_band                   # line 4
-  => "beattle"
+[PD] /Users/User/trivia_app.rb:6 in TriviaApp.question
+   > pd bug_or_band               # line 6
+  => "Beatles"
 ```
 
+`pd` revealed that the variable contains the band name "Beatles" not the bug "Beetle", in addition to revealing the printed code statement `pd bug_or_band`, the file name `/Users/User/trivia_app.rb`, the line number `6`, the class name `TriviaApp`, and the method name `question`.
+
 ## 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.
@@ -63,7 +72,7 @@ Which gets lost in a logging stream such as:
    (0.2ms)  COMMIT
 ```
 
-Here is a simple example using `pd` instead, which provides everything the puts statements above provide in addition to deducing the file name and line number automatically for dead easy debugging:
+Here is a simple example using `pd` instead, which provides everything the puts statements above provide in addition to deducing the file name, line number, class name, and method name automatically for dead-easy debugging:
 
 ```ruby
 pd order_total
@@ -77,7 +86,7 @@ Output:
    (0.2ms)  BEGIN
   SQL (0.3ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES ($1, $2, $3, $4) RETURNING "key"  [["key", "environment"], ["value", "development"], ["created_at", 2017-08-24 22:56:52 UTC], ["updated_at", 2017-08-24 22:56:52 UTC]]
    (0.3ms)  COMMIT
-[PD] /Users/User/ordering/order.rb:39
+[PD] /Users/User/ordering/order.rb:39 in Order.calculate_order_total
   > pd order_total
  => 195.50
   ActiveRecord::InternalMetadata Load (0.3ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = $1 LIMIT $2  [["key", :environment], ["LIMIT", 1]]
@@ -98,19 +107,19 @@ 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] /Users/User/ordering/order.rb:39 in Order.calculate_order_total
   > pd order_total
  => 195.50
    (0.2ms)  BEGIN
   SQL (0.3ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES ($1, $2, $3, $4) RETURNING "key"  [["key", "environment"], ["value", "development"], ["created_at", 2017-08-24 22:56:52 UTC], ["updated_at", 2017-08-24 22:56:52 UTC]]
    (0.3ms)  COMMIT
-[PD] /Users/User/ordering/order.rb:40
+[PD] /Users/User/ordering/order.rb:40 in Order.calculate_order_total
   > pd order_summary
  => "Pragmatic Ruby Book"
   ActiveRecord::InternalMetadata Load (0.3ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = $1 LIMIT $2  [["key", :environment], ["LIMIT", 1]]
    (0.2ms)  BEGIN
    (0.2ms)  COMMIT
-[PD] /Users/User/ordering/order.rb:41
+[PD] /Users/User/ordering/order.rb:41 in Order.calculate_order_total
   > pd order_details
  => "[Hard Cover] Pragmatic Ruby Book - English Version"
 ```
@@ -137,19 +146,19 @@ 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] /Users/User/ordering/order.rb:39 in Order.calculate_order_total
   > pd order_total, header: true
  => 195.50
    (0.2ms)  BEGIN
   SQL (0.3ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES ($1, $2, $3, $4) RETURNING "key"  [["key", "environment"], ["value", "development"], ["created_at", 2017-08-24 22:56:52 UTC], ["updated_at", 2017-08-24 22:56:52 UTC]]
    (0.3ms)  COMMIT
-[PD] /Users/User/ordering/order.rb:40
+[PD] /Users/User/ordering/order.rb:40 in Order.calculate_order_total
   > pd order_summary
  => "Pragmatic Ruby Book"
   ActiveRecord::InternalMetadata Load (0.3ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = $1 LIMIT $2  [["key", :environment], ["LIMIT", 1]]
    (0.2ms)  BEGIN
    (0.2ms)  COMMIT
-[PD] /Users/User/ordering/order.rb:41
+[PD] /Users/User/ordering/order.rb:41 in Order.calculate_order_total
   > pd order_details
  => "[Hard Cover] Pragmatic Ruby Book - English Version"
 ```
@@ -176,19 +185,19 @@ 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] /Users/User/ordering/order.rb:39 in Order.calculate_order_total
   > pd order_total, header: '>'*80
  => 195.50
    (0.2ms)  BEGIN
   SQL (0.3ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES ($1, $2, $3, $4) RETURNING "key"  [["key", "environment"], ["value", "development"], ["created_at", 2017-08-24 22:56:52 UTC], ["updated_at", 2017-08-24 22:56:52 UTC]]
    (0.3ms)  COMMIT
-[PD] /Users/User/ordering/order.rb:40
+[PD] /Users/User/ordering/order.rb:40 in Order.calculate_order_total
   > pd order_summary
  => "Pragmatic Ruby Book"
   ActiveRecord::InternalMetadata Load (0.3ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = $1 LIMIT $2  [["key", :environment], ["LIMIT", 1]]
    (0.2ms)  BEGIN
    (0.2ms)  COMMIT
-[PD] /Users/User/ordering/order.rb:41
+[PD] /Users/User/ordering/order.rb:41 in Order.calculate_order_total
   > pd order_details, footer: '<'*80
  => "[Hard Cover] Pragmatic Ruby Book - English Version"
 ################################################################################
@@ -216,7 +225,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] /Users/User/ordering/order.rb:39 in Order.calculate_order_total
   > pd order_total, caller: true, wrapper: true
  => 195.50
      /Users/User/.rvm/gems/ruby-2.7.1/gems/bootsnap-1.4.6/lib/bootsnap/load_path_cache/core_ext/kernel_require.rb:23:in `require'
@@ -260,13 +269,13 @@ Output:
    (0.2ms)  BEGIN
   SQL (0.3ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES ($1, $2, $3, $4) RETURNING "key"  [["key", "environment"], ["value", "development"], ["created_at", 2017-08-24 22:56:52 UTC], ["updated_at", 2017-08-24 22:56:52 UTC]]
    (0.3ms)  COMMIT
-[PD] /Users/User/ordering/order.rb:40
+[PD] /Users/User/ordering/order.rb:40 in Order.calculate_order_total
   > pd order_summary
  => "Pragmatic Ruby Book"
   ActiveRecord::InternalMetadata Load (0.3ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = $1 LIMIT $2  [["key", :environment], ["LIMIT", 1]]
    (0.2ms)  BEGIN
    (0.2ms)  COMMIT
-[PD] /Users/User/ordering/order.rb:41
+[PD] /Users/User/ordering/order.rb:41 in Order.calculate_order_total
   > pd order_details
  => "[Hard Cover] Pragmatic Ruby Book - English Version"
 ```
@@ -291,7 +300,7 @@ 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]]
 ********************************************************************************
-[PD] /Users/User/ordering/order.rb:39
+[PD] /Users/User/ordering/order.rb:39 in Order.calculate_order_total
   > pd order_total, caller: 3, wrapper: true
  => 195.50
      /Users/User/.rvm/gems/ruby-2.7.1/gems/bootsnap-1.4.6/lib/bootsnap/load_path_cache/core_ext/kernel_require.rb:23:in `require'
@@ -301,13 +310,13 @@ pd order_details
    (0.2ms)  BEGIN
   SQL (0.3ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES ($1, $2, $3, $4) RETURNING "key"  [["key", "environment"], ["value", "development"], ["created_at", 2017-08-24 22:56:52 UTC], ["updated_at", 2017-08-24 22:56:52 UTC]]
    (0.3ms)  COMMIT
-[PD] /Users/User/ordering/order.rb:40
+[PD] /Users/User/ordering/order.rb:40 in Order.calculate_order_total
   > pd order_summary
  => "Pragmatic Ruby Book"
   ActiveRecord::InternalMetadata Load (0.3ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = $1 LIMIT $2  [["key", :environment], ["LIMIT", 1]]
    (0.2ms)  BEGIN
    (0.2ms)  COMMIT
-[PD] /Users/User/ordering/order.rb:41
+[PD] /Users/User/ordering/order.rb:41 in Order.calculate_order_total
   > pd order_details
  => "[Hard Cover] Pragmatic Ruby Book - English Version"
 ```
@@ -320,10 +329,10 @@ There are many more options and features in [puts_debuggerer](https://rubygems.o
 
 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`.
+Add the following to bundler's `Gemfile` (in Rails, you can optionally limit to the `:development` and `:test` groups).
 
 ```ruby
-gem 'puts_debuggerer', '~> 0.13.5'
+gem 'puts_debuggerer', '~> 1.0.1'
 ```
 
 Run:
@@ -334,12 +343,31 @@ 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.
 
+Also, you may want to add the following to the initializer too if you limited the `puts_debuggerer` gem to the `:development` and `:test` groups:
+
+```ruby
+unless Rails.env.development? || Rails.env.test?
+  def pd(*args, &block) # `pd(...)` in Ruby 2.7+
+    # No Op (just a stub in case developers forget troubleshooting pd calls in the code and deploy to production)
+  end
+end
+```
+
+The Rails `config.log_level` is assumed to be `:debug`. If you have it set to something else like `:info`, then you need to update `PutsDebuggerer.printer` to print at a different log level (e.g. `:info`) by adding the following code to the initializer above (this code is a modification of the default at `PutsDebuggerer::PRINTER_RAILS`):
+
+```ruby
+PutsDebuggerer.printer = lambda do |output| 
+  puts output if Rails.env.test?
+  Rails.logger.info(output)  
+end
+```
+
 ### Option 2: Manual
 
 Or manually install and require library.
 
 ```bash
-gem install puts_debuggerer -v0.13.5
+gem install puts_debuggerer -v1.0.1
 ```
 
 ```ruby
@@ -364,7 +392,7 @@ Still, if you do not need it, you may disable by setting `PutsDebuggerer.print_e
 PutsDebuggerer.print_engine = :puts
 ```
 
-If you also avoid requiring 'awesome_print', PutsDebuggerer won't require it either if it sees that you have a different `print_engine`
+If you also avoid requiring 'awesome_print', PutsDebuggerer will NOT require it either if it sees that you have a different `print_engine`. In fact, you may switch to another print engine if you prefer like [amazing_print](https://github.com/amazing-print/amazing_print) as [explained here](https://github.com/AndyObtiva/puts_debuggerer#putsdebuggererprint_engine).
 
 You may also avoid requiring in Bundler `Gemfile` with `require: false`:
 
@@ -375,13 +403,39 @@ gem "puts_debuggerer"
 
 ### Usage
 
-First, add `pd` method anywhere in your code to display details about an object or expression (if you're used to awesome_print, you're in luck! puts_debuggerer includes awesome_print as the default print engine for output).
+First, add `pd` method anywhere in your code to display details about an object or expression (if you're used to awesome_print, you're in luck! puts_debuggerer includes awesome_print (or amazing_print if preferred) as the default print engine for output).
+
+Example:
+
+```ruby
+# /Users/User/trivia_app.rb      # line 1
+require 'pd'                     # line 2
+class TriviaApp                  # line 3
+  def question                   # line 4
+    bug_or_band = 'Beatles'      # line 5
+    pd bug_or_band               # line 6
+  end                            # line 7
+end                              # line 8
+TriviaApp.new.question           # line 9
+```
+
+Output:
+
+```bash
+[PD] /Users/User/trivia_app.rb:6 in TriviaApp.question
+   > pd bug_or_band               # line 6
+  => "Beatles"
+```
+
+In addition to the object/expression output, you get to see the source file name, line number, class name, method name, and source code to help you debug and troubleshoot problems quicker (it even works in IRB).
+
+You can use `pd` at the top-level main object too, and it prings `Object.<main>` for the class/method.
 
 Example:
 
 ```ruby
 # /Users/User/finance_calculator_app/pd_test.rb           # line 1
-bug = 'beattle'                                           # line 2
+bug = 'Beetle'                                            # line 2
 pd "Show me the source of the bug: #{bug}"                # line 3
 pd "Show me the result of the calculation: #{(12.0/3.0)}" # line 4
 ```
@@ -389,19 +443,18 @@ pd "Show me the result of the calculation: #{(12.0/3.0)}" # line 4
 Output:
 
 ```bash
-[PD] /Users/User/finance_calculator_app/pd_test.rb:3
+[PD] /Users/User/finance_calculator_app/pd_test.rb:3 in Object.<main>
    > pd "Show me the source of the bug: #{bug}"
-  => "Show me the source of the bug: beattle"
-[PD] /Users/User/finance_calculator_app/pd_test.rb:4
+  => "Show me the source of the bug: Beetle"
+[PD] /Users/User/finance_calculator_app/pd_test.rb:4 in Object.<main>
    > pd "Show me the result of the calculation: #{(12.0/3.0)}"
   => "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).
-
 Second, quickly locate printed lines using the Find feature (e.g. CTRL+F) by looking for:
 * [PD]
 * file:line_number
+* class.method
 * known ruby expression.
 
 Third, easily remove your ` pd ` statements via the source code Find feature once done debugging.
@@ -419,7 +472,7 @@ greeting = "Hello #{pd(name)}"                            # line 3
 Output:
 
 ```bash
-[PD] /Users/User/greeting_app/pd_test.rb:3
+[PD] /Users/User/greeting_app/pd_test.rb:3 in Object.<main>
    > greeting = "Hello #{pd(name)}"
   => "Hello Robert"
 ```
@@ -463,7 +516,7 @@ Prints out:
 
 ```bash
 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
-[PD] /Users/User/project/piecemeal.rb:3
+[PD] /Users/User/project/piecemeal.rb:3 in Object.<main>
    > pd data, header: true
   => [1, [2, 3]]
 ```
@@ -481,7 +534,7 @@ Prints out:
 ```bash
 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
    -<[PD]>-
-   /Users/User/project/piecemeal.rb:3
+   /Users/User/project/piecemeal.rb:3 in Object.<main>
    > pd data, header: '>'*80, footer: '<'*80, announcer: "   -<[PD]>-\n  "
   => [1, [2, 3]]
 <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
@@ -505,16 +558,16 @@ Example:
 ```ruby
 # /Users/User/finance_calculator_app/pd_test.rb                                 # line 1
 PutsDebuggerer.app_path = File.join('/Users', 'User', 'finance_calculator_app') # line 2
-bug = 'beattle'                                                                 # line 3
+bug = 'Beetle'                                                                  # line 3
 pd "Show me the source of the bug: #{bug}"                                      # line 4
 ```
 
 Example Printout:
 
 ```bash
-[PD] /pd_test.rb:4
+[PD] /pd_test.rb:4 in Object.<main>
    > pd "Show me the source of the bug: #{bug}"
-  => "Show me the source of the bug: beattle"
+  => "Show me the source of the bug: Beetle"
 ```
 
 #### `PutsDebuggerer.header`
@@ -536,7 +589,7 @@ Prints out:
 
 ```bash
 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
-[PD] /Users/User/example.rb:1
+[PD] /Users/User/example.rb:1 in Object.<main>
    > pd (x=1), header: true
   => "1"
 ```
@@ -551,7 +604,7 @@ Prints out:
 
 ```bash
 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
-[PD] /Users/User/example.rb:1
+[PD] /Users/User/example.rb:1 in Object.<main>
    > pd (x=1), h: :t
   => "1"
 ```
@@ -568,11 +621,11 @@ Prints out:
 
 ```bash
 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
-[PD] /Users/User/example.rb:2
+[PD] /Users/User/example.rb:2 in Object.<main>
    > pd (x=1)
   => "1"
 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
-[PD] /Users/User/example.rb:3
+[PD] /Users/User/example.rb:3 in Object.<main>
    > pd (x=2)
   => "2"
 ```
@@ -595,7 +648,7 @@ pd (x=1), footer: true
 Prints out:
 
 ```bash
-[PD] /Users/User/example.rb:1
+[PD] /Users/User/example.rb:1 in Object.<main>
    > pd (x=1), footer: true
   => "1"
 <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
@@ -610,7 +663,7 @@ pd (x=1), f: :t
 Prints out:
 
 ```bash
-[PD] /Users/User/example.rb:1
+[PD] /Users/User/example.rb:1 in Object.<main>
    > pd (x=1), f: :t
   => "1"
 <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
@@ -627,11 +680,11 @@ pd (x=2)
 Prints out:
 
 ```bash
-[PD] /Users/User/example.rb:2
+[PD] /Users/User/example.rb:2 in Object.<main>
    > pd (x=1)
   => "1"
 <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
-[PD] /Users/User/example.rb:3
+[PD] /Users/User/example.rb:3 in Object.<main>
    > pd (x=2)
   => "2"
 <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
@@ -656,7 +709,7 @@ Prints out:
 
 ```bash
 ********************************************************************************
-[PD] /Users/User/example.rb:1
+[PD] /Users/User/example.rb:1 in Object.<main>
    > pd x=1, wrapper: true
   => "1"
 ********************************************************************************
@@ -672,7 +725,7 @@ Prints out:
 
 ```bash
 ********************************************************************************
-[PD] /Users/User/example.rb:1
+[PD] /Users/User/example.rb:1 in Object.<main>
    > pd x=1, w: :t
   => "1"
 ********************************************************************************
@@ -690,12 +743,12 @@ Prints out:
 
 ```bash
 ********************************************************************************
-[PD] /Users/User/example.rb:2
+[PD] /Users/User/example.rb:2 in Object.<main>
    > pd (x=1)
   => "1"
 ********************************************************************************
 ********************************************************************************
-[PD] /Users/User/example.rb:3
+[PD] /Users/User/example.rb:3 in Object.<main>
    > pd (x=2)
   => "2"
 ********************************************************************************
@@ -716,7 +769,7 @@ pd (true ||
 Prints out:
 
 ```
-[PD] /Users/User/example.rb:1
+[PD] /Users/User/example.rb:1 in Object.<main>
    > pd (true ||
        false), source_line_count: 2
   => "true"
@@ -733,7 +786,7 @@ pd (true ||
 Prints out:
 
 ```
-[PD] /Users/User/example.rb:2
+[PD] /Users/User/example.rb:2 in Object.<main>
    > pd (true ||
        false), source_line_count: 2
   => "true"
@@ -787,12 +840,14 @@ Prints out the following in standard out stream only (not in log files):
 
 Print engine is similar to `printer`, except it is focused on the scope of formatting
 the data object being printed (excluding metadata such as file name, line number,
-and expression, which are handled by the `printer`).
+class name, method name, and expression, which are handled by the `printer`).
 As such, it is also a global method symbol or lambda expression.
 Examples of global methods are `:p`, `:ap`, and `:pp`.
 An example of a lambda expression is `lambda {|object| puts object.to_a.join(" | ")}`
 
-Defaults to [awesome_print](https://github.com/awesome-print/awesome_print).
+Defaults to [awesome_print](https://github.com/awesome-print/awesome_print). It does not load the library however until the first use of the `pd` command.
+
+If you want to avoid loading [awesome_print](https://github.com/awesome-print/awesome_print) to use an alternative instead like [amazing_print](https://github.com/amazing-print/amazing_print), make sure to load [amazing_print](https://github.com/amazing-print/amazing_print) and call `PutsDebuggerer.print_engine = :ap` before the first `pd` call ([amazing_print](https://github.com/amazing-print/amazing_print) works through `ap` just like [awesome_print](https://github.com/awesome-print/awesome_print)).
 
 Example:
 
@@ -806,7 +861,7 @@ pd array
 Prints out:
 
 ```bash
-[PD] /Users/User/example.rb:4
+[PD] /Users/User/example.rb:4 in Object.<main>
    > pd array
   => [1, [2, 3]]
 ```
@@ -827,7 +882,7 @@ Prints out:
 
 ```bash
 *** PD ***
-   /Users/User/example.rb:2
+   /Users/User/example.rb:2 in Object.<main>
    > pd x=1
   => "1"
 ```
@@ -837,15 +892,17 @@ Prints out:
 
 Formatter used in every print out
 Passed a data argument with the following keys:
-* :announcer (string)
-* :caller (array)
-* :file (string)
-* :footer (string)
-* :header (string)
-* :line_number (string)
-* :pd_expression (string)
-* :object (object)
-* :object_printer (proc)
+* `:announcer` (`String`)
+* `:caller` (`Array`)
+* `:class` (`String`)
+* `:file` (`String`)
+* `:footer` (`String`)
+* `:header` (`String`)
+* `:line_number` (`String`)
+* `:method` (`String`)
+* `:pd_expression` (`String`)
+* `:object` (`Object`)
+* `:object_printer` (`Proc`)
 
 NOTE: data for :object_printer is not a string, yet a proc that must
 be called to output value. It is a proc as it automatically handles usage
@@ -860,6 +917,8 @@ PutsDebuggerer.formatter = -> (data) {
   puts "HEADER: #{data[:header]}"
   puts "FILE: #{data[:file]}"
   puts "LINE: #{data[:line_number]}"
+  puts "CLASS: #{data[:class]}"
+  puts "METHOD: #{data[:method]}"
   puts "EXPRESSION: #{data[:pd_expression]}"
   print "PRINT OUT: "
   data[:object_printer].call
@@ -873,9 +932,11 @@ Prints out:
 
 ```bash
 -<[PD]>-
-FILE: /Users/User/example.rb
 HEADER: ********************************************************************************
+FILE: /Users/User/example.rb
 LINE: 9
+CLASS: Example
+METHOD: test
 EXPRESSION: x=1
 PRINT OUT: 1
 CALLER: #/Users/User/master_examples.rb:83:in `block (3 levels) in <top (required)>'
@@ -895,15 +956,17 @@ Example:
 
 ```ruby
 # File Name: /Users/User/sample_app/lib/sample.rb
-pd (x=1), caller: 3
+class Sample
+  pd (x=1), caller: 3
+end
 ```
 
 Prints out (fictional):
 
 ```bash
-[PD] /Users/User/sample_app/lib/sample.rb:2
+[PD] /Users/User/sample_app/lib/sample.rb:3 in Sample.<class:Sample>
     > pd x=1, caller: 3
-   => "1"
+   => 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\'
@@ -914,15 +977,17 @@ Shortcut Example:
 
 ```ruby
 # File Name: /Users/User/sample_app/lib/sample.rb
-pd (x=1), c: 3
+class Sample
+  pd (x=1), c: 3
+end
 ```
 
 Prints out (fictional):
 
 ```bash
-[PD] /Users/User/sample_app/lib/sample.rb:2
+[PD] /Users/User/sample_app/lib/sample.rb:3 in Sample.<class:Sample>
     > pd x=1, caller: 3
-   => "1"
+   => 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\'
@@ -934,23 +999,30 @@ Global Option Example:
 ```ruby
 # File Name: /Users/User/sample_app/lib/sample.rb
 PutsDebuggerer.caller = 3 # always print 3 lines only of the stack trace
-pd (x=1)
-pd (x=2)
+class Sample
+  class << self
+    def test
+      pd (x=1)
+      pd (x=2)
+    end
+  end
+end
+Sample.test
 ```
 
 Prints out:
 
 ```bash
-[PD] /Users/User/sample_app/lib/sample.rb:2
+[PD] /Users/User/sample_app/lib/sample.rb:6 in Sample.test
     > pd (x=1)
-   => "1"
+   => 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\'
-[PD] /Users/User/sample_app/lib/sample.rb:3
+[PD] /Users/User/sample_app/lib/sample.rb:7 in Sample.test
     > pd (x=2)
-   => "2"
+   => 2
      /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\'
@@ -1122,4 +1194,4 @@ Note that it ignores the configured printer when printing exceptions as it relie
 
 [MIT](LICENSE.txt)
 
-Copyright (c) 2017-2021 - Andy Maleh.
+Copyright (c) 2017-2024 - Andy Maleh.

data/VERSION

@@ -1 +1 @@
-0.13.5
+1.0.1

data/lib/pd.rb

@@ -1 +1,3 @@
+$LOAD_PATH.unshift(File.expand_path(__dir__))
+
 require 'puts_debuggerer'

data/lib/puts_debuggerer/core_ext/kernel.rb

@@ -143,6 +143,12 @@ module Kernel
     caller[caller_depth] && caller[caller_depth][regex, 1]
   end
   
+  # Provides caller method starting 1 level above caller of
+  # this method.
+  def __caller_method__(caller_depth=0)
+    regex = PutsDebuggerer::STACK_TRACE_CALL_METHOD_REGEX
+    caller[caller_depth] && caller[caller_depth][regex, 1]
+  end
   
   # Provides caller source line starting 1 level above caller of
   # this method.
@@ -189,6 +195,8 @@ module Kernel
     pd_data = {
       announcer: PutsDebuggerer.announcer,
       file: __caller_file__(depth)&.sub(PutsDebuggerer.app_path.to_s, ''),
+      class: self.is_a?(Module) ? self : self.class,
+      method: __caller_method__(depth)&.sub(PutsDebuggerer.app_path.to_s, ''),
       line_number: __caller_line_number__(depth),
       pd_expression: __caller_pd_expression__(depth, source_line_count),
       run_number: run_number,

data/lib/puts_debuggerer.rb

@@ -1,3 +1,5 @@
+$LOAD_PATH.unshift(File.expand_path(__dir__)) unless $LOAD_PATH.include?(File.expand_path(__dir__))
+
 require 'puts_debuggerer/core_ext/kernel'
 require 'puts_debuggerer/core_ext/logger'
 require 'puts_debuggerer/core_ext/logging/logger'
@@ -52,7 +54,7 @@ module PutsDebuggerer
   FORMATTER_DEFAULT = -> (data) {
       puts data[:wrapper] if data[:wrapper]
       puts data[:header] if data[:header]
-      print "#{data[:announcer]} #{data[:file]}#{':' if data[:line_number]}#{data[:line_number]}#{" (run:#{data[:run_number]})" if data[:run_number]}#{__format_pd_expression__(data[:pd_expression], data[:object])} "
+      print "#{data[:announcer]} #{data[:file]}#{':' if data[:line_number]}#{data[:line_number]} in #{[data[:class], data[:method]].compact.join('.')}#{" (run:#{data[:run_number]})" if data[:run_number]}#{__format_pd_expression__(data[:pd_expression], data[:object])} "
       data[:object_printer].call
       puts data[:caller].map {|l| '     ' + l} unless data[:caller].to_a.empty?
       puts data[:footer] if data[:footer]
@@ -63,6 +65,7 @@ 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[^\)]+)/
+  STACK_TRACE_CALL_METHOD_REGEX = /`([^']+)'$/
   OPTIONS = [:app_path, :source_line_count, :header, :h, :wrapper, :w, :footer, :f, :printer, :print_engine, :announcer, :formatter, :caller, :run_at]
   OPTION_ALIASES = {
     a: :announcer,
@@ -481,9 +484,7 @@ module PutsDebuggerer
         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)
+        convert_options(hash.slice(*OPTIONS))
       end
     end
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.13.5
+  version: 1.0.1
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2024-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -94,48 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.4
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.8.23
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.8.23
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.1
-- !ruby/object:Gem::Dependency
-  name: simplecov-lcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +124,7 @@ dependencies:
         version: '0'
 description: |
   Debuggers are great! They help us troubleshoot complicated programming problems by inspecting values produced by code, line by line. They are invaluable when trying to understand what is going on in a large application composed of thousands or millions of lines of code.
-  In day-to-day test-driven development and simple debugging though, a puts statement can be a lot quicker in revealing what is going on than halting execution completely just to inspect a single value or a few. This is certainly true when writing the simplest possible code that could possibly work, and running a test every few seconds or minutes. Problem is you need to locate puts statements in large output logs, know which methods were invoked, find out what variable names are being printed, and see nicely formatted output. Enter puts_debuggerer. A guilt-free puts debugging Ruby gem FTW that prints file names, line numbers, code statements, and formats output nicely courtesy of awesome_print.
+  In day-to-day test-driven development and simple debugging though, a puts statement can be a lot quicker in revealing what is going on than halting execution completely just to inspect a single value or a few. This is certainly true when writing the simplest possible code that could possibly work, and running a test every few seconds or minutes. Problem is you need to locate puts statements in large output logs, know which file names, line numbers, classes, and methods contained the puts statements, find out what variable names are being printed, and see nicely formatted output. Enter puts_debuggerer. A guilt-free puts debugging Ruby gem FTW that prints file names, line numbers, class names, method names, and code statements; and formats output nicely courtesy of awesome_print.
   Partially inspired by this blog post: https://tenderlovemaking.com/2016/02/05/i-am-a-puts-debuggerer.html (Credit to Tenderlove.)
 email: andy.am@gmail.com
 executables: []
@@ -206,9 +164,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.1
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Ruby library for improved puts debugging, automatically displaying bonus
-  useful information such as source line number and source code.
+  useful information such as source file name, line number, class name, method name,
+  and source code.
 test_files: []