msgpack 1.5.6 → 1.8.0

data/lib/msgpack/factory.rb

@@ -2,11 +2,46 @@ module MessagePack
   class Factory
     # see ext for other methods
 
+    def register_type(type, klass, options = { packer: :to_msgpack_ext, unpacker: :from_msgpack_ext })
+      raise FrozenError, "can't modify frozen MessagePack::Factory" if frozen?
+
+      if options
+        options = options.dup
+        case packer = options[:packer]
+        when nil, Proc
+          # all good
+        when String, Symbol
+          options[:packer] = packer.to_sym.to_proc
+        when Method
+          options[:packer] = packer.to_proc
+        when packer.respond_to?(:call)
+          options[:packer] = packer.method(:call).to_proc
+        else
+          raise ::TypeError, "expected :packer argument to be a callable object, got: #{packer.inspect}"
+        end
+
+        case unpacker = options[:unpacker]
+        when nil, Proc
+          # all good
+        when String, Symbol
+          options[:unpacker] = klass.method(unpacker).to_proc
+        when Method
+          options[:unpacker] = unpacker.to_proc
+        when packer.respond_to?(:call)
+          options[:unpacker] = unpacker.method(:call).to_proc
+        else
+          raise ::TypeError, "expected :unpacker argument to be a callable object, got: #{unpacker.inspect}"
+        end
+      end
+
+      register_type_internal(type, klass, options)
+    end
+
     # [ {type: id, class: Class(or nil), packer: arg, unpacker: arg}, ... ]
     def registered_types(selector=:both)
       packer, unpacker = registered_types_internal
-      # packer: Class -> [tid, proc, arg]
-      # unpacker: tid -> [klass, proc, arg]
+      # packer: Class -> [tid, proc, _flags]
+      # unpacker: tid -> [klass, proc, _flags]
 
       list = []
 
@@ -14,27 +49,31 @@ module MessagePack
       when :both
         packer.each_pair do |klass, ary|
           type = ary[0]
-          packer_arg = ary[2]
-          unpacker_arg = nil
-          if unpacker.has_key?(type) && unpacker[type][0] == klass
-            unpacker_arg = unpacker.delete(type)[2]
+          packer_proc = ary[1]
+          unpacker_proc = nil
+          if unpacker.has_key?(type)
+            unpacker_proc = unpacker.delete(type)[1]
           end
-          list << {type: type, class: klass, packer: packer_arg, unpacker: unpacker_arg}
+          list << {type: type, class: klass, packer: packer_proc, unpacker: unpacker_proc}
         end
 
         # unpacker definition only
         unpacker.each_pair do |type, ary|
-          list << {type: type, class: ary[0], packer: nil, unpacker: ary[2]}
+          list << {type: type, class: ary[0], packer: nil, unpacker: ary[1]}
         end
 
       when :packer
         packer.each_pair do |klass, ary|
-          list << {type: ary[0], class: klass, packer: ary[2]}
+          if ary[1]
+            list << {type: ary[0], class: klass, packer: ary[1]}
+          end
         end
 
       when :unpacker
         unpacker.each_pair do |type, ary|
-          list << {type: type, class: ary[0], unpacker: ary[2]}
+          if ary[1]
+            list << {type: type, class: ary[0], unpacker: ary[1]}
+          end
         end
 
       else
@@ -88,33 +127,34 @@ module MessagePack
 
     class Pool
       if RUBY_ENGINE == "ruby"
-        class AbstractPool
+        class MemberPool
           def initialize(size, &block)
             @size = size
             @new_member = block
             @members = []
           end
 
-          def checkout
-            @members.pop || @new_member.call
-          end
-
-          def checkin(member)
-            # If the pool is already full, we simply drop the extra member.
-            # This is because contrary to a connection pool, creating an extra instance
-            # is extremely unlikely to cause some kind of resource exhaustion.
-            #
-            # We could cycle the members (keep the newer one) but first It's more work and second
-            # the older member might have been created pre-fork, so it might be at least partially
-            # in shared memory.
-            if member && @members.size < @size
-              member.reset
-              @members << member
+          def with
+            member = @members.pop || @new_member.call
+            begin
+              yield member
+            ensure
+              # If the pool is already full, we simply drop the extra member.
+              # This is because contrary to a connection pool, creating an extra instance
+              # is extremely unlikely to cause some kind of resource exhaustion.
+              #
+              # We could cycle the members (keep the newer one) but first It's more work and second
+              # the older member might have been created pre-fork, so it might be at least partially
+              # in shared memory.
+              if member && @members.size < @size
+                member.reset
+                @members << member
+              end
             end
           end
         end
       else
-        class AbstractPool
+        class MemberPool
           def initialize(size, &block)
             @size = size
             @new_member = block
@@ -122,63 +162,50 @@ module MessagePack
             @mutex = Mutex.new
           end
 
-          def checkout
-            @mutex.synchronize { @members.pop } || @new_member.call
-          end
-
-          def checkin(member)
-            @mutex.synchronize do
-              if member && @members.size < @size
-                member.reset
-                @members << member
+          def with
+            member = @mutex.synchronize { @members.pop } || @new_member.call
+            begin
+              yield member
+            ensure
+              member.reset
+              @mutex.synchronize do
+                if member && @members.size < @size
+                  @members << member
+                end
               end
             end
           end
         end
       end
 
-      class PackerPool < AbstractPool
-        private
-
-        def reset(packer)
-          packer.clear
-        end
-      end
-
-      class UnpackerPool < AbstractPool
-        private
-
-        def reset(unpacker)
-          unpacker.reset
-        end
-      end
-
       def initialize(factory, size, options = nil)
         options = nil if !options || options.empty?
         @factory = factory
-        @packers = PackerPool.new(size) { factory.packer(options) }
-        @unpackers = UnpackerPool.new(size) { factory.unpacker(options) }
+        @packers = MemberPool.new(size) { factory.packer(options).freeze }
+        @unpackers = MemberPool.new(size) { factory.unpacker(options).freeze }
       end
 
       def load(data)
-        unpacker = @unpackers.checkout
-        begin
-          unpacker.feed_reference(data)
+        @unpackers.with do |unpacker|
+          unpacker.feed(data)
           unpacker.full_unpack
-        ensure
-          @unpackers.checkin(unpacker)
         end
       end
 
       def dump(object)
-        packer = @packers.checkout
-        begin
+        @packers.with do |packer|
           packer.write(object)
           packer.full_pack
-        ensure
-          @packers.checkin(packer)
         end
       end
+
+      def unpacker(&block)
+        @unpackers.with(&block)
+      end
+
+      def packer(&block)
+        @packers.with(&block)
+      end
     end
   end
 end

data/lib/msgpack/packer.rb

@@ -2,11 +2,20 @@ module MessagePack
   class Packer
     # see ext for other methods
 
+    # The semantic of duping a packer is just too weird.
+    undef_method :dup
+    undef_method :clone
+
+    def register_type(type, klass, method_name = nil, &block)
+      raise ArgumentError, "expected Module/Class got: #{klass.inspect}" unless klass.is_a?(Module)
+      register_type_internal(type, klass, block || method_name.to_proc)
+    end
+
     def registered_types
       list = []
 
       registered_types_internal.each_pair do |klass, ary|
-        list << {type: ary[0], class: klass, packer: ary[2]}
+        list << {type: ary[0], class: klass, packer: ary[1]}
       end
 
       list.sort{|a, b| a[:type] <=> b[:type] }

data/lib/msgpack/unpacker.rb

@@ -2,11 +2,24 @@ module MessagePack
   class Unpacker
     # see ext for other methods
 
+    # The semantic of duping an unpacker is just too weird.
+    undef_method :dup
+    undef_method :clone
+
+    def register_type(type, klass = nil, method_name = nil, &block)
+      if klass && method_name
+        block = klass.method(method_name).to_proc
+      elsif !block_given?
+        raise ArgumentError, "register_type takes either 3 arguments or a block"
+      end
+      register_type_internal(type, klass, block)
+    end
+
     def registered_types
       list = []
 
       registered_types_internal.each_pair do |type, ary|
-        list << {type: type, class: ary[0], unpacker: ary[2]}
+        list << {type: type, class: ary[0], unpacker: ary[1]}
       end
 
       list.sort{|a, b| a[:type] <=> b[:type] }

data/lib/msgpack/version.rb

@@ -1,5 +1,5 @@
 module MessagePack
-  VERSION = "1.5.6"
+  VERSION = "1.8.0"
   # Note for maintainers:
   #  Don't miss building/releasing the JRuby version (rake buld:java)
   #  See "How to build -java rubygems" in README for more details.

data/lib/msgpack.rb

@@ -7,6 +7,7 @@ else
   require "msgpack/msgpack"
 end
 
+require "msgpack/buffer"
 require "msgpack/packer"
 require "msgpack/unpacker"
 require "msgpack/factory"

data/msgpack.gemspec

@@ -12,20 +12,25 @@ Gem::Specification.new do |s|
   s.homepage = "http://msgpack.org/"
   s.require_paths = ["lib"]
   if /java/ =~ RUBY_PLATFORM
-    s.files = Dir['lib/**/*.rb', 'lib/**/*.jar']
+    s.files = Dir['lib/**/*.rb', 'lib/**/*.jar', 'LICENSE']
     s.platform = Gem::Platform.new('java')
   else
-    s.files = `git ls-files`.split("\n")
+    s.files = `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features|bench|doclib|msgpack.org.md|Gemfile|Rakefile)|\.(?:git|circleci|rubocop)|appveyor)})
+    end
     s.extensions = ["ext/msgpack/extconf.rb"]
   end
 
-  s.required_ruby_version = ">= 2.4"
+  s.required_ruby_version = ">= 2.5"
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rake-compiler', ['>= 1.1.9']
   s.add_development_dependency 'rspec', ['~> 3.3']
+  s.add_development_dependency 'ruby_memcheck'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'json'
   s.add_development_dependency 'benchmark-ips', ['~> 2.10.0']
+
+  s.metadata["changelog_uri"] = "https://github.com/msgpack/msgpack-ruby/blob/master/ChangeLog"
 end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: msgpack
 version: !ruby/object:Gem::Version
-  version: 1.5.6
+  version: 1.8.0
 platform: ruby
 authors:
 - Sadayuki Furuhashi
 - Theo Hultberg
 - Satoshi Tagomori
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2025-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,6 +67,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: ruby_memcheck
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -122,26 +135,9 @@ extensions:
 - ext/msgpack/extconf.rb
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yaml"
-- ".gitignore"
-- ".rubocop.yml"
 - ChangeLog
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- appveyor.yml
-- bench/bench.rb
-- doclib/msgpack.rb
-- doclib/msgpack/buffer.rb
-- doclib/msgpack/core_ext.rb
-- doclib/msgpack/error.rb
-- doclib/msgpack/extension_value.rb
-- doclib/msgpack/factory.rb
-- doclib/msgpack/packer.rb
-- doclib/msgpack/time.rb
-- doclib/msgpack/timestamp.rb
-- doclib/msgpack/unpacker.rb
 - ext/java/org/msgpack/jruby/Buffer.java
 - ext/java/org/msgpack/jruby/Decoder.java
 - ext/java/org/msgpack/jruby/Encoder.java
@@ -182,6 +178,7 @@ files:
 - ext/msgpack/unpacker_ext_registry.h
 - lib/msgpack.rb
 - lib/msgpack/bigint.rb
+- lib/msgpack/buffer.rb
 - lib/msgpack/core_ext.rb
 - lib/msgpack/factory.rb
 - lib/msgpack/packer.rb
@@ -191,37 +188,11 @@ files:
 - lib/msgpack/unpacker.rb
 - lib/msgpack/version.rb
 - msgpack.gemspec
-- msgpack.org.md
-- spec/bigint_spec.rb
-- spec/cases.json
-- spec/cases.msg
-- spec/cases_compact.msg
-- spec/cases_spec.rb
-- spec/cruby/buffer_io_spec.rb
-- spec/cruby/buffer_packer.rb
-- spec/cruby/buffer_spec.rb
-- spec/cruby/buffer_unpacker.rb
-- spec/cruby/unpacker_spec.rb
-- spec/ext_value_spec.rb
-- spec/exttypes.rb
-- spec/factory_spec.rb
-- spec/format_spec.rb
-- spec/jruby/benchmarks/shootout_bm.rb
-- spec/jruby/benchmarks/symbolize_keys_bm.rb
-- spec/jruby/unpacker_spec.rb
-- spec/msgpack_spec.rb
-- spec/pack_spec.rb
-- spec/packer_spec.rb
-- spec/random_compat.rb
-- spec/spec_helper.rb
-- spec/timestamp_spec.rb
-- spec/unpack_spec.rb
-- spec/unpacker_spec.rb
 homepage: http://msgpack.org/
 licenses:
 - Apache 2.0
-metadata: {}
-post_install_message:
+metadata:
+  changelog_uri: https://github.com/msgpack/msgpack-ruby/blob/master/ChangeLog
 rdoc_options: []
 require_paths:
 - lib
@@ -229,15 +200,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: MessagePack, a binary-based efficient data interchange format.
 test_files: []

data/.github/workflows/ci.yaml

@@ -1,57 +0,0 @@
-name: ci
-
-on:
-  pull_request:
-    branches: '*'
-  push:
-    branches:
-      - master
-      - main
-      - 'release-*'
-
-jobs:
-  mri:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu, macos, windows]
-        ruby: ['2.4', '2.5', '2.6', '2.7', '3.0', '3.1']
-    runs-on: ${{ matrix.os }}-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true # 'bundle install' and cache
-      - run: bundle exec rake
-
-  other:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu]
-        ruby: ['jruby-9.2.19.0', 'jruby-9.3.3.0', 'truffleruby']
-    runs-on: ${{ matrix.os }}-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true # 'bundle install' and cache
-      - run: bundle exec rake spec
-
-  head-versions:
-    continue-on-error: true
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu]
-        ruby: ['ruby-head', 'jruby-head']
-    runs-on: ${{ matrix.os }}-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true # 'bundle install' and cache
-      - run: bundle exec rake spec || echo "failed, but ignore it"

data/.gitignore

@@ -1,23 +0,0 @@
-*.o
-*.so
-*.bundle
-*.gem
-*.class
-*.jar
-doc
-.yardoc
-.bundle
-Gemfile*
-pkg
-test/debug.log
-*~
-*.swp
-/rdoc
-tmp
-.classpath
-.project
-.settings
-/nbproject/private/
-coverage/
-.idea/
-.ruby-version

data/.rubocop.yml

@@ -1,36 +0,0 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-03-09 17:42:55 +0100 using RuboCop version 0.29.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-AllCops:
-  TargetRubyVersion: 2.4
-
-# Offense count: 3
-Lint/AmbiguousOperator:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: AllowSafeAssignment.
-Lint/AssignmentInCondition:
-  Enabled: false
-
-# Offense count: 1
-Security/Eval:
-  Enabled: false
-
-# Offense count: 3
-# Cop supports --auto-correct.
-Lint/UnusedBlockArgument:
-  Enabled: false
-
-# Offense count: 35
-# Cop supports --auto-correct.
-Lint/UnusedMethodArgument:
-  Enabled: false
-
-# Offense count: 128
-Lint/Void:
-  Enabled: false

data/Gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org/'
-
-gemspec
-
-## enable this line to run benchmarks
-# gem "viiite"
-
-gem "rubocop", "~> 0.82.0"
-gem "simplecov"

data/Rakefile

@@ -1,70 +0,0 @@
-
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'fileutils'
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-require 'yard'
-
-task :spec => :compile
-
-desc 'Run RSpec code examples and measure coverage'
-task :coverage do |t|
-  ENV['SIMPLE_COV'] = '1'
-  Rake::Task["spec"].invoke
-end
-
-desc 'Generate YARD document'
-YARD::Rake::YardocTask.new(:doc) do |t|
-  t.files   = ['lib/msgpack/version.rb','doclib/**/*.rb']
-  t.options = []
-  t.options << '--debug' << '--verbose' if $trace
-end
-
-spec = eval File.read("msgpack.gemspec")
-
-if RUBY_PLATFORM =~ /java/
-  require 'rake/javaextensiontask'
-
-  Rake::JavaExtensionTask.new('msgpack', spec) do |ext|
-    ext.ext_dir = 'ext/java'
-    jruby_home = RbConfig::CONFIG['prefix']
-    jars = ["#{jruby_home}/lib/jruby.jar"]
-    ext.classpath = jars.map { |x| File.expand_path(x) }.join(':')
-    ext.lib_dir = File.join(*['lib', 'msgpack', ENV['FAT_DIR']].compact)
-    ext.release = '8'
-  end
-else
-  require 'rake/extensiontask'
-
-  Rake::ExtensionTask.new('msgpack', spec) do |ext|
-    ext.ext_dir = 'ext/msgpack'
-    ext.cross_compile = true
-    ext.lib_dir = File.join(*['lib', 'msgpack', ENV['FAT_DIR']].compact)
-    # cross_platform names are of MRI's platform name
-    ext.cross_platform = ['x86-mingw32', 'x64-mingw32']
-  end
-end
-
-test_pattern = case
-               when RUBY_PLATFORM =~ /java/ then 'spec/{,jruby/}*_spec.rb'
-               when RUBY_ENGINE =~ /rbx/ then 'spec/*_spec.rb'
-               else 'spec/{,cruby/}*_spec.rb' # MRI
-               end
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = ["-c", "-f progress"]
-  t.rspec_opts << "-Ilib"
-  t.pattern = test_pattern
-  t.verbose = true
-end
-
-namespace :build do
-  desc 'Build gem for JRuby after cleaning'
-  task :java => [:clean, :spec, :build]
-end
-
-CLEAN.include('lib/msgpack/msgpack.*')
-
-task :default => [:spec, :build, :doc]

data/appveyor.yml

@@ -1,18 +0,0 @@
----
-install:
-  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
-  - ruby --version
-  - gem --version
-  - bundle install
-build: off
-test_script:
-  - bundle exec rake -rdevkit
-
-environment:
-  matrix:
-    - ruby_version: "200"
-    - ruby_version: "200-x64"
-    - ruby_version: "21"
-    - ruby_version: "21-x64"
-    - ruby_version: "22"
-    - ruby_version: "22-x64"