puts_debuggerer 0.13.0 → 0.13.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dcb8700ea76c5b172428f7a4c08285244da367442f8a5bb90b45d1c25f7b107
-  data.tar.gz: ee730414f3252a164a5ff1d0f4321564dc9c11e36e72f7e2f63998128dbf2c1a
+  metadata.gz: 5342d5a36c1fc18c0d20b822ea80173f77f2a435fdfc6d82537ed2605a2ecaae
+  data.tar.gz: 8f22a52c546f352010c08b73d15fe48cc658ab12a0c69251f469dc4626241923
 SHA512:
-  metadata.gz: 40dcf3829312a9d2d30f77371c7296d0f4511d41917263e26248d8d9add0950847effe52a1afb4cec823e8afa4449426a4ab5e2f2aa86e107458aca4ac78ee4a
-  data.tar.gz: efc7adc8820b1ff2a483e88e4255a3dc3280fee16d22750a079e16c7f4de82023d811efa0dbf47e100cb4777e518e7c2c845c70a01878b47e8aa5b67ac9c99c4
+  metadata.gz: ec85fd9e9792767aa70cc9a2cd3d8e8b87de690d52a812c3890a501b75d12a2ed5c8c76af3c49c9e68d4ee28e989895b09f62763b54ddc44fef675e29737aa20
+  data.tar.gz: a9467cf4aa3acf6003f15cdccb6a67b96438a54be41f511a9defb466acc387c10f8081779b339756219426a7d1a66cbe2da0fd4ac69e7fb76395ad8ef4a65705

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change Log
 
+## 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
+
+## 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

@@ -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)
@@ -114,7 +115,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 +123,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 +154,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 +175,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 +191,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 +202,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 +279,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]]
@@ -285,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.0'
+gem 'puts_debuggerer', '~> 0.13.4'
+```
+
+Run:
+
+```
+bundle
 ```
 
-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.
+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.0
+gem install puts_debuggerer -v0.13.4
 ```
 
 ```ruby
@@ -451,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
@@ -470,7 +518,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 +578,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 +638,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`
@@ -715,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
 ```
@@ -762,7 +812,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 +883,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 +895,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 +1122,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.0
+0.13.4

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
@@ -147,7 +159,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

@@ -65,9 +65,11 @@ module PutsDebuggerer
   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
+    w: :wrapper,
   }
 
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.4
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2022-02-14 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.22
+rubygems_version: 3.3.1
 signing_key:
 specification_version: 4
 summary: Ruby library for improved puts debugging, automatically displaying bonus