silent_stream 1.0.11 → 1.0.13

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.
@@ -1,7 +1,11 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module SilentStream
4
+ # Version namespace for this gem.
4
5
  module Version
5
- VERSION = "1.0.11"
6
+ # Current gem version.
7
+ VERSION = "1.0.13"
6
8
  end
9
+ # Current gem version exposed at the traditional constant location.
10
+ VERSION = Version::VERSION # Traditional Constant Location
7
11
  end
data/lib/silent_stream.rb CHANGED
@@ -8,9 +8,9 @@ require "logger" # as of Ruby 3.5
8
8
 
9
9
  # External gems
10
10
  require "version_gem"
11
+ require_relative "silent_stream/version"
11
12
 
12
13
  # This gem
13
- require_relative "silent_stream/version"
14
14
 
15
15
  module SilentStream
16
16
  def self.included(base)
@@ -21,14 +21,14 @@ module SilentStream
21
21
  end
22
22
 
23
23
  module Enhanced
24
- # param switch is true or false
25
- # By default it is true, when means we don't want logging.
26
- # Switching it to false enables logging again.
27
- # By default, ERROR log level continues to be logged.
28
- # The return value is the return value of the block,
29
- # so you can use it without changing code structure.
24
+ # Silences STDOUT and optionally a Logger while executing the block.
30
25
  #
31
- # This method is not thread-safe.
26
+ # @param switch [Boolean] When false, do not silence. Defaults to true.
27
+ # @param temporary_level [Integer] Logger level to set temporarily (e.g., Logger::ERROR).
28
+ # @param logger [Logger, nil] Logger instance to adjust; defaults to Rails.logger when available.
29
+ # @yield The work to perform while silenced.
30
+ # @return [Object] Returns the block's return value.
31
+ # @note This method is not thread-safe.
32
32
  def silence_all(switch = true, temporary_level = Logger::ERROR, logger = nil, &block)
33
33
  if !switch || silent_stream_no_silence
34
34
  yield
@@ -67,10 +67,14 @@ module SilentStream
67
67
  SILENT_STREAM_NULL_DEVICE = if defined?(IO::NULL)
68
68
  IO::NULL
69
69
  else
70
+ # :nocov:
70
71
  Gem.win_platform? ? "NUL:" : "/dev/null"
72
+ # :nocov:
71
73
  end
72
74
 
73
75
  # This method is not thread-safe.
76
+ # @yield Work to perform while STDERR is silenced.
77
+ # @return [Object] The block's return value.
74
78
  def silence_stderr(&block)
75
79
  silence_stream(STDERR, &block)
76
80
  end
@@ -83,12 +87,15 @@ module SilentStream
83
87
  #
84
88
  # puts 'But this will'
85
89
  #
86
- # This method is not thread-safe.
90
+ # @param stream [IO] The stream to silence (e.g., STDOUT or STDERR).
91
+ # @yield Work to perform while the stream is silenced.
92
+ # @return [Object] The block's return value.
93
+ # @note This method is not thread-safe.
87
94
  def silence_stream(stream)
88
95
  old_stream = stream.dup
89
96
  begin
90
97
  stream.reopen(SILENT_STREAM_NULL_DEVICE, "a+")
91
- rescue Exception => e
98
+ rescue => e
92
99
  stream.puts "[SilentStream] Unable to silence. #{e.class}: #{e.message}"
93
100
  end
94
101
  stream.sync = true
@@ -114,22 +121,67 @@ module SilentStream
114
121
  # stream = capture(:stderr) { system('echo error 1>&2') }
115
122
  # stream # => "error\n"
116
123
  #
117
- # This method is not thread-safe.
124
+ # @param stream [Symbol, String] :stdout or :stderr (or equivalents), selecting which stream to capture.
125
+ # @yield Work that writes to the selected stream.
126
+ # @return [String] Captured contents of the stream written during the block.
127
+ # @note This method is not thread-safe.
118
128
  def capture(stream)
119
129
  stream = stream.to_s
130
+ io_const = (stream == "stdout") ? STDOUT : STDERR # rubocop:disable Style/GlobalStdStream
120
131
  captured_stream = Tempfile.new(stream)
121
- stream_io = eval("$#{stream}")
122
- origin_stream = stream_io.dup
123
- stream_io.reopen(captured_stream)
132
+ # Save original global var ($stdout/$stderr) and a dup of IO constant for restoration
133
+ origin_gvar = (stream == "stdout") ? $stdout : $stderr
134
+ origin_io_dup = io_const.dup
135
+ begin
136
+ io_const.reopen(captured_stream)
137
+ rescue => e
138
+ io_const.puts "[SilentStream] Unable to capture. #{e.class}: #{e.message}"
139
+ end
140
+ io_const.sync = true
141
+ if stream == "stdout"
142
+ $stdout = io_const
143
+ else
144
+ $stderr = io_const
145
+ end
124
146
 
125
147
  yield
126
148
 
127
- stream_io.rewind
149
+ begin
150
+ io_const.flush
151
+ rescue
152
+ # ignore
153
+ end
154
+ captured_stream.rewind
128
155
  captured_stream.read
129
156
  ensure
130
- captured_stream.close
131
- captured_stream.unlink
132
- stream_io.reopen(origin_stream)
157
+ begin
158
+ io_const.reopen(origin_io_dup) if defined?(io_const) && io_const
159
+ origin_io_dup.close if defined?(origin_io_dup) && origin_io_dup
160
+ rescue
161
+ # ignore
162
+ end
163
+ # Unexpected, and not reasonably testable.
164
+ # :nocov:
165
+ raise "Expected the global variable to exist" unless defined?(origin_gvar)
166
+ # :nocov:
167
+
168
+ if stream == "stdout"
169
+ $stdout = origin_gvar
170
+ else
171
+ $stderr = origin_gvar
172
+ end
173
+ if defined?(captured_stream) && captured_stream
174
+ begin
175
+ captured_stream.close
176
+ rescue
177
+ nil
178
+ end
179
+ begin
180
+ captured_stream.unlink
181
+ rescue
182
+ nil
183
+ end
184
+ end
133
185
  end
134
186
  # silence is provided by the LoggerSilence concern that continues to be
135
187
  # shipped with Rails, so not continuing with this alias.
@@ -139,12 +191,16 @@ module SilentStream
139
191
  #
140
192
  # quietly { system 'bundle install' }
141
193
  #
142
- # This method is not thread-safe.
194
+ # @yield Work to perform while both streams are silenced.
195
+ # @return [Object] The block's return value.
196
+ # @note This method is not thread-safe.
197
+ # rubocop:disable Style/GlobalStdStream
143
198
  def quietly(&block)
144
199
  silence_stream(STDOUT) do
145
200
  silence_stream(STDERR, &block)
146
201
  end
147
202
  end
203
+ # rubocop:enable Style/GlobalStdStream
148
204
 
149
205
  private
150
206
 
@@ -0,0 +1,48 @@
1
+ module SilentStream
2
+ module Enhanced
3
+ # Silence STDOUT (and optionally a Logger) while executing the given block.
4
+ # When switch is false or NO_SILENCE env var is true, the block executes without silencing.
5
+ # Returns the block's return value.
6
+ def silence_all: (*untyped) { () -> untyped } -> untyped
7
+
8
+ private
9
+
10
+ def silent_stream_no_silence: () -> bool
11
+ def silent_stream_logger: () -> (::Logger | nil)
12
+ # Sets logger.level, returns previous level (Integer) or true when previous level was nil
13
+ def silent_stream_reset_logger_level: (::Logger?, Integer) -> (Integer | true | nil)
14
+ end
15
+
16
+ module Extracted
17
+ SILENT_STREAM_NULL_DEVICE: String | IO
18
+
19
+ # Silence STDERR for the duration of the given block.
20
+ def silence_stderr: () { () -> untyped } -> untyped
21
+
22
+ # Silences the given stream for the duration of the block.
23
+ # Returns the block's return value.
24
+ def silence_stream: (IO) { () -> untyped } -> untyped
25
+
26
+ # Capture the given stream (:stdout or :stderr) while running the block and
27
+ # return it as a String.
28
+ def capture: (Symbol | String) { () -> untyped } -> String
29
+
30
+ # Silence both STDOUT and STDERR while running the block.
31
+ # Returns the block's return value.
32
+ def quietly: () { () -> untyped } -> untyped
33
+
34
+ private
35
+
36
+ SILENT_STREAM_WINDOWS_REGEXP: Regexp
37
+ SILENT_STREAM_REGEXP_HAS_MATCH: bool
38
+ def windows_os_test: () -> (bool | Integer)
39
+ end
40
+
41
+ module Version
42
+ VERSION: String
43
+ end
44
+ VERSION: String
45
+ end
46
+
47
+ module SilentStream::Version
48
+ end
data.tar.gz.sig CHANGED
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: silent_stream
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.11
4
+ version: 1.0.13
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jeremy Daer
@@ -29,7 +29,7 @@ authors:
29
29
  - Alex Tambellini
30
30
  - Arthur Nogueira Neves
31
31
  - Anil Wadghule
32
- - Peter Boling
32
+ - Peter H. Boling
33
33
  bindir: exe
34
34
  cert_chain:
35
35
  - |
@@ -60,7 +60,7 @@ cert_chain:
60
60
  DVjBtqT23eugOqQ73umLcYDZkc36vnqGxUBSsXrzY9pzV5gGr2I8YUxMqf6ATrZt
61
61
  L9nRqA==
62
62
  -----END CERTIFICATE-----
63
- date: 2025-05-16 00:00:00.000000000 Z
63
+ date: 1980-01-02 00:00:00.000000000 Z
64
64
  dependencies:
65
65
  - !ruby/object:Gem::Dependency
66
66
  name: logger
@@ -97,68 +97,123 @@ dependencies:
97
97
  - !ruby/object:Gem::Version
98
98
  version: '3'
99
99
  - !ruby/object:Gem::Dependency
100
- name: minitest
100
+ name: kettle-dev
101
101
  requirement: !ruby/object:Gem::Requirement
102
102
  requirements:
103
+ - - "~>"
104
+ - !ruby/object:Gem::Version
105
+ version: '3.1'
103
106
  - - ">="
104
107
  - !ruby/object:Gem::Version
105
- version: '5.15'
108
+ version: 3.1.29
106
109
  type: :development
107
110
  prerelease: false
108
111
  version_requirements: !ruby/object:Gem::Requirement
109
112
  requirements:
113
+ - - "~>"
114
+ - !ruby/object:Gem::Version
115
+ version: '3.1'
110
116
  - - ">="
111
117
  - !ruby/object:Gem::Version
112
- version: '5.15'
118
+ version: 3.1.29
113
119
  - !ruby/object:Gem::Dependency
114
- name: minitest-reporters
120
+ name: bundler-audit
115
121
  requirement: !ruby/object:Gem::Requirement
116
122
  requirements:
123
+ - - "~>"
124
+ - !ruby/object:Gem::Version
125
+ version: 0.9.3
126
+ type: :development
127
+ prerelease: false
128
+ version_requirements: !ruby/object:Gem::Requirement
129
+ requirements:
130
+ - - "~>"
131
+ - !ruby/object:Gem::Version
132
+ version: 0.9.3
133
+ - !ruby/object:Gem::Dependency
134
+ name: rake
135
+ requirement: !ruby/object:Gem::Requirement
136
+ requirements:
137
+ - - "~>"
138
+ - !ruby/object:Gem::Version
139
+ version: '13.0'
140
+ type: :development
141
+ prerelease: false
142
+ version_requirements: !ruby/object:Gem::Requirement
143
+ requirements:
144
+ - - "~>"
145
+ - !ruby/object:Gem::Version
146
+ version: '13.0'
147
+ - !ruby/object:Gem::Dependency
148
+ name: require_bench
149
+ requirement: !ruby/object:Gem::Requirement
150
+ requirements:
151
+ - - "~>"
152
+ - !ruby/object:Gem::Version
153
+ version: '1.0'
117
154
  - - ">="
118
155
  - !ruby/object:Gem::Version
119
- version: '0'
156
+ version: 1.0.4
120
157
  type: :development
121
158
  prerelease: false
122
159
  version_requirements: !ruby/object:Gem::Requirement
123
160
  requirements:
161
+ - - "~>"
162
+ - !ruby/object:Gem::Version
163
+ version: '1.0'
124
164
  - - ">="
125
165
  - !ruby/object:Gem::Version
126
- version: '0'
166
+ version: 1.0.4
127
167
  - !ruby/object:Gem::Dependency
128
- name: mocha
168
+ name: anonymous_loader
129
169
  requirement: !ruby/object:Gem::Requirement
130
170
  requirements:
171
+ - - "~>"
172
+ - !ruby/object:Gem::Version
173
+ version: '0.1'
131
174
  - - ">="
132
175
  - !ruby/object:Gem::Version
133
- version: '0'
176
+ version: 0.1.5
134
177
  type: :development
135
178
  prerelease: false
136
179
  version_requirements: !ruby/object:Gem::Requirement
137
180
  requirements:
181
+ - - "~>"
182
+ - !ruby/object:Gem::Version
183
+ version: '0.1'
138
184
  - - ">="
139
185
  - !ruby/object:Gem::Version
140
- version: '0'
186
+ version: 0.1.5
141
187
  - !ruby/object:Gem::Dependency
142
- name: rake
188
+ name: appraisal2
143
189
  requirement: !ruby/object:Gem::Requirement
144
190
  requirements:
145
191
  - - "~>"
146
192
  - !ruby/object:Gem::Version
147
- version: '13.0'
193
+ version: '3.2'
194
+ - - ">="
195
+ - !ruby/object:Gem::Version
196
+ version: 3.2.6
148
197
  type: :development
149
198
  prerelease: false
150
199
  version_requirements: !ruby/object:Gem::Requirement
151
200
  requirements:
152
201
  - - "~>"
153
202
  - !ruby/object:Gem::Version
154
- version: '13.0'
203
+ version: '3.2'
204
+ - - ">="
205
+ - !ruby/object:Gem::Version
206
+ version: 3.2.6
155
207
  - !ruby/object:Gem::Dependency
156
- name: ruby_engine
208
+ name: kettle-test
157
209
  requirement: !ruby/object:Gem::Requirement
158
210
  requirements:
159
211
  - - "~>"
160
212
  - !ruby/object:Gem::Version
161
213
  version: '2.0'
214
+ - - ">="
215
+ - !ruby/object:Gem::Version
216
+ version: 2.0.30
162
217
  type: :development
163
218
  prerelease: false
164
219
  version_requirements: !ruby/object:Gem::Requirement
@@ -166,20 +221,43 @@ dependencies:
166
221
  - - "~>"
167
222
  - !ruby/object:Gem::Version
168
223
  version: '2.0'
224
+ - - ">="
225
+ - !ruby/object:Gem::Version
226
+ version: 2.0.30
169
227
  - !ruby/object:Gem::Dependency
170
- name: ruby_version
228
+ name: turbo_tests2
171
229
  requirement: !ruby/object:Gem::Requirement
172
230
  requirements:
173
231
  - - "~>"
174
232
  - !ruby/object:Gem::Version
175
- version: '1.0'
233
+ version: '4.0'
234
+ - - ">="
235
+ - !ruby/object:Gem::Version
236
+ version: 4.0.2
176
237
  type: :development
177
238
  prerelease: false
178
239
  version_requirements: !ruby/object:Gem::Requirement
179
240
  requirements:
180
241
  - - "~>"
181
242
  - !ruby/object:Gem::Version
182
- version: '1.0'
243
+ version: '4.0'
244
+ - - ">="
245
+ - !ruby/object:Gem::Version
246
+ version: 4.0.2
247
+ - !ruby/object:Gem::Dependency
248
+ name: ruby-progressbar
249
+ requirement: !ruby/object:Gem::Requirement
250
+ requirements:
251
+ - - "~>"
252
+ - !ruby/object:Gem::Version
253
+ version: '1.13'
254
+ type: :development
255
+ prerelease: false
256
+ version_requirements: !ruby/object:Gem::Requirement
257
+ requirements:
258
+ - - "~>"
259
+ - !ruby/object:Gem::Version
260
+ version: '1.13'
183
261
  - !ruby/object:Gem::Dependency
184
262
  name: stone_checksums
185
263
  requirement: !ruby/object:Gem::Requirement
@@ -187,6 +265,9 @@ dependencies:
187
265
  - - "~>"
188
266
  - !ruby/object:Gem::Version
189
267
  version: '1.0'
268
+ - - ">="
269
+ - !ruby/object:Gem::Version
270
+ version: 1.0.11
190
271
  type: :development
191
272
  prerelease: false
192
273
  version_requirements: !ruby/object:Gem::Requirement
@@ -194,59 +275,121 @@ dependencies:
194
275
  - - "~>"
195
276
  - !ruby/object:Gem::Version
196
277
  version: '1.0'
278
+ - - ">="
279
+ - !ruby/object:Gem::Version
280
+ version: 1.0.11
197
281
  - !ruby/object:Gem::Dependency
198
- name: test-unit
282
+ name: gitmoji-regex
199
283
  requirement: !ruby/object:Gem::Requirement
200
284
  requirements:
285
+ - - "~>"
286
+ - !ruby/object:Gem::Version
287
+ version: '2.0'
201
288
  - - ">="
202
289
  - !ruby/object:Gem::Version
203
- version: '3.2'
290
+ version: 2.0.16
204
291
  type: :development
205
292
  prerelease: false
206
293
  version_requirements: !ruby/object:Gem::Requirement
207
294
  requirements:
295
+ - - "~>"
296
+ - !ruby/object:Gem::Version
297
+ version: '2.0'
208
298
  - - ">="
209
299
  - !ruby/object:Gem::Version
210
- version: '3.2'
211
- description: ActiveSupport Kernel Reporting Detritus with a few enhancements
300
+ version: 2.0.16
301
+ - !ruby/object:Gem::Dependency
302
+ name: erb
303
+ requirement: !ruby/object:Gem::Requirement
304
+ requirements:
305
+ - - ">="
306
+ - !ruby/object:Gem::Version
307
+ version: '2.2'
308
+ type: :development
309
+ prerelease: false
310
+ version_requirements: !ruby/object:Gem::Requirement
311
+ requirements:
312
+ - - ">="
313
+ - !ruby/object:Gem::Version
314
+ version: '2.2'
315
+ - !ruby/object:Gem::Dependency
316
+ name: ruby_engine
317
+ requirement: !ruby/object:Gem::Requirement
318
+ requirements:
319
+ - - "~>"
320
+ - !ruby/object:Gem::Version
321
+ version: '2.0'
322
+ - - ">="
323
+ - !ruby/object:Gem::Version
324
+ version: 2.0.3
325
+ type: :development
326
+ prerelease: false
327
+ version_requirements: !ruby/object:Gem::Requirement
328
+ requirements:
329
+ - - "~>"
330
+ - !ruby/object:Gem::Version
331
+ version: '2.0'
332
+ - - ">="
333
+ - !ruby/object:Gem::Version
334
+ version: 2.0.3
335
+ - !ruby/object:Gem::Dependency
336
+ name: ruby_version
337
+ requirement: !ruby/object:Gem::Requirement
338
+ requirements:
339
+ - - "~>"
340
+ - !ruby/object:Gem::Version
341
+ version: '1.0'
342
+ - - ">="
343
+ - !ruby/object:Gem::Version
344
+ version: 1.0.3
345
+ type: :development
346
+ prerelease: false
347
+ version_requirements: !ruby/object:Gem::Requirement
348
+ requirements:
349
+ - - "~>"
350
+ - !ruby/object:Gem::Version
351
+ version: '1.0'
352
+ - - ">="
353
+ - !ruby/object:Gem::Version
354
+ version: 1.0.3
355
+ description: "\U0001FAB6 (formerly) ActiveSupport Kernel Reporting Detritus with a
356
+ few enhancementsFund overlooked open source projects - bottom of stack, dev/test
357
+ dependencies: floss-funding.dev"
212
358
  email:
213
- - peter.boling@gmail.com
359
+ - floss@galtzo.com
214
360
  executables: []
215
361
  extensions: []
216
- extra_rdoc_files:
217
- - CHANGELOG.md
218
- - CODE_OF_CONDUCT.md
219
- - CONTRIBUTING.md
220
- - LICENSE.txt
221
- - README.md
222
- - SECURITY.md
362
+ extra_rdoc_files: []
223
363
  files:
224
364
  - CHANGELOG.md
225
- - CODE_OF_CONDUCT.md
226
- - CONTRIBUTING.md
227
- - LICENSE.txt
365
+ - LICENSE.md
228
366
  - README.md
229
- - SECURITY.md
230
367
  - lib/silent_stream.rb
231
368
  - lib/silent_stream/version.rb
232
- homepage: https://github.com/pboling/silent_stream
369
+ - sig/silent_stream.rbs
370
+ homepage: https://github.com/galtzo-floss/silent_stream
233
371
  licenses:
234
372
  - MIT
235
373
  metadata:
236
- homepage_uri: https://github.com/pboling/silent_stream
237
- source_code_uri: https://github.com/pboling/silent_stream/tree/v1.0.11
238
- changelog_uri: https://github.com/pboling/silent_stream/blob/v1.0.11/CHANGELOG.md
239
- bug_tracker_uri: https://github.com/pboling/silent_stream/issues
240
- documentation_uri: https://www.rubydoc.info/gems/silent_stream/1.0.11
241
- wiki_uri: https://github.com/pboling/silent_stream/wiki
242
- funding_uri: https://liberapay.com/pboling
374
+ homepage_uri: https://silent-stream.galtzo.com/
375
+ source_code_uri: https://github.com/galtzo-floss/silent_stream/tree/v1.0.13
376
+ changelog_uri: https://github.com/galtzo-floss/silent_stream/blob/v1.0.13/CHANGELOG.md
377
+ bug_tracker_uri: https://github.com/galtzo-floss/silent_stream/issues
378
+ documentation_uri: https://www.rubydoc.info/gems/silent_stream/1.0.13
379
+ funding_uri: https://github.com/sponsors/pboling
380
+ wiki_uri: https://github.com/galtzo-floss/silent_stream/wiki
243
381
  news_uri: https://www.railsbling.com/tags/silent_stream
382
+ discord_uri: https://discord.gg/3qme4XHNKN
383
+ mailing_list_uri: https://www.rubyforum.org/tag/galtzo-floss
244
384
  rubygems_mfa_required: 'true'
245
385
  rdoc_options:
246
386
  - "--title"
247
- - silent_stream - ActiveSupport's Stream Silencing - Without ActiveSupport
387
+ - "silent_stream - \U0001FAB6 formerly) ActiveSupport's Stream Silencing - Without
388
+ ActiveSupport"
248
389
  - "--main"
249
390
  - README.md
391
+ - "--exclude"
392
+ - "^sig/"
250
393
  - "--line-numbers"
251
394
  - "--inline-source"
252
395
  - "--quiet"
@@ -263,7 +406,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
263
406
  - !ruby/object:Gem::Version
264
407
  version: '0'
265
408
  requirements: []
266
- rubygems_version: 3.6.8
409
+ rubygems_version: 4.0.24
267
410
  specification_version: 4
268
- summary: ActiveSupport's Stream Silencing - Without ActiveSupport
411
+ summary: "\U0001FAB6 formerly) ActiveSupport's Stream Silencing - Without ActiveSupport"
269
412
  test_files: []
metadata.gz.sig CHANGED
Binary file