object_inspector 0.10.0 → 1.1.0

data/lib/object_inspector.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# ObjectInspector is the base namespace for all modules/classes related to the
+# Defines the base namespace for all modules/classes used by the
 # object_inspector gem.
 module ObjectInspector
   # Accessor for the {ObjectInspector::Configuration} object.
@@ -11,6 +11,8 @@ module ObjectInspector
   # @yieldparam configuration [ObjectInspector::Configuration]
   def self.configure
     yield(configuration)
+
+    configuration
   end
 
   # Reset the current configuration settings memoized by
@@ -19,11 +21,11 @@ module ObjectInspector
     @configuration = Configuration.new
   end
 
+  # :reek:TooManyInstanceVariables, :reek:TooManyMethods
+
   # ObjectInspector::Configuration stores the default configuration options for
   # the ObjectInspector gem. Modification of attributes is possible at any time,
   # and values will persist for the duration of the running process.
-  #
-  # :reek:TooManyInstanceVariables
   class Configuration
     attr_reader :formatter_class,
                 :inspect_method_prefix,
@@ -36,17 +38,59 @@ module ObjectInspector
                 :issues_separator,
                 :info_separator
 
-    def initialize
-      @formatter_class = TemplatingFormatter
-      @inspect_method_prefix = "inspect"
-      @default_scope = Scope.new(:self)
-      @wild_card_scope = "all"
-      @out_of_scope_placeholder = "*"
-      @presented_object_separator = " #{[0x21E8].pack("U")} "
-      @name_separator = " - "
-      @flags_separator = " / "
-      @issues_separator = " | "
-      @info_separator = " | "
+    # :reek:LongParameterList, :reek:BooleanParameter
+    def initialize( # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+      enabled: true,
+      formatter_class: TemplatingFormatter,
+      inspect_method_prefix: "inspect",
+      default_scope: Scope.new(:self),
+      wild_card_scope: "all",
+      out_of_scope_placeholder: "*",
+      presented_object_separator: " #{[0x21E8].pack("U")} ", # This is: " ⇨ "
+      name_separator: " - ",
+      flags_separator: " / ",
+      issues_separator: " | ",
+      info_separator: " | "
+    )
+      @enabled = enabled
+      @formatter_class = formatter_class
+      @inspect_method_prefix = inspect_method_prefix
+      @default_scope = default_scope
+      @wild_card_scope = wild_card_scope
+      @out_of_scope_placeholder = out_of_scope_placeholder
+      @presented_object_separator = presented_object_separator
+      @name_separator = name_separator
+      @flags_separator = flags_separator
+      @issues_separator = issues_separator
+      @info_separator = info_separator
+    end
+
+    # @param value [Object] Coerced to a Boolean with `!!value`.
+    def enabled=(value)
+      @enabled = !!value
+    end
+
+    # Toggles between {#enable} and {#disable} based on {#enabled?}.
+    def toggle = enabled? ? disable : enable
+
+    # @return [Boolean]
+    def enabled? = @enabled
+
+    # Enable Object Inspector for the current process and print a status
+    # message to `$stdout`.
+    def enable
+      self.enabled = true
+      puts(" -> ObjectInspector enabled")
+    end
+
+    # @return [Boolean]
+    def disabled? = !enabled?
+
+    # Disable Object Inspector for the current process and print a status
+    # message to `$stdout`.
+    def disable
+      self.enabled = false
+      puts(" -> ObjectInspector disabled")
     end
 
     def formatter_class=(value)
@@ -99,8 +143,8 @@ require "object_inspector/version"
 require "object_inspector/conversions"
 require "object_inspector/inspector"
 require "object_inspector/scope"
-require "object_inspector/inspectors_helper"
-require "object_inspector/object_interrogator"
+require "object_inspector/inspect_behaviors"
+require "object_inspector/interrogate_object"
 require "object_inspector/formatters/base_formatter"
 require "object_inspector/formatters/combining_formatter"
 require "object_inspector/formatters/templating_formatter"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: object_inspector
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Paul DobbinSchmaltz
 bindir: exe
 cert_chain: []
-date: 2025-04-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -67,7 +67,7 @@ dependencies:
         version: '0'
 description: Object Inspector takes Object#inspect to the next level. Specify any
   combination of identification attributes, flags, issues, info, and/or a name along
-  with an optional, self-definable scope option to represents objects. Great for the
+  with an optional, self-definable scope option to represent objects. Great for the
   console, logging, etc.
 email:
 - p.dobbinschmaltz@icloud.com
@@ -82,9 +82,9 @@ files:
 - lib/object_inspector/formatters/base_formatter.rb
 - lib/object_inspector/formatters/combining_formatter.rb
 - lib/object_inspector/formatters/templating_formatter.rb
+- lib/object_inspector/inspect_behaviors.rb
 - lib/object_inspector/inspector.rb
-- lib/object_inspector/inspectors_helper.rb
-- lib/object_inspector/object_interrogator.rb
+- lib/object_inspector/interrogate_object.rb
 - lib/object_inspector/scope.rb
 - lib/object_inspector/version.rb
 homepage: https://github.com/pdobb/object_inspector
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Object Inspector builds uniformly formatted inspect output with customizable
   amounts of detail.

data/lib/object_inspector/inspectors_helper.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-# ObjectInspector::InspectorsHelper can be included into any object to
-# simplify the process of instantiating an ObjectInspector::Inspector and
-# generating the inspection output.
-module ObjectInspector::InspectorsHelper
-  # Calls {ObjectInspector::Inspector.inspect} on the passed in `object`,
-  # passing through any keyword arguments.
-  #
-  # @return [String]
-  def inspect(object = self, **)
-    ObjectInspector::Inspector.inspect(object, **)
-  end
-
-  # Like {#inspect} but forces scope to `:all`. This (the bang (!) version) is
-  # considered the "more dangerous" version of {#inspect} in the sense that the
-  # `:all` scope may result in additional queries or extra processing--depending
-  # on how the inspect hooks are setup.
-  #
-  # @return [String]
-  def inspect!(object = self, **)
-    ObjectInspector::Inspector.inspect(object, **, scope: :all)
-  end
-end