debuglog 1.0.0 → 1.0.1

data/etc/example.rb

@@ -0,0 +1,24 @@
+require 'debuglog'
+
+debug "Starting example program"
+x = 6
+trace :x, binding
+trace "ENV['rvm_bin_path']", binding
+
+debug "Environment variables containing PATH"
+keys = ENV.keys.grep /PATH/
+keys.each do |key|
+  trace "  ENV[#{key.inspect}]", binding, 40
+end
+
+debug "(end of list)"
+
+t = time('sleep 3.52') { sleep 3.52 }
+debug "Time actually slept (rounded): #{t}"
+
+debug ""
+debug "Multi-\nline\ntext\n   with an indented (3 spaces) final line"
+debug ""
+debug "Display large array/hash with pp"
+hash = ENV.select { |k,v| k =~ /PATH/ }
+trace :hash, binding

data/lib/debuglog.rb

@@ -1,17 +1,17 @@
-#
-# Usage:
-#
-#   require 'debuglog'
-#   debug "..."        # -> writes "..." to 'debug.log'
-#
-# Note: +debug+ is the _default_ method name.  You can set a different one like
-# this:
-#
-#   require 'debuglog/manual'
-#   DebugLog.configure(...)  # todo: complete
-#   dbg "..."          # -> writes "..." to 'debug.log'
-#
-# If +debug+ (or the name you choose manually) is the name of an existing
-# method, it will _not_ be overwritten.
-
-require 'debuglog/auto'
+#
+# Usage:
+#
+#   require 'debuglog'
+#   debug "..."        # -> writes "..." to 'debug.log'
+#
+# Note: +debug+ is the _default_ method name.  You can set a different one like
+# this:
+#
+#   require 'debuglog/manual'
+#   DebugLog.configure(...)  # todo: complete
+#   dbg "..."          # -> writes "..." to 'debug.log'
+#
+# If +debug+ (or the name you choose manually) is the name of an existing
+# method, it will _not_ be overwritten.
+
+require 'debuglog/auto'

data/lib/debuglog/auto.rb

@@ -1,2 +1,2 @@
-require 'debuglog/manual'
-DebugLog.autoconfigure
+require 'debuglog/manual'
+DebugLog.autoconfigure

data/lib/debuglog/manual.rb

@@ -1,177 +1,177 @@
-#
-# require 'debuglog/manual'
-#
-# DebugLog.configure(:debug => :dbg)
-# dbg "..."         # -> writes "..." to file 'debug.log'
-#
-
-class DebugLog
-
-  @@instance = nil
-
-  DEFAULT_CONFIGURATION = {
-    :debug => :debug,
-    :trace => :trace,
-    :time  => :time,
-    :file  => 'debug.log'
-  }
-
-  class Error < StandardError; end
-
-  def DebugLog.err(string)
-    raise ::DebugLog::Error, "DebugLog error -- #{string}"
-  end
-
-  def DebugLog.configure(hash)
-    if @@instance.nil?
-      @@instance = DebugLog.new(hash)
-    else
-      err("DebugLog already configured")  # todo: replace
-    end
-  end
-
-  def DebugLog.autoconfigure
-    configure(DEFAULT_CONFIGURATION)
-  end
-
-  def initialize(config)
-    @kernel_methods_defined = []
-    _create_kernel_method(config[:debug], :debug)
-    _create_kernel_method(config[:trace], :trace)
-    _create_kernel_method(config[:time],  :time)
-    @filename = config[:filename] || 'debug.log'
-    begin
-      @fh = File.open(@filename, 'w')
-    rescue => e
-      raise DebugLog::Error, "#{e.class} (#{e.message})"
-    end
-    @fh.sync = true
-    @start_time = Time.now
-    header = "DebugLog -- #{@start_time}"
-    @fh.puts header
-    @fh.puts('-' * header.length)
-  end
-
-  def debug(*args)
-    string = args.map { |x| x.to_s }.join
-    _write(string)
-  end
-
-  def trace(expr, _binding, *options)
-    value = eval expr, _binding
-    require 'pp'
-    formatter = :pretty_inspect
-    ##  if (m = options.find { |o| o.is_a? Symbol })
-    ##    case m
-    ##    when :p        then :inspect
-    ##    when :s, :to_s then :to_s
-    ##    when :pp       then (require 'pp'; :pretty_inspect)
-    ##    when :yaml     then (require 'yaml'; :to_yaml)
-    ##    when :ap       then (require 'ap'; :ap)
-    ##    else           then :inspect
-    ##    end
-    ##  else
-    ##    :inspect
-    ##  end
-    value = value.send(formatter)
-    if (n = options.find { |o| o.is_a? Integer })
-      value = value[0...n] + "..."
-    end
-    message =
-      if value.index("\n")
-        value = value.gsub(/^/, '  ')
-        "#{expr} ==\n#{value}"
-      else
-        "#{expr} == #{value}"
-      end
-    _write(message)
-  end
-
-  def time(task, &block)
-    result = nil
-    message =
-      if block.nil?
-        "*** Debuglog.task: block required (#{caller[0]}) ***"
-      else
-        t = Time.now
-        result = block.call
-        t = sprintf "%.3f", (Time.now - t)
-        "#{task}: #{t} sec"
-      end
-    _write(message)
-    result
-  end
-
-  def _write(message)
-    time = (Time.now - @start_time)
-    if time.to_i != @time.to_i
-      elapsed = time.to_i - @time.to_i
-      if elapsed > 1
-        @fh.puts "------- (#{elapsed} sec)"
-      else
-        @fh.puts "-------"
-      end
-    end
-    @time = time
-    time = sprintf "%04.1f", time.to_f
-    if message.index("\n")
-      lines = message.split("\n")
-      @fh.puts "[#{time}] #{lines.shift}"
-      indent = " " * (time.size+3)
-      lines.each do |line| @fh.puts "#{indent}#{line}" end
-    else
-      text = "[#{time}] #{message}"
-      @fh.puts(text)
-    end
-  end
-
-  def _create_kernel_method(name, target)
-    if name.nil?
-      return 
-    elsif Kernel.respond_to? name
-      DebugLog.err "DebugLog: Method clash in Kernel: #{name.inspect}"
-    else
-      Kernel.module_eval %{
-        def #{name}(*args, &block)
-          DebugLog.call_method(:#{target}, *args, &block)
-        end
-      }, __FILE__, __LINE__ - 4
-      @kernel_methods_defined << name
-    end
-  end
-
-  DEBUG_METHODS = [:debug, :trace, :time]
-  def DebugLog.call_method(name, *args, &block)
-    if DEBUG_METHODS.include? name
-      if @@instance
-        @@instance.send(name, *args, &block)
-      else
-        err %{
-          ~ DebugLog is not configured.  You can:
-          ~   * require 'debuglog/auto' or call DebugLog.autoconfigure; or
-          ~   * call DebugLog.configure(...) to configure it manually
-        }.strip.gsub(/^\s+~ /, '')
-      end
-    else
-      err "illegitimate method called: #{name}"
-    end
-  end
-
-  def terminate   # For testing
-    @fh.close unless @fh.closed?
-    @kernel_methods_defined.each do |m|
-      Kernel.send(:remove_method, m)
-    end
-  end
-  private :terminate
-
-  def DebugLog.wipe_slate_clean_for_testing
-    if @@instance
-      @@instance.send(:terminate)
-      @@instance = nil
-    end
-  end
-
-end  # class DebugLog
-
-Debuglog = DebugLog
+#
+# require 'debuglog/manual'
+#
+# DebugLog.configure(:debug => :dbg)
+# dbg "..."         # -> writes "..." to file 'debug.log'
+#
+
+class DebugLog
+
+  @@instance = nil
+
+  DEFAULT_CONFIGURATION = {
+    :debug => :debug,
+    :trace => :trace,
+    :time  => :time,
+    :file  => 'debug.log'
+  }
+
+  class Error < StandardError; end
+
+  def DebugLog.err(string)
+    raise ::DebugLog::Error, "DebugLog error -- #{string}"
+  end
+
+  def DebugLog.configure(hash)
+    if @@instance.nil?
+      @@instance = DebugLog.new(hash)
+    else
+      err("DebugLog already configured")  # todo: replace
+    end
+  end
+
+  def DebugLog.autoconfigure
+    configure(DEFAULT_CONFIGURATION)
+  end
+
+  def initialize(config)
+    @kernel_methods_defined = []
+    _create_kernel_method(config[:debug], :debug)
+    _create_kernel_method(config[:trace], :trace)
+    _create_kernel_method(config[:time],  :time)
+    @filename = config[:filename] || 'debug.log'
+    begin
+      @fh = File.open(@filename, 'w')
+    rescue => e
+      raise DebugLog::Error, "#{e.class} (#{e.message})"
+    end
+    @fh.sync = true
+    @start_time = Time.now
+    header = "DebugLog -- #{@start_time}"
+    @fh.puts header
+    @fh.puts('-' * header.length)
+  end
+
+  def debug(*args)
+    string = args.map { |x| x.to_s }.join
+    _write(string)
+  end
+
+  def trace(expr, _binding, *options)
+    value = eval expr.to_s, _binding
+    require 'pp'
+    formatter = :pretty_inspect
+    ##  if (m = options.find { |o| o.is_a? Symbol })
+    ##    case m
+    ##    when :p        then :inspect
+    ##    when :s, :to_s then :to_s
+    ##    when :pp       then (require 'pp'; :pretty_inspect)
+    ##    when :yaml     then (require 'yaml'; :to_yaml)
+    ##    when :ap       then (require 'ap'; :ap)
+    ##    else           then :inspect
+    ##    end
+    ##  else
+    ##    :inspect
+    ##  end
+    value = value.send(formatter).strip
+    if (n = options.find { |o| o.is_a? Integer })
+      value = value[0...n] + "..." if value.length > n
+    end
+    message =
+      if value.index("\n")
+        value = value.gsub(/^/, '  ')
+        "#{expr} ==\n#{value}"
+      else
+        "#{expr} == #{value}"
+      end
+    _write(message)
+  end
+
+  def time(task, &block)
+    result = nil
+    message =
+      if block.nil?
+        "*** Debuglog.task: block required (#{caller[0]}) ***"
+      else
+        t = Time.now
+        result = block.call
+        t = sprintf "%.3f", (Time.now - t)
+        "#{task}: #{t} sec"
+      end
+    _write(message)
+    result
+  end
+
+  def _write(message)
+    time = (Time.now - @start_time)
+    if time.to_i != @time.to_i
+      elapsed = time.to_i - @time.to_i
+      if elapsed > 1
+        @fh.puts "------- (#{elapsed} sec)"
+      else
+        @fh.puts "-------"
+      end
+    end
+    @time = time
+    time = sprintf "%04.1f", time.to_f
+    if message.index("\n")
+      lines = message.split("\n")
+      @fh.puts "[#{time}] #{lines.shift}"
+      indent = " " * (time.size+3)
+      lines.each do |line| @fh.puts "#{indent}#{line}" end
+    else
+      text = "[#{time}] #{message}"
+      @fh.puts(text)
+    end
+  end
+
+  def _create_kernel_method(name, target)
+    if name.nil?
+      return 
+    elsif Kernel.respond_to? name
+      DebugLog.err "DebugLog: Method clash in Kernel: #{name.inspect}"
+    else
+      Kernel.module_eval %{
+        def #{name}(*args, &block)
+          DebugLog.call_method(:#{target}, *args, &block)
+        end
+      }, __FILE__, __LINE__ - 4
+      @kernel_methods_defined << name
+    end
+  end
+
+  DEBUG_METHODS = [:debug, :trace, :time]
+  def DebugLog.call_method(name, *args, &block)
+    if DEBUG_METHODS.include? name
+      if @@instance
+        @@instance.send(name, *args, &block)
+      else
+        err %{
+          ~ DebugLog is not configured.  You can:
+          ~   * require 'debuglog/auto' or call DebugLog.autoconfigure; or
+          ~   * call DebugLog.configure(...) to configure it manually
+        }.strip.gsub(/^\s+~ /, '')
+      end
+    else
+      err "illegitimate method called: #{name}"
+    end
+  end
+
+  def terminate   # For testing
+    @fh.close unless @fh.closed?
+    @kernel_methods_defined.each do |m|
+      Kernel.send(:remove_method, m)
+    end
+  end
+  private :terminate
+
+  def DebugLog.wipe_slate_clean_for_testing
+    if @@instance
+      @@instance.send(:terminate)
+      @@instance = nil
+    end
+  end
+
+end  # class DebugLog
+
+Debuglog = DebugLog

data/lib/debuglog/version.rb

@@ -0,0 +1,3 @@
+module DebugLog
+  VERSION = "1.0.1"
+end

data/test/_setup.rb

@@ -1,14 +1,13 @@
-require 'debuglog'
-require 'ruby-debug'
-
-Attest.custom :debuglog, {
-  :description => "Last line of log file",
-  :parameters  => [ [:regex, Regexp], [:filename, String] ],
-  :run => proc {
-    file_data = File.read(filename)
-    test('file exists') { N! file_data }
-    test('file has data in it') { file_data.size > 0 }
-    last_line = file_data.split("\n").last
-    test('match') { Mt last_line, regex }
-  }
-}
+require 'debuglog'
+
+Whitestone.custom :debuglog, {
+  :description => "Last line of log file",
+  :parameters  => [ [:regex, Regexp], [:filename, String] ],
+  :run => proc {
+    file_data = File.read(filename)
+    test('file exists') { N! file_data }
+    test('file has data in it') { file_data.size > 0 }
+    last_line = file_data.split("\n").last
+    test('match') { Mt last_line, regex }
+  }
+}