puts_debuggerer 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0b6b423e48750ec42b8ba75d9d11b9bee413f968
-  data.tar.gz: 436e88ff0bae84786ae496c93e9051c6a7e038f2
+SHA256:
+  metadata.gz: 8b80118305f3b8201241cb75a16fab616e1db9789daf829c5b4ea68ad7a6d94d
+  data.tar.gz: dd345085a3bcbf718cdb49983b3c2d1838b1914b231e6fc033ff30ea992fac32
 SHA512:
-  metadata.gz: 8d1fd6d211ef47039e03d2fcf0dd4e093bf68d28bae54fb3285a72fc7cb179889eefd2e4340eaecea7c630c8ec7b671a2d9b26ffbd01fc2acaccbed99e90fb17
-  data.tar.gz: 627007999c72fd0c33d7ea60aa6703f68b56ea55c3698e0cca578e41f961aaac5f01dd924a0fd3e9fac9a97364b416d82534e4cedc6855fa2f4720e988cf78ae
+  metadata.gz: 1ac9056936792d4f8c46e4ae4114b0911a6442ef5b6ee5a6a1aebd6e405c3abc37466d207f19e94c6eaf9bd58374cd30ab2f66581777b9e37b2f572953c9261a
+  data.tar.gz: 7e0bbb0fcb9c502a252227b74a68a91d39f8ecbbf5cf85a18c4f561dae0a71baa5d258680835c573d2c5f6555e142f1b911f6a3c94302022cbd3a3ac4caeda01

data/README.md

@@ -3,21 +3,35 @@
 [![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)
 
-Yes, many of us avoid debuggers like the plague and clamp on to our puts
-statements like an umbrella in a stormy day.
-Why not make it official and have puts debugging become its own perfectly
-legitimate thing?!!
+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.
 
-Enter puts_debuggerer. A guilt-free puts debugging Ruby gem FTW!
+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.
 
-For background, please read this blog post by Aaron Patterson:
-https://tenderlovemaking.com/2016/02/05/i-am-a-puts-debuggerer.html
+Basic Example:
+
+```ruby
+# /Users/User/trivia_app.rb      # line 1
+require 'puts_debuggerer'        # line 2
+bug_or_band = 'beattle'          # line 3
+pd bug_or_band                   # line 4
+```
+
+Output:
+
+```bash
+[PD] trivia_app.rb:4
+   > pd bug_or_band                   # line 4
+  => "beattle"
+```
 
 ## 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 a header (e.g. `puts "The Order Total"`) or an announcer (e.g. `puts '*'*80`) before every puts statement, leading to repetitive wasteful effort.
+For initial background, please read this blog post by Aaron Patterson (part of the inspiration for this gem):
+https://tenderlovemaking.com/2016/02/05/i-am-a-puts-debuggerer.html
+
+It can be quite frustrating to lose puts statements in a large output or log file. One way to help find them is add a header (e.g. `puts "The Order Total"`) or an announcer (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.
+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.
 
 Example without pd:
 
@@ -44,7 +58,29 @@ Which gets lost in a logging stream such as:
    (0.2ms)  COMMIT
 ```
 
-Example with pd:
+Problem can be mitigated by adding a few more puts statements:
+
+```ruby
+puts "*"*40
+puts "order_total"
+puts order_total
+```
+
+But those add up pretty quickly when inspecting multiple variables:
+
+```ruby
+puts "*"*40
+puts "order_total"
+puts order_total
+puts "*"*40
+puts "order_summary"
+puts order_summary
+puts "*"*40
+puts "order_details"
+puts order_details
+```
+
+Here is a simple example using `pd` instead:
 
 ```ruby
 pd order_total
@@ -77,7 +113,15 @@ This is not only easy to locate in a logging stream such as the one below, but a
    (0.2ms)  COMMIT
 ```
 
-And it is easy to search for using the `[PD]` announcer.
+And it is easy to search for using the `[PD]` announcer (customizable).
+
+When inspecting multiple variables, debugging code is still a snap:
+
+```ruby
+pd order_total
+pd order_summary
+pd order_details
+```
 
 ## Instructions
 
@@ -86,7 +130,7 @@ And it is easy to search for using the `[PD]` announcer.
 Add the following to bundler's `Gemfile`.
 
 ```ruby
-gem 'puts_debuggerer', '~> 0.8.1'
+gem 'puts_debuggerer', '~> 0.8.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.
@@ -96,13 +140,24 @@ 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.8.1
+gem install puts_debuggerer -v0.8.2
 ```
 
 ```ruby
 require 'puts_debuggerer'
 ```
 
+### Awesome Print
+
+puts_debuggerer comes with [awesome_print](https://github.com/awesome-print/awesome_print).
+
+You may disable when needed by not requiring in Ruby or by adding an explicit reference to awesome_print with `require: false` in bundler:
+
+```ruby
+gem "awesome_print", require: false
+gem "puts_debugger"
+```
+
 ### 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).
@@ -509,20 +564,9 @@ And:
 `PutsDebuggerer.reset_run_at_numbers`
 for piecemeal usage.
 
-### Bonus
-
-puts_debuggerer comes with a number of bonus goodies.
-
-It comes with [awesome_print](https://github.com/awesome-print/awesome_print).
-
-You may disable by not requiring in Ruby or by adding an explicit reference to awesome_print with `require: false` in bundler:
-
-```ruby
-gem "awesome_print", require: false
-gem "puts_debugger"
-```
+### Bonus API
 
-Additionally, puts_debuggerer comes with the following bonus utility methods:
+puts_debuggerer comes with the following bonus API methods:
 
 #### `__caller_line_number__(caller_depth=0)`
 
@@ -566,6 +610,7 @@ Prints out `puts __caller_source_line__`
 
 ## Release Notes
 
+* v0.8.2: require 'stringio' for projects that don't require automatically via other gems
 * v0.8.1: `printer` option support for Rails test environment
 * v0.8.0: `printer` option support
 * v0.7.1: default print engine to :ap (AwesomePrint)

data/VERSION

@@ -0,0 +1 @@
+0.8.2

data/lib/puts_debuggerer.rb

@@ -1,5 +1,6 @@
 require 'ripper'
 require 'awesome_print'
+require 'stringio'
 
 module PutsDebuggerer
   HEADER_DEFAULT = '*'*80

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Andy Maleh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-30 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -67,71 +67,93 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.3.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.3.9
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.5
+        version: 0.8.23
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.5
+        version: 0.8.23
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        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: 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.10.0
+        version: 0.3.4
 description: |
-  Yes, many of us avoid debuggers like the plague and clamp on to our puts statements like an umbrella in a stormy day. Why not make it official and have puts debugging become its own perfectly legitimate thing?!!
-
-  Enter puts_debuggerer. A guilt-free puts debugger Ruby gem FTW!
-
-  In other words, puts_debuggerer is a Ruby library for improved puts debugging, automatically displaying bonus useful information such as source line number and source code.
-
-  Partially inspired (only partially ;) by this blog post:
-  https://tenderlovemaking.com/2016/02/05/i-am-a-puts-debuggerer.html
-  (Credit to Tenderlove.)
+  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.
+  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: []
 extensions: []
@@ -141,12 +163,13 @@ extra_rdoc_files:
 files:
 - LICENSE.txt
 - README.md
+- VERSION
 - lib/puts_debuggerer.rb
 homepage: http://github.com/AndyObtiva/puts_debuggerer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,9 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.1.2
+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.