logger 1.6.2 → 1.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 513b3bfa57e4f617976d220ea3ab04b6a72f8ce0f3734b80a2de276b623d6b49
-  data.tar.gz: 26bf01af278a060e23d1d80c83e46d474933d2af9425360223656f62c04c8df6
+  metadata.gz: 46ba87e952de11303f4d8a1801c62441825513ed53de7ab20ec75d21b9524cdb
+  data.tar.gz: 985b136ab6b4027a0c28b8980374fc3beed8f3df3b31ee02fe57c0de5ab3cb56
 SHA512:
-  metadata.gz: be737e542a0c9763d280be61f8fe045c72db441f4c25032c3ac332c926abf21c0e957dcdabe17f8cc403348636c71c1e0ee5d9220ea9108572b8d3457e1e00f9
-  data.tar.gz: bcc5494d61bda582003ba814ceadce03476ca58cbecad391053b5d7b98538d3ee047bb2cce72efb80af54df0947ec82c9c993124dd91dbb1c421401b356b613f
+  metadata.gz: c3cb3e144eab09fddc21017774faa4b4f4260ddba3bc8d1b0244654c3c2bf13e610debfd3cef36e9bb83b31379dc5853384accadb586f3415deb090ac0fc1fdb
+  data.tar.gz: 82b5a284490100bee206a12e7030e3fb6287aca0ce8196e7ccc0673445b9b713df77438514b36f2e711523d5e2d1bdb897b83811ea752b3bbe26940efacee0eb

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

data/.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@a25424ba2ba8b387abc8ef40807c2c85b96cbe32 # v1.1.1
+
+      - 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 }}

data/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: test
+
+on: [push, pull_request]
+
+jobs:
+  ruby-versions:
+    uses: ruby/actions/.github/workflows/ruby_versions.yml@master
+    with:
+      engine: cruby
+      min_version: 2.5
+
+  test:
+    needs: ruby-versions
+    name: build (${{ matrix.ruby }} / ${{ matrix.os }})
+    strategy:
+      matrix:
+        ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+        exclude:
+          - ruby: 2.5
+            os: macos-latest
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run test
+      run: rake test

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+/html/
+/vendor/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "bundler"
+  gem "rake"
+  gem "test-unit"
+  gem "test-unit-ruby-core"
+end

data/README.md

@@ -0,0 +1,104 @@
+# Logger
+
+Logger is a simple but powerful logging utility to output messages in your Ruby program.
+
+Logger has the following features:
+
+ * Print messages to different levels such as `info` and `error`
+ * Auto-rolling of log files
+ * Setting the format of log messages
+ * Specifying a program name in conjunction with the message
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logger
+
+## Usage
+
+### Simple Example
+
+```ruby
+require 'logger'
+
+# Create a Logger that prints to STDOUT
+log = Logger.new(STDOUT)
+log.debug("Created Logger")
+
+log.info("Program finished")
+
+# Create a Logger that prints to STDERR
+error_log = Logger.new(STDERR)
+error_log = error_log.error("fatal error")
+```
+
+## Development
+
+After checking out the repo, run the following to install dependencies.
+
+```
+$ bin/setup
+```
+
+Then, run the tests as:
+
+```
+$ rake test
+```
+
+To install this gem onto your local machine, run
+
+```
+$ rake install
+```
+
+To release a new version, update the version number in `lib/logger/version.rb`, and then run
+
+```
+$ rake release
+```
+
+which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Advanced Development
+
+### Run tests of a specific file
+
+```
+$ ruby test/logger/test_logger.rb
+```
+
+### Run tests filtering test methods by a name
+
+`--name` option is available as:
+
+```
+$ ruby test/logger/test_logger.rb --name test_lshift
+```
+
+### Publish documents to GitHub Pages
+
+```
+$ rake gh-pages
+```
+
+Then, git commit and push the generated HTMLs onto `gh-pages` branch.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/logger.
+
+## License
+
+The gem is available as open source under the terms of the [BSD-2-Clause](BSDL).

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require "bundler/gem_tasks"
+rescue LoadError
+end
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test/lib"
+  t.ruby_opts << "-rhelper"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+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 BSDL COPYING]
+  doc.rdoc_dir = "html"
+end
+
+task "gh-pages" => :rdoc do
+  %x[git checkout gh-pages]
+  require "fileutils"
+  FileUtils.rm_rf "/tmp/html"
+  FileUtils.mv "html", "/tmp"
+  FileUtils.rm_rf "*"
+  FileUtils.cp_r Dir.glob("/tmp/html/*"), "."
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/logger/log_device.rb

@@ -30,29 +30,13 @@ class Logger
     end
 
     def write(message)
-      begin
+      handle_write_errors("writing") do
         synchronize do
           if @shift_age and @dev.respond_to?(:stat)
-            begin
-              check_shift_log
-            rescue *@reraise_write_errors
-              raise
-            rescue
-              warn("log shifting failed. #{$!}")
-            end
-          end
-          begin
-            @dev.write(message)
-          rescue *@reraise_write_errors
-            raise
-          rescue
-            warn("log writing failed. #{$!}")
+            handle_write_errors("shifting") {check_shift_log}
           end
+          handle_write_errors("writing") {@dev.write(message)}
         end
-      rescue *@reraise_write_errors
-        raise
-      rescue Exception => ignored
-        warn("log writing failed. #{ignored}")
       end
     end
 
@@ -83,6 +67,17 @@ class Logger
 
   private
 
+    # :stopdoc:
+
+    MODE = File::WRONLY | File::APPEND
+    # temporary workaround for TruffleRuby
+    if File.const_defined? :SHARE_DELETE
+      MODE_TO_OPEN = MODE | File::SHARE_DELETE | File::BINARY
+    else
+      MODE_TO_OPEN = MODE | File::BINARY
+    end
+    MODE_TO_CREATE = MODE_TO_OPEN | File::CREAT | File::EXCL
+
     def set_dev(log)
       if log.respond_to?(:write) and log.respond_to?(:close)
         @dev = log
@@ -93,34 +88,61 @@ class Logger
         end
       else
         @dev = open_logfile(log)
-        @dev.sync = true
-        @dev.binmode if @binmode
         @filename = log
       end
     end
 
+    if MODE_TO_OPEN == MODE
+      def fixup_mode(dev, filename)
+        dev
+      end
+    else
+      def fixup_mode(dev, filename)
+        return dev if @binmode
+        dev.autoclose = false
+        old_dev = dev
+        dev = File.new(dev.fileno, mode: MODE, path: filename)
+        old_dev.close
+        PathAttr.set_path(dev, filename) if defined?(PathAttr)
+        dev
+      end
+    end
+
     def open_logfile(filename)
       begin
-        File.open(filename, (File::WRONLY | File::APPEND))
+        dev = File.open(filename, MODE_TO_OPEN)
       rescue Errno::ENOENT
         create_logfile(filename)
+      else
+        dev = fixup_mode(dev, filename)
+        dev.sync = true
+        dev.binmode if @binmode
+        dev
       end
     end
 
     def create_logfile(filename)
       begin
-        logdev = File.open(filename, (File::WRONLY | File::APPEND | File::CREAT | File::EXCL))
+        logdev = File.open(filename, MODE_TO_CREATE)
         logdev.flock(File::LOCK_EX)
+        logdev = fixup_mode(logdev, filename)
         logdev.sync = true
         logdev.binmode if @binmode
         add_log_header(logdev)
         logdev.flock(File::LOCK_UN)
+        logdev
       rescue Errno::EEXIST
         # file is created by another process
-        logdev = open_logfile(filename)
-        logdev.sync = true
+        open_logfile(filename)
       end
-      logdev
+    end
+
+    def handle_write_errors(mesg)
+      yield
+    rescue *@reraise_write_errors
+      raise
+    rescue
+      warn("log #{mesg} failed. #{$!}")
     end
 
     def add_log_header(file)
@@ -144,40 +166,33 @@ class Logger
       end
     end
 
-    if /mswin|mingw|cygwin/ =~ RbConfig::CONFIG['host_os']
-      def lock_shift_log
-        yield
-      end
-    else
-      def lock_shift_log
-        retry_limit = 8
-        retry_sleep = 0.1
-        begin
-          File.open(@filename, File::WRONLY | File::APPEND) do |lock|
-            lock.flock(File::LOCK_EX) # inter-process locking. will be unlocked at closing file
-            if File.identical?(@filename, lock) and File.identical?(lock, @dev)
-              yield # log shifting
-            else
-              # log shifted by another process (i-node before locking and i-node after locking are different)
-              @dev.close rescue nil
-              @dev = open_logfile(@filename)
-              @dev.sync = true
-            end
-          end
-        rescue Errno::ENOENT
-          # @filename file would not exist right after #rename and before #create_logfile
-          if retry_limit <= 0
-            warn("log rotation inter-process lock failed. #{$!}")
+    def lock_shift_log
+      retry_limit = 8
+      retry_sleep = 0.1
+      begin
+        File.open(@filename, MODE_TO_OPEN) do |lock|
+          lock.flock(File::LOCK_EX) # inter-process locking. will be unlocked at closing file
+          if File.identical?(@filename, lock) and File.identical?(lock, @dev)
+            yield # log shifting
           else
-            sleep retry_sleep
-            retry_limit -= 1
-            retry_sleep *= 2
-            retry
+            # log shifted by another process (i-node before locking and i-node after locking are different)
+            @dev.close rescue nil
+            @dev = open_logfile(@filename)
           end
         end
-      rescue
-        warn("log rotation inter-process lock failed. #{$!}")
+      rescue Errno::ENOENT
+        # @filename file would not exist right after #rename and before #create_logfile
+        if retry_limit <= 0
+          warn("log rotation inter-process lock failed. #{$!}")
+        else
+          sleep retry_sleep
+          retry_limit -= 1
+          retry_sleep *= 2
+          retry
+        end
       end
+    rescue
+      warn("log rotation inter-process lock failed. #{$!}")
     end
 
     def shift_log_age
@@ -212,3 +227,15 @@ class Logger
     end
   end
 end
+
+File.open(__FILE__) do |f|
+  File.new(f.fileno, autoclose: false, path: "").path
+rescue IOError
+  module PathAttr               # :nodoc:
+    attr_reader :path
+
+    def self.set_path(file, path)
+      file.extend(self).instance_variable_set(:@path, path)
+    end
+  end
+end

data/lib/logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Logger
-  VERSION = "1.6.2"
+  VERSION = "1.6.5"
 end

data/logger.gemspec

@@ -15,8 +15,14 @@ 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", "BSDL", "COPYING"]
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z 2>#{IO::NULL}`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["changelog_uri"] = spec.homepage + "/releases"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: logger
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.5
 platform: ruby
 authors:
 - Naotoshi Seo
 - SHIBATA Hiroshi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-02 00:00:00.000000000 Z
+date: 2025-01-10 00:00:00.000000000 Z
 dependencies: []
 description: Provides a simple logging utility for outputting messages.
 email:
@@ -19,8 +19,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/push_gem.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
 - BSDL
 - COPYING
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/logger.rb
 - lib/logger/errors.rb
 - lib/logger/formatter.rb
@@ -33,8 +42,9 @@ homepage: https://github.com/ruby/logger
 licenses:
 - Ruby
 - BSD-2-Clause
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/ruby/logger/releases
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -50,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.11
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Provides a simple logging utility for outputting messages.
 test_files: []