From 195bdd80d82143d8cd488a9c83b853b994d7feb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A9=20Dupuis?= Date: Tue, 17 Sep 2024 11:53:48 -0700 Subject: [PATCH 1/6] Fix license link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 649684f..ceb1a21 100644 --- a/README.md +++ b/README.md @@ -101,4 +101,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/l ## License -The gem is available as open source under the terms of the [BSD-2-Clause](LICENSE.txt). +The gem is available as open source under the terms of the [BSD-2-Clause](BSDL). From dae2b832cd280ce175d2d7dc1869b8abae114eed Mon Sep 17 00:00:00 2001 From: Hartley McGuire Date: Thu, 7 Nov 2024 00:17:05 +0000 Subject: [PATCH 2/6] Enable subclasses to configure level isolation (#103) `Logger#with_level` was recently added to enable configuring a `Logger`'s level for the duration of a block. However, the configured level is always tied to the currently running `Fiber`, which is not always ideal in applications that mix `Thread`s and `Fiber`s. For example, Active Support has provided a similar feature (`ActiveSupport::Logger#log_at`) which, depending on configuration, can be isolated to either `Thread`s or `Fiber`s. This commit enables subclasses of `Logger` to customize the level isolation. Ideally, it will enable replacing most of Active Support's `#log_at`, since both methods end up serving the same purpose. --- lib/logger.rb | 12 +++++++---- test/logger/test_severity.rb | 42 +++++++++++++++++++++++++++++++++--- 2 files changed, 47 insertions(+), 7 deletions(-) diff --git a/lib/logger.rb b/lib/logger.rb index 4735209..8d6e0d7 100644 --- a/lib/logger.rb +++ b/lib/logger.rb @@ -381,7 +381,7 @@ class Logger # Logging severity threshold (e.g. Logger::INFO). def level - level_override[Fiber.current] || @level + level_override[level_key] || @level end # Sets the log level; returns +severity+. @@ -406,14 +406,14 @@ def level=(severity) # logger.debug { "Hello" } # end def with_level(severity) - prev, level_override[Fiber.current] = level, Severity.coerce(severity) + prev, level_override[level_key] = level, Severity.coerce(severity) begin yield ensure if prev - level_override[Fiber.current] = prev + level_override[level_key] = prev else - level_override.delete(Fiber.current) + level_override.delete(level_key) end end end @@ -751,6 +751,10 @@ def level_override @level_override ||= {} end + def level_key + Fiber.current + end + def format_message(severity, datetime, progname, msg) (@formatter || @default_formatter).call(severity, datetime, progname, msg) end diff --git a/test/logger/test_severity.rb b/test/logger/test_severity.rb index e1069c8..fb26939 100644 --- a/test/logger/test_severity.rb +++ b/test/logger/test_severity.rb @@ -26,7 +26,7 @@ def test_level_assignment end end - def test_thread_local_level + def test_fiber_local_level logger = Logger.new(nil) logger.level = INFO # default level other = Logger.new(nil) @@ -40,14 +40,50 @@ def test_thread_local_level logger.with_level(DEBUG) do # verify reentrancy assert_equal(logger.level, DEBUG) - Thread.new do + Fiber.new do assert_equal(logger.level, INFO) logger.with_level(:WARN) do assert_equal(other.level, ERROR) assert_equal(logger.level, WARN) end assert_equal(logger.level, INFO) - end.join + end.resume + + assert_equal(logger.level, DEBUG) + end + assert_equal(logger.level, WARN) + end + assert_equal(logger.level, INFO) + end + + def test_thread_local_level + subclass = Class.new(Logger) do + def level_key + Thread.current + end + end + + logger = subclass.new(nil) + logger.level = INFO # default level + other = subclass.new(nil) + other.level = ERROR # default level + + assert_equal(other.level, ERROR) + logger.with_level(:WARN) do + assert_equal(other.level, ERROR) + assert_equal(logger.level, WARN) + + logger.with_level(DEBUG) do # verify reentrancy + assert_equal(logger.level, DEBUG) + + Fiber.new do + assert_equal(logger.level, DEBUG) + logger.with_level(:WARN) do + assert_equal(other.level, ERROR) + assert_equal(logger.level, WARN) + end + assert_equal(logger.level, DEBUG) + end.resume assert_equal(logger.level, DEBUG) end From 1a64cb552f0dc568cb7fb03c3b96a62f39c1d081 Mon Sep 17 00:00:00 2001 From: Mike Linksvayer Date: Mon, 25 Nov 2024 12:25:42 -0800 Subject: [PATCH 3/6] include license texts in gem --- logger.gemspec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/logger.gemspec b/logger.gemspec index 5e8232e..ed55111 100644 --- a/logger.gemspec +++ b/logger.gemspec @@ -15,7 +15,7 @@ Gem::Specification.new do |spec| spec.homepage = "https://github.com/ruby/logger" spec.licenses = ["Ruby", "BSD-2-Clause"] - spec.files = Dir.glob("lib/**/*.rb") + ["logger.gemspec"] + spec.files = Dir.glob("lib/**/*.rb") + ["logger.gemspec", "BSDL", "COPYING"] spec.require_paths = ["lib"] spec.required_ruby_version = ">= 2.5.0" From a7fae5e790b67f4260118b2b776289a9bdbdef20 Mon Sep 17 00:00:00 2001 From: Mike Linksvayer Date: Mon, 25 Nov 2024 20:54:18 +0000 Subject: [PATCH 4/6] update license files in rdoc task --- Rakefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Rakefile b/Rakefile index 35dd06e..d630ceb 100644 --- a/Rakefile +++ b/Rakefile @@ -14,7 +14,7 @@ require "rdoc/task" RDoc::Task.new do |doc| doc.main = "README.md" doc.title = "Logger -- Ruby Standard Logger" - doc.rdoc_files = FileList.new %w[README.md lib LICENSE.txt] + doc.rdoc_files = FileList.new %w[README.md lib BSDL COPYING] doc.rdoc_dir = "html" end From 9512a54122060e83500c97451a634992033a8f20 Mon Sep 17 00:00:00 2001 From: Hiroshi SHIBATA Date: Mon, 2 Dec 2024 17:01:27 +0900 Subject: [PATCH 5/6] Enabled trusted publisher for rubygems.org --- .github/workflows/push_gem.yml | 46 ++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 .github/workflows/push_gem.yml diff --git a/.github/workflows/push_gem.yml b/.github/workflows/push_gem.yml new file mode 100644 index 0000000..73c515c --- /dev/null +++ b/.github/workflows/push_gem.yml @@ -0,0 +1,46 @@ +name: Publish gem to rubygems.org + +on: + push: + tags: + - 'v*' + +permissions: + contents: read + +jobs: + push: + if: github.repository == 'ruby/logger' + runs-on: ubuntu-latest + + environment: + name: rubygems.org + url: https://rubygems.org/gems/logger + + permissions: + contents: write + id-token: write + + steps: + - name: Harden Runner + uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2 + with: + egress-policy: audit + + - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4 + + - name: Set up Ruby + uses: ruby/setup-ruby@a6e6f86333f0a2523ece813039b8b4be04560854 # v1.190.0 + with: + bundler-cache: true + ruby-version: ruby + + - name: Publish to RubyGems + uses: rubygems/release-gem@9e85cb11501bebc2ae661c1500176316d3987059 # v1.1.0 + + - name: Create GitHub release + run: | + tag_name="$(git describe --tags --abbrev=0)" + gh release create "${tag_name}" --verify-tag --generate-notes + env: + GITHUB_TOKEN: ${{ secrets.MATZBOT_GITHUB_WORKFLOW_TOKEN }} From 2d07f086f8aa0bd5923a072ce7bd15e5dd301f16 Mon Sep 17 00:00:00 2001 From: Hiroshi SHIBATA Date: Mon, 2 Dec 2024 17:03:35 +0900 Subject: [PATCH 6/6] Bump up 1.6.2 --- lib/logger/version.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/logger/version.rb b/lib/logger/version.rb index 2a0801b..15fc5bc 100644 --- a/lib/logger/version.rb +++ b/lib/logger/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true class Logger - VERSION = "1.6.1" + VERSION = "1.6.2" end