puts_debuggerer 0.9.0 → 0.12.0

data/VERSION

@@ -1 +1 @@
-0.9.0
+0.12.0

data/lib/pd.rb

@@ -0,0 +1 @@
+require 'puts_debuggerer'

data/lib/puts_debuggerer.rb

@@ -1,33 +1,69 @@
-require 'awesome_print' unless RUBY_PLATFORM == 'opal'
-require 'stringio'
+require 'puts_debuggerer/core_ext/kernel'
+require 'puts_debuggerer/core_ext/logger'
+require 'puts_debuggerer/core_ext/logging/logger'
+require 'puts_debuggerer/run_determiner'
+require 'puts_debuggerer/source_file'
 
 module PutsDebuggerer
   SOURCE_LINE_COUNT_DEFAULT = 1
-  HEADER_DEFAULT = '*'*80
+  HEADER_DEFAULT = '>'*80
   WRAPPER_DEFAULT = '*'*80
-  FOOTER_DEFAULT = '*'*80
+  FOOTER_DEFAULT = '<'*80
+  LOGGER_FORMATTER_DECORATOR = proc { |original_formatter|
+    proc { |severity, datetime, progname, msg|
+      original_formatter.call(severity, datetime, progname, msg.pd_inspect)
+    }
+  }
+  LOGGING_LAYOUT_DECORATOR = proc {|original_layout|
+    original_layout.clone.tap do |layout|
+      layout.singleton_class.class_eval do
+        alias original_format_obj format_obj
+        def format_obj(obj)
+          obj.pdi # alias to pd_inspect
+        end
+      end
+    end
+  }
+  RETURN_DEFAULT = true
+  OBJECT_PRINTER_DEFAULT = lambda do |object, print_engine_options=nil, source_line_count=nil, run_number=nil|
+    lambda do
+      if object.is_a?(Exception)
+        if RUBY_ENGINE == 'opal'
+          object.backtrace.each { |line| puts line }
+        else
+          puts object.full_message
+        end
+      elsif PutsDebuggerer.print_engine.is_a?(Proc)
+        PutsDebuggerer.print_engine.call(object)
+      else
+        send(PutsDebuggerer.print_engine, object)
+      end
+    end
+  end
   PRINTER_DEFAULT = :puts
   PRINTER_RAILS = lambda do |output|
     puts output if Rails.env.test?
     Rails.logger.debug(output)
   end
   PRINT_ENGINE_DEFAULT = :ap
-  PRINTER_MESSAGE_INVALID = 'printer must be a valid global method symbol (e.g. :puts) or lambda/proc receiving a text arg'
+  PRINTER_MESSAGE_INVALID = 'printer must be a valid global method symbol (e.g. :puts), a logger, or a lambda/proc receiving a text arg'
   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]}#{" (run:#{data[:run_number]})" if data[:run_number]}#{__format_pd_expression__(data[:pd_expression], data[:object])} "
+      print "#{data[:announcer]} #{data[:file]}#{':' if data[:line_number]}#{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 = {}
+  CALLER_DEPTH_ZERO_OPAL = -1 #depth includes pd + with_options method + nested block + build_pd_data method
   STACK_TRACE_CALL_LINE_NUMBER_REGEX = /\:(\d+)\:in /
   STACK_TRACE_CALL_SOURCE_FILE_REGEX = /[ ]*([^:]+)\:\d+\:in /
+  STACK_TRACE_CALL_SOURCE_FILE_REGEX_OPAL = /(http[^\)]+)/
+  OPTIONS = [:app_path, :source_line_count, :header, :wrapper, :footer, :printer, :print_engine, :announcer, :formatter, :caller, :run_at]
 
   class << self
     # Application root path to exclude when printing out file path
@@ -90,20 +126,6 @@ module PutsDebuggerer
     #     => "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
-
     # 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`
@@ -123,20 +145,6 @@ module PutsDebuggerer
     #   ********************************************************************************
     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`
@@ -155,24 +163,27 @@ module PutsDebuggerer
     #     => "1"
     #   ********************************************************************************
     attr_reader :footer
-
-    def footer=(value)
-      if value.equal?(true)
-        @footer = FOOTER_DEFAULT
-      elsif value == ''
-        @footer = nil
-      else
-        @footer = value
+    
+    ['header', 'footer', 'wrapper'].each do |boundary_option|
+      define_method("#{boundary_option}=") do |value|
+        if value.equal?(true)
+          instance_variable_set(:"@#{boundary_option}", const_get(:"#{boundary_option.upcase}_DEFAULT"))
+        elsif value == ''
+          instance_variable_set(:"@#{boundary_option}", nil)
+        else
+          instance_variable_set(:"@#{boundary_option}", value)
+        end
+      end
+      
+      define_method("#{boundary_option}?") do
+        !!instance_variable_get(:"@#{boundary_option}")
       end
     end
 
-    def footer?
-      !!@footer
-    end
-
-    # Printer is a global method symbol or lambda expression to use in printing to the user.
-    # Examples of global methods are `:puts` and `:print`.
+    # Printer is a global method symbol, lambda expression, or logger to use in printing to the user.
+    # Examples of a global method are `:puts` and `:print`.
     # An example of a lambda expression is `lambda {|output| Rails.logger.ap(output)}`
+    # Examples of a logger are a Ruby `Logger` instance or `Logging::Logger` instance
     #
     # Defaults to `:puts`
     # In Rails, it defaults to: `lambda {|output| Rails.logger.ap(output)}`
@@ -193,17 +204,37 @@ module PutsDebuggerer
 
     def printer=(printer)
       if printer.nil?
-        if Object.const_defined?(:Rails)
-          @printer = PRINTER_RAILS
-        else
-          @printer = PRINTER_DEFAULT
+        @printer = printer_default
+      elsif printer.is_a?(Logger)
+        @printer = printer
+        @logger_original_formatter = printer.formatter || Logger::Formatter.new
+        printer.formatter = LOGGER_FORMATTER_DECORATOR.call(@logger_original_formatter)
+      elsif printer.is_a?(Logging::Logger)
+        @printer = printer
+        @logging_original_layouts = printer.appenders.reduce({}) do |hash, appender|
+          hash.merge(appender => appender.layout)
         end
-      elsif printer.is_a?(Proc)
+        printer.appenders.each do |appender|
+          appender.layout = LOGGING_LAYOUT_DECORATOR.call(appender.layout)
+        end
+      elsif printer == false || printer.is_a?(Proc) || printer.respond_to?(:log) # a logger
         @printer = printer
       else
         @printer = method(printer).name rescue raise(PRINTER_MESSAGE_INVALID)
       end
     end
+    
+    def printer_default
+      Object.const_defined?(:Rails) ? PRINTER_RAILS : PRINTER_DEFAULT
+    end
+    
+    # Logger original formatter before it was decorated with PutsDebuggerer::LOGGER_FORMATTER_DECORATOR
+    # upon setting the logger as a printer.
+    attr_reader :logger_original_formatter
+    
+    # Logging library original layouts before being decorated with PutsDebuggerer::LOGGING_LAYOUT_DECORATOR
+    # upon setting the Logging library logger as a printer.
+    attr_reader :logging_original_layouts
 
     # Print engine is similar to `printer`, except it is focused on the scope of formatting
     # the data object being printed (excluding metadata such as file name, line number,
@@ -228,17 +259,25 @@ module PutsDebuggerer
     #      > pd array
     #     => [1, [2, 3]]
     #   ]
-    attr_reader :print_engine
+    def print_engine
+      if @print_engine.nil?
+        require 'awesome_print' if RUBY_ENGINE != 'opal'
+        @print_engine = print_engine_default
+      end
+      @print_engine
+    end
 
     def print_engine=(engine)
-      if engine.nil?
-        @print_engine = Object.const_defined?(:AwesomePrint) ? PRINT_ENGINE_DEFAULT : :p
-      elsif engine.is_a?(Proc)
+      if engine.is_a?(Proc) || engine.nil?
         @print_engine = engine
       else
         @print_engine = method(engine).name rescue raise(PRINT_ENGINE_MESSAGE_INVALID)
       end
     end
+    
+    def print_engine_default
+      Object.const_defined?(:AwesomePrint) ? PRINT_ENGINE_DEFAULT : :p
+    end
 
     # Announcer (e.g. [PD]) to announce every print out with (default: "[PD]")
     #
@@ -430,44 +469,32 @@ module PutsDebuggerer
       !!@run_at
     end
 
-    attr_reader :run_at_global_number
-
-    def run_at_global_number=(value)
-      @run_at_global_number = value
-    end
-
-    def init_run_at_global_number
-      @run_at_global_number = 1
-    end
-
-    def increment_run_at_global_number
-      @run_at_global_number += 1
-    end
-
-    def reset_run_at_global_number
-      @run_at_global_number = nil
-    end
-
-    def run_at_number(object, run_at)
-      PutsDebuggerer::OBJECT_RUN_AT[[object,run_at]]
-    end
-
-    def init_run_at_number(object, run_at)
-      PutsDebuggerer::OBJECT_RUN_AT[[object,run_at]] = 1
+    def determine_options(objects)
+      if objects.size > 1 && objects.last.is_a?(Hash)
+        objects.delete_at(-1)
+      elsif objects.size == 1 && objects.first.is_a?(Hash)
+        hash = objects.first
+        hash.slice(*OPTIONS).tap do
+          hash.delete_if {|option| OPTIONS.include?(option)}
+        end
+      end
     end
 
-    def increment_run_at_number(object, run_at)
-      PutsDebuggerer::OBJECT_RUN_AT[[object,run_at]] += 1
+    def determine_object(objects)
+      objects.compact.size > 1 ? objects : objects.first
     end
 
-    def reset_run_at_number(object, run_at)
-      PutsDebuggerer::OBJECT_RUN_AT.delete([object, run_at])
+    def determine_run_at(options)
+      ((options && options[:run_at]) || PutsDebuggerer.run_at)
     end
 
-    def reset_run_at_numbers
-      PutsDebuggerer::OBJECT_RUN_AT.clear
+    def determine_printer(options)
+      if options && options.has_key?(:printer)
+        options[:printer]
+      else
+        PutsDebuggerer.printer
+      end
     end
-
   end
 end
 
@@ -480,219 +507,3 @@ 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.
-# 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
-#      > 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(*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|
-      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)
-      $stdout = stdout
-      if PutsDebuggerer.printer.is_a?(Proc)
-        PutsDebuggerer.printer.call(sio.string)
-      else
-        send(PutsDebuggerer.send(:printer), sio.string)
-      end
-    end
-  end
-
-  object
-end
-
-def __run_pd__(object, run_at)
-  run_pd = false
-  if run_at.nil?
-    run_pd = true
-  else
-    if PutsDebuggerer.run_at?
-      if PutsDebuggerer.run_at_global_number.nil?
-        PutsDebuggerer.init_run_at_global_number
-      else
-        PutsDebuggerer.increment_run_at_global_number
-      end
-      run_number = PutsDebuggerer.run_at_global_number
-    else
-      if PutsDebuggerer.run_at_number(object, run_at).nil?
-        PutsDebuggerer.init_run_at_number(object, run_at)
-      else
-        PutsDebuggerer.increment_run_at_number(object, run_at)
-      end
-      run_number = PutsDebuggerer.run_at_number(object, run_at)
-    end
-    if run_at.is_a?(Integer)
-      run_pd = true if run_at == run_number
-    elsif run_at.is_a?(Array)
-      run_pd = true if run_at.include?(run_number)
-    elsif run_at.is_a?(Range)
-      run_pd = true if run_at.cover?(run_number) || (run_at.end == -1 && run_number >= run_at.begin)
-    end
-  end
-  run_pd
-end
-
-# Provides caller line number starting 1 level above caller of
-# this method.
-#
-# Example:
-#
-#   # 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] && caller[caller_depth][PutsDebuggerer::STACK_TRACE_CALL_LINE_NUMBER_REGEX, 1].to_i
-end
-
-# Provides caller file starting 1 level above caller of
-# this method.
-#
-# Example:
-#
-#   # File Name: lib/example.rb
-#   puts __caller_file__
-#
-# prints out `lib/example.rb`
-def __caller_file__(caller_depth=0)
-  caller[caller_depth] && caller[caller_depth][PutsDebuggerer::STACK_TRACE_CALL_SOURCE_FILE_REGEX, 1]
-end
-
-
-# Provides caller source line starting 1 level above caller of
-# this method.
-#
-# Example:
-#
-#   puts __caller_source_line__
-#
-# prints out `puts __caller_source_line__`
-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 = ''
-  if source_file == '(irb)'
-    source_line = conf.io.line(source_line_number)
-  else
-    f = File.new(source_file)
-    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
-end
-
-private
-
-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, 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, ''),
-    line_number: __caller_line_number__(depth),
-    pd_expression: __caller_pd_expression__(depth, source_line_count),
-    run_number: run_number,
-    object: object,
-    object_printer: lambda do
-      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?
-          send(PutsDebuggerer.print_engine, object)
-        else
-          send(PutsDebuggerer.print_engine, object, print_engine_options) rescue send(PutsDebuggerer.print_engine, object)
-        end
-      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[:wrapper] = PutsDebuggerer.wrapper if PutsDebuggerer.wrapper?
-  pd_data[:footer] = PutsDebuggerer.footer if PutsDebuggerer.footer?
-  pd_data
-end
-
-def __format_pd_expression__(expression, object)
-  "\n   > #{expression}\n  =>"
-end
-
-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_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?(")")
-  source_line
-end
-
-# Extracts pd source line expression.
-#
-# Example:
-#
-# __extract_pd_expression__("pd (x=1)")
-#
-# outputs `(x=1)`
-def __extract_pd_expression__(source_line)
-  source_line.to_s.strip
-end