puts_debuggerer 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b97ba980916a6d84faa8817ed75f1cc5d19841435e707a61090c5bfaf511872e
-  data.tar.gz: 05e9a62ad2893e1394e18359652f5de012536b90f61ba6a2507501daaf73b774
+  metadata.gz: 2fd0277b6264431cf1d1e83db01166e95107cbbc6dc45b0eff9adac444650372
+  data.tar.gz: 31276c4cb27085ccd264897fa7305e7fe1740d8f6a4a0901c73e1e2ec179c458
 SHA512:
-  metadata.gz: 397639f53099e9fa91b5cbc7a42b0fe7c465eb2835e6b08307c5ae0b0e01036f6d3ee428c204375f2a5c977543715955f3efbd448bceb4dde59bea21f9a09290
-  data.tar.gz: b53f8db42dea2a575f438357e43966a478692cb73342dbc9255ed7e23196758f2e166180e26283bd06f19974a2a570e2bc01f52f5d37f27d57b939e16e40e797
+  metadata.gz: 96cb360a70d4118c0fc63a17b0d5d1b883f40177a8765efe2a9e135afe872686ee4090ba5e8bb5c456077545225b6a92737d2de1c315e0b3ce6184ee53ef9ac1
+  data.tar.gz: 751582b302545b1f4bea4fb7704125e0eb3e95057c4d0a3435042b3b2cddf2d13026f60318ef0da777c72f6b004479e8f64d0fc78f374b19ad9a8db9a78ed494

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.10.1
+
+- Remove the need for specifying `require 'ap'` before `require 'pd'`
+
 ## 0.10.0
 
 - Support `require 'pd`' as a shorter alternative to `require 'puts_debuggerer'`

data/README.md

@@ -18,7 +18,7 @@ Basic Example:
 
 ```ruby
 # /Users/User/trivia_app.rb      # line 1
-require 'puts_debuggerer'        # line 2
+require 'pd'                     # line 2
 bug_or_band = 'beattle'          # line 3
 pd bug_or_band                   # line 4
 ```
@@ -302,7 +302,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.0'
+gem 'puts_debuggerer', '~> 0.10.1'
 ```
 
 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.
@@ -312,18 +312,35 @@ 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.0
+gem install puts_debuggerer -v0.10.1
 ```
 
 ```ruby
 require 'puts_debuggerer'
 ```
 
+Or the shorter form (often helpful to quickly troubleshoot an app):
+
+```ruby
+require 'pd'
+```
+
+
 ### Awesome Print
 
-puts_debuggerer comes with [awesome_print](https://github.com/awesome-print/awesome_print).
+[puts_debuggerer](https://rubygems.org/gems/puts_debuggerer) comes with [awesome_print](https://github.com/awesome-print/awesome_print).
+
+It is the default `PutsDebuggerer.print_engine`
+
+Still, if you do not need it, you may disable by setting `PutsDebuggerer.print_engine` to another value. Example:
+
+```ruby
+PutsDebuggerer.print_engine = :puts
+```
 
-You may disable when needed by not requiring in Ruby or by adding an explicit reference to awesome_print with `require: false` in bundler:
+If you also avoid requiring 'awesome_print', PutsDebuggerer won't require it either if it sees that you have a different `print_engine`
+
+You may also avoid requiring in Bundler `Gemfile` with `require: false`:
 
 ```ruby
 gem "awesome_print", require: false
@@ -381,11 +398,18 @@ Output:
   => "Hello Robert"
 ```
 
-Alternatively, you may want to use `object.pd_inspect` (or alias `obj.pdi`) to 
-return formatted string without printing.
-
 Happy puts_debuggerering!
 
+#### `pd_inspect` kernel method
+
+You may want to just return the string produced by the `pd` method without printing it.
+
+In that case, you may use the `pd` alternative to `object.inspect`:
+- `object.pd_inspect` 
+- `obj.pdi` (shorter alias)
+
+This returns the `pd` formatted string without printing to the terminal or log files.
+
 #### Ruby Logger and Logging::Logger 
 
 Ruby Logger and Logging::Logger (from [logging gem](https://github.com/TwP/logging)) are supported as [printers](#putsdebuggererprinter) (learn more under [PutsDebuggerer#printer](#putsdebuggererprinter)). 
@@ -957,7 +981,7 @@ Prints out `puts __caller_source_line__`
 - IRB
 - Rails Console.
 
-It provides partial-compatibility for [Opal Ruby](https://opalrb.com/), with everything working except these features:
+It provides partial-compatibility for [Opal Ruby](https://opalrb.com/) by excluding AwesomePrint (opting for `:p` printer instead), with everything working except these features:
 - File name display
 - Line number display
 - Source code call display

data/VERSION

@@ -1 +1 @@
-0.10.0
+0.10.1

data/lib/puts_debuggerer.rb

@@ -262,19 +262,23 @@ module PutsDebuggerer
     #      > pd array
     #     => [1, [2, 3]]
     #   ]
-    attr_reader :print_engine
+    def print_engine
+      if @print_engine.nil?
+        require 'awesome_print' if RUBY_PLATFORM != 'opal'
+        @print_engine = print_engine_default    
+      end
+      @print_engine
+    end
 
     def print_engine=(engine)
-      if engine.nil?
-        @print_engine = print_engine_default
-      elsif engine.is_a?(Proc)
+      if engine.is_a?(Proc) || engine.nil?
         @print_engine = engine
       else
         @print_engine = method(engine).name rescue raise(PRINT_ENGINE_MESSAGE_INVALID)
       end
     end
     
-    def print_engine_default
+    def print_engine_default    
       Object.const_defined?(:AwesomePrint) ? PRINT_ENGINE_DEFAULT : :p    
     end
 
@@ -530,7 +534,6 @@ PutsDebuggerer.source_line_count = nil
 #     => "Show me the source of the bug: beattle"
 #   [PD] /Users/User/finance_calculator_app/pd_test.rb:4 "What line number am I?"
 def pd(*objects)
-  require 'awesome_print' if ['awesome_print', 'ap'].include?(PutsDebuggerer.print_engine.to_s) && RUBY_PLATFORM != 'opal'
   options = PutsDebuggerer.determine_options(objects) || {}
   object = PutsDebuggerer.determine_object(objects)
   run_at = PutsDebuggerer.determine_run_at(options)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print