puts_debuggerer 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c88bd5fef7057cd180ae60e177dc981f4c55e8db
-  data.tar.gz: 4d9f9d965df2e88f79a82c899e01f772fa60b316
+  metadata.gz: 74eb84d4e3c40ce1f68dd0142da2e4579a7cf2a7
+  data.tar.gz: 658504f16ce3f3522a4dba972701fb05907a5088
 SHA512:
-  metadata.gz: 87a8e6e07e3e294ed74fafb2b47fb64e3f12de5438b0969d9daa20c8c20a49677bfbf807521ca117142ecc727ad21c5327ec6ce2c1e1ad0d35f127588ba1ff95
-  data.tar.gz: a775f0476aeb9544707396a6d06b5d06452314af1607a766f404e7ecf827c8020ee6266d92c81d07f2bf577acb329ec7b68842d877c5d3a8a83117b04f1d2c49
+  metadata.gz: 25fc5da47a71afcae5d14ce8270761ddc7a637147722c778f0a18598f5b9c8a215b595c85415516e3877c6a51ba16468727d45138c024a508023a08111282a12
+  data.tar.gz: 9617fe34c02aee117c6a3741fab8edfc6700549da37d7e582d73c02be1b769072c4c36b57c761f06c097f7ea5033d4aca108a3d0d173f8f97c8ce77ab7a2748f

data/README.md

@@ -1,4 +1,4 @@
-# puts_debuggerer v0.3.0
+# puts_debuggerer v0.4.0
 [![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)
@@ -16,7 +16,7 @@ https://tenderlovemaking.com/2016/02/05/i-am-a-puts-debuggerer.html
 Add the following to bundler's `Gemfile`.
 
 ```ruby
-gem 'puts_debuggerer', '~> 0.3.0'
+gem 'puts_debuggerer', '~> 0.4.0'
 ```
 
 ### Manual
@@ -24,7 +24,7 @@ gem 'puts_debuggerer', '~> 0.3.0'
 Or manually install and require library.
 
 ```bash
-gem install puts_debuggerer -v0.3.0
+gem install puts_debuggerer -v0.4.0
 ```
 
 ```ruby
@@ -33,15 +33,21 @@ require 'puts_debuggerer'
 
 ### Usage
 
-Simply invoke global `pd` method anywhere you'd like to see line number and source code with output.
-If the argument is a pure string, the print out is simplified by not showing duplicate source.
+Simply invoke global `pd` method anywhere and it prints file, line number,
+source code in addition to output (works even in IRB).
+If the argument is a literal value with no interpolation, the print out is
+simplified by not showing source code matching output.
 
 Quickly locate printed lines using Find feature (e.g. CTRL+F) by looking for:
 * [PD]
 * file:line_number
 * ruby expression.
 
-This gives you the added benefit of easily removing your pd statements later on from the code.
+This gives you the added benefit of easily removing your `pd` statements later
+on.
+
+This can easily be augmented with a print engine like `awesome_print` and
+customized to format output differently as per options below.
 
 Happy puts_debuggerering!
 
@@ -65,7 +71,7 @@ Example Printout:
 
 ### Options
 
-#### `PutsDebuggerer.app_path`
+#### `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`
@@ -87,7 +93,7 @@ Example Printout:
 [PD] pd_test.rb:5 "What line number am I?"
 ```
 
-#### `PutsDebuggerer.header`
+#### `PutsDebuggerer.header` (default = `nil`)
 
 Header to include at the top of every print out.
 * Default value is `nil`
@@ -111,7 +117,7 @@ Prints out:
   => "1"
 ```
 
-#### `PutsDebuggerer.footer`
+#### `PutsDebuggerer.footer` (default = `nil`)
 
 Footer to include at the bottom of every print out.
 * Default value is `nil`
@@ -126,7 +132,7 @@ PutsDebuggerer.footer = true
 pd (x=1)
 ```
 
-Prints out
+Prints out:
 
 ```bash
 [PD] /Users/User/example.rb:2
@@ -135,6 +141,57 @@ 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).
+Defaults to Ruby's built-in `p` method identified by the symbol `:p`.
+
+Example:
+
+```ruby
+# File Name: /Users/User/example.rb
+require 'awesome_print'
+PutsDebuggerer.print_engine = :ap
+array = [1, [2, 3]]
+pd array
+```
+
+Prints out:
+
+```bash
+[PD] /Users/User/example.rb:5
+   > (array).inspect
+  => [
+    [0] 1,
+    [1] [
+        [0] 2,
+        [1] 3
+    ]
+]
+```
+
+#### `PutsDebuggerer.announcer` (default = `"[PD]"`)
+
+Announcer (e.g. `[PD]`) to announce every print out with (default: `"[PD]"`)
+
+Example:
+
+```ruby
+PutsDebuggerer.announcer = "*** PD ***\n  "
+pd (x=1)
+```
+
+Prints out:
+
+```bash
+*** PD ***
+   /Users/User/example.rb:2
+   > (x=1).inspect
+  => "1"
+```
+
 ### Bonus
 
 puts_debuggerer comes with the following bonus utility methods:
@@ -181,6 +238,7 @@ Prints out `puts __caller_source_line__`
 
 ## Release Notes
 
+* v0.4.0: custom print engine (e.g. ap), custom announcer, 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
 * v0.1.0: File/line/expression print out

data/lib/puts_debuggerer.rb

@@ -1,6 +1,9 @@
 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)'
+  ANNOUNCER_DEFAULT = '[PD]'
   class << self
     # Application root path to exclude when printing out file path
     #
@@ -76,6 +79,8 @@ module PutsDebuggerer
     def footer=(value)
       if value.equal?(true)
         @footer = FOOTER_DEFAULT
+      elsif value == ''
+        @footer = nil
       else
         @footer = value
       end
@@ -84,9 +89,65 @@ module PutsDebuggerer
     def footer?
       !!@footer
     end
+
+    # 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).
+    # Defaults to Ruby's built-in `p` method identified by the symbol `:p`.
+    #
+    # Example:
+    #
+    #   # File Name: /Users/User/example.rb
+    #   require 'awesome_print'
+    #   PutsDebuggerer.print_engine = :ap
+    #   array = [1, [2, 3]]
+    #   pd array
+    #
+    # Prints out
+    #
+    #   [PD] /Users/User/example.rb:5
+    #      > (array).inspect
+    #     => [
+    #       [0] 1,
+    #       [1] [
+    #           [0] 2,
+    #           [1] 3
+    #       ]
+    #   ]
+    attr_reader :print_engine
+
+    def print_engine=(engine)
+      if engine.nil?
+        @print_engine = PRINT_ENGINE_DEFAULT
+      else
+        @print_engine = method(engine).name rescue raise(PRINT_ENGINE_MESSAGE_INVALID)
+      end
+    end
+
+    # Announcer (e.g. [PD]) to announce every print out with (default: "[PD]")
+    #
+    # Example:
+    #
+    #   PutsDebuggerer.announcer = "*** PD ***\n  "
+    #   pd (x=1)
+    #
+    # Prints out
+    #
+    #   *** PD ***
+    #      /Users/User/example.rb:2
+    #      > (x=1).inspect
+    #     => "1"
+    attr_reader :announcer
+
+    def announcer=(text)
+      @announcer = text.nil? ? ANNOUNCER_DEFAULT : text
+    end
   end
 end
 
+PutsDebuggerer.print_engine = PutsDebuggerer::PRINT_ENGINE_DEFAULT
+PutsDebuggerer.announcer = PutsDebuggerer::ANNOUNCER_DEFAULT
+
 # Prints object with bonus info such as file name, line number and source
 # expression. Optionally prints out header and footer.
 # Lookup PutsDebuggerer attributes for more details about configuration options.
@@ -116,13 +177,19 @@ end
 #      > ("Show me the source of the bug: #{bug}").inspect
 #     => "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(object)
+def pd(object, options=nil)
   header = PutsDebuggerer.header? ? "#{PutsDebuggerer.header}\n" : ''
-  pd_expression = __caller_pd_expression__(object)
-  line_number = __caller_line_number__(1)
+  announcer = PutsDebuggerer.announcer
   file = __caller_file__(1).sub(PutsDebuggerer.app_path.to_s, '')
-  footer = PutsDebuggerer.footer? ? "\n#{PutsDebuggerer.footer}" : ''
-  puts "#{header}[PD] #{file}:#{line_number}#{pd_expression} #{object.inspect}#{footer}"
+  line_number = __caller_line_number__(1)
+  pd_expression = __caller_pd_expression__(object)
+  print "#{header}#{announcer} #{file}:#{line_number}#{pd_expression} "
+  if options.nil? || options == {}
+    send(PutsDebuggerer.print_engine, object)
+  else
+    send(PutsDebuggerer.print_engine, object, options) rescue send(PutsDebuggerer.print_engine, object)
+  end
+  puts PutsDebuggerer.footer if PutsDebuggerer.footer?
 end
 
 
@@ -169,9 +236,13 @@ def __caller_source_line__(caller_depth=0)
   source_line_number = __caller_line_number__(caller_depth+1)
   source_file = __caller_file__(caller_depth+1)
   source_line = nil
-  File.open(source_file, 'r') do |f|
-    lines = f.readlines
-    source_line = lines[source_line_number-1]
+  if source_file == '(irb)'
+    source_line = conf.io.line(source_line_number)
+  else
+    File.open(source_file, 'r') do |f|
+      lines = f.readlines
+      source_line = lines[source_line_number-1]
+    end
   end
   source_line
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andy Maleh
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement