loba 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd37694b2e7fc3a573237e959410b0bb388e4b4873f16ebb75724c8b3c2db359
-  data.tar.gz: c26f5ea9b333bf0bef43d19f0cd139aebe88420eb800daa344b363361fc05a05
+  metadata.gz: 6d53014bd42826b2fee7d16d06ce19a345522ecfd3eb105b5b286f1bd5348e13
+  data.tar.gz: 2d6258dd046d5899469ebdba37606cc4da74b35ae027e87151d237bf83050137
 SHA512:
-  metadata.gz: 5529034ea281db641c3105b0aba812de2b7d05933816f690a9f3cade786b9a6b7c42004ce5567ec767902538f817a17fb976c8a0f20e72ce9842f8ef53b7c4d3
-  data.tar.gz: cfcff516d957181281939ed46af92027d2c673dd6b9035a421fda4c04118c8e7d47300727cbab8230b6fef93e8ec23c368f689244e843bb87dccf20e85791b85
+  metadata.gz: 9c109e14fdbf2d6a6271e92f640cf11a214d92e434938509e8f2ad015a2c6286798b22c1cced8defce4f588394e078e098cc4fa4ef3db5ea07f6a3f21f58141c
+  data.tar.gz: 797fef5afe7e868135070abbd950c6981cdcb63720d0891aa377d62f3086b885c0dfdf9d62a5776ef0034e1ad591f4e05c7b042c73392ce2c85f18a6c8bb4d0f

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and, as of version 0.3.0 and later, this project adheres to [Semantic Versioning
 
 ## [Unreleased]
 
+## [2.1.0] - 2024-09-09
+### Added
+- Added `logger` option for accepting a logger to write to instead of default behavior
+- Added `logdev` option to direct logging in non-Rails environments
+- Added `out` option to allow turning off console (`puts`) output
+
+### Changed
+- Changed so `log` option will allow logging in non-Rails environments
+- Changed so `log` option will be defaulted to `true` when `out` options is set to `false`
+- Updated documentation for new and changed options and to improve completeness
+- Refreshed gems and dependencies
+
 ## [2.0.0] - 2023-07-07
 ### Added
 - `Loba.ts`: `log` option to allow logging to Rails.logger (ignored if unavailable)
@@ -15,7 +27,7 @@ and, as of version 0.3.0 and later, this project adheres to [Semantic Versioning
 
 ### Changed
 - Dropped support for Ruby prior to 3.0.6
-- Changed output to always write to STDOUT (regardless whether Rails is present)
+- Changed output to always write to `$stdout` (regardless whether Rails is present)
 - Changed to only write to Rails.logger (when present) when `log` option is set to `true`
 - Updated YARD documentation for improved completeness
 - Refreshed gems and dependencies
@@ -92,7 +104,8 @@ and, as of version 0.3.0 and later, this project adheres to [Semantic Versioning
 ### Added
 - Initial implementation
 
-[Unreleased]: https://github.com/rdnewman/loba/compare/v2.0.0...HEAD
+[Unreleased]: https://github.com/rdnewman/loba/compare/v2.1.0...HEAD
+[2.1.0]: https://github.com/rdnewman/loba/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/rdnewman/loba/compare/v1.2.1...v2.0.0
 [1.2.1]: https://github.com/rdnewman/loba/compare/v1.2.0...v1.2.1
 [1.2.0]: https://github.com/rdnewman/loba/compare/v1.1.0...v1.2.0

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2021 Richard Newman
+Copyright (c) 2015-2023 Richard Newman
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -7,7 +7,7 @@
 
 ![Loba is "write" in Zulu](readme/zulu.png)
 
-Easy tracing for debugging: handy methods for adding trace lines to output or Rails logs.
+Easy tracing for debugging: handy methods for adding trace lines to output (or logs).
 
 (Installation is pretty much what you'd expect for a gem, but read Environment Notes below first.)
 
@@ -20,19 +20,19 @@ There are two kinds of questions I usually want to answer when trying to diagnos
 
 Loba statements are intended to be terse to minimize typing.
 
-Loba statements are intended to be minimally invasive and atomic. They should not have any (much) more impact than regular `puts` or `Rails.logger.debug` statements.
+Loba statements are intended to be minimally invasive and atomic. They should have negligible impact over regular `puts` or logging statements.
 
 Loba statements are expected to be removed when you're done with them. No point in cluttering up production code.
 
-Loba will always write to STDOUT (i.e., `puts`).
+Loba will generally always write to `$stdout` (i.e., `puts`). In addition to `$stdout`, Loba can also be made to write to a log (:debug). Writing to `$stdout` can be overridden.
 
-Loba will work equally well with or without Rails. If Rails is present, in addition to STDOUT, Loba will also always write to `Rails.logger.debug`.
+Loba will work equally well with or without Rails. If Rails is present and writing to a log is wanted, it will use the Rails log (e.g., `Rails.logger.debug`).
 
 Loba uses the [rainbow gem](https://rubygems.org/gems/rainbow) to help make trace statements more visible.
 
 ## Usage
 
-My advice is to align Loba statements to the far left in your source code (a la `=begin` or `=end`) so they're easy to see and remove when you're done.
+Aligning Loba statements to the far left in your source code (a la `=begin` or `=end`) will make them easier to see and remove when you're done. You may though find this somewhat annoying to do if your editor auto-indents.
 
 #### Timestamp notices:  `Loba.ts`
 
@@ -56,7 +56,7 @@ You can read [more detail](readme/ts.md) on this command.
 
 #### Variable or method return inspection:  `Loba.val`
 
-Inserts line to Rails.logger.debug (or to STDOUT if Rails.logger not available) showing value with method and class identification
+Writes line to `$stdout` (or optionally to a log, `logger.debug`) showing value with method and class identification.
 
 ```ruby
 Loba.val :var_sym   # the :var_sym argument is the variable or method name given as a symbol
@@ -70,6 +70,16 @@ For example,
 
 You can read [more detail](readme/val.md) on this command.
 
+#### Output and logging options
+
+There are several options to control where Loba writes its output:
+* `out`: controls whether `puts` to `$stdout` occurs (default: `true`)
+* `log`: controls whether logging occurs (default: `false`)
+* `logger`: controls which logger is used
+* `logdev`: in non-Rails environments, another way to direct where logging occurs
+
+You can read [more detail](readme/log.md) about how to use these options.
+
 #### Snippet example
 
 ```ruby
@@ -107,14 +117,14 @@ The expectation is that Loba statements are just for development or test trace s
 
 `Loba.ts` and `Loba.val` try to protect against timestamp or value notice requests being accidentally left in the code by checking for the Rails environment Loba is being invoked under. If in production, `Loba.ts` and `Loba.val` will normally just return immediately without attempting to render anything to help minimize any impact on production code.
 
-However, that behavior can be overridden by using the options hash with `:production => true` as an additional last argument to output a notice even when in the production environment. Note also behavior of the `log` option which defaults to `false` (introduced in v2.0.0). In general, enabling in production should be avoided. We're consenting adults.
+However, that behavior can be overridden by using the option `production: true` as an additional argument to output a notice even when in the production environment. Note also behavior of the `log` option, which defaults to `false` (introduced in v2.0.0). In general, enabling in production should not be done, but we're consenting adults.
 
-WARNING: this gem depends on the [binding_of_caller gem](https://rubygems.org/gems/binding_of_caller) -- use `:production => true` with their warning in mind:
+WARNING: this gem depends on the [binding_of_caller gem](https://rubygems.org/gems/binding_of_caller) -- use `production: true` with their warning in mind:
 > **Recommended for use only in debugging situations. Do not use this in production apps.**
 
-These considerations also have an impact on how you install the Loba gem when using `bundler`. If you only install the gem for :development and :test, then any Loba statements left in the code when it goes to production will cause an error because the statements wouldn't be recognized. That's usually a Good Thing, if you never want them left in.
+These considerations also have an impact on how you install the Loba gem when using `bundler`. If you only install the gem for `:development` and `:test`, then any Loba statements left in the code when it goes to production will cause an error because the statements wouldn't be recognized. That can be a good thing if you never want them left in.
 
-If you simply install the gem for all environments, then Loba will be available in production, but you may not notice as easily if some Loba calls are unintentionally left in. Of course, if you want those statements to work in production, then you should install the gem for all environments.
+If you simply install the gem for all environments, then Loba will be available in production, but you may not notice as easily if some Loba calls are unintentionally left in. Of course, if you want Loba statements to possibly work in production, then you should install the gem for all environments.
 
 The following is the code example snippet but always logging even in Rails production environments:
 
@@ -122,12 +132,12 @@ The following is the code example snippet but always logging even in Rails produ
 class HelloWorld
   def initialize
     @x = 42
-Loba.ts production: true
+Loba.ts log: true, production: true
     @y = "Charlie"
   end
 
   def hello
-Loba.val :@x, production: true
+Loba.val :@x, log: true, production: true
     puts "Hello, #{@y}" if @x == 42
 Loba.ts true
   end
@@ -162,7 +172,7 @@ gem 'loba', require: false
 And then execute:
 
 ```bash
-bundle
+bundle install
 ```
 
 ## Development

data/SECURITY.md

@@ -11,7 +11,8 @@ additional information.
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 2.x.x   | :white_check_mark: |
+| 2.1.x   | :white_check_mark: |
+| 2.0.x   | :white_check_mark: |
 | < 2.0   | :x:                |
 
 ## Reporting a Vulnerability

data/lib/loba/error.rb

@@ -0,0 +1,18 @@
+module Loba
+  # Errors raised by Loba are subclasses of +Loba::Error+.
+  # Rescue this class to rescue any Loba-specific errors.
+  # @api private
+  class Error < StandardError; end
+
+  # Error raised with an invalid logdev is specified
+  # @api private
+  class InvalidLogdevOptionError < Error; end
+
+  # Error raised with an invalid logger is specified
+  # @api private
+  class InvalidLoggerOptionError < Error; end
+
+  # Error raised with an invalid target for #puts is specified
+  # @api private
+  class InvalidOutOptionError < Error; end
+end

data/lib/loba/internal/platform/formatter.rb

@@ -0,0 +1,43 @@
+require 'logger'
+require 'English'
+
+module Loba
+  module Internal
+    module Platform
+      # Custom logging formatter (for when Rails is not involved)
+      class Formatter
+        # Formats supplied message to write to logger.
+        #
+        # This formatter ignores +severity+, +time+, and +progname+ because it enforces
+        # that Loba messages are written out to the log without additional ornamentation.
+        #
+        # @param message [String] Loba content to write out
+        # @return [String] message formatted for writing to log
+        def call(_severity, _time, _progname, message)
+          "#{format(message)}#{$INPUT_RECORD_SEPARATOR}"
+        end
+
+        private
+
+        def format(message)
+          case message
+          when ::String
+            message
+          when ::Exception
+            format_exception(message)
+          else
+            message.inspect
+          end
+        end
+
+        def format_exception(err)
+          backtrace = err.backtrace
+          result = "#{err.message} (#{err.class})"
+          return result if backtrace.to_s.empty?
+
+          result + "\n#{backtrace}"
+        end
+      end
+    end
+  end
+end

data/lib/loba/internal/platform/within_rails.rb

@@ -0,0 +1,22 @@
+module Loba
+  module Internal
+    module Platform
+      # Internal module for considering Rails
+      module WithinRails
+        # Determines if Rails has its logger defined (generally +true+)
+        # @return [boolean] +true+ if +Rails.logger+ is defined
+        def logger?
+          Internal.boolean_cast(defined?(Rails)) && Internal.boolean_cast(Rails.logger)
+        end
+        module_function :logger?
+
+        # Determines if Rails is running in a production environment
+        # @return [boolean] +true+ if +Rails.env+ is +:production+
+        def production?
+          Internal.boolean_cast(defined?(Rails)) && Rails.env.production?
+        end
+        module_function :production?
+      end
+    end
+  end
+end

data/lib/loba/internal/platform.rb

@@ -1,44 +1,25 @@
+require_relative 'platform/formatter'
+require_relative 'platform/within_rails'
+
 module Loba
   module Internal
-    # Internal class for managing logging across Rails and non-Rails applications
-    class Platform
+    # Internal module for managing output and logging across Rails and non-Rails applications
+    module Platform
       class << self
-        # Checks if Rails is present
-        # @return [Boolean] true if Rails appears to be available; otherwise, false
-        def rails?
-          defined?(Rails) ? true : false
-        end
-
-        # Checks if logging output is permitted.
-        # @return [Boolean] true if logging is to be allowed; otherwise, false
-        def logging_ok?(force_true = false)
-          return true if force_true
-          return true unless rails?
-
-          begin
-            !Rails.env.production?
-          rescue StandardError
-            true # let it attempt to log anyway
-          end
-        end
-
-        # Provides logging mechanism appropriate in the application.
+        # Provides mechanism for appropriate console output and logging.
+        #
+        # @note To avoid doubled output, if a non-Rails logger is to be logged to and +logdev+ is
+        #   set to +$stdout+, then output will be suppressed (i.e., +settings.out+ is +false+).
+        #   Doubled output can still occur; in that case, explicitly use +out: false+.
         #
-        # Returned lambda takes 2 arguments:
-        #   * arg [String] value to be output (and potentially logged)
-        #   * force_log [Boolean] when false (default), never logs to Rails.logger;
-        #       when true, logs to Rails.logger if present
-        # @return [Lambda] procedure for logging output
-        def logger
-          if rails? && Rails.logger.present?
-            lambda do |arg, force_log = false|
-              puts arg
-              return unless force_log
+        # @param settings [::Loba::Internal::Settings] settings for output control
+        # @return [lambda {|message| ...}] procedure for presenting output. Takes one argument,
+        #   +message+ (String), for the output to be written
+        def writer(settings:)
+          lambda do |message|
+            puts(message) if settings.out?
 
-              Rails.logger.debug arg
-            end
-          else
-            ->(arg, _force_log = false) { puts arg }
+            settings.logger.debug { message } if settings.log?
           end
         end
       end

data/lib/loba/internal/settings.rb

@@ -0,0 +1,143 @@
+module Loba
+  module Internal
+    # Internal class for tracking output and logging settings based on supplied options
+    class Settings
+      # @return [boolean] whether logging is performed
+      attr_reader :log
+      alias log? log
+
+      # @return [Logger] +::Logger+ used for logging; may be +nil+ if not logging
+      attr_reader :logger
+
+      # @return [nil, String, IO, File::NULL]
+      #   any custom (overridden) logging device being written to; +nil+ if none specified
+      attr_reader :logdev
+
+      # @return [boolean] +false+ if console output is suppressed; otherwise, +true+
+      attr_reader :out
+      alias out? out
+
+      # @return [boolean]
+      #   +true+ if Loba is enabled even within a Rails production environment; otherwise, +false+
+      attr_reader :production
+      alias production? production
+
+      # @param log [boolean]
+      #   set to +false+ if no logging is ever wanted
+      #   (default when not in Rails and +logger+ is nil);
+      #   set to +true+ if logging is always wanted (default when in Rails or
+      #   when +logger+ is set or +out+ is false);
+      # @param logger [Logger] override logging with specified Ruby Logger
+      # @param logdev [nil, String, IO, File::NULL]
+      #   custom log device to use (when not in Rails); ignored if +logger+ is set;
+      #   must be filename or IO object
+      # @param out [boolean]
+      #   set to +false+ if console output is to be suppressed
+      # @param production [boolean]
+      #   set to +true+ if Loba is to work even within a Rails production environment
+      # @note To avoid doubled output, if a non-Rails logger is to be logged to and +logdev+ is
+      #   set to +$stdout+, then output will be suppressed (i.e., +settings.out+ is +false+).
+      #   Doubled output can still occur; in that case, explicitly use +out: false+.
+      # @raise [InvalidLoggerOptionError] when an invalid logger is specified
+      # @raise [InvalidLogdevOptionError] when an invalid logdev is specified
+      def initialize(log: nil, logger: nil, logdev: nil, out: true, production: false)
+        @raw_log_argument = log
+        @log = validated_log(log)
+        @out = false
+        @production = validated_production(production)
+
+        return unless enabled?
+
+        @logger = validated_logger(logger)
+        @logdev = validated_logdev(logdev)
+        @out = validated_out(out)
+
+        configure_logging
+      end
+
+      # @return [Boolean] +true+ if Loba is used; otherwise, +false+
+      def enabled?
+        production? || !Internal::Platform::WithinRails.production?
+      end
+
+      # @return [Boolean] +true+ if Loba is skipped (because of a production environment);
+      #   otherwise, +false+
+      def disabled?
+        !enabled?
+      end
+
+      private
+
+      attr_reader :raw_log_argument
+
+      def validated_log(candidate_log)
+        Internal.boolean_cast(candidate_log)
+      end
+
+      def validated_logger(candidate_logger)
+        return if candidate_logger.nil?
+        raise InvalidLoggerOptionError unless candidate_logger.is_a?(::Logger)
+
+        @log = true unless log_explicit?
+
+        candidate_logger
+      end
+
+      def validated_logdev(candidate_logdev)
+        case candidate_logdev
+        when nil, String, IO, StringIO, File::NULL
+          candidate_logdev
+        else
+          raise InvalidLogdevOptionError
+        end
+      end
+
+      def validated_out(candidate_out)
+        will_output = !logging_to_stdout? && out_param_cast(candidate_out)
+
+        @log = true unless will_output || log_explicit?
+
+        will_output
+      end
+
+      def validated_production(candidate_production)
+        Internal.boolean_cast(candidate_production)
+      end
+
+      def log_explicit?
+        !raw_log_argument.nil?
+      end
+
+      def logging_to_stdout?
+        log? && ((logdev == $stdout) || (logdev == '$stdout'))
+      end
+
+      def configure_logging
+        @log &&= enabled?
+
+        @logger ||= default_logger if log?
+      end
+
+      def default_logger
+        if Internal::Platform::WithinRails.logger?
+          ::Rails.logger
+        else
+          ::Logger.new((logdev || $stdout), formatter: Internal::Platform::Formatter.new)
+        end
+      end
+
+      def out_param_cast(value)
+        case value
+        when true, TrueClass
+          true
+        when nil, false, FalseClass, File::NULL
+          false
+        when String, Integer, IO, StringIO
+          Internal.boolean_cast(value)
+        else
+          raise InvalidOutOptionError
+        end
+      end
+    end
+  end
+end

data/lib/loba/internal/time_keeper.rb

@@ -15,9 +15,9 @@ module Loba
         reset!
       end
 
-      # Increments timestamping, including attributes `timenum` and `timewas`
+      # Increments timestamping, including attributes +timenum+ and +timewas+
       # @return [Hash] timestamp details
-      #   * :number => [Integer] incremented count of pings so far (attribute `timenum`)
+      #   * :number => [Integer] incremented count of pings so far (attribute +timenum+)
       #   * :now => [Time] current date and time
       #   * :change => [Float] difference in seconds from any previous ping or reset
       def ping

data/lib/loba/internal/value/value_helper.rb

@@ -30,7 +30,7 @@ module Loba
         # @param argument [Symbol, Object] the value or variable for which information is
         #   to be retrieved
         # @param inspect [Boolean] when true, force #inspect to be called against
-        #   `argument` when evaluating
+        #   +argument+ when evaluating
         # @param depth [Integer] depth in call stack to start evaluation from
         # @return [String] value representation of argument for display
         def value(argument:, inspect: true, depth: 0)
@@ -46,7 +46,7 @@ module Loba
 
         # Builds a label for display based on the argument when instantiated.
         # If the argument (when instantiated) is not a symbol, it may not be possible
-        # to infer a label; in that case, '[unknown value]' is returned.
+        # to infer a label; in that case, "[unknown value]"" is returned.
         #
         # @param argument [Symbol, Object] the value or variable for which information is
         #   to be retrieved
@@ -73,8 +73,8 @@ module Loba
         # Evaluate an arguments value from where it's bound.
         # @param argument [Symbol, Object] the value or variable for which information is
         #   to be retrieved
-        # @param inspect [Boolean] when true, force #inspect to be called against
-        #   `argument` when evaluating
+        # @param inspect [Boolean] when true, force +#inspect+ to be called against
+        #   +argument+ when evaluating
         # @param depth [Integer] depth in call stack to start evaluation from
         # @return [Object] value of the argument when Loba was invoked
         def evaluate(argument:, inspect: true, depth: 0)

data/lib/loba/internal/value.rb

@@ -16,8 +16,8 @@ module Loba
       #     and a label should be supplied when instantiated.
       # @param label [String] when provided, an explicit label to use; will override any
       #   possible inferred label
-      # @param inspect [Boolean] when true, force #inspect to be called against
-      #   `argument` when evaluating
+      # @param inspect [Boolean] when true, force +#inspect+ to be called against
+      #   +argument+ when evaluating
       # @param depth_offset [Integer] depth in call stack to start evaluation from
       #
       # @return [Hash] various detail about the value being analyzed
@@ -25,7 +25,7 @@ module Loba
       #   * :line => [String] code line reference
       #   * :value => [String] value of argument (if nil, '-nil-' is returned)
       #   * :label => [String] label, ending with ":"
-      #     (if not possible to infer, '[unknown value]' is returned)
+      #     (if not possible to infer, "[unknown value]" is returned)
       def phrases(argument:, label: nil, inspect: true, depth_offset: 0)
         depth = depth_offset.nil? ? 0 : depth_offset.to_i
         {

data/lib/loba/internal.rb

@@ -1,4 +1,5 @@
 require_relative 'internal/platform'
+require_relative 'internal/settings'
 require_relative 'internal/time_keeper'
 require_relative 'internal/value'
 
@@ -24,5 +25,31 @@ module Loba
       content[1...-1]
     end
     module_function :unquote
+
+    # Canonical set of values interpreted to be false.
+    # Adapted from Rails's ActiveModule::Type::Boolean (2024)
+    FALSE_VALUES = [
+      false, 0, nil, '',
+      '0', :'0',
+      'f', :f,
+      'F', :F,
+      'false', :false, # rubocop:disable Lint/BooleanSymbol
+      'FALSE', :FALSE,
+      'off', :off,
+      'OFF', :OFF
+    ].to_set.freeze
+    private_constant :FALSE_VALUES
+
+    # Casts any value to true or false (boolean)
+    #
+    # @param value [Object] the value to cast
+    #
+    # @return [true, false]
+    def boolean_cast(value)
+      return false if value.respond_to?(:empty) && value.empty?
+
+      !FALSE_VALUES.include?(value)
+    end
+    module_function :boolean_cast
   end
 end

data/lib/loba/timestamp.rb

@@ -0,0 +1,80 @@
+module Loba # rubocop:disable Style/Documentation
+  # Outputs a timestamped notice, useful for quick traces to see the code path.
+  # Also does a simple elapsed time check since the previous timestamp notice to
+  # help with quick, minimalist profiling.
+  # @param production [boolean]
+  #   set to +true+ if this timestamp notice is to be recorded
+  #   when running in a Rails production environment
+  # @param log [boolean]
+  #   set to +false+ if no logging is ever wanted
+  #   (default when not in Rails and +logger+ is nil);
+  #   set to +true+ if logging is always wanted (default when in Rails or
+  #   when +logger+ is set or +out+ is false);
+  # @param logger [Logger] override logging with specified Ruby Logger
+  # @param logdev [nil, String, IO, File::NULL]
+  #   custom log device to use (when not in Rails); ignored if +logger+ is set;
+  #   must be filename or IO object
+  # @param out [boolean]
+  #   set to +false+ if console output is to be suppressed
+  # @return [NilClass] nil
+  # @example Basic use
+  #   def hello
+  #     Loba.timestamp
+  #   end
+  #   #=> [TIMESTAMP] #=0001, diff=0.000463, at=1451615389.505411, in=/path/to/file.rb:2:in 'hello'
+  # @example Forced to output when in production environment
+  #   def hello
+  #     Loba.ts production: true # Loba.ts is a shorthand alias for Loba.timestamp
+  #   end
+  #   #=> [TIMESTAMP] #=0001, diff=0.000463, at=1451615389.505411, in=/path/to/file.rb:2:in 'hello'
+  # @example Forced to output to log in addition to $stdout
+  #   def hello
+  #     Loba.timestamp log: true
+  #   end
+  #   #=> [TIMESTAMP] #=0001, diff=0.000463, at=1451615389.505411, in=/path/to/file.rb:2:in 'hello'
+  # @note To avoid doubled output, if a non-Rails logger is to be logged to and +logdev+ is
+  #   set to +$stdout+, then output will be suppressed (i.e., +settings.out+ is +false+).
+  #   Doubled output can still occur; in that case, explicitly use +out: false+.
+  def timestamp( # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    production: false,
+    log: false,
+    logger: nil,
+    logdev: nil,
+    out: true
+  )
+    settings = Internal::Settings.new(
+      log: log, logger: logger, logdev: logdev, out: out, production: production
+    )
+
+    return unless settings.enabled?
+
+    # NOTE: while tempting, memoizing loba_logger can lead to surprises if
+    #   Rails presence isn't constant
+    writer = Internal::Platform.writer(settings: settings)
+
+    begin
+      stats = Internal::TimeKeeper.instance.ping
+      writer.call(
+        # 60: light_black / grey
+        "#{Rainbow('[TIMESTAMP]').black.bg(60)}" \
+        "#{Rainbow(' #=').yellow.bg(:default)}" \
+        "#{format('%04d', stats[:number])}" \
+        "#{Rainbow(', diff=').yellow}" \
+        "#{format('%.6f', stats[:change])}" \
+        "#{Rainbow(', at=').yellow}" \
+        "#{format('%.6f', stats[:now].round(6).to_f)}" \
+        "#{Rainbow("    \t(in #{caller(1..1).first})").color(60)}" # warning: nested interpolation
+      )
+    rescue StandardError => e
+      writer.call Rainbow("[TIMESTAMP] #=FAIL, in=#{caller(1..1).first}, err=#{e}").red
+    end
+
+    nil
+  end
+  module_function :timestamp
+
+  # Shorthand alias for Loba.timestamp.
+  # @!method ts(production: false, log: false, logger: nil, logdev: nil, out: true)
+  alias ts timestamp
+  module_function :ts
+end

data/lib/loba/value.rb

@@ -0,0 +1,104 @@
+module Loba # rubocop:disable Style/Documentation
+  # Outputs a value notice showing value of provided argument including method and
+  # class identification.
+  # @param argument [various] (required) the value to be evaluated and shown; if given as
+  #   a +Symbol+, a label based on the argument will proceed the value the argument refers to
+  # @param label [String] explicit label to be used instead of attempting
+  #   to infer from the argument; default is to attempt to infer a label from the argument
+  # @param inspect [boolean] +true+ if this value notice is to use +#inspect+ against the
+  #   content being evaluated; otherwise, +false+
+  # @param production [boolean]
+  #   set to +true+ if the value notice is to be recorded
+  #   when running in a Rails production environment
+  # @param log [boolean]
+  #   set to +false+ if no logging is ever wanted
+  #   (default when not in Rails and +logger+ is nil);
+  #   set to +true+ if logging is always wanted (default when in Rails or
+  #   when +logger+ is set or +out+ is false);
+  # @param logger [Logger] override logging with specified Ruby Logger
+  # @param logdev [nil, String, IO, File::NULL]
+  #   custom log device to use (when not in Rails); ignored if +logger+ is set;
+  #   must be filename or IO object
+  # @param out [boolean]
+  #   set to +false+ if console output is to be suppressed
+  # @return [NilClass] nil
+  # @example Using Symbol as argument
+  #   class HelloWorld
+  #     def hello(name)
+  #   Loba.value :name # putting Loba statement to far left helps remember to remove later
+  #       puts "Hello, #{name}!"
+  #     end
+  #   end
+  #   HelloWorld.new.hello("Charlie")
+  #   #=> [HelloWorld#hello] name: Charlie        (at /path/to/file/hello_world.rb:3:in 'hello')
+  #   #=> Hello, Charlie!
+  # @example Using non-Symbol as argument
+  #   class HelloWorld
+  #     def hello(name)
+  #   Loba.val name # Loba.val is a shorthand alias for Loba.value
+  #       puts "Hello, #{name}!"
+  #     end
+  #   end
+  #   HelloWorld.new.hello("Charlie")
+  #   #=> [HelloWorld#hello] Charlie        (at /path/to/file/hello_world.rb:3:in 'hello')
+  #   #=> Hello, Charlie!
+  # @example Using non-Symbol as argument with a label
+  #   class HelloWorld
+  #     def hello(name)
+  #   Loba.value name, "Name:"
+  #       puts "Hello, #{name}!"
+  #     end
+  #   end
+  #   HelloWorld.new.hello("Charlie")
+  #   #=> [HelloWorld#hello] Name: Charlie        (at /path/to/file/hello_world.rb:3:in 'hello')
+  #   #=> Hello, Charlie!
+  # @note To avoid doubled output, if a non-Rails logger is to be logged to and +logdev+ is
+  #   set to +$stdout+, then output will be suppressed (i.e., +settings.out+ is +false+).
+  #   Doubled output can still occur; in that case, explicitly use +out: false+.
+  def value( # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/ParameterLists
+    argument,
+    label: nil,
+    inspect: true,
+    production: false,
+    log: false,
+    logger: nil,
+    logdev: nil,
+    out: true
+  )
+    settings = Internal::Settings.new(
+      log: log, logger: logger, logdev: logdev, out: out, production: production
+    )
+
+    return unless settings.enabled?
+
+    text = Internal::Value.phrases(
+      argument: (argument.nil? ? :nil : argument),
+      label: label,
+      inspect: inspect,
+      depth_offset: 1
+    )
+
+    Internal::Platform.writer(settings: settings).call(
+      # NOTE: while tempting, memoizing Internal::Platform.logger can lead to surprises
+      #   if Rails presence isn't constant
+      #
+      # warning: nested interpolation below (slight help to performance)
+      # 60: light_black
+      # 62: light_green
+      "#{Rainbow("#{text[:tag]} ").green.bg(:default)}" \
+      "#{Rainbow("#{text[:label]} ").color(62)}" \
+      "#{text[:value]}" \
+      "#{Rainbow("    \t(in #{text[:line]})").color(60)}"
+    )
+
+    nil
+  end
+  module_function :value
+
+  # rubocop:disable Layout/LineLength
+  # Shorthand alias for Loba.value.
+  # @!method val(argument, label: nil, inspect: true, production: false, log: false, logger: nil, logdev:nil, out: true)
+  alias val value
+  module_function :val
+  # rubocop:enable Layout/LineLength
+end

data/lib/loba/version.rb

@@ -1,4 +1,4 @@
 module Loba
   # Semantic version number
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/lib/loba.rb

@@ -1,143 +1,14 @@
 require 'loba/version'
+require 'loba/error'
 require 'loba/internal'
 
 require 'binding_of_caller'
 require 'rainbow'
 
+require 'loba/timestamp'
+require 'loba/value'
+
 # Loba module for quick tracing of Ruby and Rails.
-# If a Rails application, will use Rails.logger.debug.
-# If not a Rails application, will use STDOUT.
+# Will write to $stdout (generally) and, optionally, a log.
 module Loba
-  # Outputs a timestamped notice, useful for quick traces to see the code path.
-  # Also does a simple elapsed time check since the previous timestamp notice to
-  # help with quick, minimalist profiling.
-  # @param production [Boolean] set to true if this timestamp notice is
-  #   to be recorded when running in :production environment
-  # @param log [Boolean] when false, will not write to Rails.logger if present;
-  #   when true, will write to Rails.logger if present
-  # @return [NilClass] nil
-  # @example Basic use
-  #   def hello
-  #     Loba.timestamp
-  #   end
-  #   #=> [TIMESTAMP] #=0001, diff=0.000463, at=1451615389.505411, in=/path/to/file.rb:2:in 'hello'
-  # @example Forced to output when in production environment
-  #   def hello
-  #     Loba.ts production: true # Loba.ts is a shorthand alias for Loba.timestamp
-  #   end
-  #   #=> [TIMESTAMP] #=0001, diff=0.000463, at=1451615389.505411, in=/path/to/file.rb:2:in 'hello'
-  # @example Forced to output to log (if Rails.logger present) in addition to $STDOUT
-  #   def hello
-  #     Loba.timestamp log: true
-  #   end
-  #   #=> [TIMESTAMP] #=0001, diff=0.000463, at=1451615389.505411, in=/path/to/file.rb:2:in 'hello'
-  def timestamp(production: false, log: false) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    return unless Internal::Platform.logging_ok?(production)
-
-    # NOTE: while tempting, memoizing loba_logger can lead to surprises if
-    #   Rails presence isn't constant
-    loba_logger = Internal::Platform.logger
-
-    begin
-      stats = Internal::TimeKeeper.instance.ping
-      loba_logger.call(
-        # 60: light_black / grey
-        "#{Rainbow('[TIMESTAMP]').black.bg(60)}" \
-        "#{Rainbow(' #=').yellow.bg(:default)}" \
-        "#{format('%04d', stats[:number])}" \
-        "#{Rainbow(', diff=').yellow}" \
-        "#{format('%.6f', stats[:change])}" \
-        "#{Rainbow(', at=').yellow}" \
-        "#{format('%.6f', stats[:now].round(6).to_f)}" \
-        "#{Rainbow("    \t(in #{caller(1..1).first})").color(60)}", # warning: nested interpolation
-        !!log
-      )
-    rescue StandardError => e
-      loba_logger.call Rainbow("[TIMESTAMP] #=FAIL, in=#{caller(1..1).first}, err=#{e}").red
-    end
-
-    nil
-  end
-  module_function :timestamp
-
-  # Shorthand alias for Loba.timestamp.
-  # @!method ts(production: false, log: false)
-  alias ts timestamp
-  module_function :ts
-
-  # Outputs a value notice showing value of provided argument including method and
-  # class identification.
-  # @param argument [various] (required) the value to be evaluated and shown; if given as
-  #   a Symbol, a label based on the argument will proceed the value the argument refers to
-  # @param label [String] explicit label to be used instead of attempting
-  #   to infer from the argument; default is to attempt to infer a label from the argument
-  # @param inspect [Boolean] true if this value notice is to use #inspect against the
-  #   content being evaluated; otherwise, false
-  # @param production [Boolean] set to true if this timestamp notice is
-  #   to be recorded when running in :production environment
-  # @param log [Boolean] when false, will not write to Rails.logger if present;
-  #   when true, will write to Rails.logger if present
-  # @return [NilClass] nil
-  # @example Using Symbol as argument
-  #   class HelloWorld
-  #     def hello(name)
-  #   Loba.value :name # putting Loba statement to far left helps remember to remove later
-  #       puts "Hello, #{name}!"
-  #     end
-  #   end
-  #   HelloWorld.new.hello("Charlie")
-  #   #=> [HelloWorld#hello] name: Charlie        (at /path/to/file/hello_world.rb:3:in `hello')
-  #   #=> Hello, Charlie!
-  # @example Using non-Symbol as argument
-  #   class HelloWorld
-  #     def hello(name)
-  #   Loba.val name # Loba.val is a shorthand alias for Loba.value
-  #       puts "Hello, #{name}!"
-  #     end
-  #   end
-  #   HelloWorld.new.hello("Charlie")
-  #   #=> [HelloWorld#hello] Charlie        (at /path/to/file/hello_world.rb:3:in `hello')
-  #   #=> Hello, Charlie!
-  # @example Using non-Symbol as argument with a label
-  #   class HelloWorld
-  #     def hello(name)
-  #   Loba.value name, "Name:"
-  #       puts "Hello, #{name}!"
-  #     end
-  #   end
-  #   HelloWorld.new.hello("Charlie")
-  #   #=> [HelloWorld#hello] Name: Charlie        (at /path/to/file/hello_world.rb:3:in `hello')
-  #   #=> Hello, Charlie!
-  def value(argument, label: nil, inspect: true, production: false, log: false) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    return nil unless Internal::Platform.logging_ok?(production)
-
-    text = Internal::Value.phrases(
-      argument: (argument.nil? ? :nil : argument),
-      label: label,
-      inspect: inspect,
-      depth_offset: 1
-    )
-
-    Internal::Platform.logger.call(
-      # NOTE: while tempting, memoizing Internal::Platform.logger can lead to surprises
-      #   if Rails presence isn't constant
-      #
-      # warning: nested interpolation below (slight help to performance)
-      # 60: light_black
-      # 62: light_green
-      "#{Rainbow("#{text[:tag]} ").green.bg(:default)}" \
-      "#{Rainbow("#{text[:label]} ").color(62)}" \
-      "#{text[:value]}" \
-      "#{Rainbow("    \t(in #{text[:line]})").color(60)}",
-      !!log
-    )
-
-    nil
-  end
-  module_function :value
-
-  # Shorthand alias for Loba.value.
-  # @!method val(argument, label: nil, inspect: true, production: false, log: false)
-  alias val value
-  module_function :val
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loba
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Richard Newman
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-09 00:00:00.000000000 Z
+date: 2024-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -51,11 +51,17 @@ files:
 - README.md
 - SECURITY.md
 - lib/loba.rb
+- lib/loba/error.rb
 - lib/loba/internal.rb
 - lib/loba/internal/platform.rb
+- lib/loba/internal/platform/formatter.rb
+- lib/loba/internal/platform/within_rails.rb
+- lib/loba/internal/settings.rb
 - lib/loba/internal/time_keeper.rb
 - lib/loba/internal/value.rb
 - lib/loba/internal/value/value_helper.rb
+- lib/loba/timestamp.rb
+- lib/loba/value.rb
 - lib/loba/version.rb
 homepage: https://github.com/rdnewman/loba
 licenses:
@@ -66,7 +72,7 @@ metadata:
   changelog_uri: https://github.com/rdnewman/loba/blob/main/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/loba
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: 'Loba: Easy tracing for debugging.'
 test_files: []