cm_logger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 761ebd63f3ecf80b8db7fbd5204718aac9982f9a43eb0866f77bba371af2ea8f
+  data.tar.gz: '091b2e075ec1eca95507c5bd6875787e39785e14c86294210b39e30cc719f1c0'
+SHA512:
+  metadata.gz: 35951ffbc63e2f1a1fec2f67c429a99c874fe481056515b0f1d91b3a4a3b70850568c2d6eb3c011565c3b982f9b1f4e9a29b1b5d49ca05bd18ce5914b8ede53a
+  data.tar.gz: b5caf453fe5c9e44ac3e5516aa0acdf242291f88f77e94d56909528084e62adf30aabcb064a3efc050fbeebc9f4e5a3451517b3513d27760906519f612e33095

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'pry'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    cm_logger (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (1.0.0)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cm_logger!
+  pry
+  rspec (~> 3.9.0)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,2 @@
+# cm_logger
+> Log related stuff for Rails

data/cm_logger.gemspec

@@ -0,0 +1,18 @@
+lib_dir = File.join(File.dirname(__FILE__),'lib')
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+Gem::Specification.new do |s|
+  s.name        = 'cm_logger'
+  s.version     = '0.0.1'
+  s.date        = '2020-04-09'
+  s.summary     = "Log related stuff for Rails"
+  s.description = "Log related stuff for Rails"
+  s.authors     = ["ben"]
+  s.email       = 'ben@arc.dev'
+  s.files = `git ls-files`.split($/)
+  s.homepage    = 'https://github.com/CodementorIO/cm_logger'
+  s.license       = 'MIT'
+  s.required_ruby_version = '>= 2.6'
+
+  s.add_development_dependency("rspec", ["~> 3.9.0"])
+end

data/lib/cm_logger.rb

@@ -0,0 +1,5 @@
+require 'lograge_formatter'
+require 'sidekiq_formatter'
+
+module CmLogger
+end

data/lib/lograge_formatter.rb

@@ -0,0 +1,30 @@
+module CmLogger
+  class LogrageFormatter
+    def call(data)
+      fields_to_display(data)
+        .map { |key| format(key, data[key]) }
+        .join(' ')
+    end
+
+    protected
+
+    def fields_to_display(data)
+      data.keys
+    end
+
+    def format(key, value)
+      "#{key}=#{parse_value(key, value)}"
+    end
+
+    def parse_value(key, value)
+      if value.is_a? Float
+        Kernel.format('%.2f', value)
+      elsif value.is_a? String
+        safe_value = value.gsub("\n", "\t")
+        "'#{safe_value}'"
+      else
+        value
+      end
+    end
+  end
+end

data/lib/sidekiq_formatter.rb

@@ -0,0 +1,38 @@
+require 'logger'
+require 'time'
+
+module CmLogger
+  class SidekiqFormatter < Logger::Formatter
+    def call(severity, time, program_name, message)
+      clean_message = message.gsub('"', '\'').gsub("\n", ' ').slice(0, 100)
+
+      log_hash = {
+        time: time.utc.iso8601(3),
+        pid: ::Process.pid,
+        tid: Thread.current.object_id.to_s(36),
+        severity: severity,
+        message: "\"#{clean_message}\""
+      }.merge(context)
+
+      log_hash.keys.map do |key|
+        "#{key}=#{log_hash[key]}"
+      end.join(" ") + "\n"
+    end
+
+    def context
+      c = Thread.current[:sidekiq_context]
+      if c && c.any?
+        tokens = c.map(&:split).flatten
+        worker_name = tokens.find { |token| token.end_with?('Worker') }
+        jid = tokens.find { |token| token.start_with?('JID') }
+
+        {
+          worker_name: worker_name,
+          jid: jid
+        }.compact
+      else
+        {}
+      end
+    end
+  end
+end

data/spec/lograge_formatter_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'CmLogger::LogrageFormatter' do
+  describe '#call' do
+    let(:formatter) do
+      CmLogger::LogrageFormatter.new
+    end
+
+    it "should foramt hash" do
+      data = { foo: "bar", baz: 123 }
+
+      result = formatter.call(data)
+
+      expect(result).to eq("foo='bar' baz=123")
+    end
+
+    it "should replace newline with \t" do
+      data = { foo: "bar\n123", baz: 123 }
+
+      result = formatter.call(data)
+
+      expect(result).to eq("foo='bar\t123' baz=123")
+    end
+
+    it "should adjust float format" do
+      data = { foo: "bar", baz: 123.45678 }
+
+      result = formatter.call(data)
+
+      expect(result).to eq("foo='bar' baz=123.46")
+    end
+  end
+end

data/spec/sidekiq_formatter_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'CmLogger::SidekiqFormatter' do
+  describe '#call(severity, time, program_name, message)' do
+    let(:formatter) do
+      CmLogger::SidekiqFormatter.new
+    end
+    let(:severity) { "INFO" }
+    let(:message) { "xxx" }
+    let(:time) { Time.now }
+    let(:program_name) { "program_name" }
+
+    it "should return log in logfmt style" do
+      args = [severity, time, program_name, message]
+
+      result = formatter.call(*args)
+
+      tid = Thread.current.object_id.to_s(36)
+      pid = ::Process.pid
+      expect(result).to eq("time=#{time.utc.iso8601(3)} pid=#{pid} tid=#{tid} severity=#{severity} message=\"#{message}\"\n")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems'
+require 'cm_logger'
+require 'pry'

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: cm_logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ben
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+description: Log related stuff for Rails
+email: ben@arc.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- cm_logger.gemspec
+- lib/cm_logger.rb
+- lib/lograge_formatter.rb
+- lib/sidekiq_formatter.rb
+- spec/lograge_formatter_spec.rb
+- spec/sidekiq_formatter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/CodementorIO/cm_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: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Log related stuff for Rails
+test_files: []