puts_debuggerer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7725af88945400b237c93414e5a326fd01ae0e16
-  data.tar.gz: 736810c4846789ee45048c7621ef034090aea238
+  metadata.gz: 4c436f4ee8d3331aeda4238d595dd1996b2ac9f6
+  data.tar.gz: 437c3424368501a52e3f203d06a9734a34efcdc3
 SHA512:
-  metadata.gz: 3f4c8b54eea069dfcd8a0118ab128be2be829129ba696e63a4617c3e42439cad32e735835db11db15abda0feb5e0aabb22837a92d86645ad462a2abf9255e8a3
-  data.tar.gz: 5102841796d47eb0f5b529f9fc6fc50972cc7d96b8dc54f841cf8fee4d59be23a4d5cc8360e0b5c639d33cc9c869b5e42dfd2c98a99052b3c0ce67554ab1e0fb
+  metadata.gz: c3812cc24eaabcfef0d4ad40cb01956e18617f3c92083b4336c3db5531acab59a54a85d00b56afd5d3fb12f6243c3e6f2d6bd9f70a6a1d25603cbe0aacf7509a
+  data.tar.gz: be7b2e10c280ef56b9690b13a7d7ea5f5fe5e3266195b7b586e8f2b638388da0322712e4fa08f00a6b24b4d9a24684b53fd7a06aedd3fb4701d734a4cb24eb92

data/README.md

@@ -0,0 +1,141 @@
+# puts_debuggerer v0.2.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)
+
+Ruby tools for improved puts debugging, automatically displaying bonus useful information such as file, line number and source code.
+
+Partially inspired by this blog post:
+https://tenderlovemaking.com/2016/02/05/i-am-a-puts-debuggerer.html
+(Credit to Tenderlove.)
+
+## Instructions
+
+### Bundler
+
+Add the following to bundler's `Gemfile`.
+
+```ruby
+gem 'puts_debuggerer', '~> 0.2.0'
+```
+
+### Manual
+
+Or manually install and require library.
+
+```bash
+gem install puts_debuggerer -v0.2.0
+```
+
+```ruby
+require 'puts_debuggerer'
+```
+
+### Usage
+
+Simple 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 => "
+
+Happy puts debugging!
+
+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
+```
+
+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?"
+```
+
+### Options
+
+#### `PutsDebuggerer.app_path`
+
+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`
+
+```ruby
+# /Users/User/finance_calculator_app/pd_test.rb                                 # line 1
+PutsDebuggerer.app_path = File.join('/Users', 'User', 'finance_calculator_app') # line 2
+bug = 'beattle'                                                                 # line 3
+pd "Show me the source of the bug: #{bug}"                                      # line 4
+pd 'What line number am I?'                                                     # line 5
+```
+
+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?"
+```
+
+### Bonus
+
+puts_debuggerer comes with the following bonus utility methods:
+
+#### `__caller_line_number__(caller_depth=0)`
+
+Provides caller line number starting 1 level above caller of this method (with default `caller_depth=0`).
+
+Example:
+
+```ruby
+# lib/example.rb                        # line 1
+puts "Print out __caller_line_number__" # line 2
+puts __caller_line_number__             # line 3
+```
+
+Prints out `3`
+
+
+#### `def __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__
+```
+
+Prints out `lib/example.rb`
+
+#### `def __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__
+```
+
+Prints out `puts __caller_source_line__`
+
+## Contributing to puts_debuggerer
+
+* 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.
+* Start a feature/bugfix branch.
+* 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.
+
+## Copyright
+
+Copyright (c) 2017 Andy Maleh. See LICENSE.txt for
+further details.

data/lib/puts_debuggerer.rb

@@ -1,3 +1,13 @@
+module PutsDebuggerer
+  class << self
+    attr_writer :app_path
+
+    def app_path
+      (@app_path || Rails.root.to_s) rescue nil
+    end
+  end
+end
+
 def pd(object)
   source_line = __caller_source_line__(1).strip.sub(/^[ ]*pd[ ]+/, '').gsub(/(^'|'$)/, '"')
   if source_line == object.inspect.sub("\n$", '')
@@ -5,7 +15,9 @@ def pd(object)
   else
     source_line += '.inspect => '
   end
-  puts "#{__caller_line_number__(1)}: #{source_line}#{object.inspect}"
+  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}"
 end
 
 STACK_TRACE_CALL_LINE_NUMBER_REGEX = /\:(\d+)\:in /
@@ -16,27 +28,43 @@ STACK_TRACE_CALL_SOURCE_FILE_REGEX = /[ ]*([^:]+)\:\d+\:in /
 #
 # Example:
 # ```ruby
-# puts "Print out __caller_line_number__" # line 1
-# puts __caller_line_number__             # line 2
+# # lib/example.rb                        # line 1
+# puts "Print out __caller_line_number__" # line 2
+# puts __caller_line_number__             # line 3
 # ```
-# prints out 2
+# prints out `3`
 def __caller_line_number__(caller_depth=0)
   caller[caller_depth][STACK_TRACE_CALL_LINE_NUMBER_REGEX, 1].to_i
 end
 
+# Provides caller file starting 1 level above caller of
+# this method.
+#
+# Example:
+# ```ruby
+# # lib/example.rb
+# puts "Print out __caller_line_number__"
+# puts __caller_line_number__
+# ```
+# prints out `lib/example.rb`
+def __caller_file__(caller_depth=0)
+  caller[caller_depth][STACK_TRACE_CALL_SOURCE_FILE_REGEX, 1]
+end
+
 
 # Provides caller source line starting 1 level above caller of
 # this method.
 #
 # Example:
 # ```ruby
-# puts "Print out __caller_line_number__" # line 1
-# puts __caller_line_number__             # line 2
+# # lib/example.rb
+# puts "Print out __caller_line_number__"
+# puts __caller_line_number__
 # ```
-# prints out 2
+# 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[caller_depth][STACK_TRACE_CALL_SOURCE_FILE_REGEX, 1]
+  source_file = __caller_file__(caller_depth+1)
   source_line = nil
   File.open(source_file, 'r') do |f|
     lines = f.readlines

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-23 00:00:00.000000000 Z
+date: 2017-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -101,10 +101,10 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 - lib/puts_debuggerer.rb
 homepage: http://github.com/AndyObtiva/puts_debuggerer
 licenses:

data/README.rdoc

@@ -1,66 +0,0 @@
-= puts_debuggerer v0.1.0
-
-Ruby tools for improved puts debugging, automatically displaying bonus useful information such as line number and source code.
-
-Partially inspired by this blog post:
-https://tenderlovemaking.com/2016/02/05/i-am-a-puts-debuggerer.html
-(Credit to Tenderlove.)
-
-== Instructions
-
-=== Bundler
-
-Add the following to bundler's `Gemfile`.
-
-```ruby
-gem 'puts_debuggerer', '~> 0.1.0'
-```
-
-=== Manual
-
-Or manually install and require library.
-
-```
-gem install puts_debuggerer
-```
-
-```ruby
-require 'puts_debuggerer'
-```
-
-=== Usage
-
-Simple 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 => "
-
-Happy puts debugging!
-
-Example Code:
-
-```ruby
-bug = 'beattle'
-pd "Show me the source of the bug: #{bug}"
-pd 'What line number am I?'
-```
-
-Example Printout:
-
-pd 2: "Show me the source of the bug: #{bug}".inspect => "Show me the source of the bug: beattle"
-pd 3: "What line number am I?"
-
-== Contributing to puts_debuggerer
-
-* 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.
-* Start a feature/bugfix branch.
-* 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.
-
-== Copyright
-
-Copyright (c) 2017 Andy Maleh. See LICENSE.txt for
-further details.