on_strum-logs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8185297963aeab5a76271658b4efca0e09834f30d1252ee89b3100f70cfd791a
+  data.tar.gz: d994258f60226574ea0c6f8a4c5729a16000f6300ade60003da39ffea8e4af9a
+SHA512:
+  metadata.gz: 5a790f196642f7d785cc71f1c4fc3ea16ba14c73e62ec21a7cfc8a0845a580d5102a7b720c417465e41d570c5fa52d2f5630fba52d26f3c6db96c3331193b587
+  data.tar.gz: f57c8918327915eba796f8c28c41544f29e5af213bc2194621b99ccb78cbc8fc45e5e7b2ec89264db27f5cdc0dd7e0aeeb1f23333ee7aae411cc8247c209a896

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-2023 onStrum and friends
+
+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/bin/console

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Logs
+    class Configuration
+      INCOMPLETE_CONFIG = 'service_name, service_version are required parameters'
+      SETTERS = %i[custom_formatter service_name service_version].freeze
+
+      attr_reader(*OnStrum::Logs::Configuration::SETTERS)
+      attr_accessor :detailed_formatter
+
+      def initialize(&block)
+        tap(&block) if block
+      end
+
+      OnStrum::Logs::Configuration::SETTERS.each do |method|
+        define_method("#{method}=") do |argument|
+          raise_unless(argument, __method__, valid_argument_type?(method, argument))
+          instance_variable_set(:"@#{method}", argument)
+        end
+      end
+
+      def complete?
+        !!(service_name && service_version)
+      end
+
+      def formatter
+        custom_formatter || builded_formatter
+      end
+
+      private
+
+      def valid_argument_type?(method_name, argument)
+        argument.is_a?(
+          case method_name
+          when :service_name, :service_version then ::String
+          when :custom_formatter then ::Class
+          end
+        )
+      end
+
+      def raise_unless(argument_context, argument_name, condition)
+        raise OnStrum::Logs::Error::ArgumentType.new(argument_context, argument_name) unless condition
+      end
+
+      def builded_formatter
+        return OnStrum::Logs::Formatter::Detailed if detailed_formatter
+
+        OnStrum::Logs::Formatter::Json
+      end
+    end
+  end
+end

data/lib/on_strum/logs/core.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Logs
+    module Error
+      require_relative 'error/argument_type'
+      require_relative 'error/configuration'
+      require_relative 'error/logger'
+    end
+
+    module Formatter
+      require_relative 'formatter/base'
+      require_relative 'formatter/json'
+      require_relative 'formatter/detailed'
+    end
+
+    require_relative 'version'
+    require_relative 'configuration'
+
+    module Logger
+      require_relative 'logger/base'
+      require_relative 'logger/default'
+    end
+
+    require_relative '../logs'
+  end
+end

data/lib/on_strum/logs/error/argument_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Logs
+    module Error
+      ArgumentType = ::Class.new(::ArgumentError) do
+        def initialize(arg_value, arg_name)
+          super("#{arg_value} is not a valid #{arg_name}")
+        end
+      end
+    end
+  end
+end

data/lib/on_strum/logs/error/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Logs
+    module Error
+      Configuration = ::Class.new(::StandardError) do
+        def initialize(message = 'use OnStrum::Logs.configure before')
+          super(message)
+        end
+      end
+    end
+  end
+end

data/lib/on_strum/logs/error/logger.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Logs
+    module Error
+      Logger = ::Class.new(::RuntimeError) do
+        def initialize(message = 'attribute :message is required')
+          super(message)
+        end
+      end
+    end
+  end
+end

data/lib/on_strum/logs/formatter/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Logs
+    module Formatter
+      class Base
+        DATETIME_FORMAT = '%FT%T.%3N%:z'
+        LOG_ATTRIBUTES_ORDER = %i[level time message context service_name service_version].freeze
+
+        def self.arrange_attrs(**log_data)
+          OnStrum::Logs::Formatter::Base::LOG_ATTRIBUTES_ORDER.each_with_object({}) do |attribute, arranged_attrs|
+            arranged_attrs[attribute] = log_data[attribute]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/on_strum/logs/formatter/detailed.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Logs
+    module Formatter
+      class Detailed < Base
+        require 'amazing_print'
+
+        def self.call(**log_data)
+          ::Kernel.ap(arrange_attrs(**log_data))
+        end
+      end
+    end
+  end
+end

data/lib/on_strum/logs/formatter/json.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Logs
+    module Formatter
+      class Json < Base
+        require 'json'
+
+        def self.call(time:, **log_data)
+          json_log = arrange_attrs(
+            time: time.strftime(OnStrum::Logs::Formatter::Base::DATETIME_FORMAT),
+            **log_data
+          ).to_json
+
+          "#{json_log}\n"
+        end
+      end
+    end
+  end
+end

data/lib/on_strum/logs/logger/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Logs
+    module Logger
+      require 'logger'
+
+      Base = ::Class.new(::Logger)
+    end
+  end
+end

data/lib/on_strum/logs/logger/default.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Logs
+    module Logger
+      class Default
+        LOG_LEVELS = %i[info error debug].freeze
+
+        def self.instance
+          @instance ||= new
+        end
+
+        def initialize
+          @logger = OnStrum::Logs::Logger::Base.new($stdout, formatter: formatter)
+        end
+
+        OnStrum::Logs::Logger::Default::LOG_LEVELS.each do |method_name|
+          define_method(method_name) do |arg|
+            raise OnStrum::Logs::Error::Configuration unless configuration
+
+            # TODO: we need to have ability to process log data before render it to STDOUT/STDERR
+            # hash_normalizer(arg); after_callback.call(arg)
+            logger.public_send(method_name, hash_normalizer(arg).merge(level: method_name.to_s.upcase))
+          end
+        end
+
+        private
+
+        attr_reader :logger
+
+        def configuration
+          OnStrum::Logs.configuration
+        end
+
+        def formatter
+          @formatter ||= proc do |_severity, datetime, _progname, log_data|
+            configuration.formatter.call(
+              time: datetime,
+              service_name: configuration.service_name,
+              service_version: configuration.service_version,
+              **log_data
+            )
+          end
+        end
+
+        def hash_normalizer(object)
+          case object
+          when ::Hash
+            raise OnStrum::Logs::Error::Logger unless object.key?(:message)
+
+            { message: object.delete(:message), context: (object.empty? ? nil : object) }
+          when ::Exception
+            {
+              message: "Exception: #{object.class}",
+              context: {
+                message: object.message,
+                stack_trace: object.backtrace
+              }
+            }
+          else { message: object.to_s, context: nil }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/on_strum/logs/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Logs
+    VERSION = '0.1.0'
+  end
+end

data/lib/on_strum/logs.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Logs
+    class << self
+      def configuration(&block)
+        @configuration ||= begin
+          return unless block
+
+          configuration = OnStrum::Logs::Configuration.new(&block)
+          raise OnStrum::Logs::Error::Configuration, OnStrum::Logs::Configuration::INCOMPLETE_CONFIG unless configuration.complete?
+
+          configuration
+        end
+      end
+
+      def configure(&block)
+        configuration(&block)
+      end
+
+      def reset_configuration!
+        @configuration = nil
+      end
+
+      OnStrum::Logs::Logger::Default::LOG_LEVELS.each do |method|
+        define_method(method) do |*arg|
+          OnStrum::Logs::Logger::Default.instance.public_send(method, *arg)
+        end
+      end
+    end
+  end
+end

data/lib/on_strum.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Logs
+    require_relative 'on_strum/logs/core'
+  end
+end

data/on_strum-logs.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/on_strum/logs/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'on_strum-logs'
+  spec.version     = OnStrum::Logs::VERSION
+  spec.authors     = ['Vladislav Trotsenko']
+  spec.email       = %w[admin@on-strum.org]
+
+  spec.summary     = %(on_strum-logs)
+  spec.description = %(Simple structured logger)
+
+  spec.homepage    = 'https://github.com/on-strum/ruby-on-strum-logs'
+  spec.license     = 'MIT'
+
+  spec.metadata    = {
+    'homepage_uri'      => 'https://github.com/on-strum/ruby-on-strum-logs',
+    'changelog_uri'     => 'https://github.com/on-strum/ruby-on-strum-logs/blob/master/CHANGELOG.md',
+    'source_code_uri'   => 'https://github.com/on-strum/ruby-on-strum-logs',
+    'documentation_uri' => 'https://github.com/on-strum/ruby-on-strum-logs/blob/master/README.md',
+    'bug_tracker_uri'   => 'https://github.com/on-strum/ruby-on-strum-logs/issues'
+  }
+
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(bin|lib)/|.ruby-version|on_strum-logs.gemspec|LICENSE}) }
+  spec.require_paths = %w[lib]
+
+  spec.add_runtime_dependency 'amazing_print', '~> 1.5'
+
+  spec.add_development_dependency 'ffaker', '~> 2.21'
+  spec.add_development_dependency 'json_matchers', '~> 0.11.1'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: on_strum-logs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vladislav Trotsenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.21'
+- !ruby/object:Gem::Dependency
+  name: json_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: Simple structured logger
+email:
+- admin@on-strum.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- LICENSE.txt
+- bin/console
+- bin/setup
+- lib/on_strum.rb
+- lib/on_strum/logs.rb
+- lib/on_strum/logs/configuration.rb
+- lib/on_strum/logs/core.rb
+- lib/on_strum/logs/error/argument_type.rb
+- lib/on_strum/logs/error/configuration.rb
+- lib/on_strum/logs/error/logger.rb
+- lib/on_strum/logs/formatter/base.rb
+- lib/on_strum/logs/formatter/detailed.rb
+- lib/on_strum/logs/formatter/json.rb
+- lib/on_strum/logs/logger/base.rb
+- lib/on_strum/logs/logger/default.rb
+- lib/on_strum/logs/version.rb
+- on_strum-logs.gemspec
+homepage: https://github.com/on-strum/ruby-on-strum-logs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/on-strum/ruby-on-strum-logs
+  changelog_uri: https://github.com/on-strum/ruby-on-strum-logs/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/on-strum/ruby-on-strum-logs
+  documentation_uri: https://github.com/on-strum/ruby-on-strum-logs/blob/master/README.md
+  bug_tracker_uri: https://github.com/on-strum/ruby-on-strum-logs/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: on_strum-logs
+test_files: []