lumberaxe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f5c1078c58ccacfe207db7fb1ad45fd544c235efcbf510d44ccda8e2a156aca
+  data.tar.gz: f701378e011e2488500621c02cee6329ff9d98483dc09990f5379c430fd3e12f
+SHA512:
+  metadata.gz: 4c186c16ac445cf75f51dc54759c6ba3d6ac469f9c53dc17631059242318ee27610bad0b7d06fdba025ca6008541157badb4cd99c9efe354fbdd54a4982a724a
+  data.tar.gz: 5328a77d64bc55bc00f15f6ed5c5a4ef58d7acfba39df55531c2f94be84da5e327b26e85ccf2afe68a9d08e4d1a4149875d2b82bd74e829e101af7ce0df2c3f0

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-powerhome
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+Rails:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --exclude-limit 500`
+# on 2022-08-11 19:45:17 UTC using RuboCop version 1.29.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+gemspec
+
+rails_version = ENV.fetch("RAILS_VERSION", ">= 5.2.8.1")
+
+gem "rails", rails_version

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+
+# frozen_string_literal: true
+
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ["lib/**/*.rb"]
+    t.options = [
+      "--no-private",
+    ]
+  end
+rescue LoadError
+  warn "Could not require() YARD! Install with 'gem install yard' to get the 'yardoc' task"
+end
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/doc/dependency_decisions.yml

@@ -0,0 +1,3 @@
+---
+- - :inherit_from
+  - https://raw.githubusercontent.com/powerhome/oss-guide/master/license_rules.yml

data/docs/README.md

@@ -0,0 +1,23 @@
+# Lumberaxe
+
+Lumberaxe handles logging output formatting.
+
+# Usage
+
+After installing the gem, require it as part of your application configuration.
+
+```ruby
+# application.rb
+
+require "lumberaxe"
+```
+
+## Setting JSON logging
+
+To set up JSON logging on puma, add this to your puma config:
+
+```ruby
+# puma.rb
+
+log_formatter(&Lumberaxe.puma_formatter)
+```

data/lib/lumberaxe/json_formatter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "active_support/tagged_logging"
+
+module Lumberaxe
+  class JSONFormatter < ::Logger::Formatter
+    include ActiveSupport::TaggedLogging::Formatter
+
+    def call(severity, time, progname, data)
+      data = data.is_a?(Hash) ? format_data(data) : { message: data.to_s }
+
+      {
+        level: severity,
+        time: time,
+        progname: progname,
+      }.merge(data).to_json.concat("\r\n")
+    end
+
+    def format_data(data)
+      data.merge!(current_tags.each_with_object({}) do |tag, hash|
+                    if tag.include?("=")
+                      key, value = tag.split("=")
+                      hash[key] = value
+                    else
+                      hash[:tags] ||= []
+                      hash[:tags] << key
+                    end
+                    hash
+                  end)
+    end
+  end
+end

data/lib/lumberaxe/logger.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lumberaxe
+  class Logger < ::ActiveSupport::Logger
+    cattr_accessor :log_level
+
+    def initialize(output = $stdout, progname:, level: log_level)
+      super output
+
+      self.progname = progname
+      self.level = level
+
+      self.formatter = JSONFormatter.new
+      extend ActiveSupport::TaggedLogging
+    end
+  end
+end

data/lib/lumberaxe/railtie.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "lograge"
+
+module Lumberaxe
+  class Railtie < Rails::Railtie
+    initializer "lumberaxe.configurations", before: :initialize_logger do |app|
+      Rails.logger = app.config.logger || Lumberaxe::Logger.new(progname: "app", level: app.config.log_level)
+
+      app.config.log_tags = [
+        ->(req) { "request_id=#{req.uuid}" },
+        ->(req) { "IP=#{req.remote_ip}" },
+      ]
+
+      Lumberaxe::Logger.log_level = app.config.log_level
+    end
+
+    initializer "lumberaxe.lograge" do
+      config.lograge.enabled = true
+      config.lograge.formatter = Lograge::Formatters::Raw.new
+      config.lograge.custom_options = ->(event) do
+        { "params" => event.payload[:params].without("controller", "action") }
+      end
+    end
+  end
+end

data/lib/lumberaxe/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Lumberaxe
+  VERSION = "0.1.0"
+end

data/lib/lumberaxe.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "logger"
+require "active_support"
+require "lumberaxe/railtie" if defined?(Rails)
+require "lumberaxe/logger"
+require "lumberaxe/json_formatter"
+
+module Lumberaxe
+  def self.puma_formatter(level: "INFO", progname: "puma")
+    ->(message) do
+      {
+        level: level,
+        time: Time.now,
+        progname: progname,
+        message: message,
+      }.to_json.concat("\r\n")
+    end
+  end
+end

data/lumberaxe.gemspec

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "lib/lumberaxe/version"
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name        = "lumberaxe"
+  spec.version     = Lumberaxe::VERSION
+  spec.authors     = ["Carlos Palhares", "Jill Klang"]
+  spec.email       = ["chjunior@gmail.com", "jillian.emilie@gmail.com"]
+
+  spec.summary     = "Power-ful logging wrapper"
+  spec.description = "Lumberaxe handles logging output formatting."
+  spec.homepage = "https://github.com/powerhome/power-tools"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/packages/lumberaxe/docs/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 5.2.8.1"
+  spec.add_dependency "lograge", "0.10.0"
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "combustion", "~> 1.3"
+  spec.add_development_dependency "license_finder", ">= 7.0"
+  spec.add_development_dependency "parser", ">= 2.5", "!= 2.5.1.1"
+  spec.add_development_dependency "pry-byebug", "3.9.0"
+  spec.add_development_dependency "rails", ">= 5.2.8.1"
+  spec.add_development_dependency "rainbow", "2.2.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails", "~> 5.1.2"
+  spec.add_development_dependency "rubocop-powerhome", "0.5.0"
+  spec.add_development_dependency "simplecov", "0.15.1"
+  spec.add_development_dependency "sqlite3", "~> 1.4.2"
+  spec.add_development_dependency "test-unit", "3.1.5"
+  spec.add_development_dependency "yard", "0.9.21"
+end

data/mkdocs.yml

@@ -0,0 +1,5 @@
+site_name: Lumberaxe
+nav:
+  - "Home": "README.md"
+plugins:
+  - techdocs-core

data/test.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -e
+
+bin/setup
+bin/build
+bin/doc
+bin/test

metadata

@@ -0,0 +1,308 @@
+--- !ruby/object:Gem::Specification
+name: lumberaxe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carlos Palhares
+- Jill Klang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.8.1
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: license_finder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 2.5.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 2.5.1.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.8.1
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-powerhome
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.21
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.21
+description: Lumberaxe handles logging output formatting.
+email:
+- chjunior@gmail.com
+- jillian.emilie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- Rakefile
+- config.ru
+- doc/dependency_decisions.yml
+- docs/README.md
+- lib/lumberaxe.rb
+- lib/lumberaxe/json_formatter.rb
+- lib/lumberaxe/logger.rb
+- lib/lumberaxe/railtie.rb
+- lib/lumberaxe/version.rb
+- lumberaxe.gemspec
+- mkdocs.yml
+- test.sh
+homepage: https://github.com/powerhome/power-tools
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/powerhome/power-tools
+  source_code_uri: https://github.com/powerhome/power-tools
+  changelog_uri: https://github.com/powerhome/power-tools/blob/main/packages/lumberaxe/docs/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Power-ful logging wrapper
+test_files: []