feat: add support for generate_from_provider_state

Author: YOU54F

documentation/README_V2.md

@@ -172,14 +172,23 @@ For details of the implementation, see [matchers.rb](../lib/pact/v2/generators.r
 - `generate_time(format: nil)` - Generates a time string in the specified `format`.
 - `generate_datetime(format: nil)` - Generates a datetime string in the specified `format`.
 - `generate_random_boolean` - Generates a random boolean value (`true` or `false`).
-- `generate_from_provider_state(expression:)` - Generates a value from the provider state using the given `expression`.
+- `generate_from_provider_state(expression:, example:)` - Generates a value from the provider state using the given `expression` and `example` value. Allows templating of url and query paths with values only know at provider verification time.
 - `generate_mock_server_url(regex: nil, example: nil)` - Generates a mock server URL. Optionally, specify a `regex` matches and/or an `example` value.
 
 These generators can be used in your DSL definitions to provide dynamic values for requests, responses, or messages in your contract tests.
 
 #### Generator Examples
 
 ```rb
+  .with_request(
+    method: :get, 
+    path: generate_from_provider_state(
+      expression: '/alligators/${alligator_name}',
+      example: '/alligators/Mary'),
+    headers: headers)
+
+...
+
   body: {
     _links: {
       :'pf:publish-provider-contract' => {
@@ -433,30 +442,30 @@ The following projects were designed for pact-ruby-v1 and have been migrated to
 
 - pact broker client
   - v1
-  - v2 https://github.com/YOU54F/pact_broker-client/pull/1
+  - v2 <https://github.com/YOU54F/pact_broker-client/pull/1>
 - pact broker
   - v1
-  - v2 https://github.com/YOU54F/pact_broker/pull/14
+  - v2 <https://github.com/YOU54F/pact_broker/pull/14>
 - animal service
   - v1
     - In repo: [example/animal-service](../example/animal-service/)
-    - Standalone: https://github.com/safdotdev/animal-service
+    - Standalone: <https://github.com/safdotdev/animal-service>
   - v2
     - In repo: [example/animal-service-v2](../example/animal-service-v2/)
-    - Standalone: https://github.com/safdotdev/animal-service/pull/1
+    - Standalone: <https://github.com/safdotdev/animal-service/pull/1>
 - zoo app
   - v1
     - In repo: [example/zoo-app](../example/zoo-app/)
-    - Standalone: https://github.com/safdotdev/zoo-app
+    - Standalone: <https://github.com/safdotdev/zoo-app>
   - v2
     - In repo: [example/zoo-app-v2](../example/zoo-app-v2/)
-    - Standalone: https://github.com/safdotdev/zoo-app/pull/1
+    - Standalone: <https://github.com/safdotdev/zoo-app/pull/1>
 - message consumer/provider
   - v1
-  - v2 https://github.com/safdotdev/pact-ruby-demo/compare/main...safdotdev:pact-ruby-demo:feat/pact-ruby-v2
+  - v2 <https://github.com/safdotdev/pact-ruby-demo/compare/main...safdotdev:pact-ruby-demo:feat/pact-ruby-v2>
 - e2e http consumer/provider
   - v1
-  - v2 https://github.com/safdotdev/pact-ruby-e2e-example/pull/1
+  - v2 <https://github.com/safdotdev/pact-ruby-e2e-example/pull/1>
 
 ### Demos
 

example/animal-service-v2/Rakefile

@@ -8,5 +8,5 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new('pact:v2:verify') do |task|
   task.pattern = 'spec/pact/consumers/*_spec.rb'
-  task.rspec_opts = ['-t pact', '--require rails_helper']
+  task.rspec_opts = ['-t pact_v2', '--require rails_helper']
 end

example/animal-service-v2/spec/pact/consumers/http_spec.rb

@@ -9,7 +9,7 @@
 include RSpec::Mocks::ExampleMethods
 
 RSpec.describe 'Verify consumers for Bar Provider', :pact_v2 do
-  http_pact_provider 'Animal Service', opts: { 
+  http_pact_provider 'Animal Service', opts: {
     pact_dir: File.expand_path('../../../../zoo-app-v2/spec/pacts', __dir__),
     http_port: 9292,
     app: AnimalService::Api
@@ -25,6 +25,12 @@
     end
   end
 
+  provider_state 'there is an alligator named {alligator_name}' do
+    set_up do |params|
+      AnimalService::DATABASE[:animals].insert(name: params['alligator_name'])
+    end
+  end
+
   provider_state 'there is not an alligator named Mary' do
     set_up do
       AnimalService::DATABASE[:animals].truncate

example/zoo-app-v2/Rakefile

@@ -13,7 +13,7 @@ end
 
 RSpec::Core::RakeTask.new('spec:v2') do |task|
   task.pattern = 'spec/pact/providers/**/*_spec.rb'
-  task.rspec_opts = ['-t pact', '--require rails_helper']
+  task.rspec_opts = ['-t pact_v2', '--require rails_helper']
 end
 
 task :default => :spec

example/zoo-app-v2/spec/pact/providers/animal_service/animal_service_client_spec.rb

@@ -2,7 +2,7 @@
 require 'zoo_app/animal_service_client'
 
 RSpec.describe 'ZooApp::AnimalServiceClient', :pact_v2 do
-  has_http_pact_between 'Zoo App', 'Animal Service', opts: { pact_specification: 'V2' }
+  has_http_pact_between 'Zoo App', 'Animal Service', opts: { pact_specification: 'V4' }
 
   subject { ZooApp::AnimalServiceClient }
 
@@ -18,9 +18,10 @@
       context 'when an alligator by the given name exists' do
         let(:interaction) do
           super()
-            .given("there is an alligator named #{alligator_name}")
+            .given('there is an alligator named {alligator_name}', { alligator_name: alligator_name })
             .upon_receiving('a request for an alligator')
-            .with_request(method: :get, path: "/alligators/#{alligator_name}", headers: headers)
+            .with_request(method: :get, path: generate_from_provider_state(expression: '/alligators/${alligator_name}',
+                                                                           example: '/alligators/Mary'), headers: headers)
             .will_respond_with(status: 200, body: alligator_body, headers: content_headers)
         end
 

example/zoo-app-v2/spec/pacts/Zoo App-Animal Service.json

@@ -5,70 +5,128 @@
   "interactions": [
     {
       "description": "a request for an alligator",
-      "providerState": "an error occurs retrieving an alligator",
+      "pending": false,
+      "providerStates": [
+        {
+          "name": "an error occurs retrieving an alligator"
+        }
+      ],
       "request": {
         "headers": {
-          "Accept": "application/json"
+          "Accept": [
+            "application/json"
+          ]
         },
         "method": "GET",
         "path": "/alligators/Mary"
       },
       "response": {
         "body": {
-          "error": "Argh!!!"
+          "content": {
+            "error": "Argh!!!"
+          },
+          "contentType": "application/json",
+          "encoded": false
         },
         "headers": {
-          "Content-Type": "application/json;charset=utf-8"
+          "Content-Type": [
+            "application/json;charset=utf-8"
+          ]
         },
         "status": 500
-      }
+      },
+      "transport": "http",
+      "type": "Synchronous/HTTP"
     },
     {
       "description": "a request for an alligator",
-      "providerState": "there is an alligator named Mary",
+      "pending": false,
+      "providerStates": [
+        {
+          "name": "there is an alligator named {alligator_name}",
+          "params": {
+            "alligator_name": "Mary"
+          }
+        }
+      ],
       "request": {
+        "generators": {
+          "path": {
+            "expression": "/alligators/${alligator_name}",
+            "type": "ProviderState"
+          }
+        },
         "headers": {
-          "Accept": "application/json"
+          "Accept": [
+            "application/json"
+          ]
+        },
+        "matchingRules": {
+          "path": {
+            "combine": "AND",
+            "matchers": [
+              {
+                "match": "type"
+              }
+            ]
+          }
         },
         "method": "GET",
         "path": "/alligators/Mary"
       },
       "response": {
         "body": {
-          "name": "Mary"
+          "content": {
+            "name": "Mary"
+          },
+          "contentType": "application/json",
+          "encoded": false
         },
         "headers": {
-          "Content-Type": "application/json;charset=utf-8"
+          "Content-Type": [
+            "application/json;charset=utf-8"
+          ]
         },
         "status": 200
-      }
+      },
+      "transport": "http",
+      "type": "Synchronous/HTTP"
     },
     {
       "description": "a request for an alligator",
-      "providerState": "there is not an alligator named Mary",
+      "pending": false,
+      "providerStates": [
+        {
+          "name": "there is not an alligator named Mary"
+        }
+      ],
       "request": {
         "headers": {
-          "Accept": "application/json"
+          "Accept": [
+            "application/json"
+          ]
         },
         "method": "GET",
         "path": "/alligators/Mary"
       },
       "response": {
         "status": 404
-      }
+      },
+      "transport": "http",
+      "type": "Synchronous/HTTP"
     }
   ],
   "metadata": {
+    "pact-ruby-v2": {
+      "pact-ffi": "0.4.28"
+    },
     "pactRust": {
       "ffi": "0.4.28",
       "mockserver": "1.2.16",
       "models": "1.3.5"
     },
     "pactSpecification": {
-      "version": "2.0.0"
-    },
-    "pact-ruby-v2": {
-      "pact-ffi": "0.4.28"
+      "version": "4.0"
     }
   },
   "provider": {

lib/pact/v2/generators.rb

@@ -37,8 +37,8 @@ def generate_random_boolean
         Pact::V2::Generators::RandomBooleanGenerator.new
       end
 
-      def generate_from_provider_state(expression:)
-        Pact::V2::Generators::ProviderStateGenerator.new(expression: expression)
+      def generate_from_provider_state(expression:, example:)
+        Pact::V2::Generators::ProviderStateGenerator.new(expression: expression, example: example).as_basic
       end
 
       def generate_mock_server_url(regex: nil, example: nil)

lib/pact/v2/generators/base.rb

@@ -249,14 +249,17 @@ def as_basic
       class ProviderStateGenerator
         include Base
 
-        def initialize(expression:)
+        def initialize(expression:, example:)
           @expression = expression
+          @value = example
         end
 
         def as_basic
           {
+            'pact:matcher:type': 'type',
             "pact:generator:type" => "ProviderState",
-            "expression" => @expression
+            "expression" => @expression,
+            "value" => @value
           }
         end
       end