puts_debuggerer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c436f4ee8d3331aeda4238d595dd1996b2ac9f6
-  data.tar.gz: 437c3424368501a52e3f203d06a9734a34efcdc3
+  metadata.gz: c88bd5fef7057cd180ae60e177dc981f4c55e8db
+  data.tar.gz: 4d9f9d965df2e88f79a82c899e01f772fa60b316
 SHA512:
-  metadata.gz: c3812cc24eaabcfef0d4ad40cb01956e18617f3c92083b4336c3db5531acab59a54a85d00b56afd5d3fb12f6243c3e6f2d6bd9f70a6a1d25603cbe0aacf7509a
-  data.tar.gz: be7b2e10c280ef56b9690b13a7d7ea5f5fe5e3266195b7b586e8f2b638388da0322712e4fa08f00a6b24b4d9a24684b53fd7a06aedd3fb4701d734a4cb24eb92
+  metadata.gz: 87a8e6e07e3e294ed74fafb2b47fb64e3f12de5438b0969d9daa20c8c20a49677bfbf807521ca117142ecc727ad21c5327ec6ce2c1e1ad0d35f127588ba1ff95
+  data.tar.gz: a775f0476aeb9544707396a6d06b5d06452314af1607a766f404e7ecf827c8020ee6266d92c81d07f2bf577acb329ec7b68842d877c5d3a8a83117b04f1d2c49

data/README.md

@@ -1,4 +1,4 @@
-# puts_debuggerer v0.2.0
+# puts_debuggerer v0.3.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.2.0'
+gem 'puts_debuggerer', '~> 0.3.0'
 ```
 
 ### Manual
@@ -24,7 +24,7 @@ gem 'puts_debuggerer', '~> 0.2.0'
 Or manually install and require library.
 
 ```bash
-gem install puts_debuggerer -v0.2.0
+gem install puts_debuggerer -v0.3.0
 ```
 
 ```ruby
@@ -33,12 +33,17 @@ require 'puts_debuggerer'
 
 ### Usage
 
-Simple invoke global `pd` method anywhere you'd like to see line number and source code with output.
+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.
 
-Quickly find printed lines by running a find (e.g. CTRL+F) for "pd " or ".inspect => "
+Quickly locate printed lines using Find feature (e.g. CTRL+F) by looking for:
+* [PD]
+* file:line_number
+* ruby expression.
 
-Happy puts debugging!
+This gives you the added benefit of easily removing your pd statements later on from the code.
+
+Happy puts_debuggerering!
 
 Example Code:
 
@@ -52,8 +57,10 @@ pd 'What line number am I?'                     # line 4
 Example Printout:
 
 ```bash
-pd /Users/User/finance_calculator_app/pd_test.rb:3 "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?"
+[PD] /Users/User/finance_calculator_app/pd_test.rb:3
+   > ("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?"
 ```
 
 ### Options
@@ -74,8 +81,58 @@ pd 'What line number am I?'
 Example Printout:
 
 ```bash
-pd pd_test.rb:4 "Show me the source of the bug: #{bug}".inspect => "Show me the source of the bug: beattle"
-pd pd_test.rb:5 "What line number am I?"
+[PD] pd_test.rb:4
+   > ("Show me the source of the bug: #{bug}").inspect
+  => "Show me the source of the bug: beattle"
+[PD] pd_test.rb:5 "What line number am I?"
+```
+
+#### `PutsDebuggerer.header`
+
+Header to include at the top of every print out.
+* Default value is `nil`
+* Value `true` enables header as `'*'*80`
+* Value `false`, `nil`, or empty string disables header
+* Any other string value gets set as a custom header
+
+Example:
+
+```ruby
+PutsDebuggerer.header = true
+pd (x=1)
+```
+
+Prints out:
+
+```bash
+********************************************************************************
+[PD] /Users/User/example.rb:2
+   > (x=1).inspect
+  => "1"
+```
+
+#### `PutsDebuggerer.footer`
+
+Footer to include at the bottom of every print out.
+* Default value is `nil`
+* Value `true` enables footer as `'*'*80`
+* Value `false`, `nil`, or empty string disables footer
+* Any other string value gets set as a custom footer
+
+Example:
+
+```ruby
+PutsDebuggerer.footer = true
+pd (x=1)
+```
+
+Prints out
+
+```bash
+[PD] /Users/User/example.rb:2
+   > (x=1).inspect
+  => "1"
+********************************************************************************
 ```
 
 ### Bonus
@@ -89,49 +146,54 @@ Provides caller line number starting 1 level above caller of this method (with d
 Example:
 
 ```ruby
-# lib/example.rb                        # line 1
-puts "Print out __caller_line_number__" # line 2
+# File Name: lib/example.rb             # line 1
+# Print out __caller_line_number__      # line 2
 puts __caller_line_number__             # line 3
 ```
 
 Prints out `3`
 
 
-#### `def __caller_file__(caller_depth=0)`
+#### `__caller_file__(caller_depth=0)`
 
 Provides caller file starting 1 level above caller of this method (with default `caller_depth=0`).
 
 Example:
 
 ```ruby
-# lib/example.rb
-puts "Print out __caller_line_number__"
-puts __caller_line_number__
+# File Name: lib/example.rb
+puts __caller_file__
 ```
 
 Prints out `lib/example.rb`
 
-#### `def __caller_source_line__(caller_depth=0)`
+#### `__caller_source_line__(caller_depth=0)`
 
 Provides caller source line starting 1 level above caller of this method (with default `caller_depth=0`).
 
 Example:
 
 ```ruby
-# lib/example.rb
-puts "Print out __caller_line_number__"
-puts __caller_line_number__
+puts __caller_source_line__
 ```
 
 Prints out `puts __caller_source_line__`
 
-## Contributing to puts_debuggerer
+## Release Notes
+
+* 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
+
+## Contributing
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
+* Change directory into project
+* Run `gem install bundler && bundle && rake` and make sure RSpec tests are passing
 * Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
+* Write RSpec tests, Code, Commit and push until you are happy with your contribution.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 

data/lib/puts_debuggerer.rb

@@ -1,25 +1,131 @@
 module PutsDebuggerer
+  HEADER_DEFAULT = '*'*80
+  FOOTER_DEFAULT = '*'*80
   class << self
-    attr_writer :app_path
-
+    # Application root path to exclude when printing out file path
+    #
+    # Example:
+    #
+    #   # File Name: /Users/User/sample_app/lib/sample.rb
+    #   PutsDebuggerer.app_path = '/Users/User/sample_app'
+    #   pd (x=1)
+    #
+    # Prints out:
+    #
+    #   [PD] lib/sample.rb:3
+    #      > (x=1).inspect
+    #     => "1"
     def app_path
       (@app_path || Rails.root.to_s) rescue nil
     end
+
+    attr_writer :app_path
+
+    # Header to include at the top of every print out.
+    # * Default value is `nil`
+    # * Value `true` enables header as `'*'*80`
+    # * Value `false`, `nil`, or empty string disables header
+    # * Any other string value gets set as a custom header
+    #
+    # Example:
+    #
+    #   PutsDebuggerer.header = true
+    #   pd (x=1)
+    #
+    # Prints out:
+    #
+    #   ********************************************************************************
+    #   [PD] /Users/User/example.rb:2
+    #      > (x=1).inspect
+    #     => "1"
+    attr_reader :header
+
+    def header=(value)
+      if value.equal?(true)
+        @header = HEADER_DEFAULT
+      elsif value == ''
+        @header = nil
+      else
+        @header = value
+      end
+    end
+
+    def header?
+      !!@header
+    end
+
+    # Footer to include at the bottom of every print out.
+    # * Default value is `nil`
+    # * Value `true` enables footer as `'*'*80`
+    # * Value `false`, `nil`, or empty string disables footer
+    # * Any other string value gets set as a custom footer
+    #
+    # Example:
+    #
+    #   PutsDebuggerer.footer = true
+    #   pd (x=1)
+    #
+    # Prints out
+    #
+    #   [PD] /Users/User/example.rb:2
+    #      > (x=1).inspect
+    #     => "1"
+    #   ********************************************************************************
+    attr_reader :footer
+
+    def footer=(value)
+      if value.equal?(true)
+        @footer = FOOTER_DEFAULT
+      else
+        @footer = value
+      end
+    end
+
+    def footer?
+      !!@footer
+    end
   end
 end
 
+# 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.
+#
+# 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.
+#
+# 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.
+#
+# Happy puts_debuggerering!
+#
+# Example Code:
+#
+#   # /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
+#
+# Example Printout:
+#
+#   [PD] /Users/User/finance_calculator_app/pd_test.rb:3
+#      > ("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)
-  source_line = __caller_source_line__(1).strip.sub(/^[ ]*pd[ ]+/, '').gsub(/(^'|'$)/, '"')
-  if source_line == object.inspect.sub("\n$", '')
-    source_line = ''
-  else
-    source_line += '.inspect => '
-  end
+  header = PutsDebuggerer.header? ? "#{PutsDebuggerer.header}\n" : ''
+  pd_expression = __caller_pd_expression__(object)
   line_number = __caller_line_number__(1)
   file = __caller_file__(1).sub(PutsDebuggerer.app_path.to_s, '')
-  puts "pd #{file}:#{line_number} #{source_line}#{object.inspect}"
+  footer = PutsDebuggerer.footer? ? "\n#{PutsDebuggerer.footer}" : ''
+  puts "#{header}[PD] #{file}:#{line_number}#{pd_expression} #{object.inspect}#{footer}"
 end
 
+
 STACK_TRACE_CALL_LINE_NUMBER_REGEX = /\:(\d+)\:in /
 STACK_TRACE_CALL_SOURCE_FILE_REGEX = /[ ]*([^:]+)\:\d+\:in /
 
@@ -27,11 +133,11 @@ STACK_TRACE_CALL_SOURCE_FILE_REGEX = /[ ]*([^:]+)\:\d+\:in /
 # this method.
 #
 # Example:
-# ```ruby
-# # lib/example.rb                        # line 1
-# puts "Print out __caller_line_number__" # line 2
-# puts __caller_line_number__             # line 3
-# ```
+#
+#   # lib/example.rb                        # line 1
+#   puts "Print out __caller_line_number__" # line 2
+#   puts __caller_line_number__             # line 3
+#
 # prints out `3`
 def __caller_line_number__(caller_depth=0)
   caller[caller_depth][STACK_TRACE_CALL_LINE_NUMBER_REGEX, 1].to_i
@@ -41,11 +147,10 @@ end
 # this method.
 #
 # Example:
-# ```ruby
-# # lib/example.rb
-# puts "Print out __caller_line_number__"
-# puts __caller_line_number__
-# ```
+#
+#   # File Name: lib/example.rb
+#   puts __caller_file__
+#
 # prints out `lib/example.rb`
 def __caller_file__(caller_depth=0)
   caller[caller_depth][STACK_TRACE_CALL_SOURCE_FILE_REGEX, 1]
@@ -56,11 +161,9 @@ end
 # this method.
 #
 # Example:
-# ```ruby
-# # lib/example.rb
-# puts "Print out __caller_line_number__"
-# puts __caller_line_number__
-# ```
+#
+#   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)
@@ -72,3 +175,29 @@ def __caller_source_line__(caller_depth=0)
   end
   source_line
 end
+
+private
+
+def __caller_pd_expression__(object)
+  # Caller Source Line Depth 2 = 1 to pd method + 1 to caller
+  source_line = __caller_source_line__(2)
+  source_line = __extract_pd_expression__(source_line)
+  source_line = source_line.gsub(/(^'|'$)/, '"') if source_line.start_with?("'") && source_line.end_with?("'")
+  source_line = source_line.gsub(/(^\(|\)$)/, '') if source_line.start_with?("(") && source_line.end_with?(")")
+  if source_line == object.inspect.sub("\n$", '')
+    ""
+  else
+    "\n   > (#{source_line}).inspect\n  =>"
+  end
+end
+
+# Extracts pd source line expression.
+#
+# Example:
+#
+# __extract_pd_expression__("pd (x=1)")
+#
+# outputs `(x=1)`
+def __extract_pd_expression__(source_line)
+  source_line.strip.sub(/^[ ]*pd[ ]+/, '').strip
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2017-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec