paquito 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae7b47980ce61a6b1c3d650217d29a5c196df0c69470a36b74f643d0ded5334c
-  data.tar.gz: 06a85f164bcf5a0e472b4ebf41ce1a9680f71557663ed3176cb7e0df368e460b
+  metadata.gz: 2882e208a7d6cc2c9b98f748578ea1c8e91133a5ecc71fdc4e41861bb7788f7e
+  data.tar.gz: 8376bc939c974028dd6957e1d98467594c33807cdf13fc0470b216aa2476f9ce
 SHA512:
-  metadata.gz: 7fcc3454d84b6cfac7ffe5f3b33780fc23aa609cad375db0e35b43a28582fc3b5dbb6913fc1b3e991b1f034418abe9dbd8c0d673f28e591fc8dee001eefd7c1c
-  data.tar.gz: 2baa0d2518993e2e140f5e989ede70a0d9aa19edb2361414bb6375a6161db0424fcbf7ab03f8f8e531ff0cef9160ea2fa0708afb345b6d3f2d2b3dcdeec332fa
+  metadata.gz: 7bb6ab11609d478cae8993c65fb12db8ea22363064401c718f6e6915ccdd75ad9ddd5c3f7a5a88a8c0562e943c2fda44c4dab101a3db4266f26134ae2ac0e26f
+  data.tar.gz: 268549cd0b872b554397b7d685e0ba9f8db9572690091ebaa4936e7a488a26569e9691ad0bfdf2447d1521a36aa5c26b8a7acf96a04271d449c0a6036de7d777

data/.github/workflows/ci.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '2.6'
+          ruby-version: '2.7'
           bundler-cache: true
       - name: Run test
         run: bundle exec rubocop
@@ -23,18 +23,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ ruby-head, '3.0', '2.7', '2.6' ]
+        ruby: [ ruby-head, '3.1', '3.0', '2.7' ]
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+      - name: Remove Gemfile.lock
+        run: rm Gemfile.lock
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - name: Install dependencies
-        run: |
-          rm Gemfile.lock
-          bundle install
+          bundler-cache: true
       - name: Run test
         run: bundle exec rake
       - name: Install gem

data/.rubocop.yml

@@ -2,4 +2,7 @@ inherit_gem:
   rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
+
+Style/ClassMethodsDefinitions:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Unreleased
 
+# 0.9.0
+
+* Handle `compress / decompress` coders (#22)
+* Introduce `FlatCacheEntryCoder` (#21).
+* Drop the partial Ruby 2.6 support.
+
+# 0.8.0
+
+* Introduce `SingleBytePrefixVersionWithStringBypass` (#18, #20).
+
 # 0.7.0
 
 * Make ActiveRecordCoder now encode wether records were persisted or not (#12).

data/Gemfile.lock

@@ -1,58 +1,56 @@
 PATH
   remote: .
   specs:
-    paquito (0.7.0)
+    paquito (0.9.0)
       msgpack (>= 1.5.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.5)
-      activesupport (= 6.1.5)
-    activerecord (6.1.5)
-      activemodel (= 6.1.5)
-      activesupport (= 6.1.5)
-    activesupport (6.1.5)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
     benchmark-ips (2.10.0)
     byebug (11.1.3)
-    concurrent-ruby (1.1.9)
-    i18n (1.10.0)
+    concurrent-ruby (1.1.10)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.15.0)
-    msgpack (1.5.4)
-    parallel (1.21.0)
-    parser (3.1.1.0)
+    minitest (5.16.3)
+    msgpack (1.6.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
-    rubocop (1.25.1)
+    rubocop (1.30.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
     rubocop-shopify (2.5.0)
       rubocop (~> 1.25)
     ruby-progressbar (1.11.0)
-    sorbet-runtime (0.5.9742)
-    sqlite3 (1.4.2)
-    tzinfo (2.0.4)
+    sorbet-runtime (0.5.10365)
+    sqlite3 (1.4.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    zeitwerk (2.5.4)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,6 +1,6 @@
 # Paquito
 
-`Paquito` provies utility classes to define optimized and evolutive serializers.
+`Paquito` provides utility classes to define optimized and evolutive serializers.
 
 ## Installation
 
@@ -62,6 +62,16 @@ coder.dump([1]) # => "\x01[1]"
 coder.load("\x00---\n:foo: 42") # => { foo: 42 }
 ```
 
+### `SingleBytePrefixVersionWithStringBypass`
+
+Works like `Paquito::SingleBytePrefixVersion` except that versions `253`, `254` and `255` are reserved for serializing strings
+in an optimized way.
+
+When the object to serialize is an `UTF-8`, `ASCII` or `BINARY` string, rather than invoking the underlying serializer, it simply
+prepends a single byte to the string which indicates the encoding.
+
+The larger the string the larger the speed gain is, e.g. for a 1MB string, it's over 500x faster than going through `MessagePack` or `Marshal`.
+
 ### `CommentPrefixVersion`
 
 Similar to the single byte prefix, but meant to be human readable and to allow for migrating unversioned payloads.
@@ -151,6 +161,28 @@ Example:
 ActiveSupport::Cache::FileStore.new("tmp/cache", coder: Paquito.chain(Paquito::CacheEntryCoder, JSON))
 ```
 
+### `FlatCacheEntryCoder`
+
+`Paquito::FlatCacheEntryCoder` is a variation of `Paquito::CacheEntryCoder`. Instead of encoding `ActiveSupport::Cache::Entry`
+into an Array of three members, it serializes the entry metadata itself and adds it as a prefix to the serialized payload.
+
+This allows to leverage `Paquito::SingleBytePrefixVersionWithStringBypass` effectively.
+
+Example:
+
+```ruby
+ActiveSupport::Cache::FileStore.new(
+  "tmp/cache",
+  coder: Paquito::FlatCacheEntryCoder.new(
+    Paquito::SingleBytePrefixVersionWithStringBypass.new(
+      1,
+      0 => Marshal,
+      1 => JSON,
+    )
+  )
+)
+```
+
 ### `SerializedColumn`
 
 `Paquito::SerializedColumn` allows you to decorate any encoder to behave like Rails's builtin `YAMLColumn`

data/Rakefile

@@ -3,8 +3,7 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-suites = [:vanilla, :activesupport]
-suites << :activerecord if RUBY_VERSION >= "2.7"
+suites = [:vanilla, :activesupport, :activerecord]
 namespace :test do
   suites.each do |suite|
     Rake::TestTask.new(suite) do |t|

data/benchmark/flat-entry-coder.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "paquito"
+require "active_support"
+require "benchmark/ips"
+
+CODEC = Paquito::CodecFactory.build
+ORIGINAL = Paquito::SingleBytePrefixVersion.new(
+  0,
+  0 => Paquito.chain(
+    Paquito::CacheEntryCoder,
+    CODEC,
+  ),
+)
+FLAT = Paquito::FlatCacheEntryCoder.new(
+  Paquito::SingleBytePrefixVersionWithStringBypass.new(
+    0,
+    0 => CODEC,
+  )
+)
+
+entries = {
+  small_string: "Hello World!",
+  bytes_1mb: Random.bytes(1_000_000),
+  int_array: 1000.times.to_a,
+}
+
+entries.each do |name, object|
+  entry = ActiveSupport::Cache::Entry.new(object, expires_at: 15.minutes.from_now.to_f)
+  original_payload = ORIGINAL.dump(entry).freeze
+  flat_payload = FLAT.dump(entry).freeze
+
+  puts " === Read #{name} ==="
+  Benchmark.ips do |x|
+    x.report("original") { ORIGINAL.load(original_payload) }
+    x.report("flat") { FLAT.load(flat_payload) }
+    x.compare!(order: :baseline)
+  end
+
+  puts " === Write #{name} ==="
+  Benchmark.ips do |x|
+    x.report("original") { ORIGINAL.dump(entry) }
+    x.report("flat") { FLAT.dump(entry) }
+    x.compare!(order: :baseline)
+  end
+
+  puts
+end

data/benchmark/string-bypass.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "paquito"
+require "benchmark/ips"
+
+CODEC = Paquito::CodecFactory.build([])
+VERSIONED = Paquito::SingleBytePrefixVersion.new(0, 0 => CODEC)
+BYPASS = Paquito::SingleBytePrefixVersionWithStringBypass.new(0, 0 => CODEC)
+
+[100, 10_000, 1_000_000].each do |size|
+  string = Random.bytes(size).freeze
+  msgpack_payload = VERSIONED.dump(string).freeze
+  bypass_payload = BYPASS.dump(string).freeze
+  marshal_payload = Marshal.dump(string).freeze
+
+  puts " === Read #{size}B ==="
+  Benchmark.ips do |x|
+    x.report("marshal") { Marshal.load(marshal_payload) }
+    x.report("msgpack") { VERSIONED.load(msgpack_payload) }
+    x.report("bypass") { BYPASS.load(bypass_payload) }
+    x.compare!(order: :baseline)
+  end
+
+  puts " === Write #{size}B ==="
+  Benchmark.ips do |x|
+    x.report("marshal") { Marshal.dump(string) }
+    x.report("msgpack") { VERSIONED.dump(string) }
+    x.report("bypass") { BYPASS.dump(string) }
+    x.compare!(order: :baseline)
+  end
+
+  puts
+end

data/dev.yml

@@ -2,11 +2,11 @@ name: paquito
 
 up:
   - ruby:
-      version: 2.6.9
+      version: 2.7.5
   - bundler
 
 commands:
   test:
     syntax: ""
     desc: 'run all the tests'
-    run: bundle exec rake test
+    run: bundle exec rake test

data/lib/paquito/active_record_coder.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+gem "activerecord", ">= 7.0"
 require "paquito/errors"
 
 module Paquito

data/lib/paquito/cache_entry_coder.rb

@@ -1,22 +1,15 @@
 # frozen_string_literal: true
 
+gem "activesupport", ">= 7.0"
+
 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
+      entry.pack
     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
+      ::ActiveSupport::Cache::Entry.unpack(payload)
     end
   end
 end

data/lib/paquito/codec_factory.rb

@@ -5,7 +5,7 @@ require "paquito/coder_chain"
 
 module Paquito
   class CodecFactory
-    def self.build(types, freeze: false, serializable_type: false, pool: 1)
+    def self.build(types = [], freeze: false, serializable_type: false, pool: 1)
       factory = if types.empty? && !serializable_type
         MessagePack::DefaultFactory
       else

data/lib/paquito/compressor.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Paquito
+  class Compressor
+    def initialize(compressor)
+      @compressor = compressor
+    end
+
+    def dump(serial)
+      @compressor.compress(serial)
+    end
+
+    def load(payload)
+      @compressor.decompress(payload)
+    end
+  end
+end

data/lib/paquito/flat_cache_entry_coder.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+gem "activesupport", ">= 7.0"
+
+module Paquito
+  class FlatCacheEntryCoder
+    METADATA_CODEC = CodecFactory.build
+
+    EXPIRES_AT_FORMAT = "E" # Float double-precision, little-endian byte order (8 bytes)
+    VERSION_SIZE_FORMAT = "l<" # 32-bit signed, little-endian byte order (int32_t) (4 bytes)
+    PREFIX_FORMAT = -(EXPIRES_AT_FORMAT + VERSION_SIZE_FORMAT)
+    VERSION_SIZE_OFFSET = [0.0].pack(EXPIRES_AT_FORMAT).bytesize # should be 8
+    VERSION_OFFSET = [0.0, 0].pack(PREFIX_FORMAT).bytesize # Should be 12
+    VERSION_SIZE_UNPACK = -"@#{VERSION_SIZE_OFFSET}#{VERSION_SIZE_FORMAT}"
+
+    def initialize(value_coder)
+      @value_coder = value_coder
+    end
+
+    def dump(entry)
+      version = entry.version
+      payload = [
+        entry.expires_at || 0.0,
+        version ? version.bytesize : -1,
+      ].pack(PREFIX_FORMAT)
+      payload << version if version
+      payload << @value_coder.dump(entry.value)
+    end
+
+    def load(payload)
+      expires_at = payload.unpack1(EXPIRES_AT_FORMAT)
+      expires_at = nil if expires_at == 0.0
+
+      version_size = payload.unpack1(VERSION_SIZE_UNPACK)
+      if version_size < 0
+        version_size = 0
+      else
+        version = payload.byteslice(VERSION_OFFSET, version_size)
+      end
+
+      ::ActiveSupport::Cache::Entry.new(
+        @value_coder.load(payload.byteslice((VERSION_OFFSET + version_size)..-1).freeze),
+        expires_at: expires_at,
+        version: version,
+      )
+    end
+  end
+end

data/lib/paquito/single_byte_prefix_version.rb

@@ -3,8 +3,8 @@
 module Paquito
   class SingleBytePrefixVersion
     def initialize(current_version, coders)
-      @current_version = current_version
-      @coders = coders.transform_values { |c| Paquito.cast(c) }
+      @current_version = validate_version(current_version)
+      @coders = coders.transform_keys { |v| validate_version(v) }.transform_values { |c| Paquito.cast(c) }
       @current_coder = coders.fetch(current_version)
     end
 
@@ -23,5 +23,15 @@ module Paquito
       end
       coder.load(payload.byteslice(1..-1))
     end
+
+    private
+
+    def validate_version(version)
+      unless (0..255).cover?(version)
+        raise ArgumentError, "Invalid version #{version.inspect}, versions must be an integer between 0 and 255"
+      end
+
+      version
+    end
   end
 end

data/lib/paquito/single_byte_prefix_version_with_string_bypass.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Paquito
+  class SingleBytePrefixVersionWithStringBypass < SingleBytePrefixVersion
+    UTF8_VERSION = 255
+    BINARY_VERSION = 254
+    ASCII_VERSION = 253
+
+    def dump(object)
+      if object.class == String # We don't want to match subclasses
+        case object.encoding
+        when Encoding::UTF_8
+          UTF8_VERSION.chr(Encoding::BINARY) << object
+        when Encoding::BINARY
+          BINARY_VERSION.chr(Encoding::BINARY) << object
+        when Encoding::US_ASCII
+          ASCII_VERSION.chr(Encoding::BINARY) << object
+        else
+          super
+        end
+      else
+        super
+      end
+    end
+
+    def load(payload)
+      payload_version = payload.getbyte(0)
+      unless payload_version
+        raise UnsupportedCodec, "Missing version byte."
+      end
+
+      case payload_version
+      when UTF8_VERSION
+        payload.byteslice(1..-1).force_encoding(Encoding::UTF_8)
+      when BINARY_VERSION
+        payload.byteslice(1..-1).force_encoding(Encoding::BINARY)
+      when ASCII_VERSION
+        payload.byteslice(1..-1).force_encoding(Encoding::US_ASCII)
+      else
+        coder = @coders.fetch(payload_version) do
+          raise UnsupportedCodec, "Unsupported packer version #{payload_version}"
+        end
+        coder.load(payload.byteslice(1..-1))
+      end
+    end
+
+    private
+
+    def validate_version(version)
+      unless (0..252).cover?(version)
+        raise ArgumentError, "Invalid version #{version.inspect}, versions must be an integer between 0 and 252"
+      end
+
+      version
+    end
+  end
+end

data/lib/paquito/types.rb

@@ -160,7 +160,7 @@ module Paquito
 
           packer.write(value.to_h)
         end,
-        unpacker: ->(unpacker) { HashWithIndifferentAccess.new(unpacker.read) },
+        unpacker: ->(unpacker) { ActiveSupport::HashWithIndifferentAccess.new(unpacker.read) },
         recursive: true,
       },
       "ActiveSupport::TimeWithZone" => {
@@ -206,11 +206,11 @@ module Paquito
     class << self
       def register(factory, types)
         types.each do |type|
-          name = type.name
-
           # Up to Rails 7 ActiveSupport::TimeWithZone#name returns "Time"
-          if name == "Time" && defined?(ActiveSupport::TimeWithZone)
-            name = "ActiveSupport::TimeWithZone" if type == ActiveSupport::TimeWithZone
+          name = if defined?(ActiveSupport::TimeWithZone) && type == ActiveSupport::TimeWithZone
+            "ActiveSupport::TimeWithZone"
+          else
+            type.name
           end
 
           type_attributes = TYPES.fetch(name)

data/lib/paquito/version.rb

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

data/lib/paquito.rb

@@ -14,8 +14,8 @@ 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/single_byte_prefix_version_with_string_bypass"
 require "paquito/comment_prefix_version"
 require "paquito/types"
 require "paquito/codec_factory"
@@ -24,6 +24,8 @@ require "paquito/typed_struct"
 require "paquito/serialized_column"
 
 module Paquito
+  autoload :CacheEntryCoder, "paquito/cache_entry_coder"
+  autoload :FlatCacheEntryCoder, "paquito/flat_cache_entry_coder"
   autoload :ActiveRecordCoder, "paquito/active_record_coder"
 
   class << self
@@ -32,6 +34,8 @@ module Paquito
         coder
       elsif coder.respond_to?(:deflate) && coder.respond_to?(:inflate)
         Deflater.new(coder)
+      elsif coder.respond_to?(:compress) && coder.respond_to?(:decompress)
+        Compressor.new(coder)
       else
         raise TypeError, "Coders must respond to #dump and #load, #{coder.inspect} doesn't"
       end

data/paquito.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Framework for defining efficient and extendable serializers"
   spec.homepage      = "https://github.com/Shopify/paquito"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paquito
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -40,7 +40,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmark/flat-entry-coder.rb
 - benchmark/msgpack-pooling.rb
+- benchmark/string-bypass.rb
 - bin/console
 - bin/setup
 - dev.yml
@@ -51,12 +53,15 @@ files:
 - lib/paquito/codec_factory.rb
 - lib/paquito/coder_chain.rb
 - lib/paquito/comment_prefix_version.rb
+- lib/paquito/compressor.rb
 - lib/paquito/conditional_compressor.rb
 - lib/paquito/deflater.rb
 - lib/paquito/errors.rb
+- lib/paquito/flat_cache_entry_coder.rb
 - lib/paquito/safe_yaml.rb
 - lib/paquito/serialized_column.rb
 - lib/paquito/single_byte_prefix_version.rb
+- lib/paquito/single_byte_prefix_version_with_string_bypass.rb
 - lib/paquito/struct.rb
 - lib/paquito/translate_errors.rb
 - lib/paquito/typed_struct.rb
@@ -79,7 +84,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="