lunchmoney 1.2.0 → 1.4.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.
Files changed (63) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/build_and_publish_yard_docs.yml +1 -1
  3. data/.github/workflows/check_pipeline.yml +2 -2
  4. data/.github/workflows/ci.yml +1 -1
  5. data/.github/workflows/{dependabot-rbi-updater.yml → rbi-updater.yml} +2 -3
  6. data/.simplecov +1 -2
  7. data/Gemfile +2 -3
  8. data/Gemfile.lock +70 -75
  9. data/lib/lunchmoney/objects/transaction.rb +9 -1
  10. data/lib/lunchmoney/objects/user.rb +4 -1
  11. data/lib/lunchmoney/version.rb +1 -1
  12. data/sorbet/rbi/annotations/activesupport.rbi +31 -0
  13. data/sorbet/rbi/annotations/minitest.rbi +119 -0
  14. data/sorbet/rbi/dsl/active_support/callbacks.rbi +1 -0
  15. data/sorbet/rbi/gems/{activesupport@7.1.3.2.rbi → activesupport@7.2.1.rbi} +1345 -1253
  16. data/sorbet/rbi/gems/{addressable@2.8.6.rbi → addressable@2.8.7.rbi} +2 -1
  17. data/sorbet/rbi/gems/{bigdecimal@3.1.7.rbi → bigdecimal@3.1.8.rbi} +1 -0
  18. data/sorbet/rbi/gems/{chef-utils@18.4.2.rbi → chef-utils@18.5.0.rbi} +1 -0
  19. data/sorbet/rbi/gems/{concurrent-ruby@1.2.3.rbi → concurrent-ruby@1.3.4.rbi} +64 -9
  20. data/sorbet/rbi/gems/{docile@1.4.0.rbi → docile@1.4.1.rbi} +1 -0
  21. data/sorbet/rbi/gems/{dotenv@3.1.0.rbi → dotenv@3.1.2.rbi} +20 -17
  22. data/sorbet/rbi/gems/{erubi@1.12.0.rbi → erubi@1.13.0.rbi} +20 -15
  23. data/sorbet/rbi/gems/{faraday-net_http@3.1.0.rbi → faraday-net_http@3.1.1.rbi} +36 -35
  24. data/sorbet/rbi/gems/{faraday@2.9.0.rbi → faraday@2.10.1.rbi} +79 -33
  25. data/sorbet/rbi/gems/{hashdiff@1.1.0.rbi → hashdiff@1.1.1.rbi} +3 -2
  26. data/sorbet/rbi/gems/{i18n@1.14.4.rbi → i18n@1.14.5.rbi} +43 -14
  27. data/sorbet/rbi/gems/{json@2.7.1.rbi → json@2.7.2.rbi} +72 -72
  28. data/sorbet/rbi/gems/logger@1.6.0.rbi +903 -0
  29. data/sorbet/rbi/gems/{minitest@5.22.3.rbi → minitest@5.25.1.rbi} +245 -235
  30. data/sorbet/rbi/gems/{mixlib-shellout@3.2.7.rbi → mixlib-shellout@3.2.8.rbi} +1 -0
  31. data/sorbet/rbi/gems/{mocha@2.1.0.rbi → mocha@2.4.5.rbi} +169 -144
  32. data/sorbet/rbi/gems/{parallel@1.24.0.rbi → parallel@1.26.3.rbi} +32 -21
  33. data/sorbet/rbi/gems/{parser@3.3.0.5.rbi → parser@3.3.4.2.rbi} +233 -186
  34. data/sorbet/rbi/gems/{prism@0.24.0.rbi → prism@0.30.0.rbi} +20933 -12761
  35. data/sorbet/rbi/gems/{public_suffix@5.0.4.rbi → public_suffix@6.0.1.rbi} +1 -0
  36. data/sorbet/rbi/gems/{racc@1.7.3.rbi → racc@1.8.1.rbi} +34 -33
  37. data/sorbet/rbi/gems/{rack@3.0.10.rbi → rack@3.1.7.rbi} +694 -987
  38. data/sorbet/rbi/gems/{rake@13.1.0.rbi → rake@13.2.1.rbi} +56 -55
  39. data/sorbet/rbi/gems/{rbi@0.1.9.rbi → rbi@0.1.14.rbi} +904 -622
  40. data/sorbet/rbi/gems/{regexp_parser@2.9.0.rbi → regexp_parser@2.9.2.rbi} +3 -2
  41. data/sorbet/rbi/gems/{rexml@3.2.6.rbi → rexml@3.3.6.rbi} +383 -245
  42. data/sorbet/rbi/gems/{rubocop-ast@1.31.2.rbi → rubocop-ast@1.32.1.rbi} +393 -349
  43. data/sorbet/rbi/gems/{rubocop-minitest@0.35.0.rbi → rubocop-minitest@0.35.1.rbi} +11 -8
  44. data/sorbet/rbi/gems/{rubocop-rails@2.24.1.rbi → rubocop-rails@2.26.0.rbi} +604 -275
  45. data/sorbet/rbi/gems/{rubocop-sorbet@0.8.0.rbi → rubocop-sorbet@0.8.5.rbi} +253 -127
  46. data/sorbet/rbi/gems/{rubocop@1.62.1.rbi → rubocop@1.65.1.rbi} +2334 -1779
  47. data/sorbet/rbi/gems/securerandom@0.3.1.rbi +73 -0
  48. data/sorbet/rbi/gems/{spoom@1.2.4.rbi → spoom@1.4.2.rbi} +2003 -848
  49. data/sorbet/rbi/gems/strscan@3.1.0.rbi +9 -0
  50. data/sorbet/rbi/gems/{tapioca@0.13.1.rbi → tapioca@0.16.1.rbi} +294 -259
  51. data/sorbet/rbi/gems/{toys-core@0.15.5.rbi → toys-core@0.15.6.rbi} +1 -0
  52. data/sorbet/rbi/gems/{toys@0.15.5.rbi → toys@0.15.6.rbi} +4 -3
  53. data/sorbet/rbi/gems/{vcr@6.2.0.rbi → vcr@6.3.1.rbi} +72 -68
  54. data/sorbet/rbi/gems/{webmock@3.23.0.rbi → webmock@3.23.1.rbi} +1 -0
  55. data/sorbet/rbi/gems/{yard-sorbet@0.8.1.rbi → yard-sorbet@0.9.0.rbi} +36 -29
  56. metadata +46 -49
  57. data/sorbet/rbi/gems/coderay@1.1.3.rbi +0 -3426
  58. data/sorbet/rbi/gems/method_source@1.0.0.rbi +0 -272
  59. data/sorbet/rbi/gems/mutex_m@0.2.0.rbi +0 -93
  60. data/sorbet/rbi/gems/prettier_print@1.2.1.rbi +0 -951
  61. data/sorbet/rbi/gems/pry-sorbet@0.2.1.rbi +0 -966
  62. data/sorbet/rbi/gems/pry@0.14.2.rbi +0 -10077
  63. data/sorbet/rbi/gems/syntax_tree@6.2.0.rbi +0 -23136
@@ -0,0 +1,903 @@
1
+ # typed: false
2
+
3
+ # DO NOT EDIT MANUALLY
4
+ # This is an autogenerated file for types exported from the `logger` gem.
5
+ # Please instead update this file by running `bin/tapioca gem logger`.
6
+
7
+
8
+ # \Class \Logger provides a simple but sophisticated logging utility that
9
+ # you can use to create one or more
10
+ # {event logs}[https://en.wikipedia.org/wiki/Logging_(software)#Event_logs]
11
+ # for your program.
12
+ # Each such log contains a chronological sequence of entries
13
+ # that provides a record of the program's activities.
14
+ #
15
+ # == About the Examples
16
+ #
17
+ # All examples on this page assume that \Logger has been required:
18
+ #
19
+ # require 'logger'
20
+ #
21
+ # == Synopsis
22
+ #
23
+ # Create a log with Logger.new:
24
+ #
25
+ # # Single log file.
26
+ # logger = Logger.new('t.log')
27
+ # # Size-based rotated logging: 3 10-megabyte files.
28
+ # logger = Logger.new('t.log', 3, 10485760)
29
+ # # Period-based rotated logging: daily (also allowed: 'weekly', 'monthly').
30
+ # logger = Logger.new('t.log', 'daily')
31
+ # # Log to an IO stream.
32
+ # logger = Logger.new($stdout)
33
+ #
34
+ # Add entries (level, message) with Logger#add:
35
+ #
36
+ # logger.add(Logger::DEBUG, 'Maximal debugging info')
37
+ # logger.add(Logger::INFO, 'Non-error information')
38
+ # logger.add(Logger::WARN, 'Non-error warning')
39
+ # logger.add(Logger::ERROR, 'Non-fatal error')
40
+ # logger.add(Logger::FATAL, 'Fatal error')
41
+ # logger.add(Logger::UNKNOWN, 'Most severe')
42
+ #
43
+ # Close the log with Logger#close:
44
+ #
45
+ # logger.close
46
+ #
47
+ # == Entries
48
+ #
49
+ # You can add entries with method Logger#add:
50
+ #
51
+ # logger.add(Logger::DEBUG, 'Maximal debugging info')
52
+ # logger.add(Logger::INFO, 'Non-error information')
53
+ # logger.add(Logger::WARN, 'Non-error warning')
54
+ # logger.add(Logger::ERROR, 'Non-fatal error')
55
+ # logger.add(Logger::FATAL, 'Fatal error')
56
+ # logger.add(Logger::UNKNOWN, 'Most severe')
57
+ #
58
+ # These shorthand methods also add entries:
59
+ #
60
+ # logger.debug('Maximal debugging info')
61
+ # logger.info('Non-error information')
62
+ # logger.warn('Non-error warning')
63
+ # logger.error('Non-fatal error')
64
+ # logger.fatal('Fatal error')
65
+ # logger.unknown('Most severe')
66
+ #
67
+ # When you call any of these methods,
68
+ # the entry may or may not be written to the log,
69
+ # depending on the entry's severity and on the log level;
70
+ # see {Log Level}[rdoc-ref:Logger@Log+Level]
71
+ #
72
+ # An entry always has:
73
+ #
74
+ # - A severity (the required argument to #add).
75
+ # - An automatically created timestamp.
76
+ #
77
+ # And may also have:
78
+ #
79
+ # - A message.
80
+ # - A program name.
81
+ #
82
+ # Example:
83
+ #
84
+ # logger = Logger.new($stdout)
85
+ # logger.add(Logger::INFO, 'My message.', 'mung')
86
+ # # => I, [2022-05-07T17:21:46.536234 #20536] INFO -- mung: My message.
87
+ #
88
+ # The default format for an entry is:
89
+ #
90
+ # "%s, [%s #%d] %5s -- %s: %s\n"
91
+ #
92
+ # where the values to be formatted are:
93
+ #
94
+ # - \Severity (one letter).
95
+ # - Timestamp.
96
+ # - Process id.
97
+ # - \Severity (word).
98
+ # - Program name.
99
+ # - Message.
100
+ #
101
+ # You can use a different entry format by:
102
+ #
103
+ # - Setting a custom format proc (affects following entries);
104
+ # see {formatter=}[Logger.html#attribute-i-formatter].
105
+ # - Calling any of the methods above with a block
106
+ # (affects only the one entry).
107
+ # Doing so can have two benefits:
108
+ #
109
+ # - Context: the block can evaluate the entire program context
110
+ # and create a context-dependent message.
111
+ # - Performance: the block is not evaluated unless the log level
112
+ # permits the entry actually to be written:
113
+ #
114
+ # logger.error { my_slow_message_generator }
115
+ #
116
+ # Contrast this with the string form, where the string is
117
+ # always evaluated, regardless of the log level:
118
+ #
119
+ # logger.error("#{my_slow_message_generator}")
120
+ #
121
+ # === \Severity
122
+ #
123
+ # The severity of a log entry has two effects:
124
+ #
125
+ # - Determines whether the entry is selected for inclusion in the log;
126
+ # see {Log Level}[rdoc-ref:Logger@Log+Level].
127
+ # - Indicates to any log reader (whether a person or a program)
128
+ # the relative importance of the entry.
129
+ #
130
+ # === Timestamp
131
+ #
132
+ # The timestamp for a log entry is generated automatically
133
+ # when the entry is created.
134
+ #
135
+ # The logged timestamp is formatted by method
136
+ # {Time#strftime}[rdoc-ref:Time#strftime]
137
+ # using this format string:
138
+ #
139
+ # '%Y-%m-%dT%H:%M:%S.%6N'
140
+ #
141
+ # Example:
142
+ #
143
+ # logger = Logger.new($stdout)
144
+ # logger.add(Logger::INFO)
145
+ # # => I, [2022-05-07T17:04:32.318331 #20536] INFO -- : nil
146
+ #
147
+ # You can set a different format using method #datetime_format=.
148
+ #
149
+ # === Message
150
+ #
151
+ # The message is an optional argument to an entry method:
152
+ #
153
+ # logger = Logger.new($stdout)
154
+ # logger.add(Logger::INFO, 'My message')
155
+ # # => I, [2022-05-07T18:15:37.647581 #20536] INFO -- : My message
156
+ #
157
+ # For the default entry formatter, <tt>Logger::Formatter</tt>,
158
+ # the message object may be:
159
+ #
160
+ # - A string: used as-is.
161
+ # - An Exception: <tt>message.message</tt> is used.
162
+ # - Anything else: <tt>message.inspect</tt> is used.
163
+ #
164
+ # *Note*: Logger::Formatter does not escape or sanitize
165
+ # the message passed to it.
166
+ # Developers should be aware that malicious data (user input)
167
+ # may be in the message, and should explicitly escape untrusted data.
168
+ #
169
+ # You can use a custom formatter to escape message data;
170
+ # see the example at {formatter=}[Logger.html#attribute-i-formatter].
171
+ #
172
+ # === Program Name
173
+ #
174
+ # The program name is an optional argument to an entry method:
175
+ #
176
+ # logger = Logger.new($stdout)
177
+ # logger.add(Logger::INFO, 'My message', 'mung')
178
+ # # => I, [2022-05-07T18:17:38.084716 #20536] INFO -- mung: My message
179
+ #
180
+ # The default program name for a new logger may be set in the call to
181
+ # Logger.new via optional keyword argument +progname+:
182
+ #
183
+ # logger = Logger.new('t.log', progname: 'mung')
184
+ #
185
+ # The default program name for an existing logger may be set
186
+ # by a call to method #progname=:
187
+ #
188
+ # logger.progname = 'mung'
189
+ #
190
+ # The current program name may be retrieved with method
191
+ # {progname}[Logger.html#attribute-i-progname]:
192
+ #
193
+ # logger.progname # => "mung"
194
+ #
195
+ # == Log Level
196
+ #
197
+ # The log level setting determines whether an entry is actually
198
+ # written to the log, based on the entry's severity.
199
+ #
200
+ # These are the defined severities (least severe to most severe):
201
+ #
202
+ # logger = Logger.new($stdout)
203
+ # logger.add(Logger::DEBUG, 'Maximal debugging info')
204
+ # # => D, [2022-05-07T17:57:41.776220 #20536] DEBUG -- : Maximal debugging info
205
+ # logger.add(Logger::INFO, 'Non-error information')
206
+ # # => I, [2022-05-07T17:59:14.349167 #20536] INFO -- : Non-error information
207
+ # logger.add(Logger::WARN, 'Non-error warning')
208
+ # # => W, [2022-05-07T18:00:45.337538 #20536] WARN -- : Non-error warning
209
+ # logger.add(Logger::ERROR, 'Non-fatal error')
210
+ # # => E, [2022-05-07T18:02:41.592912 #20536] ERROR -- : Non-fatal error
211
+ # logger.add(Logger::FATAL, 'Fatal error')
212
+ # # => F, [2022-05-07T18:05:24.703931 #20536] FATAL -- : Fatal error
213
+ # logger.add(Logger::UNKNOWN, 'Most severe')
214
+ # # => A, [2022-05-07T18:07:54.657491 #20536] ANY -- : Most severe
215
+ #
216
+ # The default initial level setting is Logger::DEBUG, the lowest level,
217
+ # which means that all entries are to be written, regardless of severity:
218
+ #
219
+ # logger = Logger.new($stdout)
220
+ # logger.level # => 0
221
+ # logger.add(0, "My message")
222
+ # # => D, [2022-05-11T15:10:59.773668 #20536] DEBUG -- : My message
223
+ #
224
+ # You can specify a different setting in a new logger
225
+ # using keyword argument +level+ with an appropriate value:
226
+ #
227
+ # logger = Logger.new($stdout, level: Logger::ERROR)
228
+ # logger = Logger.new($stdout, level: 'error')
229
+ # logger = Logger.new($stdout, level: :error)
230
+ # logger.level # => 3
231
+ #
232
+ # With this level, entries with severity Logger::ERROR and higher
233
+ # are written, while those with lower severities are not written:
234
+ #
235
+ # logger = Logger.new($stdout, level: Logger::ERROR)
236
+ # logger.add(3)
237
+ # # => E, [2022-05-11T15:17:20.933362 #20536] ERROR -- : nil
238
+ # logger.add(2) # Silent.
239
+ #
240
+ # You can set the log level for an existing logger
241
+ # with method #level=:
242
+ #
243
+ # logger.level = Logger::ERROR
244
+ #
245
+ # These shorthand methods also set the level:
246
+ #
247
+ # logger.debug! # => 0
248
+ # logger.info! # => 1
249
+ # logger.warn! # => 2
250
+ # logger.error! # => 3
251
+ # logger.fatal! # => 4
252
+ #
253
+ # You can retrieve the log level with method #level.
254
+ #
255
+ # logger.level = Logger::ERROR
256
+ # logger.level # => 3
257
+ #
258
+ # These methods return whether a given
259
+ # level is to be written:
260
+ #
261
+ # logger.level = Logger::ERROR
262
+ # logger.debug? # => false
263
+ # logger.info? # => false
264
+ # logger.warn? # => false
265
+ # logger.error? # => true
266
+ # logger.fatal? # => true
267
+ #
268
+ # == Log File Rotation
269
+ #
270
+ # By default, a log file is a single file that grows indefinitely
271
+ # (until explicitly closed); there is no file rotation.
272
+ #
273
+ # To keep log files to a manageable size,
274
+ # you can use _log_ _file_ _rotation_, which uses multiple log files:
275
+ #
276
+ # - Each log file has entries for a non-overlapping
277
+ # time interval.
278
+ # - Only the most recent log file is open and active;
279
+ # the others are closed and inactive.
280
+ #
281
+ # === Size-Based Rotation
282
+ #
283
+ # For size-based log file rotation, call Logger.new with:
284
+ #
285
+ # - Argument +logdev+ as a file path.
286
+ # - Argument +shift_age+ with a positive integer:
287
+ # the number of log files to be in the rotation.
288
+ # - Argument +shift_size+ as a positive integer:
289
+ # the maximum size (in bytes) of each log file;
290
+ # defaults to 1048576 (1 megabyte).
291
+ #
292
+ # Examples:
293
+ #
294
+ # logger = Logger.new('t.log', 3) # Three 1-megabyte files.
295
+ # logger = Logger.new('t.log', 5, 10485760) # Five 10-megabyte files.
296
+ #
297
+ # For these examples, suppose:
298
+ #
299
+ # logger = Logger.new('t.log', 3)
300
+ #
301
+ # Logging begins in the new log file, +t.log+;
302
+ # the log file is "full" and ready for rotation
303
+ # when a new entry would cause its size to exceed +shift_size+.
304
+ #
305
+ # The first time +t.log+ is full:
306
+ #
307
+ # - +t.log+ is closed and renamed to +t.log.0+.
308
+ # - A new file +t.log+ is opened.
309
+ #
310
+ # The second time +t.log+ is full:
311
+ #
312
+ # - +t.log.0 is renamed as +t.log.1+.
313
+ # - +t.log+ is closed and renamed to +t.log.0+.
314
+ # - A new file +t.log+ is opened.
315
+ #
316
+ # Each subsequent time that +t.log+ is full,
317
+ # the log files are rotated:
318
+ #
319
+ # - +t.log.1+ is removed.
320
+ # - +t.log.0 is renamed as +t.log.1+.
321
+ # - +t.log+ is closed and renamed to +t.log.0+.
322
+ # - A new file +t.log+ is opened.
323
+ #
324
+ # === Periodic Rotation
325
+ #
326
+ # For periodic rotation, call Logger.new with:
327
+ #
328
+ # - Argument +logdev+ as a file path.
329
+ # - Argument +shift_age+ as a string period indicator.
330
+ #
331
+ # Examples:
332
+ #
333
+ # logger = Logger.new('t.log', 'daily') # Rotate log files daily.
334
+ # logger = Logger.new('t.log', 'weekly') # Rotate log files weekly.
335
+ # logger = Logger.new('t.log', 'monthly') # Rotate log files monthly.
336
+ #
337
+ # Example:
338
+ #
339
+ # logger = Logger.new('t.log', 'daily')
340
+ #
341
+ # When the given period expires:
342
+ #
343
+ # - The base log file, +t.log+ is closed and renamed
344
+ # with a date-based suffix such as +t.log.20220509+.
345
+ # - A new log file +t.log+ is opened.
346
+ # - Nothing is removed.
347
+ #
348
+ # The default format for the suffix is <tt>'%Y%m%d'</tt>,
349
+ # which produces a suffix similar to the one above.
350
+ # You can set a different format using create-time option
351
+ # +shift_period_suffix+;
352
+ # see details and suggestions at
353
+ # {Time#strftime}[rdoc-ref:Time#strftime].
354
+ class Logger
355
+ include ::Logger::Severity
356
+
357
+ # :call-seq:
358
+ # Logger.new(logdev, shift_age = 0, shift_size = 1048576, **options)
359
+ #
360
+ # With the single argument +logdev+,
361
+ # returns a new logger with all default options:
362
+ #
363
+ # Logger.new('t.log') # => #<Logger:0x000001e685dc6ac8>
364
+ #
365
+ # Argument +logdev+ must be one of:
366
+ #
367
+ # - A string filepath: entries are to be written
368
+ # to the file at that path; if the file at that path exists,
369
+ # new entries are appended.
370
+ # - An IO stream (typically +$stdout+, +$stderr+. or an open file):
371
+ # entries are to be written to the given stream.
372
+ # - +nil+ or +File::NULL+: no entries are to be written.
373
+ #
374
+ # Examples:
375
+ #
376
+ # Logger.new('t.log')
377
+ # Logger.new($stdout)
378
+ #
379
+ # The keyword options are:
380
+ #
381
+ # - +level+: sets the log level; default value is Logger::DEBUG.
382
+ # See {Log Level}[rdoc-ref:Logger@Log+Level]:
383
+ #
384
+ # Logger.new('t.log', level: Logger::ERROR)
385
+ #
386
+ # - +progname+: sets the default program name; default is +nil+.
387
+ # See {Program Name}[rdoc-ref:Logger@Program+Name]:
388
+ #
389
+ # Logger.new('t.log', progname: 'mung')
390
+ #
391
+ # - +formatter+: sets the entry formatter; default is +nil+.
392
+ # See {formatter=}[Logger.html#attribute-i-formatter].
393
+ # - +datetime_format+: sets the format for entry timestamp;
394
+ # default is +nil+.
395
+ # See #datetime_format=.
396
+ # - +binmode+: sets whether the logger writes in binary mode;
397
+ # default is +false+.
398
+ # - +shift_period_suffix+: sets the format for the filename suffix
399
+ # for periodic log file rotation; default is <tt>'%Y%m%d'</tt>.
400
+ # See {Periodic Rotation}[rdoc-ref:Logger@Periodic+Rotation].
401
+ #
402
+ # @return [Logger] a new instance of Logger
403
+ #
404
+ # source://logger//logger.rb#578
405
+ def initialize(logdev, shift_age = T.unsafe(nil), shift_size = T.unsafe(nil), level: T.unsafe(nil), progname: T.unsafe(nil), formatter: T.unsafe(nil), datetime_format: T.unsafe(nil), binmode: T.unsafe(nil), shift_period_suffix: T.unsafe(nil)); end
406
+
407
+ # Writes the given +msg+ to the log with no formatting;
408
+ # returns the number of characters written,
409
+ # or +nil+ if no log device exists:
410
+ #
411
+ # logger = Logger.new($stdout)
412
+ # logger << 'My message.' # => 10
413
+ #
414
+ # Output:
415
+ #
416
+ # My message.
417
+ #
418
+ # source://logger//logger.rb#684
419
+ def <<(msg); end
420
+
421
+ # Creates a log entry, which may or may not be written to the log,
422
+ # depending on the entry's severity and on the log level.
423
+ # See {Log Level}[rdoc-ref:Logger@Log+Level]
424
+ # and {Entries}[rdoc-ref:Logger@Entries] for details.
425
+ #
426
+ # Examples:
427
+ #
428
+ # logger = Logger.new($stdout, progname: 'mung')
429
+ # logger.add(Logger::INFO)
430
+ # logger.add(Logger::ERROR, 'No good')
431
+ # logger.add(Logger::ERROR, 'No good', 'gnum')
432
+ #
433
+ # Output:
434
+ #
435
+ # I, [2022-05-12T16:25:31.469726 #36328] INFO -- mung: mung
436
+ # E, [2022-05-12T16:25:55.349414 #36328] ERROR -- mung: No good
437
+ # E, [2022-05-12T16:26:35.841134 #36328] ERROR -- gnum: No good
438
+ #
439
+ # These convenience methods have implicit severity:
440
+ #
441
+ # - #debug.
442
+ # - #info.
443
+ # - #warn.
444
+ # - #error.
445
+ # - #fatal.
446
+ # - #unknown.
447
+ #
448
+ # source://logger//logger.rb#651
449
+ def add(severity, message = T.unsafe(nil), progname = T.unsafe(nil)); end
450
+
451
+ # Closes the logger; returns +nil+:
452
+ #
453
+ # logger = Logger.new('t.log')
454
+ # logger.close # => nil
455
+ # logger.info('foo') # Prints "log writing failed. closed stream"
456
+ #
457
+ # Related: Logger#reopen.
458
+ #
459
+ # source://logger//logger.rb#731
460
+ def close; end
461
+
462
+ # Returns the date-time format; see #datetime_format=.
463
+ #
464
+ # source://logger//logger.rb#438
465
+ def datetime_format; end
466
+
467
+ # Sets the date-time format.
468
+ #
469
+ # Argument +datetime_format+ should be either of these:
470
+ #
471
+ # - A string suitable for use as a format for method
472
+ # {Time#strftime}[rdoc-ref:Time#strftime].
473
+ # - +nil+: the logger uses <tt>'%Y-%m-%dT%H:%M:%S.%6N'</tt>.
474
+ #
475
+ # source://logger//logger.rb#432
476
+ def datetime_format=(datetime_format); end
477
+
478
+ # Equivalent to calling #add with severity <tt>Logger::DEBUG</tt>.
479
+ #
480
+ # source://logger//logger.rb#690
481
+ def debug(progname = T.unsafe(nil), &block); end
482
+
483
+ # Sets the log level to Logger::DEBUG.
484
+ # See {Log Level}[rdoc-ref:Logger@Log+Level].
485
+ #
486
+ # source://logger//logger.rb#487
487
+ def debug!; end
488
+
489
+ # Returns +true+ if the log level allows entries with severity
490
+ # Logger::DEBUG to be written, +false+ otherwise.
491
+ # See {Log Level}[rdoc-ref:Logger@Log+Level].
492
+ #
493
+ # @return [Boolean]
494
+ #
495
+ # source://logger//logger.rb#482
496
+ def debug?; end
497
+
498
+ # Equivalent to calling #add with severity <tt>Logger::ERROR</tt>.
499
+ #
500
+ # source://logger//logger.rb#708
501
+ def error(progname = T.unsafe(nil), &block); end
502
+
503
+ # Sets the log level to Logger::ERROR.
504
+ # See {Log Level}[rdoc-ref:Logger@Log+Level].
505
+ #
506
+ # source://logger//logger.rb#520
507
+ def error!; end
508
+
509
+ # Returns +true+ if the log level allows entries with severity
510
+ # Logger::ERROR to be written, +false+ otherwise.
511
+ # See {Log Level}[rdoc-ref:Logger@Log+Level].
512
+ #
513
+ # @return [Boolean]
514
+ #
515
+ # source://logger//logger.rb#515
516
+ def error?; end
517
+
518
+ # Equivalent to calling #add with severity <tt>Logger::FATAL</tt>.
519
+ #
520
+ # source://logger//logger.rb#714
521
+ def fatal(progname = T.unsafe(nil), &block); end
522
+
523
+ # Sets the log level to Logger::FATAL.
524
+ # See {Log Level}[rdoc-ref:Logger@Log+Level].
525
+ #
526
+ # source://logger//logger.rb#531
527
+ def fatal!; end
528
+
529
+ # Returns +true+ if the log level allows entries with severity
530
+ # Logger::FATAL to be written, +false+ otherwise.
531
+ # See {Log Level}[rdoc-ref:Logger@Log+Level].
532
+ #
533
+ # @return [Boolean]
534
+ #
535
+ # source://logger//logger.rb#526
536
+ def fatal?; end
537
+
538
+ # Sets or retrieves the logger entry formatter proc.
539
+ #
540
+ # When +formatter+ is +nil+, the logger uses Logger::Formatter.
541
+ #
542
+ # When +formatter+ is a proc, a new entry is formatted by the proc,
543
+ # which is called with four arguments:
544
+ #
545
+ # - +severity+: The severity of the entry.
546
+ # - +time+: A Time object representing the entry's timestamp.
547
+ # - +progname+: The program name for the entry.
548
+ # - +msg+: The message for the entry (string or string-convertible object).
549
+ #
550
+ # The proc should return a string containing the formatted entry.
551
+ #
552
+ # This custom formatter uses
553
+ # {String#dump}[rdoc-ref:String#dump]
554
+ # to escape the message string:
555
+ #
556
+ # logger = Logger.new($stdout, progname: 'mung')
557
+ # original_formatter = logger.formatter || Logger::Formatter.new
558
+ # logger.formatter = proc { |severity, time, progname, msg|
559
+ # original_formatter.call(severity, time, progname, msg.dump)
560
+ # }
561
+ # logger.add(Logger::INFO, "hello \n ''")
562
+ # logger.add(Logger::INFO, "\f\x00\xff\\\"")
563
+ #
564
+ # Output:
565
+ #
566
+ # I, [2022-05-13T13:16:29.637488 #8492] INFO -- mung: "hello \n ''"
567
+ # I, [2022-05-13T13:16:29.637610 #8492] INFO -- mung: "\f\x00\xFF\\\""
568
+ #
569
+ # source://logger//logger.rb#473
570
+ def formatter; end
571
+
572
+ # Sets or retrieves the logger entry formatter proc.
573
+ #
574
+ # When +formatter+ is +nil+, the logger uses Logger::Formatter.
575
+ #
576
+ # When +formatter+ is a proc, a new entry is formatted by the proc,
577
+ # which is called with four arguments:
578
+ #
579
+ # - +severity+: The severity of the entry.
580
+ # - +time+: A Time object representing the entry's timestamp.
581
+ # - +progname+: The program name for the entry.
582
+ # - +msg+: The message for the entry (string or string-convertible object).
583
+ #
584
+ # The proc should return a string containing the formatted entry.
585
+ #
586
+ # This custom formatter uses
587
+ # {String#dump}[rdoc-ref:String#dump]
588
+ # to escape the message string:
589
+ #
590
+ # logger = Logger.new($stdout, progname: 'mung')
591
+ # original_formatter = logger.formatter || Logger::Formatter.new
592
+ # logger.formatter = proc { |severity, time, progname, msg|
593
+ # original_formatter.call(severity, time, progname, msg.dump)
594
+ # }
595
+ # logger.add(Logger::INFO, "hello \n ''")
596
+ # logger.add(Logger::INFO, "\f\x00\xff\\\"")
597
+ #
598
+ # Output:
599
+ #
600
+ # I, [2022-05-13T13:16:29.637488 #8492] INFO -- mung: "hello \n ''"
601
+ # I, [2022-05-13T13:16:29.637610 #8492] INFO -- mung: "\f\x00\xFF\\\""
602
+ #
603
+ # source://logger//logger.rb#473
604
+ def formatter=(_arg0); end
605
+
606
+ # Equivalent to calling #add with severity <tt>Logger::INFO</tt>.
607
+ #
608
+ # source://logger//logger.rb#696
609
+ def info(progname = T.unsafe(nil), &block); end
610
+
611
+ # Sets the log level to Logger::INFO.
612
+ # See {Log Level}[rdoc-ref:Logger@Log+Level].
613
+ #
614
+ # source://logger//logger.rb#498
615
+ def info!; end
616
+
617
+ # Returns +true+ if the log level allows entries with severity
618
+ # Logger::INFO to be written, +false+ otherwise.
619
+ # See {Log Level}[rdoc-ref:Logger@Log+Level].
620
+ #
621
+ # @return [Boolean]
622
+ #
623
+ # source://logger//logger.rb#493
624
+ def info?; end
625
+
626
+ # Logging severity threshold (e.g. <tt>Logger::INFO</tt>).
627
+ #
628
+ # source://logger//logger.rb#383
629
+ def level; end
630
+
631
+ # Sets the log level; returns +severity+.
632
+ # See {Log Level}[rdoc-ref:Logger@Log+Level].
633
+ #
634
+ # Argument +severity+ may be an integer, a string, or a symbol:
635
+ #
636
+ # logger.level = Logger::ERROR # => 3
637
+ # logger.level = 3 # => 3
638
+ # logger.level = 'error' # => "error"
639
+ # logger.level = :error # => :error
640
+ #
641
+ # Logger#sev_threshold= is an alias for Logger#level=.
642
+ #
643
+ # source://logger//logger.rb#399
644
+ def level=(severity); end
645
+
646
+ # Creates a log entry, which may or may not be written to the log,
647
+ # depending on the entry's severity and on the log level.
648
+ # See {Log Level}[rdoc-ref:Logger@Log+Level]
649
+ # and {Entries}[rdoc-ref:Logger@Entries] for details.
650
+ #
651
+ # Examples:
652
+ #
653
+ # logger = Logger.new($stdout, progname: 'mung')
654
+ # logger.add(Logger::INFO)
655
+ # logger.add(Logger::ERROR, 'No good')
656
+ # logger.add(Logger::ERROR, 'No good', 'gnum')
657
+ #
658
+ # Output:
659
+ #
660
+ # I, [2022-05-12T16:25:31.469726 #36328] INFO -- mung: mung
661
+ # E, [2022-05-12T16:25:55.349414 #36328] ERROR -- mung: No good
662
+ # E, [2022-05-12T16:26:35.841134 #36328] ERROR -- gnum: No good
663
+ #
664
+ # These convenience methods have implicit severity:
665
+ #
666
+ # - #debug.
667
+ # - #info.
668
+ # - #warn.
669
+ # - #error.
670
+ # - #fatal.
671
+ # - #unknown.
672
+ #
673
+ # source://logger//logger.rb#651
674
+ def log(severity, message = T.unsafe(nil), progname = T.unsafe(nil)); end
675
+
676
+ # Program name to include in log messages.
677
+ #
678
+ # source://logger//logger.rb#422
679
+ def progname; end
680
+
681
+ # Program name to include in log messages.
682
+ #
683
+ # source://logger//logger.rb#422
684
+ def progname=(_arg0); end
685
+
686
+ # Sets the logger's output stream:
687
+ #
688
+ # - If +logdev+ is +nil+, reopens the current output stream.
689
+ # - If +logdev+ is a filepath, opens the indicated file for append.
690
+ # - If +logdev+ is an IO stream
691
+ # (usually <tt>$stdout</tt>, <tt>$stderr</tt>, or an open File object),
692
+ # opens the stream for append.
693
+ #
694
+ # Example:
695
+ #
696
+ # logger = Logger.new('t.log')
697
+ # logger.add(Logger::ERROR, 'one')
698
+ # logger.close
699
+ # logger.add(Logger::ERROR, 'two') # Prints 'log writing failed. closed stream'
700
+ # logger.reopen
701
+ # logger.add(Logger::ERROR, 'three')
702
+ # logger.close
703
+ # File.readlines('t.log')
704
+ # # =>
705
+ # # ["# Logfile created on 2022-05-12 14:21:19 -0500 by logger.rb/v1.5.0\n",
706
+ # # "E, [2022-05-12T14:21:27.596726 #22428] ERROR -- : one\n",
707
+ # # "E, [2022-05-12T14:23:05.847241 #22428] ERROR -- : three\n"]
708
+ #
709
+ # source://logger//logger.rb#619
710
+ def reopen(logdev = T.unsafe(nil)); end
711
+
712
+ # Logging severity threshold (e.g. <tt>Logger::INFO</tt>).
713
+ #
714
+ # source://logger//logger.rb#383
715
+ def sev_threshold; end
716
+
717
+ # Sets the log level; returns +severity+.
718
+ # See {Log Level}[rdoc-ref:Logger@Log+Level].
719
+ #
720
+ # Argument +severity+ may be an integer, a string, or a symbol:
721
+ #
722
+ # logger.level = Logger::ERROR # => 3
723
+ # logger.level = 3 # => 3
724
+ # logger.level = 'error' # => "error"
725
+ # logger.level = :error # => :error
726
+ #
727
+ # Logger#sev_threshold= is an alias for Logger#level=.
728
+ #
729
+ # source://logger//logger.rb#399
730
+ def sev_threshold=(severity); end
731
+
732
+ # Equivalent to calling #add with severity <tt>Logger::UNKNOWN</tt>.
733
+ #
734
+ # source://logger//logger.rb#720
735
+ def unknown(progname = T.unsafe(nil), &block); end
736
+
737
+ # Equivalent to calling #add with severity <tt>Logger::WARN</tt>.
738
+ #
739
+ # source://logger//logger.rb#702
740
+ def warn(progname = T.unsafe(nil), &block); end
741
+
742
+ # Sets the log level to Logger::WARN.
743
+ # See {Log Level}[rdoc-ref:Logger@Log+Level].
744
+ #
745
+ # source://logger//logger.rb#509
746
+ def warn!; end
747
+
748
+ # Returns +true+ if the log level allows entries with severity
749
+ # Logger::WARN to be written, +false+ otherwise.
750
+ # See {Log Level}[rdoc-ref:Logger@Log+Level].
751
+ #
752
+ # @return [Boolean]
753
+ #
754
+ # source://logger//logger.rb#504
755
+ def warn?; end
756
+
757
+ # Adjust the log level during the block execution for the current Fiber only
758
+ #
759
+ # logger.with_level(:debug) do
760
+ # logger.debug { "Hello" }
761
+ # end
762
+ #
763
+ # source://logger//logger.rb#408
764
+ def with_level(severity); end
765
+
766
+ private
767
+
768
+ # source://logger//logger.rb#744
769
+ def format_message(severity, datetime, progname, msg); end
770
+
771
+ # source://logger//logger.rb#740
772
+ def format_severity(severity); end
773
+ end
774
+
775
+ # Default formatter for log messages.
776
+ class Logger::Formatter
777
+ # @return [Formatter] a new instance of Formatter
778
+ #
779
+ # source://logger//logger/formatter.rb#11
780
+ def initialize; end
781
+
782
+ # source://logger//logger/formatter.rb#15
783
+ def call(severity, time, progname, msg); end
784
+
785
+ # Returns the value of attribute datetime_format.
786
+ #
787
+ # source://logger//logger/formatter.rb#9
788
+ def datetime_format; end
789
+
790
+ # Sets the attribute datetime_format
791
+ #
792
+ # @param value the value to set the attribute datetime_format to.
793
+ #
794
+ # source://logger//logger/formatter.rb#9
795
+ def datetime_format=(_arg0); end
796
+
797
+ private
798
+
799
+ # source://logger//logger/formatter.rb#21
800
+ def format_datetime(time); end
801
+
802
+ # source://logger//logger/formatter.rb#25
803
+ def msg2str(msg); end
804
+ end
805
+
806
+ # source://logger//logger/formatter.rb#7
807
+ Logger::Formatter::DatetimeFormat = T.let(T.unsafe(nil), String)
808
+
809
+ # source://logger//logger/formatter.rb#6
810
+ Logger::Formatter::Format = T.let(T.unsafe(nil), String)
811
+
812
+ # Device used for logging messages.
813
+ class Logger::LogDevice
814
+ include ::Logger::Period
815
+ include ::MonitorMixin
816
+
817
+ # @return [LogDevice] a new instance of LogDevice
818
+ #
819
+ # source://logger//logger/log_device.rb#14
820
+ def initialize(log = T.unsafe(nil), shift_age: T.unsafe(nil), shift_size: T.unsafe(nil), shift_period_suffix: T.unsafe(nil), binmode: T.unsafe(nil)); end
821
+
822
+ # source://logger//logger/log_device.rb#52
823
+ def close; end
824
+
825
+ # Returns the value of attribute dev.
826
+ #
827
+ # source://logger//logger/log_device.rb#10
828
+ def dev; end
829
+
830
+ # Returns the value of attribute filename.
831
+ #
832
+ # source://logger//logger/log_device.rb#11
833
+ def filename; end
834
+
835
+ # source://logger//logger/log_device.rb#62
836
+ def reopen(log = T.unsafe(nil)); end
837
+
838
+ # source://logger//logger/log_device.rb#31
839
+ def write(message); end
840
+
841
+ private
842
+
843
+ # source://logger//logger/log_device.rb#119
844
+ def add_log_header(file); end
845
+
846
+ # source://logger//logger/log_device.rb#125
847
+ def check_shift_log; end
848
+
849
+ # source://logger//logger/log_device.rb#103
850
+ def create_logfile(filename); end
851
+
852
+ # source://logger//logger/log_device.rb#145
853
+ def lock_shift_log; end
854
+
855
+ # source://logger//logger/log_device.rb#95
856
+ def open_logfile(filename); end
857
+
858
+ # source://logger//logger/log_device.rb#79
859
+ def set_dev(log); end
860
+
861
+ # source://logger//logger/log_device.rb#176
862
+ def shift_log_age; end
863
+
864
+ # source://logger//logger/log_device.rb#188
865
+ def shift_log_period(period_end); end
866
+ end
867
+
868
+ module Logger::Period
869
+ private
870
+
871
+ # source://logger//logger/period.rb#9
872
+ def next_rotate_time(now, shift_age); end
873
+
874
+ # source://logger//logger/period.rb#31
875
+ def previous_period_end(now, shift_age); end
876
+
877
+ class << self
878
+ # source://logger//logger/period.rb#9
879
+ def next_rotate_time(now, shift_age); end
880
+
881
+ # source://logger//logger/period.rb#31
882
+ def previous_period_end(now, shift_age); end
883
+ end
884
+ end
885
+
886
+ # source://logger//logger/period.rb#7
887
+ Logger::Period::SiD = T.let(T.unsafe(nil), Integer)
888
+
889
+ # \Severity label for logging (max 5 chars).
890
+ #
891
+ # source://logger//logger.rb#738
892
+ Logger::SEV_LABEL = T.let(T.unsafe(nil), Array)
893
+
894
+ # Logging severity.
895
+ module Logger::Severity
896
+ class << self
897
+ # source://logger//logger/severity.rb#29
898
+ def coerce(severity); end
899
+ end
900
+ end
901
+
902
+ # source://logger//logger/severity.rb#19
903
+ Logger::Severity::LEVELS = T.let(T.unsafe(nil), Hash)