logrb 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2b3538c59ff3cd6964b1322b178ff41acd4a61f9cba41eb32f57433d9ccafa3
+  data.tar.gz: '0240916d10cc49d29214015d73d729eff14c72829212b86e57f17ea10be4395d'
+SHA512:
+  metadata.gz: c552d0a05a75e68885c9a401d17350cabc4a7257e8bf0016083567fa59992a243764ae017daddeaa9b5312f59e40726fb5742223ea67b058bb935454458a486e
+  data.tar.gz: 6c28c536a1afdd1eda0395ed6683127633e8d6701a39fb73294bc4a342aff5dc857f08c332aac0339a2e68d386e86d07d57ec76b04a083d2e18fa8f15c1c57b2

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.2
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at hey@vito.io. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in logrb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    logrb (0.1.2)
+      hexdump (~> 0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    hexdump (0.3.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.19.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  logrb!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Victor Gama
+
+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,135 @@
+# Logrb
+
+**Logrb** is a small logging library for Ruby, inspired by Go's Zap.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logrb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install logrb
+
+## Usage
+
+Start by creating a new logger:
+
+```ruby
+require 'logrb'
+
+logger = Logrb.new($stdout)
+
+# Additionally, other options can be passed to the initializer:
+# logger = Logrb.new($stdout, [format: :json], [level: :warn], [sample_field: :foo])
+```
+
+Then, call either `error`, `fatal`, `warn`, `info`, `debug`, or `dump`.
+
+```ruby
+logger.debug("Email dispatched", address: "foo@bar.com")
+# => 2021-08-16T08:42:26.528-0300 DEBUG: <main>: Email dispatched {:address=>"foo@bar.com"}
+
+logger.info("Operation completed", duration: 3.4)
+# => 2021-08-16T08:43:00.790-0300 INFO: <main>: Operation completed {:duration=>3.4}
+
+logger.warn("Attention is required", event: :something)
+# => 2021-08-16T08:44:16.172-0300 WARN: <main>: Attention is required {:event=>:something}
+
+logger.error("Something went wrong", StandardError.new("Boom"), user_id: 27)
+# => 2021-08-16T08:47:09.968-0300 ERROR: <main>: Something went wrong {:user_id=>27}: Boom
+#        (irb):2 in `<main>'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/workspace.rb:116 in `eval'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/workspace.rb:116 in `evaluate'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/context.rb:450 in `evaluate'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:567 in `block (2 levels) in eval_input'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:751 in `signal_status'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:548 in `block in eval_input'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/ruby-lex.rb:251 in `block (2 levels) in each_top_level_statement'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/ruby-lex.rb:233 in `loop'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/ruby-lex.rb:233 in `block in each_top_level_statement'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/ruby-lex.rb:232 in `catch'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/ruby-lex.rb:232 in `each_top_level_statement'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:547 in `eval_input'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:481 in `block in run'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:480 in `catch'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:480 in `run'
+#        /usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:409 in `start'
+
+logger.dump("Received data", "\xC0\xFF\xEE\xBA\xBE")
+# => 2021-08-16T08:49:52.371-0300 DUMP: <main>: Received data
+#        00000000  c0 ff ee ba be                                   |.....|
+#        00000005
+#
+```
+
+For production environments, it is recommended to use a JSON format, which spans
+one line per entry:
+
+```ruby
+logger.debug("Email dispatched", address: "foo@bar.com")
+# => {"level":"debug","caller":"(irb):10","msg":"Email dispatched","ts":1629115513,"address":"foo@bar.com"}
+
+logger.info("Operation completed", duration: 3.4)
+# => {"level":"info","caller":"(irb):11","msg":"Operation completed","ts":1629115513,"duration":3.4}
+
+logger.warn("Attention is required", event: :something)
+# => {"level":"warn","caller":"(irb):12","msg":"Attention is required","ts":1629115513,"event":"something"}
+
+logger.error("Something went wrong", StandardError.new("Boom"), user_id: 27)
+# => {"level":"error","caller":"(irb):13","msg":"Something went wrong","ts":1629115514,"stacktrace":"(irb):13 in `<main>'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/workspace.rb:116 in `eval'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/workspace.rb:116 in `evaluate'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/context.rb:450 in `evaluate'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:567 in `block (2 levels) in eval_input'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:751 in `signal_status'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:548 in `block in eval_input'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/ruby-lex.rb:251 in `block (2 levels) in each_top_level_statement'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/ruby-lex.rb:233 in `loop'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/ruby-lex.rb:233 in `block in each_top_level_statement'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/ruby-lex.rb:232 in `catch'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb/ruby-lex.rb:232 in `each_top_level_statement'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:547 in `eval_input'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:481 in `block in run'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:480 in `catch'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:480 in `run'\n/usr/local/Cellar/ruby/3.0.2/lib/ruby/3.0.0/irb.rb:409 in `start'","user_id":27}
+
+logger.dump("Received data", "\xC0\xFF\xEE\xBA\xBE")
+# => {"level":"dump","caller":"(irb):14","msg":"Received data","ts":1629115514,"dump":"00000000  c0 ff ee ba be                                   |.....|\n00000005"}
+
+```
+
+## 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 the created tag, 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/heyvito/logrb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/heyvito/logrb/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Logrb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/heyvito/logrb/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2021 Victor Gama
+
+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/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Logrb
+  VERSION = "0.1.2"
+end

data/lib/logrb.rb

@@ -0,0 +1,274 @@
+# frozen_string_literal: true
+
+require_relative "logrb/version"
+require "hexdump"
+require "json"
+
+# Logrb provides a facility for working with logs in text and json formats.
+# All instances share a single mutex to ensure logging consistency.
+# The following attributes are available:
+#
+# fields - A hash containing metadata to be included in logs emitted by this
+#          instance.
+# level  - The level filter for the instance. Valid values are :error, :fatal,
+#          :info, :warn, and :debug
+# format - The format to output logs. Supports :text and :json.
+#
+# Each instance exposes the following methods, which accepts an arbitrary
+# number of key-value pairs to be included in the logged message:
+#
+# #error(msg, error=nil, **fields): Outputs an error entry. When `error` is
+#   present, attempts to obtain backtrace information and also includes it
+#   to the emitted entry.
+#
+# #fatal(msg, **fields): Outputs a fatal entry. Calling fatal causes the
+#   current process to exit with a status 1.
+#
+# #warn(msg, **fields): Outputs a warning entry.
+# #info(msg, **fields): Outputs a informational entry.
+# #debug(msg, **fields): Outputs a debug entry.
+# #dump(msg, data=nil): Outputs a given String or Array of bytes using the
+#   same format as `hexdump -C`.
+class Logrb
+  attr_accessor :fields, :level, :format
+
+  COLORS = {
+    error: 31,
+    fatal: 31,
+    unknown: 0,
+    info: 36,
+    warn: 33,
+    debug: 30,
+    reset: 0,
+    dump: 37
+  }.freeze
+
+  BACKGROUNDS = {
+    debug: 107
+  }.freeze
+
+  LEVELS = {
+    error: 4,
+    fatal: 4,
+    unknown: 4,
+    warn: 3,
+    info: 2,
+    debug: 1,
+    reset: 1
+  }.freeze
+
+  # Internal: A mutex instance used for synchronizing the usage of the output
+  # IO.
+  def self.mutex
+    @mutex ||= Mutex.new
+  end
+
+  # Initializes a new Logger instance that outputs logs to a provided output.
+  #
+  # output - an IO-like object that implements a #write method.
+  # format - Optional. Indicates the format used to output log entries.
+  #          Supports :text (default) and :json.
+  # level  - Level to filter this logger instance
+  # fields - Fields to include in emitted entries
+  def initialize(output, format: :text, level: :debug, **fields)
+    @output = output
+    @format = format
+    @fields = fields
+    @level = level
+  end
+
+  # Returns a new logger instance using the same output of its parent's, with
+  # an optional set of fields to be merged against the parent's fields.
+  #
+  # fields - A Hash containing metadata to be included in all output entries
+  #          emitted from the returned instance.
+  def with_fields(**fields)
+    inst = Logrb.new(@output, format: @format, level: @level)
+    inst.fields = @fields.merge(fields)
+    inst
+  end
+
+  LEVELS.except(:error).each_key do |name|
+    define_method(name) do |msg, **fields|
+      return if LEVELS[@level] > LEVELS[name]
+
+      wrap(name, msg, nil, fields)
+      nil
+    end
+  end
+
+  # Public: Emits an error to the log output. When error is provided, this
+  # method attempts to gather a stacktrace to include in the emitted entry.
+  def error(msg, error = nil, **fields)
+    return if LEVELS[@level] > LEVELS[:error]
+
+    wrap(:error, msg, error, fields)
+    nil
+  end
+
+  # Public: Dumps a given String or Array in the same format as `hexdump -C`.
+  def dump(log, data = nil, **fields)
+    return if LEVELS[@level] > LEVELS[:debug]
+
+    if data.nil?
+      data = log
+      log = nil
+    end
+
+    data = data.pack("C*") if data.is_a? Array
+    dump = []
+    padding = @format == :json ? "" : "        "
+    Hexdump.dump(data, output: dump)
+    dump.map! { |line| "#{padding}#{line.chomp}" }
+    dump = dump.join("\n")
+
+    if @format == :json
+      fields[:dump] = dump
+      dump = nil
+    end
+    wrap(:dump, log || "", nil, fields)
+    write_output("#{dump}\n\n") unless dump.nil?
+  end
+
+  private
+
+  # Internal: Formats a given text using the ANSI escape sequences. Notice
+  # that this method does not attempt to determine whether the current output
+  # supports escape sequences.
+  def color(color, text)
+    bg = BACKGROUNDS[color]
+    reset_bg = ""
+    if bg
+      bg = "\e[#{bg}m"
+      reset_bg = "\e[49m"
+    end
+    "#{bg}\e[#{COLORS[color]}m#{text}\e[#{COLORS[:reset]}m#{reset_bg}"
+  end
+
+  # Internal: Removes all backtrace frames pointing to the logging facility
+  # itself.
+  def clean_caller_locations
+    caller_locations.reject { |t| t.absolute_path&.end_with?("logrb.rb") }
+  end
+
+  # Internal: Returns the caller of a function, returning a pair containing
+  # its path and base method name.
+  def determine_caller
+    c = clean_caller_locations.first
+    [normalize_location(c), c.base_label]
+  end
+
+  # Internal: Performs a cleanup for a given backtrace frame.
+  #
+  # trace - Trace to be clean.
+  # include_function_name - Optional. When true, includes the function name
+  #   on the normalized string. Defaults to false.
+  def normalize_location(trace, include_function_name: false)
+    path = trace.absolute_path
+    return trace.to_s if path.nil?
+
+    if (root = Gem.path.find { |p| path.start_with?(p) })
+      path = "$GEM_PATH#{path[root.length..]}"
+    end
+    "#{path}:#{trace.lineno}#{include_function_name ? " in `#{trace.label}'" : ""}"
+  end
+
+  # Internal: Returns a string containing a stacktrace of the current
+  # invocation.
+  def stack_trace(trace = clean_caller_locations)
+    trace.map { |s| normalize_location(s, include_function_name: true) }.join("\n")
+  end
+
+  # Internal: Composes a log line with given information.
+  # level       - The severity of the log message
+  # caller_meta - An Array containing the caller's location and name
+  # msg         - The message to be logged
+  # fields      - A Hash of fields to be included in the entry
+  def compose_line(level, caller_meta, msg, fields)
+    ts = Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%z")
+    msg = " #{msg}" unless msg.empty?
+    fields_str = if fields.empty?
+                   ""
+                 else
+                   " #{fields}"
+                 end
+    level_str = color(level, level.to_s.upcase)
+    "#{ts} #{level_str}: #{caller_meta.last}:#{msg}#{fields_str}"
+  end
+
+  # Internal: Logs a text entry to the current output.
+  # level       - The severity of the message to be logged.
+  # msg         - The message to be logged
+  # error       - Either an Exception object or nil. This parameter is used
+  #               to provide extra information on the logged entry.
+  # fields      - A Hash containing metadata to be included in the logged
+  #               entry.
+  # caller_meta - An Array containing the caller's location and name.
+  def text(level, msg, error, fields, caller_meta)
+    fields ||= {}
+    fields.merge! @fields
+    write_output(compose_line(level, caller_meta, msg, fields))
+    if (error_message = error&.message)
+      write_output(": #{error_message}")
+    end
+    write_output("\n")
+    return unless level == :error
+
+    backtrace_str = backtrace(error)
+                    .split("\n")
+                    .map { |s| "        #{s}" }.join("\n")
+    write_output(backtrace_str)
+    write_output("\n")
+  end
+
+  # Internal: Attempts to obtain a backtrace from a provided object. In case
+  # the object does not include backtrace metadata, uses #stack_trace as a
+  # fallback.
+  def backtrace(from)
+    if from.respond_to?(:backtrace_locations) && !from.backtrace_locations.nil?
+      stack_trace(from.backtrace_locations)
+    else
+      stack_trace
+    end
+  end
+
+  # Internal: Writes a given value to the current's output IO. Calls to this
+  # method are thread-safe.
+  def write_output(text)
+    Logrb.mutex.synchronize do
+      @output.write(text)
+    end
+  end
+
+  # Internal: Logs a JSON entry to the current output.
+  # level       - The severity of the message to be logged.
+  # msg         - The message to be logged
+  # error       - Either an Exception object or nil. This parameter is used
+  #               to provide extra information on the logged entry.
+  # fields      - A Hash containing metadata to be included in the logged
+  #               entry.
+  # caller_meta - An Array containing the caller's location and name.
+  def json(level, msg, error, fields, caller_meta)
+    fields ||= {}
+    fields.merge! @fields
+    data = {
+      level: level,
+      caller: caller_meta.first,
+      msg: msg,
+      ts: Time.now.utc.to_i
+    }
+
+    data[:stacktrace] = backtrace(error) if level == :error
+
+    data.merge!(fields)
+    write_output("#{data.to_json}\n")
+  end
+
+  # Internal: Dynamically invokes the current log formatter for the
+  # provided arguments. For further information, see #text and #json
+  def wrap(level, msg, error, fields)
+    msg = msg.to_s
+    send(@format, level, msg, error, fields, determine_caller)
+    exit 1 if level == :fatal
+  end
+end

data/logrb.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/logrb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "logrb"
+  spec.version       = Logrb::VERSION
+  spec.authors       = ["Victor Gama"]
+  spec.email         = ["hey@vito.io"]
+
+  spec.summary       = "Small logger inspired by Go's Zap"
+  spec.description   = "Small logger inspired by Go's Zap"
+  spec.homepage      = "https://github.com/heyvito/logrb"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hexdump", "~> 0.3.0"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: logrb
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Victor Gama
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hexdump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: Small logger inspired by Go's Zap
+email:
+- hey@vito.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/logrb.rb
+- lib/logrb/version.rb
+- logrb.gemspec
+homepage: https://github.com/heyvito/logrb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/heyvito/logrb
+  source_code_uri: https://github.com/heyvito/logrb
+  changelog_uri: https://github.com/heyvito/logrb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Small logger inspired by Go's Zap
+test_files: []