yeptris 0.6.7.4 → 0.6.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42fb4e93ee0f6709742c119496463352356ee978a4365b87c389ca90890a52e6
-  data.tar.gz: ffa4339a75f3e988ef6ce95ec39e3a1abd4fc406a5b5155717d0cfe8571ae1d8
+  metadata.gz: a084064bffdbce7ccb0461e1402e7a91331e530e71b9ad31967d82e6e5b751db
+  data.tar.gz: 0e8c5b97a1e09ef1f3bc4672806b777d68260075536370eedc8b628513f439f8
 SHA512:
-  metadata.gz: 78bf09587ca3d47460b2ba20d1e2bf5e03bf6a519dab0d0c2d04a91302b00246774b1ac70e10b1076196d5ceda8b457ea1da41011e003acc457eaba9eaf85444
-  data.tar.gz: '0992e827312cc11c40dff2a2d1a26a6b0490b407a4ee66cc9c65995b19dce11ca5956701656d7b126300fcfb4a2034e32212baedb64a821f8a47dc6befc7349c'
+  metadata.gz: 9791fdedd1c2afc3588abb612a8b98bd8ae57f065aea74db052b49f46025dfa52c40acb60a2aebb12acb41a5d464a957185d4ee62e0a07b38e069fcc94d431b2
+  data.tar.gz: 6e3931a4cd862b8e8061d9b0c999f73113e0f62e11952ae630abbfd42cbfd76dd3f935a52990ee94a646c319e391b24f379398b940a3ca3fc101084fa31fda9c

data/lib/yeptris/cbor.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Yeptris
+  # CBOR (RFC 8949) over the same FFI document the rest of the
+  # binding rides (TODO.cbor/04). Decode materializes through the
+  # Psych-compatible path; encode builds the tree with YAMLTree and
+  # hands the document to the C encoder — plain data only (aliases
+  # and non-decimal tag text are unencodable by the C contract).
+  #
+  # Representation notes inherited from the decoder: integers beyond
+  # int64 and bignums materialize as their shortest-double text, byte
+  # strings as tag-chained text — CBOR's JSON-data-model mapping.
+  module CBOR
+    STRICT = (1 << 0) # decode: reject non-minimal arguments
+    CANONICAL = (1 << 1) # encode: s4.2.1 core deterministic profile
+
+    class Error < Yeptris::Error; end
+    class UnencodableError < Error; end
+
+    module_function
+
+    def available?
+      defined?(::Yeptris::FFI::CBOR_EX) && ::Yeptris::FFI::CBOR_EX
+    end
+
+    def load(data, strict: false)
+      raise Error, "libyeptris has no CBOR support" unless available?
+
+      doc_ptr = ::Yeptris::FFI.yeptris_cbor_decode(data, data.bytesize, strict ? STRICT : 0, nil)
+      raise ParseError, ::Yeptris::FFI.last_error_message if doc_ptr.null?
+
+      # the wrapper's finalizer also frees — its idempotent #free is
+      # the ONLY release path (a raw double free corrupts the heap)
+      doc = ::Yeptris::Document.new(doc_ptr)
+      doc.root.to_ruby
+    ensure
+      doc&.free
+    end
+
+    def load_sequence(data, strict: false)
+      raise Error, "libyeptris has no CBOR support" unless available?
+
+      items = []
+      receiver = ::FFI::Function.new(:int, %i[pointer pointer size_t]) do |_ctx, item, _index|
+        # the callback owns the item; materialize then free in place
+        # (through the wrapper — the finalizer frees too)
+        doc = ::Yeptris::Document.new(item)
+        items << doc.root&.to_ruby
+        doc.free
+        0
+      end
+      st = ::Yeptris::FFI.yeptris_cbor_decode_sequence(
+        data, data.bytesize, strict ? STRICT : 0, receiver, nil, nil
+      )
+      raise ParseError, ::Yeptris::FFI.last_error_message if st.zero? && !data.empty?
+
+      items
+    end
+
+    def dump(obj, canonical: true)
+      docs = build_documents([obj])
+      begin
+        encode_one(docs[0], canonical)
+      ensure
+        docs.each(&:free)
+      end
+    end
+
+    def dump_sequence(objects, canonical: true)
+      docs = build_documents(objects)
+      begin
+        opts = canonical ? CANONICAL : 0
+        arr = ::FFI::MemoryPointer.new(:pointer, docs.size)
+        arr.write_array_of_pointer(docs.map(&:c_ptr))
+        len_ptr = ::FFI::MemoryPointer.new(:size_t)
+        take_buffer(
+          ::Yeptris::FFI.yeptris_cbor_encode_sequence(arr, docs.size, opts, len_ptr),
+          len_ptr
+        )
+      ensure
+        docs.each(&:free)
+      end
+    end
+
+    # -- internals ----------------------------------------------------
+
+    def build_documents(objects)
+      # ONE document per object: a visitor's tree is a single
+      # document and push sets its root — reuse would overwrite
+      objects.map do |obj|
+        visitor = ::Yeptris::Psych::Visitors::YAMLTree.new
+        visitor.push(obj)
+        visitor.document
+      end
+    end
+
+    def encode_one(doc, canonical)
+      opts = canonical ? CANONICAL : 0
+      len_ptr = ::FFI::MemoryPointer.new(:size_t)
+      take_buffer(::Yeptris::FFI.yeptris_cbor_encode(doc.c_ptr, opts, len_ptr), len_ptr)
+    end
+
+    # The encode convenience contract: a malloc'd buffer plus its
+    # byte length — binary data, freed through the library's own free.
+    def take_buffer(ptr, len_ptr)
+      raise UnencodableError, ::Yeptris::FFI.last_error_message if ptr.null?
+
+      len = len_ptr.read_uint64
+      ptr.read_bytes(len).force_encoding(Encoding::BINARY)
+    ensure
+      ::Yeptris::FFI.yeptris_free(ptr) if ptr && !ptr.null?
+    end
+  end
+end

data/lib/yeptris/ffi.rb

@@ -230,17 +230,45 @@ module Yeptris
       false
     end
 
+    # CBOR (RFC 8949, TODO.cbor): absent on libraries before the
+    # codec's release — the CBOR module feature-detects
+    CBOR_EX = begin
+      attach_function :yeptris_cbor_decode, %i[pointer size_t uint32 yeptris_status_out],
+                      :yeptris_document
+      callback :cbor_item_cb, %i[pointer yeptris_document size_t], :int
+      attach_function :yeptris_cbor_decode_sequence,
+                      %i[pointer size_t uint32 cbor_item_cb pointer yeptris_status_out], :size_t
+      attach_function :yeptris_cbor_encode, %i[yeptris_document uint32 pointer], :pointer
+      attach_function :yeptris_cbor_encode_sequence,
+                      %i[pointer size_t uint32 pointer], :pointer
+      true
+    rescue ::FFI::NotFoundError
+      false
+    end
+
     # Owned char* results (serialize*): one reader, freed exactly once.
     # The release goes through yeptris_free (libyeptris's own
     # allocator-matching free) because ffi's :free attach has no
     # Windows process-symbol fallback — libyeptris.dll doesn't export
     # libc free, so resolving :free against it fails on Windows.
-    begin
+    # A raised attach ABORTS this file mid-evaluation — everything
+    # after it (NODE_SCALAR and the kind constants below) never
+    # defines, and a lazily autoloaded node.rb then dies with
+    # 'uninitialized constant' (#138). Every fallback attaches too.
+    YEPTRIS_FREE = begin
       attach_function :yeptris_free, [:pointer], :void
+      :direct
     rescue ::FFI::NotFoundError
-      # libyeptris < v0.6.6: POSIX resolves :free through the process
-      # symbol table, so the direct libc attach still works there.
-      attach_function :yeptris_free, :free, [:pointer], :void
+      begin
+        # libyeptris < v0.6.6: POSIX resolves :free through the
+        # process symbol table, so the libc attach still works there.
+        attach_function :yeptris_free, :free, [:pointer], :void
+        :libc
+      rescue ::FFI::NotFoundError
+        # no owned-buffer release on this lib+platform combination;
+        # Owned.string leaks instead of killing the whole file
+        :none
+      end
     end
 
     module Owned
@@ -258,7 +286,7 @@ module Yeptris
             else
               ptr.read_string.force_encoding(Encoding::UTF_8)
             end
-        ::Yeptris::FFI.yeptris_free(ptr)
+        ::Yeptris::FFI.yeptris_free(ptr) if ::Yeptris::FFI::YEPTRIS_FREE != :none
         s
       end
     end

data/lib/yeptris/psych/visitors.rb

@@ -41,6 +41,12 @@ module Yeptris
           BuiltDocument.new(@tree)
         end
 
+        # The raw document (the CBOR encoder consumes the tree
+        # directly; #tree wraps it for stdlib's yaml face)
+        def document
+          @tree
+        end
+
         def finish
           @tree.serialize(explicit_doc_start: true)
         end

data/lib/yeptris.rb

@@ -3,7 +3,7 @@
 module Yeptris
   # The gem's version lives in the parent namespace's file — the last
   # internal require (yeptris/version) retired with it.
-  VERSION = "0.6.7.4".freeze
+  VERSION = "0.6.7.5".freeze
   # The error hierarchy lives in THIS file (the parent namespace's
   # own file): nested constants do not trigger a parent-constant
   # autoload, and the law forbids internal requires — defining the
@@ -44,6 +44,7 @@ module Yeptris
   autoload :ValueML, "yeptris/valueml"
   autoload :Psych, "yeptris/psych"
   autoload :Schema, "yeptris/schema"
+  autoload :CBOR, "yeptris/cbor"
 end
 
 # NOTE (the #318 poisoned-process class): the Psych error-name aliases

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yeptris
 version: !ruby/object:Gem::Version
-  version: 0.6.7.4
+  version: 0.6.7.5
 platform: ruby
 authors:
 - Ribose Inc.
@@ -41,6 +41,7 @@ files:
 - ext/yeptris_native/json_ruby.c
 - ext/yeptris_native/yeptris_native.c
 - lib/yeptris.rb
+- lib/yeptris/cbor.rb
 - lib/yeptris/document.rb
 - lib/yeptris/ffi.rb
 - lib/yeptris/json.rb