tee_logger 3.2.3 → 3.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.travis.yml +0 -1
- data/CHANGELOG.md +6 -0
- data/README.md +74 -28
- data/lib/tee_logger/version.rb +1 -1
- data/tee_logger.gemspec +6 -2
- metadata +7 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bc70b6c37a05823b6818f4c50fdd84ab2f7daa918850d08c2005df58ecd4e0db
|
4
|
+
data.tar.gz: 68a01c36f6e721f2c9de7dfdc48000a47cf50fdb8ce808484a40d4ba816ea7b6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e5c9c18eb38fe4a92ff9cefd7004c5abc4cde8993e30cf92607861b64ed15952db96f0d00d409259983be84015a1c37d6d841c4a4d5dd8a7257f2a5eddb4f2ac
|
7
|
+
data.tar.gz: f543787f7d4b0ee9bbe73ccf33a4e4bbef5130c1b716ee04e816a0d50bcd6bf95d49881608ca397fd62c8edb5ad5dbb9e79633346b04e48af0aaaec44302669b
|
data/.travis.yml
CHANGED
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# TeeLogger
|
2
|
+
|
1
3
|
[![Gem Version][gem_version-svg]][gem_version]
|
2
4
|
[![Build Status][travis-svg]][travis]
|
3
5
|
[![Downloads][downloads-svg]][gem_version]
|
@@ -12,20 +14,44 @@
|
|
12
14
|
- [GitHub](https://github.com/k-ta-yamada/tee_logger)
|
13
15
|
- [RubyDoc.info](https://www.rubydoc.info/gems/tee_logger)
|
14
16
|
|
15
|
-
# TeeLogger
|
16
|
-
|
17
17
|
logging to file and standard output.
|
18
18
|
require standard library only.
|
19
19
|
|
20
|
-
|
21
|
-
|
20
|
+
<!-- TOC -->
|
21
|
+
|
22
|
+
- [1. Characteristic](#1-characteristic)
|
23
|
+
- [2. Installation](#2-installation)
|
24
|
+
- [3. Usage](#3-usage)
|
25
|
+
- [3.1. let's logging](#31-lets-logging)
|
26
|
+
- [3.2. enable only when specified](#32-enable-only-when-specified)
|
27
|
+
- [3.3. log meassage indent](#33-log-meassage-indent)
|
28
|
+
- [3.4. enabling and indent](#34-enabling-and-indent)
|
29
|
+
- [3.5. disable console output](#35-disable-console-output)
|
30
|
+
- [3.6. enable console output](#36-enable-console-output)
|
31
|
+
- [3.7. disable logfile output](#37-disable-logfile-output)
|
32
|
+
- [3.8. enable logfile output](#38-enable-logfile-output)
|
33
|
+
- [3.9. disable in block](#39-disable-in-block)
|
34
|
+
- [3.10. and others like Logger's](#310-and-others-like-loggers)
|
35
|
+
- [4. include or extend TeeLogger](#4-include-or-extend-teelogger)
|
36
|
+
- [4.1. for casual use](#41-for-casual-use)
|
37
|
+
- [4.2. configuration logfile name, progname, level, formatter, and datetime_format](#42-configuration-logfile-name-progname-level-formatter-and-datetime_format)
|
38
|
+
- [5. Development](#5-development)
|
39
|
+
- [6. Contributing](#6-contributing)
|
40
|
+
- [7. License](#7-license)
|
41
|
+
|
42
|
+
<!-- /TOC -->
|
43
|
+
|
44
|
+
---
|
45
|
+
|
46
|
+
## 1. Characteristic
|
22
47
|
|
23
48
|
- use standard lib only.
|
24
49
|
- like Logger: see usage.
|
25
50
|
- enabled or disabled by switching the output of the console and the logfile.
|
26
51
|
|
52
|
+
---
|
27
53
|
|
28
|
-
## Installation
|
54
|
+
## 2. Installation
|
29
55
|
|
30
56
|
Add this line to your application's Gemfile:
|
31
57
|
|
@@ -35,20 +61,22 @@ gem 'tee_logger'
|
|
35
61
|
|
36
62
|
And then execute:
|
37
63
|
|
38
|
-
```
|
39
|
-
|
64
|
+
```sh
|
65
|
+
bundle
|
40
66
|
```
|
41
67
|
|
42
68
|
Or install it yourself as:
|
43
69
|
|
70
|
+
```sh
|
71
|
+
gem install tee_logger
|
44
72
|
```
|
45
|
-
$ gem install tee_logger
|
46
|
-
```
|
47
73
|
|
74
|
+
---
|
75
|
+
|
76
|
+
## 3. Usage
|
48
77
|
|
49
|
-
|
78
|
+
### 3.1. let's logging
|
50
79
|
|
51
|
-
### let's logging
|
52
80
|
```ruby
|
53
81
|
require 'tee_logger'
|
54
82
|
|
@@ -65,51 +93,59 @@ tl.progname = 'App'
|
|
65
93
|
tl.debug 'hello tee_logger'
|
66
94
|
```
|
67
95
|
|
68
|
-
### enable only when specified
|
96
|
+
### 3.2. enable only when specified
|
97
|
+
|
69
98
|
```ruby
|
70
99
|
tl.info 'this message is console and logfile'
|
71
100
|
tl.info 'this message is console only', :console
|
72
101
|
tl.info 'this message is logfile only', :logfile
|
73
102
|
```
|
74
103
|
|
75
|
-
### log meassage indent
|
104
|
+
### 3.3. log meassage indent
|
105
|
+
|
76
106
|
```ruby
|
77
107
|
tl.info 'hello' # => 'hello'
|
78
108
|
tl.info 'hello', 0 # => 'hello'
|
79
109
|
tl.info 'hello', 2 # => ' hello'
|
80
110
|
```
|
81
111
|
|
82
|
-
### enabling and indent
|
112
|
+
### 3.4. enabling and indent
|
113
|
+
|
83
114
|
```ruby
|
84
115
|
tl.info 'this message is console only', 2, :console
|
85
116
|
tl.info 'this message is console only', :console, 2
|
86
117
|
```
|
87
118
|
|
88
|
-
### disable console output
|
119
|
+
### 3.5. disable console output
|
120
|
+
|
89
121
|
```ruby
|
90
122
|
tl.disable(:console)
|
91
123
|
tl.info 'this message is logfile only'
|
92
124
|
```
|
93
125
|
|
94
|
-
### enable console output
|
126
|
+
### 3.6. enable console output
|
127
|
+
|
95
128
|
```ruby
|
96
129
|
tl.enable(:console)
|
97
130
|
tl.info 'this message is logfile and console'
|
98
131
|
```
|
99
132
|
|
100
|
-
### disable logfile output
|
133
|
+
### 3.7. disable logfile output
|
134
|
+
|
101
135
|
```ruby
|
102
136
|
tl.disable(:logfile)
|
103
137
|
tl.info 'this message is consle only'
|
104
138
|
```
|
105
139
|
|
106
|
-
### enable logfile output
|
140
|
+
### 3.8. enable logfile output
|
141
|
+
|
107
142
|
```ruby
|
108
143
|
tl.enable(:logfile)
|
109
144
|
tl.info 'this message is logfile and console'
|
110
145
|
```
|
111
146
|
|
112
|
-
### disable in block
|
147
|
+
### 3.9. disable in block
|
148
|
+
|
113
149
|
```ruby
|
114
150
|
tl.disable(:console) do
|
115
151
|
tl.info 'this message is logfile only'
|
@@ -117,7 +153,8 @@ end
|
|
117
153
|
tl.info 'this message is logfile and console'
|
118
154
|
```
|
119
155
|
|
120
|
-
### and others like Logger's
|
156
|
+
### 3.10. and others like Logger's
|
157
|
+
|
121
158
|
```ruby
|
122
159
|
# log_level
|
123
160
|
tl.debug? # => true
|
@@ -140,12 +177,14 @@ tl.datetime_format # => nil or Proc
|
|
140
177
|
tl.datetime_format = '%Y%m%d %H%M%S '
|
141
178
|
```
|
142
179
|
|
180
|
+
---
|
143
181
|
|
144
|
-
## include or extend TeeLogger
|
182
|
+
## 4. include or extend TeeLogger
|
145
183
|
|
146
184
|
> the log file will be in default of `./tee_logger.log`
|
147
185
|
|
148
|
-
### for casual use
|
186
|
+
### 4.1. for casual use
|
187
|
+
|
149
188
|
```ruby
|
150
189
|
require 'tee_logger'
|
151
190
|
|
@@ -170,7 +209,8 @@ module YourAwesomeModule
|
|
170
209
|
end
|
171
210
|
```
|
172
211
|
|
173
|
-
### configuration logfile name, progname, level, formatter, and datetime_format
|
212
|
+
### 4.2. configuration logfile name, progname, level, formatter, and datetime_format
|
213
|
+
|
174
214
|
```ruby
|
175
215
|
require 'tee_logger'
|
176
216
|
|
@@ -207,8 +247,9 @@ end
|
|
207
247
|
|
208
248
|
```
|
209
249
|
|
250
|
+
---
|
210
251
|
|
211
|
-
## Development
|
252
|
+
## 5. Development
|
212
253
|
|
213
254
|
After checking out the repo, run `bundle install` to install dependencies.
|
214
255
|
Then, run `rake rspec` to run the tests.
|
@@ -222,8 +263,9 @@ which will create a git tag for the version,
|
|
222
263
|
push git commits and tags,
|
223
264
|
and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
224
265
|
|
266
|
+
---
|
225
267
|
|
226
|
-
## Contributing
|
268
|
+
## 6. Contributing
|
227
269
|
|
228
270
|
Bug reports and pull requests are welcome on GitHub
|
229
271
|
at https://github.com/k-ta-yamada/tee_logger.
|
@@ -232,17 +274,21 @@ welcoming space for collaboration,
|
|
232
274
|
and contributors are expected to adhere to the
|
233
275
|
[Contributor Covenant](https://contributor-covenant.org) code of conduct.
|
234
276
|
|
277
|
+
---
|
235
278
|
|
236
|
-
## License
|
279
|
+
## 7. License
|
237
280
|
|
238
281
|
The gem is available as open source under the terms of the
|
239
282
|
[MIT License](https://opensource.org/licenses/MIT).
|
240
283
|
|
284
|
+
---
|
285
|
+
|
286
|
+
eof
|
241
287
|
|
242
288
|
[gem_version]: https://badge.fury.io/rb/tee_logger
|
243
289
|
[gem_version-svg]: https://badge.fury.io/rb/tee_logger.svg
|
244
|
-
[travis]: https://travis-ci.
|
245
|
-
[travis-svg]: https://travis-ci.
|
290
|
+
[travis]: https://app.travis-ci.com/k-ta-yamada/tee_logger
|
291
|
+
[travis-svg]: https://app.travis-ci.com/k-ta-yamada/tee_logger.svg?branch=master
|
246
292
|
[codeclimate]: https://codeclimate.com/github/k-ta-yamada/tee_logger
|
247
293
|
[codeclimate-svg]: https://codeclimate.com/github/k-ta-yamada/tee_logger/badges/gpa.svg
|
248
294
|
[codeclimate_cov]: https://codeclimate.com/github/k-ta-yamada/tee_logger/coverage
|
data/lib/tee_logger/version.rb
CHANGED
data/tee_logger.gemspec
CHANGED
@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
|
|
9
9
|
spec.authors = ['k-ta-yamada']
|
10
10
|
spec.email = ['key.luvless@gmail.com']
|
11
11
|
|
12
|
-
spec.required_ruby_version = '>= 2.
|
12
|
+
spec.required_ruby_version = '>= 2.6.0'
|
13
13
|
|
14
14
|
spec.summary = 'logging to file and standard output.'
|
15
15
|
# rubocop:disable Metrics/LineLength
|
@@ -30,7 +30,11 @@ Gem::Specification.new do |spec|
|
|
30
30
|
spec.add_development_dependency 'rake'
|
31
31
|
spec.add_development_dependency 'rspec'
|
32
32
|
spec.add_development_dependency 'fuubar'
|
33
|
-
|
33
|
+
# Workaround for cc-test-reporter with SimpleCov 0.18.
|
34
|
+
# Stop upgrading SimpleCov until the following issue will be resolved.
|
35
|
+
# https://github.com/codeclimate/test-reporter/issues/418
|
36
|
+
# https://github.com/codeclimate/test-reporter/issues/413
|
37
|
+
spec.add_development_dependency 'simplecov', '= 0.17'
|
34
38
|
spec.add_development_dependency 'simplecov-console'
|
35
39
|
|
36
40
|
spec.add_development_dependency 'pry'
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: tee_logger
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.2.
|
4
|
+
version: 3.2.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- k-ta-yamada
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-09-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -70,16 +70,16 @@ dependencies:
|
|
70
70
|
name: simplecov
|
71
71
|
requirement: !ruby/object:Gem::Requirement
|
72
72
|
requirements:
|
73
|
-
- -
|
73
|
+
- - '='
|
74
74
|
- !ruby/object:Gem::Version
|
75
|
-
version: '0'
|
75
|
+
version: '0.17'
|
76
76
|
type: :development
|
77
77
|
prerelease: false
|
78
78
|
version_requirements: !ruby/object:Gem::Requirement
|
79
79
|
requirements:
|
80
|
-
- -
|
80
|
+
- - '='
|
81
81
|
- !ruby/object:Gem::Version
|
82
|
-
version: '0'
|
82
|
+
version: '0.17'
|
83
83
|
- !ruby/object:Gem::Dependency
|
84
84
|
name: simplecov-console
|
85
85
|
requirement: !ruby/object:Gem::Requirement
|
@@ -229,7 +229,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
229
229
|
requirements:
|
230
230
|
- - ">="
|
231
231
|
- !ruby/object:Gem::Version
|
232
|
-
version: 2.
|
232
|
+
version: 2.6.0
|
233
233
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
234
234
|
requirements:
|
235
235
|
- - ">="
|