k_log 0.0.27 → 0.0.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2035ee429ccfbb7cd0307d243e9b8bd303f44444d1b356c28ad079bc8219de8f
-  data.tar.gz: c7eeff9ee82d1514859052d264cfcb06216ad939f3c215c34dfee6f64ef0d21f
+  metadata.gz: 0fa223a72a5c70dcb1c311f1da3c1e5f370c64847942a2e4e8dccf3abff05fd1
+  data.tar.gz: ab980569c01e1c99a99c157623f92a75d08a6af82163d929130f8bc1080658b2
 SHA512:
-  metadata.gz: f12d2c0fae01798339647d3905fefe8e5e63049d074965c04b878e3ba4df7b8571cba637877395f8fa033d2c780d53bfc4aaa2da605af647908fdb7e29bd1e3a
-  data.tar.gz: 3d780ecca23bac05227ff96629c464f3ecf2ed61f908a6f28145e9b00786fae625e37d751210ccaaf03d613e1683bbfbb15cf009d35e57909ac3110488b34b0f
+  metadata.gz: f1fe198aee1f8dab3e7fad5676eb209abb8e034162b26a52edc36c107dfc7606f1db5f18bbbafa8eaf120499ebc18cea302eac8aa6acadd3f2debf01dc23c1fd
+  data.tar.gz: 62f28c9a49847aaec1896759ff3ab0d9c367e84ff67c4ef80baa018d32bd25ac0cc9e4c30704d3aba9a660b38443ced2e4f6ba4418e065e6adc8d68853a3c177

data/lib/k_log/examples.rb

@@ -91,6 +91,16 @@ module KLog
       rescue StandardError => e
         log.exception(e)
       end
+      begin
+        raise 'Here is an error'
+      rescue StandardError => e
+        log.exception(e, style: :message)
+      end
+      begin
+        raise 'Here is an error'
+      rescue StandardError => e
+        log.exception(e, style: :short)
+      end
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 

data/lib/k_log/log_formatter.rb

@@ -20,8 +20,10 @@ module KLog
 
       msg = msg.is_a?(String) ? msg : msg.inspect
 
+      # "%<time>s %<severity>s %<message>s\n", {
+
       format(
-        "%<time>s %<severity>s %<message>s\n", {
+        "%<severity>s %<message>s\n", {
           time: Time.now.strftime('%d|%H:%M:%S'),
           severity: severity_value,
           message: msg

data/lib/k_log/log_structure.rb

@@ -11,6 +11,8 @@ module KLog
     attr_reader :heading
     attr_reader :heading_type
     attr_reader :line_width
+    attr_reader :key_width
+    attr_reader :show_array_count
     attr_reader :graph
     attr_reader :formatter
     attr_reader :convert_data_to
@@ -32,7 +34,9 @@ module KLog
     # @option opts [String] :heading Log heading using logger.dynamic_heading
     # @option opts [String] :heading_type :heading, :subheading, :section_heading
     # @option opts [String] :line_width line width defaults to 80, but can be overridden here
+    # @option opts [String] :key_width key width defaults to 30, but can be overridden here
     # @option opts [String] :formatter is a complex configuration for formatting different data within the structure
+    # @option opts [Symbol] :convert_data_to (:raw, open_struct)
     def initialize(opts)
       @indent           = opts[:indent] || '  '
       @title            = opts[:title]
@@ -48,6 +52,8 @@ module KLog
       @convert_data_to  = opts[:convert_data_to]    || :raw # by default leave data as is
 
       @line_width       = opts[:line_width]         || 80
+      @key_width        = opts[:key_width]          || 30
+      @show_array_count = opts[:show_array_count]   || false
       @output_as        = opts[:output_as]          || [:console]
       @output_as        = [@output_as]              unless @output_as.is_a?(Array)
       @output_file      = opts[:output_file]
@@ -102,12 +108,19 @@ module KLog
 
     # format_config = @formatter[:_root] if format_config.nil? && @recursion_depth.zero?
 
+    def data_enumerator(data)
+      return data.attributes if data.respond_to?(:attributes)
+
+      data
+    end
+
     def log_data(data)
-      data.each_pair do |k, v|
+      data_enumerator(data).each_pair do |k, v|
         key = k.is_a?(String) ? k.to_sym : k
 
         graph_path.push(key)
-        @graph_node = GraphNode.for(graph, graph_path)
+        @graph_node = GraphNode.for(self, graph, graph_path)
+        # @graph_node.debug
         # l.kv 'key', "#{key.to_s.ljust(15)}#{graph_node.skip?.to_s.ljust(6)}#{@recursion_depth}"
 
         if graph_node.skip?
@@ -116,21 +129,26 @@ module KLog
           next
         end
 
+        # xxxx.pry if graph_node.pry_at?(:before_value) # 'puts xmen'
+
         value = graph_node.transform? ? graph_node.transform(v) : v
 
-        case value
-        when OpenStruct
+        # xxxx.pry if graph_node.pry_at?(:after_value) # 'puts xmen'
+        if value.is_a?(OpenStruct) || value.respond_to?(:attributes)
+
           # l.kv 'go', 'open struct ->'
+          # xxxx.pry if graph_node.pry_at?(:before_structure) # 'puts xmen'
           log_structure(key, value)
           # l.kv 'go', 'open struct <-'
-        when Array
+        elsif value.is_a?(Array)
           # l.kv 'go', 'array ->'
           log_array(key, value)
           # l.kv 'go', 'array <-'
         else
           # l.kv 'go', 'value ->'
+          # xxxx.pry if graph_node.pry_at?(:before_kv) # 'puts xmen'
           log_heading(graph_node.heading, graph_node.heading_type) if graph_node.heading
-          add_line KLog::LogHelper.kv "#{@indent_label}#{key}", value
+          add_line KLog::LogHelper.kv("#{@indent_label}#{key}", value, key_width)
           # l.kv 'go', 'value <-'
         end
 
@@ -155,13 +173,15 @@ module KLog
     end
 
     def log_array(key, array)
-      # return if items.length.zero? && graph_node.skip_empty?
+      # xxxx.pry if graph_node.pry_at?(:before_array) # 'puts xmen'
 
       items = array.clone
       items.select! { |item| graph_node.filter(item) }  if graph_node.filter?
       items = items.take(graph_node.take)               if graph_node.limited?
       items.sort!(&graph_node.sort)                     if graph_node.sort?
 
+      # xxxx.pry if graph_node.pry_at?(:before_array_print) # 'puts xmen'
+
       return if items.length.zero? && graph_node.skip_empty?
 
       log_heading(graph_node.heading, graph_node.heading_type) if graph_node.heading
@@ -170,9 +190,12 @@ module KLog
         add_line KLog::LogHelper.kv "#{@indent_label}#{key}", items.map(&:to_s).join(', ')
       else
         table_print items, tp_columns(items)
+
+        # NEED SUPPORT FOR A configured ARRAY COUNT with width and label
+        add_line KLog::LogHelper.kv key.to_s, items.count if show_array_count
       end
-    rescue StandardError
-      #
+    rescue StandardError => e
+      KLog.logger.exception(e)
     end
 
     def table_print(items, columns)
@@ -228,6 +251,7 @@ module KLog
     def render_output
       puts content                            if output_as.include?(:console)
       File.write(output_file, clean_content)  if output_as.include?(:file) && output_file
+      # content
     end
 
     # convert_data_to: :open_struct
@@ -304,6 +328,7 @@ module KLog
     end
 
     class GraphNode
+      attr_reader   :log_structure
       attr_accessor :config
 
       class << self
@@ -311,7 +336,7 @@ module KLog
           @null ||= OpenStruct.new
         end
 
-        def for(graph, graph_path)
+        def for(log_structure, graph, graph_path)
           # node_config = graph_path.inject(graph, :send) # (uses deep nesting, but fails when nil is returned) https://stackoverflow.com/questions/15862455/ruby-nested-send
           # node.nil? ? null : node.send(name) || null
           node_config = graph_path.reduce(graph) do |node, name|
@@ -321,12 +346,14 @@ module KLog
 
             result
           end
+          # puts node_config
 
-          new(node_config)
+          new(log_structure, node_config)
         end
       end
 
-      def initialize(config)
+      def initialize(log_structure, config)
+        @log_structure = log_structure
         @config = config || OpenStruct.new
       end
 
@@ -390,10 +417,38 @@ module KLog
         config.skip == true
       end
 
+      # Useful in complex debug scenarios
+      def pry_at
+        config.pry_at || []
+      end
+
+      def pry_at?(section)
+        pry_at.include?(section)
+      end
+
       # Skip empty array node (my be useful for other nodes, but not yet)
       def skip_empty?
         config.skip_empty == true
       end
+
+      def show_array_count
+        log_structure.show_array_count
+      end
+  
+      def debug
+        l = KLog::LogUtil.new(KLog.logger)
+        l.kv('columns', columns) if columns
+        l.kv('heading', heading) if heading
+        l.kv('heading_type', heading_type) if heading_type
+        l.kv('filter?', filter?)
+        l.kv('take', take)
+        l.kv('limited?', limited?)
+        l.kv('sort?', sort?)
+        l.kv('sort', sort)
+        l.kv('skip?', skip?)
+        l.kv('pry_at', pry_at)
+        l.kv('skip_empty?', skip_empty?)
+      end
     end
   end
 end

data/lib/k_log/log_util.rb

@@ -148,7 +148,7 @@ module KLog
     # @option opts [String] :heading_type :heading, :subheading, :section_heading
     # @option opts [Boolean] :skip_array Arrays items can be skipped
     def structure(data, **opts)
-      structure = LogStructure.new(**opts)
+      structure = LogStructure.new(opts)
       structure.log(data)
     end
 
@@ -195,14 +195,31 @@ module KLog
     alias ostruct open_struct
     alias o open_struct
 
-    def exception(exception)
-      line
+    # Examples
+    # log.exception(e)
+    # log.exception(e, style: :message)
+    # log.exception(e, style: :short)
+    def exception(exception, style: :long, method_info: nil)
+      line unless style == :message
+
+      @logger.error(KLog::LogHelper.bg_red(exception.message))
+      @logger.info([method_info.owner.name, method_info.name].join('#')) if method_info
+
+      case style
+      when :short
+        trace_items = exception.backtrace.select { |row| row.start_with?(Dir.pwd) }
+      when :long
+        trace_items = exception.backtrace
+      else
+        trace_items = []  
+      end
 
-      @logger.info(KLog::LogHelper.bg_red(exception.message))
 
-      @logger.info(KLog::LogHelper.yellow(exception.backtrace.map { |row| row.start_with?(Dir.pwd) ? KLog::LogHelper.yellow(row) : KLog::LogHelper.red(row) }.join("\n")))
+      trace_items = trace_items.map { |row| row.start_with?(Dir.pwd) ? KLog::LogHelper.yellow(row) : KLog::LogHelper.red(row) }
 
-      line
+      @logger.info(KLog::LogHelper.yellow(trace_items.join("\n"))) if trace_items.length.positive?
+
+      line unless style == :message
     end
 
     #----------------------------------------------------------------------------------------------------

data/lib/k_log/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KLog
-  VERSION = '0.0.27'
+  VERSION = '0.0.32'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_log
 version: !ruby/object:Gem::Version
-  version: 0.0.27
+  version: 0.0.32
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-29 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_util