puts_debuggerer 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b80118305f3b8201241cb75a16fab616e1db9789daf829c5b4ea68ad7a6d94d
-  data.tar.gz: dd345085a3bcbf718cdb49983b3c2d1838b1914b231e6fc033ff30ea992fac32
+  metadata.gz: f418876a84bf9553ec518205bad58db7b3abc120f1cd9fcff49e6edd49267247
+  data.tar.gz: 808081fdf435cd30c4d1bb1f6a4f6211068e2ae2d52c039e3f99bbbf77071744
 SHA512:
-  metadata.gz: 1ac9056936792d4f8c46e4ae4114b0911a6442ef5b6ee5a6a1aebd6e405c3abc37466d207f19e94c6eaf9bd58374cd30ab2f66581777b9e37b2f572953c9261a
-  data.tar.gz: 7e0bbb0fcb9c502a252227b74a68a91d39f8ecbbf5cf85a18c4f561dae0a71baa5d258680835c573d2c5f6555e142f1b911f6a3c94302022cbd3a3ac4caeda01
+  metadata.gz: 4e85ad239c06a374f8e8319649cca570af59aae4b828b64e2d4e9e1102af8a41123f8896da3ce8e2ec103d5300c4968493063419a258ed672ee82de05358e3f4
+  data.tar.gz: 2c56e41a7649d11ca7998d86b1682d2b16e59ecf70b94ef71c3672857c03693932d9ef797218fb65c9cfea7563c0df6428bf2e48a1ca4ac2366f38677b6bdfb8

data/CHANGELOG.md

@@ -0,0 +1,63 @@
+# Change Log
+
+## 0.9.0
+
+- Provide partial support for Opal Ruby (missing display of file name, line number, and source code)
+- `source_line_count` option
+- `wraper` option for including both `header` and `footer`
+- Special handling of exceptions (prints using full_message)
+- Change :ap printer default to :p when unavailable
+- Support varargs printing (example: `pd arg1, arg2, arg3`)
+- Display `run_at` run number in printout
+
+## 0.8.2
+
+- require 'stringio' for projects that don't require automatically via other gems
+
+## 0.8.1
+
+- `printer` option support for Rails test environment
+
+## 0.8.0
+
+- `printer` option support
+
+## 0.7.1
+
+- default print engine to :ap (AwesomePrint)
+
+## 0.7.0
+
+- `run_at` option, global and piecemeal.
+
+## 0.6.1
+
+- updated README and broke apart specs
+
+## 0.6.0
+
+- unofficial erb support, returning evaluated object/expression, removed static syntax support (replaced with header support)
+
+## 0.5.1
+
+- support for print engine lambdas and smart defaults for leveraging Rails and AwesomePrint debuggers in Rails
+
+## 0.5.0
+
+- custom formatter, caller backtrace, per-puts piecemeal options, and multi-line support
+
+## 0.4.0
+
+- custom print engine (e.g. ap), custom announcer, and IRB support
+
+## 0.3.0
+
+- header/footer support, multi-line printout, improved format
+
+## 0.2.0
+
+- App path exclusion support, Rails root support, improved format
+
+## 0.1.0
+
+- File/line/expression print out

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017 Andy Maleh
+Copyright (c) 2017-2020 - Andy Maleh
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -130,7 +130,7 @@ pd order_details
 Add the following to bundler's `Gemfile`.
 
 ```ruby
-gem 'puts_debuggerer', '~> 0.8.2'
+gem 'puts_debuggerer', '~> 0.9.0'
 ```
 
 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.
@@ -140,7 +140,7 @@ This is the recommended way for [Rails](rubyonrails.org) apps. Optionally, you m
 Or manually install and require library.
 
 ```bash
-gem install puts_debuggerer -v0.8.2
+gem install puts_debuggerer -v0.9.0
 ```
 
 ```ruby
@@ -331,6 +331,68 @@ Prints out:
 ********************************************************************************
 ```
 
+#### `PutsDebuggerer.wrapper`
+(default = `'*'*80`)
+
+Wrapper to include at the top and bottom of every print out (both header and footer).
+* Default value is `nil`
+* Value `true` enables wrapper as `'*'*80`
+* Value `false`, `nil`, or empty string disables wrapper
+* Any other string value gets set as a custom wrapper
+
+Example:
+
+```ruby
+PutsDebuggerer.wrapper = true
+pd (x=1)
+```
+
+Prints out:
+
+```bash
+********************************************************************************
+[PD] /Users/User/example.rb:2
+   > pd x=1
+  => "1"
+********************************************************************************
+```
+
+#### `PutsDebuggerer.source_line_count`
+(default = `1`)
+
+Example:
+
+```ruby
+pd (true ||
+  false), source_line_count: 2
+```
+
+Prints out:
+
+```
+[PD] /Users/User/example.rb:2
+   > pd (true ||
+       false), source_line_count: 2
+  => "true"
+```
+
+Example:
+
+```ruby
+PutsDebuggerer.source_line_count = 2 # setting via global option
+pd (true ||
+  false)
+```
+
+Prints out:
+
+```
+[PD] /Users/User/example.rb:2
+   > pd (true ||
+       false), source_line_count: 2
+  => "true"
+```
+
 #### `PutsDebuggerer.printer`
 (default = `:puts`)
 
@@ -608,28 +670,26 @@ puts __caller_source_line__
 
 Prints out `puts __caller_source_line__`
 
-## Release Notes
-
-* v0.8.2: require 'stringio' for projects that don't require automatically via other gems
-* v0.8.1: `printer` option support for Rails test environment
-* v0.8.0: `printer` option support
-* v0.7.1: default print engine to :ap (AwesomePrint)
-* v0.7.0: `run_at` option, global and piecemeal.
-* v0.6.1: updated README and broke apart specs
-* v0.6.0: unofficial erb support, returning evaluated object/expression, removed static syntax support (replaced with header support)
-* v0.5.1: support for print engine lambdas and smart defaults for leveraging Rails and AwesomePrint debuggers in Rails
-* 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
+## Compatibility
+
+[puts_debuggerer](https://rubygems.org/gems/puts_debuggerer) is fully compatible with: 
+- [Ruby](https://www.ruby-lang.org/en/)
+- [JRuby](https://www.jruby.org/)
+- IRB
+- Rails Console.
+
+It has partial-compatibility with [Opal Ruby](https://opalrb.com/) with everything working except these features:
+- File name display
+- Line number display
+- Source code call display
+
+## Change Log
+
+[CHANGELOG.md](CHANGELOG.md)
 
 ## TODO
 
-* fix issue with printing in rspec inside a Rails project without having to do extra configuration
-* fix issue with erb support
-* display run_at run number in printout
-* implement fallback in irb for when line number cannot be discovered (issue happens in pry, perhaps this just means support pry)
+[TODO.md](TODO)
 
 ## Contributing
 
@@ -645,5 +705,6 @@ Prints out `puts __caller_source_line__`
 
 ## Copyright
 
-Copyright (c) 2017 Andy Maleh. See LICENSE.txt for
-further details.
+[MIT](LICENSE.txt)
+
+Copyright (c) 2017-2020 - Andy Maleh.

data/VERSION

@@ -1 +1 @@
-0.8.2
+0.9.0

data/lib/puts_debuggerer.rb

@@ -1,9 +1,10 @@
-require 'ripper'
-require 'awesome_print'
+require 'awesome_print' unless RUBY_PLATFORM == 'opal'
 require 'stringio'
 
 module PutsDebuggerer
+  SOURCE_LINE_COUNT_DEFAULT = 1
   HEADER_DEFAULT = '*'*80
+  WRAPPER_DEFAULT = '*'*80
   FOOTER_DEFAULT = '*'*80
   PRINTER_DEFAULT = :puts
   PRINTER_RAILS = lambda do |output|
@@ -15,11 +16,13 @@ module PutsDebuggerer
   PRINT_ENGINE_MESSAGE_INVALID = 'print_engine must be a valid global method symbol (e.g. :p, :ap or :pp) or lambda/proc receiving an object arg'
   ANNOUNCER_DEFAULT = '[PD]'
   FORMATTER_DEFAULT = -> (data) {
+      puts data[:wrapper] if data[:wrapper]
       puts data[:header] if data[:header]
-      print "#{data[:announcer]} #{data[:file]}:#{data[:line_number]}#{__format_pd_expression__(data[:pd_expression], data[:object])} "
+      print "#{data[:announcer]} #{data[:file]}:#{data[:line_number]}#{" (run:#{data[:run_number]})" if data[:run_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]
+      puts data[:wrapper] if data[:wrapper]
     }
   CALLER_DEPTH_ZERO = 4 #depth includes pd + with_options method + nested block + build_pd_data method
   OBJECT_RUN_AT = {}
@@ -46,6 +49,28 @@ module PutsDebuggerer
       @app_path = (path || Rails.root.to_s) rescue nil
     end
 
+    # Source Line Count.
+    # * Default value is `1`
+    #
+    # Example:
+    #
+    #   PutsDebuggerer.source_line_count = 2
+    #   pd (true ||
+    #     false), source_line_count: 2
+    #
+    # Prints out:
+    #
+    #   ********************************************************************************
+    #   [PD] /Users/User/example.rb:2
+    #      > pd (true ||
+    #          false), source_line_count: 2
+    #     => "true"
+    attr_reader :source_line_count
+
+    def source_line_count=(value)
+      @source_line_count = value || SOURCE_LINE_COUNT_DEFAULT
+    end
+
     # Header to include at the top of every print out.
     # * Default value is `nil`
     # * Value `true` enables header as `'*'*80`
@@ -79,6 +104,39 @@ module PutsDebuggerer
       !!@header
     end
 
+    # Wrapper to include at the top and bottom of every print out (both header and footer).
+    # * Default value is `nil`
+    # * Value `true` enables wrapper as `'*'*80`
+    # * Value `false`, `nil`, or empty string disables wrapper
+    # * Any other string value gets set as a custom wrapper
+    #
+    # Example:
+    #
+    #   PutsDebuggerer.wrapper = true
+    #   pd (x=1)
+    #
+    # Prints out:
+    #
+    #   [PD] /Users/User/example.rb:2
+    #      > pd x=1
+    #     => "1"
+    #   ********************************************************************************
+    attr_reader :wrapper
+
+    def wrapper=(value)
+      if value.equal?(true)
+        @wrapper = WRAPPER_DEFAULT
+      elsif value == ''
+        @wrapper = nil
+      else
+        @wrapper = value
+      end
+    end
+
+    def wrapper?
+      !!@wrapper
+    end
+    
     # Footer to include at the bottom of every print out.
     # * Default value is `nil`
     # * Value `true` enables footer as `'*'*80`
@@ -174,7 +232,7 @@ module PutsDebuggerer
 
     def print_engine=(engine)
       if engine.nil?
-        @print_engine = PRINT_ENGINE_DEFAULT
+        @print_engine = Object.const_defined?(:AwesomePrint) ? PRINT_ENGINE_DEFAULT : :p
       elsif engine.is_a?(Proc)
         @print_engine = engine
       else
@@ -206,12 +264,14 @@ module PutsDebuggerer
     # * :announcer (string)
     # * :caller (array)
     # * :file (string)
+    # * :wrapper (string)
     # * :footer (string)
     # * :header (string)
     # * :line_number (string)
     # * :pd_expression (string)
     # * :object (object)
     # * :object_printer (proc)
+    # * :source_line_count (integer)
     #
     # 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
@@ -289,9 +349,11 @@ module PutsDebuggerer
     def options
       {
         header: header,
+        wrapper: wrapper,
         footer: footer,
         printer: printer,
         print_engine: print_engine,
+        source_line_count: source_line_count,
         app_path: app_path,
         announcer: announcer,
         formatter: formatter,
@@ -417,6 +479,7 @@ PutsDebuggerer.formatter = nil
 PutsDebuggerer.app_path = nil
 PutsDebuggerer.caller = nil
 PutsDebuggerer.run_at = nil
+PutsDebuggerer.source_line_count = nil
 
 # Prints object with bonus info such as file name, line number and source
 # expression. Optionally prints out header and footer.
@@ -447,12 +510,15 @@ PutsDebuggerer.run_at = nil
 #      > 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)
+def pd(*objects)
+  options = objects.delete_at(-1) if objects.size > 1 && objects.last.is_a?(Hash)
+  object = objects.compact.size > 1 ? objects : objects.first
   run_at = ((options && options[:run_at]) || PutsDebuggerer.run_at)
 
   if __run_pd__(object, run_at)
     __with_pd_options__(options) do |print_engine_options|
-      formatter_pd_data = __build_pd_data__(object, print_engine_options) #depth adds build method
+      run_number = PutsDebuggerer.run_at_global_number || PutsDebuggerer.run_at_number(object, run_at)
+      formatter_pd_data = __build_pd_data__(object, print_engine_options, PutsDebuggerer.source_line_count, run_number) #depth adds build method
       stdout = $stdout
       $stdout = sio = StringIO.new
       PutsDebuggerer.formatter.call(formatter_pd_data)
@@ -510,7 +576,7 @@ end
 #
 # prints out `3`
 def __caller_line_number__(caller_depth=0)
-  caller[caller_depth][PutsDebuggerer::STACK_TRACE_CALL_LINE_NUMBER_REGEX, 1].to_i
+  caller[caller_depth] && caller[caller_depth][PutsDebuggerer::STACK_TRACE_CALL_LINE_NUMBER_REGEX, 1].to_i
 end
 
 # Provides caller file starting 1 level above caller of
@@ -523,7 +589,7 @@ end
 #
 # prints out `lib/example.rb`
 def __caller_file__(caller_depth=0)
-  caller[caller_depth][PutsDebuggerer::STACK_TRACE_CALL_SOURCE_FILE_REGEX, 1]
+  caller[caller_depth] && caller[caller_depth][PutsDebuggerer::STACK_TRACE_CALL_SOURCE_FILE_REGEX, 1]
 end
 
 
@@ -535,22 +601,28 @@ end
 #   puts __caller_source_line__
 #
 # prints out `puts __caller_source_line__`
-def __caller_source_line__(caller_depth=0, source_file=nil, source_line_number=nil)
+def __caller_source_line__(caller_depth=0, source_line_count=nil, 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
+  source_line = ''
   if source_file == '(irb)'
     source_line = conf.io.line(source_line_number)
   else
     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.include?('%>') #the last condition is for erb support (unofficial)
-        source_line_number+=1
+    if f.respond_to?(:readline) # Opal Ruby Compatibility
+      source_lines = []
+      begin
+        while f.lineno < source_line_number + source_line_count
+          file_line_number = f.lineno + 1
+          file_line = f.readline
+          if file_line_number >= source_line_number && file_line_number < source_line_number + source_line_count
+            source_lines << file_line
+          end
+        end
+      rescue EOFError
+        # Done
       end
+      source_line = source_lines.join(' '*5)
     end
   end
   source_line
@@ -567,16 +639,19 @@ def __with_pd_options__(options=nil)
   PutsDebuggerer.options = permanent_options
 end
 
-def __build_pd_data__(object, print_engine_options=nil)
+def __build_pd_data__(object, print_engine_options=nil, source_line_count=nil, run_number=nil)
   depth = PutsDebuggerer::CALLER_DEPTH_ZERO
   pd_data = {
     announcer: PutsDebuggerer.announcer,
-    file: __caller_file__(depth).sub(PutsDebuggerer.app_path.to_s, ''),
+    file: __caller_file__(depth)&.sub(PutsDebuggerer.app_path.to_s, ''),
     line_number: __caller_line_number__(depth),
-    pd_expression: __caller_pd_expression__(depth),
+    pd_expression: __caller_pd_expression__(depth, source_line_count),
+    run_number: run_number,
     object: object,
     object_printer: lambda do
-      if PutsDebuggerer.print_engine.is_a?(Proc)
+      if object.is_a?(Exception) && object.respond_to?(:full_message)
+        puts object.full_message
+      elsif PutsDebuggerer.print_engine.is_a?(Proc)
         PutsDebuggerer.print_engine.call(object)
       else
         if print_engine_options.to_h.empty?
@@ -593,6 +668,7 @@ def __build_pd_data__(object, print_engine_options=nil)
     pd_data[:caller] = caller[start_depth..caller_depth].to_a
   end
   pd_data[:header] = PutsDebuggerer.header if PutsDebuggerer.header?
+  pd_data[:wrapper] = PutsDebuggerer.wrapper if PutsDebuggerer.wrapper?
   pd_data[:footer] = PutsDebuggerer.footer if PutsDebuggerer.footer?
   pd_data
 end
@@ -601,9 +677,9 @@ def __format_pd_expression__(expression, object)
   "\n   > #{expression}\n  =>"
 end
 
-def __caller_pd_expression__(depth=0)
+def __caller_pd_expression__(depth=0, source_line_count=nil)
   # Caller Source Line Depth 2 = 1 to pd method + 1 to caller
-  source_line = __caller_source_line__(depth+1)
+  source_line = __caller_source_line__(depth+1, source_line_count)
   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?(")")
@@ -618,5 +694,5 @@ end
 #
 # outputs `(x=1)`
 def __extract_pd_expression__(source_line)
-  source_line.strip
+  source_line.to_s.strip
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puts_debuggerer
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-28 00:00:00.000000000 Z
+date: 2020-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -158,9 +158,11 @@ email: andy.am@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - VERSION