k_log 0.0.1 → 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +29 -3
- data/STORIES.md +3 -3
- data/USAGE.md +8 -6
- data/hooks/pre-commit +1 -1
- data/lib/k_log/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6f1e325c47a61e20b484d81ed0a5cec935196f9a58da8a858195538a4c17d1a7
|
4
|
+
data.tar.gz: 936c2725ada3d7c9c74c0d49870f42d822077a528004df89a53ab6e334a94a42
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cc37b200dbe1ea308738085403d317dbba8d826205b42641c350c2d747c33b00697409eb0b80370b5654ad6d5c130f2ad2206bb6304288ab1d76c9a02ccb9486
|
7
|
+
data.tar.gz: a06dc130e55068e25e57e71af44a6a902d10a950a2a1afe3bbffde67e2e746a9113489a0e84a6356a3f94a33b1bd48efff03faed75c65b0050bacd0c13e213be
|
data/README.md
CHANGED
@@ -36,12 +36,38 @@ See all [usage examples](./USAGE.md)
|
|
36
36
|
|
37
37
|
### Basic Example
|
38
38
|
|
39
|
-
####
|
39
|
+
#### Setup KLog
|
40
40
|
|
41
|
-
|
41
|
+
Pass a standard Logger to KLog and then setup an alias for easier access
|
42
42
|
|
43
43
|
```ruby
|
44
|
-
|
44
|
+
KLog.logger = Logger.new($stdout)
|
45
|
+
KLog.logger.level = Logger::DEBUG
|
46
|
+
KLog.logger.formatter = KLog::LogFormatter.new
|
47
|
+
|
48
|
+
L = KLog::LogUtil.new(KLog.logger)
|
49
|
+
```
|
50
|
+
|
51
|
+
#### Sample Usage
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
L.debug 'some debug message'
|
55
|
+
L.info 'some info message'
|
56
|
+
L.warn 'some warning message'
|
57
|
+
L.error 'some error message'
|
58
|
+
L.fatal 'some fatal message'
|
59
|
+
|
60
|
+
L.kv('First Name', 'David')
|
61
|
+
L.kv('Last Name', 'Cruwys')
|
62
|
+
L.kv('Age', 45)
|
63
|
+
L.kv('Sex', 'male')
|
64
|
+
|
65
|
+
L.line
|
66
|
+
L.line(20)
|
67
|
+
L.line(20, character: '-')
|
68
|
+
|
69
|
+
L.heading('Heading')
|
70
|
+
L.subheading('Sub Heading')
|
45
71
|
```
|
46
72
|
|
47
73
|
## Development
|
data/STORIES.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# K Log
|
2
2
|
|
3
|
-
>
|
3
|
+
> K Log provides console logging helpers and formatters
|
4
4
|
|
5
5
|
As a Developer, I need formatted console logs, so that information presents clearly
|
6
6
|
|
@@ -8,9 +8,9 @@ As a Developer, I need formatted console logs, so that information presents clea
|
|
8
8
|
|
9
9
|
### Stories next on list
|
10
10
|
|
11
|
-
As a Developer, I
|
11
|
+
As a Developer, I need formatted console logs, so that information presents clearly
|
12
12
|
|
13
|
-
-
|
13
|
+
- A range of helper methods that write formatted log entries to the console
|
14
14
|
|
15
15
|
### Tasks next on list
|
16
16
|
|
data/USAGE.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# K Log
|
2
2
|
|
3
|
-
>
|
3
|
+
> K Log provides console logging helpers and formatters
|
4
4
|
|
5
5
|
As a Developer, I need formatted console logs, so that information presents clearly
|
6
6
|
|
@@ -8,12 +8,14 @@ As a Developer, I need formatted console logs, so that information presents clea
|
|
8
8
|
|
9
9
|
### Sample Classes
|
10
10
|
|
11
|
-
####
|
11
|
+
#### Setup KLog
|
12
12
|
|
13
|
-
|
13
|
+
Pass a standard Logger to KLog and then setup an alias for easier access
|
14
14
|
|
15
15
|
```ruby
|
16
|
-
|
17
|
-
|
18
|
-
|
16
|
+
KLog.logger = Logger.new($stdout)
|
17
|
+
KLog.logger.level = Logger::DEBUG
|
18
|
+
KLog.logger.formatter = KLog::LogFormatter.new
|
19
|
+
|
20
|
+
L = KLog::LogUtil.new(KLog.logger)
|
19
21
|
```
|
data/hooks/pre-commit
CHANGED
@@ -22,8 +22,8 @@ files_changed = `git diff-index --name-only HEAD --`.split
|
|
22
22
|
files_changed -= ['Gemfile']
|
23
23
|
files_changed -= ['Gemfile.lock']
|
24
24
|
files_changed -= ['.gitignore']
|
25
|
-
files_changed -= ['README.md']
|
26
25
|
|
26
|
+
files_changed = files_changed.reject { |f| f.downcase.end_with?('.MD') }
|
27
27
|
files_changed = files_changed.reject { |f| f.downcase.end_with?('.json') }
|
28
28
|
files_changed = files_changed.reject { |f| f.downcase.end_with?('.yml') }
|
29
29
|
|
data/lib/k_log/version.rb
CHANGED