pact_broker 2.121.2 → 2.122.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49b03441c7f3ea31c20e1db9c053c6b4ce782ad321007ae1da0614774a62d614
-  data.tar.gz: 4898703bc36456dfd31a8d590834c2e8fd6c6f7f2a3f1919285b6358cb7e1311
+  metadata.gz: f515fab91233eb259d233ef8ff18b35014c55dfebb10a5cec183283bbe760d54
+  data.tar.gz: 2f35f5f3f748d3df875df0ce5b8270f2b1e4b2cf8682804fda41def6d31b88a1
 SHA512:
-  metadata.gz: 54728a387b6667b0867929ad94eec94fcd0eb303a84c1e8fce2311705b7971c168205a62364f77fc5754483cef7605f582d3b820d833c25693cd6cd2d17c23f7
-  data.tar.gz: '069dbe6afe3197ef3ad6f8035d6aee22998d8ecdec1cd582dae0d94a5555741a347a5be2ba129609f97189526a5a2ca2469fe2673805dabf26b8c22abe9acab6'
+  metadata.gz: 6eaefdf8cd5b2b9856bb076579bf034889b7fdab56cfe159c6e1ed56e74d72dca7929ca983290238e32f280e8d7e9b9bc53b9512b4d1562bde122de035e2f50b
+  data.tar.gz: fe3c3008fa385b8585d7b2faa08e8196194e92fdfc496a813f0208373905abacdcded76e0eb4b8dc115b588b20be7e5cd32580ec78c4cbddfc7db15222936b73

data/CHANGELOG.md

@@ -1,3 +1,76 @@
+## [2.122.0] _2026-10-01_
+
+### 🚀 Features
+
+-   Add a unified diff renderer
+-   Render pact diffs as unified diffs
+    > **Migration note:** the pact diff endpoints return a standard unified diff.
+    > This covers the `diff/previous-distinct`, `diff/version/{version}` and
+    > `pact-version/{sha}/diff/pact-version/{sha}` resources under
+    > `/pacts/provider/{provider}/consumer/{consumer}`, and the diff notice
+    > that `POST /contracts/publish` returns when a publish would modify an
+    > existing pact. Clients that parse this output must handle `@@` hunk
+    > headers and unchanged context lines. Keys that exist only in the newer
+    > pact now appear as `+` lines.
+    > 
+    > As an example, take an interaction whose request method changes from
+    > post to get and which gains an `Accept` header. The diff was previously:
+    > 
+    > ```diff
+    >    "interactions": [
+    >      {
+    >        "request": {
+    > -        "method": "post"
+    > +        "method": "get"
+    >        }
+    >      }
+    >    ]
+    > ```
+    > 
+    > It is now:
+    > 
+    > ```diff
+    > @@ -6,7 +6,10 @@
+    >      {
+    >        "description": "a request",
+    >        "request": {
+    > -        "method": "post",
+    > +        "headers": {
+    > +          "Accept": "application/json"
+    > +        },
+    > +        "method": "get",
+    >          "path": "/"
+    >        },
+    >        "response": {
+    > ```
+
+### 🐛 Bug Fixes
+
+-   Require date_helper in HtmlPactRenderer
+
+### 🚜 Refactor
+
+-   Remove unused pact/doc generator code
+-   Compare pact content with Hash equality
+-   Move lib/pact/doc under lib/pact_broker/api/renderers
+-   Move the markdown pact renderer under PactBroker
+-   Render pact HTML from the parsed hash
+
+### 🧪 Testing
+
+-   Stop snapshotting non-determinate response headers
+-   Replace Pact::Matchers in spec helpers with a subset matcher
+
+### 🛠️ Miscellaneous Tasks
+
+-   _(ci)_ Standardize renovate config
+-   _(ci)_ Remove stale internal workflow
+-   Remove the pact-support dependency
+    > **Migration note:** pact_broker no longer depends on pact-support, so code
+    > alongside the broker can no longer rely on Pact::* constants. Add
+    > pact-support to your own Gemfile if that code needs them.
+-   _(release)_ Render Migration-Note footers in the changelog
+
 ## [2.121.2] _2026-09-17_
 
 ### 🐛 Bug Fixes

data/Gemfile

@@ -26,7 +26,7 @@ group :test do
     gem "pact-ffi", path: "../pact-ruby-ffi"
   else
     gem "pact", ">=2.0.3"
-    gem "pact-ffi", "~>0.4.28"
+    gem "pact-ffi", "~>0.5.0"
   end
   gem "rack-test", ">= 0.6.3", "< 3.0.0"
   gem "bundler-audit", "~>0.4"
@@ -47,6 +47,3 @@ group :pg, optional: true do
   gem "pg", "~>1.6"
 end
 
-if ENV["X_PACT_DEVELOPMENT"] == "true"
-  gem "pact-support", path: "../pact-support"
-end

data/lib/pact_broker/api/renderers/html_pact_renderer.rb

@@ -1,9 +1,8 @@
-require "pact/consumer_contract"
-require "pact/reification"
 require "redcarpet"
-require "pact/doc/markdown/consumer_contract_renderer"
+require "pact_broker/api/renderers/markdown/consumer_contract_renderer"
 require "pact_broker/api/pact_broker_urls"
 require "pact_broker/logging"
+require "pact_broker/date_helper"
 require "rack"
 
 module PactBroker
@@ -11,8 +10,6 @@ module PactBroker
     module Renderers
       class HtmlPactRenderer
 
-        class NotAPactError < StandardError; end
-
         include PactBroker::Logging
 
         def self.call pact, options = {}
@@ -182,10 +179,11 @@ module PactBroker
         end
 
         def markdown
-          Pact::Doc::Markdown::ConsumerContractRenderer.call consumer_contract
-        rescue StandardError
+          Markdown::ConsumerContractRenderer.call(JSON.parse(@json_content))
+        rescue StandardError => e
+          logger.info "Could not render the following content as a pact due to #{e.class} #{e.message}, showing raw content instead: #{@json_content}"
           heading = "### A contract between #{@pact.consumer.name} and #{@pact.provider.name}"
-          warning = "_Note: this contract could not be parsed to a v1 or v2 Pact, showing raw content instead._"
+          warning = "_Note: this content could not be rendered as a pact, showing raw JSON instead._"
           pretty_json = JSON.pretty_generate(@pact.content_hash)
           "#{heading}\n#{warning}\n```json\n#{pretty_json}\n```\n"
         end
@@ -194,67 +192,6 @@ module PactBroker
           Redcarpet::Markdown.new(Redcarpet::Render::HTML, :fenced_code_blocks => true, :lax_spacing => true).render(markdown)
         end
 
-        def consumer_contract
-          pact_object = JSON.parse(@json_content)
-          convert_v3_messages_to_interactions(pact_object)
-
-          pact_object["interactions"]&.each do |interaction|
-            add_dummy_html_request_response_to_asynchronous_message(interaction)
-            add_dummy_html_request_response_to_synchronous_message(interaction)
-          end
-
-          new_json_content = pact_object.to_json  
-
-          Pact::ConsumerContract.from_json(new_json_content)
-        rescue => e
-          logger.info "Could not parse the following content to a Pact due to #{e.class} #{e.message}, showing raw content instead: #{@json_content}"
-          raise NotAPactError
-        end
-
-        def convert_v3_messages_to_interactions(pact_object)
-          return unless pact_object.key?("messages")
-
-          logger.warn "Detected a v3 Pact, converting 'messages' to 'interactions'."
-          pact_object["interactions"] = pact_object.delete("messages")
-        end        
-
-        def add_dummy_html_request_response_to_asynchronous_message(interaction)
-          if !interaction["request"] || !interaction["response"]
-            logger.warn "Interaction '#{interaction['description']}' does not have a request or response, adding dummy request and response so that they can be parsed and appear on the UI."
-          end
-
-          interaction["request"] ||= {
-            method: "FAKE_ASYNC_METHOD",
-            path: interaction["description"]
-          }
-
-          unless interaction.key?("response")
-            interaction["response"] = {
-              status: "FAKE_ASYNC_METHOD",
-              body: {
-                contents: interaction.delete("contents"),
-                metadata: interaction.delete("metadata")
-              }
-            }
-          end      
-        end
-
-        def add_dummy_html_request_response_to_synchronous_message(interaction)
-          if interaction["type"] == "Synchronous/Messages"
-            interaction["request"] = {
-              method: "FAKE_SYNC_METHOD",
-              path: interaction["description"],
-              body: interaction.delete("request"),
-            }
-            interaction["response"] = {
-              status: "FAKE_SYNC_METHOD",
-              body: {
-                contents: interaction.delete("response"),
-              }              
-            }              
-          end    
-        end
-
         def h string
           Rack::Utils.escape_html(string)
         end

data/lib/pact_broker/api/renderers/markdown/consumer_contract_renderer.rb

@@ -0,0 +1,87 @@
+require "pact_broker/api/renderers/markdown/interaction_renderer"
+require "pact_broker/api/renderers/markdown/interaction_view_model"
+require "rack/utils"
+require "pact_broker/api/renderers/markdown"
+
+module PactBroker
+  module Api
+    module Renderers
+      module Markdown
+        class ConsumerContractRenderer
+
+          # Raised when the content does not have the shape of a pact.
+          class NotAPactError < StandardError; end
+
+          def initialize pact_hash
+            unless pact_hash.is_a?(Hash) && pact_hash["consumer"].is_a?(Hash) && pact_hash["provider"].is_a?(Hash)
+              raise NotAPactError, "content does not have consumer and provider objects"
+            end
+            @pact_hash = pact_hash
+          end
+
+          def self.call pact_hash
+            new(pact_hash).call
+          end
+
+          def call
+            title + summaries_title + summaries + interactions_title + full_interactions
+          end
+
+          private
+
+          attr_reader :pact_hash
+
+          def title
+            "# A pact between #{consumer_name} and #{provider_name}\n\n"
+          end
+
+          def interaction_renderers
+            @interaction_renderers ||= sorted_interactions.collect { |view_model| InteractionRenderer.new(view_model) }
+          end
+
+          def summaries_title
+            "### Requests from #{consumer_name} to #{provider_name}\n\n"
+          end
+
+          def interactions_title
+            "### Interactions\n\n"
+          end
+
+          def summaries
+            interaction_renderers.collect(&:render_summary).join
+          end
+
+          def full_interactions
+            interaction_renderers.collect(&:render_full_interaction).join
+          end
+
+          def sorted_interactions
+            interactions.collect { |interaction| InteractionViewModel.new(interaction, pact_hash) }.sort_by(&:sortable_id)
+          end
+
+          # v3 message pacts keep their interactions under "messages"
+          def interactions
+            Array(pact_hash["interactions"] || pact_hash["messages"])
+          end
+
+          def consumer_name
+            h(markdown_escape pact_hash.dig("consumer", "name"))
+          end
+
+          def provider_name
+            h(markdown_escape pact_hash.dig("provider", "name"))
+          end
+
+          def markdown_escape string
+            return nil unless string
+            string.gsub(MARKDOWN_SPECIAL_CHARS_REGEXP) { |char| "\\#{char}" }
+          end
+
+          def h(text)
+            Rack::Utils.escape_html(text)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/renderers/markdown/interaction_renderer.rb

@@ -0,0 +1,52 @@
+require "erb"
+require "rack/utils"
+
+module PactBroker
+  module Api
+    module Renderers
+      module Markdown
+        class InteractionRenderer
+          attr_reader :interaction
+
+          def initialize interaction_view_model
+            @interaction = interaction_view_model
+          end
+
+          def render_summary
+            formatted_provider_states = h(interaction.formatted_provider_states)
+            suffix = formatted_provider_states.empty? ? "" : " given #{formatted_provider_states}"
+            "* [#{h(interaction.description(true))}](##{interaction.id})#{suffix}\n\n"
+          end
+
+          def render_full_interaction
+            if interaction.async?
+              render("/interaction_async.erb")
+            else
+              render("/interaction.erb")
+            end
+          end
+
+          def render template_file
+            ERB.new(template_string(template_file)).result(binding)
+          end
+
+          # The template file is written with only ASCII range characters, so we
+          # can read as UTF-8. But rendered strings must have same encoding as
+          # script encoding because it will joined to strings which are produced by
+          # string literal.
+          def template_string(template_file)
+            File.read(template_contents(template_file), external_encoding: Encoding::UTF_8).force_encoding(__ENCODING__)
+          end
+
+          def template_contents(template_file)
+            File.dirname(__FILE__) + template_file
+          end
+
+          def h(text)
+            Rack::Utils.escape_html(text)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/renderers/markdown/interaction_view_model.rb

@@ -0,0 +1,162 @@
+require "cgi"
+require "json"
+require "pact_broker/api/renderers/markdown"
+
+module PactBroker
+  module Api
+    module Renderers
+      module Markdown
+        # Presents one interaction from a parsed pact hash for the markdown
+        # templates. Bodies are printed as stored, so v1 pacts show their
+        # inline json_class matcher objects verbatim.
+        class InteractionViewModel
+          MARKDOWN_BOLD_CHARACTERS = "**"
+          ORDERED_KEYS = ["method", "path", "query", "status", "headers", "body"].freeze
+          ASYNC_REQUEST = "ASYNC_REQUEST"
+
+          def initialize interaction, pact
+            @interaction = interaction
+            @pact = pact
+          end
+
+          def id
+            @id ||= begin
+              full_desc = if has_provider_state?
+                            "#{description} given #{provider_state_name}"
+                          else
+                            description
+                          end
+              CGI.escapeHTML(full_desc.gsub(/\s+/, "_"))
+            end
+          end
+
+          def sortable_id
+            "#{(interaction["description"] || "").downcase} #{http_response["status"]} #{(provider_state_name || "").downcase}"
+          end
+
+          def consumer_name
+            markdown_escape pact.dig("consumer", "name")
+          end
+
+          def provider_name
+            markdown_escape pact.dig("provider", "name")
+          end
+
+          def has_provider_state?
+            !provider_state_name.nil? && !provider_state_name.empty?
+          end
+
+          def provider_state start_of_sentence = false
+            markdown_escape apply_capitals(provider_state_name.strip, start_of_sentence)
+          end
+
+          def formatted_provider_states mark_bold: false
+            bold_marker = mark_bold ? MARKDOWN_BOLD_CHARACTERS : ""
+
+            provider_state_names.map do |name|
+              "#{bold_marker}#{markdown_escape(apply_capitals(name.strip, false))}#{bold_marker}"
+            end.join(" and ")
+          end
+
+          def description start_of_sentence = false
+            return "" unless interaction["description"]
+            markdown_escape apply_capitals(interaction["description"].strip, start_of_sentence)
+          end
+
+          def request
+            return ASYNC_REQUEST if async?
+            JSON.pretty_generate(clean_request)
+          end
+
+          def response
+            JSON.pretty_generate(clean_response)
+          end
+
+          def async?
+            interaction["type"] == "Asynchronous/Messages" || !interaction.key?("request")
+          end
+
+          private
+
+          attr_reader :interaction, :pact
+
+          def sync?
+            interaction["type"] == "Synchronous/Messages"
+          end
+
+          def http_request
+            interaction["request"].is_a?(Hash) ? interaction["request"] : {}
+          end
+
+          def http_response
+            interaction["response"].is_a?(Hash) ? interaction["response"] : {}
+          end
+
+          def clean_request
+            if sync?
+              http_request.slice("contents", "metadata")
+            else
+              ordered_clean_hash(http_request).tap do |h|
+                h["body"] = http_request["body"] if http_request["body"]
+              end
+            end
+          end
+
+          def clean_response
+            if sync?
+              Array(interaction["response"]).map { |item| item.to_h.slice("contents", "metadata") }
+            elsif async?
+              { "contents" => interaction["contents"], "metadata" => interaction["metadata"] }
+            else
+              ordered_clean_hash(http_response)
+            end
+          end
+
+          # Removes empty header and body hashes, as an empty hash means
+          # "allow anything" and reads more cleanly when omitted.
+          def ordered_clean_hash source
+            ORDERED_KEYS.each_with_object({}) do |key, target|
+              if source.key? key
+                target[key] = source[key] unless value_is_an_empty_hash(source[key])
+              end
+            end
+          end
+
+          def value_is_an_empty_hash value
+            value.is_a?(Hash) && value.empty?
+          end
+
+          def provider_state_names
+            states = interaction["providerStates"]
+            if states.is_a?(Array) && states.any?
+              states.map { |state| state.is_a?(Hash) ? state["name"] : state }.compact
+            else
+              [interaction["providerState"] || interaction["provider_state"]].compact
+            end
+          end
+
+          def provider_state_name
+            provider_state_names.first
+          end
+
+          def apply_capitals string, start_of_sentence = false
+            start_of_sentence ? capitalize_first_letter(string) : lowercase_first_letter(string)
+          end
+
+          def capitalize_first_letter string
+            string[0].upcase + string[1..-1]
+          end
+
+          def lowercase_first_letter string
+            string[0].downcase + string[1..-1]
+          end
+
+          def markdown_escape string
+            return nil unless string
+            string.gsub(MARKDOWN_SPECIAL_CHARS_REGEXP) { |char| "\\#{char}" }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/renderers/markdown.rb

@@ -0,0 +1,9 @@
+module PactBroker
+  module Api
+    module Renderers
+      module Markdown
+        MARKDOWN_SPECIAL_CHARS_REGEXP = /[\\`*_\[\](){}#+\-.!|]/
+      end
+    end
+  end
+end

data/lib/pact_broker/pacts/create_formatted_diff.rb

@@ -1,14 +1,11 @@
-require "pact/support/matchers"
 require "pact_broker/json"
-require "pact/matchers/unix_diff_formatter"
+require "pact_broker/unified_diff"
 require "pact_broker/pacts/sort_content"
 require "pact_broker/pacts/content"
 
 module PactBroker
   module Pacts
     class CreateFormattedDiff
-      extend Pact::Matchers
-
       def self.call pact_json_content, previous_pact_json_content, raw: false
         pact_hash = JSON.parse(pact_json_content, **PactBroker::PACT_PARSING_OPTIONS)
         previous_pact_hash = JSON.parse(previous_pact_json_content, **PactBroker::PACT_PARSING_OPTIONS)
@@ -18,9 +15,7 @@ module PactBroker
           previous_pact_hash = SortContent.call(PactBroker::Pacts::Content.from_hash(previous_pact_hash).without_ids.to_hash)
         end
 
-        difference = diff(previous_pact_hash, pact_hash)
-
-        Pact::Matchers::UnixDiffFormatter.call(difference, colour: false, include_explanation: false)
+        PactBroker::UnifiedDiff.call(JSON.pretty_generate(previous_pact_hash), JSON.pretty_generate(pact_hash))
       end
     end
   end

data/lib/pact_broker/pacts/repository.rb

@@ -3,7 +3,6 @@ require "pact_broker/logging"
 require "pact_broker/pacts/generate_sha"
 require "pact_broker/pacts/pact_publication"
 require "pact_broker/pacts/pact_version"
-require "pact/shared/json_differ"
 require "pact_broker/domain"
 require "pact_broker/pacts/parse"
 require "pact_broker/pacts/latest_pact_publication_id_for_consumer_version"
@@ -386,7 +385,7 @@ module PactBroker
       end
 
       def different? pact, other_pact
-        Pact::JsonDiffer.(pact.content_hash, other_pact.content_hash, allow_unexpected_keys: false).any?
+        pact.content_hash != other_pact.content_hash
       end
 
       def find_or_create_pact_version consumer_id, provider_id, pact_version_sha, json_content

data/lib/pact_broker/unified_diff.rb

@@ -0,0 +1,26 @@
+require "diff/lcs"
+require "diff/lcs/hunk"
+
+module PactBroker
+  # Renders the difference between two texts in unified diff format,
+  # without the file header lines.
+  class UnifiedDiff
+    def self.call(old_text, new_text, context: 3)
+      old_lines = old_text.split("\n")
+      new_lines = new_text.split("\n")
+      pieces = Diff::LCS.diff(old_lines, new_lines)
+      return "" if pieces.empty?
+
+      hunks = []
+      length_difference = 0
+      pieces.each do |piece|
+        hunk = Diff::LCS::Hunk.new(old_lines, new_lines, piece, context, length_difference)
+        length_difference = hunk.file_length_difference
+        hunk.merge(hunks.pop) if context.positive? && hunks.last && hunk.overlaps?(hunks.last)
+        hunks << hunk
+      end
+
+      hunks.collect { |hunk| hunk.diff(:unified) }.join("\n")
+    end
+  end
+end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = "2.121.2"
+  VERSION = "2.122.0"
 end

data/pact_broker.gemspec

@@ -59,7 +59,6 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "semver2", "~> 3.4.2"
   gem.add_runtime_dependency "rack", "~> 3.2"
   gem.add_runtime_dependency "redcarpet", "~> 3.5"
-  gem.add_runtime_dependency "pact-support", "~> 2.0"
   gem.add_runtime_dependency "haml", "~>5.0"
   gem.add_runtime_dependency "sucker_punch", "~>3.0"
   gem.add_runtime_dependency "rack-protection", "~> 4.1"
@@ -70,6 +69,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "anyway_config", "~> 2.1"
   gem.add_runtime_dependency "request_store", "~> 1.5"
   gem.add_runtime_dependency "moments", "~> 0.2"
+  gem.add_runtime_dependency "diff-lcs", "~> 1.5"
   # dropped in ruby 3.4 stdlib
   gem.add_runtime_dependency "mutex_m", "~> 0.3" # until as-notifications -> webmachine requires it
   gem.add_runtime_dependency "csv", "~> 3.0" # lib/pact_broker/api/decorators/relationships_csv_decorator.rb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.121.2
+  version: 2.122.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-17 00:00:00.000000000 Z
+date: 2026-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -152,20 +152,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: pact-support
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -306,6 +292,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: mutex_m
   requirement: !ruby/object:Gem::Requirement
@@ -593,18 +593,6 @@ files:
 - docs/developer/matrix.md
 - docs/developer/rack.md
 - docs/matrix-optimisation/README.md
-- lib/pact/doc.rb
-- lib/pact/doc/doc_file.rb
-- lib/pact/doc/generate.rb
-- lib/pact/doc/generator.rb
-- lib/pact/doc/interaction_view_model.rb
-- lib/pact/doc/markdown/consumer_contract_renderer.rb
-- lib/pact/doc/markdown/generator.rb
-- lib/pact/doc/markdown/index_renderer.rb
-- lib/pact/doc/markdown/interaction.erb
-- lib/pact/doc/markdown/interaction_async.erb
-- lib/pact/doc/markdown/interaction_renderer.rb
-- lib/pact/doc/sort_interactions.rb
 - lib/pact_broker.rb
 - lib/pact_broker/api.rb
 - lib/pact_broker/api/authorization/resource_access_policy.rb
@@ -717,6 +705,12 @@ files:
 - lib/pact_broker/api/paths.rb
 - lib/pact_broker/api/renderers/html_pact_renderer.rb
 - lib/pact_broker/api/renderers/integrations_dot_renderer.rb
+- lib/pact_broker/api/renderers/markdown.rb
+- lib/pact_broker/api/renderers/markdown/consumer_contract_renderer.rb
+- lib/pact_broker/api/renderers/markdown/interaction.erb
+- lib/pact_broker/api/renderers/markdown/interaction_async.erb
+- lib/pact_broker/api/renderers/markdown/interaction_renderer.rb
+- lib/pact_broker/api/renderers/markdown/interaction_view_model.rb
 - lib/pact_broker/api/resources.rb
 - lib/pact_broker/api/resources/after_reply.rb
 - lib/pact_broker/api/resources/all_webhooks.rb
@@ -1093,6 +1087,7 @@ files:
 - lib/pact_broker/ui/views/index/show.haml
 - lib/pact_broker/ui/views/layouts/main.haml
 - lib/pact_broker/ui/views/matrix/show.haml
+- lib/pact_broker/unified_diff.rb
 - lib/pact_broker/verifications/latest_verification_for_consumer_and_provider.rb
 - lib/pact_broker/verifications/latest_verification_for_consumer_version_tag.rb
 - lib/pact_broker/verifications/latest_verification_id_for_pact_version_and_provider_version.rb

data/lib/pact/doc/doc_file.rb

@@ -1,38 +0,0 @@
-module Pact
-  module Doc
-    class DocFile
-
-      def initialize consumer_contract, dir, consumer_contract_renderer, file_extension
-        @dir = dir
-        @consumer_contract = consumer_contract
-        @consumer_contract_renderer = consumer_contract_renderer
-        @file_extension = file_extension
-      end
-
-      def write
-        File.open(path, "w") { |io|  io << doc_file_contents }
-      end
-
-      def title
-        consumer_contract.provider.name
-      end
-
-      def name
-        "#{consumer_contract.consumer.name} - #{consumer_contract.provider.name}#{file_extension}"
-      end
-
-      private
-
-      attr_reader :dir, :consumer_contract, :consumer_contract_renderer, :file_extension
-
-      def path
-        File.join(dir, name)
-      end
-
-      def doc_file_contents
-        consumer_contract_renderer.call(consumer_contract)
-      end
-
-    end
-  end
-end

data/lib/pact/doc/generate.rb

@@ -1,11 +0,0 @@
-module Pact
-  module Doc
-    class Generate
-
-      def self.call pact_dir  = Pact.configuration.pact_dir, doc_dir = Pact.configuration.doc_dir, doc_generators = Pact.configuration.doc_generators
-        doc_generators.each{| doc_generator| doc_generator.call pact_dir, doc_dir }
-      end
-
-    end
-  end
-end

data/lib/pact/doc/generator.rb

@@ -1,82 +0,0 @@
-require "pact/doc/doc_file"
-require "fileutils"
-
-module Pact
-  module Doc
-
-    class Generator
-
-      def initialize pact_dir, doc_dir, options
-        @doc_dir = doc_dir
-        @pact_dir = pact_dir
-        @consumer_contract_renderer = options[:consumer_contract_renderer]
-        @doc_type = options[:doc_type]
-        @file_extension = options[:file_extension]
-        @index_renderer = options[:index_renderer]
-        @index_name = options[:index_name]
-        @after = options.fetch(:after, lambda{|pact_dir_arg, target_dir_arg, consumer_contracts_arg| })
-      end
-
-      def call
-        ensure_target_dir_exists_and_is_clean
-        write_index if consumer_contracts.any?
-        write_doc_files
-        perform_after_hook
-      end
-
-      private
-
-      attr_reader :doc_dir, :pact_dir, :consumer_contract_renderer, :doc_type, :file_extension, :index_renderer, :after
-
-      def write_index
-        File.open(index_file_path, "w") { |io|  io << index_file_contents }
-      end
-
-      def index_file_path
-        File.join(target_dir, "#{@index_name}#{file_extension}")
-      end
-
-      def index_file_contents
-        index_renderer.call(consumer_contracts.first.consumer.name, index_data)
-      end
-
-      def index_data
-        doc_files.each_with_object({}) do | doc_file, data |
-          data[doc_file.title] = doc_file.name
-        end
-      end
-
-      def write_doc_files
-        doc_files.each(&:write)
-      end
-
-      def doc_files
-        consumer_contracts.collect do | consumer_contract |
-          DocFile.new(consumer_contract, target_dir, consumer_contract_renderer, file_extension)
-        end
-      end
-
-      def consumer_contracts
-        @consumer_contracts ||= begin
-          Dir.glob("#{pact_dir}/**").collect do |file|
-            Pact::ConsumerContract.from_uri file
-          end
-        end
-      end
-
-      def perform_after_hook
-        after.call(pact_dir, target_dir, consumer_contracts)
-      end
-
-      def ensure_target_dir_exists_and_is_clean
-        FileUtils.rm_rf target_dir
-        FileUtils.mkdir_p target_dir
-      end
-
-      def target_dir
-        File.join(doc_dir, doc_type)
-      end
-
-    end
-  end
-end

data/lib/pact/doc/interaction_view_model.rb

@@ -1,157 +0,0 @@
-require "pact/shared/active_support_support"
-require "pact/reification"
-require "cgi"
-require "pact/doc"
-
-module Pact
-  module Doc
-    class InteractionViewModel
-
-      include Pact::ActiveSupportSupport
-
-      MARKDOWN_BOLD_CHARACTERS = "**"
-
-      def initialize interaction, consumer_contract
-        @interaction = interaction
-        @consumer_contract = consumer_contract
-      end
-
-      def id
-        @id ||= begin
-          full_desc = if has_provider_state?
-                        "#{description} given #{interaction.provider_state}"
-                      else
-                        description
-                      end
-          CGI.escapeHTML(full_desc.gsub(/\s+/,"_"))
-        end
-      end
-
-      def request_method
-        interaction.request.method.upcase
-      end
-
-      def request_path
-        interaction.request.path
-      end
-
-      def response_status
-        interaction.response.status
-      end
-
-      def consumer_name
-        markdown_escape @consumer_contract.consumer.name
-      end
-
-      def provider_name
-        markdown_escape @consumer_contract.provider.name
-      end
-
-      def has_provider_state?
-        @interaction.provider_state && !@interaction.provider_state.empty?
-      end
-
-      def provider_state start_of_sentence = false
-        markdown_escape apply_capitals(@interaction.provider_state.strip, start_of_sentence)
-      end
-
-      def formatted_provider_states mark_bold: false
-        bold_marker = mark_bold ? MARKDOWN_BOLD_CHARACTERS : ""
-
-        (@interaction.provider_states || []).map do |ps|
-          "#{bold_marker}" \
-          "#{markdown_escape(apply_capitals(ps.name.strip, false))}" \
-          "#{bold_marker}"
-        end.join(" and ")
-      end
-
-      def description start_of_sentence = false
-        return "" unless @interaction.description
-        markdown_escape apply_capitals(@interaction.description.strip, start_of_sentence)
-      end
-
-      def request
-        the_clean_request = clean_request
-        if the_clean_request == "ASYNC_REQUEST"
-          "ASYNC_REQUEST"
-        else  
-          fix_json_formatting JSON.pretty_generate(clean_request)
-        end
-      end
-
-      def response
-        fix_json_formatting JSON.pretty_generate(clean_response)
-      end
-
-      private
-
-      attr_reader :interaction, :consumer_contract
-
-      def clean_request
-        reified = Reification.from_term(interaction.request)
-        return "ASYNC_REQUEST" if reified[:method] == "FAKE_ASYNC_METHOD"
-
-        ordered = ordered_clean_hash(reified).tap do |h|
-          h[:body] = reified[:body] if reified[:body]
-        end
-
-        return ordered[:body].to_h.slice("contents", "metadata") if ordered[:method] == "FAKE_SYNC_METHOD"
-
-        ordered
-      end
-
-      def clean_response
-        raw = Reification.from_term(interaction.response)
-
-        case raw[:status]
-        when "FAKE_ASYNC_METHOD"
-          raw[:body] || {}
-        when "FAKE_SYNC_METHOD"
-          Array(raw.dig(:body, "contents")).map { |item| item.slice("contents", "metadata") }
-        else
-          ordered_clean_hash(raw)
-        end
-      end
-
-      # Remove empty body and headers hashes from response, and empty headers from request,
-      # as an empty hash means "allow anything" - it's more intuitive and cleaner to just
-      # remove the empty hashes from display.
-      def ordered_clean_hash source
-        ordered_keys.each_with_object({}) do |key, target|
-          if source.key? key
-            target[key] = source[key] unless value_is_an_empty_hash(source[key])
-          end
-        end
-      end
-
-      def value_is_an_empty_hash value
-        value.is_a?(Hash) && value.empty?
-      end
-
-      def ordered_keys
-        [:method, :path, :query, :status, :headers, :body]
-      end
-
-      def remove_key_if_empty key, hash
-        hash.delete(key) if hash[key].is_a?(Hash) && hash[key].empty?
-      end
-
-      def apply_capitals string, start_of_sentence = false
-        start_of_sentence ? capitalize_first_letter(string) : lowercase_first_letter(string)
-      end
-
-      def capitalize_first_letter string
-        string[0].upcase + string[1..-1]
-      end
-
-      def lowercase_first_letter string
-        string[0].downcase + string[1..-1]
-      end
-
-      def markdown_escape string
-        return nil unless string
-        string.gsub(Pact::Doc::MARKDOWN_SPECIAL_CHARS_REGEXP) { |char| "\\#{char}" }
-      end
-    end
-  end
-end

data/lib/pact/doc/markdown/consumer_contract_renderer.rb

@@ -1,74 +0,0 @@
-require "pact/doc/markdown/interaction_renderer"
-require "pact/doc/sort_interactions"
-require "rack/utils"
-require "pact/doc"
-
-module Pact
-  module Doc
-    module Markdown
-      class ConsumerContractRenderer
-
-        def initialize consumer_contract
-          @consumer_contract = consumer_contract
-        end
-
-        def self.call consumer_contract
-          new(consumer_contract).call
-        end
-
-        def call
-          title + summaries_title + summaries + interactions_title + full_interactions
-        end
-
-        private
-
-        attr_reader :consumer_contract
-
-        def title
-          "# A pact between #{consumer_name} and #{provider_name}\n\n"
-        end
-
-        def interaction_renderers
-          @interaction_renderers ||= sorted_interactions.collect{|interaction| InteractionRenderer.new interaction, @consumer_contract}
-        end
-
-        def summaries_title
-          "### Requests from #{consumer_name} to #{provider_name}\n\n"
-        end
-
-        def interactions_title
-          "### Interactions\n\n"
-        end
-
-        def summaries
-          interaction_renderers.collect(&:render_summary).join
-        end
-
-        def full_interactions
-          interaction_renderers.collect(&:render_full_interaction).join
-        end
-
-        def sorted_interactions
-          SortInteractions.call(consumer_contract.interactions)
-        end
-
-        def consumer_name
-          h(markdown_escape consumer_contract.consumer.name)
-        end
-
-        def provider_name
-          h(markdown_escape consumer_contract.provider.name)
-        end
-
-        def markdown_escape string
-          return nil unless string
-          string.gsub(Pact::Doc::MARKDOWN_SPECIAL_CHARS_REGEXP) { |char| "\\#{char}" }
-        end
-
-        def h(text)
-          Rack::Utils.escape_html(text)
-        end
-      end
-    end
-  end
-end

data/lib/pact/doc/markdown/generator.rb

@@ -1,24 +0,0 @@
-require "pact/doc/generator"
-require "pact/doc/markdown/consumer_contract_renderer"
-require "pact/doc/markdown/index_renderer"
-
-module Pact
-  module Doc
-    module Markdown
-      class Generator < Pact::Doc::Generator
-        def initialize pact_dir, doc_dir
-          super(pact_dir, doc_dir,
-            consumer_contract_renderer: ConsumerContractRenderer,
-            doc_type: "markdown",
-            file_extension: ".md",
-            index_renderer: IndexRenderer,
-            index_name: "README")
-        end
-
-        def self.call pact_dir, doc_dir
-          new(pact_dir, doc_dir).call
-        end
-      end
-    end
-  end
-end

data/lib/pact/doc/markdown/index_renderer.rb

@@ -1,40 +0,0 @@
-module Pact
-  module Doc
-    module Markdown
-      class IndexRenderer
-        attr_reader :consumer_name
-        attr_reader :docs # Hash of pact title => file_name
-
-        def initialize consumer_name, docs
-          @consumer_name = consumer_name
-          @docs = docs
-        end
-
-        def self.call consumer_name, docs
-          new(consumer_name, docs).call
-        end
-
-        def call
-          title + "\n\n" + table_of_contents + "\n"
-        end
-
-        private
-
-        def table_of_contents
-          docs.collect do | title, file_name |
-            item title, file_name
-          end.join("\n")
-        end
-
-        def title
-          "### Pacts for #{consumer_name}"
-        end
-
-        def item title, file_name
-          "* [#{title}](#{file_name})"
-        end
-
-      end
-    end
-  end
-end

data/lib/pact/doc/markdown/interaction_renderer.rb

@@ -1,51 +0,0 @@
-require "erb"
-require "pact/doc/interaction_view_model"
-require "rack/utils"
-
-module Pact
-  module Doc
-    module Markdown
-      class InteractionRenderer
-        attr_reader :interaction
-
-        def initialize interaction, pact
-          @interaction = InteractionViewModel.new(interaction, pact)
-        end
-
-        def render_summary
-          formatted_provider_states = h(interaction.formatted_provider_states)
-          suffix = formatted_provider_states.empty? ? "" : " given #{formatted_provider_states}"
-          "* [#{h(interaction.description(true))}](##{interaction.id})#{suffix}\n\n"
-        end
-
-        def render_full_interaction
-          if interaction.request == "ASYNC_REQUEST"
-            render("/interaction_async.erb")
-          else
-            render("/interaction.erb")
-          end
-        end
-
-        def render template_file
-          ERB.new(template_string(template_file)).result(binding)
-        end
-
-        # The template file is written with only ASCII range characters, so we
-        # can read as UTF-8. But rendered strings must have same encoding as
-        # script encoding because it will joined to strings which are produced by
-        # string literal.
-        def template_string(template_file)
-          File.read(template_contents(template_file), external_encoding: Encoding::UTF_8).force_encoding(__ENCODING__)
-        end
-
-        def template_contents(template_file)
-          File.dirname(__FILE__) + template_file
-        end
-
-        def h(text)
-          Rack::Utils.escape_html(text)
-        end
-      end
-    end
-  end
-end

data/lib/pact/doc/sort_interactions.rb

@@ -1,14 +0,0 @@
-module Pact
-  module Doc
-    class SortInteractions
-      def self.call interactions
-        interactions.sort{|a, b| sortable_id(a) <=> sortable_id(b)}
-      end
-
-
-      def self.sortable_id interaction
-        "#{(interaction.description || '').downcase} #{interaction.response.status} #{(interaction.provider_state || '').downcase}"
-      end
-    end
-  end
-end

data/lib/pact/doc.rb

@@ -1,5 +0,0 @@
-module Pact
-  module Doc
-    MARKDOWN_SPECIAL_CHARS_REGEXP = /[\\`*_\[\](){}#+\-.!|]/
-  end
-end