logger 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b7218297d498d773ba9c79d57749a01f259d336a4e9b5acbfe51274d2442500
-  data.tar.gz: c455593961790cfaf065b7b6b7798d9c184900e1ccdd0aa4f89411e33400e4b0
+  metadata.gz: 8ac30b81e7461bb8da11d63f68d4981b0f058960d6001319c8709c98b05b1dfa
+  data.tar.gz: 25dfc74c49ea696330c6e2c435a27a0b6933ecd65cf4ed9ea2ede8accde35606
 SHA512:
-  metadata.gz: 5db2250788d1a9c583685501312a5f6ef277b3148b164b5ed1c2b123a88560ff795b40eee1ac70cf5f466e3dbd771e3d93773c387599b7f7c9916dd7319a99a6
-  data.tar.gz: 94a96a2fba4c2e56e18e2e40f4ca0d0238edd355f65b95182e9ffdfb9a380bd7f932cf9734c0baa2a4c7b79df182cf27151972bfdd3efc6829f58530cd28c287
+  metadata.gz: 1d724998e973037c4c5baaae8c8edc965129533a72f70b0551cfed8c871e27d6ec11e780636b329fb9ba9636e22da0cb0cfe0e76bf0fe73fe6cbbdc575068c0b
+  data.tar.gz: aaf0393b43f86dc1cada4f57e5faf64159f3d1cf52a93e97077b64721bd6287aaea7f55a7377ecf74689ed68ecda65c58440b27fbf1404f7ffd087fd80f0381a

data/Gemfile

@@ -2,5 +2,4 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in logger.gemspec
 gemspec

data/README.md

@@ -1,8 +1,15 @@
 # Logger
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/logger`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.com/ruby/logger.svg?branch=master)](https://travis-ci.com/ruby/logger)
 
-TODO: Delete this and the text above, and describe your gem
+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
 
@@ -22,13 +29,71 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### 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 `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec 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).
+Then, git commit and push the generated HTMLs onto `gh-pages` branch.
 
 ## Contributing
 

data/Rakefile

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

data/lib/logger.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 # logger.rb - simple logging utility
 # Copyright (C) 2000-2003, 2005, 2008, 2011  NAKAMURA, Hiroshi <nahi@ruby-lang.org>.
 #
@@ -12,6 +12,12 @@
 
 require 'monitor'
 
+require_relative 'logger/version'
+require_relative 'logger/formatter'
+require_relative 'logger/log_device'
+require_relative 'logger/severity'
+require_relative 'logger/errors'
+
 # == Description
 #
 # The Logger class provides a simple but sophisticated logging utility that
@@ -224,7 +230,6 @@ require 'monitor'
 #   })
 #
 class Logger
-  VERSION = "1.3.0"
   _, name, rev = %w$Id$
   if name
     name = name.chomp(",v")
@@ -232,29 +237,8 @@ class Logger
     name = File.basename(__FILE__)
   end
   rev ||= "v#{VERSION}"
-  ProgName = "#{name}/#{rev}".freeze
+  ProgName = "#{name}/#{rev}"
 
-  class Error < RuntimeError # :nodoc:
-  end
-  # not used after 1.2.7. just for compat.
-  class ShiftingError < Error # :nodoc:
-  end
-
-  # 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
   include Severity
 
   # Logging severity threshold (e.g. <tt>Logger::INFO</tt>).
@@ -322,22 +306,37 @@ class Logger
   # +DEBUG+ messages.
   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
   # +INFO+ messages.
   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
   # +WARN+ messages.
   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
   # +ERROR+ messages.
   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
   # +FATAL+ messages.
   def fatal?; @level <= FATAL; end
 
+  # Sets the severity to FATAL.
+  def fatal!; self.level = FATAL; end
+
   #
   # :call-seq:
   #   Logger.new(logdev, shift_age = 0, shift_size = 1048576)
@@ -366,6 +365,8 @@ class Logger
   #   Logging formatter. Default values is an instance of Logger::Formatter.
   # +datetime_format+::
   #   Date and time format. Default value is '%Y-%m-%d %H:%M:%S'.
+  # +binmode+::
+  #   Use binary mode on the log device. Default value is false.
   # +shift_period_suffix+::
   #   The log file suffix format for +daily+, +weekly+ or +monthly+ rotation.
   #   Default is '%Y%m%d'.
@@ -376,7 +377,7 @@ class Logger
   #
   def initialize(logdev, shift_age = 0, shift_size = 1048576, level: DEBUG,
                  progname: nil, formatter: nil, datetime_format: nil,
-                 shift_period_suffix: '%Y%m%d')
+                 binmode: false, shift_period_suffix: '%Y%m%d')
     self.level = level
     self.progname = progname
     @default_formatter = Formatter.new
@@ -384,9 +385,10 @@ class Logger
     self.formatter = formatter
     @logdev = nil
     if logdev
-      @logdev = LogDevice.new(logdev, :shift_age => shift_age,
-        :shift_size => shift_size,
-        :shift_period_suffix => shift_period_suffix)
+      @logdev = LogDevice.new(logdev, shift_age: shift_age,
+        shift_size: shift_size,
+        shift_period_suffix: shift_period_suffix,
+        binmode: binmode)
     end
   end
 
@@ -572,7 +574,7 @@ class Logger
 private
 
   # Severity label for logging (max 5 chars).
-  SEV_LABEL = %w(DEBUG INFO WARN ERROR FATAL ANY).each(&:freeze).freeze
+  SEV_LABEL = %w(DEBUG INFO WARN ERROR FATAL ANY).freeze
 
   def format_severity(severity)
     SEV_LABEL[severity] || 'ANY'
@@ -581,273 +583,4 @@ private
   def format_message(severity, datetime, progname, msg)
     (@formatter || @default_formatter).call(severity, datetime, progname, msg)
   end
-
-
-  # Default formatter for log messages.
-  class Formatter
-    Format = "%s, [%s#%d] %5s -- %s: %s\n".freeze
-
-    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 ".freeze)
-    end
-
-    def msg2str(msg)
-      case msg
-      when ::String
-        msg
-      when ::Exception
-        "#{ msg.message } (#{ msg.class })\n" <<
-          (msg.backtrace || []).join("\n")
-      else
-        msg.inspect
-      end
-    end
-  end
-
-  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
-
-  # 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)
-      @dev = @filename = @shift_age = @shift_size = @shift_period_suffix = nil
-      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
-      else
-        @dev = open_logfile(log)
-        @dev.sync = true
-        @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
-        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/logger.gemspec

@@ -1,27 +1,29 @@
 begin
-  require_relative "lib/logger"
-rescue LoadError
-  # for Ruby core repository
-  require_relative "logger"
+  require_relative "lib/logger/version"
+rescue LoadError # Fallback to load version file in ruby core repository
+  require_relative "logger/version"
 end
 
 Gem::Specification.new do |spec|
   spec.name          = "logger"
   spec.version       = Logger::VERSION
-  spec.authors       = ["SHIBATA Hiroshi"]
-  spec.email         = ["hsbt@ruby-lang.org"]
+  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.license       = "BSD-2-Clause"
 
-  spec.files         = [".gitignore", ".travis.yml", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "bin/console", "bin/setup", "lib/logger.rb", "logger.gemspec"]
+  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.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.add_development_dependency "bundler", ">= 0"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "rdoc"
 end

metadata

@@ -1,29 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: logger
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
+- Naotoshi Seo
 - SHIBATA Hiroshi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2019-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,34 +40,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides a simple logging utility for outputting messages.
 email:
+- sonots@gmail.com
 - hsbt@ruby-lang.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/logger.rb
 - logger.gemspec
 homepage: https://github.com/ruby/logger
@@ -81,15 +93,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Provides a simple logging utility for outputting messages.

data/.gitignore

@@ -1,8 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.travis.yml

@@ -1,6 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.1
-  - ruby-head  
-before_install: gem install bundler -v 1.16.2

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