hubbado-log 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2fcd8aa2b46d6659a180f1fe80edb3256a76c891a3110b258bc065e85e484a8b
+  data.tar.gz: 219e1de6ff1bd255de0668ba45b8ee385412da62fdbe03a49d7cb306a7b4f3e8
+SHA512:
+  metadata.gz: bf4a22dde2d06efe82fe8694bc4f2910810b674989de6d42e341589832d8540758bd9957083fd72ff61cb2d55ab7f3fe5ee571eec38a9b54a3711372fd78d8b5
+  data.tar.gz: 5f15f6975a2ce223503dfcd333a9579c07d09d7cfd2ffb6cdc225158a7386c2b5a2df2f9ae02c39350c0f5bf1348a6526c2bd246b6a9fa64ec7a6abe100f00be

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+# [1.0.0 - 2024-05-02]
+## Added
+- Dependency module for easier setup
+- Changed from RSpec to TestBench
+- Add "subject" to record where the logger is invoked (defaults to the class
+  name when configured via Dependency)
+
+# [0.2.1 - 2021-04-27]
+## Changed
+- Use github packages as gem source for our own gems

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hubbado
+
+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,29 @@
+# Hubbado::Logger
+
+This is an extremely lightweight, pluggable logging system
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hubbado-logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hubbado-logger
+
+## 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/hubbado/hubbado-logger.

data/hubbado-log.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |s|
+  s.name = "hubbado-log"
+  s.version = "1.0.0"
+  s.summary = "Lightweight pluggable logging system"
+
+  s.authors = ["Hubbado Devs"]
+  s.email = ["devs@hubbado.com"]
+  s.homepage = "https://www.github.com/hubbado/hubbado-log"
+  s.license  = "MIT"
+
+  s.metadata["homepage_uri"] = s.homepage
+  s.metadata["source_code_uri"] = s.homepage
+  s.metadata["changelog_uri"] = "#{s.homepage}/blob/master/CHANGELOG.md"
+
+  s.require_paths = ["lib"]
+
+  s.files = Dir.glob(%w[
+    lib/**/*.rb
+    *.gemspec
+    LICENSE*
+    README*
+    CHANGELOG*
+  ])
+
+  s.required_ruby_version = '> 2.5'
+
+  s.add_runtime_dependency 'evt-dependency'
+
+  s.add_development_dependency "debug"
+  s.add_development_dependency "hubbado-style"
+  s.add_development_dependency "test_bench"
+end

data/lib/hubbado/log/configuration.rb

@@ -0,0 +1,11 @@
+module Hubbado
+  class Log
+    class Configuration
+      attr_accessor :loggers
+
+      def initialize
+        @loggers = []
+      end
+    end
+  end
+end

data/lib/hubbado/log/controls/data.rb

@@ -0,0 +1,14 @@
+module Hubbado
+  class Log
+    module Controls
+      module Data
+        def self.example
+          {
+            one: { sample: 1, random: 'DEADBEEF' },
+            two: [1, 2, 3]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/hubbado/log/controls/exception.rb

@@ -0,0 +1,15 @@
+module Hubbado
+  class Log
+    module Controls
+      module Exception
+        def self.example
+          # This raise and rescue method seems necessary to ensure that the
+          # exception has a stable stacktrace
+          raise ArgumentError, "Some message"
+        rescue ArgumentError => e
+          e
+        end
+      end
+    end
+  end
+end

data/lib/hubbado/log/controls/log_handler.rb

@@ -0,0 +1,21 @@
+module Hubbado
+  class Log
+    module Controls
+      class LogHandler < Hubbado::Log::LogHandler
+        attr_accessor :subject
+        attr_accessor :severity
+        attr_accessor :message
+        attr_accessor :data
+        attr_accessor :stacktrace
+
+        def log(subject, severity, message, data = nil, stacktrace = nil)
+          self.subject = subject
+          self.severity = severity
+          self.message = message
+          self.data = data
+          self.stacktrace = stacktrace
+        end
+      end
+    end
+  end
+end

data/lib/hubbado/log/controls/message.rb

@@ -0,0 +1,11 @@
+module Hubbado
+  class Log
+    module Controls
+      module Message
+        def self.example
+          "Some log message"
+        end
+      end
+    end
+  end
+end

data/lib/hubbado/log/controls/subject.rb

@@ -0,0 +1,11 @@
+module Hubbado
+  class Log
+    module Controls
+      module Subject
+        def self.example
+          "SomeSubject"
+        end
+      end
+    end
+  end
+end

data/lib/hubbado/log/controls.rb

@@ -0,0 +1,6 @@
+require_relative 'controls/data'
+require_relative 'controls/exception'
+require_relative 'controls/message'
+require_relative 'controls/subject'
+
+require_relative 'controls/log_handler'

data/lib/hubbado/log/log.rb

@@ -0,0 +1,59 @@
+module Hubbado
+  class Log
+    include Dependency
+
+    SEVERITIES = { debug: 0, info: 1, warn: 2, error: 3, fatal: 4, unknown: 5 }.freeze
+    STACKTRACE_SEVERITIES = %i[warn error fatal unknown].freeze
+
+    @config = Configuration.new
+
+    class << self
+      attr_reader :config
+
+      def configuration
+        yield @config
+
+        @loggers = nil
+      end
+
+      def loggers
+        @loggers ||= config.loggers.map(&:new)
+      end
+
+      def logger
+        @logger = Logger.new('', loggers)
+      end
+
+      def log(*args)
+        logger.log(*args)
+      end
+    end
+
+    def self.inherited(cls)
+      cls.class_exec do
+        dependency_module = Module.new do
+          define_singleton_method :included do |reciever_class|
+            reciever_class.class_exec do
+              ::Dependency::Attribute.define(self, :logger, cls)
+
+              define_method :logger do
+                @logger ||= cls.configure self
+              end
+            end
+          end
+        end
+
+        const_set :Dependency, dependency_module
+      end
+    end
+
+    inherited(self)
+
+    def self.configure(receiver, attr_name: nil)
+      attr_name ||= :logger
+      instance = Logger.new(receiver.class.name, loggers)
+      receiver.public_send("#{attr_name}=", instance)
+      instance
+    end
+  end
+end

data/lib/hubbado/log/log_handler.rb

@@ -0,0 +1,9 @@
+module Hubbado
+  class Log
+    class LogHandler
+      def log(_subject, _severity, _msg, _data = nil, _stacktrace = nil)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/hubbado/log/logger.rb

@@ -0,0 +1,41 @@
+module Hubbado
+  class Log
+    class Logger
+      attr_accessor :log_handlers
+      attr_accessor :subject
+
+      def initialize(subject, log_handlers = [])
+        self.subject = subject
+        self.log_handlers = Array(log_handlers)
+      end
+
+      def log(severity, msg, data = nil)
+        unless SEVERITIES.keys.include? severity.to_sym
+          raise ArgumentError, "Unknown serverity #{severity}"
+        end
+
+        stacktrace = if data.is_a?(Exception)
+                       data.full_message
+                     elsif STACKTRACE_SEVERITIES.include?(severity)
+                       format_stacktrace Kernel.caller
+                     end
+
+        log_handlers.each do |handler|
+          handler.log(subject, severity, msg, data, stacktrace)
+        end
+      end
+
+      SEVERITIES.each_key do |severity|
+        define_method severity do |msg, data = nil|
+          log severity, msg, data
+        end
+      end
+
+      private
+
+      def format_stacktrace(stacktrace)
+        stacktrace.join("\n")
+      end
+    end
+  end
+end

data/lib/hubbado/log.rb

@@ -0,0 +1,9 @@
+require 'dependency'
+require "hubbado/log/configuration"
+require "hubbado/log/log"
+require "hubbado/log/logger"
+require "hubbado/log/log_handler"
+
+module Hubbado
+  class Log; end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: hubbado-log
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hubbado Devs
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: evt-dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hubbado-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test_bench
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email:
+- devs@hubbado.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- hubbado-log.gemspec
+- lib/hubbado/log.rb
+- lib/hubbado/log/configuration.rb
+- lib/hubbado/log/controls.rb
+- lib/hubbado/log/controls/data.rb
+- lib/hubbado/log/controls/exception.rb
+- lib/hubbado/log/controls/log_handler.rb
+- lib/hubbado/log/controls/message.rb
+- lib/hubbado/log/controls/subject.rb
+- lib/hubbado/log/log.rb
+- lib/hubbado/log/log_handler.rb
+- lib/hubbado/log/logger.rb
+homepage: https://www.github.com/hubbado/hubbado-log
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/hubbado/hubbado-log
+  source_code_uri: https://www.github.com/hubbado/hubbado-log
+  changelog_uri: https://www.github.com/hubbado/hubbado-log/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Lightweight pluggable logging system
+test_files: []