fix(deps): make pact-ffi optional in v1 releases for pact-ruby-standalone consumption

Author: YOU54F

Gemfile

@@ -11,6 +11,11 @@ if ENV['X_PACT_DEVELOPMENT']
   gem "pry-byebug"
 end
 
+group :v2, optional: true do
+  gem "pact-ffi", "~> 0.4.28"
+  gem "ffi"
+end
+
 group :local_development do
   gem "pry-byebug"
 end

documentation/README_V2.md

@@ -20,6 +20,32 @@ The `pact-ruby-v1` is in maintenance mode, as there has been a transition to rus
 - Matchers - implementation of Pact matchers, which are convenient helpers used in consumer-DSL, encapsulating all the logic for serialization into Pact format
 - Mock servers - mock servers that allow for correct execution of provider tests
 
+## Installation
+
+The `pact/v2` namespace is available in `pact-ruby` v1.70.0.
+
+It introduces a suite of new depedencies, including a reliance on the `pact-ffi` and `ffi` gems.
+
+The native extensions are marked in an optional block, so they are opt in.
+
+```rb
+ gem "pact"
+ gem "pact-ffi", "~> 0.4.28" # add this line, to use the pact/v2 namespace
+```
+
+`pact-ffi` ships prebuilt binary gems, and does not support platforms outside of the released [pact_ffi](https://github.com/pact-foundation/pact-reference/tree/master/rust/pact_ffi) libraries
+
+| Version   | Platform             |
+|-----------|----------------------|
+| 0.4.28.0  | x86_64-darwin        |
+| 0.4.28.0  | arm64-darwin         |
+| 0.4.28.0  | x86_64-linux         |
+| 0.4.28.0  | aarch64-linux        |
+| 0.4.28.0  | x86_64-linux-musl    |
+| 0.4.28.0  | aarch64-linux-musl   |
+| 0.4.28.0  | x64-mingw32          |
+| 0.4.28.0  | x64-mingw-ucrt       |
+
 ## Usage
 
 For each type of interaction (due to their specific features), a separate version of DSL has been implemented. However, the general principles remain the same for each type of interaction.

pact.gemspec

@@ -39,7 +39,9 @@ Gem::Specification.new do |gem|
   # Core dependencies (code loading)
   gem.add_dependency "zeitwerk", "~> 2.3"
   # For Pact support via Pact Rust Core
-  gem.add_dependency "pact-ffi", "~> 0.4.28"
+  # moved to optional group in Gemfile, to allow opt in for users who want Pact v2
+  # and to support pact-ruby-standalone which cannot package the ffi for all supported platforms
+  # gem.add_dependency "pact-ffi", "~> 0.4.28"
   # For Provider Side Verification
   gem.add_dependency "rack"
   gem.add_dependency "rack-proxy"