smart_logger_wrapper 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dc96e2cf2599e135aa4413b1c04214c573f1603e
-  data.tar.gz: c7809de2f8e1fb1e1a3a00e44484f02ad5e7c08e
+SHA256:
+  metadata.gz: d466f7e45ea8cef683330d3ac32cbe04e13b23e1887b36e4383999018778dbb7
+  data.tar.gz: 86b7a9d0f135905ce16d46e6e69131eec966f2486791c90d646bbb7cdf439aef
 SHA512:
-  metadata.gz: aff557feb85a24581aeb9867cde9d38f6083e0de68d6b6b66c290c03f508bb817009209720e22898bf5e53982525ff740870897ef6151506cd975ebf4653b175
-  data.tar.gz: 9cfe545b190eaf060d1ba5e0b97dbcef9abe98ab906952e113be45d2e7cd43d4857d61609e80406501d4814d56288758b8dac7f64505805cf4c464d27fd77d12
+  metadata.gz: 5b299638a87014710a8a04ca9f54a43b6d4bf36dc53324e77fe1830a30634ffb5871efaca002f54ebd5a5edb320f5d8c8a7530873d1b4406c9e1f6cc628eaddf
+  data.tar.gz: 494b1d44d563486e4ee737da7bf0208be22c343893f2fb2bfe8b160d48e008d5816ad81ea6a39b453cea203f410dec021ff9deffd1c356764758f3636b342054

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/README.md

@@ -26,7 +26,7 @@ Wrap your logger with `SmartLoggerWrapper`, for example, in `config/environments
 
 ```diff
 -  config.logger = Logger.new('log/production.log', 'daily')
-+  config.logger = SmartLoggerWrapper(Logger.new('log/production.log', 'daily')).with_position
++  config.logger = SmartLoggerWrapper.new(Logger.new('log/production.log', 'daily')).with_position
 ```
 
 Note that it is strongly recommended to use the wrapper for all kind of environments so that you can avoid exceptions such as `NoMethodError` due to the unique features of this library.
@@ -105,7 +105,7 @@ logger.to(STDERR).info 'A message'
 
 #### #with\_position
 
-`with_position` option makes the logger tag the position where the logger is called.
+`with_position` option makes the logger tag the position where the logger is called. On Rails, this information will be filtered by `Rails.backtrace_cleaner` not to bother you with annoying long file paths on logs generated by Rails.
 
 ```ruby
 logger.with_position.info 'A message'
@@ -140,11 +140,11 @@ For instance, in the case you want to integrate a messenger, such as Slack, in a
 
 ```ruby
 SmartLoggerWrapper::Options.define_redirector :to_messenger, Class.new(SmartLoggerWrapper::Options::Base) {
-  def apply!(messages, argument, severity, wrapper)
-    channel = argument || 'general'
+  def apply!(messages, arguments, severity, wrapper)
+    channel = arguments.first || 'general'
     time = Time.now
     severity_label = wrapper.format_severity(severity)
-    formatted_messages = messages.map { |message| wrapper.formatted_message(severity_label, time, nil, message) }
+    formatted_messages = messages.map { |message| wrapper.format_message(severity_label, time, nil, message) }
     Thread.new do
       SomeMessenger.new(channel: channel).post(['```', *formatted_messages, '```'].join("\n"))
     end
@@ -158,17 +158,23 @@ Then, you can post log messages as follows:
 Rails.logger.to_messenger('channel').error('foo')
 ```
 
+#### Implementation
+
+Eash option is expected to be defined with a subclass of `SmartLoggerWrapper::Options::Base`. The class is required to respond to `#apply!` with the following arguments: `messages`, `argument`, `severity` and `wrapper`. Firstly, `messages` is an array of messages to be logged. In the case that you want to update the messages, you need to destructively update the array (because of its performance). Second, `argument` is the one which is passed as the option method argument. `severity` is an integer in response to `Logger::Severity`. Lastly, `wrapper` is the caller `SmartLoggerWrapper`.
+
+#### Option priority
+
 There are three categories for `SmartLoggerWrapper::Options`. Each option will be applied in the following order according to its category:
 
-#### 1. Tagger
+##### 1. Tagger
 
 A tagger is expected to be used to tag each message. To define a tagger, you will call `SmartLoggerWrapper::Options.define_tagger`.
 
-#### 2. Appender
+##### 2. Appender
 
 An appender is expected to append some additinal information to the message list. To define an appender, you will call `SmartLoggerWrapper::Options.define_appender`.
 
-#### 3. Redirector
+##### 3. Redirector
 
 A redirector should put messages to another location from the one where the wrapped logger specifies. To define a redirector, you will call `SmartLoggerWrapper::Options.define_redirector`.
 

data/lib/smart_logger_wrapper/options/append_backtrace.rb

@@ -7,8 +7,8 @@ class SmartLoggerWrapper < Logger
     class AppendBacktrace < Base
       include ::SmartLoggerWrapper::Utils::Backtrace
 
-      def apply!(messages, argument, severity, wrapper)
-        length = argument.is_a?(Numeric) ? argument : nil
+      def apply!(messages, arguments, severity, wrapper)
+        length = arguments.first.is_a?(Numeric) ? arguments.first : nil
         messages << [
           'BACKTRACE:',
           *get_backtrace(wrapper.offset + APPLY_CALLER_STACK_DEPTH + 1, length)

data/lib/smart_logger_wrapper/options/base.rb

@@ -3,7 +3,7 @@ require 'logger'
 class SmartLoggerWrapper < Logger
   module Options
     class Base
-      def apply!(messages, argument, severity, wrapper)
+      def apply!(messages, arguments, severity, wrapper)
         raise NotImplementedError, __callee__
       end
     end

data/lib/smart_logger_wrapper/options/to.rb

@@ -4,11 +4,12 @@ require 'smart_logger_wrapper/options/base'
 class SmartLoggerWrapper < Logger
   module Options
     class To < Base
-      def apply!(messages, argument, severity, wrapper)
-        raise ApplicationError, 'No handler given' if argument == nil
+      def apply!(messages, arguments, severity, wrapper)
+        raise ApplicationError, 'No handler given' if arguments.empty?
+        out = arguments.first
         time = Time.now
         severity_label = wrapper.format_severity(severity)
-        argument.puts messages.map { |message| wrapper.format_message(severity_label, time, nil, message) }.join("\n")
+        out.puts messages.map { |message| wrapper.format_message(severity_label, time, nil, message) }.join("\n")
       rescue NoMethodError => e
         raise ApplicationError, e.message
       end

data/lib/smart_logger_wrapper/options/with_position.rb

@@ -1,18 +1,21 @@
 require 'logger'
 require 'smart_logger_wrapper/options/base'
 require 'smart_logger_wrapper/utils/path'
+require 'smart_logger_wrapper/utils/backtrace'
 
 class SmartLoggerWrapper < Logger
   module Options
     class WithPosition < Base
       include ::SmartLoggerWrapper::Utils::Path
+      include ::SmartLoggerWrapper::Utils::Backtrace
 
-      def apply!(messages, argument, severity, wrapper)
-        return if argument == false
+      def apply!(messages, arguments, severity, wrapper)
+        enabled = arguments.first || true
+        return unless enabled
         # add 1 to `start` because this method dug the backtrace by 1
         location = caller_locations(wrapper.offset + APPLY_CALLER_STACK_DEPTH + 1, 1)
         prefix =
-          if location && location.length > 0
+          if location && location.length > 0 && location_important?(location)
             method_name = location[0].label
             path        = trim_dirname(location[0].absolute_path)
             lineno      = location[0].lineno
@@ -22,6 +25,12 @@ class SmartLoggerWrapper < Logger
           end
         messages.map! { |message| [prefix, message].compact.join(' ') }
       end
+
+      private
+
+      def location_important?(location)
+        ! clean_backtrace(location.map(&:to_s)).empty?
+      end
     end
 
     define_tagger :with_position, WithPosition

data/lib/smart_logger_wrapper/options.rb

@@ -9,10 +9,10 @@ class SmartLoggerWrapper < Logger
 
     module_function
 
-    def apply_all!(messages, severity, logger)
+    def apply_all!(messages, severity, wrapper)
       [defined_appenders, defined_taggers, defined_redirectors].flatten.each do |option_key|
-        if logger.options.include?(option_key)
-          defined_options[option_key].apply!(messages, logger.options[option_key], severity, logger)
+        if wrapper.options.include?(option_key)
+          defined_options[option_key].apply!(messages, wrapper.options[option_key], severity, wrapper)
         end
       end
     end

data/lib/smart_logger_wrapper/version.rb

@@ -1,5 +1,5 @@
 require 'logger'
 
 class SmartLoggerWrapper < Logger
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/lib/smart_logger_wrapper.rb

@@ -5,7 +5,8 @@ require 'smart_logger_wrapper/options'
 class SmartLoggerWrapper < Logger
   include Logger::Severity
 
-  LOGGER_SHORTCUT_OFFSET = 3
+  BASE_OFFSET = 3
+  NESTED_WRAPPER_OFFSET = 6
 
   SEVERITY_MAPPING = {
     debug:   DEBUG,
@@ -15,16 +16,16 @@ class SmartLoggerWrapper < Logger
     fatal:   FATAL,
     unknown: UNKNOWN
   }.freeze
-  DELEGETING_METHODS = %i(<< reopen close log add level debug? level= progname datetime_format= datetime_format formatter sev_threshold sev_threshold= info? warn? error? fatal? progname= formatter=)
+  DELEGETING_METHODS = %i(<< reopen close log add level debug? level= progname datetime_format= datetime_format formatter sev_threshold sev_threshold= info? warn? error? fatal? progname= formatter=).freeze
 
-  attr_reader :loggers, :options, :offset
+  attr_reader :loggers, :options, :base_offset, :parent
 
-  def initialize(logger = Logger.new(STDOUT), *loggers, **options)
-    @loggers = [logger, *loggers].freeze
+  def initialize(logger = Logger.new(STDOUT), *loggers, base_offset: nil, parent: nil, **options)
+    @base_offset = base_offset || BASE_OFFSET
+    @parent = parent
+    @loggers = be_parent_of!(logger, *loggers).freeze
     @options = options.freeze
-    @offset = LOGGER_SHORTCUT_OFFSET
     @_loggers_cache = {}
-    @_loggers_with_offset_cache = {}
   end
 
   # For all methods with severity label, logger accepts multiple messages.
@@ -49,14 +50,13 @@ class SmartLoggerWrapper < Logger
     end
   end
 
-  def with_offset(_offset)
-    @_loggers_with_offset_cache[_offset] ||= clone.tap do |logger_with_offset|
-      logger_with_offset.instance_variable_set(:@offset, _offset)
-    end
+  def offset
+    @base_offset + depth * NESTED_WRAPPER_OFFSET
   end
 
-  def overwrite_options(_options)
-    @options = options.merge(_options).freeze
+  def depth
+    return 0 if root?
+    parent.depth + 1
   end
 
   def format_severity(severity)
@@ -67,6 +67,11 @@ class SmartLoggerWrapper < Logger
     loggers.first.send(:format_message, severity, datetime, progname, msg)
   end
 
+  def with_option(option_name, *args)
+    new_options = options.merge(option_name => args)
+    self.class.new(*loggers, base_offset: base_offset, **new_options)
+  end
+
   private
 
   def build_messages(severity, *args, &block)
@@ -98,18 +103,36 @@ class SmartLoggerWrapper < Logger
     end
   end
 
+  def set_parent!(new_parent)
+    @_loggers_cache.clear if new_parent != nil
+    @parent = new_parent == self ? nil : new_parent # to avoid stack overflow at #depth
+  end
+
+  def be_parent_of!(*loggers)
+    loggers.each do |logger|
+      # XXX: Calling a private method because it is an internal procedure
+      logger.is_a?(SmartLoggerWrapper) ? logger.send(:set_parent!, self) : logger
+    end
+  end
+
+  def root?
+    parent == nil
+  end
+
   def method_missing(method_name, *args, &block)
-    if Options.defined_option?(method_name)
-      # If there is an defined option with the same name as the method name, return a new logger with the option.
-      arg = args.first
+    if root? && Options.defined_option?(method_name)
+      # When the root wrapper receive an defined option with the same name as the method name,
+      # return a new logger wrapper with the option.
       @_loggers_cache[method_name] = {} unless @_loggers_cache.include?(method_name)
-      new_logger = @_loggers_cache[method_name][arg] ||= clone.tap do |cloned|
-        cloned.overwrite_options(method_name => arg)
-      end
-      return block.(new_logger) if block_given?
-      new_logger
+      logger_with_option = @_loggers_cache[method_name][args] ||= with_option(method_name, *args)
+      return block.(logger_with_option) if block_given?
+      logger_with_option
     else
       super
     end
   end
+
+  def respond_to_missing?(method_name, includes_private)
+    root? && Options.defined_option?(method_name) || super
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_logger_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Akihiro Katsura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2018-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -98,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: SmartLoggerWrapper adds some useful features to the Ruby Logger or a subclass.