k_log 0.0.11 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ac934ee60e4b387c82fd684b1f0e51408246cf6ba0f2b6006b2f9f249f05378
-  data.tar.gz: 3c50f23e11899c8a7c87b7f5b788fa1c600592a74814dd79e6eac51ef88498a6
+  metadata.gz: ba63dfa4daf9b11166e15ebd5b0f0204a1ff4886c9431a252e1ff93a5c2ce343
+  data.tar.gz: f4ede795aeca562e9ab6ab91329fcd9bc4657fc7e9ad3338bf748d15c24e1af6
 SHA512:
-  metadata.gz: 1f91fa31506ff4ecb7f99cd84c7ade1778bfc181a57871e9fb3e593d51613017a83197f29a858bf8414dd4112d1f408156430c478962dcbb9334b697251d4544
-  data.tar.gz: 04bff2e6b2258f96ed212fb9eefaf953309aa9dc2d39e8293de4a1fafbaa681122374cc888b9275c81e436f9f0620094aeb56d9e4acd4956032e4367077e847a
+  metadata.gz: 01dd4e8a183ec4aaa3511cd2787f65dcef0cf36ac20b6bf1159a8e920206776f7af2fed28bfd7aa59c8cf83f8d831c63be3040133f2c885f3e56483340f7e05f
+  data.tar.gz: 8aa357235342a2ce4a41d0aa37ee753d3dd5abcfc7ce50b890f958fdc3ad965949ddaf85c89f0e2c2bee3eec55aaa9c6074ee5843a2394acf3f0ba1c6d58400a

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

@@ -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
@@ -14,11 +15,25 @@ module KLog
 
   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 = Logger.new($stdout)
-# KLog.logger.level = Logger::DEBUG
-# KLog.logger.formatter = KLog::LogFormatter.new
+KLog.logger = KLog.default_logger
 
-# L = KLog::LogUtil.new(KLog.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(40)} : #{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_util.rb

@@ -100,8 +100,8 @@ module KLog
 
     # # :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}])
+    # #   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)
 
@@ -136,12 +136,12 @@ module KLog
         case value
         when OpenStruct
           if value['rows'].is_a?(Array)
-            # L.subheading(key)
+            # KLog.logger.subheading(key)
             opts[:subheading] = key
             open_struct(value, indent, **opts)
             opts.delete(:subheading)
           else
-            L.kv "#{indent}#{key}", ''
+            KLog.logger.kv "#{indent}#{key}", ''
             indent = "#{indent}  "
             open_struct(value, indent, **opts)
             indent = indent.chomp('  ')
@@ -149,18 +149,17 @@ module KLog
         when Array
           next unless opts[:skip_array].nil?
 
-          # puts LogHelper.subheading(key, 88)# unless opts[:subheading].nil?
-          puts LogHelper.subheading(opts[:subheading], 88) unless opts[:subheading].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(', ')
+              KLog.logger.kv "#{indent}#{key}", value.join(', ')
             else
               tp value, value.first.to_h.keys
             end
           end
         else
-          L.kv "#{indent}#{key}", value
+          KLog.logger.kv "#{indent}#{key}", value
         end
       end
       nil
@@ -234,6 +233,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
     #----------------------------------------------------------------------------------------------------
@@ -245,43 +265,43 @@ module KLog
     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')
+      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
-      L.block ['Line 1', 12, 'Line 3', true, 'Line 5']
+      KLog.logger.block ['Line 1', 12, 'Line 3', true, 'Line 5']
 
-      L.progress(0, 'Section 1')
-      L.progress
-      L.progress
-      save_progress = L.progress
+      KLog.logger.progress(0, 'Section 1')
+      KLog.logger.progress
+      KLog.logger.progress
+      save_progress = KLog.logger.progress
 
-      L.progress(10, 'Section 2')
-      L.progress
-      L.progress
-      L.progress
+      KLog.logger.progress(10, 'Section 2')
+      KLog.logger.progress
+      KLog.logger.progress
+      KLog.logger.progress
 
-      L.progress(save_progress, 'Section 1')
-      L.progress
-      L.progress
-      L.progress
+      KLog.logger.progress(save_progress, 'Section 1')
+      KLog.logger.progress
+      KLog.logger.progress
+      KLog.logger.progress
 
-      L.line
-      L.line(20)
-      L.line(20, character: '-')
+      KLog.logger.line
+      KLog.logger.line(20)
+      KLog.logger.line(20, character: '-')
 
       yaml1 = {}
       yaml1['title'] = 'Software Architect'
@@ -293,28 +313,28 @@ module KLog
       yaml3['age'] = 20
       yaml3['name'] = 'Jin'
 
-      L.yaml(yaml1)
+      KLog.logger.yaml(yaml1)
 
       yaml2 = OpenStruct.new
       yaml2.title = 'Software Architect'
       yaml2.age = 45
       yaml2.name = 'David'
 
-      L.yaml(yaml2)
+      KLog.logger.yaml(yaml2)
 
       mixed_yaml_array = [yaml1, yaml2]
 
       # This fails because we don't correctly pre-process the array
-      L.yaml(mixed_yaml_array)
+      KLog.logger.yaml(mixed_yaml_array)
 
       hash_yaml_array = [yaml1, yaml3]
 
-      L.yaml(hash_yaml_array)
+      KLog.logger.yaml(hash_yaml_array)
 
       begin
         raise 'Here is an error'
       rescue StandardError => e
-        L.exception(e)
+        KLog.logger.exception(e)
       end
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength

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.11'
+  VERSION = '0.0.16'
 end

metadata

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