cogger 0.5.0 → 0.6.0

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7d17e011982011c35b8d5706d9d0efe4982526b194e6f44b185a67b75065d849
4
- data.tar.gz: 3c0ddf0356820dc31deef5da24138ad49f168dfd79cbfcc16339bf40e4f8e275
3
+ metadata.gz: d2ff34be63a6d20792b0dad16762afaf0f03226964b2a83ed08194fef2f37a75
4
+ data.tar.gz: 5fce7ffb39529c8d4c29f10a03d29e3173219f0365428fa10d003501c38a2553
5
5
  SHA512:
6
- metadata.gz: 63fe3f0a14f804d9c2a2b661f7d6eae90f5f8676756610baa115aaca01e5710aa087d636f47191492eea984f0b272e29f78d1bb6015ef2f065815912aa78d9fb
7
- data.tar.gz: 73c8f8017f431c40e95d1521f735299a0aec5114b127bb2367485b99d079a1db41cec509a28f10079877172bcd6423c0fb440d4fa37a61b1f01fce0b6aa0c81c
6
+ metadata.gz: a8d82b63e521610dda3906c998e8533ad6f82920f1294dedc10a8acba2ec63084213c3ab80f37ae50525f83928d628ea7a94a37fd52c9abbb63a7da54cc619c7
7
+ data.tar.gz: 57e01b5b658f64abc8581a98e95cbb6b6794a787e7b244d79d3aa61f21d157252b19a53a84cbc3e0d18c3058250063d555d5fa133f8ddec67a12fca203657be5
checksums.yaml.gz.sig CHANGED
Binary file
data/README.adoc CHANGED
@@ -18,7 +18,7 @@ toc::[]
18
18
 
19
19
  == Screenshot
20
20
 
21
- image::https://www.alchemists.io/images/projects/cogger/screenshots/console.png[Console,width=552,height=679,role=focal_point]
21
+ image::https://alchemists.io/images/projects/cogger/screenshots/console.png[Console,width=552,height=679,role=focal_point]
22
22
 
23
23
  == Requirements
24
24
 
@@ -35,24 +35,26 @@ bin/setup
35
35
 
36
36
  == Usage
37
37
 
38
- All colorized logging is provided by the `Cogger::Client` class which can be used as follows:
38
+ All colorized logging is provided by `Cogger` which can be used as follows:
39
39
 
40
40
  [source,ruby]
41
41
  ----
42
- logger = Cogger::Client.new
43
-
44
- logger.debug "test" # true
45
- logger.debug { "test" } # true
46
- logger.info "test" # true
47
- logger.info { "test" } # true
48
- logger.warn "test" # true
49
- logger.warn { "test" } # true
50
- logger.error "test" # true
51
- logger.error { "test" } # true
52
- logger.fatal "test" # true
53
- logger.fatal { "test" } # true
54
- logger.any "test" # true
55
- logger.any { "test" } # true
42
+ logger = Cogger.init
43
+
44
+ logger.debug "test" # true
45
+ logger.debug { "test" } # true
46
+ logger.info "test" # true
47
+ logger.info { "test" } # true
48
+ logger.warn "test" # true
49
+ logger.warn { "test" } # true
50
+ logger.error "test" # true
51
+ logger.error { "test" } # true
52
+ logger.fatal "test" # true
53
+ logger.fatal { "test" } # true
54
+ logger.unknown "test" # true
55
+ logger.unknown { "test" } # true
56
+ logger.any "test" # true
57
+ logger.any { "test" } # true
56
58
  ----
57
59
 
58
60
  By default, all logging is configured to use `INFO` level and writes to `$stdout`. To see what the
@@ -63,7 +65,7 @@ Beyond the standard log level methods, the following methods are also available:
63
65
 
64
66
  [source,ruby]
65
67
  ----
66
- logger = Cogger::Client.new
68
+ logger = Cogger.init
67
69
 
68
70
  logger.formatter # #<Proc:0x000000010626ebc8 $HOME/OSS/cogger/lib/cogger/client.rb:37 (lambda)>
69
71
  logger.level # 1
@@ -82,34 +84,32 @@ you could swap out the default logger with something that logs to a string. For
82
84
 
83
85
  [source,ruby]
84
86
  ----
85
- logger = Cogger::Client.new Logger.new(StringIO.new)
87
+ logger = Cogger.init Logger.new(StringIO.new)
86
88
  ----
87
89
 
88
90
  You can also create a logger which might use custom colors. Example:
89
91
 
90
92
  [source,ruby]
91
93
  ----
92
- logger = Cogger::Client.new color: MyColor.new
94
+ logger = Cogger.init color: MyColor.new
93
95
  ----
94
96
 
95
- More information on how to customize your colors will be provided later.
96
-
97
- Lastly, you can provide any _setable_ attribute which would normally be used when constructing a
97
+ More information on how to customize your colors will be provided shortly. Lastly, you can provide any _setable_ attribute which would normally be used when constructing a
98
98
  normal logger. Example:
99
99
 
100
100
  [source,ruby]
101
101
  ----
102
- logger = Cogger::Client.new formatter: ->(severity, _at, _name, message) { "#{message}\n" },
103
- level: :debug,
104
- progname: "Test",
105
- datetime_format: "%Y-%m-%d"
102
+ logger = Cogger.init formatter: ->(severity, _at, _name, message) { "#{message}\n" },
103
+ level: :debug,
104
+ progname: "Test",
105
+ datetime_format: "%Y-%m-%d"
106
106
  ----
107
107
 
108
108
  Alternatively, you can use a block as well:
109
109
 
110
110
  [source,ruby]
111
111
  ----
112
- logger = Cogger::Client.new do |instance|
112
+ logger = Cogger.init do |instance|
113
113
  instance.formatter = ->(severity, _at, _name, message) { "#{message}\n" }
114
114
  instance.level = :debug
115
115
  instance.progname = "Test"
@@ -129,6 +129,7 @@ export LOG_LEVEL=INFO
129
129
  export LOG_LEVEL=WARN
130
130
  export LOG_LEVEL=ERROR
131
131
  export LOG_LEVEL=FATAL
132
+ export LOG_LEVEL=UNKNOWN
132
133
  export LOG_LEVEL=ANY
133
134
  ----
134
135
 
@@ -147,6 +148,7 @@ Default colors are provided by the `Cogger::Color` class which are keyed by log
147
148
  warn: %i[yellow],
148
149
  error: %i[red],
149
150
  fatal: %i[white bold on_red],
151
+ unknown: %i[white bold],
150
152
  any: %i[white bold]
151
153
  }
152
154
  ----
@@ -165,11 +167,12 @@ custom_color = Cogger::Color.new(
165
167
  warn: %i[yellow on_black],
166
168
  error: %i[red on_black],
167
169
  fatal: %i[red on_black],
170
+ unknown: %i[white on_black],
168
171
  any: %i[white on_black]
169
172
  }
170
173
  )
171
174
 
172
- logger = Cogger::Client.new color: custom_color
175
+ logger = Cogger.init color: custom_color
173
176
  ----
174
177
 
175
178
  The above would ensure all log level colors are displayed on a black background. Basically, any
@@ -184,7 +187,7 @@ was logged. Example:
184
187
  [source,ruby]
185
188
  ----
186
189
  class Demo
187
- def initialize logger: Cogger::Client.new
190
+ def initialize logger: Cogger.init
188
191
  @logger = logger
189
192
  end
190
193
 
@@ -195,10 +198,10 @@ class Demo
195
198
  attr_reader :logger
196
199
  end
197
200
 
198
- RSpec.describe Demo do
201
+ RSpec.describe Demo do
199
202
  subject(:demo) { described_class.new logger: }
200
203
 
201
- let(:logger) { Cogger::Client.new Logger.new(StringIO.new) }
204
+ let(:logger) { Cogger.init Logger.new(StringIO.new) }
202
205
 
203
206
  describe "#say" do
204
207
  it "logs text" do
@@ -237,22 +240,22 @@ To test, run:
237
240
 
238
241
  [source,bash]
239
242
  ----
240
- bundle exec rake
243
+ bin/rake
241
244
  ----
242
245
 
243
- == link:https://www.alchemists.io/policies/license[License]
246
+ == link:https://alchemists.io/policies/license[License]
244
247
 
245
- == link:https://www.alchemists.io/policies/security[Security]
248
+ == link:https://alchemists.io/policies/security[Security]
246
249
 
247
- == link:https://www.alchemists.io/policies/code_of_conduct[Code of Conduct]
250
+ == link:https://alchemists.io/policies/code_of_conduct[Code of Conduct]
248
251
 
249
- == link:https://www.alchemists.io/policies/contributions[Contributions]
252
+ == link:https://alchemists.io/policies/contributions[Contributions]
250
253
 
251
- == link:https://www.alchemists.io/projects/cogger/versions[Versions]
254
+ == link:https://alchemists.io/projects/cogger/versions[Versions]
252
255
 
253
- == link:https://www.alchemists.io/community[Community]
256
+ == link:https://alchemists.io/community[Community]
254
257
 
255
258
  == Credits
256
259
 
257
- * Built with link:https://www.alchemists.io/projects/gemsmith[Gemsmith].
258
- * Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
260
+ * Built with link:https://alchemists.io/projects/gemsmith[Gemsmith].
261
+ * Engineered by link:https://alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
data/cogger.gemspec CHANGED
@@ -2,17 +2,17 @@
2
2
 
3
3
  Gem::Specification.new do |spec|
4
4
  spec.name = "cogger"
5
- spec.version = "0.5.0"
5
+ spec.version = "0.6.0"
6
6
  spec.authors = ["Brooke Kuhlmann"]
7
7
  spec.email = ["brooke@alchemists.io"]
8
- spec.homepage = "https://www.alchemists.io/projects/cogger"
8
+ spec.homepage = "https://alchemists.io/projects/cogger"
9
9
  spec.summary = "Decorates native logging with colorized output."
10
10
  spec.license = "Hippocratic-2.1"
11
11
 
12
12
  spec.metadata = {
13
13
  "bug_tracker_uri" => "https://github.com/bkuhlmann/cogger/issues",
14
- "changelog_uri" => "https://www.alchemists.io/projects/cogger/versions",
15
- "documentation_uri" => "https://www.alchemists.io/projects/cogger",
14
+ "changelog_uri" => "https://alchemists.io/projects/cogger/versions",
15
+ "documentation_uri" => "https://alchemists.io/projects/cogger",
16
16
  "funding_uri" => "https://github.com/sponsors/bkuhlmann",
17
17
  "label" => "Cogger",
18
18
  "rubygems_mfa_required" => "true",
data/lib/cogger/client.rb CHANGED
@@ -11,7 +11,7 @@ module Cogger
11
11
 
12
12
  using Refinements::Loggers
13
13
 
14
- delegate %i[formatter level progname debug info warn error fatal] => :logger
14
+ delegate %i[formatter level progname debug info warn error fatal unknown] => :logger
15
15
 
16
16
  def initialize logger = Logger.new($stdout), color: Color.new, **attributes
17
17
  @logger = logger
data/lib/cogger/color.rb CHANGED
@@ -11,6 +11,7 @@ module Cogger
11
11
  warn: %i[yellow],
12
12
  error: %i[red],
13
13
  fatal: %i[white bold on_red],
14
+ unknown: %i[white bold],
14
15
  any: %i[white bold]
15
16
  }.freeze
16
17
 
@@ -29,6 +30,8 @@ module Cogger
29
30
 
30
31
  def fatal(text) = decorate text, __method__
31
32
 
33
+ def unknown(text) = decorate text, __method__
34
+
32
35
  def any(text) = decorate text, __method__
33
36
 
34
37
  private
data/lib/cogger.rb CHANGED
@@ -6,4 +6,5 @@ Zeitwerk::Loader.for_gem.setup
6
6
 
7
7
  # Main namespace.
8
8
  module Cogger
9
+ def self.init(...) = Client.new(...)
9
10
  end
data.tar.gz.sig CHANGED
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cogger
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.0
4
+ version: 0.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Brooke Kuhlmann
@@ -10,25 +10,27 @@ bindir: bin
10
10
  cert_chain:
11
11
  - |
12
12
  -----BEGIN CERTIFICATE-----
13
- MIIC/jCCAeagAwIBAgIBBTANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
14
- a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMjAzMTkxNzI0MzJaFw0yMzAzMTkx
15
- NzI0MzJaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
16
- IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
17
- xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
18
- brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
19
- 9z0A8KcGhz67SdcoQiD7qiCjL/2NTeWHOzkpPrdGlt088+VerEEGf5I13QCvaftP
20
- D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
21
- 3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
22
- AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
23
- 2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAJbbNyWzFjqUNVPPCUCo
24
- IMrhDa9xf1xkORXNYYbmXgoxRy/KyNbUr+jgEEoWJAm9GXlcqxxWAUI6pK/i4/Qi
25
- X6rPFEFmeObDOHNvuqy8Hd6AYsu+kP94U/KJhe9wnWGMmGoNKJNU3EkW3jM/osSl
26
- +JRxiH5t4WtnDiVyoYl5nYC02rYdjJkG6VMxDymXTqn7u6HhYgZkGujq1UPar8x2
27
- hNIWJblDKKSu7hA2d6+kUthuYo13o1sg1Da/AEDg0hoZSUvhqDEF5Hy232qb3pDt
28
- CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
29
- RFE=
13
+ MIIDdjCCAl6gAwIBAgIBATANBgkqhkiG9w0BAQsFADBBMQ8wDQYDVQQDDAZicm9v
14
+ a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
15
+ aW8wHhcNMjMwMzIyMDI1MDUzWhcNMjQwMzIxMDI1MDUzWjBBMQ8wDQYDVQQDDAZi
16
+ cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
17
+ GRYCaW8wggEgMA0GCSqGSIb3DQEBAQUAA4IBDQAwggEIAoIBAQDN48o0vC52F2Tm
18
+ +GVuhHer6sZx58nshIUHVXbD/4y5Xd798rmAtPMlwFEyvvx68wqvS+Wv96T7FckJ
19
+ 1GxNDo7Sr9qtX/ZuFtGXuR9XLiffHB9OS/66XsbGEa3JbhWzvM3wEvGbI/mmzuCC
20
+ lWhcu4fsGYSwBtDdu1sXXDBzw2fPvQMSUg1pTczZritU2loGIk13u2Swic1b1t+g
21
+ M90d9DIWUruyMvXvTlWwmgR5TJJBWmdN28r1AeK+CK4JuKtcmrbVRm5pJu/NCEVY
22
+ GK2pW2GNyH/Uhr3GURG/62CTZajgasAPCMRA6fDF3qMC5x7k8VIBHHI4C9Q+ZxMZ
23
+ bf2f5LDFAgEjo3sweTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU
24
+ o8O4DUt12YAn26VApVf0Ay2LPaQwHwYDVR0RBBgwFoEUYnJvb2tlQGFsY2hlbWlz
25
+ dHMuaW8wHwYDVR0SBBgwFoEUYnJvb2tlQGFsY2hlbWlzdHMuaW8wDQYJKoZIhvcN
26
+ AQELBQADggEBAMu9b3FOh7yAIsUwpdqRaUbqNcLkfdHOO6siBKjQmyNwXwuNsL3K
27
+ jrlf1cZjK4k7pfLnDQOh2y519gjYI5a89BO1y/kHIa+2gxYOcBYFnxwhYkeCElw7
28
+ M7IF60Kx1oA+CAnHKQiZhYza3oPqq+HnXEIaQ1yotEEGFPexrVjPT3tswNkt0MUh
29
+ 3VkmTWI8jdDdgVWe6VYA/SbV66QKMfjo6FhQOAg3r/j61p8ZrYSif9jupwwR/vPW
30
+ PeEy3IGK1LEEwzEikz3Q0ebJHITVsm7UFiyrOn2Wk2Omh33+G65HC/cXRK8h1bLM
31
+ mBOOp3pATPxRweMKsY4hosuFEwweI8Btwaw=
30
32
  -----END CERTIFICATE-----
31
- date: 2022-12-25 00:00:00.000000000 Z
33
+ date: 2023-03-22 00:00:00.000000000 Z
32
34
  dependencies:
33
35
  - !ruby/object:Gem::Dependency
34
36
  name: pastel
@@ -87,13 +89,13 @@ files:
87
89
  - lib/cogger.rb
88
90
  - lib/cogger/client.rb
89
91
  - lib/cogger/color.rb
90
- homepage: https://www.alchemists.io/projects/cogger
92
+ homepage: https://alchemists.io/projects/cogger
91
93
  licenses:
92
94
  - Hippocratic-2.1
93
95
  metadata:
94
96
  bug_tracker_uri: https://github.com/bkuhlmann/cogger/issues
95
- changelog_uri: https://www.alchemists.io/projects/cogger/versions
96
- documentation_uri: https://www.alchemists.io/projects/cogger
97
+ changelog_uri: https://alchemists.io/projects/cogger/versions
98
+ documentation_uri: https://alchemists.io/projects/cogger
97
99
  funding_uri: https://github.com/sponsors/bkuhlmann
98
100
  label: Cogger
99
101
  rubygems_mfa_required: 'true'
@@ -113,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
113
115
  - !ruby/object:Gem::Version
114
116
  version: '0'
115
117
  requirements: []
116
- rubygems_version: 3.3.26
118
+ rubygems_version: 3.4.8
117
119
  signing_key:
118
120
  specification_version: 4
119
121
  summary: Decorates native logging with colorized output.
metadata.gz.sig CHANGED
Binary file