k_log 0.0.14 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09e7a754932b0c5135aedab7479843432f91e4cb07fca8c02a9b43a39348a030'
-  data.tar.gz: 7afea8a76865110473bb5e4637407a740344cb3a14dd5d867946a088d9cb5f89
+  metadata.gz: 243999c48416e082085f9c72519cd2cc97bb8585389ee6848592f18dc2cfc6bd
+  data.tar.gz: '009abfdd9b635d89f6e31f8197516f0dd612ce14adc9dfb7f005c9a9da458684'
 SHA512:
-  metadata.gz: 0ad9e7d14ef6baea84d98656e2c05b12c8323336781c4ece398eb9c0980b167456aa890778e840d2b0cc568d61527558f331d789d9409df9e88408643a15c6e2
-  data.tar.gz: 135951199b19c6c7af7357d4419ddfffe251f52c5afd78cdc0d49b46db9d09612745300d8dc6d081a552e4598645293a2a2189440732ac4881f444c82ff7c173
+  metadata.gz: f19cf492a22aaf8dbc89dcd9246aacc5732e3db7844d17030d63091e672c4fb201d11c221bbe24450cb1d8745b16d8b70bb21994cc821387ee703aaea4bbc69f
+  data.tar.gz: f0355d0438831db47d1ec390ba7d336b763d76f8d1d23f9520c98a1641901f0114c9961e9ac5d158daa8cddf5658782c6311721aeea5f01cd6dbe7ba24a80c80

data/.rubocop.yml

@@ -44,11 +44,17 @@ Layout/LineLength:
 Lint/UnusedMethodArgument:
   AllowUnusedKeywordArguments: true
 
+Style/Documentation:
+  Enabled: false
+
 Style/BlockComments:
   Enabled: false
   Include:
     - "**/spec/*"
 
+Layout/EndOfLine:
+  EnforcedStyle: lf
+  
 # My Preferences - Start
 Metrics/ClassLength:
   Enabled: false

data/lib/k_log.rb

@@ -6,6 +6,7 @@ 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
@@ -30,4 +31,9 @@ end
 
 KLog.logger = KLog.default_logger
 
-puts "KLog::Version: #{KLog::VERSION}" if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'
+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,129 @@
+# 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')
+
+      data = OpenStruct.new
+      data.title = 'Software Architect'
+      data.age = 45
+      data.name = 'David'
+      data.names = %w[David Bill]
+      data.status = :debug
+      data.statuses = %i[debug info blah]
+      log.open_struct(data, section_heading: 'Display Open Struct')
+    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

@@ -50,6 +50,7 @@ module KLog
     #----------------------------------------------------------------------------------------------------
 
     # 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)
@@ -132,6 +133,10 @@ module KLog
 
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/AbcSize
     def open_struct(data, indent = '', **opts)
+      KLog.logger.heading(opts[:heading], 88) unless opts[:heading].nil?
+      KLog.logger.subheading(opts[:subheading], 88) unless opts[:subheading].nil?
+      KLog.logger.section_heading(opts[:section_heading], 88) unless opts[:section_heading].nil?
+
       data.each_pair do |key, value|
         case value
         when OpenStruct
@@ -152,8 +157,8 @@ module KLog
           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(', ')
+            if value.first.is_a?(String) || value.first.is_a?(Symbol)
+              KLog.logger.kv "#{indent}#{key}", value.map(&:to_s).join(', ')
             else
               tp value, value.first.to_h.keys
             end
@@ -206,6 +211,12 @@ module KLog
     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
@@ -233,6 +244,27 @@ module KLog
       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
     #----------------------------------------------------------------------------------------------------

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.14'
+  VERSION = '0.0.19'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_log
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.19
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-07-11 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