invisible_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca46784d89f34c1e96402d85cde389a0ea5b6b30
+  data.tar.gz: 47164053247b9cc2c5431d6410f9ed3c27b3d6ed
+SHA512:
+  metadata.gz: 60a2cc5d7e198ae3c3fe166a070038a113fbddf4b9d2551499e9bed8de2327a2388b8961ac75087b007d1f18a4d6beafab33939fec01e63d7b8dac6b004abd97
+  data.tar.gz: e0b1c67e297e9b0547e22b1c64dc4b41cc655f7141d9af8357ee9de325474a4824b45b4040bdf5bac8f88c5ab7755d69683db5d473abed5370816c0691cfcc98

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,88 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+### Ruby ###
+.byebug_history
+*.gem
+
+### macOS ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Config ###
+/config/*
+!/config/*.sample
+
+# Used by dotenv library to load environment variables.
+.env
+.env.*
+.env.local
+.env.local.*
+!.env.local.test
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+### Vim ###
+# swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-v][a-z]
+[._]sw[a-p]
+# session
+Session.vim
+# temporary
+.netrwhist
+*~
+# auto-generated tag files
+tags

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  DisabledByDefault: false
+  TargetRubyVersion: 2.4
+  Exclude:
+    - 'spec/fixtures/**/*'
+
+Metrics/LineLength:
+  Max: 120
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # containing a URI to be longer than Max.
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+  # The IgnoreCopDirectives option causes the LineLength rule to ignore cop
+  # directives like '# rubocop: enable ...' when calculating a line's length.
+  IgnoreCopDirectives: false
+  # The IgnoredPatterns option is a list of !ruby/regexp and/or string
+  # elements. Strings will be converted to Regexp objects. A line that matches
+  # any regular expression listed in this option will be ignored by LineLength.
+  IgnoredPatterns: []
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/AbcSize:
+  Max: 20

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at smileart21@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in invisible_logger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 smileart
+
+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,159 @@
+# 🕵🏻‍♂️ InvisibleLogger
+
+> A tool to output complex logs with minimal intrusion and smallest possible footprint in the "host" code + additional ability to aggregate separate logs.
+
+You know how sometimes one can't see the wood for the trees? The same happens with an extensive logging, when long or even multiline logs polute your code and it's hard to see the business logic behind all the noise they create. InvisibleLogger is an attempt to solve this issue.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'invisible_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install invisible_logger
+
+## Usage
+
+Have you ever encountered the situation when you can hardly see the business logic behind the logging? Let's consider an example: 
+
+```ruby
+# 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧
+
+class SomeService
+  def initialize(api_key, logger)
+    logger.info "Service → count#auth_attempt=1"
+    logger.info "Trying to login with the API key: #{api_key}" if ENV['DEBUG']
+
+    auth_result = ThirdPartyAPI.auth(api_key)
+
+    if auth_result[:status] == :success
+      @tmp_token = auth_result[:auth_token]
+
+      logger.info %W[
+          Service → Authentication was successful! ::
+          Status: #{auth_result[:status]} ::
+          API Version: #{auth_result[:api_version]} ::
+          Temporary token: #{auth_result[:auth_token]}
+      ].join ' '
+    else
+      logger.error %W[
+          Service → count#auth_errors=1 ::
+          Authentication failed with status #{auth_result[:status]} ::
+          Error code: #{auth_result[:error_code]} ::
+          Error message: #{auth_result[:error_message]}
+      ].join ' '
+
+      raise ThirdPartyAPIAuthError, auth_result[:error_message]
+    end
+  end
+end
+
+# 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧
+```
+
+With InvisibleLogger you'd be able to refactor it into something like this:
+
+```ruby
+# 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧
+
+class SomeService
+  include LogStencils::SomeService
+
+  def initialize(api_key, logger)
+    @il = InvisibleLogger.new(logger: logger, log_stencil: LOG_STENCIL)
+
+    @il.l(binding, :auth_attempt)
+    @il.l(binding, :debug_api_key) if ENV['DEBUG']
+
+    auth_result = ThirdPartyAPI.auth(api_key)
+
+    if auth_result[:status] == :success
+      @tmp_token = auth_result[:auth_token]
+      @il.l(binding, :success)
+    else
+      @il.l(binding, :failure)
+      raise ThirdPartyAPIAuthError, auth_result[:error_message]
+    end
+  end
+end
+
+# 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧
+```
+
+While the log messages themselves live in a separate dedicated place (*but, don't worry about any context lose, InvisibleLogger has DEBUG mode and customisable markers for each messag, plus error messages about wrong var names are quite readable*):
+
+```ruby
+module LogStencils
+ module SomeService
+	LOG_STENCIL = {
+	    auth_attempt: {
+	      level: :info,
+	      template: <<~LOG
+           Service → count#auth_attempt=1
+	      LOG
+	    },
+	    debug_api_key: {
+	      vars: [: api_key],
+	      level: :info,
+	      template: <<~LOG
+	        Trying to login with the API key: %<api_key>s
+	      LOG
+	    },
+	    success: {
+	      vars: [
+	        { status: 'auth_result[:status]' },
+	        { api_version: 'auth_result[:api_version]' },
+	        { tmp_token: 'auth_result[:auth_token]' }
+	      ],
+	      level: :info,
+	      template: <<~LOG
+	        Service → Authentication was successful! ::|
+           Status: %<status>s ::|
+           API Version: %<api_version>s ::|
+           Temporary token: %<tmp_token>s
+	      LOG
+	    },
+	    failure: {
+	      vars: [
+	        { status:    'auth_result[:status]' },
+	        { err_code:  'auth_result[:error_code]' },
+	        { err_msg:   'auth_result[:error_message]' }
+	      ],
+	      level: :error,
+	      template: <<~LOG
+	        Service → count#auth_errors=1 ::
+           Authentication failed with status %<status>s ::
+           Error code: %<err_code>s ::
+           Error message: %<err_msg>s
+	      LOG
+	    }
+    }
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/smileart/invisible_logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the InvisibleLogger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/smileart/invisible_logger/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'invisible_logger'
+
+# 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/invisible_logger.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'invisible_logger'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'invisible_logger'
+  spec.version       = InvisibleLogger::VERSION
+  spec.authors       = ['smileart']
+  spec.email         = ['smileart21@gmail.com']
+
+  spec.summary       = 'A tool to minimise logs footprint in the host code'
+  spec.description   = 'A tool to output complex logs with minimal intrusion and smallest possible ' \
+    'footprint in the "host" code + additional ability to aggregate separate logs'
+  spec.homepage      = 'http://github.com/smileart/invisible_logger'
+  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.16'
+  spec.add_development_dependency 'byebug',         '~> 9.1'
+  spec.add_development_dependency 'inch',           '~> 0.7'
+  spec.add_development_dependency 'letters',        '~> 0.4'
+  spec.add_development_dependency 'rake',           '~> 12.2'
+  spec.add_development_dependency 'rspec',          '~> 3.7'
+  spec.add_development_dependency 'rubocop',        '~> 0.51'
+  spec.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  spec.add_development_dependency 'simplecov',      '~> 0.15'
+  spec.add_development_dependency 'timecop',        '~> 0.9'
+  spec.add_development_dependency 'yard',           '~> 0.8'
+end

data/lib/invisible_logger.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+# encoding: UTF-8
+
+# A tool to output complex logs with minimal intrusion and smallest possible
+# footprint in the "host" code + additional ability to aggregate separate logs
+class InvisibleLogger
+  # Lib Semantic Version Constant
+  VERSION = '0.1.0'
+
+  # Read-only content of the buffered logs
+  # @see #buffer
+  attr_reader :aggregator
+
+  # Read-only "level" the aggregated log is going to be flushed with
+  # @see Logger
+  # @see #level
+  attr_reader :log_level
+
+  # Create new invisible logger instance
+  #
+  # @note Use `INV_LOGGER_DEBUG` env var to enable global debug mode
+  # @note Use `INV_LOGGER_DEBUG_MARKER` env var to change default debug marker
+  #
+  # @example
+  #   LOG_STENCIL = {
+  #     sum: {
+  #       vars: [:a, :b, :@sum],
+  #       level: :debug,
+  #       template: <<~LOG
+  #         %<a>s +|
+  #         %<b>s → |
+  #         %<@sum>s
+  #         Splendid! Magnificent!
+  #       LOG
+  #     },
+  #     warning: {
+  #       vars: [:text],
+  #       level: :warn,
+  #       template: '>>>>>>> %<text>s'
+  #     },
+  #     additional_info: {
+  #       template: "Additional INFO and nothing more... 👐"
+  #     },
+  #     eval_example: {
+  #       vars: { const: 'self.class.const_get(:LOG_STENCIL)' },
+  #       template: 'We can log constants and method calls:: %<const>s'
+  #     }
+  #   }
+  #
+  #   ENV['INV_LOGGER_DEBUG'] = '1'
+  #   ENV['INV_LOGGER_DEBUG_MARKER'] = '🚀  '
+  #
+  #   class Test
+  #     include TestLogStencil
+  #
+  #     def initialize
+  #       @logger = Logger.new(STDOUT)
+  #       @il     = InvisibleLogger.new(logger: @logger, log_stencil: LOG_STENCIL)
+  #
+  #       @sum   = '42 (Wonderful! Glorious!)'
+  #     end
+  #
+  #     def sum(a, b)
+  #       a + b
+  #       @il.l(binding, :sum, aggregate: true)
+  #     end
+  #
+  #     def one(text)
+  #       @il.l(binding, :warning, aggregate: false, debug: true)
+  #       @il.l(binding, :eval_example)
+  #     end
+  #
+  #     def test
+  #       @il.l(binding, :additional_info, aggregate: true)
+  #       @il.f!
+  #     end
+  #   end
+  #
+  #   t = Test.new
+  #   t.sum(2, 3)
+  #   t.one('Beware of beavers!')
+  #   t.test
+  #
+  # @param [Object] logger any object with standard Logger compartable interface
+  # @param [Hash] log_stencil a Hash with the names, levels, templates and var lists (see example!)
+  def initialize(logger:, log_stencil:)
+    @logger      = logger
+    @log_stencil = log_stencil
+
+    @aggregator = ''
+    @log_level  = :info
+
+    @debug_marker = ENV['INV_LOGGER_DEBUG_MARKER'] || '▶️  '
+  end
+
+  # Log something
+  #
+  # @param [Binding] context pass the current context (aka binding)
+  # @param [Symbol] name the name of the log stencil to use
+  # @param [Boolean] aggregate should the logger aggregate this message or log (default: false)
+  # @param [Boolean] debug the debug mode flag. Outputs the marker
+  #                  and the name along with tht message (default: false)
+  #
+  # @note ⚠️ WARNING!!! Keep in mind that `debug` parameter could be overwritten with INV_LOGGER_DEBUG
+  #       environment variable
+  #
+  # @raise [KeyError] if we work in debug mode
+  # @return [Boolean] true if the message was logged successfully, false if the message wasn't logged
+  #                   due to anny reason (including aggregation)
+  def log(context, name, aggregate: false, debug: false)
+    return unless context.respond_to?(:eval) && @log_stencil&.fetch(name, nil)
+
+    @log_level, log_template, log_values = init_stencil_for(context, name, debug)
+
+    log_text = render_log(log_template, log_values)
+
+    aggregate ? accumulate(log_text) : flush(@log_level, log_text)
+  rescue KeyError => e
+    handle_template_error(e, debug)
+  end
+
+  # Flush the aggregated message and clean the accumulator var on success
+  #
+  # @note ⚠️ WARNING!!! This method empties the message accumulator on successfull log flushing
+  # @note ⚠️ WARNING!!! Aggregated message will be logged with the level of the last stencil
+  #
+  # @return [String, Nil] empty String (latest aggregator state) of nil
+  def flush!(dev_null = false)
+    @aggregator = '' if dev_null || flush(@log_level, @aggregator)
+  end
+
+  # A short alias for the flush! method (to make the logging footprint even smaller)
+  alias f! flush!
+
+  # A short alias for the log method (to make the logging footprint even smaller)
+  # @note Beware of potential letters gem incompartability http://lettersrb.com
+  alias l log
+
+  # An alias to get the content of the buffered logs
+  alias buffer aggregator
+
+  # An alias to get a level the aggregated log is going to be flushed with
+  alias level log_level
+
+  private
+
+  # Flush the aggregated message if the level is supported by the Logger provided
+  #
+  # @return [Boolean] true if the level method is supported and called, false otherwise
+  def flush(level, log)
+    return if !log || log.empty?
+    @logger.respond_to?(level) ? !@logger.send(level, log).nil? : false
+  end
+
+  # Stencil handling method — extracts level, template and vars, converts vars to String,
+  # encodes them to UTF-8, links var names to the values from context
+  # @see Ruby `format` method for template string / template values Hash reference
+  #
+  # @param [Binding] context context to evaluate vars/expression in
+  # @param [Symbol] name the name of the log stencil
+  # @param [Boolean] debug render template in debug mode
+  #
+  # @return [Array(Symbol, String, Hash)] returns and array of log_method (Symbol), log_template (template String),
+  #                                       log_values (Hash for the template String)
+  def init_stencil_for(context, name, debug = false)
+    stencil = @log_stencil&.fetch(name)
+
+    log_method   = stencil.fetch(:level, nil) || :info
+    log_template = init_log_template(stencil, name, debug)
+    log_values   = init_log_values(stencil, context)
+
+    [log_method, log_template, log_values]
+  end
+
+  # Accumulate aggreagated log message and return false
+  #
+  # @param [String] message the message to put to the "aggregator" buffer
+  #
+  # @return [Boolean] false to return from log method (meaning nothing was logged to the output)
+  def accumulate(message)
+    @aggregator += " #{message}" if message
+    false
+  end
+
+  # Fetch the template for the given name from the stencil + take the debug mode into account
+  #
+  # @param [Hash] stencil a Hash with the names, levels, templates and var lists (see example!)
+  # @param [Symbol] name the name of the log stencil
+  # @param [Boolean] debug render template in debug mode
+  #
+  # @return [String, Nil] fully prepared template string or nil
+  def init_log_template(stencil, name, debug = false)
+    log_template = stencil.fetch(:template, nil)
+    log_template = debug || ENV['INV_LOGGER_DEBUG'] ? "#{@debug_marker}#{name} :: #{log_template}" : log_template
+    log_template&.split("|\n")&.join(' ')&.strip
+  end
+
+  # Form log values to put into the template using given context
+  #
+  # @param [Hash] stencil a Hash with the names, levels, templates and var lists (see example!)
+  # @param [Binding] context context to take vars/expression values from
+  #
+  # @return [Hash, Nil] Hash with all the values ready for `format` method or nil in case of no vars
+  def init_log_values(stencil, context)
+    log_values = {}
+    log_vars   = stencil.fetch(:vars, [])
+
+    log_vars.each do |v|
+      if v.respond_to?(:each_pair)
+        log_values[v.keys.first] = context.eval(v.values.first.to_s)
+      else
+        log_values[v] = context.eval(v.to_s)
+      end
+    end
+
+    log_values = log_values.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.to_s.dup.force_encoding('UTF-8') }
+
+    log_values.empty? ? nil : log_values
+  end
+
+  # Render log message (fill template placeholders with the respective values) or receive a static String
+  #
+  # @param [String] template standard ruby tempalte string with named placeholders
+  # @param [Hash] values standard ruby Hash with respective key names to fill placeholders
+  #
+  # @return [String] Rendered template string with filled placeholders filled with the respective values
+  def render_log(template, values)
+    template && values ? format(template, values) : template
+  end
+
+  # Handle log method exceptions (takes into account the debug mode)
+  #
+  # @param [Exception] exception the exception to handle
+  #
+  # @raise [KeyError] if we work in debug mode
+  # @return [String] Rendered template string with filled placeholders filled with the respective values
+  def handle_template_error(exception, debug = false)
+    raise exception if debug || ENV['INV_LOGGER_DEBUG']
+  end
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: invisible_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- smileart
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: letters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: A tool to output complex logs with minimal intrusion and smallest possible
+  footprint in the "host" code + additional ability to aggregate separate logs
+email:
+- smileart21@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- invisible_logger.gemspec
+- lib/invisible_logger.rb
+homepage: http://github.com/smileart/invisible_logger
+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.14
+signing_key: 
+specification_version: 4
+summary: A tool to minimise logs footprint in the host code
+test_files: []