sleeping_king_studios-tools 1.3.0.rc.1 → 1.3.0.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4939601ed132d3b370114ce53c547e220277c715eb1d442dc20566049f041bea
-  data.tar.gz: f5cf620154ef2245749693dc5da447adb6fc0e2644bf3aa1094d289881a32338
+  metadata.gz: 6b3b28222878c3e3bf364e7467ca85e76b4ba8c40e86b1062169d2943ab9a181
+  data.tar.gz: 31cbc80f6c696aebbb9f5ed955852424bda57b03ec65a4f37bdcd969fa6825d5
 SHA512:
-  metadata.gz: 0da898a1ae8bd177700cbd6d3736fe171a534ad2f9b7e3c934f9e033c4b61136e4996dc8d375c98706a83b4ef573531901a3fa4de830a29fc3bff6c39f251307
-  data.tar.gz: 050d5c3e8ae855129dc5aa0d426038bda2bd43706282c3b89e418e56d69973781d9996002168e15bcdc29ae0acd387494dc260402351058d76400c0ee4ace564
+  metadata.gz: e14d9a823ebbd1a3eb8cf4e00ae298bfbedfa1fd797b19b493b0187a6b5f128c6f2d08e05101a39619ea51755fb321798b27af6d8741b1cdea2695a2a8d4f204
+  data.tar.gz: b26b0693f575e15c0c1a91b97eae350d677f73fa6c7426b4b77b92537a6e988fa52c52f68e0a88a210fad78d617cdb298b663c0cae3fd20992aed7017e3c1145

data/CHANGELOG.md

@@ -62,6 +62,8 @@ Added `#[]` support to `ObjectTools#dig`, allowing access through indexed data s
 
 Added `ObjectTools#fetch`, which tries to find the requested value via the named method call or by calling `#[]`.
 
+Added `ObjectTools#format_inspect`, which generates a `String` representation of the object (similar to the built-in `Object#inspect`) with support for `BasicObject`s and for customizing the displayed properties.
+
 Deprecated methods with native equivalents:
 
 - Deprecated `#eigenclass` - use `Object#singleton_class` instead.

data/lib/sleeping_king_studios/tools/object_tools.rb

@@ -5,6 +5,9 @@ require 'sleeping_king_studios/tools'
 module SleepingKingStudios::Tools
   # Low-level tools for working with objects.
   class ObjectTools < SleepingKingStudios::Tools::Base # rubocop:disable Metrics/ClassLength
+    MEMORY_ADDRESS_PATTERN = /#<[:\w]+:(?'address'0x\h+)/
+    private_constant :MEMORY_ADDRESS_PATTERN
+
     TEMPORARY_METHOD_NAME =
       '__sleeping_king_studios_tools_apply_%i__'
     private_constant :TEMPORARY_METHOD_NAME
@@ -283,6 +286,39 @@ module SleepingKingStudios::Tools
       end
     end
 
+    # Creates a string representation of the object and specified properties.
+    #
+    # The string representation resembles the output of Object#inspect, but with
+    # support for BasicObjects and greater customization of the displayed
+    # properties.
+    #
+    # @param obj [BasicObject] the object to inspect.
+    # @param address [true, false] if true, includes the formatted memory
+    #   address from Object#inspect. Defaults to true.
+    # @param properties [Array, Hash] the properties to display. If the given
+    #   properties are an Array, maps the values to instance variables or public
+    #   methods based on the property name.
+    #
+    # @return [String] the string representation of the object.
+    def format_inspect(obj, address: true, properties: {}) # rubocop:disable Metrics/MethodLength
+      str = "#<#{class_name(obj)}"
+
+      if address
+        native  = Object.instance_method(:inspect).bind(obj).call
+        address = MEMORY_ADDRESS_PATTERN.match(native)&.[](:address)
+
+        str << ':' << address
+      end
+
+      if properties.is_a?(Hash)
+        format_properties_hash(str, **properties)
+      elsif properties.is_a?(Enumerable)
+        format_properties_array(str, obj, *properties)
+      end
+
+      str << '>'
+    end
+
     # Checks if the object is immutable.
     #
     # - nil, false, and true are always immutable, as are instances of Numeric
@@ -417,6 +453,17 @@ module SleepingKingStudios::Tools
 
     private
 
+    def class_name(obj)
+      klass =
+        if object?(obj)
+          obj.class
+        else
+          Object.instance_method(:class).bind(obj).call
+        end
+
+      klass.name || klass.inspect
+    end
+
     def fetch_array(ary, index, default = UNDEFINED, &)
       return toolbelt.array_tools.fetch(ary, index, &) if default == UNDEFINED
 
@@ -431,6 +478,45 @@ module SleepingKingStudios::Tools
       toolbelt.hash_tools.fetch(hsh, key, default, indifferent_key:, &)
     end
 
+    def format_properties_array(buf, obj, *properties)
+      properties.each do |property|
+        property_name = property.to_s
+
+        value = get_object_property(obj, property_name)
+
+        buf << ' ' << property_name << '=' << value
+      end
+    end
+
+    def format_properties_hash(buf, **properties)
+      properties.each do |property, value|
+        property_name = property.to_s
+
+        buf << ' ' << property_name << '=' << value.inspect
+      end
+    end
+
+    def get_instance_variable(obj, property_name)
+      return obj.instance_variable_get(property_name) if object?(obj)
+
+      Object
+        .instance_method(:instance_variable_get)
+        .bind(obj)
+        .call(property_name)
+    end
+
+    def get_object_property(obj, property_name)
+      if property_name.start_with?('@')
+        return 'undefined' unless has_instance_variable?(obj, property_name)
+
+        get_instance_variable(obj, property_name).inspect
+      else
+        return 'undefined' unless respond_to_method?(obj, property_name)
+
+        obj.__send__(property_name).inspect
+      end
+    end
+
     def handle_invalid_fetch(obj, key, default, &block)
       return block.call(key) if block_given?
 
@@ -443,6 +529,15 @@ module SleepingKingStudios::Tools
       raise NoMethodError, message
     end
 
+    def has_instance_variable?(obj, property_name) # rubocop:disable Naming/PredicatePrefix
+      return obj.instance_variable_defined?(property_name) if object?(obj)
+
+      Object
+        .instance_method(:instance_variable_defined?)
+        .bind(obj)
+        .call(property_name)
+    end
+
     def indifferent_get(object, key)
       case key
       when String
@@ -462,6 +557,15 @@ module SleepingKingStudios::Tools
       object.respond_to?(maybe_method_name)
     end
 
+    def respond_to_method?(obj, method_name)
+      return obj.respond_to?(method_name) if object?(obj)
+
+      Object
+        .instance_method(:respond_to?)
+        .bind(obj)
+        .call(method_name)
+    end
+
     def with_temporary_method(receiver, method_name, proc)
       metaclass = class << receiver; self; end
       metaclass.send :define_method, method_name, &proc

data/lib/sleeping_king_studios/tools/toolbox/heritable_data.rb

@@ -129,25 +129,18 @@ module SleepingKingStudios::Tools::Toolbox
       # @return [Class, nil] the parent data class.
       attr_reader :parent_class
 
-      private
-
-      def each_ancestor
-        return enum_for(:each_ancestor) unless block_given?
+      # Iterates over the ::HeritableMethods modules for parent classes.
+      def each_heritable_module
+        return enum_for(:each_heritable_module) unless block_given?
 
-        ancestor = parent_class
+        ancestor = self
 
         while ancestor
-          yield ancestor::HeritableMethods
+          yield ancestor
 
-          ancestor = ancestor::HeritableMethods.parent_class
+          ancestor = ancestor.parent_class&.then { |mod| mod::HeritableMethods }
         end
       end
-
-      def included(other)
-        super
-
-        each_ancestor { |ancestor| other.include(ancestor) }
-      end
     end
 
     class << self
@@ -174,7 +167,7 @@ module SleepingKingStudios::Tools::Toolbox
           HeritableData::HeritableMethods.new(parent_class:, &)
         )
 
-        data_class.include(data_class::HeritableMethods)
+        data_class.include(*data_class::HeritableMethods.each_heritable_module)
       end
 
       def included(other)

data/lib/sleeping_king_studios/tools/version.rb

@@ -15,7 +15,7 @@ module SleepingKingStudios
       # Prerelease version.
       PRERELEASE = :rc
       # Build metadata.
-      BUILD = 1
+      BUILD = 2
 
       class << self
         # Generates the gem version string from the Version constants.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sleeping_king_studios-tools
 version: !ruby/object:Gem::Version
-  version: 1.3.0.rc.1
+  version: 1.3.0.rc.2
 platform: ruby
 authors:
 - Rob "Merlin" Smith