logger 1.4.0 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ac30b81e7461bb8da11d63f68d4981b0f058960d6001319c8709c98b05b1dfa
-  data.tar.gz: 25dfc74c49ea696330c6e2c435a27a0b6933ecd65cf4ed9ea2ede8accde35606
+  metadata.gz: 86ff5c7f2a189b07730b1fbe6287938cf7501889ee62bd89d8de6d02902f1bee
+  data.tar.gz: 62343e3ea1b0dbd6cdb94ff67721f1f86e54876bd6cd0265b112181d60fd1125
 SHA512:
-  metadata.gz: 1d724998e973037c4c5baaae8c8edc965129533a72f70b0551cfed8c871e27d6ec11e780636b329fb9ba9636e22da0cb0cfe0e76bf0fe73fe6cbbdc575068c0b
-  data.tar.gz: aaf0393b43f86dc1cada4f57e5faf64159f3d1cf52a93e97077b64721bd6287aaea7f55a7377ecf74689ed68ecda65c58440b27fbf1404f7ffd087fd80f0381a
+  metadata.gz: 302bbc40320bd744a40924ce6837499d2d9460ebab7745805352cb86d1348737a350bcb94918474cc0cf517b04b6b374eddcfc6a9d142d92943d99ec746df335
+  data.tar.gz: c4d057679ca2aed3e4e57424eacb0167ebb34fcb135bb7b9961a7f2e4b0bfdb33a6f902cd5255acaee7d04adb10d9d5e7035a3784aa0b3e9bc19b5fdd2d528e7

data/lib/logger/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# not used after 1.2.7. just for compat.
+class Logger
+  class Error < RuntimeError # :nodoc:
+  end
+  class ShiftingError < Error # :nodoc:
+  end
+end

data/lib/logger/formatter.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class Logger
+  # Default formatter for log messages.
+  class Formatter
+    Format = "%s, [%s#%d] %5s -- %s: %s\n"
+
+    attr_accessor :datetime_format
+
+    def initialize
+      @datetime_format = nil
+    end
+
+    def call(severity, time, progname, msg)
+      Format % [severity[0..0], format_datetime(time), Process.pid, severity, progname,
+        msg2str(msg)]
+    end
+
+  private
+
+    def format_datetime(time)
+      time.strftime(@datetime_format || "%Y-%m-%dT%H:%M:%S.%6N ")
+    end
+
+    def msg2str(msg)
+      case msg
+      when ::String
+        msg
+      when ::Exception
+        "#{ msg.message } (#{ msg.class })\n#{ msg.backtrace.join("\n") if msg.backtrace }"
+      else
+        msg.inspect
+      end
+    end
+  end
+end

data/lib/logger/log_device.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require_relative 'period'
+
+class Logger
+  # Device used for logging messages.
+  class LogDevice
+    include Period
+
+    attr_reader :dev
+    attr_reader :filename
+    include MonitorMixin
+
+    def initialize(log = nil, shift_age: nil, shift_size: nil, shift_period_suffix: nil, binmode: false)
+      @dev = @filename = @shift_age = @shift_size = @shift_period_suffix = nil
+      @binmode = binmode
+      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
+    end
+
+    def write(message)
+      begin
+        synchronize do
+          if @shift_age and @dev.respond_to?(:stat)
+            begin
+              check_shift_log
+            rescue
+              warn("log shifting failed. #{$!}")
+            end
+          end
+          begin
+            @dev.write(message)
+          rescue
+            warn("log writing failed. #{$!}")
+          end
+        end
+      rescue Exception => ignored
+        warn("log writing failed. #{ignored}")
+      end
+    end
+
+    def close
+      begin
+        synchronize do
+          @dev.close rescue nil
+        end
+      rescue Exception
+        @dev.close rescue nil
+      end
+    end
+
+    def reopen(log = nil)
+      # reopen the same filename if no argument, do nothing for IO
+      log ||= @filename if @filename
+      if log
+        synchronize do
+          if @filename and @dev
+            @dev.close rescue nil # close only file opened by Logger
+            @filename = nil
+          end
+          set_dev(log)
+        end
+      end
+      self
+    end
+
+  private
+
+    def set_dev(log)
+      if log.respond_to?(:write) and log.respond_to?(:close)
+        @dev = log
+        if log.respond_to?(:path)
+          @filename = log.path
+        end
+      else
+        @dev = open_logfile(log)
+        @dev.sync = true
+        @dev.binmode if @binmode
+        @filename = log
+      end
+    end
+
+    def open_logfile(filename)
+      begin
+        File.open(filename, (File::WRONLY | File::APPEND))
+      rescue Errno::ENOENT
+        create_logfile(filename)
+      end
+    end
+
+    def create_logfile(filename)
+      begin
+        logdev = File.open(filename, (File::WRONLY | File::APPEND | File::CREAT | File::EXCL))
+        logdev.flock(File::LOCK_EX)
+        logdev.sync = true
+        logdev.binmode if @binmode
+        add_log_header(logdev)
+        logdev.flock(File::LOCK_UN)
+      rescue Errno::EEXIST
+        # file is created by another process
+        logdev = open_logfile(filename)
+        logdev.sync = true
+      end
+      logdev
+    end
+
+    def add_log_header(file)
+      file.write(
+        "# Logfile created on %s by %s\n" % [Time.now.to_s, Logger::ProgName]
+      ) if file.size == 0
+    end
+
+    def check_shift_log
+      if @shift_age.is_a?(Integer)
+        # Note: always returns false if '0'.
+        if @filename && (@shift_age > 0) && (@dev.stat.size > @shift_size)
+          lock_shift_log { shift_log_age }
+        end
+      else
+        now = Time.now
+        if now >= @next_rotate_time
+          @next_rotate_time = next_rotate_time(now, @shift_age)
+          lock_shift_log { shift_log_period(previous_period_end(now, @shift_age)) }
+        end
+      end
+    end
+
+    if /mswin|mingw|cygwin/ =~ RUBY_PLATFORM
+      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. #{$!}")
+          else
+            sleep retry_sleep
+            retry_limit -= 1
+            retry_sleep *= 2
+            retry
+          end
+        end
+      rescue
+        warn("log rotation inter-process lock failed. #{$!}")
+      end
+    end
+
+    def shift_log_age
+      (@shift_age-3).downto(0) do |i|
+        if FileTest.exist?("#{@filename}.#{i}")
+          File.rename("#{@filename}.#{i}", "#{@filename}.#{i+1}")
+        end
+      end
+      @dev.close rescue nil
+      File.rename("#{@filename}", "#{@filename}.0")
+      @dev = create_logfile(@filename)
+      return true
+    end
+
+    def shift_log_period(period_end)
+      suffix = period_end.strftime(@shift_period_suffix)
+      age_file = "#{@filename}.#{suffix}"
+      if FileTest.exist?(age_file)
+        # try to avoid filename crash caused by Timestamp change.
+        idx = 0
+        # .99 can be overridden; avoid too much file search with 'loop do'
+        while idx < 100
+          idx += 1
+          age_file = "#{@filename}.#{suffix}.#{idx}"
+          break unless FileTest.exist?(age_file)
+        end
+      end
+      @dev.close rescue nil
+      File.rename("#{@filename}", age_file)
+      @dev = create_logfile(@filename)
+      return true
+    end
+  end
+end

data/lib/logger/period.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class Logger
+  module Period
+    module_function
+
+    SiD = 24 * 60 * 60
+
+    def next_rotate_time(now, shift_age)
+      case shift_age
+      when 'daily'
+        t = Time.mktime(now.year, now.month, now.mday) + SiD
+      when 'weekly'
+        t = Time.mktime(now.year, now.month, now.mday) + SiD * (7 - now.wday)
+      when 'monthly'
+        t = Time.mktime(now.year, now.month, 1) + SiD * 32
+        return Time.mktime(t.year, t.month, 1)
+      when 'now', 'everytime'
+        return now
+      else
+        raise ArgumentError, "invalid :shift_age #{shift_age.inspect}, should be daily, weekly, monthly, or everytime"
+      end
+      if t.hour.nonzero? or t.min.nonzero? or t.sec.nonzero?
+        hour = t.hour
+        t = Time.mktime(t.year, t.month, t.mday)
+        t += SiD if hour > 12
+      end
+      t
+    end
+
+    def previous_period_end(now, shift_age)
+      case shift_age
+      when 'daily'
+        t = Time.mktime(now.year, now.month, now.mday) - SiD / 2
+      when 'weekly'
+        t = Time.mktime(now.year, now.month, now.mday) - (SiD * now.wday + SiD / 2)
+      when 'monthly'
+        t = Time.mktime(now.year, now.month, 1) - SiD / 2
+      when 'now', 'everytime'
+        return now
+      else
+        raise ArgumentError, "invalid :shift_age #{shift_age.inspect}, should be daily, weekly, monthly, or everytime"
+      end
+      Time.mktime(t.year, t.month, t.mday, 23, 59, 59)
+    end
+  end
+end

data/lib/logger/severity.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class Logger
+  # Logging severity.
+  module Severity
+    # Low-level information, mostly for developers.
+    DEBUG = 0
+    # Generic (useful) information about system operation.
+    INFO = 1
+    # A warning.
+    WARN = 2
+    # A handleable error condition.
+    ERROR = 3
+    # An unhandleable error that results in a program crash.
+    FATAL = 4
+    # An unknown message that should always be logged.
+    UNKNOWN = 5
+  end
+end

data/lib/logger/version.rb

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

data/lib/logger.rb

@@ -302,37 +302,37 @@ class Logger
   alias sev_threshold level
   alias sev_threshold= level=
 
-  # Returns +true+ iff the current severity level allows for the printing of
+  # Returns +true+ if and only if the current severity level allows for the printing of
   # +DEBUG+ messages.
-  def debug?; @level <= DEBUG; end
+  def debug?; level <= DEBUG; end
 
   # Sets the severity to DEBUG.
   def debug!; self.level = DEBUG; end
 
-  # Returns +true+ iff the current severity level allows for the printing of
+  # Returns +true+ if and only if the current severity level allows for the printing of
   # +INFO+ messages.
-  def info?; @level <= INFO; end
+  def info?; level <= INFO; end
 
   # Sets the severity to INFO.
   def info!; self.level = INFO; end
 
-  # Returns +true+ iff the current severity level allows for the printing of
+  # Returns +true+ if and only if the current severity level allows for the printing of
   # +WARN+ messages.
-  def warn?; @level <= WARN; end
+  def warn?; level <= WARN; end
 
   # Sets the severity to WARN.
   def warn!; self.level = WARN; end
 
-  # Returns +true+ iff the current severity level allows for the printing of
+  # Returns +true+ if and only if the current severity level allows for the printing of
   # +ERROR+ messages.
-  def error?; @level <= ERROR; end
+  def error?; level <= ERROR; end
 
   # Sets the severity to ERROR.
   def error!; self.level = ERROR; end
 
-  # Returns +true+ iff the current severity level allows for the printing of
+  # Returns +true+ if and only if the current severity level allows for the printing of
   # +FATAL+ messages.
-  def fatal?; @level <= FATAL; end
+  def fatal?; level <= FATAL; end
 
   # Sets the severity to FATAL.
   def fatal!; self.level = FATAL; end
@@ -349,14 +349,16 @@ class Logger
   # === Args
   #
   # +logdev+::
-  #   The log device.  This is a filename (String) or IO object (typically
-  #   +STDOUT+, +STDERR+, or an open file).
+  #   The log device.  This is a filename (String), IO object (typically
+  #   +STDOUT+, +STDERR+, or an open file), +nil+ (it writes nothing) or
+  #   +File::NULL+ (same as +nil+).
   # +shift_age+::
   #   Number of old log files to keep, *or* frequency of rotation (+daily+,
-  #   +weekly+ or +monthly+). Default value is 0.
+  #   +weekly+ or +monthly+). Default value is 0, which disables log file
+  #   rotation.
   # +shift_size+::
-  #   Maximum logfile size in bytes (only applies when +shift_age+ is a number).
-  #   Defaults to +1048576+ (1MB).
+  #   Maximum logfile size in bytes (only applies when +shift_age+ is a positive
+  #   Integer). Defaults to +1048576+ (1MB).
   # +level+::
   #   Logging severity threshold. Default values is Logger::DEBUG.
   # +progname+::
@@ -384,7 +386,7 @@ class Logger
     self.datetime_format = datetime_format
     self.formatter = formatter
     @logdev = nil
-    if logdev
+    if logdev && logdev != File::NULL
       @logdev = LogDevice.new(logdev, shift_age: shift_age,
         shift_size: shift_size,
         shift_period_suffix: shift_period_suffix,
@@ -409,7 +411,7 @@ class Logger
   # Reopen a log device.
   #
   def reopen(logdev = nil)
-    @logdev.reopen(logdev)
+    @logdev&.reopen(logdev)
     self
   end
 
@@ -456,7 +458,7 @@ class Logger
   #
   def add(severity, message = nil, progname = nil)
     severity ||= UNKNOWN
-    if @logdev.nil? or severity < @level
+    if @logdev.nil? or severity < level
       return true
     end
     if progname.nil?

data/logger.gemspec

@@ -1,7 +1,7 @@
 begin
   require_relative "lib/logger/version"
 rescue LoadError # Fallback to load version file in ruby core repository
-  require_relative "logger/version"
+  require_relative "version"
 end
 
 Gem::Specification.new do |spec|
@@ -13,17 +13,15 @@ Gem::Specification.new do |spec|
   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.license       = "BSD-2-Clause"
+  spec.licenses      = ["Ruby", "BSD-2-Clause"]
 
-  spec.files         = ["Gemfile", "LICENSE.txt", "README.md", "Rakefile", "lib/logger.rb", "logger.gemspec"]
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files         = Dir.glob("lib/**/*.rb") + ["logger.gemspec"]
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = ">= 2.3.0"
 
   spec.add_development_dependency "bundler", ">= 0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "test-unit"
   spec.add_development_dependency "rdoc"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: logger
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.4
 platform: ruby
 authors:
 - Naotoshi Seo
 - SHIBATA Hiroshi
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -29,16 +29,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -75,17 +75,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
 - lib/logger.rb
+- lib/logger/errors.rb
+- lib/logger/formatter.rb
+- lib/logger/log_device.rb
+- 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: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,8 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.0.dev
+signing_key:
 specification_version: 4
 summary: Provides a simple logging utility for outputting messages.
 test_files: []

data/Gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-gemspec

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-1. Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGE.

data/README.md

@@ -1,104 +0,0 @@
-# Logger
-
-[![Build Status](https://travis-ci.com/ruby/logger.svg?branch=master)](https://travis-ci.com/ruby/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
-
-    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 = Logger.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](LICENSE.txt).

data/Rakefile

@@ -1,28 +0,0 @@
-begin
-  require "bundler/gem_tasks"
-rescue LoadError
-end
-
-require "rake/testtask"
-Rake::TestTask.new(:test) do |t|
-  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 LICENSE.txt]
-  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