Allow for custom < Hash classes to override #to_s

.ruby-version

@@ -1 +1 @@
-3.3.6
+3.4.1

CONTRIBUTING.md

@@ -29,8 +29,6 @@
 
 ## Releasing
 
-* Bump the version in `lib/liquid/version.rb`
-* Update the `History.md` file
-* Open a PR like [this one](https://github.com/Shopify/liquid/pull/1894) and merge it to `main`
+* Bump the version in `lib/liquid/version.rb` and merge it on `main`
 * Create a new release using the [GitHub UI](https://github.com/Shopify/liquid/releases/new)
 

History.md

@@ -1,54 +1,12 @@
 # Liquid Change Log
 
-## 5.8.0 (unreleased)
-
-## 5.7.0 2025-01-16
-
-### Features
-* Add `find`, `find_index`, `has`, and `reject` filters to arrays
-* Compatibility with Ruby 3.4
-
-## 5.6.4 2025-01-14
+## 5.6.0 (unreleased)
 
 ### Fixes
-* Add a default `string_scanner` to avoid errors with `Liquid::VariableLookup.parse("foo.bar")` [Ian Ker-Seymer]
 
-## 5.6.3 2025-01-13
-* Remove `lru_redux` dependency [Michael Go]
-
-## 5.6.2 2025-01-13
-
-### Fixes
-* Preserve the old behavior of requiring floats to start with a digit [Michael Go]
-
-## 5.6.1 2025-01-13
-
-### Performance improvements
-* Faster Expression parser / Tokenizer with StringScanner [Michael Go]
-
-## 5.6.0 2024-12-19
-
-### Architectural changes
-* Added new `Environment` class to manage configuration and state that was previously stored in `Template` [Ian Ker-Seymer]
-* Moved tag registration from `Template` to `Environment` [Ian Ker-Seymer]
-* Removed `StrainerFactory` in favor of `Environment`-based strainer creation [Ian Ker-Seymer]
-* Consolidated standard tags into a new `Tags` module with `STANDARD_TAGS` constant [Ian Ker-Seymer]
-
-### Performance improvements
-* Optimized `Lexer` with a new `Lexer2` implementation using jump tables for faster tokenization, requires Ruby 3.4 [Ian Ker-Seymer]
-* Improved variable rendering with specialized handling for different types [Michael Go]
-* Reduced array allocations by using frozen empty constants [Michael Go]
-
-### API changes
-* Deprecated several `Template` class methods in favor of `Environment` methods [Ian Ker-Seymer]
-* Added deprecation warnings system [Ian Ker-Seymer]
-* Changed how filters and tags are registered to use Environment [Ian Ker-Seymer]
-
-### Fixes
-* Fixed table row handling of break interrupts [Alex Coco]
-* Improved variable output handling for arrays [Ian Ker-Seymer]
 * Fix Tokenizer to handle null source value (#1873) [Bahar Pourazar]
 
+
 ## 5.5.0 2024-03-21
 
 Please reference the GitHub release for more information.

lib/liquid/utils.rb

@@ -90,34 +90,38 @@ module Liquid
       obj
     end
 
-    if RUBY_VERSION >= '3.4'
-      def self.to_s(obj, seen = {})
-        case obj
-        when Hash
+    def self.to_s(obj, seen = {})
+      case obj
+      when Hash
+        # If the custom hash implementation overrides `#to_s`, use their
+        # custom implementation. Otherwise we use Liquid's default
+        # implementation.
+        if obj.class.instance_method(:to_s) == HASH_TO_S_METHOD
           hash_inspect(obj, seen)
-        when Array
-          array_inspect(obj, seen)
         else
           obj.to_s
         end
+      when Array
+        array_inspect(obj, seen)
+      else
+        obj.to_s
       end
+    end
 
-      def self.inspect(obj, seen = {})
-        case obj
-        when Hash
+    def self.inspect(obj, seen = {})
+      case obj
+      when Hash
+        # If the custom hash implementation overrides `#inspect`, use their
+        # custom implementation. Otherwise we use Liquid's default
+        # implementation.
+        if obj.class.instance_method(:inspect) == HASH_INSPECT_METHOD
           hash_inspect(obj, seen)
-        when Array
-          array_inspect(obj, seen)
         else
           obj.inspect
         end
-      end
-    else
-      def self.to_s(obj, seen = nil)
-        obj.to_s
-      end
-
-      def self.inspect(obj, seen = nil)
+      when Array
+        array_inspect(obj, seen)
+      else
         obj.inspect
       end
     end
@@ -175,5 +179,11 @@ module Liquid
     ensure
       seen.delete(hash.object_id)
     end
+
+    HASH_TO_S_METHOD = Hash.instance_method(:to_s)
+    private_constant :HASH_TO_S_METHOD
+
+    HASH_INSPECT_METHOD = Hash.instance_method(:inspect)
+    private_constant :HASH_INSPECT_METHOD
   end
 end

lib/liquid/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Liquid
-  VERSION = "5.7.0"
+  VERSION = "5.6.5"
 end

test/integration/hash_rendering_test.rb

@@ -80,4 +80,21 @@ class HashRenderingTest < Minitest::Test
   def test_render_hash_with_hash_key
     assert_template_result("{{\"foo\"=>\"bar\"}=>42}", "{{ my_hash }}", { "my_hash" => { Hash["foo" => "bar"] => 42 } })
   end
+
+  def test_rendering_hash_with_custom_to_s_method_uses_custom_to_s
+    my_hash = Class.new(Hash) do
+      def to_s
+        "kewl"
+      end
+    end.new
+
+    assert_template_result("kewl", "{{ my_hash }}", { "my_hash" => my_hash })
+  end
+
+  def test_rendering_hash_without_custom_to_s_uses_default_inspect
+    my_hash = Class.new(Hash).new
+    my_hash[:foo] = :bar
+
+    assert_template_result("{:foo=>:bar}", "{{ my_hash }}", { "my_hash" => my_hash })
+  end
 end