ciborium 0.1.0-x86_64-linux-gnu

data/lib/ciborium/extensions/uri.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+require "uri"
+
+module Ciborium
+  module Extensions
+    # Tag 32 (RFC 8949 section 3.4.5.3) as URI.
+    class URI
+      #: () -> Array[Integer]
+      def tags = [32]
+
+      #: () -> Array[Module]
+      def classes = [::URI::Generic]
+
+      #: (Integer tag, untyped value) -> ::URI::Generic
+      def decode(tag, value)
+        raise ArgumentError, "tag #{tag} content must be text" unless value.is_a?(String)
+
+        ::URI.parse(value)
+      end
+
+      #: (::URI::Generic object) -> Tagged
+      def encode(object)
+        Tagged.new(32, object.to_s)
+      end
+    end
+  end
+end

data/lib/ciborium/extensions.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+module Ciborium
+  # Tag handling beyond Tagged, enabled per call through the extensions: option.
+  #
+  # An extension is any object that responds to:
+  #
+  # - tags: the tag numbers it decodes
+  # - classes: the classes whose instances it encodes
+  # - decode(tag, value): the object for a tag's decoded content
+  # - encode(object): an object to encode in place of object, typically a Tagged
+  #
+  # Symbols name the built-in extensions.
+  module Extensions
+    BUILTIN = {
+      bignum: "BigInteger",
+      time: "Time",
+      uri: "URI",
+      regexp: "Regexp",
+    }.freeze #: Hash[Symbol, String]
+
+    # Resolves Symbols to the built-in extensions and checks every entry is an extension.
+    #
+    #: (untyped extensions) -> Array[_Extension]
+    def self.resolve(extensions)
+      unless extensions.is_a?(Array)
+        raise ArgumentError, "extensions must be an Array, got #{extensions.inspect}"
+      end
+
+      extensions.map do |extension|
+        next builtin(extension) if extension.is_a?(Symbol)
+
+        unless [:tags, :classes, :decode, :encode].all? { |m| extension.respond_to?(m) }
+          raise ArgumentError, "#{extension.inspect} does not implement tags, classes, decode and encode"
+        end
+
+        extension
+      end
+    end
+
+    # Maps each tag to a callable that wraps the extension's failures in ExtensionError.
+    #
+    #: (Array[_Extension] extensions) -> Hash[Integer, ^(Integer, untyped) -> untyped]?
+    def self.tag_handlers(extensions)
+      return if extensions.empty?
+
+      handlers = {} #: Hash[Integer, ^(Integer, untyped) -> untyped]
+      extensions.each do |extension|
+        extension.tags.each do |tag|
+          raise ArgumentError, "more than one extension decodes tag #{tag}" if handlers.key?(tag)
+
+          handlers[tag] = ->(t, value) do
+            extension.decode(t, value)
+          rescue StandardError
+            raise ExtensionError, "#{extension.inspect} failed to decode tag #{t}"
+          end
+        end
+      end
+      handlers.freeze
+    end
+
+    # Pairs each class with a callable that wraps the extension's failures in EncodeError.
+    #
+    #: (Array[_Extension] extensions) -> Array[[Module, ^(untyped) -> untyped]]?
+    def self.class_handlers(extensions)
+      return if extensions.empty?
+
+      extensions.flat_map do |extension|
+        handler = ->(object) do
+          extension.encode(object)
+        rescue StandardError
+          raise EncodeError, "#{extension.inspect} failed to encode an instance of #{object.class}"
+        end
+        extension.classes.map do |klass|
+          raise ArgumentError, "#{extension.inspect} lists #{klass.inspect}, which is not a Module" unless klass.is_a?(Module)
+
+          [klass, handler] #: [Module, ^(untyped) -> untyped]
+        end
+      end.freeze
+    end
+
+    #: (Symbol name) -> _Extension
+    private_class_method def self.builtin(name)
+      class_name = BUILTIN.fetch(name) do
+        raise ArgumentError, "unknown extension #{name.inspect}; built-in ones are #{BUILTIN.keys.inspect}"
+      end
+      require_relative "extensions/#{name}"
+      const_get(class_name).new
+    end
+  end
+end

data/lib/ciborium/native.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+require "rbconfig"
+
+# Precompiled gems carry one extension per Ruby minor under lib/ciborium/<X.Y>/.
+fat = File.expand_path("#{RUBY_VERSION[/\A\d+\.\d+/]}/ciborium_native", __dir__.to_s)
+if File.exist?("#{fat}.#{RbConfig::CONFIG.fetch("DLEXT")}")
+  require fat
+else
+  require_relative "ciborium_native"
+end
+
+module Ciborium
+  module Native
+    # Called by the encoder for text in an encoding other than UTF-8 or US-ASCII.
+    #
+    #: (String string) -> String
+    def self.transcode(string)
+      string.encode(Encoding::UTF_8)
+    rescue EncodingError
+      raise EncodeError, "cannot transcode a #{string.encoding} string to UTF-8"
+    end
+  end
+end

data/lib/ciborium/replace.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+# Installs Ciborium::Compat as CBOR, the constant of the cbor gem, in the manner of resolv-replace.
+# Require it before anything requires "cbor": with Bundler, after bundler/setup and before
+# Bundler.require.
+
+require_relative "compat"
+
+module Ciborium
+  module Compat
+    # Classes the cbor gem gives to_cbor. URI::Generic is included when URI is loaded.
+    CORE_EXT_CLASSES = [
+      NilClass,
+      TrueClass,
+      FalseClass,
+      Integer,
+      Float,
+      String,
+      Array,
+      Hash,
+      Symbol,
+      Time,
+      Regexp,
+      Ciborium::Tagged,
+      Ciborium::Simple,
+    ].freeze #: Array[Module]
+
+    # Constants of the cbor gem that CBOR carries.
+    CBOR_CONSTANTS = [
+      :Packer, :Unpacker, :Buffer, :Tagged, :Simple, :UnpackError, :MalformedFormatError, :StackError, :TypeError,
+    ].freeze #: Array[Symbol]
+
+    # Module functions of the cbor gem that CBOR carries.
+    CBOR_FUNCTIONS = [:encode, :pack, :dump, :decode, :unpack, :load].freeze #: Array[Symbol]
+
+    # @rbs self.@facade: Module?
+
+    # The frozen module installed as CBOR. It delegates to Compat rather than being Compat, so the
+    # cbor gem's extension, should it load anyway, fails on reopening it instead of replacing
+    # Compat's methods with its own.
+    #
+    #: () -> Module
+    def self.facade
+      @facade ||= begin
+        compat = self
+        facade = Module.new
+        CBOR_CONSTANTS.each { |name| facade.const_set(name, const_get(name)) }
+        CBOR_FUNCTIONS.each do |name|
+          facade.define_singleton_method(name) { |*args| compat.public_send(name, *args) }
+        end
+        [Packer, Unpacker, Buffer].each(&:freeze)
+        facade.freeze
+      end
+    end
+
+    # Marks every file of the installed cbor gems that require "cbor" could load as loaded.
+    #
+    #: () -> void
+    def self.block_cbor_gem
+      $LOADED_FEATURES.concat(cbor_gem_features - $LOADED_FEATURES)
+    end
+
+    # The cbor gem's entry point and extension: as found on the load path, and in every
+    # installed version, since RubyGems may activate any of them later.
+    #
+    #: () -> Array[String]
+    def self.cbor_gem_features
+      paths = ["cbor", "cbor/cbor"].filter_map do |feature|
+        _type, path = $LOAD_PATH.resolve_feature_path(feature)
+        path
+      rescue LoadError
+        nil
+      end
+      if defined?(Gem::Specification)
+        Gem::Specification.find_all_by_name("cbor").each do |spec|
+          spec.full_require_paths.each do |dir|
+            paths.concat(Dir[File.join(dir, "cbor.rb"), File.join(dir, "cbor", "{,*/}cbor.{so,bundle}")])
+          end
+        end
+      end
+      paths.uniq
+    end
+
+    #: () -> void
+    def self.install
+      block_cbor_gem
+      if Object.const_defined?(:CBOR, false) && !Object.const_get(:CBOR, false).equal?(facade)
+        warn(
+          "ciborium/replace: CBOR was already defined, likely by the cbor gem, and is now replaced. " \
+            "Require ciborium/replace before Bundler.require so the cbor gem is never loaded.",
+        )
+        Object.send(:remove_const, :CBOR)
+      end
+      Object.const_set(:CBOR, facade) unless Object.const_defined?(:CBOR, false)
+
+      classes = CORE_EXT_CLASSES.dup
+      classes << ::URI::Generic if defined?(::URI::Generic)
+      # prepend rather than include, so these replace to_cbor the cbor gem defined on the class.
+      classes.each { |klass| klass.prepend(CoreExt) }
+    end
+  end
+end
+
+Ciborium::Compat.install

data/lib/ciborium/simple.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+# rbs_inline: disabled
+
+module Ciborium
+  # A simple value (RFC 8949 section 3.3) other than false, true and null.
+  Simple = Data.define(:value)
+
+  class Simple
+    def initialize(value:)
+      raise ::TypeError, "simple value must be an Integer, got #{value.inspect}" unless value.is_a?(Integer)
+      # 24 to 31 are reserved, so no well-formed encoding exists for them.
+      unless value.between?(0, 23) || value.between?(32, 255)
+        raise ::RangeError, "simple value must be in 0..23 or 32..255, got #{value}"
+      end
+
+      super
+    end
+  end
+
+  UNDEFINED = Simple.new(23)
+end

data/lib/ciborium/tagged.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+# rbs_inline: disabled
+
+module Ciborium
+  # A tagged data item (RFC 8949 section 3.4) that no allowlisted extension interprets.
+  Tagged = Data.define(:tag, :value)
+
+  class Tagged
+    MAX_TAG = 2**64 - 1
+
+    def initialize(tag:, value:)
+      raise ::TypeError, "tag must be an Integer, got #{tag.inspect}" unless tag.is_a?(Integer)
+      raise ::RangeError, "tag must be between 0 and 2**64-1, got #{tag}" unless tag.between?(0, MAX_TAG)
+
+      super
+    end
+  end
+end

data/lib/ciborium/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+module Ciborium
+  VERSION = "0.1.0" #: String
+end

data/lib/ciborium.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+# rbs_inline: enabled
+
+require_relative "ciborium/version"
+require_relative "ciborium/errors"
+require_relative "ciborium/tagged"
+require_relative "ciborium/simple"
+require_relative "ciborium/encoded"
+require_relative "ciborium/native"
+require_relative "ciborium/extensions"
+require_relative "ciborium/decode_options"
+require_relative "ciborium/encode_options"
+require_relative "ciborium/encoder"
+require_relative "ciborium/decoder"
+
+# A CBOR (RFC 8949) encoder and decoder. Tags carry no meaning unless an extension for them is
+# allowlisted.
+module Ciborium
+  # Encodes object into a binary String.
+  #
+  # Options are those of EncodeOptions.build.
+  #
+  #: (untyped object, **untyped options) -> String
+  def self.encode(object, **options)
+    opts = EncodeOptions.build(**options)
+    Native.encode(object, opts.max_depth, opts.flags, opts.fallback, opts.class_handlers)
+  end
+
+  # Decodes a single data item. Raises MalformedError when bytes follow it.
+  #
+  # Options are those of DecodeOptions.build.
+  #
+  #: (String bytes, **untyped options) -> untyped
+  def self.decode(bytes, **options)
+    value, pos = decode_prefix(bytes, **options)
+    unless pos == bytes.bytesize
+      raise MalformedError, "#{bytes.bytesize - pos} bytes follow the decoded item"
+    end
+
+    value
+  end
+
+  # Decodes the data item at the start of bytes and returns it with the number of bytes it took,
+  # leaving whatever follows unread.
+  #
+  #: (String bytes, **untyped options) -> [untyped, Integer]
+  def self.decode_prefix(bytes, **options)
+    opts = DecodeOptions.build(**options)
+    Native.decode(bytes, 0, opts.max_depth, opts.flags, opts.handlers)
+  end
+
+  # Decodes a CBOR sequence (RFC 8742), a concatenation of zero or more data items.
+  #
+  #: (String bytes, **untyped options) -> Array[untyped]
+  def self.decode_sequence(bytes, **options)
+    opts = DecodeOptions.build(**options)
+    items = [] #: Array[untyped]
+    pos = 0
+    while pos < bytes.bytesize
+      item, pos = Native.decode(bytes, pos, opts.max_depth, opts.flags, opts.handlers)
+      items << item
+    end
+    items
+  end
+end

data/licenses/cfg-if-LICENSE-APACHE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/licenses/cfg-if-LICENSE-MIT

@@ -0,0 +1,25 @@
+Copyright (c) 2014 Alex Crichton
+
+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.