chrono_logger 0.0.5 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 08bc980d1aec36c6dd84be8aa0964a89f026357a
-  data.tar.gz: 36c8767249f645a1cf6a491dd03a29e0e47a95bd
+SHA256:
+  metadata.gz: ee8232f6e93fdb6766c7685404c008954c26570cc08ee7d9a26df0492b721ad3
+  data.tar.gz: 8c362f4ef826b32830a4326ee6929fc6731579cb0a55f871757fcc4233338ea2
 SHA512:
-  metadata.gz: 364f9de5b3a3694e4e54d4dfa2a27511c6a0d18bbcb5186f69bf538503cd950fdd46ef35681f950ec8b158977103b3fa2f4496851f1b3939e75846d0a5a40ba9
-  data.tar.gz: db43d8701920d88b5fa46e1b9ed3aeae4b6fa97f5b82aace8fc99431c0f64decb645a4a2953029d16ec146bab507c358423971c73acca6d2c232bc6407eb2495
+  metadata.gz: 60f8897ee73f13eedc17b65de6c0c64339827c6abd6b8892ed95a81ad24c50f3b346b5a4667f721a2c3183cefcd9384ca0f293623c1805befb1b863695976525
+  data.tar.gz: e4676e13ab6e54452249fa1e089d96e1d19a5d76c935ff8cc9945592b5f47a421ce6ecf7e833363dc3f408a94975bc178442dc97182e00908c792d491fec2455

data/.github/workflows/ruby.yml

@@ -0,0 +1,36 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.7', '3.0', '3.1' ]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: |
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## 1.1.0 (2015-08-17)
+
+* Enhancements
+  * strftime format for directory name
+
+```ruby
+logger = ChronoLogger.new('%Y/%m/%d.log')
+```
+
+## 1.0.0 (2015-02-05)
+
+* First Major Release
+

data/README.md

@@ -1,11 +1,8 @@
 # ChronoLogger
 
 [![Gem Version](https://badge.fury.io/rb/chrono_logger.svg)](http://badge.fury.io/rb/chrono_logger)
-[![Build Status](https://travis-ci.org/ma2gedev/chrono_logger.svg)](https://travis-ci.org/ma2gedev/chrono_logger)
+[![Build Status](https://github.com/ma2gedev/chrono_logger/workflows/Ruby/badge.svg?branch=master)](https://github.com/ma2gedev/chrono_logger/actions?query=workflow%3ARuby)
 [![Code Climate](https://codeclimate.com/github/ma2gedev/chrono_logger/badges/gpa.svg)](https://codeclimate.com/github/ma2gedev/chrono_logger)
-[![Coverage Status](https://coveralls.io/repos/ma2gedev/chrono_logger/badge.svg)](https://coveralls.io/r/ma2gedev/chrono_logger)
-[![Inline docs](http://inch-ci.org/github/ma2gedev/chrono_logger.svg?branch=master)](http://inch-ci.org/github/ma2gedev/chrono_logger)
-[![endorse](https://api.coderwall.com/ma2gedev/endorsecount.png)](https://coderwall.com/ma2gedev)
 
 A lock-free logger with timebased file rotation.
 
@@ -33,8 +30,8 @@ File.exist?('/log/production.log.20150127')
 Current my projects uses `::Logger` with cronolog. So
 
 - Reduce dependency such as cronolog
-- Remove mutexes in ruby world because os already does
-- Support time based rotation without renaming file because file renaming is complex
+- Remove mutexes in ruby world because os already does when some environments (ex: ext4 file system)
+- Support time based rotation without renaming file because file renaming sometime makes problem
 
 ## Installation
 
@@ -56,7 +53,7 @@ Or install it yourself as:
 
 Same interfaces ruby's stdlib `Logger` except for `new` method.
 
-```
+```ruby
 require 'chrono_logger'
 
 # specify path with `Time#strftime` format
@@ -68,9 +65,29 @@ logger.info("Enjoy")
 logger.debug("programming!")
 ```
 
+With Rails:
+
+```ruby
+# in config/environments/{development,production}.rb
+
+config.logger = ChronoLogger.new("#{config.paths['log'].first}.%Y%m%d")
+```
+
+## Migrating from `::Logger` with cronolog
+
+You only change `Logger.new` into `ChronoLogger.new`:
+
+```ruby
+# for instance your setup is like the following
+Logger.new(IO.popen("/usr/sbin/cronolog production.%Y%m%d", "w"))
+
+# turns into
+ChronoLogger.new('production.%Y%m%d')
+```
+
 ## Limitation
 
-- High performance only daily based time formatting path for example `'%Y%m%d'`. You can create pull request if you need other time period.
+- High performance logging only daily based time formatting path for example `'%Y%m%d'`. You can create pull request if you need other time period.
 
 ## Contributing
 
@@ -83,3 +100,8 @@ logger.debug("programming!")
 ## License
 
 MIT. See [LICENSE.txt](LICENSE.txt) for more details.
+
+## Resources
+
+- [ChronoLogger logging is 1.5x faster than ruby's stdlib Logger](https://coderwall.com/p/vjjszq/chronologger-logging-is-1-5x-faster-than-ruby-s-stdlib-logger)
+

data/chrono_logger.gemspec

@@ -18,13 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 0"
   spec.add_development_dependency "test-unit"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "delorean"
   spec.add_development_dependency "parallel"
-  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "simplecov"
 
   # for performance check
   spec.add_development_dependency "mono_logger"

data/lib/chrono_logger/version.rb

@@ -1,5 +1,5 @@
 require 'logger'
 
 class ChronoLogger < Logger
-  VERSION = "0.0.5"
+  VERSION = "1.1.2"
 end

data/lib/chrono_logger.rb

@@ -1,5 +1,6 @@
 require "chrono_logger/version"
 require 'logger'
+require 'pathname'
 
 # A lock-free logger with timebased file rotation.
 class ChronoLogger < Logger
@@ -53,8 +54,13 @@ class ChronoLogger < Logger
     DELAY_SECOND_TO_CLOSE_FILE = 5
 
     def initialize(log = nil, opt = {})
-      @dev = @filename = nil
-      @mutex = LogDeviceMutex.new
+      @dev = @filename = @pattern = nil
+      if defined?(LogDeviceMutex) # Ruby < 2.3
+        @mutex = LogDeviceMutex.new
+      else
+        mon_initialize
+        @mutex = self
+      end
       if log.respond_to?(:write) and log.respond_to?(:close)
         @dev = log
       else
@@ -69,7 +75,7 @@ class ChronoLogger < Logger
     end
 
     def write(message)
-      check_shift_log if @pattern
+      check_and_shift_log if @pattern
       @dev.write(message)
     rescue
       warn("log writing failed. #{$!}")
@@ -91,6 +97,7 @@ class ChronoLogger < Logger
 
     def create_logfile(filename)
       begin
+        Pathname(filename).dirname.mkpath
         logdev = open(filename, (File::WRONLY | File::APPEND | File::CREAT | File::EXCL))
         logdev.sync = true
       rescue Errno::EEXIST
@@ -101,12 +108,12 @@ class ChronoLogger < Logger
       logdev
     end
 
-    def check_shift_log
+    def check_and_shift_log
       if next_period?(Time.now)
         now = Time.now
         new_filename = now.strftime(@pattern)
         next_start_period = next_start_period(now, @period)
-        shift_log_period(new_filename)
+        shift_log(new_filename)
         @filename = new_filename
         @next_start_period = next_start_period
       end
@@ -120,7 +127,7 @@ class ChronoLogger < Logger
       end
     end
 
-    def shift_log_period(filename)
+    def shift_log(filename)
       begin
         @mutex.synchronize do
           tmp_dev = @dev
@@ -131,7 +138,7 @@ class ChronoLogger < Logger
           end
         end
       rescue Exception => ignored
-        warn("log shifting failed. #{$!}")
+        warn("log shifting failed. #{ignored}")
       end
     end
   end

data/test/from_ruby_repo/test_logger.rb

@@ -12,6 +12,7 @@ class TestLogger < Test::Unit::TestCase
   class Log
     attr_reader :label, :datetime, :pid, :severity, :progname, :msg
     def initialize(line)
+      # NOTE: adapt the following pattern ruby's original test after support only ruby 3.1 or higher
       /\A(\w+), \[([^#]*)#(\d+)\]\s+(\w+) -- (\w*): ([\x0-\xff]*)/ =~ line
       @label, @datetime, @pid, @severity, @progname, @msg = $1, $2, $3, $4, $5, $6
     end
@@ -82,10 +83,11 @@ class TestLogger < Test::Unit::TestCase
     assert_match(/^\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d.\s*\d+ $/, log.datetime)
     logger.datetime_format = "%d%b%Y@%H:%M:%S"
     log = log_add(logger, INFO, "foo")
-    assert_match(/^\d\d\w\w\w\d\d\d\d@\d\d:\d\d:\d\d$/, log.datetime)
+    # NOTE: ` ?` contained in the following will be removed after support only ruby 3.1 or higher
+    assert_match(/^\d\d\w\w\w\d\d\d\d@\d\d:\d\d:\d\d ?$/, log.datetime)
     logger.datetime_format = ""
     log = log_add(logger, INFO, "foo")
-    assert_match(/^$/, log.datetime)
+    assert_match(/^ ?$/, log.datetime)
   end
 
   def test_formatter

data/test/helper.rb

@@ -1,5 +1,5 @@
-require 'coveralls'
-Coveralls.wear!
+require 'simplecov'
+SimpleCov.start
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'chrono_logger'

data/test/test_chrono_logger.rb

@@ -29,6 +29,31 @@ class TestChronoLogger < Test::Unit::TestCase
     confirm_daily_rotation(in_processes: 2)
   end
 
+  def test_exception_on_shifting_log
+    old_log = [@tempfile.path, '20220101'].join
+    new_log = [@tempfile.path, '20220102'].join
+    $stderr, stderr = StringIO.new, $stderr
+    begin
+      Delorean.time_travel_to '2022-01-01 23:59:59.990'
+      logger = ChronoLogger.new(@format)
+      old_logdev = logger.instance_variable_get('@logdev')
+      def old_logdev.create_logfile(filename)
+        raise 'override create_logfile method'
+      end
+      sleep 1 # waiting for shift log file
+
+      logger.info 'shift log'
+
+      assert_match(/log shifting failed\. override create_logfile method/, $stderr.string)
+      assert { File.exist?(old_log) }
+      assert { !File.exist?(new_log) }
+    ensure
+      $stderr, stderr = stderr, $stderr
+      Delorean.back_to_the_present
+      File.unlink(old_log)
+    end
+  end
+
   def test_rotation_per_second
     Dir.mktmpdir do |tmpdir|
       begin
@@ -46,6 +71,23 @@ class TestChronoLogger < Test::Unit::TestCase
     end
   end
 
+  def test_rotation_per_day_and_create_dir
+    Dir.mktmpdir do |tmpdir|
+      begin
+        Delorean.time_travel_to '2015-08-01 23:59:50'
+        logger = ChronoLogger.new([tmpdir, '/%Y/%m/%d/test.log'].join)
+        logger.debug 'rotation'
+        Delorean.time_travel_to '2015-08-02 00:00:01'
+        logger.debug 'new dir'
+
+        assert { File.exist?([tmpdir, '/2015/08/01/test.log'].join) }
+        assert { File.exist?([tmpdir, '/2015/08/02/test.log'].join) }
+      ensure
+        Delorean.back_to_the_present
+      end
+    end
+  end
+
   class PeriodTest
     include ChronoLogger::Period
   end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: chrono_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.1.2
 platform: ruby
 authors:
 - Takayuki Matsubara
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-01-31 00:00:00.000000000 Z
+date: 2022-01-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -143,8 +129,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -161,7 +148,7 @@ homepage: https://github.com/ma2gedev/chrono_logger
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -176,9 +163,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A lock-free logger with timebased file rotation.
 test_files:

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-  - 2.0.0-p598
-  - 2.1.5
-  - 2.2.0
-sudo: false
-cache: bundler