puts_debuggerer 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a76ad1423ec2f3a99ddc81f5180ff557bbef1a8b
-  data.tar.gz: 86c7f3bec6285fa098500f7135da7b3cefd3df0f
+  metadata.gz: 88d9830281a5e05522ae9d8e5b897f16f9be2d83
+  data.tar.gz: 3be27b32cbb31b1e0c1b31d987c8ee99dcbd197a
 SHA512:
-  metadata.gz: c9e6a0d82247b43c84370708b98629ba19da1eaef472ae0980940e04ac4b6e4a1785fbe010aa14026ce35a63de95cb14160c62d9c9b89782eb0b1276519592f7
-  data.tar.gz: 236fd33a65d78794613d5a0de3e26afcf784cf88c9592773eba76e9ee4ceb17020a6eb2176c6a8e793d71b05e75933a596447f00ce3d86bb468514d330e9af01
+  metadata.gz: fb1d343228ff5550b5b9371db25e33ae5d3d36d0d6cf22c6ba8680adf17122e89678467065d27e730bbb2011c7e106a76c675092c57ae6a1948d436b238858d8
+  data.tar.gz: f9dd158281412769600f08a2b31fe4a1b313bfbb5eb5f04a3c17a22c0d27ea167973cd89c56b4c0c760aa783f56dff82c68eeda4079a403bae2a2358846176f2

data/README.md

@@ -1,4 +1,4 @@
-# puts_debuggerer v0.5.0
+# puts_debuggerer v0.5.1
 [![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)
@@ -8,7 +8,7 @@ statements like an umbrella in a stormy day.
 Why not make it official and have puts debugging become its own perfectly
 legitimate thing?!!
 
-And thus, puts_debuggerer was born. A guilt-free puts debugger Ruby gem FTW!
+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.
 
@@ -16,22 +16,26 @@ Partially inspired (only partially ;) by this blog post:
 https://tenderlovemaking.com/2016/02/05/i-am-a-puts-debuggerer.html
 (Credit to Tenderlove.)
 
+Love PD?! Why not promote with [merchandise](https://www.zazzle.com/i+heart+pd+gifts)?
+
 ## Instructions
 
-### Bundler
+### Option 1: Bundler
 
 Add the following to bundler's `Gemfile`.
 
 ```ruby
-gem 'puts_debuggerer', '~> 0.5.0'
+gem 'puts_debuggerer', '~> 0.5.1'
 ```
 
-### Manual
+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.
+
+### Option 2: Manual
 
 Or manually install and require library.
 
 ```bash
-gem install puts_debuggerer -v0.5.0
+gem install puts_debuggerer -v0.5.1
 ```
 
 ```ruby
@@ -61,19 +65,23 @@ Happy puts_debuggerering!
 Example Code:
 
 ```ruby
-# /Users/User/finance_calculator_app/pd_test.rb # line 1
-bug = 'beattle'                                 # line 2
-pd "Show me the source of the bug: #{bug}"      # line 3
-pd 'What line number am I?'                     # line 4
+# /Users/User/finance_calculator_app/pd_test.rb           # line 1
+bug = 'beattle'                                           # line 2
+pd 'Debugging Info:'                                      # line 3 (literal)
+pd "Show me the source of the bug: #{bug}"                # line 4
+pd "Show me the result of the calculation: #{(12.0/3.0)}" # line 5
 ```
 
 Example Printout:
 
 ```bash
-[PD] /Users/User/finance_calculator_app/pd_test.rb:3
+[PD] /Users/User/finance_calculator_app/pd_test.rb:3 "Debugging Info:"
+[PD] /Users/User/finance_calculator_app/pd_test.rb:4
    > 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 "What line number am I?"
+[PD] /Users/User/finance_calculator_app/pd_test.rb:5
+   > pd "Show me the result of the calculation: #{(12.0/3.0)}"
+  => "Show me the result of the calculation: 4.0"
 ```
 
 ### Options
@@ -87,7 +95,24 @@ Global configuration is done via `PutsDebuggerer` module attribute writers.
 On the other hand, piecemeal options can be passed to the `pd` global method as
 the second argument.
 
-Example:
+Example 1:
+
+```ruby
+# File Name: /Users/User/project/piecemeal.rb
+data = [1, [2, 3]]
+pd data, header: true
+```
+
+Prints out:
+
+```bash
+********************************************************************************
+[PD] /Users/User/project/piecemeal.rb:3
+   > pd data, header: true
+  => [1, [2, 3]]
+```
+
+Example 2:
 
 ```ruby
 # File Name: /Users/User/project/piecemeal.rb
@@ -101,7 +126,7 @@ Prints out:
 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
    -<[PD]>-
    /Users/User/project/piecemeal.rb:3
-   > pd data
+   > pd data, header: '>'*80, footer: '<'*80, announcer: "   -<[PD]>-\n  "
   => [1, [2, 3]]
 <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
 ```
@@ -184,11 +209,10 @@ Prints out:
 #### `PutsDebuggerer.print_engine`
 (default = `:p`)
 
-Print engine to use in object printout (e.g. `p`, `ap`, `pp`).
-It is represented by the print engine's global method name as a symbol
-(e.g. `:ap` for [awesome_print](https://github.com/awesome-print/awesome_print)).
+Print engine is a global method symbol or lambda expression to use in object printout. Examples of global methods are `:p`, `:ap`, and `:pp`. An example of a lambda expression is `lambda {|o| Rails.logger.info(o)}`
+
 Defaults to Ruby's built-in `p` method identified by the symbol `:p`.
-If it finds [awesome_print](https://github.com/awesome-print/awesome_print) loaded, it defaults to `ap` as `:ap` instead.
+If it finds [awesome_print](https://github.com/awesome-print/awesome_print) loaded, it defaults to `ap` as `:ap` instead. Also, if it finds Rails loaded without ap, it relies on `lambda {|o| Rails.logger.debug(o)}` as the print engine. Otherwise if both Rails and [awesome_print](https://github.com/awesome-print/awesome_print) are loaded, then it relies on `lambda {|o| Rails.logger.ap(o)}` instead
 
 Example:
 
@@ -316,7 +340,18 @@ Prints out:
 
 ### Bonus
 
-puts_debuggerer comes with the following bonus utility methods:
+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"
+```
+
+Additionally, puts_debuggerer comes with the following bonus utility methods:
 
 #### `__caller_line_number__(caller_depth=0)`
 
@@ -360,7 +395,7 @@ Prints out `puts __caller_source_line__`
 
 ## Release Notes
 
-* v0.5.0: custom formatter, caller backtrace, per-puts piecemeal options, and multi-line support
+* v0.5.1: custom formatter, caller backtrace, per-puts piecemeal options, and multi-line support
 * v0.4.0: custom print engine (e.g. ap), custom announcer, and IRB support
 * v0.3.0: header/footer support, multi-line printout, improved format
 * v0.2.0: App path exclusion support, Rails root support, improved format

data/lib/puts_debuggerer.rb

@@ -4,7 +4,7 @@ module PutsDebuggerer
   HEADER_DEFAULT = '*'*80
   FOOTER_DEFAULT = '*'*80
   PRINT_ENGINE_DEFAULT = :p
-  PRINT_ENGINE_MESSAGE_INVALID = 'print_engine must be a valid global method symbol (e.g. :p or :puts)'
+  PRINT_ENGINE_MESSAGE_INVALID = 'print_engine must be a valid global method symbol (e.g. :p or :puts) or lambda/proc'
   ANNOUNCER_DEFAULT = '[PD]'
   FORMATTER_DEFAULT = -> (data) {
       puts data[:header] if data[:header]
@@ -130,7 +130,17 @@ module PutsDebuggerer
 
     def print_engine=(engine)
       if engine.nil?
-        @print_engine = method(:ap).name rescue PRINT_ENGINE_DEFAULT
+        if Object.const_defined?(:Rails)
+          if Object.respond_to?(:ap, 'Hello')
+            @print_engine = lambda {|object| Rails.logger.ap(object)}
+          else
+            @print_engine = lambda {|object| Rails.logger.debug(object)}
+          end
+        else
+          @print_engine = method(:ap).name rescue PRINT_ENGINE_DEFAULT
+        end
+      elsif engine.is_a?(Proc)
+        @print_engine = engine #TODO check that it takes one parameter or else fail fast
       else
         @print_engine = method(engine).name rescue raise(PRINT_ENGINE_MESSAGE_INVALID)
       end
@@ -258,14 +268,13 @@ module PutsDebuggerer
         send("#{option}=", value)
       end
     end
-
   end
 end
 
 PutsDebuggerer.print_engine = PutsDebuggerer::PRINT_ENGINE_DEFAULT
 PutsDebuggerer.announcer = PutsDebuggerer::ANNOUNCER_DEFAULT
 PutsDebuggerer.formatter = PutsDebuggerer::FORMATTER_DEFAULT
-PutsDebuggerer.app_path = nil
+PutsDebuggerer.app_path = nil #TODO also have it set Rails root on first PD
 PutsDebuggerer.caller = nil
 
 # Prints object with bonus info such as file name, line number and source
@@ -345,9 +354,9 @@ end
 #   puts __caller_source_line__
 #
 # prints out `puts __caller_source_line__`
-def __caller_source_line__(caller_depth=0)
-  source_line_number = __caller_line_number__(caller_depth+1)
-  source_file = __caller_file__(caller_depth+1)
+def __caller_source_line__(caller_depth=0, source_file=nil, source_line_number=nil)
+  source_line_number ||= __caller_line_number__(caller_depth+1)
+  source_file ||= __caller_file__(caller_depth+1)
   source_line = nil
   if source_file == '(irb)'
     source_line = conf.io.line(source_line_number)
@@ -386,10 +395,14 @@ def __build_pd_data__(object, print_engine_options=nil)
     pd_expression: __caller_pd_expression__(depth),
     object: object,
     object_printer: lambda do
-      if print_engine_options.to_h.empty?
-        send(PutsDebuggerer.print_engine, object)
+      if PutsDebuggerer.print_engine.is_a?(Proc)
+        PutsDebuggerer.print_engine.call(object)
       else
-        send(PutsDebuggerer.print_engine, object, print_engine_options) rescue send(PutsDebuggerer.print_engine, object)
+        if print_engine_options.to_h.empty?
+          send(PutsDebuggerer.print_engine, object)
+        else
+          send(PutsDebuggerer.print_engine, object, print_engine_options) rescue send(PutsDebuggerer.print_engine, object)
+        end
       end
     end
   }

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Andy Maleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2017-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
-  type: :development
+        version: 1.7.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
-  name: rspec-mocks
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.5.0
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -125,7 +125,7 @@ dependencies:
 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?!!
 
-  And thus, puts_debuggerer was born. A guilt-free puts debugger Ruby gem FTW!
+  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.