paquito 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd75bf76fc877be94ad6310f8fa90840492b2854eab2e98a58f2e5eab976fa9
-  data.tar.gz: 388742a39bfecd9b415eddc0581c19ae76fbada06beef2e929b060059e2b3efa
+  metadata.gz: dd3a891430b40fa7fad9d50b8f383070cee22cba06d19c0db67670324c575613
+  data.tar.gz: 752e27818f5781652fc91407b51a7f5c16e0a8a07baa0f1285b3e4a3c9029bb0
 SHA512:
-  metadata.gz: 1183ea104b4426acee742d3554662564edd7c09b99c9eafd5a5edf96dbecdb4bcb8bf723ed78734f32cb260b312e02da50299b981ad641f85b9077e140e2c49a
-  data.tar.gz: 5ec3f301e10bc80b69bddfeeaeab44dd4ca89bbaf08e4e40b77386d99ff8e90001a1c17c90c6917dc3a737a766d700995789c5257278ee1f8e3caf4c62220004
+  metadata.gz: 7b25933ab48ec3327e7e2c781f6502f90ed7a440163e58c3255d43bb1473fc5da5414b44d85f06de7f0d90ef05d57871bd8fcb3aabd22caa19d97df3422240d2
+  data.tar.gz: aca4aa6e5d417d40926d9cf57045157d1eaffdae225cc051b97ad861e0dc2d19fecf1f6acdea1a9fa91982697cee231326d410a21b0c130f327fc21f967c914e

data/.github/workflows/ci.yml

@@ -3,6 +3,21 @@ name: CI
 on: [push, pull_request]
 
 jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+      - name: Run test
+        run: bundle exec rubocop
+
   rubies:
     runs-on: ubuntu-latest
     strategy:

data/Gemfile

@@ -5,12 +5,13 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in paquito.gemspec
 gemspec
 
-gem "msgpack", github: "msgpack/msgpack-ruby" # Waiting for release of https://github.com/msgpack/msgpack-ruby/pull/220
+gem "msgpack", github: "msgpack/msgpack-ruby"
 
 gem "rake", "~> 13.0"
-gem "activesupport", ">= 7.0.0.alpha2"
-gem "activerecord", ">= 7.0.0.alpha2"
+gem "activesupport", ">= 7.0.0"
+gem "activerecord", ">= 7.0.0"
 gem "sqlite3"
+gem "benchmark-ips"
 
 gem "minitest", "~> 5.0"
 

data/Gemfile.lock

@@ -1,56 +1,57 @@
 GIT
   remote: https://github.com/msgpack/msgpack-ruby.git
-  revision: ea20842ea732f4d625fd30c7b8f67655d73652f2
+  revision: b69e6d6965ef46890885ddf73f02b820f3185d80
   specs:
-    msgpack (1.4.2)
+    msgpack (1.4.5)
 
 PATH
   remote: .
   specs:
-    paquito (0.2.1)
+    paquito (0.4.0)
       msgpack
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.0.alpha2)
-      activesupport (= 7.0.0.alpha2)
-    activerecord (7.0.0.alpha2)
-      activemodel (= 7.0.0.alpha2)
-      activesupport (= 7.0.0.alpha2)
-    activesupport (7.0.0.alpha2)
+    activemodel (7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activerecord (7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activesupport (7.0.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
+    benchmark-ips (2.10.0)
     byebug (11.1.3)
     concurrent-ruby (1.1.9)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
+    minitest (5.15.0)
     parallel (1.21.0)
-    parser (3.0.2.0)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.1)
     rexml (3.2.5)
-    rubocop (1.22.1)
+    rubocop (1.25.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
-      parser (>= 3.0.1.1)
-    rubocop-shopify (2.3.0)
-      rubocop (~> 1.22)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-shopify (2.5.0)
+      rubocop (~> 1.25)
     ruby-progressbar (1.11.0)
-    sorbet-runtime (0.5.9209)
+    sorbet-runtime (0.5.9742)
     sqlite3 (1.4.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
@@ -62,8 +63,9 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  activerecord (>= 7.0.0.alpha2)
-  activesupport (>= 7.0.0.alpha2)
+  activerecord (>= 7.0.0)
+  activesupport (>= 7.0.0)
+  benchmark-ips
   byebug
   minitest (~> 5.0)
   msgpack!
@@ -75,4 +77,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.2.22
+   2.2.33

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ### `chain`
 
-`Paquito::CoderChain` allows to combine two or more serializers into one.
+`Paquito::CoderChain` combines two or more serializers into one.
 
 Example:
 
@@ -34,7 +34,7 @@ compressed_yaml_coder.load(payload) # => { foo: 42 }
 
 ### `ConditionalCompressor`
 
-`Paquito::ConditionalCompressor` compress payloads if they are over a defined size.
+`Paquito::ConditionalCompressor` compresses payloads if they are over a defined size.
 
 Example:
 ```ruby
@@ -45,8 +45,8 @@ coder.dump("foo" * 500) # => "\x01<compressed-data....>"
 
 ### `SingleBytePrefixVersion`
 
-`Paquito::SingleBytePrefixVersion` prepends a version prefix to the payloads, which then allow to seemlessly transition from
-different serialization methods.
+`Paquito::SingleBytePrefixVersion` prepends a version prefix to the payloads, which allows you to seamlessly transition
+between different serialization methods.
 
 The first argument is the current version used for newly generated payloads.
 
@@ -64,9 +64,9 @@ coder.load("\x00---\n:foo: 42") # => { foo: 42 }
 
 ### `CommentPrefixVersion`
 
-Similar to the single byte prefix, but meant to be human readable and to allow for migrating unversionned payloads.
+Similar to the single byte prefix, but meant to be human readable and to allow for migrating unversioned payloads.
 
-Payload without a version prefix are assumed to be version `0`.
+Payloads without a version prefix are assumed to be version `0`.
 
 The first argument is the current version used for newly generated payloads.
 
@@ -84,7 +84,7 @@ coder.dump([1]) # => "#☠1☢\n[1]"
 
 ### `allow_nil`
 
-In some situation where you'd rather not serialize `nil`, you can use the `Paquito.allow_nil` shorthand:
+In some situations where you'd rather not serialize `nil`, you can use the `Paquito.allow_nil` shorthand:
 
 ```ruby
 coder = Paquito.allow_nil(Marshal)
@@ -95,7 +95,7 @@ coder.load(nil) # => nil
 ### `TranslateErrors`
 
 If you do need to handle serialization or deserialization errors, for instance to fallback to acting like a cache miss,
-`Paquito::TranslateErrors` translate all underlying exceptions into `Paquito::Error` descendants.
+`Paquito::TranslateErrors` translates all underlying exceptions into `Paquito::Error` descendants.
 
 Example:
 
@@ -117,9 +117,11 @@ coder.load(coder.dump(%i(foo bar).to_set)) # => #<Set: {:foo, :bar}>
 
 ### `TypedStruct`
 
-`Paquito::TypedStruct` is a opt-in Sorbet runtime plugin that allows `T::Struct` classes to be serializable. You need to explicitly include the module in the `T::Struct` classes that you will be serializing.
+`Paquito::TypedStruct` is a opt-in Sorbet runtime plugin that allows `T::Struct` classes to be serializable. You need
+to explicitly include the module in the `T::Struct` classes that you will be serializing.
 
 Example
+
 ```ruby
 class MyStruct < T::Struct
   include Paquito::TypedStruct
@@ -134,13 +136,24 @@ my_struct.as_pack # => [26450, "foo", 1]
 MyStruct.from_pack([26450, "foo", 1]) # => <MyStruct bar=1, foo="foo">
 ```
 
-## Active Record utilities
+## Rails utilities
+
+`paquito` doesn't depend on `rails` or any of its components, however it does provide some optional utilities.
+
+### `CacheEntryCoder`
+
+`Paquito::CacheEntryCoder` turns an `ActiveSupport::Cache::Entry` instance into a simple `Array` instance. This allows
+you to implement custom coders for `ActiveSupport::Cache`.
 
-`paquito` doesn't not depend on `rails` nor any of it's componement, however it does provide some optional utilities for it.
+Example:
+
+```ruby
+ActiveSupport::Cache::FileStore.new("tmp/cache", coder: Paquito.chain(Paquito::CacheEntryCoder, JSON))
+```
 
 ### `SerializedColumn`
 
-`Paquito::SerializedColumn` allows to decorate any encoder to behave like Rails's builtin `YAMLColumn`
+`Paquito::SerializedColumn` allows you to decorate any encoder to behave like Rails's builtin `YAMLColumn`
 
 Example:
 

data/benchmark/msgpack-pooling.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "paquito"
+require "benchmark/ips"
+
+BASELINE = Paquito::CodecFactory.build([Symbol], pool: false)
+POOLED = Paquito::CodecFactory.build([Symbol], pool: 1)
+
+PAYLOAD = BASELINE.dump(:foo)
+MARSHAL_PAYLOAD = Marshal.dump(:foo)
+
+Benchmark.ips do |x|
+  x.report("marshal") { Marshal.load(MARSHAL_PAYLOAD) }
+  x.report("msgpack") { BASELINE.load(PAYLOAD) }
+  x.report("pooled") { POOLED.load(PAYLOAD) }
+  x.compare!(order: :baseline)
+end

data/lib/paquito/allow_nil.rb

@@ -8,11 +8,13 @@ module Paquito
 
     def dump(object)
       return nil if object.nil?
+
       @coder.dump(object)
     end
 
     def load(payload)
       return nil if payload.nil?
+
       @coder.load(payload)
     end
   end

data/lib/paquito/cache_entry_coder.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Paquito
+  module CacheEntryCoder
+    def self.dump(entry)
+      attrs = [entry.value, entry.expires_at, entry.version]
+      # drop any trailing nil values to save a couple bytes
+      attrs.pop until !attrs.last.nil? || attrs.empty?
+      attrs
+    end
+
+    def self.load(payload)
+      entry = ::ActiveSupport::Cache::Entry.allocate
+      value, expires_in, version = payload
+      entry.instance_variable_set(:@value, value)
+      entry.instance_variable_set(:@expires_in, expires_in)
+      entry.instance_variable_set(:@created_at, 0.0)
+      entry.instance_variable_set(:@version, version)
+      entry
+    end
+  end
+end

data/lib/paquito/codec_factory.rb

@@ -5,15 +5,24 @@ require "paquito/coder_chain"
 
 module Paquito
   class CodecFactory
-    def self.build(types, freeze: false, serializable_type: false)
-      factory =
-        if types.empty? && !serializable_type
-          MessagePack
-        else
-          MessagePack::Factory.new
-        end
+    def self.build(types, freeze: false, serializable_type: false, pool: 1)
+      factory = if types.empty? && !serializable_type
+        MessagePack::DefaultFactory
+      else
+        MessagePack::Factory.new
+      end
+
       Types.register(factory, types) unless types.empty?
       Types.register_serializable_type(factory) if serializable_type
+
+      if pool && pool > 0 && factory.respond_to?(:pool)
+        if serializable_type || types.any? { |t| Types.recursive?(t) }
+          pool *= 2
+        end
+        factory = factory.freeze.pool(pool, freeze: freeze)
+        freeze = false
+      end
+
       MessagePackCodec.new(factory, freeze: freeze)
     end
 
@@ -32,7 +41,11 @@ module Paquito
       end
 
       def load(payload)
-        @factory.load(payload, freeze: @freeze)
+        if @freeze
+          @factory.load(payload, freeze: @freeze)
+        else
+          @factory.load(payload)
+        end
       rescue MessagePack::UnpackError => error
         raise UnpackError, error.message
       rescue IOError => error

data/lib/paquito/safe_yaml.rb

@@ -43,31 +43,37 @@ module Paquito
 
     class RestrictedYAMLTree < Psych::Visitors::YAMLTree
       class DispatchCache
-        def initialize(visitor, cache, permitted_classes)
+        def initialize(visitor, cache)
           @visitor = visitor
           @cache = cache
-          @permitted_classes = permitted_classes
-
-          @permitted_cache = Hash.new do |h, klass|
-            unless @permitted_classes.include?(klass.name)
-              raise UnsupportedType, "Tried to dump unspecified class: #{klass.name.inspect}"
-            end
-
-            h[klass] = true
-          end.compare_by_identity
         end
 
         def [](klass)
-          if @permitted_cache[klass]
-            @cache[klass]
-          end
+          @cache[klass] if @visitor.permitted_class?(klass)
         end
       end
 
       def initialize(...)
         super
         @permitted_classes = Set.new(@options[:permitted_classes])
-        @dispatch_cache = DispatchCache.new(self, @dispatch_cache, @permitted_classes)
+        @dispatch_cache = DispatchCache.new(self, @dispatch_cache)
+        @permitted_cache = Hash.new do |h, klass|
+          unless @permitted_classes.include?(klass.name)
+            raise UnsupportedType, "Tried to dump unspecified class: #{klass.name.inspect}"
+          end
+
+          h[klass] = true
+        end.compare_by_identity
+      end
+
+      def dump_coder(target)
+        return unless permitted_class?(target.class)
+
+        super
+      end
+
+      def permitted_class?(klass)
+        @permitted_cache[klass]
       end
     end
   end

data/lib/paquito/typed_struct.rb

@@ -41,6 +41,7 @@ module Paquito
         if pack_digest != digest
           raise(VersionMismatchError, "#{self} digests do not match")
         end
+
         new(**props.keys.zip(values).to_h)
       end
 

data/lib/paquito/types.rb

@@ -37,10 +37,12 @@ module Paquito
         def register(klass, packer: nil, unpacker:)
           if packer
             raise ArgumentError, "packer for #{klass} already defined" if packers.key?(klass)
+
             packers[klass] = packer
           end
 
           raise ArgumentError, "unpacker for #{klass} already defined" if unpackers.key?(klass)
+
           unpackers[klass] = unpacker
 
           self
@@ -72,13 +74,13 @@ module Paquito
     # New types can be added as long as they have unique #code.
     TYPES = {
       "Symbol" => {
-        code: 0x00,
-        packer: :to_s,
+        code: 0,
+        packer: Symbol.method_defined?(:name) ? :name : :to_s,
         unpacker: :to_sym,
         optimized_symbols_parsing: true,
       }.freeze,
       "Time" => {
-        code: 0x01,
+        code: 1,
         packer: ->(value) do
           rational = value.utc.to_r
           [rational.numerator, rational.denominator].pack(TIME_FORMAT)
@@ -89,7 +91,7 @@ module Paquito
         end,
       }.freeze,
       "DateTime" => {
-        code: 0x02,
+        code: 2,
         packer: ->(value) do
           sec = value.sec + value.sec_fraction
           offset = value.offset
@@ -129,7 +131,7 @@ module Paquito
         end,
       }.freeze,
       "Date" => {
-        code: 0x03,
+        code: 3,
         packer: ->(value) do
           [value.year, value.month, value.day].pack(DATE_FORMAT)
         end,
@@ -139,28 +141,29 @@ module Paquito
         end,
       }.freeze,
       "BigDecimal" => {
-        code: 0x04,
+        code: 4,
         packer: :_dump,
         unpacker: BigDecimal.method(:_load),
       }.freeze,
       # Range => { code: 0x05 }, do not recycle that code
       "ActiveRecord::Base" => {
-        code: 0x6,
+        code: 6,
         packer: ->(value) { ActiveRecordPacker.dump(value) },
         unpacker: ->(value) { ActiveRecordPacker.load(value) },
       }.freeze,
       "ActiveSupport::HashWithIndifferentAccess" => {
-        code: 0x7,
+        code: 7,
         packer: ->(factory, value) do
           unless value.instance_of?(ActiveSupport::HashWithIndifferentAccess)
             raise PackError.new("cannot pack HashWithIndifferentClass subclass", value)
           end
+
           factory.dump(value.to_h)
         end,
         unpacker: ->(factory, value) { HashWithIndifferentAccess.new(factory.load(value)) },
       },
       "ActiveSupport::TimeWithZone" => {
-        code: 0x8,
+        code: 8,
         packer: ->(value) do
           [
             value.utc.to_i,
@@ -176,12 +179,27 @@ module Paquito
         end,
       },
       "Set" => {
-        code: 0x9,
+        code: 9,
         packer: ->(factory, value) { factory.dump(value.to_a) },
         unpacker: ->(factory, value) { factory.load(value).to_set },
       },
-      # Object => { code: 0x7f }, reserved for serializable Object type
-    }.freeze
+      # Integer => { code: 10 }, reserved for oversized Integer
+      # Object => { code: 127 }, reserved for serializable Object type
+    }
+    begin
+      require "msgpack/bigint"
+
+      TYPES["Integer"] = {
+        code: 10,
+        packer: MessagePack::Bigint.method(:to_msgpack_ext),
+        unpacker: MessagePack::Bigint.method(:from_msgpack_ext),
+        oversized_integer_extension: true,
+      }
+    rescue LoadError
+      # expected on older msgpack
+    end
+
+    TYPES.freeze
 
     class << self
       def register(factory, types)
@@ -194,15 +212,23 @@ module Paquito
           end
 
           type_attributes = TYPES.fetch(name)
+          type_attributes = type_attributes.merge(
+            packer: curry_callback(type_attributes.fetch(:packer), factory),
+            unpacker: curry_callback(type_attributes.fetch(:unpacker), factory),
+          )
           factory.register_type(
             type_attributes.fetch(:code),
             type,
-            packer: curry_callback(type_attributes.fetch(:packer), factory),
-            unpacker: curry_callback(type_attributes.fetch(:unpacker), factory),
+            type_attributes
           )
         end
       end
 
+      def recursive?(type)
+        type_attributes = TYPES.fetch(type.name)
+        recursive_callback?(type_attributes[:packer]) || recursive_callback?(type_attributes[:unpacker])
+      end
+
       def register_serializable_type(factory)
         factory.register_type(
           0x7f,
@@ -233,9 +259,14 @@ module Paquito
 
       private
 
+      def recursive_callback?(callback)
+        callback.respond_to?(:arity) && callback.arity != 1
+      end
+
       def curry_callback(callback, factory)
         return callback.to_proc if callback.is_a?(Symbol)
         return callback if callback.arity == 1
+
         callback.curry.call(factory)
       end
     end

data/lib/paquito/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paquito
-  VERSION = "0.2.1"
+  VERSION = "0.4.0"
 end

data/lib/paquito.rb

@@ -14,6 +14,7 @@ require "paquito/allow_nil"
 require "paquito/translate_errors"
 require "paquito/safe_yaml"
 require "paquito/conditional_compressor"
+require "paquito/cache_entry_coder"
 require "paquito/single_byte_prefix_version"
 require "paquito/comment_prefix_version"
 require "paquito/types"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paquito
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-10 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -39,12 +39,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmark/msgpack-pooling.rb
 - bin/console
 - bin/setup
 - dev.yml
 - lib/paquito.rb
 - lib/paquito/active_record_coder.rb
 - lib/paquito/allow_nil.rb
+- lib/paquito/cache_entry_coder.rb
 - lib/paquito/codec_factory.rb
 - lib/paquito/coder_chain.rb
 - lib/paquito/comment_prefix_version.rb