k_log 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2ccb53751a29b845bfd6390858eb240022f36a7a6fccf4ecd7ee1ce9bff6e3c
-  data.tar.gz: 4674f6da5073ae74d02e757a2e262cb0f0565937c823b1b8a7e5542b97293a08
+  metadata.gz: ba63dfa4daf9b11166e15ebd5b0f0204a1ff4886c9431a252e1ff93a5c2ce343
+  data.tar.gz: f4ede795aeca562e9ab6ab91329fcd9bc4657fc7e9ad3338bf748d15c24e1af6
 SHA512:
-  metadata.gz: 925822534585b98027b1f101f6897cb6404bff3f5e51d2bf67acc25a7a6f0ea88534dba1d4245a51a491054d236b226895f2891b453d0f780b7f16937d8a9559
-  data.tar.gz: 69c222e2bf0d58c487bc639780befdad04d30779c5d60e66f43970a89a4441103e66d0eae2b66c42118f05d8e415624bbcb839d17ad4af6816eeb9eada4a8239
+  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/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

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/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.15'
+  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.15
+  version: 0.0.16
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-03 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