ruby_smart-simple_logger 1.0.0

data/lib/ruby_smart/simple_logger/logger.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative 'extensions/helper'
+require_relative 'extensions/logs'
+require_relative 'extensions/mask'
+require_relative 'extensions/scene'
+require_relative 'extensions/severity'
+require_relative 'extensions/simple_log'
+require_relative 'extensions/timer'
+
+require_relative 'devices/memory_device'
+require_relative 'devices/multi_device'
+require_relative 'devices/proc_device'
+
+require_relative 'formatter'
+require_relative 'scenes'
+
+# requires ruby's logger
+require 'logger'
+require 'gem_info'
+
+module RubySmart
+  module SimpleLogger
+    class Logger < ::Logger
+      include Extensions::Helper
+      include Extensions::Logs
+      include Extensions::Mask
+      include Extensions::Scene
+      include Extensions::Severity
+      include Extensions::SimpleLog
+      include Extensions::Timer
+
+      include Scenes
+
+      # enable access to the logdev
+      attr_reader :logdev
+
+      # defines a uniq key to parse the data
+      PAYLOAD_DATA_KEY = :_data
+
+      # initialize new Logger
+      # @param [Object, Symbol, nil] builtin
+      # @param [Hash] opts
+      # @option opts [Symbol] :format - defines a custom format
+      def initialize(builtin = nil, opts = nil)
+        # check if only a hash was provided
+        if opts.nil? && builtin.is_a?(Hash)
+          opts = builtin
+        else
+          opts ||= {}
+
+          # extend builtin option if not set
+          opts[:builtin] = builtin unless opts[:builtin]
+        end
+
+        # initialize provided opts
+        o = _init_opts(opts)
+
+        super(
+          _logdev(o[:device]),
+          o[:shift_age] || 0,
+          o[:shift_size] || 1048576,
+          **o.slice(:level, :progname, :formatter, :datetime_format, :binmode, :shift_period_suffix)
+        )
+      end
+
+      # overwrite level setter, to accept every available (also newly defined) Severity
+      # @param [Numeric, String, Symbol] sev - severity to resolve
+      def level=(sev)
+        @level = _level(sev)
+      end
+    end
+  end
+end

data/lib/ruby_smart/simple_logger/scenes.rb

@@ -0,0 +1,288 @@
+# frozen_string_literal: true
+
+module RubySmart
+  module SimpleLogger
+    module Scenes
+      def self.included(base)
+        # debug method
+        # log level @ debug
+        # prints: prettified data by using the 'inspect' method
+        #
+        # > ================================================= [Debug] ================================================
+        # > "DEBUGGED DATA" <- analyzed by awesome_print#ai method
+        # > ==========================================================================================================
+        base.scene :debug, { level: :debug, inspect: true, payload: [[:mask, ' [%{subject}] '], :_data, :mask] } do |data, subject = 'Debug', opts = {}|
+          self.log data, _scene_opt(:debug, { subject: subject }, opts)
+        end
+
+        # info method (BASE)
+        # log level @ info
+        # prints: enclosed data
+        #
+        # > ================================================= [Info] =================================================
+        # > DATA
+        # > ==========================================================================================================
+        base.scene :info, { level: :info, mask: { clr: :cyan }, payload: [[:mask, ' [%{subject}] '], :_data, :mask] } do |data, subject = 'Info', opts = {}|
+          self.log data, _scene_opt(:info, { subject: subject }, opts)
+        end
+
+        # warn method (BASE)
+        # log level @ warn
+        # prints: enclosed data
+        #
+        # > ================================================= [Warn] =================================================
+        # > DATA
+        # > ==========================================================================================================
+        base.scene :warn, { level: :warn, mask: { clr: :yellow }, payload: [[:mask, ' [%{subject}] '], :_data, :mask] } do |data, subject = 'Warn', opts = {}|
+          self.log data, _scene_opt(:warn, { subject: subject }, opts)
+        end
+
+        # error method (BASE)
+        # log level @ error
+        # prints: enclosed data
+        #
+        # > ================================================ [Error] =================================================
+        # > DATA
+        # > ==========================================================================================================
+        base.scene :error, { level: :error, mask: { clr: :red }, payload: [[:mask, ' [%{subject}] '], :_data, :mask] } do |data, subject = 'Error', opts = {}|
+          self.log data, _scene_opt(:error, { subject: subject }, opts)
+        end
+
+        # fatal method (BASE)
+        # log level @ fatal
+        # prints: enclosed data
+        #
+        # > ================================================ [Fatal] =================================================
+        # > DATA
+        # > ==========================================================================================================
+        base.scene :fatal, { level: :fatal, mask: { clr: :bg_red }, payload: [[:mask, ' [%{subject}] '], :_data, :mask] } do |data, subject = 'Fatal', opts = {}|
+          self.log data, _scene_opt(:fatal, { subject: subject }, opts)
+        end
+
+        # success method
+        # log level @ success (sub-level of info)
+        # prints: enclosed data
+        #
+        # > ================================================ [Success] ================================================
+        # > DATA
+        # > ===========================================================================================================
+        base.scene :success, { level: :success, mask: { clr: :green }, payload: [[:mask, ' [%{subject}] '], :_data, :mask] } do |data, subject = 'Success', opts = {}|
+          self.log data, _scene_opt(:success, { subject: subject }, opts)
+        end
+
+        # header method
+        # log level @ debug
+        # prints: prettified subject
+        #
+        # > ===========================================================================================================
+        # > ================================================ <Subject> ================================================
+        # > ===========================================================================================================
+        base.scene :header, { level: :debug, payload: [:mask, [:mask, ' <%{subject}> '], :mask] } do |subject, opts = {}|
+          # autostart a timer method, if required
+          self.timer(:start, :default) if opts[:timer]
+
+          self.log nil, _scene_opt(:header, { subject: subject }, opts)
+        end
+
+        # footer method
+        # log level @ debug
+        # prints: prettified subject
+        #
+        # > ===========================================================================================================
+        # > ================================================ >Subject< ================================================
+        # > ===========================================================================================================
+        base.scene :footer, { level: :debug, payload: [:mask, [:mask, ' >%{subject}< '], :mask] } do |subject, opts = {}|
+          self.log nil, _scene_opt(:footer, { subject: subject }, opts)
+
+          # clears & prints timer
+          self.desc("duration: #{self.timer(:clear, :default, :humanized => true)}") if opts[:timer]
+        end
+
+        # topic method
+        # log level @ debug
+        # prints: prettified subject
+        #
+        # > --------------------------------------------------------------------------------
+        # > #----------------------------------- Subject ----------------------------------#
+        # > --------------------------------------------------------------------------------
+        base.scene :topic, { level: :debug, mask: { char: '-', length: 95, clr: :blueish }, payload: [:mask, [:mask, '%{title}'], :mask] } do |subject, opts = {}|
+          opts         = _scene_opt(:topic, opts)
+          txt          = " #{subject} ".center(opts[:mask][:length] - 2, opts[:mask][:char])
+          opts[:title] = "##{txt}#"
+
+          self.log nil, opts
+        end
+
+        # theme method
+        # log level @ debug
+        # prints: prettified, colored subject
+        #
+        # > # Subject
+        # > ----------------------------------------------------------------------
+        base.scene :theme, { level: :debug, clr: :purple, mask: { char: '-', length: 85, clr: :purple }, payload: [[:txt, '# %{subject}'], :mask] } do |subject, opts = {}|
+          self.log nil, _scene_opt(:theme, { subject: subject }, opts)
+        end
+
+        # theme_result method
+        # log level @ debug
+        # prints: prettified, colored result
+        #
+        # > ----------------------------------------------------------------------
+        # > -> Result
+        # >
+        base.scene :theme_result, { level: :debug, mask: { char: '-', length: 85, clr: :purple }, payload: [:mask, [:txt, '-> %{result}'], ''] } do |result, status = nil, opts = {}|
+          res_or_clr = status.nil? ? result : status
+          self.log nil, _scene_opt(:theme_result, { result: result, clr: _res_clr(res_or_clr) }, opts)
+        end
+
+        # theme_line method
+        # log level @ debug
+        # prints: colored line with no text
+        #
+        # > ----------------------------------------------------------------------
+        base.scene :theme_line, { level: :debug, mask: { char: '-', length: 85, clr: :purple }, payload: [:mask] } do |opts = {}|
+          self.log nil, _scene_opt(:theme_line, opts)
+        end
+
+        # desc method
+        # log level @ debug
+        # prints: colored text
+        #
+        # > "description"
+        # >
+        base.scene :desc, { level: :debug, clr: :purple, payload: [[:txt, '%{description}']] } do |description, opts = {}|
+          self.log nil, _scene_opt(:desc, { description: description.to_s }, opts)
+        end
+
+        # job method
+        # log level @ debug
+        # prints: colored line with job name (on inline formatter it prevents a line-break)
+        # calls the result method if a block was provided
+        #
+        # > - Job name                                                         =>
+        #     ________________________________________________________________ <- 64 chars
+        base.scene :job, { level: :debug, clr: :cyan, nl: false, length: 64, payload: [[:concat, ['- ', [:txt, '%{name}'], ' => ']]] } do |name, opts = {}, &block|
+          self.log nil, _scene_opt(:job, { name: name }, opts)
+          self.result(*block.call) if block_given?
+        end
+
+        # sub_job method
+        # log level @ debug
+        # prints: line with job name (on inline formatter it prevents a line-break)
+        # calls the result method if a block was provided
+        #
+        # >   * Subjob name                                                    =>
+        #       ______________________________________________________________ <- 62 chars
+        base.scene :sub_job, { level: :debug, clr: :cyan, nl: false, length: 62, payload: [[:concat, ['  * ', [:txt, '%{name}'], ' => ']]] } do |name, opts = {}, &block|
+          self.log nil, _scene_opt(:sub_job, { name: name }, opts)
+          self.result(*block.call) if block_given?
+        end
+
+        # result method
+        # log level @ debug
+        # prints: colored result
+        #
+        # > Result
+        base.scene :result, { level: :debug, payload: [[:txt, '%{result}']] } do |result, status = nil, opts = {}|
+          res_or_clr = status.nil? ? result : status
+          self.log nil, _scene_opt(:result, { result: result, clr: _res_clr(res_or_clr) }, opts)
+        end
+
+        # job_result method
+        # log level @ debug
+        # prints: job with combined colored result
+        #
+        # > - Job name                                                         => Result
+        base.scene :job_result, { level: :debug } do |name, result, status = nil, opts = {}|
+          self.job(name, opts)
+          self.result(result, status, opts)
+        end
+
+        # sub_job_result method
+        # log level @ debug
+        # prints: sub_job with combined colored result
+        #
+        # >   * Subjob name                                                    => Result
+        base.scene :sub_job_result, { level: :debug } do |name, result, status = nil, opts = {}|
+          self.sub_job(name, opts)
+          self.result(result, status, opts)
+        end
+
+        # line method
+        # log level @ debug
+        # prints: just a line with data
+        #
+        # > DATA
+        base.scene :line, { level: :debug } do |data, opts = {}|
+          self.log data, _scene_opt(:line, opts)
+        end
+
+        # print method
+        # log level @ debug
+        # prints: prints data without a newline
+        #
+        # > DATA
+        base.scene :print, { level: :debug, nl: false } do |data, opts = {}|
+          self.log data, _scene_opt(:print, opts)
+        end
+
+        # nl method
+        # log level @ debug
+        # prints: a line break without any data
+        #
+        # >
+        # >
+        base.scene :nl, { level: :debug } do |opts = {}|
+          self.log '', _scene_opt(:nl, opts)
+        end
+
+        # spec method
+        # log level @ debug
+        # prints: colored spec result string - depending on the status (on inline formatter it prevents a line-break)
+        #
+        # true      => . (green)
+        # false     => F (red)
+        # "other"   => ? (yellow)
+        #
+        # > .FFF...??...F....F...F..???....F...??
+        base.scene :spec, { level: :debug, nl: false, payload: [[:txt, '%{result}']] } do |status, opts = {}|
+          result = if status.is_a?(TrueClass)
+                     '.'
+                   elsif status.is_a?(FalseClass)
+                     'F'
+                   else
+                     status = :yellow
+                     '?'
+                   end
+          self.log nil, _scene_opt(:spec, { result: result, clr: _res_clr(status) }, opts)
+        end
+
+        # progress method
+        # log level @ debug
+        # prints: a colored progress indicator
+        #
+        # > - Progress of Step 0                               [  0%] >-------------------------------------------------
+        # > - Progress of Step 1                               [ 40%] ===================>------------------------------
+        #     ________________________________________________ <- 48 chars
+        #                                                 50 chars -> __________________________________________________
+        base.scene :progress, { level: :debug, payload: [[:txt, '- %{name} [%{perc}%] %{progress}']] } do |name, perc, opts = {}|
+          pmask_length = 50
+
+          # convert and fix progress
+          perc = perc.to_i
+          perc = 0 if perc < 0
+          perc = 100 if perc > 100
+
+          pmask_left_length = (pmask_length * perc / 100)
+          # reduce 1 char for the arrow '>'
+          pmask_left_length -= 1 if pmask_left_length > 0
+          pmask_right_length = pmask_length - pmask_left_length - 1
+
+          progress_string = _clr(('=' * pmask_left_length) + '>', :green) + _clr('-' * pmask_right_length, :red)
+          perc_string = perc.to_s.rjust(3,' ')
+          self.log nil, _scene_opt(:progress, { name: _clr(_lgth(name, 48), :cyan), perc: perc_string, progress: progress_string }, opts)
+        end
+      end
+    end
+  end
+end

data/lib/ruby_smart/simple_logger/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'gem_version'
+
+module RubySmart
+  module SimpleLogger
+    # Returns the version of the currently loaded Gem as a <tt>Gem::Version</tt>
+    def self.version
+      gem_version
+    end
+  end
+end

data/lib/ruby_smart/simple_logger.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "gem_info"
+
+require_relative "simple_logger/core_ext/ruby/string"
+require_relative "simple_logger/version"
+require_relative "simple_logger/logger"
+require_relative "simple_logger/klass_logger"
+
+module RubySmart
+  module SimpleLogger
+    # delegate new method to logger
+    def self.new(*args)
+      RubySmart::SimpleLogger::Logger.new(*args)
+    end
+  end
+end
+
+# load date extensions for logger
+if GemInfo.loaded?('activesupport') && GemInfo.installed?('actionview')
+  ActiveSupport.on_load(:action_view) do
+    require('action_view/helpers/date_helper')
+    RubySmart::SimpleLogger::Logger.include(ActionView::Helpers::DateHelper)
+  end
+end

data/lib/ruby_smart-simple_logger.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'ruby_smart/simple_logger'

data/lib/simple_logger.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'ruby_smart/simple_logger'
+
+class SimpleLogger
+  extend ::RubySmart::SimpleLogger::KlassLogger
+end

data/ruby_smart-simple_logger.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/ruby_smart/simple_logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "ruby_smart-simple_logger"
+  spec.version = RubySmart::SimpleLogger.version
+  spec.authors     = ['Tobias Gonsior']
+  spec.email       = ['info@ruby-smart.org']
+
+  spec.summary               = "A simple, multifunctional logging library for Ruby."
+  spec.description = <<~DESC
+    RubySmart::SimpleLogger is a fast, customizable logging library with multi-device support, 
+    special (PRE-defined) scenes for better logging visibility.
+  DESC
+
+  spec.homepage              = 'https://github.com/ruby-smart/simple_logger'
+  spec.license               = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri']      = spec.homepage
+  spec.metadata['source_code_uri']   = 'https://github.com/ruby-smart/simple_logger'
+  spec.metadata['documentation_uri'] = 'https://rubydoc.info/gems/ruby_smart-simple_logger'
+  spec.metadata['changelog_uri']     = "#{spec.metadata["source_code_uri"]}/blob/main/docs/CHANGELOG.md"
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ruby_smart-support', '~> 1.2'
+
+  spec.add_development_dependency 'awesome_print', '~> 1.9'
+  spec.add_development_dependency 'coveralls_reborn', '~> 0.25'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: ruby_smart-simple_logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tobias Gonsior
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_smart-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: coveralls_reborn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
+- !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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: "RubySmart::SimpleLogger is a fast, customizable logging library with
+  multi-device support, \nspecial (PRE-defined) scenes for better logging visibility.\n"
+email:
+- info@ruby-smart.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docs/CHANGELOG.md
+- docs/CODE_OF_CONDUCT.md
+- docs/LICENSE.txt
+- lib/debugger.rb
+- lib/ruby_smart-simple_logger.rb
+- lib/ruby_smart/simple_logger.rb
+- lib/ruby_smart/simple_logger/core_ext/ruby/string.rb
+- lib/ruby_smart/simple_logger/devices/memory_device.rb
+- lib/ruby_smart/simple_logger/devices/multi_device.rb
+- lib/ruby_smart/simple_logger/devices/proc_device.rb
+- lib/ruby_smart/simple_logger/extensions/helper.rb
+- lib/ruby_smart/simple_logger/extensions/logs.rb
+- lib/ruby_smart/simple_logger/extensions/mask.rb
+- lib/ruby_smart/simple_logger/extensions/scene.rb
+- lib/ruby_smart/simple_logger/extensions/severity.rb
+- lib/ruby_smart/simple_logger/extensions/simple_log.rb
+- lib/ruby_smart/simple_logger/extensions/timer.rb
+- lib/ruby_smart/simple_logger/formatter.rb
+- lib/ruby_smart/simple_logger/gem_version.rb
+- lib/ruby_smart/simple_logger/klass_logger.rb
+- lib/ruby_smart/simple_logger/logger.rb
+- lib/ruby_smart/simple_logger/scenes.rb
+- lib/ruby_smart/simple_logger/version.rb
+- lib/simple_logger.rb
+- ruby_smart-simple_logger.gemspec
+homepage: https://github.com/ruby-smart/simple_logger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ruby-smart/simple_logger
+  source_code_uri: https://github.com/ruby-smart/simple_logger
+  documentation_uri: https://rubydoc.info/gems/ruby_smart-simple_logger
+  changelog_uri: https://github.com/ruby-smart/simple_logger/blob/main/docs/CHANGELOG.md
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+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: A simple, multifunctional logging library for Ruby.
+test_files: []