marshal-md 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 850fa2bae403ca2746a23669fb64fa5e973382c129059ee3fc34558b087a2f19
+  data.tar.gz: '0629489b93629f8482810a86c531bd6cedb762afd67f832fafd9995db32d9d74'
+SHA512:
+  metadata.gz: 7b838189a18a72980b67269d42a9ca370782a83310b7710df36a770f9835538048e1a2812c41073d0b805c9f938667d5e618b2eff685a96f25c4465592766e3d
+  data.tar.gz: d2bd6363ba5ad25ac96d013242cb0d16cf4ed70238d02a2e98bf51e3ccfc16a67b6f835f91a5392c42db226b81bdbba0587e64b807124ef25e12ef834802ff55

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 twokidsCarl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,148 @@
+# marshal-md
+
+Human-readable Ruby Marshal alternative. Serializes Ruby objects to Markdown format with full round-trip fidelity.
+
+## Why?
+
+Ruby's `Marshal.dump` produces opaque binary. `marshal-md` produces readable, diff-friendly text while maintaining the same API and behavior.
+
+```
+Marshal.dump({name: "Alice", age: 30})
+# => "\x04\b{\a:\tname\"\nAlice:\bage\x1Ei\x23"
+
+MarshalMd.dump({name: "Alice", age: 30})
+# => {name: "Alice", age: 30} (Hash)
+```
+
+## Install
+
+```ruby
+gem "marshal-md"
+```
+
+## Usage
+
+API is symmetric with Ruby's `Marshal`:
+
+```ruby
+require "marshal-md"
+
+# Dump
+md = MarshalMd.dump(obj)    # => Markdown string
+MarshalMd.dump(obj, io)     # write to IO
+
+# Load
+obj = MarshalMd.load(md)    # from string
+obj = MarshalMd.load(io)    # from IO
+```
+
+## Format
+
+### Scalars
+
+```
+42 (Integer)
+3.14 (Float)
+"hello world" (String)
+true (Boolean)
+nil (NilClass)
+:foo (Symbol)
+```
+
+### Collections
+
+```
+[1, "two", 3.0] (Array)
+{name: "Alice", age: 30} (Hash)
+1..10 (Range)
+/^\d+$/ (Regexp)
+2026-04-03 10:30:00.000000 +0800 (Time)
+```
+
+### Objects
+
+```
+#<Email> (Email)
+  @subject: "URGENT: Server down"
+  @body: "Database connection pool exhausted"
+  @priority: "high"
+```
+
+### Nested structures
+
+```
+#<User> (User)
+  @name: "Alice"
+  @scores: [85, 92, 78] (Array)
+  @address:
+    #<Address> (Address)
+      @city: "Tokyo"
+      @zip: "100-0001"
+```
+
+### References and circular references
+
+```
+&obj_1 [1, 2, 3] (Array)
+*obj_1 (ref)
+```
+
+Circular:
+```
+&obj_1 (Array)
+  1 (Integer)
+  *obj_1 (ref)
+```
+
+### Binary data
+
+```
+base64:iVBORw0KGgo... (String, ASCII-8BIT, 4096 bytes)
+```
+
+## Monkey-patch mode
+
+Drop-in replacement for `Marshal`:
+
+```ruby
+require "marshal-md/patch"
+
+Marshal.dump(obj)   # => Markdown (not binary)
+Marshal.load(md)    # auto-detects format
+
+# Binary still available
+Marshal.binary_dump(obj)
+Marshal.binary_load(data)
+```
+
+Format detection: binary Marshal starts with `\x04\x08`. Everything else is treated as Markdown.
+
+## Compatibility
+
+Passes the CRuby official `Marshal` test suite (52 tests, 464 assertions).
+
+Supported types:
+- All primitives: Integer, Float, String, Symbol, true, false, nil
+- Collections: Array, Hash, Range, Regexp, Time, Struct
+- Numeric: Complex, Rational
+- Custom objects: instance variables, `marshal_dump`/`marshal_load`, `_dump`/`_load`
+- Subclassed built-in types
+- Module extensions (`extend`, `prepend`)
+- Shared and circular references
+- Class/Module references
+
+Unsupported (same as `Marshal`):
+- Proc / Lambda
+- IO / File
+- Thread / Fiber
+- Binding
+- Method / UnboundMethod
+
+## Requirements
+
+- Ruby >= 2.5
+- Zero runtime dependencies
+
+## License
+
+MIT