logger 1.6.5 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46ba87e952de11303f4d8a1801c62441825513ed53de7ab20ec75d21b9524cdb
-  data.tar.gz: 985b136ab6b4027a0c28b8980374fc3beed8f3df3b31ee02fe57c0de5ab3cb56
+  metadata.gz: c84ac2b70e090b47e48cc054906f75f21b26b3648dad0b363f54bba83f37e372
+  data.tar.gz: f7b0cbf4e55fd9c5831cb2500e21d27faa6bc02356ddc484d819a4ef806e4dee
 SHA512:
-  metadata.gz: c3cb3e144eab09fddc21017774faa4b4f4260ddba3bc8d1b0244654c3c2bf13e610debfd3cef36e9bb83b31379dc5853384accadb586f3415deb090ac0fc1fdb
-  data.tar.gz: 82b5a284490100bee206a12e7030e3fb6287aca0ce8196e7ccc0673445b9b713df77438514b36f2e711523d5e2d1bdb897b83811ea752b3bbe26940efacee0eb
+  metadata.gz: 1ffa55991e59e4dadd824e1bcf19b0deee701fc9512ba4dc97f15d45f7450bff12422266bac8b9d041222cb386bd5b70ffbb2379107a2c76cd5a4cdcf418a9cf
+  data.tar.gz: 03e58b69f2e3f0eae398506fc1aa417d70fe17c190efa2c4c2ceb558b90bcadee62e088929a774f3d01242c9e72486f365b9555a78419c8553140a3517f2dad3

data/.document

@@ -0,0 +1,4 @@
+BSDL
+COPYING
+README.md
+lib/

data/.rdoc_options

@@ -0,0 +1,3 @@
+---
+main_page: README.md
+title: Documentation for Logger

data/lib/logger/log_device.rb

@@ -11,22 +11,17 @@ class Logger
     attr_reader :filename
     include MonitorMixin
 
-    def initialize(log = nil, shift_age: nil, shift_size: nil, shift_period_suffix: nil, binmode: false, reraise_write_errors: [])
+    def initialize(
+      log = nil, shift_age: nil, shift_size: nil, shift_period_suffix: nil,
+      binmode: false, reraise_write_errors: [], skip_header: false
+    )
       @dev = @filename = @shift_age = @shift_size = @shift_period_suffix = nil
       @binmode = binmode
       @reraise_write_errors = reraise_write_errors
+      @skip_header = skip_header
       mon_initialize
       set_dev(log)
-      if @filename
-        @shift_age = shift_age || 7
-        @shift_size = shift_size || 1048576
-        @shift_period_suffix = shift_period_suffix || '%Y%m%d'
-
-        unless @shift_age.is_a?(Integer)
-          base_time = @dev.respond_to?(:stat) ? @dev.stat.mtime : Time.now
-          @next_rotate_time = next_rotate_time(base_time, @shift_age)
-        end
-      end
+      set_file(shift_age, shift_size, shift_period_suffix) if @filename
     end
 
     def write(message)
@@ -50,9 +45,10 @@ class Logger
       end
     end
 
-    def reopen(log = nil)
+    def reopen(log = nil, shift_age: nil, shift_size: nil, shift_period_suffix: nil, binmode: nil)
       # reopen the same filename if no argument, do nothing for IO
       log ||= @filename if @filename
+      @binmode = binmode unless binmode.nil?
       if log
         synchronize do
           if @filename and @dev
@@ -60,6 +56,7 @@ class Logger
             @filename = nil
           end
           set_dev(log)
+          set_file(shift_age, shift_size, shift_period_suffix) if @filename
         end
       end
       self
@@ -70,7 +67,7 @@ class Logger
     # :stopdoc:
 
     MODE = File::WRONLY | File::APPEND
-    # temporary workaround for TruffleRuby
+    # TruffleRuby < 24.2 does not have File::SHARE_DELETE
     if File.const_defined? :SHARE_DELETE
       MODE_TO_OPEN = MODE | File::SHARE_DELETE | File::BINARY
     else
@@ -92,16 +89,27 @@ class Logger
       end
     end
 
+    def set_file(shift_age, shift_size, shift_period_suffix)
+      @shift_age = shift_age || @shift_age || 7
+      @shift_size = shift_size || @shift_size || 1048576
+      @shift_period_suffix = shift_period_suffix || @shift_period_suffix || '%Y%m%d'
+
+      unless @shift_age.is_a?(Integer)
+        base_time = @dev.respond_to?(:stat) ? @dev.stat.mtime : Time.now
+        @next_rotate_time = next_rotate_time(base_time, @shift_age)
+      end
+    end
+
     if MODE_TO_OPEN == MODE
-      def fixup_mode(dev, filename)
+      def fixup_mode(dev)
         dev
       end
     else
-      def fixup_mode(dev, filename)
+      def fixup_mode(dev)
         return dev if @binmode
         dev.autoclose = false
         old_dev = dev
-        dev = File.new(dev.fileno, mode: MODE, path: filename)
+        dev = File.new(dev.fileno, mode: MODE, path: dev.path)
         old_dev.close
         PathAttr.set_path(dev, filename) if defined?(PathAttr)
         dev
@@ -114,7 +122,7 @@ class Logger
       rescue Errno::ENOENT
         create_logfile(filename)
       else
-        dev = fixup_mode(dev, filename)
+        dev = fixup_mode(dev)
         dev.sync = true
         dev.binmode if @binmode
         dev
@@ -125,10 +133,10 @@ class Logger
       begin
         logdev = File.open(filename, MODE_TO_CREATE)
         logdev.flock(File::LOCK_EX)
-        logdev = fixup_mode(logdev, filename)
+        logdev = fixup_mode(logdev)
         logdev.sync = true
         logdev.binmode if @binmode
-        add_log_header(logdev)
+        add_log_header(logdev) unless @skip_header
         logdev.flock(File::LOCK_UN)
         logdev
       rescue Errno::EEXIST
@@ -180,6 +188,7 @@ class Logger
             @dev = open_logfile(@filename)
           end
         end
+        true
       rescue Errno::ENOENT
         # @filename file would not exist right after #rename and before #create_logfile
         if retry_limit <= 0
@@ -201,10 +210,7 @@ class Logger
           File.rename("#{@filename}.#{i}", "#{@filename}.#{i+1}")
         end
       end
-      @dev.close rescue nil
-      File.rename("#{@filename}", "#{@filename}.0")
-      @dev = create_logfile(@filename)
-      return true
+      shift_log_file("#{@filename}.0")
     end
 
     def shift_log_period(period_end)
@@ -220,9 +226,27 @@ class Logger
           break unless FileTest.exist?(age_file)
         end
       end
+      shift_log_file(age_file)
+    end
+
+    def shift_log_file(shifted)
+      stat = @dev.stat
       @dev.close rescue nil
-      File.rename("#{@filename}", age_file)
+      File.rename(@filename, shifted)
       @dev = create_logfile(@filename)
+      mode, uid, gid = stat.mode, stat.uid, stat.gid
+      begin
+        @dev.chmod(mode) if mode
+        mode = nil
+        @dev.chown(uid, gid)
+      rescue Errno::EPERM
+        if mode
+          # failed to chmod, probably nothing can do more.
+        elsif uid
+          uid = nil
+          retry # to change gid only
+        end
+      end
       return true
     end
   end

data/lib/logger/version.rb

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

data/lib/logger.rb

@@ -543,10 +543,20 @@ class Logger
   # - A string filepath: entries are to be written
   #   to the file at that path; if the file at that path exists,
   #   new entries are appended.
-  # - An IO stream (typically +$stdout+, +$stderr+. or an open file):
-  #   entries are to be written to the given stream.
+  # - An IO stream (typically <tt>$stdout</tt>, <tt>$stderr</tt>. or
+  #   an open file): entries are to be written to the given stream.
   # - +nil+ or +File::NULL+: no entries are to be written.
   #
+  # Argument +shift_age+ must be one of:
+  #
+  # - The number of log files to be in the rotation.
+  #   See {Size-Based Rotation}[rdoc-ref:Logger@Size-Based+Rotation].
+  # - A string period indicator.
+  #   See {Periodic Rotation}[rdoc-ref:Logger@Periodic+Rotation].
+  #
+  # Argument +shift_size+ is the maximum size (in bytes) of each log file.
+  # See {Size-Based Rotation}[rdoc-ref:Logger@Size-Based+Rotation].
+  #
   # Examples:
   #
   #   Logger.new('t.log')
@@ -566,22 +576,29 @@ class Logger
   #
   # - +formatter+: sets the entry formatter; default is +nil+.
   #   See {formatter=}[Logger.html#attribute-i-formatter].
+  #
   # - +datetime_format+: sets the format for entry timestamp;
   #   default is +nil+.
   #   See #datetime_format=.
+  #
   # - +binmode+: sets whether the logger writes in binary mode;
   #   default is +false+.
+  #
   # - +shift_period_suffix+: sets the format for the filename suffix
   #   for periodic log file rotation; default is <tt>'%Y%m%d'</tt>.
   #   See {Periodic Rotation}[rdoc-ref:Logger@Periodic+Rotation].
+  #
   # - +reraise_write_errors+: An array of exception classes, which will
   #   be reraised if there is an error when writing to the log device.
   #   The default is to swallow all exceptions raised.
+  # - +skip_header+: If +true+, prevents the logger from writing a header
+  #   when creating a new log file. The default is +false+, meaning
+  #   the header will be written as usual.
   #
   def initialize(logdev, shift_age = 0, shift_size = 1048576, level: DEBUG,
                  progname: nil, formatter: nil, datetime_format: nil,
                  binmode: false, shift_period_suffix: '%Y%m%d',
-                 reraise_write_errors: [])
+                 reraise_write_errors: [], skip_header: false)
     self.level = level
     self.progname = progname
     @default_formatter = Formatter.new
@@ -594,7 +611,8 @@ class Logger
         shift_size: shift_size,
         shift_period_suffix: shift_period_suffix,
         binmode: binmode,
-        reraise_write_errors: reraise_write_errors)
+        reraise_write_errors: reraise_write_errors,
+        skip_header: skip_header)
     end
   end
 
@@ -621,8 +639,9 @@ class Logger
   #   #  "E, [2022-05-12T14:21:27.596726 #22428] ERROR -- : one\n",
   #   #  "E, [2022-05-12T14:23:05.847241 #22428] ERROR -- : three\n"]
   #
-  def reopen(logdev = nil)
-    @logdev&.reopen(logdev)
+  def reopen(logdev = nil, shift_age = nil, shift_size = nil, shift_period_suffix: nil, binmode: nil)
+    @logdev&.reopen(logdev, shift_age: shift_age, shift_size: shift_size,
+                    shift_period_suffix: shift_period_suffix, binmode: binmode)
     self
   end
 
@@ -748,6 +767,15 @@ private
 
   # Guarantee the existence of this ivar even when subclasses don't call the superclass constructor.
   def level_override
+    unless defined?(@level_override)
+      bad = self.class.instance_method(:initialize)
+      file, line = bad.source_location
+      Kernel.warn <<~";;;", uplevel: 2
+        Logger not initialized properly
+        #{file}:#{line}: info: #{bad.owner}\##{bad.name}: \
+        does not call super probably
+      ;;;
+    end
     @level_override ||= {}
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logger
 version: !ruby/object:Gem::Version
-  version: 1.6.5
+  version: 1.7.0
 platform: ruby
 authors:
 - Naotoshi Seo
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-10 00:00:00.000000000 Z
+date: 2025-03-27 00:00:00.000000000 Z
 dependencies: []
 description: Provides a simple logging utility for outputting messages.
 email:
@@ -19,17 +19,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
-- ".github/workflows/push_gem.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
+- ".document"
+- ".rdoc_options"
 - BSDL
 - COPYING
-- Gemfile
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/logger.rb
 - lib/logger/errors.rb
 - lib/logger/formatter.rb
@@ -37,7 +31,6 @@ files:
 - lib/logger/period.rb
 - lib/logger/severity.rb
 - lib/logger/version.rb
-- logger.gemspec
 homepage: https://github.com/ruby/logger
 licenses:
 - Ruby

data/.github/dependabot.yml

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

data/.github/workflows/push_gem.yml

@@ -1,46 +0,0 @@
-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

@@ -1,32 +0,0 @@
-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

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

data/Gemfile

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

data/Rakefile

@@ -1,30 +0,0 @@
-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

@@ -1,14 +0,0 @@
-#!/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

@@ -1,8 +0,0 @@
-#!/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/logger.gemspec

@@ -1,28 +0,0 @@
-begin
-  require_relative "lib/logger/version"
-rescue LoadError # Fallback to load version file in ruby core repository
-  require_relative "version"
-end
-
-Gem::Specification.new do |spec|
-  spec.name          = "logger"
-  spec.version       = Logger::VERSION
-  spec.authors       = ["Naotoshi Seo", "SHIBATA Hiroshi"]
-  spec.email         = ["sonots@gmail.com", "hsbt@ruby-lang.org"]
-
-  spec.summary       = %q{Provides a simple logging utility for outputting messages.}
-  spec.description   = %q{Provides a simple logging utility for outputting messages.}
-  spec.homepage      = "https://github.com/ruby/logger"
-  spec.licenses      = ["Ruby", "BSD-2-Clause"]
-
-  # 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