smart_logger_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e74dde7e2e9f462afec29ffccaf4066fffe25f4
+  data.tar.gz: bcbbe35862489fe01aa3629cbe8d6026f09889aa
+SHA512:
+  metadata.gz: aeef4e5d071ba8d79f3ca8c335c82b31430759090dc0e38ae95ce7f8d0ea3a64bad34a82f5fe542dcf5411e671397be23d04f386ac3d0e0ef6f7fc04edc1de95
+  data.tar.gz: 32f1a2b6ddc5fb8ba57a93b3e7aaec27f4fdbad2dcd3be215968a4a48844613aed9cc49e64ce67ed9af21530ae05daef93d82654623c1085a62272ce664eab1a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/vendor
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smart_logger_wrapper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 akihiro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,127 @@
+# SmartLoggerWrapper
+
+SmartLoggerWrapper adds some useful features to the Ruby Logger or the compatibles. See Usage below to find out how it benefits your development.
+
+[![Build Status](https://travis-ci.org/akeyhero/smart_logger_wrapper.svg?branch=master)](https://travis-ci.org/akeyhero/smart_logger_wrapper)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smart_logger_wrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smart_logger_wrapper
+
+### For Ruby on Rails
+
+Wrap your logger with `SmartLoggerWrapper`, for example:
+
+```diff
+-  config.logger = Logger.new('log/production.log', 'daily')
++  config.logger = SmartLoggerWrapper(Logger.new('log/production.log', 'daily')).with_position
+```
+
+Note that it is strongly recommended to use the wrapper for all environments so that you can avoid exceptions such as `NoMethodError` due to the unique features of this library.
+
+## Usage
+
+### Basic
+
+Initialize with a Ruby `Logger` or an instance of the compatibles (e.g. `ActiveSupport::TaggedLogging`):
+
+```ruby
+require 'logger'
+require 'smart_logger_wrapper'
+
+logger = SmartLoggerWrapper.new(Logger.new('log/development.log'))
+
+logger.info 'Call logging methods as usual.'
+```
+
+The compatibles must respond to `#log` with the same arguments as `Logger#log`.
+
+### Feature 1: Integrate multiple logger calls
+
+`SmartLoggerWrapper` accepts multiple arguments like `puts` method does. Then the wrapped logger will be called for each of the arguments.
+
+```ruby
+logger.info 'foo', 'bar'
+# => I, [2018-03-19T03:03:52.525503 #92534]  INFO -- : foo
+# => I, [2018-03-19T03:03:52.527478 #92534]  INFO -- : bar
+```
+
+### Feature 2: Better exception logging
+
+When you pass an exception to this logger, it logs the backtrace of the exception along with the message.
+
+```ruby
+logger.error ex
+# => E, [2018-03-19T02:53:01.605740 #92534] ERROR -- : #<RuntimeError: an error>
+# => path/to/code.rb:6:in `foo'
+# => path/to/code.rb:2:in `bar'
+```
+
+### Feature 3: Optional modifiers
+
+You can chain options to the logger instance to modify logging messages.
+
+```ruby
+logger.with_position.to(STDERR).info 'A message'
+
+# You can use blocks to log several times with the same options.
+logger.with_position do |pos_logger|
+  pos_logger.info 'A message'
+  pos_logger.append_backtrace.error 'An error'
+end
+```
+
+#### #to
+
+With `to` option, this logger leaves your messages to another location besides the original where the wrapped logger logs.
+
+```ruby
+logger.to(STDERR).info 'A message'
+```
+
+#### #with\_position
+
+`with_position` option makes the logger tag the position where the logger is called.
+
+```ruby
+logger.with_position.info 'A message'
+# => I, [2018-03-19T03:34:10.448542 #92534]  INFO -- : [path/to/caller.rb@foo:2] A message
+
+# You can turn off this option by chaining #with_position with false
+logger.with_position.with_position(false).info 'A message'
+```
+
+#### #append\_backtrace
+
+With `append_backtrace`, the logger adjoins its caller's backtrace.
+
+```ruby
+logger.append_backtrace.info 'A message'
+# => I, [2018-03-19T03:44:36.987404 #97956]  INFO -- : A message
+# => I, [2018-03-19T03:44:36.987530 #97956]  INFO -- : BACKTRACE:
+# => path/to/code.rb:6:in `foo'
+# => path/to/code.rb:2:in `bar'
+
+# You can specify the length of the backtrace to log
+logger.append_backtrace(2).info 'A message'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/akeyhero/smart_logger_wrapper.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "smart_logger_wrapper"
+
+# 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

@@ -0,0 +1,8 @@
+#!/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

data/lib/smart_logger_wrapper.rb

@@ -0,0 +1,81 @@
+require 'logger'
+require 'smart_logger_wrapper/version'
+require 'smart_logger_wrapper/options'
+
+class SmartLoggerWrapper
+  include Logger::Severity
+
+  SEVERITY_MAPPING = {
+    debug:   DEBUG,
+    info:    INFO,
+    warn:    WARN,
+    error:   ERROR,
+    fatal:   FATAL,
+    unknown: UNKNOWN
+  }.freeze
+
+  attr_reader :logger, :options
+
+  def initialize(logger = Logger.new(STDOUT), **options)
+    @logger = logger
+    @options = options
+  end
+
+  def log(severity, *args, &block)
+    _log(severity, *args, &block)
+  end
+  alias add log
+
+  SEVERITY_MAPPING.each do |severity_name, severity|
+    define_method(severity_name) do |*args, &block|
+      _log(severity, *args, &block)
+    end
+  end
+
+  private
+
+  # All methods calling this must have the synchronized call stack depth so that this can show neat positions and backtraces
+  def _log(severity, *args, &block)
+    messages = args.map { |arg| to_message(arg) }
+    messages << to_message(block.call) if block_given?
+    begin
+      Options.apply_all!(messages, options)
+      true
+    rescue Options::ApplicationError => e
+      logger.error(<<~EOM)
+        Failed to apply options: #{e.inspect}
+        #{e.backtrace.join("\n")}
+      EOM
+      false
+    end.tap do |succeeded|
+      messages.each do |message|
+        logger.log(severity, nil, message)
+      end
+    end
+  end
+
+  def to_message(object)
+    case object
+    when String
+      object
+    when Exception
+      backtrace = object.backtrace ? Utils::Backtrace.clean_backtrace(object.backtrace) : []
+      info = [object.inspect]
+      (info + backtrace).join("\n")
+    else
+      object.inspect
+    end
+  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.
+      new_logger = self.class.new(logger, **options.merge(method_name => args.first))
+      return block.(new_logger) if block_given?
+      new_logger
+    else
+      # otherwise, call the method of the warpped logger.
+      logger.public_send(method_name, *args, &block)
+    end
+  end
+end

data/lib/smart_logger_wrapper/options.rb

@@ -0,0 +1,58 @@
+class SmartLoggerWrapper
+  module Options
+    class ApplicationError < StandardError; end
+
+    # XXX: Be careful! This relies strongly on the implementation of this and the callers
+    APPLY_CALLER_STACK_DEPTH = 4
+
+    module_function
+
+    def apply_all!(messages, options)
+      [defined_appenders, defined_taggers, defined_redirectors].flatten.each do |option_key|
+        defined_options[option_key].apply!(messages, options[option_key]) if options.include?(option_key)
+      end
+    end
+
+    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)
+    end
+
+    def define_appender(option_name, option_object)
+      define_option(option_name, option_object, defined_appenders)
+    end
+
+    def define_tagger(option_name, option_object)
+      define_option(option_name, option_object, defined_taggers)
+    end
+
+    def define_redirector(option_name, option_object)
+      define_option(option_name, option_object, defined_redirectors)
+    end
+
+    def defined_appenders
+      @defined_appenders ||= []
+    end
+
+    def defined_taggers
+      @defined_taggers ||= []
+    end
+
+    def defined_redirectors
+      @defined_redirectors ||= []
+    end
+
+    def defined_options
+      @defined_options ||= {}
+    end
+
+    def defined_option?(option_name)
+      defined_options.include?(option_name.to_sym)
+    end
+  end
+end
+
+require 'smart_logger_wrapper/options/to'
+require 'smart_logger_wrapper/options/append_backtrace'
+require 'smart_logger_wrapper/options/with_position'

data/lib/smart_logger_wrapper/options/append_backtrace.rb

@@ -0,0 +1,22 @@
+require 'smart_logger_wrapper/options/base'
+require 'smart_logger_wrapper/utils/backtrace'
+
+class SmartLoggerWrapper
+  module Options
+    class AppendBacktrace < Base
+      include ::SmartLoggerWrapper::Utils::Backtrace
+
+      def initialize(start)
+        super()
+        @start = start
+      end
+
+      def apply!(messages, value = nil)
+        length = value.is_a?(Numeric) ? value : nil
+        messages << "BACKTRACE:\n" + get_backtrace(@start + 1, length).join("\n")
+      end
+    end
+
+    define_appender :append_backtrace, AppendBacktrace.new(APPLY_CALLER_STACK_DEPTH + 1)
+  end
+end

data/lib/smart_logger_wrapper/options/base.rb

@@ -0,0 +1,10 @@
+class SmartLoggerWrapper
+  module Options
+    class Base
+      def apply!(messages, value)
+        raise NotImplementedError, __callee__
+      end
+    end
+  end
+end
+

data/lib/smart_logger_wrapper/options/to.rb

@@ -0,0 +1,16 @@
+require 'smart_logger_wrapper/options/base'
+
+class SmartLoggerWrapper
+  module Options
+    class To < Base
+      def apply!(messages, value)
+        raise ApplicationError, 'No handler given' if value == nil
+        value.puts messages.join("\n")
+      rescue NoMethodError => e
+        raise ApplicationError, e.message
+      end
+    end
+
+    define_redirector :to, To.new
+  end
+end

data/lib/smart_logger_wrapper/options/with_position.rb

@@ -0,0 +1,33 @@
+require 'smart_logger_wrapper/options/base'
+require 'smart_logger_wrapper/utils/path'
+
+class SmartLoggerWrapper
+  module Options
+    class WithPosition < Base
+      include ::SmartLoggerWrapper::Utils::Path
+
+      def initialize(start)
+        super()
+        @start = start
+      end
+
+      def apply!(messages, value = nil)
+        return if value == false
+        # add 1 to `start` because this method dug the backtrace by 1
+        location = caller_locations(@start + 1, 1)
+        prefix =
+          if location && location.length > 0
+            method_name = location[0].label
+            path        = trim_dirname(location[0].absolute_path)
+            lineno      = location[0].lineno
+            "[#{method_name}@#{path}:#{lineno}]"
+          else
+            nil
+          end
+        messages.map! { |message| [prefix, message].compact.join(' ') }
+      end
+    end
+
+    define_tagger :with_position, WithPosition.new(APPLY_CALLER_STACK_DEPTH + 1)
+  end
+end

data/lib/smart_logger_wrapper/utils/backtrace.rb

@@ -0,0 +1,25 @@
+require 'smart_logger_wrapper/utils/path'
+
+class SmartLoggerWrapper
+  module Utils
+    module Backtrace
+      module_function
+
+      def get_backtrace(start, length = nil)
+        # add 1 to `start` because this method dug the backtrace by 1
+        backtrace = clean_backtrace(caller_locations(start + 1).map(&:to_s).lazy)
+        length == nil ? backtrace.to_a : backtrace.first(length)
+      end
+
+      def clean_backtrace(backtrace)
+        (
+          if defined?(::Rails) && ::Rails.respond_to?(:backtrace_cleaner)
+            Rails.backtrace_cleaner.filter(backtrace)
+          else
+            backtrace
+          end
+        ).map { |line| Path.trim_dirname(line) }
+      end
+    end
+  end
+end

data/lib/smart_logger_wrapper/utils/path.rb

@@ -0,0 +1,13 @@
+class SmartLoggerWrapper
+  module Utils
+    module Path
+      DIR_TRIMMER_PATTERN = /^#{Dir.pwd}\/?/
+
+      module_function
+
+      def trim_dirname(line)
+        line.sub(DIR_TRIMMER_PATTERN, '')
+      end
+    end
+  end
+end

data/lib/smart_logger_wrapper/version.rb

@@ -0,0 +1,3 @@
+class SmartLoggerWrapper
+  VERSION = "0.1.0"
+end

data/smart_logger_wrapper.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smart_logger_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smart_logger_wrapper"
+  spec.version       = SmartLoggerWrapper::VERSION
+  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.homepage      = "https://github.com/akeyhero/smart_logger_wrapper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: smart_logger_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akihiro Katsura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- info@kats.la
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smart_logger_wrapper.rb
+- lib/smart_logger_wrapper/options.rb
+- lib/smart_logger_wrapper/options/append_backtrace.rb
+- lib/smart_logger_wrapper/options/base.rb
+- lib/smart_logger_wrapper/options/to.rb
+- lib/smart_logger_wrapper/options/with_position.rb
+- lib/smart_logger_wrapper/utils/backtrace.rb
+- lib/smart_logger_wrapper/utils/path.rb
+- lib/smart_logger_wrapper/version.rb
+- smart_logger_wrapper.gemspec
+homepage: https://github.com/akeyhero/smart_logger_wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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.
+test_files: []