hourly_logger_rotator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8d774882a0a310ba65664a1b1fff0fa20844de51266996a0f3b555faf5f4d87
-  data.tar.gz: f880ffdc11abbe033de8275f6db0a584196ad1c4fd01a86a9c2d4e5e86067f8e
+  metadata.gz: 37ba72e1b0c1b5517b1681a450164b4c5bb64feefd051a1421eaeea3c3d5844c
+  data.tar.gz: 4fc662711182b5a7119bdf50074c52d1a6f78e22884acfe6744cd722a941b939
 SHA512:
-  metadata.gz: 70aaf82624b3f3a6c56f8a7e04412058d4279c35b7a7ca0e88cc780819b08fe924b798eec69d4fed617ace069ef99968f32747c9787fd1b770d93a37fe0f4e42
-  data.tar.gz: 3474702dca641a2f2a806b92d63d0fd72f5a21caa4a7ef8dd87afe629636a873fe50a399858704dd698e5e5bc5b85641c9317ad096ee2a324dfc248b2e79d33e
+  metadata.gz: 5e03e918c4ee8756e7d4a47e3fe46b15e64a966b46ba75cb78b09477e5e089c3ea206b2c64218892a718352da8b59fd71e40e5641ce92d453131de35ade83d08
+  data.tar.gz: 79bd4e3420eb628ddeb953077cbc4328f302de02f3760c7470d18fed666c36b0a89a56a24f5ad13fadb8d68b47aedb826c43a76c4f30ce0b7de46e5097f17b35

data/.gitignore

@@ -6,5 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+/log
 .rspec_status
 .ruby-version

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_gem:
+  rubocop-config-umbrellio: lib/rubocop.yml
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2018-03-12
+### Added
+- Ruby 2.3, 2.4, 2.5 support
+
 ## [0.1.0] - 2018-03-05
 ### Added
 - Initial release

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 gemspec

data/Gemfile.lock

@@ -1,17 +1,23 @@
 PATH
   remote: .
   specs:
-    hourly_logger_rotator (0.1.0)
+    hourly_logger_rotator (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     coderay (1.1.2)
     diff-lcs (1.3)
     method_source (0.9.0)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -26,6 +32,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-config-umbrellio (0.52.1.0)
+      rubocop (= 0.52.1)
+      rubocop-rspec (= 1.22.1)
+    rubocop-rspec (1.22.1)
+      rubocop (>= 0.52.1)
+    ruby-progressbar (1.9.0)
+    timecop (0.9.1)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
@@ -36,6 +57,8 @@ DEPENDENCIES
   pry
   rake
   rspec
+  rubocop-config-umbrellio
+  timecop
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -1,3 +1,43 @@
 # HourlyLoggerRotator
 
-WIP
+Logger class patch for hourly log rotation support 
+
+## Requirements
+
+Ruby 2.3, 2.4 or 2.5
+
+## Installation
+
+- `gem install hourly_logger_rotator` and `require "hourly_logger_rotation"`
+- Or add it to your Gemfile and `bundle`
+
+## Usage
+
+Requiring the gem automatically adds an `hourly` rotation period support to Ruby's standard
+Logger class. You can initialize it like this:
+
+```
+Logger.new('some_log_file', 'hourly')
+```
+
+Keep in mind that loggers created before the gem is required will not
+support the hourly rotation period. Specifically, in case of a Rails app,
+require this before Rails initializes; a good place to do that is in `application.rb`
+right after requiring `boot`
+
+### Setting default rotation period
+
+`HourlyLoggerRotator.default_rotation_period=(some_period)` will make it so newly created
+loggers have a rotation period of `some_period` unless you provide an explicit
+period in the constructor
+
+## License
+Released under MIT License
+
+## Authors
+Created by Dmitry Gubitskiy
+
+<a href="https://github.com/umbrellio/">
+<img style="float: left;" src="https://umbrellio.github.io/Umbrellio/supported_by_umbrellio.svg"
+alt="Supported by Umbrellio" width="439" height="72">
+</a>

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
+require "pry"
 require "hourly_logger_rotator"
 
-require "pry"
 Pry.start

data/hourly_logger_rotator.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "hourly_logger_rotator/version"
@@ -9,14 +11,16 @@ Gem::Specification.new do |spec|
   spec.email         = ["d.gubitskiy@gmail.com"]
 
   spec.summary       = "Ruby Logger patch for hourly log rotation"
-  spec.homepage      = "https://github.com/umbrellio/hourly_log_rotator"
+  spec.homepage      = "https://github.com/umbrellio/hourly_logger_rotator"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rubocop-config-umbrellio"
+  spec.add_development_dependency "timecop"
 end

data/lib/hourly_logger_rotator.rb

@@ -1,4 +1,50 @@
+# frozen_string_literal: true
+
+require "logger"
 require "hourly_logger_rotator/version"
 
+pattern = File.join(File.dirname(__FILE__), "hourly_logger_rotator", "patch", "*.rb")
+Dir[pattern].each { |file| require_relative(file) }
+
 module HourlyLoggerRotator
+  class << self
+    def add_hourly_rotation_period_support!
+      if hourly_mixin
+        Logger::LogDevice.prepend(hourly_mixin)
+      else
+        warn unsupported_warning
+      end
+    end
+
+    def default_rotation_period=(period)
+      raise unsupported_warning if period == "hourly" && !hourly_mixin
+
+      mixin = Module.new do
+        define_method(:initialize) do |logdev, shift_age = period, *args|
+          super(logdev, shift_age, *args)
+        end
+      end
+
+      Logger.prepend(mixin)
+    end
+
+    private
+
+    def hourly_mixin
+      return @mixin if defined?(@mixin)
+
+      mixin_name = "HourlyLoggerRotator::Patch::Ruby_#{RUBY_VERSION.split('.').first(2).join('_')}"
+      @mixin = begin
+        Module.const_get(mixin_name)
+      rescue NameError
+        nil
+      end
+    end
+
+    def unsupported_warning
+      "Hourly log rotation period is not supported for Ruby #{RUBY_VERSION}"
+    end
+  end
 end
+
+HourlyLoggerRotator.add_hourly_rotation_period_support!

data/lib/hourly_logger_rotator/patch/ruby_2_3.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module HourlyLoggerRotator
+  module Patch
+    # rubocop:disable Naming/ClassAndModuleCamelCase
+    module Ruby_2_3
+      # rubocop:enable Naming/ClassAndModuleCamelCase
+      SiD = Logger::Period::SiD
+
+      def shift_log_period(period_end)
+        format = @shift_age == "hourly" ? "%Y%m%d%H" : "%Y%m%d"
+        postfix = period_end.strftime(format)
+        age_file = "#{@filename}.#{postfix}"
+        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}.#{postfix}.#{idx}"
+            break unless FileTest.exist?(age_file)
+          end
+        end
+        @dev.close rescue nil
+        File.rename(@filename.to_s, age_file)
+        @dev = create_logfile(@filename)
+        true
+      end
+
+      def next_rotate_time(now, shift_age)
+        case shift_age
+        when "hourly"
+          t = Time.mktime(now.year, now.month, now.mday, now.hour) + SiD / 24
+        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.min.nonzero? or t.sec.nonzero?
+          min = t.min
+          t = Time.mktime(t.year, t.month, t.mday, t.hour)
+          t += (SiD / 24) if min > 30
+        end
+        t
+      end
+
+      def previous_period_end(now, shift_age)
+        case shift_age
+        when "hourly"
+          t = Time.mktime(now.year, now.month, now.mday, now.hour) - 1
+        when "daily"
+          t = Time.mktime(now.year, now.month, now.mday) - 1
+        when "weekly"
+          t = Time.mktime(now.year, now.month, now.mday) - (SiD * now.wday + 1)
+        when "monthly"
+          t = Time.mktime(now.year, now.month, 1) - 1
+        else
+          return now
+        end
+        Time.mktime(t.year, t.month, t.mday, t.hour, 59, 59)
+      end
+    end
+  end
+end

data/lib/hourly_logger_rotator/patch/ruby_2_4.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module HourlyLoggerRotator
+  module Patch
+    # rubocop:disable Naming/ClassAndModuleCamelCase
+    module Ruby_2_4
+      # rubocop:enable Naming/ClassAndModuleCamelCase
+      SiD = Logger::Period::SiD
+
+      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
+          suffix = shift_age == "hourly" ? "%Y%m%d%H" : (shift_period_suffix || "%Y%m%d")
+          @shift_period_suffix = suffix
+
+          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 next_rotate_time(now, shift_age)
+        case shift_age
+        when "hourly"
+          t = Time.mktime(now.year, now.month, now.mday, now.hour) + SiD / 24
+        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.min.nonzero? or t.sec.nonzero?
+          min = t.min
+          t = Time.mktime(t.year, t.month, t.mday, t.hour)
+          t += (SiD / 24) if min > 30
+        end
+        t
+      end
+
+      def previous_period_end(now, shift_age)
+        case shift_age
+        when "hourly"
+          t = Time.mktime(now.year, now.month, now.mday, now.hour) - 1
+        when "daily"
+          t = Time.mktime(now.year, now.month, now.mday) - 1
+        when "weekly"
+          t = Time.mktime(now.year, now.month, now.mday) - (SiD * now.wday + 1)
+        when "monthly"
+          t = Time.mktime(now.year, now.month, 1) - 1
+        else
+          return now
+        end
+        Time.mktime(t.year, t.month, t.mday, t.hour, 59, 59)
+      end
+    end
+  end
+end

data/lib/hourly_logger_rotator/patch/ruby_2_5.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "hourly_logger_rotator/patch/ruby_2_4"
+
+module HourlyLoggerRotator
+  module Patch
+    # rubocop:disable Naming/ClassAndModuleCamelCase
+    module Ruby_2_5
+      # rubocop:enable Naming/ClassAndModuleCamelCase
+      include Ruby_2_4
+    end
+  end
+end

data/lib/hourly_logger_rotator/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HourlyLoggerRotator
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hourly_logger_rotator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dmitry Gubitskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop-config-umbrellio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -75,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -87,8 +116,11 @@ files:
 - bin/console
 - hourly_logger_rotator.gemspec
 - lib/hourly_logger_rotator.rb
+- lib/hourly_logger_rotator/patch/ruby_2_3.rb
+- lib/hourly_logger_rotator/patch/ruby_2_4.rb
+- lib/hourly_logger_rotator/patch/ruby_2_5.rb
 - lib/hourly_logger_rotator/version.rb
-homepage: https://github.com/umbrellio/hourly_log_rotator
+homepage: https://github.com/umbrellio/hourly_logger_rotator
 licenses:
 - MIT
 metadata: {}