logger 1.6.4 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7342324d3e0712ca848158153398c4a83117ba503860ecf9e6bdfb6af659c671
-  data.tar.gz: ec5f49b614221c3e2278b3d21781b3270035225db3d69ee9823c59055caf8b9f
+  metadata.gz: c84ac2b70e090b47e48cc054906f75f21b26b3648dad0b363f54bba83f37e372
+  data.tar.gz: f7b0cbf4e55fd9c5831cb2500e21d27faa6bc02356ddc484d819a4ef806e4dee
 SHA512:
-  metadata.gz: 93c4e8130c1c1e80453aaa72b2c9af936755bb07af4d5f6ee3f2101f26de7219c786db26849c0b17f1c741471182ebd96738457c2c2db7649ac03666e54fd475
-  data.tar.gz: 238eb90c2b827d02a1e81c07451a65d8e6e2f9c626446cdbace821c4617cacc0b2ad7c69d4b7d92c35405a9f73ef6a5d6ba4215e3252792adb201e9c0518c947
+  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/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/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,12 @@ class Logger
     # :stopdoc:
 
     MODE = File::WRONLY | File::APPEND
-    MODE_TO_OPEN = MODE | File::SHARE_DELETE | File::BINARY
+    # 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
+      MODE_TO_OPEN = MODE | File::BINARY
+    end
     MODE_TO_CREATE = MODE_TO_OPEN | File::CREAT | File::EXCL
 
     def set_dev(log)
@@ -87,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
@@ -109,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
@@ -120,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
@@ -175,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
@@ -196,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)
@@ -215,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.4"
+  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.4
+  version: 1.7.0
 platform: ruby
 authors:
 - Naotoshi Seo
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-19 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,8 +19,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".document"
+- ".rdoc_options"
 - BSDL
 - COPYING
+- README.md
 - lib/logger.rb
 - lib/logger/errors.rb
 - lib/logger/formatter.rb
@@ -28,12 +31,12 @@ files:
 - lib/logger/period.rb
 - lib/logger/severity.rb
 - lib/logger/version.rb
-- logger.gemspec
 homepage: https://github.com/ruby/logger
 licenses:
 - Ruby
 - BSD-2-Clause
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/ruby/logger/releases
 post_install_message:
 rdoc_options: []
 require_paths:

data/logger.gemspec

@@ -1,22 +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"]
-
-  spec.files         = Dir.glob("lib/**/*.rb") + ["logger.gemspec", "BSDL", "COPYING"]
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = ">= 2.5.0"
-end