paquito 0.11.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c17414fe5eb86f48716aba9c725c46366b93f55dc5995c835cd37e67d4497407
-  data.tar.gz: 56998f2dbe8154770b95baf199fa1c4e784c5463d85350537407d9786aa85aeb
+  metadata.gz: 6b6c5c9838f1a54d3ffce2095ac8b46b423b54eaea4704ace9e7a33ad011316d
+  data.tar.gz: e3b26fc6ecdc8ad279b2f9157089536d69e942fe011458b521da0daf2b8e423d
 SHA512:
-  metadata.gz: 6b6d275659c0714a06ec387799c15d0011a8e568530c16a7719b187d314a47ec8b8b91a19d131e1c5adb182bccf7f591a41b2f19032fdda416be93584aaaed9a
-  data.tar.gz: 9ae37989ccbad977917fd0528c023f73fd56b4ba160058d6ab90b9fbeeb5db8dd4cf3d1eded1d976c92c3ffa666a7e6397a519deda464fb15f231f6d1f9141b0
+  metadata.gz: 513b52e62ba30a9f3f94f63b19b467f9c9dbed9ec3a65d41dd9efe8a50a97bbf580c8c3c29a6dd15a2f4ace5e4f692728377757983d6500ef3b531db83c955e8
+  data.tar.gz: 90b2dffe3fe1569ee79927e7aecead29731665908b03772c300e95bab2e62844fc2a247b4b54da5ab1999c0608fa8bb7606990b1d18777779bf651ada1fd14eb

data/.devcontainer/Dockerfile

@@ -0,0 +1,7 @@
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version
+ARG RUBY_VERSION=3.4.1
+FROM ghcr.io/rails/devcontainer/images/ruby:$RUBY_VERSION
+
+RUN apt-get update && apt-get install -y \
+    libsqlite3-dev \
+    pkg-config

data/.devcontainer/devcontainer.json

@@ -0,0 +1,25 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"dockerFile": "Dockerfile",
+	"features": {
+		"ghcr.io/devcontainers/features/github-cli:1": {}
+	}
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.github/workflows/ci.yml

@@ -29,25 +29,29 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.3'
+          ruby-version: '3.4'
           bundler-cache: true
 
       - name: Install gem
         run: bundle exec rake install
-    
+
 
   rubies:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ ruby-head, '3.3', '3.2', '3.1']
-        rails: [ '7.2', '7.1']
+        ruby: [ ruby-head, '3.4', '3.3', '3.2']
+        rails: [ '8.0', '7.2', '7.1']
         include:
           - ruby: '2.7'
             rails: '7.1'
           - ruby: '3.0'
             rails: '7.1'
+          - ruby: '3.1'
+            rails: '7.1'
+          - ruby: '3.1'
+            rails: '7.2'
     env:
       BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/rails_${{ matrix.rails }}.gemfile
     steps:

data/.ruby-version

@@ -1 +1 @@
-3.3.0
+3.4.1

data/CHANGELOG.md

@@ -1,4 +1,20 @@
-# Unreleased
+# 1.0.0
+
+Both changes in this release require applications to be fully updated to the latest patch version of the gem before
+bumping to this version.
+
+* Store md5 digest of columns + sql types along with records (#51)
+  *IMPORTANT*: if you are storing Active Record objects in the cache, ensure you have updated and deployed 0.11.3 before
+  upgrading, and ensure you are handling either all `ActiveRecordCoder::Error` errors, or that you explicitly add
+  `ActiveRecordCoder::ColumnsDigestMismatch` to your error handling.
+* Bump `Paquito.format_version` to `1` by default.
+  *IMPORTANT*: if you are upgrading from a previous version, you MUST first fully deploy the gem up to at least version 0.10.0
+  and release before enabling it. If you don't, you may notice some `UnpackError` during the code rollout, which may be fine
+  if you only use Paquito for ephemeral cache data. See release notes for v0.10.0.
+
+# 0.11.3
+
+* Deserialize records with extra unused array elements in payload (#52)
 
 # 0.11.2
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paquito (0.11.2)
+    paquito (1.0.0)
       msgpack (>= 1.5.2)
 
 GEM
@@ -37,6 +37,7 @@ GEM
     json (2.7.1)
     language_server-protocol (3.17.0.3)
     logger (1.6.0)
+    mini_portile2 (2.8.8)
     minitest (5.25.1)
     msgpack (1.7.2)
     parallel (1.24.0)
@@ -47,8 +48,7 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.9.0)
-    rexml (3.3.6)
-      strscan
+    rexml (3.3.9)
     rubocop (1.62.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -66,16 +66,16 @@ GEM
       rubocop (~> 1.44)
     ruby-progressbar (1.13.0)
     securerandom (0.3.1)
-    sorbet-runtime (0.5.10712)
-    sqlite3 (2.0.4-arm64-darwin)
-    sqlite3 (2.0.4-x86_64-linux-gnu)
-    strscan (3.1.0)
+    sorbet-runtime (0.5.11633)
+    sqlite3 (2.0.4)
+      mini_portile2 (~> 2.8.0)
     timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
 
 PLATFORMS
+  aarch64-linux
   arm64-darwin
   x86_64-linux
 
@@ -93,4 +93,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.5.7
+   2.6.3

data/gemfiles/rails_8.0.gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "msgpack", ">= 1.5.2"
+
+gem "rake", "~> 13.0"
+gem "activesupport", "~> 8.0.0"
+gem "activerecord", "~> 8.0.0"
+gem "sqlite3"
+gem "benchmark-ips"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop"
+gem "rubocop-shopify", "~> 2.0", require: false
+gem "byebug"
+
+gem "sorbet-runtime"

data/lib/paquito/active_record_coder.rb

@@ -88,9 +88,12 @@ module Paquito
       end
 
       def serialize_record(record)
-        arguments = [record.class.name, attributes_for_database(record)]
-        arguments << true if record.new_record?
-        arguments
+        [
+          record.class.name,
+          attributes_for_database(record),
+          record.new_record?,
+          columns_digest(record.class),
+        ]
       end
 
       def attributes_for_database(record)
@@ -99,18 +102,28 @@ module Paquito
         attributes
       end
 
-      def deserialize_record(class_name, attributes_from_database, new_record = false)
+      def deserialize_record(class_name, attributes_from_database, new_record = false, hash = nil, *)
         begin
           klass = Object.const_get(class_name)
         rescue NameError
           raise ClassMissingError, "undefined class: #{class_name}"
         end
 
+        if hash && (hash != (expected_digest = columns_digest(klass)))
+          raise ColumnsDigestMismatch,
+            "\"#{hash}\" does not match the expected digest of \"#{expected_digest}\""
+        end
+
         # Ideally we'd like to call `klass.instantiate`, however it doesn't allow to pass
         # wether the record was persisted or not.
         attributes = klass.attributes_builder.build_from_database(attributes_from_database, EMPTY_HASH)
         klass.allocate.init_with_attributes(attributes, new_record)
       end
+
+      def columns_digest(klass)
+        str = klass.columns_hash.map { |name, column| [name, column.sql_type].join(":") }.join(",")
+        ::Digest::MD5.digest(str).unpack1("s")
+      end
     end
 
     class Error < ::Paquito::Error
@@ -122,6 +135,9 @@ module Paquito
     class AssociationMissingError < Error
     end
 
+    class ColumnsDigestMismatch < Error
+    end
+
     class InstanceTracker
       def initialize
         @instances = []

data/lib/paquito/version.rb

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

data/lib/paquito.rb

@@ -29,7 +29,7 @@ module Paquito
   autoload :FlatCacheEntryCoder, "paquito/flat_cache_entry_coder"
   autoload :ActiveRecordCoder, "paquito/active_record_coder"
 
-  DEFAULT_FORMAT_VERSION = 0
+  DEFAULT_FORMAT_VERSION = 1
   @format_version = DEFAULT_FORMAT_VERSION
 
   class << self

data/paquito.gemspec

@@ -19,6 +19,14 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/Shopify/paquito"
 
+  spec.post_install_message = <<~POST_INSTALL_MSG
+    Warning: Paquito 1.0 includes potentially breaking changes to ActiveRecordCoder.
+    Before upgrading to 1.0 from an earlier version, ensure you have first upgraded
+    to 0.11.3 and deployed your application before upgrading to 1.0. Also ensure you
+    rescue either all `ActiveRecordCoder::Error` errors, or that you explicitly
+    rescue the new `ActiveRecord::ColumnsDigestError`.
+  POST_INSTALL_MSG
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: paquito
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Jean Boussier
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-17 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -31,6 +30,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
 - ".github/workflows/ci.yml"
 - ".github/workflows/cla.yml"
 - ".gitignore"
@@ -50,6 +51,7 @@ files:
 - dev.yml
 - gemfiles/rails_7.1.gemfile
 - gemfiles/rails_7.2.gemfile
+- gemfiles/rails_8.0.gemfile
 - lib/paquito.rb
 - lib/paquito/active_record_coder.rb
 - lib/paquito/allow_nil.rb
@@ -80,7 +82,12 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/Shopify/paquito
   source_code_uri: https://github.com/Shopify/paquito
-post_install_message:
+post_install_message: |
+  Warning: Paquito 1.0 includes potentially breaking changes to ActiveRecordCoder.
+  Before upgrading to 1.0 from an earlier version, ensure you have first upgraded
+  to 0.11.3 and deployed your application before upgrading to 1.0. Also ensure you
+  rescue either all `ActiveRecordCoder::Error` errors, or that you explicitly
+  rescue the new `ActiveRecord::ColumnsDigestError`.
 rdoc_options: []
 require_paths:
 - lib
@@ -95,8 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Framework for defining efficient and extendable serializers
 test_files: []