foobara-util 1.0.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10d3c0d79a87e3a7a92abf69915f5835b4973e43de6eca90e9bdcdb91f1f0838
-  data.tar.gz: 9458bdc26b15ec704e49163621acabab67f59fa6f4cb64d531183d1c58e2523b
+  metadata.gz: 773e6de381b5e09f00f4145f882cca6a35ff48c04905275ec102aad86bdaab8b
+  data.tar.gz: 16092889c533865713a4ea719c9027d00b6ff3eb78e195086ccd7c5d38939e18
 SHA512:
-  metadata.gz: 26fea39e3fedef82f906e526bd5fd52bb744ced65b6099d912ad60a69a0b2803527b00315de7a2477554c1d51d2c95841b04ad890d21b3d1ffd1f222b3f78e8d
-  data.tar.gz: 716bdb5a05215ec218f0edfef4e64c6e7bc792fce8854eed3c301244a1d15d21d2a06f835eb73abdf9342445ef0ea2a70f7eec75ec6f092ce34f277a377a6033
+  metadata.gz: '06831ffb45e2c36640f50825c1ae4367b776154a87c770d0bb94ffc5eab2b879263ae3b73b421af5f118607a7151a7bb12991510ef37d4f4a6777b89661297a2'
+  data.tar.gz: b80cf394837039df4790b159f19039e6023e701c2c0705c87a355fbee9f6b0a52e35975eec53045867132a60f0162a0e6e5187ec3764fe94fe2e650b81f00995

data/CHANGELOG.md

@@ -1,7 +1,15 @@
+## [1.0.9] - 2026-09-22
+
+- Don't load "foobara/util/object_space" by default
+
+## [1.0.8] - 2026-01-22
+
+- Add .sort_by_keys/.sort_by_keys! for hashes
+
 ## [1.0.7] - 2025-12-19
 
 - Fix bug where .all_symbolic_keys? would return true for a hash with a string key
-- Handle situations where Hash subclass or non-Hash are passed to .symbolize_keys
+- Handle situations where Hash subclass or non-Hash are passed to .symbolize_keys and .symbolize_keys!
 
 ## [1.0.6] - 2025-12-14
 

data/lib/foobara/truncated_inspect.rb

@@ -52,7 +52,7 @@ module Foobara
 
         instance_vars = instance_vars.join(", ")
 
-        result = "#<#{self.class.name}:0x#{object_id.to_s(16)} #{instance_vars}>"
+        result = "#<#{self.class.name}:0x#{__id__.to_s(16)} #{instance_vars}>"
 
         if result.size > MAX_LENGTH
           result = "#{result[0..(MAX_LENGTH - 5)]}...>"

data/lib/foobara/util/args.rb

@@ -4,15 +4,15 @@ module Foobara
 
     def args_and_opts_to_opts(args, opts)
       unless args.is_a?(::Array)
-        # :nocov:
+        # simplecov:disable
         raise ArgumentError, "args must be an array of 0 or 1 hashes but received #{args}"
-        # :nocov:
+        # simplecov:enable
       end
 
       unless opts.is_a?(::Hash)
-        # :nocov:
+        # simplecov:disable
         raise ArgumentError, "opts must be a hash not a #{opts.class}"
-        # :nocov:
+        # simplecov:enable
       end
 
       case args.size
@@ -23,9 +23,9 @@ module Foobara
 
         if opts && !opts.empty?
           unless arg.is_a?(::Hash)
-            # :nocov:
+            # simplecov:disable
             raise ArgumentError, "opts must be a hash not a #{arg.class}"
-            # :nocov:
+            # simplecov:enable
           end
 
           arg.merge(opts)
@@ -33,9 +33,9 @@ module Foobara
           arg
         end
       else
-        # :nocov:
+        # simplecov:disable
         raise ArgumentError, "args must be an array of 0 or 1 hashes but received #{args}"
-        # :nocov:
+        # simplecov:enable
       end
     end
 
@@ -43,15 +43,15 @@ module Foobara
       if arg && !arg.empty?
         if opts && !opts.empty?
           unless opts.is_a?(::Hash)
-            # :nocov:
+            # simplecov:disable
             raise ArgumentError, "opts must be a hash not a #{opts}"
-            # :nocov:
+            # simplecov:enable
           end
 
           unless arg.is_a?(::Hash)
-            # :nocov:
+            # simplecov:disable
             raise ArgumentError, "arg must be a hash if present when opts is present"
-            # :nocov:
+            # simplecov:enable
           end
 
           arg.merge(opts)
@@ -70,9 +70,9 @@ module Foobara
     # argument with stuff merged into the argument if needed.
     def args_and_opts_to_args(args, opts)
       unless args.is_a?(::Array)
-        # :nocov:
+        # simplecov:disable
         raise ArgumentError, "args must be an array of 0 or 1 hashes but received #{args}"
-        # :nocov:
+        # simplecov:enable
       end
 
       case args.size
@@ -84,9 +84,9 @@ module Foobara
           arg = args.first
 
           unless arg.is_a?(::Hash)
-            # :nocov:
+            # simplecov:disable
             raise ArgumentError, "Expected #{arg.inspect} to be a Hash"
-            # :nocov:
+            # simplecov:enable
           end
 
           [arg_and_opts_to_arg(args.first, opts)]
@@ -96,9 +96,9 @@ module Foobara
 
         [arg_and_opts_to_arg(args.first, opts)]
       else
-        # :nocov:
+        # simplecov:disable
         raise ArgumentError, "args must be an array of 0 or 1 hashes but received #{args}"
-        # :nocov:
+        # simplecov:enable
       end
     end
   end

data/lib/foobara/util/array.rb

@@ -24,7 +24,7 @@ module Foobara
     end
 
     def all_symbolic_elements?(array)
-      array.all? { |key| key.is_a?(Symbol) }
+      array.all?(Symbol)
     end
 
     def all_symbolizable_elements?(array)

data/lib/foobara/util/hash.rb

@@ -2,18 +2,63 @@ module Foobara
   module Util
     module_function
 
+    def sort_by_keys(hash)
+      keys = hash.keys
+
+      keys.sort!
+
+      sorted_hash = {}
+
+      keys.each do |key|
+        sorted_hash[key] = hash[key]
+      end
+
+      sorted_hash
+    end
+
+    def sort_by_keys!(hash)
+      last_key = keys_to_move = nil
+
+      hash.each_key do |key|
+        if last_key
+          if key < last_key
+            if keys_to_move
+              keys_to_move << key
+            else
+              keys_to_move = [key]
+            end
+
+            next
+          end
+        end
+
+        last_key = key
+      end
+
+      return hash unless keys_to_move
+
+      keys_to_move.sort!
+
+      keys_to_move.each do |key|
+        value = hash.delete(key)
+        hash[key] = value
+      end
+
+      hash
+    end
+
     def symbolize_keys(hash)
       unless all_symbolizable_keys?(hash)
-        # :nocov:
+        # simplecov:disable
         raise "Cannot symbolize keys for #{hash} because they are not all symbolizable"
-        # :nocov:
+        # simplecov:enable
       end
 
       unless hash.instance_of?(::Hash)
         unless hash.respond_to?(:to_h)
-          # :nocov:
+          # simplecov:disable
           raise ArgumentError, "Could not turn #{hash} into an instance of Hash"
-          # :nocov:
+          # simplecov:enable
         end
 
         hash = hash.to_h
@@ -24,17 +69,21 @@ module Foobara
 
     def symbolize_keys!(hash)
       unless all_symbolizable_keys?(hash)
-        # :nocov:
+        # simplecov:disable
         raise "Cannot symbolize keys for #{hash} because they are not all symbolizable"
-        # :nocov:
+        # simplecov:enable
       end
 
       hash.transform_keys!(&:to_sym)
 
       unless hash.instance_of?(::Hash)
+        # simplecov:disable
         unless all_symbolic_keys?(hash)
-          raise ArgumentError, "Cannot symbolize keys for #{hash} because it isn't behaving like a Hash"
+          # This can happen with HashWithIndifferentAccess
+          raise ArgumentError,
+                "Cannot symbolize keys for #{hash} because its transform_keys! method does not behave as expected"
         end
+        # simplecov:enable
       end
 
       hash

data/lib/foobara/util/meta.rb

@@ -39,12 +39,11 @@ module Foobara
       end
 
       unless already_exists
-        # rubocop:disable Security/Eval, Style/DocumentDynamicEvalDefinition
+        # rubocop:disable-next Security/Eval, Style/DocumentDynamicEvalDefinition
         eval(<<~RUBY, binding, __FILE__, __LINE__ + 1)
           #{which} ::#{name}#{inherit}
           end
         RUBY
-        # rubocop:enable Security/Eval, Style/DocumentDynamicEvalDefinition
       end
 
       klass = Object.const_get(name, false)

data/lib/foobara/util/module.rb

@@ -37,9 +37,9 @@ module Foobara
 
     def constant_values(mod, is_a: nil, extends: nil, inherit: false)
       if inherit && !mod.is_a?(Class)
-        # :nocov:
+        # simplecov:disable
         raise "Cannot pass inherit: true for something that is not a Class"
-        # :nocov:
+        # simplecov:enable
       end
 
       if inherit
@@ -71,9 +71,9 @@ module Foobara
       mod.const_get(name)
     rescue NameError => e
       if mod == Object || e.message !~ /uninitialized constant (.*::)?#{name}\z/
-        # :nocov:
+        # simplecov:disable
         raise
-        # :nocov:
+        # simplecov:enable
       end
 
       mod = if mod.name&.include?("::")

data/lib/foobara/util/object_space.rb

@@ -19,7 +19,7 @@ module Foobara
       end
 
       def referencing_paths(object)
-        paths = _referencing_paths(object.object_id, object_id_referenced_by_map)
+        paths = _referencing_paths(object.__id__, object_id_referenced_by_map)
         paths.sort_by!(&:size)
         paths.reverse!
         paths
@@ -56,9 +56,9 @@ module Foobara
                   when :ivar
                     via
                   else
-                    # :nocov:
+                    # simplecov:disable
                     raise "Unexpected via_type #{part.via_type}"
-                    # :nocov:
+                    # simplecov:enable
                   end
 
             class_part = if referenced_by.is_a?(Module)
@@ -67,12 +67,12 @@ module Foobara
                            if name
                              name
                            elsif referenced_by.is_a?(Class)
-                             "AnonClass:#{referenced_by.object_id}"
+                             "AnonClass:#{referenced_by.__id__}"
                            else
-                             "AnonModule:#{referenced_by.object_id}"
+                             "AnonModule:#{referenced_by.__id__}"
                            end
                          else
-                           "<#{referenced_by.class}:#{referenced_by.object_id}>"
+                           "<#{referenced_by.class}:#{referenced_by.__id__}>"
                          end
 
             resolved_parts << "#{class_part}#{via}"
@@ -119,9 +119,7 @@ module Foobara
         end
 
         objects.each do |object|
-          # rubocop:disable Lint/HashCompareByIdentity
-          references[object.object_id] = object_id_references(object)
-          # rubocop:enable Lint/HashCompareByIdentity
+          references[object.__id__] = object_id_references(object)
         end
 
         references
@@ -143,12 +141,12 @@ module Foobara
       end
 
       def object_id_references(object)
-        object_id = object.object_id
+        object_id = object.__id__
 
         references = object.instance_variables.map do |ivar|
           ReferencePathPart.new(
             object_id,
-            object.instance_variable_get(ivar).object_id,
+            object.instance_variable_get(ivar).__id__,
             ivar,
             :ivar
           )
@@ -159,7 +157,7 @@ module Foobara
           object.constants(false).each do |constant_name|
             references << ReferencePathPart.new(
               object_id,
-              object.const_get(constant_name).object_id,
+              object.const_get(constant_name).__id__,
               constant_name,
               :constant
             )
@@ -169,11 +167,10 @@ module Foobara
             nil
           end
         when ::Array, ::Set
-
           object.each.with_index do |element, index|
             references << ReferencePathPart.new(
               object_id,
-              element.object_id,
+              element.__id__,
               index,
               :array_index
             )
@@ -181,8 +178,8 @@ module Foobara
 
         when ::Hash
           object.each_pair do |k, v|
-            references << ReferencePathPart.new(object_id, k.object_id, k, :hash_key)
-            references << ReferencePathPart.new(object_id, v.object_id, k, :hash_value)
+            references << ReferencePathPart.new(object_id, k.__id__, k, :hash_key)
+            references << ReferencePathPart.new(object_id, v.__id__, k, :hash_value)
           end
         end
 

data/lib/foobara/util/require.rb

@@ -10,9 +10,9 @@ module Foobara
       files = Dir[glob]
 
       if files.empty?
-        # :nocov:
+        # simplecov:disable
         raise "Didn't find anything to require for #{glob}"
-        # :nocov:
+        # simplecov:enable
       end
 
       files.sort_by { |file| [file.count("/"), file.length, file] }.reverse.each do |f|

data/lib/foobara/util/string.rb

@@ -7,7 +7,12 @@ module Foobara
     end
 
     def camelize(string, upcase_first = false)
-      return nil if string.nil?
+      if string.nil?
+        # simplecov:disable
+        warn "Passing nil to .#{__callee__} is deprecated. Pass a string only."
+        return nil
+        # simplecov:enable
+      end
 
       if string.is_a?(::Symbol)
         string = string.to_s
@@ -33,7 +38,12 @@ module Foobara
     IS_IDENTIFIER_CHARACTER = /\w/
 
     def constantify(string)
-      return nil if string.nil?
+      if string.nil?
+        # simplecov:disable
+        warn "Passing nil to .#{__callee__} is deprecated. Pass a string only."
+        return nil
+        # simplecov:enable
+      end
 
       if string.is_a?(::Symbol)
         string = string.to_s
@@ -47,11 +57,23 @@ module Foobara
     end
 
     def constantify_sym(string)
-      constantify(string)&.to_sym
+      if string.nil?
+        # simplecov:disable
+        warn "Passing nil to .#{__callee__} is deprecated. Pass a string only."
+        return nil
+        # simplecov:enable
+      end
+
+      constantify(string).to_sym
     end
 
     def underscore(string)
-      return nil if string.nil?
+      if string.nil?
+        # simplecov:disable
+        warn "Passing nil to .#{__callee__} is deprecated. Pass a string only."
+        return nil
+        # simplecov:enable
+      end
 
       if string.is_a?(::Symbol)
         string = string.to_s
@@ -86,11 +108,25 @@ module Foobara
     end
 
     def kebab_case(string)
-      underscore(string)&.gsub("_", "-")
+      if string.nil?
+        # simplecov:disable
+        warn "Passing nil to .#{__callee__} is deprecated. Pass a string only."
+        return nil
+        # simplecov:enable
+      end
+
+      underscore(string).gsub("_", "-")
     end
 
     def underscore_sym(string)
-      underscore(string)&.to_sym
+      if string.nil?
+        # simplecov:disable
+        warn "Passing nil to .#{__callee__} is deprecated. Pass a string only."
+        return nil
+        # simplecov:enable
+      end
+
+      underscore(string).to_sym
     end
 
     def to_sentence(strings, connector = ", ", last_connector = ", and ")
@@ -110,7 +146,12 @@ module Foobara
     end
 
     def humanize(string)
-      return nil if string.nil?
+      if string.nil?
+        # simplecov:disable
+        warn "Passing nil to .#{__callee__} is deprecated. Pass a string only."
+        return nil
+        # simplecov:enable
+      end
 
       if string.is_a?(::Symbol)
         string = string.to_s

data/lib/foobara/util.rb

@@ -1 +1,6 @@
-Dir["#{__dir__}/../**/*.rb"].each { |f| require f }
+Dir["#{__dir__}/../**/*.rb"].each do |file|
+  # only load this via require "foobara/util/object_space" for detecting memory leaks.
+  unless file =~ /\butil\/object_space.rb$/
+    require file
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara-util
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
 platform: ruby
 authors:
 - Miles Georgi
@@ -57,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Utility functions used across various Foobara projects
 test_files: []