ruby_smart-simple_logger 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 101c7a9ab2862c9ff3e7ace74f812a20a522dfa7fa8c6fcdf9f9accc53fd29e2
-  data.tar.gz: 1e1f7d6e1c9cbfe48a21cc8cceaa7cd37de7712363ae78e80bcff87aa6c5ca5a
+  metadata.gz: 499ca8f400db9b2df6a9e3017fece6c7e2b94c32c72feb2d04c3a7013a946c4e
+  data.tar.gz: f684b602ec79afe45e2cebf5b158eacfab127cd1af7e9aee994a7ec824b0f802
 SHA512:
-  metadata.gz: 875fc9ea64929088e6a445f43b1e3a0c7b1c92de106a53c8112c68a3eb28ab5ea081c2a1e21d7d672d7e3109c68e68a83283be41364d65b2c450b6932408e15a
-  data.tar.gz: 9be8b0019a5afb3b3a9050dcb6139d9cf2ffe9fbd89549ebb717e8e4a2b59ee981dad95948400836a78e8b8205a324dbd2a35dea6638567143e37cbc93425e32
+  metadata.gz: aa7911b6005d56ffc56585674bd90ff47f07bb0e632b08447c52e4f4222996ca52d783ab44fcae057b034b2920f0b7e0e5cb044be66a7c79be4dcb1ff18abcc6
+  data.tar.gz: 9f1ae4aed0ca7965cbe57d24223a7283915cf7ab876a467945da7269ea6bb66f292704f7e48400a260542eb5b35dc0898b277c5ad338443e459a529e9f5bebf5

data/README.md

@@ -9,7 +9,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/ruby-smart/simple_logger/badge.svg?branch=main&kill_cache=1)](https://coveralls.io/github/ruby-smart/simple_logger?branch=main)
 [![Tests](https://github.com/ruby-smart/simple_logger/actions/workflows/ruby.yml/badge.svg)](https://github.com/ruby-smart/simple_logger/actions/workflows/ruby.yml)
 
-A simple, multifunctional logging library for Ruby.
+A simple, multifunctional logging library for Ruby (and Rails).
 It features a fast, customizable logging with multi-device support (e.g. log to STDOUT AND file).
 Special (PRE-defined) scenes can be used for interactive CLI and better logging visibility.
 
@@ -36,7 +36,7 @@ Or install it yourself as:
 ## Enhancements
 * PRE-defined scenes to fastly create a simple, structured CLI output. _(see [Scenes](#scenes))_
 * Better log-visibility with masked output through scenes
-* ```awesome_print``` gem compatibility for a prettified object debug
+* `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))_
 
@@ -198,10 +198,11 @@ While you can just build a new logger _(or use the klass_logger)_ without any ar
 
 ### nil Builtin
 
-A ```nil``` builtin will auto-detect the best logging solution for you.
-For CLI or windowed programs it'll just send the logs to ```STDOUT```.
-For rails-applications it'll send to the current ```Rails.logger``` instance.
-Otherwise it'll store logs temporary in memory _(accessible through the #logs method)_
+A `nil` builtin will auto-detect the best logging solution for you:
+* For CLI or windowed programs it'll just send the logs to `STDOUT`.
+* For Debugging _(e.g. IDE-related debugging gems)_ it'll send the logs to the `Debugger`.
+* For rails-applications it'll send to the current `Rails.logger` instance.
+* Otherwise it'll store logs temporary in memory _(accessible through the #logs method)_
 
 **Example:**
 ```ruby
@@ -211,7 +212,7 @@ logger.debug "some debug"
 
 ### stdout / stderr Builtin
 
-A ```:stdout / :stderr``` builtin will send to ```STDOUT / STDERR``` and uses a colored output by default.
+A `:stdout / :stderr` builtin will send to `STDOUT / STDERR` and uses a colored output by default.
 
 **Example:**
 ```ruby
@@ -224,9 +225,34 @@ logger = ::SimpleLogger.new(:stdout)
 logger.debug "some debug"
 ```
 
+### debugger Builtin
+
+A `:debugger` builtin will send to the `Debugger` (e.g. your IDE's debugging gem)
+
+**Example:**
+```ruby
+logger = ::SimpleLogger.new(:debugger)
+
+# > will be shown within your debugging gem
+logger.debug "some debug"
+```
+
+
+### null Builtin
+
+A `:null` builtin will silently swallow all logging data (so it will not be send).
+
+**Example:**
+```ruby
+logger = ::SimpleLogger.new(:null)
+
+# >
+logger.debug "some debug"
+```
+
 ### rails Builtin
 
-A ```:rails``` builtin will always send to the ```Rails.logger``` instance.
+A `:rails` builtin will always send to the `Rails.logger` instance.
 
 **Example:**
 ```ruby
@@ -238,9 +264,9 @@ logger.debug "some debug"
 
 ### proc Builtin
 
-A ```:proc``` builtin will call the provided proc _(through ```options[:proc]```)_ everytime a log will be written.
+A `:proc` builtin will call the provided proc _(through `options[:proc]```)_ everytime a log will be written.
 
-The data will be provided as array _( ```[severity, time, progname, data]``` )_.
+The data will be provided as array _( `[severity, time, progname, data]` )_.
 
 **Example:**
 ```ruby
@@ -255,7 +281,7 @@ logger.debug "some debug"
 
 ### memory Builtin
 
-A ```:memory``` builtin will always store the logged data within an _instance variable_ and can be accessed through the ```#logs``` or ```#logs_to_h``` methods.
+A `:memory` builtin will always store the logged data within an _instance variable_ and can be accessed through the `#logs` or `#logs_to_h` methods.
 
 **Example:**
 ```ruby
@@ -276,7 +302,7 @@ logger.logs
 
 ### String Builtin
 
-Providing a ```String``` will always create and write to a new logfile.
+Providing a `String` will always create and write to a new logfile.
 
 **Example:**
 ```ruby
@@ -313,7 +339,7 @@ noformat_logger.debug "some debug without color and mask - uses the default form
 
 ### Module Builtin
 
-Providing a ```module``` will also create and write to a new logfile.
+Providing a `module` will also create and write to a new logfile.
 The path depends on the provided module name.
 
 **Example:**
@@ -331,13 +357,13 @@ logger.debug "some debug"
 
 ### other Builtin
 
-Providing any other Object must respond to ```#write```.
+Providing any other Object must respond to `#write```.
 
 -----
 
 ## Formats
 
-The default formatter _(if no other was provided through ```opts[:formatter```)_ will provide the following PRE-defined formats:
+The default formatter _(if no other was provided through `opts[:formatter```)_ will provide the following PRE-defined formats:
 _Also prints a colored output by default._
 
 ### default Format
@@ -447,7 +473,7 @@ logger = ::SimpleLogger.new(:stdout, payload: false)
 ### format
 
 Provide a other format.
-Possible values: ```:default, :passthrough, :plain, :memory, :datalog```
+Possible values: `:default, :passthrough, :plain, :memory, :datalog```
 ```ruby
 logger = ::SimpleLogger.new(format: :default)
 logger = ::SimpleLogger.new(:memory, format: :passthrough)
@@ -465,7 +491,7 @@ logger.debug "debug 2"
 
 ### proc _(:proc-builtin ONLY)_
 
-Provide a callback for the ```:proc``` builtin.
+Provide a callback for the `:proc` builtin.
 ```ruby
 logger = ::SimpleLogger.new(:proc, proc: lambda{|data| ... })
 ```
@@ -528,7 +554,7 @@ logger.debug({a: {custom: 'object'}})
 
 ### inspector
 
-Provide a other ```inspector``` method for the data-debug.
+Provide a other `inspector` method for the data-debug.
 
 ```ruby
 logger = ::SimpleLogger.new(inspector: :to_s)
@@ -541,13 +567,13 @@ logger.debug({ a: 1, b: 2 })
 
 ## _defaults_
 
-Device default options are still available: ```shift_age, shift_size, progname, datetime_format, shift_period_suffix, binmode```
+Device default options are still available: `shift_age, shift_size, progname, datetime_format, shift_period_suffix, binmode```
 
 -----
 
 ## Scenes
 
-The following PRE-defined scenes are available. _(You can define your own scenes by using the class method ```.scene```)_
+The following PRE-defined scenes are available. _(You can define your own scenes by using the class method `.scene```)_
 
 ### debug(data, subject = 'Debug')
 ```ruby
@@ -768,6 +794,7 @@ end
 - line
 - print
 - nl
+- model _(rails only)_
 
 -----
 
@@ -784,7 +811,7 @@ This project is intended to be a safe, welcoming space for collaboration, and co
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-A copy of the [LICENSE](docs/LICENSE.txt) can be found @ the docs.
+A copy of the [LICENSE](LICENSE.txt) can be found @ the docs.
 
 ## Code of Conduct
 

data/docs/CHANGELOG.md

@@ -1,5 +1,15 @@
 # RubySmart::SimpleLogger - CHANGELOG
 
+## [1.4.0] - 2024-07-31
+* **[add]** 'null'-device / builtin
+* **[add]** 'debugger'-builtin to send logs to the debugging gem
+* **[add]** new logging method `model` _(for rails applications only)_
+* **[ref]** `nil`-builtin to detect `Debugger` after checking for stdout
+* **[ref]** `mask`-length to 120 _(was 100 by default)_
+* **[ref]** `ruby_smart-support`-gem dependency to 1.5
+* **[fix]** exception _(to build a new device)_ if a Logger was provided
+* **[fix]** mask-reference manipulation on inherited classes
+
 ## [1.3.0] - 2023-08-15
 * **[add]** exception message within `processed`-scene
 * **[add]** new logging option `tag`, to prefix a log-string with a [TAG]

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

@@ -4,7 +4,6 @@ module RubySmart
   module SimpleLogger
     module Devices
       class MemoryDevice
-
         attr_reader :logs
         attr_reader :status
 

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RubySmart
+  module SimpleLogger
+    module Devices
+      class NullDevice
+        attr_reader :status
+
+        def initialize
+          @status = true
+        end
+
+        def write(*)
+          nil
+        end
+
+        alias_method :<<, :write
+
+        # disables writing
+        def close
+          @status = false
+        end
+
+        # enables writing
+        def reopen
+          @status = true
+        end
+
+        # clears all logs
+        def clear!
+          nil
+        end
+
+        # returns logs
+        # @return [Array] logs
+        def logs
+          []
+        end
+      end
+    end
+  end
+end

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

@@ -132,11 +132,19 @@ module RubySmart
           when nil # builtin is nil - resolve optimal device for current environment
             if ::ThreadInfo.stdout?
               _resolve_device(:stdout, opts)
+            elsif ::ThreadInfo.debugger?
+              _resolve_device(:debugger, opts)
             elsif ::ThreadInfo.rails? && ::Rails.logger
               _resolve_device(:rails, opts)
             else
               _resolve_device(:memory, opts)
             end
+          when :null
+            ::RubySmart::SimpleLogger::Devices::NullDevice.new
+          when :debugger
+            raise "Unable to build SimpleLogger with 'debugger' builtin for not initialized Debugger!" unless ThreadInfo.debugger?
+
+            _resolve_device(::Debugger.logger, opts)
           when :stdout
             STDOUT
           when :stderr
@@ -148,9 +156,9 @@ module RubySmart
             if ThreadInfo.console? && ::Rails.logger.instance_variable_get(:@logdev).dev != STDOUT
               ::RubySmart::SimpleLogger::Devices::MultiDevice
                 .register(_resolve_device(:stdout, opts))
-                .register(::Rails.logger.instance_variable_get(:@logdev).dev)
+                .register(_resolve_device(::Rails.logger, opts))
             else
-              ::Rails.logger.instance_variable_get(:@logdev).dev
+              _resolve_device(::Rails.logger, opts)
             end
           when :proc
             # force overwrite opts
@@ -171,6 +179,8 @@ module RubySmart
             # force overwrite opts
             opts[:clr] = false
             _logdev(opts, builtin)
+          when ::Logger
+            builtin.instance_variable_get(:@logdev).dev
           else
             _logdev(opts, builtin)
           end

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

@@ -13,17 +13,25 @@ module RubySmart
             # @option [String] :char - the character to be used as mask
             # @option [Integer] :length - the mask length (amount of mask chars be line)
             # @option [Symbol] :clr - the color to be used by printing the mask
-            self.mask = { char: '=', length: 100, clr: :blue }
+            self.mask = { char: '=', length: 120, clr: :blue }
           end
         end
 
         module ClassMethods
           def mask
-            class_variable_get('@@mask')
+            @mask
           end
 
           def mask=(mask)
-            class_variable_set('@@mask', mask)
+            @mask = mask
+          end
+
+          # prevents to overwrite parent class through inheriting subclasses
+          def inherited(subclass)
+            super
+
+            # dup existing values
+            subclass.mask = self.mask.dup
           end
         end
 

data/lib/ruby_smart/simple_logger/gem_version.rb

@@ -9,7 +9,7 @@ module RubySmart
 
     module VERSION
       MAJOR = 1
-      MINOR = 3
+      MINOR = 4
       TINY  = 0
       PRE   = nil
 

data/lib/ruby_smart/simple_logger/logger.rb

@@ -11,6 +11,7 @@ require_relative 'extensions/timer'
 
 require_relative 'devices/memory_device'
 require_relative 'devices/multi_device'
+require_relative 'devices/null_device'
 require_relative 'devices/proc_device'
 
 require_relative 'formatter'

data/lib/ruby_smart/simple_logger/scenes.rb

@@ -47,7 +47,7 @@ module RubySmart
         # > ================================================ [Error] =================================================
         # > DATA
         # > ==========================================================================================================
-        base.scene :error, { level: :error, mask: { clr: :red }, payload: [[:mask, ' [%{subject}] '], :__data__, :mask] } do |data,*args|
+        base.scene :error, { level: :error, mask: { clr: :red }, payload: [[:mask, ' [%{subject}] '], :__data__, :mask] } do |data, *args|
           subject, opts = _scene_subject_with_opts(args, 'Error')
           self.log data, _scene_opt(:error, { subject: subject }, opts)
         end
@@ -353,6 +353,32 @@ module RubySmart
 
           true
         end
+
+        # model method
+        # log level @ error/success/info
+        # prints: ActiveRecord::Base related data, depending on the models "save" state (also shows possible errors)
+        base.scene :model do |model, opts = {}|
+          # build model-logging string
+          mdl_string = "#{model.id.present? ? "##{model.id} - " : ''}#{model.to_s[0..49]}"
+
+          # resolve model's status
+          status = ((model.persisted? && model.errors.empty?) ? (model.previous_changes.blank? ? :skipped : :success) : :error)
+
+          # switch between status
+          case status
+          when :success
+            # show verbose logging for updated records
+            if opts[:verbose] != false && !model.previously_new_record?
+              log(:success, "#{mdl_string} (#{model.previous_changes.inspect})", tag: "#{model.class.name.upcase}|UPDATED")
+            else
+              log(:success, mdl_string, tag: "#{model.class.name.upcase}|#{(model.previously_new_record? ? 'CREATED' : 'UPDATED')}")
+            end
+          when :error
+            log(:error, "#{mdl_string} (#{model.errors.full_messages.join(', ').presence || '-'})", tag: "#{model.class.name.upcase}|ERROR")
+          else
+            log(:info, mdl_string, tag: "#{model.class.name.upcase}|#{status}")
+          end
+        end
       end
     end
   end

data/ruby_smart-simple_logger.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors     = ['Tobias Gonsior']
   spec.email       = ['info@ruby-smart.org']
 
-  spec.summary               = "A simple, multifunctional logging library for Ruby."
+  spec.summary               = "A simple, multifunctional logging library for Ruby (and Rails)."
   spec.description = <<~DESC
     RubySmart::SimpleLogger is a fast, customizable logging library with multi-device support, 
     special (PRE-defined) scenes for better logging visibility.
@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'ruby_smart-support', '~> 1.2'
+  spec.add_dependency 'ruby_smart-support', '~> 1.5'
 
   spec.add_development_dependency 'awesome_print', '~> 1.9'
   spec.add_development_dependency 'coveralls_reborn', '~> 0.25'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_smart-simple_logger
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Tobias Gonsior
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-14 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_smart-support
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -135,19 +135,20 @@ files:
 - ".rspec"
 - ".yardopts"
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - docs/CHANGELOG.md
 - docs/CODE_OF_CONDUCT.md
-- docs/LICENSE.txt
 - lib/ruby_smart-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/null_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
@@ -189,8 +190,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.14
 signing_key: 
 specification_version: 4
-summary: A simple, multifunctional logging library for Ruby.
+summary: A simple, multifunctional logging library for Ruby (and Rails).
 test_files: []