ruby_smart-simple_logger 1.0.0

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ruby_smart/simple_logger"
+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/docs/CHANGELOG.md

@@ -0,0 +1,17 @@
+# RubySmart::SimpleLogger - CHANGELOG
+
+## [1.0.0] - 2023-01-29
+* **[add]** full documentation
+* **[add]** add colors, if gem `awesome_print` ist missing
+* **[add]** klass_logger_opts
+* **[add]** builtin / opts support for Logger.new
+* **[add]** MemoryDevice, MultiDevice, ProcDevice
+* **[ref]** docs & code comments
+* **[ref]** cleanup & remove unused code
+* **[ref]** Logger#simple_log - to use customized inspector method
+* **[ref]** update gem dependencies
+* **[fix]** minor bugs & log forwarding
+
+## [0.1.0] - 2023-01-24
+* Initial commit
+* docs, version, structure

data/docs/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 tg@reimbursement.institute. 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/docs/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ruby Smart
+
+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/lib/debugger.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "gem_info"
+require 'ruby_smart/simple_logger'
+
+# to prevent compatibility issues with the ruby-debug-ide gem (uses same Namespace 'Debugger')
+GemInfo.safe_require 'ruby-debug-ide'
+
+# try to load 'awesome_print', if available
+GemInfo.safe_require 'awesome_print'
+
+class Debugger
+  extend ::RubySmart::SimpleLogger::KlassLogger
+
+  # overwrite existing "debug" method (if Debase was loaded)
+  def self.debug(*args)
+    return false if args.none?
+    klass_logger.debug(*args)
+  end
+end

data/lib/ruby_smart/simple_logger/core_ext/ruby/string.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+unless String.method_defined? "bg_black"
+  class String
+    # add string background colors
+    #
+    # ANSI color codes:
+    #   \e => escape
+    #   40 => color bg base
+    #
+    # For HTML coloring we use <kbd> tag instead of <span> to require monospace font.
+    %w(black red green yellow blue purple cyan white).each_with_index do |color, i|
+      define_method "bg_#{color}" do |*html|
+        html[0] ? %Q|<kbd style="background:#{color}">#{self}</kbd>| : "\e[#{40 + i}m#{self}\e[0m"
+      end
+    end
+  end
+end
+
+# only as comment - if we decide to remove 'awesome_print'
+unless String.method_defined? "black"
+  class String
+    # add string colors
+    #
+    # ANSI color codes:
+    #   \e => escape
+    #   1;30 => color base
+    #
+    # For HTML coloring we use <kbd> tag instead of <span> to require monospace font.
+    %w(gray red green yellow blue purple cyan white).each_with_index do |color, i|
+      define_method color do |*html|
+        html[0] ? %Q|<kbd style="color:#{color}">#{self}</kbd>| : "\e[1;#{30 + i}m#{self}\e[0m"
+      end
+
+      define_method "#{color}ish" do |*html|
+        html[0] ? %Q|<kbd style="color:#{color}">#{self}</kbd>| : "\e[0;#{30 + i}m#{self}\e[0m"
+      end
+    end
+
+    alias :black :grayish
+    alias :pale  :whiteish
+  end
+end

data/lib/ruby_smart/simple_logger/devices/memory_device.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RubySmart
+  module SimpleLogger
+    module Devices
+      class MemoryDevice
+
+        attr_reader :logs
+        attr_reader :status
+
+        def initialize
+          @logs   = []
+          @status = true
+        end
+
+        # adds data to the logs
+        # @param [Object] data
+        def write(data)
+          return false unless status
+
+          @logs << data
+        end
+
+        alias_method :<<, :write
+
+        # disables writing
+        def close
+          @status = false
+        end
+
+        # enables writing
+        def reopen
+          @status = true
+        end
+
+        # clears all logs
+        def clear!
+          @logs = []
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smart/simple_logger/devices/multi_device.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RubySmart
+  module SimpleLogger
+    module Devices
+      class MultiDevice
+
+        attr_reader :devices
+        attr_reader :status
+
+        def initialize
+          @devices = []
+          @status  = true
+        end
+
+        # pass data to the devices
+        # @param [Object] data
+        def write(data)
+          return false unless status
+
+          devices.each do |device|
+            if device[:formatter]
+              device[:dev].write(device[:formatter].(*data))
+            else
+              device[:dev].write(data)
+            end
+          end
+        end
+
+        alias_method :<<, :write
+
+        # disables writing
+        def close
+          @status = false
+        end
+
+        # enables writing
+        def reopen
+          @status = true
+        end
+
+        # clears all devices
+        def clear!
+          @devices = []
+        end
+
+        # registers a new device.
+        # CHAINABLE
+        #
+        # @param [Object] dev
+        def register(dev, formatter = nil)
+          @devices << {
+            dev:       dev,
+            formatter: formatter
+          }
+
+          self
+        end
+
+        # returns logs from the first loggable device
+        # @return [Array] logs
+        def logs
+          logdev = devices.detect { |device| device[:dev].respond_to?(:logs) }
+          logdev.nil? ? [] : logdev[:dev].logs
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smart/simple_logger/devices/proc_device.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RubySmart
+  module SimpleLogger
+    module Devices
+      class ProcDevice
+
+        attr_reader :status
+
+        def initialize(proc)
+          @proc = proc
+          @status = true
+        end
+
+        # pass data to the callback
+        # @param [Object] data
+        def write(data)
+          return false unless status
+
+          @proc.call(data)
+        end
+
+        alias_method :<<, :write
+
+        # disables writing
+        def close
+          @status = false
+        end
+
+        # enables writing
+        def reopen
+          @status = true
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smart/simple_logger/extensions/helper.rb

@@ -0,0 +1,259 @@
+# frozen_string_literal: false
+
+# use from ruby_smart-support
+require 'thread_info'
+require 'fileutils'
+
+module RubySmart
+  module SimpleLogger
+    module Extensions
+      module Helper
+
+        private
+
+        # prepare builtin defaults
+        # @param [Hash] opts
+        def _opts_builtin(opts)
+          builtin = opts.delete(:builtin)
+
+          case builtin
+          when nil
+            # device is nil - resolve optimal device
+            opts[:device] ||= if ::ThreadInfo.stdout?
+                                # colorize output
+                                opts[:clr] = true if opts[:clr].nil?
+
+                                STDOUT
+                              elsif ::ThreadInfo.rails? && ::Rails.logger
+                                ::RubySmart::SimpleLogger::Devices::MultiDevice.new.register(::Rails.logger.instance_variable_get(:@logdev).dev)
+                              else
+                                ::RubySmart::SimpleLogger::Devices::MemoryDevice.new
+                              end
+          when :stdout
+            opts[:device] ||= STDOUT
+            # colorize output
+            opts[:clr]    = true if opts[:clr].nil?
+          when :stderr
+            opts[:device] ||= STDERR
+            # colorize output
+            opts[:clr]    = true if opts[:clr].nil?
+          when :rails
+            opts[:device] ||= ::RubySmart::SimpleLogger::Devices::MultiDevice.new.register(::Rails.logger.instance_variable_get(:@logdev).dev)
+          when :proc
+            # auto sets related opts for proc device
+            opts[:payload] = false
+            opts[:format]  ||= :passthrough
+
+            # force set device
+            opts[:device] ||= ::RubySmart::SimpleLogger::Devices::ProcDevice.new(opts[:proc])
+          when :memory
+            # auto sets related opts for memory device
+            opts[:payload] = false
+
+            # set device
+            opts[:device] ||= if opts[:stdout]
+                                # IMPORTANT: There will be a 'default' formatter created, which will passthrough all data to the device
+                                opts[:format] ||= :passthrough
+
+                                # special case handling to additionally stdout logs
+                                ::RubySmart::SimpleLogger::Devices::MultiDevice.new.
+                                  register(::RubySmart::SimpleLogger::Devices::MemoryDevice.new, ::RubySmart::SimpleLogger::Formatter.new(format: :memory, nl: false)).
+                                  register(STDOUT, ::RubySmart::SimpleLogger::Formatter.new(format: :default, nl: true, clr: (opts[:clr] != nil)))
+                              else
+                                opts[:format] ||= :memory
+                                ::RubySmart::SimpleLogger::Devices::MemoryDevice.new
+                              end
+          else
+            # forward provided device ONLY if unset in opts
+            opts[:device] ||= builtin
+          end
+        end
+
+        # resolve the final log-device from provided param
+        # @param [Object] device
+        # @return [Object]
+        def _logdev(device)
+          if device.is_a?(Module)
+            devstring = device.to_s
+            logfile   = (devstring.respond_to?(:underscore) ? devstring.underscore : _underscore(device.to_s)) + '.log'
+            # check for rails
+            if ::ThreadInfo.rails?
+              file_location = File.join(Rails.root, 'log', logfile)
+            else
+              file_location = File.join('log', logfile)
+            end
+
+            # resolve path to create a folder
+            file_path = File.dirname(file_location)
+            FileUtils.mkdir_p(file_path) unless File.directory?(file_path)
+
+            file_location
+          elsif device.is_a?(String)
+            device = "log/#{device}" unless device[0] == '/'
+
+            # resolve path to create a folder
+            file_path = File.dirname(device)
+            FileUtils.mkdir_p(file_path) unless File.directory?(file_path)
+
+            device
+          elsif device.respond_to?(:write)
+            device
+          else
+            raise "SimpleLogger :: device '#{device}' must respond to 'write'!"
+          end
+        end
+
+        # this is a 1:1 copy of +String#underscore+ @ activesupport gem
+        def _underscore(camel_cased_word)
+          return camel_cased_word unless /[A-Z-]|::/.match?(camel_cased_word)
+          word = camel_cased_word.to_s.gsub("::", "/")
+          word.gsub!(/(?:(?<=([A-Za-z\d]))|\b)((?=a)b)(?=\b|[^a-z])/) { "#{$1 && '_' }#{$2.downcase}" }
+          word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+          word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+          word.tr!("-", "_")
+          word.downcase!
+          word
+        end
+
+        # build log-device & options on initialize
+        # @param [Hash] opts
+        # @return [Array<logdev,opts>] logdev, opts
+        def _init_opts(opts)
+          # clean & rewrite opts (especially device) to a real logdev
+          _opts_builtin(opts)
+
+          # set mask from options
+          self.mask(opts[:mask]) if opts[:mask]
+
+          # disable mask color if explicit disabled
+          self.mask(clr: false) if opts[:clr] == false
+
+          # reduce mask-size to window size
+          if ::ThreadInfo.windowed? && ::ThreadInfo.winsize[1] < self.mask[:length]
+            self.mask(length: ::ThreadInfo.winsize[1])
+          end
+
+          # initialize a default rails-dependent output
+          if ::ThreadInfo.rails?
+            opts[:level] ||= (::Rails.env.production? ? :info : :debug)
+          end
+
+          # clean & rewrite level (possible symbols) to real level
+          opts[:level] = _level(opts[:level] || :debug)
+
+          # provide custom formatter and forward special opts (format, nl, clr)
+          opts[:formatter] ||= ::RubySmart::SimpleLogger::Formatter.new({ format: :plain, nl: false, clr: false }.merge(opts.slice(:format, :nl, :clr)))
+
+          # ignore payload and send data directly to the logdev
+          @ignore_payload  = true if opts[:payload].is_a?(FalseClass)
+
+          # set the inspector to be used for data inspection
+          @inspector = opts[:inspector]
+
+          # disable inspector
+          @inspector = :to_s if opts[:inspect] == false
+
+          # # build logdev
+          # opts[:logdev] = _logdev(opts[:device])
+
+          # simple return opts
+          opts
+        end
+
+        # merge all provided hashes into one single hash
+        #
+        # @example
+        #   _opt({level: :debug, formatter: :my, payload: []}, {payload: [:_], ins: true})
+        #   > {level: :debug, formatter: :my, payload: [:_], ins: true}
+        #
+        # @param [Hash] opts
+        # @return [Hash] opts
+        def _opt(*opts)
+          # IMPORTANT: Do not remove first empty hash!
+          opts.unshift {}
+
+          # merge each single provided option
+          opts.reduce({}) do |m, opt|
+            opt.each do |k, v|
+              if v.is_a?(Hash) && m[k].is_a?(Hash)
+                m[k] = m[k].merge(v)
+              else
+                m[k] = v
+              end
+            end
+            m
+          end
+        end
+
+        # colorizes a provided string
+        # returns the string if no color was provided or invalid
+        #
+        # @example
+        #   _clr('Test',nil)
+        #   > "Test"
+        #
+        #   _clr('Test2', :red)
+        #   > "\e[1;31mTest2\e[0m"
+        #
+        #   _clr('Test3', :not_a_valid_color)
+        #   > "Test3"
+        #
+        # @param [String] str
+        # @param [String, Symbol, nil] color
+        # @return [String] colored string
+        def _clr(str, color)
+          return str unless color && str.respond_to?(color)
+          str.send(color) rescue str
+        end
+
+        # force string to exact length
+        #
+        # @example
+        #   _lgth('test', 10)
+        #   > "test      "
+        #
+        #   _lgth('very long teststring', 10)
+        #    > "very long "
+        #
+        #   _lgth('very', 10,'-')
+        #   > "very------"
+        #
+        # @param [String] str
+        # @param [Integer] length
+        # @param [String] padstr - optional (default: ' ')
+        # @return [String] str
+        def _lgth(str, length, padstr = ' ')
+          str.to_s.ljust(length, padstr)[0..(length - 1)]
+        end
+
+        # returns a Symbol by provided result or color
+        #
+        # @example
+        #   _res_clr(true)
+        #   > :green
+        #
+        #   _res_clr('0')
+        #   > :red
+        #
+        #   _res_clr(:yellow)
+        #   > :yellow
+        #
+        #   _res_clr('not_really_a_color')
+        #   > :not_really_a_color
+        #
+        # @param [Boolean, String, Integer, Symbol] res_or_clr
+        # @return [Symbol] color
+        def _res_clr(res_or_clr)
+          case res_or_clr
+          when true, 1, '1'
+            :green
+          when false, 0, '0'
+            :red
+          else
+            res_or_clr.to_sym
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smart/simple_logger/extensions/logs.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RubySmart
+  module SimpleLogger
+    module Extensions
+      module Logs
+        # returns the logdev logs
+        # @return [Array]
+        def logs
+          return [] unless logdev.dev.respond_to?(:logs)
+          logdev.dev.logs
+        end
+
+        # transforms the logs-array into a hash of logs, grouped by level (:error, :success, ...)
+        # @return [Hash] logs
+        def logs_to_h
+          logs.reduce({}) do |m, log|
+            m[log[0]] ||= []
+            m[log[0]] << log[2]
+            m
+          end
+        end
+      end
+    end
+  end
+end