puts_debuggerer 0.12.0 → 0.13.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85cc76378a88f1e7c8019f347e69070190ca4f051619fc60dee05d2ff3e83dda
-  data.tar.gz: fb66e2375aa5624c8910d429032e9d99367b1ed5560aa7e364bd431167f5a291
+  metadata.gz: 0b3e07943392edd34351e36147a4582452c9af5b8ca592c815d9be8b43578384
+  data.tar.gz: a97d234a8d2b8f7c995066911244628b3b1e0e6feb7ae07846551f884074cb23
 SHA512:
-  metadata.gz: e61dc7234af7e6392bc61a8510a63846c65a6cf305e5ba2dd2ce807d6ec72d259675cf0f32bddb45709d0d823e2123d8e3ce4ecce14c8165bb15874354128c24
-  data.tar.gz: 5140b36a4d575b4f27e19929c70437d8e30a45d5085b682106868c2e915e49be6744a6aea772946b8e05b3ec2d1ed4d3be21ba163dec2db56a21eeaa6b991650
+  metadata.gz: 7ffdfe67fbe6b650594023cafb7998553bd0212268b833df16061fa3b2ca7dc9e92d3a406a0b04eb28dcd903128271ec8ab62cf54f55db5f32cc689bfb25197d
+  data.tar.gz: 17b022318d9e0d7044b24e5c5c9602549784237df32ec75c7c01b393ace9eece7389b071832f823e881da7925aa32262ba57e1b8d348220747e6d17ea0ba4909

data/CHANGELOG.md

@@ -1,8 +1,28 @@
 # Change Log
 
+## 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`
+- Support `f: :t` shortcut to passing `footer: true`
+- Support `w: :t` shortcut to passing `wrapper: true`
+
 ## 0.12.0
 
-- Upgrade `awesome_print` to `~> 0.9.2`
+- 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`)
 

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)
+## [State of the Art Rails 2021](https://github.com/DanielVartanov/state-of-the-art-rails)
 [![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)
@@ -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,7 +191,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 +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]]
@@ -279,7 +312,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 +321,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.12.0'
+gem 'puts_debuggerer', '~> 0.13.3'
 ```
 
 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 +331,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.12.0
+gem install puts_debuggerer -v0.13.3
 ```
 
 ```ruby
@@ -470,7 +503,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`
@@ -493,6 +526,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
@@ -515,7 +563,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`
@@ -538,6 +586,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
@@ -560,7 +623,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`
@@ -584,6 +647,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
@@ -716,7 +795,7 @@ Prints out:
 ```
 
 #### `PutsDebuggerer.announcer`
-(default = `"[PD]"`)
+(default = `"[PD]"`) [shortcut: `a`]
 
 Announcer (e.g. `[PD]`) to announce every print out with (default: `"[PD]"`)
 
@@ -787,7 +866,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.
@@ -799,15 +878,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\'
@@ -1008,4 +1105,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.12.0
+0.13.3

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

@@ -42,7 +42,7 @@ module PutsDebuggerer
   end
   PRINTER_DEFAULT = :puts
   PRINTER_RAILS = lambda do |output|
-    puts output if Rails.env.test?
+    puts output
     Rails.logger.debug(output)
   end
   PRINT_ENGINE_DEFAULT = :ap
@@ -63,7 +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, :wrapper, :footer, :printer, :print_engine, :announcer, :formatter, :caller, :run_at]
+  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
@@ -471,14 +478,18 @@ module PutsDebuggerer
 
     def determine_options(objects)
       if objects.size > 1 && objects.last.is_a?(Hash)
-        objects.delete_at(-1)
+        convert_options(objects.delete_at(-1))
       elsif objects.size == 1 && objects.first.is_a?(Hash)
         hash = objects.first
-        hash.slice(*OPTIONS).tap do
+        convert_options(hash.slice(*OPTIONS).tap do
           hash.delete_if {|option| OPTIONS.include?(option)}
-        end
+        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)
       objects.compact.size > 1 ? objects : objects.first

metadata

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