✨ Serialization Extensions (iii)

pboling · pboling · commit c63d03d172c8 · 2025-05-22T03:35:20.000+07:00
diff --git a/.rubocop_gradual.lock b/.rubocop_gradual.lock
@@ -11,7 +11,7 @@
   "spec/snaky_hash/bad_snake_spec.rb:3931746112": [
     [3, 16, 11, "RSpec/DescribeClass: The first argument to describe should be the class or module being tested.", 1577626599]
   ],
-  "spec/snaky_hash/snake_spec.rb:2603178792": [
+  "spec/snaky_hash/snake_spec.rb:1921604918": [
     [4, 3, 92, "RSpec/LeakyConstantDeclaration: Stub class constant instead of declaring explicitly.", 3047242215]
   ]
 }
diff --git a/doc/SnakyHash.html b/doc/SnakyHash.html
@@ -123,7 +123,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/SnakyHash/Error.html b/doc/SnakyHash/Error.html
@@ -114,7 +114,7 @@
 </div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/SnakyHash/Extensions.html b/doc/SnakyHash/Extensions.html
@@ -446,7 +446,7 @@ <h3 class="signature " id="run-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/SnakyHash/Serializer.html b/doc/SnakyHash/Serializer.html
@@ -316,7 +316,7 @@ <h3 class="signature " id="load-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/SnakyHash/Serializer/BackportedInstanceMethods.html b/doc/SnakyHash/Serializer/BackportedInstanceMethods.html
@@ -190,7 +190,7 @@ <h3 class="signature first" id="transform_values-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/SnakyHash/Serializer/Modulizer.html b/doc/SnakyHash/Serializer/Modulizer.html
@@ -189,7 +189,7 @@ <h3 class="signature first" id="to_extended_mod-class_method">
 </div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/SnakyHash/Snake.html b/doc/SnakyHash/Snake.html
@@ -275,7 +275,7 @@ <h3 class="signature first" id="included-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/SnakyHash/Snake/SnakyModulizer.html b/doc/SnakyHash/Snake/SnakyModulizer.html
@@ -261,7 +261,7 @@ <h3 class="signature first" id="to_mod-class_method">
 </div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/SnakyHash/StringKeyed.html b/doc/SnakyHash/StringKeyed.html
@@ -130,7 +130,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/SnakyHash/SymbolKeyed.html b/doc/SnakyHash/SymbolKeyed.html
@@ -130,7 +130,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/SnakyHash/Version.html b/doc/SnakyHash/Version.html
@@ -111,7 +111,7 @@ <h2>
 </div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/_index.html b/doc/_index.html
@@ -214,7 +214,7 @@ <h2>Namespace Listing A-Z</h2>
 </div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/file.CHANGELOG.html b/doc/file.CHANGELOG.html
@@ -147,7 +147,7 @@ <h3 id="added-5">Added</h3>
 </div></div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/file.CODE_OF_CONDUCT.html b/doc/file.CODE_OF_CONDUCT.html
@@ -192,7 +192,7 @@ <h2 id="attribution">Attribution</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/file.CONTRIBUTING.html b/doc/file.CONTRIBUTING.html
@@ -195,7 +195,7 @@ <h3 id="to-release-a-new-version">To release a new version:</h3>
 </div></div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/file.LICENSE.html b/doc/file.LICENSE.html
@@ -60,7 +60,7 @@
       <div id="content"><div id='filecontents'>The MIT License (MIT)<br><br>Copyright (c) 2022, 2025 Peter Boling<br><br>Permission is hereby granted, free of charge, to any person obtaining a copy<br>of this software and associated documentation files (the "Software"), to deal<br>in the Software without restriction, including without limitation the rights<br>to use, copy, modify, merge, publish, distribute, sublicense, and/or sell<br>copies of the Software, and to permit persons to whom the Software is<br>furnished to do so, subject to the following conditions:<br><br>The above copyright notice and this permission notice shall be included in<br>all copies or substantial portions of the Software.<br><br>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR<br>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,<br>FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE<br>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER<br>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,<br>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN<br>THE SOFTWARE.</div></div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/file.README.html b/doc/file.README.html
@@ -634,7 +634,7 @@ <h2 id="-one-more-thing">🤑 One more thing</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/file.SECURITY.html b/doc/file.SECURITY.html
@@ -104,7 +104,7 @@ <h2 id="snaky-hash-for-enterprise">Snaky Hash for Enterprise</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/index.html b/doc/index.html
@@ -634,7 +634,7 @@ <h2 id="-one-more-thing">🤑 One more thing</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/doc/top-level-namespace.html b/doc/top-level-namespace.html
@@ -100,7 +100,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Thu May 22 02:24:19 2025 by
+  Generated on Thu May 22 03:35:07 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.3).
 </div>
diff --git a/spec/snaky_hash/snake_spec.rb b/spec/snaky_hash/snake_spec.rb
@@ -34,117 +34,78 @@ class TheSnakedHash < Hashie::Mash
   end
 
   context "when serializer: true" do
-    # Older versions of Ruby can't do Integer#to_sym,
-    #   which means snaky_hash on older rubies can't handle integer keys via new
-    if RUBY_VERSION >= "3.0"
-      context "when Ruby >= 3.0" do
-        let(:snaky_klass) do
-          klass = Class.new(Hashie::Mash) do
-            include SnakyHash::Snake.new(
-              key_type: :symbol, # default :string
-              serializer: true,   # default: false
-            )
-          end
+    let(:snaky_klass) do
+      klass = Class.new(Hashie::Mash) do
+        include SnakyHash::Snake.new(
+          key_type: :symbol, # default :string
+          serializer: true,   # default: false
+        )
+      end
 
-          klass.load_hash_extensions.add(:non_zero_keys_to_int) do |value|
-            if value.is_a?(Hash)
-              value.transform_keys do |key|
-                key_int = key.to_s.to_i
-                if key_int > 0
-                  key_int
-                else
-                  key
-                end
-              end
+      klass.load_hash_extensions.add(:keys_are_based) do |value|
+        if value.is_a?(Hash)
+          value.keys.sort.each_with_index do |key, index|
+            key_int = key.to_s.to_i
+            ref = value.delete(key)
+            encoded_key = if key_int > 0
+              # See: https://idiosyncratic-ruby.com/4-what-the-pack.html#m0--base64-encoding-rfc-4648
+              "dog-#{index}"
             else
-              value
+              "cat-#{index}"
             end
+            value[encoded_key] = ref
           end
-
-          klass
-        end
-
-        let(:snake) { snaky_klass.new(1 => "a", 0 => 4, "VeryFineHat" => {3 => "v", 5 => 7, :very_fine_hat => "feathers"}) }
-        let(:dump) { snaky_klass.dump(snake) }
-        let(:hydrated) { snaky_klass.load(dump) }
-
-        it "can initialize" do
-          expect(snake).to eq({1 => "a", 0 => 4, :very_fine_hat => {3 => "v", 5 => 7, :very_fine_hat => "feathers"}})
-        end
-
-        it "can dump" do
-          expect(dump).to eq "{\"1\":\"a\",\"0\":4,\"very_fine_hat\":{\"3\":\"v\",\"5\":7,\"very_fine_hat\":\"feathers\"}}"
-        end
-
-        it "can load" do
-          expect(hydrated).to eq({1 => "a", :"0" => 4, :very_fine_hat => {3 => "v", 5 => 7, :very_fine_hat => "feathers"}})
-        end
-
-        it "can access keys" do
-          expect(hydrated["1"]).to be_nil
-          expect(hydrated[1]).to eq("a")
-          expect(hydrated["0"]).to eq(4)
-          expect(hydrated[0]).to be_nil
-          expect(hydrated.very_fine_hat).to eq({3 => "v", 5 => 7, :very_fine_hat => "feathers"})
-          expect(hydrated.very_fine_hat.very_fine_hat).to eq("feathers")
-          expect(hydrated.very_fine_hat[:very_fine_hat]).to eq("feathers")
-          expect(hydrated.very_fine_hat["very_fine_hat"]).to eq("feathers")
         end
+        value
       end
-    else
-      context "when Ruby < 3.0" do
-        let(:snaky_klass) do
-          klass = Class.new(Hashie::Mash) do
-            include SnakyHash::Snake.new(
-              key_type: :symbol, # default :string
-              serializer: true,   # default: false
-            )
-          end
 
-          klass.load_hash_extensions.add(:non_zero_keys_to_int) do |value|
-            if value.is_a?(Hash)
-              value.keys.each do |key|
-                key_int = key.to_s.to_i
-                if key_int > 0
-                  ref = value.delete(key)
-                  value[key_int] = ref
-                end
-              end
-            else
-              value
-            end
-          end
-
-          klass
-        end
+      klass
+    end
 
-        let(:snake) { snaky_klass.new("1" => "a", "0" => 4, "VeryFineHat" => {"3" => "v", "5" => 7, :very_fine_hat => "feathers"}) }
-        let(:dump) { snaky_klass.dump(snake) }
-        let(:hydrated) { snaky_klass.load(dump) }
+    let(:snake) { snaky_klass.new("1" => "a", "0" => 4, "VeryFineHat" => {"3" => "v", "5" => 7, :very_fine_hat => "feathers"}) }
+    let(:dump) { snaky_klass.dump(snake) }
+    let(:hydrated) { snaky_klass.load(dump) }
 
-        it "can initialize" do
-          expect(snake).to eq({"1" => "a", "0" => 4, :very_fine_hat => {"3" => "v", "5" => 7, :very_fine_hat => "feathers"}})
-        end
+    it "can initialize" do
+      expect(snake).to eq({"0": 4, "1": "a", very_fine_hat: {"3": "v", "5": 7, very_fine_hat: "feathers"}})
+    end
 
-        it "can dump" do
-          expect(dump).to eq "{\"1\":\"a\",\"0\":4,\"very_fine_hat\":{\"3\":\"v\",\"5\":7,\"very_fine_hat\":\"feathers\"}}"
-        end
+    it "can dump" do
+      expect(dump).to eq "{\"1\":\"a\",\"0\":4,\"very_fine_hat\":{\"3\":\"v\",\"5\":7,\"very_fine_hat\":\"feathers\"}}"
+    end
 
-        it "can load" do
-          expect(hydrated).to eq({1 => "a", :"0" => 4, :very_fine_hat => {3 => "v", 5 => 7, :very_fine_hat => "feathers"}})
-        end
+    it "can load" do
+      expect(hydrated).to eq(
+        {
+          dog_1: "a",
+          cat_0: 4,
+          cat_2: {
+            dog_0: "v",
+            dog_1: 7,
+            cat_2: "feathers",
+          },
+        },
+      )
+    end
 
-        it "can access keys" do
-          expect(hydrated["1"]).to be_nil
-          expect(hydrated[1]).to eq("a")
-          expect(hydrated["0"]).to eq(4)
-          expect(hydrated[0]).to be_nil
-          expect(hydrated.very_fine_hat).to eq({3 => "v", 5 => 7, :very_fine_hat => "feathers"})
-          expect(hydrated.very_fine_hat.very_fine_hat).to eq("feathers")
-          expect(hydrated.very_fine_hat[:very_fine_hat]).to eq("feathers")
-          expect(hydrated.very_fine_hat["very_fine_hat"]).to eq("feathers")
-        end
-      end
+    it "can access keys" do
+      expect(hydrated["1"]).to be_nil
+      expect(hydrated[1]).to be_nil
+      expect(hydrated["dog_1"]).to eq("a")
+      expect(hydrated[:dog_1]).to eq("a")
+      expect(hydrated.dog_1).to eq("a")
+      expect(hydrated["0"]).to be_nil
+      expect(hydrated[0]).to be_nil
+      expect(hydrated["cat_0"]).to eq(4)
+      expect(hydrated[:cat_0]).to eq(4)
+      expect(hydrated.cat_0).to eq(4)
+      expect(hydrated.very_fine_hat).to be_nil
+      expect(hydrated.cat_2).to eq({cat_2: "feathers", dog_0: "v", dog_1: 7})
+      expect(hydrated.cat_2.cat_2).to eq("feathers")
+      expect(hydrated.cat_2["cat_2"]).to eq("feathers")
+      expect(hydrated.cat_2[:cat_2]).to eq("feathers")
+      expect(hydrated.cat_2.dog_0).to eq("v")
+      expect(hydrated.cat_2.dog_1).to eq(7)
     end
   end
 end

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`"spec/snaky_hash/bad_snake_spec.rb:3931746112": [`
`12`	`12`	`[3, 16, 11, "RSpec/DescribeClass: The first argument to describe should be the class or module being tested.", 1577626599]`
`13`	`13`	`],`
`14`		`- "spec/snaky_hash/snake_spec.rb:2603178792": [`
	`14`	`+ "spec/snaky_hash/snake_spec.rb:1921604918": [`
`15`	`15`	`[4, 3, 92, "RSpec/LeakyConstantDeclaration: Stub class constant instead of declaring explicitly.", 3047242215]`
`16`	`16`	`]`
`17`	`17`	`}`