✨ Serialization Extensions (i)

pboling · pboling · commit 227b8dbc2255 · 2025-05-22T01:52:09.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:3264128361": [
+  "spec/snaky_hash/snake_spec.rb:3662358368": [
     [4, 3, 92, "RSpec/LeakyConstantDeclaration: Stub class constant instead of declaring explicitly.", 3047242215]
   ]
 }
diff --git a/README.md b/README.md
@@ -193,12 +193,12 @@ This is also not a bug, though if you need different behavior, there is a soluti
 
 You can write your own arbitrary extensions:
 
-* hash load extensions operate on the hash, and nested hashes
-  * use `::load_hash_extensions.add(:extension_name) {}`
-* load extensions operate on the values, and nested hash values, if any
-    * use `::load_extensions.add(:extension_name) {}`
-* dump extensions operate on the values, and nested hash values, if any
-    * use `::dump_extensions.add(:extension_name) {}`
+* "Hash Load" extensions operate on the hash, and nested hashes
+  * use `::load_hash_extensions.add(:extension_name) { |hash| }`
+* "Load" extensions operate on the values, and nested hash's values, if any
+    * use `::load_extensions.add(:extension_name) { |value| }`
+* "Dump" extensions operate on the values, and nested hash's values, if any
+    * use `::dump_extensions.add(:extension_name) { |value| }`
 
 #### Example
 
@@ -234,16 +234,16 @@ hydrated = MyExtSnakedHash.load(dump) # => {1 => "a", "0": 4, very_fine_hat: {3
 hydrated.class # => MyExtSnakedHash
 hydrated["1"] # => nil
 hydrated[1] # => "a"
-hydrated["2"] # => nil
-hydrated[2] # => 4
 hydrated["0"] # => 4
 hydrated[0] # => nil
 hydrated.very_fine_hat # => {3 => "v", 5 => 7, very_fine_hat: "feathers"}
 hydrated.very_fine_hat.very_fine_hat # => "feathers"
-hydrated.very_fine_hat[:very_fine_hat] # => 'Feathers'
-hydrated.very_fine_hat["very_fine_hat"] # => 'Feathers'
+hydrated.very_fine_hat[:very_fine_hat] # => 'feathers'
+hydrated.very_fine_hat["very_fine_hat"] # => 'feathers'
 ```
 
+See the specs for more examples.
+
 ### Stranger Things
 
 I don't recommend using these features... but they exist (for now).
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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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
@@ -137,7 +137,7 @@ <h3 id="added-4">Added</h3>
 </div></div>
 
       <div id="footer">
-  Generated on Thu May 22 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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
@@ -407,21 +407,21 @@ <h3 id="extensions">Extensions</h3>
 <p>You can write your own arbitrary extensions:</p>
 
 <ul>
-  <li>hash load extensions operate on the hash, and nested hashes
+  <li>“Hash Load” extensions operate on the hash, and nested hashes
     <ul>
-      <li>use <code>::load_hash_extensions.add(:extension_name) {}</code>
+      <li>use <code>::load_hash_extensions.add(:extension_name) { |hash| }</code>
 </li>
     </ul>
   </li>
-  <li>load extensions operate on the values, and nested hash values, if any
+  <li>“Load” extensions operate on the values, and nested hash’s values, if any
     <ul>
-      <li>use <code>::load_extensions.add(:extension_name) {}</code>
+      <li>use <code>::load_extensions.add(:extension_name) { |value| }</code>
 </li>
     </ul>
   </li>
-  <li>dump extensions operate on the values, and nested hash values, if any
+  <li>“Dump” extensions operate on the values, and nested hash’s values, if any
     <ul>
-      <li>use <code>::dump_extensions.add(:extension_name) {}</code>
+      <li>use <code>::dump_extensions.add(:extension_name) { |value| }</code>
 </li>
     </ul>
   </li>
@@ -460,16 +460,16 @@ <h4 id="example">Example</h4>
 hydrated.class # =&gt; MyExtSnakedHash
 hydrated[&quot;1&quot;] # =&gt; nil
 hydrated[1] # =&gt; &quot;a&quot;
-hydrated[&quot;2&quot;] # =&gt; nil
-hydrated[2] # =&gt; 4
 hydrated[&quot;0&quot;] # =&gt; 4
 hydrated[0] # =&gt; nil
 hydrated.very_fine_hat # =&gt; {3 =&gt; &quot;v&quot;, 5 =&gt; 7, very_fine_hat: &quot;feathers&quot;}
 hydrated.very_fine_hat.very_fine_hat # =&gt; &quot;feathers&quot;
-hydrated.very_fine_hat[:very_fine_hat] # =&gt; &#39;Feathers&#39;
-hydrated.very_fine_hat[&quot;very_fine_hat&quot;] # =&gt; &#39;Feathers&#39;
+hydrated.very_fine_hat[:very_fine_hat] # =&gt; &#39;feathers&#39;
+hydrated.very_fine_hat[&quot;very_fine_hat&quot;] # =&gt; &#39;feathers&#39;
 </code></pre>
 
+<p>See the specs for more examples.</p>
+
 <h3 id="stranger-things">Stranger Things</h3>
 
 <p>I don’t recommend using these features… but they exist (for now).<br>
@@ -624,7 +624,7 @@ <h2 id="-one-more-thing">🤑 One more thing</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Thu May 22 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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
@@ -407,21 +407,21 @@ <h3 id="extensions">Extensions</h3>
 <p>You can write your own arbitrary extensions:</p>
 
 <ul>
-  <li>hash load extensions operate on the hash, and nested hashes
+  <li>“Hash Load” extensions operate on the hash, and nested hashes
     <ul>
-      <li>use <code>::load_hash_extensions.add(:extension_name) {}</code>
+      <li>use <code>::load_hash_extensions.add(:extension_name) { |hash| }</code>
 </li>
     </ul>
   </li>
-  <li>load extensions operate on the values, and nested hash values, if any
+  <li>“Load” extensions operate on the values, and nested hash’s values, if any
     <ul>
-      <li>use <code>::load_extensions.add(:extension_name) {}</code>
+      <li>use <code>::load_extensions.add(:extension_name) { |value| }</code>
 </li>
     </ul>
   </li>
-  <li>dump extensions operate on the values, and nested hash values, if any
+  <li>“Dump” extensions operate on the values, and nested hash’s values, if any
     <ul>
-      <li>use <code>::dump_extensions.add(:extension_name) {}</code>
+      <li>use <code>::dump_extensions.add(:extension_name) { |value| }</code>
 </li>
     </ul>
   </li>
@@ -460,16 +460,16 @@ <h4 id="example">Example</h4>
 hydrated.class # =&gt; MyExtSnakedHash
 hydrated[&quot;1&quot;] # =&gt; nil
 hydrated[1] # =&gt; &quot;a&quot;
-hydrated[&quot;2&quot;] # =&gt; nil
-hydrated[2] # =&gt; 4
 hydrated[&quot;0&quot;] # =&gt; 4
 hydrated[0] # =&gt; nil
 hydrated.very_fine_hat # =&gt; {3 =&gt; &quot;v&quot;, 5 =&gt; 7, very_fine_hat: &quot;feathers&quot;}
 hydrated.very_fine_hat.very_fine_hat # =&gt; &quot;feathers&quot;
-hydrated.very_fine_hat[:very_fine_hat] # =&gt; &#39;Feathers&#39;
-hydrated.very_fine_hat[&quot;very_fine_hat&quot;] # =&gt; &#39;Feathers&#39;
+hydrated.very_fine_hat[:very_fine_hat] # =&gt; &#39;feathers&#39;
+hydrated.very_fine_hat[&quot;very_fine_hat&quot;] # =&gt; &#39;feathers&#39;
 </code></pre>
 
+<p>See the specs for more examples.</p>
+
 <h3 id="stranger-things">Stranger Things</h3>
 
 <p>I don’t recommend using these features… but they exist (for now).<br>
@@ -624,7 +624,7 @@ <h2 id="-one-more-thing">🤑 One more thing</h2>
 </div></div>
 
       <div id="footer">
-  Generated on Thu May 22 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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 01:26:13 2025 by
+  Generated on Thu May 22 01:51:49 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
@@ -32,4 +32,59 @@ class TheSnakedHash < Hashie::Mash
     expect(res).not_to be_a(TheSnakedHash)
     expect(res).to be_a(Hash)
   end
+
+  context "when serializer: true" 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.transform_keys do |key|
+            key_int = key.to_s.to_i
+            if key_int > 0
+              key_int
+            else
+              key
+            end
+          end
+        else
+          value
+        end
+      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
+  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:3264128361": [`
	`14`	`+ "spec/snaky_hash/snake_spec.rb:3662358368": [`
`15`	`15`	`[4, 3, 92, "RSpec/LeakyConstantDeclaration: Stub class constant instead of declaring explicitly.", 3047242215]`
`16`	`16`	`]`
`17`	`17`	`}`