puts_debuggerer 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74eb84d4e3c40ce1f68dd0142da2e4579a7cf2a7
-  data.tar.gz: 658504f16ce3f3522a4dba972701fb05907a5088
+  metadata.gz: a76ad1423ec2f3a99ddc81f5180ff557bbef1a8b
+  data.tar.gz: 86c7f3bec6285fa098500f7135da7b3cefd3df0f
 SHA512:
-  metadata.gz: 25fc5da47a71afcae5d14ce8270761ddc7a637147722c778f0a18598f5b9c8a215b595c85415516e3877c6a51ba16468727d45138c024a508023a08111282a12
-  data.tar.gz: 9617fe34c02aee117c6a3741fab8edfc6700549da37d7e582d73c02be1b769072c4c36b57c761f06c097f7ea5033d4aca108a3d0d173f8f97c8ce77ab7a2748f
+  metadata.gz: c9e6a0d82247b43c84370708b98629ba19da1eaef472ae0980940e04ac4b6e4a1785fbe010aa14026ce35a63de95cb14160c62d9c9b89782eb0b1276519592f7
+  data.tar.gz: 236fd33a65d78794613d5a0de3e26afcf784cf88c9592773eba76e9ee4ceb17020a6eb2176c6a8e793d71b05e75933a596447f00ce3d86bb468514d330e9af01

data/README.md

@@ -1,11 +1,18 @@
-# puts_debuggerer v0.4.0
+# puts_debuggerer v0.5.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.
+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?!!
 
-Partially inspired by this blog post:
+And thus, puts_debuggerer was born. 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.
+
+Partially inspired (only partially ;) by this blog post:
 https://tenderlovemaking.com/2016/02/05/i-am-a-puts-debuggerer.html
 (Credit to Tenderlove.)
 
@@ -16,7 +23,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.4.0'
+gem 'puts_debuggerer', '~> 0.5.0'
 ```
 
 ### Manual
@@ -24,7 +31,7 @@ gem 'puts_debuggerer', '~> 0.4.0'
 Or manually install and require library.
 
 ```bash
-gem install puts_debuggerer -v0.4.0
+gem install puts_debuggerer -v0.5.0
 ```
 
 ```ruby
@@ -33,8 +40,8 @@ require 'puts_debuggerer'
 
 ### Usage
 
-Simply invoke global `pd` method anywhere and it prints file, line number,
-source code in addition to output (works even in IRB).
+Simply invoke global `pd` method anywhere and it prints source file, line
+number, and 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.
 
@@ -46,7 +53,7 @@ Quickly locate printed lines using Find feature (e.g. CTRL+F) by looking for:
 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
+This can easily be augmented with a print engine like [awesome_print](https://github.com/awesome-print/awesome_print) and
 customized to format output differently as per options below.
 
 Happy puts_debuggerering!
@@ -64,14 +71,45 @@ Example Printout:
 
 ```bash
 [PD] /Users/User/finance_calculator_app/pd_test.rb:3
-   > ("Show me the source of the bug: #{bug}").inspect
+   > 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?"
 ```
 
 ### Options
 
-#### `PutsDebuggerer.app_path` (default = `nil`)
+Options enable more data to be displayed with puts_debuggerer, such as the caller
+backtrace, header, and footer. They also allow customization of output format.
+
+Options can be set as a global configuration or piecemeal per puts statement.
+
+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:
+
+```ruby
+# File Name: /Users/User/project/piecemeal.rb
+data = [1, [2, 3]]
+pd data, header: '>'*80, footer: '<'*80, announcer: "   -<[PD]>-\n  "
+```
+
+Prints out:
+
+```bash
+>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+   -<[PD]>-
+   /Users/User/project/piecemeal.rb:3
+   > pd data
+  => [1, [2, 3]]
+<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
+```
+
+Details about all the available options are included below.
+
+#### `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`
@@ -88,12 +126,13 @@ Example Printout:
 
 ```bash
 [PD] pd_test.rb:4
-   > ("Show me the source of the bug: #{bug}").inspect
+   > pd "Show me the source of the bug: #{bug}"
   => "Show me the source of the bug: beattle"
 [PD] pd_test.rb:5 "What line number am I?"
 ```
 
-#### `PutsDebuggerer.header` (default = `nil`)
+#### `PutsDebuggerer.header`
+(default = `'*'*80`)
 
 Header to include at the top of every print out.
 * Default value is `nil`
@@ -113,11 +152,12 @@ Prints out:
 ```bash
 ********************************************************************************
 [PD] /Users/User/example.rb:2
-   > (x=1).inspect
+   > pd x=1
   => "1"
 ```
 
-#### `PutsDebuggerer.footer` (default = `nil`)
+#### `PutsDebuggerer.footer`
+(default = `'*'*80`)
 
 Footer to include at the bottom of every print out.
 * Default value is `nil`
@@ -136,17 +176,19 @@ Prints out:
 
 ```bash
 [PD] /Users/User/example.rb:2
-   > (x=1).inspect
+   > pd x=1
   => "1"
 ********************************************************************************
 ```
 
-#### `PutsDebuggerer.print_engine` (default = `:p`)
+#### `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).
+(e.g. `:ap` for [awesome_print](https://github.com/awesome-print/awesome_print)).
 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.
 
 Example:
 
@@ -162,7 +204,7 @@ Prints out:
 
 ```bash
 [PD] /Users/User/example.rb:5
-   > (array).inspect
+   > pd array
   => [
     [0] 1,
     [1] [
@@ -172,7 +214,8 @@ Prints out:
 ]
 ```
 
-#### `PutsDebuggerer.announcer` (default = `"[PD]"`)
+#### `PutsDebuggerer.announcer`
+(default = `"[PD]"`)
 
 Announcer (e.g. `[PD]`) to announce every print out with (default: `"[PD]"`)
 
@@ -188,10 +231,89 @@ Prints out:
 ```bash
 *** PD ***
    /Users/User/example.rb:2
-   > (x=1).inspect
+   > pd x=1
   => "1"
 ```
 
+#### `PutsDebuggerer.formatter`
+(default = `PutsDebuggerer::FORMATTER_DEFAULT`)
+
+Formatter used in every print out
+Passed a data argument with the following keys:
+* :announcer (string)
+* :caller (array)
+* :file (string)
+* :footer (string)
+* :header (string)
+* :line_number (string)
+* :pd_expression (string)
+* :object (object)
+* :object_printer (proc)
+
+NOTE: data for :object_printer is not a string, yet a proc that must
+be called to output value. It is a proc as it automatically handles usage
+of print_engine and encapsulates its details. In any case, data for :object
+is available should one want to avoid altogether.
+
+Example:
+
+```ruby
+PutsDebuggerer.formatter = -> (data) {
+  puts "-<#{data[:announcer]}>-"
+  puts "HEADER: #{data[:header]}"
+  puts "FILE: #{data[:file]}"
+  puts "LINE: #{data[:line_number]}"
+  puts "EXPRESSION: #{data[:pd_expression]}"
+  print "PRINT OUT: "
+  data[:object_printer].call
+  puts "CALLER: #{data[:caller].to_a.first}"
+  puts "FOOTER: #{data[:footer]}"
+}
+pd (x=1)
+```
+
+Prints out:
+
+```bash
+-<[PD]>-
+FILE: /Users/User/example.rb
+HEADER: ********************************************************************************
+LINE: 9
+EXPRESSION: x=1
+PRINT OUT: 1
+CALLER: #/Users/User/master_examples.rb:83:in `block (3 levels) in <top (required)>'
+FOOTER: ********************************************************************************
+```
+
+#### `PutsDebuggerer.caller`
+(default = nil)
+
+Caller backtrace included at the end of every print out
+Passed an argument of true/false, nil, or depth as an integer.
+* true and -1 means include full caller backtrace
+* false and nil means do not include caller backtrace
+* depth (0-based) means include limited caller backtrace depth
+
+Example:
+
+```ruby
+# File Name: /Users/User/sample_app/lib/sample.rb
+PutsDebuggerer.caller = 3
+pd (x=1)
+```
+
+Prints out:
+
+```bash
+[PD] /Users/User/sample_app/lib/sample.rb:3
+    > pd x=1
+   => "1"
+     /Users/User/sample_app/lib/master_samples.rb:368:in \`block (3 levels) in <top (required)>\'
+     /Users/User/.rvm/rubies/ruby-2.4.0/lib/ruby/2.4.0/irb/workspace.rb:87:in \`eval\'
+     /Users/User/.rvm/rubies/ruby-2.4.0/lib/ruby/2.4.0/irb/workspace.rb:87:in \`evaluate\'
+     /Users/User/.rvm/rubies/ruby-2.4.0/lib/ruby/2.4.0/irb/context.rb:381:in \`evaluate\'
+```
+
 ### Bonus
 
 puts_debuggerer comes with the following bonus utility methods:
@@ -238,7 +360,8 @@ Prints out `puts __caller_source_line__`
 
 ## Release Notes
 
-* v0.4.0: custom print engine (e.g. ap), custom announcer, IRB support
+* v0.5.0: 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
 * v0.1.0: File/line/expression print out

data/lib/puts_debuggerer.rb

@@ -1,9 +1,20 @@
+require 'ripper'
+
 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]'
+  FORMATTER_DEFAULT = -> (data) {
+      puts data[:header] if data[:header]
+      print "#{data[:announcer]} #{data[:file]}:#{data[:line_number]}#{__format_pd_expression__(data[:pd_expression], data[:object])} "
+      data[:object_printer].call
+      puts data[:caller].map {|l| '     ' + l} unless data[:caller].to_a.empty?
+      puts data[:footer] if data[:footer]
+    }
+  CALLER_DEPTH_ZERO = 4 #depth includes pd + with_options method + nested block + build_pd_data method
+
   class << self
     # Application root path to exclude when printing out file path
     #
@@ -16,13 +27,13 @@ module PutsDebuggerer
     # Prints out:
     #
     #   [PD] lib/sample.rb:3
-    #      > (x=1).inspect
+    #      > pd x=1
     #     => "1"
-    def app_path
-      (@app_path || Rails.root.to_s) rescue nil
-    end
+    attr_reader :app_path
 
-    attr_writer :app_path
+    def app_path=(path)
+      @app_path = (path || Rails.root.to_s) rescue nil
+    end
 
     # Header to include at the top of every print out.
     # * Default value is `nil`
@@ -39,7 +50,7 @@ module PutsDebuggerer
     #
     #   ********************************************************************************
     #   [PD] /Users/User/example.rb:2
-    #      > (x=1).inspect
+    #      > pd x=1
     #     => "1"
     attr_reader :header
 
@@ -68,10 +79,10 @@ module PutsDebuggerer
     #   PutsDebuggerer.footer = true
     #   pd (x=1)
     #
-    # Prints out
+    # Prints out:
     #
     #   [PD] /Users/User/example.rb:2
-    #      > (x=1).inspect
+    #      > pd x=1
     #     => "1"
     #   ********************************************************************************
     attr_reader :footer
@@ -94,6 +105,7 @@ module PutsDebuggerer
     # 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`.
+    # If it finds awesome_print loaded, it defaults to `ap` as `:ap` instead.
     #
     # Example:
     #
@@ -103,10 +115,10 @@ module PutsDebuggerer
     #   array = [1, [2, 3]]
     #   pd array
     #
-    # Prints out
+    # Prints out:
     #
     #   [PD] /Users/User/example.rb:5
-    #      > (array).inspect
+    #      > pd array
     #     => [
     #       [0] 1,
     #       [1] [
@@ -118,7 +130,7 @@ module PutsDebuggerer
 
     def print_engine=(engine)
       if engine.nil?
-        @print_engine = PRINT_ENGINE_DEFAULT
+        @print_engine = method(:ap).name rescue PRINT_ENGINE_DEFAULT
       else
         @print_engine = method(engine).name rescue raise(PRINT_ENGINE_MESSAGE_INVALID)
       end
@@ -131,22 +143,130 @@ module PutsDebuggerer
     #   PutsDebuggerer.announcer = "*** PD ***\n  "
     #   pd (x=1)
     #
-    # Prints out
+    # Prints out:
     #
     #   *** PD ***
     #      /Users/User/example.rb:2
-    #      > (x=1).inspect
-    #     => "1"
+    #      > pd x=1
+    #     => 1
     attr_reader :announcer
 
     def announcer=(text)
       @announcer = text.nil? ? ANNOUNCER_DEFAULT : text
     end
+
+    # Formatter used in every print out
+    # Passed a data argument with the following keys:
+    # * :announcer (string)
+    # * :caller (array)
+    # * :file (string)
+    # * :footer (string)
+    # * :header (string)
+    # * :line_number (string)
+    # * :pd_expression (string)
+    # * :object (object)
+    # * :object_printer (proc)
+    #
+    # NOTE: data for :object_printer is not a string, yet a proc that must
+    # be called to output value. It is a proc as it automatically handles usage
+    # of print_engine and encapsulates its details. In any case, data for :object
+    # is available should one want to avoid altogether.
+    #
+    # Example:
+    #
+    #   PutsDebuggerer.formatter = -> (data) {
+    #     puts "-<#{data[:announcer]}>-"
+    #     puts "HEADER: #{data[:header]}"
+    #     puts "FILE: #{data[:file]}"
+    #     puts "LINE: #{data[:line_number]}"
+    #     puts "EXPRESSION: #{data[:pd_expression]}"
+    #     print "PRINT OUT: "
+    #     data[:object_printer].call
+    #     puts "CALLER: #{data[:caller].to_a.first}"
+    #     puts "FOOTER: #{data[:footer]}"
+    #   }
+    #   pd (x=1)
+    #
+    # Prints out:
+    #
+    #   -<[PD]>-
+    #   FILE: /Users/User/example.rb
+    #   HEADER: ********************************************************************************
+    #   LINE: 9
+    #   EXPRESSION: x=1
+    #   PRINT OUT: 1
+    #   CALLER: #/Users/User/master_examples.rb:83:in `block (3 levels) in <top (required)>'
+    #   FOOTER: ********************************************************************************
+    attr_reader :formatter
+
+    def formatter=(formatter_proc)
+      @formatter = formatter_proc.nil? ? FORMATTER_DEFAULT : formatter_proc
+    end
+
+    # Caller backtrace included at the end of every print out
+    # Passed an argument of true/false, nil, or depth as an integer.
+    # * true and -1 means include full caller backtrace
+    # * false and nil means do not include caller backtrace
+    # * depth (0-based) means include limited caller backtrace depth
+    #
+    # Example:
+    #
+    #   # File Name: /Users/User/sample_app/lib/sample.rb
+    #   PutsDebuggerer.caller = 3
+    #   pd (x=1)
+    #
+    # Prints out:
+    #
+    #   [PD] /Users/User/sample_app/lib/sample.rb:3
+    #      > pd x=1
+    #     => "1"
+    #        /Users/User/sample_app/lib/master_samples.rb:368:in `block (3 levels) in <top (required)>'
+    #        /Users/User/.rvm/rubies/ruby-2.4.0/lib/ruby/2.4.0/irb/workspace.rb:87:in `eval'
+    #        /Users/User/.rvm/rubies/ruby-2.4.0/lib/ruby/2.4.0/irb/workspace.rb:87:in `evaluate'
+    #        /Users/User/.rvm/rubies/ruby-2.4.0/lib/ruby/2.4.0/irb/context.rb:381:in `evaluate'
+    attr_reader :caller
+
+    def caller=(value)
+      if value.equal?(true)
+        @caller = -1 #needed for upper bound in pd method
+      else
+        @caller = value
+      end
+    end
+
+    def caller?
+      !!caller
+    end
+
+
+    # Options as a hash. Useful for reading and backing up options
+    def options
+      {
+        header: header,
+        footer: footer,
+        print_engine: print_engine,
+        app_path: app_path,
+        announcer: announcer,
+        formatter: formatter,
+        caller: caller
+      }
+    end
+
+    # Sets options included in hash
+    def options=(hash)
+      hash.each do |option, value|
+        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.caller = nil
 
 # Prints object with bonus info such as file name, line number and source
 # expression. Optionally prints out header and footer.
@@ -174,22 +294,15 @@ PutsDebuggerer.announcer = PutsDebuggerer::ANNOUNCER_DEFAULT
 # Example Printout:
 #
 #   [PD] /Users/User/finance_calculator_app/pd_test.rb:3
-#      > ("Show me the source of the bug: #{bug}").inspect
+#      > 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?"
 def pd(object, options=nil)
-  header = PutsDebuggerer.header? ? "#{PutsDebuggerer.header}\n" : ''
-  announcer = PutsDebuggerer.announcer
-  file = __caller_file__(1).sub(PutsDebuggerer.app_path.to_s, '')
-  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)
+  __with_pd_options__(options) do |print_engine_options|
+    formatter_pd_data = __build_pd_data__(object, print_engine_options) #depth adds build method
+    PutsDebuggerer.formatter.call(formatter_pd_data)
   end
-  puts PutsDebuggerer.footer if PutsDebuggerer.footer?
+  nil
 end
 
 
@@ -239,9 +352,15 @@ def __caller_source_line__(caller_depth=0)
   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]
+    f = File.new(source_file)
+    source_line = ''
+    done = false
+    f.each_line do |line|
+      if !done && f.lineno == source_line_number
+        source_line << line
+        done = true if Ripper.sexp_raw(source_line)
+        source_line_number+=1
+      end
     end
   end
   source_line
@@ -249,17 +368,53 @@ end
 
 private
 
-def __caller_pd_expression__(object)
+def __with_pd_options__(options=nil)
+  options ||= {}
+  permanent_options = PutsDebuggerer.options
+  PutsDebuggerer.options = options.select {|option, _| PutsDebuggerer.options.keys.include?(option)}
+  print_engine_options = options.delete_if {|option, _| PutsDebuggerer.options.keys.include?(option)}
+  yield print_engine_options
+  PutsDebuggerer.options = permanent_options
+end
+
+def __build_pd_data__(object, print_engine_options=nil)
+  depth = PutsDebuggerer::CALLER_DEPTH_ZERO
+  pd_data = {
+    announcer: PutsDebuggerer.announcer,
+    file: __caller_file__(depth).sub(PutsDebuggerer.app_path.to_s, ''),
+    line_number: __caller_line_number__(depth),
+    pd_expression: __caller_pd_expression__(depth),
+    object: object,
+    object_printer: lambda do
+      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
+  }
+  if PutsDebuggerer.caller?
+    start_depth = depth.to_i
+    caller_depth = PutsDebuggerer.caller == -1 ? -1 : (start_depth + PutsDebuggerer.caller)
+    pd_data[:caller] = caller[start_depth..caller_depth].to_a
+  end
+  pd_data[:header] = PutsDebuggerer.header if PutsDebuggerer.header?
+  pd_data[:footer] = PutsDebuggerer.footer if PutsDebuggerer.footer?
+  pd_data
+end
+
+def __format_pd_expression__(expression, object)
+  # avoid printing expression if it matches object inspection to prevent redundancy
+  expression == object.inspect.sub("\n$", '') ? "" : "\n   > pd #{expression}\n  =>"
+end
+
+def __caller_pd_expression__(depth=0)
   # Caller Source Line Depth 2 = 1 to pd method + 1 to caller
-  source_line = __caller_source_line__(2)
+  source_line = __caller_source_line__(depth+1)
   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
+  source_line
 end
 
 # Extracts pd source line expression.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-05 00:00:00.000000000 Z
+date: 2017-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -122,8 +122,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
-description: Ruby tools for improved puts debugging, automatically displaying bonus
-  useful information such as line number and source code
+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!
+
+  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.
+
+  Partially inspired (only partially ;) by this blog post:
+  https://tenderlovemaking.com/2016/02/05/i-am-a-puts-debuggerer.html
+  (Credit to Tenderlove.)
 email: andy.am@gmail.com
 executables: []
 extensions: []
@@ -157,5 +165,6 @@ rubyforge_project:
 rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: Ruby tools for improved puts debugging
+summary: Ruby library for improved puts debugging, automatically displaying bonus
+  useful information such as source line number and source code.
 test_files: []