log_decorator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba107a1dc8b72623b1856a7313aa34b531a8b83d
+  data.tar.gz: e50d21dce4fdb6ea705b54e8af6734fd8f734829
+SHA512:
+  metadata.gz: d2cc774af0caacf463887e802425d9fef36aba9b0735ee1e5f5f9819fa497084c1293f4d53c59924fdc1555700a0887dcadf0fe5d6ad745adce08cdf9cc22e4a
+  data.tar.gz: 4b90098ffec9fadb8a72a9fccf6d318fef4b8e5770d18abe6f637e3d47e296df512b80ab3be3c1ff7935767d81b34c92edb00616c9a2d90d26c0f167d80189d0

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# 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.1
+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 log_decorator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 ManageIQ
+
+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,80 @@
+# LogDecorator
+
+Acts as a proxy to a configurable underlying logging mechanism,
+permitting the code to be executed in absence of the logger.
+
+Provides hooks to permit the "decoration" of log messages. By default,
+the class and method name of the caller are added to the log message.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'log_decorator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install log_decorator
+
+## Usage
+
+### Initialization
+
+```ruby
+logger = Logger.new # Instantiate an instance of the logger of your choice
+logger.level = desired_log_level # Set up the logger as needed
+LogDecorator.logger = logger # Tell LogDecorator to use the logger
+```
+
+### Use
+
+Given:
+
+```ruby
+class MyClass
+  include LogDecorator
+
+  def self.method_1
+    _log.debug "Called"
+  end
+
+  def method_2
+    _log.debug "Called"
+  end
+end
+```
+
+Then:
+
+```ruby
+MyClass.method_1
+```
+
+Logs:
+
+```
+MyClass.method_1 Called
+```
+
+and
+
+```ruby
+MyClass.new.method_2
+```
+
+Logs:
+
+```
+MyClass#method_2 Called
+```
+
+## 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 "log_decorator"
+
+# 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/log_decorator.rb

@@ -0,0 +1,26 @@
+require "log_decorator/version"
+require "log_decorator/log_proxy"
+require "log_decorator/logging"
+
+module LogDecorator
+  DEFAULT_PREFIX = lambda do |klass, separator, location|
+    location = location.first if location.is_a?(Array)
+    meth = location.base_label
+    meth ? "#{klass}#{separator}#{meth}" : klass
+  end
+
+  DEFAULT_LOG_LEVELS = [:debug, :info, :warn, :error]
+
+  class << self
+    attr_writer :prefix, :log_levels
+    attr_accessor :logger
+
+    def prefix
+      @prefix ||= DEFAULT_PREFIX
+    end
+
+    def log_levels
+      @log_levels ||= DEFAULT_LOG_LEVELS
+    end
+  end
+end

data/lib/log_decorator/log_proxy.rb

@@ -0,0 +1,50 @@
+module LogDecorator
+  class LogProxy
+    attr_accessor :prefix, :logger
+
+    def self.initialize_log_levels # rubocop:disable AbcSize
+      return if @log_levels_initialized
+      @log_levels_initialized = true
+
+      LogDecorator.log_levels.each do |level|
+        define_method(level) do |msg = nil, &blk|
+          return unless logger # rubocop:disable Lint/NonLocalExitFromIterator
+          location = caller_locations(1, 1)
+          if blk
+            logger.send(level) do
+              "#{@prefix.call(@klass, @separator, location)} #{blk.call}"
+            end
+          else
+            logger.send(level, "#{@prefix.call(@klass, @separator, location)} #{msg}")
+          end
+        end
+
+        level_bool = :"#{level}?"
+        define_method(level_bool) do
+          return unless logger # rubocop:disable Lint/NonLocalExitFromIterator
+          logger.send(level_bool)
+        end
+      end
+    end
+
+    def initialize(klass, separator)
+      self.class.initialize_log_levels
+      @klass     = klass
+      @separator = separator
+      @prefix    = LogDecorator.prefix
+      @logger    = LogDecorator.logger
+    end
+
+    def level
+      logger.level if logger
+    end
+
+    def level=(level)
+      logger.level = level if logger
+    end
+
+    def log_backtrace
+      logger.log_backtrace if logger
+    end
+  end
+end

data/lib/log_decorator/logging.rb

@@ -0,0 +1,33 @@
+module LogDecorator
+  module Logging
+    module ClassMethods
+      def instance_logger
+        @instance_logger ||= LogProxy.new(name, '#')
+      end
+
+      def _log
+        @_log ||= LogProxy.new(name, '.')
+      end
+
+      def _logger=(logger)
+        _log.logger = logger
+        instance_logger.logger = logger
+      end
+
+      def _log_prefix=(prefix)
+        _log.prefix = prefix
+        instance_logger.prefix = prefix
+      end
+    end
+
+    def self.included(host_class)
+      host_class.extend(ClassMethods) unless host_class.respond_to?(:_log)
+      host_class.instance_logger
+      host_class._log
+    end
+
+    def _log
+      self.class.instance_logger
+    end
+  end
+end

data/lib/log_decorator/version.rb

@@ -0,0 +1,3 @@
+module LogDecorator
+  VERSION = "0.1.0"
+end

data/log_decorator.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'log_decorator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "log_decorator"
+  spec.version       = LogDecorator::VERSION
+  spec.authors       = ["ManageIQ Authors"]
+
+  spec.summary       = "Add caller location information to log messages - class and method names."
+  spec.description   = %q(
+    Acts as a proxy to a configurable underlying logging mechanism,
+    permitting the code to be executed in absence of the logger.
+
+    Provides hooks to permit the "decoration" of log messages. By default,
+    the class and method name of the caller are added to the log message.
+  )
+  spec.homepage      = "https://github.com/ManageIQ/log_decorator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "log4r"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: log_decorator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ManageIQ Authors
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  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'
+description: "\n    Acts as a proxy to a configurable underlying logging mechanism,\n
+  \   permitting the code to be executed in absence of the logger.\n\n    Provides
+  hooks to permit the \"decoration\" of log messages. By default,\n    the class and
+  method name of the caller are added to the log message.\n  "
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/log_decorator.rb
+- lib/log_decorator/log_proxy.rb
+- lib/log_decorator/logging.rb
+- lib/log_decorator/version.rb
+- log_decorator.gemspec
+homepage: https://github.com/ManageIQ/log_decorator
+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.11
+signing_key: 
+specification_version: 4
+summary: Add caller location information to log messages - class and method names.
+test_files: []