pact-support 1.4.0 → 1.7.0

data/lib/pact/matchers/multipart_form_diff_formatter.rb

@@ -0,0 +1,41 @@
+require 'pact/matchers/unix_diff_formatter'
+require 'pact/matchers/differ'
+
+module Pact
+  module Matchers
+    class MultipartFormDiffFormatter
+
+      def initialize diff, options = {}
+        @options = options
+        @body_diff = diff[:body]
+        @non_body_diff = diff.reject{ |k, v| k == :body }
+        @colour = options.fetch(:colour, false)
+        @differ = Pact::Matchers::Differ.new(@colour)
+      end
+
+      def self.call diff, options = {}
+        new(diff, options).call
+      end
+
+      def call
+        Pact::Matchers::UnixDiffFormatter::MESSAGES_TITLE + "\n" + non_body_diff_string + "\n" + body_diff_string
+      end
+
+      def non_body_diff_string
+        if @non_body_diff.any?
+          Pact::Matchers::ExtractDiffMessages.call(@non_body_diff).collect{ | message| "* #{message}" }.join("\n")
+        else
+          ""
+        end
+      end
+
+      def body_diff_string
+        if @body_diff
+          @differ.diff_as_string(@body_diff.expected, @body_diff.actual)
+        else
+          ""
+        end
+      end
+    end
+  end
+end

data/lib/pact/matching_rules/merge.rb

@@ -13,11 +13,12 @@ module Pact
         @expected = expected
         @matching_rules = standardise_paths(matching_rules)
         @root_path = JsonPath.new(root_path).to_s
+        @used_rules = []
       end
 
       def call
         return @expected if @matching_rules.nil? || @matching_rules.empty?
-        recurse @expected, @root_path
+        recurse(@expected, @root_path).tap { log_ignored_rules }
       end
 
       private
@@ -46,14 +47,18 @@ module Pact
       end
 
       def recurse_array array, path
+        parent_match_rule = find_rule(path, 'match')
+        log_used_rule(path, 'match', parent_match_rule) if parent_match_rule
+
         array_like_children_path = "#{path}[*]*"
-        parent_match_rule = @matching_rules[path] && @matching_rules[path]['match']
-        children_match_rule = @matching_rules[array_like_children_path] && @matching_rules[array_like_children_path]['match']
-        min = @matching_rules[path] && @matching_rules[path]['min']
+        children_match_rule = find_rule(array_like_children_path, 'match')
+        log_used_rule(array_like_children_path, 'match', children_match_rule) if children_match_rule
+
+        min = find_rule(path, 'min')
+        log_used_rule(path, 'min', min) if min
 
         if min && (children_match_rule == 'type' || (children_match_rule.nil? && parent_match_rule == 'type'))
           warn_when_not_one_example_item(array, path)
-          # log_ignored_rules(path, @matching_rules[path], {'min' => min})
           Pact::ArrayLike.new(recurse(array.first, "#{path}[*]"), min: min)
         else
           new_array = []
@@ -81,30 +86,41 @@ module Pact
         elsif rules['regex']
           handle_regex(object, path, rules)
         else
-          log_ignored_rules(path, rules, {})
           object
         end
       end
 
       def handle_match_type object, path, rules
-        log_ignored_rules(path, rules, {'match' => 'type'})
-        Pact::SomethingLike.new(object)
+        log_used_rule(path, 'match', 'type')
+        Pact::SomethingLike.new(recurse(object, path))
       end
 
       def handle_regex object, path, rules
-        log_ignored_rules(path, rules, {'match' => 'regex', 'regex' => rules['regex']})
+        log_used_rule(path, 'match', 'regex') # assumed to be present
+        log_used_rule(path, 'regex', rules['regex'])
         Pact::Term.new(generate: object, matcher: Regexp.new(rules['regex']))
       end
 
-      def log_ignored_rules path, rules, used_rules
-        dup_rules = rules.dup
-        used_rules.each_pair do | used_key, used_value |
-          dup_rules.delete(used_key) if dup_rules[used_key] == used_value
+      def log_ignored_rules
+        dup_rules = @matching_rules.dup
+        @used_rules.each do | (path, key, value) |
+          dup_rules[path].delete(key) if dup_rules[path][key] == value
         end
+
         if dup_rules.any?
-          $stderr.puts "WARN: Ignoring unsupported matching rules #{dup_rules} for path #{path}"
+          dup_rules.each do | path, rules |
+            $stderr.puts "WARN: Ignoring unsupported matching rules #{rules} for path #{path}" if rules.any?
+          end
         end
       end
+
+      def find_rule(path, key)
+        @matching_rules[path] && @matching_rules[path][key]
+      end
+
+      def log_used_rule path, key, value
+        @used_rules << [path, key, value]
+      end
     end
   end
 end

data/lib/pact/matching_rules/v3/extract.rb

@@ -0,0 +1,94 @@
+require 'pact/something_like'
+require 'pact/array_like'
+require 'pact/term'
+
+module Pact
+  module MatchingRules::V3
+    class Extract
+
+      def self.call matchable
+        new(matchable).call
+      end
+
+      def initialize matchable
+        @matchable = matchable
+        @rules = Hash.new
+      end
+
+      def call
+        recurse matchable, "$", nil
+        rules
+      end
+
+      private
+
+      attr_reader :matchable, :rules
+
+      def recurse object, path, match_type
+        case object
+        when Hash then recurse_hash(object, path, match_type)
+        when Array then recurse_array(object, path, match_type)
+        when Pact::SomethingLike then handle_something_like(object, path, match_type)
+        when Pact::ArrayLike then handle_array_like(object, path, match_type)
+        when Pact::Term then record_regex_rule object, path
+        when Pact::QueryString then recurse(object.query, path, match_type)
+        when Pact::QueryHash then recurse_hash(object.query, path, match_type)
+        end
+      end
+
+      def recurse_hash hash, path, match_type
+        hash.each do | (key, value) |
+          recurse value, "#{path}#{next_path_part(key)}", match_type
+        end
+      end
+
+      def recurse_array new_array, path, match_type
+        new_array.each_with_index do | value, index |
+          recurse value, "#{path}[#{index}]", match_type
+        end
+      end
+
+      def handle_something_like something_like, path, match_type
+        record_match_type_rule path, "type"
+        recurse something_like.contents, path, "type"
+      end
+
+      def handle_array_like array_like, path, match_type
+        record_rule "#{path}", 'min' => array_like.min
+        record_match_type_rule "#{path}[*].*", 'type'
+        recurse array_like.contents, "#{path}[*]", :array_like
+      end
+
+      def record_rule path, rule
+        rules[path] ||= {}
+        rules[path]['matchers'] ||= []
+        rules[path]['matchers'] << rule
+      end
+
+      def record_regex_rule term, path
+        rules[path] ||= {}
+        rules[path]['matchers'] ||= []
+        rule = { 'match' => 'regex', 'regex' => term.matcher.inspect[1..-2]}
+        rules[path]['matchers'] << rule
+      end
+
+      def record_match_type_rule path, match_type
+        unless match_type == :array_like || match_type.nil?
+          rules[path] ||= {}
+          rules[path]['matchers'] ||= []
+          rules[path]['matchers'] << { 'match' => match_type }
+        end
+      end
+
+      # Beth: there's a potential bug if the key contains a dot and a single quote.
+      # Not sure what to do then.
+      def next_path_part key
+        if key.to_s.include?('.')
+          "['#{key}']"
+        else
+          ".#{key}"
+        end
+      end
+    end
+  end
+end

data/lib/pact/matching_rules/v3/merge.rb

@@ -0,0 +1,128 @@
+require 'pact/array_like'
+require 'pact/matching_rules/jsonpath'
+
+module Pact
+  module MatchingRules
+    module V3
+      class Merge
+
+        def self.call expected, matching_rules, root_path = '$'
+          new(expected, matching_rules, root_path).call
+        end
+
+        def initialize expected, matching_rules, root_path
+          @expected = expected
+          @matching_rules = standardise_paths(matching_rules)
+          @root_path = JsonPath.new(root_path).to_s
+        end
+
+        def call
+          return @expected if @matching_rules.nil? || @matching_rules.empty?
+          recurse(@expected, @root_path).tap { log_ignored_rules }
+        end
+
+        private
+
+        def standardise_paths matching_rules
+          return matching_rules if matching_rules.nil? || matching_rules.empty?
+          matching_rules.each_with_object({}) do | (path, rules), new_matching_rules |
+            new_matching_rules[JsonPath.new(path).to_s] = Marshal.load(Marshal.dump(rules)) # simplest way to deep clone
+          end
+        end
+
+        def recurse expected, path
+          case expected
+          when Hash then recurse_hash(expected, path)
+          when Array then recurse_array(expected, path)
+          else
+            expected
+          end
+        end
+
+        def recurse_hash hash, path
+          hash.each_with_object({}) do | (k, v), new_hash |
+            new_path = path + "['#{k}']"
+            new_hash[k] = recurse(wrap(v, new_path), new_path)
+          end
+        end
+
+        def recurse_array array, path
+
+          parent_match_rule = @matching_rules[path] && @matching_rules[path]['matchers'] && @matching_rules[path]['matchers'].first && @matching_rules[path]['matchers'].first.delete('match')
+          array_like_children_path = "#{path}[*]*"
+          children_match_rule = @matching_rules[array_like_children_path] && @matching_rules[array_like_children_path]['matchers'] && @matching_rules[array_like_children_path]['matchers'].first && @matching_rules[array_like_children_path]['matchers'].first.delete('match')
+          min = @matching_rules[path] && @matching_rules[path]['matchers'] && @matching_rules[path]['matchers'].first && @matching_rules[path]['matchers'].first.delete('min')
+
+          if min && (children_match_rule == 'type' || (children_match_rule.nil? && parent_match_rule == 'type'))
+            warn_when_not_one_example_item(array, path)
+            Pact::ArrayLike.new(recurse(array.first, "#{path}[*]"), min: min)
+          else
+            new_array = []
+            array.each_with_index do | item, index |
+              new_path = path + "[#{index}]"
+              new_array << recurse(wrap(item, new_path), new_path)
+            end
+            new_array
+          end
+        end
+
+        def warn_when_not_one_example_item array, path
+          unless array.size == 1
+            Pact.configuration.error_stream.puts "WARN: Only the first item will be used to match the items in the array at #{path}"
+          end
+        end
+
+        def wrap object, path
+          rules = @matching_rules[path] && @matching_rules[path]['matchers'] && @matching_rules[path]['matchers'].first
+          array_rules = @matching_rules["#{path}[*]*"] && @matching_rules["#{path}[*]*"]['matchers'] && @matching_rules["#{path}[*]*"]['matchers'].first
+          return object unless rules || array_rules
+
+          if rules['match'] == 'type' && !rules.has_key?('min')
+            handle_match_type(object, path, rules)
+          elsif rules['regex']
+            handle_regex(object, path, rules)
+          else
+            #log_ignored_rules(path, rules, {})
+            object
+          end
+        end
+
+        def handle_match_type object, path, rules
+          rules.delete('match')
+          Pact::SomethingLike.new(recurse(object, path))
+        end
+
+        def handle_regex object, path, rules
+          rules.delete('match')
+          regex = rules.delete('regex')
+          Pact::Term.new(generate: object, matcher: Regexp.new(regex))
+        end
+
+        def log_ignored_rules
+          @matching_rules.each do | jsonpath, rules_hash |
+            rules_array = rules_hash["matchers"]
+            ((rules_array.length - 1)..0).each do | index |
+              rules_array.delete_at(index) if rules_array[index].empty?
+            end
+          end
+
+          if @matching_rules.any?
+            @matching_rules.each do | path, rules_hash |
+              rules_hash.each do | key, value |
+                $stderr.puts "WARN: Ignoring unsupported #{key} #{value} for path #{path}" if value.any?
+              end
+            end
+          end
+        end
+
+        def find_rule(path, key)
+          @matching_rules[path] && @matching_rules[path][key]
+        end
+
+        def log_used_rule path, key, value
+          @used_rules << [path, key, value]
+        end
+      end
+    end
+  end
+end

data/lib/pact/matching_rules.rb

@@ -1,17 +1,30 @@
 require 'pact/matching_rules/extract'
+require 'pact/matching_rules/v3/extract'
 require 'pact/matching_rules/merge'
+require 'pact/matching_rules/v3/merge'
 
 module Pact
   module MatchingRules
 
     # @api public Used by pact-mock_service
-    def self.extract object_graph
-      Extract.(object_graph)
+    def self.extract object_graph, options = {}
+      pact_specification_version = options[:pact_specification_version] || Pact::SpecificationVersion::NIL_VERSION
+      case pact_specification_version.major
+      when nil, 0, 1, 2
+        Extract.(object_graph)
+      else
+        V3::Extract.(object_graph)
+      end
     end
 
-    def self.merge object_graph, matching_rules
-      Merge.(object_graph, matching_rules)
+    def self.merge object_graph, matching_rules, options = {}
+      pact_specification_version = options[:pact_specification_version] || Pact::SpecificationVersion::NIL_VERSION
+      case pact_specification_version.major
+      when nil, 0, 1, 2
+        Merge.(object_graph, matching_rules)
+      else
+        V3::Merge.(object_graph, matching_rules)
+      end
     end
-
   end
-end
+end

data/lib/pact/reification.rb

@@ -5,6 +5,7 @@ require 'pact/array_like'
 require 'pact/shared/request'
 require 'pact/consumer_contract/query_hash'
 require 'pact/consumer_contract/query_string'
+require 'pact/consumer_contract/string_with_matching_rules'
 
 module Pact
   module Reification
@@ -26,15 +27,17 @@ module Pact
       when Pact::QueryString
         from_term(term.query)
       when Pact::QueryHash
-        term.query.map { |k, v|
+        from_term(term.query).map { |k, v|
           if v.nil?
             k
           elsif v.is_a?(Array) #For cases where there are multiple instance of the same parameter
-            v.map { |x| "#{k}=#{escape(from_term(x))}"}.join('&')
+            v.map { |x| "#{k}=#{escape(x)}"}.join('&')
           else
-            "#{k}=#{escape(from_term(v))}"
+            "#{k}=#{escape(v)}"
           end
         }.join('&')
+      when Pact::StringWithMatchingRules
+        String.new(term)
       else
         term
       end

data/lib/pact/shared/multipart_form_differ.rb

@@ -0,0 +1,14 @@
+require 'uri'
+require 'pact/shared/text_differ'
+
+module Pact
+  class MultipartFormDiffer
+    def self.call expected, actual, options = {}
+      require 'pact/matchers' # avoid recursive loop between this file and pact/matchers
+      expected_boundary = expected.split.first
+      actual_boundary = actual.split.first
+      actual_with_hardcoded_boundary = actual.gsub(actual_boundary, expected_boundary)
+      TextDiffer.call(expected, actual_with_hardcoded_boundary, options)
+    end
+  end
+end

data/lib/pact/specification_version.rb

@@ -0,0 +1,18 @@
+module Pact
+  class SpecificationVersion < Gem::Version
+
+    def major
+      segments.first
+    end
+
+    def === other
+      major && major == other
+    end
+
+    def after? other
+      major && other < major
+    end
+  end
+
+  SpecificationVersion::NIL_VERSION = Pact::SpecificationVersion.new('0')
+end

data/lib/pact/support/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module Support
-    VERSION = "1.4.0"
+    VERSION = "1.7.0"
   end
 end

data/script/release.sh

@@ -5,5 +5,5 @@ git checkout -- lib/pact/support/version.rb
 bundle exec bump ${1:-minor} --no-commit
 bundle exec rake generate_changelog
 git add CHANGELOG.md lib/pact/support/version.rb
-git commit -m "Releasing version $(ruby -r ./lib/pact/support/version.rb -e "puts Pact::Support::VERSION")"
+git commit -m "chore(release): version $(ruby -r ./lib/pact/support/version.rb -e "puts Pact::Support::VERSION")"
 bundle exec rake release

data/spec/fixtures/multipart-form-diff.txt

@@ -0,0 +1,9 @@
+
+
+Description of differences
+--------------------------------------
+* Wrong header
+
+@@ -1,2 +1,2 @@
+-bar
++foo

data/spec/fixtures/not-a-pact.json

@@ -0,0 +1,3 @@
+{
+  "foo": "bar"
+}

data/spec/fixtures/pact-http-v2.json

@@ -0,0 +1,36 @@
+{
+  "consumer": {
+    "name": "some-test-consumer"
+  },
+  "provider": {
+    "name": "an unknown provider"
+  },
+  "interactions": [
+    {
+      "description": "a test request",
+      "request": {
+        "method": "get",
+        "path": "/weather",
+        "query": ""
+      },
+      "response": {
+        "matchingRules": {
+          "$.headers.Content-Type" : {
+            "match": "regex", "regex": "json"
+          },
+          "$.body.message" : {
+            "match": "regex", "regex": "sun"
+          }
+        },
+        "status": 200,
+        "headers" : {
+          "Content-Type": "foo/json"
+        },
+        "body": {
+          "message" : "sunful"
+        }
+      },
+      "provider_state": "the weather is sunny"
+    }
+  ]
+}

data/spec/fixtures/pact-http-v3.json

@@ -0,0 +1,36 @@
+{
+  "consumer": {
+    "name": "consumer"
+  },
+  "interactions": [
+    {
+      "description": "a test request",
+      "providerState": "the weather is sunny",
+      "request": {
+        "method": "get",
+        "path": "/foo"
+      },
+      "response": {
+        "body": {
+          "foo": "bar"
+        },
+        "matchingRules": {
+          "body": {
+            "$.foo": {
+              "matchers": [{ "match": "type" }]
+            }
+          }
+        },
+        "status": 200
+      }
+    }
+  ],
+  "provider": {
+    "name": "provider"
+  },
+  "metadata": {
+    "pactSpecification": {
+      "version": "3.0"
+    }
+  }
+}

data/spec/integration/matching_rules_extract_and_merge_spec.rb

@@ -1,7 +1,9 @@
 require 'pact/term'
 require 'pact/something_like'
 require 'pact/matching_rules/extract'
+require 'pact/matching_rules/v3/extract'
 require 'pact/matching_rules/merge'
+require 'pact/matching_rules/v3/merge'
 require 'pact/reification'
 
 describe "converting Pact::Term and Pact::SomethingLike to matching rules and back again" do
@@ -10,6 +12,9 @@ describe "converting Pact::Term and Pact::SomethingLike to matching rules and ba
   let(:matching_rules) { Pact::MatchingRules::Extract.(expected) }
   let(:recreated_expected) { Pact::MatchingRules::Merge.(example, matching_rules)}
 
+  let(:recreated_expected_v3) { Pact::MatchingRules::V3::Merge.(example, matching_rules_v3) }
+  let(:matching_rules_v3) { Pact::MatchingRules::V3::Extract.(expected) }
+
   context "with a Pact::Term" do
     let(:expected) do
       {
@@ -21,9 +26,29 @@ describe "converting Pact::Term and Pact::SomethingLike to matching rules and ba
       }
     end
 
-    it "recreates the same object hierarchy" do
+    it "recreates the same object hierarchy with v2 matching" do
+      expect(recreated_expected).to eq expected
+    end
+
+    it "recreates the same object hierarchy with v3 matching" do
+      expect(recreated_expected_v3).to eq expected
+    end
+  end
+
+  context "with a Pact::SomethingLike containing a Pact::ArrayLike" do
+    let(:expected) do
+      {
+        body: Pact::SomethingLike.new(children: Pact::ArrayLike.new("foo", min: 2))
+      }
+    end
+
+    it "recreates the same object hierarchy with v2 matching" do
       expect(recreated_expected).to eq expected
     end
+
+    it "recreates the same object hierarchy with v3 matching" do
+      expect(recreated_expected_v3).to eq expected
+    end
   end
 
   context "with a Pact::SomethingLike" do
@@ -37,9 +62,13 @@ describe "converting Pact::Term and Pact::SomethingLike to matching rules and ba
       }
     end
 
-    it "recreates the same object hierarchy" do
+    it "recreates the same object hierarchy with v2 matching" do
       expect(recreated_expected).to eq expected
     end
+
+    it "recreates the same object hierarchy with v3 matching" do
+      expect(recreated_expected_v3).to eq expected
+    end
   end
 
   context "with a Pact::SomethingLike containing a Hash" do
@@ -61,9 +90,13 @@ describe "converting Pact::Term and Pact::SomethingLike to matching rules and ba
       }
     end
 
-    it "recreates the same object hierarchy" do
+    it "recreates the same object hierarchy with v2 matching" do
       expect(recreated_expected).to eq expected
     end
+
+    it "recreates the same object hierarchy with v3 matching" do
+      expect(recreated_expected_v3).to eq expected
+    end
   end
 
   context "with a Pact::SomethingLike containing an Array" do
@@ -83,8 +116,12 @@ describe "converting Pact::Term and Pact::SomethingLike to matching rules and ba
       }
     end
 
-    it "recreates the same object hierarchy" do
+    it "recreates the same object hierarchy with v2 matching" do
       expect(recreated_expected).to eq expected
     end
+
+    it "recreates the same object hierarchy with v3 matching" do
+      expect(recreated_expected_v3).to eq expected
+    end
   end
 end