class Pact::MatchingRules::Merge

Public Class Methods

call(expected, matching_rules, root_path = '$') click to toggle source
# File lib/pact/matching_rules/merge.rb, line 8
def self.call expected, matching_rules, root_path = '$'
  new(expected, matching_rules, root_path).call
end
new(expected, matching_rules, root_path) click to toggle source
# File lib/pact/matching_rules/merge.rb, line 12
def initialize expected, matching_rules, root_path
  @expected = expected
  @matching_rules = standardise_paths(matching_rules)
  @root_path = JsonPath.new(root_path).to_s
  @used_rules = []
end

Public Instance Methods

call() click to toggle source
# File lib/pact/matching_rules/merge.rb, line 19
def call
  return @expected if @matching_rules.nil? || @matching_rules.empty?
  recurse(@expected, @root_path).tap { log_ignored_rules }
end

Private Instance Methods

find_rule(path, key) click to toggle source
# File lib/pact/matching_rules/merge.rb, line 116
def find_rule(path, key)
  @matching_rules[path] && @matching_rules[path][key]
end
handle_match_type(object, path) click to toggle source
# File lib/pact/matching_rules/merge.rb, line 91
def handle_match_type object, path
  log_used_rule(path, 'match', 'type')
  Pact::SomethingLike.new(object)
end
handle_regex(object, path) click to toggle source
# File lib/pact/matching_rules/merge.rb, line 96
def handle_regex object, path
  regex = find_rule(path, 'regex')
  log_used_rule(path, 'match', 'regex') # assumed to be present
  log_used_rule(path, 'regex', regex)
  Pact::Term.new(generate: object, matcher: Regexp.new(regex))
end
log_ignored_rules() click to toggle source
# File lib/pact/matching_rules/merge.rb, line 103
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?
    dup_rules.each do | path, rules |
      $stderr.puts "WARN: Ignoring unsupported matching rules #{rules} for path #{path}" if rules.any?
    end
  end
end
log_used_rule(path, key, value) click to toggle source
# File lib/pact/matching_rules/merge.rb, line 120
def log_used_rule path, key, value
  @used_rules << [path, key, value]
end
recurse(expected, path) click to toggle source
# File lib/pact/matching_rules/merge.rb, line 33
def recurse expected, path
  recursed = case expected
  when Hash then recurse_hash(expected, path)
  when Array then recurse_array(expected, path)
  else
    expected
  end

  wrap(recursed, path)
end
recurse_array(array, path) click to toggle source
# File lib/pact/matching_rules/merge.rb, line 51
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}[*]*"
  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)
    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(item, new_path)
    end
    new_array
  end
end
recurse_hash(hash, path) click to toggle source
# File lib/pact/matching_rules/merge.rb, line 44
def recurse_hash hash, path
  hash.each_with_object({}) do | (k, v), new_hash |
    new_path = path + "['#{k}']"
    new_hash[k] = recurse(v, new_path)
  end
end
standardise_paths(matching_rules) click to toggle source
# File lib/pact/matching_rules/merge.rb, line 26
def standardise_paths matching_rules
  return matching_rules if matching_rules.nil? || matching_rules.empty?
  matching_rules.each_with_object({}) do | (path, rule), new_matching_rules |
    new_matching_rules[JsonPath.new(path).to_s] = rule
  end
end
warn_when_not_one_example_item(array, path) click to toggle source
# File lib/pact/matching_rules/merge.rb, line 75
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
wrap(object, path) click to toggle source
# File lib/pact/matching_rules/merge.rb, line 81
def wrap object, path
  if find_rule(path, 'match') == 'type' && !find_rule(path, 'min')
    handle_match_type(object, path)
  elsif find_rule(path, 'regex')
    handle_regex(object, path)
  else
    object
  end
end