smart_logger_wrapper 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f45d9e44bc4f77ee5b3f83e20fb5e2218c730eb5
-  data.tar.gz: 3cee85975631e80310d7bf41aa00af346cefae86
+  metadata.gz: f821646a21a7ca5704bedff4b51aad0655417dfa
+  data.tar.gz: 2dea06157c0c52b008fe3e991b3c6d10947ac99a
 SHA512:
-  metadata.gz: f6c9bd513546ab8151367defcb7a210deab757ad5c20d313b2ae3ba00a4134230457030c8c231dc5c216808c7ca53d7f017131c06ed9139b2f7ae7c93cbd94ae
-  data.tar.gz: 8fcd107646c2e6e2af92a78eccaba36287fee0177d6d90adbe1cb78ab734a28a6d34a801b84592df51c51753dc97603448996689b427e155454f45ff9f9c43d0
+  metadata.gz: cddf0ac43265639c9ef533974225c874dd3ef97f94aff290c0711579ee912670fb1c59164bef8374c62faf9d4aaf29009ba6d63a10be48aa01317e26c0d2152f
+  data.tar.gz: c1e9928de163ef319c761c51be91aa601f0ee810e4e2349101fafe740615b37df4fcec8f09faebbf9fdac37fdcd151413ddbf1ccdd75ad3b43242805a48124ba

data/README.md

@@ -31,12 +31,12 @@ Wrap your logger with `SmartLoggerWrapper`, for example, in `config/environments
 
 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.
 
-You may want to put log messages to `STDOUT` in your development environment. Then:
+You may want to put log messages to `STDERR` in your development environment. Then:
 
 ```ruby
   config.logger = SmartLoggerWrapper.new(
     SmartLoggerWrapper.new(Logger.new("log/development.log")).with_position,
-    ActiveSupport::Logger.new(STDOUT)
+    ActiveSupport::Logger.new(STDERR)
   )
 ```
 
@@ -130,6 +130,49 @@ logger.append_backtrace.info 'A message'
 logger.append_backtrace(2).info 'A message'
 ```
 
+### Define your own options
+
+You can define a new option by your own.
+
+For instance, in the case you want to integrate a messenger, such as Slack, in a Rails app, you will define an initializer like this:
+
+`config/initializers/some_messenger_integration.rb`
+
+```ruby
+SmartLoggerWrapper::Options.define_redirector :to_messenger, Class.new(SmartLoggerWrapper::Options::Base) do
+  def apply!(messages, argument, severity, wrapper)
+    channel = argument || 'general'
+    formatter = wrapper.formatter
+    formatted_messages = messages.map { |message| formatter.call(severity, time, nil, message) }
+    Thread.new do
+      SomeMessenger.new(channel: channel).post(['```', *formatted_messages, '```'].join("\n"))
+    end
+  end
+end
+```
+
+Then, you can post log messages as follows:
+
+```ruby
+Rails.logger.to_messenger('channel').error('foo')
+```
+
+There are three categories for `SmartLoggerWrapper::Options`. Each option will be applied in the following order according to its category:
+
+#### 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
+
+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
+
+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`.
+
+Indeed, these categories don't restrict how you implement your options. You can, for example, tag messages with a redirector in your responsibility.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/akeyhero/smart_logger_wrapper.

data/lib/smart_logger_wrapper/options/append_backtrace.rb

@@ -7,15 +7,15 @@ class SmartLoggerWrapper < Logger
     class AppendBacktrace < Base
       include ::SmartLoggerWrapper::Utils::Backtrace
 
-      def apply!(messages, value, logger)
-        length = value.is_a?(Numeric) ? value : nil
+      def apply!(messages, argument, severity, wrapper)
+        length = argument.is_a?(Numeric) ? argument : nil
         messages << [
           'BACKTRACE:',
-          *get_backtrace(logger.offset + APPLY_CALLER_STACK_DEPTH + 1, length)
+          *get_backtrace(wrapper.offset + APPLY_CALLER_STACK_DEPTH + 1, length)
         ].join("\n")
       end
     end
 
-    define_appender :append_backtrace, AppendBacktrace.new
+    define_appender :append_backtrace, AppendBacktrace
   end
 end

data/lib/smart_logger_wrapper/options/base.rb

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

data/lib/smart_logger_wrapper/options/to.rb

@@ -4,14 +4,16 @@ require 'smart_logger_wrapper/options/base'
 class SmartLoggerWrapper < Logger
   module Options
     class To < Base
-      def apply!(messages, value, logger)
-        raise ApplicationError, 'No handler given' if value == nil
-        value.puts messages.join("\n")
+      def apply!(messages, argument, severity, wrapper)
+        raise ApplicationError, 'No handler given' if argument == nil
+        time = Time.now
+        formatter = wrapper.formatter
+        argument.puts messages.map { |message| formatter.call(severity, time, nil, message) }.join("\n")
       rescue NoMethodError => e
         raise ApplicationError, e.message
       end
     end
 
-    define_redirector :to, To.new
+    define_redirector :to, To
   end
 end

data/lib/smart_logger_wrapper/options/with_position.rb

@@ -7,10 +7,10 @@ class SmartLoggerWrapper < Logger
     class WithPosition < Base
       include ::SmartLoggerWrapper::Utils::Path
 
-      def apply!(messages, value, logger)
-        return if value == false
+      def apply!(messages, argument, severity, wrapper)
+        return if argument == false
         # add 1 to `start` because this method dug the backtrace by 1
-        location = caller_locations(logger.offset + APPLY_CALLER_STACK_DEPTH + 1, 1)
+        location = caller_locations(wrapper.offset + APPLY_CALLER_STACK_DEPTH + 1, 1)
         prefix =
           if location && location.length > 0
             method_name = location[0].label
@@ -24,6 +24,6 @@ class SmartLoggerWrapper < Logger
       end
     end
 
-    define_tagger :with_position, WithPosition.new
+    define_tagger :with_position, WithPosition
   end
 end

data/lib/smart_logger_wrapper/options.rb

@@ -9,10 +9,10 @@ class SmartLoggerWrapper < Logger
 
     module_function
 
-    def apply_all!(messages, logger)
+    def apply_all!(messages, severity, logger)
       [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], logger)
+          defined_options[option_key].apply!(messages, logger.options[option_key], severity, logger)
         end
       end
     end
@@ -20,7 +20,7 @@ class SmartLoggerWrapper < Logger
     def define_option(option_name, option_object, defined_option_keys)
       key = option_name.to_sym
       defined_option_keys.push(key)
-      defined_options.merge!(key => option_object)
+      defined_options.merge!(key => option_object.new)
     end
 
     def define_appender(option_name, option_object)

data/lib/smart_logger_wrapper/version.rb

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

data/lib/smart_logger_wrapper.rb

@@ -31,7 +31,7 @@ class SmartLoggerWrapper < Logger
   # The return value is the first one of the first logger's.
   SEVERITY_MAPPING.each do |severity_name, severity|
     define_method(severity_name) do |*args, &block|
-      format_messages(*args, &block).map do |message|
+      format_messages(severity, *args, &block).map do |message|
         loggers.map do |logger|
           logger.public_send(severity_name, message)
         end.first
@@ -61,11 +61,11 @@ class SmartLoggerWrapper < Logger
 
   private
 
-  def format_messages(*args, &block)
+  def format_messages(severity, *args, &block)
     messages = args.map { |arg| to_message(arg) }
     messages << to_message(block.call) if block_given?
     begin
-      Options.apply_all!(messages, self)
+      Options.apply_all!(messages, severity, self)
     rescue Options::ApplicationError => e
       loggers.each do |logger|
         logger.error(<<~EOM)

data/smart_logger_wrapper.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Akihiro Katsura"]
   spec.email         = ["info@kats.la"]
 
-  spec.summary       = %q{SmartLoggerWrapper adds some useful features to the Ruby Logger or the compatibles.}
-  # spec.description   = %q{SmartLoggerWrapper adds some useful features to the Ruby Logger or the compatibles.}
+  spec.summary       = %q{SmartLoggerWrapper adds some useful features to the Ruby Logger or a subclass.}
+  # spec.description   = %q{SmartLoggerWrapper adds some useful features to the Ruby Logger or a subclass.}
   spec.homepage      = "https://github.com/akeyhero/smart_logger_wrapper"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_logger_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Akihiro Katsura
@@ -101,5 +101,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: SmartLoggerWrapper adds some useful features to the Ruby Logger or the compatibles.
+summary: SmartLoggerWrapper adds some useful features to the Ruby Logger or a subclass.
 test_files: []