k_log 0.0.13 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87495f9dbb82ab9af517ee962042df71740f8bf223f8d9935098c28c017379e5
-  data.tar.gz: d63f3c5ba3af1088ef434bbd2677771304ddbff857aafe63ca64f0b053fbd631
+  metadata.gz: 785e24f33c830f5aa042dafcf83f188a097b8cf5060598f690245a71646726d2
+  data.tar.gz: 0d78f522bc72498a30c6eb04e845ff51a346228378ffd78ae38767cb5f2b3abc
 SHA512:
-  metadata.gz: d612388ab6ed66d80750e91936a7311f6cb2d3b643499ca3297856cdf3cad72b2640affe34c5e75cd364d99537640b40b6dc16cb5edf0e89a51d8e9aa8c0c652
-  data.tar.gz: 7ebcbf83cfa5b0a48fdab4d879d0aa3a9ed6887f4e01c9109b0d91b9fa916d96ed49407c5e33eeb1f1840f5c6ea3577839165fac8029c3830feccc0a17f0e902
+  metadata.gz: 00c9050b591c246589a74a257a1c7b243eff8b0ef23a94652480d33bf713fd2f9bef5ac33f6f7c9e2784ab6d951405d04d57feaf2d3e8625667f443ea8b58f6a
+  data.tar.gz: 03676ef5279a6dc4c498ef4dd7c0d77bcb1f39eee93295cc58e3913a1e484809f85f1e7bc68a87b0683d428504e5ccfc5daf81b2861315777e3586d6b9b0d263

data/.rubocop.yml

@@ -44,6 +44,9 @@ Layout/LineLength:
 Lint/UnusedMethodArgument:
   AllowUnusedKeywordArguments: true
 
+Style/Documentation:
+  Enabled: false
+
 Style/BlockComments:
   Enabled: false
   Include:

data/k_log.gemspec

@@ -38,6 +38,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   # spec.extensions    = ['ext/k_log/extconf.rb']
 
-  spec.add_dependency 'table_print',         '~> 1.5.7'
+  spec.add_dependency 'table_print', '~> 1.5.7'
   # spec.add_dependency 'tty-box',         '~> 0.5.0'
 end

data/lib/k_log.rb

@@ -1,30 +1,39 @@
-# frozen_string_literal: true
-
-require 'logger'
-require 'table_print'
-require 'k_log/version'
-require 'k_log/log_formatter'
-require 'k_log/log_helper'
-require 'k_log/log_util'
-
-# Simple console log helpers
-module KLog
-  # raise KLog::Error, 'Sample message'
-  class Error < StandardError; end
-
-  class << self
-    attr_accessor :logger
-  end
-
-  def self.default_logger
-    return @default_logger if defined? @default_logger
-    @default_logger = begin
-      logger = Logger.new($stdout)
-      logger.level = Logger::DEBUG
-      logger.formatter = KLog::LogFormatter.new
-      KLog::LogUtil.new(logger)
-    end      
-  end
-end
-
-puts "KLog::Version: #{KLog::VERSION}" if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'
+# frozen_string_literal: true
+
+require 'logger'
+require 'table_print'
+require 'k_log/version'
+require 'k_log/log_formatter'
+require 'k_log/log_helper'
+require 'k_log/log_util'
+require 'k_log/logging'
+
+# Simple console log helpers
+module KLog
+  # raise KLog::Error, 'Sample message'
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :logger
+
+    def default_logger
+      return @default_logger if defined? @default_logger
+
+      @default_logger = begin
+        logger = Logger.new($stdout)
+        logger.level = Logger::DEBUG
+        logger.formatter = KLog::LogFormatter.new
+        KLog::LogUtil.new(logger)
+      end
+    end
+  end
+end
+
+KLog.logger = KLog.default_logger
+
+if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'
+  namespace = 'KLog::Version'
+  file_path = $LOADED_FEATURES.find { |f| f.include?('k_log/version') }
+  version   = KLog::VERSION.ljust(9)
+  puts "#{namespace.ljust(35)} : #{version.ljust(9)} : #{file_path}"
+end

data/lib/k_log/examples.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module KLog
+  class Examples
+    include KLog::Logging
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def examples
+      examples_simple
+      examples_complex
+    end
+
+    def examples_simple
+      log.debug 'some debug message'
+      log.info 'some info message'
+      log.warn 'some warning message'
+      log.error 'some error message'
+      log.fatal 'some fatal message'
+
+      log.kv('First Name', 'David')
+      log.kv('Last Name', 'Cruwys')
+      log.kv('Age', 45)
+      log.kv('Sex', 'male')
+
+      log.heading('Heading')
+      log.subheading('Sub Heading')
+      log.section_heading('Section Heading')
+    end
+
+    def examples_complex
+      log.block ['Line 1', 12, 'Line 3', true, 'Line 5']
+
+      log.progress(0, 'Section 1')
+      log.progress
+      log.progress
+      save_progress = log.progress
+
+      log.progress(10, 'Section 2')
+      log.progress
+      log.progress
+      log.progress
+
+      log.progress(save_progress, 'Section 1')
+      log.progress
+      log.progress
+      log.progress
+
+      log.line
+      log.line(20)
+      log.line(20, character: '-')
+
+      yaml1 = {}
+      yaml1['title'] = 'Software Architect'
+      yaml1['age'] = 45
+      yaml1['name'] = 'David'
+
+      yaml3 = {}
+      yaml3['title'] = 'Developer'
+      yaml3['age'] = 20
+      yaml3['name'] = 'Jin'
+
+      log.yaml(yaml1)
+
+      yaml2 = OpenStruct.new
+      yaml2.title = 'Software Architect'
+      yaml2.age = 45
+      yaml2.name = 'David'
+
+      log.yaml(yaml2)
+
+      mixed_yaml_array = [yaml1, yaml2]
+
+      # This fails because we don't correctly pre-process the array
+      log.yaml(mixed_yaml_array)
+
+      hash_yaml_array = [yaml1, yaml3]
+
+      log.yaml(hash_yaml_array)
+
+      begin
+        raise 'Here is an error'
+      rescue StandardError => e
+        log.exception(e)
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    private
+
+    def debug_multi_lines(lines)
+      lines.each do |line|
+        debug(line)
+      end
+    end
+
+    def info_multi_lines(lines)
+      lines.each do |line|
+        info(line)
+      end
+    end
+
+    def warn_multi_lines(lines)
+      lines.each do |line|
+        warn(line)
+      end
+    end
+
+    def error_multi_lines(lines)
+      lines.each do |line|
+        error(line)
+      end
+    end
+
+    def fatal_multi_lines(lines)
+      lines.each do |line|
+        fatal(line)
+      end
+    end
+  end
+end

data/lib/k_log/log_helper.rb

@@ -89,7 +89,7 @@ module KLog
 
       unless title.nil?
         result.push(title)
-        result.push(line(70, ','))
+        result.push(line(70, '-'))
       end
 
       result.push messages if messages.is_a?(String) || messages.is_a?(Integer)

data/lib/k_log/log_util.rb

@@ -1,353 +1,381 @@
-# frozen_string_literal: true
-
-# Format Logger Util provides static helper methods that delegate responsibility
-# to the underlying Format Logger, you can use the Util instead Rails.logger so
-# that you have access to IDE intellisense around available methods and so you
-# can use the same logger calls from controllers/models which normally have
-# access to to a logger variable and services which do not have access to a
-# logger variable
-#
-# I usually alias the call to LogUtil by doing L = LogUtil
-
-# require_relative 'format_logger'
-# require_relative 'format_logger_helper'
-
-module KLog
-  # Simple console log helpers
-  class LogUtil
-    def initialize(logger)
-      @logger = logger
-    end
-
-    # include ActiveSupport::LoggerThreadSafeLevel
-    # include LoggerSilence
-
-    #----------------------------------------------------------------------------------------------------
-    # Standard Accessors that are on the standard rails Logger
-    #----------------------------------------------------------------------------------------------------
-    def debug(value)
-      @logger.debug(value)
-    end
-
-    def info(value)
-      @logger.info(value)
-    end
-
-    def warn(value)
-      @logger.warn(value)
-    end
-
-    def error(value)
-      @logger.error(value)
-    end
-
-    def fatal(value)
-      @logger.fatal(value)
-    end
-
-    #----------------------------------------------------------------------------------------------------
-    # Helper Log output Methods
-    #----------------------------------------------------------------------------------------------------
-
-    # Write a Key/Value Pair
-    def kv(key, value, key_width = 30)
-      message = LogHelper.kv(key, value, key_width)
-      @logger.info(message)
-    end
-
-    # Write a progress point, progress will update on it's own
-    def progress(pos = nil, section = nil)
-      message = LogHelper.progress(pos, section)
-      # @logger.debug(message)
-      @logger.info(message)
-
-      LogHelper.progress_position
-    end
-
-    # prints out a line to the log
-    def line(size = 70, character: '=')
-      message = LogHelper.line(size, character)
-
-      @logger.info(message)
-    end
-
-    def heading(heading, size = 70)
-      lines = LogHelper.heading(heading, size)
-      info_multi_lines(lines)
-    end
-
-    def subheading(heading, size = 70)
-      lines = LogHelper.subheading(heading, size)
-
-      info_multi_lines(lines)
-    end
-
-    # A section heading
-    #
-    # example:
-    # [ I am a heading ]----------------------------------------------------
-    def section_heading(heading, size = 70)
-      heading = LogHelper.section_heading(heading, size)
-
-      info(heading)
-    end
-
-    def block(messages, include_line: true, title: nil)
-      lines = LogHelper.block(messages, include_line: include_line, title: title)
-
-      info_multi_lines(lines)
-    end
-
-    # # :sql_array should be an array with SQL and values or with SQL and Hash
-    # # example:
-    # #   L.sql(["name = :name and group_id = :value OR parent_id = :value", name: "foo'bar", value: 4])
-    # #   L.sql([sql_exact_match_skills_in_use, {names: self.segments_container.segment_values}])
-    # def sql(sql_array)
-    #   value = ActiveRecord::Base.send(:sanitize_sql_array, sql_array)
-
-    #   info(value)
-    # end
-
-    def yaml(data, is_line: true)
-      require 'yaml'
-      line if is_line
-
-      @logger.info(data.to_yaml) if data.is_a?(Hash)
-
-      @logger.info(data.marshal_dump.to_yaml) if data.is_a?(OpenStruct)
-
-      if data.is_a? Array
-        data.each do |d|
-          @logger.info(d.to_yaml)
-        end
-      end
-
-      line if is_line
-    end
-
-    def json(data)
-      @logger.info(JSON.pretty_generate(data))
-    end
-    alias j json
-
-    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/AbcSize
-    def open_struct(data, indent = '', **opts)
-      data.each_pair do |key, value|
-        case value
-        when OpenStruct
-          if value['rows'].is_a?(Array)
-            # L.subheading(key)
-            opts[:subheading] = key
-            open_struct(value, indent, **opts)
-            opts.delete(:subheading)
-          else
-            L.kv "#{indent}#{key}", ''
-            indent = "#{indent}  "
-            open_struct(value, indent, **opts)
-            indent = indent.chomp('  ')
-          end
-        when Array
-          next unless opts[:skip_array].nil?
-
-          puts LogHelper.section_heading(opts[:subheading], 88) unless opts[:subheading].nil?
-
-          if value.length.positive?
-            if value.first.is_a?(String)
-              L.kv "#{indent}#{key}", value.join(', ')
-            else
-              tp value, value.first.to_h.keys
-            end
-          end
-        else
-          L.kv "#{indent}#{key}", value
-        end
-      end
-      nil
-    end
-    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/AbcSize
-    alias ostruct open_struct
-    alias o open_struct
-
-    def exception(exception)
-      line
-
-      @logger.info(exception.message)
-      @logger.info(exception.backtrace.join("\n"))
-
-      line
-    end
-
-    #----------------------------------------------------------------------------------------------------
-    # Pretty Loggers
-    #----------------------------------------------------------------------------------------------------
-
-    # NOTE: using  pretty_inspect is an existing namespace conflict
-    # rubocop:disable Metrics/AbcSize
-    def pretty_class(instance)
-      c = instance.class
-
-      line
-
-      kv('Full Class', c.name)
-      kv('Module', c.name.deconstantize)
-      kv('Class', c.name.demodulize)
-
-      source_location = c.instance_methods(false).map do |m|
-        c.instance_method(m).source_location.first
-      end.uniq
-
-      begin
-        kv('Source Location', source_location)
-      rescue StandardError => e
-        warn e
-      end
-
-      line
-    end
-    # rubocop:enable Metrics/AbcSize
-
-    # NOTE: using  pretty_inspect is an existing namespace conflict
-    def pretty_params(params)
-      line
-
-      params.each do |k, v|
-        if params[k].is_a?(Hash)
-
-          params[k].each do |child_k, child_v|
-            kv("#{k}[#{child_k}]", child_v)
-          end
-
-        else
-          kv(k, v)
-        end
-      end
-
-      line
-    end
-
-    def help_all_symbols
-      # Produces a lot of data, need some sort of filter I think before this is useful
-      Symbol.all_symbols.each do |s|
-        info s
-        # debug s
-      end
-    end
-
-    #----------------------------------------------------------------------------------------------------
-    # Internal Methods
-    #----------------------------------------------------------------------------------------------------
-
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    def self.examples
-      examples_simple
-      # examples_complex
-    end
-
-    def self.examples_simple
-      L.debug 'some debug message'
-      L.info 'some info message'
-      L.warn 'some warning message'
-      L.error 'some error message'
-      L.fatal 'some fatal message'
-
-      L.kv('First Name', 'David')
-      L.kv('Last Name', 'Cruwys')
-      L.kv('Age', 45)
-      L.kv('Sex', 'male')
-
-      L.heading('Heading')
-      L.subheading('Sub Heading')
-      L.section_heading('Section Heading')
-    end
-
-    def self.examples_complex
-      L.block ['Line 1', 12, 'Line 3', true, 'Line 5']
-
-      L.progress(0, 'Section 1')
-      L.progress
-      L.progress
-      save_progress = L.progress
-
-      L.progress(10, 'Section 2')
-      L.progress
-      L.progress
-      L.progress
-
-      L.progress(save_progress, 'Section 1')
-      L.progress
-      L.progress
-      L.progress
-
-      L.line
-      L.line(20)
-      L.line(20, character: '-')
-
-      yaml1 = {}
-      yaml1['title'] = 'Software Architect'
-      yaml1['age'] = 45
-      yaml1['name'] = 'David'
-
-      yaml3 = {}
-      yaml3['title'] = 'Developer'
-      yaml3['age'] = 20
-      yaml3['name'] = 'Jin'
-
-      L.yaml(yaml1)
-
-      yaml2 = OpenStruct.new
-      yaml2.title = 'Software Architect'
-      yaml2.age = 45
-      yaml2.name = 'David'
-
-      L.yaml(yaml2)
-
-      mixed_yaml_array = [yaml1, yaml2]
-
-      # This fails because we don't correctly pre-process the array
-      L.yaml(mixed_yaml_array)
-
-      hash_yaml_array = [yaml1, yaml3]
-
-      L.yaml(hash_yaml_array)
-
-      begin
-        raise 'Here is an error'
-      rescue StandardError => e
-        L.exception(e)
-      end
-    end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
-
-    private
-
-    def debug_multi_lines(lines)
-      lines.each do |line|
-        debug(line)
-      end
-    end
-
-    def info_multi_lines(lines)
-      lines.each do |line|
-        info(line)
-      end
-    end
-
-    def warn_multi_lines(lines)
-      lines.each do |line|
-        warn(line)
-      end
-    end
-
-    def error_multi_lines(lines)
-      lines.each do |line|
-        error(line)
-      end
-    end
-
-    def fatal_multi_lines(lines)
-      lines.each do |line|
-        fatal(line)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+# Format Logger Util provides static helper methods that delegate responsibility
+# to the underlying Format Logger, you can use the Util instead Rails.logger so
+# that you have access to IDE intellisense around available methods and so you
+# can use the same logger calls from controllers/models which normally have
+# access to to a logger variable and services which do not have access to a
+# logger variable
+#
+# I usually alias the call to LogUtil by doing L = LogUtil
+
+# require_relative 'format_logger'
+# require_relative 'format_logger_helper'
+
+module KLog
+  # Simple console log helpers
+  class LogUtil
+    def initialize(logger)
+      @logger = logger
+    end
+
+    # include ActiveSupport::LoggerThreadSafeLevel
+    # include LoggerSilence
+
+    #----------------------------------------------------------------------------------------------------
+    # Standard Accessors that are on the standard rails Logger
+    #----------------------------------------------------------------------------------------------------
+    def debug(value)
+      @logger.debug(value)
+    end
+
+    def info(value)
+      @logger.info(value)
+    end
+
+    def warn(value)
+      @logger.warn(value)
+    end
+
+    def error(value)
+      @logger.error(value)
+    end
+
+    def fatal(value)
+      @logger.fatal(value)
+    end
+
+    #----------------------------------------------------------------------------------------------------
+    # Helper Log output Methods
+    #----------------------------------------------------------------------------------------------------
+
+    # Write a Key/Value Pair
+    # Need to change this to named_param
+    def kv(key, value, key_width = 30)
+      message = LogHelper.kv(key, value, key_width)
+      @logger.info(message)
+    end
+
+    # Write a progress point, progress will update on it's own
+    def progress(pos = nil, section = nil)
+      message = LogHelper.progress(pos, section)
+      # @logger.debug(message)
+      @logger.info(message)
+
+      LogHelper.progress_position
+    end
+
+    # prints out a line to the log
+    def line(size = 70, character: '=')
+      message = LogHelper.line(size, character)
+
+      @logger.info(message)
+    end
+
+    def heading(heading, size = 70)
+      lines = LogHelper.heading(heading, size)
+      info_multi_lines(lines)
+    end
+
+    def subheading(heading, size = 70)
+      lines = LogHelper.subheading(heading, size)
+
+      info_multi_lines(lines)
+    end
+
+    # A section heading
+    #
+    # example:
+    # [ I am a heading ]----------------------------------------------------
+    def section_heading(heading, size = 70)
+      heading = LogHelper.section_heading(heading, size)
+
+      info(heading)
+    end
+
+    def block(messages, include_line: true, title: nil)
+      lines = LogHelper.block(messages, include_line: include_line, title: title)
+
+      info_multi_lines(lines)
+    end
+
+    # # :sql_array should be an array with SQL and values or with SQL and Hash
+    # # example:
+    # #   KLog.logger.sql(["name = :name and group_id = :value OR parent_id = :value", name: "foo'bar", value: 4])
+    # #   KLog.logger.sql([sql_exact_match_skills_in_use, {names: self.segments_container.segment_values}])
+    # def sql(sql_array)
+    #   value = ActiveRecord::Base.send(:sanitize_sql_array, sql_array)
+
+    #   info(value)
+    # end
+
+    def yaml(data, is_line: true)
+      require 'yaml'
+      line if is_line
+
+      @logger.info(data.to_yaml) if data.is_a?(Hash)
+
+      @logger.info(data.marshal_dump.to_yaml) if data.is_a?(OpenStruct)
+
+      if data.is_a? Array
+        data.each do |d|
+          @logger.info(d.to_yaml)
+        end
+      end
+
+      line if is_line
+    end
+
+    def json(data)
+      @logger.info(JSON.pretty_generate(data))
+    end
+    alias j json
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/AbcSize
+    def open_struct(data, indent = '', **opts)
+      data.each_pair do |key, value|
+        case value
+        when OpenStruct
+          if value['rows'].is_a?(Array)
+            # KLog.logger.subheading(key)
+            opts[:subheading] = key
+            open_struct(value, indent, **opts)
+            opts.delete(:subheading)
+          else
+            KLog.logger.kv "#{indent}#{key}", ''
+            indent = "#{indent}  "
+            open_struct(value, indent, **opts)
+            indent = indent.chomp('  ')
+          end
+        when Array
+          next unless opts[:skip_array].nil?
+
+          puts LogHelper.section_heading(opts[:subheading], 88) unless opts[:subheading].nil?
+
+          if value.length.positive?
+            if value.first.is_a?(String)
+              KLog.logger.kv "#{indent}#{key}", value.join(', ')
+            else
+              tp value, value.first.to_h.keys
+            end
+          end
+        else
+          KLog.logger.kv "#{indent}#{key}", value
+        end
+      end
+      nil
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/AbcSize
+    alias ostruct open_struct
+    alias o open_struct
+
+    def exception(exception)
+      line
+
+      @logger.info(exception.message)
+      @logger.info(exception.backtrace.join("\n"))
+
+      line
+    end
+
+    #----------------------------------------------------------------------------------------------------
+    # Pretty Loggers
+    #----------------------------------------------------------------------------------------------------
+
+    # NOTE: using  pretty_inspect is an existing namespace conflict
+    # rubocop:disable Metrics/AbcSize
+    def pretty_class(instance)
+      c = instance.class
+
+      line
+
+      kv('Full Class', c.name)
+      kv('Module', c.name.deconstantize)
+      kv('Class', c.name.demodulize)
+
+      source_location = c.instance_methods(false).map do |m|
+        c.instance_method(m).source_location.first
+      end.uniq
+
+      begin
+        kv('Source Location', source_location)
+      rescue StandardError => e
+        warn e
+      end
+
+      line
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def kv_hash(hash)
+      hash.each do |key, value|
+        kv(key, value)
+      end
+    end
+
+    # NOTE: using  pretty_inspect is an existing namespace conflict
+    def pretty_params(params)
+      line
+
+      params.each do |k, v|
+        if params[k].is_a?(Hash)
+
+          params[k].each do |child_k, child_v|
+            kv("#{k}[#{child_k}]", child_v)
+          end
+
+        else
+          kv(k, v)
+        end
+      end
+
+      line
+    end
+
+    def help_all_symbols
+      # Produces a lot of data, need some sort of filter I think before this is useful
+      Symbol.all_symbols.each do |s|
+        info s
+        # debug s
+      end
+    end
+
+    def visual_compare_hashes(hash1, hash2)
+      content1 = JSON.pretty_generate(hash1)
+      content2 = JSON.pretty_generate(hash2)
+
+      file1 = Tempfile.new('hash1')
+      file1.write(content1)
+      file1.close
+
+      file2 = Tempfile.new('hash2')
+      file2.write(content2)
+      file2.close
+
+      system "code --diff #{file1.path} #{file2.path}"
+
+      # Provide enough time for vscode to open and display the files before deleting them
+      sleep 1
+
+      file1.unlink
+      file2.unlink
+    end
+
+    #----------------------------------------------------------------------------------------------------
+    # Internal Methods
+    #----------------------------------------------------------------------------------------------------
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def self.examples
+      examples_simple
+      # examples_complex
+    end
+
+    def self.examples_simple
+      KLog.logger.debug 'some debug message'
+      KLog.logger.info 'some info message'
+      KLog.logger.warn 'some warning message'
+      KLog.logger.error 'some error message'
+      KLog.logger.fatal 'some fatal message'
+
+      KLog.logger.kv('First Name', 'David')
+      KLog.logger.kv('Last Name', 'Cruwys')
+      KLog.logger.kv('Age', 45)
+      KLog.logger.kv('Sex', 'male')
+
+      KLog.logger.heading('Heading')
+      KLog.logger.subheading('Sub Heading')
+      KLog.logger.section_heading('Section Heading')
+    end
+
+    def self.examples_complex
+      KLog.logger.block ['Line 1', 12, 'Line 3', true, 'Line 5']
+
+      KLog.logger.progress(0, 'Section 1')
+      KLog.logger.progress
+      KLog.logger.progress
+      save_progress = KLog.logger.progress
+
+      KLog.logger.progress(10, 'Section 2')
+      KLog.logger.progress
+      KLog.logger.progress
+      KLog.logger.progress
+
+      KLog.logger.progress(save_progress, 'Section 1')
+      KLog.logger.progress
+      KLog.logger.progress
+      KLog.logger.progress
+
+      KLog.logger.line
+      KLog.logger.line(20)
+      KLog.logger.line(20, character: '-')
+
+      yaml1 = {}
+      yaml1['title'] = 'Software Architect'
+      yaml1['age'] = 45
+      yaml1['name'] = 'David'
+
+      yaml3 = {}
+      yaml3['title'] = 'Developer'
+      yaml3['age'] = 20
+      yaml3['name'] = 'Jin'
+
+      KLog.logger.yaml(yaml1)
+
+      yaml2 = OpenStruct.new
+      yaml2.title = 'Software Architect'
+      yaml2.age = 45
+      yaml2.name = 'David'
+
+      KLog.logger.yaml(yaml2)
+
+      mixed_yaml_array = [yaml1, yaml2]
+
+      # This fails because we don't correctly pre-process the array
+      KLog.logger.yaml(mixed_yaml_array)
+
+      hash_yaml_array = [yaml1, yaml3]
+
+      KLog.logger.yaml(hash_yaml_array)
+
+      begin
+        raise 'Here is an error'
+      rescue StandardError => e
+        KLog.logger.exception(e)
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    private
+
+    def debug_multi_lines(lines)
+      lines.each do |line|
+        debug(line)
+      end
+    end
+
+    def info_multi_lines(lines)
+      lines.each do |line|
+        info(line)
+      end
+    end
+
+    def warn_multi_lines(lines)
+      lines.each do |line|
+        warn(line)
+      end
+    end
+
+    def error_multi_lines(lines)
+      lines.each do |line|
+        error(line)
+      end
+    end
+
+    def fatal_multi_lines(lines)
+      lines.each do |line|
+        fatal(line)
+      end
+    end
+  end
+end

data/lib/k_log/logging.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module KLog
+  module Logging
+    def log
+      @log ||= KLog.logger
+    end
+  end
+end

data/lib/k_log/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_log
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.18
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: table_print
@@ -52,9 +52,11 @@ files:
 - hooks/update-version
 - k_log.gemspec
 - lib/k_log.rb
+- lib/k_log/examples.rb
 - lib/k_log/log_formatter.rb
 - lib/k_log/log_helper.rb
 - lib/k_log/log_util.rb
+- lib/k_log/logging.rb
 - lib/k_log/version.rb
 - usage.png
 homepage: http://appydave.com/gems/k-log