marshal-md 0.1.0

data/lib/marshal-md/object_registry.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MarshalMd
+  class ObjectRegistry
+    def initialize
+      @id_to_anchor = {} # object_id => "obj_1"
+      @anchor_to_obj = {} # "obj_1" => object
+      @counter = 0
+    end
+
+    # Dump mode: register an object, return its anchor name
+    def register(obj)
+      oid = obj.object_id
+      return @id_to_anchor[oid] if @id_to_anchor.key?(oid)
+
+      @counter += 1
+      anchor = "obj_#{@counter}"
+      @id_to_anchor[oid] = anchor
+      anchor
+    end
+
+    def anchor_for(obj)
+      @id_to_anchor[obj.object_id]
+    end
+
+    def registered?(obj)
+      @id_to_anchor.key?(obj.object_id)
+    end
+
+    # Load mode: store anchor -> object mapping
+    def store(anchor, obj)
+      @anchor_to_obj[anchor] = obj
+    end
+
+    def resolve(anchor)
+      unless @anchor_to_obj.key?(anchor)
+        raise ArgumentError, "undefined reference: *#{anchor}"
+      end
+
+      @anchor_to_obj[anchor]
+    end
+  end
+end

data/lib/marshal-md/patch.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "../marshal-md"
+
+module MarshalMd
+  module Patch
+    BINARY_MARSHAL_HEADER = "\x04\x08".b.freeze
+
+    def self.apply!
+      ::Marshal.class_eval do
+        class << self
+          alias_method :binary_dump, :dump
+          alias_method :binary_load, :load
+
+          def dump(obj, *args)
+            if args.first.respond_to?(:write)
+              io = args.first
+              md = MarshalMd.dump(obj)
+              io.write(md)
+              io
+            else
+              MarshalMd.dump(obj)
+            end
+          end
+
+          def load(source, *args)
+            data = source.respond_to?(:read) ? source.read : source
+            if data.b[0, 2] == MarshalMd::Patch::BINARY_MARSHAL_HEADER
+              binary_load(data, *args)
+            else
+              MarshalMd.load(data)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+MarshalMd::Patch.apply!

data/lib/marshal-md/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MarshalMd
+  VERSION = "0.1.0"
+end

data/lib/marshal-md.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative "marshal-md/version"
+require_relative "marshal-md/object_registry"
+require_relative "marshal-md/dumper"
+require_relative "marshal-md/loader"
+
+module MarshalMd
+  # Match Marshal.dump signature: dump(obj [, io] [, limit])
+  def self.dump(obj, *args)
+    io = nil
+    limit = -1
+
+    args.each do |arg|
+      if arg.respond_to?(:write)
+        io = arg
+      elsif arg.is_a?(Integer)
+        limit = arg
+      end
+    end
+
+    md = Dumper.new(obj, limit: limit).dump
+    if io
+      io.write(md)
+      io
+    else
+      md
+    end
+  end
+
+  # Match Marshal.load signature: load(source [, proc] [, freeze: false])
+  def self.load(source, proc = nil, freeze: false)
+    md = source.respond_to?(:read) ? source.read : source
+    obj = Loader.new(md).load
+    obj = apply_proc_recursive(obj, proc) if proc
+    deep_freeze(obj) if freeze
+    obj
+  end
+
+  class << self
+    private
+
+    # Apply proc to all deserialized objects, bottom-up.
+    # The proc return value replaces the original in parent containers.
+    # Uses an identity map so shared references get the same replacement.
+    def apply_proc_recursive(obj, proc, visited = {}.compare_by_identity)
+      begin
+        return visited[obj] if visited.key?(obj)
+      rescue TypeError
+        # Immediate values
+      end
+
+      # Process children first (bottom-up)
+      case obj
+      when Array
+        obj.each_with_index { |el, i| obj[i] = apply_proc_recursive(el, proc, visited) }
+      when Hash
+        obj.each { |k, v| obj[k] = apply_proc_recursive(v, proc, visited) }
+      end
+
+      result = proc.call(obj)
+
+      begin
+        visited[obj] = result
+      rescue TypeError
+        # Immediate values
+      end
+
+      result
+    end
+
+    def deep_freeze(obj, visited = {}.compare_by_identity)
+      return if obj.frozen?
+
+      begin
+        return if visited.key?(obj)
+        visited[obj] = true
+      rescue TypeError
+        # Immediate values
+      end
+
+      case obj
+      when Array
+        obj.each { |el| deep_freeze(el, visited) }
+      when Hash
+        obj.each { |k, v| deep_freeze(k, visited); deep_freeze(v, visited) }
+      when String
+        # freeze string
+      else
+        obj.instance_variables.each do |iv|
+          deep_freeze(obj.instance_variable_get(iv), visited)
+        end
+      end
+
+      obj.freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: marshal-md
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- twokidsCarl
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Serialize Ruby objects to readable Markdown format. API-compatible with
+  Ruby's built-in Marshal. Passes the CRuby official Marshal test suite.
+email:
+- carl@anz.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/marshal-md.rb
+- lib/marshal-md/dumper.rb
+- lib/marshal-md/loader.rb
+- lib/marshal-md/object_registry.rb
+- lib/marshal-md/patch.rb
+- lib/marshal-md/version.rb
+homepage: https://twokidscarl.github.io/marshal-md
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://twokidscarl.github.io/marshal-md
+  source_code_uri: https://github.com/twokidsCarl/marshal-md
+  changelog_uri: https://github.com/twokidsCarl/marshal-md/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Human-readable Ruby Marshal alternative using Markdown
+test_files: []