logger 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ac30b81e7461bb8da11d63f68d4981b0f058960d6001319c8709c98b05b1dfa
-  data.tar.gz: 25dfc74c49ea696330c6e2c435a27a0b6933ecd65cf4ed9ea2ede8accde35606
+  metadata.gz: 9ddf4801d5f2a31d107d694a433dcd93583d43cc405ee2347ca8054409705c68
+  data.tar.gz: d42cd2e291492d13dd458afc25b349a2501dbddfba526af27185ec199cc203b2
 SHA512:
-  metadata.gz: 1d724998e973037c4c5baaae8c8edc965129533a72f70b0551cfed8c871e27d6ec11e780636b329fb9ba9636e22da0cb0cfe0e76bf0fe73fe6cbbdc575068c0b
-  data.tar.gz: aaf0393b43f86dc1cada4f57e5faf64159f3d1cf52a93e97077b64721bd6287aaea7f55a7377ecf74689ed68ecda65c58440b27fbf1404f7ffd087fd80f0381a
+  metadata.gz: 1db29e10a929c956f8db43abfbd42ac12edf83f10eff23026041e3c1381929bd571f74c9f900337994c980a9eda9ba9e10ca888f67ba986f3727c9897326c98d
+  data.tar.gz: 55b2c8e12eac1c2a9b7a0ac41ea7df4be72704c4f8b5396fa8c90e13c1682ca6d6711f9ee903bf386a0283bf02cd68dcb1577737998144536ab137dc8e4ba2ac

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), $$, 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/ =~ 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,43 @@
+# 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)
+      else
+        return now
+      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
+      else
+        return now
+      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.1"
+end

data/logger.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/ruby/logger"
   spec.license       = "BSD-2-Clause"
 
-  spec.files         = ["Gemfile", "LICENSE.txt", "README.md", "Rakefile", "lib/logger.rb", "logger.gemspec"]
+  spec.files         = Dir.glob("lib/**/*.rb") + ["logger.gemspec"]
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logger
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Naotoshi Seo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,11 +75,13 @@ 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:

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