ruby_smart-simple_logger 1.5.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc624589a3aa7114bbec118563f3f802b046032abe1df2fbddf762971b99bf12
-  data.tar.gz: 94a9de8091320a9d5395878e1a22362e2ae15d0be0e497f2a6ff3d9f22eeddd4
+  metadata.gz: 5f377784d8f7f47e7e2e6e8db6af4a59f18141a46dc4a02c6a1e7d065b40d660
+  data.tar.gz: 23bceaf895ef087fb54620a3b8b09c8c1952da685ce862c8eaafff52bf7756fa
 SHA512:
-  metadata.gz: 7a80eff8cd646906a76abab041aa884fe769a4707e8b9ba7d819707664b71352108f1116eb5530711925bf6d1bc7eac104f5a2086bd050db41177e56d32f0874
-  data.tar.gz: 92c98897175040fc149e8825db0d1f941197b0aa301ea025731f38fb79a70ac09eff6833ebd622030167c2d530cf9db2dd7b5a9feaaf2ee5838561a9297ff991
+  metadata.gz: 2c1de42c4b096d61f6c9e085c613cb3d70f82c6aae3abdb4d2f4e488d4eb665576a37d68b22d23fb57d15d6bebbe4231f533c34b12e1e3a079ccb4d6f540acb2
+  data.tar.gz: e6eef91be3f2e57d15401b9ae6d4768265376957009b3934122d21456b7ad16c1c2322b35aa12b658af027e6407c252a5e5d49cf745ed32a995e28ab78b97b76

data/README.md

@@ -39,6 +39,7 @@ Or install it yourself as:
 * `awesome_print` gem compatibility for a prettified object debug
 * Multi-device support (write to logfile & to STDOUT & to ... & to ...)
 * 'klass_logger' instances for easier access _(see [klass_logger](#klass_logger_Usage))_
+* Debug / Debase compatibility
 
 -----
 
@@ -789,12 +790,89 @@ end
 # ╚   END ❯ Process Alpha (0.001036969)
 ```
 
-### _other useful methods_
+### model(mdl, opts)
+Useful for rails applications to debug or log a save _(create/update)_ result of a model.
+The `model` method logs in three different scenes `SUCCESS ERROR INFO`, depending on the models state: created, updated, error, skipped
 
-- line
-- print
-- nl
-- model _(rails only)_
+```ruby
+require 'simple_logger'
+l = SimpleLogger.new(:stdout, payload: false)
+
+# create a model and save it (with validation errors)
+mdl = User.new first_name: 'Max'
+mdl.save
+
+# log the result
+l.model(mdl)
+
+# creates an ERROR of:
+# [USER|ERROR] Max (E-Mail is invalid, Username is invalid)
+
+# ------------------------------------------------------------------------------------------
+
+# update the model to prevent validation errors
+mdl.username = 'test'
+mdl.email = 'max@test.x'
+mdl.save
+
+# creates an SUCCESS of:
+# [USER|CREATED] #1 - Max
+
+# ------------------------------------------------------------------------------------------
+
+# update the model
+mdl.update(username: 'tester')
+
+# creates an SUCCESS of:
+# [USER|UPDATED] #1 - Max
+
+# ------------------------------------------------------------------------------------------
+
+# update the model again (without any change)
+mdl.update(username: 'tester')
+
+# creates an INFO of:
+# [USER|SKIPPED] #1 - Max
+```
+
+### line(data, opts)
+Prints just a line with data and line-break _(for payloads)_
+
+```ruby
+require 'simple_logger'
+l = SimpleLogger.new(:stdout)
+
+l.line "some example line of DATA"
+l.print "other example"
+# > some example line of DATA
+# > other example
+# > 
+```
+
+### print(data, opts)
+Prints just data without line-break
+
+```ruby
+require 'simple_logger'
+l = SimpleLogger.new(:stdout)
+
+l.print "some example line of DATA"
+l.print "other example"
+# > some example line of DATAother example
+```
+
+
+### nl(opts)
+Prints just a line-break.
+
+```ruby
+require 'simple_logger'
+l = SimpleLogger.new(:stdout)
+
+l.nl
+# > 
+# > 
+```
 
 -----
 

data/docs/CHANGELOG.md

@@ -1,5 +1,11 @@
 # RubySmart::SimpleLogger - CHANGELOG
 
+## [1.6.0] - 2025-06-13
+* **[add]** `Proc` to builtins
+* **[add]** better specs
+* **[ref]** initialization process _(simplify, move instance-assignments to `#initialize`, rename \_opts_x to assign_x)_
+* **[fix]** `Debase.logger` rewriting for Ruby 3.x _(Debase.logger is a proc instead of a Logger / STDOUT)_
+
 ## [1.5.3] - 2024-09-16
 * **[fix]** scene `job`-, `sub_job`-methods not working with provided block
 * **[fix]** scene `result`-methods not printing boolean results (also fixes exception for boolean/numeric results)

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

@@ -13,7 +13,7 @@ module RubySmart
 
         # set / overwrite default opts
         # @param [Hash] opts
-        def _opts_init!(opts)
+        def assign_defaults!(opts)
           # -- level ---------------------------------------------------------------------------------------------------
 
           # initialize a default rails-dependent output
@@ -37,32 +37,17 @@ module RubySmart
             self.mask(length: ::ThreadInfo.winsize[1])
           end
 
-          # -- instance related ----------------------------------------------------------------------------------------
-
-          # ignore payload and send data directly to the logdev
-          @ignore_payload   = true if @ignore_payload.nil? && opts[:payload] == false
-
-          # ignore processed logging and send data without 'leveling' & PCD-char to the logdev
-          @ignore_processed = true if @ignore_processed.nil? && opts[:processed] == false
-
-          # ignore tagged logging and send data without 'tags' to the logdev
-          @ignore_tagged    = true if @ignore_tagged.nil? && opts[:tagged] == false
-
-          # set custom inspector (used for data inspection)
-          # 'disable' inspector, if false was provided - which simply results in +#to_s+
-          @inspector = (opts[:inspect] == false) ? :to_s : opts[:inspector]
-
-          # prevent to return any data
+          # prevent returning any data
           nil
         end
 
-        # enhance provided opts with +:device+.
+        # enhance provided opts with +:logdev+.
         # opts may be manipulated by resolved device
         # does not return any data.
         # @param [Hash] opts
-        def _opts_device!(opts)
-          # check for already existing +device+
-          return if opts[:device]
+        def assign_logdev!(opts)
+          # check for already existing +logdev+
+          return if opts[:logdev]
 
           # remove builtin key from opts and force an array
           builtins = Array(opts.delete(:builtin))
@@ -77,20 +62,23 @@ module RubySmart
 
           # don't create multi-device for a single (or +nil+) builtin
           if builtins.length < 2
-            opts[:device] = _resolve_device(builtins[0], opts)
+            opts[:logdev] = _resolve_device(builtins[0], opts)
           else
-            opts[:device] = ::RubySmart::SimpleLogger::Devices::MultiDevice.new
+            opts[:logdev] = ::RubySmart::SimpleLogger::Devices::MultiDevice.new
             builtins.each do |builtin|
               # IMPORTANT: dup, original hash to prevent reference manipulation (on the TOP-level, only)
               builtin_opts = opts.dup
-              opts[:device].register(_resolve_device(builtin, builtin_opts), _resolve_formatter(builtin_opts))
+              opts[:logdev].register(_resolve_device(builtin, builtin_opts), _resolve_formatter(builtin_opts))
+
+              # disable payload, if any is disabled
+              opts[:payload] = false if builtin_opts[:payload] == false
             end
 
             # force 'passthrough', as format, since this is required for multi-devices
             opts[:format] = :passthrough
           end
 
-          # prevent to return any data
+          # prevent returning any data
           nil
         end
 
@@ -98,13 +86,13 @@ module RubySmart
         # opts may be manipulated by resolved formatter
         # does not return any data.
         # @param [Hash] opts
-        def _opts_formatter!(opts)
+        def assign_formatter!(opts)
           # check for already existing +formatter+
           return if opts[:formatter]
 
           opts[:formatter] = _resolve_formatter(opts)
 
-          # prevent to return any data
+          # prevent returning any data
           nil
         end
 
@@ -116,7 +104,7 @@ module RubySmart
           opts[:format] ||= :plain
 
           # fix nl - which depends on other opts
-          opts[:nl]  = _nl(opts)
+          opts[:nl] = _nl(opts)
 
           # fix clr
           opts[:clr] = true if opts[:clr].nil?
@@ -125,12 +113,17 @@ module RubySmart
         end
 
         # resolves & returns device from builtin & provided opts
-        # @param [Object] builtin
+        # @param [Object,nil] builtin
         # @param [Hash] opts
         def _resolve_device(builtin, opts)
+          # in case the provided *builtin* already responds to +write+, return it
+          return builtin if builtin.respond_to?(:write)
+
           case builtin
           when nil # builtin is nil - resolve optimal device for current environment
-            if ::ThreadInfo.stdout?
+            if opts.key?(:device)
+              _resolve_device(opts.delete(:device), opts)
+            elsif ::ThreadInfo.stdout?
               _resolve_device(:stdout, opts)
             elsif ::ThreadInfo.debugger?
               _resolve_device(:debugger, opts)
@@ -144,7 +137,13 @@ module RubySmart
           when :debugger
             raise "Unable to build SimpleLogger with 'debugger' builtin for not initialized Debugger!" unless ThreadInfo.debugger?
 
-            _resolve_device(::Debugger.logger, opts)
+            # since some IDEs did a Debase rewriting for Ruby 3.x, the logger is a Proc instead of a Logger instance
+            if ::Debugger.logger.is_a?(Proc)
+              opts[:format] = :plain # only the data string is forwarded to the proc
+              ::RubySmart::SimpleLogger::Devices::ProcDevice.new(::Debugger.logger)
+            else
+              _resolve_device(::Debugger.logger, opts)
+            end
           when :stdout
             STDOUT
           when :stderr
@@ -161,84 +160,103 @@ module RubySmart
               _resolve_device(::Rails.logger, opts)
             end
           when :proc
-            # force overwrite opts
-            @ignore_payload = true
-            opts[:nl]       = false
-            opts[:format]   = :passthrough
-
-            ::RubySmart::SimpleLogger::Devices::ProcDevice.new(opts.delete(:proc))
+            # slurp the proc and call the '_resolve_device' again
+            _resolve_device(opts.delete(:proc), opts)
           when :memory
             # force overwrite opts
-            @ignore_payload = true
-            opts[:format]   = :memory
+            opts[:payload] = false
+            opts[:format] = :memory
             # no color logging for memory devices
             opts[:clr] = false
 
             ::RubySmart::SimpleLogger::Devices::MemoryDevice.new
-          when Module, String
+          when Proc
             # force overwrite opts
-            opts[:clr] = false
-            _logdev(opts, builtin)
-          when ::Logger
-            builtin.instance_variable_get(:@logdev).dev
-          else
-            _logdev(opts, builtin)
-          end
-        end
-
-        # resolve the final log-device from provided param
-        # @param [Hash] opts
-        # @param [Object] device
-        # @return [:Logger::LogDevice]
-        def _logdev(opts, device = nil)
-          device ||= opts.delete(:device)
+            opts[:payload] = false
+            opts[:nl] = false
+            opts[:format] = :passthrough
 
-          # if existing device is already writeable, simply return it
-          return device if device.respond_to?(:write)
+            ::RubySmart::SimpleLogger::Devices::ProcDevice.new(builtin)
+          when Module
+            # no color logging for logfiles
+            opts[:clr] = false
 
-          file_location = nil
+            logfile = _underscore(builtin.to_s) + '.log'
 
-          # resolve the file_location from provided device
-          case device
-          when 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
+            file_location = if ::ThreadInfo.rails? # check for rails
+                              File.join(::Rails.root, 'log', logfile)
+                            else
+                              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)
 
-            # the logdev
-            file_location
+            # resolve new logdev with the provided options
+            _logdev(file_location, opts)
           when String
-            file_location = (device[0] == '/' ? device : "log/#{device}")
+            # no color logging for logfiles
+            opts[:clr] = false
+
+            logfile = if builtin[-4..-1] == '.log'
+                        builtin
+                      else
+                        builtin + '.log'
+                      end
+
+            file_location = if builtin[0] == '/'
+                              builtin
+                            elsif ::ThreadInfo.rails?
+                              File.join(Rails.root, 'log', logfile)
+                            else
+                              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
+            # resolve new logdev with the provided options
+            _logdev(file_location, opts)
+          when ::Logger
+            # resolve the logdev from the provided logger
+            builtin.instance_variable_get(:@logdev).dev
           else
-            raise "Unable to build SimpleLogger! The provided device '#{device}' must respond to 'write'!"
+            raise "Unable to build SimpleLogger! The provided device '#{builtin}' must respond to 'write'!"
           end
+        end
 
+        # Creates and configures a new instance of Logger::LogDevice based on the provided file location
+        # and optional settings.
+        #
+        # The configuration differs slightly based on the Ruby version being used. For Ruby versions
+        # prior to 2.7, the options `:binmode` is omitted as it is not supported. For Ruby 2.7 and newer,
+        # the `:binmode` option is included.
+        #
+        # @param [String] file_location - the file path where the log will be written.
+        # @param [Hash] opts
+        #   A hash of options to configure the log device:
+        #   - `:shift_age` (default: 0) - Specifies the number of old log files to retain.
+        #   - `:shift_size` (default: 1048576, 1MB) - Specifies the maximum size of the log file,
+        #     after which the file will be rotated.
+        #   - `:shift_period_suffix` - A string specifying the date format for rotated files (optional).
+        #   - `:binmode` (Ruby >= 2.7 only) - Enables binary mode explicitly if set to `true`.
+        #
+        # @return [Logger::LogDevice]
+        #   Returns a newly configured instance of Logger::LogDevice.
+        def _logdev(file_location, opts)
           if GemInfo.match?(RUBY_VERSION, '< 2.7')
             ::Logger::LogDevice.new(file_location,
-                                    shift_age:           opts[:shift_age] || 0,
-                                    shift_size:          opts[:shift_size] || 1048576,
+                                    shift_age: opts[:shift_age] || 0,
+                                    shift_size: opts[:shift_size] || 1048576,
                                     shift_period_suffix: opts[:shift_period_suffix])
           else
             ::Logger::LogDevice.new(file_location,
-                                    shift_age:           opts[:shift_age] || 0,
-                                    shift_size:          opts[:shift_size] || 1048576,
+                                    shift_age: opts[:shift_age] || 0,
+                                    shift_size: opts[:shift_size] || 1048576,
                                     shift_period_suffix: opts[:shift_period_suffix],
-                                    binmode:             opts[:binmode])
+                                    binmode: opts[:binmode])
           end
         end
 

data/lib/ruby_smart/simple_logger/gem_version.rb

@@ -9,8 +9,8 @@ module RubySmart
 
     module VERSION
       MAJOR = 1
-      MINOR = 5
-      TINY  = 3
+      MINOR = 6
+      TINY  = 0
       PRE   = nil
 
       STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/lib/ruby_smart/simple_logger/logger.rb

@@ -47,24 +47,44 @@ module RubySmart
       # @option args[Symbol,Array] <builtin> - provide a builtin, either a single symbol or array of symbols
       # @option args[Hash] <options> - provide custom options
       def initialize(*args)
+        # transform args to opts
         opts = args.last.is_a?(Hash) ? args.pop : {}
         opts[:builtin] = args if args.length > 0
 
-        # enhance options with device & formatter
-        _opts_device!(opts)
-        _opts_formatter!(opts)
+        # assign logdev to opts
+        assign_logdev!(opts)
 
-        # initialize & set defaults by provided opts
-        _opts_init!(opts)
+        # assign formatter to opts
+        assign_formatter!(opts)
+
+        # assign default opts
+        assign_defaults!(opts)
 
         # initialize with a nil +logdev+ to prevent any nested +LogDevice+ creation.
         # we already arranged device & formatter to be able to respond to ther required methods
         super(nil)
 
-        # set explicit after called super
+        # level must be set through the *_level* method, to prevent invalid values
         self.level = opts[:level]
+
+        # use the provided formatter
         self.formatter = opts[:formatter]
-        @logdev = _logdev(opts)
+
+        # ignore payload and send data directly to the logdev
+        @ignore_payload = true if opts[:payload] == false
+
+        # ignore processed logging and send data without 'leveling' & PCD-char to the logdev
+        @ignore_processed = true if opts[:processed] == false
+
+        # ignore tagged logging and send data without 'tags' to the logdev
+        @ignore_tagged = true if opts[:tagged] == false
+
+        # set custom inspector (used for data inspection)
+        # 'disable' inspector, if false was provided - which simply results in +#to_s+
+        @inspector = (opts[:inspect] == false) ? :to_s : opts[:inspector]
+
+        # set resolved logdev
+        @logdev = opts[:logdev]
       end
 
       # overwrite level setter, to accept every available (also newly defined) Severity

data/lib/ruby_smart/simple_logger/scenes.rb

@@ -85,9 +85,9 @@ module RubySmart
         # log level @ debug
         # prints: prettified subject
         #
-        # > ===========================================================================================================
-        # > ================================================ <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]
@@ -99,9 +99,9 @@ module RubySmart
         # log level @ debug
         # prints: prettified subject
         #
-        # > ===========================================================================================================
-        # > ================================================ >Subject< ================================================
-        # > ===========================================================================================================
+        # > ========================================================================================================================
+        # > ======================================================= >Subject< ======================================================
+        # > ========================================================================================================================
         base.scene :footer, { level: :debug, payload: [:mask, [:mask, ' >%{subject}< '], :mask] } do |subject, **opts|
           self.log nil, _scene_opts(:footer, subject: subject.to_s, **opts)
 
@@ -113,9 +113,9 @@ module RubySmart
         # log level @ debug
         # prints: prettified subject
         #
-        # > --------------------------------------------------------------------------------
-        # > #----------------------------------- Subject ----------------------------------#
-        # > --------------------------------------------------------------------------------
+        # > -----------------------------------------------------------------------------------------------
+        # > #------------------------------------------ Subject ------------------------------------------#
+        # > -----------------------------------------------------------------------------------------------
         base.scene :topic, { level: :debug, mask: { char: '-', length: 95, clr: :blueish }, payload: [:mask, [:mask, '%{title}'], :mask] } do |subject, **opts|
           opts         = _scene_opts(:topic, **opts)
           txt          = " #{subject} ".center(opts[:mask][:length] - 2, opts[:mask][:char])
@@ -129,7 +129,7 @@ module RubySmart
         # 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_opts(:theme, subject: subject.to_s, **opts)
         end
@@ -138,7 +138,7 @@ module RubySmart
         # 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|
@@ -149,7 +149,7 @@ module RubySmart
         # 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_opts(:theme_line, **opts)
         end
@@ -170,7 +170,7 @@ module RubySmart
         # calls the result method if a block was provided
         #
         # > - Job name                                                         =>
-        #     ________________________________________________________________ <- 64 chars
+        #     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ <- 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_opts(:job, name: name, **opts)
           self.result(*block.call) if block
@@ -182,7 +182,7 @@ module RubySmart
         # calls the result method if a block was provided
         #
         # >   * Subjob name                                                    =>
-        #       ______________________________________________________________ <- 62 chars
+        #       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ <- 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_opts(:sub_job, name: name, **opts)
           self.result(*block.call) if block
@@ -331,6 +331,7 @@ module RubySmart
                          end
           rescue => e
             self.fatal("#{e.message} @ #{e.backtrace_locations&.first}") unless opts[:silent]
+
             # reraise exception
             raise
           ensure

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby_smart-simple_logger
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.6.0
 platform: ruby
 authors:
 - Tobias Gonsior
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_smart-support
@@ -175,7 +174,6 @@ metadata:
   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
@@ -190,8 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A simple, multifunctional logging library for Ruby (and Rails).
 test_files: []