k_log 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89223209de09159a690392c8d5c064029ce95ae01bce49d5cfbbb05ba5e52d7a
-  data.tar.gz: 3b47e1f5809e1f3b901ff835a1efa2848b7738ba82c826a0bc4b37e8a32ce99b
+  metadata.gz: 6f1e325c47a61e20b484d81ed0a5cec935196f9a58da8a858195538a4c17d1a7
+  data.tar.gz: 936c2725ada3d7c9c74c0d49870f42d822077a528004df89a53ab6e334a94a42
 SHA512:
-  metadata.gz: aee02a521c935d936c7a0ea33f549072cfa2dc0259b2046651ba07bfad5f58bf6b6e74dfd6d366113a6f59f59eb53c5b5866ec8de2c9b70810c8ee05a7c3cd5d
-  data.tar.gz: d4e85c21ca84c339ad4ffc762edc4aed63e2af41083f23dbec90068286ff871d8b72d6aa3ed59a155125ca7811ec817e9b657d69b99d9f0f73399729ff6eb867
+  metadata.gz: cc37b200dbe1ea308738085403d317dbba8d826205b42641c350c2d747c33b00697409eb0b80370b5654ad6d5c130f2ad2206bb6304288ab1d76c9a02ccb9486
+  data.tar.gz: a06dc130e55068e25e57e71af44a6a902d10a950a2a1afe3bbffde67e2e746a9113489a0e84a6356a3f94a33b1bd48efff03faed75c65b0050bacd0c13e213be

data/README.md

@@ -36,12 +36,38 @@ See all [usage examples](./USAGE.md)
 
 ### Basic Example
 
-#### Basic example
+#### Setup KLog
 
-Description for a basic example to be featured in the main README.MD file
+Pass a standard Logger to KLog and then setup an alias for easier access
 
 ```ruby
-class SomeRuby; end
+KLog.logger = Logger.new($stdout)
+KLog.logger.level = Logger::DEBUG
+KLog.logger.formatter = KLog::LogFormatter.new
+
+L = KLog::LogUtil.new(KLog.logger)
+```
+
+#### Sample Usage
+
+```ruby
+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.line
+L.line(20)
+L.line(20, character: '-')
+
+L.heading('Heading')
+L.subheading('Sub Heading')
 ```
 
 ## Development

data/STORIES.md

@@ -1,6 +1,6 @@
 # K Log
 
-> KLog provides console logging helpers and formatters
+> K Log provides console logging helpers and formatters
 
 As a Developer, I need formatted console logs, so that information presents clearly
 
@@ -8,9 +8,9 @@ As a Developer, I need formatted console logs, so that information presents clea
 
 ### Stories next on list
 
-As a Developer, I can DO_SOMETHING, so that I QUALITY_OF_LIFE
+As a Developer, I need formatted console logs, so that information presents clearly
 
-- Subtask
+- A range of helper methods that write formatted log entries to the console
 
 ### Tasks next on list
 

data/USAGE.md

@@ -1,6 +1,6 @@
 # K Log
 
-> KLog provides console logging helpers and formatters
+> K Log provides console logging helpers and formatters
 
 As a Developer, I need formatted console logs, so that information presents clearly
 
@@ -8,12 +8,14 @@ As a Developer, I need formatted console logs, so that information presents clea
 
 ### Sample Classes
 
-#### Simple example
+#### Setup KLog
 
-Description for a simple example that shows up in the USAGE.MD
+Pass a standard Logger to KLog and then setup an alias for easier access
 
 ```ruby
-class SomeRuby
-  def initialize; end
-end
+KLog.logger = Logger.new($stdout)
+KLog.logger.level = Logger::DEBUG
+KLog.logger.formatter = KLog::LogFormatter.new
+
+L = KLog::LogUtil.new(KLog.logger)
 ```

data/hooks/pre-commit

@@ -22,8 +22,8 @@ files_changed = `git diff-index --name-only HEAD --`.split
 files_changed -= ['Gemfile']
 files_changed -= ['Gemfile.lock']
 files_changed -= ['.gitignore']
-files_changed -= ['README.md']
 
+files_changed = files_changed.reject { |f| f.downcase.end_with?('.MD') }
 files_changed = files_changed.reject { |f| f.downcase.end_with?('.json') }
 files_changed = files_changed.reject { |f| f.downcase.end_with?('.yml') }
 

data/lib/k_log/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: k_log
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - David Cruwys